@pulse-editor/shared-utils 0.1.1-alpha.4 → 0.1.1-alpha.41

package/dist/imc/inter-module-communication.d.ts

@@ -2,17 +2,25 @@ import { IMCMessageTypeEnum, ReceiverHandlerMap } from "../types/types";
 export declare class InterModuleCommunication {
     private thisWindow;
     private otherWindow;
-    private thisPendingTasks;
-    private otherPendingMessages;
     private receiver;
     private sender;
-    private moduleName;
+    private thisWindowId;
+    private otherWindowId;
     private receiverHandlerMap;
     private listener;
-    constructor(moduleName: string);
-    initThisWindow(window: Window): void;
-    initOtherWindow(window: Window): void;
+    private messageRecords;
+    /**
+     * Initialize a receiver to receive message.
+     * @param window The current window.
+     * @param otherWindowId The ID of the other window. This is optional and can be undefined.
+     * When defined, the receiver will only receive messages from window with the ID.
+     */
+    initThisWindow(window: Window, otherWindowId?: string): void;
+    initOtherWindow(window: Window): Promise<void>;
     close(): void;
     sendMessage(type: IMCMessageTypeEnum, payload?: any, abortSignal?: AbortSignal): Promise<any>;
     updateReceiverHandlerMap(receiverHandlerMap: ReceiverHandlerMap): void;
+    getThisWindowId(): string;
+    getOtherWindowId(): string;
+    private setBaseHandler;
 }

package/dist/imc/message-receiver.d.ts

@@ -2,10 +2,8 @@ import { IMCMessage, ReceiverHandlerMap } from "../types/types";
 export declare class MessageReceiver {
     private handlerMap;
     private pendingTasks;
-    private moduleName;
-    constructor(listenerMap: ReceiverHandlerMap, pendingTasks: Map<string, {
-        controller: AbortController;
-    }>, moduleInfo: string);
+    private windowId;
+    constructor(listenerMap: ReceiverHandlerMap, windowId: string);
     receiveMessage(senderWindow: Window, message: IMCMessage): void;
     private acknowledgeSender;
 }

package/dist/imc/message-sender.d.ts

@@ -3,10 +3,12 @@ export declare class MessageSender {
     private targetWindow;
     private timeout;
     private pendingMessages;
-    private moduleName;
-    constructor(targetWindow: Window, timeout: number, pendingMessages: Map<string, {
+    private moduleId;
+    constructor(targetWindow: Window, timeout: number, moduleId: string);
+    sendMessage(handlingType: IMCMessageTypeEnum, payload?: any, abortSignal?: AbortSignal): Promise<any>;
+    getPendingMessage(id: string): {
         resolve: (result: any) => void;
         reject: () => void;
-    }>, moduleInfo: string);
-    sendMessage(handlingType: IMCMessageTypeEnum, payload?: any, abortSignal?: AbortSignal): Promise<any>;
+    } | undefined;
+    removePendingMessage(id: string): void;
 }

package/dist/imc/poly-imc.d.ts

@@ -0,0 +1,37 @@
+import { IMCMessage, IMCMessageTypeEnum, ReceiverHandlerMap } from "../types/types";
+/**
+ * Poly IMC establishes two-way inter-module communication channels,
+ * where each channel consists of a sender and a receiver to send and
+ * receive messages between host window and the other module's window.
+ *
+ * This assumes the other window has IMC or Poly-IMC setup.
+ */
+export declare class PolyIMC {
+    private channels;
+    private baseReceiverHandlerMap;
+    private channelReceiverHandlerMapMap;
+    /**
+     *
+     * @param baseReceiverHandlerMap A base receiver handler map for universal handlers.
+     * E.g. Pulse Editor API handler
+     */
+    constructor(baseReceiverHandlerMap: ReceiverHandlerMap);
+    sendMessage(targetWindowId: string, handlingType: IMCMessageTypeEnum, payload?: any, abortSignal?: AbortSignal): Promise<any>;
+    updateBaseReceiverHandlerMap(handlerMap: ReceiverHandlerMap): void;
+    updateChannelReceiverHandlerMap(targetWindowId: string, handlerMap: ReceiverHandlerMap): void;
+    createChannel(targetWindow: Window, targetWindowId: string, receiverHandlerMap?: ReceiverHandlerMap): Promise<void>;
+    removeChannel(targetWindowId: string): void;
+    hasChannel(targetWindowId: string): boolean;
+    close(): void;
+    private getCombinedHandlerMap;
+}
+export declare class ConnectionListener {
+    private polyIMC;
+    private newConnectionReceiverHandlerMap;
+    private onConnection?;
+    private listener;
+    constructor(polyIMC: PolyIMC, newConnectionReceiverHandlerMap: ReceiverHandlerMap, onConnection?: (senderWindow: Window, message: IMCMessage) => void);
+    close(): void;
+    updateReceiverHandlerMap(newReceiverHandlerMap: ReceiverHandlerMap): void;
+    private handleExtReady;
+}

