@cognitiondesk/widget 1.2.1 → 1.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lucilo del Castillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS 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.

package/README.md

@@ -1,269 +1,2 @@
-# @cognitiondesk/widget
+# cognitiondesk_npm_package
 
-Embed a CognitionDesk AI chat widget into any website with a single API key.  
-Supports React, Vue, plain HTML, WordPress, and Shopify — no build step required for script-tag usage.
-
-## Installation
-
-```bash
-npm install @cognitiondesk/widget
-```
-
----
-
-## Quick start
-
-### React — minimal (recommended)
-
-```jsx
-import { CognitionDeskWidget } from '@cognitiondesk/widget/react';
-
-export default function App() {
-  return (
-    <>
-      <YourApp />
-      {/* Loads all config from the platform using widgetId */}
-      <CognitionDeskWidget
-        apiKey="YOUR_API_KEY"
-        widgetId="YOUR_WIDGET_ID"
-      />
-    </>
-  );
-}
-```
-
-### React — full inline config
-
-```jsx
-import { CognitionDeskWidget } from '@cognitiondesk/widget/react';
-
-export default function App() {
-  return (
-    <>
-      <YourApp />
-      <CognitionDeskWidget
-        apiKey="YOUR_API_KEY"
-        assistantId="YOUR_ASSISTANT_ID"
-        theme="light"
-        primaryColor="#2563eb"
-        botName="Support Bot"
-        botEmoji="🤖"
-        welcomeMessage="Hi! How can I help?"
-        placeholder="Type a message…"
-        defaultOpen={false}
-        streaming={true}
-        onOpen={() => console.log('chat opened')}
-        onClose={() => console.log('chat closed')}
-      />
-    </>
-  );
-}
-```
-
-### React — programmatic control via ref
-
-```jsx
-import { useRef } from 'react';
-import { CognitionDeskWidget } from '@cognitiondesk/widget/react';
-
-export default function App() {
-  const widgetRef = useRef(null);
-
-  return (
-    <>
-      <button onClick={() => widgetRef.current?.open()}>Open chat</button>
-      <CognitionDeskWidget
-        ref={widgetRef}
-        apiKey="YOUR_API_KEY"
-        widgetId="YOUR_WIDGET_ID"
-      />
-    </>
-  );
-}
-```
-
-### Vanilla JS
-
-```js
-import CognitionDeskWidget from '@cognitiondesk/widget';
-
-const widget = new CognitionDeskWidget({
-  apiKey:   'YOUR_API_KEY',
-  widgetId: 'YOUR_WIDGET_ID',  // fetches full config from platform
-});
-
-await widget.mount();          // async when widgetId is set
-```
-
-### Script tag / CDN (no build step)
-
-```html
-<!-- Minimal — loads config from the platform -->
-<script
-  src="https://cdn.jsdelivr.net/npm/@cognitiondesk/widget/dist/widget.umd.cjs"
-  data-api-key="YOUR_API_KEY"
-  data-widget-id="YOUR_WIDGET_ID">
-</script>
-```
-
-```html
-<!-- Full inline config -->
-<script
-  src="https://cdn.jsdelivr.net/npm/@cognitiondesk/widget/dist/widget.umd.cjs"
-  data-api-key="YOUR_API_KEY"
-  data-assistant-id="YOUR_ASSISTANT_ID"
-  data-theme="light"
-  data-primary-color="#2563eb"
-  data-bot-name="Support Bot"
-  data-bot-emoji="🤖"
-  data-welcome-message="Hi! How can I help?"
-  data-placeholder="Type a message…"
-  data-streaming="true">
-</script>
-```
-
----
-
-## Authentication
-
-Every request is authenticated with an **API key** passed via the `apiKey` prop (or `data-api-key` attribute for script-tag usage).
-
-Generate and manage API keys in your [CognitionDesk dashboard](https://app.cognitiondesk.com) under **Settings → API Keys**.
-
-Each API key:
-- Authenticates widget requests to the AI backend
-- Tracks usage against your plan quotas
-- Associates conversations with your account
-
----
-
-## Configuration options
-
-### Core props
-
-| Prop / Attribute | Type | Default | Description |
-|---|---|---|---|
-| `apiKey` / `data-api-key` | `string` | **required** | Your CognitionDesk API key |
-| `widgetId` / `data-widget-id` | `string` | `undefined` | Widget ID from the platform — fetches full config automatically |
-| `assistantId` / `data-assistant-id` | `string` | `undefined` | Use a specific assistant (falls back to account default) |
-| `theme` / `data-theme` | `'light'│'dark'│'auto'` | `'light'` | Color scheme |
-| `primaryColor` / `data-primary-color` | `string` | `'#2563eb'` | Brand accent color (any CSS color) |
-| `botName` / `data-bot-name` | `string` | `'AI Assistant'` | Name shown in the widget header |
-| `botEmoji` / `data-bot-emoji` | `string` | `'🤖'` | Avatar emoji |
-| `welcomeMessage` / `data-welcome-message` | `string` | `'Hello! How can I help you today?'` | First message shown to the user |
-| `placeholder` / `data-placeholder` | `string` | `'Type a message…'` | Input placeholder text |
-| `streaming` / `data-streaming` | `boolean` | `true` | Enable streaming (SSE) responses |
-| `defaultOpen` | `boolean` | `false` | Open widget on load *(React only)* |
-| `backendUrl` / `data-backend-url` | `string` | auto | Override backend URL (self-hosted setups) |
-
-### Rate limiting props
-
-Control how many messages a single visitor can send to prevent abuse and excessive API usage.  
-Limits are enforced **both client-side** (instant feedback) and **server-side** (can't be bypassed).
-
-| Prop | Type | Default | Description |
-|---|---|---|---|
-| `maxMessagesPerSession` | `number` | `0` | Max total messages per visitor session. `0` = unlimited |
-| `maxMessagesPerMinute` | `number` | `0` | Max messages per minute per visitor. `0` = unlimited |
-| `limitReachedMessage` | `string` | `"You've reached the message limit for this session."` | Message shown when session limit is hit |
-| `rateLimitMessage` | `string` | `"You're sending messages too quickly. Please wait a moment."` | Message shown when per-minute limit is hit |
-
-> **Note:** When using `widgetId`, rate limit settings are fetched from the platform and override any props you pass here. Configure them in the **Web Widget creator** on the platform dashboard.
-
-#### Example — React
-
-```jsx
-<CognitionDeskWidget
-  apiKey="YOUR_API_KEY"
-  assistantId="YOUR_ASSISTANT_ID"
-  maxMessagesPerSession={50}
-  maxMessagesPerMinute={10}
-  limitReachedMessage="You've used all your messages for this session."
-  rateLimitMessage="Slow down — please wait a few seconds."
-/>
-```
-
-#### Example — Vanilla JS
-
-```js
-const widget = new CognitionDeskWidget({
-  apiKey:      'YOUR_API_KEY',
-  assistantId: 'YOUR_ASSISTANT_ID',
-  rateLimiting: {
-    enabled:               true,
-    maxMessagesPerSession: 50,
-    maxMessagesPerMinute:  10,
-    limitReachedMessage:   "You've used all your messages for this session.",
-    rateLimitMessage:      "Slow down — please wait a few seconds.",
-  },
-});
-widget.mount();
-```
-
-### Callbacks *(React only)*
-
-| Prop | Type | Description |
-|---|---|---|
-| `onOpen` | `() => void` | Called when the chat panel opens |
-| `onClose` | `() => void` | Called when the chat panel closes |
-
----
-
-## Widget methods
-
-Available on the class instance (vanilla JS) or via `ref` (React).
-
-```js
-widget.mount(el?)      // Mount to DOM — pass an element or defaults to document.body
-                       // Returns a Promise when widgetId is set (async config fetch)
-widget.open()          // Open the chat panel
-widget.close()         // Close the chat panel
-widget.toggle()        // Toggle open/closed
-widget.clearHistory()  // Reset the conversation
-widget.unmount()       // Remove from DOM and clean up
-```
-
-### React ref example
-
-```jsx
-const ref = useRef(null);
-// ...
-<CognitionDeskWidget ref={ref} apiKey="..." widgetId="..." />
-
-// Later:
-ref.current?.open();
-ref.current?.clearHistory();
-```
-
----
-
-## CDN data-attribute reference
-
-All configuration options are available as `data-*` attributes for script-tag usage:
-
-| Attribute | Description |
-|---|---|
-| `data-api-key` | **Required.** Your API key |
-| `data-widget-id` | Widget ID (loads config from platform) |
-| `data-assistant-id` | Direct assistant ID |
-| `data-theme` | `"light"`, `"dark"`, or `"auto"` |
-| `data-primary-color` | Hex color, e.g. `"#2563eb"` |
-| `data-bot-name` | Display name |
-| `data-bot-emoji` | Avatar emoji |
-| `data-welcome-message` | Opening message |
-| `data-placeholder` | Input placeholder |
-| `data-streaming` | `"true"` or `"false"` |
-| `data-backend-url` | Override API base URL |
-
----
-
-## Platform integrations
-
-Full installation guides for React, Vue, WordPress, and Shopify are available in the  
-[CognitionDesk documentation](https://docs.cognitiondesk.com/docs/web-widget).
-
----
-
-## License
-
-MIT