@player-ui/beacon-plugin 0.3.1-next.0 → 0.4.0-next.0

package/dist/index.cjs.js

@@ -72,16 +72,18 @@ const _BeaconPlugin = class {
       });
     }
   }
-  apply(player) {
-    this.player = player;
-    this.logger = player.logger;
-    player.hooks.dataController.tap(this.name, (dataController) => {
-      this.dataController = dataController;
-    });
-    player.hooks.expressionEvaluator.tap(this.name, (expressionEvaluator) => {
-      this.expressionEvaluator = expressionEvaluator;
+  apply(player$1) {
+    this.player = player$1;
+    this.logger = player$1.logger;
+    player$1.hooks.state.tap(this.name, (playerState) => {
+      if (playerState.status === "in-progress") {
+        this.resolveDataRefs = (data) => player.resolveDataRefs(data, {
+          model: playerState.controllers.data,
+          evaluate: playerState.controllers.expression.evaluate
+        });
+      }
     });
-    player.hooks.viewController.tap(this.name, (vc) => {
+    player$1.hooks.viewController.tap(this.name, (vc) => {
       this.beaconContext = {
         view: void 0
       };
@@ -115,7 +117,7 @@ const _BeaconPlugin = class {
         });
       });
     });
-    player.hooks.expressionEvaluator.tap(this.name, (evaluator) => {
+    player$1.hooks.expressionEvaluator.tap(this.name, (evaluator) => {
       evaluator.addExpressionFunction("beacon", (_ctx, action, data) => {
         const view = this.beaconContext.view || {};
         this.beacon({
@@ -132,8 +134,9 @@ const _BeaconPlugin = class {
     const { action, element, asset, view } = event;
     const { view: currentView } = this.beaconContext;
     setTimeout(() => __async(this, null, function* () {
-      var _a, _b, _c, _d;
-      const data = (event == null ? void 0 : event.data) || ((_b = (_a = event.asset) == null ? void 0 : _a.metaData) == null ? void 0 : _b.beacon);
+      var _a, _b, _c, _d, _e, _f;
+      const unresolvedData = (event == null ? void 0 : event.data) || ((_b = (_a = event.asset) == null ? void 0 : _a.metaData) == null ? void 0 : _b.beacon);
+      const data = (_d = (_c = this.resolveDataRefs) == null ? void 0 : _c.call(this, unresolvedData)) != null ? _d : unresolvedData;
       const defaultBeacon = {
         action,
         element,
@@ -141,22 +144,21 @@ const _BeaconPlugin = class {
         assetId: asset == null ? void 0 : asset.id,
         viewId: currentView == null ? void 0 : currentView.id
       };
-      const state = (_c = this.player) == null ? void 0 : _c.getState();
+      const state = (_e = this.player) == null ? void 0 : _e.getState();
       const hookArgs = __spreadProps(__spreadValues({}, event), {
         data,
         state,
-        view: view || currentView,
+        view: view != null ? view : currentView,
         logger: this.logger
       });
-      const beacon = (yield this.hooks.buildBeacon.call(defaultBeacon, hookArgs)) || defaultBeacon;
+      let beacon = (yield this.hooks.buildBeacon.call(defaultBeacon, hookArgs)) || defaultBeacon;
+      if (beacon !== defaultBeacon && this.resolveDataRefs) {
+        beacon = this.resolveDataRefs(beacon);
+      }
       const shouldCancel = this.hooks.cancelBeacon.call(hookArgs) || false;
       if (!shouldCancel) {
-        const resolvedBeacon = this.dataController && this.expressionEvaluator ? player.resolveDataRefs(beacon, {
-          model: this.dataController,
-          evaluate: this.expressionEvaluator.evaluate
-        }) : beacon;
-        (_d = this.logger) == null ? void 0 : _d.debug("Sending beacon event", resolvedBeacon);
-        this.hooks.publishBeacon.call(resolvedBeacon);
+        (_f = this.logger) == null ? void 0 : _f.debug("Sending beacon event", beacon);
+        this.hooks.publishBeacon.call(beacon);
       }
     }), 0);
   }

package/dist/index.d.ts

@@ -52,8 +52,7 @@ declare class BeaconPlugin implements PlayerPlugin {
     private player?;
     private logger?;
     private beaconContext;
-    private dataController?;
-    private expressionEvaluator?;
+    private resolveDataRefs?;
     hooks: {
         buildBeacon: AsyncSeriesWaterfallHook<[unknown, HookArgs], Record<string, any>>;
         cancelBeacon: SyncBailHook<[HookArgs], boolean, Record<string, any>>;

package/dist/index.esm.js

@@ -71,11 +71,13 @@ const _BeaconPlugin = class {
   apply(player) {
     this.player = player;
     this.logger = player.logger;
-    player.hooks.dataController.tap(this.name, (dataController) => {
-      this.dataController = dataController;
-    });
-    player.hooks.expressionEvaluator.tap(this.name, (expressionEvaluator) => {
-      this.expressionEvaluator = expressionEvaluator;
+    player.hooks.state.tap(this.name, (playerState) => {
+      if (playerState.status === "in-progress") {
+        this.resolveDataRefs = (data) => resolveDataRefs(data, {
+          model: playerState.controllers.data,
+          evaluate: playerState.controllers.expression.evaluate
+        });
+      }
     });
     player.hooks.viewController.tap(this.name, (vc) => {
       this.beaconContext = {
@@ -128,8 +130,9 @@ const _BeaconPlugin = class {
     const { action, element, asset, view } = event;
     const { view: currentView } = this.beaconContext;
     setTimeout(() => __async(this, null, function* () {
-      var _a, _b, _c, _d;
-      const data = (event == null ? void 0 : event.data) || ((_b = (_a = event.asset) == null ? void 0 : _a.metaData) == null ? void 0 : _b.beacon);
+      var _a, _b, _c, _d, _e, _f;
+      const unresolvedData = (event == null ? void 0 : event.data) || ((_b = (_a = event.asset) == null ? void 0 : _a.metaData) == null ? void 0 : _b.beacon);
+      const data = (_d = (_c = this.resolveDataRefs) == null ? void 0 : _c.call(this, unresolvedData)) != null ? _d : unresolvedData;
       const defaultBeacon = {
         action,
         element,
@@ -137,22 +140,21 @@ const _BeaconPlugin = class {
         assetId: asset == null ? void 0 : asset.id,
         viewId: currentView == null ? void 0 : currentView.id
       };
-      const state = (_c = this.player) == null ? void 0 : _c.getState();
+      const state = (_e = this.player) == null ? void 0 : _e.getState();
       const hookArgs = __spreadProps(__spreadValues({}, event), {
         data,
         state,
-        view: view || currentView,
+        view: view != null ? view : currentView,
         logger: this.logger
       });
-      const beacon = (yield this.hooks.buildBeacon.call(defaultBeacon, hookArgs)) || defaultBeacon;
+      let beacon = (yield this.hooks.buildBeacon.call(defaultBeacon, hookArgs)) || defaultBeacon;
+      if (beacon !== defaultBeacon && this.resolveDataRefs) {
+        beacon = this.resolveDataRefs(beacon);
+      }
       const shouldCancel = this.hooks.cancelBeacon.call(hookArgs) || false;
       if (!shouldCancel) {
-        const resolvedBeacon = this.dataController && this.expressionEvaluator ? resolveDataRefs(beacon, {
-          model: this.dataController,
-          evaluate: this.expressionEvaluator.evaluate
-        }) : beacon;
-        (_d = this.logger) == null ? void 0 : _d.debug("Sending beacon event", resolvedBeacon);
-        this.hooks.publishBeacon.call(resolvedBeacon);
+        (_f = this.logger) == null ? void 0 : _f.debug("Sending beacon event", beacon);
+        this.hooks.publishBeacon.call(beacon);
       }
     }), 0);
   }

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@player-ui/beacon-plugin",
-  "version": "0.3.1-next.0",
+  "version": "0.4.0-next.0",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@player-ui/player": "0.3.1-next.0",
-    "@player-ui/types": "0.3.1-next.0"
+    "@player-ui/player": "0.4.0-next.0",
+    "@player-ui/types": "0.4.0-next.0"
   },
   "dependencies": {
-    "tapable-ts": "^0.1.0",
+    "tapable-ts": "^0.2.2",
     "timm": "^1.6.2",
     "@babel/runtime": "7.15.4"
   },

package/src/beacon.ts

@@ -3,8 +3,6 @@ import type {
   Player,
   PlayerPlugin,
   PlayerFlowState,
-  DataController,
-  ExpressionEvaluator,
   Logger,
 } from '@player-ui/player';
 import { resolveDataRefs } from '@player-ui/player';
@@ -81,8 +79,7 @@ export class BeaconPlugin implements PlayerPlugin {
     view: undefined,
   };
 
-  private dataController?: DataController;
-  private expressionEvaluator?: ExpressionEvaluator;
+  private resolveDataRefs?: <T>(data: T) => T;
 
   public hooks = {
     buildBeacon: new AsyncSeriesWaterfallHook<[unknown, HookArgs]>(),
@@ -110,12 +107,14 @@ export class BeaconPlugin implements PlayerPlugin {
     this.player = player;
     this.logger = player.logger;
 
-    player.hooks.dataController.tap(this.name, (dataController) => {
-      this.dataController = dataController;
-    });
-
-    player.hooks.expressionEvaluator.tap(this.name, (expressionEvaluator) => {
-      this.expressionEvaluator = expressionEvaluator;
+    player.hooks.state.tap(this.name, (playerState) => {
+      if (playerState.status === 'in-progress') {
+        this.resolveDataRefs = (data) =>
+          resolveDataRefs(data, {
+            model: playerState.controllers.data,
+            evaluate: playerState.controllers.expression.evaluate,
+          });
+      }
     });
 
     player.hooks.viewController.tap(this.name, (vc) => {
@@ -185,7 +184,9 @@ export class BeaconPlugin implements PlayerPlugin {
     const { action, element, asset, view } = event;
     const { view: currentView } = this.beaconContext;
     setTimeout(async () => {
-      const data = event?.data || event.asset?.metaData?.beacon;
+      const unresolvedData = event?.data || event.asset?.metaData?.beacon;
+
+      const data = this.resolveDataRefs?.(unresolvedData) ?? unresolvedData;
 
       const defaultBeacon = {
         action,
@@ -199,25 +200,23 @@ export class BeaconPlugin implements PlayerPlugin {
         ...event,
         data,
         state,
-        view: view || currentView,
+        view: view ?? currentView,
         logger: this.logger as Logger,
       };
-      const beacon =
+      let beacon =
         (await this.hooks.buildBeacon.call(defaultBeacon, hookArgs)) ||
         defaultBeacon;
+
+      // Re-resolve data refs in case the hook modified the beacon and introduced more
+      if (beacon !== defaultBeacon && this.resolveDataRefs) {
+        beacon = this.resolveDataRefs(beacon);
+      }
+
       const shouldCancel = this.hooks.cancelBeacon.call(hookArgs) || false;
 
       if (!shouldCancel) {
-        const resolvedBeacon =
-          this.dataController && this.expressionEvaluator
-            ? resolveDataRefs(beacon, {
-                model: this.dataController,
-                evaluate: this.expressionEvaluator.evaluate,
-              })
-            : beacon;
-
-        this.logger?.debug('Sending beacon event', resolvedBeacon);
-        this.hooks.publishBeacon.call(resolvedBeacon);
+        this.logger?.debug('Sending beacon event', beacon);
+        this.hooks.publishBeacon.call(beacon);
       }
     }, 0);
   }