apaas-oapi-client 0.1.39 → 1.0.0

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import { LoggerLevel } from './logger';
 import { FIELD_TYPES, SYSTEM_FIELDS, LANGUAGE_CODES, SCHEMA_GUIDELINES, CREATE_OBJECT_EXAMPLE, UPDATE_OBJECT_ADD_FIELD_EXAMPLE, UPDATE_OBJECT_REPLACE_FIELD_EXAMPLE, UPDATE_OBJECT_REMOVE_FIELD_EXAMPLE, UPDATE_OBJECT_SETTINGS_EXAMPLE, getSystemFields, getCustomFieldTypes, getFieldType, isSystemField, createMultilingualText, extractMultilingualText, type FieldTypeMetadata, type MultilingualText, type ObjectSettings, type FieldTypeDefinition, type EncryptType, type FieldOperator, type CreateFieldDefinition, type UpdateFieldDefinition, type CreateObjectDefinition, type UpdateObjectDefinition } from './field-types';
+import { SCHEMA_TYPE_BY_METADATA_TYPE, OPTION_COLOR_LIST, OPTION_COLOR_CODE_BY_NAME, OPTION_COLOR_NAME_BY_CODE, OPTION_COLOR_RULES, FIELD_SCHEMA_RULES, SCHEMA_TYPE_MISMATCHES, SQL_TYPE_TO_SCHEMA_TYPE, COLUMN_NAME_SEMANTIC_RULES, SQL_CONSTRAINT_TO_SETTINGS, BATCH_UPDATE_REQUIREMENTS, getOptionColor, getOptionColorCode, normalizeOptionColorForSchema, type MetadataFieldType, type SchemaFieldType, type FieldCreateRule, type OptionColor, type OptionColorCode, type SqlTypeMapping, type ColumnNameSemanticRule, type SqlConstraintMapping } from './field-schema-rules';
+import { SCHEMA_BATCH_SIZE, addFieldsIdempotent, batchExecute, buildFieldRemovalPlan, checkSchemaResponse, createSchemaObjectShells, createSchemaObjectsInStages, deleteAllCustomObjects, isSystemSchemaName, normalizeSchemaObjectsForWrite, splitSchemaFieldsByDependency, validateSchemaResponse, verifySchemaObjects, type DeleteAllCustomObjectsOptions, type DeleteAllCustomObjectsResult, type SchemaAddFieldsOptions, type SchemaAddFieldsResult, type SchemaBatchExecuteOptions, type SchemaBatchExecuteResult, type SchemaBatchInfo, type SchemaCreateObjectsInStagesOptions, type SchemaCreateObjectsInStagesResult, type SchemaCreateShellsOptions, type SchemaCreateShellsResult, type SchemaFieldRemovalPlan, type SchemaManagedObjectDefinition, type SchemaObjectVerification, type SchemaResponse, type SchemaResponseFailure, type SchemaResponseFailureLayer, type SchemaResponseItem, type SchemaResponseValidationOptions, type SchemaResponseValidationResult, type SchemaStageFieldDefinition, type SchemaVerificationOptions, type SchemaVerificationResult } from './schema-utils';
 /**
  * 批量操作结果
  */
@@ -97,6 +99,7 @@ declare class Client {
      * 获取当前 namespace
      */
     get currentNamespace(): string;
+    private authHeaders;
     /**
      * 对象模块
      */
@@ -234,7 +237,53 @@ declare class Client {
                 object_name: string;
                 data?: any;
             }) => Promise<any>;
+            /**
+             * 跨对象搜索记录
+             * @description 在最多 5 个对象中按搜索词查询记录
+             * @param params 请求体，包含 q、search_objects、page_token、page_size、metadata 等
+             */
+            recordsAcrossObjects: (params: {
+                q: string;
+                search_objects: Array<{
+                    api_name: string;
+                    select?: string[];
+                    search_fields?: string[];
+                    filter?: any;
+                    order_by?: any[];
+                }>;
+                page_token?: string;
+                page_size?: number;
+                metadata?: "Label" | "SearchLayout" | string;
+            }) => Promise<any>;
+            /**
+             * 跨对象搜索记录 - 自动 page_token 分页
+             */
+            recordsAcrossObjectsWithIterator: (params: {
+                q: string;
+                search_objects: Array<{
+                    api_name: string;
+                    select?: string[];
+                    search_fields?: string[];
+                    filter?: any;
+                    order_by?: any[];
+                }>;
+                page_token?: string;
+                page_size?: number;
+                metadata?: "Label" | "SearchLayout" | string;
+            }) => Promise<{
+                items: any[];
+                lastResponse: any;
+            }>;
         };
