@player-ui/pubsub-plugin 0.4.0-next.9 → 0.4.1-next.0

package/dist/index.cjs.js

@@ -104,8 +104,13 @@ const _PubSubPlugin = class {
     this.symbol = _PubSubPlugin.Symbol;
     var _a;
     this.expressionName = (_a = config == null ? void 0 : config.expressionName) != null ? _a : "publish";
+    this.pubsub = pubsub;
   }
   apply(player) {
+    const existing = player.findPlugin(PubSubPluginSymbol);
+    if (existing !== void 0) {
+      this.pubsub = existing.pubsub;
+    }
     player.hooks.expressionEvaluator.tap(this.name, (expEvaluator) => {
       const existingExpression = expEvaluator.operators.expressions.get(this.expressionName);
       if (existingExpression) {
@@ -123,16 +128,16 @@ const _PubSubPlugin = class {
     });
   }
   publish(event, ...args) {
-    pubsub.publish(event, ...args);
+    this.pubsub.publish(event, ...args);
   }
   subscribe(event, handler) {
-    return pubsub.subscribe(event, handler);
+    return this.pubsub.subscribe(event, handler);
   }
   unsubscribe(token) {
-    pubsub.unsubscribe(token);
+    this.pubsub.unsubscribe(token);
   }
   clear() {
-    pubsub.clear();
+    this.pubsub.clear();
   }
 };
 let PubSubPlugin = _PubSubPlugin;

package/dist/index.d.ts

@@ -5,6 +5,51 @@ import { PlayerPlugin, Player, InProgressState } from '@player-ui/player';
  * multiple arguments could be passed into the publish and subscription handlers.
  */
 declare type SubscribeHandler<T extends string, A extends unknown[]> = (type: T, ...args: A) => void;
+/**
+ * Tiny pubsub maker
+ */
+declare class TinyPubSub {
+    private events;
+    private tokens;
+    constructor();
+    /**
+     * Publish an event with any number of additional arguments
+     */
+    publish(event: string, ...args: unknown[]): void;
+    /**
+     * Subscribe to an event
+     *
+     * Events are also heirarchical when separated by a period. Given the following:
+     *
+     * publish('a.b.c', 'one', 'two', 'three)
+     *
+     * The subscribe event will be called when the event is passed as 'a', 'a.b', or 'a.b.c'.
+     *
+     * @example
+     * // subscribes to the top level 'a' publish
+     * subscribe('a', (event, ...args) => console.log(event, ...args))
+     */
+    subscribe(event: string, handler: SubscribeHandler<any, any>): string;
+    /**
+     * Unsubscribes to a specific subscription given it's symbol or an entire
+     * event when passed as a string.
+     *
+     * When existing subscriptions exist for heirarchical events such as 'a.b.c',
+     * when passing an event 'a' to unsubscribe, all subscriptions for 'a', 'a.b',
+     * & 'a.b.c' will be unsubscribed as well.
+     */
+    unsubscribe(value: string | symbol): void;
+    /**
+     * Get the number of subscriptions for a specific event, or when left blank
+     * will return the overall number of subscriptions for the entire pubsub.
+     */
+    count(event?: string): number;
+    /**
+     * Deletes all existing subscriptions
+     */
+    clear(): void;
+    private deliver;
+}
 
 interface PubSubConfig {
     /** A custom expression name to register  */
@@ -23,6 +68,7 @@ declare class PubSubPlugin implements PlayerPlugin {
     name: string;
     static Symbol: symbol;
     readonly symbol: symbol;
+    protected pubsub: TinyPubSub;
     private expressionName;
     constructor(config?: PubSubConfig);
     apply(player: Player): void;

package/dist/index.esm.js

@@ -100,8 +100,13 @@ const _PubSubPlugin = class {
     this.symbol = _PubSubPlugin.Symbol;
     var _a;
     this.expressionName = (_a = config == null ? void 0 : config.expressionName) != null ? _a : "publish";
+    this.pubsub = pubsub;
   }
   apply(player) {
+    const existing = player.findPlugin(PubSubPluginSymbol);
+    if (existing !== void 0) {
+      this.pubsub = existing.pubsub;
+    }
     player.hooks.expressionEvaluator.tap(this.name, (expEvaluator) => {
       const existingExpression = expEvaluator.operators.expressions.get(this.expressionName);
       if (existingExpression) {
@@ -119,16 +124,16 @@ const _PubSubPlugin = class {
     });
   }
   publish(event, ...args) {
-    pubsub.publish(event, ...args);
+    this.pubsub.publish(event, ...args);
   }
   subscribe(event, handler) {
-    return pubsub.subscribe(event, handler);
+    return this.pubsub.subscribe(event, handler);
   }
   unsubscribe(token) {
-    pubsub.unsubscribe(token);
+    this.pubsub.unsubscribe(token);
   }
   clear() {
-    pubsub.clear();
+    this.pubsub.clear();
   }
 };
 let PubSubPlugin = _PubSubPlugin;

package/dist/pubsub-plugin.dev.js

@@ -210,8 +210,13 @@ const _PubSubPlugin = class {
     this.symbol = _PubSubPlugin.Symbol;
     var _a;
     this.expressionName = (_a = config == null ? void 0 : config.expressionName) != null ? _a : "publish";
+    this.pubsub = pubsub;
   }
   apply(player) {
+    const existing = player.findPlugin(PubSubPluginSymbol);
+    if (existing !== void 0) {
+      this.pubsub = existing.pubsub;
+    }
     player.hooks.expressionEvaluator.tap(this.name, (expEvaluator) => {
       const existingExpression = expEvaluator.operators.expressions.get(this.expressionName);
       if (existingExpression) {
@@ -229,16 +234,16 @@ const _PubSubPlugin = class {
     });
   }
   publish(event, ...args) {
-    pubsub.publish(event, ...args);
+    this.pubsub.publish(event, ...args);
   }
   subscribe(event, handler) {
-    return pubsub.subscribe(event, handler);
+    return this.pubsub.subscribe(event, handler);
   }
   unsubscribe(token) {
-    pubsub.unsubscribe(token);
+    this.pubsub.unsubscribe(token);
   }
   clear() {
-    pubsub.clear();
+    this.pubsub.clear();
   }
 };
 let PubSubPlugin = _PubSubPlugin;

package/dist/pubsub-plugin.prod.js

@@ -1 +1 @@
-!function(e,t){"object"===typeof exports&&"object"===typeof module?module.exports=t():"function"===typeof define&&define.amd?define([],t):"object"===typeof exports?exports.PubSubPlugin=t():e.PubSubPlugin=t()}(this,(function(){return function(e){var t={};function n(s){if(t[s])return t[s].exports;var r=t[s]={i:s,l:!1,exports:{}};return e[s].call(r.exports,r,r.exports,n),r.l=!0,r.exports}return n.m=e,n.c=t,n.d=function(e,t,s){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:s})},n.r=function(e){"undefined"!==typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"===typeof e&&e&&e.__esModule)return e;var s=Object.create(null);if(n.r(s),Object.defineProperty(s,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var r in e)n.d(s,r,function(t){return e[t]}.bind(null,r));return s},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=0)}([function(e,t,n){"use strict";n.r(t),n.d(t,"PubSubHandlerPlugin",(function(){return l})),n.d(t,"PubSubPlugin",(function(){return u})),n.d(t,"PubSubPluginSymbol",(function(){return i}));let s=1;const r=new class{constructor(){this.events=new Map,this.tokens=new Map}publish(e,...t){if("string"===typeof e){if(e.includes(".")){const n=function(e){return e.split(".").reduce(((e,t,n)=>0===n?[t]:[...e,`${e[n-1]}.${t}`]),[])}(e);n.forEach((n=>{this.deliver(n,e,...t)}))}else this.deliver(e,e,...t);this.deliver("*",e,...t)}}subscribe(e,t){const n="uuid_"+ ++s;if("string"===typeof e){this.events.has(e)||this.events.set(e,new Map);this.events.get(e).set(n,t),this.tokens.set(n,e)}return n}unsubscribe(e){if("string"===typeof e&&e.startsWith("uuid")){const t=this.tokens.get(e);if("undefined"===typeof t)return;const n=this.events.get(t);return null==n||n.delete(e),void this.tokens.delete(e)}if("string"===typeof e)for(const t of this.events.keys())if(0===t.indexOf(e)){const e=this.events.get(t);if(e&&e.size)for(const t of e.keys())this.tokens.delete(t);this.events.delete(t)}}count(e){let t=0;if("undefined"===typeof e){for(const e of this.events.values())t+=e.size;return t}const n=this.events.get(e);return(null==n?void 0:n.size)?n.size:t}clear(){this.events.clear(),this.tokens.clear()}deliver(e,t,...n){const s=this.events.get(e);if(s&&s.size)for(const r of s.values())r(t,...n)}},i=Symbol.for("PubSubPlugin"),o=class{constructor(e){var t;this.name="pub-sub",this.symbol=o.Symbol,this.expressionName=null!=(t=null==e?void 0:e.expressionName)?t:"publish"}apply(e){e.hooks.expressionEvaluator.tap(this.name,(t=>{t.operators.expressions.get(this.expressionName)?e.logger.warn(`[PubSubPlugin] expression ${this.expressionName} is already registered.`):t.addExpressionFunction(this.expressionName,((e,t,...n)=>{"string"===typeof t&&this.publish(t,...n)}))})),e.hooks.onEnd.tap(this.name,(()=>{this.clear()}))}publish(e,...t){r.publish(e,...t)}subscribe(e,t){return r.subscribe(e,t)}unsubscribe(e){r.unsubscribe(e)}clear(){r.clear()}};let u=o;u.Symbol=i;class l{constructor(e){this.name="pubsub-handler",this.subscriptions=e}apply(e){const t=function(e){const t=e.findPlugin(i),n=t||new u;return t||e.registerPlugin(n),n}(e);e.hooks.onStart.tap(this.name,(()=>{this.subscriptions.forEach(((n,s)=>{t.subscribe(s,((t,...r)=>{const i=e.getState();if("in-progress"===i.status)return n(i,...r);e.logger.info(`[PubSubHandlerPlugin] subscriber for ${s} was called when player was not in-progress`)}))}))}))}}}])}));
+!function(e,t){"object"===typeof exports&&"object"===typeof module?module.exports=t():"function"===typeof define&&define.amd?define([],t):"object"===typeof exports?exports.PubSubPlugin=t():e.PubSubPlugin=t()}(this,(function(){return function(e){var t={};function s(n){if(t[n])return t[n].exports;var i=t[n]={i:n,l:!1,exports:{}};return e[n].call(i.exports,i,i.exports,s),i.l=!0,i.exports}return s.m=e,s.c=t,s.d=function(e,t,n){s.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},s.r=function(e){"undefined"!==typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},s.t=function(e,t){if(1&t&&(e=s(e)),8&t)return e;if(4&t&&"object"===typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(s.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)s.d(n,i,function(t){return e[t]}.bind(null,i));return n},s.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return s.d(t,"a",t),t},s.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},s.p="",s(s.s=0)}([function(e,t,s){"use strict";s.r(t),s.d(t,"PubSubHandlerPlugin",(function(){return l})),s.d(t,"PubSubPlugin",(function(){return u})),s.d(t,"PubSubPluginSymbol",(function(){return r}));let n=1;const i=new class{constructor(){this.events=new Map,this.tokens=new Map}publish(e,...t){if("string"===typeof e){if(e.includes(".")){const s=function(e){return e.split(".").reduce(((e,t,s)=>0===s?[t]:[...e,`${e[s-1]}.${t}`]),[])}(e);s.forEach((s=>{this.deliver(s,e,...t)}))}else this.deliver(e,e,...t);this.deliver("*",e,...t)}}subscribe(e,t){const s="uuid_"+ ++n;if("string"===typeof e){this.events.has(e)||this.events.set(e,new Map);this.events.get(e).set(s,t),this.tokens.set(s,e)}return s}unsubscribe(e){if("string"===typeof e&&e.startsWith("uuid")){const t=this.tokens.get(e);if("undefined"===typeof t)return;const s=this.events.get(t);return null==s||s.delete(e),void this.tokens.delete(e)}if("string"===typeof e)for(const t of this.events.keys())if(0===t.indexOf(e)){const e=this.events.get(t);if(e&&e.size)for(const t of e.keys())this.tokens.delete(t);this.events.delete(t)}}count(e){let t=0;if("undefined"===typeof e){for(const e of this.events.values())t+=e.size;return t}const s=this.events.get(e);return(null==s?void 0:s.size)?s.size:t}clear(){this.events.clear(),this.tokens.clear()}deliver(e,t,...s){const n=this.events.get(e);if(n&&n.size)for(const i of n.values())i(t,...s)}},r=Symbol.for("PubSubPlugin"),o=class{constructor(e){var t;this.name="pub-sub",this.symbol=o.Symbol,this.expressionName=null!=(t=null==e?void 0:e.expressionName)?t:"publish",this.pubsub=i}apply(e){const t=e.findPlugin(r);void 0!==t&&(this.pubsub=t.pubsub),e.hooks.expressionEvaluator.tap(this.name,(t=>{t.operators.expressions.get(this.expressionName)?e.logger.warn(`[PubSubPlugin] expression ${this.expressionName} is already registered.`):t.addExpressionFunction(this.expressionName,((e,t,...s)=>{"string"===typeof t&&this.publish(t,...s)}))})),e.hooks.onEnd.tap(this.name,(()=>{this.clear()}))}publish(e,...t){this.pubsub.publish(e,...t)}subscribe(e,t){return this.pubsub.subscribe(e,t)}unsubscribe(e){this.pubsub.unsubscribe(e)}clear(){this.pubsub.clear()}};let u=o;u.Symbol=r;class l{constructor(e){this.name="pubsub-handler",this.subscriptions=e}apply(e){const t=function(e){const t=e.findPlugin(r),s=t||new u;return t||e.registerPlugin(s),s}(e);e.hooks.onStart.tap(this.name,(()=>{this.subscriptions.forEach(((s,n)=>{t.subscribe(n,((t,...i)=>{const r=e.getState();if("in-progress"===r.status)return s(r,...i);e.logger.info(`[PubSubHandlerPlugin] subscriber for ${n} was called when player was not in-progress`)}))}))}))}}}])}));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@player-ui/pubsub-plugin",
-  "version": "0.4.0-next.9",
+  "version": "0.4.1-next.0",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@player-ui/player": "0.4.0-next.9"
+    "@player-ui/player": "0.4.1-next.0"
   },
   "dependencies": {
     "tapable-ts": "^0.2.3",

package/src/plugin.ts

@@ -3,7 +3,7 @@ import type {
   PlayerPlugin,
   ExpressionContext,
 } from '@player-ui/player';
-import type { SubscribeHandler } from './pubsub';
+import type { SubscribeHandler, TinyPubSub } from './pubsub';
 import { pubsub } from './pubsub';
 import { PubSubPluginSymbol } from './symbols';
 
@@ -27,13 +27,23 @@ export class PubSubPlugin implements PlayerPlugin {
   static Symbol = PubSubPluginSymbol;
   public readonly symbol = PubSubPlugin.Symbol;
 
+  protected pubsub: TinyPubSub;
+
   private expressionName: string;
 
   constructor(config?: PubSubConfig) {
     this.expressionName = config?.expressionName ?? 'publish';
+    this.pubsub = pubsub;
   }
 
   apply(player: Player) {
+    // if there is already a pubsub plugin, reuse its pubsub instance
+    // to maintain the singleton across bundles for iOS/Android
+    const existing = player.findPlugin<PubSubPlugin>(PubSubPluginSymbol);
+    if (existing !== undefined) {
+      this.pubsub = existing.pubsub;
+    }
+
     player.hooks.expressionEvaluator.tap(this.name, (expEvaluator) => {
       const existingExpression = expEvaluator.operators.expressions.get(
         this.expressionName
@@ -67,7 +77,7 @@ export class PubSubPlugin implements PlayerPlugin {
    * @param data - Any additional data to attach to the event
    */
   publish(event: string, ...args: unknown[]) {
-    pubsub.publish(event, ...args);
+    this.pubsub.publish(event, ...args);
   }
 
   /**
@@ -81,7 +91,7 @@ export class PubSubPlugin implements PlayerPlugin {
     event: T,
     handler: SubscribeHandler<T, A>
   ) {
-    return pubsub.subscribe(event, handler);
+    return this.pubsub.subscribe(event, handler);
   }
 
   /**
@@ -90,13 +100,13 @@ export class PubSubPlugin implements PlayerPlugin {
    * @param token - A token from a `subscribe` call
    */
   unsubscribe(token: string) {
-    pubsub.unsubscribe(token);
+    this.pubsub.unsubscribe(token);
   }
 
   /**
    * Remove all subscriptions
    */
   clear() {
-    pubsub.clear();
+    this.pubsub.clear();
   }
 }

package/src/pubsub.ts

@@ -28,7 +28,7 @@ let count = 1;
 /**
  * Tiny pubsub maker
  */
-class TinyPubSub {
+export class TinyPubSub {
   private events: Map<string, Map<PubSubUUID, SubscribeHandler<any, any>>>;
   private tokens: Map<PubSubUUID, string>;