@tachybase/plugin-auth-dingtalk 1.3.17 → 1.3.19

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.
@@ -1 +1 @@
1
- {"name":"@alicloud/dingtalk","version":"2.1.75","description":"","main":"dist/index.js","scripts":{"test":"mocha --reporter spec --timeout 3000 test/*.test.js","test-cov":"nyc -e .ts -r=html -r=text -r=lcov npm run test","build":"tsc","prepublishOnly":"tsc"},"author":"Alibaba Cloud SDK","license":"Apache-2.0","devDependencies":{"@types/node":"^16.0.0","nyc":"^15.0.0","source-map-support":"^0.5.16","ts-node":"^10.0.0","typescript":"^5"},"dependencies":{"@alicloud/tea-typescript":"^1.7.1","@alicloud/openapi-client":"^0.4.12","@alicloud/tea-util":"^1.4.9","@alicloud/openapi-util":"^0.3.2","@alicloud/endpoint-util":"^0.0.1","@alicloud/gateway-spi":"^0.0.8","@alicloud/gateway-dingtalk":"^1.0.2"},"files":["dist","src","*.js"],"_lastModified":"2025-07-04T04:00:06.450Z"}
1
+ {"name":"@alicloud/dingtalk","version":"2.1.75","description":"","main":"dist/index.js","scripts":{"test":"mocha --reporter spec --timeout 3000 test/*.test.js","test-cov":"nyc -e .ts -r=html -r=text -r=lcov npm run test","build":"tsc","prepublishOnly":"tsc"},"author":"Alibaba Cloud SDK","license":"Apache-2.0","devDependencies":{"@types/node":"^16.0.0","nyc":"^15.0.0","source-map-support":"^0.5.16","ts-node":"^10.0.0","typescript":"^5"},"dependencies":{"@alicloud/tea-typescript":"^1.7.1","@alicloud/openapi-client":"^0.4.12","@alicloud/tea-util":"^1.4.9","@alicloud/openapi-util":"^0.3.2","@alicloud/endpoint-util":"^0.0.1","@alicloud/gateway-spi":"^0.0.8","@alicloud/gateway-dingtalk":"^1.0.2"},"files":["dist","src","*.js"],"_lastModified":"2025-07-17T10:57:39.337Z"}
@@ -1,10 +1,10 @@
1
- /// <reference types="node" />
2
1
  /**
2
+ * @remarks
3
3
  * This is for OpenApi SDK
4
4
  */
5
5
  import * as $Util from '@alicloud/tea-util';
6
6
  import Credential from '@alicloud/credentials';
7
- import SPI from '@alicloud/gateway-spi';
7
+ import SPI, * as $SPI from '@alicloud/gateway-spi';
8
8
  import { Readable } from 'stream';
9
9
  import * as $tea from '@alicloud/tea-typescript';
10
10
  export declare class GlobalParameters extends $tea.Model {
@@ -25,39 +25,247 @@ export declare class GlobalParameters extends $tea.Model {
25
25
  });
26
26
  }
27
27
  /**
28
+ * @remarks
28
29
  * Model for initing client
29
30
  */
