@botpress/webchat 1.3.3 → 1.3.4

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+> @botpress/webchat@1.3.4 build /home/runner/work/echo/echo/packages/webchat-frontend
+> vite build
+
+vite v4.4.11 building for production...
+transforming...
+[plugin:vite:resolve] Module "crypto" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/packages/webchat-frontend/src/gen/client/errors.ts". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "node:http" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@botpress+sdk@0.8.2/node_modules/@botpress/sdk/dist/index.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "util" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@botpress+sdk@0.8.2/node_modules/@botpress/sdk/dist/index.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "path" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@apidevtools+json-schema-ref-parser@11.6.1/node_modules/@apidevtools/json-schema-ref-parser/dist/lib/util/url.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "path" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@apidevtools+json-schema-ref-parser@11.6.1/node_modules/@apidevtools/json-schema-ref-parser/dist/lib/util/convert-path-to-posix.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "util" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@jsdevtools+ono@7.1.3/node_modules/@jsdevtools/ono/esm/types.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+../../node_modules/.pnpm/@jsdevtools+ono@7.1.3/node_modules/@jsdevtools/ono/esm/types.js (1:9) "inspect" is not exported by "__vite-browser-external", imported by "../../node_modules/.pnpm/@jsdevtools+ono@7.1.3/node_modules/@jsdevtools/ono/esm/types.js".
+✓ 2306 modules transformed.
+rendering chunks...
+
+[vite:dts] Start generate declaration files...
+computing gzip size...
+[vite:dts] Declaration files built in 14532ms.
+
+dist/index.js  1,501.30 kB │ gzip: 369.07 kB
+dist/index.umd.cjs  1,034.78 kB │ gzip: 308.50 kB
+✓ built in 25.13s

package/dist/adapters/messaging-to-target.d.ts

@@ -5,9 +5,9 @@ export type MessagingToTargetAdapters = adapters.Adapter<adapters.messaging.Mess
 export declare const audioAdapter: ({ type, audio }: {
     type: "audio";
     audio: string;
+    title?: string | undefined;
     className?: string | undefined;
     avatarUrl?: string | undefined;
-    title?: string | undefined;
 }) => {
     payload: {
         type: "audio";
@@ -31,9 +31,9 @@ export declare const cardAdapter: (card: {
         payload: string;
     })[];
     className?: string | undefined;
-    avatarUrl?: string | undefined;
-    subtitle?: string | undefined;
     image?: string | undefined;
+    subtitle?: string | undefined;
+    avatarUrl?: string | undefined;
 }) => {
     payload: WithBubble<target.ColumnMessage>;
 };
@@ -56,9 +56,9 @@ export declare const carouselAdapter: ({ items }: {
             payload: string;
         })[];
         className?: string | undefined;
-        avatarUrl?: string | undefined;
-        subtitle?: string | undefined;
         image?: string | undefined;
+        subtitle?: string | undefined;
+        avatarUrl?: string | undefined;
     }[];
     className?: string | undefined;
     avatarUrl?: string | undefined;
