{"_id":"@aionis/doc","_rev":"2-cfdd993dd367e87a32a569a4cd5ab057","name":"@aionis/doc","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@aionis/doc","version":"0.1.0","keywords":["aionis","document","compiler","typescript"],"author":{"name":"Aionis Core"},"license":"Apache-2.0","_id":"@aionis/doc@0.1.0","maintainers":[{"name":"fielddd","email":"heyopscc@gmail.com"}],"bin":{"compile-aionis-doc":"dist/cli.js","execute-aionis-doc":"dist/execute-cli.js","resume-aionis-doc-runtime":"dist/resume-cli.js","publish-aionis-doc-handoff":"dist/publish-cli.js","recover-aionis-doc-handoff":"dist/recover-cli.js","build-aionis-doc-runtime-handoff":"dist/runtime-handoff-cli.js","build-aionis-doc-handoff-store-request":"dist/handoff-store-cli.js"},"dist":{"shasum":"a78855cf2d9665490294d1b30fdc885c2a3d78ab","tarball":"https://registry.npmjs.org/@aionis/doc/-/doc-0.1.0.tgz","fileCount":65,"integrity":"sha512-1+ZyllWhEuJHO+KgiVOOVdikLxA482UHKzfe8D2KE+/9lj0TlmfqIkPkUHw9qQ7ExSaroTUkvJNOBFtzRNWKgQ==","signatures":[{"sig":"MEQCIDqJ95EIyIpDVWxZyZ5zrGNKRX4JKglbCptboLm+cq90AiBeN4AxOLVrka1/VCvVAdnjt6gfpBMArrXqPzM8Q2szBA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":763930},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"6d48e5f8ef51007908d12068c254736059ab031a","scripts":{"build":"tsc -p tsconfig.build.json","clean":"rm -rf dist","pack:dry-run":"npm pack --dry-run --cache /tmp/aionis-npm-cache"},"_npmUser":{"name":"fielddd","email":"heyopscc@gmail.com"},"_npmVersion":"11.6.2","description":"Parser and compiler primitives for Aionis Doc","directories":{},"_nodeVersion":"24.12.0","dependencies":{"zod":"^3.23.8"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc_0.1.0_1773821373566_0.8966419949773281","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@aionis/doc","version":"0.2.0","description":"Parser and compiler primitives for Aionis Doc","type":"module","main":"dist/index.js","types":"dist/index.d.ts","bin":{"compile-aionis-doc":"dist/cli.js","run-aionis-doc":"dist/run-cli.js","validate-aionis-doc-registry":"dist/validate-registry-cli.js","validate-aionis-doc-module":"dist/validate-module-cli.js","execute-aionis-doc":"dist/execute-cli.js","build-aionis-doc-runtime-handoff":"dist/runtime-handoff-cli.js","build-aionis-doc-handoff-store-request":"dist/handoff-store-cli.js","publish-aionis-doc-handoff":"dist/publish-cli.js","recover-aionis-doc-handoff":"dist/recover-cli.js","resume-aionis-doc-runtime":"dist/resume-cli.js"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"publishConfig":{"access":"public"},"engines":{"node":">=18.0.0"},"scripts":{"build":"tsc -p tsconfig.build.json","clean":"rm -rf dist","pack:dry-run":"npm pack --dry-run --cache /tmp/aionis-npm-cache"},"dependencies":{"zod":"^3.23.8"},"keywords":["aionis","document","compiler","typescript"],"author":{"name":"Aionis Core"},"license":"Apache-2.0","gitHead":"b7101527b8e2ee15aaba5687cbaa7ca1d99ca254","_id":"@aionis/doc@0.2.0","_nodeVersion":"24.12.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-sjwl3UEWI+N54uu+qkZuHu63SaqAvY85AMxQOgMmpAcGV+wjqAOI7F6zZ0hGeYpZqVvjcEumNdUnCfEYnePOQw==","shasum":"982c7d519a3e79b6c46f3302473f05b09a08c16f","tarball":"https://registry.npmjs.org/@aionis/doc/-/doc-0.2.0.tgz","fileCount":79,"unpackedSize":797260,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIB9/0b0af92umk0NJqDoCDavvA8tDzeFlD/2k8NmdIVqAiAaUn/6ANNtU5cl0NGsjg5j5j34GH7IrHlEqw17LuRfRw=="}]},"_npmUser":{"name":"fielddd","email":"heyopscc@gmail.com"},"directories":{},"maintainers":[{"name":"fielddd","email":"heyopscc@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/doc_0.2.0_1773831413765_0.9837483960244908"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-18T08:09:33.506Z","modified":"2026-03-18T10:56:54.028Z","0.1.0":"2026-03-18T08:09:33.704Z","0.2.0":"2026-03-18T10:56:53.904Z"},"author":{"name":"Aionis Core"},"license":"Apache-2.0","keywords":["aionis","document","compiler","typescript"],"description":"Parser and compiler primitives for Aionis Doc","maintainers":[{"name":"fielddd","email":"heyopscc@gmail.com"}],"readme":"# @aionis/doc\n\nParser, compiler, standalone runner, and continuity toolchain for Aionis Doc.\n\n## Install\n\n```bash\nnpm i @aionis/doc@0.2.0\n```\n\nThis package exposes two standalone paths:\n\n1. portable execution through `run-aionis-doc`\n2. Aionis-native continuity through handoff, publish, recover, and resume\n\nThe shortest standalone execution path is:\n\n```bash\nnpx @aionis/doc@0.2.0 run-aionis-doc ./workflow.aionis.md --registry ./module-registry.json\n```\n\nThe stable registry path is the local file registry:\n\n1. `aionis_doc_module_registry_v1`\n2. runtime id: `standalone_file_registry_v1`\n\nAn experimental npm-installed registry prototype is also supported:\n\n1. `aionis_doc_npm_module_registry_v1`\n2. runtime id: `standalone_npm_registry_v1`\n\nThe first official module package set is now published on npm:\n\n1. `@aionis/doc-module-research-claims`\n2. `@aionis/doc-module-copy-summary`\n3. `@aionis/doc-module-json-transform`\n\nIf you are authoring your own package, the shortest stable workflow is:\n\n1. export `manifest` and `handler`\n2. validate the module entry with `validate-aionis-doc-module`\n3. attach it to a registry\n4. validate the registry\n5. run the document through `run-aionis-doc`\n\nThe full package binaries are:\n\n```bash\nnpx @aionis/doc@0.2.0 compile-aionis-doc ./workflow.aionis.md --emit all\nnpx @aionis/doc@0.2.0 run-aionis-doc ./workflow.aionis.md --registry ./module-registry.json\nnpx @aionis/doc@0.2.0 validate-aionis-doc-registry ./module-registry.json\nnpx @aionis/doc@0.2.0 validate-aionis-doc-module ./modules/copy-summary.mjs --declared-module copy.summary.v1\nnpx @aionis/doc@0.2.0 execute-aionis-doc ./workflow.aionis.md\nnpx @aionis/doc@0.2.0 build-aionis-doc-runtime-handoff ./workflow.aionis.md --scope default\nnpx @aionis/doc@0.2.0 build-aionis-doc-handoff-store-request ./runtime-handoff.json --scope default\nnpx @aionis/doc@0.2.0 publish-aionis-doc-handoff ./workflow.aionis.md --base-url http://127.0.0.1:3001\nnpx @aionis/doc@0.2.0 recover-aionis-doc-handoff ./workflow.aionis.md --base-url http://127.0.0.1:3001\nnpx @aionis/doc@0.2.0 resume-aionis-doc-runtime ./recover-result.json --input-kind recover-result --candidate resume_patch --candidate request_review\n```\n\n## CLI Surface\n\n1. `compile-aionis-doc`\n2. `run-aionis-doc`\n3. `validate-aionis-doc-registry`\n4. `validate-aionis-doc-module`\n5. `execute-aionis-doc`\n6. `build-aionis-doc-runtime-handoff`\n7. `build-aionis-doc-handoff-store-request`\n8. `publish-aionis-doc-handoff`\n9. `recover-aionis-doc-handoff`\n10. `resume-aionis-doc-runtime`\n\n## Package Usage\n\n```ts\nimport {\n  compileAionisDoc,\n  compileAndExecuteAionisDoc,\n  buildRuntimeHandoffV1,\n  buildHandoffStoreRequestFromRuntimeHandoff,\n  ModuleRegistryExecutionRuntime,\n  StaticModuleRegistry,\n  runAionisDoc,\n} from \"@aionis/doc\";\n\nconst result = compileAionisDoc(sourceText);\n\nconst standaloneResult = await runAionisDoc({\n  inputPath: \"./workflow.aionis.md\",\n  inputKind: \"source\",\n  registryPath: \"./module-registry.json\",\n});\n\nconst handoff = buildRuntimeHandoffV1({\n  inputPath: \"./workflow.aionis.md\",\n  result,\n  scope: \"default\",\n  repoRoot: process.cwd(),\n});\n\nconst storeRequest = buildHandoffStoreRequestFromRuntimeHandoff({\n  handoff,\n  scope: \"default\",\n});\n\nconst runtime = new ModuleRegistryExecutionRuntime({\n  runtime_id: \"custom_runtime_v1\",\n  registry: new StaticModuleRegistry([\n    {\n      manifest: {\n        module: \"custom.echo.v1\",\n        version: \"1.0.0\",\n        description: \"Echo a text payload.\",\n        deterministic: true,\n        required_capabilities: [\"direct_execution\"],\n        input_contract: {\n          kind: \"object\",\n          properties: {\n            text: { kind: \"string\" },\n          },\n          required: [\"text\"],\n          additional_properties: false,\n        },\n        output_contract: {\n          kind: \"object\",\n          properties: {\n            text: { kind: \"string\" },\n          },\n          required: [\"text\"],\n          additional_properties: false,\n        },\n        artifact_contract: {\n          kind: \"object\",\n          properties: {\n            uri: { kind: \"string\" },\n          },\n          required: [\"uri\"],\n          additional_properties: false,\n        },\n        evidence_contract: {\n          kind: \"object\",\n          properties: {\n            claim: { kind: \"string\" },\n          },\n          required: [\"claim\"],\n          additional_properties: false,\n        },\n      },\n      handler: (input) => ({\n        kind: \"module_result\",\n        output: input,\n        artifacts: [{ uri: \"memory://artifacts/custom.echo.v1/result.json\" }],\n        evidence: [{ claim: \"Echo module returned the input payload.\" }],\n      }),\n    },\n  ]),\n});\n\nconst executionResult = await compileAndExecuteAionisDoc(sourceText, { runtime });\n```\n\nThe module contract is now split into:\n\n1. `manifest`: stable runtime-neutral metadata and input/output contracts\n2. `artifact_contract` and `evidence_contract`: optional structured side-output contracts\n3. `handler`: the runtime-specific implementation\n\nThe important boundary is:\n\n1. `run-aionis-doc` and `runAionisDoc(...)` are standalone execution entrypoints\n2. `validate-aionis-doc-registry` and `validate-aionis-doc-module` are standalone contract checks\n3. `publish / recover / resume` remain Aionis-native continuity enhancements\n\n## Local Release Checks\n\nFrom the repository root:\n\n```bash\nnpm run aionis-doc:build\nnpm run aionis-doc:test\nnpm run aionis-doc:cli:test\nnpm run aionis-doc:run:cli:test\nnpm run aionis-doc:modules:test\nnpm run aionis-doc:execute:cli:test\nnpm run aionis-doc:handoff:cli:test\nnpm run aionis-doc:store-request:cli:test\nnpm run aionis-doc:publish:cli:test\nnpm run aionis-doc:recover:cli:test\nnpm run aionis-doc:release-check\nnpm run aionis-doc:pack-dry-run\n```\n","readmeFilename":"README.md"}