@octostar/platform-types 0.5.11 → 0.5.13

package/dist/platform-types.d.ts

@@ -93,6 +93,8 @@ export declare type ApiErrorResult = {
     data: string;
     /** The cause of the error, represented by a number. */
     cause: number;
+    /** The original error object. */
+    err: Error;
 };
 
 /**
@@ -449,6 +451,75 @@ 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>> {
+    /** The current context data */
+    context: ContextData;
+    /** Optional channel ID for context synchronization */
+    channelId: string | undefined;
+    /**
+     * @beta
+     * Retrieves the current context
+     * @returns The current context data
+     */
+    getContext(): ContextData;
+    /**
+     * @beta
+     * Updates the context with new data
+     * @param context - New context or function that returns new context based on current
+     */
+    setContext(context: ContextAPISetParams<ContextData>): void;
+    /**
+     * @beta
+     * Notifies all registered listeners about context changes
+     */
+    notifyListeners(): void;
+    /**
+     * @beta
+     * Synchronizes context data to the associated channel
+     */
+    syncContextToChannel(): 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;
+}
+
+export declare type ContextAPIContructorParams<ContextData extends Record<string, any>> = {
+    initialContext: ContextData;
+    id?: string;
+    channelId?: string;
+};
+
+export declare type ContextAPIMessage<ContextData> = {
+    from: string;
+    context: ContextData;
+};
+
+export declare type ContextAPISetParams<ContextData> = ContextData | ((currentContext: ContextData) => ContextData);
+
+export declare type ContextListener<ContextData> = (context: ContextData) => void;
+
 /**
  * @beta
  * Type representing the groups for a context menu.
@@ -1095,6 +1166,10 @@ export declare type DesktopActionMenuItem = {
      * Function to invoke the action.
      */
     invoke: DesktopAction;
+    /**
+     * AI description for the app manifest or service.
+     */
+    aiDescription?: string;
 };
 
 /**
@@ -1924,8 +1999,12 @@ export declare type JobManifest = {
     name: string;
     /** Description of the job. */
     description: string;
+    /** AI description for the job. */
+    aiDescription?: string;
     /** Icon for the job. */
     icon: string;
+    /** Custom color for the app. */
+    color?: string;
     /** Optional image for the job. */
     image?: string;
     /** Optional engine for the job. */
@@ -3129,6 +3208,10 @@ export declare type SendQueryOptions = {
 export declare type ServiceDefinition = {
     /** Description of the service. */
     description: string;
+    /**
+     * AI description for the service.
+     */
+    aiDescription?: string;
     /** Label of the service. */
     label: string;
     /** Icon for the service. */

package/package.json

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