+        /**
+         * 执行 OQL
+         * @description 执行对象查询语言，支持匿名参数 args 和具名参数 namedArgs
+         */
+        oql: (params: {
+            query: string;
+            args?: any[];
+            namedArgs?: Record<string, any>;
+        }) => Promise<any>;
         create: {
             /**
              * 单条记录创建
@@ -375,6 +424,48 @@ declare class Client {
             }>;
         };
     };
+    /**
+     * 常量对象模块
+     */
+    constant: {
+        /**
+         * 查询常量对象列表。object_name 可取 _currency、_country、_timeZone。
+         */
+        records: (params: {
+            object_name: "_currency" | "_country" | "_timeZone" | string;
+            data?: {
+                limit?: number;
+                offset?: number;
+                count?: boolean;
+                fields?: string[] | string;
+                quickSearch?: string;
+                filter?: any[];
+                sort?: any[];
+            };
+        }) => Promise<any>;
+        /**
+         * 查询常量对象单条记录详情。
+         */
+        record: (params: {
+            object_name: "_currency" | "_country" | "_timeZone" | string;
+            record_id: string;
+        }) => Promise<any>;
+        metadata: {
+            /**
+             * 获取常量对象元数据。
+             */
+            fields: (params: {
+                object_name: "_currency" | "_country" | "_timeZone" | string;
+            }) => Promise<any>;
+            /**
+             * 获取常量对象字段详情。
+             */
+            field: (params: {
+                object_name: "_currency" | "_country" | "_timeZone" | string;
+                field_name: string;
+            }) => Promise<any>;
+        };
+    };
     /**
      * 部门 ID 交换模块
      */
@@ -425,6 +516,33 @@ declare class Client {
             retryOptions?: RetryOptions;
         }) => Promise<BatchResult<any>>;
     };
+    /**
+     * 集成模块
+     */
+    integration: {
+        lark: {
+            /**
+             * 获取默认飞书集成 tenantAccessToken。
+             */
+            defaultTenantAccessToken: () => Promise<any>;
+            /**
+             * 获取默认飞书集成 appAccessToken。
+             */
+            defaultAppAccessToken: () => Promise<any>;
+            /**
+             * 获取自定义飞书集成 tenantAccessToken。
+             */
+            tenantAccessToken: (params: {
+                lark_integration_api_name: string;
+            }) => Promise<any>;
+            /**
+             * 获取自定义飞书集成 appAccessToken。
+             */
+            appAccessToken: (params: {
+                lark_integration_api_name: string;
+            }) => Promise<any>;
+        };
+    };
     /**
      * 云函数模块
      */
@@ -625,6 +743,44 @@ declare class Client {
             }>;
         };
     };
+    /**
+     * 数据集模块
+     */
+    dataset: {
+        /**
+         * 查询数据集列表。
+         */
+        list: (params?: {
+            keyword?: string;
+            order_by?: {
+                field?: "create_time" | "update_time" | string;
+                direction?: "asc" | "desc" | string;
+            } | string;
+            page_type?: "cursor" | "offset";
+            page_size?: number;
+            page_token?: string;
+            offset?: number | string;
+            created_by?: string[];
+            updated_by?: string[];
+        }) => Promise<any>;
+        /**
+         * 查询全部数据集 - 默认使用 cursor 分页。
+         */
+        listWithIterator: (params?: {
+            keyword?: string;
+            order_by?: {
+                field?: "create_time" | "update_time" | string;
+                direction?: "asc" | "desc" | string;
+            } | string;
+            page_size?: number;
+            created_by?: string[];
+            updated_by?: string[];
+        }) => Promise<{
+            total: number;
+            datasets: any[];
+            lastResponse: any;
+        }>;
+    };
     /**
      * 自动化流程模块
      */
@@ -668,6 +824,136 @@ declare class Client {
             }) => Promise<any>;
         };
     };
