@player-ui/player 0.8.0--canary.307.9621 → 0.8.0-next.0

package/src/view/builder/index.test.ts

@@ -0,0 +1,69 @@
+import { describe, test, expect } from "vitest";
+import { Builder } from ".";
+import { NodeType } from "../parser";
+
+test("asset", () => {
+  const result = Builder.asset({ id: "foo", type: "text" });
+  expect(result.type).toBe(NodeType.Asset);
+  expect(result.value.type).toBe("text");
+});
+
+describe("value", () => {
+  test("with no parameters", () => {
+    const result = Builder.value();
+    expect(result.type).toBe(NodeType.Value);
+    expect(result.value).toBeUndefined();
+  });
+
+  test("with parameters", () => {
+    const result = Builder.value({ foo: true });
+    expect(result.type).toBe(NodeType.Value);
+    expect(result.value.foo).toBe(true);
+  });
+});
+
+describe("multiNode", () => {
+  test("sets the parent node on all nodes", () => {
+    const v1 = Builder.value({ id: 1 });
+    const v2 = Builder.value({ id: 2 });
+    const result = Builder.multiNode(v1, v2);
+
+    expect(result.type).toBe(NodeType.MultiNode);
+    expect(v1.parent).toBe(result);
+    expect(v2.parent).toBe(result);
+  });
+});
+
+describe("addChild", () => {
+  test("sets the parent on the child node", () => {
+    const asset = Builder.asset({ id: "asset", type: "text" });
+    const value = Builder.value({ id: 2 });
+    Builder.addChild(asset, "childValue", value);
+
+    expect(value.parent).toBe(asset);
+  });
+  test("returns the original node", () => {
+    const original = Builder.asset({ id: "asset", type: "text" });
+    const value = Builder.value({ id: 2 });
+    const updated = Builder.addChild(original, "childValue", value);
+
+    expect(updated).toBe(original);
+  });
+  test("appends to an existing child array", () => {
+    const parent = Builder.asset({ id: "asset", type: "text" });
+    const v1 = Builder.value({ id: 1 });
+    const v2 = Builder.value({ id: 2 });
+    Builder.addChild(parent, "first", v1);
+    Builder.addChild(parent, "second", v2);
+
+    expect(parent.children).toHaveLength(2);
+  });
+
+  test("handles an array of path segments", () => {
+    const asset = Builder.asset({ id: "asset", type: "text" });
+    const value = Builder.value({ id: 2 });
+    Builder.addChild(asset, ["path1", "path2"], value);
+
+    expect(asset.children?.[0].path).toStrictEqual(["path1", "path2"]);
+  });
+});

package/src/view/builder/index.ts

