@courseecho/ai-core-sdk 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2026 CourseEcho
+
+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.
+
+---
+
+For more information about CourseEcho, visit https://courseecho.com

package/README.md

@@ -0,0 +1,263 @@
+# 🤖 @courseecho/ai-core-sdk
+
+**Framework-agnostic core AI chat SDK** - The foundation for all CourseEcho AI widgets.
+
+[![npm version](https://img.shields.io/npm/v/@courseecho/ai-core-sdk.svg)](https://www.npmjs.com/package/@courseecho/ai-core-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## 📖 Overview
+
+This is the **core SDK** that powers all CourseEcho AI widgets. It handles:
+- 🔄 State management (chat messages, context, charts)
+- 🌐 HTTP communication with your AI backend
+- 🔐 Authentication (JWT tokens, API keys)
+- 📊 Data transformation and validation
+
+**Perfect for:** React, Vue, Angular, Node.js, jQuery - build your own integrations!
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+npm install @courseecho/ai-core-sdk
+```
+
+### Basic Usage
+
+```typescript
+import { AiWidgetSDK } from '@courseecho/ai-core-sdk';
+
+const sdk = new AiWidgetSDK({
+  apiEndpoint: 'https://api.courseecho.com/api',
+  context: {
+    pageType: 'course',
+    entityId: 'course-123',
+    userId: 'user-456'
+  },
+  jwtToken: 'your-jwt-token'
+});
+
+// Send a message
+const response = await sdk.sendQuery('What is this course about?');
+console.log(response.answer);
+
+// Listen to state changes
+sdk.onStateChange((state) => {
+  console.log('Messages:', state.messages);
+  console.log('Loading:', state.loading);
+});
+```
+
+## 📦 What's Included
+
+```
+dist/
+├── index.mjs          # ES Module (modern)
+├── index.cjs          # CommonJS (Node.js)
+├── index.d.ts         # TypeScript definitions
+└── ...
+```
+
+## 🎯 Use Cases
+
+### 1. React App
+```bash
+npm install @courseecho/ai-widget-react @courseecho/ai-core-sdk
+```
+
+### 2. Vue 3 App
+```bash
+npm install @courseecho/ai-widget-vue @courseecho/ai-core-sdk
+```
+
+### 3. Angular 19+ App
+```bash
+npm install @courseecho/ai-widget-angular @courseecho/ai-core-sdk
+```
+
+### 4. Custom Implementation
+```typescript
+import { AiWidgetSDK, ChatMessage, ContextData } from '@courseecho/ai-core-sdk';
+
+// Build your own UI with the core SDK
+const sdk = new AiWidgetSDK({ /* config */ });
+```
+
+## 🔌 API Reference
+
+### Constructor Options
+
+```typescript
+interface AiWidgetConfig {
+  apiEndpoint: string;           // Your API server URL
+  context: ContextData;          // Page/entity context
+  jwtToken?: string;             // Optional JWT token
+  apiKey?: string;               // Optional API key
+  theme?: 'light' | 'dark';      // UI theme
+}
+
+interface ContextData {
+  pageType: string;              // e.g., 'course', 'lesson'
+  entityId?: string;             // e.g., 'course-123'
+  userId?: string;               // User identifier
+  customData?: Record<string, any>;
+}
+```
+
+### Methods
+
+```typescript
+// Send a query
+await sdk.sendQuery(message: string, context?: ContextData): Promise<ChatResponse>
+
+// Send batch queries
+await sdk.sendBatchQueries(messages: string[]): Promise<ChatResponse[]>
+
+// Get current state
+const state = sdk.getState(): AiWidgetState
+
+// Update context
+sdk.setContext(context: ContextData): void
+
+// Listen to changes
+sdk.onStateChange(callback: (state: AiWidgetState) => void): void
+
+// Clear history
+sdk.clearHistory(): void
+
+// Destroy SDK
+sdk.destroy(): void
+```
+
+## 📊 State Management
+
+```typescript
+interface AiWidgetState {
+  messages: ChatMessage[];       // All messages
+  loading: boolean;              // Is loading?
+  error: string | null;          // Error message
+  context: ContextData;          // Current context
+  charts: ChartData[];           // Data visualizations
+}
+
+interface ChatMessage {
+  id: string;
+  content: string;
+  role: 'user' | 'assistant';
+  timestamp: Date;
+  metadata?: Record<string, any>;
+}
+```
+
+## 🔐 Authentication
+
+### JWT Token
+```typescript
+const sdk = new AiWidgetSDK({
+  apiEndpoint: 'https://api.example.com/api',
+  context: { pageType: 'course' },
+  jwtToken: 'eyJhbGciOiJIUzI1NiIs...'
+});
+```
+
+### API Key
+```typescript
+const sdk = new AiWidgetSDK({
+  apiEndpoint: 'https://api.example.com/api',
+  context: { pageType: 'course' },
+  apiKey: 'sk-123456789...'
+});
+```
+
+## 🎨 Framework Integrations
+
+| Framework | Package | Docs |
+|-----------|---------|------|
+| **React** | `@courseecho/ai-widget-react` | [React Docs](../ai-widget-react) |
+| **Vue** | `@courseecho/ai-widget-vue` | [Vue Docs](../ai-widget-vue) |
+| **Angular** | `@courseecho/ai-widget-angular` | [Angular Docs](../ai-widget-angular) |
+| **Node.js** | `@courseecho/ai-client-node` | [Node.js Docs](../ai-client-node) |
+| **jQuery** | `@courseecho/ai-widget-jquery` | [jQuery Docs](../ai-widget-jquery) |
+
+## 📚 Examples
+
+### Example 1: Custom Vue Composable
+```typescript
+import { AiWidgetSDK } from '@courseecho/ai-core-sdk';
+import { ref } from 'vue';
+
+export function useAiChat() {
+  const sdk = new AiWidgetSDK({
+    apiEndpoint: 'https://api.courseecho.com/api',
+    context: { pageType: 'course' }
+  });
+
+  const messages = ref([]);
+  const loading = ref(false);
+
+  sdk.onStateChange((state) => {
+    messages.value = state.messages;
+    loading.value = state.loading;
+  });
+
+  return {
+    messages,
+    loading,
+    sendMessage: (msg: string) => sdk.sendQuery(msg)
+  };
+}
+```
+
+### Example 2: Custom React Hook
+```typescript
+import { AiWidgetSDK } from '@courseecho/ai-core-sdk';
+import { useState, useEffect } from 'react';
+
+export function useAiChat() {
+  const [state, setState] = useState(null);
+
+  useEffect(() => {
+    const sdk = new AiWidgetSDK({
+      apiEndpoint: 'https://api.courseecho.com/api',
+      context: { pageType: 'course' }
+    });
+
+    sdk.onStateChange(setState);
+    return () => sdk.destroy();
+  }, []);
+
+  return state;
+}
+```
+
+## 🌍 About CourseEcho
+
+[CourseEcho](https://courseecho.com) is an AI-powered educational platform that provides intelligent tutoring and course assistance.
+
+- 🌐 Website: https://courseecho.com
+- 📧 Support: support@courseecho.com
+- 📱 Product: https://courseecho.com/products/ai-widget
+
+## 📄 License
+
+MIT © 2026 CourseEcho
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](../../CONTRIBUTING.md)
+
+## 📞 Support
+
+- 📖 Documentation: https://courseecho.com/docs
+- 🐛 Issues: [GitHub Issues](https://github.com/courseecho/ai-widget-sdk/issues)
+- 💬 Community: [Discord](https://discord.gg/courseecho)
+
+---
+
+**Other CourseEcho Packages:**
+- [@courseecho/ai-widget-react](../ai-widget-react)
+- [@courseecho/ai-widget-vue](../ai-widget-vue)
+- [@courseecho/ai-widget-angular](../ai-widget-angular)
+- [@courseecho/ai-widget-jquery](../ai-widget-jquery)
+- [@courseecho/ai-client-node](../ai-client-node)

package/package.json

@@ -1,39 +1,39 @@
 {
-  "name": "@courseecho/ai-core-sdk",
-  "version": "1.0.0",
-  "description": "Framework-agnostic core AI chat SDK. Shared logic for all framework wrappers.",
-  "license": "MIT",
-  "author": "CourseEcho",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "test": "jest",
-    "lint": "eslint src/**/*.ts"
-  },
-  "dependencies": {
-    "rxjs": "^7.8.0"
-  },
-  "devDependencies": {
-    "typescript": "^5.3.0",
-    "@types/node": "^20.0.0",
-    "jest": "^29.0.0",
-    "@types/jest": "^29.0.0",
-    "ts-jest": "^29.0.0",
-    "eslint": "^8.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.0.0"
-  }
+    "name":  "@courseecho/ai-core-sdk",
+    "version":  "1.0.2",
+    "description":  "Framework-agnostic core AI chat SDK. Shared logic for all framework wrappers.",
+    "license":  "MIT",
+    "author":  "CourseEcho",
+    "main":  "dist/index.cjs",
+    "module":  "dist/index.mjs",
+    "types":  "dist/index.d.ts",
+    "exports":  {
+                    ".":  {
+                              "import":  "./dist/index.mjs",
+                              "require":  "./dist/index.cjs",
+                              "types":  "./dist/index.d.ts"
+                          }
+                },
+    "files":  [
+                  "dist"
+              ],
+    "scripts":  {
+                    "build":  "tsc",
+                    "dev":  "tsc --watch",
+                    "test":  "jest",
+                    "lint":  "eslint src/**/*.ts"
+                },
+    "dependencies":  {
+                         "rxjs":  "^7.8.0"
+                     },
+    "devDependencies":  {
+                            "typescript":  "^5.3.0",
+                            "@types/node":  "^20.0.0",
+                            "jest":  "^29.0.0",
+                            "@types/jest":  "^29.0.0",
+                            "ts-jest":  "^29.0.0",
+                            "eslint":  "^8.0.0",
+                            "@typescript-eslint/parser":  "^6.0.0",
+                            "@typescript-eslint/eslint-plugin":  "^6.0.0"
+                        }
 }