@xsai/shared-chat 0.0.22

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Moeru AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,107 @@
+import { CommonRequestOptions } from '@xsai/shared';
+
+type Part = AudioPart | ImagePart | RefusalPart | TextPart;
+interface CommonPart<T extends string> {
+    type: T;
+}
+interface ImagePart extends CommonPart<'image_url'> {
+    image_url: ImageURLorBase64;
+}
+interface ImageURLorBase64 {
+    /**
+     * Specifies the detail level of the image.
+     */
+    detail?: 'auto' | 'high' | 'low';
+    /**
+     * Either a URL of the image or the base64 encoded image data.
+     */
+    url: string;
+}
+interface AudioPart extends CommonPart<'input_audio'> {
+    input_audio: AudioBase64;
+}
+interface AudioBase64 {
+    /**
+     * Base64 encoded audio data.
+     */
+    data: string;
+    format: 'mp3' | 'wav';
+}
+interface RefusalPart extends CommonPart<'refusal'> {
+    refusal: string;
+}
+interface TextPart extends CommonPart<'text'> {
+    text: string;
+}
+
+type Optional<T, K extends keyof T> = Omit<T, K> & Pick<Partial<T>, K>;
+type Message = AssistantMessage | SystemMessage | ToolMessage | UserMessage;
+interface CommonMessage<T extends string, P extends Part> {
+    content: Array<P> | string;
+    name?: string;
+    role: T;
+}
+type SystemMessagePart = TextPart;
+interface SystemMessage extends CommonMessage<'system', SystemMessagePart> {
+}
+type UserMessagePart = AudioPart | ImagePart | TextPart;
+interface UserMessage extends CommonMessage<'user', UserMessagePart> {
+}
+type AssistantMessagePart = RefusalPart | TextPart;
+interface ToolCall {
+    function: {
+        arguments: string;
+        name: string;
+    };
+    id: string;
+    type: 'function';
+}
+interface AssistantMessage extends Optional<CommonMessage<'assistant', AssistantMessagePart>, 'content'> {
+    refusal?: null | string;
+    tool_calls?: ToolCall[];
+}
+interface AssistantMessageResponse extends Omit<AssistantMessage, 'content'> {
+    content?: string;
+}
+type ToolMessagePart = TextPart;
+interface ToolMessage extends Omit<CommonMessage<'tool', ToolMessagePart>, 'name'> {
+    tool_call_id: string;
+}
+
+type ToolChoice = 'auto' | 'none' | 'required' | {
+    function: {
+        name: string;
+    };
+    type: 'function';
+};
+
+interface ChatCompletionOptions extends CommonRequestOptions {
+    [key: string]: unknown;
+    messages: Message[];
+    toolChoice?: ToolChoice;
+}
+
+type FinishReason = 'content_filter' | 'error' | 'length' | 'other' | 'stop' | 'tool-calls' | ({} & string);
+
+interface Tool {
+    execute: (input: unknown) => Promise<string> | string;
+    function: {
+        description?: string;
+        name: string;
+        parameters: Record<string, unknown>;
+        strict?: boolean;
+    };
+    type: 'function';
+}
+
+declare const chatCompletion: <T extends ChatCompletionOptions>(options: T) => Promise<Response>;
+
+declare function messages(...messages: Message[]): Message[];
+declare function system<C extends string | SystemMessagePart[]>(content: C): SystemMessage;
+declare function user<C extends Array<UserMessagePart> | string>(content: C): UserMessage;
+declare function textPart(text: string): TextPart;
+declare function imagePart(url: string): ImagePart;
+declare function assistant<C extends AssistantMessagePart[] | string | ToolCall>(content: C): AssistantMessage;
+declare function tool<C extends string | ToolMessagePart[]>(content: C, toolCall: ToolCall): ToolMessage;
+
+export { type AssistantMessage, type AssistantMessagePart, type AssistantMessageResponse, type AudioBase64, type AudioPart, type ChatCompletionOptions, type CommonMessage, type CommonPart, type FinishReason, type ImagePart, type ImageURLorBase64, type Message, type Part, type RefusalPart, type SystemMessage, type SystemMessagePart, type TextPart, type Tool, type ToolCall, type ToolChoice, type ToolMessage, type ToolMessagePart, type UserMessage, type UserMessagePart, assistant, chatCompletion, imagePart, messages, system, textPart, tool, user };

package/dist/index.js

@@ -0,0 +1,49 @@
+import { requestBody, requestHeaders } from '@xsai/shared';
+
+const chatCompletion = async (options) => await (options.fetch ?? globalThis.fetch)(new URL("chat/completions", options.baseURL), {
+  body: requestBody({
+    ...options,
+    tools: options.tools?.map((tool) => ({
+      function: tool.function,
+      type: "function"
+    }))
+  }),
+  headers: requestHeaders({
+    "Content-Type": "application/json",
+    ...options.headers
+  }, options.apiKey),
+  method: "POST",
+  signal: options.abortSignal
+});
+
+function messages(...messages2) {
+  return messages2;
+}
+function system(content) {
+  return { content, role: "system" };
+}
+function user(content) {
+  return { content, role: "user" };
+}
+function textPart(text) {
+  return { text, type: "text" };
+}
+function imagePart(url) {
+  return { image_url: { url }, type: "image_url" };
+}
+function assistant(content) {
+  if (typeof content === "string")
+    return { content, role: "assistant" };
+  if (Array.isArray(content))
+    return { content, role: "assistant" };
+  return { role: "assistant", tool_calls: [content] };
+}
+function tool(content, toolCall) {
+  return {
+    content,
+    role: "tool",
+    tool_call_id: toolCall.id
+  };
+}
+
+export { assistant, chatCompletion, imagePart, messages, system, textPart, tool, user };

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@xsai/shared-chat",
+  "version": "0.0.22",
+  "type": "module",
+  "author": "Moeru AI",
+  "license": "MIT",
+  "homepage": "https://xsai.js.org",
+  "description": "extra-small AI SDK for Browser, Node.js, Deno, Bun or Edge Runtime.",
+  "keywords": [
+    "xsai",
+    "openai",
+    "ai"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moeru-ai/xsai.git",
+    "directory": "packages/shared-chat"
+  },
+  "bugs": "https://github.com/moeru-ai/xsai/issues",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@xsai/shared": ""
+  },
+  "scripts": {
+    "build": "pkgroll",
+    "build:watch": "pkgroll --watch"
+  }
+}