@octostar/platform-api 0.5.18 → 0.5.20

package/dist/apis.d.ts

@@ -1,5 +1,5 @@
-import { Desktop, Ontology, ExtrasApi, RemoteAppApi, SavedSearchAPIInterface, Context } from '@octostar/platform-types';
-import { EnsureMethodsReturnPromise } from './types';
+import { Desktop, Ontology, ExtrasApi, RemoteAppApi, SavedSearchAPIInterface } from '@octostar/platform-types';
+import { ContextApi, EnsureMethodsReturnPromise } from './types';
 /**
  * @beta
  * Provides access to the desktop API.
@@ -20,7 +20,7 @@ export declare const ontologyApi: () => EnsureMethodsReturnPromise<Ontology>;
  * Provides access to the context API.
  * For asynchronous access, use {@link getContextApi}.
  */
-export declare const contextApi: () => EnsureMethodsReturnPromise<Context<Record<string, any>>>;
+export declare const contextApi: () => EnsureMethodsReturnPromise<ContextApi<unknown>>;
 /**
  * @beta
  * Get the desktop API asynchronously.
@@ -35,5 +35,5 @@ export declare const getOntologyApi: () => Promise<EnsureMethodsReturnPromise<On
  * @beta
  * Get the context API asynchronously.
  */
-export declare const getContextApi: () => Promise<EnsureMethodsReturnPromise<Context<Record<string, any>>>>;
+export declare const getContextApi: () => Promise<EnsureMethodsReturnPromise<ContextApi<unknown>>>;
 //# sourceMappingURL=apis.d.ts.map

