@simplex-chat/types 0.2.0 → 0.2.2

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 (9) hide show
  1. package/README.md +1 -1
  2. package/dist/events.d.ts +52 -48
  3. package/dist/responses.d.ts +55 -51
  4. package/package.json +4 -3
  5. package/src/commands.ts +693 -0
  6. package/src/events.ts +439 -0
  7. package/src/index.ts +4 -0
  8. package/src/responses.ts +423 -0
  9. package/src/types.ts +4587 -0
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  This TypeScript library provides auto-generated types for bots API: commands and responses, events and all types they use.
4
4
 
5
- It is used in [simplex-chat](https://www.npmjs.com/package/simplex-chat) library that uses WebSockets interface of SimpleX Chat CLI.
5
+ It is used in [simplex-chat](https://www.npmjs.com/package/simplex-chat) Node.js library.
6
6
 
7
7
  [API reference](https://github.com/simplex-chat/simplex-chat/tree/stable/bots).
8
8
 
package/dist/events.d.ts CHANGED
@@ -1,69 +1,71 @@
1
1
  import * as T from "./types";
2
- export type ChatEvent = CEvt.ContactConnected | CEvt.ContactUpdated | CEvt.ContactDeletedByContact | CEvt.ReceivedContactRequest | CEvt.NewMemberContactReceivedInv | CEvt.ContactSndReady | CEvt.NewChatItems | CEvt.ChatItemReaction | CEvt.ChatItemsDeleted | CEvt.ChatItemUpdated | CEvt.GroupChatItemsDeleted | CEvt.ChatItemsStatusesUpdated | CEvt.ReceivedGroupInvitation | CEvt.UserJoinedGroup | CEvt.GroupUpdated | CEvt.JoinedGroupMember | CEvt.MemberRole | CEvt.DeletedMember | CEvt.LeftMember | CEvt.DeletedMemberUser | CEvt.GroupDeleted | CEvt.ConnectedToGroupMember | CEvt.MemberAcceptedByOther | CEvt.MemberBlockedForAll | CEvt.GroupMemberUpdated | CEvt.RcvFileDescrReady | CEvt.RcvFileComplete | CEvt.SndFileCompleteXFTP | CEvt.RcvFileStart | CEvt.RcvFileSndCancelled | CEvt.RcvFileAccepted | CEvt.RcvFileError | CEvt.RcvFileWarning | CEvt.SndFileError | CEvt.SndFileWarning | CEvt.AcceptingContactRequest | CEvt.AcceptingBusinessRequest | CEvt.ContactConnecting | CEvt.BusinessLinkConnecting | CEvt.JoinedGroupMemberConnecting | CEvt.SentGroupInvitation | CEvt.GroupLinkConnecting | CEvt.MessageError | CEvt.ChatError | CEvt.ChatErrors;
2
+ export type ChatEvent = CEvt.ContactConnected | CEvt.ContactUpdated | CEvt.ContactDeletedByContact | CEvt.ReceivedContactRequest | CEvt.NewMemberContactReceivedInv | CEvt.ContactSndReady | CEvt.NewChatItems | CEvt.ChatItemReaction | CEvt.ChatItemsDeleted | CEvt.ChatItemUpdated | CEvt.GroupChatItemsDeleted | CEvt.ChatItemsStatusesUpdated | CEvt.ReceivedGroupInvitation | CEvt.UserJoinedGroup | CEvt.GroupUpdated | CEvt.JoinedGroupMember | CEvt.MemberRole | CEvt.DeletedMember | CEvt.LeftMember | CEvt.DeletedMemberUser | CEvt.GroupDeleted | CEvt.ConnectedToGroupMember | CEvt.MemberAcceptedByOther | CEvt.MemberBlockedForAll | CEvt.GroupMemberUpdated | CEvt.RcvFileDescrReady | CEvt.RcvFileComplete | CEvt.SndFileCompleteXFTP | CEvt.RcvFileStart | CEvt.RcvFileSndCancelled | CEvt.RcvFileAccepted | CEvt.RcvFileError | CEvt.RcvFileWarning | CEvt.SndFileError | CEvt.SndFileWarning | CEvt.AcceptingContactRequest | CEvt.AcceptingBusinessRequest | CEvt.ContactConnecting | CEvt.BusinessLinkConnecting | CEvt.JoinedGroupMemberConnecting | CEvt.SentGroupInvitation | CEvt.GroupLinkConnecting | CEvt.MessageError | CEvt.ChatError | CEvt.ChatErrors | CEvt.Unkwnown;
3
3
  export declare namespace CEvt {
4
- export type Tag = "contactConnected" | "contactUpdated" | "contactDeletedByContact" | "receivedContactRequest" | "newMemberContactReceivedInv" | "contactSndReady" | "newChatItems" | "chatItemReaction" | "chatItemsDeleted" | "chatItemUpdated" | "groupChatItemsDeleted" | "chatItemsStatusesUpdated" | "receivedGroupInvitation" | "userJoinedGroup" | "groupUpdated" | "joinedGroupMember" | "memberRole" | "deletedMember" | "leftMember" | "deletedMemberUser" | "groupDeleted" | "connectedToGroupMember" | "memberAcceptedByOther" | "memberBlockedForAll" | "groupMemberUpdated" | "rcvFileDescrReady" | "rcvFileComplete" | "sndFileCompleteXFTP" | "rcvFileStart" | "rcvFileSndCancelled" | "rcvFileAccepted" | "rcvFileError" | "rcvFileWarning" | "sndFileError" | "sndFileWarning" | "acceptingContactRequest" | "acceptingBusinessRequest" | "contactConnecting" | "businessLinkConnecting" | "joinedGroupMemberConnecting" | "sentGroupInvitation" | "groupLinkConnecting" | "messageError" | "chatError" | "chatErrors";
4
+ type Tag = KnownTag | UnknownTag;
5
+ type KnownTag = "contactConnected" | "contactUpdated" | "contactDeletedByContact" | "receivedContactRequest" | "newMemberContactReceivedInv" | "contactSndReady" | "newChatItems" | "chatItemReaction" | "chatItemsDeleted" | "chatItemUpdated" | "groupChatItemsDeleted" | "chatItemsStatusesUpdated" | "receivedGroupInvitation" | "userJoinedGroup" | "groupUpdated" | "joinedGroupMember" | "memberRole" | "deletedMember" | "leftMember" | "deletedMemberUser" | "groupDeleted" | "connectedToGroupMember" | "memberAcceptedByOther" | "memberBlockedForAll" | "groupMemberUpdated" | "rcvFileDescrReady" | "rcvFileComplete" | "sndFileCompleteXFTP" | "rcvFileStart" | "rcvFileSndCancelled" | "rcvFileAccepted" | "rcvFileError" | "rcvFileWarning" | "sndFileError" | "sndFileWarning" | "acceptingContactRequest" | "acceptingBusinessRequest" | "contactConnecting" | "businessLinkConnecting" | "joinedGroupMemberConnecting" | "sentGroupInvitation" | "groupLinkConnecting" | "messageError" | "chatError" | "chatErrors";
6
+ type UnknownTag = Exclude<string, KnownTag>;
5
7
  interface Interface {
6
8
  type: Tag;
7
9
  }
8
- export interface ContactConnected extends Interface {
10
+ interface ContactConnected extends Interface {
9
11
  type: "contactConnected";
10
12
  user: T.User;
11
13
  contact: T.Contact;
12
14
  userCustomProfile?: T.Profile;
13
15
  }
14
- export interface ContactUpdated extends Interface {
16
+ interface ContactUpdated extends Interface {
15
17
  type: "contactUpdated";
16
18
  user: T.User;
17
19
  fromContact: T.Contact;
18
20
  toContact: T.Contact;
19
21
  }
20
- export interface ContactDeletedByContact extends Interface {
22
+ interface ContactDeletedByContact extends Interface {
21
23
  type: "contactDeletedByContact";
22
24
  user: T.User;
23
25
  contact: T.Contact;
24
26
  }
25
- export interface ReceivedContactRequest extends Interface {
27
+ interface ReceivedContactRequest extends Interface {
26
28
  type: "receivedContactRequest";
27
29
  user: T.User;
28
30
  contactRequest: T.UserContactRequest;
29
31
  chat_?: T.AChat;
30
32
  }
31
- export interface NewMemberContactReceivedInv extends Interface {
33
+ interface NewMemberContactReceivedInv extends Interface {
32
34
  type: "newMemberContactReceivedInv";
33
35
  user: T.User;
34
36
  contact: T.Contact;
35
37
  groupInfo: T.GroupInfo;
36
38
  member: T.GroupMember;
37
39
  }
38
- export interface ContactSndReady extends Interface {
40
+ interface ContactSndReady extends Interface {
39
41
  type: "contactSndReady";
40
42
  user: T.User;
41
43
  contact: T.Contact;
42
44
  }
43
- export interface NewChatItems extends Interface {
45
+ interface NewChatItems extends Interface {
44
46
  type: "newChatItems";
45
47
  user: T.User;
46
48
  chatItems: T.AChatItem[];
47
49
  }
48
- export interface ChatItemReaction extends Interface {
50
+ interface ChatItemReaction extends Interface {
49
51
  type: "chatItemReaction";
50
52
  user: T.User;
51
53
  added: boolean;
52
54
  reaction: T.ACIReaction;
53
55
  }
54
- export interface ChatItemsDeleted extends Interface {
56
+ interface ChatItemsDeleted extends Interface {
55
57
  type: "chatItemsDeleted";
56
58
  user: T.User;
57
59
  chatItemDeletions: T.ChatItemDeletion[];
58
60
  byUser: boolean;
59
61
  timed: boolean;
60
62
  }
61
- export interface ChatItemUpdated extends Interface {
63
+ interface ChatItemUpdated extends Interface {
62
64
  type: "chatItemUpdated";
63
65
  user: T.User;
64
66
  chatItem: T.AChatItem;
65
67
  }
66
- export interface GroupChatItemsDeleted extends Interface {
68
+ interface GroupChatItemsDeleted extends Interface {
67
69
  type: "groupChatItemsDeleted";
68
70
  user: T.User;
69
71
  groupInfo: T.GroupInfo;
@@ -71,12 +73,12 @@ export declare namespace CEvt {
71
73
  byUser: boolean;
72
74
  member_?: T.GroupMember;
73
75
  }
74
- export interface ChatItemsStatusesUpdated extends Interface {
76
+ interface ChatItemsStatusesUpdated extends Interface {
75
77
  type: "chatItemsStatusesUpdated";
76
78
  user: T.User;
77
79
  chatItems: T.AChatItem[];
78
80
  }
79
- export interface ReceivedGroupInvitation extends Interface {
81
+ interface ReceivedGroupInvitation extends Interface {
80
82
  type: "receivedGroupInvitation";
81
83
  user: T.User;
82
84
  groupInfo: T.GroupInfo;
@@ -84,26 +86,26 @@ export declare namespace CEvt {
84
86
  fromMemberRole: T.GroupMemberRole;
85
87
  memberRole: T.GroupMemberRole;
86
88
  }
87
- export interface UserJoinedGroup extends Interface {
89
+ interface UserJoinedGroup extends Interface {
88
90
  type: "userJoinedGroup";
89
91
  user: T.User;
90
92
  groupInfo: T.GroupInfo;
91
93
  hostMember: T.GroupMember;
92
94
  }
93
- export interface GroupUpdated extends Interface {
95
+ interface GroupUpdated extends Interface {
94
96
  type: "groupUpdated";
95
97
  user: T.User;
96
98
  fromGroup: T.GroupInfo;
97
99
  toGroup: T.GroupInfo;
98
100
  member_?: T.GroupMember;
99
101
  }
100
- export interface JoinedGroupMember extends Interface {
102
+ interface JoinedGroupMember extends Interface {
101
103
  type: "joinedGroupMember";
102
104
  user: T.User;
103
105
  groupInfo: T.GroupInfo;
104
106
  member: T.GroupMember;
105
107
  }
106
- export interface MemberRole extends Interface {
108
+ interface MemberRole extends Interface {
107
109
  type: "memberRole";
108
110
  user: T.User;
109
111
  groupInfo: T.GroupInfo;
@@ -112,7 +114,7 @@ export declare namespace CEvt {
112
114
  fromRole: T.GroupMemberRole;
113
115
  toRole: T.GroupMemberRole;
114
116
  }
115
- export interface DeletedMember extends Interface {
117
+ interface DeletedMember extends Interface {
116
118
  type: "deletedMember";
117
119
  user: T.User;
118
120
  groupInfo: T.GroupInfo;
@@ -120,40 +122,40 @@ export declare namespace CEvt {
120
122
  deletedMember: T.GroupMember;
121
123
  withMessages: boolean;
122
124
  }
123
- export interface LeftMember extends Interface {
125
+ interface LeftMember extends Interface {
124
126
  type: "leftMember";
125
127
  user: T.User;
126
128
  groupInfo: T.GroupInfo;
127
129
  member: T.GroupMember;
128
130
  }
129
- export interface DeletedMemberUser extends Interface {
131
+ interface DeletedMemberUser extends Interface {
130
132
  type: "deletedMemberUser";
131
133
  user: T.User;
132
134
  groupInfo: T.GroupInfo;
133
135
  member: T.GroupMember;
134
136
  withMessages: boolean;
135
137
  }
136
- export interface GroupDeleted extends Interface {
138
+ interface GroupDeleted extends Interface {
137
139
  type: "groupDeleted";
138
140
  user: T.User;
139
141
  groupInfo: T.GroupInfo;
140
142
  member: T.GroupMember;
141
143
  }
142
- export interface ConnectedToGroupMember extends Interface {
144
+ interface ConnectedToGroupMember extends Interface {
143
145
  type: "connectedToGroupMember";
144
146
  user: T.User;
145
147
  groupInfo: T.GroupInfo;
146
148
  member: T.GroupMember;
147
149
  memberContact?: T.Contact;
148
150
  }
149
- export interface MemberAcceptedByOther extends Interface {
151
+ interface MemberAcceptedByOther extends Interface {
150
152
  type: "memberAcceptedByOther";
151
153
  user: T.User;
152
154
  groupInfo: T.GroupInfo;
153
155
  acceptingMember: T.GroupMember;
154
156
  member: T.GroupMember;
155
157
  }
156
- export interface MemberBlockedForAll extends Interface {
158
+ interface MemberBlockedForAll extends Interface {
157
159
  type: "memberBlockedForAll";
158
160
  user: T.User;
159
161
  groupInfo: T.GroupInfo;
@@ -161,130 +163,132 @@ export declare namespace CEvt {
161
163
  member: T.GroupMember;
162
164
  blocked: boolean;
163
165
  }
164
- export interface GroupMemberUpdated extends Interface {
166
+ interface GroupMemberUpdated extends Interface {
165
167
  type: "groupMemberUpdated";
166
168
  user: T.User;
167
169
  groupInfo: T.GroupInfo;
168
170
  fromMember: T.GroupMember;
169
171
  toMember: T.GroupMember;
170
172
  }
171
- export interface RcvFileDescrReady extends Interface {
173
+ interface RcvFileDescrReady extends Interface {
172
174
  type: "rcvFileDescrReady";
173
175
  user: T.User;
174
176
  chatItem: T.AChatItem;
175
177
  rcvFileTransfer: T.RcvFileTransfer;
176
178
  rcvFileDescr: T.RcvFileDescr;
177
179
  }
178
- export interface RcvFileComplete extends Interface {
180
+ interface RcvFileComplete extends Interface {
179
181
  type: "rcvFileComplete";
180
182
  user: T.User;
181
183
  chatItem: T.AChatItem;
182
184
  }
183
- export interface SndFileCompleteXFTP extends Interface {
185
+ interface SndFileCompleteXFTP extends Interface {
184
186
  type: "sndFileCompleteXFTP";
185
187
  user: T.User;
186
188
  chatItem: T.AChatItem;
187
189
  fileTransferMeta: T.FileTransferMeta;
188
190
  }
189
- export interface RcvFileStart extends Interface {
191
+ interface RcvFileStart extends Interface {
190
192
  type: "rcvFileStart";
191
193
  user: T.User;
192
194
  chatItem: T.AChatItem;
193
195
  }
194
- export interface RcvFileSndCancelled extends Interface {
196
+ interface RcvFileSndCancelled extends Interface {
195
197
  type: "rcvFileSndCancelled";
196
198
  user: T.User;
197
199
  chatItem: T.AChatItem;
198
200
  rcvFileTransfer: T.RcvFileTransfer;
199
201
  }
200
- export interface RcvFileAccepted extends Interface {
202
+ interface RcvFileAccepted extends Interface {
201
203
  type: "rcvFileAccepted";
202
204
  user: T.User;
203
205
  chatItem: T.AChatItem;
204
206
  }
205
- export interface RcvFileError extends Interface {
207
+ interface RcvFileError extends Interface {
206
208
  type: "rcvFileError";
207
209
  user: T.User;
208
210
  chatItem_?: T.AChatItem;
209
211
  agentError: T.AgentErrorType;
210
212
  rcvFileTransfer: T.RcvFileTransfer;
211
213
  }
212
- export interface RcvFileWarning extends Interface {
214
+ interface RcvFileWarning extends Interface {
213
215
  type: "rcvFileWarning";
214
216
  user: T.User;
215
217
  chatItem_?: T.AChatItem;
216
218
  agentError: T.AgentErrorType;
217
219
  rcvFileTransfer: T.RcvFileTransfer;
218
220
  }
219
- export interface SndFileError extends Interface {
221
+ interface SndFileError extends Interface {
220
222
  type: "sndFileError";
221
223
  user: T.User;
222
224
  chatItem_?: T.AChatItem;
223
225
  fileTransferMeta: T.FileTransferMeta;
224
226
  errorMessage: string;
225
227
  }
226
- export interface SndFileWarning extends Interface {
228
+ interface SndFileWarning extends Interface {
227
229
  type: "sndFileWarning";
228
230
  user: T.User;
229
231
  chatItem_?: T.AChatItem;
230
232
  fileTransferMeta: T.FileTransferMeta;
231
233
  errorMessage: string;
232
234
  }
233
- export interface AcceptingContactRequest extends Interface {
235
+ interface AcceptingContactRequest extends Interface {
234
236
  type: "acceptingContactRequest";
235
237
  user: T.User;
236
238
  contact: T.Contact;
237
239
  }
238
- export interface AcceptingBusinessRequest extends Interface {
240
+ interface AcceptingBusinessRequest extends Interface {
239
241
  type: "acceptingBusinessRequest";
240
242
  user: T.User;
241
243
  groupInfo: T.GroupInfo;
242
244
  }
243
- export interface ContactConnecting extends Interface {
245
+ interface ContactConnecting extends Interface {
244
246
  type: "contactConnecting";
245
247
  user: T.User;
246
248
  contact: T.Contact;
247
249
  }
248
- export interface BusinessLinkConnecting extends Interface {
250
+ interface BusinessLinkConnecting extends Interface {
249
251
  type: "businessLinkConnecting";
250
252
  user: T.User;
251
253
  groupInfo: T.GroupInfo;
252
254
  hostMember: T.GroupMember;
253
255
  fromContact: T.Contact;
254
256
  }
255
- export interface JoinedGroupMemberConnecting extends Interface {
257
+ interface JoinedGroupMemberConnecting extends Interface {
256
258
  type: "joinedGroupMemberConnecting";
257
259
  user: T.User;
258
260
  groupInfo: T.GroupInfo;
259
261
  hostMember: T.GroupMember;
260
262
  member: T.GroupMember;
261
263
  }
262
- export interface SentGroupInvitation extends Interface {
264
+ interface SentGroupInvitation extends Interface {
263
265
  type: "sentGroupInvitation";
264
266
  user: T.User;
265
267
  groupInfo: T.GroupInfo;
266
268
  contact: T.Contact;
267
269
  member: T.GroupMember;
268
270
  }
269
- export interface GroupLinkConnecting extends Interface {
271
+ interface GroupLinkConnecting extends Interface {
270
272
  type: "groupLinkConnecting";
271
273
  user: T.User;
272
274
  groupInfo: T.GroupInfo;
273
275
  hostMember: T.GroupMember;
274
276
  }
275
- export interface MessageError extends Interface {
277
+ interface MessageError extends Interface {
276
278
  type: "messageError";
277
279
  user: T.User;
278
280
  severity: string;
279
281
  errorMessage: string;
280
282
  }
281
- export interface ChatError extends Interface {
283
+ interface ChatError extends Interface {
282
284
  type: "chatError";
283
285
  chatError: T.ChatError;
284
286
  }
285
- export interface ChatErrors extends Interface {
287
+ interface ChatErrors extends Interface {
286
288
  type: "chatErrors";
287
289
  chatErrors: T.ChatError[];
288
290
  }
289
- export {};
291
+ interface Unkwnown extends Interface {
292
+ type: UnknownTag;
293
+ }
290
294
  }