@pulse-editor/shared-utils 0.1.1-alpha.7 → 0.1.1-alpha.8

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

@@ -2,17 +2,24 @@ import { IMCMessageTypeEnum, ReceiverHandlerMap } from "../types/types";
 export declare class InterModuleCommunication {
     private thisWindow;
     private otherWindow;
-    private thisPendingTasks;
-    private otherPendingMessages;
     private receiver;
     private sender;
-    private id;
+    private thisWindowId;
+    private otherWindowId;
     private receiverHandlerMap;
     private listener;
-    constructor(id?: string);
-    initThisWindow(window: Window): void;
+    constructor();
+    /**
+     * 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): void;
     close(): void;
     sendMessage(type: IMCMessageTypeEnum, payload?: any, abortSignal?: AbortSignal): Promise<any>;
     updateReceiverHandlerMap(receiverHandlerMap: ReceiverHandlerMap): void;
+    getThisWindowId(): string;
+    getOtherWindowId(): string;
 }

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;
-    }>, moduleName: string);
+    private moduleId;
+    constructor(listenerMap: ReceiverHandlerMap, moduleId: 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,33 @@
+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;
+    private connectionListener;
+    /**
+     *
+     * @param baseReceiverHandlerMap A base receiver handler map for universal handlers.
+     * E.g. Pulse Editor API handler
+     */
+    constructor(baseReceiverHandlerMap: ReceiverHandlerMap, isAutoConnect?: boolean);
+    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): Promise<void>;
+    hasChannel(targetWindowId: string): boolean;
+    private getCombinedHandlerMap;
+    private getConnectionListenerHandlerMap;
+}
+export declare class ConnectionListener {
+    private listener;
+    constructor(polyIMC: PolyIMC, newConnectionReceiverHandlerMap: ReceiverHandlerMap, onConnection?: (senderWindow: Window, message: IMCMessage) => void);
+    close(): void;
+}

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 { PolyIMC, ConnectionListener } from "./imc/poly-imc";
+export * from "./types/constants";
+export * from "./types/types";
+export { InterModuleCommunication, MessageReceiver, MessageSender, PolyIMC, ConnectionListener, };

package/dist/main.js

