ctod 1.0.7 → 1.1.1

package/lib/service/openai/chat.ts

@@ -1,11 +1,13 @@
 import { json } from 'power-helper'
 import { parseJSONStream } from '../../utils/json.js'
 import { OpenAICtodService } from './index.js'
+import { PolymorphicMessage } from '../../broker/chat.js'
 
 export type ChatGPTMessage = {
     role: 'system' | 'user' | 'assistant' | string
     name?: string
-    content: string
+    content?: string
+    contents?: PolymorphicMessage[]
 }
 
 type ApiResponse = {
@@ -194,6 +196,39 @@ export class OpenAIChat {
         this.openai = openai
     }
 
+    static toApiMessages(messages: ChatGPTMessage[]) {
+        return messages.map(message => {
+            const output = []
+            if (message.content) {
+                output.push({
+                    type: 'input_text',
+                    text: message.content
+                })
+            }
+            if (message.contents) {
+                for (const item of message.contents) {
+                    if (item.type === 'text') {
+                        output.push({
+                            type: 'input_text',
+                            text: item.content
+                        })
+                    } else if (item.type === 'image') {
+                        const url = item.content || ''
+                        output.push({
+                            type: 'input_image',
+                            image_url: url
+                        })
+                    }
+                }
+            }
+            return {
+                role: message.role,
+                name: message.name,
+                content: output
+            }
+        })
+    }
+
     /**
      * @zh 改變對話的一些設定
      * @en Change some settings of the conversation
@@ -242,7 +277,7 @@ export class OpenAIChat {
         }
         const result = await this.openai._axios.post<ApiResponse>(`${this.openai._baseUrl}/v1/responses`, {
             model: this.config.model,
-            input: newMessages,
+            input: OpenAIChat.toApiMessages(newMessages),
             temperature: this.config.temperature,
             max_output_tokens: this.config.maxTokens,
             reasoning: this.config.reasoning,
@@ -280,17 +315,20 @@ export class OpenAIChat {
     talkStream(params: {
         messages: any[]
         onMessage: (_message: string) => void
-        onEnd: () => void
+        onEnd: (_params: { isManualCancelled: boolean }) => void
         onError: (_error: any) => void
         onWarn?: (_warn: any) => void
         onThinking?: (_message: string) => void
     }) {
         let endFlag = false
+        let isManualCancelled = false
         const controller = new AbortController()
         const end = () => {
             if (endFlag) return
             endFlag = true
-            params.onEnd()
+            params.onEnd({
+                isManualCancelled
+            })
         }
         fetch(`${this.openai._baseUrl}/v1/responses`, {
             method: 'POST',
@@ -355,7 +393,11 @@ export class OpenAIChat {
             }
         })
         return {
-            cancel: () => controller.abort()
+            isManualCancelled: () => isManualCancelled,
+            cancel: () => {
+                isManualCancelled = true
+                controller.abort()
+            }
         }
     }
 

package/lib/service/x/chat.ts

@@ -1,11 +1,13 @@
 import { json } from 'power-helper'
 import { XCtodService } from './index.js'
 import { parseJSONStream } from '../../utils/json.js'
+import { PolymorphicMessage } from '../../broker/chat.js'
 
 export type XMessage = {
     role: 'system' | 'user' | 'assistant'
     name?: string
-    content: string
+    content?: string
+    contents?: PolymorphicMessage[]
 }
 
 type ApiResponse = {
@@ -190,6 +192,39 @@ export class XChat {
         maxTokens: undefined
     }
 
+    static toApiMessages(messages: XMessage[]) {
+        return messages.map(message => {
+            const output = []
+            if (message.content) {
+                output.push({
+                    type: 'input_text',
+                    text: message.content
+                })
+            }
+            if (message.contents) {
+                for (const item of message.contents) {
+                    if (item.type === 'text') {
+                        output.push({
+                            type: 'input_text',
+                            text: item.content
+                        })
+                    } else if (item.type === 'image') {
+                        const url = item.content || ''
+                        output.push({
+                            type: 'input_image',
+                            image_url: url
+                        })
+                    }
+                }
+            }
+            return {
+                role: message.role,
+                name: message.name,
+                content: output
+            }
+        })
+    }
+
     constructor(xAi: XCtodService) {
         this.xAi = xAi
     }
@@ -223,7 +258,7 @@ export class XChat {
         }
         const result = await this.xAi._axios.post<ApiResponse>('https://api.x.ai/v1/responses', {
             model: this.config.model,
-            input: newMessages,
+            input: XChat.toApiMessages(newMessages),
             temperature: this.config.temperature,
             max_output_tokens: this.config.maxTokens,
             reasoning: this.config.reasoning,
@@ -261,17 +296,20 @@ export class XChat {
     talkStream(params: {
         messages: any[]
         onMessage: (_message: string) => void
-        onEnd: () => void
+        onEnd: (_params: { isManualCancelled: boolean }) => void
         onWarn?: (_warn: any) => void
         onThinking?: (_message: string) => void
         onError: (_error: any) => void
     }) {
         let endFlag = false
+        let isManualCancelled = false
         const controller = new AbortController()
         const end = () => {
             if (endFlag) return
             endFlag = true
-            params.onEnd()
+            params.onEnd({
+                isManualCancelled
+            })
         }
         fetch('https://api.x.ai/v1/responses', {
             method: 'POST',
@@ -336,7 +374,11 @@ export class XChat {
             }
         })
         return {
-            cancel: () => controller.abort()
+            isManualCancelled: () => isManualCancelled,
+            cancel: () => {
+                isManualCancelled = true
+                controller.abort()
+            }
         }
     }
 

package/lib/utils/paragraph.ts

@@ -0,0 +1,10 @@
+/**
+ * @zh 將陣列的多行文字合併為一個字串。
+ * @en Join multiple lines of text from an array into a single string.
+ */
+export const paragraph = (texts: string | string[]): string => {
+    if (typeof texts === 'string') {
+        return texts
+    }
+    return texts.join('\n')
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ctod",
-  "version": "1.0.7",
+  "version": "1.1.1",
   "description": "CtoD Is Chat To Data Utils.",
   "main": "./dist/index.js",
   "type": "module",
@@ -62,6 +62,6 @@
     "json5": "^2.2.3",
     "opencc-js": "^1.0.5",
     "power-helper": "^0.9.0",
-    "zod": "^4.1.12"
+    "zod": "^4.3.6"
   }
 }

