@player-ui/reference-assets-plugin 0.7.4-next.4 → 0.7.5--canary.434.14868

package/dist/xlr/InfoAsset.json

@@ -0,0 +1,58 @@
+{
+    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/2147/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/info/types.ts",
+    "name": "InfoAsset",
+    "type": "object",
+    "properties": {
+        "title": {
+            "required": false,
+            "node": {
+                "type": "ref",
+                "ref": "AssetWrapper",
+                "title": "InfoAsset.title",
+                "description": "The string value to show"
+            }
+        },
+        "subTitle": {
+            "required": false,
+            "node": {
+                "type": "ref",
+                "ref": "AssetWrapper",
+                "title": "InfoAsset.subTitle",
+                "description": "subtitle"
+            }
+        },
+        "primaryInfo": {
+            "required": false,
+            "node": {
+                "type": "ref",
+                "ref": "AssetWrapper",
+                "title": "InfoAsset.primaryInfo",
+                "description": "Primary place for info"
+            }
+        },
+        "actions": {
+            "required": false,
+            "node": {
+                "type": "array",
+                "elementType": {
+                    "type": "ref",
+                    "ref": "AssetWrapper"
+                },
+                "title": "InfoAsset.actions",
+                "description": "List of actions to show at the bottom of the page"
+            }
+        }
+    },
+    "additionalProperties": false,
+    "title": "InfoAsset",
+    "extends": {
+        "type": "ref",
+        "ref": "Asset<\"info\">",
+        "genericArguments": [
+            {
+                "type": "string",
+                "const": "info"
+            }
+        ]
+    }
+}

package/dist/xlr/InputAsset.json

@@ -0,0 +1,109 @@
+{
+    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/2147/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/input/types.ts",
+    "name": "InputAsset",
+    "type": "object",
+    "properties": {
+        "label": {
+            "required": false,
+            "node": {
+                "type": "ref",
+                "ref": "AssetWrapper<AnyTextAsset>",
+                "genericArguments": [
+                    {
+                        "type": "ref",
+                        "ref": "AnyTextAsset"
+                    }
+                ],
+                "title": "InputAsset.label",
+                "description": "Asset container for a field label."
+            }
+        },
+        "note": {
+            "required": false,
+            "node": {
+                "type": "ref",
+                "ref": "AssetWrapper<AnyTextAsset>",
+                "genericArguments": [
+                    {
+                        "type": "ref",
+                        "ref": "AnyTextAsset"
+                    }
+                ],
+                "title": "InputAsset.note",
+                "description": "Asset container for a note."
+            }
+        },
+        "binding": {
+            "required": true,
+            "node": {
+                "type": "ref",
+                "ref": "Binding",
+                "title": "InputAsset.binding",
+                "description": "The location in the data-model to store the data"
+            }
+        },
+        "metaData": {
+            "required": false,
+            "node": {
+                "type": "object",
+                "properties": {
+                    "beacon": {
+                        "required": false,
+                        "node": {
+                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/2147/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": [
+                                {
+                                    "type": "string",
+                                    "title": "BeaconDataType"
+                                },
+                                {
+                                    "type": "record",
+                                    "keyType": {
+                                        "type": "string"
+                                    },
+                                    "valueType": {
+                                        "type": "any"
+                                    },
+                                    "title": "BeaconDataType"
+                                }
+                            ],
+                            "title": "InputAsset.metaData.beacon",
+                            "description": "Additional data to beacon when this input changes"
+                        }
+                    }
+                },
+                "additionalProperties": false,
+                "title": "InputAsset.metaData",
+                "description": "Optional additional data"
+            }
+        }
+    },
+    "additionalProperties": false,
+    "title": "InputAsset",
+    "description": "This is the most generic way of gathering data. The input is bound to a data model using the 'binding' property.\nPlayers can get field type information from the 'schema' definition, thus to decide the input controls for visual rendering.",
+    "genericTokens": [
+        {
+            "symbol": "AnyTextAsset",
+            "constraints": {
+                "type": "ref",
+                "ref": "Asset"
+            },
+            "default": {
+                "type": "ref",
+                "ref": "Asset"
+            }
+        }
+    ],
+    "extends": {
+        "type": "ref",
+        "ref": "Asset<\"input\">",
+        "genericArguments": [
+            {
+                "type": "string",
+                "const": "input"
+            }
+        ]
+    }
+}

package/dist/xlr/TextAsset.json