@@ -1 +1 @@
-var e,t,i,s;!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"}(i||(i={})),function(e){e.public="public",e.private="private"}(s||(s={}));const n=3e5;class r{constructor(e,t,i){this.handlerMap=e,this.pendingTasks=t,this.moduleName=i}receiveMessage(t,i){if(this.moduleName===i.from)return;if("development"===process.env.NODE_ENV&&console.log(`Module ${this.moduleName} received message from module ${i.from}:\n ${JSON.stringify(i)}`),i.type===e.Abort){const e=i.id,t=this.pendingTasks.get(e);return void(t&&(console.log("Aborting task",e),t.controller.abort(),this.pendingTasks.delete(e)))}const s=this.handlerMap.get(i.type);if(s){const n=new AbortController,r=n.signal;this.pendingTasks.set(i.id,{controller:n});s(t,i,r).then((s=>{r.aborted||i.type!==e.Acknowledge&&this.acknowledgeSender(t,i.id,s)})).catch((s=>{const n={id:i.id,type:e.Error,payload:s.message,from:this.moduleName};t.postMessage(n,"*")})).finally((()=>{this.pendingTasks.delete(i.id)}))}}acknowledgeSender(t,i,s){const n={id:i,type:e.Acknowledge,payload:s,from:this.moduleName};t.postMessage(n,"*")}}class o{constructor(e,t,i,s){this.targetWindow=e,this.timeout=t,this.pendingMessages=i,this.moduleName=s}async sendMessage(t,i,s){const n=(new Date).getTime().toString(),r={id:n,type:t,payload:i,from:this.moduleName};return new Promise(((t,i)=>{if(s?.aborted)return i(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})},"*"),i(new Error("Request aborted"))};s?.addEventListener("abort",o),this.pendingMessages.set(n,{resolve:t,reject:i}),this.targetWindow.postMessage(r,"*");const a=setTimeout((()=>{this.pendingMessages.delete(n),s?.removeEventListener("abort",o),i(new Error("Communication with Pulse Editor timeout."))}),this.timeout),d=this.pendingMessages.get(n);d&&(d.resolve=e=>{clearTimeout(a),s?.removeEventListener("abort",o),t(e)},d.reject=()=>{clearTimeout(a),s?.removeEventListener("abort",o),i()})}))}}class a{constructor(e){if(!e){const t=window.viewId;if(!t)throw new Error("View ID is not defined.");e=t}this.id=e}initThisWindow(e){this.thisWindow=e,this.receiverHandlerMap=new Map,this.thisPendingTasks=new Map;const t=new r(this.receiverHandlerMap,this.thisPendingTasks,this.id);this.receiver=t,this.listener=e=>{if(!t)throw new Error("Receiver not initialized at module "+this.id);const i=e.data,s=e.source;t.receiveMessage(s,i)},e.addEventListener("message",this.listener),console.log("Adding IMC listener in "+this.id)}initOtherWindow(t){this.otherWindow=t,this.otherPendingMessages=new Map;const i=new o(t,n,this.otherPendingMessages,this.id);if(this.sender=i,!this.receiverHandlerMap)throw new Error("You must initialize the current window first.");this.receiverHandlerMap.set(e.Acknowledge,(async(e,t)=>{const i=this.otherPendingMessages?.get(t.id);i&&(i.resolve(t.payload),this.otherPendingMessages?.delete(t.id))}))}close(){this.listener&&window.removeEventListener("message",this.listener)}async sendMessage(e,t,i){if(!this.sender)throw new Error("Sender not initialized");return await this.sender.sendMessage(e,t,i)}updateReceiverHandlerMap(e){if(!this.receiver)throw new Error("Receiver not initialized");this.receiverHandlerMap?.clear(),e.forEach(((e,t)=>{this.receiverHandlerMap?.set(t,e)}))}}export{s as AccessEnum,i as ExtensionTypeEnum,e as IMCMessageTypeEnum,a as InterModuleCommunication,r as MessageReceiver,o as MessageSender,t as NotificationTypeEnum,n as messageTimeout};
+var e,n,t,i;function s(e){return Array.isArray(e)&&1===e.length}function r(e){return"object"==typeof e&&!Array.isArray(e)}!function(e){e.WriteViewFile="write-view-file",e.RequestViewFile="request-view-file",e.Fetch="fetch",e.Notification="notification",e.ThemeChange="theme-change",e.RunAgentMethod="run-agent-method",e.UseVAD="use-vad",e.UseSTT="use-stt",e.UseLLM="use-llm",e.UseTTS="use-tts",e.UseDiffusion="use-diffusion",e.UseOCR="use-ocr",e.UseSpeech2Speech="use-speech2speech",e.RunExtCommand="run-ext-command",e.RequestTerminal="request-terminal",e.ExtReady="ext-ready",e.ExtClose="ext-close",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"}(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"}(i||(i={}));const o=3e5;class a{constructor(e,n){this.handlerMap=e,this.pendingTasks=new Map,this.moduleId=n}receiveMessage(n,t){if(this.moduleId===t.from)return;if("development"===process.env.NODE_ENV&&console.log(`Module ${this.moduleId} received message from module ${t.from}:\n ${JSON.stringify(t)}`),t.type===e.Abort){const e=t.id,n=this.pendingTasks.get(e);return void(n&&(console.log("Aborting task",e),n.controller.abort(),this.pendingTasks.delete(e)))}const i=this.handlerMap.get(t.type);if(i){const s=new AbortController,r=s.signal;this.pendingTasks.set(t.id,{controller:s});i(n,t,r).then((i=>{r.aborted||t.type!==e.Acknowledge&&this.acknowledgeSender(n,t.id,i)})).catch((i=>{const s={id:t.id,type:e.Error,payload:i.message,from:this.moduleId};n.postMessage(s,"*")})).finally((()=>{this.pendingTasks.delete(t.id)}))}}acknowledgeSender(n,t,i){const s={id:t,type:e.Acknowledge,payload:i,from:this.moduleId};n.postMessage(s,"*")}}class d{constructor(e,n,t){this.targetWindow=e,this.timeout=n,this.pendingMessages=new Map,this.moduleId=t}async sendMessage(n,t,i){const s=(new Date).getTime().toString(),r={id:s,type:n,payload:t,from:this.moduleId};return new Promise(((n,t)=>{if(i?.aborted)return t(new Error("Request aborted"));const o=()=>{this.pendingMessages.delete(s),this.targetWindow.postMessage({id:s,type:e.Abort,payload:JSON.stringify({status:"Task aborted",data:null})},"*"),t(new Error("Request aborted"))};i?.addEventListener("abort",o),this.pendingMessages.set(s,{resolve:n,reject:t}),this.targetWindow.postMessage(r,"*");const a=setTimeout((()=>{this.pendingMessages.delete(s),i?.removeEventListener("abort",o),t(new Error("Communication with Pulse Editor timeout."))}),this.timeout),d=this.pendingMessages.get(s);d&&(d.resolve=e=>{clearTimeout(a),i?.removeEventListener("abort",o),n(e)},d.reject=()=>{clearTimeout(a),i?.removeEventListener("abort",o),t()})}))}getPendingMessage(e){return this.pendingMessages.get(e)}removePendingMessage(e){this.pendingMessages.delete(e)}}class h{constructor(){}initThisWindow(e,n){this.thisWindow=e;const t=e.viewId;if(!t)throw new Error("Current window's ID is not defined.");this.thisWindowId=t,this.receiverHandlerMap=new Map;const i=new a(this.receiverHandlerMap,this.thisWindowId);this.receiver=i,this.listener=e=>{if(!i)throw new Error("Receiver not initialized at module "+this.thisWindowId);const t=e.data;if(n&&t.from!==n)return;const s=e.source;i.receiveMessage(s,t)},e.addEventListener("message",this.listener),console.log("Adding IMC listener in "+this.thisWindowId)}initOtherWindow(n){if(!this.thisWindow||!this.thisWindowId)throw new Error("You must initialize the current window first.");this.otherWindow=n;const t=n.viewId;if(!t)throw new Error("Other window's ID is not defined.");this.otherWindowId=t;const i=new d(n,o,this.thisWindowId);if(this.sender=i,!this.receiverHandlerMap)throw new Error("You must initialize the current window first.");this.receiverHandlerMap.set(e.Acknowledge,(async(e,n)=>{const t=i.getPendingMessage(n.id);t&&(t.resolve(n.payload),i.removePendingMessage(n.id))}))}close(){this.listener&&window.removeEventListener("message",this.listener)}async sendMessage(e,n,t){const i=this.sender;if(!i)throw new Error("Sender not initialized");return await i.sendMessage(e,n,t)}updateReceiverHandlerMap(n){if(!this.receiver)throw new Error("Receiver not initialized");this.receiverHandlerMap?.clear(),this.receiverHandlerMap?.set(e.Acknowledge,(async(e,n)=>{const t=this.sender?.getPendingMessage(n.id);t&&(t.resolve(n.payload),this.sender?.removePendingMessage(n.id))})),n.forEach(((e,n)=>{this.receiverHandlerMap?.set(n,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}}class c{constructor(e,n=!1){this.channels=new Map,this.baseReceiverHandlerMap=e,this.channelReceiverHandlerMapMap=new Map,n&&(this.connectionListener=new h,this.connectionListener.initThisWindow(window),this.connectionListener.updateReceiverHandlerMap(this.getConnectionListenerHandlerMap()))}async sendMessage(e,n,t,i){const s=this.channels.get(e);if(!s)throw new Error("Channel not found for window ID "+e);return await s.sendMessage(n,t,i)}updateBaseReceiverHandlerMap(e){this.baseReceiverHandlerMap=e,this.channels.forEach(((e,n)=>{const t=this.getCombinedHandlerMap(this.baseReceiverHandlerMap,this.channelReceiverHandlerMapMap.get(n));e.updateReceiverHandlerMap(t)}))}updateChannelReceiverHandlerMap(e,n){const t=this.channels.get(e);if(!t)throw new Error("Channel not found for window ID "+e);const i=this.getCombinedHandlerMap(this.baseReceiverHandlerMap,n);t.updateReceiverHandlerMap(i)}async createChannel(e,n,t){const i=new h;i.initThisWindow(window,n),i.initOtherWindow(e),t?(i.updateReceiverHandlerMap(this.getCombinedHandlerMap(this.baseReceiverHandlerMap,t)),this.channelReceiverHandlerMapMap.set(n,t)):i.updateReceiverHandlerMap(this.baseReceiverHandlerMap),this.channels.set(n,i)}async removeChannel(e){const n=this.channels.get(e);if(!n)throw new Error("Channel not found for window ID "+e);n.close(),this.channels.delete(e),this.channelReceiverHandlerMapMap.delete(e)}hasChannel(e){return this.channels.has(e)}getCombinedHandlerMap(e,n){if(e&&n){return new Map([...e,...n])}return e||(n||new Map)}getConnectionListenerHandlerMap(){return new Map([[e.ExtReady,async(e,n)=>{const t=n.from;this.channels.has(t)?console.log("Channel already exists for window ID "+t+". Re-using the existing channel."):await this.createChannel(e,t,this.getCombinedHandlerMap(this.baseReceiverHandlerMap,this.channelReceiverHandlerMapMap.get(t)))}]])}}class l{constructor(n,t,i){const s=new h;this.listener=s,s.initThisWindow(window),s.updateReceiverHandlerMap(new Map([[e.ExtReady,async(e,s,r)=>{const o=s.from;n.hasChannel(o)?console.log("Channel already exists for window ID "+o+". Re-using the existing channel."):(await n.createChannel(e,o,t),i&&i(e,s))}]]))}close(){this.listener?.close()}}export{i as AccessEnum,l as ConnectionListener,t as ExtensionTypeEnum,e as IMCMessageTypeEnum,h as InterModuleCommunication,a as MessageReceiver,d as MessageSender,n as NotificationTypeEnum,c as PolyIMC,s as isArrayType,r as isObjectType,o as messageTimeout};

package/dist/types/types.d.ts

@@ -4,12 +4,18 @@ export declare enum IMCMessageTypeEnum {
     Fetch = "fetch",
     Notification = "notification",
     ThemeChange = "theme-change",
-    InstallAgent = "install-agent",
     RunAgentMethod = "run-agent-method",
-    InstallAgentTool = "install-agent-tool",
-    OCR = "ocr",
+    UseVAD = "use-vad",
+    UseSTT = "use-stt",
+    UseLLM = "use-llm",
+    UseTTS = "use-tts",
+    UseDiffusion = "use-diffusion",
+    UseOCR = "use-ocr",
+    UseSpeech2Speech = "use-speech2speech",
+    RunExtCommand = "run-ext-command",
     RequestTerminal = "request-terminal",
-    Ready = "ready",
+    ExtReady = "ext-ready",
+    ExtClose = "ext-close",
     Loaded = "loaded",
     Acknowledge = "acknowledge",
     Abort = "abort",
@@ -21,19 +27,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;
+    isFocused: boolean;
+    file?: {
+        content: string;
+        path: string;
+        selections?: TextFileSelection[];
+    };
+    extensionConfig?: ExtensionConfig;
 };
 export type FetchPayload = {
     uri: string;
@@ -61,6 +70,8 @@ export type ExtensionConfig = {
     fileTypes?: string[];
     preview?: string;
     enabledPlatforms?: Record<string, boolean>;
+    agents?: Agent[];
+    commandsInfoList?: ExtensionCommandInfo[];
 };
 export type Agent = {
     name: string;
@@ -77,43 +88,62 @@ 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;
+    name: string;
     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" | 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 ExtensionCommandInfo = {
+    name: string;
+    description: string;
+    parameters: Record<string, TypedVariable>;
+};
+export type ExtensionCommand = {
+    info: ExtensionCommandInfo;
+    handler: (args: any) => Promise<any>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pulse-editor/shared-utils",
-    "version": "0.1.1-alpha.7",
+    "version": "0.1.1-alpha.8",
     "main": "dist/main.js",
     "files": [
         "dist"