@webitel/chat-web-sdk 0.0.2 → 0.0.4

package/README.md

@@ -1 +1,3 @@
-# chat-sdk-web
+# `@webitel/chat-web-sdk`
+
+> **Beta:** This SDK is in beta. APIs and behavior may change between releases; pin versions in production and review changelogs when upgrading.

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import * as _webitel_api_services_gen_models from '@webitel/api-services/gen/models';
+import { WebitelImApiGatewayV1HistoryMessage, WebitelImApiGatewayV1SearchMessageHistoryResponse, WebitelImApiGatewayV1SendDocumentRequest, WebitelImApiGatewayV1SendImageRequest, WebitelImApiGatewayV1ContactList, WebitelImApiGatewayV1Contact, WebitelImApiGatewayV1SendTextRequest, WebitelImApiGatewayV1SendTextResponse, ContactsSearchParams, MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams, WebitelImApiGatewayV1SendDocumentResponse, WebitelImApiGatewayV1SendImageResponse, WebitelImApiGatewayV1Thread, WebitelImApiGatewayV1SearchThreadResponse, ThreadManagementSearchParams } from '@webitel/api-services/gen/models';
+export { WebitelImApiGatewayV1Authorization as AccountModel, WebitelImApiGatewayV1Contact as ContactModel, ContactsSearchParams as ContactSearchParams, MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams as MessageHistorySearchParams, WebitelImApiGatewayV1HistoryMessage as MessageModel, WebitelImApiGatewayV1Thread as ThreadModel, ThreadManagementSearchParams as ThreadSearchParams } from '@webitel/api-services/gen/models';
 import { AxiosInstance } from 'axios';
