@altopelago/aeon-finalize 0.9.0

package/dist/transform.js

@@ -0,0 +1,43 @@
+export function transformDocument(document, transform) {
+    const root = transformNode(document.root, transform, { path: ['$'] });
+    return { root };
+}
+export function transformNode(node, transform, ctx) {
+    const entered = transform.enter ? transform.enter(node, ctx) : undefined;
+    const current = entered ?? node;
+    let next = current;
+    if (current.type === 'Object') {
+        next = transformObject(current, transform, ctx);
+    }
+    else if (current.type === 'List') {
+        next = transformList(current, transform, ctx);
+    }
+    const left = transform.leave ? transform.leave(next, ctx) : undefined;
+    return left ?? next;
+}
+function transformObject(node, transform, ctx) {
+    const entries = new Map();
+    for (const [key, value] of node.entries.entries()) {
+        const childCtx = {
+            path: [...ctx.path, key],
+        };
+        entries.set(key, transformNode(value, transform, childCtx));
+    }
+    return entriesAreSame(node.entries, entries) ? node : { ...node, entries };
+}
+function transformList(node, transform, ctx) {
+    const items = node.items.map((item, index) => transformNode(item, transform, { path: [...ctx.path, `[${index}]`] }));
+    return items === node.items ? node : { ...node, items };
+}
+function entriesAreSame(original, next) {
+    if (original.size !== next.size)
+        return false;
+    for (const [key, value] of original.entries()) {
+        if (!next.has(key))
+            return false;
+        if (next.get(key) !== value)
+            return false;
+    }
+    return true;
+}
+//# sourceMappingURL=transform.js.map

