@player-ui/reference-assets-plugin 0.13.0-next.5 → 0.13.0-next.6

package/dist/xlr/InputAsset.json

@@ -1,5 +1,5 @@
 {
-    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/3223/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/input/types.ts",
+    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/input/types.ts",
     "name": "InputAsset",
     "type": "object",
     "properties": {
@@ -50,7 +50,7 @@
                     "beacon": {
                         "required": false,
                         "node": {
-                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/3223/execroot/_main/bazel-out/k8-fastbuild/bin/node_modules/.aspect_rules_js/@player-ui+beacon-plugin@0.0.0/node_modules/@player-ui/beacon-plugin/types/beacon.d.ts",
+                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/node_modules/.aspect_rules_js/@player-ui+beacon-plugin@0.0.0/node_modules/@player-ui/beacon-plugin/types/beacon.d.ts",
                             "name": "BeaconDataType",
                             "type": "or",
                             "or": [

package/dist/xlr/TextAsset.json

@@ -1,5 +1,5 @@
 {
-    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/3223/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
     "name": "TextAsset",
     "type": "object",
     "properties": {
@@ -16,12 +16,12 @@
             "node": {
                 "type": "array",
                 "elementType": {
-                    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/3223/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+                    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
                     "name": "TextModifier",
                     "type": "or",
                     "or": [
                         {
-                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/3223/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
                             "name": "BasicTextModifier",
                             "type": "object",
                             "properties": {
@@ -48,7 +48,7 @@
                             "title": "BasicTextModifier"
                         },
                         {
-                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/3223/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
                             "name": "LinkModifier",
                             "type": "object",
                             "properties": {

package/dist/xlr/send.json

@@ -0,0 +1,40 @@
+{
+    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/4555/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/plugins/send.ts",
+    "name": "send",
+    "type": "ref",
+    "ref": "ExpressionHandler<[string, string | undefined]>",
+    "genericArguments": [
+        {
+            "type": "tuple",
+            "elementTypes": [
+                {
+                    "type": {
+                        "type": "string",
+                        "title": "0"
+                    },
+                    "optional": false
+                },
+                {
+                    "type": {
+                        "type": "or",
+                        "or": [
+                            {
+                                "type": "string",
+                                "title": "1"
+                            },
+                            {
+                                "type": "undefined",
+                                "title": "1"
+                            }
+                        ],
+                        "title": "1"
+                    },
+                    "optional": false
+                }
+            ],
+            "additionalItems": false,
+            "minItems": 2
+        }
+    ],
+    "title": "send"
+}

package/package.json

@@ -6,12 +6,14 @@
     "types"
   ],
   "name": "@player-ui/reference-assets-plugin",
-  "version": "0.13.0-next.5",
+  "version": "0.13.0-next.6",
   "main": "dist/cjs/index.cjs",
   "dependencies": {
-    "@player-ui/asset-transform-plugin": "0.13.0-next.5",
-    "@player-ui/beacon-plugin": "0.13.0-next.5",
-    "@player-ui/async-node-plugin": "0.13.0-next.5",
+    "@player-ui/asset-transform-plugin": "0.13.0-next.6",
+    "@player-ui/beacon-plugin": "0.13.0-next.6",
+    "@player-ui/async-node-plugin": "0.13.0-next.6",
+    "@player-ui/expression-plugin": "0.13.0-next.6",
+    "@player-ui/meta-plugin": "0.13.0-next.6",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
@@ -19,7 +21,7 @@
     "@player-ui/common-types-plugin": "workspace:*"
   },
   "peerDependencies": {
-    "@player-ui/player": "0.13.0-next.5"
+    "@player-ui/player": "0.13.0-next.6"
   },
   "module": "dist/index.legacy-esm.js",
   "types": "types/index.d.ts",

package/src/__tests__/plugin.test.ts

@@ -0,0 +1,287 @@
+import { Flow, InProgressState, Logger, Player } from "@player-ui/player";
+import { describe, it, expect, beforeEach, vi } from "vitest";
+import { ChatUiDemoPlugin } from "../plugins/chat-ui-demo-plugin";
+import { AsyncNodePlugin } from "@player-ui/async-node-plugin";
+import { ReferenceAssetsPlugin } from "../plugin";
+
+const mockLogger = (): Logger => ({
+  trace: vi.fn(),
+  debug: vi.fn(),
+  error: vi.fn(),
+  info: vi.fn(),
+  warn: vi.fn(),
+});
+
+const makeFlow = (asyncNodeCount: number): Flow => ({
+  id: "flow-with-async",
+  views: [
+    {
+      id: "view",
+      type: "view",
+      values: Array.from({ length: asyncNodeCount }, (_, index) => ({
+        async: true,
+        id: `id-${index}`,
+      })),
+    },
+  ],
+  navigation: {
+    BEGIN: "FlowStart",
+    FlowStart: {
+      startState: "VIEW_1",
+      VIEW_1: {
+        state_type: "VIEW",
+        ref: "view",
+        transitions: {
+          "*": "END_DONE",
+        },
+      },
+      END_DONE: {
+        state_type: "END",
+        outcome: "DONE",
+      },
+    },
+  },
+});
+
+describe("ReferenceAssetsPlugin", () => {
+  let player: Player;
+  let logger: Logger;
+  let asyncPlugin: AsyncNodePlugin;
+
+  beforeEach(() => {
+    logger = mockLogger();
+
+    player = new Player({
+      logger,
+      plugins: [new ReferenceAssetsPlugin()],
+    });
+
+    asyncPlugin = player.findPlugin<AsyncNodePlugin>(AsyncNodePlugin.Symbol)!;
+  });
+
+  describe("ChatUiPlugin", () => {
+    it("should warn when there is no async node to receive the message", async () => {
+      player.start(makeFlow(0));
+      const state = player.getState();
+
+      expect(state.status).toBe("in-progress");
+      (state as InProgressState).controllers.expression.evaluate(
+        "send('message')",
+      );
+
+      await vi.waitFor(() => {
+        expect(logger.warn).toHaveBeenCalledOnce();
+        expect(logger.warn).toHaveBeenCalledWith(
+          "'send' called with no waiting async nodes",
+        );
+      });
+    });
+
+    it("should warn when there is no async node that matches the given id", async () => {
+      player.start(makeFlow(1));
+      const state = player.getState();
+
+      expect(state.status).toBe("in-progress");
+      (state as InProgressState).controllers.expression.evaluate(
+        "send('message', 'Not a real id')",
+      );
+
+      await vi.waitFor(() => {
+        expect(logger.warn).toHaveBeenCalledOnce();
+        expect(logger.warn).toHaveBeenCalledWith(
+          "'send' expression called with unrecognized id 'Not a real id'",
+        );
+      });
+    });
+
+    it("should resolve all async node to a chat message when the send expression is called without an id", async () => {
+      const asyncHookTap = vi.fn();
+      asyncPlugin.hooks.onAsyncNode.intercept({
+        context: false,
+        call: asyncHookTap,
+      });
+      player.start(makeFlow(2));
+
+      await vi.waitFor(() => {
+        expect(asyncHookTap).toHaveBeenCalledTimes(2);
+      });
+
+      const state = player.getState();
+
+      expect(state.status).toBe("in-progress");
+      (state as InProgressState).controllers.expression.evaluate(
+        "send('message')",
+      );
+
+      await vi.waitFor(() => {
+        const nextState = player.getState();
+        expect(nextState.status).toBe("in-progress");
+        const inProgress = nextState as InProgressState;
+        const view = inProgress.controllers.view.currentView?.lastUpdate;
+        expect(view).toBeDefined();
+        // Don't need to test the whole view, just that the values array has been updated with the results of the 'send' command
+        expect(view).toStrictEqual(
+          expect.objectContaining({
+            values: [
+              {
+                asset: {
+                  type: "collection",
+                  id: "collection-async-message-0",
+                  values: [
+                    {
+                      asset: {
+                        id: "message-0-value",
+                        type: "text",
+                        value: "message",
+                      },
+                    },
+                  ],
+                },
+              },
+              {
+                asset: {
+                  type: "collection",
+                  id: "collection-async-message-1",
+                  values: [
+                    {
+                      asset: {
+                        id: "message-1-value",
+                        type: "text",
+                        value: "message",
+                      },
+                    },
+                  ],
+                },
+              },
+            ],
+          }),
+        );
+      });
+    });
+
+    it("should resolve allow for single resolution by id", async () => {
+      const asyncHookTap = vi.fn();
+      asyncPlugin.hooks.onAsyncNode.intercept({
+        context: false,
+        call: asyncHookTap,
+      });
+      player.start(makeFlow(2));
+
+      await vi.waitFor(() => {
+        expect(asyncHookTap).toHaveBeenCalledTimes(2);
+      });
+
+      let state = player.getState();
+
+      expect(state.status).toBe("in-progress");
+      // resolve the second async node by targeting it by id
+      (state as InProgressState).controllers.expression.evaluate(
+        "send('first resolve', 'id-1')",
+      );
+
+      await vi.waitFor(() => {
+        const nextState = player.getState();
+        expect(nextState.status).toBe("in-progress");
+        const inProgress = nextState as InProgressState;
+        const view = inProgress.controllers.view.currentView?.lastUpdate;
+        expect(view).toBeDefined();
+        // Don't need to test the whole view, just that the values array has been updated with the results of the 'send' command
+        expect(view).toStrictEqual(
+          expect.objectContaining({
+            values: [
+              {
+                asset: {
+                  type: "collection",
+                  id: "collection-async-message-0",
+                  values: [
+                    {
+                      asset: {
+                        id: "message-0-value",
+                        type: "text",
+                        value: "first resolve",
+                      },
+                    },
+                  ],
+                },
+              },
+            ],
+          }),
+        );
+      });
+
+      state = player.getState();
+
+      expect(state.status).toBe("in-progress");
+      // resolve the first async node and the new one generated by the last chat-message by allowing the plugin to resolve remaining nodes.
+      (state as InProgressState).controllers.expression.evaluate(
+        "send('second resolve')",
+      );
+
+      await vi.waitFor(() => {
+        const nextState = player.getState();
+        expect(nextState.status).toBe("in-progress");
+        const inProgress = nextState as InProgressState;
+        const view = inProgress.controllers.view.currentView?.lastUpdate;
+        expect(view).toBeDefined();
+        // Don't need to test the whole view, just that the values array has been updated with the results of the 'send' command
+        expect(view).toStrictEqual(
+          expect.objectContaining({
+            values: [
+              {
+                asset: {
+                  type: "collection",
+                  id: "collection-async-message-1",
+                  values: [
+                    {
+                      asset: {
+                        id: "message-1-value",
+                        type: "text",
+                        value: "second resolve",
+                      },
+                    },
+                  ],
+                },
+              },
+              {
+                asset: {
+                  type: "collection",
+                  id: "collection-async-message-0",
+                  values: [
+                    {
+                      asset: {
+                        id: "message-0-value",
+                        type: "text",
+                        value: "first resolve",
+                      },
+                    },
+                    {
+                      asset: {
+                        id: "message-2-value",
+                        type: "text",
+                        value: "second resolve",
+                      },
+                    },
+                  ],
+                },
+              },
+            ],
+          }),
+        );
+      });
+    });
+  });
+});
+
+describe("ChatUiDemoPlugin - Failed Setup", () => {
+  it("should warn if the async node plugin is not found", () => {
+    const logger = mockLogger();
+    new Player({
+      logger,
+      plugins: [new ChatUiDemoPlugin()],
+    });
+
+    expect(logger.warn).toHaveBeenCalledWith(
+      "Failed to apply 'chat-ui-demo-plugin'. Reason: Could not find AsyncNodePlugin.",
+    );
+  });
+});

package/src/assets/chat-message/transform.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/ban-ts-comment */
 import type {
   BeforeTransformFunction,
   TransformFunctions,

package/src/plugin.ts

@@ -1,54 +1,26 @@
-import type { Player, ExtendedPlayerPlugin } from "@player-ui/player";
-import { AssetTransformPlugin } from "@player-ui/asset-transform-plugin";
-import type {
-  ActionAsset,
-  InputAsset,
-  ImageAsset,
-  InfoAsset,
-  TextAsset,
-  CollectionAsset,
-  ChoiceAsset,
-  ChatMessageAsset,
-} from "./assets";
+import type { Player, PlayerPlugin } from "@player-ui/player";
+import { MetaPlugin } from "@player-ui/meta-plugin";
+import { ChatUiDemoPlugin, ReferenceAssetsTransformPlugin } from "./plugins";
 import {
-  inputTransform,
-  actionTransform,
-  imageTransform,
-  infoTransform,
-  choiceTransform,
-  chatMessageTransform,
-} from "./assets";
+  AsyncNodePlugin,
+  AsyncNodePluginPlugin,
+} from "@player-ui/async-node-plugin";
 
 /**
  * A plugin to add transforms for the reference assets
  */
-export class ReferenceAssetsPlugin
-  implements
-    ExtendedPlayerPlugin<
-      [
-        ActionAsset,
-        InputAsset,
-        ImageAsset,
-        TextAsset,
-        CollectionAsset,
-        ChoiceAsset,
-        ChatMessageAsset,
-      ],
-      [InfoAsset]
-    >
-{
-  name = "reference-assets-transforms";
+export class ReferenceAssetsPlugin implements PlayerPlugin {
+  name = "reference-assets-plugin";
 
-  apply(player: Player) {
-    player.registerPlugin(
-      new AssetTransformPlugin([
-        [{ type: "action" }, actionTransform],
-        [{ type: "input" }, inputTransform],
-        [{ type: "image" }, imageTransform],
-        [{ type: "info" }, infoTransform],
-        [{ type: "choice" }, choiceTransform],
-        [{ type: "chat-message" }, chatMessageTransform],
-      ]),
-    );
+  private readonly metaPlugin = new MetaPlugin([
+    new AsyncNodePlugin({
+      plugins: [new AsyncNodePluginPlugin()],
+    }),
+    new ReferenceAssetsTransformPlugin(),
+    new ChatUiDemoPlugin(),
+  ]);
+
+  apply(player: Player): void {
+    player.registerPlugin(this.metaPlugin);
   }
 }

package/src/plugins/chat-ui-demo-plugin.ts

@@ -0,0 +1,101 @@
+import { AsyncNodePlugin } from "@player-ui/async-node-plugin";
+import {
+  ExpressionContext,
+  ExtendedPlayerPlugin,
+  Player,
+} from "@player-ui/player";
+import { ExpressionPlugin } from "@player-ui/expression-plugin";
+import { send } from "./send";
+
+const createContentFromMessage = (message: string, id: string): any => ({
+  asset: {
+    type: "chat-message",
+    id,
+    value: {
+      asset: {
+        type: "text",
+        id: `${id}-value`,
+        value: message,
+      },
+    },
+  },
+});
+
+export class ChatUiDemoPlugin implements ExtendedPlayerPlugin<[], [], [send]> {
+  public readonly name = "chat-ui-demo-plugin";
+
+  public apply(player: Player): void {
+    const asyncNodePlugin = player.findPlugin<AsyncNodePlugin>(
+      AsyncNodePlugin.Symbol,
+    );
+
+    if (!asyncNodePlugin) {
+      player.logger.warn(
+        `Failed to apply '${this.name}'. Reason: Could not find AsyncNodePlugin.`,
+      );
+      return;
+    }
+
+    let deferredPromises: Record<string, (val: string) => void> = {};
+    let allPromiseKeys: string[] = [];
+    let counter = 0;
+
+    const sendMessage: send = (
+      context: ExpressionContext,
+      message: string,
+      nodeId?: string,
+    ): void => {
+      if (nodeId && !(nodeId in deferredPromises)) {
+        context.logger?.warn(
+          `'send' expression called with unrecognized id '${nodeId}'`,
+        );
+        return;
+      }
+
+      if (!nodeId && allPromiseKeys.length === 0) {
+        context.logger?.warn(`'send' called with no waiting async nodes`);
+        return;
+      }
+
+      // Either resolve the node by the id or resolve all of them if no id provided
+      const keys = nodeId ? [nodeId] : allPromiseKeys;
+
+      for (const id of keys) {
+        const content = createContentFromMessage(
+          message,
+          `message-${counter++}`,
+        );
+        const resolveFunction = deferredPromises[id];
+        resolveFunction?.(content);
+        delete deferredPromises[id];
+      }
+
+      if (nodeId) {
+        const index = allPromiseKeys.indexOf(nodeId);
+        allPromiseKeys.splice(index, 1);
+      } else {
+        allPromiseKeys = [];
+      }
+    };
+
+    asyncNodePlugin.hooks.onAsyncNode.tap(this.name, (node) => {
+      return new Promise((res) => {
+        deferredPromises[node.id] = res;
+        allPromiseKeys.push(node.id);
+      });
+    });
+
+    // Reset at the start of a new view.
+    player.hooks.view.tap(this.name, (_) => {
+      deferredPromises = {};
+      allPromiseKeys = [];
+      counter = 0;
+    });
+
+    // Register 'send' expression
+    const expressionPlugin = new ExpressionPlugin(
+      new Map([["send", sendMessage]]),
+    );
+    player.registerPlugin(expressionPlugin);
+  }
+}

package/src/plugins/index.ts

@@ -0,0 +1,2 @@
+export * from "./chat-ui-demo-plugin";
+export * from "./reference-assets-transform-plugin";

package/src/plugins/reference-assets-transform-plugin.ts

@@ -0,0 +1,51 @@
+import type { ExtendedPlayerPlugin, Player } from "@player-ui/player";
+import { AssetTransformPlugin } from "@player-ui/asset-transform-plugin";
+import {
+  actionTransform,
+  chatMessageTransform,
+  choiceTransform,
+  imageTransform,
+  infoTransform,
+  inputTransform,
+} from "../assets";
+import type {
+  ActionAsset,
+  ChatMessageAsset,
+  ChoiceAsset,
+  CollectionAsset,
+  ImageAsset,
+  InfoAsset,
+  InputAsset,
+  TextAsset,
+} from "../assets";
+
+export class ReferenceAssetsTransformPlugin
+  implements
+    ExtendedPlayerPlugin<
+      [
+        ActionAsset,
+        InputAsset,
+        ImageAsset,
+        TextAsset,
+        CollectionAsset,
+        ChoiceAsset,
+        ChatMessageAsset,
+      ],
+      [InfoAsset]
+    >
+{
+  name = "reference-assets-transforms";
+
+  apply(player: Player): void {
+    player.registerPlugin(
+      new AssetTransformPlugin([
+        [{ type: "action" }, actionTransform],
+        [{ type: "input" }, inputTransform],
+        [{ type: "image" }, imageTransform],
+        [{ type: "info" }, infoTransform],
+        [{ type: "choice" }, choiceTransform],
+        [{ type: "chat-message" }, chatMessageTransform],
+      ]),
+    );
+  }
+}

package/src/plugins/send.ts

@@ -0,0 +1,3 @@
+import type { ExpressionHandler } from "@player-ui/player";
+
+export type send = ExpressionHandler<[string, string | undefined]>;

package/types/plugin.d.ts

@@ -1,20 +1,10 @@
-import type { Player, ExtendedPlayerPlugin } from "@player-ui/player";
-import type { ActionAsset, InputAsset, ImageAsset, InfoAsset, TextAsset, CollectionAsset, ChoiceAsset, ChatMessageAsset } from "./assets";
+import type { Player, PlayerPlugin } from "@player-ui/player";
 /**
  * A plugin to add transforms for the reference assets
  */
-export declare class ReferenceAssetsPlugin implements ExtendedPlayerPlugin<[
-    ActionAsset,
-    InputAsset,
-    ImageAsset,
-    TextAsset,
-    CollectionAsset,
-    ChoiceAsset,
-    ChatMessageAsset
-], [
-    InfoAsset
-]> {
+export declare class ReferenceAssetsPlugin implements PlayerPlugin {
     name: string;
+    private readonly metaPlugin;
     apply(player: Player): void;
 }
 //# sourceMappingURL=plugin.d.ts.map

package/types/plugins/chat-ui-demo-plugin.d.ts

@@ -0,0 +1,7 @@
+import { ExtendedPlayerPlugin, Player } from "@player-ui/player";
+import { send } from "./send";
+export declare class ChatUiDemoPlugin implements ExtendedPlayerPlugin<[], [], [send]> {
+    readonly name = "chat-ui-demo-plugin";
+    apply(player: Player): void;
+}
+//# sourceMappingURL=chat-ui-demo-plugin.d.ts.map