@opengeni/sdk 0.52.1 → 1.0.0

package/dist/chat/http.d.ts

@@ -0,0 +1,67 @@
+import type { OpenGeni } from "./opengeni.js";
+import { type ChatImportedMessage, type ChatOptions } from "./types.js";
+/** Internal HTTP plumbing shared by the native handler and the protocol adapters. */
+/**
+ * Header a client uses to name the conversation it is on. Every handler reads
+ * the client conversation as: the host's resolution, else this header, else
+ * the protocol's own field.
+ */
+export declare const CHAT_CONVERSATION_HEADER = "x-opengeni-conversation";
+/** What the host's auth hook returns: identity from the host, conversation optional per protocol. */
+export type ChatResolution = Omit<ChatOptions, "conversation"> & {
+    conversation?: string | undefined;
+};
+/**
+ * The host's authentication hook. It receives the raw request and returns the
+ * tenant/user/conversation the caller is allowed to use, or a `Response` to
+ * reject the request. Never derive tenant or user from the request body.
+ */
+export type ChatResolve = (request: Request) => Promise<ChatResolution | Response> | ChatResolution | Response;
+export type ChatErrorSummary = {
+    status: number;
+    code: string;
+    message: string;
+};
+export declare function jsonResponse(body: unknown, status?: number, headers?: HeadersInit): Response;
+export declare function errorResponse(status: number, message: string, code: string): Response;
+export declare function readJsonObject(request: Request): Promise<Record<string, unknown> | null>;
+export declare function resolveChatRequest(request: Request, resolve: ChatResolve): Promise<{
+    resolution: ChatResolution;
+    response?: undefined;
+} | {
+    response: Response;
+}>;
+/** The client-supplied conversation: the header, else the protocol's own field. */
+export declare function clientConversation(request: Request, protocolField: unknown): string | undefined;
+/**
+ * Open a chat from a resolution plus the conversation the client supplied.
+ * The host names the conversation, or the host names the user and the client
+ * conversation id is namespaced to that user; anything else is a 400, because
+ * an unscoped client id could address any conversation in the workspace.
+ */
+export declare function openResolvedChat(og: OpenGeni, resolution: ChatResolution, clientConversationId: string | undefined): Promise<{
+    chat: Awaited<ReturnType<OpenGeni["chat"]>>;
+    response?: undefined;
+} | {
+    response: Response;
+}>;
+export declare function chatErrorSummary(error: unknown): ChatErrorSummary;
+export declare function sseHeaders(extra?: Record<string, string>): Record<string, string>;
+export declare function sseLine(data: string, event?: string): string;
+/**
+ * Pull-based text-to-bytes stream over already-formatted SSE blocks. Upstream
+ * consumption follows downstream demand; cancelling fires `onCancel` so the
+ * producer can abort its OpenGeni stream.
+ */
+export declare function sseByteStream(blocks: AsyncIterable<string>, onCancel?: () => void): ReadableStream<Uint8Array>;
+/** Text from an OpenAI-style message content: a string or `[{ type, text }]` parts. */
+export declare function messageContentText(content: unknown, partTypes: string[]): string | null;
+/** The last user-role message's text from an OpenAI/Vercel-style `messages` array. */
+export declare function lastUserMessageText(messages: unknown, partTypes: string[], partsField: "parts" | "content"): string | null;
+/**
+ * Every user/assistant/system message before the last user message, as
+ * imported history for the first create. Items without a role or text
+ * (tool calls, files) are skipped.
+ */
+export declare function importedHistoryBefore(messages: unknown, partTypes: string[], partsField: "parts" | "content"): ChatImportedMessage[];
+export declare function unixSeconds(): number;

