@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.
- package/dist/bitable-base-field.d.ts +405 -274
- package/dist/bitable-base-record.d.ts +312 -198
- package/dist/contact-base.d.ts +328 -233
- package/dist/im-base.d.ts +175 -122
- package/dist/im-base.type.d.ts +26 -10
- package/package.json +3 -2
package/dist/im-base.d.ts
CHANGED
|
@@ -1,140 +1,193 @@
|
|
|
1
1
|
import { Logger } from '@nestjs/common';
|
|
2
2
|
import { FeishuBasePlus } from './feishu-base-plus';
|
|
3
|
-
import {
|
|
3
|
+
import {
|
|
4
|
+
imChatCreateDataType,
|
|
5
|
+
imChatCreateParamsType,
|
|
6
|
+
imMessageCreateByCardPayloadType,
|
|
7
|
+
imMessagePatchPayloadType,
|
|
8
|
+
imMessageUpdateByCardPayloadType,
|
|
9
|
+
} from './im-base.type';
|
|
4
10
|
export declare class ImBase {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
11
|
+
readonly logger: Logger;
|
|
12
|
+
feishuBaseInstance: FeishuBasePlus;
|
|
13
|
+
constructor(feishuBaseInstance: FeishuBasePlus);
|
|
14
|
+
getImMessageList(container_id: string, start_time: number): Promise<any[]>;
|
|
15
|
+
getImChatList(): Promise<
|
|
16
|
+
{
|
|
17
|
+
chat_id?: string | undefined;
|
|
18
|
+
avatar?: string | undefined;
|
|
19
|
+
name?: string | undefined;
|
|
20
|
+
description?: string | undefined;
|
|
21
|
+
owner_id?: string | undefined;
|
|
22
|
+
owner_id_type?: string | undefined;
|
|
23
|
+
external?: boolean | undefined;
|
|
24
|
+
tenant_key?: string | undefined;
|
|
25
|
+
labels?: string[] | undefined;
|
|
26
|
+
chat_status?: 'normal' | 'dissolved' | 'dissolved_save' | undefined;
|
|
27
|
+
}[]
|
|
28
|
+
>;
|
|
29
|
+
chatCreate(
|
|
30
|
+
imChatCreateData: imChatCreateDataType,
|
|
31
|
+
imChatCreateParams: imChatCreateParamsType,
|
|
32
|
+
): Promise<{
|
|
33
|
+
code?: number | undefined;
|
|
34
|
+
msg?: string | undefined;
|
|
35
|
+
data?:
|
|
36
|
+
| {
|
|
37
|
+
chat_id?: string | undefined;
|
|
38
|
+
avatar?: string | undefined;
|
|
39
|
+
name?: string | undefined;
|
|
40
|
+
description?: string | undefined;
|
|
41
|
+
i18n_names?:
|
|
42
|
+
| {
|
|
30
43
|
zh_cn?: string | undefined;
|
|
31
44
|
en_us?: string | undefined;
|
|
32
45
|
ja_jp?: string | undefined;
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
46
|
+
}
|
|
47
|
+
| undefined;
|
|
48
|
+
owner_id?: string | undefined;
|
|
49
|
+
owner_id_type?: string | undefined;
|
|
50
|
+
urgent_setting?: 'all_members' | 'only_owner' | undefined;
|
|
51
|
+
video_conference_setting?: 'all_members' | 'only_owner' | undefined;
|
|
52
|
+
pin_manage_setting?: 'all_members' | 'only_owner' | undefined;
|
|
53
|
+
add_member_permission?: string | undefined;
|
|
54
|
+
share_card_permission?: string | undefined;
|
|
55
|
+
at_all_permission?: string | undefined;
|
|
56
|
+
edit_permission?: string | undefined;
|
|
57
|
+
group_message_type?: string | undefined;
|
|
58
|
+
chat_mode?: string | undefined;
|
|
59
|
+
chat_type?: string | undefined;
|
|
60
|
+
chat_tag?: string | undefined;
|
|
61
|
+
external?: boolean | undefined;
|
|
62
|
+
tenant_key?: string | undefined;
|
|
63
|
+
join_message_visibility?: string | undefined;
|
|
64
|
+
leave_message_visibility?: string | undefined;
|
|
65
|
+
membership_approval?: string | undefined;
|
|
66
|
+
moderation_permission?: string | undefined;
|
|
67
|
+
labels?: string[] | undefined;
|
|
68
|
+
toolkit_ids?: string[] | undefined;
|
|
69
|
+
restricted_mode_setting?:
|
|
70
|
+
| {
|
|
56
71
|
status?: boolean | undefined;
|
|
57
|
-
screenshot_has_permission_setting?:
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
72
|
+
screenshot_has_permission_setting?:
|
|
73
|
+
| 'all_members'
|
|
74
|
+
| 'not_anyone'
|
|
75
|
+
| undefined;
|
|
76
|
+
download_has_permission_setting?:
|
|
77
|
+
| 'all_members'
|
|
78
|
+
| 'not_anyone'
|
|
79
|
+
| undefined;
|
|
80
|
+
message_has_permission_setting?:
|
|
81
|
+
| 'all_members'
|
|
82
|
+
| 'not_anyone'
|
|
83
|
+
| undefined;
|
|
84
|
+
}
|
|
85
|
+
| undefined;
|
|
86
|
+
hide_member_count_setting?: 'all_members' | 'only_owner' | undefined;
|
|
87
|
+
}
|
|
88
|
+
| undefined;
|
|
89
|
+
}>;
|
|
90
|
+
getChatLink(chatId: string): Promise<{
|
|
91
|
+
code?: number | undefined;
|
|
92
|
+
msg?: string | undefined;
|
|
93
|
+
data?:
|
|
94
|
+
| {
|
|
95
|
+
share_link?: string | undefined;
|
|
96
|
+
expire_time?: string | undefined;
|
|
97
|
+
is_permanent?: boolean | undefined;
|
|
98
|
+
}
|
|
99
|
+
| undefined;
|
|
100
|
+
}>;
|
|
101
|
+
getGroupMemberList(
|
|
102
|
+
chatId: string,
|
|
103
|
+
member_id_type?: 'user_id' | 'union_id' | 'open_id',
|
|
104
|
+
): Promise<
|
|
105
|
+
{
|
|
106
|
+
member_id_type?: string | undefined;
|
|
107
|
+
member_id?: string | undefined;
|
|
108
|
+
name?: string | undefined;
|
|
109
|
+
tenant_key?: string | undefined;
|
|
110
|
+
}[]
|
|
111
|
+
>;
|
|
112
|
+
getUserByMobile(mobiles: string[]): Promise<
|
|
113
|
+
{
|
|
114
|
+
union_id: string;
|
|
115
|
+
nickname: string;
|
|
116
|
+
name: string;
|
|
117
|
+
mobile: string;
|
|
118
|
+
user_id: string;
|
|
119
|
+
open_id: string;
|
|
120
|
+
}[]
|
|
121
|
+
>;
|
|
122
|
+
batchUser(
|
|
123
|
+
user_ids: string[],
|
|
124
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id',
|
|
125
|
+
): Promise<
|
|
126
|
+
{
|
|
127
|
+
union_id: string;
|
|
128
|
+
nickname: string;
|
|
129
|
+
name: string;
|
|
130
|
+
mobile: string;
|
|
131
|
+
user_id: string;
|
|
132
|
+
open_id: string;
|
|
133
|
+
}[]
|
|
134
|
+
>;
|
|
135
|
+
getUuid(content: string | object): string;
|
|
136
|
+
sendFeishuMessage(
|
|
137
|
+
title: string,
|
|
138
|
+
content: string,
|
|
139
|
+
messageReceiveList: string[],
|
|
140
|
+
type?: 'error' | 'info' | 'warn',
|
|
141
|
+
): Promise<void>;
|
|
142
|
+
createByCard(payload: imMessageCreateByCardPayloadType): Promise<{
|
|
143
|
+
code?: number | undefined;
|
|
144
|
+
msg?: string | undefined;
|
|
145
|
+
data?:
|
|
146
|
+
| {
|
|
147
|
+
message_id?: string | undefined;
|
|
148
|
+
root_id?: string | undefined;
|
|
149
|
+
parent_id?: string | undefined;
|
|
150
|
+
thread_id?: string | undefined;
|
|
151
|
+
msg_type?: string | undefined;
|
|
152
|
+
create_time?: string | undefined;
|
|
153
|
+
update_time?: string | undefined;
|
|
154
|
+
deleted?: boolean | undefined;
|
|
155
|
+
updated?: boolean | undefined;
|
|
156
|
+
chat_id?: string | undefined;
|
|
157
|
+
sender?:
|
|
158
|
+
| {
|
|
112
159
|
id: string;
|
|
113
160
|
id_type: string;
|
|
114
161
|
sender_type: string;
|
|
115
162
|
tenant_key?: string | undefined;
|
|
116
|
-
|
|
117
|
-
|
|
163
|
+
}
|
|
164
|
+
| undefined;
|
|
165
|
+
body?:
|
|
166
|
+
| {
|
|
118
167
|
content: string;
|
|
119
|
-
|
|
120
|
-
|
|
168
|
+
}
|
|
169
|
+
| undefined;
|
|
170
|
+
mentions?:
|
|
171
|
+
| {
|
|
121
172
|
key: string;
|
|
122
173
|
id: string;
|
|
123
174
|
id_type: string;
|
|
124
175
|
name: string;
|
|
125
176
|
tenant_key?: string | undefined;
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
177
|
+
}[]
|
|
178
|
+
| undefined;
|
|
179
|
+
upper_message_id?: string | undefined;
|
|
180
|
+
}
|
|
181
|
+
| undefined;
|
|
182
|
+
}>;
|
|
183
|
+
patch(payload: imMessagePatchPayloadType): Promise<{
|
|
184
|
+
code?: number | undefined;
|
|
185
|
+
msg?: string | undefined;
|
|
186
|
+
data?: {} | undefined;
|
|
187
|
+
}>;
|
|
188
|
+
updateByCard(payload: imMessageUpdateByCardPayloadType): Promise<{
|
|
189
|
+
code?: number | undefined;
|
|
190
|
+
msg?: string | undefined;
|
|
191
|
+
data?: {} | undefined;
|
|
192
|
+
}>;
|
|
140
193
|
}
|
package/dist/im-base.type.d.ts
CHANGED
|
@@ -4,24 +4,40 @@ export type imType = lark.Client['im'];
|
|
|
4
4
|
export type imChatType = imType['chat'];
|
|
5
5
|
export type imChatListType = imChatType['list'];
|
|
6
6
|
export type imChatListParamsType = Parameters<imChatListType>[0]['params'];
|
|
7
|
-
export type imChatListDataItemsType = UnPromise<
|
|
7
|
+
export type imChatListDataItemsType = UnPromise<
|
|
8
|
+
ReturnType<imChatListType>
|
|
9
|
+
>['data']['items'];
|
|
8
10
|
export type imChatCreateType = imChatType['create'];
|
|
9
11
|
export type imChatCreateDataType = Parameters<imChatCreateType>[0]['data'];
|
|
10
12
|
export type imChatCreateParamsType = Parameters<imChatCreateType>[0]['params'];
|
|
11
13
|
export type imChatMembersType = imType['chatMembers'];
|
|
12
14
|
export type imChatMembersGetType = imChatMembersType['get'];
|
|
13
|
-
export type imChatMembersDataItemsType = UnPromise<
|
|
15
|
+
export type imChatMembersDataItemsType = UnPromise<
|
|
16
|
+
ReturnType<imChatMembersGetType>
|
|
17
|
+
>['data']['items'];
|
|
14
18
|
export type imMessageType = imType['message'];
|
|
15
19
|
export type imMessageCreateByCardType = imMessageType['createByCard'];
|
|
16
|
-
export type imMessageCreateByCardPayloadType =
|
|
17
|
-
|
|
18
|
-
export type
|
|
20
|
+
export type imMessageCreateByCardPayloadType =
|
|
21
|
+
Parameters<imMessageCreateByCardType>[0];
|
|
22
|
+
export type imMessageCreateByCardResultType = UnPromise<
|
|
23
|
+
ReturnType<imMessageCreateByCardType>
|
|
24
|
+
>;
|
|
25
|
+
export type receiveIdType =
|
|
26
|
+
imMessageCreateByCardPayloadType['params']['receive_id_type'];
|
|
19
27
|
export type imMessageUpdateByCardType = imMessageType['updateByCard'];
|
|
20
|
-
export type imMessageUpdateByCardPayloadType =
|
|
21
|
-
|
|
28
|
+
export type imMessageUpdateByCardPayloadType =
|
|
29
|
+
Parameters<imMessageUpdateByCardType>[0];
|
|
30
|
+
export type imMessageUpdateByCardResultType = UnPromise<
|
|
31
|
+
ReturnType<imMessageUpdateByCardType>
|
|
32
|
+
>;
|
|
22
33
|
export type imMessagePatchType = imMessageType['patch'];
|
|
23
34
|
export type imMessagePatchPayloadType = Parameters<imMessagePatchType>[0];
|
|
24
|
-
export type imMessagePatchResultType = UnPromise<
|
|
35
|
+
export type imMessagePatchResultType = UnPromise<
|
|
36
|
+
ReturnType<imMessagePatchType>
|
|
37
|
+
>;
|
|
25
38
|
export type imMessageListType = imMessageType['list'];
|
|
26
|
-
export type imMessageListTypeResultType = UnPromise<
|
|
27
|
-
|
|
39
|
+
export type imMessageListTypeResultType = UnPromise<
|
|
40
|
+
ReturnType<imMessageListType>
|
|
41
|
+
>;
|
|
42
|
+
export type imMessageListDataItemsType =
|
|
43
|
+
imMessageListTypeResultType['data']['items'];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nest-packages/nestjs-lark-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"files": [
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
],
|
|
9
9
|
"peerDependencies": {
|
|
10
10
|
"@nestjs/common": "^11.0.0",
|
|
11
|
-
"@nestjs/core": "^11.0.0"
|
|
11
|
+
"@nestjs/core": "^11.0.0",
|
|
12
|
+
"@nest-packages/nestjs-queue-events": "*"
|
|
12
13
|
},
|
|
13
14
|
"scripts": {
|
|
14
15
|
"build": "tsc -p tsconfig.build.json"
|