@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-record.d.ts CHANGED
@@ -2,213 +2,327 @@ import { Client } from '@larksuiteoapi/node-sdk';
2
2
  import { Logger } from '@nestjs/common';
3
3
  import { BitableFieldBase } from './bitable-base-field';
4
4
  import { FeishuBasePlus } from './feishu-base-plus';
5
- import { TypeAppTablePath, TypeAppTableRecordSearchPayloadData, TypeAppTableRecordSearchPayloadParams } from './type.bitable';
6
- import { appTableFieldCreatePath, AppTableRecordRecordField, typeAppTableRecordCreateFields, TypeBitablePath } from './types';
5
+ import {
6
+ TypeAppTablePath,
7
+ TypeAppTableRecordSearchPayloadData,
8
+ TypeAppTableRecordSearchPayloadParams,
9
+ } from './type.bitable';
10
+ import {
11
+ appTableFieldCreatePath,
12
+ AppTableRecordRecordField,
13
+ typeAppTableRecordCreateFields,
14
+ TypeBitablePath,
15
+ } from './types';
7
16
  export declare class BitableRecordBase extends BitableFieldBase {
8
- logger: Logger;
9
- bitablePath: appTableFieldCreatePath;
10
- larkClient: Client;
11
- static instance: Map<string, BitableRecordBase>;
12
- constructor(feishuBaseInstance: FeishuBasePlus, bitableUrl: string);
13
- getBitablePath(bitableUrl: string): Promise<TypeBitablePath>;
14
- setBitablePath(path: appTableFieldCreatePath | string): Promise<{
15
- app_token: string;
16
- table_id: string;
17
- }>;
18
- getRecordById<T = AppTableRecordRecordField>(record_id: string, bitableUrl?: string, user_id_type?: 'open_id' | 'user_id' | 'union_id'): Promise<T>;
19
- batchGetRecord<T = AppTableRecordRecordField>(record_ids: string[], bitableUrl?: string, user_id_type?: 'open_id' | 'user_id' | 'union_id'): Promise<T[]>;
20
- recordUpdate(record_id: string, fields: any, bitableUrl?: string): Promise<{
21
- fields: Record<string, string | number | number | number | boolean | {
22
- text?: string;
23
- link?: string;
24
- } | {
25
- location?: string;
26
- pname?: string;
27
- cityname?: string;
28
- adname?: string;
29
- address?: string;
30
- name?: string;
31
- full_address?: string;
32
- } | Array<{
33
- id?: string;
34
- name?: string;
35
- avatar_url?: string;
36
- }> | Array<string> | Array<{
37
- id?: string;
38
- name?: string;
39
- en_name?: string;
40
- email?: string;
41
- avatar_url?: string;
42
- }> | Array<{
43
- file_token?: string;
44
- name?: string;
45
- type?: string;
46
- size?: number;
47
- url?: string;
48
- tmp_url?: string;
49
- }>>;
50
- record_id?: string | undefined;
51
- created_by?: {
52
- id?: string | undefined;
53
- name?: string | undefined;
54
- en_name?: string | undefined;
55
- email?: string | undefined;
56
- avatar_url?: string | undefined;
57
- } | undefined;
58
- created_time?: number | undefined;
59
- last_modified_by?: {
60
- id?: string | undefined;
61
- name?: string | undefined;
62
- en_name?: string | undefined;
63
- email?: string | undefined;
64
- avatar_url?: string | undefined;
65
- } | undefined;
66
- last_modified_time?: number | undefined;
67
- shared_url?: string | undefined;
68
- record_url?: string | undefined;
69
- }>;
70
- search(payloadData: TypeAppTableRecordSearchPayloadData, payloadParams: TypeAppTableRecordSearchPayloadParams, path: TypeAppTablePath): Promise<{
71
- code?: number | undefined;
72
- msg?: string | undefined;
73
- data?: {
74
- items?: {
75
- fields: Record<string, string | number | number | number | boolean | {
76
- text?: string;
77
- link?: string;
78
- } | {
79
- location?: string;
80
- pname?: string;
81
- cityname?: string;
82
- adname?: string;
83
- address?: string;
84
- name?: string;
85
- full_address?: string;
86
- } | Array<{
87
- id?: string;
88
- name?: string;
89
- avatar_url?: string;
90
- }> | Array<string> | Array<{
91
- id?: string;
92
- name?: string;
93
- en_name?: string;
94
- email?: string;
95
- avatar_url?: string;
96
- }> | Array<{
97
- file_token?: string;
98
- name?: string;
99
- type?: string;
100
- size?: number;
101
- url?: string;
102
- tmp_url?: string;
103
- }>>;
17
+ logger: Logger;
18
+ bitablePath: appTableFieldCreatePath;
19
+ larkClient: Client;
20
+ static instance: Map<string, BitableRecordBase>;
21
+ constructor(feishuBaseInstance: FeishuBasePlus, bitableUrl: string);
22
+ getBitablePath(bitableUrl: string): Promise<TypeBitablePath>;
23
+ setBitablePath(path: appTableFieldCreatePath | string): Promise<{
24
+ app_token: string;
25
+ table_id: string;
26
+ }>;
27
+ getRecordById<T = AppTableRecordRecordField>(
28
+ record_id: string,
29
+ bitableUrl?: string,
30
+ user_id_type?: 'open_id' | 'user_id' | 'union_id',
31
+ ): Promise<T>;
32
+ batchGetRecord<T = AppTableRecordRecordField>(
33
+ record_ids: string[],
34
+ bitableUrl?: string,
35
+ user_id_type?: 'open_id' | 'user_id' | 'union_id',
36
+ ): Promise<T[]>;
37
+ recordUpdate(
38
+ record_id: string,
39
+ fields: any,
40
+ bitableUrl?: string,
41
+ ): Promise<{
42
+ fields: Record<
43
+ string,
44
+ | string
45
+ | number
46
+ | number
47
+ | number
48
+ | boolean
49
+ | {
50
+ text?: string;
51
+ link?: string;
52
+ }
53
+ | {
54
+ location?: string;
55
+ pname?: string;
56
+ cityname?: string;
57
+ adname?: string;
58
+ address?: string;
59
+ name?: string;
60
+ full_address?: string;
61
+ }
62
+ | Array<{
63
+ id?: string;
64
+ name?: string;
65
+ avatar_url?: string;
66
+ }>
67
+ | Array<string>
68
+ | Array<{
69
+ id?: string;
70
+ name?: string;
71
+ en_name?: string;
72
+ email?: string;
73
+ avatar_url?: string;
74
+ }>
75
+ | Array<{
76
+ file_token?: string;
77
+ name?: string;
78
+ type?: string;
79
+ size?: number;
80
+ url?: string;
81
+ tmp_url?: string;
82
+ }>
83
+ >;
84
+ record_id?: string | undefined;
85
+ created_by?:
86
+ | {
87
+ id?: string | undefined;
88
+ name?: string | undefined;
89
+ en_name?: string | undefined;
90
+ email?: string | undefined;
91
+ avatar_url?: string | undefined;
92
+ }
93
+ | undefined;
94
+ created_time?: number | undefined;
95
+ last_modified_by?:
96
+ | {
97
+ id?: string | undefined;
98
+ name?: string | undefined;
99
+ en_name?: string | undefined;
100
+ email?: string | undefined;
101
+ avatar_url?: string | undefined;
102
+ }
103
+ | undefined;
104
+ last_modified_time?: number | undefined;
105
+ shared_url?: string | undefined;
106
+ record_url?: string | undefined;
107
+ }>;
108
+ search(
109
+ payloadData: TypeAppTableRecordSearchPayloadData,
110
+ payloadParams: TypeAppTableRecordSearchPayloadParams,
111
+ path: TypeAppTablePath,
112
+ ): Promise<{
113
+ code?: number | undefined;
114
+ msg?: string | undefined;
115
+ data?:
116
+ | {
117
+ items?:
118
+ | {
119
+ fields: Record<
120
+ string,
121
+ | string
122
+ | number
123
+ | number
124
+ | number
125
+ | boolean
126
+ | {
127
+ text?: string;
128
+ link?: string;
129
+ }
130
+ | {
131
+ location?: string;
132
+ pname?: string;
133
+ cityname?: string;
134
+ adname?: string;
135
+ address?: string;
136
+ name?: string;
137
+ full_address?: string;
138
+ }
139
+ | Array<{
140
+ id?: string;
141
+ name?: string;
142
+ avatar_url?: string;
143
+ }>
144
+ | Array<string>
145
+ | Array<{
146
+ id?: string;
147
+ name?: string;
148
+ en_name?: string;
149
+ email?: string;
150
+ avatar_url?: string;
151
+ }>
152
+ | Array<{
153
+ file_token?: string;
154
+ name?: string;
155
+ type?: string;
156
+ size?: number;
157
+ url?: string;
158
+ tmp_url?: string;
159
+ }>
160
+ >;
104
161
  record_id?: string | undefined;
105
- created_by?: {
106
- id?: string | undefined;
107
- name?: string | undefined;
108
- en_name?: string | undefined;
109
- email?: string | undefined;
110
- avatar_url?: string | undefined;
111
- } | undefined;
162
+ created_by?:
163
+ | {
164
+ id?: string | undefined;
165
+ name?: string | undefined;
166
+ en_name?: string | undefined;
167
+ email?: string | undefined;
168
+ avatar_url?: string | undefined;
169
+ }
170
+ | undefined;
112
171
  created_time?: number | undefined;
113
- last_modified_by?: {
114
- id?: string | undefined;
115
- name?: string | undefined;
116
- en_name?: string | undefined;
117
- email?: string | undefined;
118
- avatar_url?: string | undefined;
119
- } | undefined;
172
+ last_modified_by?:
173
+ | {
174
+ id?: string | undefined;
175
+ name?: string | undefined;
176
+ en_name?: string | undefined;
177
+ email?: string | undefined;
178
+ avatar_url?: string | undefined;
179
+ }
180
+ | undefined;
120
181
  last_modified_time?: number | undefined;
121
182
  shared_url?: string | undefined;
122
183
  record_url?: string | undefined;
123
- }[] | undefined;
124
- has_more?: boolean | undefined;
125
- page_token?: string | undefined;
126
- total?: number | undefined;
127
- } | undefined;
128
- }>;
129
- searchAllRecord<T = AppTableRecordRecordField>(payloadData: TypeAppTableRecordSearchPayloadData, payloadParams: TypeAppTableRecordSearchPayloadParams, path: TypeAppTablePath): Promise<T[]>;
130
- createRecord<T extends Record<string, any> = typeAppTableRecordCreateFields>(fields: T): Promise<{
131
- code?: number | undefined;
132
- msg?: string | undefined;
133
- data?: {
134
- record?: {
135
- fields: Record<string, string | number | number | number | boolean | {
136
- text?: string;
137
- link?: string;
138
- } | {
139
- location?: string;
140
- pname?: string;
141
- cityname?: string;
142
- adname?: string;
143
- address?: string;
144
- name?: string;
145
- full_address?: string;
146
- } | Array<{
147
- id?: string;
148
- name?: string;
149
- avatar_url?: string;
150
- }> | Array<string> | Array<{
151
- id?: string;
152
- name?: string;
153
- en_name?: string;
154
- email?: string;
155
- avatar_url?: string;
156
- }> | Array<{
157
- file_token?: string;
158
- name?: string;
159
- type?: string;
160
- size?: number;
161
- url?: string;
162
- tmp_url?: string;
163
- }>>;
184
+ }[]
185
+ | undefined;
186
+ has_more?: boolean | undefined;
187
+ page_token?: string | undefined;
188
+ total?: number | undefined;
189
+ }
190
+ | undefined;
191
+ }>;
192
+ searchAllRecord<T = AppTableRecordRecordField>(
193
+ payloadData: TypeAppTableRecordSearchPayloadData,
194
+ payloadParams: TypeAppTableRecordSearchPayloadParams,
195
+ path: TypeAppTablePath,
196
+ ): Promise<T[]>;
197
+ createRecord<T extends Record<string, any> = typeAppTableRecordCreateFields>(
198
+ fields: T,
199
+ ): Promise<{
200
+ code?: number | undefined;
201
+ msg?: string | undefined;
202
+ data?:
203
+ | {
204
+ record?:
205
+ | {
206
+ fields: Record<
207
+ string,
208
+ | string
209
+ | number
210
+ | number
211
+ | number
212
+ | boolean
213
+ | {
214
+ text?: string;
215
+ link?: string;
216
+ }
217
+ | {
218
+ location?: string;
219
+ pname?: string;
220
+ cityname?: string;
221
+ adname?: string;
222
+ address?: string;
223
+ name?: string;
224
+ full_address?: string;
225
+ }
226
+ | Array<{
227
+ id?: string;
228
+ name?: string;
229
+ avatar_url?: string;
230
+ }>
231
+ | Array<string>
232
+ | Array<{
233
+ id?: string;
234
+ name?: string;
235
+ en_name?: string;
236
+ email?: string;
237
+ avatar_url?: string;
238
+ }>
239
+ | Array<{
240
+ file_token?: string;
241
+ name?: string;
242
+ type?: string;
243
+ size?: number;
244
+ url?: string;
245
+ tmp_url?: string;
246
+ }>
247
+ >;
164
248
  record_id?: string | undefined;
165
- created_by?: {
166
- id?: string | undefined;
167
- name?: string | undefined;
168
- en_name?: string | undefined;
169
- email?: string | undefined;
170
- avatar_url?: string | undefined;
171
- } | undefined;
249
+ created_by?:
250
+ | {
251
+ id?: string | undefined;
252
+ name?: string | undefined;
253
+ en_name?: string | undefined;
254
+ email?: string | undefined;
255
+ avatar_url?: string | undefined;
256
+ }
257
+ | undefined;
172
258
  created_time?: number | undefined;
173
- last_modified_by?: {
174
- id?: string | undefined;
175
- name?: string | undefined;
176
- en_name?: string | undefined;
177
- email?: string | undefined;
178
- avatar_url?: string | undefined;
179
- } | undefined;
259
+ last_modified_by?:
260
+ | {
261
+ id?: string | undefined;
262
+ name?: string | undefined;
263
+ en_name?: string | undefined;
264
+ email?: string | undefined;
265
+ avatar_url?: string | undefined;
266
+ }
267
+ | undefined;
180
268
  last_modified_time?: number | undefined;
181
269
  shared_url?: string | undefined;
182
270
  record_url?: string | undefined;
183
- } | undefined;
184
- } | undefined;
185
- }>;
186
- protected fetchBatchBitTableParamsChunk(records: any[], chunkSize?: number): any;
187
- appTableRecordBatchDelete(records: string[], bitablePath: TypeBitablePath): Promise<{
188
- fail: number;
189
- success: number;
190
- }>;
191
- batchBitableControl(records: any, bitablePath: TypeBitablePath, chunkSize?: number, user_id_type?: 'open_id' | 'user_id' | 'union_id'): Promise<{
192
- edit: {
193
- successTotal: number;
194
- failTotal: number;
195
- total: number;
196
- title: string;
197
- };
198
- add: {
199
- successTotal: number;
200
- failTotal: number;
201
- total: number;
202
- title: string;
203
- };
204
- }>;
205
- updateBitableRecords(recordsList: any[], opType: 'edit' | 'add', bitablePath: any, chunkSize?: number, user_id_type?: 'open_id' | 'user_id' | 'union_id'): Promise<{
206
- successTotal: number;
207
- failTotal: number;
208
- total: number;
209
- title: string;
210
- }>;
211
- getRecordIdsMap(records: any[], fieldsKey: string, type?: string): Map<string, {
212
- record_id: any;
213
- }>;
271
+ }
272
+ | undefined;
273
+ }
274
+ | undefined;
275
+ }>;
276
+ protected fetchBatchBitTableParamsChunk(
277
+ records: any[],
278
+ chunkSize?: number,
279
+ ): any;
280
+ appTableRecordBatchDelete(
281
+ records: string[],
282
+ bitablePath: TypeBitablePath,
283
+ ): Promise<{
284
+ fail: number;
285
+ success: number;
286
+ }>;
287
+ batchBitableControl(
288
+ records: any,
289
+ bitablePath: TypeBitablePath,
290
+ chunkSize?: number,
291
+ user_id_type?: 'open_id' | 'user_id' | 'union_id',
292
+ ): Promise<{
293
+ edit: {
294
+ successTotal: number;
295
+ failTotal: number;
296
+ total: number;
297
+ title: string;
298
+ };
299
+ add: {
300
+ successTotal: number;
301
+ failTotal: number;
302
+ total: number;
303
+ title: string;
304
+ };
305
+ }>;
306
+ updateBitableRecords(
307
+ recordsList: any[],
308
+ opType: 'edit' | 'add',
309
+ bitablePath: any,
310
+ chunkSize?: number,
311
+ user_id_type?: 'open_id' | 'user_id' | 'union_id',
312
+ ): Promise<{
313
+ successTotal: number;
314
+ failTotal: number;
315
+ total: number;
316
+ title: string;
317
+ }>;
318
+ getRecordIdsMap(
319
+ records: any[],
320
+ fieldsKey: string,
321
+ type?: string,
322
+ ): Map<
323
+ string,
324
+ {
325
+ record_id: any;
326
+ }
327
+ >;
214
328
  }