@pulse-editor/react-api 0.1.1-alpha.5 → 0.1.1-alpha.50

package/dist/hooks/agent/use-agent-tools.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Add or use agent tools in the editor.
+ * @param moduleName
+ * @returns
+ */
+export default function useAgentTools(): {};

package/dist/hooks/agent/use-agents.d.ts

@@ -0,0 +1,5 @@
+import { LLMConfig } from "@pulse-editor/shared-utils";
+export default function useAgents(): {
+    runAgentMethod: (agentName: string, methodName: string, args: Record<string, any>, abortSignal?: AbortSignal, llmConfig?: LLMConfig) => Promise<any>;
+    isReady: boolean;
+};

package/dist/hooks/ai-modality/use-image-gen.d.ts

@@ -0,0 +1,8 @@
+import { ImageModelConfig } from "@pulse-editor/shared-utils";
+export default function useImageGen(): {
+    runImageGen: (textPrompt?: string, imagePrompt?: string | ArrayBuffer, imageModelConfig?: ImageModelConfig) => Promise<{
+        arrayBuffer?: ArrayBuffer;
+        url?: string;
+    }>;
+    isReady: boolean;
+};

package/dist/hooks/ai-modality/use-llm.d.ts

@@ -0,0 +1,5 @@
+import { LLMConfig } from "@pulse-editor/shared-utils";
+export default function useLLM(): {
+    runLLM: (prompt: string, llmConfig?: LLMConfig) => Promise<string>;
+    isReady: boolean;
+};

package/dist/hooks/ai-modality/use-ocr.d.ts

@@ -0,0 +1,3 @@
+export default function useOCR(): {
+    recognizeText: (image: string) => Promise<string>;
+};

package/dist/hooks/ai-modality/use-speech2speech.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Use speech-to-speech API to listen to user input and read the output
+ * provided by you.
+ */
+export default function useSpeech2Speech(): {
+    isReady: boolean;
+    userInput: string;
+    isUserStopped: boolean;
+    respondAndRead: (text: string) => Promise<void>;
+};

package/dist/hooks/ai-modality/use-stt.d.ts

@@ -0,0 +1,5 @@
+import { STTConfig } from "@pulse-editor/shared-utils";
+export default function useSTT(): {
+    runSTT: (audio: Uint8Array, sttConfig?: STTConfig) => Promise<string>;
+    isReady: boolean;
+};

package/dist/hooks/ai-modality/use-tts.d.ts

@@ -0,0 +1,5 @@
+import { TTSConfig } from "@pulse-editor/shared-utils";
+export default function useTTS(): {
+    runTTS: (text: string, ttsConfig?: TTSConfig) => Promise<Uint8Array>;
+    isReady: boolean;
+};

package/dist/hooks/ai-modality/use-video-gen.d.ts

@@ -0,0 +1,8 @@
+import { VideoModelConfig } from "@pulse-editor/shared-utils";
+export default function useVideoGen(): {
+    runVideoGen: (duration: number, textPrompt?: string, imagePrompt?: string | ArrayBuffer, videoModelConfig?: VideoModelConfig) => Promise<{
+        url?: string;
+        arrayBuffer?: ArrayBuffer;
+    }>;
+    isReady: boolean;
+};

package/dist/hooks/editor/use-env.d.ts

@@ -0,0 +1,4 @@
+export default function usePulseEnv(): {
+    isReady: boolean;
+    envs: Record<string, string>;
+};

package/dist/hooks/editor/use-file.d.ts

@@ -0,0 +1,4 @@
+export default function useFile(uri: string | undefined): {
+    file: File | undefined;
+    saveFile: (fileContent: string) => void;
+};

package/dist/hooks/editor/use-loading.d.ts

@@ -0,0 +1,4 @@
+export default function useLoading(): {
+    isReady: boolean;
+    toggleLoading: (isLoading: boolean) => void;
+};

package/dist/hooks/editor/use-mic.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Use the microphone to record audio. (WIP)
+ */
+export default function useMic(): void;

package/dist/hooks/{use-notification.d.ts → editor/use-notification.d.ts}

