@octostar/platform-types 0.5.23 → 0.5.24

package/dist/platform-types.d.ts

@@ -669,6 +669,8 @@ export declare type DataMask = {
     ownState?: Record<string, any>;
 };
 
+export declare type DefaultLiveContextData = Record<string, any>;
+
 /**
  * Interface for desktop actions.
  * @beta
@@ -2012,6 +2014,75 @@ export declare type KnownCounts = {
     [relationship_name: string]: number;
 };
 
+/**
+ * @beta
+ * Represents a context management interface for handling state across components
+ */
+export declare interface LiveContext<ContextData extends DefaultLiveContextData = DefaultLiveContextData> {
+    /**
+     * @beta
+     * Retrieves the current context data
+     * @returns The current context data
+     */
+    getContext(): ContextData;
+    /**
+     * @beta
+     * Updates the context with new data
+     * @param context - New context data or function to update context
+     */
+    setContext(context: LiveContextAPISetParams<ContextData>): Promise<void>;
+    /**
+     * @beta
+     * Subscribes to context changes with an automatically generated ID
+     * @param contextListener - Callback function triggered on context changes
+     * @returns Generated subscription ID
+     */
+    subscribeToChanges(contextListener: LiveContextListener<ContextData>): string;
+    /**
+     * @beta
+     * Subscribes to context changes with a custom ID
+     * @param id - Custom subscription ID
+     * @param contextListener - Callback function triggered on context changes
+     * @returns The subscription ID
+     */
+    subscribeToChanges(id: string, contextListener: LiveContextListener<ContextData>): string;
+    /**
+     * @beta
+     * Unsubscribes from context changes
+     * @param id - Subscription ID to remove
+     */
+    unsubscribeFromChanges(id: string): void;
+    /**
+     * @beta
+     * Adds a context listener to another Context instance
+     * @param contextAPI - The Context instance to connect to
+     * @param mapContext - Optional function to transform context data
+     * @returns Function to remove the context listener
+     */
+    addContextListener<ContextDataToConnect extends DefaultLiveContextData>(contextAPI: LiveContext<ContextDataToConnect>, mapContext?: (context: ContextDataToConnect) => ContextData): () => void;
+    /**
+     * @beta
+     * Removes a context listener
+     * @param idOrContextAPI - ID or Context instance to disconnect from
+     */
+    removeContextListener<ContextDataToConnect extends DefaultLiveContextData>(idOrContextAPI: LiveContext<ContextDataToConnect> | string): void;
+    /**
+     * @beta
+     * Connects to target window for context synchronization
+     * @returns The channel ID used for communication
+     */
+    connect(): string;
+    /**
+     * @beta
+     * Destroys the context and cleans up all listeners
+     */
+    destroy(): void;
+}
+
+export declare type LiveContextAPISetParams<ContextData extends Record<string, any> = Record<string, any>> = ContextData | ((currentContext: ContextData) => ContextData);
+
+export declare type LiveContextListener<ContextData extends Record<string, any> = Record<string, any>> = (context: ContextData) => void;
+
 export declare type ManifestSecrets = {
     [key: string]: {
         description: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octostar/platform-types",
-  "version": "0.5.23",
+  "version": "0.5.24",
   "description": "Types for the API exposed by Octostar platform to third parties",
   "keywords": [
     "octostar",