feat: add workflows app_id (#40)

* feat: add worksflow app_id

* fix: improve type safety

---------

Co-authored-by: fengguocai <[email protected]>

Author: gcfeng

packages/coze-js/src/core.ts

@@ -1,5 +1,9 @@
 /* eslint-disable max-params */
-import { type AxiosRequestConfig, type AxiosResponseHeaders } from 'axios';
+import {
+  type AxiosRequestConfig,
+  type AxiosResponseHeaders,
+  type AxiosInstance,
+} from 'axios';
 
 import { getNodeClientUserAgent, getUserAgent } from './version.js';
 import { isBrowser, isPersonalAccessToken, mergeConfig } from './utils.js';
@@ -11,18 +15,21 @@ import { COZE_COM_BASE_URL } from './constant.js';
 export type RequestOptions = Omit<
   AxiosRequestConfig,
   'url' | 'method' | 'baseURL' | 'data' | 'responseType'
->;
+> &
+  Record<string, unknown>;
 export interface ClientOptions {
   /** baseURL, default is https://api.coze.com, Use https://api.coze.cn if you use https://coze.cn */
   baseURL?: string;
   /** Personal Access Token (PAT) or OAuth2.0 token */
   token: string;
   /** see https://github.com/axios/axios?tab=readme-ov-file#request-config */
   axiosOptions?: RequestOptions;
+  /** Custom axios instance */
+  axiosInstance?: AxiosInstance | unknown;
   /** Whether to enable debug mode */
   debug?: boolean;
   /** Custom headers */
-  headers?: Headers | undefined;
+  headers?: Headers | Record<string, unknown>;
   /** Whether Personal Access Tokens (PAT) are allowed in browser environments */
   allowPersonalAccessTokenInBrowser?: boolean;
 }
@@ -32,15 +39,17 @@ export class APIClient {
   baseURL: string;
   token: string;
   axiosOptions?: RequestOptions;
+  axiosInstance?: AxiosInstance | unknown;
   debug: boolean;
   allowPersonalAccessTokenInBrowser: boolean;
-  headers?: Headers;
+  headers?: Headers | Record<string, unknown>;
 
   constructor(config: ClientOptions) {
     this._config = config;
     this.baseURL = config.baseURL || COZE_COM_BASE_URL;
     this.token = config.token;
     this.axiosOptions = config.axiosOptions || {};
+    this.axiosInstance = config.axiosInstance;
     this.debug = config.debug || false;
     this.allowPersonalAccessTokenInBrowser =
       config.allowPersonalAccessTokenInBrowser || false;
@@ -101,6 +110,7 @@ export class APIClient {
 
     const fetchOptions = this.buildOptions(method, body, options);
     fetchOptions.isStreaming = isStream;
+    fetchOptions.axiosInstance = this.axiosInstance;
 
     this.debugLog(`--- request url: ${fullUrl}`);
     this.debugLog('--- request options:', fetchOptions);
@@ -110,7 +120,9 @@ export class APIClient {
     this.debugLog(`--- response status: ${response.status}`);
     this.debugLog('--- response headers: ', response.headers);
 
-    const contentType = response.headers['content-type'];
+    // Taro use `header`
+    const contentType = (response.headers ??
+      (response as unknown as Record<string, string>).header)['content-type'];
 
     if (isStream) {
       if (contentType && contentType.includes('application/json')) {

packages/coze-js/src/fetcher.ts

@@ -4,6 +4,8 @@ import axios, {
   type AxiosResponseHeaders,
   type AxiosRequestConfig,
   type AxiosResponse,
+  type AxiosInstance,
+  type AxiosStatic,
 } from 'axios';
 
 import {
@@ -16,7 +18,7 @@ import {
 
 export interface FetchAPIOptions extends AxiosRequestConfig {
   // Custom axios instance
-  axiosInstance?: typeof axios;
+  axiosInstance?: AxiosInstance | unknown;
   // Whether to use streaming mode
   isStreaming?: boolean;
 }
@@ -55,7 +57,7 @@ export async function fetchAPI<ResultType>(
   const axiosInstance = options.axiosInstance || axios;
 
   // Add version check for streaming requests
-  if (options.isStreaming) {
+  if (options.isStreaming && isAxiosStatic(axiosInstance)) {
     const axiosVersion = axiosInstance.VERSION || axios.VERSION;
     if (!axiosVersion || compareVersions(axiosVersion, '1.7.1') < 0) {
       throw new CozeError(
@@ -64,7 +66,7 @@ export async function fetchAPI<ResultType>(
     }
   }
 
-  const response: AxiosResponse = await axiosInstance({
+  const response: AxiosResponse = await (axiosInstance as AxiosInstance)({
     url,
     responseType: options.isStreaming ? 'stream' : 'json',
     adapter: options.isStreaming ? 'fetch' : undefined,
@@ -77,12 +79,16 @@ export async function fetchAPI<ResultType>(
     async *stream(): AsyncGenerator<ResultType> {
       try {
         const stream = response.data;
-        const reader = stream[Symbol.asyncIterator]();
+        const reader = stream[Symbol.asyncIterator]
+          ? stream[Symbol.asyncIterator]()
+          : stream.getReader();
         const decoder = new TextDecoder();
         const fieldValues: Record<string, string> = {};
         let buffer = '';
         while (true) {
-          const { done, value } = await reader.next();
+          const { done, value } = await (reader.next
+            ? reader.next()
+            : reader.read());
           if (done) {
             if (buffer) {
               // If the stream ends without a newline, it means an error occurred
@@ -135,3 +141,7 @@ function compareVersions(v1: string, v2: string): number {
   }
   return 0;
 }
+
+function isAxiosStatic(instance: unknown): instance is AxiosStatic {
+  return !!(instance as AxiosStatic)?.Axios;
+}

packages/coze-js/src/index.ts

@@ -11,6 +11,7 @@ export class CozeAPI extends APIClient {
   workspaces: API.WorkSpaces = new API.WorkSpaces(this);
   audio: API.Audio = new API.Audio(this);
 }
+export { type ClientOptions, type RequestOptions } from './core.js';
 export * from './auth.js';
 export * from './resources/index.js';
 export * from './fetcher.js';

packages/coze-js/src/resources/workflows/runs/runs.ts

@@ -11,6 +11,9 @@ export class Runs extends APIResource {
    * @param params.bot_id - Optional The ID of the bot associated with the workflow. | 可选 与工作流关联的机器人 ID。
    * @param params.parameters - Optional Parameters for the workflow execution. | 可选 工作流执行的参数。
    * @param params.ext - Optional Additional information for the workflow execution. | 可选 工作流执行的附加信息。
+   * @param params.execute_mode - Optional The mode in which to execute the workflow. | 可选 工作流执行的模式。
+   * @param params.connector_id - Optional The ID of the connector to use for the workflow. | 可选 用于工作流的连接器 ID。
+   * @param params.app_id - Optional The ID of the app.  | 可选 要进行会话聊天的 App ID
    * @returns RunWorkflowData | 工作流运行数据
    */
   async create(params: RunWorkflowReq, options?: RequestOptions) {
@@ -31,6 +34,9 @@ export class Runs extends APIResource {
    * @param params.bot_id - Optional The ID of the bot associated with the workflow. | 可选 与工作流关联的机器人 ID。
    * @param params.parameters - Optional Parameters for the workflow execution. | 可选 工作流执行的参数。
    * @param params.ext - Optional Additional information for the workflow execution. | 可选 工作流执行的附加信息。
+   * @param params.execute_mode - Optional The mode in which to execute the workflow. | 可选 工作流执行的模式。
+   * @param params.connector_id - Optional The ID of the connector to use for the workflow. | 可选 用于工作流的连接器 ID。
+   * @param params.app_id - Optional The ID of the app.  | 可选 要进行会话聊天的 App ID
    * @returns Stream<WorkflowEvent, { id: string; event: string; data: string }> | 工作流事件流
    */
   async *stream(params: RunWorkflowReq, options?: RequestOptions) {
@@ -68,7 +74,6 @@ export class Runs extends APIResource {
    * @param params.interrupt_type - Required The type of interruption to resume from. | 必选 要恢复的中断类型。
    * @returns { id: string; event: WorkflowEventType; data: WorkflowEventMessage | WorkflowEventInterrupt | WorkflowEventError | null } | 恢复的工作流事件数据
    */
-
   async resume(params: ResumeWorkflowReq, options?: RequestOptions) {
     const apiUrl = '/v1/workflow/stream_resume';
     const response = await this._client.post<
@@ -92,6 +97,9 @@ export interface RunWorkflowReq {
   bot_id?: string;
   parameters?: Record<string, unknown>;
   ext?: Record<string, string>;
+  execute_mode?: string;
+  connector_id?: string;
+  app_id?: string;
 }
 
 export interface RunWorkflowData {