@octostar/platform-api 0.5.13 → 0.5.15

package/dist/lib/ContextAPI.d.ts

@@ -1,14 +1,20 @@
 import { Context, ContextAPISetParams, ContextAPIStaticData, ContextListener } from '@octostar/platform-types';
-type ContextAPIConstructorParams<ContextData extends Record<string, any>> = ContextAPIStaticData<ContextData> & {
+export type ContextAPIConstructorParams<ContextData extends Record<string, any>> = ContextAPIStaticData<ContextData> & {
     targetWindow?: Window;
+    channelId?: string;
 };
 export declare class ContextAPI<ContextData extends Record<string, any>> implements Context<ContextData> {
     private contextData;
     targetWindow: Window | undefined;
     readonly id: string;
     private listeners;
+    private postRobotListener;
+    private internalChannelId;
     private postRobotEventId;
-    constructor({ targetWindow, contextData }: ContextAPIConstructorParams<ContextData>);
+    constructor({ targetWindow, contextData, channelId, }: ContextAPIConstructorParams<ContextData>);
+    get channelId(): string | undefined;
+    set channelId(channelId: string | undefined);
+    listenToPostRobot(): void;
     get context(): ContextData;
     set context(context: ContextData);
     getContext(): ContextData;
@@ -18,6 +24,6 @@ export declare class ContextAPI<ContextData extends Record<string, any>> impleme
     subscribeToChanges(contextListener: ContextListener<ContextData>): string;
     subscribeToChanges(id: string, contextListener: ContextListener<ContextData>): string;
     unsubscribeFromChanges(id: string): void;
+    destroy(): void;
 }
-export {};
 //# sourceMappingURL=ContextAPI.d.ts.map

package/dist/lib/ContextAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContextAPI.d.ts","sourceRoot":"","sources":["../../src/lib/ContextAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAK/G,KAAK,2BAA2B,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,oBAAoB,CAAC,WAAW,CAAC,GAAG;IAC9G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,qBAAa,UAAU,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,YAAW,OAAO,CAAC,WAAW,CAAC;IAC9F,OAAO,CAAC,WAAW,CAAa;IAEzB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,SAAS,CAA+C;IAEhE,OAAO,CAAC,gBAAgB,CAAwB;gBAEpC,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,2BAA2B,CAAC,WAAW,CAAC;IAanF,IAAI,OAAO,IAIU,WAAW,CAF/B;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,WAAW,EAK/B;IAED,UAAU;IAIV,UAAU,CAAC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC;IAKpD,eAAe;IAIT,oBAAoB;IAc1B,kBAAkB,CAAC,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,MAAM;IAEzE,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC,GAC5C,MAAM;IAqBT,sBAAsB,CAAC,EAAE,EAAE,MAAM;CAGlC"}
+{"version":3,"file":"ContextAPI.d.ts","sourceRoot":"","sources":["../../src/lib/ContextAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAIlC,MAAM,MAAM,2BAA2B,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC7E,oBAAoB,CAAC,WAAW,CAAC,GAAG;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ,qBAAa,UAAU,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAC7D,YAAW,OAAO,CAAC,WAAW,CAAC;IAE/B,OAAO,CAAC,WAAW,CAAc;IAE1B,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,SAAS,CAA+C;IAEhE,OAAO,CAAC,iBAAiB,CAAM;IAE/B,OAAO,CAAC,iBAAiB,CAAqB;IAE9C,OAAO,CAAC,gBAAgB,CAAqB;gBAEjC,EACV,YAAY,EACZ,WAAW,EACX,SAAS,GACV,EAAE,2BAA2B,CAAC,WAAW,CAAC;IAQ3C,IAAI,SAAS,IAIY,MAAM,GAAG,SAAS,CAF1C;IAED,IAAI,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAM1C;IAED,iBAAiB;IAgBjB,IAAI,OAAO,IAIU,WAAW,CAF/B;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,WAAW,EAK/B;IAED,UAAU;IAIV,UAAU,CAAC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC;IAKpD,eAAe;IAIT,oBAAoB;IAc1B,kBAAkB,CAAC,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,MAAM;IAEzE,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC,GAC5C,MAAM;IAqBT,sBAAsB,CAAC,EAAE,EAAE,MAAM;IAIjC,OAAO;CAGR"}

package/dist/lib/ContextAPI.js

@@ -1,16 +1,35 @@
 import { v4 as uuidv4 } from 'uuid';
 import postRobot from 'post-robot';
 export class ContextAPI {
-    constructor({ targetWindow, contextData }) {
-        this.postRobotEventId = 'context-api-update';
+    constructor({ targetWindow, contextData, channelId, }) {
         this.contextData = contextData;
         this.listeners = {};
         this.id = uuidv4();
         this.targetWindow = targetWindow;
-        postRobot.on(this.postRobotEventId, (event) => {
+        this.channelId = channelId;
+    }
+    get channelId() {
+        return this.internalChannelId;
+    }
+    set channelId(channelId) {
+        this.internalChannelId = channelId;
+        if (channelId) {
+            this.postRobotEventId = `context-api-update::${channelId}`;
+            this.listenToPostRobot();
+        }
+    }
+    listenToPostRobot() {
+        if (!this.postRobotEventId) {
+            return;
+        }
+        if (this.postRobotListener) {
+            this.postRobotListener.cancel();
+        }
+        this.postRobotListener = postRobot.on(this.postRobotEventId, event => {
             if (event.data.from !== this.id) {
                 this.contextData = { ...this.contextData, ...event.data.contextData };
             }
+            return Promise.resolve();
         });
     }
     get context() {
@@ -32,7 +51,7 @@ export class ContextAPI {
         Object.values(this.listeners).forEach(listener => listener(this.context));
     }
     async syncContextToChannel() {
-        if (!this.targetWindow) {
+        if (!this.targetWindow || !this.postRobotEventId) {
             return;
         }
         /** Try to exclude functions in the context */
@@ -56,5 +75,8 @@ export class ContextAPI {
     unsubscribeFromChanges(id) {
         delete this.listeners[id];
     }
+    destroy() {
+        this.postRobotListener.cancel();
+    }
 }
 //# sourceMappingURL=ContextAPI.js.map

package/dist/lib/ContextAPI.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContextAPI.js","sourceRoot":"","sources":["../../src/lib/ContextAPI.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,SAAS,MAAM,YAAY,CAAC;AAMnC,MAAM,OAAO,UAAU;IAWrB,YAAY,EAAE,YAAY,EAAE,WAAW,EAA4C;QAF3E,qBAAgB,GAAG,oBAAoB,CAAC;QAG9C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QAEjC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,KAA2D,EAAE,EAAE;YAClG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACxE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO,CAAC,OAAoB;QAC9B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE3B,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,UAAU,CAAC,OAAyC;QAClD,IAAI,CAAC,OAAO;YACV,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,eAAe;QACb,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,8CAA8C;QAC9C,uDAAuD;QAExD,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE;YAC1D,IAAI,EAAE,IAAI,CAAC,EAAE;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC,CAAC;IACL,CAAC;IASD,kBAAkB,CAChB,mBAA0D,EAC1D,wBAAuD;QAEvD,MAAM,EAAE,GACN,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3E,MAAM,eAAe,GACnB,OAAO,mBAAmB,KAAK,UAAU;YACvC,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,wBAAwB,CAAC;QAE/B,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC;QACrC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,sBAAsB,CAAC,EAAU;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;CACF"}
+{"version":3,"file":"ContextAPI.js","sourceRoot":"","sources":["../../src/lib/ContextAPI.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,SAAS,MAAM,YAAY,CAAC;AAQnC,MAAM,OAAO,UAAU;IAiBrB,YAAY,EACV,YAAY,EACZ,WAAW,EACX,SAAS,GACgC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,IAAI,SAAS,CAAC,SAA6B;QACzC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;QACnC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,SAAS,EAAE,CAAC;YAC3D,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,EAAE;YACnE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACxE,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO,CAAC,OAAoB;QAC9B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE3B,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,UAAU,CAAC,OAAyC;QAClD,IAAI,CAAC,OAAO;YACV,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,eAAe;QACb,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACjD,OAAO;QACT,CAAC;QAED,8CAA8C;QAC9C,uDAAuD;QAEvD,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE;YAC7D,IAAI,EAAE,IAAI,CAAC,EAAE;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IASD,kBAAkB,CAChB,mBAA0D,EAC1D,wBAAuD;QAEvD,MAAM,EAAE,GACN,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3E,MAAM,eAAe,GACnB,OAAO,mBAAmB,KAAK,UAAU;YACvC,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,wBAAwB,CAAC;QAE/B,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC;QACrC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,sBAAsB,CAAC,EAAU;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO;QACL,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;IAClC,CAAC;CACF"}

package/dist/octostar-platform-api.js

@@ -7094,22 +7094,46 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 var ContextAPI = exports.ContextAPI = /*#__PURE__*/function () {
   function ContextAPI(_ref) {
-    var _this = this;
     var targetWindow = _ref.targetWindow,
-      contextData = _ref.contextData;
+      contextData = _ref.contextData,
+      channelId = _ref.channelId;
     _classCallCheck(this, ContextAPI);
-    this.postRobotEventId = 'context-api-update';
     this.contextData = contextData;
     this.listeners = {};
     this.id = (0, _uuid.v4)();
     this.targetWindow = targetWindow;
-    _postRobot["default"].on(this.postRobotEventId, function (event) {
-      if (event.data.from !== _this.id) {
-        _this.contextData = _objectSpread(_objectSpread({}, _this.contextData), event.data.contextData);
-      }
-    });
+    this.channelId = channelId;
   }
   return _createClass(ContextAPI, [{
+    key: "channelId",
+    get: function get() {
+      return this.internalChannelId;
+    },
+    set: function set(channelId) {
+      this.internalChannelId = channelId;
+      if (channelId) {
+        this.postRobotEventId = "context-api-update::".concat(channelId);
+        this.listenToPostRobot();
+      }
+    }
+  }, {
+    key: "listenToPostRobot",
+    value: function listenToPostRobot() {
+      var _this = this;
+      if (!this.postRobotEventId) {
+        return;
+      }
+      if (this.postRobotListener) {
+        this.postRobotListener.cancel();
+      }
+      this.postRobotListener = _postRobot["default"].on(this.postRobotEventId, function (event) {
+        if (event.data.from !== _this.id) {
+          _this.contextData = _objectSpread(_objectSpread({}, _this.contextData), event.data.contextData);
+        }
+        return Promise.resolve();
+      });
+    }
+  }, {
     key: "context",
     get: function get() {
       return this.contextData;
@@ -7144,7 +7168,7 @@ var ContextAPI = exports.ContextAPI = /*#__PURE__*/function () {
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              if (this.targetWindow) {
+              if (!(!this.targetWindow || !this.postRobotEventId)) {
                 _context.next = 2;
                 break;
               }
@@ -7182,6 +7206,11 @@ var ContextAPI = exports.ContextAPI = /*#__PURE__*/function () {
     value: function unsubscribeFromChanges(id) {
       delete this.listeners[id];
     }
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      this.postRobotListener.cancel();
+    }
   }]);
 }();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octostar/platform-api",
-  "version": "0.5.13",
+  "version": "0.5.15",
   "description": "Provides access to the API exposed by Octostar platform to an application run in an iframe",
   "keywords": [
     "octostar",
@@ -38,10 +38,10 @@
     "rimraf": "^5.0.5",
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
-    "@octostar/platform-types": "0.5.16"
+    "@octostar/platform-types": "0.5.18"
   },
   "peerDependencies": {
-    "@octostar/platform-types": "^0.5.16"
+    "@octostar/platform-types": "^0.5.18"
   },
   "publishConfig": {
     "access": "public"