package/dist/main.d.ts

@@ -1,6 +1,7 @@
 import { InterModuleCommunication } from "./imc/inter-module-communication";
-import { MessageSender } from "./imc/message-sender";
 import { MessageReceiver } from "./imc/message-receiver";
-import { AccessEnum, Agent, AgentMethod, AgentTool, AgentVariable, AgentVariableType, ExtensionConfig, ExtensionTypeEnum, FetchPayload, FileViewModel, IMCMessage, IMCMessageTypeEnum, LLMConfig, NotificationTypeEnum, ReceiverHandlerMap, TextFileSelection } from "./types/types";
-import { messageTimeout } from "./types/constants";
-export { InterModuleCommunication, MessageSender, MessageReceiver, AccessEnum, Agent, AgentMethod, AgentTool, AgentVariable, AgentVariableType, ExtensionConfig, ExtensionTypeEnum, FetchPayload, FileViewModel, IMCMessage, IMCMessageTypeEnum, LLMConfig, NotificationTypeEnum, ReceiverHandlerMap, TextFileSelection, messageTimeout, };
+import { MessageSender } from "./imc/message-sender";
+import { ConnectionListener, PolyIMC } from "./imc/poly-imc";
+export * from "./types/constants";
+export * from "./types/types";
+export { ConnectionListener, InterModuleCommunication, MessageReceiver, MessageSender, PolyIMC, };

package/dist/main.js

