ai-publish-sdk 1.1.0 → 1.2.0

package/README.md

@@ -8,6 +8,19 @@ SDK for embedded apps to communicate with the host environment.
 npm install ai-publish-sdk
 ```
 
+## General
+
+### RpcConfig
+
+Optional config passed to any function call.
+
+```typescript
+interface RpcConfig {
+  timeout?: number      // ms, default 15000
+  targetOrigin?: string // postMessage target origin, default '*'
+}
+```
+
 ## Core API
 
 ### getUserInfo()
@@ -37,7 +50,7 @@ Get OAuth token for an integration.
 ```typescript
 getToken(appName: IntegrationAppName, options?: GetTokenOptions, config?: RpcConfig): Promise<GetTokenResult | null>
 
-type IntegrationAppName = 'gmail' | 'jira' | 'googledrive' | 'salesforce' | 'googlecalendar'
+type IntegrationAppName = 'gmail' | 'jira' | 'googledrive' | 'salesforce' | 'googlecalendar' | 'slack'
 
 interface GetTokenOptions {
   interactive?: boolean // show OAuth flow if not yet authorized
@@ -70,13 +83,34 @@ Execute JavaScript on the host page.
 executeScript(code: string, config?: RpcConfig): Promise<void>
 ```
 
-### RpcConfig
+## TCP API
 
-Optional config passed to any function call.
+All data is base64-encoded. Import as `import { tcp }`.
+
+### 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, config?: RpcConfig): Promise<TcpSocket | null>
+
+interface TcpSocket {
+  send(dataBase64: string, config?: RpcConfig): Promise<number | null>
+  receive(timeoutMs?: number, config?: RpcConfig): Promise<string | null>
+  close(config?: RpcConfig): 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(timeoutMs?)
+
+Wait for and receive data from an open socket. Returns base64-encoded data, or `null` if TCP is unavailable. Defaults to a 10 second timeout.
+
+**Two-timeout interaction:** `receive()` has two independent timeouts: `timeoutMs` (host-side, how long to wait for data) and `RpcConfig.timeout` (SDK-side postMessage round-trip, default 15 s). If `timeoutMs` is longer than `RpcConfig.timeout`, the RPC layer will reject before the host-side timeout fires. Set `RpcConfig.timeout` to at least `timeoutMs + 5000` to avoid spurious RPC timeout rejections.
+
+### TcpSocket.close()
+
+Disconnect and close an open socket.

package/index.d.ts

@@ -1,3 +1,5 @@
 export { generateMessage, getToken, getUserInfo } from './lib/functions';
+export { tcp } from './lib/tcp-socket';
+export type { TcpSocket } from './lib/tcp-socket';
 export type { RpcConfig } 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"});const m=15e3,u=new Map;let l=!1;function p(){l||(l=!0,window.addEventListener("message",t=>{const e=t.data;if(!e?.messageId||!("name"in e))return;const n=u.get(e.messageId);n&&(clearTimeout(n.timer),u.delete(e.messageId),e.error?n.reject(new Error(e.error.message??"RPC error")):n.resolve(e.data))}))}function s(t,e,n){p();const o=n?.timeout??m,r=n?.targetOrigin??"*";return new Promise((c,a)=>{const i=crypto.randomUUID(),g=setTimeout(()=>{u.delete(i),a(new Error(`RPC timeout: ${t}`))},o);u.set(i,{resolve:c,reject:a,timer:g});const d={action:t,params:e,messageId:i};window.parent.postMessage(d,r)})}async function f(t,e,n){return s("generateMessage",[t,e],n)}async function y(t,e,n){return s("getToken",[t,e],n)}async function w(t){return s("getUserInfo",[],t)}async function I(t,e){return s("tcpConnect",[t],e)}async function T(t,e,n){return s("tcpSend",[t,e],n)}async function v(t,e,n){return s("tcpReceive",[t,e],n)}async function C(t,e){return s("tcpClose",[t],e)}const U={async connect(t,e,n){const o=await I({host:t,port:e},n);return o===null?null:{send:async(r,c)=>(await T(o,{dataBase64:r},c??n))?.bytesSent??null,receive:async(r,c)=>(await v(o,r!==void 0?{timeoutMs:r}:void 0,c??n))?.data??null,close:r=>C(o,r??n)}}};exports.generateMessage=f;exports.getToken=y;exports.getUserInfo=w;exports.tcp=U;

package/index.mjs

@@ -1,40 +1,71 @@
-const n = /* @__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));
+const u = /* @__PURE__ */ new Map();
+let l = !1;
+function m() {
+  l || (l = !0, window.addEventListener("message", (t) => {
+    const e = t.data;
+    if (!e?.messageId || !("name" in e)) return;
+    const n = u.get(e.messageId);
+    n && (clearTimeout(n.timer), u.delete(e.messageId), e.error ? n.reject(new Error(e.error.message ?? "RPC error")) : n.resolve(e.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,
+function s(t, e, n) {
+  m();
+  const c = n?.timeout ?? 15e3, r = n?.targetOrigin ?? "*";
+  return new Promise((o, a) => {
+    const i = crypto.randomUUID(), d = setTimeout(() => {
+      u.delete(i), a(new Error(`RPC timeout: ${t}`));
+    }, c);
+    u.set(i, {
+      resolve: o,
+      reject: a,
       timer: d
     });
-    const c = { action: r, params: e, messageId: s };
-    window.parent.postMessage(c, m);
+    const g = { action: t, params: e, messageId: i };
+    window.parent.postMessage(g, r);
   });
 }
-async function T(r, e, t) {
-  return a("generateMessage", [r, e], t);
+async function T(t, e, n) {
+  return s("generateMessage", [t, e], n);
 }
-async function I(r, e, t) {
-  return a("getToken", [r, e], t);
+async function I(t, e, n) {
+  return s("getToken", [t, e], n);
 }
-async function w(r) {
-  return a("getUserInfo", [], r);
+async function U(t) {
+  return s("getUserInfo", [], t);
 }
+async function p(t, e) {
+  return s("tcpConnect", [t], e);
+}
+async function f(t, e, n) {
+  return s("tcpSend", [t, e], n);
+}
+async function y(t, e, n) {
+  return s("tcpReceive", [t, e], n);
+}
+async function w(t, e) {
+  return s("tcpClose", [t], e);
+}
+const v = {
+  /**
+   * 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(t, e, n) {
+    const c = await p({ host: t, port: e }, n);
+    return c === null ? null : {
+      send: async (r, o) => (await f(c, { dataBase64: r }, o ?? n))?.bytesSent ?? null,
+      receive: async (r, o) => (await y(c, r !== void 0 ? { timeoutMs: r } : void 0, o ?? n))?.data ?? null,
+      close: (r) => w(c, r ?? n)
+    };
+  }
+};
 export {
   T as generateMessage,
   I as getToken,
-  w as getUserInfo
+  U as getUserInfo,
+  v as tcp
 };

package/lib/functions.d.ts

@@ -1,6 +1,10 @@
 import { RpcConfig } from './rpc-bridge';
-import { GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, UserInfo } from './types';
+import { GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, TcpConnectOptions, TcpConnectionSettings, TcpReceiveOptions, TcpReceiveResult, TcpSendMessage, TcpSendResult, 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>;
+export declare function tcpConnect(options: TcpConnectOptions, config?: RpcConfig): Promise<TcpConnectionSettings | null>;
+export declare function tcpSend(connection: TcpConnectionSettings, message: TcpSendMessage, config?: RpcConfig): Promise<TcpSendResult | null>;
+export declare function tcpReceive(connection: TcpConnectionSettings, options?: TcpReceiveOptions, config?: RpcConfig): Promise<TcpReceiveResult | null>;
+export declare function tcpClose(connection: TcpConnectionSettings, config?: RpcConfig): Promise<void>;

package/lib/tcp-socket.d.ts

@@ -0,0 +1,17 @@
+import { RpcConfig } from './rpc-bridge';
+export interface TcpSocket {
+    send(dataBase64: string, config?: RpcConfig): Promise<number | null>;
+    receive(timeoutMs?: number, config?: RpcConfig): Promise<string | null>;
+    close(config?: RpcConfig): 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, config?: RpcConfig): 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.0",
+  "version": "1.2.0",
   "module": "./index.mjs",
   "main": "./index.js",
   "types": "./index.d.ts",