tchao 0.1.2

package/LICENSE.TXT

@@ -0,0 +1,20 @@
+Licence Agreement for Now.ts, Version 1.1
+
+This Licence Agreement ("Agreement") is made between Codelynx, LLC, the copyright holder ("Licensor") and the user ("Licensee") of the Now.ts software ("Software"), version 1.1.
+
+Grant of Licence: Licensor hereby grants Licensee a non-exclusive, non-transferable, perpetual licence to use the Software for the purpose of developing commercial applications. Licensee is permitted to use the Software in the creation of applications that the Licensee may commercialize.
+
+Restrictions: Licensee is expressly prohibited from modifying, distributing, sublicensing, or making available the Software to any third party. The Licensee shall not use the Software for any other purpose than as explicitly provided in this Agreement without the prior written consent of Licensor.
+
+Ownership: The Software and all intellectual property rights therein are and shall remain the property of Licensor. The Licensee does not acquire any ownership rights to the Software under this Agreement.
+
+No Warranty: The Software is provided "as is," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement. In no event shall the Licensor be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the Software.
+
+Limitation of Liability: Licensor shall not be liable for any direct, indirect, incidental, special, consequential or exemplary damages, including but not limited to, damages for loss of profits, goodwill, use, data or other intangible losses (even if Licensor has been advised of the possibility of such damages), resulting from the Licensee's use of the Software.
+
+Jurisdiction: This Agreement shall be governed by and construed in accordance with the laws of the United States of America, without giving effect to any principles of conflicts of law.
+
+By using the Software, Licensee agrees to be bound by the terms of this Agreement. If Licensee does not agree to the terms of this Agreement, they must not use the Software.
+
+Melvyn Malherbe, Codelynx LLC
+3 February 2024

package/README.md

@@ -0,0 +1,161 @@
+# Tchao
+
+JavaScript SDK for integrating the Tchao chat widget into your application.
+
+## Installation
+
+### Option 1: npm package
+
+```bash
+npm install tchao
+# or
+pnpm add tchao
+# or
+yarn add tchao
+```
+
+### Option 2: Script tag
+
+```html
+<script src="https://tchao.app/widget.js" data-website-id="your-website-id"></script>
+```
+
+## Usage
+
+### npm package
+
+```typescript
+import { Tchao } from 'tchao';
+
+// Initialize the widget
+const widget = await Tchao.init({
+  websiteId: 'your-website-id'
+});
+
+// Open the chat window
+widget.open();
+```
+
+### Script tag (global object)
+
+```html
+<script src="https://tchao.app/widget.js" data-website-id="your-website-id"></script>
+<script>
+  // Widget auto-initializes, access via global object
+  window.Tchao.open();
+
+  // Listen for events
+  window.Tchao.on('ready', () => {
+    console.log('Widget ready!');
+  });
+</script>
+```
+
+## API Reference
+
+### `Tchao.init(config)` (npm only)
+
+Initialize the Tchao widget programmatically.
+
+```typescript
+const widget = await Tchao.init({
+  websiteId: 'your-website-id', // Required
+  host: 'https://tchao.app'     // Optional, for self-hosted instances
+});
+```
+
+Returns a `Promise<TchaoInstance>`.
+
+### Instance Methods
+
+#### `widget.show()`
+Show the widget launcher button.
+
+#### `widget.hide()`
+Hide the widget launcher button.
+
+#### `widget.toggle()`
+Toggle the chat window open/closed.
+
+#### `widget.open()`
+Open the chat window.
+
+#### `widget.identify(info)`
+Identify the visitor with their information.
+
+```typescript
+widget.identify({
+  email: 'user@example.com',
+  name: 'John Doe',
+  avatar: 'https://example.com/avatar.jpg',
+  metadata: {
+    plan: 'pro',
+    userId: '12345'
+  }
+});
+```
+
+#### `widget.config(options)`
+Update widget configuration.
+
+```typescript
+widget.config({
+  position: 'bottom-left',  // 'bottom-right' | 'bottom-left'
+  primaryColor: '#6366f1',
+  themeMode: 'dark'         // 'light' | 'dark' | 'system'
+});
+```
+
+#### `widget.on(event, callback)`
+Subscribe to widget events.
+
+```typescript
+widget.on('message', (message) => {
+  console.log('New message:', message.content);
+});
+
+widget.on('open', () => {
+  console.log('Chat opened');
+});
+
+widget.on('close', () => {
+  console.log('Chat closed');
+});
+
+widget.on('ready', () => {
+  console.log('Widget ready');
+});
+```
+
+#### `widget.off(event, callback)`
+Unsubscribe from widget events.
+
+```typescript
+const handleMessage = (message) => console.log(message);
+widget.on('message', handleMessage);
+widget.off('message', handleMessage);
+```
+
+#### `widget.destroy()` (npm only)
+Clean up and remove the widget from the page.
+
+```typescript
+widget.destroy();
+```
+
+## TypeScript
+
+Full TypeScript support is included. Import types as needed:
+
+```typescript
+import type {
+  TchaoConfig,
+  TchaoInstance,
+  VisitorInfo,
+  Message
+} from 'tchao';
+```
+
+## License
+
+MIT

