@qarakash/blockwriteai 1.0.21 → 1.1.0

package/README.md

@@ -1,256 +1,256 @@
-# BlockWriteAI
-
-BlockWriteAI is a JSON-first block editor for web apps. It works with a script tag, npm, PHP/Composer, and Python static-file workflows.
-
-Use the free core editor for normal documents. Serve premium tools such as AI, Mermaid, Drawing, Signature, and Signature Flow only through your licensed server endpoint.
-
-## Quick Start With CDN
-
-Add the stylesheet, editor script, and free plugin bundle:
-
-```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/blockwriteai.min.css">
-
-<div id="editor"></div>
-
-<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/blockwriteai.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/plugins/blockwriteai-code-assist.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/plugins/blockwriteai-advanced-blocks.min.js"></script>
-<script>
-  const editor = new BlockWriteAI({
-    holder: "#editor",
-    placeholder: "Write something, or press / for blocks",
-    async onSave(data) {
-      await fetch("/api/documents", {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify(data)
-      });
-    }
-  });
-</script>
-```
-
-Use these CDN URLs for production:
-
-```text
-https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/blockwriteai.min.css
-https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/blockwriteai.min.js
-https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/plugins/blockwriteai-code-assist.min.js
-https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/plugins/blockwriteai-advanced-blocks.min.js
-```
-
-Optional history plugin:
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.21/dist/plugins/blockwriteai-history.min.js"></script>
-```
-
-Premium CDN integrations should load licensed plugins and verify usage through the production BlockWriteAI Platform:
-
-```js
-await BlockWriteAI.loadPremiumPlugins({
-  licenseKey: "bwai_live_xxxxx",
-  endpoint: BlockWriteAI.platformEndpoints.premiumPlugins,
-  features: ["drawing", "mermaid", "signature", "signature_flow", "ai"]
-});
-```
-
-## Install With Node
-
-```bash
-npm install @qarakash/blockwriteai
-```
-
-```js
-import BlockWriteAI from "@qarakash/blockwriteai";
-import "@qarakash/blockwriteai/css";
-import "@qarakash/blockwriteai/plugins/code-assist/min";
-import "@qarakash/blockwriteai/plugins/advanced/min";
-
-const editor = new BlockWriteAI({
-  holder: "#editor",
-  premium: {
-    licenseKey: "bwai_live_xxxxx",
-    verifyEndpoint: BlockWriteAI.platformEndpoints.licenseVerify,
-    usageEndpoint: BlockWriteAI.platformEndpoints.aiUsage,
-    featureUsageEndpoint: BlockWriteAI.platformEndpoints.premiumUsage,
-    eventEndpoint: BlockWriteAI.platformEndpoints.premiumEvent,
-    signatureEventEndpoint: BlockWriteAI.platformEndpoints.signatureEvent
-  },
-  async onSave(data) {
-    await fetch("/api/documents", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify(data)
-    });
-  }
-});
-```
-
-## Install With PHP
-
-```bash
-composer require qarakash/blockwriteai
-```
-
-Publish the package `dist` assets into a public asset directory in your app, then print the tags:
-
-```php
-<?php
-
-use QarAkash\BlockWriteAI\BlockWriteAIAssets;
-
-echo BlockWriteAIAssets::stylesheetTag('/assets/blockwriteai');
-echo BlockWriteAIAssets::scriptTags('/assets/blockwriteai');
-
-$platform = BlockWriteAIAssets::platformEndpoints();
-```
-
-Create the editor:
-
-```html
-<div id="editor"></div>
-<script>
-  const editor = new BlockWriteAI({
-    holder: "#editor",
-    async onSave(data) {
-      await fetch("/api/documents/save.php", {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify(data)
-      });
-    }
-  });
-</script>
-```
-
-## Install With Python
-
-```bash
-pip install blockwriteai-editor
-```
-
-Copy the packaged assets into your app static directory:
-
-```python
-from blockwriteai_editor import copy_static
-
-copy_static("static/blockwriteai")
-```
-
-Generate tags in Flask, Django, or any Python web app:
-
-```python
-from blockwriteai_editor import platform_endpoints, stylesheet_tag, script_tags
-
-print(stylesheet_tag("/static/blockwriteai"))
-print(script_tags("/static/blockwriteai"))
-
-platform = platform_endpoints()
-```
-
-Then mount the editor in your template:
-
-```html
-<div id="editor"></div>
-<script>
-  const editor = new BlockWriteAI({
-    holder: "#editor",
-    async onSave(data) {
-      await fetch("/api/documents", {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify(data)
-      });
-    }
-  });
-</script>
-```
-
-## Read Saved Documents
-
-BlockWriteAI saves JSON. Store that JSON in your database, then render it later with a preview container:
-
-```html
-<link rel="stylesheet" href="/assets/blockwriteai/blockwriteai.min.css">
-
-<div class="blockwriteai-preview" data-source="/api/documents/123.json"></div>
-
-<script src="/assets/blockwriteai/blockwriteai.min.js"></script>
-<script src="/assets/blockwriteai/plugins/blockwriteai-advanced-blocks.min.js"></script>
-<script>
-  BlockWriteAI.mountPreviews();
-</script>
-```
-
-The JSON endpoint can return a document directly:
-
-```json
-{
-  "time": 1779540000000,
-  "version": "1.0.21",
-  "blocks": []
-}
-```
-
-It can also return a wrapper:
-
-```json
-{
-  "ok": true,
-  "data": {
-    "time": 1779540000000,
-    "version": "1.0.21",
-    "blocks": []
-  }
-}
-```
-
-## Premium Plugins
-
-Do not expose premium plugin files as normal public scripts. Load them after your server verifies an active license:
-
-```html
-<script>
-  async function bootEditor() {
-    await BlockWriteAI.loadPremiumPlugins({
-      licenseKey: "bwai_live_xxxxx",
-      endpoint: "https://blockwriteai.in/api/premium_plugins.php",
-      features: ["drawing", "mermaid", "signature", "signature_flow", "ai"]
-    });
-
-    window.editor = new BlockWriteAI({
-      holder: "#editor",
-      premium: {
-        licenseKey: "bwai_live_xxxxx",
-        verifyEndpoint: "https://blockwriteai.in/api/license_verify.php",
-        usageEndpoint: "https://blockwriteai.in/api/ai_usage.php"
-      },
-      ai: {
-        endpoint: "https://blockwriteai.in/api/ai_generate.php"
-      }
-    });
-  }
-
-  bootEditor();
-</script>
-```
-
-The browser plugin must never receive private API keys. Keep OpenAI, billing, usage limits, and license checks on your server.
-
-## Release Checklist
-
-1. Run `npm run build:min`.
-2. Run `npm run check`.
-3. Publish `@qarakash/blockwriteai` to npm.
-4. Publish `qarakash/blockwriteai` to Packagist.
-5. Publish `blockwriteai-editor` to PyPI.
-6. Serve only the public asset directory from your application.
-
-## Notes For Production
-
-- Use the `.min.css` and `.min.js` files in public pages.
-- Do not publish source folders, examples, build artifacts, package caches, or private configuration files.
-- Browser-delivered CSS and JavaScript can always be downloaded. Protect paid features with server-side license checks and metered premium bundle delivery.
-- Keep secret keys in backend environment variables only.
+# BlockWriteAI
+
+BlockWriteAI is a JSON-first block editor for web apps. It works with a script tag, npm, PHP/Composer, and Python static-file workflows.
+
+Use the free core editor for normal documents. Serve premium tools such as AI, Mermaid, Drawing, Signature, and Signature Flow only through your licensed server endpoint.
+
+## Quick Start With CDN
+
+Add the stylesheet, editor script, and free plugin bundle:
+
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/blockwriteai.min.css">
+
+<div id="editor"></div>
+
+<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/blockwriteai.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/plugins/blockwriteai-code-assist.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/plugins/blockwriteai-advanced-blocks.min.js"></script>
+<script>
+  const editor = new BlockWriteAI({
+    holder: "#editor",
+    placeholder: "Write something, or press / for blocks",
+    async onSave(data) {
+      await fetch("/api/documents", {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(data)
+      });
+    }
+  });
+</script>
+```
+
+Use these CDN URLs for production:
+
+```text
+https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/blockwriteai.min.css
+https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/blockwriteai.min.js
+https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/plugins/blockwriteai-code-assist.min.js
+https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/plugins/blockwriteai-advanced-blocks.min.js
+```
+
+Optional history plugin:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.1.0/dist/plugins/blockwriteai-history.min.js"></script>
+```
+
+Premium CDN integrations should load licensed plugins and verify usage through the production BlockWriteAI Platform:
+
+```js
+await BlockWriteAI.loadPremiumPlugins({
+  licenseKey: "bwai_live_xxxxx",
+  endpoint: BlockWriteAI.platformEndpoints.premiumPlugins,
+  features: ["drawing", "mermaid", "signature", "signature_flow", "ai"]
+});
+```
+
+## Install With Node
+
+```bash
+npm install @qarakash/blockwriteai
+```
+
+```js
+import BlockWriteAI from "@qarakash/blockwriteai";
+import "@qarakash/blockwriteai/css";
+import "@qarakash/blockwriteai/plugins/code-assist/min";
+import "@qarakash/blockwriteai/plugins/advanced/min";
+
+const editor = new BlockWriteAI({
+  holder: "#editor",
+  premium: {
+    licenseKey: "bwai_live_xxxxx",
+    verifyEndpoint: BlockWriteAI.platformEndpoints.licenseVerify,
+    usageEndpoint: BlockWriteAI.platformEndpoints.aiUsage,
+    featureUsageEndpoint: BlockWriteAI.platformEndpoints.premiumUsage,
+    eventEndpoint: BlockWriteAI.platformEndpoints.premiumEvent,
+    signatureEventEndpoint: BlockWriteAI.platformEndpoints.signatureEvent
+  },
+  async onSave(data) {
+    await fetch("/api/documents", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(data)
+    });
+  }
+});
+```
+
+## Install With PHP
+
+```bash
+composer require qarakash/blockwriteai
+```
+
+Publish the package `dist` assets into a public asset directory in your app, then print the tags:
+
+```php
+<?php
+
+use QarAkash\BlockWriteAI\BlockWriteAIAssets;
+
+echo BlockWriteAIAssets::stylesheetTag('/assets/blockwriteai');
+echo BlockWriteAIAssets::scriptTags('/assets/blockwriteai');
+
+$platform = BlockWriteAIAssets::platformEndpoints();
+```
+
+Create the editor:
+
+```html
+<div id="editor"></div>
+<script>
+  const editor = new BlockWriteAI({
+    holder: "#editor",
+    async onSave(data) {
+      await fetch("/api/documents/save.php", {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(data)
+      });
+    }
+  });
+</script>
+```
+
+## Install With Python
+
+```bash
+pip install blockwriteai-editor
+```
+
+Copy the packaged assets into your app static directory:
+
+```python
+from blockwriteai_editor import copy_static
+
+copy_static("static/blockwriteai")
+```
+
+Generate tags in Flask, Django, or any Python web app:
+
+```python
+from blockwriteai_editor import platform_endpoints, stylesheet_tag, script_tags
+
+print(stylesheet_tag("/static/blockwriteai"))
+print(script_tags("/static/blockwriteai"))
+
+platform = platform_endpoints()
+```
+
+Then mount the editor in your template:
+
+```html
+<div id="editor"></div>
+<script>
+  const editor = new BlockWriteAI({
+    holder: "#editor",
+    async onSave(data) {
+      await fetch("/api/documents", {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(data)
+      });
+    }
+  });
+</script>
+```
+
+## Read Saved Documents
+
+BlockWriteAI saves JSON. Store that JSON in your database, then render it later with a preview container:
+
+```html
+<link rel="stylesheet" href="/assets/blockwriteai/blockwriteai.min.css">
+
+<div class="blockwriteai-preview" data-source="/api/documents/123.json"></div>
+
+<script src="/assets/blockwriteai/blockwriteai.min.js"></script>
+<script src="/assets/blockwriteai/plugins/blockwriteai-advanced-blocks.min.js"></script>
+<script>
+  BlockWriteAI.mountPreviews();
+</script>
+```
+
+The JSON endpoint can return a document directly:
+
+```json
+{
+  "time": 1779540000000,
+  "version": "1.1.0",
+  "blocks": []
+}
+```
+
+It can also return a wrapper:
+
+```json
+{
+  "ok": true,
+  "data": {
+    "time": 1779540000000,
+    "version": "1.1.0",
+    "blocks": []
+  }
+}
+```
+
+## Premium Plugins
+
+Do not expose premium plugin files as normal public scripts. Load them after your server verifies an active license:
+
+```html
+<script>
+  async function bootEditor() {
+    await BlockWriteAI.loadPremiumPlugins({
+      licenseKey: "bwai_live_xxxxx",
+      endpoint: "https://blockwriteai.in/api/premium_plugins.php",
+      features: ["drawing", "mermaid", "signature", "signature_flow", "ai"]
+    });
+
+    window.editor = new BlockWriteAI({
+      holder: "#editor",
+      premium: {
+        licenseKey: "bwai_live_xxxxx",
+        verifyEndpoint: "https://blockwriteai.in/api/license_verify.php",
+        usageEndpoint: "https://blockwriteai.in/api/ai_usage.php"
+      },
+      ai: {
+        endpoint: "https://blockwriteai.in/api/ai_generate.php"
+      }
+    });
+  }
+
+  bootEditor();
+</script>
+```
+
+The browser plugin must never receive private API keys. Keep OpenAI, billing, usage limits, and license checks on your server.
+
+## Release Checklist
+
+1. Run `npm run build:min`.
+2. Run `npm run check`.
+3. Publish `@qarakash/blockwriteai` to npm.
+4. Publish `qarakash/blockwriteai` to Packagist.
+5. Publish `blockwriteai-editor` to PyPI.
+6. Serve only the public asset directory from your application.
+
+## Notes For Production
+
+- Use the `.min.css` and `.min.js` files in public pages.
+- Do not publish source folders, examples, build artifacts, package caches, or private configuration files.
+- Browser-delivered CSS and JavaScript can always be downloaded. Protect paid features with server-side license checks and metered premium bundle delivery.
+- Keep secret keys in backend environment variables only.