@@ -1 +1 @@
-var e,t,s,i;!function(e){e.WriteViewFile="write-view-file",e.RequestViewFile="request-view-file",e.Fetch="fetch",e.Notification="notification",e.ThemeChange="theme-change",e.InstallAgent="install-agent",e.RunAgentMethod="run-agent-method",e.InstallAgentTool="install-agent-tool",e.OCR="ocr",e.RequestTerminal="request-terminal",e.Ready="ready",e.Loaded="loaded",e.Acknowledge="acknowledge",e.Abort="abort",e.Error="error"}(e||(e={})),function(e){e.Success="success",e.Error="error",e.Info="info",e.Warning="warning"}(t||(t={})),function(e){e.Generic="generic",e.FileView="file-view",e.ConsoleView="console-view"}(s||(s={})),function(e){e.public="public",e.private="private"}(i||(i={}));const n=3e5;class r{constructor(e,t,s){this.handlerMap=e,this.pendingTasks=t,this.moduleName=s}receiveMessage(t,s){if(this.moduleName===s.from)return;if("development"===process.env.NODE_ENV&&console.log(`Module ${this.moduleName} received message from module ${s.from}:\n ${JSON.stringify(s)}`),s.type===e.Abort){const e=s.id,t=this.pendingTasks.get(e);return void(t&&(console.log("Aborting task",e),t.controller.abort(),this.pendingTasks.delete(e)))}const i=this.handlerMap.get(s.type);if(i){const n=new AbortController,r=n.signal;this.pendingTasks.set(s.id,{controller:n});i(t,s,r).then((i=>{r.aborted||s.type!==e.Acknowledge&&this.acknowledgeSender(t,s.id,i)})).catch((i=>{const n={id:s.id,type:e.Error,payload:i.message,from:this.moduleName};t.postMessage(n,"*")})).finally((()=>{this.pendingTasks.delete(s.id)}))}}acknowledgeSender(t,s,i){const n={id:s,type:e.Acknowledge,payload:i,from:this.moduleName};t.postMessage(n,"*")}}class o{constructor(e,t,s,i){this.targetWindow=e,this.timeout=t,this.pendingMessages=s,this.moduleName=i}async sendMessage(t,s,i){const n=(new Date).getTime().toString(),r={id:n,type:t,payload:s,from:this.moduleName};return new Promise(((t,s)=>{if(i?.aborted)return s(new Error("Request aborted"));const o=()=>{this.pendingMessages.delete(n),this.targetWindow.postMessage({id:n,type:e.Abort,payload:JSON.stringify({status:"Task aborted",data:null})},"*"),s(new Error("Request aborted"))};i?.addEventListener("abort",o),this.pendingMessages.set(n,{resolve:t,reject:s}),this.targetWindow.postMessage(r,"*");const a=setTimeout((()=>{this.pendingMessages.delete(n),i?.removeEventListener("abort",o),s(new Error("Communication with Pulse Editor timeout."))}),this.timeout),d=this.pendingMessages.get(n);d&&(d.resolve=e=>{clearTimeout(a),i?.removeEventListener("abort",o),t(e)},d.reject=()=>{clearTimeout(a),i?.removeEventListener("abort",o),s()})}))}}class a{constructor(e){this.moduleName=e}initThisWindow(e){this.thisWindow=e,this.receiverHandlerMap=new Map,this.thisPendingTasks=new Map;const t=new r(this.receiverHandlerMap,this.thisPendingTasks,this.moduleName);this.receiver=t,this.listener=e=>{if(!t)throw new Error("Receiver not initialized at module "+this.moduleName);const s=e.data,i=e.source;t.receiveMessage(i,s)},e.addEventListener("message",this.listener),console.log("Adding IMC listener in "+this.moduleName)}initOtherWindow(t){this.otherWindow=t,this.otherPendingMessages=new Map;const s=new o(t,n,this.otherPendingMessages,this.moduleName);if(this.sender=s,!this.receiverHandlerMap)throw new Error("You must initialize the current window first.");this.receiverHandlerMap.set(e.Acknowledge,(async(e,t)=>{const s=this.otherPendingMessages?.get(t.id);s&&(s.resolve(t.payload),this.otherPendingMessages?.delete(t.id))}))}close(){this.listener&&window.removeEventListener("message",this.listener)}async sendMessage(e,t,s){if(!this.sender)throw new Error("Sender not initialized");return await this.sender.sendMessage(e,t,s)}updateReceiverHandlerMap(e){if(!this.receiver)throw new Error("Receiver not initialized");this.receiverHandlerMap?.clear(),e.forEach(((e,t)=>{this.receiverHandlerMap?.set(t,e)}))}}export{i as AccessEnum,s as ExtensionTypeEnum,e as IMCMessageTypeEnum,a as InterModuleCommunication,r as MessageReceiver,o as MessageSender,t as NotificationTypeEnum,n as messageTimeout};
+var e,i,n,t,s;function r(e){return Array.isArray(e)&&1===e.length}function o(e){return"object"==typeof e&&!Array.isArray(e)}!function(e){e.ModalityVAD="modality-vad",e.ModalitySTT="modality-stt",e.ModalityLLM="modality-llm",e.ModalityTTS="modality-tts",e.ModalitySpeech2Speech="modality-speech-to-speech",e.ModalityImageGen="modality-image-gen",e.ModalityVideoGen="modality-video-gen",e.ModalityOCR="modality-ocr",e.ModalityMusicGen="modality-music-gen",e.AppReady="app-ready",e.AppClose="app-close",e.EditorLoadingApp="editor-loading-app",e.EditorRegisterAction="editor-register-action",e.EditorRunAppAction="editor-run-app-action",e.EditorRunAgentMethod="editor-run-agent-method",e.EditorThemeUpdate="editor-theme-update",e.EditorShowNotification="editor-show-notification",e.EditorGetEnv="editor-get-env",e.PlatformCreateTerminal="platform-create-terminal",e.PlatformWriteFile="platform-write-file",e.PlatformReadFile="platform-read-file",e.SignalGetWindowId="signal-get-window-id",e.SignalReturnWindowId="signal-return-window-id",e.SignalAcknowledge="signal-acknowledge",e.SignalAbort="signal-abort",e.SignalError="signal-error"}(e||(e={})),function(e){e.App="app",e.Canvas="canvas",e.Home="home"}(i||(i={})),function(e){e.Success="success",e.Error="error",e.Info="info",e.Warning="warning"}(n||(n={})),function(e){e.Generic="generic",e.FileView="file-view",e.ConsoleView="console-view"}(t||(t={})),function(e){e.public="public",e.private="private"}(s||(s={}));const a=3e5;class d{constructor(e,i){this.handlerMap=e,this.pendingTasks=new Map,this.windowId=i}receiveMessage(i,n){if(this.windowId===n.from)return;if(n.type===e.SignalAbort){const e=n.id,i=this.pendingTasks.get(e);return void(i&&(console.log("Aborting task",e),i.controller.abort(),this.pendingTasks.delete(e)))}const t=this.handlerMap.get(n.type);if(t){const s=new AbortController,r=s.signal;this.pendingTasks.set(n.id,{controller:s});t(i,n,r).then(t=>{r.aborted||n.type!==e.SignalAcknowledge&&this.acknowledgeSender(i,n.id,t)}).catch(t=>{const s={id:n.id,type:e.SignalError,payload:t.message,from:this.windowId};console.error("Error handling message:",t),i.postMessage(s,"*")}).finally(()=>{this.pendingTasks.delete(n.id)})}}acknowledgeSender(i,n,t){const s={id:n,type:e.SignalAcknowledge,payload:t,from:this.windowId};i.postMessage(s,"*")}}class l{constructor(e,i,n){this.targetWindow=e,this.timeout=i,this.pendingMessages=new Map,this.moduleId=n}async sendMessage(i,n,t){const s=(new Date).getTime().toString(),r={id:s,type:i,payload:n,from:this.moduleId};return new Promise((i,n)=>{if(t?.aborted)return n(new Error("Request aborted"));const o=()=>{this.pendingMessages.delete(s),this.targetWindow.postMessage({id:s,type:e.SignalAbort,payload:JSON.stringify({status:"Task aborted",data:null})},"*"),n(new Error("Request aborted"))};t?.addEventListener("abort",o),this.pendingMessages.set(s,{resolve:i,reject:n}),this.targetWindow.postMessage(r,"*");const a=setTimeout(()=>{this.pendingMessages.delete(s),t?.removeEventListener("abort",o),n(new Error("Communication with Pulse Editor timeout."))},this.timeout),d=this.pendingMessages.get(s);d&&(d.resolve=e=>{clearTimeout(a),t?.removeEventListener("abort",o),i(e)},d.reject=()=>{clearTimeout(a),t?.removeEventListener("abort",o),n()})})}getPendingMessage(e){return this.pendingMessages.get(e)}removePendingMessage(e){this.pendingMessages.delete(e)}}class h{initThisWindow(i,n){this.thisWindow=i;const t=i.viewId;if(!t)throw new Error("Current window's ID is not defined.");this.thisWindowId=t,this.receiverHandlerMap=new Map;const s=new d(this.receiverHandlerMap,this.thisWindowId);this.receiver=s,this.messageRecords=new Map,this.listener=i=>{const t=i.data.id,r=i.data.type;if(this.messageRecords?.has(t)&&r!==e.SignalGetWindowId)return void console.warn(`Duplicate message received with message ID: ${t}. Ignoring this message. Message: ${JSON.stringify(i.data)}`);if(this.messageRecords?.set(t,i.data),!s)throw new Error("Receiver not initialized at module "+this.thisWindowId);const o=i.data;if("development"===process.env.NODE_ENV&&void 0!==o.from&&console.log(`Module ${this.thisWindowId} received message from module ${o.from}:\n ${JSON.stringify(o)}`),n&&o.from!==n)return;const a=i.source;s.receiveMessage(a,o)},i.addEventListener("message",this.listener),console.log("Adding IMC listener in "+this.thisWindowId),this.setBaseHandler()}async initOtherWindow(i){return new Promise(n=>{if(!this.thisWindow||!this.thisWindowId)throw new Error("You must initialize the current window first.");this.thisWindow.addEventListener("message",e=>{if(!this.thisWindow||!this.thisWindowId)throw new Error("You must initialize the current window first.");const t=e.data.windowId;this.otherWindowId=t;const s=new l(i,a,this.thisWindowId);if(this.sender=s,!this.receiverHandlerMap)throw new Error("You must initialize the current window first.");this.setBaseHandler(),n()},{once:!0}),this.otherWindow=i,this.otherWindow.postMessage({type:e.SignalGetWindowId,from:this.thisWindowId},"*")})}close(){this.listener&&window.removeEventListener("message",this.listener)}async sendMessage(e,i,n){const t=this.sender;if(!t)throw new Error("Sender not initialized");return await t.sendMessage(e,i,n)}updateReceiverHandlerMap(e){if(!this.receiver)throw new Error("Receiver not initialized");this.receiverHandlerMap?.clear(),this.setBaseHandler(),e.forEach((e,i)=>{this.receiverHandlerMap?.set(i,e)})}getThisWindowId(){if(!this.thisWindowId)throw new Error("This window ID is not defined.");return this.thisWindowId}getOtherWindowId(){if(!this.otherWindowId)throw new Error("Other window ID is not defined.");return this.otherWindowId}setBaseHandler(){this.receiverHandlerMap?.set(e.SignalAcknowledge,async(e,i)=>{const n=this.sender?.getPendingMessage(i.id);n&&(n.resolve(i.payload),this.sender?.removePendingMessage(i.id))}),this.receiverHandlerMap?.set(e.SignalGetWindowId,async(i,n)=>{console.log("Received window ID request. Sending current window ID to other window: ");const t=this.thisWindowId;if(!t)throw new Error("This window ID is not defined.");const s={id:n.id,type:e.SignalReturnWindowId,payload:{windowId:t},from:t};i.postMessage(s,"*")})}}class c{constructor(e){this.channels=new Map,this.baseReceiverHandlerMap=e,this.channelReceiverHandlerMapMap=new Map}async sendMessage(e,i,n,t){const s=this.channels.get(e);if(!s)throw new Error("Channel not found for window ID "+e);return await s.sendMessage(i,n,t)}updateBaseReceiverHandlerMap(e){this.baseReceiverHandlerMap=e,this.channels.forEach((e,i)=>{const n=this.getCombinedHandlerMap(this.baseReceiverHandlerMap,this.channelReceiverHandlerMapMap.get(i));e.updateReceiverHandlerMap(n)})}updateChannelReceiverHandlerMap(e,i){const n=this.channels.get(e);if(!n)throw new Error("Channel not found for window ID "+e);const t=this.getCombinedHandlerMap(this.baseReceiverHandlerMap,i);n.updateReceiverHandlerMap(t),this.channelReceiverHandlerMapMap.set(e,i)}async createChannel(e,i,n){console.log("Creating channel for window ID: "+i);const t=new h;t.initThisWindow(window,i),await t.initOtherWindow(e),this.channels.set(i,t),n?this.updateChannelReceiverHandlerMap(i,n):t.updateReceiverHandlerMap(this.baseReceiverHandlerMap)}removeChannel(e){const i=this.channels.get(e);if(!i)throw new Error("Channel not found for window ID "+e);i.close(),this.channels.delete(e),this.channelReceiverHandlerMapMap.delete(e)}hasChannel(e){return this.channels.has(e)}close(){this.channels.forEach(e=>{e.close()}),this.channels.clear(),this.channelReceiverHandlerMapMap.clear()}getCombinedHandlerMap(e,i){if(e&&i){return new Map([...e,...i])}return e||(i||new Map)}}class w{constructor(i,n,t){this.polyIMC=i,this.newConnectionReceiverHandlerMap=n,this.onConnection=t;const s=new h;this.listener=s,s.initThisWindow(window),s.updateReceiverHandlerMap(new Map([[e.AppReady,async(e,i,n)=>{this.handleExtReady(e,i,n)}]]))}close(){this.listener?.close()}updateReceiverHandlerMap(e){this.newConnectionReceiverHandlerMap=e}async handleExtReady(e,i,n){const t=i.from;this.polyIMC.hasChannel(t)?console.log("Channel already exists for window ID "+t+". Re-using the existing channel."):(await this.polyIMC.createChannel(e,t,this.newConnectionReceiverHandlerMap),this.onConnection&&this.onConnection(e,i))}}export{s as AccessEnum,t as AppTypeEnum,w as ConnectionListener,e as IMCMessageTypeEnum,h as InterModuleCommunication,d as MessageReceiver,l as MessageSender,n as NotificationTypeEnum,c as PolyIMC,i as ViewModeEnum,r as isArrayType,o as isObjectType,a as messageTimeout};