package/dist/npm.d.mts

@@ -0,0 +1,97 @@
+type SenderType = "VISITOR" | "AGENT" | "AI" | "SYSTEM";
+type ConversationStatus = "OPEN" | "IN_PROGRESS" | "CLOSED";
+type MessageStatus = "sending" | "sent" | "failed";
+type WidgetPosition = "bottom-right" | "bottom-left";
+type WidgetStyle = "bubble" | "name_line" | "question_cta";
+type ThemeMode = "light" | "dark" | "system";
+type VisitorInfo = {
+    name?: string;
+    email?: string;
+    avatar?: string;
+    metadata?: Record<string, unknown>;
+};
+type MessageReaction = {
+    emoji: string;
+    userIds: string[];
+};
+type Message = {
+    id: string;
+    content: string;
+    senderType: SenderType;
+    senderId: string;
+    screenshot?: string | null;
+    image?: string | null;
+    timestamp: number;
+    status?: MessageStatus;
+    reactions?: MessageReaction[] | null;
+};
+type WidgetConfig = {
+    websiteId: string;
+    apiBaseUrl: string;
+    convexUrl?: string;
+    position?: WidgetPosition;
+    primaryColor?: string;
+    widgetStyle?: WidgetStyle;
+    themeMode?: ThemeMode;
+};
+type SDKEventMap = {
+    message: (message: Message) => void;
+    open: () => void;
+    close: () => void;
+    ready: () => void;
+};
+type SDKMethods = {
+    show: () => void;
+    hide: () => void;
+    toggle: () => void;
+    open: () => void;
+    identify: (info: VisitorInfo) => void;
+    config: (opts: Partial<WidgetConfig>) => void;
+    on: <K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]) => void;
+    off: <K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]) => void;
+};
+
+declare class TchaoSDK implements SDKMethods {
+    private readonly listeners;
+    private showCallback;
+    private hideCallback;
+    private toggleCallback;
+    private openCallback;
+    private identifyCallback;
+    private configCallback;
+    setCallbacks(callbacks: {
+        show: () => void;
+        hide: () => void;
+        toggle: () => void;
+        open: () => void;
+        identify: (info: VisitorInfo) => void;
+        config: (opts: Partial<WidgetConfig>) => void;
+    }): void;
+    show(): void;
+    hide(): void;
+    toggle(): void;
+    open(): void;
+    identify(info: VisitorInfo): void;
+    config(opts: Partial<WidgetConfig>): void;
+    on<K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]): void;
+    off<K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]): void;
+    emit<K extends keyof SDKEventMap>(event: K, ...args: Parameters<SDKEventMap[K]>): void;
+}
+
+type TchaoInitConfig = {
+    websiteId: string;
+    host?: string;
+};
+
+type TchaoConfig = TchaoInitConfig;
+type TchaoInstance = SDKMethods & {
+    destroy: () => void;
+};
+type TchaoEvents = SDKEventMap;
+
+declare function init(config: TchaoConfig): Promise<TchaoInstance>;
+declare const Tchao: {
+    init: typeof init;
+};
+
+export { type ConversationStatus, type Message, type MessageReaction, type MessageStatus, type SenderType, Tchao, type TchaoConfig, type TchaoEvents, type TchaoInstance, TchaoSDK, type ThemeMode, type VisitorInfo, type WidgetConfig, type WidgetPosition, type WidgetStyle, Tchao as default, init };

