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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/bitable-base-field.d.ts +405 -274
  2. package/dist/bitable-base-record.d.ts +312 -198
  3. package/dist/contact-base.d.ts +328 -233
  4. package/dist/im-base.d.ts +175 -122
  5. package/dist/im-base.type.d.ts +26 -10
  6. package/package.json +3 -2
package/dist/bitable-base-field.d.ts CHANGED
@@ -1,186 +1,199 @@
1
1
  import { Logger } from '@nestjs/common';
2
- import { appTableCreateData, appTableFieldCreateData, appTableFieldCreatePath } from './types';
2
+ import {
3
+ appTableCreateData,
4
+ appTableFieldCreateData,
5
+ appTableFieldCreatePath,
6
+ } from './types';
3
7
  import { AbstractBaseBitable } from './bitable-base.abstract';
4
8
  import { FeishuBasePlus } from './feishu-base-plus';
5
9
  export declare enum fieldTypeEnum {
6
- '多行文本' = 1,
7
- '数字' = 2,
8
- '单选' = 3,
9
- '多选' = 4,
10
- '日期' = 5,
11
- '复选框' = 7,
12
- '人员' = 11,
13
- '电话号码' = 13,
14
- '超链接' = 15,
15
- '附件' = 17,
16
- '单向关联' = 18,
17
- '公式' = 20,
18
- '双向关联' = 21,
19
- '地理位置' = 22,
20
- '群组' = 23,
21
- '创建时间' = 1001,
22
- '最后更新时间' = 1002,
23
- '创建人' = 1003,
24
- '修改人' = 1004,
25
- '自动编号' = 1005
10
+ '多行文本' = 1,
11
+ '数字' = 2,
12
+ '单选' = 3,
13
+ '多选' = 4,
14
+ '日期' = 5,
15
+ '复选框' = 7,
16
+ '人员' = 11,
17
+ '电话号码' = 13,
18
+ '超链接' = 15,
19
+ '附件' = 17,
20
+ '单向关联' = 18,
21
+ '公式' = 20,
22
+ '双向关联' = 21,
23
+ '地理位置' = 22,
24
+ '群组' = 23,
25
+ '创建时间' = 1001,
26
+ '最后更新时间' = 1002,
27
+ '创建人' = 1003,
28
+ '修改人' = 1004,
29
+ '自动编号' = 1005,
26
30
  }
