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

package/src/plugin.ts

@@ -1,26 +1,50 @@
-import type { Player, PlayerPlugin } from '@player-ui/player';
-import { AssetTransformPlugin } from '@player-ui/asset-transform-plugin';
+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,
+} from "./assets";
 import {
   inputTransform,
   actionTransform,
   imageTransform,
   infoTransform,
-} from './assets';
+  choiceTransform,
+} from "./assets";
 
 /**
  * A plugin to add transforms for the reference assets
  */
-export class ReferenceAssetsPlugin implements PlayerPlugin {
-  name = 'reference-assets-transforms';
+export class ReferenceAssetsPlugin
+  implements
+    ExtendedPlayerPlugin<
+      [
+        ActionAsset,
+        InputAsset,
+        ImageAsset,
+        TextAsset,
+        CollectionAsset,
+        ChoiceAsset,
+      ],
+      [InfoAsset]
+    >
+{
+  name = "reference-assets-transforms";
 
   apply(player: Player) {
     player.registerPlugin(
       new AssetTransformPlugin([
-        [{ type: 'action' }, actionTransform],
-        [{ type: 'input' }, inputTransform],
-        [{ type: 'image' }, imageTransform],
-        [{ type: 'info' }, infoTransform],
-      ])
+        [{ type: "action" }, actionTransform],
+        [{ type: "input" }, inputTransform],
+        [{ type: "image" }, imageTransform],
+        [{ type: "info" }, infoTransform],
+        [{ type: "choice" }, choiceTransform],
+      ]),
     );
   }
 }

package/types/assets/action/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./transform";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/action/transform.d.ts

@@ -0,0 +1,14 @@
+import type { Asset, BeforeTransformFunction } from "@player-ui/player";
+import type { ActionAsset } from "./types";
+/**
+ * Function to find prev button
+ */
+export declare function isBackAction(action: ActionAsset): boolean;
+/**
+ * Appends `exp` to the plugins.stringResolver.propertiesToSkip array or creates it if it doesn't exist
+ *
+ * @param asset - Asset to apply the transform to
+ */
+export declare const expPropTransform: BeforeTransformFunction<Asset>;
+export declare const actionTransform: import("@player-ui/player").TransformFunctions;
+//# sourceMappingURL=transform.d.ts.map

package/types/assets/action/types.d.ts

