@lingya-ai/agents-sdk 0.4.0 → 0.7.0

package/dist/client.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -9,173 +23,113 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LingyaApiError = exports.LingyaAgentsUserClient = exports.LingyaAgentsClient = exports.ApiError = exports.AgentsUserClient = exports.AgentsClient = void 0;
+exports.LingyaAgentsClient = exports.AgentsClient = void 0;
+const ws_1 = require("ws");
+const lifecycle_1 = require("./lifecycle");
+const client_core_1 = require("./client-core");
 const runtime_1 = require("./runtime");
-const apis_1 = require("./apis");
 const hmac_1 = require("./hmac");
-const bound_1 = require("./bound");
-/**
- * Lingya Agents SDK 入口，仅适用于可信服务端。 / Server-side Lingya Agents SDK entry point.
- *
- * 客户端保存 channel 范围的凭证，但只有 [forUser] 创建的用户客户端可以发起请求。
- */
+const token_1 = require("./token");
+__exportStar(require("./client-core"), exports);
+__exportStar(require("./token"), exports);
+/** Channel client; options construction binds authentication and exposes API groups directly. */
 class AgentsClient {
-    /**
-     * 创建 channel 范围的客户端。 / Creates a channel-scoped client.
-     *
-     * @param baseUrl - 服务根地址，不包含 `/api/.../chat`。 / Service root without the API path.
-     * @param channelId - OpenAPI channel ID，不得为空。 / Non-empty OpenAPI channel ID.
-     * @param credentials - 仅保存在当前服务端进程中的 HMAC 凭证。 / HMAC credentials kept in this server process.
-     */
-    constructor(baseUrl, channelId, credentials) {
-        this.baseUrl = baseUrl;
-        this.channelId = channelId;
-        this.credentials = credentials;
-        if (channelId.length === 0)
+    constructor(options, channelId, credentials) {
+        this.baseUrl = typeof options === 'string' ? options : options.baseUrl;
+        this.channelId = typeof options === 'string' ? channelId : options.channelId;
+        if (!this.channelId)
             throw new Error('channelId must not be empty');
+        if (typeof options === 'string') {
+            if (!credentials)
+                throw new Error('credentials are required');
+            this.credentials = credentials;
+        }
+        else {
+            const transport = options.auth.type === 'token'
+                ? (0, token_1.createTokenFetch)(options.auth.tokenProvider, this.channelId, options.fetch)
+                : (0, hmac_1.createSignedFetch)(options.auth, options.auth.externalUserId, options.fetch);
+            this.bound = this.bind(transport, options.auth.type === 'token', (url, signal, requestId) => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const factory = (_a = options.webSocketFactory) !== null && _a !== void 0 ? _a : createNodeWebSocket;
+                if (options.auth.type === 'token') {
+                    let token;
+                    try {
+                        token = yield (0, lifecycle_1.abortable)(Promise.resolve().then(() => { var _a; return options.auth.type === 'token' ? options.auth.tokenProvider({ channelId: this.channelId, signal, fetch: (_a = options.fetch) !== null && _a !== void 0 ? _a : globalThis.fetch }) : ''; }), signal);
+                    }
+                    catch (error) {
+                        if (signal.aborted)
+                            throw error;
+                        throw new lifecycle_1.ApiError('', '', undefined, '', { kind: 'authentication' });
+                    }
+                    if (typeof token !== 'string' || !/^[!#-~]+$/.test(token))
+                        throw new lifecycle_1.ApiError('', '', undefined, '', { kind: 'authentication' });
+                    (0, lifecycle_1.checkSignal)(signal);
+                    return factory(url, { protocols: [`xlt-openapi-token.${token}`], headers: requestId ? { 'X-Request-ID': requestId } : undefined });
+                }
+                const httpUrl = url.replace(/^ws/, 'http');
+                const capture = (input) => __awaiter(this, void 0, void 0, function* () { return new Response(null, { headers: new Request(input).headers }); });
+                const response = yield (0, hmac_1.createSignedFetch)(options.auth, options.auth.externalUserId, capture)(httpUrl, { signal });
+                (0, lifecycle_1.checkSignal)(signal);
+                return factory(url, { protocols: [], headers: Object.assign(Object.assign({}, Object.fromEntries(response.headers.entries())), (requestId ? { 'X-Request-ID': requestId } : {})) });
+            }));
+        }
+    }
+    bind(transport, tokenAuth = false, connector) {
+        return new client_core_1.AgentsUserClient(this.channelId, new runtime_1.Configuration({
+            basePath: this.baseUrl.replace(/\/+$/, ''), fetchApi: transport,
+        }), transport, this.baseUrl, tokenAuth, connector);
     }
-    /**
-     * 绑定外部用户身份；后续所有请求都以该身份独立签名。 / Binds one external user to all subsequent signed calls.
-     *
-     * @param externalUserId - 调用方系统的稳定用户 ID，UTF-8 编码后为 1..256 字节且不能含 NUL。
-     * @returns 注入用户身份并可调用全部契约 API 的客户端。
-     */
     forUser(externalUserId) {
-        const signedFetch = (0, hmac_1.createSignedFetch)(this.credentials, externalUserId);
-        const configuration = new runtime_1.Configuration({ basePath: this.baseUrl.replace(/\/+$/, ''), fetchApi: signedFetch });
-        return new AgentsUserClient(this.channelId, configuration, signedFetch, this.baseUrl);
+        if (!this.credentials)
+            throw new Error('Options clients already bind identity; create a new client to switch users');
+        return new AgentsClient({ baseUrl: this.baseUrl, channelId: this.channelId, auth: Object.assign(Object.assign({ type: 'hmac' }, this.credentials), { externalUserId }) }).user;
     }
+    get user() {
+        if (!this.bound)
+            throw new Error('Call forUser before using a legacy channel client');
+        return this.bound;
+    }
+    get chat() { return this.user.chat; }
+    get configuration() { return this.user.configuration; }
+    get conversations() { return this.user.conversations; }
+    get events() { return this.user.events; }
+    get files() { return this.user.files; }
+    get interactions() { return this.user.interactions; }
+    get knowledge() { return this.user.knowledge; }
+    get messages() { return this.user.messages; }
+    get sql() { return this.user.sql; }
+    get workspace() { return this.user.workspace; }
+    get lowLevel() { return this.user.lowLevel; }
 }
 exports.AgentsClient = AgentsClient;
 exports.LingyaAgentsClient = AgentsClient;
-/** 已绑定外部用户的强类型 API 集合。 / Strongly typed API collection bound to one external user. */
-class AgentsUserClient {
-    constructor(channelId, configuration, signedFetch, baseUrl) {
-        this.channelId = channelId;
-        this.signedFetch = signedFetch;
-        this.baseUrl = baseUrl;
-        const chat = new apis_1.ChatApi(configuration);
-        const configurationApi = new apis_1.ConfigurationApi(configuration);
-        const conversations = new apis_1.ConversationsApi(configuration);
-        const events = new apis_1.EventsApi(configuration);
-        const files = new apis_1.FilesApi(configuration);
-        const interactions = new apis_1.InteractionsApi(configuration);
-        const knowledge = new apis_1.KnowledgeApi(configuration);
-        const messages = new apis_1.MessagesApi(configuration);
-        const sql = new apis_1.SQLApi(configuration);
-        const workspace = new apis_1.WorkspaceApi(configuration);
-        this.lowLevel = new bound_1.AgentsLowLevelApis(configurationApi, chat, conversations, sql, messages, events, interactions, files, knowledge, workspace);
-        const rawRequest = this.rawRequest.bind(this);
-        this.chat = new bound_1.ChatApi(channelId, chat, rawRequest);
-        this.configuration = new bound_1.ConfigurationApi(channelId, configurationApi);
-        this.conversations = new bound_1.ConversationsApi(channelId, conversations);
-        this.events = new bound_1.EventsApi(channelId, events);
-        this.files = new bound_1.FilesApi(channelId, files);
-        this.interactions = new bound_1.InteractionsApi(channelId, interactions);
-        this.knowledge = new bound_1.KnowledgeApi(channelId, knowledge);
-        this.messages = new bound_1.MessagesApi(channelId, messages);
-        this.sql = new bound_1.SqlApi(channelId, sql);
-        this.workspace = new bound_1.WorkspaceApi(channelId, workspace);
-    }
-    /**
-     * 调用契约端点并按指定类型返回 JSON；优先使用上方生成的强类型 API。 / Calls a contract endpoint and decodes typed JSON.
-     *
-     * @param method - 大写 HTTP method。
-     * @param suffix - 相对于 channel chat 根路径的已编码路径。
-     * @param bodyJson - 最终发送并参与签名的 UTF-8 JSON 字符串；无请求体时省略。
-     * @param query - 已按最终顺序组装的查询参数，允许重复键。
-     * @returns 调用方指定的响应类型。
-     * @throws [ApiError] 当服务端返回非 2xx 状态。
-     */
-    /** @deprecated 使用对应的业务分组方法。 / Use the matching grouped facade operation. */
-    request(method, suffix, bodyJson, query) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.rawRequest(method, suffix, bodyJson, query, 'application/json');
-            return yield response.json();
-        });
-    }
-    /**
-     * 调用无响应正文的契约端点。 / Calls a contract endpoint that has no response body.
-     *
-     * @param method - 大写 HTTP method。
-     * @param suffix - 相对于 channel chat 根路径的已编码路径。
-     * @param bodyJson - 最终发送并参与签名的 UTF-8 JSON 字符串。
-     * @param query - 保留顺序的查询参数。
-     * @returns 2xx HTTP 状态码。
-     */
-    /** @deprecated 使用对应的业务分组方法。 / Use the matching grouped facade operation. */
-    requestStatus(method, suffix, bodyJson, query) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.rawRequest(method, suffix, bodyJson, query, 'application/json')).status;
-        });
-    }
-    /**
-     * 下载二进制响应，返回精确响应字节。 / Downloads an exact binary response.
-     *
-     * @param method - HTTP method，通常为 `GET`。
-     * @param suffix - 已编码的相对路径。
-     * @param query - 保留顺序的查询参数。
-     * @returns 未经文本转换的响应字节。
-     */
-    /** @deprecated 使用对应的业务分组方法。 / Use the matching grouped facade operation. */
-    requestBinary(method, suffix, query) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.rawRequest(method, suffix, undefined, query, 'application/octet-stream');
-            return new Uint8Array(yield response.arrayBuffer());
-        });
-    }
-    /**
-     * 订阅对话 SSE，事件按契约判别联合返回。 / Streams SSE as the contract discriminated union.
-     *
-     * @param conversationId - 要订阅的会话 ID。
-     * @param messageId - 触发本次生成的消息 ID。
-     * @returns 支持取消的异步事件序列；未知 type 保留 `rawJson`。
-     */
-    /** @deprecated 使用 `chat.streamChatEvents(conversationId, { messageId })`。 / Use the channel-bound chat facade. */
-    streamChatEvents(conversationId, messageId) {
-        return this.chat.streamChatEvents(conversationId, { messageId });
-    }
-    /**
-     * 发送底层受控请求；调用前固定最终 path、query、Content-Type 与 body 字节。 / Sends an exactly signed low-level request.
-     *
-     * 每次调用重新生成 timestamp 与 nonce，不对写请求自动重试。
-     *
-     * @param method - HTTP method。
-     * @param suffix - 已完成路径转义的相对路径；本方法不会二次编码。
-     * @param bodyJson - 最终 JSON 字符串，最大 2 MiB；省略时 Content-Type 为空。
-     * @param query - 最终查询参数；顺序和重复键均参与签名。
-     * @param accept - 精确的 Accept 值，例如 `application/json`、`text/event-stream` 或 `text/csv`。
-     * @returns 成功的原始 Fetch Response。
-     * @throws [ApiError] 当服务端返回非 2xx 状态。
-     */
-    /** @deprecated 使用 `lowLevel`，或使用对应的业务分组方法。 / Use `lowLevel` or a grouped facade operation. */
-    rawRequest(method_1, suffix_1, bodyJson_1, query_1) {
-        return __awaiter(this, arguments, void 0, function* (method, suffix, bodyJson, query, accept = 'application/json', requestId) {
-            const root = `${this.baseUrl.replace(/\/+$/, '')}/api/agents/channel/openapi/v1/${encodeURIComponent(this.channelId)}/chat`;
-            const url = `${root}${suffix}${query === undefined || query.size === 0 ? '' : `?${query.toString()}`}`;
-            const response = yield this.signedFetch(url, {
-                method,
-                headers: Object.assign(Object.assign({ Accept: accept }, (bodyJson === undefined ? {} : { 'Content-Type': 'application/json' })), (requestId === undefined ? {} : { 'X-Request-ID': requestId })),
-                body: bodyJson,
-            });
-            if (!response.ok)
-                throw new ApiError(method, suffix, response.status, yield response.text());
-            return response;
+function createNodeWebSocket(address, init) {
+    const socket = new ws_1.WebSocket(address, init.protocols, { headers: init.headers });
+    const result = socket;
+    // ws is an EventEmitter: termination while connecting must also have an error listener.
+    socket.on('error', () => undefined);
+    socket.on('upgrade', response => {
+        const id = response.headers['x-request-id'];
+        if (typeof id === 'string')
+            result.serverRequestId = id;
+    });
+    socket.on('unexpected-response', (_request, response) => {
+        const chunks = [];
+        let size = 0;
+        response.on('data', chunk => {
+            const bytes = Buffer.from(chunk);
+            if (size < 65536)
+                chunks.push(bytes.subarray(0, 65536 - size));
+            size += bytes.length;
         });
-    }
-}
-exports.AgentsUserClient = AgentsUserClient;
-exports.LingyaAgentsUserClient = AgentsUserClient;
-/** 不含凭证的 HTTP 错误。 / HTTP failure that never includes credentials. */
-class ApiError extends Error {
-    constructor(method, path, status, responseBody) {
-        super(`${method} ${path} returned HTTP ${status}`);
-        this.method = method;
-        this.path = path;
-        this.status = status;
-        this.responseBody = responseBody;
-        this.name = 'ApiError';
-    }
+        const fail = () => {
+            const id = response.headers['x-request-id'];
+            result.handshakeError = new lifecycle_1.ApiError('GET', '/stream/ws', response.statusCode, Buffer.concat(chunks).toString('utf8'), { kind: 'http', requestId: typeof id === 'string' ? id : undefined });
+            socket.terminate();
+        };
+        response.once('end', fail);
+        response.once('error', fail);
+        socket.once('close', () => response.destroy());
+    });
+    return result;
 }
-exports.ApiError = ApiError;
-exports.LingyaApiError = ApiError;