@gunkin/uiify 0.0.26-alpha → 0.0.27-alpha

package/dist/ai/types.d.ts

@@ -0,0 +1,33 @@
+import type { ComponentType } from "react";
+import type { UiNode, UiType } from "./catalog.generated.js";
+/** A stored UI document: a version and one root node. */
+export interface UiDocumentData {
+    readonly version: 1;
+    readonly root: UiNode;
+}
+/** One problem found in a document, written so a person or a model can repair it. */
+export interface UiValidationIssue {
+    /** JSON Pointer into the validated value, e.g. `/root/children/0/props/variant`. */
+    readonly path: string;
+    /** Readable location, e.g. `form › Field.Root › Button.props.variant`. */
+    readonly breadcrumb: string;
+    readonly message: string;
+    /** The values that would have been accepted, when the problem is a closed set. */
+    readonly allowed?: readonly unknown[];
+}
+/** Thrown when a document is invalid; carries the same issues `validateDocument` returns. */
+export declare class UiDocumentError extends Error {
+    readonly issues: readonly UiValidationIssue[];
+    constructor(issues: readonly UiValidationIssue[]);
+}
+/** A validated document with the component of every part type it uses, ready to render. */
+export interface LoadedDocument {
+    readonly root: UiNode;
+    /** Component and layout parts by type; native types render as their own tag. */
+    readonly components: ReadonlyMap<UiType, ComponentType<any>>;
+}
+export interface UiDocumentProps {
+    /** Untrusted document data: `{ version: 1, root }` or a bare node. */
+    readonly node: unknown;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/ai/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ai/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAE7D,yDAAyD;AACzD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,qFAAqF;AACrF,MAAM,WAAW,iBAAiB;IAChC,oFAAoF;IACpF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0EAA0E;IAC1E,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,kFAAkF;IAClF,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;CACvC;AAED,6FAA6F;AAC7F,qBAAa,eAAgB,SAAQ,KAAK;IACxC,QAAQ,CAAC,MAAM,EAAE,SAAS,iBAAiB,EAAE,CAAC;gBAElC,MAAM,EAAE,SAAS,iBAAiB,EAAE;CAOjD;AAED,2FAA2F;AAC3F,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gFAAgF;IAEhF,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,eAAe;IAC9B,sEAAsE;IACtE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB"}

package/dist/ai/types.js

@@ -0,0 +1,14 @@
+class UiDocumentError extends Error {
+  issues;
+  constructor(issues) {
+    const shown = issues.slice(0, 10).map((issue) => `- ${issue.breadcrumb}: ${issue.message}`);
+    const more = issues.length > shown.length ? [`- and ${issues.length - shown.length} more`] : [];
+    super(["Invalid UI document:", ...shown, ...more].join("\n"));
+    this.name = "UiDocumentError";
+    this.issues = issues;
+  }
+}
+export {
+  UiDocumentError
+};
+//# sourceMappingURL=types.js.map

package/dist/ai/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/ai/types.ts"],"sourcesContent":["import type { ComponentType } from \"react\";\nimport type { UiNode, UiType } from \"./catalog.generated.js\";\n\n/** A stored UI document: a version and one root node. */\nexport interface UiDocumentData {\n  readonly version: 1;\n  readonly root: UiNode;\n}\n\n/** One problem found in a document, written so a person or a model can repair it. */\nexport interface UiValidationIssue {\n  /** JSON Pointer into the validated value, e.g. `/root/children/0/props/variant`. */\n  readonly path: string;\n  /** Readable location, e.g. `form › Field.Root › Button.props.variant`. */\n  readonly breadcrumb: string;\n  readonly message: string;\n  /** The values that would have been accepted, when the problem is a closed set. */\n  readonly allowed?: readonly unknown[];\n}\n\n/** Thrown when a document is invalid; carries the same issues `validateDocument` returns. */\nexport class UiDocumentError extends Error {\n  readonly issues: readonly UiValidationIssue[];\n\n  constructor(issues: readonly UiValidationIssue[]) {\n    const shown = issues.slice(0, 10).map((issue) => `- ${issue.breadcrumb}: ${issue.message}`);\n    const more = issues.length > shown.length ? [`- and ${issues.length - shown.length} more`] : [];\n    super([\"Invalid UI document:\", ...shown, ...more].join(\"\\n\"));\n    this.name = \"UiDocumentError\";\n    this.issues = issues;\n  }\n}\n\n/** A validated document with the component of every part type it uses, ready to render. */\nexport interface LoadedDocument {\n  readonly root: UiNode;\n  /** Component and layout parts by type; native types render as their own tag. */\n  // oxlint-disable-next-line typescript/no-explicit-any -- each part takes its own props\n  readonly components: ReadonlyMap<UiType, ComponentType<any>>;\n}\n\nexport interface UiDocumentProps {\n  /** Untrusted document data: `{ version: 1, root }` or a bare node. */\n  readonly node: unknown;\n}\n"],"mappings":"AAqBO,MAAM,wBAAwB,MAAM;AAAA,EAChC;AAAA,EAET,YAAY,QAAsC;AAChD,UAAM,QAAQ,OAAO,MAAM,GAAG,EAAE,EAAE,IAAI,CAAC,UAAU,KAAK,MAAM,UAAU,KAAK,MAAM,OAAO,EAAE;AAC1F,UAAM,OAAO,OAAO,SAAS,MAAM,SAAS,CAAC,SAAS,OAAO,SAAS,MAAM,MAAM,OAAO,IAAI,CAAC;AAC9F,UAAM,CAAC,wBAAwB,GAAG,OAAO,GAAG,IAAI,EAAE,KAAK,IAAI,CAAC;AAC5D,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;","names":[]}

