@uranotools/urano-social 0.0.0-stage → 0.3.0

package/dist/server/websocket.js

@@ -0,0 +1,126 @@
+import { signHmacHex } from '../crypto';
+import { resolveVisitorId, DEFAULT_COOKIE_NAME } from './visitorCookie';
+/**
+ * Attaches an optional WebSocket bridge to a Node HTTP server.
+ * Next App Router cannot upgrade sockets in a route handler — use SSE there.
+ * Astro Node / custom servers can call this after `http.createServer`.
+ */
+export function attachSocialWebSocket(server, partial) {
+    const webhookUrl = (partial?.webhookUrl || process.env.URANO_SOCIAL_WEBHOOK_URL || '').replace(/\/$/, '');
+    const webhookSecret = partial?.webhookSecret || process.env.URANO_SOCIAL_WEBHOOK_SECRET || '';
+    const cookieSecret = partial?.cookieSecret || process.env.URANO_SOCIAL_COOKIE_SECRET || webhookSecret;
+    const cookieName = partial?.cookieName || DEFAULT_COOKIE_NAME;
+    const path = partial?.path || '/api/urano-social/ws';
+    if (!webhookUrl || !webhookSecret) {
+        throw new Error('attachSocialWebSocket requires URANO_SOCIAL_WEBHOOK_URL and URANO_SOCIAL_WEBHOOK_SECRET');
+    }
+    const upstreamWs = webhookUrl.replace(/^http/, 'ws') + '/ws';
+    const onUpgrade = (req, socket, head) => {
+        const url = new URL(req.url || '/', 'http://localhost');
+        if (url.pathname !== path)
+            return;
+        const visitor = resolveVisitorId({
+            cookieHeader: req.headers.cookie,
+            cookieName,
+            cookieSecret,
+        });
+        // Minimal RFC6455 accept handshake, then bridge frames as text JSON.
+        // Prefer the host runtime's `ws` package when available; fall back to rejecting.
+        let WebSocketImpl;
+        try {
+            WebSocketImpl = require('ws');
+        }
+        catch {
+            socket.write('HTTP/1.1 501 Not Implemented\r\nConnection: close\r\n\r\n');
+            socket.destroy();
+            return;
+        }
+        const wss = new WebSocketImpl.Server({ noServer: true });
+        wss.handleUpgrade(req, socket, head, (client) => {
+            if (visitor.setCookie) {
+                // Cookie already set via prior HTTP; continue.
+            }
+            const upstream = new WebSocketImpl(upstreamWs);
+            let sessionId;
+            upstream.on('open', () => {
+                client.send(JSON.stringify({ type: 'proxy_ready', visitorId: visitor.visitorId }));
+            });
+            client.on('message', (data) => {
+                let msg;
+                try {
+                    msg = JSON.parse(String(data));
+                }
+                catch {
+                    client.send(JSON.stringify({ type: 'error', error: 'invalid_json' }));
+                    return;
+                }
+                const payloadObj = {
+                    visitorId: visitor.visitorId,
+                    from: visitor.visitorId,
+                    text: typeof msg.text === 'string' ? msg.text : undefined,
+                    sessionId: typeof msg.sessionId === 'string' ? msg.sessionId : sessionId,
+                    displayName: typeof msg.displayName === 'string' ? msg.displayName : undefined,
+                    webhookAction: msg.webhookAction,
+                    turnId: msg.turnId,
+                };
+                const payloadStr = JSON.stringify(payloadObj);
+                const signature = signHmacHex(payloadStr, webhookSecret);
+                upstream.send(JSON.stringify({
+                    payload: payloadStr,
+                    headers: {
+                        'x-urano-signature': signature,
+                        'Content-Type': 'application/json',
+                        'X-Urano-Protocol-Version': '1',
+                        ...(msg.idempotencyKey ? { 'Idempotency-Key': msg.idempotencyKey } : {}),
+                    },
+                }));
+            });
+            upstream.on('message', (data) => {
+                try {
+                    const evt = JSON.parse(String(data));
+                    if (evt?.sessionId)
+                        sessionId = evt.sessionId;
+                    if (evt?.type === 'session' && evt.sessionId)
+                        sessionId = evt.sessionId;
+                }
+                catch { /* forward raw */ }
+                if (client.readyState === 1)
+                    client.send(String(data));
+            });
+            const closeBoth = () => {
+                try {
+                    client.close();
+                }
+                catch { /* ignore */ }
+                try {
+                    upstream.close();
+                }
+                catch { /* ignore */ }
+            };
+            client.on('close', closeBoth);
+            upstream.on('close', closeBoth);
+            client.on('error', closeBoth);
+            upstream.on('error', (err) => {
+                try {
+                    client.send(JSON.stringify({ type: 'error', error: err.message }));
+                }
+                catch { /* ignore */ }
+                closeBoth();
+            });
+        });
+    };
+    server.on('upgrade', onUpgrade);
+    return () => server.off('upgrade', onUpgrade);
+}
+/** Exported for tests — builds the WS envelope the upstream expects. */
+export function buildWsEnvelope(payload, secret) {
+    const payloadStr = JSON.stringify(payload);
+    return {
+        payload: payloadStr,
+        headers: {
+            'x-urano-signature': signHmacHex(payloadStr, secret),
+            'Content-Type': 'application/json',
+            'X-Urano-Protocol-Version': '1',
+        },
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,94 @@
+export type SocialTransport = 'sse' | 'wait' | 'ws' | 'async';
+export type WebhookAction = 'status' | 'events' | 'cancel';
+/** Shared honeypot field name (safe to import from browser bundles). */
+export declare const DEFAULT_HONEYPOT_FIELD = "website";
+export declare const DEFAULT_RECAPTCHA_ACTION = "contact";
+export interface ContactAntiSpamConfig {
+    /** Master switch for contact gates. Default true. */
+    enabled?: boolean;
+    /** Hidden field name bots fill. Default `website`. */
+    honeypotField?: string;
+    /** Minimum ms between issuing a contact ticket and accepting submit. Default 2500. */
+    minSubmitAgeMs?: number;
+    /** Maximum ticket lifetime. Default 30 minutes. */
+    maxSubmitAgeMs?: number;
+    /** Max contact submits per visitor+IP per hour. Default 5. */
+    maxPerHour?: number;
+    /** Max message length. Default 4000. */
+    maxMessageChars?: number;
+    /** Google reCAPTCHA v3 secret (server-only). Env: URANO_SOCIAL_RECAPTCHA_SECRET */
+    recaptchaSecret?: string;
+    /** Minimum v3 score. Default 0.5. */
+    recaptchaMinScore?: number;
+    /** Expected grecaptcha action. Default `contact`. */
+    recaptchaAction?: string;
+    /**
+     * When a recaptcha secret is set, require a token (default true).
+     * Set false to verify only when the client sends a token.
+     */
+    requireRecaptcha?: boolean;
+}
+export interface SocialProxyConfig {
+    webhookUrl: string;
+    webhookSecret: string;
+    /** Secret used to sign the HttpOnly visitor cookie. Defaults to webhookSecret. */
+    cookieSecret?: string;
+    cookieName?: string;
+    cookieMaxAgeSec?: number;
+    /** Default display name forwarded as displayName when the client omits one. */
+    defaultDisplayName?: string;
+    /** Contact-form anti-spam (honeypot, ticket, rate limit, optional reCAPTCHA v3). */
+    antiSpam?: ContactAntiSpamConfig;
+}
+export interface SocialClientMessage {
+    id: string;
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+    streaming?: boolean;
+    turnId?: string;
+    createdAt: number;
+}
+export interface SocialChatEvent {
+    type: string;
+    version?: number;
+    id?: string;
+    sequence?: number;
+    turnId?: string;
+    requestId?: string;
+    sessionId?: string;
+    chunk?: string;
+    response?: string;
+    agentId?: string;
+    toolsUsed?: string[];
+    error?: string;
+    status?: number;
+    [key: string]: unknown;
+}
+export interface SocialSendOptions {
+    text: string;
+    displayName?: string;
+    mode?: 'sse' | 'wait';
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+export interface SocialControlOptions {
+    action: WebhookAction;
+    turnId: string;
+    after?: string;
+    signal?: AbortSignal;
+}
+export interface CreateUranoChatOptions {
+    /** Site proxy endpoint, default `/api/urano-social`. */
+    endpoint?: string;
+    sessionId?: string | null;
+    displayName?: string;
+    preferredTransport?: 'auto' | 'sse' | 'wait' | 'ws';
+    onEvent?: (event: SocialChatEvent) => void;
+    onMessages?: (messages: SocialClientMessage[]) => void;
+    onError?: (error: Error) => void;
+    onStatus?: (status: {
+        connected: boolean;
+        streaming: boolean;
+        sessionId: string | null;
+    }) => void;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+/** Shared honeypot field name (safe to import from browser bundles). */
+export const DEFAULT_HONEYPOT_FIELD = 'website';
+export const DEFAULT_RECAPTCHA_ACTION = 'contact';

package/package.json

@@ -1,6 +1,94 @@
 {
   "name": "@uranotools/urano-social",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.3.0",
+  "description": "Customer-support chat widget for SalesAgentConnector MCP webhooks (SSE / WebSocket / wait)",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc && node scripts/copy-assets.cjs",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build",
+    "test": "tsx --test test/*.test.ts",
+    "typecheck": "tsc --noEmit",
+    "publish:npm": "npm publish --access public"
+  },
+  "keywords": [
+    "urano",
+    "chat",
+    "customer-support",
+    "sse",
+    "websocket",
+    "salesagent",
+    "astro",
+    "nextjs"
+  ],
+  "author": "Urano Open Source",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    ".env.example"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.js",
+      "default": "./dist/client/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.js",
+      "require": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.js",
+      "default": "./dist/react/index.js"
+    },
+    "./flavors.css": "./dist/flavors/styles.css"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "optionalDependencies": {
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "@types/react": "^18.3.12",
+    "react": "^18.3.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.3.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uranotools/urano-social.git"
+  },
+  "bugs": {
+    "url": "https://github.com/uranotools/urano-social/issues"
+  },
+  "homepage": "https://github.com/uranotools/urano-social#readme"
+}