@microsoft/fast-html 1.0.0-alpha.4 → 1.0.0-alpha.40

package/dist/esm/components/schema.spec.js

@@ -0,0 +1,484 @@
+import { expect, test } from "@playwright/test";
+import { refPropertyName, Schema } from "./schema.js";
+test.describe("Schema", async () => {
+    test("should instantiate with a custom element name without throwing", async () => {
+        expect(() => new Schema("my-custom-element")).not.toThrow();
+    });
+    test("should return null when a JSON schema is requested but none exists for that property name", async () => {
+        const schema = new Schema("my-custom-element");
+        expect(schema.getSchema("foo")).toEqual(null);
+    });
+    test("should be able to return a JSON schema after adding a path", async () => {
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).not.toBe(null);
+        expect(schemaA.$id).toEqual("https://fast.design/schemas/my-custom-element/a.json");
+        expect(schemaA.$schema).toEqual("https://json-schema.org/draft/2019-09/schema");
+    });
+    test("should add a property and cast the schema as type object if a nested path is given", async () => {
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        let schemaA = schema.getSchema("a");
+        expect(schemaA.properties).toBeDefined();
+        expect(schemaA.properties).toHaveProperty("b");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b.c",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schemaA = schema.getSchema("a");
+        expect(schemaA.properties).toBeDefined();
+        expect(schemaA.properties).toHaveProperty("b");
+        expect(schemaA.properties.b.properties).toBeDefined();
+        expect(schemaA.properties.b.properties).toHaveProperty("c");
+    });
+    test("should add a new context in a schema", async () => {
+        var _a, _b, _c;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "items",
+            pathConfig: {
+                type: "repeat",
+                path: "items",
+                currentContext: "item",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("items");
+        expect(schemaA).toBeDefined();
+        expect(schemaA.$ref).toBeDefined();
+        expect(schemaA.$ref).toEqual("#/$defs/item");
+        expect(schemaA.type).toEqual("array");
+        expect((_a = schemaA.$defs) === null || _a === void 0 ? void 0 : _a["item"]).toBeDefined();
+        expect((_b = schemaA.$defs) === null || _b === void 0 ? void 0 : _b["item"].$fast_context).toEqual("items");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["item"].$fast_parent_contexts).toEqual([null]);
+    });
+    test("should add an object to a context in a schema", async () => {
+        var _a, _b, _c, _d, _e, _f;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "items",
+            pathConfig: {
+                type: "repeat",
+                path: "items",
+                currentContext: "item",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "items",
+            pathConfig: {
+                type: "default",
+                path: "item.a.b",
+                currentContext: "item",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("items");
+        expect(schemaA).toBeDefined();
+        expect(schemaA.$ref).toBeDefined();
+        expect(schemaA.$ref).toEqual("#/$defs/item");
+        expect(schemaA.type).toEqual("array");
+        expect((_a = schemaA.$defs) === null || _a === void 0 ? void 0 : _a["item"]).toBeDefined();
+        expect((_b = schemaA.$defs) === null || _b === void 0 ? void 0 : _b["item"].$fast_context).toEqual("items");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["item"].$fast_parent_contexts).toEqual([null]);
+        expect((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["item"].properties).toBeDefined();
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["item"].properties["a"]).toBeDefined();
+        expect((_f = schemaA.$defs) === null || _f === void 0 ? void 0 : _f["item"].properties["a"].type).toEqual("object");
+    });
+    test("should add a nested context in a schema", async () => {
+        var _a, _b, _c, _d, _e;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "a.items",
+                currentContext: "item",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).toBeDefined();
+        expect((_a = schemaA === null || schemaA === void 0 ? void 0 : schemaA.properties) === null || _a === void 0 ? void 0 : _a["items"]).toBeDefined();
+        expect((_b = schemaA === null || schemaA === void 0 ? void 0 : schemaA.properties) === null || _b === void 0 ? void 0 : _b["items"].items.$ref).toEqual("#/$defs/item");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["item"]).toBeDefined();
+        expect((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["item"].$fast_context).toEqual("items");
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["item"].$fast_parent_contexts).toEqual([null]);
+    });
+    test("should define an object as a nested context in a schema", async () => {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "a.items",
+                currentContext: "item",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "access",
+                path: "item.b",
+                currentContext: "item",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).toBeDefined();
+        expect((_a = schemaA.$defs) === null || _a === void 0 ? void 0 : _a["item"]).toBeDefined();
+        expect((_b = schemaA.$defs) === null || _b === void 0 ? void 0 : _b["item"].$fast_context).toEqual("items");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["item"].$fast_parent_contexts).toEqual([null]);
+        expect((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["item"].type).toEqual("object");
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["item"].properties).toBeDefined();
+        expect((_g = (_f = schemaA.$defs) === null || _f === void 0 ? void 0 : _f["item"].properties) === null || _g === void 0 ? void 0 : _g["b"]).toBeDefined();
+    });
+    test("should define nested contexts in a schema", async () => {
+        var _a, _b, _c, _d, _e, _f;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "a.users",
+                currentContext: "user",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "user.posts",
+                currentContext: "post",
+                parentContext: "user"
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).toBeDefined();
+        expect((_a = schemaA.$defs) === null || _a === void 0 ? void 0 : _a["user"]).toBeDefined();
+        expect((_b = schemaA.$defs) === null || _b === void 0 ? void 0 : _b["user"].$fast_context).toEqual("users");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["user"].$fast_parent_contexts).toEqual([null]);
+        expect((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["post"]).toBeDefined();
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["post"].$fast_context).toEqual("posts");
+        expect((_f = schemaA.$defs) === null || _f === void 0 ? void 0 : _f["post"].$fast_parent_contexts).toEqual([null, "user"]);
+    });
+    test("should define nested contexts with objects in a schema", async () => {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "a.users",
+                currentContext: "user",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "access",
+                path: "user.a.b",
+                currentContext: "user",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "user.posts",
+                currentContext: "post",
+                parentContext: "user"
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "access",
+                path: "post.c.d",
+                currentContext: "post",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "post.meta.tags",
+                currentContext: "tag",
+                parentContext: "post"
+            },
+            childrenMap: null,
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).toBeDefined();
+        expect((_a = schemaA.$defs) === null || _a === void 0 ? void 0 : _a["user"]).toBeDefined();
+        expect((_b = schemaA.$defs) === null || _b === void 0 ? void 0 : _b["user"].$fast_context).toEqual("users");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["user"].$fast_parent_contexts).toEqual([null]);
+        expect((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["user"].type).toEqual("object");
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["user"].properties).toBeDefined();
+        expect((_f = schemaA.$defs) === null || _f === void 0 ? void 0 : _f["user"].properties["a"]).toBeDefined();
+        expect((_g = schemaA.$defs) === null || _g === void 0 ? void 0 : _g["user"].properties["a"].properties["b"]).toBeDefined();
+        expect((_h = schemaA.$defs) === null || _h === void 0 ? void 0 : _h["post"]).toBeDefined();
+        expect((_j = schemaA.$defs) === null || _j === void 0 ? void 0 : _j["post"].$fast_context).toEqual("posts");
+        expect((_k = schemaA.$defs) === null || _k === void 0 ? void 0 : _k["post"].$fast_parent_contexts).toEqual([null, "user"]);
+        expect((_l = schemaA.$defs) === null || _l === void 0 ? void 0 : _l["post"].type).toEqual("object");
+        expect((_m = schemaA.$defs) === null || _m === void 0 ? void 0 : _m["post"].properties).toBeDefined();
+        expect((_o = schemaA.$defs) === null || _o === void 0 ? void 0 : _o["post"].properties["c"]).toBeDefined();
+        expect((_p = schemaA.$defs) === null || _p === void 0 ? void 0 : _p["post"].properties["c"].properties["d"]).toBeDefined();
+        expect((_q = schemaA.$defs) === null || _q === void 0 ? void 0 : _q["post"].properties["meta"]).toBeDefined();
+        expect((_r = schemaA.$defs) === null || _r === void 0 ? void 0 : _r["post"].properties["meta"].properties["tags"]).toBeDefined();
+        expect((_s = schemaA.$defs) === null || _s === void 0 ? void 0 : _s["post"].properties["meta"].properties["tags"].items).toBeDefined();
+        expect((_t = schemaA.$defs) === null || _t === void 0 ? void 0 : _t["post"].properties["meta"].properties["tags"].items.$ref).toEqual("#/$defs/tag");
+        expect((_u = schemaA.$defs) === null || _u === void 0 ? void 0 : _u["tag"]).toBeDefined();
+        expect((_v = schemaA.$defs) === null || _v === void 0 ? void 0 : _v["tag"].$fast_context).toEqual("tags");
+        expect((_w = schemaA.$defs) === null || _w === void 0 ? void 0 : _w["tag"].$fast_parent_contexts).toEqual([null, "user", "post"]);
+    });
+    test("should define an anyOf with a $ref to another schema", async () => {
+        var _a;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-2",
+                attributeName: "b",
+            },
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).not.toBe(null);
+        expect(schemaA.$id).toEqual("https://fast.design/schemas/my-custom-element/a.json");
+        expect(schemaA.$schema).toEqual("https://json-schema.org/draft/2019-09/schema");
+        expect(schemaA.anyOf).not.toBeUndefined();
+        expect(schemaA.anyOf).toHaveLength(1);
+        expect((_a = schemaA.anyOf) === null || _a === void 0 ? void 0 : _a[0].$ref).toEqual("https://fast.design/schemas/my-custom-element-2/b.json");
+    });
+    test("should define an anyOf with a $ref to multiple schemas", async () => {
+        var _a, _b;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-2",
+                attributeName: "b",
+            },
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-3",
+                attributeName: "c",
+            },
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).not.toBe(null);
+        expect(schemaA.$id).toEqual("https://fast.design/schemas/my-custom-element/a.json");
+        expect(schemaA.$schema).toEqual("https://json-schema.org/draft/2019-09/schema");
+        expect(schemaA.anyOf).not.toBeUndefined();
+        expect(schemaA.anyOf).toHaveLength(2);
+        expect((_a = schemaA.anyOf) === null || _a === void 0 ? void 0 : _a[0].$ref).toEqual("https://fast.design/schemas/my-custom-element-2/b.json");
+        expect((_b = schemaA.anyOf) === null || _b === void 0 ? void 0 : _b[1].$ref).toEqual("https://fast.design/schemas/my-custom-element-3/c.json");
+    });
+    test("should define an anyOf with a $ref to another schema in a nested object", async () => {
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        let schemaA = schema.getSchema("a");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b.c",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-2",
+                attributeName: "test"
+            },
+        });
+        schemaA = schema.getSchema("a");
+        expect(schemaA.properties.b.properties.c).toBeDefined();
+        expect(schemaA.properties.b.properties.c.anyOf).not.toBeUndefined();
+        expect(schemaA.properties.b.properties.c.anyOf[0].$ref).toEqual("https://fast.design/schemas/my-custom-element-2/test.json");
+    });
+    test("should define an anyOf with a $ref to multiple schemas in a nested object", async () => {
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        let schemaA = schema.getSchema("a");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b.c",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-2",
+                attributeName: "test"
+            },
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "default",
+                path: "a.b.c",
+                currentContext: null,
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-3",
+                attributeName: "test-2"
+            },
+        });
+        schemaA = schema.getSchema("a");
+        expect(schemaA.properties.b.properties.c).toBeDefined();
+        expect(schemaA.properties.b.properties.c.anyOf).not.toBeUndefined();
+        expect(schemaA.properties.b.properties.c.anyOf[0].$ref).toEqual("https://fast.design/schemas/my-custom-element-2/test.json");
+        expect(schemaA.properties.b.properties.c.anyOf[1].$ref).toEqual("https://fast.design/schemas/my-custom-element-3/test-2.json");
+    });
+    test("should define an anyOf with a $ref in a nested object in a context", async () => {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        const schema = new Schema("my-custom-element");
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "repeat",
+                path: "a.users",
+                currentContext: "user",
+                parentContext: null,
+            },
+            childrenMap: null,
+        });
+        schema.addPath({
+            rootPropertyName: "a",
+            pathConfig: {
+                type: "access",
+                path: "user.a.b",
+                currentContext: "user",
+                parentContext: null,
+            },
+            childrenMap: {
+                customElementName: "my-custom-element-2",
+                attributeName: "c"
+            },
+        });
+        const schemaA = schema.getSchema("a");
+        expect(schemaA).toBeDefined();
+        expect((_a = schemaA.$defs) === null || _a === void 0 ? void 0 : _a["user"]).toBeDefined();
+        expect((_b = schemaA.$defs) === null || _b === void 0 ? void 0 : _b["user"].$fast_context).toEqual("users");
+        expect((_c = schemaA.$defs) === null || _c === void 0 ? void 0 : _c["user"].$fast_parent_contexts).toEqual([null]);
+        expect((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["user"].type).toEqual("object");
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["user"].properties).toBeDefined();
+        expect((_f = schemaA.$defs) === null || _f === void 0 ? void 0 : _f["user"].properties["a"]).toBeDefined();
+        expect((_g = schemaA.$defs) === null || _g === void 0 ? void 0 : _g["user"].properties["a"].properties["b"]).toBeDefined();
+        expect((_h = schemaA.$defs) === null || _h === void 0 ? void 0 : _h["user"].properties["a"].properties["b"].anyOf).toHaveLength(1);
+        expect((_j = schemaA.$defs) === null || _j === void 0 ? void 0 : _j["user"].properties["a"].properties["b"].anyOf[0][refPropertyName]).toEqual("https://fast.design/schemas/my-custom-element-2/c.json");
+    });
+});