@player-tools/json-language-service 0.8.1 → 0.8.2--canary.169.3835

package/package.json

@@ -6,12 +6,13 @@
     "types"
   ],
   "name": "@player-tools/json-language-service",
-  "version": "0.8.1",
+  "version": "0.8.2--canary.169.3835",
   "main": "dist/cjs/index.cjs",
   "dependencies": {
-    "@player-tools/xlr": "0.8.1",
-    "@player-tools/xlr-sdk": "0.8.1",
-    "@player-tools/xlr-utils": "0.8.1",
+    "@player-tools/xlr": "0.8.2--canary.169.3835",
+    "@player-tools/xlr-sdk": "0.8.2--canary.169.3835",
+    "@player-tools/xlr-utils": "0.8.2--canary.169.3835",
+    "@player-ui/player": "0.7.3",
     "change-case": "^4.1.1",
     "cross-fetch": "^3.0.5",
     "detect-indent": "^6.0.0",

package/src/constants.ts

@@ -1,11 +1,11 @@
 import type { Filters } from "@player-tools/xlr-sdk";
+import { TransformFunction } from "@player-tools/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 { LegacyActionPlugin } from "./plugins/legacy-action-plugin";
-import { LegacyTemplatePlugin } from "./plugins/legacy-template-plugin";
 import { MissingAssetWrapperPlugin } from "./plugins/missing-asset-wrapper-plugin";
 import { NavStatePlugin } from "./plugins/nav-state-plugin";
 import { ViewNodePlugin } from "./plugins/view-node-plugin";
@@ -20,8 +20,6 @@ export const PLUGINS: Array<PlayerLanguageServicePlugin> = [
   new DuplicateIDPlugin(),
   new ViewNodePlugin(),
   new SchemaInfoPlugin(),
-  new LegacyTemplatePlugin(),
-  new LegacyActionPlugin(),
   new AssetWrapperArrayPlugin(),
   new NavStatePlugin(),
   new MissingAssetWrapperPlugin(),
@@ -32,7 +30,7 @@ export const DEFAULT_FILTERS: Filters = {
   typeFilter: "Transformed",
 };
 
-export const TRANSFORM_FUNCTIONS = [
+export const TRANSFORM_FUNCTIONS: Array<TransformFunction> = [
   applyAssetWrapperOrSwitch,
   applyValueRefs,
   applyCommonProps,

package/src/index.ts

@@ -79,7 +79,36 @@ export class PlayerLanguageService {
     Map<Diagnostic, Violation>
   >();
 
-  public readonly hooks = {
+  public readonly hooks: {
+    onDocumentUpdate: SyncHook<[DocumentContext], Record<string, any>>;
+    validate: AsyncParallelHook<[DocumentContext, ValidationContext], void>;
+    onValidateEnd: SyncWaterfallHook<
+      [
+        Diagnostic[],
+        {
+          /** The context of the document */
+          documentContext: DocumentContext;
+          /** A callback for adding a new fixable rule */
+          addFixableViolation: (diag: Diagnostic, violation: Violation) => void;
+        }
+      ],
+      Record<string, any>
+    >;
+    complete: AsyncParallelHook<
+      [EnhancedDocumentContextWithPosition, CompletionContext],
+      void
+    >;
+    hover: SyncBailHook<
+      [EnhancedDocumentContextWithPosition],
+      Hover | undefined,
+      Record<string, any>
+    >;
+    definition: SyncBailHook<
+      [EnhancedDocumentContextWithPosition],
+      Location | undefined,
+      Record<string, any>
+    >;
+  } = {
     onDocumentUpdate: new SyncHook<[DocumentContext]>(),
 
     validate: new AsyncParallelHook<
@@ -200,7 +229,7 @@ export class PlayerLanguageService {
     };
   }
 
-  public onClose(document: TextDocument) {
+  public onClose(document: TextDocument): void {
     this.fixableViolationsForDocument.delete(document.uri);
     this.parseCache.delete(document.uri);
   }
@@ -423,11 +452,11 @@ export class PlayerLanguageService {
     );
   }
 
-  public addLSPPlugin(plugin: PlayerLanguageServicePlugin) {
+  public addLSPPlugin(plugin: PlayerLanguageServicePlugin): void {
     plugin.apply(this);
   }
 
-  async setAssetTypes(typeFiles: Array<string>) {
+  async setAssetTypes(typeFiles: Array<string>): Promise<void> {
     // await this.typescriptService.setAssetTypes(typeFiles);
     typeFiles.forEach((file) => {
       // Find a better way of loading default types
@@ -443,17 +472,19 @@ export class PlayerLanguageService {
     });
   }
 
-  async setAssetTypesFromModule(manifest: Array<TSManifest>) {
-    manifest.forEach((m) => {
-      if (m.capabilities["Types"]?.length) {
-        this.XLRService.XLRSDK.loadDefinitionsFromModule(m);
-      } else {
-        this.XLRService.XLRSDK.loadDefinitionsFromModule(
-          m,
-          DEFAULT_FILTERS,
-          TRANSFORM_FUNCTIONS
-        );
-      }
-    });
+  async setAssetTypesFromModule(manifest: Array<TSManifest>): Promise<void> {
+    await Promise.allSettled(
+      manifest.map((m) => {
+        if (m.capabilities["Types"]?.length) {
+          return this.XLRService.XLRSDK.loadDefinitionsFromModule(m);
+        } else {
+          return this.XLRService.XLRSDK.loadDefinitionsFromModule(
+            m,
+            DEFAULT_FILTERS,
+            TRANSFORM_FUNCTIONS
+          );
+        }
+      })
+    );
   }
 }

package/src/parser/index.ts

@@ -16,7 +16,7 @@ export interface PlayerContentProvider {
 export async function walk(
   node: ASTNode,
   visitor: (n: ASTNode) => Promise<boolean>
-) {
+): Promise<void> {
   const queue: ASTNode[] = [node];
   let stop = false;
 

package/src/plugins/asset-wrapper-array-plugin.ts

@@ -51,7 +51,7 @@ const checkSwitchCase = (node: StringASTNode): boolean => {
 export class AssetWrapperArrayPlugin implements PlayerLanguageServicePlugin {
   name = "asset-wrapper-to-array";
 
-  apply(service: PlayerLanguageService) {
+  apply(service: PlayerLanguageService): void {
     service.hooks.validate.tap(
       this.name,
       async (documentInfo, validationContext) => {

package/src/plugins/binding-schema-plugin.ts

@@ -246,7 +246,7 @@ function getLocationForSchemaType(
 export class SchemaInfoPlugin implements PlayerLanguageServicePlugin {
   name = "view-node";
 
-  apply(service: PlayerLanguageService) {
+  apply(service: PlayerLanguageService): void {
     let schemaInfo: SchemaInfo | undefined;
 
     service.hooks.onDocumentUpdate.tap(this.name, (ctx) => {

package/src/plugins/duplicate-id-plugin.ts

@@ -110,7 +110,7 @@ const createValidationVisitor = (ctx: ValidationContext): ASTVisitor => {
 export class DuplicateIDPlugin implements PlayerLanguageServicePlugin {
   name = "duplicate-id";
 
-  apply(service: PlayerLanguageService) {
+  apply(service: PlayerLanguageService): void {
     service.hooks.validate.tap(this.name, async (ctx, validation) => {
       validation.useASTVisitor(createValidationVisitor(validation));
     });

package/src/plugins/nav-state-plugin.ts

@@ -93,7 +93,7 @@ const getFlowNode = (node: ASTNode): FlowASTNode | undefined => {
 export class NavStatePlugin implements PlayerLanguageServicePlugin {
   name = "nav-state";
 
-  apply(service: PlayerLanguageService) {
+  apply(service: PlayerLanguageService): void {
     service.hooks.validate.tap(this.name, async (ctx, validation) => {
       validation.useASTVisitor(createValidationVisitor(validation));
     });

package/src/plugins/view-node-plugin.ts

@@ -142,7 +142,7 @@ const getViewInfo = (ctx: DocumentContext): DocumentViewInfo => {
 export class ViewNodePlugin implements PlayerLanguageServicePlugin {
   name = "view-node";
 
-  apply(service: PlayerLanguageService) {
+  apply(service: PlayerLanguageService): void {
     let viewInfo: DocumentViewInfo | undefined;
 
     service.hooks.validate.tap(this.name, async (ctx, validation) => {

package/src/plugins/xlr-plugin.ts

@@ -332,7 +332,7 @@ function hover(ctx: EnhancedDocumentContextWithPosition) {
 export class XLRPlugin implements PlayerLanguageServicePlugin {
   name = "xlr-plugin";
 
-  apply(service: PlayerLanguageService) {
+  apply(service: PlayerLanguageService): void {
     service.hooks.validate.tap(this.name, async (ctx, validation) => {
       validation.useASTVisitor(
         createValidationVisitor(validation, service.XLRService.XLRSDK)

package/src/utils.ts

@@ -115,7 +115,9 @@ export function formatLikeNode(
 }
 
 /** Maps the string identifying the FlowType to the named type */
-export function mapFlowStateToType(flowType: string | undefined) {
+export function mapFlowStateToType(
+  flowType: string | undefined
+): string | undefined {
   let flowXLR;
   switch (flowType) {
     case "VIEW":

package/types/constants.d.ts

@@ -1,6 +1,7 @@
 import type { Filters } from "@player-tools/xlr-sdk";
+import { TransformFunction } from "@player-tools/xlr";
 import type { PlayerLanguageServicePlugin } from ".";
 export declare const PLUGINS: Array<PlayerLanguageServicePlugin>;
 export declare const DEFAULT_FILTERS: Filters;
-export declare const TRANSFORM_FUNCTIONS: import("@player-tools/xlr").TransformFunction[];
+export declare const TRANSFORM_FUNCTIONS: Array<TransformFunction>;
 //# sourceMappingURL=constants.d.ts.map

package/types/index.d.ts

@@ -25,15 +25,25 @@ export declare class PlayerLanguageService {
     readonly hooks: {
         onDocumentUpdate: SyncHook<[DocumentContext], Record<string, any>>;
         validate: AsyncParallelHook<[DocumentContext, ValidationContext], void>;
-        onValidateEnd: SyncWaterfallHook<[Diagnostic[], {
-            /** The context of the document */
-            documentContext: DocumentContext;
-            /** A callback for adding a new fixable rule */
-            addFixableViolation: (diag: Diagnostic, violation: Violation) => void;
-        }], Record<string, any>>;
-        complete: AsyncParallelHook<[EnhancedDocumentContextWithPosition, CompletionContext], void>;
-        hover: SyncBailHook<[EnhancedDocumentContextWithPosition], Hover | undefined, Record<string, any>>;
-        definition: SyncBailHook<[EnhancedDocumentContextWithPosition], Location | undefined, Record<string, any>>;
+        onValidateEnd: SyncWaterfallHook<[
+            Diagnostic[],
+            {
+                /** The context of the document */
+                documentContext: DocumentContext;
+                /** A callback for adding a new fixable rule */
+                addFixableViolation: (diag: Diagnostic, violation: Violation) => void;
+            }
+        ], Record<string, any>>;
+        complete: AsyncParallelHook<[
+            EnhancedDocumentContextWithPosition,
+            CompletionContext
+        ], void>;
+        hover: SyncBailHook<[
+            EnhancedDocumentContextWithPosition
+        ], Hover | undefined, Record<string, any>>;
+        definition: SyncBailHook<[
+            EnhancedDocumentContextWithPosition
+        ], Location | undefined, Record<string, any>>;
     };
     constructor(config?: {
         /** A list of plugins to include */

package/src/plugins/__tests__/action-plugin.test.ts

@@ -1,168 +0,0 @@
-import { test, expect, describe, beforeEach } from "vitest";
-import { TextDocument } from "vscode-languageserver-textdocument";
-import {
-  ReferenceAssetsWebPluginManifest,
-  Types,
-} from "@player-tools/static-xlrs";
-import { PlayerLanguageService } from "../..";
-import { toTextDocument } from "../../utils";
-
-describe("action-plugin", () => {
-  let service: PlayerLanguageService;
-
-  beforeEach(async () => {
-    service = new PlayerLanguageService();
-    await service.setAssetTypesFromModule([
-      Types,
-      ReferenceAssetsWebPluginManifest,
-    ]);
-  });
-
-  test("fixes old actions", async () => {
-    let testDocument = toTextDocument(
-      JSON.stringify(
-        {
-          id: "foo",
-          views: [
-            {
-              id: "bar",
-              type: "collection",
-              actions: [
-                {
-                  id: "action-1",
-                  value: "Next",
-                },
-                {
-                  value: "other",
-                  label: {
-                    asset: {
-                      id: "other-label",
-                      type: "text",
-                      value: "Other",
-                    },
-                  },
-                },
-              ],
-            },
-          ],
-        },
-        null,
-        2
-      )
-    );
-
-    let diags = await service.validateTextDocument(testDocument);
-
-    expect(diags).toHaveLength(4);
-    expect(diags?.map((m) => m.message)).toMatchInlineSnapshot(`
-      [
-        "Content Validation Error - missing: Property "navigation" missing from type "Flow"",
-        "View is not reachable",
-        "Migrate to an action-asset",
-        "Migrate to an action-asset",
-      ]
-    `);
-
-    const actions = await service.getCodeActionsInRange(testDocument, {
-      diagnostics: diags ?? [],
-    });
-
-    expect(actions).toHaveLength(2);
-
-    const editActions = actions[0].edit?.changes?.[testDocument.uri];
-
-    const appliedAction = TextDocument.applyEdits(
-      testDocument,
-      editActions ?? []
-    );
-
-    expect(appliedAction).toMatchInlineSnapshot(`
-      "{
-        "id": "foo",
-        "views": [
-          {
-            "id": "bar",
-            "type": "collection",
-            "actions": [
-              {
-        "asset": {
-          "type": "action",
-          "id": "action-1",
-          "value": "Next"
-        }
-      },
-              {
-                "value": "other",
-                "label": {
-                  "asset": {
-                    "id": "other-label",
-                    "type": "text",
-                    "value": "Other"
-                  }
-                }
-              }
-            ]
-          }
-        ]
-      }"
-    `);
-
-    testDocument = TextDocument.update(
-      testDocument,
-      [
-        {
-          text: appliedAction,
-        },
-      ],
-      2
-    );
-    diags = await service.validateTextDocument(testDocument);
-
-    const nextActions = await service.getCodeActionsInRange(testDocument, {
-      diagnostics: diags ?? [],
-    });
-
-    expect(nextActions).toHaveLength(1);
-
-    const nextAction = nextActions[0].edit?.changes?.[testDocument.uri];
-
-    const nextAppliedAction = TextDocument.applyEdits(
-      testDocument,
-      nextAction ?? []
-    );
-
-    expect(nextAppliedAction).toMatchInlineSnapshot(`
-      "{
-        "id": "foo",
-        "views": [
-          {
-            "id": "bar",
-            "type": "collection",
-            "actions": [
-              {
-        "asset": {
-          "type": "action",
-          "id": "action-1",
-          "value": "Next"
-        }
-      },
-              {
-        "asset": {
-          "type": "action",
-          "value": "other",
-          "label": {
-            "asset": {
-              "id": "other-label",
-              "type": "text",
-              "value": "Other"
-            }
-          }
-        }
-      }
-            ]
-          }
-        ]
-      }"
-    `);
-  });
-});

package/src/plugins/__tests__/template-plugin.test.ts

@@ -1,97 +0,0 @@
-import { test, expect, describe, beforeEach } from "vitest";
-import { TextDocument } from "vscode-languageserver-textdocument";
-import {
-  ReferenceAssetsWebPluginManifest,
-  Types,
-} from "@player-tools/static-xlrs";
-import { PlayerLanguageService } from "../..";
-import { toTextDocument } from "../../utils";
-
-describe("template-plugin", () => {
-  let service: PlayerLanguageService;
-
-  beforeEach(async () => {
-    service = new PlayerLanguageService();
-    await service.setAssetTypesFromModule([
-      Types,
-      ReferenceAssetsWebPluginManifest,
-    ]);
-  });
-
-  test("fixes old templates", async () => {
-    const testDocument = toTextDocument(
-      JSON.stringify(
-        {
-          id: "foo",
-          views: [
-            {
-              id: "bar",
-              type: "collection",
-              templateData: "foo.bar",
-              templateOutput: "values",
-              template: {
-                asset: {
-                  id: "asset-_index_",
-                  type: "text",
-                  value: "_index_",
-                },
-              },
-            },
-          ],
-        },
-        null,
-        2
-      )
-    );
-
-    const diags = await service.validateTextDocument(testDocument);
-
-    expect(diags?.map((m) => m.message)).toMatchInlineSnapshot(`
-      [
-        "Content Validation Error - missing: Property "navigation" missing from type "Flow"",
-        "View is not reachable",
-        "Migrate to the template[] syntax.",
-        "Migrate to the template[] syntax.",
-        "View Validation Error - type: Expected an array but got an "object"",
-      ]
-    `);
-
-    const actions = await service.getCodeActionsInRange(testDocument, {
-      diagnostics: diags ?? [],
-    });
-
-    expect(actions).toHaveLength(2);
-
-    const editActions = actions[0].edit?.changes?.[testDocument.uri];
-
-    const appliedAction = TextDocument.applyEdits(
-      testDocument,
-      editActions ?? []
-    );
-
-    expect(appliedAction).toMatchInlineSnapshot(`
-      "{
-        "id": "foo",
-        "views": [
-          {
-            "id": "bar",
-            "type": "collection",
-            "template": [
-              {
-                "value": {
-                  "asset": {
-                    "id": "asset-_index_",
-                    "type": "text",
-                    "value": "_index_"
-                  }
-                },
-                "output": "values",
-                "data": "foo.bar"
-              }
-            ]
-          }
-        ]
-      }"
-    `);
-  });
-});

package/src/plugins/legacy-action-plugin.ts

@@ -1,79 +0,0 @@
-import { DiagnosticSeverity } from "vscode-languageserver-types";
-import type { PlayerLanguageService, PlayerLanguageServicePlugin } from "..";
-import type { ASTNode } from "../parser";
-import { getNodeValue } from "../parser";
-import type { ASTVisitor, ValidationContext } from "../types";
-
-/** Create an AST visitor for checking the legacy action */
-function createRuleVisitor(context: ValidationContext): ASTVisitor {
-  /** Check if a node is using the action asset or not */
-  const checkForLegacyAction = (node: ASTNode) => {
-    if (node.type === "asset") {
-      return;
-    }
-
-    if (
-      node.type === "object" &&
-      !node.properties.some(
-        (p) =>
-          p.keyNode.value === "asset" ||
-          p.keyNode.value === "dynamicSwitch" ||
-          p.keyNode.value === "staticSwitch"
-      )
-    ) {
-      context.addViolation({
-        message: "Migrate to an action-asset",
-        node,
-        severity: DiagnosticSeverity.Warning,
-        fix: () => {
-          const newActionAsset = {
-            asset: {
-              type: "action",
-              ...getNodeValue(node),
-            },
-          };
-
-          return {
-            name: "Convert to Asset",
-            edit: {
-              type: "replace",
-              node,
-              value: JSON.stringify(newActionAsset, null, 2),
-            },
-          };
-        },
-      });
-    }
-  };
-
-  return {
-    ViewNode: (viewNode) => {
-      // Check for an `actions` array of non-assets
-
-      const actionsProp = viewNode.properties.find(
-        (p) => p.keyNode.value === "actions"
-      );
-
-      if (!actionsProp || actionsProp.valueNode?.type !== "array") {
-        return;
-      }
-
-      // Go through the array and add a violation/fix for anything that's not an asset
-
-      actionsProp.valueNode.children.forEach((action) => {
-        checkForLegacyAction(action);
-      });
-    },
-  };
-}
-
-/** A plugin that validates and corrects the usage of non-asset actions in a view */
-export class LegacyActionPlugin implements PlayerLanguageServicePlugin {
-  name = "legacy-action";
-
-  apply(service: PlayerLanguageService) {
-    service.hooks.validate.tap(this.name, async (ctx, validationContext) => {
-      validationContext.useASTVisitor(createRuleVisitor(validationContext));
-    });
-  }
-}