@nlxai/touchpoint-ui 1.2.1 → 1.2.2-alpha.0

package/README.md

@@ -26,3 +26,9 @@ const touchpoint = await create({
 
 `npm install`
 `npm run dev`
+
+## Styling
+
+Touchpoint UI is styled with [Tailwind](https://tailwindcss.com), with the compiled CSS injected inside the custom element's shadow root.
+
+> Since the @property rule doesn't work properly inside the shadow root, translation-related classes must specify both x and y coordinates, for example `transform translate-x-full translate-y-0` (where normally the last class name is not necessary).

package/docs/README.md

@@ -6,17 +6,36 @@
 
 ## Interfaces
 
+- [InteractiveElementInfo](interfaces/InteractiveElementInfo.md)
+- [PageForms](interfaces/PageForms.md)
 - [CustomCardProps](interfaces/CustomCardProps.md)
 - [CustomCardRowProps](interfaces/CustomCardRowProps.md)
 - [DateInputProps](interfaces/DateInputProps.md)
 - [IconButtonProps](interfaces/IconButtonProps.md)
 - [TextButtonProps](interfaces/TextButtonProps.md)
-- [TouchpointInstance](interfaces/TouchpointInstance.md)
+- [ChoiceMessage](interfaces/ChoiceMessage.md)
 - [Theme](interfaces/Theme.md)
+- [InputField](interfaces/InputField.md)
+- [PageState](interfaces/PageState.md)
+- [BidirectionalContext](interfaces/BidirectionalContext.md)
 - [TouchpointConfiguration](interfaces/TouchpointConfiguration.md)
+- [BidirectionalCustomCommand](interfaces/BidirectionalCustomCommand.md)
+- [TouchpointInstance](interfaces/TouchpointInstance.md)
 
 ## Type Aliases
 
+### AccessibilityInformation
+
+Ƭ **AccessibilityInformation**: `Record`\<`string`, `any`\>
+
+Accessibility information
+
+#### Defined in
+
+[packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:9](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L9)
+
+___
+
 ### IconButtonType
 
 Ƭ **IconButtonType**: ``"main"`` \| ``"ghost"`` \| ``"activated"`` \| ``"coverup"`` \| ``"error"`` \| ``"overlay"``
@@ -31,7 +50,7 @@ Represents the different types of icon buttons available in the application.
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:16](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L16)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:16](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L16)
 
 ___
 
@@ -43,7 +62,7 @@ Window size configuration
 
 #### Defined in
 
-[packages/touchpoint-ui/src/types.ts:7](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L7)
+[packages/touchpoint-ui/src/interface.ts:13](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L13)
 
 ___
 
@@ -55,13 +74,13 @@ Color mode configuration (light/dark modes)
 
 #### Defined in
 
-[packages/touchpoint-ui/src/types.ts:12](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L12)
+[packages/touchpoint-ui/src/interface.ts:18](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L18)
 
 ___
 
 ### CustomModalityComponent
 
-Ƭ **CustomModalityComponent**\<`Data`\>: `FC`\<\{ `data`: `Data` ; `conversationHandler`: `ConversationHandler` ; `enabled`: `boolean`  }\>
+Ƭ **CustomModalityComponent**\<`Data`\>: `ComponentType`\<\{ `data`: `Data` ; `conversationHandler`: `ConversationHandler` ; `enabled`: `boolean` ; `className?`: `string`  }\>
 
 Custom Modalities allow rendering of rich components from nodes.
 See: https://docs.studio.nlx.ai/build/resources/modalities
@@ -74,25 +93,26 @@ See: https://docs.studio.nlx.ai/build/resources/modalities
 
 #### Defined in
 
-[packages/touchpoint-ui/src/types.ts:36](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L36)
+[packages/touchpoint-ui/src/interface.ts:42](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L42)
 
 ___
 
 ### InitializeConversation
 
-Ƭ **InitializeConversation**: (`handler`: `ConversationHandler`) => `void`
+Ƭ **InitializeConversation**: (`handler`: `ConversationHandler`, `context?`: `Context`) => `void`
 
 Custom conversation init method. Defaults to sending the welcome intent
 
 #### Type declaration
 
-▸ (`handler`): `void`
+▸ (`handler`, `context?`): `void`
 
 ##### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `handler` | `ConversationHandler` | the conversation handler. |
+| `context?` | `Context` | context set via TouchpointConfiguration.initialContext |
 
 ##### Returns
 
@@ -100,10 +120,99 @@ Custom conversation init method. Defaults to sending the welcome intent
 
 #### Defined in
 
-[packages/touchpoint-ui/src/types.ts:169](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/types.ts#L169)
+[packages/touchpoint-ui/src/interface.ts:180](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L180)
+
+___
+
+### CustomLaunchButton
+
+Ƭ **CustomLaunchButton**: `ComponentType`\<\{ `className?`: `string` ; `onClick?`: () => `void`  }\>
+
+Fully custom launch icon
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:188](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L188)
+
+___
+
+### Input
+
+Ƭ **Input**: ``"text"`` \| ``"voice"`` \| ``"voiceMini"``
+
+Input type for the experience
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:202](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L202)
+
+___
+
+### BidirectionalConfig
+
+Ƭ **BidirectionalConfig**: \{ `automaticContext?`: ``true`` ; `navigation?`: (`action`: ``"page_next"`` \| ``"page_previous"`` \| ``"page_custom"`` \| ``"page_unknown"``, `destination`: `string` \| `undefined`, `destinations`: `Record`\<`string`, `string`\>) => `void` ; `input?`: (`fields`: [`InputField`](interfaces/InputField.md)[], `pageFields`: `Record`\<`string`, `Element`\>) => `void` ; `custom?`: (`action`: `string`, `payload`: `unknown`) => `void` ; `customizeAutomaticContext?`: (`arg`: \{ `context`: [`BidirectionalContext`](interfaces/BidirectionalContext.md) ; `state`: [`PageState`](interfaces/PageState.md)  }) => \{ `context`: [`BidirectionalContext`](interfaces/BidirectionalContext.md) ; `state`: [`PageState`](interfaces/PageState.md)  }  } \| \{ `automaticContext`: ``false`` ; `navigation?`: (`action`: ``"page_next"`` \| ``"page_previous"`` \| ``"page_custom"`` \| ``"page_unknown"``, `destination?`: `string`) => `void` ; `input?`: (`fields`: [`InputField`](interfaces/InputField.md)[]) => `void` ; `custom?`: (`action`: `string`, `payload`: `unknown`) => `void`  }
+
+Configuration for bidirectional mode of voice+.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:256](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L256)
+
+## Variables
+
+### version
+
+• `Const` **version**: `string` = `packageJson.version`
+
+Package version
+
+#### Defined in
+
+[packages/touchpoint-ui/src/index.tsx:52](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/index.tsx#L52)
 
 ## Functions
 
+### analyzePageForms
+
+▸ **analyzePageForms**(): [`PageForms`](interfaces/PageForms.md)
+
+Analyze page forms
+
+#### Returns
+
+[`PageForms`](interfaces/PageForms.md)
+
+pageForms
+
+#### Defined in
+
+[packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:89](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L89)
+
+___
+
+### Ripple
+
+▸ **Ripple**(`props`, `deprecatedLegacyContext?`): `ReactNode`
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `props` | `Object` | - |
+| `props.className?` | `string` | - |
+| `props.style?` | `CSSProperties` | - |
+| `deprecatedLegacyContext?` | `any` | **`Deprecated`** **`See`** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) |
+
+#### Returns
+
+`ReactNode`
+
+#### Defined in
+
+[packages/touchpoint-ui/src/components/Ripple.tsx:24](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/Ripple.tsx#L24)
+
+___
+
 ### Carousel
 
 ▸ **Carousel**(`props`, `deprecatedLegacyContext?`): `ReactNode`
@@ -113,7 +222,8 @@ Custom conversation init method. Defaults to sending the welcome intent
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `props` | `Object` | - |
-| `props.children` | `ReactNode` | - |
+| `props.className?` | `string` | - |
+| `props.children?` | `ReactNode` | - |
 | `deprecatedLegacyContext?` | `any` | **`Deprecated`** **`See`** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) |
 
 #### Returns
