hivewrite-sdk 1.1.4 → 1.1.6

package/README.md

@@ -28,7 +28,7 @@ npm install hivewrite-sdk
 
 ### Via CDN (Plain HTML/JS)
 ```html
-<script src="https://cdn.jsdelivr.net/npm/hivewrite-sdk/bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/hivewrite-sdk@latest/bundle.min.js"></script>
 ```
 
 ---
@@ -70,7 +70,7 @@ const MyEditor = () => {
 ```html
 <div id="editor-container" style="height: 100vh;"></div>
 
-<script src="https://cdn.jsdelivr.net/npm/hivewrite-sdk/bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/hivewrite-sdk@latest/bundle.min.js"></script>
 <script>
     hivewrite.init({
         apiKey: 'your-api-key',
@@ -101,6 +101,7 @@ Initializes and mounts the editor.
 | :--- | :--- | :--- | :--- |
 | `apiKey` | `string` | Yes | Your HiveWrite API Key |
 | `container` | `string \| HTMLElement` | Yes | CSS selector or DOM element to mount the editor |
+| `userId` | `string` | No | Unique identifier for the current user |
 | `mode` | `string` | Yes | `'FULL_EDITOR'`, `'DESIGN_ONLY'`, `'READ_ONLY'` |
 | `theme` | `string` | No | `'light'` (default) or `'dark'` |
 | `locale` | `string` | No | `'en'` (default), `'es'`, or `'fr'` |
@@ -218,9 +219,10 @@ mergeTags: [
 | Callback | Arguments | Description |
 | :--- | :--- | :--- |
 | `onLoad` | `()` | Editor fully initialized |
-| `onSave` | `(json: any)` | User saves or `saveDesign` called |
-| `onExport` | `(html: string)` | User exports or `exportHtml` called |
-| `onError` | `(err: any)` | Initialization or processing error |
+| `onSave` | `(json: any, userId?: string)` | User saves or `saveDesign` called |
+| `onExport` | `(html: string, userId?: string)` | User exports or `exportHtml` called |
+| `onError` | `(err: any, userId?: string)` | Initialization or processing error |
+| `onTemplateChange` | `(templateId: string, userId?: string)` | Template selection changed |
 | `onImageUpload` | `(file: File)` | **Async**. Handle image uploads, return URL |
 
 ### Image Upload Example
@@ -233,6 +235,32 @@ callbacks: {
     const data = await res.json();
     return data.url; // Return the uploaded image URL
   }
+  }
+}
+```
+
+### Response Examples
+
+#### `onSave(design, userId)`
+The `design` object contains the full state of the editor.
+
+```json
+{
+  "blocks": [ ... ],       // Array of block objects
+  "canvasSettings": { ... }, // Canvas styles (width, background, etc)
+  "templateName": "My Email Template",
+  "userId": "user_12345"   // The current user ID, If present
+}
+```
+
+#### `onExport(html, userId)`
+The `html` argument is a string containing the final generated HTML.
+
+```javascript
+// Example usage
+onExport: (html, userId) => {
+  console.log(`Exported for user ${userId}`);
+  saveToDatabase(html);
 }
 ```
 
@@ -272,6 +300,7 @@ Exported HTML is fully compatible with:
 | `saveTemplate({ name })` | Save as reusable template |
 | `importHTML({ html })` | Import HTML into editor (experimental) |
 | `setTheme(theme)` | Switch theme at runtime |
+| `setUserId(userId)` | Update user ID at runtime |
 | `destroy()` | Unmount and cleanup |
 
 ---
@@ -279,3 +308,7 @@ Exported HTML is fully compatible with:
 ## 📄 License
 
 MIT © [Babber Maven](https://github.com/babbermaven)
+
+<br/>
+
+Created & Maintained by [Shahzad Siddique](https://github.com/code-with-shahzad)