apaas-oapi-client 0.1.37 → 0.1.38

package/dist/src/index.d.ts

@@ -1,674 +0,0 @@
-import { LoggerLevel } from './logger';
-/**
- * 批量操作结果
- */
-interface BatchResult<T> {
-    /** 成功的项 */
-    success: T[];
-    /** 失败的项 */
-    failed: Array<{
-        id: string;
-        error: string;
-    }>;
-    /** 成功数量 */
-    successCount: number;
-    /** 失败数量 */
-    failedCount: number;
-    /** 总数 */
-    total: number;
-}
-/**
- * 重试配置
- */
-interface RetryOptions {
-    /** 最大重试次数 */
-    maxRetries?: number;
-    /** 初始延迟时间(ms) */
-    initialDelay?: number;
-    /** 最大延迟时间(ms) */
-    maxDelay?: number;
-    /** 延迟倍数 */
-    backoffMultiplier?: number;
-}
-/**
- * Client 初始化配置
- */
-interface ClientOptions {
-    /** 命名空间, 例如 app_xxx */
-    namespace: string;
-    /** 应用 clientId */
-    clientId: string;
-    /** 应用 clientSecret */
-    clientSecret: string;
-    /** 是否禁用 token 缓存, 每次调用强制刷新 token, 默认 false */
-    disableTokenCache?: boolean;
-}
-/**
- * aPaaS OpenAPI 客户端
- */
-declare class Client {
-    private clientId;
-    private clientSecret;
-    private namespace;
-    private disableTokenCache;
-    private accessToken;
-    private expireTime;
-    private axiosInstance;
-    private loggerLevel;
-    /**
-     * 构造函数
-     * @param options ClientOptions
-     */
-    constructor(options: ClientOptions);
-    /**
-     * 设置日志等级
-     * @param level LoggerLevel
-     */
-    setLoggerLevel(level: LoggerLevel): void;
-    /**
-     * 日志打印方法
-     * @param level LoggerLevel
-     * @param args 打印内容
-     */
-    private log;
-    /**
-     * 初始化 client, 自动获取 token
-     */
-    init(): Promise<void>;
-    /**
-     * 获取 accessToken
-     */
-    private getAccessToken;
-    /**
-     * 确保 token 有效, 若过期则刷新
-     */
-    private ensureTokenValid;
-    /**
-     * 获取当前 accessToken
-     */
-    get token(): string | null;
-    /**
-     * 获取当前 token 剩余过期时间（单位：秒）
-     * @returns 剩余秒数，若无 token 则返回 null
-     */
-    get tokenExpireTime(): number | null;
-    /**
-     * 获取当前 namespace
-     */
-    get currentNamespace(): string;
-    /**
-     * 对象模块
-     */
-    object: {
-        /**
-         * 列出所有对象（数据表）
-         * @param params 请求参数 { offset?, filter?, limit? }
-         * @returns 接口返回结果 { code, items, total, msg, has_more }
-         */
-        list: (params?: {
-            offset?: number;
-            filter?: {
-                type?: string;
-                quickQuery?: string;
-            };
-            limit?: number;
-        }) => Promise<any>;
-        /**
-         * 列出所有对象（数据表）- 支持自动分页查询
-         * @description 该方法会自动处理分页，直到没有更多数据为止
-         * @param params 请求参数 { filter?, limit? }
-         * @returns { code, msg, items, total, failed? } - code 表示失败的分页数量
-         */
-        listWithIterator: (params?: {
-            filter?: {
-                type?: string;
-                quickQuery?: string;
-            };
-            limit?: number;
-        }) => Promise<{
-            code: string;
-            msg: string;
-            items: any[];
-            total: number;
-            failed?: Array<{
-                offset: number;
-                limit: number;
-                code: string;
-                msg: string;
-            }>;
-        }>;
-        metadata: {
-            /**
-             * 获取指定对象下指定字段的元数据
-             * @description 查询指定对象下的单个字段元数据
-             * @param params 请求参数 { object_name, field_name }
-             * @returns 接口返回结果
-             */
-            field: (params: {
-                object_name: string;
-                field_name: string;
-            }) => Promise<any>;
-            /**
-             * 获取指定对象的所有字段信息
-             * @description 查询指定对象下的所有字段元数据
-             * @param params 请求参数 { object_name }
-             * @returns 接口返回结果
-             */
-            fields: (params: {
-                object_name: string;
-            }) => Promise<any>;
-            /**
-             * 导出数据对象元数据为 Markdown 文档
-             * @description 将数据对象的字段信息导出为详细的 Markdown 文档，包含字段类型、配置、选项等完整信息
-             * @param options 导出配置
-             * @param options.object_names 可选，要导出的对象名称数组。如果不传，则导出所有对象
-             * @returns Markdown 文档字符串
-             * @example
-             * ```typescript
-             * // 导出所有对象
-             * const markdown = await client.object.metadata.export2markdown();
-             *
-             * // 只导出指定对象
-             * const markdown = await client.object.metadata.export2markdown({
-             *   object_names: ['object_store', 'object_order', '_user']
-             * });
-             *
-             * // 结合 listWithIterator 使用
-             * const allObjects = await client.object.listWithIterator();
-             * const objectNames = allObjects.items.map(obj => obj.apiName);
-             * const markdown = await client.object.metadata.export2markdown({
-             *   object_names: objectNames
-             * });
-             *
-             * // 保存到文件
-             * fs.writeFileSync('objects_doc.md', markdown, 'utf-8');
-             * ```
-             */
-            export2markdown: (options?: {
-                object_names?: string[];
-            }) => Promise<string>;
-        };
-        search: {
-            /**
-             * 单条记录查询
-             * @description 查询指定对象下的单条记录
-             * @param params 请求参数
-             * @returns 接口返回结果
-             */
-            record: (params: {
-                object_name: string;
-                record_id: string;
-                select: string[];
-            }) => Promise<any>;
-            /**
-             * 多条记录查询 - 最多传入 100 条
-             * @description 查询指定对象下的多条记录
-             * @param params 请求参数
-             * @returns 接口返回结果
-             */
-            records: (params: {
-                object_name: string;
-                data: any;
-            }) => Promise<any>;
-            /**
-             * 查询所有记录 - 支持超过 100 条数据，自动分页查询
-             * @description 该方法会自动处理分页，直到没有更多数据为止
-             * @param params 请求参数
-             * @returns { total, items }
-             */
-            recordsWithIterator: (params: {
-                object_name: string;
-                data: any;
-            }) => Promise<{
-                total: number;
-                items: any[];
-            }>;
-            /**
-             * 统计记录数量
-             * @description 统计指定对象中的记录总数，支持按条件统计
-             * @param params 请求参数 { object_name, data? }
-             * @returns 接口返回结果 { code, total, msg }
-             */
-            count: (params: {
-                object_name: string;
-                data?: any;
-            }) => Promise<any>;
-        };
-        create: {
-            /**
-             * 单条记录创建
-             * @description 创建单条记录到指定对象中
-             * @param params 请求参数 { object_name, record }
-             * @returns 接口返回结果
-             */
-            record: (params: {
-                object_name: string;
-                record: any;
-            }) => Promise<any>;
-            /**
-             * 批量创建记录 - 最多传入 100 条
-             * @description 创建多条记录到指定对象中
-             * @param params 请求参数 { object_name, records }
-             * @returns 接口返回结果
-             */
-            records: (params: {
-                object_name: string;
-                records: any[];
-            }) => Promise<any>;
-            /**
-             * 分批创建所有记录 - 支持超过 100 条数据，自动拆分
-             * @description 创建多条记录到指定对象中，超过 100 条数据会自动拆分为多次请求
-             * @param params 请求参数 { object_name, records, limit }
-             * @returns { total, success, failed, successCount, failedCount }
-             */
-            recordsWithIterator: (params: {
-                object_name: string;
-                records: any[];
-                limit?: number;
-            }) => Promise<{
-                total: number;
-                success: Array<{
-                    _id: string;
-                    success: true;
-                }>;
-                failed: Array<{
-                    _id: string;
-                    success: false;
-                    error?: string;
-                }>;
-                successCount: number;
-                failedCount: number;
-            }>;
-        };
-        update: {
-            /**
-             * 单条更新
-             * @description 更新指定对象下的单条记录
-             * @param params 请求参数
-             * @returns 接口返回结果
-             */
-            record: (params: {
-                object_name: string;
-                record_id: string;
-                record: any;
-            }) => Promise<any>;
-            /**
-             * 多条更新 - 最多传入 100 条
-             * @description 更新指定对象下的多条记录
-             * @param params 请求参数
-             * @returns 接口返回结果
-             */
-            records: (params: {
-                object_name: string;
-                records: any[];
-            }) => Promise<any>;
-            /**
-             * 批量更新 - 支持超过 100 条数据，自动拆分
-             * @description 更新指定对象下的多条记录，超过 100 条数据会自动拆分为多次请求
-             * @param params 请求参数，包含 object_name, records, limit
-             * @returns { total, success, failed, successCount, failedCount }
-             */
-            recordsWithIterator: (params: {
-                object_name: string;
-                records: any[];
-                limit?: number;
-            }) => Promise<{
-                total: number;
-                success: Array<{
-                    _id: string;
-                    success: true;
-                }>;
-                failed: Array<{
-                    _id: string;
-                    success: false;
-                    error?: string;
-                }>;
-                successCount: number;
-                failedCount: number;
-            }>;
-        };
-        delete: {
-            /**
-             * 单条删除
-             * @description 删除指定对象下的单条记录
-             * @param params 请求参数，包含 object_name 和 record_id
-             * @returns 接口返回结果
-             */
-            record: (params: {
-                object_name: string;
-                record_id: string;
-            }) => Promise<any>;
-            /**
-             * 多条删除 - 最多传入 100 条
-             * @description 删除指定对象下的多条记录
-             * @param params 请求参数，包含 object_name 和 ids 数组
-             * @returns 接口返回结果
-             */
-            records: (params: {
-                object_name: string;
-                ids: string[];
-            }) => Promise<any>;
-            /**
-             * 批量删除
-             * @description 删除指定对象下的多条记录，超过 100 条数据会自动拆分为多次请求
-             * @param params 请求参数，包含 object_name, ids 数组 和 可选的 limit
-             * @returns { total, success, failed, successCount, failedCount }
-             */
-            recordsWithIterator: (params: {
-                object_name: string;
-                ids: string[];
-                limit?: number;
-            }) => Promise<{
-                total: number;
-                success: Array<{
-                    _id: string;
-                    success: true;
-                }>;
-                failed: Array<{
-                    _id: string;
-                    success: false;
-                    error?: string;
-                }>;
-                successCount: number;
-                failedCount: number;
-            }>;
-        };
-    };
-    /**
-     * 部门 ID 交换模块
-     */
-    department: {
-        /**
-         * 单个部门 ID 交换
-         * @param params 请求参数
-         * @returns 单个部门映射结果
-         */
-        exchange: (params: {
-            department_id_type: "department_id" | "external_department_id" | "external_open_department_id";
-            department_id: string;
-        }) => Promise<any>;
-        /**
-         * 批量部门 ID 交换
-         * @param params 请求参数
-         * @returns 批量操作结果，包含成功和失败的详细信息
-         */
-        batchExchange: (params: {
-            department_id_type: "department_id" | "external_department_id" | "external_open_department_id";
-            department_ids: string[];
-            retryOptions?: RetryOptions;
-        }) => Promise<BatchResult<any>>;
-    };
-    /**
-     * 用户 ID 交换模块
-     */
-    user: {
-        /**
-         * 单个用户 ID 交换
-         * @param params 请求参数
-         * @returns 单个用户映射结果
-         */
-        exchange: (params: {
-            user_id_type: "user_id" | "external_user_id" | "external_open_id";
-            user_id: string;
-            feishu_app_id: string;
-        }) => Promise<any>;
-        /**
-         * 批量用户 ID 交换
-         * @param params 请求参数
-         * @returns 批量操作结果，包含成功和失败的详细信息
-         */
-        batchExchange: (params: {
-            user_id_type: "user_id" | "external_user_id" | "external_open_id";
-            user_ids: string[];
-            feishu_app_id: string;
-            retryOptions?: RetryOptions;
-        }) => Promise<BatchResult<any>>;
-    };
-    /**
-     * 云函数模块
-     */
-    function: {
-        /**
-         * 调用云函数
-         * @param params 请求参数 { name: string; params: any }
-         * @returns 接口返回结果
-         */
-        invoke: (params: {
-            name: string;
-            params: any;
-        }) => Promise<any>;
-    };
-    /**
-     * 页面模块
-     */
-    page: {
-        /**
-         * 获取所有页面
-         * @param params 请求参数 { limit: number (max 200), offset: number }
-         * @returns 接口返回结果
-         */
-        list: (params: {
-            limit: number;
-            offset: number;
-        }) => Promise<any>;
-        /**
-         * 获取所有页面 - 支持自动分页，获取全部数据
-         * @description 该方法会自动处理分页，直到获取所有页面数据
-         * @param params 请求参数 { limit?: number }
-         * @returns { total, items }
-         */
-        listWithIterator: (params?: {
-            limit?: number;
-        }) => Promise<{
-            total: number;
-            items: any[];
-        }>;
-        /**
-         * 获取页面详情
-         * @param params 请求参数 { page_id: string }
-         * @returns 接口返回结果
-         */
-        detail: (params: {
-            page_id: string;
-        }) => Promise<any>;
-        /**
-         * 获取页面访问地址
-         * @param params 请求参数 { page_id: string, pageParams?: any, parentPageParams?: any, navId?: string, tabId?: string }
-         * @returns 接口返回结果
-         */
-        url: (params: {
-            page_id: string;
-            pageParams?: any;
-            parentPageParams?: any;
-            navId?: string;
-            tabId?: string;
-        }) => Promise<any>;
-    };
-    /**
-     * 附件模块
-     */
-    attachment: {
-        /**
-         * 文件操作
-         */
-        file: {
-            /**
-             * 上传文件
-             * @param params 请求参数 { file: any }
-             * @returns 接口返回结果
-             */
-            upload: (params: {
-                file: any;
-            }) => Promise<any>;
-            /**
-             * 下载文件
-             * @param params 请求参数 { file_id: string }
-             * @returns 文件二进制流
-             */
-            download: (params: {
-                file_id: string;
-            }) => Promise<any>;
-            /**
-             * 删除文件
-             * @param params 请求参数 { file_id: string }
-             * @returns 接口返回结果
-             */
-            delete: (params: {
-                file_id: string;
-            }) => Promise<any>;
-        };
-        /**
-         * 头像图片操作
-         */
-        avatar: {
-            /**
-             * 上传头像图片
-             * @param params 请求参数 { image: any }
-             * @returns 接口返回结果
-             */
-            upload: (params: {
-                image: any;
-            }) => Promise<any>;
-            /**
-             * 下载头像图片
-             * @param params 请求参数 { image_id: string }
-             * @returns 图片二进制流
-             */
-            download: (params: {
-                image_id: string;
-            }) => Promise<any>;
-        };
-    };
-    /**
-     * 全局数据模块
-     */
-    global: {
-        /**
-         * 全局选项
-         */
-        options: {
-            /**
-             * 查询全局选项详情
-             * @param params 请求参数 { api_name: string }
-             * @returns 接口返回结果
-             */
-            detail: (params: {
-                api_name: string;
-            }) => Promise<any>;
-            /**
-             * 查询全局选项列表
-             * @param params 请求参数 { limit: number, offset: number, filter?: { quickQuery?: string } }
-             * @returns 接口返回结果
-             */
-            list: (params: {
-                limit: number;
-                offset: number;
-                filter?: {
-                    quickQuery?: string;
-                };
-            }) => Promise<any>;
-            /**
-             * 查询所有全局选项 - 支持自动分页，获取全部数据
-             * @description 该方法会自动处理分页，直到获取所有全局选项数据
-             * @param params 请求参数 { limit?: number, filter?: { quickQuery?: string } }
-             * @returns { total, items }
-             */
-            listWithIterator: (params?: {
-                limit?: number;
-                filter?: {
-                    quickQuery?: string;
-                };
-            }) => Promise<{
-                total: number;
-                items: any[];
-            }>;
-        };
-        /**
-         * 环境变量
-         */
-        variables: {
-            /**
-             * 查询环境变量详情
-             * @param params 请求参数 { api_name: string }
-             * @returns 接口返回结果
-             */
-            detail: (params: {
-                api_name: string;
-            }) => Promise<any>;
-            /**
-             * 查询环境变量列表
-             * @param params 请求参数 { limit: number, offset: number, filter?: { quickQuery?: string } }
-             * @returns 接口返回结果
-             */
-            list: (params: {
-                limit: number;
-                offset: number;
-                filter?: {
-                    quickQuery?: string;
-                };
-            }) => Promise<any>;
-            /**
-             * 查询所有环境变量 - 支持自动分页，获取全部数据
-             * @description 该方法会自动处理分页，直到获取所有环境变量数据
-             * @param params 请求参数 { limit?: number, filter?: { quickQuery?: string } }
-             * @returns { total, items }
-             */
-            listWithIterator: (params?: {
-                limit?: number;
-                filter?: {
-                    quickQuery?: string;
-                };
-            }) => Promise<{
-                total: number;
-                items: any[];
-            }>;
-        };
-    };
-    /**
-     * 自动化流程模块
-     */
-    automation: {
-        /**
-         * V1 版本
-         */
-        v1: {
-            /**
-             * 执行流程
-             * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any }
-             * @returns 接口返回结果
-             */
-            execute: (params: {
-                flow_api_name: string;
-                operator: {
-                    _id: number;
-                    email: string;
-                };
-                params: any;
-            }) => Promise<any>;
-        };
-        /**
-         * V2 版本
-         */
-        v2: {
-            /**
-             * 执行流程
-             * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any, is_resubmit?: boolean, pre_instance_id?: string }
-             * @returns 接口返回结果
-             */
-            execute: (params: {
-                flow_api_name: string;
-                operator: {
-                    _id: number;
-                    email: string;
-                };
-                params: any;
-                is_resubmit?: boolean;
-                pre_instance_id?: string;
-            }) => Promise<any>;
-        };
-    };
-}
-export declare const apaas: {
-    Client: typeof Client;
-};
-export type { BatchResult, RetryOptions };

package/dist/src/limiter.d.ts

@@ -1,17 +0,0 @@
-import Bottleneck from 'bottleneck';
-/**
- * 默认 apaas 限流配置
- */
-export declare const apaasLimiterOptions: {
-    minTime: number;
-    reservoir: number;
-    reservoirRefreshAmount: number;
-    reservoirRefreshInterval: number;
-};
-/**
- * 创建限流器
- * @param fn 被限流函数
- * @param options 自定义限流配置
- * @returns 包装后的限流函数
- */
-export declare function functionLimiter<T>(fn: () => Promise<T>, options?: Partial<Bottleneck.ConstructorOptions>): Promise<T>;

package/dist/src/logger.d.ts

@@ -1,11 +0,0 @@
-/**
- * 日志等级枚举
- */
-export declare enum LoggerLevel {
-    fatal = 0,
-    error = 1,
-    warn = 2,
-    info = 3,
-    debug = 4,
-    trace = 5
-}