@object-ui/sdui-parser 16.1.0 → 17.2.0

package/dist/index.d.ts

@@ -10,12 +10,12 @@ export { parseJsx, interpretBrace } from './parse.js';
 export { validateTree } from './validate.js';
 export { generateDts, propsName, generateBlockList } from './codegen.js';
 export type { CodegenOptions } from './codegen.js';
-import type { Diagnostic, Manifest, SchemaElement, ValidationResult } from './types.js';
+import type { Diagnostic, Manifest, SchemaElement, ManifestValidationResult } from './types.js';
 export interface CompileResult {
     tree: SchemaElement | null;
     diagnostics: Diagnostic[];
     requires: string[];
-    bindings: ValidationResult['bindings'];
+    bindings: ManifestValidationResult['bindings'];
     /** true when there are no error-severity diagnostics — the save gate's pass/fail */
     ok: boolean;
 }
@@ -43,7 +43,46 @@ export interface RegistryConfigLike {
         binding?: 'object' | 'field';
         description?: string;
     }>;
+    /**
+     * True when the registry entry is a pending lazy stub — registered, but its
+     * plugin module has not been imported, so it carries metadata and no
+     * `inputs`. See {@link assertFullyLoaded}.
+     */
+    lazy?: boolean;
 }
+/**
+ * Build-time guard for the manifest generators.
+ *
+ * A manifest is the contract's frozen form: the parser's tag whitelist and the
+ * save gate's prop validator both read it. So it has to be generated from
+ * FULLY LOADED registrations. A `lazy: true` entry means the generator never
+ * imported that plugin, and the block would be written out with empty
+ * `inputs` — indistinguishable from a block that legitimately takes no props,
+ * which turns every prop an author writes on it into an `unknown-prop`
+ * diagnostic. Wrong quietly, in the artifact everything downstream trusts.
+ *
+ * The generators keep their own eager import list, so this is what catches it
+ * drifting behind the app's registration list (objectui#2953 was the same
+ * class of bug one layer down).
+ */
+export declare function assertFullyLoaded(configs: RegistryConfigLike[]): void;
+/**
+ * Project registry configs into the SDUI manifest.
+ *
+ * ⚠️ Every field here is copied from what the registration **declared**. In
+ * particular `inputs` is `config.inputs` verbatim — this function does not, and
+ * cannot, observe whether the renderer behind the block reads any of them.
+ *
+ * Worth stating because of what consumes the output. The framework's
+ * `check:react-blocks-declaration-parity` diffs this against the spec's zod
+ * schemas, and while that check was named `check:react-conformance` it was read
+ * — by its own file header — as confirming the components "ACTUALLY implement"
+ * the spec's props. It never could: both sides of that diff are declarations,
+ * and this is the side this file produces. Four blocks published an `objectName`
+ * no renderer read and sailed through it green (objectstack#4413; corrected in
+ * objectstack#4472). Evidence about the render path has to come from the render
+ * path — see `apps/console/src/__tests__/public-block-binding-reach.test.tsx`.
+ */
 export declare function manifestFromConfigs(configs: RegistryConfigLike[], opts?: {
     only?: Set<string>;
     publicOnly?: boolean;

package/dist/index.js

@@ -28,6 +28,30 @@ export function compile(source, manifest) {
         ok: !diagnostics.some((d) => d.severity === 'error'),
     };
 }
+/**
+ * Build-time guard for the manifest generators.
+ *
+ * A manifest is the contract's frozen form: the parser's tag whitelist and the
+ * save gate's prop validator both read it. So it has to be generated from
+ * FULLY LOADED registrations. A `lazy: true` entry means the generator never
+ * imported that plugin, and the block would be written out with empty
+ * `inputs` — indistinguishable from a block that legitimately takes no props,
+ * which turns every prop an author writes on it into an `unknown-prop`
+ * diagnostic. Wrong quietly, in the artifact everything downstream trusts.
+ *
+ * The generators keep their own eager import list, so this is what catches it
+ * drifting behind the app's registration list (objectui#2953 was the same
+ * class of bug one layer down).
+ */
+export function assertFullyLoaded(configs) {
+    const stubs = configs.filter((c) => c.lazy).map((c) => c.type).sort();
+    if (stubs.length === 0)
+        return;
+    throw new Error(`Manifest generation saw ${stubs.length} not-yet-loaded lazy block(s): ${stubs.join(', ')}.\n` +
+        `A manifest must describe loaded registrations — these would be written out with no \`inputs\`, ` +
+        `so every prop an author passes them would be reported as unknown.\n` +
+        `Add an eager \`import\` of each block's plugin to the generator entry.`);
+}
 const INPUT_TYPES = new Set([
     'string',
     'number',
@@ -41,6 +65,23 @@ const INPUT_TYPES = new Set([
     'file',
     'slot',
 ]);
+/**
+ * Project registry configs into the SDUI manifest.
+ *
+ * ⚠️ Every field here is copied from what the registration **declared**. In
+ * particular `inputs` is `config.inputs` verbatim — this function does not, and
+ * cannot, observe whether the renderer behind the block reads any of them.
+ *
+ * Worth stating because of what consumes the output. The framework's
+ * `check:react-blocks-declaration-parity` diffs this against the spec's zod
+ * schemas, and while that check was named `check:react-conformance` it was read
+ * — by its own file header — as confirming the components "ACTUALLY implement"
+ * the spec's props. It never could: both sides of that diff are declarations,
+ * and this is the side this file produces. Four blocks published an `objectName`
+ * no renderer read and sailed through it green (objectstack#4413; corrected in
+ * objectstack#4472). Evidence about the render path has to come from the render
+ * path — see `apps/console/src/__tests__/public-block-binding-reach.test.tsx`.
+ */
 export function manifestFromConfigs(configs, opts = {}) {
     const components = {};
     for (const c of configs) {

package/dist/types.d.ts

@@ -61,8 +61,23 @@ export interface Manifest {
     /** keyed by component `type` */
     components: Record<string, ManifestComponent>;
 }
-/** Result of validating a compiled tree against the manifest. */
-export interface ValidationResult {
+/**
+ * Result of validating a compiled tree against the MANIFEST.
+ *
+ * Named `ManifestValidationResult`, not `ValidationResult` (objectui#3161,
+ * objectstack#4115 ledger batch 7), following the convention registered on
+ * objectstack#4115 for this name: **`<what was validated>Validation<Error |
+ * Result>`**. `ValidationResult` is exported twice by the spec — `kernel` and
+ * `contracts`, both `{ valid, errors?: [{ field, message, code? }], warnings? }`
+ * for PLUGIN MANIFEST validation — and `@object-ui/core` took
+ * `SchemaNodeValidationResult` under the same convention in batch 4
+ * (objectui#3188). Three results, three subjects: a plugin, a schema node, and
+ * this one, which carries no `valid` flag at all — it returns `diagnostics`
+ * (severity lives per entry), the `requires` set the compiled page needs, and
+ * the binding sites the server must resolve. Nothing here is assignable to
+ * anything there in either direction.
+ */
+export interface ManifestValidationResult {
     diagnostics: Diagnostic[];
     /** unique plugin namespaces referenced — the page's `requires` */
     requires: string[];

package/dist/validate.d.ts

@@ -6,5 +6,5 @@
  * and binding sites the SERVER must resolve against object schema (we cannot
  * resolve objects/fields here — that check is framework-side by design).
  */
-import type { Manifest, SchemaElement, ValidationResult } from './types.js';
-export declare function validateTree(tree: SchemaElement | null, manifest: Manifest): ValidationResult;
+import type { Manifest, SchemaElement, ManifestValidationResult } from './types.js';
+export declare function validateTree(tree: SchemaElement | null, manifest: Manifest): ManifestValidationResult;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/sdui-parser",
-  "version": "16.1.0",
+  "version": "17.2.0",
   "type": "module",
   "sideEffects": false,
   "license": "MIT",
@@ -24,11 +24,15 @@
   "files": [
     "dist"
   ],
-  "devDependencies": {},
+  "devDependencies": {
+    "@objectstack/spec": "^17.0.0-rc.1",
+    "@object-ui/core": "17.2.0",
+    "@object-ui/react": "17.2.0"
+  },
   "scripts": {
     "build": "tsc",
     "test": "vitest run",
-    "type-check": "tsc --noEmit",
+    "type-check": "tsc --noEmit && tsc -p tsconfig.test.json",
     "lint": "eslint ."
   }
 }