package/dist/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../src/transform.ts"],"names":[],"mappings":"AASA,MAAM,UAAU,iBAAiB,CAC7B,QAA+B,EAC/B,SAAwB;IAExB,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAwB,CAAC;IAC7F,OAAO,EAAE,IAAI,EAAE,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,aAAa,CACzB,IAAmB,EACnB,SAAwB,EACxB,GAAyB;IAEzB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,MAAM,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC;IAEhC,IAAI,IAAI,GAAG,OAAO,CAAC;IACnB,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IACpD,CAAC;SAAM,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACjC,IAAI,GAAG,aAAa,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,OAAO,IAAI,IAAI,IAAI,CAAC;AACxB,CAAC;AAED,SAAS,eAAe,CACpB,IAAyB,EACzB,SAAwB,EACxB,GAAyB;IAEzB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAyB,CAAC;IACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAyB;YACnC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC;SAC3B,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC;AAC/E,CAAC;AAED,SAAS,aAAa,CAClB,IAAuB,EACvB,SAAwB,EACxB,GAAyB;IAEzB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACzC,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC,CACxE,CAAC;IACF,OAAO,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC;AAC5D,CAAC;AAED,SAAS,cAAc,CACnB,QAA4C,EAC5C,IAAwC;IAExC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACjC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,KAAK;YAAE,OAAO,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,123 @@
+import type { AssignmentEvent } from '@altopelago/aeon-aes';
+type Span = AssignmentEvent['span'];
+type Value = AssignmentEvent['value'];
+type AnnotationMap = NonNullable<AssignmentEvent['annotations']>;
+type AnnotationEntry = AnnotationMap extends ReadonlyMap<string, infer T> ? T : {
+    value: Value;
+    datatype?: string;
+};
+export type DiagnosticLevel = 'error' | 'warning';
+export interface Diagnostic {
+    readonly level: DiagnosticLevel;
+    readonly message: string;
+    readonly code?: string;
+    readonly span?: Span;
+    readonly path?: string;
+}
+export interface FinalizedEntry {
+    readonly path: string;
+    readonly value: Value;
+    readonly span: Span;
+    readonly datatype?: string;
+    readonly annotations?: ReadonlyMap<string, AnnotationEntry>;
+}
+export interface FinalizedMap {
+    readonly entries: ReadonlyMap<string, FinalizedEntry>;
+}
+export interface FinalizeOptions {
+    readonly mode?: 'strict' | 'loose';
+    readonly materialization?: 'all' | 'projected';
+    readonly includePaths?: readonly string[];
+    readonly scope?: FinalizeScope;
+    readonly header?: FinalizeHeader;
+    readonly maxMaterializedWeight?: number;
+    readonly maxReferenceDepth?: number;
+}
+export type FinalizeScope = 'full' | 'header' | 'payload';
+export interface FinalizeHeader {
+    readonly fields: ReadonlyMap<string, Value>;
+    readonly span?: Span;
+    readonly form?: 'structured' | 'shorthand';
+}
+export interface FinalizeMeta {
+    readonly errors?: readonly Diagnostic[];
+    readonly warnings?: readonly Diagnostic[];
+}
+export interface FinalizeResult {
+    readonly document: FinalizedMap;
+    readonly meta?: FinalizeMeta;
+}
+export type FinalizeInput = readonly AssignmentEvent[];
+export type JsonPrimitive = null | boolean | number | string;
+export interface JsonObject {
+    [key: string]: JsonValue;
+}
+export type JsonArray = readonly JsonValue[];
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export interface FinalizeJsonResult {
+    readonly document: JsonObject;
+    readonly meta?: FinalizeMeta;
+}
+export type FinalizedNode = FinalizedObjectNode | FinalizedListNode | FinalizedScalarNode | FinalizedReferenceNode;
+export interface FinalizedNodeBase {
+    readonly span: Span;
+    readonly datatype?: string;
+    readonly annotations?: ReadonlyMap<string, AnnotationEntry>;
+}
+export interface FinalizedObjectNode extends FinalizedNodeBase {
+    readonly type: 'Object';
+    readonly entries: ReadonlyMap<string, FinalizedNode>;
+}
+export interface FinalizedListNode extends FinalizedNodeBase {
+    readonly type: 'List';
+    readonly items: readonly FinalizedNode[];
+}
+export interface FinalizedScalarNode extends FinalizedNodeBase {
+    readonly type: 'Null' | 'String' | 'Number' | 'Boolean' | 'Toggle' | 'Hex' | 'Radix' | 'Encoding' | 'Separator' | 'Date' | 'DateTime' | 'Time';
+    readonly value: null | string | number | boolean;
+    readonly raw: string;
+}
+export interface FinalizedReferenceNode extends FinalizedNodeBase {
+    readonly type: 'Reference';
+    readonly kind: 'clone' | 'pointer';
+    readonly path: readonly (string | number | {
+        readonly type: 'attr';
+        readonly key: string;
+    })[];
+    readonly token: string;
+}
+export interface FinalizedNodeDocument {
+    readonly root: FinalizedObjectNode;
+}
+export interface FinalizeNodeResult {
+    readonly document: FinalizedNodeDocument;
+    readonly meta?: FinalizeMeta;
+}
+export interface NodeTransformContext {
+    readonly path: readonly string[];
+}
+export interface NodeTransform {
+    enter?(node: FinalizedNode, ctx: NodeTransformContext): FinalizedNode | void;
+    leave?(node: FinalizedNode, ctx: NodeTransformContext): FinalizedNode | void;
+}
+export interface OutputProfile<TDocument> {
+    readonly id: string;
+    finalize(aes: FinalizeInput, options?: FinalizeOptions): {
+        document: TDocument;
+        meta?: FinalizeMeta;
+    };
+}
+export type OutputProfileRef<TDocument> = string | OutputProfile<TDocument>;
+export interface OutputRegistry {
+    register<TDocument>(profile: OutputProfile<TDocument>): OutputRegistry;
+    get(id: string): OutputProfile<unknown> | undefined;
+    has(id: string): boolean;
+    list(): readonly OutputProfile<unknown>[];
+}
+export interface FinalizeWithProfileOptions<TDocument> {
+    readonly profile: OutputProfileRef<TDocument>;
+    readonly registry?: OutputRegistry;
+    readonly mode?: 'strict' | 'loose';
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,KAAK,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AACpC,KAAK,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;AACtC,KAAK,aAAa,GAAG,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC;AACjE,KAAK,eAAe,GAAG,aAAa,SAAS,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GACnE,CAAC,GACD;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,SAAS,CAAC;AAElD,MAAM,WAAW,UAAU;IACvB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC;IAC/C,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACvC;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE1D,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,GAAG,WAAW,CAAC;CAC9C;AAED,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;CAChC;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,eAAe,EAAE,CAAC;AAEvD,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,UAAU;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,MAAM,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;AAE/D,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;CAChC;AAED,MAAM,MAAM,aAAa,GACnB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,sBAAsB,CAAC;AAE7B,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC1D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC1D,QAAQ,CAAC,IAAI,EACP,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,KAAK,GACL,OAAO,GACP,UAAU,GACV,WAAW,GACX,MAAM,GACN,UAAU,GACV,MAAM,CAAC;IACb,QAAQ,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB;IAC7D,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;IAC9F,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC1B,KAAK,CAAC,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,oBAAoB,GAAG,aAAa,GAAG,IAAI,CAAC;IAC7E,KAAK,CAAC,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,oBAAoB,GAAG,aAAa,GAAG,IAAI,CAAC;CAChF;AAED,MAAM,WAAW,aAAa,CAAC,SAAS;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG;QAAE,QAAQ,EAAE,SAAS,CAAC;QAAC,IAAI,CAAC,EAAE,YAAY,CAAA;KAAE,CAAC;CACzG;AAED,MAAM,MAAM,gBAAgB,CAAC,SAAS,IAAI,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;AAE5E,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;IACvE,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACpD,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,IAAI,IAAI,SAAS,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,0BAA0B,CAAC,SAAS;IACjD,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC9C,QAAQ,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;CACtC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@altopelago/aeon-finalize",
+  "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-aes": "0.9.0"
+  },
+  "devDependencies": {
+    "@altopelago/aeon-parser": "0.9.0",
+    "@altopelago/aeon-lexer": "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"
+  }
+}