@player-lang/json-language-service 0.0.2-next.0

package/src/__tests__/__snapshots__/service.test.ts.snap

@@ -0,0 +1,213 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`player language service > completion > basic object completions 1`] = `
+[
+  {
+    "documentation": "The text to display",
+    "kind": 10,
+    "label": "value",
+  },
+  {
+    "documentation": "Any modifiers on the text",
+    "kind": 10,
+    "label": "modifiers",
+  },
+  {
+    "documentation": "Evaluate the given expression (or boolean) and if falsy, remove this node from the tree. This is re-computed for each change in the data-model",
+    "kind": 10,
+    "label": "applicability",
+  },
+  {
+    "documentation": "Adds a comment for the given node",
+    "kind": 10,
+    "label": "_comment",
+  },
+  {
+    "documentation": "A list of templates to process for this node",
+    "kind": 10,
+    "label": "template",
+  },
+]
+`;
+
+exports[`player language service > completion > basic object completions 2`] = `
+[
+  {
+    "documentation": "The name of the Flow to begin on",
+    "kind": 10,
+    "label": "BEGIN",
+  },
+]
+`;
+
+exports[`player language service > completion > basic value completions 1`] = `
+[
+  {
+    "kind": 12,
+    "label": "VIEW",
+  },
+  {
+    "kind": 12,
+    "label": "END",
+  },
+  {
+    "kind": 12,
+    "label": "FLOW",
+  },
+  {
+    "kind": 12,
+    "label": "ACTION",
+  },
+  {
+    "kind": 12,
+    "label": "EXTERNAL",
+  },
+]
+`;
+
+exports[`player language service > completion > schema completions 1`] = `
+[
+  {
+    "kind": 12,
+    "label": "",
+  },
+  {
+    "kind": 12,
+    "label": ".bar",
+  },
+  {
+    "kind": 12,
+    "label": ".baz",
+  },
+]
+`;
+
+exports[`player language service > hover > basic hover docs 1`] = `
+{
+  "contents": {
+    "kind": "plaintext",
+    "value": "Each asset requires a unique id per view",
+  },
+}
+`;
+
+exports[`player language service > hover > basic hover docs 2`] = `
+{
+  "contents": {
+    "kind": "plaintext",
+    "value": "The asset type determines the semantics of how a user interacts with a page",
+  },
+}
+`;
+
+exports[`player language service > hover > basic hover docs 3`] = `
+{
+  "contents": {
+    "kind": "plaintext",
+    "value": "Any initial data that the flow can use",
+  },
+}
+`;
+
+exports[`player language service > validation > throws AssetWrapper errors 1`] = `
+[
+  {
+    "message": "Content Validation Error - type: Expected type "string" but got "null"",
+    "range": {
+      "end": {
+        "character": 28,
+        "line": 20,
+      },
+      "start": {
+        "character": 16,
+        "line": 20,
+      },
+    },
+    "severity": 1,
+  },
+  {
+    "message": "Content Validation Error - missing: Property "BEGIN" missing from type "Navigation"",
+    "range": {
+      "end": {
+        "character": 26,
+        "line": 16,
+      },
+      "start": {
+        "character": 24,
+        "line": 16,
+      },
+    },
+    "severity": 1,
+  },
+  {
+    "message": "Navigation Validation Error - missing: Property "BEGIN" missing from type "Navigation"",
+    "range": {
+      "end": {
+        "character": 26,
+        "line": 16,
+      },
+      "start": {
+        "character": 24,
+        "line": 16,
+      },
+    },
+    "severity": 1,
+  },
+  {
+    "message": "View is not reachable",
+    "range": {
+      "end": {
+        "character": 33,
+        "line": 5,
+      },
+      "start": {
+        "character": 20,
+        "line": 5,
+      },
+    },
+    "severity": 2,
+  },
+  {
+    "message": "View Validation Error - value: Does not match any of the expected types for type: 'AssetWrapperOrSwitch'",
+    "range": {
+      "end": {
+        "character": 16,
+        "line": 12,
+      },
+      "start": {
+        "character": 23,
+        "line": 8,
+      },
+    },
+    "severity": 1,
+  },
+  {
+    "message": "Expected: AssetWrapper & object literal | StaticSwitch & object literal | DynamicSwitch & object literal",
+    "range": {
+      "end": {
+        "character": 16,
+        "line": 12,
+      },
+      "start": {
+        "character": 23,
+        "line": 8,
+      },
+    },
+    "severity": 3,
+  },
+  {
+    "message": "Implicit Array -> "collection" assets is not supported.",
+    "range": {
+      "end": {
+        "character": 21,
+        "line": 8,
+      },
+      "start": {
+        "character": 14,
+        "line": 8,
+      },
+    },
+    "severity": 1,
+  },
+]
+`;

