{
  "markdown": "# spec-objects-business\n\n> Filament Module: tier-2 business ObjectTypes (DDD: domain, entity, value_object, aggregate_root, repository, event, state_machine, process, enumeration)\n\nAgent-IX Filament module loaded by [`quire-cli`](https://github.com/agent-ix/quire-cli) and [`quoin`](https://github.com/agent-ix/quoin).\n\n## Installing quire-cli\n\n`@agent-ix` packages are published to public npm. Install the CLI globally:\n\n```bash\nnpm install -g @agent-ix/quire-cli\n```\n\nSee https://github.com/agent-ix/quire-cli#install for details.\n\n## Install this module via npm\n\nThis module is also published as a config-only npm package: `@agent-ix/spec-objects-business`.\nThe package root **is** the Filament module (`manifest.yaml` + schemas/skeletons),\nso it works directly as a `--module` target or via quoin's `package:` source.\n\n```bash\nnpm install @agent-ix/spec-objects-business\n```\n\n```bash\n# quoin — resolve the module from npm by name\nquoin plugin install package:@agent-ix/spec-objects-business\n\n# or point any tool at the installed package root\nquire validate spec/**/*.md --module node_modules/@agent-ix/spec-objects-business\n```\n\n## Object types provided\n\n| Object | `type:` | Description |\n|--------|---------|-------------|\n| Domain | `domain` | A bounded context defining what it owns vs. delegates to neighbouring contexts, with an optional entity summary, ERD, and ubiquitous language. |\n| Entity | `entity` | An object with a stable identity field plus its typed attributes and their meaning. |\n| Value object | `value_object` | An immutable value defined by its components, with equality and validity rules but no identity of its own. |\n| Aggregate root | `aggregate_root` | The consistency boundary — root, nested entities, owned value objects, and the invariants the root enforces over them. |\n| Nested entity | `nested_entity` | An entity owned by an aggregate root, with parent-local identity whose every mutation is mediated by the parent. |\n| Repository | `repository` | The collection-like access point that loads and saves whole aggregates, with each operation's signature, behaviour, and failure semantics. |\n| Event | `event` | A domain/integration event whose payload contract is given as a JSON Schema. |\n| State machine | `state_machine` | An object lifecycle expressed as a mermaid `stateDiagram-v2` of states and transitions. |\n| Process | `process` | A long-running workflow/saga diagrammed in mermaid (one or more flows), with optional state diagrams, specification, and algorithm. |\n| Enumeration | `enumeration` | A controlled label vocabulary (state names, kinds, codes) as a `Value | Description` table referenced by exact string. |\n\n## How this module is used\n\n### With quoin (recommended)\n\n```bash\n# Install this module as a plugin (from a local checkout)\nquoin plugin install path:../spec-objects-business\n\n# List the kinds the installed modules expose\nquoin catalog list\n\n# Author new artifacts from these object types\nquoin write . --types domain,aggregate_root\n\n# Review/validate the authored artifacts\nquoin review\n```\n\nSee [quoin](https://github.com/agent-ix/quoin).\n\n### With quire-cli directly\n\n```bash\n# Emit an authoring skeleton for a given kind\nquire schema domain --module ./spec_objects_business\n\n# Validate Markdown spec artifacts against the module\nquire validate spec/**/*.md --module ./spec_objects_business\n\n# Extract structured object bodies from a document\nquire extract spec/order-management.md --module ./spec_objects_business\n```\n\nSee [quire-cli usage instructions](https://github.com/agent-ix/quire-cli#usage-instructions).\n\n## Development\n\nPython 3.13+, [Poetry](https://python-poetry.org/) managed, flat layout (package `spec_objects_business` at root). Versioning is dynamic from the Git tag; CI (GitHub Actions on `push`/`pull_request`/`tag v*.*.*`) runs tests + lint and publishes the wheel/sdist to Google Artifact Registry (PyPI-compatible) via `twine`.\n\n```bash\nmake install                  # install deps into the Poetry venv\nmake test                     # run pytest\nmake lint                     # ruff + black check\nmake format                   # ruff + black format\nmake build                    # build wheel + sdist under dist/\nmake update-lock              # update poetry.lock\nmake use-local p=<name>       # switch a dep to local pypi.ix\nmake use-upstream p=<name>    # switch a dep back to upstream\nmake local-publish            # build + publish to local pypi.ix\n```\n\nRequired CI secrets/vars: `GCP_SERVICE_ACCOUNT_KEY`, `GCP_REGION`, `GCP_PROJECT_NAME`, `GCP_PYPI`.\n",
  "bytes": 4548,
  "sha": "98889a9d585e88f8a620ddb13b96ed3150bc19d288458f293171dba2e18213bd",
  "repo_slug": "agent-ix/spec-objects-business",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/okf_agent_ix_spec_objects_business_plan_plan_4492b70c/readme"
}