@octostar/platform-api 0.5.10 → 0.5.11

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export * from './lib/JWTProvider';
 export * from './lib/AIClientImpl';
 export * from './lib/Proxy';
 export * from './lib/userWorkspace';
+export * from './lib/ContextAPI';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -8,4 +8,5 @@ export * from './lib/JWTProvider';
 export * from './lib/AIClientImpl';
 export * from './lib/Proxy';
 export * from './lib/userWorkspace';
+export * from './lib/ContextAPI';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC"}

package/dist/lib/ContextAPI.d.ts

@@ -0,0 +1,24 @@
+import { Context, ContextAPISetParams, ContextAPIStaticData, ContextListener } from '@octostar/platform-types';
+type ContextAPIContructorParams<ContextData extends Record<string, any>> = ContextAPIStaticData<ContextData> & {
+    id?: string;
+};
+export declare class ContextAPI<ContextData extends Record<string, any>> implements Context<ContextData> {
+    readonly static_data: ContextAPIStaticData<ContextData>;
+    private channel;
+    private listeners;
+    private id;
+    constructor({ id, ...static_data }: ContextAPIContructorParams<ContextData>);
+    get context(): ContextData;
+    set context(context: ContextData);
+    get channelId(): string | undefined;
+    set channelId(channelId: string | undefined);
+    getContext(): ContextData;
+    setContext(context: ContextAPISetParams<ContextData>): void;
+    notifyListeners(): void;
+    syncContextToChannel(): void;
+    subscribeToChanges(contextListener: ContextListener<ContextData>): string;
+    subscribeToChanges(id: string, contextListener: ContextListener<ContextData>): string;
+    unsubscribeFromChanges(id: string): void;
+}
+export {};
+//# sourceMappingURL=ContextAPI.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContextAPI.d.ts","sourceRoot":"","sources":["../../src/lib/ContextAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAqB,oBAAoB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAGlI,KAAK,0BAA0B,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,oBAAoB,CAAC,WAAW,CAAC,GAAG;IAC7G,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,qBAAa,UAAU,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,YAAW,OAAO,CAAC,WAAW,CAAC;IAC9F,QAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAA;IAEvD,OAAO,CAAC,OAAO,CAA+B;IAE9C,OAAO,CAAC,SAAS,CAA+C;IAEhE,OAAO,CAAC,EAAE,CAAS;gBAEP,EAAE,EAAE,EAAE,GAAG,WAAW,EAAE,EAAE,0BAA0B,CAAC,WAAW,CAAC;IAO3E,IAAI,OAAO,IAIU,WAAW,CAF/B;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,WAAW,EAK/B;IAED,IAAI,SAAS,IAIc,MAAM,GAAG,SAAS,CAF5C;IAEC,IAAI,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAe1C;IAEH,UAAU;IAIV,UAAU,CAAC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC;IAKpD,eAAe;IAIf,oBAAoB;IAWpB,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"}

package/dist/lib/ContextAPI.js

@@ -0,0 +1,67 @@
+import { v4 as uuidv4 } from 'uuid';
+export class ContextAPI {
+    constructor({ id, ...static_data }) {
+        this.static_data = static_data;
+        this.listeners = {};
+        this.id = id ?? uuidv4();
+        this.channelId = static_data.channelId;
+    }
+    get context() {
+        return this.static_data.context;
+    }
+    set context(context) {
+        this.static_data.context = context;
+        this.notifyListeners();
+        this.syncContextToChannel();
+    }
+    get channelId() {
+        return this.static_data.channelId;
+    }
+    set channelId(channelId) {
+        this.static_data.channelId = channelId;
+        const contextChannelId = this.static_data.channelId && `ContextAPI-${this.static_data.channelId}`;
+        if (!contextChannelId) {
+            return;
+        }
+        this.channel = new BroadcastChannel(contextChannelId);
+        this.channel.onmessage = (event) => {
+            if (event.data.from !== this.id) {
+                this.static_data.context = event.data.context;
+            }
+        };
+    }
+    getContext() {
+        return this.context;
+    }
+    setContext(context) {
+        this.context =
+            typeof context === 'function' ? context(this.context) : context;
+    }
+    notifyListeners() {
+        Object.values(this.listeners).forEach(listener => listener(this.context));
+    }
+    syncContextToChannel() {
+        if (!this.channel) {
+            return;
+        }
+        this.channel.postMessage({
+            from: this.id,
+            context: this.context,
+        });
+    }
+    subscribeToChanges(idOrContextListener, contextListenerOrNothing) {
+        const id = typeof idOrContextListener === 'string' ? idOrContextListener : uuidv4();
+        const contextListener = typeof idOrContextListener === 'function'
+            ? idOrContextListener
+            : contextListenerOrNothing;
+        if (!contextListener) {
+            throw new Error('Context listener is required');
+        }
+        this.listeners[id] = contextListener;
+        return id;
+    }
+    unsubscribeFromChanges(id) {
+        delete this.listeners[id];
+    }
+}
+//# sourceMappingURL=ContextAPI.js.map