+    /**
+     * 流程模块
+     */
+    workflow: {
+        execution: {
+            /**
+             * 查询异步流程状态。
+             */
+            status: (params: {
+                execution_id: string | number;
+            }) => Promise<any>;
+        };
+        definition: {
+            /**
+             * 获取流程定义详情。
+             */
+            detail: (params: {
+                flow_api_name: string;
+            }) => Promise<any>;
+        };
+        userTask: {
+            /**
+             * 获取包含人工任务的流程列表。
+             */
+            flows: (params: {
+                limit: number;
+                offset?: number;
+            }) => Promise<any>;
+            /**
+             * 获取包含人工任务的流程实例 ID 列表。
+             */
+            instanceIds: (params: {
+                page_size?: number;
+                page_token?: string;
+                start_time?: string | number;
+                end_time?: string | number;
+                api_ids?: string[];
+            }) => Promise<any>;
+            /**
+             * 获取流程实例详情。
+             */
+            instanceDetail: (params: {
+                approval_instance_id: string;
+                includes?: string[];
+            }) => Promise<any>;
+            /**
+             * 批量获取流程实例的任务列表。
+             */
+            instanceTasks: (params: {
+                approval_instance_ids: Array<string | number>;
+                task_status?: string;
+            }) => Promise<any>;
+            /**
+             * 获取任务列表。
+             */
+            tasks: (params: {
+                type: "archived" | "pending" | string;
+                source: "fromMe" | "assignMe" | "CCMe" | string;
+                kunlun_user_id: string;
+                limit?: number | string;
+                offset?: number | string;
+                start_time?: string | number;
+                end_time?: string | number;
+                api_ids?: string[];
+            }) => Promise<any>;
+            /**
+             * 获取任务详情。
+             */
+            detail: (params: {
+                task_id: string;
+            }) => Promise<any>;
+            agree: (params: {
+                approval_task_id: string;
+                user_id: string;
+                opinion?: string;
+            }) => Promise<any>;
+            reject: (params: {
+                approval_task_id: string;
+                user_id: string;
+                opinion?: string;
+            }) => Promise<any>;
+            transfer: (params: {
+                approval_task_id: string;
+                user_id: string;
+                from_user_ids: string[];
+                to_user_ids: string[];
+                opinion?: string;
+            }) => Promise<any>;
+            addAssignee: (params: {
+                approval_task_id: string;
+                user_id: string;
+                approvers: string[];
+                add_assignee_type: "currentAndAddAssign" | "afterAndAddAssign" | string;
+                opinion?: string;
+            }) => Promise<any>;
+            cc: (params: {
+                task_id: string;
+                cc_user_ids: string[];
+                operator_user_id: string;
+            }) => Promise<any>;
+            expedite: (params: {
+                task_id: string;
+                expediting_user_ids: string[];
+                operator_user_id: string;
+                opinion?: string;
+            }) => Promise<any>;
+            cancelInstance: (params: {
+                approval_instance_id: string;
+                user_id: string;
+                opinion?: string;
+            }) => Promise<any>;
+            rollbackPoints: (params: {
+                task_id: string;
+                operator_user_id: string;
+            }) => Promise<any>;
+            rollback: (params: {
+                task_id: string;
+                operator_user_id: string;
+                to_task_id: string;
+                opinion?: string;
+            }) => Promise<any>;
+            startChat: (params: {
+                task_id: string;
+                operator_user_id: string;
+                invite_user_ids?: string[];
+                chat_id?: string;
+                chat_name?: string;
+            }) => Promise<any>;
+        };
+    };
     /**
      * 数据对象结构管理模块（Schema）
      */
@@ -690,7 +976,7 @@ declare class Client {
                     display_name?: string;
                     search_layout?: string[];
                 };
