@adminiumjs/engine 0.2.2-rc.0 → 0.2.3

package/dist/ir-json-schema.d.ts

@@ -0,0 +1,18 @@
+/** Where the docs site serves this document (`apps/docs/src/pages/schemas/`). */
+export declare const IR_SCHEMA_URL = "https://docs.adminium.dev/schemas/ir-v1.json";
+/**
+ * The schema document, serialized exactly as `ir-v1.schema.json` holds it.
+ *
+ * `io: 'input'` is deliberate: the model defaults nearly everything, and an
+ * author needs to know what they MAY omit. The output schema would mark every
+ * defaulted field required and reject the minimal IR §2.3 promises works.
+ *
+ * `$schema` is added to the root as an allowed property. The generated document
+ * is `additionalProperties: false` throughout (every IR object is a Zod
+ * `strictObject`), so without this the very pointer that makes an editor
+ * validate the file would be the first thing the editor flagged.
+ * `schema-import`'s `parsers/json.ts` strips it on the way in for the same
+ * reason.
+ */
+export declare function irJsonSchemaDocument(): string;
+//# sourceMappingURL=ir-json-schema.d.ts.map

package/dist/ir-json-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir-json-schema.d.ts","sourceRoot":"","sources":["../src/ir-json-schema.ts"],"names":[],"mappings":"AAkBA,iFAAiF;AACjF,eAAO,MAAM,aAAa,iDAAiD,CAAC;AAE5E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CA0C7C"}

package/dist/ir-json-schema.js

@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * The published JSON Schema for the IR — `docs.adminium.dev/schemas/ir-v1.json`.
+ *
+ * The JSON IR guide has told readers to point `$schema` at that URL since the
+ * page was written, and no such document was ever generated: the URL 404'd. A
+ * hand-written one would have drifted from the model within a release, so this
+ * derives it from `databaseModelSchema` — the same schema that validates every
+ * import.
+ *
+ * Lives in `src` rather than in the emitting script because both the script
+ * (via `dist`) and the drift test (via `src`) must produce byte-identical
+ * output; two copies would be the drift the artifact exists to prevent.
+ */
+import { z } from 'zod';
+import { IR_VERSION, databaseModelSchema } from './schema-model.js';
+/** Where the docs site serves this document (`apps/docs/src/pages/schemas/`). */
+export const IR_SCHEMA_URL = 'https://docs.adminium.dev/schemas/ir-v1.json';
+/**
+ * The schema document, serialized exactly as `ir-v1.schema.json` holds it.
+ *
+ * `io: 'input'` is deliberate: the model defaults nearly everything, and an
+ * author needs to know what they MAY omit. The output schema would mark every
+ * defaulted field required and reject the minimal IR §2.3 promises works.
+ *
+ * `$schema` is added to the root as an allowed property. The generated document
+ * is `additionalProperties: false` throughout (every IR object is a Zod
+ * `strictObject`), so without this the very pointer that makes an editor
+ * validate the file would be the first thing the editor flagged.
+ * `schema-import`'s `parsers/json.ts` strips it on the way in for the same
+ * reason.
+ */
+export function irJsonSchemaDocument() {
+    const generated = z.toJSONSchema(databaseModelSchema, { io: 'input' });
+    // `introspectedAt` defaults to `new Date().toISOString()`, so the raw output
+    // embeds the moment of generation and the artifact differs from itself on
+    // every run — a `--check` gate that fails on a clean tree teaches people to
+    // ignore it. The default is not expressible as a constant anyway: it means
+    // "when this was imported", which is what the description now says.
+    const introspectedAt = generated.properties?.introspectedAt;
+    if (introspectedAt !== undefined) {
+        const stable = { ...introspectedAt };
+        delete stable.default;
+        generated.properties.introspectedAt = {
+            ...stable,
+            description: 'ISO 8601. Defaults to the moment of import when omitted.',
+        };
+    }
+    return `${JSON.stringify({
+        $schema: 'https://json-schema.org/draft/2020-12/schema',
+        $id: IR_SCHEMA_URL,
+        title: `Adminium schema IR v${String(IR_VERSION)}`,
+        description: 'The intermediate representation every Adminium schema import converges on. ' +
+            'Generated from packages/engine/src/schema-model.ts — do not edit by hand.',
+        ...generated,
+        properties: {
+            $schema: {
+                type: 'string',
+                description: 'Optional pointer to this schema. Adminium ignores it on import.',
+            },
+            ...generated.properties,
+        },
+    }, null, 2)}\n`;
+}
+//# sourceMappingURL=ir-json-schema.js.map

package/dist/ir-json-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir-json-schema.js","sourceRoot":"","sources":["../src/ir-json-schema.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,iFAAiF;AACjF,MAAM,CAAC,MAAM,aAAa,GAAG,8CAA8C,CAAC;AAE5E;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB;IAClC,MAAM,SAAS,GAAG,CAAC,CAAC,YAAY,CAAC,mBAAmB,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAGpE,CAAC;IAEF,6EAA6E;IAC7E,0EAA0E;IAC1E,4EAA4E;IAC5E,2EAA2E;IAC3E,oEAAoE;IACpE,MAAM,cAAc,GAAG,SAAS,CAAC,UAAU,EAAE,cAEhC,CAAC;IACd,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,EAAE,GAAG,cAAc,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC,OAAO,CAAC;QACrB,SAAS,CAAC,UAAsC,CAAC,cAAc,GAAG;YACjE,GAAG,MAAM;YACT,WAAW,EAAE,0DAA0D;SACxE,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,IAAI,CAAC,SAAS,CACtB;QACE,OAAO,EAAE,8CAA8C;QACvD,GAAG,EAAE,aAAa;QAClB,KAAK,EAAE,uBAAuB,MAAM,CAAC,UAAU,CAAC,EAAE;QAClD,WAAW,EACT,6EAA6E;YAC7E,2EAA2E;QAC7E,GAAG,SAAS;QACZ,UAAU,EAAE;YACV,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iEAAiE;aAC/E;YACD,GAAG,SAAS,CAAC,UAAU;SACxB;KACF,EACD,IAAI,EACJ,CAAC,CACF,IAAI,CAAC;AACR,CAAC"}