@@ -0,0 +1,32 @@
+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.
+ * Each view typically has one or more actions that allow the user to navigate away from that view.
+ * In addition, several asset types can have actions that apply to that asset only.
+ */
+export interface ActionAsset<AnyTextAsset extends Asset = Asset> extends Asset<"action"> {
+    /** The transition value of the action in the state machine */
+    value?: string;
+    /** A text-like asset for the action's label */
+    label?: AssetWrapper<AnyTextAsset>;
+    /** An optional expression to execute before transitioning */
+    exp?: Expression;
+    /** An optional string that describes the action for screen-readers */
+    accessibility?: string;
+    /** Additional optional data to assist with the action interactions on the page */
+    metaData?: {
+        /** Additional data to beacon */
+        beacon?: BeaconDataType;
+        /** Force transition to the next view without checking for validation */
+        skipValidation?: boolean;
+        /** string value to decide for the left anchor sign */
+        role?: string;
+    };
+}
+/** A stateful instance of an action */
+export interface TransformedAction extends ActionAsset {
+    /** A method to execute the action */
+    run: () => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/assets/choice/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./transform";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/choice/transform.d.ts

@@ -0,0 +1,7 @@
+import type { TransformFunction } from "@player-ui/player";
+import type { ChoiceAsset, TransformedChoice } from "./types";
+/**
+ * Docs about the asset transform
+ */
+export declare const choiceTransform: TransformFunction<ChoiceAsset, TransformedChoice>;
+//# sourceMappingURL=transform.d.ts.map

package/types/assets/choice/types.d.ts

@@ -0,0 +1,51 @@
+import type { Asset, AssetWrapper, Binding, ValidationResponse, Schema } from "@player-ui/player";
+import type { BeaconMetaData } from "@player-ui/beacon-plugin";
+/**
+ * A choice asset represents a single selection choice, often displayed as radio buttons in a web context.
+ * This will allow users to test out more complex flows than just inputs + buttons.
+ */
+export interface ChoiceAsset<AnyTextAsset extends Asset = Asset> extends Asset<"choice"> {
+    /** A text-like asset for the choice's label */
+    title?: AssetWrapper<AnyTextAsset>;
+    /** Asset container for a note. */
+    note?: AssetWrapper<AnyTextAsset>;
+    /** The location in the data-model to store the data */
+    binding?: Binding;
+    /** The options to select from */
+    items?: Array<ChoiceItem>;
+    /** Optional additional data */
+    metaData?: BeaconMetaData;
+}
+export type ValueType = string | number | boolean | null;
+export interface ChoiceItem<AnyTextAsset extends Asset = Asset> {
+    /** The id associated with the choice item */
+    id: string;
+    /** A text-like asset for the choice's label */
+    label?: AssetWrapper<AnyTextAsset>;
+    /** The value of the input from the data-model */
+    value?: ValueType;
+}
+/** A stateful instance of a choice */
+export interface TransformedChoice extends ChoiceAsset {
+    /**
+     * A function to unselect all of the options
+     * This is typically used when selecting a placeholder value
+     */
+    clearSelection: () => void;
+    /** The transformed options to select from */
+    items?: Array<TransformedChoiceItem>;
+    /** The value of the selected choice from the data-model */
+    value?: ValueType;
+    /** Any validation associated with the current choice's value */
+    validation?: ValidationResponse;
+    /** The dataType defined from the schema */
+    dataType?: Schema.DataType;
+}
+/** A stateful instance of a Choice Item */
+export interface TransformedChoiceItem extends ChoiceItem {
+    /** The function that is called when a choice item is selected */
+    select: () => void;
+    /** The function that is called when a choice item is unSelected */
+    unselect: () => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/assets/collection/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/collection/types.d.ts

@@ -0,0 +1,8 @@
+import type { AssetWrapper, Asset } from "@player-ui/player";
+export interface CollectionAsset extends Asset<"collection"> {
+    /** An optional label to title the collection */
+    label?: AssetWrapper;
+    /** The string value to show */
+    values?: Array<AssetWrapper>;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/assets/image/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./transform";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/image/transform.d.ts

@@ -0,0 +1,7 @@
+import type { TransformFunction } from "@player-ui/player";
+import type { ImageAsset, TransformedImage } from "./types";
+/**
+ * Sets the Image's placeholder and accessibilty
+ */
+export declare const imageTransform: TransformFunction<ImageAsset, TransformedImage>;
+//# sourceMappingURL=transform.d.ts.map

package/types/assets/image/types.d.ts

@@ -0,0 +1,21 @@
+import type { Asset, AssetWrapper } from "@player-ui/player";
+export interface ImageAsset extends Asset<"image"> {
+    /** Reference to the image */
+    metaData: ImageMetaData;
+    /** Optional placeholder text */
+    placeholder?: string;
+    /** Optional caption */
+    caption?: AssetWrapper;
+}
+/** A modifier to turn the text into a link */
+export interface ImageMetaData {
+    /** The location of the image to load */
+    ref: string;
+    /** Used for accessibility support */
+    accessibility?: string;
+}
+export interface TransformedImage extends ImageAsset {
+    /** Alt text */
+    altText: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/assets/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./input";
+export * from "./action";
+export * from "./collection";
+export * from "./info";
+export * from "./text";
+export * from "./image";
+export * from "./choice";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/info/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./transform";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/info/transform.d.ts

@@ -0,0 +1,8 @@
+import type { TransformFunction } from "@player-ui/player";
+import type { InfoAsset, InfoAssetTransform } from "./types";
+/**
+ * This transform should add segmentedActions to the info asset.
+ * Segmented actions display side by side in larger viewports. Segmented Actions is an object of next and prev actions
+ */
+export declare const infoTransform: TransformFunction<InfoAsset, InfoAssetTransform>;
+//# sourceMappingURL=transform.d.ts.map

package/types/assets/info/types.d.ts

@@ -0,0 +1,28 @@
+import type { AssetWrapper, Asset } from "@player-ui/player";
+import type { ActionAsset } from "../action/types";
+export interface InfoAsset extends Asset<"info"> {
+    /** The string value to show */
+    title?: AssetWrapper;
+    /** subtitle */
+    subTitle?: AssetWrapper;
+    /** Primary place for info  */
+    primaryInfo?: AssetWrapper;
+    /** List of actions to show at the bottom of the page */
+    actions?: Array<AssetWrapper>;
+}
+export interface InfoAssetTransform extends InfoAsset {
+    /**
+     * This is an array of next and prev actions
+     */
+    segmentedActions?: {
+        /**
+         * Array of next actions
+         */
+        next: Array<AssetWrapper<ActionAsset>>;
+        /**
+         * Array of prev actions
+         */
+        prev: Array<AssetWrapper<ActionAsset>>;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/types/assets/input/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./transform";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/input/transform.d.ts

@@ -0,0 +1,7 @@
+import type { TransformFunction } from "@player-ui/player";
+import type { InputAsset, TransformedInput } from "./types";
+/**
+ * Docs about the asset transform
+ */
+export declare const inputTransform: TransformFunction<InputAsset, TransformedInput>;
+//# sourceMappingURL=transform.d.ts.map

package/types/assets/input/types.d.ts

@@ -0,0 +1,34 @@
+import type { Asset, AssetWrapper, Schema, Binding, ValidationResponse } from "@player-ui/player";
+import type { BeaconDataType } from "@player-ui/beacon-plugin";
+/**
+ * This is the most generic way of gathering data. The input is bound to a data model using the 'binding' property.
+ * Players can get field type information from the 'schema' definition, thus to decide the input controls for visual rendering.
+ * */
+export interface InputAsset<AnyTextAsset extends Asset = Asset> extends Asset<"input"> {
+    /** Asset container for a field label. */
+    label?: AssetWrapper<AnyTextAsset>;
+    /** Asset container for a note. */
+    note?: AssetWrapper<AnyTextAsset>;
+    /** The location in the data-model to store the data */
+    binding: Binding;
+    /** Optional additional data */
+    metaData?: {
+        /** Additional data to beacon when this input changes */
+        beacon?: BeaconDataType;
+    };
+}
+type ValueType = string | undefined;
+export interface TransformedInput extends InputAsset {
+    /** A function to commit the new value to the data-model */
+    set: (newValue: ValueType) => void;
+    /** A function to format a value */
+    format: (newValue: ValueType) => ValueType;
+    /** The current value of the input from the data-model */
+    value: ValueType;
+    /** Any validation associated with the current input's value */
+    validation?: ValidationResponse;
+    /** The dataType defined from the schema */
+    dataType?: Schema.DataType;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/types/assets/text/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/types/assets/text/types.d.ts

@@ -0,0 +1,31 @@
+import type { Asset, Expression } from "@player-ui/player";
+export interface TextAsset extends Asset<"text"> {
+    /** The text to display */
+    value: string;
+    /** Any modifiers on the text */
+    modifiers?: Array<TextModifier>;
+}
+export type TextModifier = BasicTextModifier | LinkModifier;
+export interface BasicTextModifier {
+    /** The modifier type */
+    type: string;
+    /** Modifiers can be named when used in strings */
+    name?: string;
+    /** A spot for other metaData or properties */
+    [key: string]: unknown;
+}
+/** A modifier to turn the text into a link */
+export interface LinkModifier {
+    /** The link type denotes this as a link */
+    type: "link";
+    /** An optional expression to run before the link is opened */
+    exp?: Expression;
+    /** metaData about the link's target */
+    metaData: {
+        /** The location of the link to load */
+        ref: string;
+        /** Used to indicate an application specific resolver to use */
+        "mime-type"?: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./assets";
+export * from "./plugin";
+//# sourceMappingURL=index.d.ts.map

package/types/plugin.d.ts

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

package/dist/index.cjs.js

@@ -1,204 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var assetTransformPlugin = require('@player-ui/asset-transform-plugin');
-
-var __defProp$3 = Object.defineProperty;
-var __defProps$3 = Object.defineProperties;
-var __getOwnPropDescs$3 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$3 = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp$3.call(b, prop))
-      __defNormalProp$3(a, prop, b[prop]);
-  if (__getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(b)) {
-      if (__propIsEnum$3.call(b, prop))
-        __defNormalProp$3(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps$3 = (a, b) => __defProps$3(a, __getOwnPropDescs$3(b));
-const inputTransform = (asset, options) => {
-  var _a, _b;
-  return __spreadProps$3(__spreadValues$3({}, asset), {
-    format(val) {
-      if (asset.binding === void 0) {
-        return val;
-      }
-      return options.data.format(asset.binding, val);
-    },
-    set(val) {
-      if (asset.binding === void 0) {
-        return;
-      }
-      return options.data.model.set([[asset.binding, val]], {
-        formatted: true
-      });
-    },
-    value: asset.binding === void 0 ? "" : options.data.model.get(asset.binding, {
-      includeInvalid: true,
-      formatted: true
-    }),
-    validation: asset.binding === void 0 ? void 0 : (_a = options.validation) == null ? void 0 : _a.get(asset.binding, { track: true }),
-    dataType: asset.binding === void 0 ? void 0 : (_b = options.validation) == null ? void 0 : _b.type(asset.binding)
-  });
-};
-
-var __defProp$2 = Object.defineProperty;
-var __defProps$2 = Object.defineProperties;
-var __getOwnPropDescs$2 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
-var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
-var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$2 = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp$2.call(b, prop))
-      __defNormalProp$2(a, prop, b[prop]);
-  if (__getOwnPropSymbols$2)
-    for (var prop of __getOwnPropSymbols$2(b)) {
-      if (__propIsEnum$2.call(b, prop))
-        __defNormalProp$2(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps$2 = (a, b) => __defProps$2(a, __getOwnPropDescs$2(b));
-function isBackAction(action) {
-  return action.value === "Prev";
-}
-const transform = (action, options) => {
-  return __spreadProps$2(__spreadValues$2({}, action), {
-    run() {
-      var _a, _b;
-      if (action.exp) {
-        options.evaluate(action.exp);
-      }
-      if (action.value) {
-        const skipValidation = (_a = action.metaData) == null ? void 0 : _a.skipValidation;
-        (_b = options.transition) == null ? void 0 : _b.call(options, action.value, { force: skipValidation });
-      }
-    }
-  });
-};
-const backIconTransform = (action) => {
-  var _a;
-  if (isBackAction(action) && ((_a = action == null ? void 0 : action.metaData) == null ? void 0 : _a.role) === void 0) {
-    return __spreadProps$2(__spreadValues$2({}, action), {
-      metaData: __spreadProps$2(__spreadValues$2({}, action == null ? void 0 : action.metaData), {
-        role: "back"
-      })
-    });
-  }
-  return action;
-};
-const expPropTransform = (asset) => {
-  var _a, _b, _c, _d, _e, _f;
-  const skipArray = (_b = (_a = asset.plugins) == null ? void 0 : _a.stringResolver) == null ? void 0 : _b.propertiesToSkip;
-  if (skipArray && skipArray.indexOf("exp") > 1) {
-    return asset;
-  }
-  return __spreadProps$2(__spreadValues$2({}, asset), {
-    plugins: __spreadProps$2(__spreadValues$2({}, asset.plugins), {
-      stringResolver: __spreadProps$2(__spreadValues$2({}, (_c = asset == null ? void 0 : asset.plugins) == null ? void 0 : _c.stringResolver), {
-        propertiesToSkip: [
-          ...(_f = (_e = (_d = asset.plugins) == null ? void 0 : _d.stringResolver) == null ? void 0 : _e.propertiesToSkip) != null ? _f : [],
-          "exp"
-        ]
-      })
-    })
-  });
-};
-const actionTransform = assetTransformPlugin.compose(transform, backIconTransform, assetTransformPlugin.composeBefore(expPropTransform));
-
-var __defProp$1 = Object.defineProperty;
-var __defProps$1 = Object.defineProperties;
-var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
-var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
-var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$1 = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp$1.call(b, prop))
-      __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$1)
-    for (var prop of __getOwnPropSymbols$1(b)) {
-      if (__propIsEnum$1.call(b, prop))
-        __defNormalProp$1(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
-const infoTransform = (infoAsset) => {
-  const actions = infoAsset == null ? void 0 : infoAsset.actions;
-  const segmentedActions = actions == null ? void 0 : actions.reduce((segmentedActionsArray, action) => {
-    segmentedActionsArray[isBackAction(action.asset) ? "prev" : "next"].push(action);
-    return segmentedActionsArray;
-  }, { next: [], prev: [] });
-  return __spreadProps$1(__spreadValues$1({}, infoAsset), {
-    segmentedActions
-  });
-};
-
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-const getImageAlt = (props) => {
-  const { metaData, placeholder } = props;
-  if (metaData.accessibility)
-    return metaData.accessibility;
-  if (placeholder)
-    return placeholder;
-  return "Image";
-};
-const imageTransform = (props) => {
-  const altText = getImageAlt(props);
-  const newImage = __spreadProps(__spreadValues({}, props), {
-    altText
-  });
-  return newImage;
-};
-
-class ReferenceAssetsPlugin {
-  constructor() {
-    this.name = "reference-assets-transforms";
-  }
-  apply(player) {
-    player.registerPlugin(new assetTransformPlugin.AssetTransformPlugin([
-      [{ type: "action" }, actionTransform],
-      [{ type: "input" }, inputTransform],
-      [{ type: "image" }, imageTransform],
-      [{ type: "info" }, infoTransform]
-    ]));
-  }
-}
-
-exports.ReferenceAssetsPlugin = ReferenceAssetsPlugin;
-exports.actionTransform = actionTransform;
-exports.expPropTransform = expPropTransform;
-exports.imageTransform = imageTransform;
-exports.infoTransform = infoTransform;
-exports.inputTransform = inputTransform;
-exports.isBackAction = isBackAction;
-//# sourceMappingURL=index.cjs.js.map