@easbot/gateway-sdk 0.3.29 → 0.3.36

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/index.d.cts CHANGED
@@ -1,470 +1,5 @@
1
- type ClientOptions$1 = {
2
- baseUrl: 'http://localhost:8080' | (string & {});
3
- };
4
- type HealthResponse = {
5
- status: string;
6
- timestamp: number;
7
- version: string;
8
- };
9
- type StatusResponse = {
10
- status: string;
11
- connections: number;
12
- sessions: number;
13
- messageSubscriptions: number;
14
- agentSubscriptions: number;
15
- uptime: number;
16
- version: string;
17
- agents?: {
18
- total: number;
19
- healthy: number;
20
- unhealthy: number;
21
- };
22
- channels?: Array<{
23
- id: string;
24
- platform: string;
25
- name: string;
26
- version: string;
27
- }>;
28
- };
29
- type ChannelListResponse = {
30
- channels: Array<{
31
- id: string;
32
- platform: string;
33
- name: string;
34
- version?: string;
35
- }>;
36
- total: number;
37
- };
38
- type ContactListResponse = {
39
- contacts: Array<ContactInfo>;
40
- total: number;
41
- hasMore: boolean;
42
- };
43
- type ContactInfo = {
44
- uid: string;
45
- platform: string;
46
- stableId: string;
47
- profile: {
48
- displayName?: string;
49
- username?: string;
50
- };
51
- lastSeenAt: number;
52
- createdAt: number;
53
- };
54
- type SessionListResponse = {
55
- sessions: Array<SessionInfo>;
56
- total: number;
57
- hasMore: boolean;
58
- };
59
- type SessionInfo = {
60
- id: string;
61
- platform?: string;
62
- channelId?: string;
63
- userId?: string;
64
- chatId?: string;
65
- chatType?: string;
66
- chatTitle?: string;
67
- state: string;
68
- createdAt: number;
69
- lastActiveAt: number;
70
- };
71
- type CreateSessionResponse = {
72
- id: string;
73
- createdAt: number;
74
- };
75
- type SendMessageResponse = {
76
- messageId: string;
77
- sessionId: string;
78
- createdAt: number;
79
- metadata?: {
80
- channel?: string;
81
- channelSource?: string;
82
- channelInfo?: {
83
- platform?: string;
84
- channelId?: string;
85
- chatId?: string;
86
- userId?: string;
87
- };
88
- };
89
- };
90
- type HealthCheckData = {
91
- body?: never;
92
- path?: never;
93
- query?: never;
94
- url: '/health';
95
- };
96
- type HealthCheckResponses = {
97
- 200: HealthResponse;
98
- };
99
- type HealthCheckResponse = HealthCheckResponses[keyof HealthCheckResponses];
100
- type GetStatusData = {
101
- body?: never;
102
- path?: never;
103
- query?: never;
104
- url: '/status';
105
- };
106
- type GetStatusResponses = {
107
- 200: StatusResponse;
108
- };
109
- type GetStatusResponse = GetStatusResponses[keyof GetStatusResponses];
110
- type ListChannelsData = {
111
- body?: never;
112
- path?: never;
113
- query?: never;
114
- url: '/channels';
115
- };
116
- type ListChannelsResponses = {
117
- 200: ChannelListResponse;
118
- };
119
- type ListChannelsResponse = ListChannelsResponses[keyof ListChannelsResponses];
120
- type ListContactsData = {
121
- body?: never;
122
- path?: never;
123
- query: {
124
- platform: string;
125
- limit?: number;
126
- offset?: number;
127
- };
128
- url: '/contacts';
129
- };
130
- type ListContactsResponses = {
131
- 200: ContactListResponse;
132
- };
133
- type ListContactsResponse = ListContactsResponses[keyof ListContactsResponses];
134
- type GetContactData = {
135
- body?: never;
136
- path: {
137
- uid: string;
138
- };
139
- query?: never;
140
- url: '/contacts/{uid}';
141
- };
142
- type GetContactErrors = {
143
- 404: unknown;
144
- };
145
- type GetContactResponses = {
146
- 200: ContactInfo & {
147
- aliases?: {
148
- [key: string]: unknown;
149
- };
150
- };
151
- };
152
- type GetContactResponse = GetContactResponses[keyof GetContactResponses];
153
- type ListSessionsData = {
154
- body?: never;
155
- path?: never;
156
- query?: {
157
- limit?: number;
158
- offset?: number;
159
- platform?: string;
160
- channelId?: string;
161
- userId?: string;
162
- chatId?: string;
163
- };
164
- url: '/sessions';
165
- };
166
- type ListSessionsResponses = {
167
- 200: SessionListResponse;
168
- };
169
- type ListSessionsResponse = ListSessionsResponses[keyof ListSessionsResponses];
170
- type GetSessionData = {
171
- body?: never;
172
- path: {
173
- id: string;
174
- };
175
- query?: never;
176
- url: '/sessions/{id}';
177
- };
178
- type GetSessionErrors = {
179
- 404: unknown;
180
- };
181
- type GetSessionResponses = {
182
- 200: SessionInfo & {
183
- subscriberCount?: number;
184
- };
185
- };
186
- type GetSessionResponse = GetSessionResponses[keyof GetSessionResponses];
187
- type CreateSessionData = {
188
- body?: {
189
- title?: string;
190
- channel?: {
191
- platform?: string;
192
- channelId?: string;
193
- userId?: string;
194
- chatId?: string;
195
- };
196
- };
197
- path?: never;
198
- query?: never;
199
- url: '/session';
200
- };
201
- type CreateSessionResponses = {
202
- 200: CreateSessionResponse;
203
- };
204
- type CreateSessionResponse2 = CreateSessionResponses[keyof CreateSessionResponses];
205
- type SendMessageData = {
206
- body: {
207
- content: Array<{
208
- type: string;
209
- text?: string;
210
- image?: string;
211
- data?: string;
212
- }>;
213
- channel?: string;
214
- userId?: string;
215
- chatId?: string;
216
- messageType?: string;
217
- processorId?: string;
218
- agent?: string;
219
- replyToMessageId?: string;
220
- };
221
- path: {
222
- id: string;
223
- };
224
- query?: never;
225
- url: '/session/{id}/prompt';
226
- };
227
- type SendMessageErrors = {
228
- 404: unknown;
229
- };
230
- type SendMessageResponses = {
231
- 200: SendMessageResponse;
232
- };
233
- type SendMessageResponse2 = SendMessageResponses[keyof SendMessageResponses];
234
-
235
- type AuthToken = string | undefined;
236
- interface Auth {
237
- in?: 'header' | 'query' | 'cookie';
238
- key?: string;
239
- name?: string;
240
- scheme?: 'basic' | 'bearer';
241
- type: 'apiKey' | 'http';
242
- }
243
-
244
- interface SerializerOptions<T> {
245
- explode: boolean;
246
- style: T;
247
- }
248
- type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
249
- type ObjectStyle = 'form' | 'deepObject';
250
-
251
- type QuerySerializer = (query: Record<string, unknown>) => string;
252
- type BodySerializer = (body: unknown) => unknown;
253
- type QuerySerializerOptionsObject = {
254
- allowReserved?: boolean;
255
- array?: Partial<SerializerOptions<ArrayStyle>>;
256
- object?: Partial<SerializerOptions<ObjectStyle>>;
257
- };
258
- type QuerySerializerOptions = QuerySerializerOptionsObject & {
259
- parameters?: Record<string, QuerySerializerOptionsObject>;
260
- };
261
-
262
- type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
263
- type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
264
- buildUrl: BuildUrlFn;
265
- getConfig: () => Config;
266
- request: RequestFn;
267
- setConfig: (config: Config) => Config;
268
- } & {
269
- [K in HttpMethod]: MethodFn;
270
- } & ([SseFn] extends [never] ? {
271
- sse?: never;
272
- } : {
273
- sse: {
274
- [K in HttpMethod]: SseFn;
275
- };
276
- });
277
- interface Config$1 {
278
- auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
279
- bodySerializer?: BodySerializer | null;
280
- headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
281
- method?: Uppercase<HttpMethod>;
282
- querySerializer?: QuerySerializer | QuerySerializerOptions;
283
- requestValidator?: (data: unknown) => Promise<unknown>;
284
- responseTransformer?: (data: unknown) => Promise<unknown>;
285
- responseValidator?: (data: unknown) => Promise<unknown>;
286
- }
287
- interface ClientMeta {
288
- }
289
-
290
- type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
291
- fetch?: typeof fetch;
292
- onRequest?: (url: string, init: RequestInit) => Promise<Request>;
293
- onSseError?: (error: unknown) => void;
294
- onSseEvent?: (event: StreamEvent<TData>) => void;
295
- serializedBody?: RequestInit['body'];
296
- sseDefaultRetryDelay?: number;
297
- sseMaxRetryAttempts?: number;
298
- sseMaxRetryDelay?: number;
299
- sseSleepFn?: (ms: number) => Promise<void>;
300
- url: string;
301
- };
302
- interface StreamEvent<TData = unknown> {
303
- data: TData;
304
- event?: string;
305
- id?: string;
306
- retry?: number;
307
- }
308
- type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
309
- stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
310
- };
311
-
312
- type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res | undefined, request: Req | undefined, options: Options) => Err | Promise<Err>;
313
- type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
314
- type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
315
- declare class Interceptors<Interceptor> {
316
- fns: Array<Interceptor | null>;
317
- clear(): void;
318
- eject(id: number | Interceptor): void;
319
- exists(id: number | Interceptor): boolean;
320
- getInterceptorIndex(id: number | Interceptor): number;
321
- update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
322
- use(fn: Interceptor): number;
323
- }
324
- interface Middleware<Req, Res, Err, Options> {
325
- error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
326
- request: Interceptors<ReqInterceptor<Req, Options>>;
327
- response: Interceptors<ResInterceptor<Res, Req, Options>>;
328
- }
329
-
330
- type ResponseStyle = 'data' | 'fields';
331
- interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
332
- baseUrl?: T['baseUrl'];
333
- fetch?: typeof fetch;
334
- next?: never;
335
- parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
336
- responseStyle?: ResponseStyle;
337
- throwOnError?: T['throwOnError'];
338
- }
339
- interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
340
- responseStyle: TResponseStyle;
341
- throwOnError: ThrowOnError;
342
- }>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
343
- body?: unknown;
344
- path?: Record<string, unknown>;
345
- query?: Record<string, unknown>;
346
- security?: ReadonlyArray<Auth>;
347
- url: Url;
348
- }
349
- interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
350
- headers: Headers;
351
- serializedBody?: string;
352
- }
353
- type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
354
- data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
355
- request: Request;
356
- response: Response;
357
- }> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
358
- data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
359
- error: undefined;
360
- } | {
361
- data: undefined;
362
- error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
363
- }) & {
364
- request?: Request;
365
- response?: Response;
366
- }>;
367
- interface ClientOptions {
368
- baseUrl?: string;
369
- responseStyle?: ResponseStyle;
370
- throwOnError?: boolean;
371
- }
372
- type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
373
- type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
374
- type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
375
- type BuildUrlFn = <TData extends {
376
- body?: unknown;
377
- path?: Record<string, unknown>;
378
- query?: Record<string, unknown>;
379
- url: string;
380
- }>(options: TData & Options$1<TData>) => string;
381
- type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
382
- interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
383
- };
384
- interface TDataShape {
385
- body?: unknown;
386
- headers?: unknown;
387
- path?: unknown;
388
- query?: unknown;
389
- url: string;
390
- }
391
- type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
392
- type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
393
-
394
- type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
395
- client?: Client;
396
- meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
397
- };
398
- declare class HeyApiClient {
399
- client: Client;
400
- constructor(args?: {
401
- client?: Client;
402
- });
403
- }
404
- declare class HeyApiRegistry<T> {
405
- private readonly defaultKey;
406
- private readonly instances;
407
- get(key?: string): T;
408
- set(value: T, key?: string): void;
409
- }
410
- declare class EasbotGatewayClient extends HeyApiClient {
411
- static readonly __registry: HeyApiRegistry<EasbotGatewayClient>;
412
- constructor(args?: {
413
- client?: Client;
414
- key?: string;
415
- });
416
- healthCheck<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<HealthCheckResponses, unknown, ThrowOnError>;
417
- getStatus<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<GetStatusResponses, unknown, ThrowOnError>;
418
- listChannels<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<ListChannelsResponses, unknown, ThrowOnError>;
419
- listContacts<ThrowOnError extends boolean = false>(parameters: {
420
- platform: string;
421
- limit?: number;
422
- offset?: number;
423
- }, options?: Options<never, ThrowOnError>): RequestResult<ListContactsResponses, unknown, ThrowOnError>;
424
- getContact<ThrowOnError extends boolean = false>(parameters: {
425
- uid: string;
426
- }, options?: Options<never, ThrowOnError>): RequestResult<GetContactResponses, GetContactErrors, ThrowOnError>;
427
- listSessions<ThrowOnError extends boolean = false>(parameters?: {
428
- limit?: number;
429
- offset?: number;
430
- platform?: string;
431
- channelId?: string;
432
- userId?: string;
433
- chatId?: string;
434
- }, options?: Options<never, ThrowOnError>): RequestResult<ListSessionsResponses, unknown, ThrowOnError>;
435
- getSession<ThrowOnError extends boolean = false>(parameters: {
436
- id: string;
437
- }, options?: Options<never, ThrowOnError>): RequestResult<GetSessionResponses, GetSessionErrors, ThrowOnError>;
438
- createSession<ThrowOnError extends boolean = false>(parameters?: {
439
- title?: string;
440
- channel?: {
441
- platform?: string;
442
- channelId?: string;
443
- userId?: string;
444
- chatId?: string;
445
- };
446
- }, options?: Options<never, ThrowOnError>): RequestResult<CreateSessionResponses, unknown, ThrowOnError>;
447
- sendMessage<ThrowOnError extends boolean = false>(parameters: {
448
- id: string;
449
- content: Array<{
450
- type: string;
451
- text?: string;
452
- image?: string;
453
- data?: string;
454
- }>;
455
- channel?: string;
456
- userId?: string;
457
- chatId?: string;
458
- messageType?: string;
459
- processorId?: string;
460
- agent?: string;
461
- replyToMessageId?: string;
462
- }, options?: Options<never, ThrowOnError>): RequestResult<SendMessageResponses, SendMessageErrors, ThrowOnError>;
463
- }
464
-
465
- declare function createEasbotGatewayClient(config?: Config & {
466
- directory?: string;
467
- }): EasbotGatewayClient;
1
+ import { EasbotGatewayClientConfig as Config, EasbotGatewayClient } from './client-entry.cjs';
2
+ export { Client, ClientOptions, GatewayChannelsListData, GatewayChannelsListError, GatewayChannelsListErrors, GatewayChannelsListResponse, GatewayChannelsListResponses, GatewayContactsGetData, GatewayContactsGetError, GatewayContactsGetErrors, GatewayContactsGetResponse, GatewayContactsGetResponses, GatewayContactsListData, GatewayContactsListError, GatewayContactsListErrors, GatewayContactsListResponse, GatewayContactsListResponses, GatewayHealthData, GatewayHealthResponse, GatewayHealthResponses, GatewaySessionCreateData, GatewaySessionCreateError, GatewaySessionCreateErrors, GatewaySessionCreateResponse, GatewaySessionCreateResponses, GatewaySessionPromptData, GatewaySessionPromptError, GatewaySessionPromptErrors, GatewaySessionPromptResponse, GatewaySessionPromptResponses, GatewaySessionsGetData, GatewaySessionsGetError, GatewaySessionsGetErrors, GatewaySessionsGetResponse, GatewaySessionsGetResponses, GatewaySessionsListData, GatewaySessionsListResponse, GatewaySessionsListResponses, GatewayStatusData, GatewayStatusResponse, GatewayStatusResponses, GatewaySubscriptionsListData, GatewaySubscriptionsListResponse, GatewaySubscriptionsListResponses, Options, RequestResult, createEasbotGatewayClient } from './client-entry.cjs';
468
3
 