package/dist/lib/ContextAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextAPI.js","sourceRoot":"","sources":["../../src/lib/ContextAPI.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAMpC,MAAM,OAAO,UAAU;IASrB,YAAY,EAAE,EAAE,EAAE,GAAG,WAAW,EAA2C;QACzE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC;IACzC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,IAAI,OAAO,CAAC,OAAoB;QAC9B,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QAEnC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IACpC,CAAC;IAEC,IAAI,SAAS,CAAC,SAA6B;QACzC,IAAI,CAAC,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QACvC,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,IAAI,cAAc,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;QAClG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAEtD,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,CACvB,KAAmD,EACnD,EAAE;YACF,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAEH,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,oBAAoB;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;YACvB,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;CACF"}

package/dist/octostar-platform-api.js

@@ -6684,7 +6684,7 @@ var forwardCallsToFutureObject = exports.forwardCallsToFutureObject = function f
   });
 };
 
-},{"./constants":33,"./utils":43,"post-robot":5}],35:[function(require,module,exports){
+},{"./constants":33,"./utils":44,"post-robot":5}],35:[function(require,module,exports){
 "use strict";
 
 Object.defineProperty(exports, "__esModule", {
@@ -6800,8 +6800,19 @@ Object.keys(_userWorkspace).forEach(function (key) {
     }
   });
 });
+var _ContextAPI = require("./lib/ContextAPI");
+Object.keys(_ContextAPI).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ContextAPI[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ContextAPI[key];
+    }
+  });
+});
 