package/dist/types/types.d.ts

@@ -1,19 +1,30 @@
 export declare enum IMCMessageTypeEnum {
-    WriteViewFile = "write-view-file",
-    RequestViewFile = "request-view-file",
-    Fetch = "fetch",
-    Notification = "notification",
-    ThemeChange = "theme-change",
-    InstallAgent = "install-agent",
-    RunAgentMethod = "run-agent-method",
-    InstallAgentTool = "install-agent-tool",
-    OCR = "ocr",
-    RequestTerminal = "request-terminal",
-    Ready = "ready",
-    Loaded = "loaded",
-    Acknowledge = "acknowledge",
-    Abort = "abort",
-    Error = "error"
+    ModalityVAD = "modality-vad",
+    ModalitySTT = "modality-stt",
+    ModalityLLM = "modality-llm",
+    ModalityTTS = "modality-tts",
+    ModalitySpeech2Speech = "modality-speech-to-speech",
+    ModalityImageGen = "modality-image-gen",
+    ModalityVideoGen = "modality-video-gen",
+    ModalityOCR = "modality-ocr",
+    ModalityMusicGen = "modality-music-gen",
+    AppReady = "app-ready",
+    AppClose = "app-close",
+    EditorLoadingApp = "editor-loading-app",
+    EditorRegisterAction = "editor-register-action",
+    EditorRunAppAction = "editor-run-app-action",
+    EditorRunAgentMethod = "editor-run-agent-method",
+    EditorThemeUpdate = "editor-theme-update",
+    EditorShowNotification = "editor-show-notification",
+    EditorGetEnv = "editor-get-env",
+    PlatformCreateTerminal = "platform-create-terminal",
+    PlatformWriteFile = "platform-write-file",
+    PlatformReadFile = "platform-read-file",
+    SignalGetWindowId = "signal-get-window-id",
+    SignalReturnWindowId = "signal-return-window-id",
+    SignalAcknowledge = "signal-acknowledge",
+    SignalAbort = "signal-abort",
+    SignalError = "signal-error"
 }
 export type IMCMessage = {
     id: string;
@@ -21,20 +32,22 @@ export type IMCMessage = {
     type: IMCMessageTypeEnum;
     payload?: any;
 };
-export type ReceiverHandlerMap = Map<IMCMessageTypeEnum, {
-    (senderWindow: Window, message: IMCMessage, abortSignal?: AbortSignal): Promise<any>;
-}>;
+export type ReceiverHandler = (senderWindow: Window, message: IMCMessage, abortSignal?: AbortSignal) => Promise<any>;
+export type ReceiverHandlerMap = Map<IMCMessageTypeEnum, ReceiverHandler>;
 export type TextFileSelection = {
     lineStart: number;
     lineEnd: number;
     text: string;
 };
-export type FileViewModel = {
-    fileContent: string;
-    filePath: string;
-    selections?: TextFileSelection[];
-    isActive: boolean;
+export type ViewModel = {
+    viewId: string;
+    appConfig?: AppConfig;
 };
+export declare enum ViewModeEnum {
+    App = "app",
+    Canvas = "canvas",
+    Home = "home"
+}
 export type FetchPayload = {
     uri: string;
     options?: RequestInit;
@@ -45,31 +58,44 @@ export declare enum NotificationTypeEnum {
     Info = "info",
     Warning = "warning"
 }
-export declare enum ExtensionTypeEnum {
+export declare enum AppTypeEnum {
     Generic = "generic",
     FileView = "file-view",
     ConsoleView = "console-view"
 }
-export type ExtensionConfig = {
+export type AppConfig = {
     id: string;
     version: string;
+    libVersion: string;
     author?: string;
     displayName?: string;
     description?: string;
     materialIcon?: string;
-    extensionType?: ExtensionTypeEnum;
+    appType?: AppTypeEnum;
     fileTypes?: string[];
-    preview?: string;
+    thumbnail?: string;
     enabledPlatforms?: Record<string, boolean>;
+    agents?: Agent[];
+    preRegisteredActions?: Action[];
+    visibility: string;
+    recommendedHeight?: number;
+    recommendedWidth?: number;
+};
+export type Action = {
+    name: string;
+    description: string;
+    parameters: Record<string, TypedVariable>;
+    returns: Record<string, TypedVariable>;
+    handler?: (args: any) => Promise<any>;
 };
 export type Agent = {
     name: string;
     version: string;
     systemPrompt: string;
     availableMethods: AgentMethod[];
-    LLMConfig: LLMConfig;
     description: string;
     tools?: AgentTool[];
+    LLMConfig?: LLMConfig;
 };
 /**
  * An agent method is a sub task that an agent can perform.
@@ -77,43 +103,60 @@ export type Agent = {
 export type AgentMethod = {
     access: AccessEnum;
     name: string;
-    parameters: Record<string, AgentVariable>;
+    parameters: Record<string, TypedVariable>;
     prompt: string;
-    returns: Record<string, AgentVariable>;
+    returns: Record<string, TypedVariable>;
     LLMConfig?: LLMConfig;
 };
-export type AgentVariable = {
-    type: AgentVariableType;
+export type TypedVariable = {
+    type: TypedVariableType;
     description: string;
-};
-export type AgentVariableType = "string" | "number" | "boolean" | AgentVariableTypeArray;
-type AgentVariableTypeArray = {
-    size: number;
-    elementType: AgentVariableType;
+    optional?: boolean;
+    defaultValue?: any;
 };
 /**
  * A tool that agent can use during method execution.
  *
- * This is linked to a callback function created by user,
- * tool developer, or extension.
  *
- * The tool may optionally return a value to running
- * agent method.
+ * The tool may optionally return a value to the agent.
  */
 export type AgentTool = {
     access: AccessEnum;
     name: string;
     description: string;
-    parameters: Record<string, AgentVariable>;
-    returns: Record<string, AgentVariable>;
+    parameters: Record<string, TypedVariable>;
+    returns: Record<string, TypedVariable>;
 };
-export type LLMConfig = {
-    provider: string;
-    modelName: string;
-    temperature: number;
+export type TypedVariableType = "string" | "number" | "boolean" | "any" | TypedVariableObjectType | TypedVariableArrayType;
+export type TypedVariableObjectType = {
+    [key: string]: TypedVariable;
 };
+export type TypedVariableArrayType = [TypedVariableType];
+export declare function isArrayType(value: TypedVariableType): value is TypedVariableArrayType;
+export declare function isObjectType(value: TypedVariableType): value is TypedVariableObjectType;
 export declare enum AccessEnum {
     public = "public",
     private = "private"
 }
-export {};
+export type STTConfig = {
+    provider: string;
+    modelName: string;
+};
+export type LLMConfig = {
+    provider: string;
+    modelName: string;
+    temperature: number;
+};
+export type TTSConfig = {
+    provider: string;
+    modelName: string;
+    voice: string;
+};
+export type ImageModelConfig = {
+    provider: string;
+    modelName: string;
+};
+export type VideoModelConfig = {
+    provider: string;
+    modelName: string;
+};

package/package.json

@@ -1,14 +1,15 @@
 {
     "name": "@pulse-editor/shared-utils",
-    "version": "0.1.1-alpha.4",
+    "version": "0.1.1-alpha.41",
     "main": "dist/main.js",
-    "type": "module",
     "files": [
         "dist"
     ],
     "publishConfig": {
         "access": "public"
     },
+    "types": "dist/main.d.ts",
+    "type": "module",
     "scripts": {
         "build": "npm run clean && rollup -c",
         "lint": "eslint .",
@@ -19,6 +20,7 @@
         "@babel/preset-env": "^7.26.9",
         "@eslint/js": "^9.25.0",
         "@rollup/plugin-babel": "^6.0.4",
+        "@rollup/plugin-json": "^6.1.0",
         "@rollup/plugin-node-resolve": "^16.0.1",
         "@rollup/plugin-terser": "^0.4.4",
         "@rollup/plugin-typescript": "^12.1.2",