package/src/__tests__/service.test.ts

@@ -0,0 +1,298 @@
+import { test, expect, describe, beforeEach } from "vitest";
+import { TextDocument } from "vscode-languageserver-textdocument";
+import {
+  ReferenceAssetsWebPluginManifest,
+  Types,
+} from "@player-lang/static-xlrs";
+import { PlayerLanguageService } from "..";
+import { toTextDocument } from "../utils";
+
+describe("player language service", () => {
+  let service: PlayerLanguageService;
+
+  beforeEach(async () => {
+    service = new PlayerLanguageService();
+    await service.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+  });
+
+  describe("formatting", () => {
+    test("formats a document", async () => {
+      const document = toTextDocument(
+        `{
+"id": "foo",
+"views": [{"id":"view1"}]
+}
+`,
+      );
+
+      const formatEdits = await service.formatTextDocument(document, {
+        tabSize: 2,
+        insertSpaces: true,
+      });
+      expect(formatEdits).toHaveLength(8);
+      const updatedDocument = TextDocument.applyEdits(
+        document,
+        formatEdits ?? [],
+      );
+      expect(updatedDocument).toMatchInlineSnapshot(`
+        "{
+          "id": "foo",
+          "views": [
+            {
+              "id": "view1"
+            }
+          ]
+        }"
+      `);
+    });
+  });
+
+  describe("validation", () => {
+    test("throws AssetWrapper errors", async () => {
+      const document = toTextDocument(
+        `
+        {
+          "id": "foo",
+          "views": [
+            {
+              "id": "input-asset",
+              "type": "input",
+              "binding": "foo",
+              "label": [{
+                "id":"test",
+                "type": "text",
+                "value": "test"
+              }]
+            }
+          ],
+          "data": {},
+          "navigation": {},
+          "schema": {
+            "ROOT": {
+              "application": {
+                "type": null
+              },
+              "foo": {
+                "type": "fooType"
+              }
+            },
+            "fooType": {
+              "bar": {
+                "type": "barType",
+                "validation": [
+                  {
+                    "type": "required",
+                    "severity": "error"
+                  }
+                ]
+              },
+              "baz": {
+                "type": "bazType",
+                "validation": [
+                  {
+                    "type": "required",
+                    "message": "this is my own message"
+                  }
+                ]
+              }
+            }
+          }
+        }
+        `,
+      );
+      const validationErrors = await service.validateTextDocument(document);
+
+      expect(validationErrors).toMatchSnapshot();
+    });
+  });
+
+  describe("completion", () => {
+    test("basic object completions", async () => {
+      const document = toTextDocument(
+        `
+{
+"id": "foo",
+"views": [
+  {
+   "id": "view-1",
+   "type": "main",
+   "title": {
+    "asset": {
+     "id": "title-asset",
+     "type": "text",
+      
+    }
+   }
+  }
+],
+"data":{},
+"navigation":{
+
+}
+}
+`,
+      );
+
+      let completions = await service.getCompletionsAtPosition(document, {
+        line: 11,
+        character: 6,
+      });
+      expect(completions.items).toMatchSnapshot();
+
+      completions = await service.getCompletionsAtPosition(document, {
+        line: 18,
+        character: 2,
+      });
+      expect(completions.items).toMatchSnapshot();
+    });
+
+    test("basic value completions", async () => {
+      const document = toTextDocument(
+        `
+{
+ "id": "foo",
+ "views": [],
+ "data":{},
+ "navigation":{
+  "BEGIN": "FLOW_1",
+   "FLOW_1": {
+   "startState": "VIEW_1",
+   "VIEW_1": {
+    "state_type": "",
+    "ref": "action",
+    "transitions": {
+     "*": "END_Done"
+    }
+   },
+   "END_Done": {
+    "state_type": "END",
+     "outcome": "done"
+   }
+  }
+ }
+}
+`,
+      );
+
+      const completions = await service.getCompletionsAtPosition(document, {
+        line: 10,
+        character: 19,
+      });
+      expect(completions.items).toMatchSnapshot();
+    });
+
+    test("schema completions", async () => {
+      const document = toTextDocument(
+        `
+        {
+          "id": "foo",
+          "views": [
+            {
+              "id": "view-1",
+              "type": "main",
+              "title": {
+                "asset": {
+                  "id": "input-asset",
+                  "type": "input",
+                  "binding": "foo"
+                }
+              }
+            }
+          ],
+          "data": {},
+          "navigation": {},
+          "schema": {
+            "ROOT": {
+              "application": {
+                "type": null
+              },
+              "foo": {
+                "type": "fooType"
+              }
+            },
+            "fooType": {
+              "bar": {
+                "type": "barType",
+                "validation": [
+                  {
+                    "type": "required",
+                    "severity": "error"
+                  }
+                ]
+              },
+              "baz": {
+                "type": "bazType",
+                "validation": [
+                  {
+                    "type": "required",
+                    "message": "this is my own message"
+                  }
+                ]
+              }
+            }
+          }
+        }
+        
+`,
+      );
+
+      const completions = await service.getCompletionsAtPosition(document, {
+        line: 11,
+        character: 33,
+      });
+      expect(completions.items).toMatchSnapshot();
+    });
+  });
+
+  describe("hover", () => {
+    test("basic hover docs", async () => {
+      const document = toTextDocument(
+        `
+{
+  "id": "foo",
+  "views": [
+    {
+      "id": "view-1",
+      "type": "main",
+      "title": {
+        "asset": {
+          "id": "title-asset",
+          "type": "text"
+        }
+      }
+    }
+  ],
+  "data": {},
+  "navigation": {
+    "BEGIN":""
+  }
+}
+`,
+      );
+
+      let docs = await service.getHoverInfoAtPosition(document, {
+        line: 5,
+        character: 9,
+      });
+      expect(docs).toBeDefined();
+      expect(docs).toMatchSnapshot();
+
+      docs = await service.getHoverInfoAtPosition(document, {
+        line: 10,
+        character: 13,
+      });
+      expect(docs).toBeDefined();
+      expect(docs).toMatchSnapshot();
+
+      docs = await service.getHoverInfoAtPosition(document, {
+        line: 15,
+        character: 6,
+      });
+      expect(docs).toBeDefined();
+      expect(docs).toMatchSnapshot();
+    });
+  });
+});