package/types/lib/broker/chat.d.ts

@@ -3,10 +3,16 @@ import { Event, Hook, Log } from 'power-helper';
 import { Translator, TranslatorParams } from '../core/translator.js';
 import { ValidateCallback, ValidateCallbackOutputs } from '../utils/validate.js';
 import { z } from 'zod';
+import { CtoD } from '../ctod.js';
+export type PolymorphicMessage = {
+    type: 'text' | 'image';
+    content: string;
+};
 export type Message = {
     role: 'system' | 'user' | 'assistant' | (string & Record<string, unknown>);
     name?: string;
-    content: string;
+    content?: string;
+    contents?: PolymorphicMessage[];
 };
 export type ChatBrokerHooks<S extends ValidateCallback<any>, O extends ValidateCallback<any>, P extends ChatBrokerPlugin<any, any>, PS extends Record<string, ReturnType<P['use']>>> = {
     /**
@@ -28,7 +34,9 @@ export type ChatBrokerHooks<S extends ValidateCallback<any>, O extends ValidateC
         };
         messages: Message[];
         setPreMessages: (messages: (Omit<Message, 'content'> & {
-            content: string | string[];
+            content?: string | string[];
+        } & {
+            contents?: PolymorphicMessage[];
         })[]) => void;
         changeMessages: (messages: Message[]) => void;
         changeOutputSchema: (output: O) => void;
@@ -140,6 +148,7 @@ export declare class ChatBroker<S extends ValidateCallback<any>, O extends Valid
     constructor(params: Params<S, O, C, P, PS>);
     protected _install(): any;
     cancel(requestId?: string): Promise<void>;
+    cloneFrom(ctod: CtoD<any, any>): ChatBroker<S, O, P, PS, C>;
     requestWithId<T extends Translator<S, O>>(data: T['__schemeType']): {
         id: string;
         request: Promise<T['__outputType']>;
@@ -157,7 +166,9 @@ export declare class ChatBroker<S extends ValidateCallback<any>, O extends Valid
         outputSchema: {
             [x: string]: any;
         };
-        outputJsonSchema: z.core.JSONSchema.JSONSchema;
+        outputJsonSchema: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
+            [x: string]: any;
+        }, z.core.$strip>>;
         requestMessages: Message[];
     }>;
 }

package/types/lib/ctod.d.ts

@@ -1,4 +1,4 @@
-import { ChatBroker, Message, Params as ChatBrokerParams, ChatBrokerHooks, RequestContext } from './broker/chat.js';
+import { PolymorphicMessage, ChatBroker, Message, Params as ChatBrokerParams, ChatBrokerHooks, RequestContext } from './broker/chat.js';
 import { ChatBrokerPlugin } from './core/plugin.js';
 import * as z from 'zod';
 type IO = any;
@@ -22,7 +22,9 @@ export declare class CtoD<P extends ChatBrokerPlugin<IO, IO>, PS extends Record<
                 send: (data: PS[K]["__receiveData"]) => void;
             }; };
             setMessages: (messages: (Omit<Message, "content"> & {
-                content: string | string[];
+                content?: string | string[];
+            } & {
+                contents?: PolymorphicMessage[];
             })[]) => void;
             metadata: Map<string, any>;
         }) => Promise<O>) => ChatBroker<() => I, () => O, P, PS, ChatBrokerHooks<() => I, () => O, P, PS>>;

package/types/lib/index.d.ts

@@ -4,6 +4,7 @@ export * as chineseConverter from './utils/chinese-conv.js';
 export { CtoD } from './ctod.js';
 export { validateToJsonSchema } from './utils/validate.js';
 export { parseJSONStream } from './utils/json.js';
+export { paragraph } from './utils/paragraph.js';
 export { OpenAICtodService } from './service/openai/index.js';
 export { LlamaCppCtodService } from './service/llama-cpp/index.js';
 export { GoogleCtodService } from './service/google/index.js';
@@ -18,3 +19,4 @@ export { Translator } from './core/translator.js';
 export type { ValidateCallback } from './utils/validate.js';
 export type { TranslatorParams } from './core/translator.js';
 export type { ChatGPTMessage } from './service/openai/chat.js';
+export type { PolymorphicMessage } from './broker/chat.js';

package/types/lib/service/anthropic/chat.d.ts

@@ -1,8 +1,10 @@
 import { AnthropicCtodService } from './index.js';
+import { PolymorphicMessage } from '../../broker/chat.js';
 type AnthropicSdk = AnthropicCtodService['anthropicSdk'];
 export type Message = {
     role: string;
-    content: string;
+    content?: string;
+    contents?: PolymorphicMessage[];
 };
 export type Config = {
     /**
@@ -76,9 +78,12 @@ export declare class AnthropicChat {
         messages: Message[];
         onMessage: (_message: string) => void;
         onThinking?: (_thinking: string) => void;
-        onEnd: () => void;
+        onEnd: (_params: {
+            isManualCancelled: boolean;
+        }) => void;
         onError: (_error: any) => void;
     }): {
+        isManualCancelled: () => boolean;
         cancel: () => void;
     };
 }

package/types/lib/service/google/chat.d.ts

@@ -11,6 +11,10 @@ type Part = {
         data: string;
         mimeType: string;
     };
+} | {
+    fileData: {
+        fileUri: string;
+    };
 };
 export type GoogleMessage = {
     role: 'model' | 'user';
@@ -67,10 +71,13 @@ export declare class GoogleChat {
         system?: string;
         messages: GoogleMessage[];
         onMessage: (_message: string) => void;
-        onEnd: () => void;
+        onEnd: (_params: {
+            isManualCancelled: boolean;
+        }) => void;
         onThinking?: (_thinking: string) => void;
         onError: (_error: any) => void;
     }): {
+        isManualCancelled: () => boolean;
         cancel: () => void;
     };
 }

package/types/lib/service/google/index.d.ts

@@ -2,9 +2,9 @@ import { GoogleMessage, GoogleChat, Config } from './chat.js';
 import { GoogleImagesGeneration } from './images-generation.js';
 import type { GoogleGenAI } from '@google/genai';
 type GPTContent = {
-    type: 'image_url' | 'text';
+    type: 'image_url' | 'text' | 'input_text' | 'input_image';
     text?: string;
-    image_url?: {
+    image_url?: string | {
         url: string;
         detail?: string;
     };

package/types/lib/service/llama-cpp/completion.d.ts

@@ -1,7 +1,9 @@
 import { LlamaCppCtodService } from './index.js';
+import { PolymorphicMessage } from '../../broker/chat.js';
 type Message = {
     role: string;
-    content: string;
+    content?: string;
+    contents?: PolymorphicMessage[];
 };
 type Options = any;
 export type Config = {
@@ -11,7 +13,9 @@ export type Config = {
 };
 type Stream = {
     onMessage: (message: string) => void;
-    onEnd?: () => void;
+    onEnd?: (params: {
+        isManualCancelled: boolean;
+    }) => void;
     onWarn?: (error: any) => void;
     onError?: (error: any) => void;
 };

package/types/lib/service/openai/chat.d.ts

@@ -1,8 +1,10 @@
 import { OpenAICtodService } from './index.js';
+import { PolymorphicMessage } from '../../broker/chat.js';
 export type ChatGPTMessage = {
     role: 'system' | 'user' | 'assistant' | string;
     name?: string;
-    content: string;
+    content?: string;
+    contents?: PolymorphicMessage[];
 };
 type ApiResponse = {
     id: string;
@@ -90,6 +92,19 @@ export declare class OpenAIChat {
     openai: OpenAICtodService;
     config: Config;
     constructor(openai: OpenAICtodService);
+    static toApiMessages(messages: ChatGPTMessage[]): {
+        role: string;
+        name: string | undefined;
+        content: ({
+            type: string;
+            text: string;
+            image_url?: undefined;
+        } | {
+            type: string;
+            image_url: string;
+            text?: undefined;
+        })[];
+    }[];
     /**
      * @zh 改變對話的一些設定
      * @en Change some settings of the conversation
@@ -120,11 +135,14 @@ export declare class OpenAIChat {
     talkStream(params: {
         messages: any[];
         onMessage: (_message: string) => void;
-        onEnd: () => void;
+        onEnd: (_params: {
+            isManualCancelled: boolean;
+        }) => void;
         onError: (_error: any) => void;
         onWarn?: (_warn: any) => void;
         onThinking?: (_message: string) => void;
     }): {
+        isManualCancelled: () => boolean;
         cancel: () => void;
     };
     /**

package/types/lib/service/x/chat.d.ts

@@ -1,8 +1,10 @@
 import { XCtodService } from './index.js';
+import { PolymorphicMessage } from '../../broker/chat.js';
 export type XMessage = {
     role: 'system' | 'user' | 'assistant';
     name?: string;
-    content: string;
+    content?: string;
+    contents?: PolymorphicMessage[];
 };
 type ApiResponse = {
     id: string;
@@ -89,6 +91,19 @@ export type Config = {
 export declare class XChat {
     xAi: XCtodService;
     config: Config;
+    static toApiMessages(messages: XMessage[]): {
+        role: "system" | "user" | "assistant";
+        name: string | undefined;
+        content: ({
+            type: string;
+            text: string;
+            image_url?: undefined;
+        } | {
+            type: string;
+            image_url: string;
+            text?: undefined;
+        })[];
+    }[];
     constructor(xAi: XCtodService);
     /**
      * @zh 改變對話的一些設定
@@ -113,11 +128,14 @@ export declare class XChat {
     talkStream(params: {
         messages: any[];
         onMessage: (_message: string) => void;
-        onEnd: () => void;
+        onEnd: (_params: {
+            isManualCancelled: boolean;
+        }) => void;
         onWarn?: (_warn: any) => void;
         onThinking?: (_message: string) => void;
         onError: (_error: any) => void;
     }): {
+        isManualCancelled: () => boolean;
         cancel: () => void;
     };
     /**

package/types/lib/utils/paragraph.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @zh 將陣列的多行文字合併為一個字串。
+ * @en Join multiple lines of text from an array into a single string.
+ */
+export declare const paragraph: (texts: string | string[]) => string;

package/types/lib/utils/validate.d.ts

@@ -7,4 +7,4 @@ export type ValidateCallbackOutputs<T extends ValidateCallback<any>, R = ReturnT
 };
 export declare function definedValidateSchema<T extends ValidateCallback<any>>(cb: T): T;
 export declare function validate<T extends ValidateCallback<any>, R = ReturnType<T>>(target: any, schemaCallback: T): { [K in keyof R]: R[K] extends z.ZodTypeAny ? z.infer<R[K]> : R[K]; };
-export declare function validateToJsonSchema<T extends ValidateCallback<any>>(target: () => T): z.core.JSONSchema.JSONSchema;
+export declare function validateToJsonSchema<T extends ValidateCallback<any>>(target: () => T): z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{ -readonly [P in keyof T]: T[P]; }, z.core.$strip>>;