package/dist/chat/ids.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Deterministic chat identities. A conversation id maps to exactly one
+ * session id per workspace, so any process can address the same session
+ * without storing a mapping, and a double-submitted create collapses through
+ * the idempotency key. The optional legacy label argument is retained only to
+ * reproduce historical addresses. New chat calls do not use it: authorization
+ * is independent of addressing, so collaborators can share a conversation.
+ */
+/** The end-user label a conversation is namespaced to: the product `source` plus the opaque user id. */
+export type ChatUserLabel = {
+    source: string;
+    id: string;
+};
+/** Fixed RFC 4122 namespace for chat session ids. Never change it. */
+export declare const CHAT_SESSION_NAMESPACE = "7c1e6d3a-5b2f-4e8a-9d4c-0f3b6a8e2c17";
+/** RFC 4122 version 5 (SHA-1) UUID of `name` inside `namespace`. */
+export declare function uuidV5(name: string, namespace: string): Promise<string>;
+/**
+ * The session id of `conversation` in `workspaceId`: RFC 4122 v5 of the JSON
+ * tuple `[workspaceId, conversation]`, or `[workspaceId, source, id, conversation]`
+ * when the conversation belongs to an end user. JSON encoding keeps the tuple
+ * unambiguous: an id containing `:` or any other delimiter can never make two
+ * different (user, conversation) pairs share a session.
+ */
+export declare function chatSessionId(workspaceId: string, conversation: string, user?: ChatUserLabel | undefined): Promise<string>;
+/** The exact v5 name behind {@link chatSessionId}; exported for tests and audits. */
+export declare function chatIdentityName(workspaceId: string, conversation: string, user?: ChatUserLabel | undefined): string;
+/**
+ * The create idempotency key for a chat session: `chat:<sessionId>`. The
+ * session id already encodes the workspace, user label, and conversation as an
+ * unambiguous tuple, so the key inherits that and stays bounded.
+ */
+export declare function chatIdempotencyKey(sessionId: string): string;
+export declare function isUuid(value: string): boolean;

package/dist/chat/index.d.ts

@@ -0,0 +1,9 @@
+export type { Chats } from "../chats.js";
+export { OpenGeniSetupError } from "../errors.js";
+export { Chat, DEFAULT_CHAT_SOURCE, DEFAULT_OPENGENI_BASE_URL, IMPORTED_HISTORY_MAX_CHARS, OpenGeni, formatImportedHistory, } from "./opengeni.js";
+export { OpenGeniChatError, type ChatAgentAccess, type ChatChunk, type ChatImportedMessage, type ChatMemory, type ChatMessage, type ChatOptions, type ChatPending, type ChatReply, type ChatReplyStatus, type ChatRespondInput, type ChatSendOptions, type ChatSessionListOptions, type ChatSnapshot, type ChatTarget, type WorkspaceTarget, type ChatToolStatus, type OpenGeniOptions, } from "./types.js";
+export { CHAT_SESSION_NAMESPACE, chatIdempotencyKey, chatIdentityName, chatSessionId, uuidV5, type ChatUserLabel, } from "./ids.js";
+export { ChatTurnFold, approvalPending, humanInputPending, type ChatFoldStep, type ChatTurnTerminal, } from "./fold.js";
+export { CHAT_CONVERSATION_HEADER, CHAT_FORMAT_HEADER, chatChunksToSseBlocks, chatChunksToSseResponse, chatChunksToSseStream, createChatHandler, handleNativeChatRequest, handleNativeHistoryRequest, handleNativeRespondRequest, parseChatChunkStream, respondInputFromBody, type ChatHandlerFormat, type ChatHandlerOptions, type ChatResolution, type ChatResolve, } from "./handler.js";
+export { UI_MESSAGE_STREAM_HEADER, UI_MESSAGE_STREAM_VERSION, chatChunksToUIMessageStream, handleVercelChatRequest, lastUIMessageText, uiMessageStreamBlocks, uiMessageStreamParts, uiMessageStreamResponse, type UIMessageStreamOptions, } from "./vercel.js";
+export { chatCompletionBlocks, chatCompletionObject, decodeResponseId, encodeResponseId, handleChatCompletionsRequest, handleResponsesRequest, responsesBlocks, responsesInputText, } from "./openai.js";