@player-ui/shared-constants-plugin 0.0.1-next.1

package/dist/index.cjs.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var binding = require('@player-ui/binding');
+var get = require('dlv');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
+
+class ConstantsPlugin {
+  constructor(params) {
+    this.name = "constants";
+    this.updatePlayerConstants = new Set();
+    var _a, _b;
+    this.data = params.data;
+    this.namespace = (_a = params.namespace) != null ? _a : "constants";
+    this.dataPath = new binding.BindingInstance((_b = params.dataPath) != null ? _b : ["data", "constants"]);
+  }
+  apply(player) {
+    const updatePlayerConstants = () => player.constantsController.addConstants(this.data, this.namespace);
+    updatePlayerConstants();
+    player.hooks.onStart.tap(this.name, (flowObj) => {
+      var _a;
+      this.updatePlayerConstants.add(updatePlayerConstants);
+      updatePlayerConstants();
+      const tempData = (_a = get__default["default"](flowObj, this.dataPath.asString())) != null ? _a : {};
+      player.constantsController.clearTemporaryValues();
+      player.constantsController.setTemporaryValues(tempData, this.namespace);
+    });
+    player.hooks.onEnd.tap(this.name, () => {
+      player.constantsController.clearTemporaryValues();
+      this.updatePlayerConstants.delete(updatePlayerConstants);
+    });
+  }
+  updateConstants() {
+    this.updatePlayerConstants.forEach((update) => update());
+  }
+  getConstants() {
+    return this.data;
+  }
+  setConstants(data) {
+    this.data = data;
+    this.updateConstants();
+  }
+}
+
+exports.ConstantsPlugin = ConstantsPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { PlayerPlugin, Player } from '@player-ui/player';
+
+interface ConstantsPluginConfig {
+    /** Constants defined in an Content */
+    data: any;
+    /** Namespace to store the constants under. If none is specified it defaults to constants */
+    namespace?: string;
+    /** Path to data in the content root to apply as temporary data */
+    dataPath?: string;
+}
+/**
+ * A plugin to manage constant strings across flows
+ * It allows for runtime extensions/overrides through a `constants` property in the flow
+ */
+declare class ConstantsPlugin implements PlayerPlugin {
+    name: string;
+    /**
+     * Namespace to store the constants under
+     * If none is specified it defaults to constants
+     */
+    private namespace;
+    /** Constants defined in an Content */
+    private data;
+    /** Path to data in the content root to apply as temporary data */
+    private dataPath;
+    /** Functions to update the constants within applied players */
+    private updatePlayerConstants;
+    /**
+     * Store the initial constants in the constant map
+     */
+    constructor(params: ConstantsPluginConfig);
+    /**
+     * Grab constants from content then store them store them over after every content
+     */
+    apply(player: Player): void;
+    /** Update constants for all active players */
+    private updateConstants;
+    /** Get constants for this namespace */
+    getConstants(): any;
+    /** Update constants for this namespace */
+    setConstants(data: any): void;
+}
+
+export { ConstantsPlugin, ConstantsPluginConfig };

package/dist/index.esm.js