-                fields: Array<{
+                fields?: Array<{
                     api_name: string;
                     label: {
                         zh_cn: string;
@@ -798,10 +1084,53 @@ declare class Client {
         delete: (params: {
             api_names: string[];
         }) => Promise<any>;
+        /**
+         * 校验 schema 写接口响应，覆盖请求级错误、data=null 静默失败、item 级失败。
+         */
+        checkResponse: typeof checkSchemaResponse;
+        /**
+         * 返回 schema 写接口响应校验结果，不抛错。
+         */
+        validateResponse: typeof validateSchemaResponse;
+        /**
+         * 按 schema 单批 10 个对象的限制分批执行。
+         */
+        batchExecute: typeof batchExecute;
+        /**
+         * 创建对象空壳。会移除 fields，并将 display/search 临时指向 _id。
+         */
+        createShells: (params: {
+            objects: SchemaManagedObjectDefinition[];
+        } & SchemaCreateShellsOptions) => Promise<SchemaCreateShellsResult>;
+        /**
+         * 幂等添加字段：先读 metadata，跳过已存在字段，再调用 schema.update。
+         */
+        addFieldsIdempotent: (params: {
+            object_name: string;
+            fields: SchemaStageFieldDefinition[];
+        } & SchemaAddFieldsOptions) => Promise<SchemaAddFieldsResult>;
+        /**
+         * 三阶段创建对象：空壳 -> 基础字段 -> lookup -> reference_field -> final settings。
+         */
+        createWithStages: (params: {
+            objects: SchemaManagedObjectDefinition[];
+        } & SchemaCreateObjectsInStagesOptions) => Promise<SchemaCreateObjectsInStagesResult>;
+        /**
+         * 写后验证对象和字段，可选导出 Markdown。
+         */
+        verifyObjects: (params: {
+            object_names: string[];
+        } & SchemaVerificationOptions) => Promise<SchemaVerificationResult>;
+        /**
+         * 删除全部自定义对象。高风险操作，必须显式传 confirm: true。
+         */
+        deleteAllCustomObjects: (params: DeleteAllCustomObjectsOptions & {
+            confirm: true;
+        }) => Promise<DeleteAllCustomObjectsResult>;
     };
 }
 export declare const apaas: {
     Client: typeof Client;
 };
-export type { BatchResult, RetryOptions, FieldTypeMetadata, MultilingualText, ObjectSettings, FieldTypeDefinition, EncryptType, FieldOperator, CreateFieldDefinition, UpdateFieldDefinition, CreateObjectDefinition, UpdateObjectDefinition };
-export { FIELD_TYPES, SYSTEM_FIELDS, LANGUAGE_CODES, SCHEMA_GUIDELINES, CREATE_OBJECT_EXAMPLE, UPDATE_OBJECT_ADD_FIELD_EXAMPLE, UPDATE_OBJECT_REPLACE_FIELD_EXAMPLE, UPDATE_OBJECT_REMOVE_FIELD_EXAMPLE, UPDATE_OBJECT_SETTINGS_EXAMPLE, getSystemFields, getCustomFieldTypes, getFieldType, isSystemField, createMultilingualText, extractMultilingualText };
+export type { BatchResult, RetryOptions, FieldTypeMetadata, MultilingualText, ObjectSettings, FieldTypeDefinition, EncryptType, FieldOperator, CreateFieldDefinition, UpdateFieldDefinition, CreateObjectDefinition, UpdateObjectDefinition, MetadataFieldType, SchemaFieldType, FieldCreateRule, OptionColor, OptionColorCode, SqlTypeMapping, ColumnNameSemanticRule, SqlConstraintMapping, DeleteAllCustomObjectsOptions, DeleteAllCustomObjectsResult, SchemaAddFieldsOptions, SchemaAddFieldsResult, SchemaBatchExecuteOptions, SchemaBatchExecuteResult, SchemaBatchInfo, SchemaCreateObjectsInStagesOptions, SchemaCreateObjectsInStagesResult, SchemaCreateShellsOptions, SchemaCreateShellsResult, SchemaFieldRemovalPlan, SchemaManagedObjectDefinition, SchemaObjectVerification, SchemaResponse, SchemaResponseFailure, SchemaResponseFailureLayer, SchemaResponseItem, SchemaResponseValidationOptions, SchemaResponseValidationResult, SchemaStageFieldDefinition, SchemaVerificationOptions, SchemaVerificationResult };
+export { FIELD_TYPES, SYSTEM_FIELDS, LANGUAGE_CODES, SCHEMA_GUIDELINES, CREATE_OBJECT_EXAMPLE, UPDATE_OBJECT_ADD_FIELD_EXAMPLE, UPDATE_OBJECT_REPLACE_FIELD_EXAMPLE, UPDATE_OBJECT_REMOVE_FIELD_EXAMPLE, UPDATE_OBJECT_SETTINGS_EXAMPLE, getSystemFields, getCustomFieldTypes, getFieldType, isSystemField, createMultilingualText, extractMultilingualText, SCHEMA_TYPE_BY_METADATA_TYPE, OPTION_COLOR_LIST, OPTION_COLOR_CODE_BY_NAME, OPTION_COLOR_NAME_BY_CODE, OPTION_COLOR_RULES, FIELD_SCHEMA_RULES, SCHEMA_TYPE_MISMATCHES, SQL_TYPE_TO_SCHEMA_TYPE, COLUMN_NAME_SEMANTIC_RULES, SQL_CONSTRAINT_TO_SETTINGS, BATCH_UPDATE_REQUIREMENTS, getOptionColor, getOptionColorCode, normalizeOptionColorForSchema, SCHEMA_BATCH_SIZE, addFieldsIdempotent, batchExecute, buildFieldRemovalPlan, checkSchemaResponse, createSchemaObjectShells, createSchemaObjectsInStages, deleteAllCustomObjects, isSystemSchemaName, normalizeSchemaObjectsForWrite, splitSchemaFieldsByDependency, validateSchemaResponse, verifySchemaObjects };