-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
types.ts
218 lines (187 loc) · 5.59 KB
/
types.ts
1
2
3
4
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/* eslint-disable camelcase */
import type {
NativeComponent,
EventMiddleware,
DispatchMiddleware,
PlatformUtilities,
MachinatNode,
} from '@machinat/core';
import type { DispatchFrame, DispatchResponse } from '@machinat/core/engine';
import type { MaybeContainer } from '@machinat/core/service';
import type { IntermediateSegment } from '@machinat/core/renderer';
import type { WebhookMetadata } from '@machinat/http/webhook';
import type { MessengerBot } from './Bot';
import type MessengerChat from './Chat';
import type SendTarget from './SendTarget';
import type { MessengerEvent } from './event/types';
import type { API_PATH, ATTACHMENT_DATA, ATTACHMENT_INFO } from './constant';
export * from './event/types';
export type MessengerChannel = MessengerChat | SendTarget;
export type PSIDTarget = { id: string };
export type UserRefTarget = { user_ref: string };
export type PostPrivateReplyTarget = { post_id: string };
export type CommentPrivateReplyTarget = { comment_id: string };
export type MessengerTarget =
| PSIDTarget
| UserRefTarget
| PostPrivateReplyTarget
| CommentPrivateReplyTarget;
// TODO: type the raw event object
export type MessengerRawEvent = any;
// TODO: detailed message type
export type RawMessage = any;
type MessagingType = 'RESPONSE' | 'UPDATE' | 'MESSAGE_TAG';
type NotificationType = 'REGULAR' | 'SILENT_PUSH' | 'NO_PUSH';
type MessageTags =
| 'CONFIRMED_EVENT_UPDATE'
| 'POST_PURCHASE_UPDATE'
| 'ACCOUNT_UPDATE'
| 'HUMAN_AGENT';
export type FileInfo = {
filename?: string;
filepath?: string;
contentType?: string;
knownLength?: number;
};
export type MessageValue = {
message: RawMessage;
messaging_type?: MessagingType;
notification_type?: NotificationType;
tag?: MessageTags;
persona_id?: string;
[ATTACHMENT_DATA]?: string | Buffer | NodeJS.ReadableStream;
[ATTACHMENT_INFO]?: FileInfo;
};
export type SenderActionValue = {
sender_action: 'mark_seen' | 'typing_on' | 'typing_off'; // eslint-disable-line camelcase
};
export type PassThreadControlValue = {
target_app_id: number; // eslint-disable-line camelcase
metadata?: string;
[API_PATH]: any;
};
export type RequestThreadControlValue = {
metadata?: string;
[API_PATH]: any;
};
export type TakeThreadControlValue = RequestThreadControlValue;
export type HandoverProtocolValue =
| PassThreadControlValue
| RequestThreadControlValue
| TakeThreadControlValue;
export type MessengerSegmentValue =
| MessageValue
| SenderActionValue
| HandoverProtocolValue;
export type MessengerComponent<
Props,
Segment extends IntermediateSegment<MessengerSegmentValue> = IntermediateSegment<MessengerSegmentValue>
> = NativeComponent<Props, Segment>;
export type BatchApiRequest = {
method: string;
relative_url: string;
body: null | any;
name?: string;
depends_on?: string;
attached_files?: string;
omit_response_on_success?: boolean;
};
export type MessengerJob = {
request: BatchApiRequest;
key?: string;
assetTag?: string;
fileData?: string | Buffer | NodeJS.ReadableStream;
fileInfo?: {
filename?: string;
filepath?: string;
contentType?: string;
knownLength?: number;
};
};
export type FbGraphApiResult = Record<string, any>;
export type MessengerResult = {
code: number;
headers: Record<string, string>;
body: FbGraphApiResult;
};
export type GraphApiErrorInfo = {
message: string;
type: string;
code: number;
error_subcode: number;
fbtrace_id: string;
};
export type GraphApiErrorBody = {
error: GraphApiErrorInfo;
};
export type RawUserProfile = {
id: string;
name: string;
first_name: string;
last_name: string;
profile_pic: string;
locale?: string;
timezone?: number;
gender?: string;
};
export type MessengerDispatchResponse = DispatchResponse<
MessengerJob,
MessengerResult
>;
export type MessengerEventContext = {
platform: 'messenger';
event: MessengerEvent;
metadata: WebhookMetadata;
bot: MessengerBot;
reply(message: MachinatNode): Promise<null | MessengerDispatchResponse>;
};
export type MessengerEventMiddleware = EventMiddleware<
MessengerEventContext,
null
>;
export type MessengerDispatchFrame = DispatchFrame<
MessengerChannel,
MessengerJob
>;
export type MessengerDispatchMiddleware = DispatchMiddleware<
MessengerJob,
MessengerDispatchFrame,
MessengerResult
>;
export type MessengerConfigs = {
/** The Facebook page id */
pageId: string;
/** The page access token for the app */
accessToken: string;
/** The Facebook app secret */
appSecret?: string;
/** To verify the webhook request by the signature or not. Default to `true` */
shouldVerifyRequest?: boolean;
/** To handle the webhook challenge request or not. Default to `true` */
shouldHandleChallenge?: boolean;
/** The secret string to verify the webhook challenge request */
verifyToken?: string;
/** The webhook path to receive events. Default to `/` */
webhookPath?: string;
/** The graph API version to make API calls */
graphApiVersion?: string;
/** Request additional info of user profile. This requires addtional permisions of your app */
optionalProfileFields?: ('locale' | 'timezone' | 'gender')[];
apiBatchRequestInterval?: number;
eventMiddlewares?: MaybeContainer<MessengerEventMiddleware>[];
dispatchMiddlewares?: MaybeContainer<MessengerDispatchMiddleware>[];
};
export type MessengerSendOptions = {
messagingType?: MessagingType;
tag?: string;
notificationType?: NotificationType;
personaId?: string;
oneTimeNotifToken?: string;
};
export type MessengerPlatformUtilities = PlatformUtilities<
MessengerEventContext,
null,
MessengerJob,
MessengerDispatchFrame,
MessengerResult
>;