@octostar/platform-types 0.5.22 → 0.5.24

package/dist/liveContext.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=liveContext.js.map

package/dist/liveContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveContext.js","sourceRoot":"","sources":["../src/liveContext.ts"],"names":[],"mappings":""}

package/dist/platform-types.d.ts

@@ -451,71 +451,6 @@ export declare type ConnectedEntity = Entity & {
     concept_name: string;
 };
 
-/**
- * @beta
- * Represents a context management interface for handling state across components
- */
-export declare interface Context<ContextData extends Record<string, any>> {
-    /**
-     * @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 to merge with existing context
-     * @param doMerge - Whether to merge the new context with existing context (default: true)
-     */
-    setContext(context: ContextData, doMerge?: boolean): 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: ContextListener<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: ContextListener<ContextData>): string;
-    /**
-     * @beta
-     * Unsubscribes from context changes
-     * @param id - Subscription ID to remove
-     */
-    unsubscribeFromChanges(id: string): void;
-    /**
-     * @beta
-     * Connects to an iframe for context synchronization
-     * @returns Object containing channelId and onIframeLoad event handler
-     * @throws Error if the context is not a parent type
-     */
-    connectToIframe(): {
-        channelId: string;
-        onIframeLoad: React.ReactEventHandler<HTMLIFrameElement>;
-    };
-    /**
-     * @beta
-     * Connects to parent window for context synchronization
-     */
-    connectToParent(): void;
-    /**
-     * @beta
-     * Destroys the context and cleans up all listeners
-     */
-    destroy(): void;
-}
-
-export declare type ContextAPISetParams<ContextData> = ContextData | ((currentContext: ContextData) => ContextData);
-
-export declare type ContextListener<ContextData> = (context: ContextData | undefined) => void;
-
 /**
  * @beta
  * Type representing the groups for a context menu.
@@ -734,6 +669,8 @@ export declare type DataMask = {
     ownState?: Record<string, any>;
 };
 
+export declare type DefaultLiveContextData = Record<string, any>;
+
 /**
  * Interface for desktop actions.
  * @beta
@@ -1600,6 +1537,43 @@ export declare type FileCode = {
     file: string;
 };
 
+export declare interface FileListOptions {
+    maxFolders?: number;
+    maxFiles?: number;
+    folderOffset?: number;
+    fileOffset?: number;
+}
+
+export declare interface FileListResponse {
+    folders: WorkspaceItem[];
+    files: WorkspaceItem[];
+    total_folders: number;
+    total_files: number;
+}
+
+/**
+ * Files service for interacting with the file system
+ */
+export declare interface Files {
+    /**
+     * Check if file/folder/workspace exists and return its complete entity data
+     *
+     * @param os_workspace - The workspace ID
+     * @param path - The path to check (empty string for workspace info)
+     * @returns Complete entity data if found
+     */
+    stat(os_workspace: string, path?: string): Promise<WorkspaceItem>;
+    /**
+     * List immediate children (files and folders) of a given path
+     *
+     * @param os_workspace - The workspace ID
+     * @param path - The path to list children for (empty string for workspace root)
+     * @param options - Optional parameters for pagination
+     * @returns Object containing arrays of folders and files with pagination info
+     */
+    list_folder(os_workspace: string, path?: string, options?: FileListOptions): Promise<FileListResponse>;
+}
+
 /**
  * Options for file tree.
  * @beta
@@ -2040,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.22",
+  "version": "0.5.24",
   "description": "Types for the API exposed by Octostar platform to third parties",
   "keywords": [
     "octostar",

package/dist/context.d.ts

@@ -1,64 +0,0 @@
-type ContextListener<ContextData> = (context: ContextData | undefined) => void;
-type ContextAPISetParams<ContextData> = ContextData | ((currentContext: ContextData) => ContextData);
-/**
- * @beta
- * Represents a context management interface for handling state across components
- */
-export interface Context<ContextData extends Record<string, any>> {
-    /**
-     * @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 to merge with existing context
-     * @param doMerge - Whether to merge the new context with existing context (default: true)
-     */
-    setContext(context: ContextData, doMerge?: boolean): 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: ContextListener<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: ContextListener<ContextData>): string;
-    /**
-     * @beta
-     * Unsubscribes from context changes
-     * @param id - Subscription ID to remove
-     */
-    unsubscribeFromChanges(id: string): void;
-    /**
-     * @beta
-     * Connects to an iframe for context synchronization
-     * @returns Object containing channelId and onIframeLoad event handler
-     * @throws Error if the context is not a parent type
-     */
-    connectToIframe(): {
-        channelId: string;
-        onIframeLoad: React.ReactEventHandler<HTMLIFrameElement>;
-    };
-    /**
-     * @beta
-     * Connects to parent window for context synchronization
-     */
-    connectToParent(): void;
-    /**
-     * @beta
-     * Destroys the context and cleans up all listeners
-     */
-    destroy(): void;
-}
-export type { ContextListener, ContextAPISetParams };
-//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,CAAC,WAAW,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,KAAK,IAAI,CAAC;AAE/E,KAAK,mBAAmB,CAAC,WAAW,IAChC,WAAW,GACX,CAAC,CAAC,cAAc,EAAE,WAAW,KAAK,WAAW,CAAC,CAAC;AAGnD;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC9D;;;;OAIG;IACH,UAAU,IAAI,WAAW,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1D;;;;;OAKG;IACH,kBAAkB,CAAC,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;IAE1E;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;IAEtF;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;;OAKG;IACH,eAAe,IAAI;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;KAAE,CAAC;IAEnG;;;OAGG;IACH,eAAe,IAAI,IAAI,CAAC;IAExB;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,YAAY,EACV,eAAe,EACf,mBAAmB,EACpB,CAAC"}

