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

package/dist/index.d.ts

@@ -1,185 +0,0 @@
-import * as _player_ui_player from '@player-ui/player';
-import { Asset, AssetWrapper, Binding, ValidationResponse, Schema, TransformFunction, Expression, BeforeTransformFunction, PlayerPlugin, Player } from '@player-ui/player';
-import { 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.
- * */
-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;
-    };
-}
-declare type ValueType = string | undefined;
-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;
-}
-
-/**
- * Docs about the asset transform
- */
-declare const inputTransform: TransformFunction<InputAsset, TransformedInput>;
-
-/**
- * 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.
- */
-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 */
-interface TransformedAction extends ActionAsset {
-    /** A method to execute the action */
-    run: () => void;
-}
-
-/**
- * Function to find prev button
- */
-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
- */
-declare const expPropTransform: BeforeTransformFunction<Asset>;
-declare const actionTransform: _player_ui_player.TransformFunctions;
-
-interface CollectionAsset extends Asset<'collection'> {
-    /** An optional label to title the collection */
-    label?: AssetWrapper;
-    /** The string value to show */
-    values?: Array<AssetWrapper>;
-}
-
-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>;
-}
-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>>;
-    };
-}
-
-/**
- * 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
- */
-declare const infoTransform: TransformFunction<InfoAsset, InfoAssetTransform>;
-
-interface TextAsset extends Asset<'text'> {
-    /** The text to display */
-    value: string;
-    /** Any modifiers on the text */
-    modifiers?: Array<TextModifier>;
-}
-declare type TextModifier = BasicTextModifier | LinkModifier;
-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 */
-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;
-    };
-}
-
-interface ImageAsset extends Asset<'image'> {
-    /** Reference to the image */
-    metaData: ImageMetaData;
-    /** Optional placeholder text */
-    placeholder?: string;
-    /** Optional caption */
-    caption?: Asset;
-}
-/** A modifier to turn the text into a link */
-interface ImageMetaData {
-    /** The location of the image to load */
-    ref: string;
-    /** Used for accessibility support */
-    accessibility?: string;
-}
-interface TransformedImage extends ImageAsset {
-    /** Alt text */
-    altText: string;
-}
-
-/**
- * Sets the Image's placeholder and accessibilty
- */
-declare const imageTransform: TransformFunction<ImageAsset, TransformedImage>;
-
-/**
- * A plugin to add transforms for the reference assets
- */
-declare class ReferenceAssetsPlugin implements PlayerPlugin {
-    name: string;
-    apply(player: Player): void;
-}
-
-export { ActionAsset, BasicTextModifier, CollectionAsset, ImageAsset, ImageMetaData, InfoAsset, InfoAssetTransform, InputAsset, LinkModifier, ReferenceAssetsPlugin, TextAsset, TextModifier, TransformedAction, TransformedImage, TransformedInput, actionTransform, expPropTransform, imageTransform, infoTransform, inputTransform, isBackAction };

package/dist/index.esm.js

@@ -1,194 +0,0 @@
-import { compose, composeBefore, AssetTransformPlugin } from '@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 = compose(transform, backIconTransform, 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([
-      [{ type: "action" }, actionTransform],
-      [{ type: "input" }, inputTransform],
-      [{ type: "image" }, imageTransform],
-      [{ type: "info" }, infoTransform]
-    ]));
-  }
-}
-
-export { ReferenceAssetsPlugin, actionTransform, expPropTransform, imageTransform, infoTransform, inputTransform, isBackAction };
-//# sourceMappingURL=index.esm.js.map