@nlxai/touchpoint-ui 1.0.5-alpha.2 → 1.0.5-alpha.4

package/lib/types.d.ts

@@ -197,5 +197,5 @@ export interface TouchpointConfiguration {
     /**
      * Controls the ways in which the user can communicate with the application. Defaults to `"text"`
      */
-    input?: "text" | "textAndVoice";
+    input?: "text" | "voice" | "textAndVoice";
 }

package/lib/voice.d.ts

@@ -3,6 +3,7 @@ type VoiceRoomState = "inactive" | "pending" | "active" | "error";
 interface VoiceHookReturn {
     roomState: VoiceRoomState;
     isUserSpeaking: boolean;
+    isApplicationSpeaking: boolean;
 }
 export declare const useVoice: ({ active, handler, }: {
     active: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.0.5-alpha.2",
+  "version": "1.0.5-alpha.4",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -24,7 +24,7 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@nlxai/chat-core": "^1.0.5-alpha.2",
+    "@nlxai/chat-core": "^1.0.5-alpha.4",
     "@react-hookz/web": "^25.0.1",
     "@react-input/mask": "^2.0.4",
     "clsx": "^2.1.1",
@@ -57,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "af2fea91300ecfab6c3ca8832dc3b13971ba5f46"
+  "gitHead": "4cc1ed43fde42daf06e14e0fc5dd4c386bc5f354"
 }

package/docs/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/README.md

@@ -1,341 +0,0 @@
-# @nlxai/touchpoint-ui
-
-## Namespaces
-
-- [Icons](modules/Icons.md)
-
-## Interfaces
-
-- [CustomCardProps](interfaces/CustomCardProps.md)
-- [CustomCardRowProps](interfaces/CustomCardRowProps.md)
-- [DateInputProps](interfaces/DateInputProps.md)
-- [IconButtonProps](interfaces/IconButtonProps.md)
-- [TextButtonProps](interfaces/TextButtonProps.md)
-- [TouchpointInstance](interfaces/TouchpointInstance.md)
-- [Theme](interfaces/Theme.md)
-- [TouchpointConfiguration](interfaces/TouchpointConfiguration.md)
-
-## Type Aliases
-
-### IconButtonType
-
-Ƭ **IconButtonType**: ``"main"`` \| ``"ghost"`` \| ``"activated"`` \| ``"coverup"`` \| ``"overlay"``
-
-Represents the different types of icon buttons available in the application.
-
-- `main`: The primary icon button.
-- `ghost`: A transparent or less prominent icon button.
-- `activated`: An icon button that indicates an active state.
-- `coverup`: An icon button used to cover up or mask something.
-- `overlay`: An icon button that appears over other content.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:16](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L16)
-
-___
-
-### WindowSize
-
-Ƭ **WindowSize**: ``"half"`` \| ``"full"``
-
-Window size configuration
-
-#### Defined in
-
-[packages/touchpoint-ui/src/types.ts:7](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L7)
-
-___
-
-### ColorMode
-
-Ƭ **ColorMode**: ``"light"`` \| ``"dark"``
-
-Color mode configuration (light/dark modes)
-
-#### Defined in
-
-[packages/touchpoint-ui/src/types.ts:12](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L12)
-
-___
-
-### CustomModalityComponent
-
-Ƭ **CustomModalityComponent**\<`Data`\>: `FC`\<\{ `data`: `Data` ; `conversationHandler`: `ConversationHandler` ; `enabled`: `boolean`  }\>
-
-Custom Modalities allow rendering of rich components from nodes.
-See: https://docs.studio.nlx.ai/build/resources/modalities
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `Data` |
-
-#### Defined in
-
-[packages/touchpoint-ui/src/types.ts:36](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L36)
-
-## Functions
-
-### Carousel
-
-▸ **Carousel**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | `Object` | - |
-| `props.children` | `ReactNode` | - |
-| `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/ui/Carousel.tsx:5](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/Carousel.tsx#L5)
-
-___
-
-### CustomCard
-
-▸ **CustomCard**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | [`CustomCardProps`](interfaces/CustomCardProps.md) | - |
-| `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/ui/CustomCard.tsx:25](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L25)
-
-___
-
-### CustomCardImageRow
-
-▸ **CustomCardImageRow**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | `Object` | - |
-| `props.src` | `string` | - |
-| `props.alt?` | `string` | - |
-| `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/ui/CustomCard.tsx:44](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L44)
-
-___
-
-### CustomCardRow
-
-▸ **CustomCardRow**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | [`CustomCardRowProps`](interfaces/CustomCardRowProps.md) | - |
-| `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/ui/CustomCard.tsx:69](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L69)
-
-___
-
-### DateInput
-
-▸ **DateInput**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | [`DateInputProps`](interfaces/DateInputProps.md) | - |
-| `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/ui/DateInput.tsx:25](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L25)
-
-___
-
-### IconButton
-
-▸ **IconButton**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | [`IconButtonProps`](interfaces/IconButtonProps.md) | - |
-| `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/ui/IconButton.tsx:64](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L64)
-
-___
-
-### TextButton
-
-▸ **TextButton**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | [`TextButtonProps`](interfaces/TextButtonProps.md) | - |
-| `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/ui/TextButton.tsx:33](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L33)
-
-___
-
-### BaseText
-
-▸ **BaseText**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | `Object` | - |
-| `props.children` | `ReactNode` | - |
-| `props.faded?` | `boolean` | - |
-| `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/ui/Typography.tsx:5](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/Typography.tsx#L5)
-
-___
-
-### SmallText
-
-▸ **SmallText**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | `Object` | - |
-| `props.children` | `ReactNode` | - |
-| `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/ui/Typography.tsx:16](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/Typography.tsx#L16)
-
-___
-
-### html
-
-▸ **html**(`strings`, `...values`): `unknown`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `strings` | `TemplateStringsArray` |
-| `...values` | `any`[] |
-
-#### Returns
-
-`unknown`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/index.tsx:33](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/index.tsx#L33)
-
-___
-
-### create
-
-▸ **create**(`props`): `Promise`\<[`TouchpointInstance`](interfaces/TouchpointInstance.md)\>
-
-Creates a new Touchpoint UI instance and appends it to the document body
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | [`TouchpointConfiguration`](interfaces/TouchpointConfiguration.md) | Configuration props for Touchpoint |
-
-#### Returns
-
-`Promise`\<[`TouchpointInstance`](interfaces/TouchpointInstance.md)\>
-
-A promise that resolves to a TouchpointInstance
-
-#### Defined in
-
-[packages/touchpoint-ui/src/index.tsx:195](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/index.tsx#L195)
-
-___
-
-### PreviewContainer
-
-▸ **PreviewContainer**(`props`, `deprecatedLegacyContext?`): `ReactNode`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `props` | `Object` | - |
-| `props.children` | `ReactNode` | - |
-| `props.mode` | [`ColorMode`](README.md#colormode) | - |
-| `props.theme` | `Partial`\<[`Theme`](interfaces/Theme.md)\> | - |
-| `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/preview.tsx:10](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/preview.tsx#L10)

package/docs/interfaces/CustomCardProps.md

@@ -1,47 +0,0 @@
-# Interface: CustomCardProps
-
-Props for the CustomCard component
-
-## Properties
-
-### children
-
-• **children**: `ReactNode`
-
-Content to be rendered inside the card.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:14](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L14)
-
-___
-
-### selected
-
-• `Optional` **selected**: `boolean`
-
-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/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L18)
-
-___
-
-### onClick
-
-• `Optional` **onClick**: () => `void`
-
-Handler function for when the card is clicked
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:22](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L22)