469
4
  type ServerOptions = {
470
5
  hostname?: string;
@@ -486,4 +21,4 @@ declare function createEasbotGateway(options?: ServerOptions): Promise<{
486
21
  };
487
22
  }>;
488
23
 
489
- export { type ChannelListResponse, type Client, type ClientOptions$1 as ClientOptions, type ContactInfo, type ContactListResponse, type CreateSessionData, type CreateSessionResponse, type CreateSessionResponse2, type CreateSessionResponses, EasbotGatewayClient, type Config as EasbotGatewayClientConfig, type GetContactData, type GetContactErrors, type GetContactResponse, type GetContactResponses, type GetSessionData, type GetSessionErrors, type GetSessionResponse, type GetSessionResponses, type GetStatusData, type GetStatusResponse, type GetStatusResponses, type HealthCheckData, type HealthCheckResponse, type HealthCheckResponses, type HealthResponse, type ListChannelsData, type ListChannelsResponse, type ListChannelsResponses, type ListContactsData, type ListContactsResponse, type ListContactsResponses, type ListSessionsData, type ListSessionsResponse, type ListSessionsResponses, type Options$1 as Options, type RequestResult, type SendMessageData, type SendMessageErrors, type SendMessageResponse, type SendMessageResponse2, type SendMessageResponses, type ServerOptions, type SessionInfo, type SessionListResponse, type StatusResponse, createEasbotGateway, createEasbotGatewayClient, createEasbotGatewayServer };
24
+ export { EasbotGatewayClient, Config as EasbotGatewayClientConfig, type ServerOptions, createEasbotGateway, createEasbotGatewayServer };