@player-ui/metrics-plugin 0.0.1-next.2 → 0.0.1-next.22

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var tapable = require('tapable');
+var tapableTs = require('tapable-ts');
 var beaconPlugin = require('@player-ui/beacon-plugin');
 
 const MetricsCorePluginSymbol = Symbol.for("MetricsCorePlugin");
@@ -126,42 +126,17 @@ class MetricsCorePlugin {
     this.name = "metrics";
     this.symbol = MetricsCorePluginSymbol;
     this.hooks = {
-      resolveRequestTime: new tapable.SyncBailHook(["requestTime"]),
-      onFlowBegin: new tapable.SyncHook(["update"]),
-      onFlowEnd: new tapable.SyncHook(["update"]),
-      onInteractive: new tapable.SyncHook([
-        "timing",
-        "update"
-      ]),
-      onNodeStart: new tapable.SyncHook([
-        "nodeMetrics",
-        "update"
-      ]),
-      onNodeEnd: new tapable.SyncHook([
-        "nodeMetrics",
-        "update"
-      ]),
-      onRenderStart: new tapable.SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onRenderEnd: new tapable.SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onUpdateStart: new tapable.SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onUpdateEnd: new tapable.SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onUpdate: new tapable.SyncHook(["update"])
+      resolveRequestTime: new tapableTs.SyncBailHook(),
+      onFlowBegin: new tapableTs.SyncHook(),
+      onFlowEnd: new tapableTs.SyncHook(),
+      onInteractive: new tapableTs.SyncHook(),
+      onNodeStart: new tapableTs.SyncHook(),
+      onNodeEnd: new tapableTs.SyncHook(),
+      onRenderStart: new tapableTs.SyncHook(),
+      onRenderEnd: new tapableTs.SyncHook(),
+      onUpdateStart: new tapableTs.SyncHook(),
+      onUpdateEnd: new tapableTs.SyncHook(),
+      onUpdate: new tapableTs.SyncHook()
     };
     this.metrics = {};
     var _a, _b, _c;
@@ -280,7 +255,7 @@ class MetricsCorePlugin {
       this.metrics = {
         flow: {
           id: flow.id,
-          requestTime,
+          requestTime: requestTime != null ? requestTime : void 0,
           timeline: [],
           startTime,
           completed: false,

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { PlayerPlugin, Player } from '@player-ui/player';
-import { SyncBailHook, SyncHook } from 'tapable';
+import { SyncBailHook, SyncHook } from 'tapable-ts';
 import { BeaconPluginPlugin, BeaconPlugin } from '@player-ui/beacon-plugin';
 
 declare const defaultGetTime: () => number;
@@ -115,17 +115,17 @@ declare class MetricsCorePlugin implements PlayerPlugin {
     protected trackUpdate: boolean;
     protected getTime: () => number;
     readonly hooks: {
-        resolveRequestTime: SyncBailHook<number, any, any, any>;
-        onFlowBegin: SyncHook<PlayerFlowMetrics, any, any>;
-        onFlowEnd: SyncHook<PlayerFlowMetrics, any, any>;
-        onInteractive: SyncHook<Timing, PlayerFlowMetrics, any>;
-        onNodeStart: SyncHook<NodeMetrics | NodeRenderMetrics, any, any>;
-        onNodeEnd: SyncHook<NodeMetrics | NodeRenderMetrics, any, any>;
-        onRenderStart: SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>;
-        onRenderEnd: SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>;
-        onUpdateStart: SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>;
-        onUpdateEnd: SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>;
-        onUpdate: SyncHook<PlayerFlowMetrics, any, any>;
+        resolveRequestTime: SyncBailHook<[], number, Record<string, any>>;
+        onFlowBegin: SyncHook<[PlayerFlowMetrics], Record<string, any>>;
+        onFlowEnd: SyncHook<[PlayerFlowMetrics], Record<string, any>>;
+        onInteractive: SyncHook<[Timing, PlayerFlowMetrics], Record<string, any>>;
+        onNodeStart: SyncHook<[NodeMetrics | NodeRenderMetrics], Record<string, any>>;
+        onNodeEnd: SyncHook<[NodeMetrics | NodeRenderMetrics], Record<string, any>>;
+        onRenderStart: SyncHook<[Timing, NodeRenderMetrics, PlayerFlowMetrics], Record<string, any>>;
+        onRenderEnd: SyncHook<[Timing, NodeRenderMetrics, PlayerFlowMetrics], Record<string, any>>;
+        onUpdateStart: SyncHook<[Timing, NodeRenderMetrics, PlayerFlowMetrics], Record<string, any>>;
+        onUpdateEnd: SyncHook<[Timing, NodeRenderMetrics, PlayerFlowMetrics], Record<string, any>>;
+        onUpdate: SyncHook<[PlayerFlowMetrics], Record<string, any>>;
     };
     private metrics;
     constructor(options?: MetricsWebPluginOptions);

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { SyncBailHook, SyncHook } from 'tapable';
+import { SyncBailHook, SyncHook } from 'tapable-ts';
 import { BeaconPlugin } from '@player-ui/beacon-plugin';
 
 const MetricsCorePluginSymbol = Symbol.for("MetricsCorePlugin");
@@ -122,42 +122,17 @@ class MetricsCorePlugin {
     this.name = "metrics";
     this.symbol = MetricsCorePluginSymbol;
     this.hooks = {
-      resolveRequestTime: new SyncBailHook(["requestTime"]),
-      onFlowBegin: new SyncHook(["update"]),
-      onFlowEnd: new SyncHook(["update"]),
-      onInteractive: new SyncHook([
-        "timing",
-        "update"
-      ]),
-      onNodeStart: new SyncHook([
-        "nodeMetrics",
-        "update"
-      ]),
-      onNodeEnd: new SyncHook([
-        "nodeMetrics",
-        "update"
-      ]),
-      onRenderStart: new SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onRenderEnd: new SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onUpdateStart: new SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onUpdateEnd: new SyncHook([
-        "timing",
-        "nodeMetrics",
-        "update"
-      ]),
-      onUpdate: new SyncHook(["update"])
+      resolveRequestTime: new SyncBailHook(),
+      onFlowBegin: new SyncHook(),
+      onFlowEnd: new SyncHook(),
+      onInteractive: new SyncHook(),
+      onNodeStart: new SyncHook(),
+      onNodeEnd: new SyncHook(),
+      onRenderStart: new SyncHook(),
+      onRenderEnd: new SyncHook(),
+      onUpdateStart: new SyncHook(),
+      onUpdateEnd: new SyncHook(),
+      onUpdate: new SyncHook()
     };
     this.metrics = {};
     var _a, _b, _c;
@@ -276,7 +251,7 @@ class MetricsCorePlugin {
       this.metrics = {
         flow: {
           id: flow.id,
-          requestTime,
+          requestTime: requestTime != null ? requestTime : void 0,
           timeline: [],
           startTime,
           completed: false,

package/package.json

@@ -1,19 +1,59 @@
 {
   "name": "@player-ui/metrics-plugin",
-  "version": "0.0.1-next.2",
+  "version": "0.0.1-next.22",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@player-ui/binding-grammar": "0.0.1-next.2"
+    "@player-ui/player": "0.0.1-next.22"
   },
   "dependencies": {
-    "tapable": "1.1.3",
-    "@types/tapable": "^1.0.5",
+    "@player-ui/beacon-plugin": "0.0.1-next.22",
+    "tapable-ts": "^0.1.0",
     "@babel/runtime": "7.15.4"
   },
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
-  "typings": "dist/index.d.ts"
+  "typings": "dist/index.d.ts",
+  "sideEffects": false,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/player-ui/player-ui"
+  },
+  "bugs": {
+    "url": "https://github.com/player-ui/player-ui/issues"
+  },
+  "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"
+    }
+  ]
 }

package/src/metrics.ts

@@ -1,5 +1,5 @@
 import type { Player, PlayerPlugin } from '@player-ui/player';
-import { SyncHook, SyncBailHook } from 'tapable';
+import { SyncHook, SyncBailHook } from 'tapable-ts';
 import type { BeaconPluginPlugin, BeaconArgs } from '@player-ui/beacon-plugin';
 import { BeaconPlugin } from '@player-ui/beacon-plugin';
 import {
@@ -112,7 +112,7 @@ export class MetricsViewBeaconPlugin implements BeaconPluginPlugin {
   apply(beaconPlugin: BeaconPlugin) {
     beaconPlugin.hooks.buildBeacon.intercept({
       context: true,
-      call: (context, beacon) => {
+      call: (context: any, beacon) => {
         if (context && (beacon as BeaconArgs).action === 'viewed') {
           context[this.symbol] = this.buildContext();
         }
@@ -251,48 +251,27 @@ export class MetricsCorePlugin implements PlayerPlugin {
   protected getTime: () => number;
 
   public readonly hooks = {
-    resolveRequestTime: new SyncBailHook<number>(['requestTime']),
-
-    onFlowBegin: new SyncHook<PlayerFlowMetrics>(['update']),
-    onFlowEnd: new SyncHook<PlayerFlowMetrics>(['update']),
-
-    onInteractive: new SyncHook<Timing, PlayerFlowMetrics>([
-      'timing',
-      'update',
-    ]),
-
-    onNodeStart: new SyncHook<NodeMetrics | NodeRenderMetrics>([
-      'nodeMetrics',
-      'update',
-    ]),
-    onNodeEnd: new SyncHook<NodeMetrics | NodeRenderMetrics>([
-      'nodeMetrics',
-      'update',
-    ]),
-
-    onRenderStart: new SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>([
-      'timing',
-      'nodeMetrics',
-      'update',
-    ]),
-    onRenderEnd: new SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>([
-      'timing',
-      'nodeMetrics',
-      'update',
-    ]),
-
-    onUpdateStart: new SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>([
-      'timing',
-      'nodeMetrics',
-      'update',
-    ]),
-    onUpdateEnd: new SyncHook<Timing, NodeRenderMetrics, PlayerFlowMetrics>([
-      'timing',
-      'nodeMetrics',
-      'update',
-    ]),
-
-    onUpdate: new SyncHook<PlayerFlowMetrics>(['update']),
+    resolveRequestTime: new SyncBailHook<[], number>(),
+
+    onFlowBegin: new SyncHook<[PlayerFlowMetrics]>(),
+    onFlowEnd: new SyncHook<[PlayerFlowMetrics]>(),
+
+    onInteractive: new SyncHook<[Timing, PlayerFlowMetrics]>(),
+
+    onNodeStart: new SyncHook<[NodeMetrics | NodeRenderMetrics]>(),
+    onNodeEnd: new SyncHook<[NodeMetrics | NodeRenderMetrics]>(),
+
+    onRenderStart: new SyncHook<
+      [Timing, NodeRenderMetrics, PlayerFlowMetrics]
+    >(),
+    onRenderEnd: new SyncHook<[Timing, NodeRenderMetrics, PlayerFlowMetrics]>(),
+
+    onUpdateStart: new SyncHook<
+      [Timing, NodeRenderMetrics, PlayerFlowMetrics]
+    >(),
+    onUpdateEnd: new SyncHook<[Timing, NodeRenderMetrics, PlayerFlowMetrics]>(),
+
+    onUpdate: new SyncHook<[PlayerFlowMetrics]>(),
   };
 
   private metrics: PlayerFlowMetrics = {};
@@ -321,7 +300,7 @@ export class MetricsCorePlugin implements PlayerPlugin {
 
     callbacks.forEach((hookName) => {
       if (options?.[hookName] !== undefined) {
-        this.hooks[hookName].tap('options', options?.[hookName] as any);
+        (this.hooks[hookName] as any).tap('options', options?.[hookName]);
       }
     });
   }
@@ -472,7 +451,7 @@ export class MetricsCorePlugin implements PlayerPlugin {
       this.metrics = {
         flow: {
           id: flow.id,
-          requestTime,
+          requestTime: requestTime ?? undefined,
           timeline: [],
           startTime,
           completed: false,