@@ -122,7 +232,7 @@ Custom conversation init method. Defaults to sending the welcome intent
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/Carousel.tsx:5](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/Carousel.tsx#L5)
+[packages/touchpoint-ui/src/components/ui/Carousel.tsx:17](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Carousel.tsx#L17)
 
 ___
 
@@ -143,7 +253,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:25](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L25)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:38](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L38)
 
 ___
 
@@ -166,7 +276,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:44](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L44)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:96](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L96)
 
 ___
 
@@ -187,7 +297,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:69](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L69)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:121](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L121)
 
 ___
 
@@ -208,7 +318,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/DateInput.tsx:25](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L25)
+[packages/touchpoint-ui/src/components/ui/DateInput.tsx:29](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L29)
 
 ___
 
@@ -229,7 +339,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:67](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L67)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:94](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L94)
 
 ___
 
@@ -250,7 +360,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/TextButton.tsx:33](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L33)
+[packages/touchpoint-ui/src/components/ui/TextButton.tsx:33](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L33)
 
 ___
 
@@ -265,6 +375,7 @@ ___
 | `props` | `Object` | - |
 | `props.children` | `ReactNode` | - |
 | `props.faded?` | `boolean` | - |
+| `props.className?` | `string` | - |
 | `deprecatedLegacyContext?` | `any` | **`Deprecated`** **`See`** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) |
 
 #### Returns
