Static assets and helpers for the BlockWriteAI JSON-first editor with free core blocks and license-gated premium plugins.
Project description
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:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/blockwriteai.min.css">
<div id="editor"></div>
<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/blockwriteai.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/plugins/blockwriteai-code-assist.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/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:
https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/blockwriteai.min.css
https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/blockwriteai.min.js
https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/plugins/blockwriteai-code-assist.min.js
https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/plugins/blockwriteai-advanced-blocks.min.js
Optional history plugin:
<script src="https://cdn.jsdelivr.net/npm/@qarakash/blockwriteai@1.0.11/dist/plugins/blockwriteai-history.min.js"></script>
Premium CDN integrations should load licensed plugins and verify usage through the production BlockWriteAI Platform:
await BlockWriteAI.loadPremiumPlugins({
licenseKey: "bwai_live_xxxxx",
endpoint: BlockWriteAI.platformEndpoints.premiumPlugins,
features: ["drawing", "mermaid", "signature", "signature_flow", "ai"]
});
Install With Node
npm install @qarakash/blockwriteai
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
},
async onSave(data) {
await fetch("/api/documents", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(data)
});
}
});
Install With PHP
composer require qarakash/blockwriteai
Publish the package dist assets into a public asset directory in your app, then print the tags:
<?php
use QarAkash\BlockWriteAI\BlockWriteAIAssets;
echo BlockWriteAIAssets::stylesheetTag('/assets/blockwriteai');
echo BlockWriteAIAssets::scriptTags('/assets/blockwriteai');
$platform = BlockWriteAIAssets::platformEndpoints();
Create the editor:
<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
pip install blockwriteai-editor
Copy the packaged assets into your app static directory:
from blockwriteai_editor import copy_static
copy_static("static/blockwriteai")
Generate tags in Flask, Django, or any Python web app:
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:
<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:
<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:
{
"time": 1779540000000,
"version": "1.0.11",
"blocks": []
}
It can also return a wrapper:
{
"ok": true,
"data": {
"time": 1779540000000,
"version": "1.0.11",
"blocks": []
}
}
Premium Plugins
Do not expose premium plugin files as normal public scripts. Load them after your server verifies an active license:
<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
- Run
npm run build:min. - Run
npm run check. - Publish
@qarakash/blockwriteaito npm. - Publish
qarakash/blockwriteaito Packagist. - Publish
blockwriteai-editorto PyPI. - Serve only the public asset directory from your application.
Notes For Production
- Use the
.min.cssand.min.jsfiles 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file blockwriteai_editor-1.0.11.tar.gz.
File metadata
- Download URL: blockwriteai_editor-1.0.11.tar.gz
- Upload date:
- Size: 122.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30dd5b730759031d0b25a93b92eacf43ba3095798610b320303c864fcee0f520
|
|
| MD5 |
042f56b7dbc25f6371f0579de3488cde
|
|
| BLAKE2b-256 |
939a8e80f578c3fa02336bf655395c20ca5ef8bf4c99695d0296ebbe3090113c
|
File details
Details for the file blockwriteai_editor-1.0.11-py3-none-any.whl.
File metadata
- Download URL: blockwriteai_editor-1.0.11-py3-none-any.whl
- Upload date:
- Size: 129.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2c093972ba3365e18b0a69be60ae3c265db786cb3aed42e5bc2db98300999249
|
|
| MD5 |
2672b3ac0106bad16b692b1ca67d3476
|
|
| BLAKE2b-256 |
f4fc042d35d1a4144bcf128dc26d2c83636f91feaceabf1d5554d0bd110c64b6
|