@microsoft/fast-html 1.0.0-alpha.3 → 1.0.0-alpha.30

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

@@ -0,0 +1,485 @@
+import { __awaiter } from "tslib";
+import { expect, test } from "@playwright/test";
+import { refPropertyName, Schema } from "./schema.js";
+test.describe("Schema", () => __awaiter(void 0, void 0, void 0, function* () {
+    test("should instantiate with a custom element name without throwing", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _d, _e, _f, _g, _h, _j;
+        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((_d = schemaA.$defs) === null || _d === void 0 ? void 0 : _d["item"]).toBeDefined();
+        expect((_e = schemaA.$defs) === null || _e === void 0 ? void 0 : _e["item"].$fast_context).toEqual("items");
+        expect((_f = schemaA.$defs) === null || _f === void 0 ? void 0 : _f["item"].$fast_parent_contexts).toEqual([null]);
+        expect((_g = schemaA.$defs) === null || _g === void 0 ? void 0 : _g["item"].properties).toBeDefined();
+        expect((_h = schemaA.$defs) === null || _h === void 0 ? void 0 : _h["item"].properties["a"]).toBeDefined();
+        expect((_j = schemaA.$defs) === null || _j === void 0 ? void 0 : _j["item"].properties["a"].type).toEqual("object");
+    }));
+    test("should add a nested context in a schema", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _k, _l, _m, _o, _p;
+        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((_k = schemaA === null || schemaA === void 0 ? void 0 : schemaA.properties) === null || _k === void 0 ? void 0 : _k["items"]).toBeDefined();
+        expect((_l = schemaA === null || schemaA === void 0 ? void 0 : schemaA.properties) === null || _l === void 0 ? void 0 : _l["items"].items.$ref).toEqual("#/$defs/item");
+        expect((_m = schemaA.$defs) === null || _m === void 0 ? void 0 : _m["item"]).toBeDefined();
+        expect((_o = schemaA.$defs) === null || _o === void 0 ? void 0 : _o["item"].$fast_context).toEqual("items");
+        expect((_p = schemaA.$defs) === null || _p === void 0 ? void 0 : _p["item"].$fast_parent_contexts).toEqual([null]);
+    }));
+    test("should define an object as a nested context in a schema", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _q, _r, _s, _t, _u, _v, _w;
+        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((_q = schemaA.$defs) === null || _q === void 0 ? void 0 : _q["item"]).toBeDefined();
+        expect((_r = schemaA.$defs) === null || _r === void 0 ? void 0 : _r["item"].$fast_context).toEqual("items");
+        expect((_s = schemaA.$defs) === null || _s === void 0 ? void 0 : _s["item"].$fast_parent_contexts).toEqual([null]);
+        expect((_t = schemaA.$defs) === null || _t === void 0 ? void 0 : _t["item"].type).toEqual("object");
+        expect((_u = schemaA.$defs) === null || _u === void 0 ? void 0 : _u["item"].properties).toBeDefined();
+        expect((_w = (_v = schemaA.$defs) === null || _v === void 0 ? void 0 : _v["item"].properties) === null || _w === void 0 ? void 0 : _w["b"]).toBeDefined();
+    }));
+    test("should define nested contexts in a schema", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _x, _y, _z, _0, _1, _2;
+        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((_x = schemaA.$defs) === null || _x === void 0 ? void 0 : _x["user"]).toBeDefined();
+        expect((_y = schemaA.$defs) === null || _y === void 0 ? void 0 : _y["user"].$fast_context).toEqual("users");
+        expect((_z = schemaA.$defs) === null || _z === void 0 ? void 0 : _z["user"].$fast_parent_contexts).toEqual([null]);
+        expect((_0 = schemaA.$defs) === null || _0 === void 0 ? void 0 : _0["post"]).toBeDefined();
+        expect((_1 = schemaA.$defs) === null || _1 === void 0 ? void 0 : _1["post"].$fast_context).toEqual("posts");
+        expect((_2 = schemaA.$defs) === null || _2 === void 0 ? void 0 : _2["post"].$fast_parent_contexts).toEqual([null, "user"]);
+    }));
+    test("should define nested contexts with objects in a schema", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23;
+        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((_3 = schemaA.$defs) === null || _3 === void 0 ? void 0 : _3["user"]).toBeDefined();
+        expect((_4 = schemaA.$defs) === null || _4 === void 0 ? void 0 : _4["user"].$fast_context).toEqual("users");
+        expect((_5 = schemaA.$defs) === null || _5 === void 0 ? void 0 : _5["user"].$fast_parent_contexts).toEqual([null]);
+        expect((_6 = schemaA.$defs) === null || _6 === void 0 ? void 0 : _6["user"].type).toEqual("object");
+        expect((_7 = schemaA.$defs) === null || _7 === void 0 ? void 0 : _7["user"].properties).toBeDefined();
+        expect((_8 = schemaA.$defs) === null || _8 === void 0 ? void 0 : _8["user"].properties["a"]).toBeDefined();
+        expect((_9 = schemaA.$defs) === null || _9 === void 0 ? void 0 : _9["user"].properties["a"].properties["b"]).toBeDefined();
+        expect((_10 = schemaA.$defs) === null || _10 === void 0 ? void 0 : _10["post"]).toBeDefined();
+        expect((_11 = schemaA.$defs) === null || _11 === void 0 ? void 0 : _11["post"].$fast_context).toEqual("posts");
+        expect((_12 = schemaA.$defs) === null || _12 === void 0 ? void 0 : _12["post"].$fast_parent_contexts).toEqual([null, "user"]);
+        expect((_13 = schemaA.$defs) === null || _13 === void 0 ? void 0 : _13["post"].type).toEqual("object");
+        expect((_14 = schemaA.$defs) === null || _14 === void 0 ? void 0 : _14["post"].properties).toBeDefined();
+        expect((_15 = schemaA.$defs) === null || _15 === void 0 ? void 0 : _15["post"].properties["c"]).toBeDefined();
+        expect((_16 = schemaA.$defs) === null || _16 === void 0 ? void 0 : _16["post"].properties["c"].properties["d"]).toBeDefined();
+        expect((_17 = schemaA.$defs) === null || _17 === void 0 ? void 0 : _17["post"].properties["meta"]).toBeDefined();
+        expect((_18 = schemaA.$defs) === null || _18 === void 0 ? void 0 : _18["post"].properties["meta"].properties["tags"]).toBeDefined();
+        expect((_19 = schemaA.$defs) === null || _19 === void 0 ? void 0 : _19["post"].properties["meta"].properties["tags"].items).toBeDefined();
+        expect((_20 = schemaA.$defs) === null || _20 === void 0 ? void 0 : _20["post"].properties["meta"].properties["tags"].items.$ref).toEqual("#/$defs/tag");
+        expect((_21 = schemaA.$defs) === null || _21 === void 0 ? void 0 : _21["tag"]).toBeDefined();
+        expect((_22 = schemaA.$defs) === null || _22 === void 0 ? void 0 : _22["tag"].$fast_context).toEqual("tags");
+        expect((_23 = schemaA.$defs) === null || _23 === void 0 ? void 0 : _23["tag"].$fast_parent_contexts).toEqual([null, "user", "post"]);
+    }));
+    test("should define an anyOf with a $ref to another schema", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _24;
+        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((_24 = schemaA.anyOf) === null || _24 === void 0 ? void 0 : _24[0].$ref).toEqual("https://fast.design/schemas/my-custom-element-2/b.json");
+    }));
+    test("should define an anyOf with a $ref to multiple schemas", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _25, _26;
+        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((_25 = schemaA.anyOf) === null || _25 === void 0 ? void 0 : _25[0].$ref).toEqual("https://fast.design/schemas/my-custom-element-2/b.json");
+        expect((_26 = schemaA.anyOf) === null || _26 === void 0 ? void 0 : _26[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", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        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", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _27, _28, _29, _30, _31, _32, _33, _34, _35;
+        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((_27 = schemaA.$defs) === null || _27 === void 0 ? void 0 : _27["user"]).toBeDefined();
+        expect((_28 = schemaA.$defs) === null || _28 === void 0 ? void 0 : _28["user"].$fast_context).toEqual("users");
+        expect((_29 = schemaA.$defs) === null || _29 === void 0 ? void 0 : _29["user"].$fast_parent_contexts).toEqual([null]);
+        expect((_30 = schemaA.$defs) === null || _30 === void 0 ? void 0 : _30["user"].type).toEqual("object");
+        expect((_31 = schemaA.$defs) === null || _31 === void 0 ? void 0 : _31["user"].properties).toBeDefined();
+        expect((_32 = schemaA.$defs) === null || _32 === void 0 ? void 0 : _32["user"].properties["a"]).toBeDefined();
+        expect((_33 = schemaA.$defs) === null || _33 === void 0 ? void 0 : _33["user"].properties["a"].properties["b"]).toBeDefined();
+        expect((_34 = schemaA.$defs) === null || _34 === void 0 ? void 0 : _34["user"].properties["a"].properties["b"].anyOf).toHaveLength(1);
+        expect((_35 = schemaA.$defs) === null || _35 === void 0 ? void 0 : _35["user"].properties["a"].properties["b"].anyOf[0][refPropertyName]).toEqual("https://fast.design/schemas/my-custom-element-2/c.json");
+    }));
+}));