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

package/lib/types.d.ts

@@ -1,323 +1,5 @@
-import { Config, ApplicationMessage, ConversationHandler, Context } from '@nlxai/core';
-import { ComponentType } from 'react';
-/**
- * Window size configuration
- */
-export type WindowSize = "half" | "full";
-/**
- * Color mode configuration (light/dark modes)
- */
-export type ColorMode = "light" | "dark";
-/**
- * Choice message with metadata
- */
-export interface ChoiceMessage {
-    /**
-     * Message contents
-     */
-    message: ApplicationMessage;
-    /**
-     * Index in the response transcript history
-     */
-    responseIndex: number;
-    /**
-     * Message index in the current response
-     */
-    messageIndex: number;
-}
-/**
- * Custom Modalities allow rendering of rich components from nodes.
- * See: https://docs.studio.nlx.ai/build/resources/modalities
- */
-export type CustomModalityComponent<Data> = ComponentType<{
-    /**
-     * The payload of the Custom Modality. The schema is defined in Dialog Studio settings.
-     */
-    data: Data;
-    /**
-     * Conversation handler instance
-     */
-    conversationHandler: ConversationHandler;
-    /**
-     * Whether the component is enabled
-     * We should probably use context and handle disabling interactive components automatically for the user
-     * @internal
-     */
-    enabled: boolean;
-    /**
-     * Class name to propagate to the container
-     */
-    className?: string;
-}>;
-/**
- * The full theme expressed as CSS custom properties
- */
-export interface Theme {
-    /**
-     * Font family
-     */
-    fontFamily: string;
-    /**
-     * Primary color with 80% opacity
-     */
-    primary80: string;
-    /**
-     * Primary color with 60% opacity
-     */
-    primary60: string;
-    /**
-     * Primary color with 40% opacity
-     */
-    primary40: string;
-    /**
-     * Primary color with 20% opacity
-     */
-    primary20: string;
-    /**
-     * Primary color with 10% opacity
-     */
-    primary10: string;
-    /**
-     * Primary color with 5% opacity
-     */
-    primary5: string;
-    /**
-     * Primary color with 1% opacity
-     */
-    primary1: string;
-    /**
-     * Secondary color with 80% opacity
-     */
-    secondary80: string;
-    /**
-     * Secondary color with 60% opacity
-     */
-    secondary60: string;
-    /**
-     * Secondary color with 40% opacity
-     */
-    secondary40: string;
-    /**
-     * Secondary color with 20% opacity
-     */
-    secondary20: string;
-    /**
-     * Secondary color with 10% opacity
-     */
-    secondary10: string;
-    /**
-     * Secondary color with 5% opacity
-     */
-    secondary5: string;
-    /**
-     * Secondary color with 1% opacity
-     */
-    secondary1: string;
-    /**
-     * Accent color used e.g. for prominent buttons, the loader animation as well as selected card outlines
-     */
-    accent: string;
-    /**
-     * Accent color with 20% opacity
-     */
-    accent20: string;
-    /**
-     * The background color of the main Touchpoint interface
-     */
-    background: string;
-    /**
-     * The color of the overlay covering the visible portion of the website when the Touchpoint interface does not cover the full screen
-     */
-    overlay: string;
-    /**
-     * Primary warning color
-     */
-    warningPrimary: string;
-    /**
-     * Secondary warning color
-     */
-    warningSecondary: string;
-    /**
-     * Primary error color
-     */
-    errorPrimary: string;
-    /**
-     * Secondary error color
-     */
-    errorSecondary: string;
-    /**
-     * Inner border radius: used for most buttons
-     */
-    innerBorderRadius: string;
-    /**
-     * Outer border radius: generally used for elements that contain buttons that have inner border radius. Also used by the launch button.
-     */
-    outerBorderRadius: string;
-}
-/**
- * Custom conversation init method. Defaults to sending the welcome intent
- * @param handler - the conversation handler.
- * @param context - context set via TouchpointConfiguration.initialContext
- */
-export type InitializeConversation = (handler: ConversationHandler, context?: Context) => void;
-/**
- * Fully custom launch icon
- */
-export type CustomLaunchButton = ComponentType<{
-    /**
-     * Class name injected into the component mainly to take care of positioning and z-index. Can be combined with more presentational and sizing-related class names.
-     */
-    className?: string;
-    /**
-     * Click handler that expands Touchpoint, without the caller having to implement this based on Touchpoint instance methods.
-     */
-    onClick?: () => void;
-}>;
-/**
- * Input type for the experience
- */
-export type Input = "text" | "voice" | "voiceMini";
-/**
- * Configuration for bidirectional mode of voice+.
- */
-export type BidirectionalConfig = {
-    /**
-     * Attempt to gather and send page context automatically. This will work well on semantically coded pages without too many custom form controls.
-     * This enables a number of automatic features.
-     *
-     * Defaults to `true`.
-     */
-    automaticContext?: true;
-    /**
-     * Navigation handler for bidirectional mode.
-     *
-     * If automatic context gathering is enabled, the default implementation will navigate to those pages using standard `window.location` APIs.
-     * @param action - The navigation action to perform.
-     * @param destination - The name of the destination to navigate to if `action` is `"page_custom"`.
-     * @param destinations - A map of destination names to URLs for custom navigation. Only present if `automaticContext` is enabled.
-     */
-    navigation?: (action: "page_next" | "page_previous" | "page_custom" | "page_unknown", destination: string | undefined, destinations: Record<string, string>) => void;
-    /**
-     * A callback for filling out form fields in bidirectional mode.
-     *
-     * If automatic context gathering is enabled, the default implementation will fill out the form fields using standard DOM APIs.
-     * @param fields - An array of field objects with `id` and `value` properties.
-     * @param pageFields - A map of field IDs to DOM elements for custom form filling. Only present if `automaticContext` is enabled.
-     */
-    input?: (fields: Array<{
-        id: string;
-        value: string;
-    }>, pageFields: Record<string, Element>) => void;
-    /**
-     * A callback for custom actions in bidirectional mode.
-     * @param action - The custom name of your action.
-     * @param payload - The payload defined for the custom action.
-     * @returns
-     */
-    custom?: (action: string, payload: unknown) => void;
-} | {
-    /**
-     * Attempt to gather and send page context automatically. This will work well on semantically coded pages without too many custom form controls.
-     * This enables a number of automatic features.
-     *
-     * Defaults to `true`.
-     */
-    automaticContext: false;
-    /**
-     * Navigation handler for bidirectional mode.
-     *
-     * If automatic context gathering is enabled, the default implementation will navigate to those pages using standard `window.location` APIs.
-     * @param action - The navigation action to perform.
-     * @param destination - The name of the destination to navigate to if `action` is `"page_custom"`.
-     */
-    navigation?: (action: "page_next" | "page_previous" | "page_custom" | "page_unknown", destination?: string) => void;
-    /**
-     * A callback for filling out form fields in bidirectional mode.
-     *
-     * If automatic context gathering is enabled, the default implementation will fill out the form fields using standard DOM APIs.
-     * @param fields - An array of field objects with `id` and `value` properties.
-     */
-    input?: (fields: Array<{
-        id: string;
-        value: string;
-    }>) => void;
-    /**
-     * A callback for custom actions in bidirectional mode.
-     * @param action - The custom name of your action.
-     * @param payload - The payload defined for the custom action.
-     * @returns
-     */
-    custom?: (action: string, payload: unknown) => void;
-};
-/**
- * Main Touchpoint creation properties object
- */
-export interface TouchpointConfiguration {
-    /**
-     * Connection information for the \@nlxai/core conversation handler
-     */
-    config: Config;
-    /**
-     * Optional window size for the chat window, defaults to `half`
-     */
-    windowSize?: WindowSize;
-    /**
-     * Optional color mode for the chat window, defaults to `dark`
-     */
-    colorMode?: ColorMode;
-    /**
-     * URL of icon used to display the brand in the chat header
-     */
-    brandIcon?: string;
-    /**
-     * 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.
-     */
-    launchIcon?: string | boolean | CustomLaunchButton;
-    /**
-     * Specifies whether the user message has bubbles or not
-     */
-    userMessageBubble?: boolean;
-    /**
-     * Specifies whether the agent message has bubbles or not
-     */
-    agentMessageBubble?: boolean;
-    /**
-     * Enables chat mode, a classic chat experience with inline loaders and the chat history visible at all times.
-     */
-    chatMode?: boolean;
-    /**
-     * Optional theme object to override default theme values
-     */
-    theme?: Partial<Theme>;
-    /**
-     * Optional custom modality components to render in Touchpoint
-     */
-    customModalities?: Record<string, CustomModalityComponent<unknown>>;
-    /**
-     * Custom conversation init method. Defaults to sending the welcome intent
-     * @param handler - the conversation handler.
-     * @param context - the context object
-     */
-    initializeConversation?: InitializeConversation;
-    /**
-     * Controls the ways in which  the user can communicate with the application. Defaults to `"text"`
-     */
-    input?: Input;
-    /**
-     * Context sent with the initial request.
-     */
-    initialContext?: Context;
-    /**
-     * Enables bidirectional mode of voice+. Will automatically set the bidirectional flag in the config.
-     *
-     */
-    bidirectional?: BidirectionalConfig;
-}
-/**
- * @internal
- */
+import { Config } from '@nlxai/core';
+import { TouchpointConfiguration } from './interface';
 export type NormalizedTouchpointConfiguration = TouchpointConfiguration & Required<Pick<TouchpointConfiguration, "initializeConversation" | "input">> & {
     config: Required<Pick<Config, "conversationId" | "userId" | "bidirectional">>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.1.8-alpha.0",
+  "version": "1.1.8-alpha.2",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -27,6 +27,7 @@
     "@nlxai/core": "^1.1.8-alpha.0",
     "@react-hookz/web": "^25.0.1",
     "@react-input/mask": "^2.0.4",
+    "@types/json-schema": "^7.0.15",
     "clsx": "^2.1.1",
     "hast": "^0.0.2",
     "htm": "^3.1.1",
@@ -60,5 +61,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8f4341c889c73a3b681dcdf25420ecec285c1ef6"
+  "gitHead": "a9cf00e44e050d087a2ffa657dc5e73d0bcf6816"
 }

package/tsdoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["typedoc/tsdoc.json"],
+  "noStandardTags": false,
+  "tagDefinitions": []
+}