@seamly/web-ui 24.5.0-beta.1 → 25.0.0

package/src/javascripts/core/api/channel.types.ts

@@ -4,7 +4,6 @@
  */
 
 /** OneOf type helpers */
-// eslint-disable-next-line no-unused-vars
 type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never }
 type XOR<T, U> = T | U extends object
   ? (Without<T, U> & U) | (Without<U, T> & T)
@@ -144,21 +143,21 @@ export interface components {
         conversations?: {
           /**
            * @description The endpoint to create a new conversation
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations
            */
           href: string
         }
         self?: {
           /**
            * @description The endpoint of the current request
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/configs?v=2
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/configs?v=2
            */
           href: string
         }
         translations?: {
           /**
            * @description The endpoint to fetch the translation labels to use in the interface of your client. You must replace {version} by the version of the translation set (currently: 1), and you must replace {locale} by the required locale (ie: 'nl-informal').
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/translations/{version}/{locale}
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/translations/{version}/{locale}
            */
           href: string
           /**
@@ -223,22 +222,8 @@ export interface components {
           settings?: {
             /** @description Settings related to the input field */
             entry: {
-              /**
-               * @description The default type of input field.
-               * @example text
-               * @enum {string}
-               */
-              default: 'text' | 'postal_code' | 'upload'
               /** @description Specific options of the various entry types */
               options: {
-                /** @description Settings of the text entry */
-                text: {
-                  /**
-                   * @description Maximum number of characters the use may enter
-                   * @example 100
-                   */
-                  limit: number | null
-                }
                 /** @description Settings of the upload entry */
                 upload: {
                   /**
@@ -313,7 +298,7 @@ export interface components {
           } | null
         }
         /**
-         * @description The amount of unread messages. Unread MessageMessage and MessageInfo (with type=text) messages are counted.
+         * @description The number of unread messages. Unread MessageMessage and MessageInfo (with type=text) messages are counted.
          * @example 2
          */
         unreadMessageCount: number
@@ -327,28 +312,28 @@ export interface components {
         conversation: {
           /**
            * @description The endpoint retrieve the conversation later on to resume it
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c
            */
           href: string
         }
         self: {
           /**
            * @description The endpoint retrieve the conversation later on to resume it
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c
            */
           href: string
         }
         socket: {
           /**
            * @description The endpoint of the conversation websocket
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/socket/websocket
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/socket/websocket
            */
           href: string
         }
         uploads: {
           /**
            * @description The endpoint to send uploaded files to
-           * @example /channels/api/v2/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/uploads
+           * @example /channels/api/v3/client/f38c06f4-283b-4011-8672-4923cbdc8f26/srv_id/3010109/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/uploads
            */
           href: string
         }
@@ -407,16 +392,295 @@ export interface components {
       } | null
     } | null
     Entry:
+      | components['schemas']['EntryAlphanumeric']
+      | components['schemas']['EntryChoicePrompt']
+      | components['schemas']['EntryDateTime']
+      | components['schemas']['EntryIntent']
+      | components['schemas']['EntryMfa']
+      | components['schemas']['EntryNumeric']
+      | components['schemas']['EntryPhoneNumber']
+      | components['schemas']['EntryPostalCode']
       | components['schemas']['EntryText']
       | components['schemas']['EntryUpload']
-    EntryText: {
-      /** @description Settings of the text entry */
+    EntryAlphanumeric: {
+      /** @description Settings of the alphanumeric entry */
       options: {
         /**
-         * @description Allow the user to also manually enter text as a response to a choice prompt message. By default this is set to true.
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+        /**
+         * @description Seamly validates the processed input using this PCRE regular expression. The processed input will be used if it matches the pattern. In any other case, the original input is kept as-is.
+         * @example /[a-f0-9]{6}/i
+         */
+        validationPattern: string
+      }
+      /**
+       * @description Entry type
+       * @example alphanumeric
+       * @enum {string}
+       */
+      type: 'alphanumeric'
+    }
+    EntryChoicePrompt: {
+      /** @description Settings of the choice prompt entry */
+      options: {
+        /**
+         * @description Whether manual input is allowed. When set to `false`, the user must pick from one of the available options.
          * @example true
          */
-        allowManualInput?: boolean
+        allowManualInput: boolean
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+        /** @description Entry for textual responses to a choice prompt. */
+        textualResponseEntry: components['schemas']['Entry'] | null
+      }
+      /**
+       * @description Entry type
+       * @example choice_prompt
+       * @enum {string}
+       */
+      type: 'choice_prompt'
+    }
+    EntryDateTime: {
+      /** @description Settings of the date time entry */
+      options: {
+        /**
+         * @description Indicates the kind of input expected and the output produced. If the input was recognised, `date` outputs will be in the form of `yyyy-mm-dd`, and `time` outputs will be in the form of `hh:mm`.
+         * @example date
+         * @enum {string}
+         */
+        format: 'date' | 'time'
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example date_time
+       * @enum {string}
+       */
+      type: 'date_time'
+    }
+    EntryIntent: {
+      /** @description Settings of the intent entry */
+      options: {
+        /**
+         * @description Name of the intent to be matched
+         * @example wait
+         */
+        intentName: string
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description Model ID.
+         * @example 8f19cf20-d072-4432-a7be-70258aa40224
+         */
+        modelId: string
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example intent
+       * @enum {string}
+       */
+      type: 'intent'
+    }
+    EntryMfa: {
+      /** @description Settings of the MFA entry */
+      options: {
+        /**
+         * @description The email addresses the MFA code has been sent to.
+         * @example [
+         *   "john@acme.com",
+         *   "john@acme.co.uk"
+         * ]
+         */
+        emailAddresses: string[]
+        /**
+         * @description Timestamp (in milliseconds) when the MFA code expires.
+         * @example 1750679434372
+         */
+        expiresAt: number
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description The phone numbers the MFA code has been sent to.
+         * @example [
+         *   "+31612345678"
+         * ]
+         */
+        mobilePhoneNumbers: string[]
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example mfa
+       * @enum {string}
+       */
+      type: 'mfa'
+    }
+    EntryNumeric: {
+      /** @description Settings of the numeric entry */
+      options: {
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 7
+         */
+        limit: number | null
+        /**
+         * @description The maximum length of the processed input.
+         * @example 7
+         */
+        maxLength: number | null
+        /**
+         * @description The minimum length of the processed input.
+         * @example 1
+         */
+        minLength: number
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example numeric
+       * @enum {string}
+       */
+      type: 'numeric'
+    }
+    EntryPhoneNumber: {
+      /** @description Settings of the phone number entry */
+      options: {
+        /**
+         * @description The country code will be used if Seamly cannot determine the correct country from the input. For instance, if the `country_code` is set to `"NL"` an input of `"+4912312421421"` will still be recognised as a German phone number. However, an input of `"06123456789"` with `country_code` `"NL"` will yield the phone number `"+316123456789"`, as the country cannot be determined from the number alone.
+         * @example NL
+         */
+        countryCode: string | null
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example phone_number
+       * @enum {string}
+       */
+      type: 'phone_number'
+    }
+    EntryPostalCode: {
+      /** @description Settings of the postal code entry */
+      options: {
+        /**
+         * @description The country code (ISO 3166-1 alpha-2) of the expected postal code.
+         * @example NL
+         */
+        countryCode: string | null
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example postal_code
+       * @enum {string}
+       */
+      type: 'postal_code'
+    }
+    EntryText: {
+      /** @description Settings of the text entry */
+      options: {
         /**
          * @description A custom label to show above the input field
          * @example Your name:
@@ -426,7 +690,7 @@ export interface components {
          * @description Whether or not the expected input is language neutral. A postal code or a last name for example are independent of language.
          * @example false
          */
-        languageNeutral?: boolean
+        languageNeutral: boolean
         /**
          * @description Maximum number of characters the user may enter
          * @example 100
@@ -483,7 +747,7 @@ export interface components {
          * @description A reference to the upload as stored in the conversation context. When set, the upload can later on be used in hooks.
          * @example cv
          */
-        reference: string
+        reference: string | null
       }
       /**
        * @description Entry type
@@ -528,7 +792,6 @@ export interface components {
         | components['schemas']['MessageBodyCard']
         | components['schemas']['MessageBodyCarousel']
         | components['schemas']['MessageBodyChoicePrompt']
-        | components['schemas']['MessageBodyCTA']
         | components['schemas']['MessageBodyCustom']
         | components['schemas']['MessageBodyImage']
         | components['schemas']['MessageBodyText']
@@ -558,7 +821,6 @@ export interface components {
         | components['schemas']['MessageBodyCard']
         | components['schemas']['MessageBodyCarousel']
         | components['schemas']['MessageBodyChoicePrompt']
-        | components['schemas']['MessageBodyCTA']
         | components['schemas']['MessageBodyCustom']
         | components['schemas']['MessageBodyImage']
         | components['schemas']['MessageBodyText']
@@ -577,7 +839,6 @@ export interface components {
         | 'card'
         | 'carousel'
         | 'choice_prompt'
-        | 'cta'
         | 'custom'
         | 'image'
         | 'splash'
@@ -809,35 +1070,6 @@ export interface components {
             type: 'image'
           }
     }
-    /** @description A Call To Action (CTA) message */
-    MessageBodyCTA: {
-      /**
-       * @description URL of the CTA
-       * @example https://seamly.ai
-       */
-      buttonLink: string
-      /**
-       * @description Whether or not the link should be opened in a new window/tab
-       * @example true
-       */
-      buttonNewTab: boolean
-      /**
-       * @description Text on the CTA button
-       * @example Buy now!
-       */
-      buttonText: string
-      /**
-       * @description <p>Text shown above the CTA button<p>
-       * @example Would you like to order a pizza? Click on the button below!
-       */
-      description: string
-      /**
-       * @description Textual representation of whole CTA message. Can be used in case the CTA cannot be rendered properly.
-       * @example Text shown above the CTA button
-       * Text on the CTA button : https://seamly.ai
-       */
-      text: string
-    }
     /** @description A custom message to be used and designed for specific accounts */
     MessageBodyCustom: {
       /**
@@ -1033,7 +1265,7 @@ export interface components {
       serviceSessionId: string | null
     }
     /**
-     * @description Identifier of the transaction this message belongs to. Aids to group and link messages together. When a bot service for instance emits multiple messages at once they'll all have the same transctionId.
+     * @description Identifier of the transaction this message belongs to. Aids to group and link messages together. When a bot service for instance emits multiple messages at once they'll all have the same transactionId.
      * @example ddff6efa-619a-497d-854c-f6a111f19196
      */
     TransactionId: string | null
@@ -1057,7 +1289,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
       }
     }
     /** @description Payload */
@@ -1162,7 +1394,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
         /**
          * @description Translation file version
          * @example 1
@@ -1203,7 +1435,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
         /** @description Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
         srv_id: string
       }
@@ -1265,7 +1497,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
         /** @description Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
         srv_id: string
         /** @description Id of the conversation */
@@ -1306,7 +1538,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
         /** @description Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
         srv_id: string
         /** @description Id of the conversation */
@@ -1339,7 +1571,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
         /** @description Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
         srv_id: string
         /** @description Id of the conversation */
@@ -1406,7 +1638,7 @@ export interface operations {
         /** @description Seamly account API key */
         api_key: string
         /** @description Seamly Channel API version */
-        channel_api_version: 'v2'
+        channel_api_version: 'v3'
         /** @description Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
         srv_id: string
         /** @description Id of the conversation */

package/src/javascripts/core/api/conversation-connector.ts

@@ -1,5 +1,5 @@
-import ReconnectingWebSocket, { Event } from 'reconnecting-websocket'
 import splitUrlParams from 'lib/split-url-params'
+import ReconnectingWebSocket, { Event } from 'reconnecting-websocket'
 
 type CurrentConnectionState =
   | 'socket_closed' // Socket is closed.
@@ -27,10 +27,8 @@ const emitChange = () => {
 export default class ConversationConnector {
   #connectionListeners: ((_payload: ConnectionState) => boolean | void)[] = []
 
-  // eslint-disable-next-line no-undef
   #statusInterval: ReturnType<typeof setInterval> | null = null
 
-  // eslint-disable-next-line no-unused-vars
   #openListener: ((this: ReconnectingWebSocket, ev: Event) => void) | null =
     null
 

package/src/javascripts/core/api/errors/seamly-api-error.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line no-undef
 interface ApiErrorOptions extends ErrorOptions {
   status?: number
 }

package/src/javascripts/core/api/errors/seamly-base-error.ts

@@ -2,7 +2,7 @@ function parseOriginalErrMsg(str: string) {
   try {
     const json = JSON.parse(str)
     return json.error
-  } catch (e) {
+  } catch (_e) {
     return str
   }
 }

package/src/javascripts/core/api/index.ts

@@ -9,11 +9,6 @@ import SeamlyConfigurationError from 'api/errors/seamly-configuration-error'
 import SeamlyGeneralError from 'api/errors/seamly-general-error'
 import SeamlySessionExpiredError from 'api/errors/seamly-session-expired-error'
 import SeamlyUnauthorizedError from 'api/errors/seamly-unauthorized-error'
-import debug from 'lib/debug'
-import { objectStore } from 'lib/store/index'
-import sessionStorageProvider from 'lib/store/providers/session-storage'
-import { sourceTypes } from 'ui/utils/seamly-utils'
-import { buildPayload, fetchApi, getTimeZone } from './utils'
 import type {
   AccountConfigContext,
   ApiConfig,
@@ -22,6 +17,11 @@ import type {
   LayoutMode,
 } from 'config.types'
 import type { MessageUpload } from 'domains/store/store.types'
+import debug from 'lib/debug'
+import { objectStore } from 'lib/store/index'
+import sessionStorageProvider from 'lib/store/providers/session-storage'
+import { sourceTypes } from 'ui/utils/seamly-utils'
+import { buildPayload, fetchApi, getTimeZone } from './utils'
 
 declare let PACKAGE_NAME: string
 declare let PACKAGE_VERSION: string
@@ -114,11 +114,11 @@ export default class API {
 
     this.URLS = {
       translations: {
-        href: `/channels/api/v2/client/${this.connectionInfo.apiKey}/translations/{version}/{locale}.json`,
+        href: `/channels/api/v3/client/${this.connectionInfo.apiKey}/translations/{version}/{locale}.json`,
         templated: true,
       },
       config: {
-        href: `/channels/api/v2/client/${this.connectionInfo.apiKey}/configs`,
+        href: `/channels/api/v3/client/${this.connectionInfo.apiKey}/configs`,
         templated: true,
       },
     }

package/src/javascripts/core/api/utils.ts

@@ -18,7 +18,6 @@ export function buildPayload(command, payload) {
 
 export const fetchApi = async (
   input: string,
-  // eslint-disable-next-line no-undef
   init: RequestInit,
 ): Promise<Response> => {
   const url = new URL(input)

package/src/javascripts/core/domains/app/actions.ts

@@ -2,12 +2,12 @@ import { createAsyncThunk } from '@reduxjs/toolkit'
 import { ChannelConversation } from 'api/api.types'
 import SeamlySessionExpiredError from 'api/errors/seamly-session-expired-error'
 import SeamlyUnavailableError from 'api/errors/seamly-unavailable-error'
+import type { Config } from 'config.types'
 import { initializeConfig, resetConfig } from 'domains/config/actions'
 import createDebouncedAsyncThunk from 'domains/redux/create-debounced-async-thunk'
 import { ThunkAPI } from 'domains/redux/redux.types'
 import { initializeVisibility } from 'domains/visibility/actions'
 import { actionTypes } from 'ui/utils/seamly-utils'
-import type { Config } from 'config.types'
 
 export const initializeApp = createAsyncThunk<
   {

package/src/javascripts/core/domains/app/hooks.ts

@@ -1,4 +1,4 @@
-import { useSelector } from 'react-redux'
 import { selectUserHasResponded } from 'domains/app/selectors'
+import { useSelector } from 'react-redux'
 
 export const useUserHasResponded = () => useSelector(selectUserHasResponded)

package/src/javascripts/core/domains/config/hooks.ts

@@ -1,5 +1,5 @@
-import { useSelector } from 'react-redux'
 import { selectConfig } from 'domains/config/selectors'
+import { useSelector } from 'react-redux'
 
 export const useConfig = () => useSelector(selectConfig)
 

package/src/javascripts/core/domains/config/selectors.ts

@@ -1,7 +1,7 @@
 import { createSelector } from '@reduxjs/toolkit'
-import { visibilityStates } from 'domains/visibility/constants'
 import type { VisibilityOptions } from 'config.types'
 import type { RootState } from 'domains/store'
+import { visibilityStates } from 'domains/visibility/constants'
 
 export const selectConfig = createSelector(
   ({ config }: RootState) => config,

package/src/javascripts/core/domains/config/slice.ts

@@ -1,9 +1,9 @@
 import { PayloadAction, createSlice } from '@reduxjs/toolkit'
 import { defaultConfig } from 'config'
-import { initializeConfig, resetConfig } from 'domains/config/actions'
-import { pick } from 'ui/utils/general-utils'
 import type { Config } from 'config.types'
+import { initializeConfig, resetConfig } from 'domains/config/actions'
 import type { ChannelEvent } from 'domains/store/store.types'
+import { pick } from 'ui/utils/general-utils'
 
 export const initialConfigState: Config = {
   ...defaultConfig,