@nest-packages/nestjs-lark-sdk 0.1.1 → 0.2.0

package/dist/bitable-base-field.d.ts

@@ -1,54 +1,199 @@
 import { Logger } from '@nestjs/common';
-import { appTableCreateData, appTableFieldCreateData, appTableFieldCreatePath } from './types';
+import {
+  appTableCreateData,
+  appTableFieldCreateData,
+  appTableFieldCreatePath,
+} from './types';
 import { AbstractBaseBitable } from './bitable-base.abstract';
 import { FeishuBasePlus } from './feishu-base-plus';
 export declare enum fieldTypeEnum {
-    '多行文本' = 1,
-    '数字' = 2,
-    '单选' = 3,
-    '多选' = 4,
-    '日期' = 5,
-    '复选框' = 7,
-    '人员' = 11,
-    '电话号码' = 13,
-    '超链接' = 15,
-    '附件' = 17,
-    '单向关联' = 18,
-    '公式' = 20,
-    '双向关联' = 21,
-    '地理位置' = 22,
-    '群组' = 23,
-    '创建时间' = 1001,
-    '最后更新时间' = 1002,
-    '创建人' = 1003,
-    '修改人' = 1004,
-    '自动编号' = 1005
+  '多行文本' = 1,
+  '数字' = 2,
+  '单选' = 3,
+  '多选' = 4,
+  '日期' = 5,
+  '复选框' = 7,
+  '人员' = 11,
+  '电话号码' = 13,
+  '超链接' = 15,
+  '附件' = 17,
+  '单向关联' = 18,
+  '公式' = 20,
+  '双向关联' = 21,
+  '地理位置' = 22,
+  '群组' = 23,
+  '创建时间' = 1001,
+  '最后更新时间' = 1002,
+  '创建人' = 1003,
+  '修改人' = 1004,
+  '自动编号' = 1005,
 }