@@ -0,0 +1,125 @@
+{
+    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/2147/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+    "name": "TextAsset",
+    "type": "object",
+    "properties": {
+        "value": {
+            "required": true,
+            "node": {
+                "type": "string",
+                "title": "TextAsset.value",
+                "description": "The text to display"
+            }
+        },
+        "modifiers": {
+            "required": false,
+            "node": {
+                "type": "array",
+                "elementType": {
+                    "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/2147/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/2147/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+                            "name": "BasicTextModifier",
+                            "type": "object",
+                            "properties": {
+                                "type": {
+                                    "required": true,
+                                    "node": {
+                                        "type": "string",
+                                        "title": "BasicTextModifier.type",
+                                        "description": "The modifier type"
+                                    }
+                                },
+                                "name": {
+                                    "required": false,
+                                    "node": {
+                                        "type": "string",
+                                        "title": "BasicTextModifier.name",
+                                        "description": "Modifiers can be named when used in strings"
+                                    }
+                                }
+                            },
+                            "additionalProperties": {
+                                "type": "unknown"
+                            },
+                            "title": "BasicTextModifier"
+                        },
+                        {
+                            "source": "/home/circleci/.cache/bazel/_bazel_circleci/e8362d362e14c7d23506d1dfa3aea8b8/sandbox/processwrapper-sandbox/2147/execroot/_main/bazel-out/k8-fastbuild/bin/plugins/reference-assets/core/src/assets/text/types.ts",
+                            "name": "LinkModifier",
+                            "type": "object",
+                            "properties": {
+                                "type": {
+                                    "required": true,
+                                    "node": {
+                                        "type": "string",
+                                        "const": "link",
+                                        "title": "LinkModifier.type",
+                                        "description": "The link type denotes this as a link"
+                                    }
+                                },
+                                "exp": {
+                                    "required": false,
+                                    "node": {
+                                        "type": "ref",
+                                        "ref": "Expression",
+                                        "title": "LinkModifier.exp",
+                                        "description": "An optional expression to run before the link is opened"
+                                    }
+                                },
+                                "metaData": {
+                                    "required": true,
+                                    "node": {
+                                        "type": "object",
+                                        "properties": {
+                                            "ref": {
+                                                "required": true,
+                                                "node": {
+                                                    "type": "string",
+                                                    "title": "LinkModifier.metaData.ref",
+                                                    "description": "The location of the link to load"
+                                                }
+                                            },
+                                            "\"mime-type\"": {
+                                                "required": false,
+                                                "node": {
+                                                    "type": "string",
+                                                    "title": "LinkModifier.metaData.\"mime-type\"",
+                                                    "description": "Used to indicate an application specific resolver to use"
+                                                }
+                                            }
+                                        },
+                                        "additionalProperties": false,
+                                        "title": "LinkModifier.metaData",
+                                        "description": "metaData about the link's target"
+                                    }
+                                }
+                            },
+                            "additionalProperties": false,
+                            "title": "LinkModifier",
+                            "description": "A modifier to turn the text into a link"
+                        }
+                    ],
+                    "title": "TextModifier"
+                },
+                "title": "TextAsset.modifiers",
+                "description": "Any modifiers on the text"
+            }
+        }
+    },
+    "additionalProperties": false,
+    "title": "TextAsset",
+    "extends": {
+        "type": "ref",
+        "ref": "Asset<\"text\">",
+        "genericArguments": [
+            {
+                "type": "string",
+                "const": "text"
+            }
+        ]
+    }
+}

package/dist/xlr/manifest.js

@@ -0,0 +1,18 @@
+const ActionAsset = require("./ActionAsset.json")
+const InputAsset = require("./InputAsset.json")
+const ImageAsset = require("./ImageAsset.json")
+const TextAsset = require("./TextAsset.json")
+const CollectionAsset = require("./CollectionAsset.json")
+const ChoiceAsset = require("./ChoiceAsset.json")
+const InfoAsset = require("./InfoAsset.json")
+
+    module.exports = {
+      "pluginName": "reference-assets-transforms",
+      "capabilities": {
+        "Assets":[ActionAsset,InputAsset,ImageAsset,TextAsset,CollectionAsset,ChoiceAsset],
+		"Views":[InfoAsset],
+      },
+      "customPrimitives": [
+        "Expression","Asset","Binding","AssetWrapper","Schema.DataType","ExpressionHandler"
+      ]
+    }

package/dist/xlr/manifest.json

@@ -0,0 +1,24 @@
+{
+    "pluginName": "reference-assets-transforms",
+    "capabilities": {
+        "Assets": [
+            "ActionAsset",
+            "InputAsset",
+            "ImageAsset",
+            "TextAsset",
+            "CollectionAsset",
+            "ChoiceAsset"
+        ],
+        "Views": [
+            "InfoAsset"
+        ]
+    },
+    "customPrimitives": [
+        "Expression",
+        "Asset",
+        "Binding",
+        "AssetWrapper",
+        "Schema.DataType",
+        "ExpressionHandler"
+    ]
+}

