@chatbotkit/widget 1.25.0

package/README.md

@@ -0,0 +1,95 @@
+[![ChatBotKit](https://img.shields.io/badge/credits-ChatBotKit-blue.svg)](https://chatbotkit.com)
+[![CBK.AI](https://img.shields.io/badge/credits-CBK.AI-blue.svg)](https://cbk.ai)
+[![Follow on Twitter](https://img.shields.io/twitter/follow/chatbotkit.svg?logo=twitter)](https://twitter.com/chatbotkit)
+[![NPM](https://img.shields.io/npm/v/@chatbotkit/widget.svg)](https://www.npmjs.com/package/@chatbotkit/widget)
+[![Email](https://img.shields.io/badge/Email-Support-blue?logo=mail.ru)](mailto:support@chatbotkit.com)
+[![Discord](https://img.shields.io/badge/Discord-Support-blue?logo=discord)](https://go.cbk.ai/discord)
+
+# ChatBotKit Widget Types
+
+Type definitions for the ChatBotKit widget custom element. This package provides TypeScript types for interacting with the ChatBotKit widget (v2).
+
+## What's Included
+
+- **`ChatBotKitWidgetElementV2`**: The main widget custom element interface with all available methods and properties
+- **`ChatBotKitGlobalObject`**: The global `window.chatbotkitWidget` object interface
+- **`Message`**: Type for conversation messages
+- **`FunctionDefinition`**: Type for registering custom functions with the widget
+- **`NotificationDefinition`**: Type for widget notifications
+- **`Contact`**: Type for contact information
+- **`Meta`**: Type for session metadata
+
+## Installation
+
+```bash
+npm install @chatbotkit/widget
+```
+
+## Usage
+
+Import the types directly:
+
+```typescript
+import type {
+  ChatBotKitWidgetElementV2,
+  ChatBotKitGlobalObject,
+  FunctionDefinition,
+  Message,
+} from '@chatbotkit/widget'
+
+// Access the widget instance
+const widget = window.chatbotkitWidget.instance
+
+// Or wait for it to be ready
+const widget = await window.chatbotkitWidget.instancePromise
+
+// Register custom functions
+const myFunction: FunctionDefinition = {
+  description: 'Get the current user name',
+  parameters: {},
+  handler: async () => {
+    return 'John Doe'
+  },
+}
+
+widget.registerFunctions({ getUserName: myFunction })
+
+// Send a message
+widget.sendMessage({ text: 'Hello!' })
+
+// Listen to messages
+console.log(widget.messages)
+```
+
+### Using with the Widget Script
+
+The types augment the global `Window` interface, so you can access `window.chatbotkitWidget` with full type safety:
+
+```typescript
+import '@chatbotkit/widget'
+
+// Now window.chatbotkitWidget is typed
+window.chatbotkitWidget.instancePromise.then((widget) => {
+  widget.open = true
+  widget.sendMessage({ text: 'Hello from TypeScript!' })
+})
+```
+
+### Using with React
+
+For React integration, consider using the `@chatbotkit/react` package which includes hooks like:
+
+- `useWidgetInstance` - Access the widget instance
+- `useWidgetInstanceFunctions` - Register functions with the widget
+- `useWidgetInstanceNotifications` - Manage widget notifications
+
+## Documentation
+
+For more information about the ChatBotKit widget, visit:
+
+- [ChatBotKit Documentation](https://chatbotkit.com/docs)
+- [Type Documentation](https://chatbotkit.github.io/node-sdk/modules/_chatbotkit_widget.html)
+
+## Contributing
+
+Found a bug or wish to contribute? We welcome your input! Please open an issue or submit a pull request on our [official GitHub repository](https://github.com/chatbotkit/node-sdk).

package/dist/cjs/index.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./v2.cjs"), exports);

package/dist/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from './v2.cjs';

package/dist/cjs/v2.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/v2.d.ts

@@ -0,0 +1,66 @@
+export interface Message {
+    id: string;
+    type: 'user' | 'bot' | 'input';
+    text: string;
+    meta?: Record<string, unknown>;
+}
+export interface FunctionDefinition {
+    description: string;
+    parameters: Record<string, unknown>;
+    handler: (args: Record<string, unknown>) => unknown | Promise<unknown>;
+}
+export interface Contact {
+    name?: string;
+    email?: string;
+    phone?: string;
+}
+export type Meta = Record<string, unknown>;
+export interface NotificationDefinition {
+    text: string;
+}
+export interface InitiateMessageOptions {
+    text?: string;
+}
+export interface SendMessageOptions {
+    text: string;
+}
+export interface RenderOptions {
+    [key: string]: unknown;
+}
+export interface ChatBotKitWidgetElementV2 extends HTMLElement {
+    readonly ready: boolean;
+    readonly readyPromise: Promise<boolean>;
+    messages: Message[] | null;
+    functions: Record<string, FunctionDefinition | null> | null;
+    contact: Contact | null;
+    meta: Meta | null;
+    notifications: Record<string, NotificationDefinition | null>;
+    open: boolean;
+    hide(): void;
+    show(): void;
+    restartConversation(): void;
+    initiateMessage(props: InitiateMessageOptions): void;
+    sendMessage(props: SendMessageOptions): void;
+    maximize(): void;
+    minimize(): void;
+    render(props: RenderOptions): void;
+    registerFunctions(functions: Record<string, FunctionDefinition | null>): void;
+    unregisterFunctions(functions: string[]): void;
+    assignContact(props: Contact): void;
+}
+export interface ChatBotKitGlobalObject {
+    readonly instance: ChatBotKitWidgetElementV2 | null;
+    readonly instancePromise: Promise<ChatBotKitWidgetElementV2>;
+}
+declare global {
+    interface Window {
+        chatbotkitWidget: ChatBotKitGlobalObject;
+        CHATBOTKIT_LOG_WARNING?: boolean;
+        CHATBOTKIT_WARNING_LOG?: boolean;
+        CHATBOTKIT_LOG_ERROR?: boolean;
+        CHATBOTKIT_ERROR_LOG?: boolean;
+    }
+    interface HTMLElementTagNameMap {
+        'chatbotkit-widget': ChatBotKitWidgetElementV2;
+    }
+}

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export * from './v2.js';

package/dist/esm/index.js

@@ -0,0 +1 @@
+export * from './v2.js';

package/dist/esm/v2.d.ts

@@ -0,0 +1,66 @@
+export interface Message {
+    id: string;
+    type: 'user' | 'bot' | 'input';
+    text: string;
+    meta?: Record<string, unknown>;
+}
+export interface FunctionDefinition {
+    description: string;
+    parameters: Record<string, unknown>;
+    handler: (args: Record<string, unknown>) => unknown | Promise<unknown>;
+}
+export interface Contact {
+    name?: string;
+    email?: string;
+    phone?: string;
+}
+export type Meta = Record<string, unknown>;
+export interface NotificationDefinition {
+    text: string;
+}
+export interface InitiateMessageOptions {
+    text?: string;
+}
+export interface SendMessageOptions {
+    text: string;
+}
+export interface RenderOptions {
+    [key: string]: unknown;
+}
+export interface ChatBotKitWidgetElementV2 extends HTMLElement {
+    readonly ready: boolean;
+    readonly readyPromise: Promise<boolean>;
+    messages: Message[] | null;
+    functions: Record<string, FunctionDefinition | null> | null;
+    contact: Contact | null;
+    meta: Meta | null;
+    notifications: Record<string, NotificationDefinition | null>;
+    open: boolean;
+    hide(): void;
+    show(): void;
+    restartConversation(): void;
+    initiateMessage(props: InitiateMessageOptions): void;
+    sendMessage(props: SendMessageOptions): void;
+    maximize(): void;
+    minimize(): void;
+    render(props: RenderOptions): void;
+    registerFunctions(functions: Record<string, FunctionDefinition | null>): void;
+    unregisterFunctions(functions: string[]): void;
+    assignContact(props: Contact): void;
+}
+export interface ChatBotKitGlobalObject {
+    readonly instance: ChatBotKitWidgetElementV2 | null;
+    readonly instancePromise: Promise<ChatBotKitWidgetElementV2>;
+}
+declare global {
+    interface Window {
+        chatbotkitWidget: ChatBotKitGlobalObject;
+        CHATBOTKIT_LOG_WARNING?: boolean;
+        CHATBOTKIT_WARNING_LOG?: boolean;
+        CHATBOTKIT_LOG_ERROR?: boolean;
+        CHATBOTKIT_ERROR_LOG?: boolean;
+    }
+    interface HTMLElementTagNameMap {
+        'chatbotkit-widget': ChatBotKitWidgetElementV2;
+    }
+}

package/dist/esm/v2.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "@chatbotkit/widget",
+  "version": "1.25.0",
+  "description": "Type definitions for the ChatBotKit widget custom element",
+  "license": "ISC",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chatbotkit/node-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/chatbotkit/node-sdk/issues"
+  },
+  "homepage": "https://github.com/chatbotkit/node-sdk#readme",
+  "author": "",
+  "keywords": [
+    "widget",
+    "chatbot",
+    "chatbotkit",
+    "types",
+    "typescript"
+  ],
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./index": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./index.js": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./v2": {
+      "import": {
+        "types": "./dist/esm/v2.d.ts",
+        "default": "./dist/esm/v2.js"
+      },
+      "require": {
+        "types": "./dist/cjs/v2.d.ts",
+        "default": "./dist/cjs/v2.cjs"
+      }
+    },
+    "./v2.js": {
+      "import": {
+        "types": "./dist/esm/v2.d.ts",
+        "default": "./dist/esm/v2.js"
+      },
+      "require": {
+        "types": "./dist/cjs/v2.d.ts",
+        "default": "./dist/cjs/v2.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/cjs/index.d.ts",
+  "dependencies": {
+    "tslib": "^2.6.2"
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.5",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-mdn-links": "^5.0.10",
+    "typescript": "^5.9"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "run-s build:*",
+    "build:01-cjs": "tsc -p tsconfig.cjs.json",
+    "build:01-cjs_rename": "node ../../scripts/rename-cjs.js",
+    "build:01-cjs_rewrite_cjs": "node ../../scripts/rewrite-cjs.js",
+    "build:01-cjs_rewrite_ts": "node ../../scripts/rewrite-ts.js",
+    "build:03-docs": "typedoc",
+    "build:02-esm": "tsc -p tsconfig.esm.json",
+    "build:00-exports": "node ../../scripts/create-standard-exports.js",
+    "build:00-types": "tsc -p tsconfig.types.json",
+    "check": "tsc -p tsconfig.check.json",
+    "clean": "run-p clean:*",
+    "clean:buildinfo": "rimraf *.tsbuildinfo",
+    "clean:dists": "rimraf dist",
+    "clean:exports": "run-s build:aaa_exports",
+    "clean:node_modules": "rimraf node_modules",
+    "clean:types": "rimraf types",
+    "lint": "eslint .",
+    "test": "true"
+  }
+}