@nlxai/touchpoint-ui 1.0.5-alpha.5 → 1.0.5-alpha.7

package/docs/interfaces/Theme.md

@@ -0,0 +1,303 @@
+# Interface: Theme
+
+The full theme expressed as CSS custom properties
+
+## Properties
+
+### fontFamily
+
+• **fontFamily**: `string`
+
+Font family
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:61](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L61)
+
+___
+
+### primary80
+
+• **primary80**: `string`
+
+Primary color with 80% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:66](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L66)
+
+___
+
+### primary60
+
+• **primary60**: `string`
+
+Primary color with 60% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:70](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L70)
+
+___
+
+### primary40
+
+• **primary40**: `string`
+
+Primary color with 40% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:74](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L74)
+
+___
+
+### primary20
+
+• **primary20**: `string`
+
+Primary color with 20% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:78](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L78)
+
+___
+
+### primary10
+
+• **primary10**: `string`
+
+Primary color with 10% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:82](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L82)
+
+___
+
+### primary5
+
+• **primary5**: `string`
+
+Primary color with 5% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:86](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L86)
+
+___
+
+### primary1
+
+• **primary1**: `string`
+
+Primary color with 1% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:90](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L90)
+
+___
+
+### secondary80
+
+• **secondary80**: `string`
+
+Secondary color with 80% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:95](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L95)
+
+___
+
+### secondary60
+
+• **secondary60**: `string`
+
+Secondary color with 60% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:99](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L99)
+
+___
+
+### secondary40
+
+• **secondary40**: `string`
+
+Secondary color with 40% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:103](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L103)
+
+___
+
+### secondary20
+
+• **secondary20**: `string`
+
+Secondary color with 20% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:107](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L107)
+
+___
+
+### secondary10
+
+• **secondary10**: `string`
+
+Secondary color with 10% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:111](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L111)
+
+___
+
+### secondary5
+
+• **secondary5**: `string`
+
+Secondary color with 5% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:115](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L115)
+
+___
+
+### secondary1
+
+• **secondary1**: `string`
+
+Secondary color with 1% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:119](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L119)
+
+___
+
+### 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/types.ts:124](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L124)
+
+___
+
+### accent20
+
+• **accent20**: `string`
+
+Accent color with 20% opacity
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:128](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L128)
+
+___
+
+### background
+
+• **background**: `string`
+
+The background color of the main Touchpoint interface
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:132](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L132)
+
+___
+
+### 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/types.ts:136](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L136)
+
+___
+
+### warningPrimary
+
+• **warningPrimary**: `string`
+
+Primary warning color
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:141](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L141)
+
+___
+
+### warningSecondary
+
+• **warningSecondary**: `string`
+
+Secondary warning color
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:145](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L145)
+
+___
+
+### errorPrimary
+
+• **errorPrimary**: `string`
+
+Primary error color
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:149](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L149)
+
+___
+
+### errorSecondary
+
+• **errorSecondary**: `string`
+
+Secondary error color
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:153](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L153)
+
+___
+
+### innerBorderRadius
+
+• **innerBorderRadius**: `string`
+
+Inner border radius: used for most buttons
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:158](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L158)
+
+___
+
+### 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/types.ts:162](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L162)

package/docs/interfaces/TouchpointConfiguration.md

@@ -0,0 +1,141 @@
+# Interface: TouchpointConfiguration
+
+Main Touchpoint creation properties object
+
+## Properties
+
+### config
+
+• **config**: `Config`
+
+Connection information for the @nlxai/chat-core conversation handler
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:178](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L178)
+
+___
+
+### windowSize
+
+• `Optional` **windowSize**: [`WindowSize`](../README.md#windowsize)
+
+Optional window size for the chat window, defaults to `half`
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:182](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L182)
+
+___
+
+### colorMode
+
+• `Optional` **colorMode**: [`ColorMode`](../README.md#colormode)
+
+Optional color mode for the chat window, defaults to `dark`
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:186](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L186)
+
+___
+
+### brandIcon
+
+• `Optional` **brandIcon**: `string`
+
+URL of icon used to display the brand in the chat header
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:190](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L190)
+
+___
+
+### launchIcon
+
+• `Optional` **launchIcon**: `string` \| `boolean`
+
+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/types.ts:196](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L196)
+
+___
+
+### userMessageBubble
+
+• `Optional` **userMessageBubble**: `boolean`
+
+Specifies whether the user message has bubbles or not
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:200](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L200)
+
+___
+
+### agentMessageBubble
+
+• `Optional` **agentMessageBubble**: `boolean`
+
+Specifies whether the agent message has bubbles or not
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:204](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L204)
+
+___
+
+### theme
+
+• `Optional` **theme**: `Partial`\<[`Theme`](Theme.md)\>
+
+Optional theme object to override default theme values
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:208](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L208)
+
+___
+
+### customModalities
+
+• `Optional` **customModalities**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`any`\>\>
+
+Optional custom modality components to render in Touchpoint
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:212](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L212)
+
+___
+
+### initializeConversation
+
+• `Optional` **initializeConversation**: [`InitializeConversation`](../README.md#initializeconversation)
+
+Custom conversation init method. Defaults to sending the welcome intent
+
+**`Param`**
+
+the conversation handler.
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:217](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L217)
+
+___
+
+### input
+
+• `Optional` **input**: ``"text"`` \| ``"voice"``
+
+Controls the ways in which the user can communicate with the application. Defaults to `"text"`
+
+#### Defined in
+
+[packages/touchpoint-ui/src/types.ts:221](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/types.ts#L221)

package/docs/interfaces/TouchpointInstance.md

@@ -0,0 +1,47 @@
+# 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/index.tsx:186](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/index.tsx#L186)
+
+___
+
+### conversationHandler
+
+• **conversationHandler**: `ConversationHandler`
+
+The conversation handler instance for interacting with the application
+
+#### Defined in
+
+[packages/touchpoint-ui/src/index.tsx:190](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/index.tsx#L190)
+
+___
+
+### teardown
+
+• **teardown**: () => `void`
+
+Method to remove the Touchpoint UI from the DOM
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/touchpoint-ui/src/index.tsx:194](https://github.com/nlxai/sdk/blob/2c1daa9b06c19ec11d0568f15cba44c1e623e265/packages/touchpoint-ui/src/index.tsx#L194)