27
31
  export declare const FIELD_MAPPING: {
28
- 文本: {
29
- type: number;
30
- ui_type: string;
31
- desc: string;
32
- };
33
- 条码: {
34
- type: number;
35
- ui_type: string;
36
- desc: string;
37
- };
38
- 邮箱: {
39
- type: number;
40
- ui_type: string;
41
- desc: string;
42
- };
43
- 数字: {
44
- type: number;
45
- ui_type: string;
46
- desc: string;
47
- };
48
- 进度: {
49
- type: number;
50
- ui_type: string;
51
- desc: string;
52
- };
53
- 货币: {
54
- type: number;
55
- ui_type: string;
56
- desc: string;
57
- };
58
- 评分: {
59
- type: number;
60
- ui_type: string;
61
- desc: string;
62
- };
63
- 单选: {
64
- type: number;
65
- ui_type: string;
66
- desc: string;
67
- };
68
- 多选: {
69
- type: number;
70
- ui_type: string;
71
- desc: string;
72
- };
73
- 日期: {
74
- type: number;
75
- ui_type: string;
76
- desc: string;
77
- };
78
- 复选框: {
79
- type: number;
80
- ui_type: string;
81
- desc: string;
82
- };
83
- 人员: {
84
- type: number;
85
- ui_type: string;
86
- desc: string;
87
- };
88
- 电话号码: {
89
- type: number;
90
- ui_type: string;
91
- desc: string;
92
- };
93
- 超链接: {
94
- type: number;
95
- ui_type: string;
96
- desc: string;
97
- };
98
- 附件: {
99
- type: number;
100
- ui_type: string;
101
- desc: string;
102
- };
103
- 单向关联: {
104
- type: number;
105
- ui_type: string;
106
- desc: string;
107
- };
108
- 查找引用: {
109
- type: number;
110
- ui_type: string;
111
- desc: string;
112
- };
113
- 公式: {
114
- type: number;
115
- ui_type: string;
116
- desc: string;
117
- };
118
- 双向关联: {
119
- type: number;
120
- ui_type: string;
121
- desc: string;
122
- };
123
- 地理位置: {
124
- type: number;
125
- ui_type: string;
126
- desc: string;
127
- };
128
- 群组: {
129
- type: number;
130
- ui_type: string;
131
- desc: string;
132
- };
133
- 创建时间: {
134
- type: number;
135
- ui_type: string;
136
- desc: string;
137
- };
138
- 最后更新时间: {
139
- type: number;
140
- ui_type: string;
141
- desc: string;
142
- };
143
- 创建人: {
144
- type: number;
145
- ui_type: string;
146
- desc: string;
147
- };
148
- 修改人: {
149
- type: number;
150
- ui_type: string;
151
- desc: string;
152
- };
153
- 自动编号: {
154
- type: number;
155
- ui_type: string;
156
- desc: string;
157
- };
32
+ 文本: {
33
+ type: number;
34
+ ui_type: string;
35
+ desc: string;
36
+ };
37
+ 条码: {
38
+ type: number;
39
+ ui_type: string;
40
+ desc: string;
41
+ };
42
+ 邮箱: {
43
+ type: number;
44
+ ui_type: string;
45
+ desc: string;
46
+ };
47
+ 数字: {
48
+ type: number;
49
+ ui_type: string;
50
+ desc: string;
51
+ };
52
+ 进度: {
53
+ type: number;
54
+ ui_type: string;
55
+ desc: string;
56
+ };
57
+ 货币: {
58
+ type: number;
59
+ ui_type: string;
60
+ desc: string;
61
+ };
62
+ 评分: {
63
+ type: number;
64
+ ui_type: string;
65
+ desc: string;
66
+ };
67
+ 单选: {
68
+ type: number;
69
+ ui_type: string;
70
+ desc: string;
71
+ };
72
+ 多选: {
73
+ type: number;
74
+ ui_type: string;
75
+ desc: string;
76
+ };
77
+ 日期: {
78
+ type: number;
79
+ ui_type: string;
80
+ desc: string;
81
+ };
82
+ 复选框: {
83
+ type: number;
84
+ ui_type: string;
85
+ desc: string;
86
+ };
87
+ 人员: {
88
+ type: number;
89
+ ui_type: string;
90
+ desc: string;
91
+ };
92
+ 电话号码: {
93
+ type: number;
94
+ ui_type: string;
95
+ desc: string;
96
+ };
97
+ 超链接: {
98
+ type: number;
99
+ ui_type: string;
100
+ desc: string;
101
+ };
102
+ 附件: {
103
+ type: number;
104
+ ui_type: string;
105
+ desc: string;
106
+ };
107
+ 单向关联: {
108
+ type: number;
109
+ ui_type: string;
110
+ desc: string;
111
+ };
112
+ 查找引用: {
113
+ type: number;
114
+ ui_type: string;
115
+ desc: string;
116
+ };
117
+ 公式: {
118
+ type: number;
119
+ ui_type: string;
120
+ desc: string;
121
+ };
122
+ 双向关联: {
123
+ type: number;
124
+ ui_type: string;
125
+ desc: string;
126
+ };
127
+ 地理位置: {
128
+ type: number;
129
+ ui_type: string;
130
+ desc: string;
131
+ };
132
+ 群组: {
133
+ type: number;
134
+ ui_type: string;
135
+ desc: string;
136
+ };
137
+ 创建时间: {
138
+ type: number;
139
+ ui_type: string;
140
+ desc: string;
141
+ };
142
+ 最后更新时间: {
143
+ type: number;
144
+ ui_type: string;
145
+ desc: string;
146
+ };
147
+ 创建人: {
148
+ type: number;
149
+ ui_type: string;
150
+ desc: string;
151
+ };
152
+ 修改人: {
153
+ type: number;
154
+ ui_type: string;
155
+ desc: string;
156
+ };
157
+ 自动编号: {
158
+ type: number;
159
+ ui_type: string;
160
+ desc: string;
161
+ };
158
162
  };
