@nlxai/touchpoint-ui 1.2.4-alpha.1 → 1.2.4-alpha.5

package/docs/interfaces/Theme.md

@@ -1,303 +0,0 @@
-# Interface: Theme
-
-The full theme expressed as CSS custom properties
-
-## Properties
-
-### fontFamily
-
-• **fontFamily**: `string`
-
-Font family
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:71](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L71)
-
-___
-
-### primary80
-
-• **primary80**: `string`
-
-Primary color with 80% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:76](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L76)
-
-___
-
-### primary60
-
-• **primary60**: `string`
-
-Primary color with 60% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:80](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L80)
-
-___
-
-### primary40
-
-• **primary40**: `string`
-
-Primary color with 40% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:84](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L84)
-
-___
-
-### primary20
-
-• **primary20**: `string`
-
-Primary color with 20% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:88](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L88)
-
-___
-
-### primary10
-
-• **primary10**: `string`
-
-Primary color with 10% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:92](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L92)
-
-___
-
-### primary5
-
-• **primary5**: `string`
-
-Primary color with 5% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:96](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L96)
-
-___
-
-### primary1
-
-• **primary1**: `string`
-
-Primary color with 1% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:100](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L100)
-
-___
-
-### secondary80
-
-• **secondary80**: `string`
-
-Secondary color with 80% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:105](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L105)
-
-___
-
-### secondary60
-
-• **secondary60**: `string`
-
-Secondary color with 60% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:109](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L109)
-
-___
-
-### secondary40
-
-• **secondary40**: `string`
-
-Secondary color with 40% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:113](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L113)
-
-___
-
-### secondary20
-
-• **secondary20**: `string`
-
-Secondary color with 20% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:117](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L117)
-
-___
-
-### secondary10
-
-• **secondary10**: `string`
-
-Secondary color with 10% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:121](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L121)
-
-___
-
-### secondary5
-
-• **secondary5**: `string`
-
-Secondary color with 5% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:125](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L125)
-
-___
-
-### secondary1
-
-• **secondary1**: `string`
-
-Secondary color with 1% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:129](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L129)
-
-___
-
-### accent
-
-• **accent**: `string`
-
-Accent color used e.g. for prominent buttons, the loader animation as well as selected card outlines
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:134](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L134)
-
-___
-
-### accent20
-
-• **accent20**: `string`
-
-Accent color with 20% opacity
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:138](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L138)
-
-___
-
-### background
-
-• **background**: `string`
-
-The background color of the main Touchpoint interface
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:142](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L142)
-
-___
-
-### overlay
-
-• **overlay**: `string`
-
-The color of the overlay covering the visible portion of the website when the Touchpoint interface does not cover the full screen
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:146](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L146)
-
-___
-
-### warningPrimary
-
-• **warningPrimary**: `string`
-
-Primary warning color
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:151](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L151)
-
-___
-
-### warningSecondary
-
-• **warningSecondary**: `string`
-
-Secondary warning color
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:155](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L155)
-
-___
-
-### errorPrimary
-
-• **errorPrimary**: `string`
-
-Primary error color
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:159](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L159)
-
-___
-
-### errorSecondary
-
-• **errorSecondary**: `string`
-
-Secondary error color
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:163](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L163)
-
-___
-
-### innerBorderRadius
-
-• **innerBorderRadius**: `string`
-
-Inner border radius: used for most buttons
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:168](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L168)
-
-___
-
-### outerBorderRadius
-
-• **outerBorderRadius**: `string`
-
-Outer border radius: generally used for elements that contain buttons that have inner border radius. Also used by the launch button.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:172](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L172)

package/docs/interfaces/TouchpointConfiguration.md