@@ -273,7 +384,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/Typography.tsx:5](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/Typography.tsx#L5)
+[packages/touchpoint-ui/src/components/ui/Typography.tsx:5](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Typography.tsx#L5)
 
 ___
 
@@ -287,6 +398,7 @@ ___
 | :------ | :------ | :------ |
 | `props` | `Object` | - |
 | `props.children` | `ReactNode` | - |
+| `props.className?` | `string` | - |
 | `deprecatedLegacyContext?` | `any` | **`Deprecated`** **`See`** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) |
 
 #### Returns
@@ -295,7 +407,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/Typography.tsx:16](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/Typography.tsx#L16)
+[packages/touchpoint-ui/src/components/ui/Typography.tsx:21](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Typography.tsx#L21)
 
 ___
 
@@ -316,7 +428,7 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/index.tsx:33](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/index.tsx#L33)
+[packages/touchpoint-ui/src/index.tsx:61](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/index.tsx#L61)
 
 ___
 
@@ -340,7 +452,7 @@ A promise that resolves to a TouchpointInstance
 
 #### Defined in
 
-[packages/touchpoint-ui/src/index.tsx:202](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/index.tsx#L202)
+[packages/touchpoint-ui/src/index.tsx:342](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/index.tsx#L342)
 
 ___
 
@@ -364,4 +476,4 @@ ___
 
 #### Defined in
 
-[packages/touchpoint-ui/src/preview.tsx:10](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/preview.tsx#L10)
+[packages/touchpoint-ui/src/preview.tsx:10](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/preview.tsx#L10)

package/docs/interfaces/BidirectionalContext.md

@@ -0,0 +1,51 @@
+# Interface: BidirectionalContext
+
+Bidirectional context information that is sent to the LLM.
+
+## Properties
+
+### uri
+
+• `Optional` **uri**: `string`
+
+Identifier for which page you are currently on. This can be used to filter the relevant KB pages.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:235](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L235)
+
+___
+
+### fields
+
+• `Optional` **fields**: [`InteractiveElementInfo`](InteractiveElementInfo.md)[]
+
+The active form fields that can be filled in.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:237](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L237)
+
+___
+
+### destinations
+
+• `Optional` **destinations**: `string`[]
+
+Human readable location names that can be navigated to.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:239](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L239)
+
+___
+
+### actions
+
+• `Optional` **actions**: \{ `action`: `string` ; `description?`: `string` ; `schema?`: `any`  }[]
+
+Custom actions that can be performed.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:243](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L243)

package/docs/interfaces/BidirectionalCustomCommand.md

@@ -0,0 +1,79 @@
+# Interface: BidirectionalCustomCommand
+
+During a Voice+ bidirectional conversation, you can indicate to the application the availability of
+custom commands that the user can invoke.
+
+**`Type Param`**
+
+Commands can take a single parameter which will be generated from this schema.
+
+## Properties
+
+### action
+
+• **action**: `string`
+
+The name of the command, used to invoke it. Should be unique and descriptive in the context of the LLM.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:444](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L444)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+A short description of the command, used to help the LLM understand its purpose.
+
+If omitted, then the command will not be sent to the application and must be triggered
+from the application side.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:451](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L451)
+
+___
+
+### schema
+
+• `Optional` **schema**: `any`
+
+A JSON Schema that defines the structure of the command's input.
+
+Use descriptive names and `description` fields to give the underlying LLM plenty of context for
+it to generate reasonable parameters. Note that the LLM output will be validated (and transformed)
+with this schema, so you are guaranteed type safe inputs to your handler.
+
+Should follow the JSONSchema specification.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:462](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L462)
+
+___
+
+### handler
+
+• **handler**: (`value`: `any`) => `void`
+
+A handler that will be called with an argument matching the schema when the command is invoked.
+
+#### Type declaration
+
+▸ (`value`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `any` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:466](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L466)