159
163
  export declare class BitableFieldBase extends AbstractBaseBitable {
160
- readonly logger: Logger;
161
- bitablePath: appTableFieldCreatePath;
162
- bitableUrl: string;
163
- constructor(feishuBaseInstance: FeishuBasePlus, bitableUrl: string);
164
- setBitablePath(path: appTableFieldCreatePath | string): Promise<{
165
- app_token: string;
166
- table_id: string;
167
- }>;
168
- getBitablePath(bitableUrl?: string): Promise<{
169
- app_token: string;
170
- table_id: string;
171
- }>;
172
- batchFieldList(batchFieldListPayload: appTableFieldCreateData[]): Promise<boolean>;
173
- sleep(ms: any): Promise<unknown>;
174
- updateField(payloadData: appTableFieldCreateData, field_id?: string): Promise<{
175
- field?: {
176
- field_name: string;
177
- type: number;
178
- property?: {
179
- options?: {
180
- name?: string | undefined;
181
- id?: string | undefined;
182
- color?: number | undefined;
183
- }[] | undefined;
164
+ readonly logger: Logger;
165
+ bitablePath: appTableFieldCreatePath;
166
+ bitableUrl: string;
167
+ constructor(feishuBaseInstance: FeishuBasePlus, bitableUrl: string);
168
+ setBitablePath(path: appTableFieldCreatePath | string): Promise<{
169
+ app_token: string;
170
+ table_id: string;
171
+ }>;
172
+ getBitablePath(bitableUrl?: string): Promise<{
173
+ app_token: string;
174
+ table_id: string;
175
+ }>;
176
+ batchFieldList(
177
+ batchFieldListPayload: appTableFieldCreateData[],
178
+ ): Promise<boolean>;
179
+ sleep(ms: any): Promise<unknown>;
180
+ updateField(
181
+ payloadData: appTableFieldCreateData,
182
+ field_id?: string,
183
+ ): Promise<{
184
+ field?:
185
+ | {
186
+ field_name: string;
187
+ type: number;
188
+ property?:
189
+ | {
190
+ options?:
191
+ | {
192
+ name?: string | undefined;
193
+ id?: string | undefined;
194
+ color?: number | undefined;
195
+ }[]
196
+ | undefined;
184
197
  formatter?: string | undefined;
185
198
  date_formatter?: string | undefined;
186
199
  auto_fill?: boolean | undefined;
@@ -188,63 +201,122 @@ export declare class BitableFieldBase extends AbstractBaseBitable {
188
201
  table_id?: string | undefined;
189
202
  table_name?: string | undefined;
190
203
  back_field_name?: string | undefined;
191
- auto_serial?: {
192
- type: "custom" | "auto_increment_number";
193
- options?: {
194
- type: "system_number" | "fixed_text" | "created_time";
195
- value: string;
196
- }[] | undefined;
197
- } | undefined;
198
- location?: {
199
- input_type: "only_mobile" | "not_limit";
200
- } | undefined;
204
+ auto_serial?:
205
+ | {
206
+ type: 'custom' | 'auto_increment_number';
207
+ options?:
208
+ | {
209
+ type:
210
+ | 'system_number'
211
+ | 'fixed_text'
212
+ | 'created_time';
213
+ value: string;
214
+ }[]
215
+ | undefined;
216
+ }
217
+ | undefined;
218
+ location?:
219
+ | {
220
+ input_type: 'only_mobile' | 'not_limit';
221
+ }
222
+ | undefined;
201
223
  formula_expression?: string | undefined;
202
- allowed_edit_modes?: {
203
- manual?: boolean | undefined;
204
- scan?: boolean | undefined;
205
- } | undefined;
224
+ allowed_edit_modes?:
225
+ | {
226
+ manual?: boolean | undefined;
227
+ scan?: boolean | undefined;
228
+ }
229
+ | undefined;
206
230
  min?: number | undefined;
207
231
  max?: number | undefined;
208
232
  range_customize?: boolean | undefined;
209
233
  currency_code?: string | undefined;
210
- rating?: {
211
- symbol?: string | undefined;
212
- } | undefined;
213
- type?: {
214
- data_type: number;
215
- ui_property?: {
216
- currency_code?: string | undefined;
217
- formatter?: string | undefined;
218
- range_customize?: boolean | undefined;
219
- min?: number | undefined;
220
- max?: number | undefined;
221
- date_formatter?: string | undefined;
222
- rating?: {
223
- symbol?: string | undefined;
224
- } | undefined;
225
- } | undefined;
226
- ui_type?: "Number" | "Progress" | "Currency" | "Rating" | "DateTime" | undefined;
227
- } | undefined;
228
- } | undefined;
229
- description?: {
234
+ rating?:
235
+ | {
236
+ symbol?: string | undefined;
237
+ }
238
+ | undefined;
239
+ type?:
240
+ | {
241
+ data_type: number;
242
+ ui_property?:
243
+ | {
244
+ currency_code?: string | undefined;
245
+ formatter?: string | undefined;
246
+ range_customize?: boolean | undefined;
247
+ min?: number | undefined;
248
+ max?: number | undefined;
249
+ date_formatter?: string | undefined;
250
+ rating?:
251
+ | {
252
+ symbol?: string | undefined;
253
+ }
254
+ | undefined;
255
+ }
256
+ | undefined;
257
+ ui_type?:
258
+ | 'Number'
259
+ | 'Progress'
260
+ | 'Currency'
261
+ | 'Rating'
262
+ | 'DateTime'
263
+ | undefined;
264
+ }
265
+ | undefined;
266
+ }
267
+ | undefined;
268
+ description?:
269
+ | {
230
270
  disable_sync?: boolean | undefined;
231
271
  text?: string | undefined;
232
- } | undefined;
233
- is_primary?: boolean | undefined;
234
- field_id?: string | undefined;
235
- 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;
236
- is_hidden?: boolean | undefined;
237
- } | undefined;
238
- }>;
239
- getFieldList(): Promise<{
240
- field_name: string;
241
- type: number;
242
- property?: {
243
- options?: {
244
- name?: string | undefined;
245
- id?: string | undefined;
246
- color?: number | undefined;
247
- }[] | undefined;
272
+ }
273
+ | undefined;
274
+ is_primary?: boolean | undefined;
275
+ field_id?: string | undefined;
276
+ ui_type?:
277
+ | 'Text'
278
+ | 'Barcode'
279
+ | 'Number'
280
+ | 'Progress'
281
+ | 'Currency'
282
+ | 'Rating'
283
+ | 'SingleSelect'
284
+ | 'MultiSelect'
285
+ | 'DateTime'
286
+ | 'Checkbox'
287
+ | 'User'
288
+ | 'GroupChat'
289
+ | 'Phone'
290
+ | 'Url'
291
+ | 'Attachment'
292
+ | 'SingleLink'
293
+ | 'Formula'
294
+ | 'DuplexLink'
295
+ | 'Location'
296
+ | 'CreatedTime'
297
+ | 'ModifiedTime'
298
+ | 'CreatedUser'
299
+ | 'ModifiedUser'
300
+ | 'AutoNumber'
301
+ | 'Email'
302
+ | undefined;
303
+ is_hidden?: boolean | undefined;
304
+ }
305
+ | undefined;
306
+ }>;
307
+ getFieldList(): Promise<
308
+ {
309
+ field_name: string;
310
+ type: number;
311
+ property?:
312
+ | {
313
+ options?:
314
+ | {
315
+ name?: string | undefined;
316
+ id?: string | undefined;
317
+ color?: number | undefined;
318
+ }[]
319
+ | undefined;
248
320
  formatter?: string | undefined;
249
321
  date_formatter?: string | undefined;
250
322
  auto_fill?: boolean | undefined;
@@ -252,58 +324,117 @@ export declare class BitableFieldBase extends AbstractBaseBitable {
252
324
  table_id?: string | undefined;
253
325
  table_name?: string | undefined;
254
326
  back_field_name?: string | undefined;
255
- auto_serial?: {
256
- type: "custom" | "auto_increment_number";
257
- options?: {
258
- type: "system_number" | "fixed_text" | "created_time";
259
- value: string;
260
- }[] | undefined;
261
- } | undefined;
262
- location?: {
263
- input_type: "only_mobile" | "not_limit";
264
- } | undefined;
327
+ auto_serial?:
328
+ | {
329
+ type: 'custom' | 'auto_increment_number';
330
+ options?:
331
+ | {
332
+ type: 'system_number' | 'fixed_text' | 'created_time';
333
+ value: string;
334
+ }[]
335
+ | undefined;
336
+ }
337
+ | undefined;
338
+ location?:
339
+ | {
340
+ input_type: 'only_mobile' | 'not_limit';
341
+ }
342
+ | undefined;
265
343
  formula_expression?: string | undefined;
266
- allowed_edit_modes?: {
267
- manual?: boolean | undefined;
268
- scan?: boolean | undefined;
269
- } | undefined;
344
+ allowed_edit_modes?:
345
+ | {
346
+ manual?: boolean | undefined;
347
+ scan?: boolean | undefined;
348
+ }
349
+ | undefined;
270
350
  min?: number | undefined;
271
351
  max?: number | undefined;
272
352
  range_customize?: boolean | undefined;
273
353
  currency_code?: string | undefined;
274
- rating?: {
275
- symbol?: string | undefined;
276
- } | undefined;
277
- type?: {
278
- data_type: number;
279
- ui_property?: {
280
- currency_code?: string | undefined;
281
- formatter?: string | undefined;
282
- range_customize?: boolean | undefined;
283
- min?: number | undefined;
284
- max?: number | undefined;
285
- date_formatter?: string | undefined;
286
- rating?: {
287
- symbol?: string | undefined;
288
- } | undefined;
289
- } | undefined;
290
- ui_type?: "Number" | "Progress" | "Currency" | "Rating" | "DateTime" | undefined;
291
- } | undefined;
292
- } | undefined;
293
- description?: string | undefined;
294
- is_primary?: boolean | undefined;
295
- field_id?: string | undefined;
296
- 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;
297
- is_hidden?: boolean | undefined;
298
- }[]>;
299
- getAppTableList(path: appTableFieldCreatePath): Promise<{
300
- table_id?: string | undefined;
301
- revision?: number | undefined;
302
- name?: string | undefined;
303
- }[]>;
304
- getTargetTable(bitableUrl: string, tableName: any, batchFieldListPayload: appTableCreateData[]): Promise<{
305
- table_id: string;
306
- app_token: string;
307
- }>;
308
- getAppTableCreate(tableName: string, appToken: string, batchFieldListPayload: appTableCreateData[]): Promise<string>;
354
+ rating?:
355
+ | {
356
+ symbol?: string | undefined;
357
+ }
358
+ | undefined;
359
+ type?:
360
+ | {
361
+ data_type: number;
362
+ ui_property?:
363
+ | {
364
+ currency_code?: string | undefined;
365
+ formatter?: string | undefined;
366
+ range_customize?: boolean | undefined;
367
+ min?: number | undefined;
368
+ max?: number | undefined;
369
+ date_formatter?: string | undefined;
370
+ rating?:
371
+ | {
372
+ symbol?: string | undefined;
373
+ }
374
+ | undefined;
375
+ }
376
+ | undefined;
377
+ ui_type?:
378
+ | 'Number'
379
+ | 'Progress'
380
+ | 'Currency'
381
+ | 'Rating'
382
+ | 'DateTime'
383
+ | undefined;
384
+ }
385
+ | undefined;
386
+ }
387
+ | undefined;
388
+ description?: string | undefined;
389
+ is_primary?: boolean | undefined;
390
+ field_id?: string | undefined;
391
+ ui_type?:
392
+ | 'Text'
393
+ | 'Barcode'
394
+ | 'Number'
395
+ | 'Progress'
396
+ | 'Currency'
397
+ | 'Rating'
398
+ | 'SingleSelect'
399
+ | 'MultiSelect'
400
+ | 'DateTime'
401
+ | 'Checkbox'
402
+ | 'User'
403
+ | 'GroupChat'
404
+ | 'Phone'
405
+ | 'Url'
406
+ | 'Attachment'
407
+ | 'SingleLink'
408
+ | 'Formula'
409
+ | 'DuplexLink'
410
+ | 'Location'
411
+ | 'CreatedTime'
412
+ | 'ModifiedTime'
413
+ | 'CreatedUser'
414
+ | 'ModifiedUser'
415
+ | 'AutoNumber'
416
+ | undefined;
417
+ is_hidden?: boolean | undefined;
418
+ }[]
419
+ >;
420
+ getAppTableList(path: appTableFieldCreatePath): Promise<
421
+ {
422
+ table_id?: string | undefined;
423
+ revision?: number | undefined;
424
+ name?: string | undefined;
425
+ }[]
426
+ >;
427
+ getTargetTable(
428
+ bitableUrl: string,
429
+ tableName: any,
430
+ batchFieldListPayload: appTableCreateData[],
431
+ ): Promise<{
432
+ table_id: string;
433
+ app_token: string;
434
+ }>;
435
+ getAppTableCreate(
436
+ tableName: string,
437
+ appToken: string,
438
+ batchFieldListPayload: appTableCreateData[],
439
+ ): Promise<string>;
309
440
  }