package/dist/ai/validate.d.ts

@@ -0,0 +1,15 @@
+import type { UiDocumentData, UiValidationIssue } from "./types.js";
+export type UiValidationResult = {
+    readonly ok: true;
+    readonly document: UiDocumentData;
+} | {
+    readonly ok: false;
+    readonly issues: readonly UiValidationIssue[];
+};
+/**
+ * Validates untrusted data as a UI document: `{ version: 1, root }`, or a bare node, which is
+ * wrapped. Stages run in order and stop at the first that fails: limits, version, schema, rules.
+ * Nothing in the value is evaluated or modified.
+ */
+export declare function validateDocument(value: unknown): UiValidationResult;
+//# sourceMappingURL=validate.d.ts.map

package/dist/ai/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/ai/validate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpE,MAAM,MAAM,kBAAkB,GAC1B;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;CAAE,GACxD;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,iBAAiB,EAAE,CAAA;CAAE,CAAC;AAM1E;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB,CA+BnE"}

package/dist/ai/validate.js

@@ -0,0 +1,32 @@
+import { toIssues } from "./issues.js";
+import { checkLimits } from "./limits.js";
+import { checkRules } from "./rules.js";
+import { validateSchema } from "./validator.generated.js";
+function fail(issues) {
+  return { ok: false, issues };
+}
+function validateDocument(value) {
+  const limitIssues = checkLimits(value);
+  if (limitIssues.length > 0) return fail(limitIssues);
+  const isObject = typeof value === "object" && value !== null && !Array.isArray(value);
+  const bare = isObject && Object.hasOwn(value, "type");
+  if (isObject && !bare && Object.hasOwn(value, "version") && value.version !== 1) {
+    const version = value.version;
+    return fail([
+      {
+        path: "/version",
+        breadcrumb: "version",
+        message: `unsupported version ${typeof version === "string" ? JSON.stringify(version) : String(JSON.stringify(version))}; this validator reads version 1`,
+        allowed: [1]
+      }
+    ]);
+  }
+  if (!validateSchema(value)) return fail(toIssues(validateSchema.errors, value));
+  const document = bare ? { version: 1, root: value } : value;
+  const ruleIssues = checkRules(document.root, bare ? "" : "/root");
+  return ruleIssues.length > 0 ? fail(ruleIssues) : { ok: true, document };
+}
+export {
+  validateDocument
+};
+//# sourceMappingURL=validate.js.map

