@nlxai/touchpoint-ui 1.1.7 → 1.1.8-alpha.0

package/README.md

@@ -1,10 +1,28 @@
-# touchpoint-prototype
+# Touchpoint
+
+Touchpoint UI provides a customizable chat interface that you can embed in your web applications. Touchpoint UI allows users to interact with your application and provides a seamless conversational experience.
+
+```js
+import { create } from "@nlxai/touchpoint-ui";
+
+const touchpoint = await create({
+  config: {
+    applicationUrl: "REPLACE_WITH_APPLICATION_URL",
+    headers: {
+      "nlx-api-key": "REPLACE_WITH_API_KEY",
+    },
+    languageCode: "en-US",
+    userId: "REPLACE_WITH_USER_ID",
+  },
+  colorMode: "light",
+  input: "voice",
+  theme: { fontFamily: '"Neue Haas Grotesk", sans-serif', accent: "#AECAFF" },
+});
+```
+
+[Official documentation](https://docs.nlx.ai/platform/touchpoint)
 
 ## Run locally
 
 `npm install`
 `npm run dev`
-
-## Standalone dev environment and design system
-
-`npm run design-system`

package/lib/App.d.ts

@@ -1,4 +1,4 @@
-import { ConversationHandler } from '@nlxai/chat-core';
+import { ConversationHandler } from '@nlxai/core';
 import { NormalizedTouchpointConfiguration } from './types';
 /**
  * Main Touchpoint creation properties object

package/lib/bidirectional/automaticContext.d.ts

@@ -1,4 +1,4 @@
-import { ConversationHandler } from '@nlxai/chat-core';
+import { ConversationHandler } from '@nlxai/core';
 export declare const gatherAutomaticContext: (handler: ConversationHandler, setPageState: (state: {
     formElements: any;
     links: Record<string, string>;

package/lib/bidirectional/commandHandler.d.ts

@@ -1,4 +1,4 @@
-import { ConversationHandler } from '@nlxai/chat-core';
+import { ConversationHandler } from '@nlxai/core';
 import { BidirectionalConfig } from '../types';
 export declare const commandHandler: (handler: ConversationHandler, bidirectional: BidirectionalConfig, pageState: {
     current: {

package/lib/components/FullscreenVoice.d.ts

@@ -1,5 +1,5 @@
-import { FC, ReactNode } from 'react';
-import { Context, ConversationHandler } from '@nlxai/chat-core';
+import { FC } from 'react';
+import { Context, ConversationHandler } from '@nlxai/core';
 import { ColorMode, InitializeConversation, CustomModalityComponent } from '../types';
 import { ModalitiesWithContext } from '../voice';
 interface Props {
@@ -13,10 +13,8 @@ interface Props {
     customModalities?: Record<string, CustomModalityComponent<unknown>>;
 }
 export declare const VoiceModalities: FC<{
-    Wrapper?: FC<{
-        children: ReactNode;
-    }>;
-    roomData: ModalitiesWithContext;
+    className?: string;
+    modalities: ModalitiesWithContext[];
     customModalities: Record<string, CustomModalityComponent<unknown>>;
     handler: ConversationHandler;
 }>;

package/lib/components/Input.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { ConversationHandler, UploadUrl } from '@nlxai/chat-core';
+import { ConversationHandler, UploadUrl } from '@nlxai/core';
 interface InputProps {
     className?: string;
     handler: ConversationHandler;

package/lib/components/Messages.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { Response, ConversationHandler, BotMessage } from '@nlxai/chat-core';
+import { Response, ConversationHandler, ApplicationMessage } from '@nlxai/core';
 import { CustomModalityComponent, ColorMode } from '../types';
 export interface MessagesProps {
     isWaiting: boolean;
@@ -10,14 +10,14 @@ export interface MessagesProps {
     chatMode: boolean;
     colorMode: ColorMode;
     uploadedFiles: Record<string, File>;
-    lastBotResponseIndex?: number;
+    lastApplicationResponseIndex?: number;
     customModalities: Record<string, CustomModalityComponent<unknown>>;
     className?: string;
     enabled: boolean;
 }
 export declare const MessageChoices: FC<{
     handler: ConversationHandler;
-    message: BotMessage;
+    message: ApplicationMessage;
     responseIndex: number;
     messageIndex: number;
 }>;

package/lib/components/Settings.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { ConversationHandler } from '@nlxai/chat-core';
+import { ConversationHandler } from '@nlxai/core';
 interface SettingsProps {
     onClose: () => void;
     reset: () => void;

package/lib/components/VoiceMini.d.ts

@@ -1,4 +1,4 @@
-import { Context, ConversationHandler } from '@nlxai/chat-core';
+import { Context, ConversationHandler } from '@nlxai/core';
 import { FC } from 'react';
 import { CustomModalityComponent } from '../types';
 export declare const VoiceMini: FC<{

package/lib/components/defaultModalities/DefaultCard.d.ts

@@ -0,0 +1,3 @@
+import { CustomModalityComponent } from '../../types';
+import { CardData } from './shared';
+export declare const DefaultCard: CustomModalityComponent<CardData>;

package/lib/components/defaultModalities/DefaultCarousel.d.ts

@@ -0,0 +1,6 @@
+import { CustomModalityComponent } from '../../types';
+import { SaveAs, CardData } from './shared';
+export declare const DefaultCarousel: CustomModalityComponent<{
+    cards: CardData[];
+    $saveAs: SaveAs;
+}>;

package/lib/components/defaultModalities/DefaultDateInput.d.ts

@@ -0,0 +1,5 @@
+import { SaveAs } from './shared';
+import { CustomModalityComponent } from '../../types';
+export declare const DefaultDateInput: CustomModalityComponent<{
+    $saveAs: SaveAs;
+}>;

package/lib/components/defaultModalities/shared.d.ts

@@ -0,0 +1,13 @@
+import { ConversationHandler } from '@nlxai/core';
+export interface SaveAs {
+    type: "slot" | "context";
+    id: string;
+}
+export interface CardData {
+    id?: string;
+    thumbnail?: string;
+    thumbnailAlt?: string;
+    label?: string;
+    value?: string;
+}
+export declare const saveFn: ($saveAs: SaveAs, conversationHandler: ConversationHandler) => ((val: any) => void);

package/lib/components/ui/Carousel.d.ts

@@ -1,4 +1,5 @@
 import { FC, ReactNode } from 'react';
 export declare const Carousel: FC<{
+    className?: string;
     children: ReactNode;
 }>;

package/lib/components/ui/CustomCard.d.ts

@@ -4,6 +4,10 @@ import { Icon } from '../ui/Icons';
  * Props for the CustomCard component
  */
 export interface CustomCardProps {
+    /**
+     * Class name
+     */
+    className?: string;
     /**
      * Content to be rendered inside the card.
      */

package/lib/components/ui/DateInput.d.ts

@@ -8,5 +8,9 @@ export interface DateInputProps {
      * @param date - The submitted date in YYYY-MM-DD format
      */
     onSubmit?: (date: string) => void;
+    /**
+     * Class name
+     */
+    className?: string;
 }
 export declare const DateInput: FC<DateInputProps>;

package/lib/components/ui/Typography.d.ts

@@ -2,7 +2,9 @@ import { FC, ReactNode } from 'react';
 export declare const BaseText: FC<{
     children: ReactNode;
     faded?: boolean;
+    className?: string;
 }>;
 export declare const SmallText: FC<{
     children: ReactNode;
+    className?: string;
 }>;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { ConversationHandler } from '@nlxai/chat-core';
+import { ConversationHandler } from '@nlxai/core';
 import { TextButton } from './components/ui/TextButton';
 import { IconButton } from './components/ui/IconButton';
 import { Ripple } from './components/Ripple';