-import { WebitelImApiGatewayV1HistoryMessage, WebitelImApiGatewayV1SearchMessageHistoryResponse, WebitelImApiGatewayV1Thread, MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams, WebitelImApiGatewayV1SearchThreadResponse, ThreadManagementSearchParams, WebitelImApiGatewayV1ContactList, WebitelImApiGatewayV1Contact, ContactsSearchParams } from '@webitel/api-services/gen/models';
-export { WebitelImApiGatewayV1Contact as ContactModel, ContactsSearchParams as ContactSearchParams, MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams as MessageHistorySearchParams, WebitelImApiGatewayV1HistoryMessage as MessageModel, WebitelImApiGatewayV1Thread as ThreadModel, ThreadManagementSearchParams as ThreadSearchParams } from '@webitel/api-services/gen/models';
 
 type ServiceConfigInputSchema = {
     baseUrl: string;
@@ -10,7 +11,7 @@ declare class ServiceConfig implements ServiceConfigInputSchema {
     baseUrl: string;
     accessToken: string | (() => string) | (() => Promise<string>);
     axiosInstance: AxiosInstance;
-    constructor({ baseUrl, accessToken, }: ServiceConfigInputSchema);
+    constructor({ baseUrl, accessToken }: ServiceConfigInputSchema);
     setupAxiosTokenHandler(): void;
 }
 declare function createServiceConfig(rawServiceConfig: ServiceConfigInputSchema): ServiceConfig;
@@ -22,7 +23,7 @@ type SocketConfigInputSchema = {
 declare class SocketConfig implements SocketConfigInputSchema {
     baseUrl: string;
     accessToken: string | (() => string) | (() => Promise<string>);
-    constructor({ baseUrl, accessToken, }: SocketConfigInputSchema);
+    constructor({ baseUrl, accessToken }: SocketConfigInputSchema);
 }
 declare function createSocketConfig(rawSocketConfig: SocketConfigInputSchema): SocketConfig;
 
@@ -30,30 +31,32 @@ interface ServiceConfigurable {
     get serviceConfig(): ServiceConfig;
 }
 
+declare function useAccountService(config: ServiceConfig): {
+    getAccount: () => Promise<_webitel_api_services_gen_models.WebitelImApiGatewayV1Authorization>;
+};
+
 interface IMessage extends WebitelImApiGatewayV1HistoryMessage {
     markRead: () => Promise<void>;
 }
 /**
  * API response with `messages` replaced by instantiated SDK `Message` classes.
  */
-type MessageHistorySearchResult = Omit<WebitelImApiGatewayV1SearchMessageHistoryResponse, 'messages'> & {
-    messages: IMessage[];
+type MessageHistorySearchResult = Omit<WebitelImApiGatewayV1SearchMessageHistoryResponse, 'items'> & {
+    items: IMessage[];
 };
-
-interface IThread extends WebitelImApiGatewayV1Thread, ServiceConfigurable {
-    id: string;
-    fetchMessageHistory: (params?: MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams) => Promise<MessageHistorySearchResult>;
-}
-type ThreadSearchResult = Omit<WebitelImApiGatewayV1SearchThreadResponse, 'threads'> & {
-    threads: IThread[];
+type MessageSendFileParams = Omit<WebitelImApiGatewayV1SendDocumentRequest, 'document'> & {
+    document?: NonNullable<WebitelImApiGatewayV1SendDocumentRequest['document']>;
+    file: File;
+    threadId: string;
 };
-
-declare function useThreadsService(config: ServiceConfig): {
-    fetchThreads: (params?: ThreadManagementSearchParams) => Promise<ThreadSearchResult>;
+type MessageSendImageParams = Omit<WebitelImApiGatewayV1SendImageRequest, 'image'> & {
+    image?: NonNullable<WebitelImApiGatewayV1SendImageRequest['image']>;
+    file: File;
+    threadId: string;
 };
 
 interface IContact extends WebitelImApiGatewayV1Contact, ServiceConfigurable {
-    sendMessage: () => {};
+    sendTextMessage: (body: string, params?: Omit<WebitelImApiGatewayV1SendTextRequest, 'body' | 'to'>) => Promise<WebitelImApiGatewayV1SendTextResponse>;
 }
 type ContactSearchResult = Omit<WebitelImApiGatewayV1ContactList, 'items'> & {
     items: IContact[];
@@ -63,9 +66,13 @@ declare function useContactsService(config: ServiceConfig): {
     fetchContacts: (params?: ContactsSearchParams) => Promise<ContactSearchResult>;
 };
 
-declare function useMessagesService(config: ServiceConfig): {
+interface IMessagesService {
     fetchMessageHistory: (threadId: string, params?: MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams) => Promise<MessageHistorySearchResult>;
-};
+    sendTextMessage: (params: WebitelImApiGatewayV1SendTextRequest) => Promise<WebitelImApiGatewayV1SendTextResponse>;
+    sendFileMessage: (params: MessageSendFileParams) => Promise<WebitelImApiGatewayV1SendDocumentResponse>;
+    sendImageMessage: (params: MessageSendImageParams) => Promise<WebitelImApiGatewayV1SendImageResponse>;
+}
+declare function useMessagesService(config: ServiceConfig): IMessagesService;
 
 /**
  * @see https://github.com/webitel/im-delivery-service/blob/main/api/asyncapi/asyncapi.yaml#L56
@@ -109,4 +116,22 @@ declare class ChatsSocketClient implements IChatsSocketClient {
 }
 declare function createChatsSocketClient(config: SocketConfig): ChatsSocketClient;
 
-export { ChatsSocketMessage, type ContactSearchResult, type IContact, type IMessage, type IThread, type MessageHistorySearchResult, ServiceConfig, type ServiceConfigInputSchema, SocketConfig, type SocketConfigInputSchema, type ThreadSearchResult, createChatsSocketClient, createServiceConfig, createSocketConfig, useContactsService, useMessagesService, useThreadsService };
+type ThreadSendTextMessageParams = Omit<WebitelImApiGatewayV1SendTextRequest, 'body' | 'to'>;
+type ThreadSendFileMessageParams = Omit<MessageSendFileParams, 'file' | 'threadId' | 'to'>;
+type ThreadSendImageMessageParams = Omit<MessageSendImageParams, 'file' | 'threadId' | 'to'>;
+interface IThread extends WebitelImApiGatewayV1Thread, ServiceConfigurable {
+    id: string;
+    fetchMessageHistory: (params?: MessageHistorySearchThreadMessagesHistoryWebitelImApiGatewayV1MessageHistoryParams) => Promise<MessageHistorySearchResult>;
+    sendTextMessage: (body: string, params?: ThreadSendTextMessageParams) => Promise<WebitelImApiGatewayV1SendTextResponse>;
+    sendFileMessage: (file: File, params?: ThreadSendFileMessageParams) => Promise<WebitelImApiGatewayV1SendDocumentResponse>;
+    sendImageMessage: (file: File, params?: ThreadSendImageMessageParams) => Promise<WebitelImApiGatewayV1SendImageResponse>;
+}
+type ThreadSearchResult = Omit<WebitelImApiGatewayV1SearchThreadResponse, 'items'> & {
+    items: IThread[];
+};
+
+declare function useThreadsService(config: ServiceConfig): {
+    fetchThreads: (params?: ThreadManagementSearchParams) => Promise<ThreadSearchResult>;
+};
+
+export { ChatsSocketMessage, type ContactSearchResult, type IContact, type IMessage, type IThread, type MessageHistorySearchResult, ServiceConfig, type ServiceConfigInputSchema, SocketConfig, type SocketConfigInputSchema, type ThreadSearchResult, createChatsSocketClient, createServiceConfig, createSocketConfig, useAccountService, useContactsService, useMessagesService, useThreadsService };