package/package.json

@@ -1,68 +1,35 @@
 {
   "name": "@player-ui/reference-assets-plugin",
-  "version": "0.7.4-next.4",
-  "private": false,
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
-  "peerDependencies": {
-    "@player-ui/player": "0.7.4-next.4"
-  },
+  "version": "0.7.5--canary.434.14868",
+  "main": "dist/cjs/index.cjs",
   "dependencies": {
-    "@player-ui/beacon-plugin": "0.7.4-next.4",
-    "@player-ui/asset-transform-plugin": "0.7.4-next.4",
-    "@babel/runtime": "7.15.4"
+    "@player-ui/asset-transform-plugin": "0.7.5--canary.434.14868",
+    "@player-ui/beacon-plugin": "0.7.5--canary.434.14868",
+    "tslib": "^2.6.2"
   },
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "typings": "dist/index.d.ts",
-  "sideEffects": false,
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/player-ui/player-ui"
+  "devDependencies": {
+    "@player-ui/asset-testing-library": "workspace:*",
+    "@player-ui/common-types-plugin": "workspace:*"
   },
-  "bugs": {
-    "url": "https://github.com/player-ui/player-ui/issues"
+  "peerDependencies": {
+    "@player-ui/player": "0.7.5--canary.434.14868"
   },
-  "homepage": "https://player-ui.github.io",
-  "contributors": [
-    {
-      "name": "Adam Dierkens",
-      "url": "https://github.com/adierkens"
-    },
-    {
-      "name": "Spencer Hamm",
-      "url": "https://github.com/spentacular"
-    },
-    {
-      "name": "Harris Borawski",
-      "url": "https://github.com/hborawski"
-    },
-    {
-      "name": "Jeremiah Zucker",
-      "url": "https://github.com/sugarmanz"
-    },
-    {
-      "name": "Ketan Reddy",
-      "url": "https://github.com/KetanReddy"
-    },
-    {
-      "name": "Brocollie08",
-      "url": "https://github.com/brocollie08"
-    },
-    {
-      "name": "Kelly Harrop",
-      "url": "https://github.com/kharrop"
-    },
-    {
-      "name": "Alejandro Fimbres",
-      "url": "https://github.com/lexfm"
-    },
-    {
-      "name": "Rafael Campos",
-      "url": "https://github.com/rafbcampos"
+  "module": "dist/index.legacy-esm.js",
+  "types": "types/index.d.ts",
+  "bundle": "dist/ReferenceAssetsPlugin.native.js",
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    "./dist/index.css": "./dist/index.css",
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/cjs/index.cjs"
     }
-  ],
-  "bundle": "./dist/reference-assets-plugin.prod.js"
+  },
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ]
 }

package/src/assets/action/__tests__/transform.test.ts

@@ -0,0 +1,118 @@
+import { describe, it, expect } from "vitest";
+import { runTransform } from "@player-ui/asset-testing-library";
+import type { InProgressState } from "@player-ui/player";
+import { actionTransform } from "..";
+
+describe("action transform", () => {
+  it("adds a run method that evals an expression", () => {
+    const ref = runTransform("action", actionTransform, {
+      type: "action",
+      exp: "{{count}} = 100",
+      id: "action",
+    });
+
+    ref.current?.run();
+
+    expect(ref.controllers?.data.get("count")).toBe(100);
+  });
+
+  it("transitions between things", async () => {
+    const ref = runTransform("action", actionTransform, {
+      id: "test-flow",
+      views: [
+        {
+          type: "action",
+          id: "view-1",
+          value: "Next",
+        },
+        {
+          type: "action",
+          id: "view-2",
+          value: "Next",
+        },
+      ],
+      navigation: {
+        BEGIN: "FLOW_1",
+        FLOW_1: {
+          startState: "view_1",
+          view_1: {
+            state_type: "VIEW",
+            ref: "view-1",
+            transitions: {
+              "*": "view_2",
+            },
+          },
+          view_2: {
+            state_type: "VIEW",
+            ref: "view-2",
+            transitions: {
+              "*": "end",
+            },
+          },
+          end: {
+            state_type: "END",
+            outcome: "done",
+          },
+        },
+      },
+    });
+
+    expect(ref.current?.id).toBe("view-1");
+    ref.current?.run();
+    expect(ref.current?.id).toBe("view-2");
+    ref.current?.run();
+
+    await (ref.player.getState() as InProgressState).flowResult;
+    expect(ref.player.getState().status).toBe("completed");
+  });
+
+  it("prev button transitions", async () => {
+    const ref = runTransform("action", actionTransform, {
+      id: "test-flow",
+      views: [
+        {
+          type: "action",
+          id: "view-1",
+          value: "Prev",
+        },
+        {
+          type: "action",
+          id: "view-2",
+          value: "Prev",
+        },
+      ],
+      navigation: {
+        BEGIN: "FLOW_1",
+        FLOW_1: {
+          startState: "view_1",
+          view_1: {
+            state_type: "VIEW",
+            ref: "view-1",
+            transitions: {
+              "*": "view_2",
+            },
+          },
+          view_2: {
+            state_type: "VIEW",
+            ref: "view-2",
+            transitions: {
+              "*": "end",
+            },
+          },
+          end: {
+            state_type: "END",
+            outcome: "done",
+          },
+        },
+      },
+    });
+    expect(ref?.current?.metaData?.role).toBe("back");
+    expect(ref.current?.id).toBe("view-1");
+    ref.current?.run();
+    expect(ref.current?.id).toBe("view-2");
+    ref.current?.run();
+
+    await (ref.player.getState() as InProgressState).flowResult;
+    expect(ref.player.getState().status).toBe("completed");
+  });
+});