@@ -76,8 +76,8 @@ export declare const choiceAdapter: (x: {
         value: string;
     }[];
     className?: string | undefined;
-    avatarUrl?: string | undefined;
     disableFreeText?: boolean | undefined;
+    avatarUrl?: string | undefined;
 }) => {
     disableInput: boolean | undefined;
     payload: target.Message;
@@ -88,17 +88,17 @@ export declare const dropdownAdapter: (x: {
         label: string;
     }[];
     type: "dropdown";
+    message?: string | undefined;
+    text?: string | undefined;
     className?: string | undefined;
+    markdown?: boolean | undefined;
     avatarUrl?: string | undefined;
-    message?: string | undefined;
     allowCreation?: boolean | undefined;
     placeholderText?: string | undefined;
     allowMultiple?: boolean | undefined;
     buttonText?: string | undefined;
     width?: number | undefined;
     displayInKeyboard?: boolean | undefined;
-    markdown?: boolean | undefined;
-    text?: string | undefined;
 }) => {
     disableInput: true;
     payload: WithBubble<target.ColumnMessage>;
@@ -106,15 +106,15 @@ export declare const dropdownAdapter: (x: {
 export declare const fileAdapter: ({ file, ...props }: {
     type: "file";
     file: string;
+    title?: string | undefined;
     className?: string | undefined;
     avatarUrl?: string | undefined;
-    title?: string | undefined;
 }) => {
     payload: {
         type: "file";
+        title?: string | undefined;
         className?: string | undefined;
         avatarUrl?: string | undefined;
-        title?: string | undefined;
         url: string;
     };
 };
@@ -133,10 +133,10 @@ export declare const locationAdapter: ({ type, latitude, longitude, title, addre
     type: "location";
     latitude: number;
     longitude: number;
+    title?: string | undefined;
     className?: string | undefined;
-    avatarUrl?: string | undefined;
     address?: string | undefined;
-    title?: string | undefined;
+    avatarUrl?: string | undefined;
 }) => {
     payload: {
         type: "location";
@@ -159,8 +159,8 @@ export declare const textAdapter: ({ type, text }: {
     type: "text";
     text: string;
     className?: string | undefined;
-    avatarUrl?: string | undefined;
     markdown?: boolean | undefined;
+    avatarUrl?: string | undefined;
 }) => {
     payload: WithBubble<{
         type: "text";
@@ -170,9 +170,9 @@ export declare const textAdapter: ({ type, text }: {
 export declare const videoAdapter: ({ type, video }: {
     type: "video";
     video: string;
+    title?: string | undefined;
     className?: string | undefined;
     avatarUrl?: string | undefined;
-    title?: string | undefined;
 }) => {
     payload: {
         type: "video";

package/dist/adapters/webchat-to-target.d.ts

@@ -54,8 +54,8 @@ export declare const choiceAdapter: (webchatMessage: {
     }[];
     type: "choice";
     text: string;
-    disableFreeText?: boolean | undefined;
     className?: string | undefined;
+    disableFreeText?: boolean | undefined;
 }) => {
     disableInput: boolean | undefined;
     payload: target.Message;
@@ -82,9 +82,9 @@ export declare const fileAdapter: (webchatMessage: {
 }) => {
     payload: {
         type: "file";
+        title?: string | undefined;
         className?: string | undefined;
         avatarUrl?: string | undefined;
-        title?: string | undefined;
         url: string;
     };
 };
@@ -103,8 +103,8 @@ export declare const locationAdapter: (webchatMessage: {
     latitude: number;
     longitude: number;
     title?: string | undefined;
-    address?: string | undefined;
     className?: string | undefined;
+    address?: string | undefined;
 }) => {
     payload: {
         type: "location";

package/dist/client/PushpinClient/inner-client/index.d.ts

@@ -1,4 +1,4 @@
-import { ApiClient as AutoGeneratedClient } from '../../../gen/client/client';
+import { Client as AutoGeneratedClient } from '../../../gen/client';
 import { SignalListener } from './signal-listener';
 export type { Message, Conversation, User } from '../../../gen/client';
 export * from '../../../gen/client/errors';
@@ -37,5 +37,5 @@ export declare class Client implements IClient {
     readonly deleteUser: IAutoClient['deleteUser'];
     readonly createEvent: IAutoClient['createEvent'];
     readonly getEvent: IAutoClient['getEvent'];
-    readonly listenConversation: ({ id, xUserKey }: ListenConversationArgs) => Promise<SignalListener>;
+    readonly listenConversation: ({ id, "x-user-key": userKey, }: ListenConversationArgs) => Promise<SignalListener>;
 }

package/dist/gen/client/index.d.ts

@@ -1,13 +1,78 @@
-/**
- * Webchat API
- * API for the Webchat Integration
- *
- * The version of the OpenAPI document: 0.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export * from "./api";
-export * from "./configuration";
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import * as addParticipant from './operations/addParticipant';
+import * as createConversation from './operations/createConversation';
+import * as deleteConversation from './operations/deleteConversation';
+import * as getConversation from './operations/getConversation';
+import * as getParticipant from './operations/getParticipant';
+import * as listConversationMessages from './operations/listConversationMessages';
+import * as listConversations from './operations/listConversations';
+import * as listParticipants from './operations/listParticipants';
+import * as listenConversation from './operations/listenConversation';
+import * as removeParticipant from './operations/removeParticipant';
+import * as createMessage from './operations/createMessage';
+import * as deleteMessage from './operations/deleteMessage';
+import * as getMessage from './operations/getMessage';
+import * as createUser from './operations/createUser';
+import * as deleteUser from './operations/deleteUser';
+import * as getUser from './operations/getUser';
+import * as updateUser from './operations/updateUser';
+import * as createEvent from './operations/createEvent';
+import * as getEvent from './operations/getEvent';
+export * from './models';
+export * as addParticipant from './operations/addParticipant';
+export * as createConversation from './operations/createConversation';
+export * as deleteConversation from './operations/deleteConversation';
+export * as getConversation from './operations/getConversation';
+export * as getParticipant from './operations/getParticipant';
+export * as listConversationMessages from './operations/listConversationMessages';
+export * as listConversations from './operations/listConversations';
+export * as listParticipants from './operations/listParticipants';
+export * as listenConversation from './operations/listenConversation';
+export * as removeParticipant from './operations/removeParticipant';
+export * as createMessage from './operations/createMessage';
+export * as deleteMessage from './operations/deleteMessage';
+export * as getMessage from './operations/getMessage';
+export * as createUser from './operations/createUser';
+export * as deleteUser from './operations/deleteUser';
+export * as getUser from './operations/getUser';
+export * as updateUser from './operations/updateUser';
+export * as createEvent from './operations/createEvent';
+export * as getEvent from './operations/getEvent';
+export declare class Client {
+    private axiosInstance;
+    constructor(axiosInstance: AxiosInstance);
+    readonly addParticipant: (input: addParticipant.AddParticipantInput) => Promise<addParticipant.AddParticipantResponse>;
+    readonly createConversation: (input: createConversation.CreateConversationInput) => Promise<createConversation.CreateConversationResponse>;
+    readonly deleteConversation: (input: deleteConversation.DeleteConversationInput) => Promise<deleteConversation.DeleteConversationResponse>;
+    readonly getConversation: (input: getConversation.GetConversationInput) => Promise<getConversation.GetConversationResponse>;
+    readonly getParticipant: (input: getParticipant.GetParticipantInput) => Promise<getParticipant.GetParticipantResponse>;
+    readonly listConversationMessages: (input: listConversationMessages.ListConversationMessagesInput) => Promise<listConversationMessages.ListConversationMessagesResponse>;
+    readonly listConversations: (input: listConversations.ListConversationsInput) => Promise<listConversations.ListConversationsResponse>;
+    readonly listParticipants: (input: listParticipants.ListParticipantsInput) => Promise<listParticipants.ListParticipantsResponse>;
+    readonly listenConversation: (input: listenConversation.ListenConversationInput) => Promise<listenConversation.ListenConversationResponse>;
+    readonly removeParticipant: (input: removeParticipant.RemoveParticipantInput) => Promise<removeParticipant.RemoveParticipantResponse>;
+    readonly createMessage: (input: createMessage.CreateMessageInput) => Promise<createMessage.CreateMessageResponse>;
+    readonly deleteMessage: (input: deleteMessage.DeleteMessageInput) => Promise<deleteMessage.DeleteMessageResponse>;
+    readonly getMessage: (input: getMessage.GetMessageInput) => Promise<getMessage.GetMessageResponse>;
+    readonly createUser: (input: createUser.CreateUserInput) => Promise<createUser.CreateUserResponse>;
+    readonly deleteUser: (input: deleteUser.DeleteUserInput) => Promise<deleteUser.DeleteUserResponse>;
+    readonly getUser: (input: getUser.GetUserInput) => Promise<getUser.GetUserResponse>;
+    readonly updateUser: (input: updateUser.UpdateUserInput) => Promise<updateUser.UpdateUserResponse>;
+    readonly createEvent: (input: createEvent.CreateEventInput) => Promise<createEvent.CreateEventResponse>;
+    readonly getEvent: (input: getEvent.GetEventInput) => Promise<getEvent.GetEventResponse>;
+}
+type Primitive = string | number | boolean;
+type Value<P extends Primitive> = P | P[] | Record<string, P>;
+type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
+type AnyQueryParams = Record<string, QueryValue>;
+type HeaderValue = string | undefined;
+type AnyHeaderParams = Record<string, HeaderValue>;
+type AnyBodyParams = Record<string, any>;
+type ParsedRequest = {
+    method: string;
+    path: string;
+    query: AnyQueryParams;
+    headers: AnyHeaderParams;
+    body: AnyBodyParams;
+};
+export declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig;

package/dist/gen/client/models.d.ts

@@ -0,0 +1,210 @@
+/**
+ * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
+ */
+export interface User {
+    /**
+     * Name of the [User](#schema_user)
+     */
+    name?: string;
+    /**
+     * Picture url of the [User](#schema_user)
+     */
+    pictureUrl?: string;
+    /**
+     * Id of the [User](#schema_user)
+     */
+    id: string;
+    /**
+     * Creation date of the [User](#schema_user) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Updating date of the [User](#schema_user) in ISO 8601 format
+     */
+    updatedAt: string;
+}
+export interface Conversation {
+    /**
+     * Id of the [Conversation](#schema_conversation)
+     */
+    id: string;
+    /**
+     * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
+     */
+    updatedAt: string;
+}
+/**
+ * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
+ */
+export interface Message {
+    /**
+     * Id of the [Message](#schema_message)
+     */
+    id: string;
+    /**
+     * Creation date of the [Message](#schema_message) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Payload is the content type of the message.
+     */
+    payload: {
+        audioUrl: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "audio";
+    } | {
+        title: string;
+        subtitle?: string;
+        imageUrl?: string;
+        actions: {
+            action: "postback" | "url" | "say";
+            label: string;
+            value: string;
+        }[];
+        type: "card";
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+    } | {
+        items: {
+            title: string;
+            subtitle?: string;
+            imageUrl?: string;
+            actions: {
+                action: "postback" | "url" | "say";
+                label: string;
+                value: string;
+            }[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+        }[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "carousel";
+    } | {
+        text: string;
+        options: {
+            label: string;
+            value: string;
+        }[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "choice";
+        disableFreeText?: boolean;
+    } | {
+        text: string;
+        options: {
+            label: string;
+            value: string;
+        }[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "dropdown";
+    } | {
+        fileUrl: string;
+        title?: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "file";
+    } | {
+        imageUrl: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "image";
+    } | {
+        latitude: number;
+        longitude: number;
+        address?: string;
+        title?: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "location";
+    } | {
+        markdown: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "markdown";
+    } | {
+        text: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "text";
+    } | {
+        videoUrl: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "video";
+    };
+    /**
+     * ID of the [User](#schema_user)
+     */
+    userId: string;
+    /**
+     * ID of the [Conversation](#schema_conversation)
+     */
+    conversationId: string;
+}
+export interface Event {
+    /**
+     * ID of the [Event](#schema_event).
+     */
+    id: string;
+    /**
+     * Creation date of the [Event](#schema_event) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Payload is the content of the event.
+     */
+    payload: {
+        type: "custom";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    } | {
+        type: "conversation_started";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    };
+    /**
+     * ID of the [Conversation](#schema_conversation).
+     */
+    conversationId: string;
+    /**
+     * ID of the [User](#schema_user).
+     */
+    userId: string;
+}

package/dist/gen/client/operations/addParticipant.d.ts

@@ -0,0 +1,51 @@
+export interface AddParticipantRequestHeaders {
+    "x-user-key": string;
+}
+export interface AddParticipantRequestQuery {
+}
+export interface AddParticipantRequestParams {
+    id: string;
+}
+export interface AddParticipantRequestBody {
+    /**
+     * User id
+     */
+    userId: string;
+}
+export type AddParticipantInput = AddParticipantRequestBody & AddParticipantRequestHeaders & AddParticipantRequestQuery & AddParticipantRequestParams;
+export type AddParticipantRequest = {
+    headers: AddParticipantRequestHeaders;
+    query: AddParticipantRequestQuery;
+    params: AddParticipantRequestParams;
+    body: AddParticipantRequestBody;
+};
+export declare const parseReq: (input: AddParticipantInput) => AddParticipantRequest & {
+    path: string;
+};
+export interface AddParticipantResponse {
+    /**
+     * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
+     */
+    participant: {
+        /**
+         * Name of the [User](#schema_user)
+         */
+        name?: string;
+        /**
+         * Picture url of the [User](#schema_user)
+         */
+        pictureUrl?: string;
+        /**
+         * Id of the [User](#schema_user)
+         */
+        id: string;
+        /**
+         * Creation date of the [User](#schema_user) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [User](#schema_user) in ISO 8601 format
+         */
+        updatedAt: string;
+    };
+}

package/dist/gen/client/operations/createConversation.d.ts

@@ -0,0 +1,39 @@
+export interface CreateConversationRequestHeaders {
+    "x-user-key": string;
+}
+export interface CreateConversationRequestQuery {
+}
+export interface CreateConversationRequestParams {
+}
+/**
+ * Conversation properties
+ */
+export interface CreateConversationRequestBody {
+    _?: string;
+}
+export type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
+export type CreateConversationRequest = {
+    headers: CreateConversationRequestHeaders;
+    query: CreateConversationRequestQuery;
+    params: CreateConversationRequestParams;
+    body: CreateConversationRequestBody;
+};
+export declare const parseReq: (input: CreateConversationInput) => CreateConversationRequest & {
+    path: string;
+};
+export interface CreateConversationResponse {
+    conversation: {
+        /**
+         * Id of the [Conversation](#schema_conversation)
+         */
+        id: string;
+        /**
+         * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
+         */
+        updatedAt: string;
+    };
+}

package/dist/gen/client/operations/createEvent.d.ts

@@ -0,0 +1,79 @@
+export interface CreateEventRequestHeaders {
+    "x-user-key": string;
+}
+export interface CreateEventRequestQuery {
+}
+export interface CreateEventRequestParams {
+}
+export interface CreateEventRequestBody {
+    /**
+     * Payload is the content type of the event.
+     */
+    payload: {
+        type: "custom";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    } | {
+        type: "conversation_started";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    };
+    /**
+     * ID of the [Conversation](#schema_conversation)
+     */
+    conversationId: string;
+}
+export type CreateEventInput = CreateEventRequestBody & CreateEventRequestHeaders & CreateEventRequestQuery & CreateEventRequestParams;
+export type CreateEventRequest = {
+    headers: CreateEventRequestHeaders;
+    query: CreateEventRequestQuery;
+    params: CreateEventRequestParams;
+    body: CreateEventRequestBody;
+};
+export declare const parseReq: (input: CreateEventInput) => CreateEventRequest & {
+    path: string;
+};
+export interface CreateEventResponse {
+    event: {
+        /**
+         * ID of the [Event](#schema_event).
+         */
+        id: string;
+        /**
+         * Creation date of the [Event](#schema_event) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Payload is the content of the event.
+         */
+        payload: {
+            type: "custom";
+            data: {
+                [k: string]: {
+                    [k: string]: any;
+                };
+            };
+        } | {
+            type: "conversation_started";
+            data: {
+                [k: string]: {
+                    [k: string]: any;
+                };
+            };
+        };
+        /**
+         * ID of the [Conversation](#schema_conversation).
+         */
+        conversationId: string;
+        /**
+         * ID of the [User](#schema_user).
+         */
+        userId: string;
+    };
+}