@nlxai/touchpoint-ui 1.0.4 → 1.0.5-alpha.1

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import { BotMessage, ConversationHandler } from '@nlxai/chat-core';
+import { Config, BotMessage, ConversationHandler } from '@nlxai/chat-core';
 import { FC } from 'react';
 /**
  * Window size configuration
@@ -38,6 +38,12 @@ export type CustomModalityComponent<Data> = FC<{
      * 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;
 }>;
 /**
  * The full theme expressed as CSS custom properties
@@ -144,3 +150,38 @@ export interface Theme {
      */
     outerBorderRadius: string;
 }
+/**
+ * Main Touchpoint creation properties object
+ */
+export interface TouchpointConfiguration {
+    /**
+     * Connection information for the \@nlxai/chat-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;
+    /**
+     * Optional theme object to override default theme values
+     */
+    theme?: Partial<Theme>;
+    /**
+     * Optional custom modality components to render in Touchpoint
+     */
+    customModalities?: Record<string, CustomModalityComponent<any>>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nlxai/touchpoint-ui",
-  "version": "1.0.4",
+  "version": "1.0.5-alpha.1",
   "description": "Web UI for Touchpoint",
   "type": "module",
   "main": "lib/index.js",
@@ -13,18 +13,18 @@
     "dev": "vite",
     "design-system": "vite --mode design-system",
     "build": "tsc && vite build",
-    "docs": "echo \"todo\"",
+    "docs": "rm -rf docs/ && typedoc && concat-md --decrease-title-levels --dir-name-as-title docs/ > docs/index.md",
     "lint:check": "eslint src/ --ext .ts,.tsx,.js,.jsx --max-warnings 0",
     "prepublish": "npm run build",
     "lint": "eslint src/ --ext .ts,.tsx,.js,.jsx --fix",
     "format": "git ls-files | grep -E '\\.(js|jsx|ts|tsx|css|html)$' | xargs prettier --write",
-    "preview-docs": "echo \"todo\"",
-    "publish-docs": "echo \"todo\"",
-    "test": "echo \"todo\"",
+    "preview-docs": "npm run docs && comrak --unsafe --gfm -o docs/index.html docs/index.md && open docs/index.html",
+    "publish-docs": "npm run docs && mv docs/index.md ../website/src/content/touchpoint-ui-api-reference.md",
+    "test": "typedoc --emit none",
     "tsc": "tsc"
   },
   "dependencies": {
-    "@nlxai/chat-core": "^1.0.4",
+    "@nlxai/chat-core": "^1.0.5-alpha.0",
     "@react-hookz/web": "^25.0.1",
     "@react-input/mask": "^2.0.4",
     "clsx": "^2.1.1",
@@ -56,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "27ff05880575d5e4656c5d22dd85d29e9490d9d2"
+  "gitHead": "e0328435afc01c60e717f630d55299597989d70a"
 }

package/typedoc.cjs

@@ -0,0 +1,14 @@
+/** @type { import('typedoc').TypeDocOptions & { hideInPageTOC?: boolean, hideBreadcrumbs?: boolean} } */
+module.exports = {
+  excludeExternals: true,
+  entryPoints: ["./src/index.tsx"],
+  hideBreadcrumbs: true,
+  hideInPageTOC: true,
+  out: "docs",
+  plugin: ["typedoc-plugin-markdown"],
+  readme: "none",
+  sort: ["source-order", "kind", "instance-first", "alphabetical"],
+  treatValidationWarningsAsErrors: true,
+  treatWarningsAsErrors: true,
+  validation: { notExported: true, invalidLink: true, notDocumented: true },
+};