@@ -0,0 +1,42 @@
+import { BindingInstance } from '@player-ui/binding';
+import get from 'dlv';
+
+class ConstantsPlugin {
+  constructor(params) {
+    this.name = "constants";
+    this.updatePlayerConstants = new Set();
+    var _a, _b;
+    this.data = params.data;
+    this.namespace = (_a = params.namespace) != null ? _a : "constants";
+    this.dataPath = new BindingInstance((_b = params.dataPath) != null ? _b : ["data", "constants"]);
+  }
+  apply(player) {
+    const updatePlayerConstants = () => player.constantsController.addConstants(this.data, this.namespace);
+    updatePlayerConstants();
+    player.hooks.onStart.tap(this.name, (flowObj) => {
+      var _a;
+      this.updatePlayerConstants.add(updatePlayerConstants);
+      updatePlayerConstants();
+      const tempData = (_a = get(flowObj, this.dataPath.asString())) != null ? _a : {};
+      player.constantsController.clearTemporaryValues();
+      player.constantsController.setTemporaryValues(tempData, this.namespace);
+    });
+    player.hooks.onEnd.tap(this.name, () => {
+      player.constantsController.clearTemporaryValues();
+      this.updatePlayerConstants.delete(updatePlayerConstants);
+    });
+  }
+  updateConstants() {
+    this.updatePlayerConstants.forEach((update) => update());
+  }
+  getConstants() {
+    return this.data;
+  }
+  setConstants(data) {
+    this.data = data;
+    this.updateConstants();
+  }
+}
+
+export { ConstantsPlugin };
+//# sourceMappingURL=index.esm.js.map

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@player-ui/shared-constants-plugin",
+  "version": "0.0.1-next.1",
+  "private": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "@player-ui/binding-grammar": "0.0.1-next.1"
+  },
+  "dependencies": {
+    "tapable": "1.1.3",
+    "@types/tapable": "^1.0.5",
+    "dlv": "^1.1.3",
+    "@babel/runtime": "7.15.4"
+  },
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts"
+}

package/src/index.ts

@@ -0,0 +1,90 @@
+import type { Player, PlayerPlugin } from '@player-ui/player';
+import { BindingInstance } from '@player-ui/binding';
+import get from 'dlv';
+
+export interface ConstantsPluginConfig {
+  /** Constants defined in an Content */
+  data: any;
+
+  /** Namespace to store the constants under. If none is specified it defaults to constants */
+  namespace?: string;
+
+  /** Path to data in the content root to apply as temporary data */
+  dataPath?: string;
+}
+
+/**
+ * A plugin to manage constant strings across flows
+ * It allows for runtime extensions/overrides through a `constants` property in the flow
+ */
+export class ConstantsPlugin implements PlayerPlugin {
+  name = 'constants';
+
+  /**
+   * Namespace to store the constants under
+   * If none is specified it defaults to constants
+   */
+  private namespace: string;
+
+  /** Constants defined in an Content */
+  private data: Record<string, any>;
+
+  /** Path to data in the content root to apply as temporary data */
+  private dataPath: BindingInstance;
+
+  /** Functions to update the constants within applied players */
+  private updatePlayerConstants: Set<() => void> = new Set();
+
+  /**
+   * Store the initial constants in the constant map
+   */
+  constructor(params: ConstantsPluginConfig) {
+    this.data = params.data;
+    this.namespace = params.namespace ?? 'constants';
+    this.dataPath = new BindingInstance(
+      params.dataPath ?? ['data', 'constants']
+    );
+  }
+
+  /**
+   * Grab constants from content then store them store them over after every content
+   */
+  apply(player: Player) {
+    /** Update constants for this player */
+    const updatePlayerConstants = () =>
+      player.constantsController.addConstants(this.data, this.namespace);
+    updatePlayerConstants();
+
+    // Setup hook to load latest constants and flow specific overrides to constants
+    player.hooks.onStart.tap(this.name, (flowObj) => {
+      this.updatePlayerConstants.add(updatePlayerConstants);
+      updatePlayerConstants();
+
+      const tempData = get(flowObj, this.dataPath.asString()) ?? {};
+      player.constantsController.clearTemporaryValues();
+      player.constantsController.setTemporaryValues(tempData, this.namespace);
+    });
+    // Clear flow specific overrides at the end of the flow and remove strong ref to player
+    player.hooks.onEnd.tap(this.name, () => {
+      player.constantsController.clearTemporaryValues();
+
+      this.updatePlayerConstants.delete(updatePlayerConstants);
+    });
+  }
+
+  /** Update constants for all active players */
+  private updateConstants() {
+    this.updatePlayerConstants.forEach((update) => update());
+  }
+
+  /** Get constants for this namespace */
+  getConstants(): any {
+    return this.data;
+  }
+
+  /** Update constants for this namespace */
+  setConstants(data: any) {
+    this.data = data;
+    this.updateConstants();
+  }
+}