package/docs/interfaces/CustomCardRowProps.md

@@ -1,39 +0,0 @@
-# Interface: CustomCardRowProps
-
-Props for the CustomCardRow component
-
-## Properties
-
-### left
-
-• **left**: `ReactNode`
-
-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/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L58)
-
-___
-
-### right
-
-• **right**: `ReactNode`
-
-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/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L62)
-
-___
-
-### icon
-
-• `Optional` **icon**: [`Icon`](../modules/Icons.md#icon)
-
-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/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L66)

package/docs/interfaces/DateInputProps.md

@@ -1,29 +0,0 @@
-# Interface: DateInputProps
-
-Props for the DateInput component
-
-## Properties
-
-### onSubmit
-
-• `Optional` **onSubmit**: (`date`: `string`) => `void`
-
-Handler function called when the date is submitted
-
-#### Type declaration
-
-▸ (`date`): `void`
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `date` | `string` | The submitted date in YYYY-MM-DD format |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/DateInput.tsx:16](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L16)

package/docs/interfaces/IconButtonProps.md

@@ -1,71 +0,0 @@
-# Interface: IconButtonProps
-
-Props for the IconButton component
-
-## Properties
-
-### onClick
-
-• `Optional` **onClick**: () => `void`
-
-Handler function called when the button is clicked
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:30](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L30)
-
-___
-
-### label
-
-• **label**: `string`
-
-Accessible label for the button
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:34](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L34)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Additional CSS classes to apply to the button
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:38](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L38)
-
-___
-
-### type
-
-• **type**: [`IconButtonType`](../README.md#iconbuttontype)
-
-Visual style variant of the button. One of IconButtonType.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:42](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L42)
-
-___
-
-### Icon
-
-• **Icon**: `FC`\<[`IconProps`](Icons.IconProps.md)\>
-
-Icon component to display inside the button
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/IconButton.tsx:46](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L46)

package/docs/interfaces/Icons.IconProps.md

@@ -1,29 +0,0 @@
-# Interface: IconProps
-
-[Icons](../modules/Icons.md).IconProps
-
-Props for icon components
-
-## Properties
-
-### className
-
-• `Optional` **className**: `string`
-
-Additional CSS classes to apply to the icon
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/Icons.tsx:11](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/Icons.tsx#L11)
-
-___
-
-### size
-
-• `Optional` **size**: `number`
-
-Custom size in pixels for the icon
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/Icons.tsx:15](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/Icons.tsx#L15)

package/docs/interfaces/TextButtonProps.md

@@ -1,72 +0,0 @@
-# Interface: TextButtonProps
-
-Props for the TextButton component
-
-## Properties
-
-### onClick
-
-• `Optional` **onClick**: () => `void`
-
-Handler function called when the button is clicked
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/TextButton.tsx:13](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L13)
-
-___
-
-### label
-
-• **label**: `string`
-
-Text to display on the button
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/TextButton.tsx:17](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L17)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Additional CSS classes to apply to the button
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/TextButton.tsx:21](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L21)
-
-___
-
-### type
-
-• `Optional` **type**: ``"main"`` \| ``"ghost"``
-
-Visual style variant of the button
-Default value is "ghost"
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/TextButton.tsx:26](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L26)
-
-___
-
-### Icon
-
-• **Icon**: `FC`\<[`IconProps`](Icons.IconProps.md)\>
-
-Icon component to display inside the button.
-
-#### Defined in
-
-[packages/touchpoint-ui/src/components/ui/TextButton.tsx:30](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L30)