30
31
  export declare class Config extends $tea.Model {
32
+ /**
33
+ * @remarks
34
+ * accesskey id
35
+ */
31
36
  accessKeyId?: string;
37
+ /**
38
+ * @remarks
39
+ * accesskey secret
40
+ */
32
41
  accessKeySecret?: string;
42
+ /**
43
+ * @remarks
44
+ * security token
45
+ *
46
+ * @example
47
+ * a.txt
48
+ */
33
49
  securityToken?: string;
50
+ /**
51
+ * @remarks
52
+ * bearer token
53
+ *
54
+ * @example
55
+ * the-bearer-token
56
+ */
34
57
  bearerToken?: string;
58
+ /**
59
+ * @remarks
60
+ * http protocol
61
+ *
62
+ * @example
63
+ * http
64
+ */
35
65
  protocol?: string;
66
+ /**
67
+ * @remarks
68
+ * http method
69
+ *
70
+ * @example
71
+ * GET
72
+ */
36
73
  method?: string;
74
+ /**
75
+ * @remarks
76
+ * region id
77
+ *
78
+ * @example
79
+ * cn-hangzhou
80
+ */
37
81
  regionId?: string;
82
+ /**
83
+ * @remarks
84
+ * read timeout
85
+ *
86
+ * @example
87
+ * 10
88
+ */
38
89
  readTimeout?: number;
90
+ /**
91
+ * @remarks
92
+ * connect timeout
93
+ *
94
+ * @example
95
+ * 10
96
+ */
39
97
  connectTimeout?: number;
98
+ /**
99
+ * @remarks
100
+ * http proxy
101
+ *
102
+ * @example
103
+ * http://localhost
104
+ */
40
105
  httpProxy?: string;
106
+ /**
107
+ * @remarks
108
+ * https proxy
109
+ *
110
+ * @example
111
+ * https://localhost
112
+ */
41
113
  httpsProxy?: string;
114
+ /**
115
+ * @remarks
116
+ * credential
117
+ */
42
118
  credential?: Credential;
119
+ /**
120
+ * @remarks
121
+ * endpoint
122
+ *
123
+ * @example
124
+ * cs.aliyuncs.com
125
+ */
43
126
  endpoint?: string;
127
+ /**
128
+ * @remarks
129
+ * proxy white list
130
+ *
131
+ * @example
132
+ * http://localhost
133
+ */
44
134
  noProxy?: string;
135
+ /**
136
+ * @remarks
137
+ * max idle conns
138
+ *
139
+ * @example
140
+ * 3
141
+ */
45
142
  maxIdleConns?: number;
143
+ /**
144
+ * @remarks
145
+ * network for endpoint
146
+ *
147
+ * @example
148
+ * public
149
+ */
46
150
  network?: string;
151
+ /**
152
+ * @remarks
153
+ * user agent
154
+ *
155
+ * @example
156
+ * Alibabacloud/1
157
+ */
47
158
  userAgent?: string;
159
+ /**
160
+ * @remarks
161
+ * suffix for endpoint
162
+ *
163
+ * @example
164
+ * aliyun
165
+ */
48
166
  suffix?: string;
167
+ /**
168
+ * @remarks
169
+ * socks5 proxy
170
+ */
49
171
  socks5Proxy?: string;
172
+ /**
173
+ * @remarks
174
+ * socks5 network
175
+ *
176
+ * @example
177
+ * TCP
178
+ */
50
179
  socks5NetWork?: string;
180
+ /**
181
+ * @remarks
182
+ * endpoint type
183
+ *
184
+ * @example
185
+ * internal
186
+ */
51
187
  endpointType?: string;
188
+ /**
189
+ * @remarks
190
+ * OpenPlatform endpoint
191
+ *
192
+ * @example
193
+ * openplatform.aliyuncs.com
194
+ */
52
195
  openPlatformEndpoint?: string;
196
+ /**
197
+ * @remarks
198
+ * credential type
199
+ *
200
+ * @example
201
+ * access_key
202
+ *
203
+ * @deprecated
204
+ */
53
205
  type?: string;
206
+ /**
207
+ * @remarks
208
+ * Signature Version
209
+ *
210
+ * @example
211
+ * v1
212
+ */
54
213
  signatureVersion?: string;
214
+ /**
215
+ * @remarks
216
+ * Signature Algorithm
217
+ *
218
+ * @example
219
+ * ACS3-HMAC-SHA256
220
+ */
55
221
  signatureAlgorithm?: string;
222
+ /**
223
+ * @remarks
224
+ * Global Parameters
225
+ */
56
226
  globalParameters?: GlobalParameters;
227
+ /**
228
+ * @remarks
229
+ * privite key for client certificate
230
+ *
231
+ * @example
232
+ * MIIEvQ
233
+ */
57
234
  key?: string;
235
+ /**
236
+ * @remarks
237
+ * client certificate
238
+ *
239
+ * @example
240
+ * -----BEGIN CERTIFICATE-----
241
+ * xxx-----END CERTIFICATE-----
242
+ */
58
243
  cert?: string;
244
+ /**
245
+ * @remarks
246
+ * server certificate
247
+ *
248
+ * @example
249
+ * -----BEGIN CERTIFICATE-----
250
+ * xxx-----END CERTIFICATE-----
251
+ */
59
252
  ca?: string;
253
+ /**
254
+ * @remarks
255
+ * disable HTTP/2
256
+ *
257
+ * @example
258
+ * false
259
+ */
60
260
  disableHttp2?: boolean;
261
+ /**
262
+ * @remarks
263
+ * TLS Minimum Version
264
+ *
265
+ * @example
266
+ * TLSv1, TLSv1.1, TLSv1.2, TLSv1.3
267
+ */
268
+ tlsMinVersion?: string;
61
269
  static names(): {
62
270
  [key: string]: string;
63
271
  };
@@ -146,84 +354,98 @@ export default class Client {
146
354
  _cert: string;
147
355
  _ca: string;
148
356
  _disableHttp2: boolean;
357
+ _tlsMinVersion: string;
358
+ _attributeMap: $SPI.AttributeMap;
149
359
  /**
360
+ * @remarks
150
361
  * Init client with Config
151
- * @param config config contains the necessary information to create a client
362
+ *
363
+ * @param config - config contains the necessary information to create a client
152
364
  */
153
365
  constructor(config: Config);
154
366
  /**
367
+ * @remarks
155
368
  * Encapsulate the request and invoke the network
156
- * @param action api name
157
- * @param version product version
158
- * @param protocol http or https
159
- * @param method e.g. GET
160
- * @param authType authorization type e.g. AK
161
- * @param bodyType response body type e.g. String
162
- * @param request object of OpenApiRequest
163
- * @param runtime which controls some details of call api, such as retry times
164
- * @return the response
369
+ *
370
+ * @param action - api name
371
+ * @param version - product version
372
+ * @param protocol - http or https
373
+ * @param method - e.g. GET
374
+ * @param authType - authorization type e.g. AK
375
+ * @param bodyType - response body type e.g. String
376
+ * @param request - object of OpenApiRequest
377
+ * @param runtime - which controls some details of call api, such as retry times
378
+ * @returns the response
165
379
  */
166
380
  doRPCRequest(action: string, version: string, protocol: string, method: string, authType: string, bodyType: string, request: OpenApiRequest, runtime: $Util.RuntimeOptions): Promise<{
167
381
  [key: string]: any;
168
382
  }>;
169
383
  /**
384
+ * @remarks
170
385
  * Encapsulate the request and invoke the network
171
- * @param action api name
172
- * @param version product version
173
- * @param protocol http or https
174
- * @param method e.g. GET
175
- * @param authType authorization type e.g. AK
176
- * @param pathname pathname of every api
177
- * @param bodyType response body type e.g. String
178
- * @param request object of OpenApiRequest
179
- * @param runtime which controls some details of call api, such as retry times
180
- * @return the response
386
+ *
387
+ * @param action - api name
388
+ * @param version - product version
389
+ * @param protocol - http or https
390
+ * @param method - e.g. GET
391
+ * @param authType - authorization type e.g. AK
392
+ * @param pathname - pathname of every api
393
+ * @param bodyType - response body type e.g. String
394
+ * @param request - object of OpenApiRequest
395
+ * @param runtime - which controls some details of call api, such as retry times
396
+ * @returns the response
181
397
  */
182
398
  doROARequest(action: string, version: string, protocol: string, method: string, authType: string, pathname: string, bodyType: string, request: OpenApiRequest, runtime: $Util.RuntimeOptions): Promise<{
183
399
  [key: string]: any;
184
400
  }>;
185
401
  /**
402
+ * @remarks
186
403
  * Encapsulate the request and invoke the network with form body
187
- * @param action api name
188
- * @param version product version
189
- * @param protocol http or https
190
- * @param method e.g. GET
191
- * @param authType authorization type e.g. AK
192
- * @param pathname pathname of every api
193
- * @param bodyType response body type e.g. String
194
- * @param request object of OpenApiRequest
195
- * @param runtime which controls some details of call api, such as retry times
196
- * @return the response
404
+ *
405
+ * @param action - api name
406
+ * @param version - product version
407
+ * @param protocol - http or https
408
+ * @param method - e.g. GET
409
+ * @param authType - authorization type e.g. AK
410
+ * @param pathname - pathname of every api
411
+ * @param bodyType - response body type e.g. String
412
+ * @param request - object of OpenApiRequest
413
+ * @param runtime - which controls some details of call api, such as retry times
414
+ * @returns the response
197
415
  */
198
416
  doROARequestWithForm(action: string, version: string, protocol: string, method: string, authType: string, pathname: string, bodyType: string, request: OpenApiRequest, runtime: $Util.RuntimeOptions): Promise<{
199
417
  [key: string]: any;
200
418
  }>;
201
419
  /**
420
+ * @remarks
202
421
  * Encapsulate the request and invoke the network
203
- * @param action api name
204
- * @param version product version
205
- * @param protocol http or https
206
- * @param method e.g. GET
207
- * @param authType authorization type e.g. AK
208
- * @param bodyType response body type e.g. String
209
- * @param request object of OpenApiRequest
210
- * @param runtime which controls some details of call api, such as retry times
211
- * @return the response
422
+ *
423
+ * @param action - api name
424
+ * @param version - product version
425
+ * @param protocol - http or https
426
+ * @param method - e.g. GET
427
+ * @param authType - authorization type e.g. AK
428
+ * @param bodyType - response body type e.g. String
429
+ * @param request - object of OpenApiRequest
430
+ * @param runtime - which controls some details of call api, such as retry times
431
+ * @returns the response
212
432
  */
213
433
  doRequest(params: Params, request: OpenApiRequest, runtime: $Util.RuntimeOptions): Promise<{
214
434
  [key: string]: any;
215
435
  }>;
216
436
  /**
437
+ * @remarks
217
438
  * Encapsulate the request and invoke the network
218
- * @param action api name
219
- * @param version product version
220
- * @param protocol http or https
221
- * @param method e.g. GET
222
- * @param authType authorization type e.g. AK
223
- * @param bodyType response body type e.g. String
224
- * @param request object of OpenApiRequest
225
- * @param runtime which controls some details of call api, such as retry times
226
- * @return the response
439
+ *
440
+ * @param action - api name
441
+ * @param version - product version
442
+ * @param protocol - http or https
443
+ * @param method - e.g. GET
444
+ * @param authType - authorization type e.g. AK
445
+ * @param bodyType - response body type e.g. String
446
+ * @param request - object of OpenApiRequest
447
+ * @param runtime - which controls some details of call api, such as retry times
448
+ * @returns the response
227
449
  */
228
450
  execute(params: Params, request: OpenApiRequest, runtime: $Util.RuntimeOptions): Promise<{
229
451
  [key: string]: any;
@@ -232,60 +454,75 @@ export default class Client {
232
454
  [key: string]: any;
233
455
  }>;
234
456
  /**
457
+ * @remarks
235
458
  * Get user agent
236
- * @return user agent
459
+ * @returns user agent
237
460
  */
238
461
  getUserAgent(): string;
239
462
  /**
463
+ * @remarks
240
464
  * Get accesskey id by using credential
241
- * @return accesskey id
465
+ * @returns accesskey id
242
466
  */
243
467
  getAccessKeyId(): Promise<string>;
244
468
  /**
469
+ * @remarks
245
470
  * Get accesskey secret by using credential
246
- * @return accesskey secret
471
+ * @returns accesskey secret
247
472
  */
248
473
  getAccessKeySecret(): Promise<string>;
249
474
  /**
475
+ * @remarks
250
476
  * Get security token by using credential
251
- * @return security token
477
+ * @returns security token
252
478
  */
253
479
  getSecurityToken(): Promise<string>;
254
480
  /**
481
+ * @remarks
255
482
  * Get bearer token by credential
256
- * @return bearer token
483
+ * @returns bearer token
257
484
  */
258
485
  getBearerToken(): Promise<string>;
259
486
  /**
487
+ * @remarks
260
488
  * Get credential type by credential
261
- * @return credential type e.g. access_key
489
+ * @returns credential type e.g. access_key
262
490
  */
263
491
  getType(): Promise<string>;
264
492
  /**
493
+ * @remarks
265
494
  * If inputValue is not null, return it or return defaultValue
266
- * @param inputValue users input value
267
- * @param defaultValue default value
268
- * @return the final result
495
+ *
496
+ * @param inputValue - users input value
497
+ * @param defaultValue - default value
498
+ * @returns the final result
269
499
  */
270
500
  static defaultAny(inputValue: any, defaultValue: any): any;
271
501
  /**
502
+ * @remarks
272
503
  * If the endpointRule and config.endpoint are empty, throw error
273
- * @param config config contains the necessary information to create a client
504
+ *
505
+ * @param config - config contains the necessary information to create a client
274
506
  */
275
507
  checkConfig(config: Config): void;
276
508
  /**
509
+ * @remarks
277
510
  * set gateway client
278
- * @param spi.
511
+ *
512
+ * @param spi - .
279
513
  */
280
514
  setGatewayClient(spi: SPI): void;
281
515
  /**
516
+ * @remarks
282
517
  * set RPC header for debug
283
- * @param headers headers for debug, this header can be used only once.
518
+ *
519
+ * @param headers - headers for debug, this header can be used only once.
284
520
  */
285
521
  setRpcHeaders(headers: {
286
522
  [key: string]: string;
287
523
  }): void;
288
524
  /**
525
+ * @remarks
289
526
  * get RPC header for debug
290
527
  */
291
528
  getRpcHeaders(): {