package/src/constants.ts

@@ -0,0 +1,38 @@
+import type { Filters } from "@xlr-lib/xlr-sdk";
+import { TransformFunction } from "@xlr-lib/xlr";
+
+import type { PlayerLanguageServicePlugin } from ".";
+import { AssetWrapperArrayPlugin } from "./plugins/asset-wrapper-array-plugin";
+import { SchemaInfoPlugin } from "./plugins/binding-schema-plugin";
+import { XLRPlugin } from "./plugins/xlr-plugin";
+import { DuplicateIDPlugin } from "./plugins/duplicate-id-plugin";
+import { MissingAssetWrapperPlugin } from "./plugins/missing-asset-wrapper-plugin";
+import { NavStatePlugin } from "./plugins/nav-state-plugin";
+import { ViewNodePlugin } from "./plugins/view-node-plugin";
+import {
+  applyAssetWrapperOrSwitch,
+  applyCommonProps,
+  applyTemplateProperty,
+  applyValueRefs,
+} from "./xlr/transforms";
+
+export const PLUGINS: Array<PlayerLanguageServicePlugin> = [
+  new DuplicateIDPlugin(),
+  new ViewNodePlugin(),
+  new SchemaInfoPlugin(),
+  new AssetWrapperArrayPlugin(),
+  new NavStatePlugin(),
+  new MissingAssetWrapperPlugin(),
+  new XLRPlugin(),
+];
+
+export const DEFAULT_FILTERS: Filters = {
+  typeFilter: "Transformed",
+};
+
+export const TRANSFORM_FUNCTIONS: Array<TransformFunction> = [
+  applyAssetWrapperOrSwitch,
+  applyValueRefs,
+  applyCommonProps,
+  applyTemplateProperty,
+];