ai-publish-sdk 1.1.1 → 1.3.0

package/README.md

@@ -8,6 +8,20 @@ SDK for embedded apps to communicate with the host environment.
 npm install ai-publish-sdk
 ```
 
+## Timeout Configuration
+
+Default timeout is 15 seconds. You can change it globally or wrap a single call:
+
+```typescript
+import { setGlobalTimeout, withTimeout, getUserInfo } from 'ai-publish-sdk'
+
+// Change the default for all calls
+setGlobalTimeout(30_000)
+
+// Override for a single call
+await withTimeout(() => getUserInfo(), 10_000)
+```
+
 ## Core API
 
 ### getUserInfo()
@@ -15,7 +29,7 @@ npm install ai-publish-sdk
 Get current user info.
 
 ```typescript
-getUserInfo(config?: RpcConfig): Promise<UserInfo | null>
+getUserInfo(): Promise<UserInfo | null>
 
 interface UserInfo {
   userId: string
@@ -35,7 +49,7 @@ interface UserInfo {
 Get OAuth token for an integration.
 
 ```typescript
-getToken(appName: IntegrationAppName, options?: GetTokenOptions, config?: RpcConfig): Promise<GetTokenResult | null>
+getToken(appName: IntegrationAppName, options?: GetTokenOptions): Promise<GetTokenResult | null>
 
 type IntegrationAppName = 'gmail' | 'jira' | 'googledrive' | 'salesforce' | 'googlecalendar' | 'slack'
 
@@ -54,7 +68,7 @@ interface GetTokenResult {
 Generate an AI message.
 
 ```typescript
-generateMessage(prompt: string, options: GenerateMessageOptions, config?: RpcConfig): Promise<string | null>
+generateMessage(prompt: string, options: GenerateMessageOptions): Promise<string | null>
 
 interface GenerateMessageOptions {
   withPageContext?: boolean // include current page content as context
@@ -67,16 +81,35 @@ interface GenerateMessageOptions {
 Execute JavaScript on the host page.
 
 ```typescript
-executeScript(code: string, config?: RpcConfig): Promise<void>
+executeScript(code: string): Promise<void>
 ```
 
-### RpcConfig
+## TCP API
+
+All data is base64-encoded. Import as `import { tcp }`.
 
-Optional config passed to any function call.
+### tcp.connect(host, port)
+
+Open a TCP connection. Returns a `TcpSocket` object for subsequent operations, or `null` if TCP is unavailable.
 
 ```typescript
-interface RpcConfig {
-  timeout?: number      // ms, default 15000
-  targetOrigin?: string // postMessage target origin, default '*'
+tcp.connect(host: string, port: number): Promise<TcpSocket | null>
+
+interface TcpSocket {
+  send(dataBase64: string): Promise<number | null>
+  receive(): Promise<string | null>
+  close(): Promise<void>
 }
 ```
+
+### TcpSocket.send(dataBase64)
+
+Send data over an open socket. Data must be base64-encoded. Returns the number of bytes sent, or `null` if TCP is unavailable.
+
+### TcpSocket.receive()
+
+Wait for and receive data from an open socket. Returns base64-encoded data, or `null` if TCP is unavailable. Use `withTimeout(() => socket.receive(), ms)` for custom timeouts.
+
+### TcpSocket.close()
+
+Disconnect and close an open socket.

package/index.d.ts

@@ -1,3 +1,5 @@
 export { generateMessage, getToken, getUserInfo } from './lib/functions';
-export type { RpcConfig } from './lib/rpc-bridge';
+export { tcp } from './lib/tcp-socket';
+export type { TcpSocket } from './lib/tcp-socket';
+export { setGlobalTimeout, withTimeout } from './lib/rpc-bridge';
 export type { GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, UserInfo } from './lib/types';

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=15e3,n=new Map;let i=!1;function I(){i||(i=!0,window.addEventListener("message",r=>{const e=r.data;if(!(e!=null&&e.messageId)||!("name"in e))return;const t=n.get(e.messageId);t&&(clearTimeout(t.timer),n.delete(e.messageId),e.error?t.reject(new Error(e.error.message??"RPC error")):t.resolve(e.data))}))}function o(r,e,t){I();const u=(t==null?void 0:t.timeout)??c,g=(t==null?void 0:t.targetOrigin)??"*";return new Promise((m,a)=>{const s=crypto.randomUUID(),d=setTimeout(()=>{n.delete(s),a(new Error(`RPC timeout: ${r}`))},u);n.set(s,{resolve:m,reject:a,timer:d});const l={action:r,params:e,messageId:s};window.parent.postMessage(l,g)})}async function T(r,e,t){return o("generateMessage",[r,e],t)}async function w(r,e,t){return o("getToken",[r,e],t)}async function p(r){return o("getUserInfo",[],r)}exports.generateMessage=T;exports.getToken=w;exports.getUserInfo=p;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});let u=15e3;const c=new Map;let a=!1;function m(e){u=e}let i;function d(e,t){i=t;try{return e()}finally{i=void 0}}function f(){a||(a=!0,window.addEventListener("message",e=>{const t=e.data;if(!t?.messageId||!("name"in t))return;const n=c.get(t.messageId);n&&(clearTimeout(n.timer),c.delete(t.messageId),t.error?n.reject(new Error(t.error.message??"RPC error")):n.resolve(t.data))}))}function r(e,t){return f(),new Promise((n,s)=>{const o=crypto.randomUUID(),l=setTimeout(()=>{c.delete(o),s(new Error(`RPC timeout: ${e}`))},i??u);c.set(o,{resolve:n,reject:s,timer:l});const g={action:e,params:t,messageId:o};window.parent.postMessage(g,"*")})}async function p(e,t){return r("generateMessage",[e,t])}async function y(e,t){return r("getToken",[e,t])}async function w(){return r("getUserInfo",[])}async function T(e){return r("tcpConnect",[e])}async function v(e,t){return r("tcpSend",[e,t])}async function I(e,t){return r("tcpReceive",[e,t])}async function C(e){return r("tcpClose",[e])}const b={async connect(e,t){const n=await T({host:e,port:t});return n===null?null:{send:async s=>(await v(n,{dataBase64:s}))?.bytesSent??null,receive:async()=>(await I(n))?.data??null,close:()=>C(n)}}};exports.generateMessage=p;exports.getToken=y;exports.getUserInfo=w;exports.setGlobalTimeout=m;exports.tcp=b;exports.withTimeout=d;

package/index.mjs

@@ -1,40 +1,84 @@
-const n = /* @__PURE__ */ new Map();
+let u = 15e3;
+const c = /* @__PURE__ */ new Map();
 let i = !1;
-function l() {
-  i || (i = !0, window.addEventListener("message", (r) => {
-    const e = r.data;
-    if (!(e != null && e.messageId) || !("name" in e)) return;
-    const t = n.get(e.messageId);
-    t && (clearTimeout(t.timer), n.delete(e.messageId), e.error ? t.reject(new Error(e.error.message ?? "RPC error")) : t.resolve(e.data));
+function T(e) {
+  u = e;
+}
+let a;
+function v(e, t) {
+  a = t;
+  try {
+    return e();
+  } finally {
+    a = void 0;
+  }
+}
+function m() {
+  i || (i = !0, window.addEventListener("message", (e) => {
+    const t = e.data;
+    if (!t?.messageId || !("name" in t)) return;
+    const n = c.get(t.messageId);
+    n && (clearTimeout(n.timer), c.delete(t.messageId), t.error ? n.reject(new Error(t.error.message ?? "RPC error")) : n.resolve(t.data));
   }));
 }
-function a(r, e, t) {
-  l();
-  const u = (t == null ? void 0 : t.timeout) ?? 15e3, m = (t == null ? void 0 : t.targetOrigin) ?? "*";
-  return new Promise((g, o) => {
-    const s = crypto.randomUUID(), d = setTimeout(() => {
-      n.delete(s), o(new Error(`RPC timeout: ${r}`));
-    }, u);
-    n.set(s, {
-      resolve: g,
-      reject: o,
-      timer: d
+function r(e, t) {
+  return m(), new Promise((n, s) => {
+    const o = crypto.randomUUID(), l = setTimeout(() => {
+      c.delete(o), s(new Error(`RPC timeout: ${e}`));
+    }, a ?? u);
+    c.set(o, {
+      resolve: n,
+      reject: s,
+      timer: l
     });
-    const c = { action: r, params: e, messageId: s };
-    window.parent.postMessage(c, m);
+    const d = { action: e, params: t, messageId: o };
+    window.parent.postMessage(d, "*");
   });
 }
-async function T(r, e, t) {
-  return a("generateMessage", [r, e], t);
+async function C(e, t) {
+  return r("generateMessage", [e, t]);
+}
+async function I(e, t) {
+  return r("getToken", [e, t]);
+}
+async function M() {
+  return r("getUserInfo", []);
 }
-async function I(r, e, t) {
-  return a("getToken", [r, e], t);
+async function f(e) {
+  return r("tcpConnect", [e]);
 }
-async function w(r) {
-  return a("getUserInfo", [], r);
+async function g(e, t) {
+  return r("tcpSend", [e, t]);
 }
+async function p(e, t) {
+  return r("tcpReceive", [e, t]);
+}
+async function y(e) {
+  return r("tcpClose", [e]);
+}
+const R = {
+  /**
+   * Opens a TCP connection and returns a `TcpSocket` wrapper.
+   *
+   * The `TcpSocket` wrapper hides the socket ID as an implementation detail,
+   * preventing accidental misuse. Authorization (ensuring only the owning app can
+   * use a socket) is enforced on the host side — do not assume the closure provides
+   * security guarantees.
+   */
+  async connect(e, t) {
+    const n = await f({ host: e, port: t });
+    return n === null ? null : {
+      send: async (s) => (await g(n, { dataBase64: s }))?.bytesSent ?? null,
+      receive: async () => (await p(n))?.data ?? null,
+      close: () => y(n)
+    };
+  }
+};
 export {
-  T as generateMessage,
+  C as generateMessage,
   I as getToken,
-  w as getUserInfo
+  M as getUserInfo,
+  T as setGlobalTimeout,
+  R as tcp,
+  v as withTimeout
 };

package/lib/functions.d.ts

@@ -1,6 +1,9 @@
-import { RpcConfig } from './rpc-bridge';
-import { GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, UserInfo } from './types';
-export declare function generateMessage(prompt: string, options: GenerateMessageOptions, config?: RpcConfig): Promise<string | null>;
-export declare function getToken(appName: IntegrationAppName, options?: GetTokenOptions, config?: RpcConfig): Promise<GetTokenResult | null>;
-export declare function getUserInfo(config?: RpcConfig): Promise<UserInfo | null>;
-export declare function executeScript(code: string, config?: RpcConfig): Promise<void>;
+import { GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, TcpConnectOptions, TcpConnectionSettings, TcpReceiveOptions, TcpReceiveResult, TcpSendMessage, TcpSendResult, UserInfo } from './types';
+export declare function generateMessage(prompt: string, options: GenerateMessageOptions): Promise<string | null>;
+export declare function getToken(appName: IntegrationAppName, options?: GetTokenOptions): Promise<GetTokenResult | null>;
+export declare function getUserInfo(): Promise<UserInfo | null>;
+export declare function executeScript(code: string): Promise<void>;
+export declare function tcpConnect(options: TcpConnectOptions): Promise<TcpConnectionSettings | null>;
+export declare function tcpSend(connection: TcpConnectionSettings, message: TcpSendMessage): Promise<TcpSendResult | null>;
+export declare function tcpReceive(connection: TcpConnectionSettings, options?: TcpReceiveOptions): Promise<TcpReceiveResult | null>;
+export declare function tcpClose(connection: TcpConnectionSettings): Promise<void>;

package/lib/rpc-bridge.d.ts

@@ -1,5 +1,4 @@
-export interface RpcConfig {
-    timeout?: number;
-    targetOrigin?: string;
-}
-export declare function rpcCall<T = unknown>(action: string, params: unknown[], config?: RpcConfig): Promise<T>;
+export declare function setGlobalTimeout(ms: number): void;
+export declare function resetForTesting(): void;
+export declare function withTimeout<T>(fn: () => Promise<T>, ms: number): Promise<T>;
+export declare function rpcCall<T = unknown>(action: string, params: unknown[]): Promise<T>;

package/lib/tcp-socket.d.ts

@@ -0,0 +1,16 @@
+export interface TcpSocket {
+    send(dataBase64: string): Promise<number | null>;
+    receive(): Promise<string | null>;
+    close(): Promise<void>;
+}
+export declare const tcp: {
+    /**
+     * Opens a TCP connection and returns a `TcpSocket` wrapper.
+     *
+     * The `TcpSocket` wrapper hides the socket ID as an implementation detail,
+     * preventing accidental misuse. Authorization (ensuring only the owning app can
+     * use a socket) is enforced on the host side — do not assume the closure provides
+     * security guarantees.
+     */
+    connect(host: string, port: number): Promise<TcpSocket | null>;
+};

package/lib/types.d.ts

@@ -21,3 +21,22 @@ export interface UserInfo {
     email?: string;
     picture?: string;
 }
+export interface TcpConnectOptions {
+    host: string;
+    port: number;
+}
+export interface TcpConnectionSettings {
+    socketId: number;
+}
+export interface TcpSendMessage {
+    dataBase64: string;
+}
+export interface TcpSendResult {
+    bytesSent: number;
+}
+export interface TcpReceiveOptions {
+    timeoutMs?: number;
+}
+export interface TcpReceiveResult {
+    data: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-publish-sdk",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "module": "./index.mjs",
   "main": "./index.js",
   "types": "./index.d.ts",