@altopelago/aeon-sdk 0.9.0

package/README.md

@@ -0,0 +1,36 @@
+# @altopelago/aeon-sdk
+
+Application-facing convenience layer for common AEON read/write flows.
+
+## Quick Start
+
+```ts
+import { readAeonChecked, writeAeon } from '@altopelago/aeon-sdk';
+
+const parsed = readAeonChecked('greeting:string = "Hello"');
+console.log(parsed.finalized.document);
+
+const emitted = writeAeon({ app: 'todo', version: 1 });
+console.log(emitted.text);
+```
+
+## What This Package Does
+
+- wraps common read flows around `@altopelago/aeon-core` and `@altopelago/aeon-finalize`
+- wraps object emission via `@altopelago/aeon-canonical`
+- exposes a canonical-path event index for app code and examples
+
+## API
+
+- `readAeon(input, options?)`
+- `readAeonChecked(input, options?)`
+- `readAeonStrictCustom(input)`
+- `writeAeon(object, options?)`
+- `formatPath(path)`
+- `indexEventsByPath(events)`
+
+## Notes
+
+- Prefer this package for simple application examples.
+- Use `@altopelago/aeon-core` when you only need compile-only behavior.
+- Use `@altopelago/aeon-runtime` when you need the full orchestrated runtime pipeline.

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import { formatPath, type CompileOptions, type CompileResult } from '@altopelago/aeon-core';
+import { type FinalizeJsonResult, type FinalizeOptions } from '@altopelago/aeon-finalize';
+import { type EmitObjectOptions, type EmitResult } from '@altopelago/aeon-canonical';
+export interface ReadAeonOptions {
+    readonly compile?: CompileOptions;
+    readonly finalize?: FinalizeOptions;
+}
+export interface ReadAeonResult {
+    readonly compile: CompileResult;
+    readonly finalized: FinalizeJsonResult;
+}
+export interface ReadAeonCheckedResult extends ReadAeonResult {
+    readonly eventsByPath: ReadonlyMap<string, CompileResult['events'][number]>;
+}
+export declare function readAeon(input: string, options?: ReadAeonOptions): ReadAeonResult;
+export declare function indexEventsByPath(events: readonly CompileResult['events'][number][]): ReadonlyMap<string, CompileResult['events'][number]>;
+export declare function readAeonChecked(input: string, options?: ReadAeonOptions): ReadAeonCheckedResult;
+export declare function readAeonStrictCustom(input: string): ReadAeonCheckedResult;
+export declare function writeAeon(object: Readonly<Record<string, unknown>>, options?: EmitObjectOptions): EmitResult;
+export { formatPath };
+export type { CompileOptions, CompileResult, FinalizeOptions, FinalizeJsonResult, EmitObjectOptions, EmitResult, };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,UAAU,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACrG,OAAO,EAAgB,KAAK,kBAAkB,EAAE,KAAK,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACxG,OAAO,EAAkB,KAAK,iBAAiB,EAAE,KAAK,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAErG,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;CACrC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;CAC7E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,cAAc,CAcrF;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAE1I;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,qBAAqB,CAiBnG;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,qBAAqB,CAKzE;AAED,wBAAgB,SAAS,CACvB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACzC,OAAO,GAAE,iBAAsB,GAC9B,UAAU,CAEZ;AAED,OAAO,EAAE,UAAU,EAAE,CAAC;AAEtB,YAAY,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,GACX,CAAC"}

package/dist/index.js

@@ -0,0 +1,46 @@
+import { compile, formatPath } from '@altopelago/aeon-core';
+import { finalizeJson } from '@altopelago/aeon-finalize';
+import { emitFromObject } from '@altopelago/aeon-canonical';
+export function readAeon(input, options = {}) {
+    const compileResult = compile(input, {
+        ...(options.compile ?? {}),
+    });
+    const finalized = finalizeJson(compileResult.events, {
+        mode: 'strict',
+        ...(options.finalize ?? {}),
+    });
+    return {
+        compile: compileResult,
+        finalized,
+    };
+}
+export function indexEventsByPath(events) {
+    return new Map(events.map((event) => [formatPath(event.path), event]));
+}
+export function readAeonChecked(input, options = {}) {
+    const result = readAeon(input, options);
+    if (result.compile.errors.length > 0) {
+        const summary = result.compile.errors.map((error) => `${error.code}: ${error.message}`).join('\n');
+        throw new Error(`AEON compile failed with ${result.compile.errors.length} error(s):\n${summary}`);
+    }
+    const finalizeErrors = result.finalized.meta?.errors ?? [];
+    if (finalizeErrors.length > 0) {
+        const summary = finalizeErrors.map((error) => error.message).join('\n');
+        throw new Error(`AEON finalize failed with ${finalizeErrors.length} error(s):\n${summary}`);
+    }
+    return {
+        ...result,
+        eventsByPath: indexEventsByPath(result.compile.events),
+    };
+}
+export function readAeonStrictCustom(input) {
+    return readAeonChecked(input, {
+        compile: { datatypePolicy: 'allow_custom' },
+        finalize: { mode: 'strict' },
+    });
+}
+export function writeAeon(object, options = {}) {
+    return emitFromObject(object, options);
+}
+export { formatPath };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAA2C,MAAM,uBAAuB,CAAC;AACrG,OAAO,EAAE,YAAY,EAAiD,MAAM,2BAA2B,CAAC;AACxG,OAAO,EAAE,cAAc,EAA2C,MAAM,4BAA4B,CAAC;AAgBrG,MAAM,UAAU,QAAQ,CAAC,KAAa,EAAE,UAA2B,EAAE;IACnE,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE;QACnC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;KAC3B,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,EAAE;QACnD,IAAI,EAAE,QAAQ;QACd,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAC5B,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,aAAa;QACtB,SAAS;KACV,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAkD;IAClF,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,UAA2B,EAAE;IAC1E,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnG,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,eAAe,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC;IAC3D,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,MAAM,eAAe,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,YAAY,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAO,eAAe,CAAC,KAAK,EAAE;QAC5B,OAAO,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE;QAC3C,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC7B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,MAAyC,EACzC,UAA6B,EAAE;IAE/B,OAAO,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@altopelago/aeon-sdk",
+  "version": "0.9.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.d.ts",
+    "!dist/**/*.test.d.ts.map",
+    "!dist/**/*.test.js",
+    "!dist/**/*.test.js.map"
+  ],
+  "dependencies": {
+    "@altopelago/aeon-core": "0.9.0",
+    "@altopelago/aeon-finalize": "0.9.0",
+    "@altopelago/aeon-canonical": "0.9.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "node --test dist/*.test.js",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}