-},{"./apis":22,"./components":32,"./constants":33,"./lib/AIClientImpl":36,"./lib/JWTProvider":38,"./lib/Proxy":39,"./lib/userWorkspace":40,"./permissions":41,"./types":42,"./utils":43}],36:[function(require,module,exports){
+},{"./apis":22,"./components":32,"./constants":33,"./lib/AIClientImpl":36,"./lib/ContextAPI":38,"./lib/JWTProvider":39,"./lib/Proxy":40,"./lib/userWorkspace":41,"./permissions":42,"./types":43,"./utils":44}],36:[function(require,module,exports){
 "use strict";
 
 Object.defineProperty(exports, "__esModule", {
@@ -7051,6 +7062,110 @@ AsyncServiceLocator.instances = {};
 },{}],38:[function(require,module,exports){
 "use strict";
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ContextAPI = void 0;
+var _uuid = require("uuid");
+var _excluded = ["id"];
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+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 id = _ref.id,
+      static_data = _objectWithoutProperties(_ref, _excluded);
+    _classCallCheck(this, ContextAPI);
+    this.static_data = static_data;
+    this.listeners = {};
+    this.id = id !== null && id !== void 0 ? id : (0, _uuid.v4)();
+    this.channelId = static_data.channelId;
+  }
+  return _createClass(ContextAPI, [{
+    key: "context",
+    get: function get() {
+      return this.static_data.context;
+    },
+    set: function set(context) {
+      this.static_data.context = context;
+      this.notifyListeners();
+      this.syncContextToChannel();
+    }
+  }, {
+    key: "channelId",
+    get: function get() {
+      return this.static_data.channelId;
+    },
+    set: function set(channelId) {
+      var _this = this;
+      this.static_data.channelId = channelId;
+      var contextChannelId = this.static_data.channelId && "ContextAPI-".concat(this.static_data.channelId);
+      if (!contextChannelId) {
+        return;
+      }
+      this.channel = new BroadcastChannel(contextChannelId);
+      this.channel.onmessage = function (event) {
+        if (event.data.from !== _this.id) {
+          _this.static_data.context = event.data.context;
+        }
+      };
+    }
+  }, {
+    key: "getContext",
+    value: function getContext() {
+      return this.context;
+    }
+  }, {
+    key: "setContext",
+    value: function setContext(context) {
+      this.context = typeof context === 'function' ? context(this.context) : context;
+    }
+  }, {
+    key: "notifyListeners",
+    value: function notifyListeners() {
+      var _this2 = this;
+      Object.values(this.listeners).forEach(function (listener) {
+        return listener(_this2.context);
+      });
+    }
+  }, {
+    key: "syncContextToChannel",
+    value: function syncContextToChannel() {
+      if (!this.channel) {
+        return;
+      }
+      this.channel.postMessage({
+        from: this.id,
+        context: this.context
+      });
+    }
+  }, {
+    key: "subscribeToChanges",
+    value: function subscribeToChanges(idOrContextListener, contextListenerOrNothing) {
+      var id = typeof idOrContextListener === 'string' ? idOrContextListener : (0, _uuid.v4)();
+      var contextListener = typeof idOrContextListener === 'function' ? idOrContextListener : contextListenerOrNothing;
+      if (!contextListener) {
+        throw new Error('Context listener is required');
+      }
+      this.listeners[id] = contextListener;
+      return id;
+    }
+  }, {
+    key: "unsubscribeFromChanges",
+    value: function unsubscribeFromChanges(id) {
+      delete this.listeners[id];
+    }
+  }]);
+}();
+
+},{"uuid":6}],39:[function(require,module,exports){
+"use strict";
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -7134,7 +7249,7 @@ var JWTProvider = exports.JWTProvider = /*#__PURE__*/function () {
   }]);
 }();
 
-},{}],39:[function(require,module,exports){
+},{}],40:[function(require,module,exports){
 "use strict";
 
 Object.defineProperty(exports, "__esModule", {
@@ -7169,7 +7284,7 @@ var makeProxy = exports.makeProxy = function makeProxy(obj) {
   return proxyObj;
 };
 
-},{}],40:[function(require,module,exports){
+},{}],41:[function(require,module,exports){
 "use strict";
 
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
@@ -7222,7 +7337,7 @@ var getOrCreateUsersPrivateWorkspaceRecord = exports.getOrCreateUsersPrivateWork
   };
 }();
 
-},{"uuid":6}],41:[function(require,module,exports){
+},{"uuid":6}],42:[function(require,module,exports){
 "use strict";
 
 Object.defineProperty(exports, "__esModule", {
@@ -7247,14 +7362,14 @@ var ONTOLOGY_PERMISSION_GROUP = exports.ONTOLOGY_PERMISSION_GROUP = 'octostar:on
 var ALL_PERMISSIONS = exports.ALL_PERMISSIONS = 'all';
 var ALL_PERMISSIONS_ARRAY = exports.ALL_PERMISSIONS_ARRAY = [ALL_PERMISSIONS];
 
-},{}],42:[function(require,module,exports){
+},{}],43:[function(require,module,exports){
 "use strict";
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
-},{}],43:[function(require,module,exports){
+},{}],44:[function(require,module,exports){
 "use strict";
 
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octostar/platform-api",
-  "version": "0.5.10",
+  "version": "0.5.11",
   "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.13"
+    "@octostar/platform-types": "0.5.14"
   },
   "peerDependencies": {
-    "@octostar/platform-types": "^0.5.13"
+    "@octostar/platform-types": "^0.5.14"
   },
   "publishConfig": {
     "access": "public"