@askly/widget 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 StrontiumTechnologies
+
+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

@@ -0,0 +1,132 @@
+# Askly Widget SDK
+
+Embeddable AI support chat widget with voice capabilities, RAG integration, and customizable themes.
+
+## Installation
+
+### NPM
+```bash
+npm install @askly/widget
+```
+
+### CDN
+Include the UMD build directly in your HTML:
+```html
+<!-- React Dependencies -->
+<script crossorigin src="https://unpkg.com/react@18/umd/react.production.min.js"></script>
+<script crossorigin src="https://unpkg.com/react-dom@18/umd/react-dom.production.min.js"></script>
+
+<!-- Askly SDK -->
+<script src="https://unpkg.com/@askly/widget@latest/dist/index.umd.js"></script>
+```
+
+## Quick Start
+
+Initialize the widget in your application:
+
+```javascript
+import Askly from '@askly/widget';
+
+Askly.init({
+  orgId: "your-org-id",
+  orgServerRoute: "https://your-backend.com/api/chat",
+  organizationName: "Support",
+  themeColor: "#0f172a"
+});
+```
+
+For CDN initialization:
+```html
+<script>
+  Askly.init({
+    orgId: "your-org-id",
+    orgServerRoute: "https://your-backend.com/api/chat",
+    organizationName: "Support"
+  });
+</script>
+```
+
+Alternatively, initialize automatically via script data attributes:
+```html
+<script 
+  src="https://unpkg.com/@askly/widget@latest/dist/index.umd.js"
+  data-org-id="your-org-id"
+  data-org-server-route="https://your-backend.com/api/chat"
+  data-org-name="Support"
+></script>
+```
+
+## Configuration
+
+The `Askly.init()` method accepts an object with the following configuration options:
+
+| Option | Type | Required | Default | Description |
+| :--- | :--- | :--- | :--- | :--- |
+| `orgId` | `string` | Yes | - | Your organization ID. |
+| `orgServerRoute` | `string` | Yes | - | Backend API gateway endpoint. |
+| `organizationName` | `string` | No | `"Askly"` | Name displayed in the header. |
+| `themeColor` | `string` | No | `"#0f172a"` | Theme color (Slate 900). |
+| `organizationLogo` | `string` | No | - | URL of the logo image. |
+| `position` | `"left" \| "right"` | No | `"right"` | Screen placement. |
+| `welcomeMessage` | `string` | No | `"Hi! How can I help you today?"` | Initial greeting message. |
+| `placeholderText` | `string` | No | `"Type your message..."` | Input placeholder. |
+| `enableVoiceChat` | `boolean` | No | `false` | Enable Web Speech input/output. |
+| `showTimestamp` | `boolean` | No | `false` | Display timestamps in chat. |
+| `soundEnabled` | `boolean` | No | `false` | Play synthesized audio alerts. |
+| `soundVolume` | `number` | No | `0.4` | Sound volume (0.0 to 1.0). |
+| `autoOpen` | `boolean` | No | `false` | Open chat on page load. |
+| `poweredBy` | `string` | No | `"Team Askly"` | Branding attribution. |
+| `userId` | `string` | No | - | Authenticated user ID. |
+| `timestamp` | `number` | No | - | Request signature timestamp. |
+| `signature` | `string` | No | - | HMAC request signature. |
+| `turnstileSiteKey` | `string` | No | - | Cloudflare Turnstile key. |
+| `excludePaths` | `string[]` | No | `[]` | URL path prefixes to exclude widget. |
+
+## Lifecycle Callbacks
+
+Attach listeners to widget events:
+
+```javascript
+Askly.init({
+  orgId: "your-org-id",
+  orgServerRoute: "https://your-backend.com/api/chat",
+  onMessageSent: (message) => console.log("Sent:", message),
+  onMessageReceived: (reply) => console.log("Received:", reply),
+  onChatOpened: () => console.log("Opened"),
+  onChatClosed: () => console.log("Closed"),
+  onEscalation: (data) => console.log("Escalated to agent:", data)
+});
+```
+
+## Backend Integration
+
+Your `orgServerRoute` endpoint must accept a `POST` request with the following JSON body:
+
+```json
+{
+  "message": "User's message",
+  "orgId": "your-org-id"
+}
+```
+
+The response must return the reply:
+
+```json
+{
+  "reply": "Agent response text"
+}
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Compile production bundles
+npm run build
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+export interface AsklyConfig {
+    orgId: string;
+    orgServerRoute: string;
+    organizationName?: string;
+    position?: "left" | "right";
+    themeColor?: string;
+    enableVoiceChat?: boolean;
+    welcomeMessage?: string;
+    placeholderText?: string;
+    organizationLogo?: string;
+    buttonIcon?: string;
+    autoOpen?: boolean;
+    showTimestamp?: boolean;
+    soundEnabled?: boolean;
+    soundVolume?: number;
+    poweredBy?: string;
+    userId?: string;
+    timestamp?: number;
+    signature?: string;
+    turnstileSiteKey?: string;
+    excludePaths?: string[];
+    onMessageSent?: (message: string) => void;
+    onMessageReceived?: (reply: string) => void;
+    onChatOpened?: () => void;
+    onChatClosed?: () => void;
+    onEscalation?: (data: any) => void;
+}
+declare const Askly: {
+    init: (config: AsklyConfig) => void;
+};
+export default Askly;