@@ -1,5 +1,5 @@
-import type { Node, AnyAssetType } from '../parser';
-import { NodeType } from '../parser';
+import type { Node, AnyAssetType } from "../parser";
+import { NodeType } from "../parser";
 
 /**
  * Functions for building AST nodes (relatively) easily
@@ -62,7 +62,7 @@ export class Builder {
   static addChild<N extends Node.BaseWithChildren<NT>, NT extends NodeType>(
     node: N,
     path: Node.PathSegment | Node.PathSegment[],
-    child: Node.Node
+    child: Node.Node,
   ) {
     // eslint-disable-next-line no-param-reassign
     child.parent = node as Node.Node;

package/src/view/index.ts

@@ -1,5 +1,5 @@
-export * from './view';
-export * from './resolver';
-export * from './parser';
-export * from './builder';
-export * from './plugins';
+export * from "./view";
+export * from "./resolver";
+export * from "./parser";
+export * from "./builder";
+export * from "./plugins";

package/src/view/parser/__tests__/__snapshots__/parser.test.ts.snap

@@ -0,0 +1,394 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`generates the correct AST > parses an exp array 1`] = `
+{
+  "children": [
+    {
+      "path": [
+        "exp",
+      ],
+      "value": {
+        "override": true,
+        "parent": [Circular],
+        "type": "multi-node",
+        "values": [
+          {
+            "parent": [Circular],
+            "type": "value",
+            "value": "{{please}} = "work"",
+          },
+        ],
+      },
+    },
+  ],
+  "type": "asset",
+  "value": {
+    "id": "foo",
+    "type": "action",
+  },
+}
+`;
+
+exports[`generates the correct AST > parses an object 1`] = `
+{
+  "children": [
+    {
+      "path": [
+        "asset",
+      ],
+      "value": {
+        "parent": [Circular],
+        "type": "asset",
+        "value": {
+          "type": "bar",
+        },
+      },
+    },
+  ],
+  "type": "value",
+  "value": undefined,
+}
+`;
+
+exports[`generates the correct AST > works with applicability things 1`] = `
+{
+  "expression": "{{baz}}",
+  "type": "applicability",
+  "value": {
+    "parent": [Circular],
+    "type": "value",
+    "value": {
+      "foo": "bar",
+    },
+  },
+}
+`;
+
+exports[`generates the correct AST > works with applicability things 2`] = `
+{
+  "children": [
+    {
+      "path": [
+        "asset",
+      ],
+      "value": {
+        "children": [
+          {
+            "path": [
+              "values",
+            ],
+            "value": {
+              "override": true,
+              "parent": [Circular],
+              "type": "multi-node",
+              "values": [
+                {
+                  "expression": "{{foo}}",
+                  "parent": [Circular],
+                  "type": "applicability",
+                  "value": {
+                    "parent": [Circular],
+                    "type": "value",
+                    "value": {
+                      "value": "foo",
+                    },
+                  },
+                },
+                {
+                  "parent": [Circular],
+                  "type": "value",
+                  "value": {
+                    "value": "bar",
+                  },
+                },
+              ],
+            },
+          },
+        ],
+        "parent": [Circular],
+        "type": "asset",
+        "value": undefined,
+      },
+    },
+  ],
+  "type": "value",
+  "value": undefined,
+}
+`;
+
+exports[`generates the correct AST > works with applicability things 3`] = `
+{
+  "children": [
+    {
+      "path": [
+        "asset",
+      ],
+      "value": {
+        "children": [
+          {
+            "path": [
+              "someProp",
+            ],
+            "value": {
+              "expression": "{{foo}}",
+              "parent": [Circular],
+              "type": "applicability",
+              "value": {
+                "parent": [Circular],
+                "type": "value",
+                "value": {
+                  "description": {
+                    "value": "description",
+                  },
+                  "label": {
+                    "value": "label",
+                  },
+                },
+              },
+            },
+          },
+        ],
+        "parent": [Circular],
+        "type": "asset",
+        "value": undefined,
+      },
+    },
+  ],
+  "type": "value",
+  "value": undefined,
+}
+`;
+
+exports[`generates the correct AST > works with applicability things 4`] = `
+{
+  "children": [
+    {
+      "path": [
+        "asset",
+      ],
+      "value": {
+        "children": [
+          {
+            "path": [
+              "someProp",
+              "asset",
+            ],
+            "value": {
+              "expression": "{{foo}}",
+              "parent": [Circular],
+              "type": "applicability",
+              "value": {
+                "parent": [Circular],
+                "type": "asset",
+                "value": {
+                  "type": "someAsset",
+                },
+              },
+            },
+          },
+        ],
+        "parent": [Circular],
+        "type": "asset",
+        "value": undefined,
+      },
+    },
+  ],
+  "type": "value",
+  "value": undefined,
+}
+`;
+
+exports[`generates the correct AST when using switch plugin > works with asset wrapped objects 1`] = `
+{
+  "children": [
+    {
+      "path": [
+        "title",
+        "asset",
+      ],
+      "value": {
+        "parent": [Circular],
+        "type": "asset",
+        "value": {
+          "id": "businessprofile-tile-screen-yoy-subtitle",
+          "type": "text",
+          "value": "If it's changed since last year, let us know. Feel free to pick more than one.",
+        },
+      },
+    },
+  ],
+  "type": "value",
+  "value": {
+    "id": "toughView",
+    "type": "view",
+  },
+}
+`;
+
+exports[`generates the correct AST when using switch plugin > works with objects in a multiNode 1`] = `
+{
+  "children": [
+    {
+      "path": [
+        "title",
+        "asset",
+      ],
+      "value": {
+        "children": [
+          {
+            "path": [
+              "values",
+            ],
+            "value": {
+              "override": true,
+              "parent": [Circular],
+              "type": "multi-node",
+              "values": [
+                {
+                  "children": [
+                    {
+                      "path": [
+                        "asset",
+                      ],
+                      "value": {
+                        "parent": [Circular],
+                        "type": "asset",
+                        "value": {
+                          "id": "businessprofile-tile-screen-yoy-subtitle-1",
+                          "type": "text",
+                          "value": "If it's changed since last year, let us know. Feel free to pick more than one.",
+                        },
+                      },
+                    },
+                  ],
+                  "parent": [Circular],
+                  "type": "value",
+                  "value": undefined,
+                },
+                {
+                  "children": [
+                    {
+                      "path": [
+                        "asset",
+                      ],
+                      "value": {
+                        "parent": [Circular],
+                        "type": "asset",
+                        "value": {
+                          "id": "businessprofile-tile-screen-yoy-subtitle-2",
+                          "type": "text",
+                          "value": "More text",
+                        },
+                      },
+                    },
+                  ],
+                  "parent": [Circular],
+                  "type": "value",
+                  "value": undefined,
+                },
+              ],
+            },
+          },
+        ],
+        "parent": [Circular],
+        "type": "asset",
+        "value": {
+          "id": "someMultiNode",
+          "type": "type",
+        },
+      },
+    },
+  ],
+  "type": "value",
+  "value": {
+    "id": "toughView",
+    "type": "view",
+  },
+}
+`;
+
+exports[`parseView > parses a simple view 1`] = `
+{
+  "children": [
+    {
+      "path": [
+        "fields",
+        "asset",
+      ],
+      "value": {
+        "children": [
+          {
+            "path": [
+              "values",
+            ],
+            "value": {
+              "override": true,
+              "parent": [Circular],
+              "type": "multi-node",
+              "values": [
+                {
+                  "children": [
+                    {
+                      "path": [
+                        "asset",
+                      ],
+                      "value": {
+                        "parent": [Circular],
+                        "type": "asset",
+                        "value": {
+                          "id": "text-asset",
+                          "type": "text",
+                          "value": "bar",
+                        },
+                      },
+                    },
+                  ],
+                  "parent": [Circular],
+                  "type": "value",
+                  "value": undefined,
+                },
+                {
+                  "children": [
+                    {
+                      "path": [
+                        "asset",
+                      ],
+                      "value": {
+                        "expression": "foo.bar",
+                        "parent": [Circular],
+                        "type": "applicability",
+                        "value": {
+                          "parent": [Circular],
+                          "type": "asset",
+                          "value": {
+                            "id": "input-asset",
+                            "type": "input",
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "parent": [Circular],
+                  "type": "value",
+                  "value": undefined,
+                },
+              ],
+            },
+          },
+        ],
+        "parent": [Circular],
+        "type": "asset",
+        "value": {
+          "id": "foo-asset",
+          "type": "collection",
+        },
+      },
+    },
+  ],
+  "type": "view",
+  "value": {
+    "id": "foo-view",
+    "type": "viewtype",
+  },
+}
+`;