package/src/assets/action/index.ts

@@ -1,2 +1,2 @@
-export * from './transform';
-export * from './types';
+export * from "./transform";
+export * from "./types";

package/src/assets/action/transform.ts

@@ -2,15 +2,15 @@ import type {
   Asset,
   TransformFunction,
   BeforeTransformFunction,
-} from '@player-ui/player';
-import { compose, composeBefore } from '@player-ui/asset-transform-plugin';
-import type { ActionAsset, TransformedAction } from './types';
+} from "@player-ui/player";
+import { compose, composeBefore } from "@player-ui/asset-transform-plugin";
+import type { ActionAsset, TransformedAction } from "./types";
 
 /**
  * Function to find prev button
  */
 export function isBackAction(action: ActionAsset): boolean {
-  return action.value === 'Prev';
+  return action.value === "Prev";
 }
 
 /**
@@ -18,7 +18,7 @@ export function isBackAction(action: ActionAsset): boolean {
  */
 const transform: TransformFunction<ActionAsset, TransformedAction> = (
   action,
-  options
+  options,
 ) => {
   return {
     ...action,
@@ -39,7 +39,7 @@ const transform: TransformFunction<ActionAsset, TransformedAction> = (
  * De couples back button from the back icon
  */
 const backIconTransform: TransformFunction<ActionAsset, ActionAsset> = (
-  action
+  action,
 ) => {
   /** For previous versions of player, the back button would already have the back icon.
    *  This ensures that the old functionality does not break and back button is still visible when they update the player.
@@ -49,7 +49,7 @@ const backIconTransform: TransformFunction<ActionAsset, ActionAsset> = (
       ...action,
       metaData: {
         ...action?.metaData,
-        role: 'back',
+        role: "back",
       },
     };
   }
@@ -65,7 +65,7 @@ const backIconTransform: TransformFunction<ActionAsset, ActionAsset> = (
 export const expPropTransform: BeforeTransformFunction<Asset> = (asset) => {
   const skipArray = asset.plugins?.stringResolver?.propertiesToSkip;
 
-  if (skipArray && skipArray.indexOf('exp') > 1) {
+  if (skipArray && skipArray.indexOf("exp") > 1) {
     return asset;
   }
 
@@ -77,7 +77,7 @@ export const expPropTransform: BeforeTransformFunction<Asset> = (asset) => {
         ...asset?.plugins?.stringResolver,
         propertiesToSkip: [
           ...(asset.plugins?.stringResolver?.propertiesToSkip ?? []),
-          'exp',
+          "exp",
         ],
       },
     },
@@ -87,5 +87,5 @@ export const expPropTransform: BeforeTransformFunction<Asset> = (asset) => {
 export const actionTransform = compose(
   transform,
   backIconTransform,
-  composeBefore(expPropTransform)
+  composeBefore(expPropTransform),
 );

package/src/assets/action/types.ts

@@ -1,5 +1,5 @@
-import type { Asset, AssetWrapper, Expression } from '@player-ui/player';
-import type { BeaconDataType } from '@player-ui/beacon-plugin';
+import type { Asset, AssetWrapper, Expression } from "@player-ui/player";
+import type { BeaconDataType } from "@player-ui/beacon-plugin";
 
 /**
  * User actions can be represented in several places.
@@ -7,7 +7,7 @@ import type { BeaconDataType } from '@player-ui/beacon-plugin';
  * In addition, several asset types can have actions that apply to that asset only.
  */
 export interface ActionAsset<AnyTextAsset extends Asset = Asset>
-  extends Asset<'action'> {
+  extends Asset<"action"> {
   /** The transition value of the action in the state machine */
   value?: string;