package/dist/npm.d.ts

@@ -0,0 +1,97 @@
+type SenderType = "VISITOR" | "AGENT" | "AI" | "SYSTEM";
+type ConversationStatus = "OPEN" | "IN_PROGRESS" | "CLOSED";
+type MessageStatus = "sending" | "sent" | "failed";
+type WidgetPosition = "bottom-right" | "bottom-left";
+type WidgetStyle = "bubble" | "name_line" | "question_cta";
+type ThemeMode = "light" | "dark" | "system";
+type VisitorInfo = {
+    name?: string;
+    email?: string;
+    avatar?: string;
+    metadata?: Record<string, unknown>;
+};
+type MessageReaction = {
+    emoji: string;
+    userIds: string[];
+};
+type Message = {
+    id: string;
+    content: string;
+    senderType: SenderType;
+    senderId: string;
+    screenshot?: string | null;
+    image?: string | null;
+    timestamp: number;
+    status?: MessageStatus;
+    reactions?: MessageReaction[] | null;
+};
+type WidgetConfig = {
+    websiteId: string;
+    apiBaseUrl: string;
+    convexUrl?: string;
+    position?: WidgetPosition;
+    primaryColor?: string;
+    widgetStyle?: WidgetStyle;
+    themeMode?: ThemeMode;
+};
+type SDKEventMap = {
+    message: (message: Message) => void;
+    open: () => void;
+    close: () => void;
+    ready: () => void;
+};
+type SDKMethods = {
+    show: () => void;
+    hide: () => void;
+    toggle: () => void;
+    open: () => void;
+    identify: (info: VisitorInfo) => void;
+    config: (opts: Partial<WidgetConfig>) => void;
+    on: <K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]) => void;
+    off: <K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]) => void;
+};
+
+declare class TchaoSDK implements SDKMethods {
+    private readonly listeners;
+    private showCallback;
+    private hideCallback;
+    private toggleCallback;
+    private openCallback;
+    private identifyCallback;
+    private configCallback;
+    setCallbacks(callbacks: {
+        show: () => void;
+        hide: () => void;
+        toggle: () => void;
+        open: () => void;
+        identify: (info: VisitorInfo) => void;
+        config: (opts: Partial<WidgetConfig>) => void;
+    }): void;
+    show(): void;
+    hide(): void;
+    toggle(): void;
+    open(): void;
+    identify(info: VisitorInfo): void;
+    config(opts: Partial<WidgetConfig>): void;
+    on<K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]): void;
+    off<K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]): void;
+    emit<K extends keyof SDKEventMap>(event: K, ...args: Parameters<SDKEventMap[K]>): void;
+}
+
+type TchaoInitConfig = {
+    websiteId: string;
+    host?: string;
+};
+
+type TchaoConfig = TchaoInitConfig;
+type TchaoInstance = SDKMethods & {
+    destroy: () => void;
+};
+type TchaoEvents = SDKEventMap;
+
+declare function init(config: TchaoConfig): Promise<TchaoInstance>;
+declare const Tchao: {
+    init: typeof init;
+};
+
+export { type ConversationStatus, type Message, type MessageReaction, type MessageStatus, type SenderType, Tchao, type TchaoConfig, type TchaoEvents, type TchaoInstance, TchaoSDK, type ThemeMode, type VisitorInfo, type WidgetConfig, type WidgetPosition, type WidgetStyle, Tchao as default, init };