package/docs/interfaces/ChoiceMessage.md

@@ -0,0 +1,39 @@
+# Interface: ChoiceMessage
+
+Choice message with metadata
+
+## Properties
+
+### message
+
+• **message**: `ApplicationMessage`
+
+Message contents
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:27](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L27)
+
+___
+
+### responseIndex
+
+• **responseIndex**: `number`
+
+Index in the response transcript history
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:31](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L31)
+
+___
+
+### messageIndex
+
+• **messageIndex**: `number`
+
+Message index in the current response
+
+#### Defined in
+
+[packages/touchpoint-ui/src/interface.ts:35](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L35)

package/docs/interfaces/CustomCardProps.md

@@ -4,6 +4,18 @@ Props for the CustomCard component
 
 ## Properties
 
+### className
+
+• `Optional` **className**: `string`
+
+Class name
+
+#### Defined in
+
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:15](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L15)
+
+___
+
 ### children
 
 • **children**: `ReactNode`
@@ -12,7 +24,7 @@ Content to be rendered inside the card.
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:14](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L14)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:19](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L19)
 
 ___
 
@@ -24,7 +36,7 @@ Whether the card is in a selected state. Used to highlight the card.
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:18](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L18)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:23](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L23)
 
 ___
 
@@ -44,4 +56,28 @@ Handler function for when the card is clicked
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:22](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L22)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:27](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L27)
+
+___
+
+### href
+
+• `Optional` **href**: `string`
+
+Transform the card into an anchor tag with the href specified
+
+#### Defined in
+
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:31](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L31)
+
+___
+
+### newTab
+
+• `Optional` **newTab**: `boolean`
+
+Specify whether the URL should take the user to a new tab
+
+#### Defined in
+
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:35](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L35)

package/docs/interfaces/CustomCardRowProps.md

@@ -12,7 +12,7 @@ Content to be displayed on the left side of the row
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:58](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L58)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:110](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L110)
 
 ___
 
@@ -24,7 +24,7 @@ Content to be displayed on the right side of the row
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:62](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L62)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:114](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L114)
 
 ___
 
@@ -36,4 +36,4 @@ Optional icon to be displayed in the center of the row
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:66](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L66)
+[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:118](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L118)

package/docs/interfaces/DateInputProps.md

@@ -26,4 +26,16 @@ Handler function called when the date is submitted
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/DateInput.tsx:16](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L16)
+[packages/touchpoint-ui/src/components/ui/DateInput.tsx:16](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L16)
+
+___
+
+### className
+
+• `Optional` **className**: `string`
+
+Class name
+
+#### Defined in
+
+[packages/touchpoint-ui/src/components/ui/DateInput.tsx:20](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L20)

package/docs/interfaces/IconButtonProps.md

@@ -20,7 +20,7 @@ Handler function called when the button is clicked
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:31](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L31)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:31](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L31)
 
 ___
 
@@ -32,7 +32,7 @@ Accessible label for the button
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:35](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L35)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:35](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L35)
 
 ___
 
@@ -44,7 +44,7 @@ Additional CSS classes to apply to the button
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:39](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L39)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:39](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L39)
 
 ___
 
@@ -56,7 +56,7 @@ Visual style variant of the button. One of IconButtonType.
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:43](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L43)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:43](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L43)
 
 ___
 
@@ -68,4 +68,4 @@ Icon component to display inside the button
 
 #### Defined in
 
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:47](https://github.com/nlxai/sdk/blob/4ed1b691443f6f0d50583f93b653454e560516a7/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L47)
+[packages/touchpoint-ui/src/components/ui/IconButton.tsx:47](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L47)