package/dist/apis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apis.d.ts","sourceRoot":"","sources":["../src/apis.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,uBAAuB,EACvB,OAAO,EACR,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAG,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAsCtD;;;;GAIG;AACH,eAAO,MAAM,UAAU,2CACwC,CAAC;AAEhE,eAAO,MAAM,SAAS,6CACwC,CAAC;AAE/D,eAAO,MAAM,YAAY,gDACwC,CAAC;AAElE,eAAO,MAAM,cAAc,2DACwC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,WAAW,4CACwC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,UAAU,gEACwC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,aAAa,oDACoB,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,cAAc,qDACqB,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,aAAa,yEACoB,CAAC"}
+{"version":3,"file":"apis.d.ts","sourceRoot":"","sources":["../src/apis.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,UAAU,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAsCjE;;;;GAIG;AACH,eAAO,MAAM,UAAU,2CACwC,CAAC;AAEhE,eAAO,MAAM,SAAS,6CACwC,CAAC;AAE/D,eAAO,MAAM,YAAY,gDACwC,CAAC;AAElE,eAAO,MAAM,cAAc,2DACwC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,WAAW,4CACwC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,UAAU,uDACwC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,aAAa,oDACoB,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,cAAc,qDACqB,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,aAAa,gEACoB,CAAC"}

package/dist/apis.js.map

@@ -1 +1 @@
-{"version":3,"file":"apis.js","sourceRoot":"","sources":["../src/apis.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAE9E,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,MAAM,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,cAAc,EAAE;IAClE,KAAK,EAAE,KAAK;CACb,CAAC;KACC,eAAe,CAAC,SAAS,EAAE,GAAG,EAAE,CAC/B,qBAAqB,CAAsC;IACzD,IAAI,EAAE,QAAQ,CAAC,OAAO;CACvB,CAAC,CACH;KACA,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,CAChC,qBAAqB,CAAuC;IAC1D,IAAI,EAAE,QAAQ,CAAC,QAAQ;CACxB,CAAC,CACH;KACA,eAAe,CAAC,SAAS,EAAE,GAAG,EAAE;AAC/B,uCAAuC;AACvC,qBAAqB,CAA2D;IAC9E,IAAI,EAAE,QAAQ,CAAC,OAAO;CACvB,CAAC,CACH;KACA,eAAe,CAAC,QAAQ,EAAE,GAAG,EAAE,CAC9B,qBAAqB,CAAwC;IAC3D,IAAI,EAAE,QAAQ,CAAC,MAAM;CACtB,CAAC,CACH;KACA,eAAe,CAAC,WAAW,EAAE,GAAG,EAAE,CACjC,qBAAqB,CAA2C;IAC9D,IAAI,EAAE,QAAQ,CAAC,SAAS;CACzB,CAAC,CACH;KACA,eAAe,CAAC,aAAa,EAAE,GAAG,EAAE,CACnC,qBAAqB,CAAsD;IACzE,IAAI,EAAE,QAAQ,CAAC,WAAW;CAC3B,CAAC,CACH,CAAC;AAEJ;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAC7B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,EAAE,CAC5B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,EAAE,CAC/B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;AAElE,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE,CACjC,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,EAAE,CAC9B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAC7B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE,CACtC,WAAW,CAAC,UAAU,CAAY,SAAS,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,IAAI,EAAE,CACvC,WAAW,CAAC,UAAU,CAAa,UAAU,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE,CACtC,WAAW,CAAC,UAAU,CAAY,SAAS,CAAC,CAAC"}
+{"version":3,"file":"apis.js","sourceRoot":"","sources":["../src/apis.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAE9E,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,MAAM,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,cAAc,EAAE;IAClE,KAAK,EAAE,KAAK;CACb,CAAC;KACC,eAAe,CAAC,SAAS,EAAE,GAAG,EAAE,CAC/B,qBAAqB,CAAsC;IACzD,IAAI,EAAE,QAAQ,CAAC,OAAO;CACvB,CAAC,CACH;KACA,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,CAChC,qBAAqB,CAAuC;IAC1D,IAAI,EAAE,QAAQ,CAAC,QAAQ;CACxB,CAAC,CACH;KACA,eAAe,CAAC,SAAS,EAAE,GAAG,EAAE;AAC/B,uCAAuC;AACvC,qBAAqB,CAAkD;IACrE,IAAI,EAAE,QAAQ,CAAC,OAAO;CACvB,CAAC,CACH;KACA,eAAe,CAAC,QAAQ,EAAE,GAAG,EAAE,CAC9B,qBAAqB,CAAwC;IAC3D,IAAI,EAAE,QAAQ,CAAC,MAAM;CACtB,CAAC,CACH;KACA,eAAe,CAAC,WAAW,EAAE,GAAG,EAAE,CACjC,qBAAqB,CAA2C;IAC9D,IAAI,EAAE,QAAQ,CAAC,SAAS;CACzB,CAAC,CACH;KACA,eAAe,CAAC,aAAa,EAAE,GAAG,EAAE,CACnC,qBAAqB,CAAsD;IACzE,IAAI,EAAE,QAAQ,CAAC,WAAW;CAC3B,CAAC,CACH,CAAC;AAEJ;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAC7B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,EAAE,CAC5B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,EAAE,CAC/B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;AAElE,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE,CACjC,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,EAAE,CAC9B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAC7B,0BAA0B,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE,CACtC,WAAW,CAAC,UAAU,CAAY,SAAS,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,IAAI,EAAE,CACvC,WAAW,CAAC,UAAU,CAAa,UAAU,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE,CACtC,WAAW,CAAC,UAAU,CAAY,SAAS,CAAC,CAAC"}

package/dist/index.d.ts

@@ -8,6 +8,5 @@ export * from './lib/JWTProvider';
 export * from './lib/AIClientImpl';
 export * from './lib/Proxy';
 export * from './lib/userWorkspace';
-export * from './lib/ContextAPI';
-export * from './lib/classInstanceToObject';
+export * from './lib/LiveContextAPI';
 //# 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;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,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,sBAAsB,CAAC"}

package/dist/index.js

@@ -8,6 +8,5 @@ export * from './lib/JWTProvider';
 export * from './lib/AIClientImpl';
 export * from './lib/Proxy';
 export * from './lib/userWorkspace';
-export * from './lib/ContextAPI';
-export * from './lib/classInstanceToObject';
+export * from './lib/LiveContextAPI';
 //# 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;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,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,sBAAsB,CAAC"}

package/dist/lib/FilesAPIImpl.d.ts

@@ -0,0 +1,8 @@
+import { Files, FileListOptions, FileListResponse, OsAPIClient, WorkspaceItem } from '@octostar/platform-types';
+export declare class FilesAPIImpl implements Files {
+    private osAPIClient;
+    constructor(osAPIClient: OsAPIClient);
+    stat(os_workspace: string, path?: string): Promise<WorkspaceItem>;
+    list_folder(os_workspace: string, path?: string, options?: FileListOptions): Promise<FileListResponse>;
+}
+//# sourceMappingURL=FilesAPIImpl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FilesAPIImpl.d.ts","sourceRoot":"","sources":["../../src/lib/FilesAPIImpl.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,aAAa,EAEd,MAAM,0BAA0B,CAAC;AAElC,qBAAa,YAAa,YAAW,KAAK;IACxC,OAAO,CAAC,WAAW,CAAc;gBAErB,WAAW,EAAE,WAAW;IAI9B,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAajE,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,gBAAgB,CAAC;CAuB7B"}

package/dist/lib/FilesAPIImpl.js

@@ -0,0 +1,38 @@
+export class FilesAPIImpl {
+    constructor(osAPIClient) {
+        this.osAPIClient = osAPIClient;
+    }
+    async stat(os_workspace, path) {
+        const url = path
+            ? `/api/v1/files/stat/${os_workspace}/${encodeURIComponent(path)}`
+            : `/api/v1/files/stat/${os_workspace}`;
+        return this.osAPIClient.fetchData({
+            endpoint: url,
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        });
+    }
+    async list_folder(os_workspace, path, options) {
+        const params = new URLSearchParams();
+        if (options?.maxFolders !== undefined)
+            params.append('max_folders', String(options.maxFolders));
+        if (options?.maxFiles !== undefined)
+            params.append('max_files', String(options.maxFiles));
+        if (options?.folderOffset !== undefined)
+            params.append('folder_offset', String(options.folderOffset));
+        if (options?.fileOffset !== undefined)
+            params.append('file_offset', String(options.fileOffset));
+        const queryString = params.toString();
+        const url = `/api/v1/files/list/${os_workspace}/${path}${queryString ? `?${queryString}` : ''}`;
+        return this.osAPIClient.fetchData({
+            endpoint: url,
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        });
+    }
+}
+//# sourceMappingURL=FilesAPIImpl.js.map

package/dist/lib/FilesAPIImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilesAPIImpl.js","sourceRoot":"","sources":["../../src/lib/FilesAPIImpl.ts"],"names":[],"mappings":"AASA,MAAM,OAAO,YAAY;IAGvB,YAAY,WAAwB;QAClC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,YAAoB,EAAE,IAAa;QAC5C,MAAM,GAAG,GAAG,IAAI;YACd,CAAC,CAAC,sBAAsB,YAAY,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE;YAClE,CAAC,CAAC,sBAAsB,YAAY,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAgB;YAC/C,QAAQ,EAAE,GAAG;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CACf,YAAoB,EACpB,IAAa,EACb,OAAyB;QAEzB,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,UAAU,KAAK,SAAS;YACnC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3D,IAAI,OAAO,EAAE,QAAQ,KAAK,SAAS;YACjC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvD,IAAI,OAAO,EAAE,YAAY,KAAK,SAAS;YACrC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE,UAAU,KAAK,SAAS;YACnC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAE3D,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,sBAAsB,YAAY,IAAI,IAAI,GACpD,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACpC,EAAE,CAAC;QACH,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAmB;YAClD,QAAQ,EAAE,GAAG;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/lib/LiveContextAPI.d.ts

@@ -0,0 +1,27 @@
+import { LiveContext, LiveContextListener, LiveContextAPISetParams, DefaultLiveContextData } from '@octostar/platform-types';
+export declare class LiveContextAPI<ContextData extends DefaultLiveContextData = DefaultLiveContextData> implements LiveContext<ContextData> {
+    private contextData;
+    private listeners;
+    private postRobotListener;
+    private type;
+    private channelId;
+    private iframeChannelAttr;
+    readonly id: string;
+    constructor(contextData: ContextData);
+    private connectPostRobot;
+    private getConnectId;
+    private getTargetWindow;
+    private setContextAndNotify;
+    private getPostRobotEventName;
+    private sendContextUpdate;
+    getContext(): ContextData;
+    setContext(context: LiveContextAPISetParams<ContextData>): Promise<void>;
+    subscribeToChanges(contextListener: LiveContextListener<ContextData>): string;
+    subscribeToChanges(id: string, contextListener: LiveContextListener<ContextData>): string;
+    unsubscribeFromChanges(id: string): void;
+    addContextListener<ContextDataToConnect extends DefaultLiveContextData>(LiveContextAPItoConnect: LiveContextAPI<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData): () => void;
+    removeContextListener<ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContextAPI<ContextDataToConnect> | string): void;
+    connect(): string;
+    destroy(): void;
+}
+//# sourceMappingURL=LiveContextAPI.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LiveContextAPI.d.ts","sourceRoot":"","sources":["../../src/lib/LiveContextAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAMlC,qBAAa,cAAc,CAAC,WAAW,SAAS,sBAAsB,GAAG,sBAAsB,CAAE,YAAW,WAAW,CAAC,WAAW,CAAC;IAElI,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,SAAS,CAAwD;IACzE,OAAO,CAAC,iBAAiB,CAAgD;IACzE,OAAO,CAAC,IAAI,CAAsB;IAClC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,iBAAiB,CAAkC;IAC3D,QAAQ,CAAC,EAAE,SAAY;gBAEX,WAAW,EAAE,WAAW;YAOtB,gBAAgB;IAc9B,OAAO,CAAC,YAAY;YAIN,eAAe;IAyB7B,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,qBAAqB;YAIf,iBAAiB;IAU/B,UAAU;IAIJ,UAAU,CAAC,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC;IAK9D,kBAAkB,CAAC,eAAe,EAAE,mBAAmB,CAAC,WAAW,CAAC,GAAG,MAAM;IAE7E,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,mBAAmB,CAAC,WAAW,CAAC,GAChD,MAAM;IAsBT,sBAAsB,CAAC,EAAE,EAAE,MAAM;IAIjC,kBAAkB,CAAC,oBAAoB,SAAS,sBAAsB,EAAE,uBAAuB,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAAE,UAAU,GAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,WAA4D,GAAG,MAAM,IAAI;IAc/P,qBAAqB,CAAC,oBAAoB,SAAS,sBAAsB,EAAE,cAAc,EAAE,cAAc,CAAC,oBAAoB,CAAC,GAAG,MAAM;IAKvI,OAAO;IAMR,OAAO;CAGR"}

package/dist/lib/LiveContextAPI.js

@@ -0,0 +1,120 @@
+import { v4 as uuidv4 } from 'uuid';
+import * as postRobot from 'post-robot';
+const CONTEXT_UPDATE_EVENT = 'context-update';
+export class LiveContextAPI {
+    constructor(contextData) {
+        this.listeners = {};
+        this.iframeChannelAttr = 'data-octostar-iframe-channel';
+        this.id = uuidv4();
+        this.contextData = contextData;
+        const iframeChannelId = window.frameElement?.getAttribute(this.iframeChannelAttr);
+        this.channelId = iframeChannelId || uuidv4();
+        this.type = iframeChannelId ? 'iframe' : 'parent';
+    }
+    async connectPostRobot() {
+        const targetWindow = await this.getTargetWindow();
+        const postRobotEventName = this.getPostRobotEventName(this.channelId);
+        this.postRobotListener = (postRobot.on(postRobotEventName, { window: targetWindow }, (event) => {
+            if (event.data.type === 'init') {
+                this.setContext((context) => ({ ...context, ...event.data.context }));
+            }
+            else {
+                this.setContextAndNotify((context) => ({ ...context, ...event.data.context }));
+            }
+            return Promise.resolve();
+        }));
+        await this.sendContextUpdate(true);
+    }
+    getConnectId(contextAPI) {
+        return `ContextAPI-${contextAPI.id}`;
+    }
+    async getTargetWindow() {
+        if (this.type === 'iframe' && window.top) {
+            return window.top;
+        }
+        const iframe = document.querySelector(`iframe[${this.iframeChannelAttr}='${this.channelId}']`);
+        if (iframe?.contentWindow) {
+            return iframe.contentWindow;
+        }
+        // Wait for the iframe to appear in the DOM
+        return new Promise((resolve) => {
+            const observer = new MutationObserver(() => {
+                const iframe = document.querySelector(`iframe[${this.iframeChannelAttr}='${this.channelId}']`);
+                if (iframe?.contentWindow) {
+                    observer.disconnect();
+                    resolve(iframe.contentWindow);
+                }
+            });
+            // Start observing
+            observer.observe(document.body, { childList: true, subtree: true });
+        });
+    }
+    setContextAndNotify(context) {
+        if (typeof context === 'function') {
+            this.contextData = context(this.contextData);
+        }
+        else {
+            this.contextData = context;
+        }
+        Object.values(this.listeners).forEach(listener => listener(this.contextData));
+    }
+    getPostRobotEventName(channelId) {
+        return `${channelId}-${CONTEXT_UPDATE_EVENT}`;
+    }
+    async sendContextUpdate(isInit = false) {
+        try {
+            const targetWindow = await this.getTargetWindow();
+            postRobot.send(targetWindow, this.getPostRobotEventName(this.channelId), { context: this.contextData, ...(isInit && { type: 'init' }) });
+        }
+        catch (error) {
+            // Silently ignore any errors during context update
+            console.debug('Failed to send context update:', error);
+        }
+    }
+    getContext() {
+        return this.contextData;
+    }
+    async setContext(context) {
+        this.setContextAndNotify(context);
+        await this.sendContextUpdate();
+    }
+    subscribeToChanges(idOrContextListener, contextListenerOrNothing) {
+        const id = typeof idOrContextListener === 'string' ? idOrContextListener : uuidv4();
+        const contextListener = typeof idOrContextListener === 'function'
+            ? idOrContextListener
+            : contextListenerOrNothing;
+        if (!contextListener) {
+            const error = new Error('Context listener is required');
+            throw error;
+        }
+        this.listeners[id] = contextListener;
+        return id;
+    }
+    unsubscribeFromChanges(id) {
+        delete this.listeners[id];
+    }
+    addContextListener(LiveContextAPItoConnect, mapContext = (context) => context) {
+        // Merge the new context with existing context
+        this.setContext((currentContext) => ({ ...currentContext, ...mapContext(LiveContextAPItoConnect.getContext()) }));
+        // Subscribe to changes if id is provided
+        const subscriptionId = this.getConnectId(LiveContextAPItoConnect);
+        LiveContextAPItoConnect.subscribeToChanges(subscriptionId, (updatedContext) => {
+            this.setContext((currentContext) => ({ ...currentContext, ...mapContext(updatedContext) }));
+        });
+        // Return a callback function that unsubscribes
+        return () => this.unsubscribeFromChanges(subscriptionId);
+    }
+    removeContextListener(idOrContextAPI) {
+        const id = typeof idOrContextAPI === 'string' ? idOrContextAPI : this.getConnectId(idOrContextAPI);
+        this.unsubscribeFromChanges(id);
+    }
+    connect() {
+        const channelId = this.channelId;
+        this.connectPostRobot();
+        return channelId;
+    }
+    destroy() {
+        this.postRobotListener?.cancel();
+    }
+}
+//# sourceMappingURL=LiveContextAPI.js.map

package/dist/lib/LiveContextAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveContextAPI.js","sourceRoot":"","sources":["../../src/lib/LiveContextAPI.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,KAAK,SAAS,MAAM,YAAY,CAAC;AAExC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAE9C,MAAM,OAAO,cAAc;IAUzB,YAAY,WAAwB;QAP5B,cAAS,GAAqD,EAAE,CAAC;QAIjE,sBAAiB,GAAG,8BAA8B,CAAC;QAClD,OAAE,GAAG,MAAM,EAAE,CAAC;QAGrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,MAAM,eAAe,GAAG,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAClF,IAAI,CAAC,SAAS,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAClD,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,CAAC,iBAAiB,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE;YAC7F,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC/B,IAAI,CAAC,UAAU,CAAC,CAAC,OAAoB,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACrF,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,mBAAmB,CAAC,CAAC,OAAoB,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC9F,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC,CAAC;QACJ,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEO,YAAY,CAAsD,UAAgD;QACxH,OAAO,cAAc,UAAU,CAAC,EAAE,EAAE,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;YACzC,OAAO,MAAM,CAAC,GAAG,CAAC;QACpB,CAAC;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAoB,UAAU,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;QAClH,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,aAAa,CAAC;QAC9B,CAAC;QAED,2CAA2C;QAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,GAAG,EAAE;gBACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAoB,UAAU,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;gBAClH,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;oBAC1B,QAAQ,CAAC,UAAU,EAAE,CAAC;oBACtB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,kBAAkB;YAClB,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,OAA6C;QACvE,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAC7B,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAChF,CAAC;IAEO,qBAAqB,CAAC,SAAiB;QAC7C,OAAO,GAAG,SAAS,IAAI,oBAAoB,EAAE,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,MAAM,GAAG,KAAK;QAC5C,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YAClD,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;QAC3I,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,mDAAmD;YACnD,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAA6C;QAC5D,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACjC,CAAC;IASD,kBAAkB,CAChB,mBAA8D,EAC9D,wBAA2D;QAE5D,MAAM,EAAE,GACL,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,KAAK,GAAG,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YACxD,MAAM,KAAK,CAAC;QACd,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,kBAAkB,CAAsD,uBAA6D,EAAE,aAA6D,CAAC,OAAO,EAAE,EAAE,CAAC,OAAiC;QAChP,8CAA8C;QAC9C,IAAI,CAAC,UAAU,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,UAAU,CAAC,uBAAuB,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAElH,yCAAyC;QACzC,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC;QAClE,uBAAuB,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAC,cAAc,EAAE,EAAE;YAC5E,IAAI,CAAC,UAAU,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC;QAEH,+CAA+C;QAC/C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED,qBAAqB,CAAsD,cAA6D;QACtI,MAAM,EAAE,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QACnG,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IAEA,OAAO;QACN,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;IACnC,CAAC;CACF"}