@@ -1,209 +0,0 @@
-# Interface: TouchpointConfiguration
-
-Main Touchpoint creation properties object
-
-## Properties
-
-### config
-
-• **config**: `Config`
-
-Connection information for the @nlxai/core conversation handler
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:365](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L365)
-
-___
-
-### windowSize
-
-• `Optional` **windowSize**: [`WindowSize`](../README.md#windowsize)
-
-Optional window size for the chat window, defaults to `half`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:369](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L369)
-
-___
-
-### colorMode
-
-• `Optional` **colorMode**: [`ColorMode`](../README.md#colormode)
-
-Optional color mode for the chat window, defaults to `dark`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:373](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L373)
-
-___
-
-### brandIcon
-
-• `Optional` **brandIcon**: `string`
-
-URL of icon used to display the brand in the chat header
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:377](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L377)
-
-___
-
-### animate
-
-• `Optional` **animate**: `boolean`
-
-Include border animation. Currently only supported in Voice Mini.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:381](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L381)
-
-___
-
-### launchIcon
-
-• `Optional` **launchIcon**: `string` \| `boolean` \| [`CustomLaunchButton`](../README.md#customlaunchbutton)
-
-URL of icon used on the launch icon in the bottom right when the experience is collapsed.
-
-When set to `false`, no launch button is shown at all. When not set or set to `true`, the default launch icon is rendered.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:387](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L387)
-
-___
-
-### userMessageBubble
-
-• `Optional` **userMessageBubble**: `boolean`
-
-Specifies whether the user message has bubbles or not
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:391](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L391)
-
-___
-
-### agentMessageBubble
-
-• `Optional` **agentMessageBubble**: `boolean`
-
-Specifies whether the agent message has bubbles or not
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:395](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L395)
-
-___
-
-### chatMode
-
-• `Optional` **chatMode**: `boolean`
-
-Enables chat mode, a classic chat experience with inline loaders and the chat history visible at all times.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:399](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L399)
-
-___
-
-### theme
-
-• `Optional` **theme**: `Partial`\<[`Theme`](Theme.md)\>
-
-Optional theme object to override default theme values
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:403](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L403)
-
-___
-
-### modalityComponents
-
-• `Optional` **modalityComponents**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`unknown`\>\>
-
-Optional custom modality components to render in Touchpoint
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:407](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L407)
-
-___
-
-### customModalities
-
-• `Optional` **customModalities**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`unknown`\>\>
-
-Optional custom modality components to render in Touchpoint
-
-**`Deprecated`**
-
-use [TouchpointConfiguration.modalityComponents](TouchpointConfiguration.md#modalitycomponents) instead.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:412](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L412)
-
-___
-
-### initializeConversation
-
-• `Optional` **initializeConversation**: [`InitializeConversation`](../README.md#initializeconversation)
-
-Custom conversation init method. Defaults to sending the welcome intent
-
-**`Param`**
-
-the conversation handler.
-
-**`Param`**
-
-the context object
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:418](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L418)
-
-___
-
-### input
-
-• `Optional` **input**: [`Input`](../README.md#input)
-
-Controls the ways in which  the user can communicate with the application. Defaults to `"text"`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:422](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L422)
-
-___
-
-### initialContext
-
-• `Optional` **initialContext**: `Context`
-
-Context sent with the initial request.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:426](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L426)
-
-___
-
-### bidirectional
-
-• `Optional` **bidirectional**: [`BidirectionalConfig`](../README.md#bidirectionalconfig)
-
-Enables bidirectional mode of voice+. Will automatically set the bidirectional flag in the config.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:432](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L432)

package/docs/interfaces/TouchpointInstance.md

@@ -1,121 +0,0 @@
-# Interface: TouchpointInstance
-
-Instance of a Touchpoint UI component
-
-## Properties
-
-### expanded
-
-• **expanded**: `boolean`
-
-Controls whether the Touchpoint UI is expanded or collapsed
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:476](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L476)
-
-___
-
-### conversationHandler
-
-• **conversationHandler**: `ConversationHandler`
-
-The conversation handler instance for interacting with the application
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:480](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L480)
-
-___
-
-### teardown
-
-• **teardown**: () => `void`
-
-Method to remove the Touchpoint UI from the DOM
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:484](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L484)
-
-___
-
-### setCustomBidirectionalCommands
-
-• **setCustomBidirectionalCommands**: (`commands`: [`BidirectionalCustomCommand`](BidirectionalCustomCommand.md)[]) => `void`
-
-Sets currently available custom bidirectional commands.
-This allows you to define custom commands that can be used in the voice bot.
-The commands will be available in the voice bot and can be used to trigger actions.
-
-Example:
-```javascript
-client.setCustomBidirectionalCommands([
-    {
-      action: "Meal",
-      description: "add a meal to your flight",
-      schema: {
-        enum: ["standard", "vegetarian", "vegan", "gluten-free"],
-      },
-      handler: (value) => {
-        console.log("Meal option:", value);
-      },
-    },
-  ]);
-```
-
-This will allow the voice bot to use the command `Meal` with the value `standard`, `vegetarian`, `vegan`, or `gluten-free`.
-
-When using more complex arguments, a library such as [Zod](https://zod.dev) can be useful:
-
-```javascript
-import * as z from "zod/v4";
-
-const schema = z.object({
-  "name": z.string().describe("The customer's name, such as John Doe"),
-  "email": z.string().email().describe("The customer's email address"),
-});
-
-client.setCustomBidirectionalCommands([
-    {
-      action: "Meal",
-      description: "add a meal to your flight",
-      schema: z.toJSONSchema(schema, {io: "input"}),
-      handler: (value) => {
-        const result = z.safeParse(schema, value);
-        if (result.success) {
-          // result.data is now type safe and TypeScript can reason about it
-          console.log("Meal option:", result.data);
-        } else {
-          console.error("Failed to parse Meal option:", result.error);
-        }
-      },
-    },
-  ]);
-```
-
-#### Type declaration
-
-▸ (`commands`): `void`
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `commands` | [`BidirectionalCustomCommand`](BidirectionalCustomCommand.md)[] | A list containing the custom commands to set. |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/interface.ts:538](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L538)