package/dist/context.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":""}

package/dist/docs/interfaces/Context.html

@@ -1,28 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Context | @octostar/platform-types - v0.5.22</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.22</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="Context.html">Context</a></li></ul><h1>Interface Context&lt;ContextData&gt;<code class="tsd-tag">Beta</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a context management interface for handling state across components</p>
-</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Context</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#connectToIframe.connectToIframe-1">connectToIframe</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">onIframeLoad</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactEventHandler</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLIFrameElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#connectToParent.connectToParent-1">connectToParent</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#destroy.destroy-1">destroy</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#getContext.getContext-1">getContext</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#setContext.setContext-1">setContext</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a>, <span class="tsd-kind-parameter">doMerge</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#subscribeToChanges.subscribeToChanges-1">subscribeToChanges</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/ContextListener.html" class="tsd-signature-type tsd-kind-type-alias">ContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#subscribeToChanges.subscribeToChanges-2">subscribeToChanges</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">: </span><a href="../types/ContextListener.html" class="tsd-signature-type tsd-kind-type-alias">ContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="Context.html#unsubscribeFromChanges.unsubscribeFromChanges-1">unsubscribeFromChanges</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ContextData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ContextData</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L12">context.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Context.html#connectToIframe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>To<wbr/>Iframe</span></a>
-<a href="Context.html#connectToParent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>To<wbr/>Parent</span></a>
-<a href="Context.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a>
-<a href="Context.html#getContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Context</span></a>
-<a href="Context.html#setContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Context</span></a>
-<a href="Context.html#subscribeToChanges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>To<wbr/>Changes</span></a>
-<a href="Context.html#unsubscribeFromChanges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unsubscribe<wbr/>From<wbr/>Changes</span></a>
-</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="connectToIframe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect<wbr/>To<wbr/>Iframe</span><a href="#connectToIframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connectToIframe.connectToIframe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect<wbr/>To<wbr/>Iframe</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">onIframeLoad</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactEventHandler</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLIFrameElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#connectToIframe.connectToIframe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Connects to an iframe for context synchronization</p>
-</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">channelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">onIframeLoad</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactEventHandler</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLIFrameElement</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><p>Object containing channelId and onIframeLoad event handler</p>
-<ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">channel<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Beta</code><span class="tsd-kind-property">on<wbr/>Iframe<wbr/>Load</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactEventHandler</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLIFrameElement</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"></div></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Throws"><h4 class="tsd-anchor-link"><a id="Throws" class="tsd-anchor"></a>Throws<a href="#Throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Error if the context is not a parent type</p>
-</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L58">context.ts:58</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connectToParent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect<wbr/>To<wbr/>Parent</span><a href="#connectToParent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connectToParent.connectToParent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect<wbr/>To<wbr/>Parent</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#connectToParent.connectToParent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Connects to parent window for context synchronization</p>
-</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L64">context.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="destroy.destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Destroys the context and cleans up all listeners</p>
-</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L70">context.ts:70</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Context</span><a href="#getContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getContext.getContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><a href="#getContext.getContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Retrieves the current context data</p>
-</div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a></h4><p>The current context data</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L18">context.ts:18</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Context</span><a href="#setContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setContext.setContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span>, <span class="tsd-kind-parameter">doMerge</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setContext.setContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Updates the context with new data</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a></span><div class="tsd-comment tsd-typography"><p>New context data to merge with existing context</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">doMerge</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to merge the new context with existing context (default: true)</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L26">context.ts:26</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribeToChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe<wbr/>To<wbr/>Changes</span><a href="#subscribeToChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subscribeToChanges.subscribeToChanges-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribe<wbr/>To<wbr/>Changes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#subscribeToChanges.subscribeToChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Subscribes to context changes with an automatically generated ID</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contextListener</span>: <a href="../types/ContextListener.html" class="tsd-signature-type tsd-kind-type-alias">ContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Callback function triggered on context changes</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Generated subscription ID</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L34">context.ts:34</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="subscribeToChanges.subscribeToChanges-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribe<wbr/>To<wbr/>Changes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">contextListener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#subscribeToChanges.subscribeToChanges-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Subscribes to context changes with a custom ID</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Custom subscription ID</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">contextListener</span>: <a href="../types/ContextListener.html" class="tsd-signature-type tsd-kind-type-alias">ContextListener</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Context.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Callback function triggered on context changes</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The subscription ID</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L43">context.ts:43</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unsubscribeFromChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unsubscribe<wbr/>From<wbr/>Changes</span><a href="#unsubscribeFromChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unsubscribeFromChanges.unsubscribeFromChanges-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unsubscribe<wbr/>From<wbr/>Changes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unsubscribeFromChanges.unsubscribeFromChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Beta</code><div class="tsd-comment tsd-typography"><p>Unsubscribes from context changes</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Subscription ID to remove</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L50">context.ts:50</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#connectToIframe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>To<wbr/>Iframe</span></a><a href="#connectToParent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>To<wbr/>Parent</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#getContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Context</span></a><a href="#setContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Context</span></a><a href="#subscribeToChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>To<wbr/>Changes</span></a><a href="#unsubscribeFromChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unsubscribe<wbr/>From<wbr/>Changes</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.22</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/dist/docs/types/ContextAPISetParams.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ContextAPISetParams | @octostar/platform-types - v0.5.22</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.22</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="ContextAPISetParams.html">ContextAPISetParams</a></li></ul><h1>Type Alias ContextAPISetParams&lt;ContextData&gt;</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ContextAPISet<wbr/>Params</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ContextAPISetParams.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="ContextAPISetParams.html#ContextData">ContextData</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">currentContext</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ContextAPISetParams.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ContextAPISetParams.html#ContextData">ContextData</a><span class="tsd-signature-symbol">)</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ContextData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ContextData</span></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L3">context.ts:3</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.22</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/dist/docs/types/ContextListener.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ContextListener | @octostar/platform-types - v0.5.22</title><meta name="description" content="Documentation for @octostar/platform-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@octostar/platform-types - v0.5.22</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@octostar/platform-types</a></li><li><a href="ContextListener.html">ContextListener</a></li></ul><h1>Type Alias ContextListener&lt;ContextData&gt;</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Context<wbr/>Listener</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ContextListener.html#ContextData">ContextData</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ContextListener.html#ContextData">ContextData</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ContextData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ContextData</span></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Octostarco/octostar-frontend/blob/f33e6c99c336fb90daadb240e80b9b91907846cc/packages/octostar-platform-types/src/context.ts#L1">context.ts:1</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@octostar/platform-types - v0.5.22</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>