@@ -1,4 +1,4 @@
 import { NotificationTypeEnum } from "@pulse-editor/shared-utils";
-export default function useNotification(moduleName: string): {
+export default function useNotification(): {
     openNotification: (text: string, type: NotificationTypeEnum) => void;
 };

package/dist/hooks/editor/use-receive-file.d.ts

@@ -0,0 +1,3 @@
+export default function useReceiveFile(): {
+    receivedFileUri: string | undefined;
+};

package/dist/hooks/editor/use-register-action.d.ts

@@ -0,0 +1,24 @@
+import { TypedVariable } from "@pulse-editor/shared-utils";
+import { DependencyList } from "react";
+/**
+ * Register an app action to listen to IMC messages from the core,
+ * and pass to the action to handle.
+ *
+ * @param name Name of the command.
+ * @param description Description of the command.
+ * @param parameters Parameters of the command.
+ * @param returns Return values of the command.
+ * @param callbackHandler Callback handler function to handle the command.
+ * @param deps Dependency list to re-register the action when changed.
+ * @param isExtReady Whether the extension is ready to receive commands.
+ * Useful for actions that need to wait for some certain app state to be ready.
+ *
+ */
+export default function useRegisterAction(actionInfo: {
+    name: string;
+    description: string;
+    parameters?: Record<string, TypedVariable>;
+    returns?: Record<string, TypedVariable>;
+}, callbackHandler: (args: any) => Promise<any>, deps: DependencyList, isExtReady?: boolean): {
+    isReady: boolean;
+};

package/dist/hooks/editor/use-snapshot-state.d.ts

@@ -0,0 +1 @@
+export default function useSnapShotState<T>(key: string, initialValue?: T, onRestore?: (value: T) => void): readonly [T, import("react").Dispatch<import("react").SetStateAction<T>>];

package/dist/hooks/editor/use-theme.d.ts

@@ -0,0 +1,3 @@
+export default function useTheme(): {
+    theme: string;
+};

package/dist/hooks/editor/use-toolbar.d.ts

@@ -0,0 +1 @@
+export default function useToolbar(): {};

package/dist/hooks/imc/use-imc.d.ts

@@ -0,0 +1,5 @@
+import { InterModuleCommunication, ReceiverHandlerMap } from "@pulse-editor/shared-utils";
+export default function useIMC(handlerMap: ReceiverHandlerMap): {
+    imc: InterModuleCommunication | undefined;
+    isReady: boolean;
+};

package/dist/hooks/terminal/use-terminal.d.ts

@@ -0,0 +1,4 @@
+export default function useTerminal(): {
+    websocketUrl: string | undefined;
+    projectHomePath: string | undefined;
+};

package/dist/main.d.ts

@@ -1,7 +1,21 @@
-import useFileView from "./hooks/use-file-view";
-import useTheme from "./hooks/use-theme";
-import useNotification from "./hooks/use-notification";
-import useAgents from "./hooks/use-agents";
-import useOCR from "./hooks/use-orc";
-import useTerminal from "./hooks/use-terminal";
-export { useFileView, useTheme, useNotification, useAgents, useOCR, useTerminal, };
+import useAgentTools from "./hooks/agent/use-agent-tools";
+import useAgents from "./hooks/agent/use-agents";
+import useFile from "./hooks/editor/use-file";
+import useLoading from "./hooks/editor/use-loading";
+import useNotification from "./hooks/editor/use-notification";
+import useRegisterAction from "./hooks/editor/use-register-action";
+import useTheme from "./hooks/editor/use-theme";
+import useToolbar from "./hooks/editor/use-toolbar";
+import useImageGen from "./hooks/ai-modality/use-image-gen";
+import useLLM from "./hooks/ai-modality/use-llm";
+import useOCR from "./hooks/ai-modality/use-ocr";
+import useSTT from "./hooks/ai-modality/use-stt";
+import useTTS from "./hooks/ai-modality/use-tts";
+import useVideoGen from "./hooks/ai-modality/use-video-gen";
+import usePulseEnv from "./hooks/editor/use-env";
+import useReceiveFile from "./hooks/editor/use-receive-file";
+import useSnapshotState from "./hooks/editor/use-snapshot-state";
+import useTerminal from "./hooks/terminal/use-terminal";
+import ReceiveFileProvider from "./providers/receive-file-provider";
+import SnapshotProvider from "./providers/snapshot-provider";
+export { ReceiveFileProvider, SnapshotProvider, useAgentTools, useAgents, useFile, useImageGen, useLLM, useLoading, useNotification, useOCR, usePulseEnv, useReceiveFile, useRegisterAction, useSTT, useSnapshotState, useTTS, useTerminal, useTheme, useToolbar, useVideoGen, };

package/dist/main.js

@@ -1 +1 @@
-import{InterModuleCommunication as e,IMCMessageTypeEnum as n}from"@pulse-editor/shared-utils";import{useState as t,useEffect as i}from"react";function o(o,s){const[a,r]=t(void 0),[d,c]=t(!1),w=window.parent;return i((()=>{const t=new e(o);return t.initThisWindow(window),t.updateReceiverHandlerMap(s),t.initOtherWindow(w),r(t),t.sendMessage(n.Ready).then((()=>{c(!0)})),()=>{t.close()}}),[]),{imc:a,isReady:d}}function s(e){const[s,a]=t(void 0),[r,d]=t(!1),c=new Map,{imc:w,isReady:u}=o(e,c);return i((()=>{u&&w?.sendMessage(n.RequestViewFile).then((e=>{a(e)}))}),[u]),i((()=>{r&&w?.sendMessage(n.Loaded)}),[r,w]),{viewFile:s,updateViewFile:function(e){w?.sendMessage(n.WriteViewFile,e)},setIsLoaded:d}}function a(e){const[i,s]=t("light"),a=new Map;return a.set(n.ThemeChange,(async(e,n)=>{const t=n.payload;s((e=>t))})),o(e,a),{theme:i}}function r(e){const t=new Map,{imc:i}=o(e,t);return{openNotification:function(e,t){if(!i)throw new Error("IMC is not initialized.");i.sendMessage(n.Notification,{text:e,type:t})}}}function d(e){const t=new Map,{imc:i,isReady:s}=o(e,t);return{installAgent:async function(e){if(!i)throw new Error("IMC not initialized.");await i.sendMessage(n.InstallAgent,e).catch((e=>{throw new Error(e)}))},runAgentMethod:async function(e,t,o,s){if(!i)throw new Error("IMC not initialized.");return await i.sendMessage(n.RunAgentMethod,{agentName:e,methodName:t,parameters:o},s).then((e=>e))},isReady:s}}function c(e){const t=new Map,{imc:i}=o(e,t);return{recognizeText:async function(e){if(!i)throw new Error("IMC is not initialized.");return(await i.sendMessage(n.OCR,{uri:e})).payload.text}}}function w(e){const s=new Map,{imc:a,isReady:r}=o(e,s),[d,c]=t(void 0);return i((()=>{r&&a?.sendMessage(n.RequestTerminal).then((e=>{const{websocketUrl:t}=e;c(t),a.sendMessage(n.Loaded)}))}),[r]),{websocketUrl:d}}export{d as useAgents,s as useFileView,r as useNotification,c as useOCR,w as useTerminal,a as useTheme};
+import{InterModuleCommunication as e,IMCMessageTypeEnum as t}from"@pulse-editor/shared-utils";import n,{useState as r,useEffect as i,useCallback as o,useRef as a,createContext as s,useContext as c}from"react";function d(n){const[o,a]=r(void 0),[s,c]=r(!1),[d,u]=r(!1),p=window.parent;return i(()=>(u(!0),()=>{u(!1),o?.close(),a(void 0)}),[]),i(()=>{!async function(){if(!d)return;if(void 0!==o)return;const r=new e;r.initThisWindow(window),r.updateReceiverHandlerMap(n),await r.initOtherWindow(p),a(r),await r.sendMessage(t.AppReady),c(!0)}()},[d,o]),{imc:o,isReady:s}}function u(){return d(new Map),{}}function p(){const e=new Map,{imc:n,isReady:r}=d(e);return{runAgentMethod:async function(e,r,i,o,a){if(!n)throw new Error("IMC not initialized.");return await n.sendMessage(t.EditorRunAgentMethod,{agentName:e,methodName:r,args:i,llmConfig:a},o).then(e=>e)},isReady:r}}function f(e){const[n,a]=r(void 0),s=new Map([[t.PlatformFileUpdate,async(e,t)=>{const n=t.payload;a(n)}]]),{imc:c,isReady:u}=d(s),p=o(r=>{if(!e)return;if(!n)return;const i=new File([r],n.name,{type:n.type,lastModified:Date.now()});a(i),u&&e&&c?.sendMessage(t.PlatformWriteFile,{uri:e,file:i})},[e,n,u]);return i(()=>{u&&c?.sendMessage(t.PlatformReadFile,{uri:e}).then(e=>{a(e)})},[u,e]),{file:n,saveFile:p}}function l(){const e=new Map,{imc:n,isReady:o}=d(e),[a,s]=r(!0);return i(()=>{o&&n?.sendMessage(t.EditorLoadingApp,{isLoading:a})},[a]),{isReady:o,toggleLoading:function(e){s(t=>e)}}}function m(){const e=new Map,{imc:n}=d(e);return{openNotification:function(e,r){if(!n)throw new Error("IMC is not initialized.");n.sendMessage(t.EditorShowNotification,{text:e,type:r})}}}function w(e,n,o,s=!0){const{isReady:c,imc:u}=d(w()),p=a([]),[f,l]=r({name:e.name,description:e.description,parameters:e.parameters??{},returns:e.returns??{},handler:n});async function m(e){if(!f.handler)return;return await f.handler(e)}function w(){return new Map([[t.EditorRunAppAction,async(t,n)=>{const{name:r,args:i}=n.payload;if(e.name===r){const t=e.parameters??{};if(Object.keys(i).length!==Object.keys(t).length)throw new Error(`Invalid number of parameters: expected ${Object.keys(t).length}, got ${Object.keys(i).length}`);for(const[e,n]of Object.entries(i)){if(void 0===t[e])throw new Error(`Invalid parameter: ${e}`);if(typeof n!==t[e].type)throw new Error(`Invalid type for parameter ${e}: expected ${t[e].type}, got ${typeof n}. Value received: ${n}`)}return s?await m(i):new Promise(e=>{p.current.push({args:i,resolve:e})})}}]])}return i(()=>{if(s&&p.current.length>0){const e=[...p.current];p.current=[],e.forEach(async({args:e,resolve:t})=>{t(await m(e))})}},[s]),i(()=>{s&&async function(){await(u?.sendMessage(t.EditorRegisterAction,{name:f.name,description:f.description,parameters:f.parameters,returns:f.returns})),u?.updateReceiverHandlerMap(w())}()},[f,u,s]),i(()=>{l(t=>({...t,name:e.name,description:e.description,parameters:e.parameters??{},returns:e.returns??{},handler:n}))},[...o]),{isReady:c}}function y(){const[e,n]=r("light"),o=new Map;o.set(t.EditorThemeUpdate,async(e,t)=>{const r=t.payload;n(e=>r)});const{imc:a,isReady:s}=d(o);return i(()=>{s&&a?.sendMessage(t.EditorAppRequestTheme).then(e=>{n(t=>e)})},[s]),{theme:e}}function h(){return{}}function M(){const e=new Map,{imc:n,isReady:r}=d(e);return{runImageGen:async function(e,r,i){if(!n)throw new Error("IMC not initialized.");if(!e&&!r)throw new Error("At least one of textPrompt or imagePrompt is required.");return await n.sendMessage(t.ModalityImageGen,{textPrompt:e,imagePrompt:r,imageModelConfig:i}).then(e=>e)},isReady:r}}function g(){const e=new Map,{imc:n,isReady:r}=d(e);return{runLLM:async function(e,r){if(!n)throw new Error("IMC not initialized.");return await n.sendMessage(t.ModalityLLM,{prompt:e,llmConfig:r}).then(e=>e)},isReady:r}}function v(){const e=new Map,{imc:n}=d(e);return{recognizeText:async function(e){if(!n)throw new Error("IMC is not initialized.");return(await n.sendMessage(t.ModalityOCR,{image:e})).payload.text}}}function R(){const e=new Map,{imc:n,isReady:r}=d(e);return{runSTT:async function(e,r){if(!n)throw new Error("IMC not initialized.");return await n.sendMessage(t.ModalitySTT,{audio:e,sttConfig:r}).then(e=>e)},isReady:r}}function E(){const e=new Map,{imc:n,isReady:r}=d(e);return{runTTS:async function(e,r){if(!n)throw new Error("IMC not initialized.");return await n.sendMessage(t.ModalityTTS,{text:e,ttsConfig:r}).then(e=>e)},isReady:r}}function P(){const e=new Map,{imc:n,isReady:r}=d(e);return{runVideoGen:async function(e,r,i,o){if(!n)throw new Error("IMC not initialized.");if(!r&&!i)throw new Error("At least one of textPrompt or imagePrompt is required.");return await n.sendMessage(t.ModalityVideoGen,{duration:e,textPrompt:r,imagePrompt:i,videoModelConfig:o}).then(e=>e)},isReady:r}}function S(){const e=new Map,{imc:n,isReady:o}=d(e),[a,s]=r({});return i(()=>{o&&n?.sendMessage(t.EditorGetEnv).then(e=>{s(e)})},[o]),{isReady:o,envs:a}}const C=s(void 0);function A({children:e}){const[i,o]=r(void 0);return d(new Map([[t.EditorAppReceiveFileUri,async(e,t)=>{const{uri:n}=t.payload;o(e=>n)}]])),n.createElement(C.Provider,{value:{selectedFileUri:i}},e)}function I(){const e=c(C);if(!e)throw new Error("useReceiveFile must be used within a ReceiveFileProvider");return{receivedFileUri:e.selectedFileUri}}const T=s(void 0);function x({children:e}){const[o,a]=r({}),s=new Map([[t.EditorAppStateSnapshotRestore,async(e,t)=>{const{states:n}=t.payload;console.log("Restoring snapshot states:",n),a(e=>({...n}))}],[t.EditorAppStateSnapshotSave,async(e,t)=>({states:o})]]),{imc:c,isReady:u}=d(s);return i(()=>{u&&c?.updateReceiverHandlerMap(s)},[u,o]),n.createElement(T.Provider,{value:{states:o,setStates:a}},e)}function F(e,t,n){const o=c(T);if(!o)throw new Error("useSnapShotState must be used within a SnapshotProvider");const{states:s,setStates:d}=o,[u,p]=r(void 0!==s[e]?s[e]:t),f=a(!1);return i(()=>{void 0===s[e]&&void 0!==t&&d(n=>({...n,[e]:t}))},[]),i(()=>{const t=s[e];void 0!==t&&(f.current?f.current=!1:t!==u&&(console.log("Restoring state for key:",e,t),p(t),n?.(t)))},[s[e]]),[u,t=>{p(n=>{const r="function"==typeof t?t(n):t;return f.current=!0,Promise.resolve().then(()=>{d(t=>({...t,[e]:r}))}),r})}]}function b(){const e=new Map,{imc:n,isReady:o}=d(e),[a,s]=r(void 0),[c,u]=r(void 0);return i(()=>{o&&n?.sendMessage(t.PlatformCreateTerminal).then(e=>{const{websocketUrl:t,projectHomePath:n}=e;s(t),u(n)})},[o]),{websocketUrl:a,projectHomePath:c}}export{A as ReceiveFileProvider,x as SnapshotProvider,u as useAgentTools,p as useAgents,f as useFile,M as useImageGen,g as useLLM,l as useLoading,m as useNotification,v as useOCR,S as usePulseEnv,I as useReceiveFile,w as useRegisterAction,R as useSTT,F as useSnapshotState,E as useTTS,b as useTerminal,y as useTheme,h as useToolbar,P as useVideoGen};

package/dist/providers/receive-file-provider.d.ts

@@ -0,0 +1,8 @@
+import React, { ReactNode } from "react";
+export declare const ReceiveFileContext: React.Context<ReceiveFileContextType | undefined>;
+export type ReceiveFileContextType = {
+    selectedFileUri: string | undefined;
+};
+export default function ReceiveFileProvider({ children, }: {
+    children: ReactNode;
+}): React.JSX.Element;

package/dist/providers/snapshot-provider.d.ts

@@ -0,0 +1,13 @@
+import React, { Dispatch, ReactNode, SetStateAction } from "react";
+export declare const SnapshotContext: React.Context<SnapshotContextType | undefined>;
+export type SnapshotContextType = {
+    states: {
+        [key: string]: any;
+    };
+    setStates: Dispatch<SetStateAction<{
+        [key: string]: any;
+    }>>;
+};
+export default function SnapshotProvider({ children, }: {
+    children: ReactNode;
+}): React.JSX.Element;

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@pulse-editor/react-api",
-  "version": "0.1.1-alpha.5",
-  "type": "module",
+  "version": "0.1.1-alpha.50",
+  "main": "dist/main.js",
   "files": [
     "dist"
   ],
   "publishConfig": {
     "access": "public"
   },
+  "types": "dist/main.d.ts",
+  "type": "module",
   "scripts": {
     "build": "npm run clean && rollup -c",
     "lint": "eslint .",
@@ -36,7 +38,7 @@
     "typescript-eslint": "^8.30.1"
   },
   "peerDependencies": {
-    "@pulse-editor/shared-utils": "0.1.1-alpha.5",
+    "@pulse-editor/shared-utils": "0.1.1-alpha.50",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   }

package/dist/hooks/use-agent-tools.d.ts

@@ -1,4 +0,0 @@
-import { AgentTool } from "@pulse-editor/shared-utils";
-export default function useAgentTools(moduleName: string): {
-    installAgentTool: (tool: AgentTool) => Promise<void>;
-};

package/dist/hooks/use-agents.d.ts

@@ -1,6 +0,0 @@
-import { Agent } from "@pulse-editor/shared-utils";
-export default function useAgents(moduleName: string): {
-    installAgent: (config: Agent) => Promise<void>;
-    runAgentMethod: (agentName: string, methodName: string, parameters: Record<string, any>, abortSignal?: AbortSignal) => Promise<Record<string, any>>;
-    isReady: boolean;
-};

package/dist/hooks/use-fetch.d.ts

@@ -1,3 +0,0 @@
-export default function useFetch(moduleName: string): {
-    fetch: (uri: string, options?: RequestInit) => Promise<Response>;
-};

package/dist/hooks/use-file-view.d.ts

@@ -1,6 +0,0 @@
-import { FileViewModel } from "@pulse-editor/shared-utils";
-export default function useFileView(moduleName: string): {
-    viewFile: FileViewModel | undefined;
-    updateViewFile: (file: FileViewModel) => void;
-    setIsLoaded: import("react").Dispatch<import("react").SetStateAction<boolean>>;
-};

package/dist/hooks/use-orc.d.ts

@@ -1,3 +0,0 @@
-export default function useOCR(moduleName: string): {
-    recognizeText: (uri: string) => Promise<string>;
-};

package/dist/hooks/use-terminal.d.ts

@@ -1,3 +0,0 @@
-export default function useTerminal(moduleName: string): {
-    websocketUrl: string | undefined;
-};

package/dist/hooks/use-theme.d.ts

@@ -1,3 +0,0 @@
-export default function useTheme(moduleName: string): {
-    theme: string;
-};

package/dist/lib/hooks/use-imc.d.ts

@@ -1,6 +0,0 @@
-import { InterModuleCommunication } from "@pulse-editor/shared-utils";
-import { ReceiverHandlerMap } from "@pulse-editor/shared-utils";
-export default function useIMC(moduleName: string, handlerMap: ReceiverHandlerMap): {
-    imc: InterModuleCommunication | undefined;
-    isReady: boolean;
-};