package/dist/ai/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/ai/validate.ts"],"sourcesContent":["import type { UiNode } from \"./catalog.generated.js\";\nimport { toIssues } from \"./issues.js\";\nimport { checkLimits } from \"./limits.js\";\nimport { checkRules } from \"./rules.js\";\nimport type { UiDocumentData, UiValidationIssue } from \"./types.js\";\nimport { validateSchema } from \"./validator.generated.js\";\n\nexport type UiValidationResult =\n  | { readonly ok: true; readonly document: UiDocumentData }\n  | { readonly ok: false; readonly issues: readonly UiValidationIssue[] };\n\nfunction fail(issues: readonly UiValidationIssue[]): UiValidationResult {\n  return { ok: false, issues };\n}\n\n/**\n * Validates untrusted data as a UI document: `{ version: 1, root }`, or a bare node, which is\n * wrapped. Stages run in order and stop at the first that fails: limits, version, schema, rules.\n * Nothing in the value is evaluated or modified.\n */\nexport function validateDocument(value: unknown): UiValidationResult {\n  const limitIssues = checkLimits(value);\n  if (limitIssues.length > 0) return fail(limitIssues);\n\n  const isObject = typeof value === \"object\" && value !== null && !Array.isArray(value);\n  const bare = isObject && Object.hasOwn(value, \"type\");\n\n  if (\n    isObject &&\n    !bare &&\n    Object.hasOwn(value, \"version\") &&\n    (value as { version: unknown }).version !== 1\n  ) {\n    const version = (value as { version: unknown }).version;\n    return fail([\n      {\n        path: \"/version\",\n        breadcrumb: \"version\",\n        message: `unsupported version ${typeof version === \"string\" ? JSON.stringify(version) : String(JSON.stringify(version))}; this validator reads version 1`,\n        allowed: [1],\n      },\n    ]);\n  }\n\n  if (!validateSchema(value)) return fail(toIssues(validateSchema.errors, value));\n\n  const document: UiDocumentData = bare\n    ? { version: 1, root: value as UiNode }\n    : (value as UiDocumentData);\n  const ruleIssues = checkRules(document.root, bare ? \"\" : \"/root\");\n  return ruleIssues.length > 0 ? fail(ruleIssues) : { ok: true, document };\n}\n"],"mappings":"AACA,SAAS,gBAAgB;AACzB,SAAS,mBAAmB;AAC5B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAM/B,SAAS,KAAK,QAA0D;AACtE,SAAO,EAAE,IAAI,OAAO,OAAO;AAC7B;AAOO,SAAS,iBAAiB,OAAoC;AACnE,QAAM,cAAc,YAAY,KAAK;AACrC,MAAI,YAAY,SAAS,EAAG,QAAO,KAAK,WAAW;AAEnD,QAAM,WAAW,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AACpF,QAAM,OAAO,YAAY,OAAO,OAAO,OAAO,MAAM;AAEpD,MACE,YACA,CAAC,QACD,OAAO,OAAO,OAAO,SAAS,KAC7B,MAA+B,YAAY,GAC5C;AACA,UAAM,UAAW,MAA+B;AAChD,WAAO,KAAK;AAAA,MACV;AAAA,QACE,MAAM;AAAA,QACN,YAAY;AAAA,QACZ,SAAS,uBAAuB,OAAO,YAAY,WAAW,KAAK,UAAU,OAAO,IAAI,OAAO,KAAK,UAAU,OAAO,CAAC,CAAC;AAAA,QACvH,SAAS,CAAC,CAAC;AAAA,MACb;AAAA,IACF,CAAC;AAAA,EACH;AAEA,MAAI,CAAC,eAAe,KAAK,EAAG,QAAO,KAAK,SAAS,eAAe,QAAQ,KAAK,CAAC;AAE9E,QAAM,WAA2B,OAC7B,EAAE,SAAS,GAAG,MAAM,MAAgB,IACnC;AACL,QAAM,aAAa,WAAW,SAAS,MAAM,OAAO,KAAK,OAAO;AAChE,SAAO,WAAW,SAAS,IAAI,KAAK,UAAU,IAAI,EAAE,IAAI,MAAM,SAAS;AACzE;","names":[]}

package/dist/ai/validator.generated.d.ts

@@ -0,0 +1,13 @@
+/** One schema error, as Ajv reports it. */
+export interface AjvError {
+    readonly keyword: string;
+    readonly instancePath: string;
+    readonly schemaPath: string;
+    readonly params: Readonly<Record<string, unknown>>;
+    readonly propertyName?: string;
+    readonly message?: string;
+}
+export declare const validateSchema: ((value: unknown) => boolean) & {
+    errors?: AjvError[] | null;
+};
+//# sourceMappingURL=validator.generated.d.ts.map

package/dist/ai/validator.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.generated.d.ts","sourceRoot":"","sources":["../../src/ai/validator.generated.ts"],"names":[],"mappings":"AAKA,2CAA2C;AAC3C,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;CAC7E,CAAC"}