@a2ui/web_core 0.8.0 → 0.9.1-alpha.0

package/src/v0_9/schema/verify-schema.test.js

@@ -0,0 +1,174 @@
+/**
+ * Copyright 2026 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { describe, it } from 'node:test';
+import * as assert from 'node:assert';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import { readFileSync } from 'fs';
+import { resolve, join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { A2uiMessageSchema, CreateSurfaceMessageSchema, UpdateComponentsMessageSchema, UpdateDataModelMessageSchema, DeleteSurfaceMessageSchema, } from './server-to-client.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+// `__dirname` will be `dist/src/v0_9/schema` when run via `node --test dist/**/*.test.js`
+const SPEC_DIR_V0_9 = resolve(__dirname, '../../../../../../specification/v0_9/json');
+// Parse both so we can do structural comparison rather than formatting
+// Compare definitions specifically, ignoring descriptions
+function compareDefinitions(zodDefs, jsonDefs) {
+    const diff = {};
+    const keys = new Set([
+        ...Object.keys(zodDefs || {}),
+        ...Object.keys(jsonDefs || {}),
+    ]);
+    for (const key of keys) {
+        if (key === 'A2uiMessage')
+            continue; // Zod wrapper artifact
+        if (!zodDefs[key])
+            diff[key] = { error: 'Missing in Zod schema' };
+        else if (!jsonDefs[key])
+            diff[key] = { error: 'Missing in JSON schema' };
+        else {
+            const defDiff = getObjectDiff(zodDefs[key], jsonDefs[key]);
+            if (Object.keys(defDiff).length > 0) {
+                diff[key] = defDiff;
+            }
+        }
+    }
+    return diff;
+}
+function getObjectDiff(obj1, obj2, path = '') {
+    const diff = {};
+    // Ignore descriptions in strict structural comparison
+    const ignoreKeys = new Set(['description', 'title', '$id', '$schema']);
+    const keys = new Set([
+        ...Object.keys(obj1 || {}),
+        ...Object.keys(obj2 || {}),
+    ]);
+    for (const key of keys) {
+        if (ignoreKeys.has(key))
+            continue;
+        const currentPath = path ? `${path}.${key}` : key;
+        const val1 = obj1 ? obj1[key] : undefined;
+        const val2 = obj2 ? obj2[key] : undefined;
+        // Zod emits `type: "string"` for consts, whereas JSON Schema infers it.
+        if (path.endsWith('version') &&
+            key === 'type' &&
+            val1 === 'string' &&
+            val2 === undefined) {
+            continue;
+        }
+        // Zod doesn't emit additionalProperties: true by default, but it's the default
+        if (currentPath.endsWith('updateDataModel.properties.value.additionalProperties') &&
+            val1 === undefined &&
+            val2 === true) {
+            continue;
+        }
+        // Zod resolves the AnyComponentSchema instead of preserving the $ref because we imported it.
+        // The JSON spec uses a `$ref` to `catalog.json`
+        if (currentPath.includes('components.items')) {
+            continue;
+        }
+        // Zod defines theme as any (no validation), while JSON spec references catalog.json theme schema
+        if (currentPath.includes('theme.$ref') &&
+            val1 === undefined &&
+            val2 === 'catalog.json#/$defs/theme') {
+            continue;
+        }
+        if (typeof val1 === 'object' &&
+            val1 !== null &&
+            typeof val2 === 'object' &&
+            val2 !== null) {
+            if (Array.isArray(val1) && Array.isArray(val2)) {
+                // Sort arrays to ignore order differences (like `required`)
+                const sortedVal1 = [...val1].sort();
+                const sortedVal2 = [...val2].sort();
+                if (JSON.stringify(sortedVal1) !== JSON.stringify(sortedVal2)) {
+                    diff[currentPath] = { zod: val1, json: val2 };
+                }
+            }
+            else {
+                const nestedDiff = getObjectDiff(val1, val2, currentPath);
+                if (Object.keys(nestedDiff).length > 0) {
+                    Object.assign(diff, nestedDiff);
+                }
+            }
+        }
+        else if (val1 !== val2) {
+            diff[currentPath] = { zod: val1, json: val2 };
+        }
+    }
+    return diff;
+}
+function verifySchema(version, zodSchemaSpec, jsonSpecPath, definitionsMap) {
+    console.log(`\nVerifying Zod schema for ${version}...`);
+    // Generate JSON Schema from Zod
+    const jsonSchemaString = JSON.stringify(zodToJsonSchema(zodSchemaSpec, {
+        target: 'jsonSchema2019-09', // Better matches draft 2020-12
+        definitions: definitionsMap || {},
+        name: 'A2uiMessage',
+    }), null, 2);
+    // Load the official schema
+    const officialSchemaString = readFileSync(jsonSpecPath, 'utf-8');
+    // Extract the definitions
+    const generatedSchema = JSON.parse(jsonSchemaString);
+    const officialSchema = JSON.parse(officialSchemaString);
+    if (definitionsMap) {
+        const zodDefs = generatedSchema.$defs || generatedSchema.definitions || {};
+        const jsonDefs = officialSchema.$defs || officialSchema.definitions || {};
+        const diffs = compareDefinitions(zodDefs, jsonDefs);
+        if (Object.keys(diffs).length > 0) {
+            assert.deepStrictEqual(diffs, {}, `Zod schema definitions do not structurally match the ${version} JSON spec.`);
+        }
+    }
+    const rootZodSchema = (generatedSchema.definitions || generatedSchema.$defs || {})['A2uiMessage'] || {};
+    if (officialSchema.oneOf || officialSchema.anyOf) {
+        const zodOneOf = rootZodSchema.anyOf || rootZodSchema.oneOf || [];
+        const normalizedGeneratedOneOf = zodOneOf.map((schema) => {
+            if (schema.$ref && schema.$ref.startsWith('#/definitions/')) {
+                return { $ref: schema.$ref.replace('#/definitions/', '#/$defs/') };
+            }
+            return schema;
+        });
+        const topLevelDiff = getObjectDiff(normalizedGeneratedOneOf, officialSchema.oneOf || officialSchema.anyOf);
+        if (Object.keys(topLevelDiff).length > 0) {
+            assert.deepStrictEqual(topLevelDiff, {}, `Zod schema top-level oneOf does not match the ${version} JSON spec.`);
+        }
+    }
+    else if (officialSchema.properties) {
+        const topLevelDiff = getObjectDiff(rootZodSchema.properties, officialSchema.properties);
+        if (Object.keys(topLevelDiff).length > 0) {
+            assert.deepStrictEqual(topLevelDiff, {}, `Zod schema top-level properties do not match the ${version} JSON spec.`);
+        }
+    }
+    console.log(`Zod schema structurally matches the ${version} JSON spec!`);
+}
+describe('A2UI Schema Verification v0.9', () => {
+    it('verifies v0.9 schema', () => {
+        verifySchema('v0.9', A2uiMessageSchema, join(SPEC_DIR_V0_9, 'server_to_client.json'), {
+            CreateSurfaceMessage: CreateSurfaceMessageSchema,
+            UpdateComponentsMessage: UpdateComponentsMessageSchema,
+            UpdateDataModelMessage: UpdateDataModelMessageSchema,
+            DeleteSurfaceMessage: DeleteSurfaceMessageSchema,
+        });
+    });
+    it('validates A2uiMessage wrapper', () => {
+        const msg = {
+            version: 'v0.9',
+            deleteSurface: { surfaceId: 'surface-1' },
+        };
+        assert.deepStrictEqual(A2uiMessageSchema.parse(msg), msg);
+    });
+});
+//# sourceMappingURL=verify-schema.test.js.map

package/src/v0_9/schema/verify-schema.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify-schema.test.js","sourceRoot":"","sources":["../../../../src/v0_9/schema/verify-schema.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAC,QAAQ,EAAE,EAAE,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAC,YAAY,EAAC,MAAM,IAAI,CAAC;AAChC,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,MAAM,CAAC;AAC5C,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAC;AAClC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAC1B,6BAA6B,EAC7B,4BAA4B,EAC5B,0BAA0B,GAC3B,MAAM,uBAAuB,CAAC;AAE/B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEtC,0FAA0F;AAC1F,MAAM,aAAa,GAAG,OAAO,CAC3B,SAAS,EACT,2CAA2C,CAC5C,CAAC;AAEF,uEAAuE;AACvE,0DAA0D;AAC1D,SAAS,kBAAkB,CAAC,OAAY,EAAE,QAAa;IACrD,MAAM,IAAI,GAAwB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC;QACnB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAC7B,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;KAC/B,CAAC,CAAC;IAEH,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,aAAa;YAAE,SAAS,CAAC,uBAAuB;QAE5D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAC,KAAK,EAAE,uBAAuB,EAAC,CAAC;aAC3D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAC,KAAK,EAAE,wBAAwB,EAAC,CAAC;aAClE,CAAC;YACJ,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3D,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,IAAS,EAAE,IAAS,EAAE,IAAI,GAAG,EAAE;IACpD,MAAM,IAAI,GAAwB,EAAE,CAAC;IAErC,sDAAsD;IACtD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;IAEvE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC;QACnB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC1B,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;KAC3B,CAAC,CAAC;IAEH,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,SAAS;QAElC,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1C,wEAAwE;QACxE,IACE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YACxB,GAAG,KAAK,MAAM;YACd,IAAI,KAAK,QAAQ;YACjB,IAAI,KAAK,SAAS,EAClB,CAAC;YACD,SAAS;QACX,CAAC;QAED,+EAA+E;QAC/E,IACE,WAAW,CAAC,QAAQ,CAClB,uDAAuD,CACxD;YACD,IAAI,KAAK,SAAS;YAClB,IAAI,KAAK,IAAI,EACb,CAAC;YACD,SAAS;QACX,CAAC;QAED,6FAA6F;QAC7F,gDAAgD;QAChD,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC7C,SAAS;QACX,CAAC;QAED,iGAAiG;QACjG,IACE,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;YAClC,IAAI,KAAK,SAAS;YAClB,IAAI,KAAK,2BAA2B,EACpC,CAAC;YACD,SAAS;QACX,CAAC;QAED,IACE,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI;YACb,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI,EACb,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,4DAA4D;gBAC5D,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;gBACpC,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;gBACpC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9D,IAAI,CAAC,WAAW,CAAC,GAAG,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;gBAC1D,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACvC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,GAAG,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CACnB,OAAe,EACf,aAAkB,EAClB,YAAoB,EACpB,cAAoC;IAEpC,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,KAAK,CAAC,CAAC;IACxD,gCAAgC;IAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CACrC,eAAe,CAAC,aAAa,EAAE;QAC7B,MAAM,EAAE,mBAAmB,EAAE,+BAA+B;QAC5D,WAAW,EAAE,cAAc,IAAI,EAAE;QACjC,IAAI,EAAE,aAAa;KACpB,CAAC,EACF,IAAI,EACJ,CAAC,CACF,CAAC;IAEF,2BAA2B;IAC3B,MAAM,oBAAoB,GAAG,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAEjE,0BAA0B;IAC1B,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACrD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAExD,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,IAAI,eAAe,CAAC,WAAW,IAAI,EAAE,CAAC;QAC3E,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,IAAI,cAAc,CAAC,WAAW,IAAI,EAAE,CAAC;QAE1E,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,CAAC,eAAe,CACpB,KAAK,EACL,EAAE,EACF,wDAAwD,OAAO,aAAa,CAC7E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GACjB,CAAC,eAAe,CAAC,WAAW,IAAI,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC,CAC1D,aAAa,CACd,IAAI,EAAE,CAAC;IAEV,IAAI,cAAc,CAAC,KAAK,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;QAClE,MAAM,wBAAwB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;YAC5D,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC5D,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAAC,CAAC;YACnE,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,aAAa,CAChC,wBAAwB,EACxB,cAAc,CAAC,KAAK,IAAI,cAAc,CAAC,KAAK,CAC7C,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,eAAe,CACpB,YAAY,EACZ,EAAE,EACF,iDAAiD,OAAO,aAAa,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,cAAc,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,YAAY,GAAG,aAAa,CAChC,aAAa,CAAC,UAAU,EACxB,cAAc,CAAC,UAAU,CAC1B,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,eAAe,CACpB,YAAY,EACZ,EAAE,EACF,oDAAoD,OAAO,aAAa,CACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,uCAAuC,OAAO,aAAa,CAAC,CAAC;AAC3E,CAAC;AAED,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,YAAY,CACV,MAAM,EACN,iBAAiB,EACjB,IAAI,CAAC,aAAa,EAAE,uBAAuB,CAAC,EAC5C;YACE,oBAAoB,EAAE,0BAA0B;YAChD,uBAAuB,EAAE,6BAA6B;YACtD,sBAAsB,EAAE,4BAA4B;YACpD,oBAAoB,EAAE,0BAA0B;SACjD,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,GAAG,GAAG;YACV,OAAO,EAAE,MAAM;YACf,aAAa,EAAE,EAAC,SAAS,EAAE,WAAW,EAAC;SACxC,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}