+export declare const FIELD_MAPPING: {
+  文本: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  条码: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  邮箱: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  数字: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  进度: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  货币: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  评分: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  单选: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  多选: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  日期: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  复选框: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  人员: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  电话号码: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  超链接: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  附件: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  单向关联: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  查找引用: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  公式: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  双向关联: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  地理位置: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  群组: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  创建时间: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  最后更新时间: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  创建人: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  修改人: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+  自动编号: {
+    type: number;
+    ui_type: string;
+    desc: string;
+  };
+};
 export declare class BitableFieldBase extends AbstractBaseBitable {
-    readonly logger: Logger;
-    bitablePath: appTableFieldCreatePath;
-    bitableUrl: string;
-    constructor(feishuBaseInstance: FeishuBasePlus, bitableUrl: string);
-    setBitablePath(path: appTableFieldCreatePath | string): Promise<{
-        app_token: string;
-        table_id: string;
-    }>;
-    getBitablePath(bitableUrl?: string): Promise<{
-        app_token: string;
-        table_id: string;
-    }>;
-    batchFieldList(batchFieldListPayload: appTableFieldCreateData[]): Promise<boolean>;
-    sleep(ms: any): Promise<unknown>;
-    updateField(payloadData: appTableFieldCreateData, field_id?: string): Promise<{
-        field?: {
-            field_name: string;
-            type: number;
-            property?: {
-                options?: {
-                    name?: string | undefined;
-                    id?: string | undefined;
-                    color?: number | undefined;
-                }[] | undefined;
+  readonly logger: Logger;
+  bitablePath: appTableFieldCreatePath;
+  bitableUrl: string;
+  constructor(feishuBaseInstance: FeishuBasePlus, bitableUrl: string);
+  setBitablePath(path: appTableFieldCreatePath | string): Promise<{
+    app_token: string;
+    table_id: string;
+  }>;
+  getBitablePath(bitableUrl?: string): Promise<{
+    app_token: string;
+    table_id: string;
+  }>;
+  batchFieldList(
+    batchFieldListPayload: appTableFieldCreateData[],
+  ): Promise<boolean>;
+  sleep(ms: any): Promise<unknown>;
+  updateField(
+    payloadData: appTableFieldCreateData,
+    field_id?: string,
+  ): Promise<{
+    field?:
+      | {
+          field_name: string;
+          type: number;
+          property?:
+            | {
+                options?:
+                  | {
+                      name?: string | undefined;
+                      id?: string | undefined;
+                      color?: number | undefined;
+                    }[]
+                  | undefined;
                 formatter?: string | undefined;
                 date_formatter?: string | undefined;
                 auto_fill?: boolean | undefined;
@@ -56,63 +201,122 @@ export declare class BitableFieldBase extends AbstractBaseBitable {
                 table_id?: string | undefined;
                 table_name?: string | undefined;
                 back_field_name?: string | undefined;
-                auto_serial?: {
-                    type: "custom" | "auto_increment_number";
-                    options?: {
-                        type: "system_number" | "fixed_text" | "created_time";
-                        value: string;
-                    }[] | undefined;
-                } | undefined;
-                location?: {
-                    input_type: "only_mobile" | "not_limit";
-                } | undefined;
+                auto_serial?:
+                  | {
+                      type: 'custom' | 'auto_increment_number';
+                      options?:
+                        | {
+                            type:
+                              | 'system_number'
+                              | 'fixed_text'
+                              | 'created_time';
+                            value: string;
+                          }[]
+                        | undefined;
+                    }
+                  | undefined;
+                location?:
+                  | {
+                      input_type: 'only_mobile' | 'not_limit';
+                    }
+                  | undefined;
                 formula_expression?: string | undefined;
-                allowed_edit_modes?: {
-                    manual?: boolean | undefined;
-                    scan?: boolean | undefined;
-                } | undefined;
+                allowed_edit_modes?:
+                  | {
+                      manual?: boolean | undefined;
+                      scan?: boolean | undefined;
+                    }
+                  | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 range_customize?: boolean | undefined;
                 currency_code?: string | undefined;
-                rating?: {
-                    symbol?: string | undefined;
-                } | undefined;
-                type?: {
-                    data_type: number;
-                    ui_property?: {
-                        currency_code?: string | undefined;
-                        formatter?: string | undefined;
-                        range_customize?: boolean | undefined;
-                        min?: number | undefined;
-                        max?: number | undefined;
-                        date_formatter?: string | undefined;
-                        rating?: {
-                            symbol?: string | undefined;
-                        } | undefined;
-                    } | undefined;
-                    ui_type?: "Number" | "Progress" | "Currency" | "Rating" | "DateTime" | undefined;
-                } | undefined;
-            } | undefined;
-            description?: {
+                rating?:
+                  | {
+                      symbol?: string | undefined;
+                    }
+                  | undefined;
+                type?:
+                  | {
+                      data_type: number;
+                      ui_property?:
+                        | {
+                            currency_code?: string | undefined;
+                            formatter?: string | undefined;
+                            range_customize?: boolean | undefined;
+                            min?: number | undefined;
+                            max?: number | undefined;
+                            date_formatter?: string | undefined;
+                            rating?:
+                              | {
+                                  symbol?: string | undefined;
+                                }
+                              | undefined;
+                          }
+                        | undefined;
+                      ui_type?:
+                        | 'Number'
+                        | 'Progress'
+                        | 'Currency'
+                        | 'Rating'
+                        | 'DateTime'
+                        | undefined;
+                    }
+                  | undefined;
+              }
+            | undefined;
+          description?:
+            | {
                 disable_sync?: boolean | undefined;
                 text?: string | undefined;
-            } | undefined;
-            is_primary?: boolean | undefined;
-            field_id?: string | undefined;
-            ui_type?: "Text" | "Barcode" | "Number" | "Progress" | "Currency" | "Rating" | "SingleSelect" | "MultiSelect" | "DateTime" | "Checkbox" | "User" | "GroupChat" | "Phone" | "Url" | "Attachment" | "SingleLink" | "Formula" | "DuplexLink" | "Location" | "CreatedTime" | "ModifiedTime" | "CreatedUser" | "ModifiedUser" | "AutoNumber" | "Email" | undefined;
-            is_hidden?: boolean | undefined;
-        } | undefined;
-    }>;
-    getFieldList(): Promise<{
-        field_name: string;
-        type: number;
-        property?: {
-            options?: {
-                name?: string | undefined;
-                id?: string | undefined;
-                color?: number | undefined;
-            }[] | undefined;
+              }
+            | undefined;
+          is_primary?: boolean | undefined;
+          field_id?: string | undefined;
+          ui_type?:
+            | 'Text'
+            | 'Barcode'
+            | 'Number'
+            | 'Progress'
+            | 'Currency'
+            | 'Rating'
+            | 'SingleSelect'
+            | 'MultiSelect'
+            | 'DateTime'
+            | 'Checkbox'
+            | 'User'
+            | 'GroupChat'
+            | 'Phone'
+            | 'Url'
+            | 'Attachment'
+            | 'SingleLink'
+            | 'Formula'
+            | 'DuplexLink'
+            | 'Location'
+            | 'CreatedTime'
+            | 'ModifiedTime'
+            | 'CreatedUser'
+            | 'ModifiedUser'
+            | 'AutoNumber'
+            | 'Email'
+            | undefined;
+          is_hidden?: boolean | undefined;
+        }
+      | undefined;
+  }>;
+  getFieldList(): Promise<
+    {
+      field_name: string;
+      type: number;
+      property?:
+        | {
+            options?:
+              | {
+                  name?: string | undefined;
+                  id?: string | undefined;
+                  color?: number | undefined;
+                }[]
+              | undefined;
             formatter?: string | undefined;
             date_formatter?: string | undefined;
             auto_fill?: boolean | undefined;
@@ -120,58 +324,117 @@ export declare class BitableFieldBase extends AbstractBaseBitable {
             table_id?: string | undefined;
             table_name?: string | undefined;
             back_field_name?: string | undefined;
-            auto_serial?: {
-                type: "custom" | "auto_increment_number";
-                options?: {
-                    type: "system_number" | "fixed_text" | "created_time";
-                    value: string;
-                }[] | undefined;
-            } | undefined;
-            location?: {
-                input_type: "only_mobile" | "not_limit";
-            } | undefined;
+            auto_serial?:
+              | {
+                  type: 'custom' | 'auto_increment_number';
+                  options?:
+                    | {
+                        type: 'system_number' | 'fixed_text' | 'created_time';
+                        value: string;
+                      }[]
+                    | undefined;
+                }
+              | undefined;
+            location?:
+              | {
+                  input_type: 'only_mobile' | 'not_limit';
+                }
+              | undefined;
             formula_expression?: string | undefined;
-            allowed_edit_modes?: {
-                manual?: boolean | undefined;
-                scan?: boolean | undefined;
-            } | undefined;
+            allowed_edit_modes?:
+              | {
+                  manual?: boolean | undefined;
+                  scan?: boolean | undefined;
+                }
+              | undefined;
             min?: number | undefined;
             max?: number | undefined;
             range_customize?: boolean | undefined;
             currency_code?: string | undefined;
-            rating?: {
-                symbol?: string | undefined;
-            } | undefined;
-            type?: {
-                data_type: number;
-                ui_property?: {
-                    currency_code?: string | undefined;
-                    formatter?: string | undefined;
-                    range_customize?: boolean | undefined;
-                    min?: number | undefined;
-                    max?: number | undefined;
-                    date_formatter?: string | undefined;
-                    rating?: {
-                        symbol?: string | undefined;
-                    } | undefined;
-                } | undefined;
-                ui_type?: "Number" | "Progress" | "Currency" | "Rating" | "DateTime" | undefined;
-            } | undefined;
-        } | undefined;
-        description?: string | undefined;
-        is_primary?: boolean | undefined;
-        field_id?: string | undefined;
-        ui_type?: "Text" | "Barcode" | "Number" | "Progress" | "Currency" | "Rating" | "SingleSelect" | "MultiSelect" | "DateTime" | "Checkbox" | "User" | "GroupChat" | "Phone" | "Url" | "Attachment" | "SingleLink" | "Formula" | "DuplexLink" | "Location" | "CreatedTime" | "ModifiedTime" | "CreatedUser" | "ModifiedUser" | "AutoNumber" | undefined;
-        is_hidden?: boolean | undefined;
-    }[]>;
-    getAppTableList(path: appTableFieldCreatePath): Promise<{
-        table_id?: string | undefined;
-        revision?: number | undefined;
-        name?: string | undefined;
-    }[]>;
-    getTargetTable(bitableUrl: string, tableName: any, batchFieldListPayload: appTableCreateData[]): Promise<{
-        table_id: string;
-        app_token: string;
-    }>;
-    getAppTableCreate(tableName: string, appToken: string, batchFieldListPayload: appTableCreateData[]): Promise<string>;
+            rating?:
+              | {
+                  symbol?: string | undefined;
+                }
+              | undefined;
+            type?:
+              | {
+                  data_type: number;
+                  ui_property?:
+                    | {
+                        currency_code?: string | undefined;
+                        formatter?: string | undefined;
+                        range_customize?: boolean | undefined;
+                        min?: number | undefined;
+                        max?: number | undefined;
+                        date_formatter?: string | undefined;
+                        rating?:
+                          | {
+                              symbol?: string | undefined;
+                            }
+                          | undefined;
+                      }
+                    | undefined;
+                  ui_type?:
+                    | 'Number'
+                    | 'Progress'
+                    | 'Currency'
+                    | 'Rating'
+                    | 'DateTime'
+                    | undefined;
+                }
+              | undefined;
+          }
+        | undefined;
+      description?: string | undefined;
+      is_primary?: boolean | undefined;
+      field_id?: string | undefined;
+      ui_type?:
+        | 'Text'
+        | 'Barcode'
+        | 'Number'
+        | 'Progress'
+        | 'Currency'
+        | 'Rating'
+        | 'SingleSelect'
+        | 'MultiSelect'
+        | 'DateTime'
+        | 'Checkbox'
+        | 'User'
+        | 'GroupChat'
+        | 'Phone'
+        | 'Url'
+        | 'Attachment'
+        | 'SingleLink'
+        | 'Formula'
+        | 'DuplexLink'
+        | 'Location'
+        | 'CreatedTime'
+        | 'ModifiedTime'
+        | 'CreatedUser'
+        | 'ModifiedUser'
+        | 'AutoNumber'
+        | undefined;
+      is_hidden?: boolean | undefined;
+    }[]
+  >;
+  getAppTableList(path: appTableFieldCreatePath): Promise<
+    {
+      table_id?: string | undefined;
+      revision?: number | undefined;
+      name?: string | undefined;
+    }[]
+  >;
+  getTargetTable(
+    bitableUrl: string,
+    tableName: any,
+    batchFieldListPayload: appTableCreateData[],
+  ): Promise<{
+    table_id: string;
+    app_token: string;
+  }>;
+  getAppTableCreate(
+    tableName: string,
+    appToken: string,
+    batchFieldListPayload: appTableCreateData[],
+  ): Promise<string>;
 }