@kubuild/react 0.0.1 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kustora
+
+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,119 @@
+# @kubuild/react
+
+[![npm version](https://img.shields.io/npm/v/@kubuild/react.svg)](https://www.npmjs.com/package/@kubuild/react)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-blue)](https://www.typescriptlang.org/)
+
+Unified React entrypoint for **KUBUILD**: combines `@kubuild/schema`, `@kubuild/core`, `@kubuild/components`, `@kubuild/renderer`, and `@kubuild/editor` into a single, comprehensive package.
+
+---
+
+## 📦 Installation
+
+```bash
+# Using pnpm (recommended)
+pnpm add @kubuild/react react react-dom
+
+# Using npm
+npm install @kubuild/react react react-dom
+
+# Using yarn
+yarn add @kubuild/react react react-dom
+```
+
+---
+
+## ✨ Features
+
+- **All-in-One Convenience**: Single package install that gives you the complete visual page builder suite:
+  - 🎨 **Visual Editor** (`@kubuild/editor`)
+  - ⚡ **Recursive Renderer** (`@kubuild/renderer`)
+  - 🧩 **Component Registry & Templates** (`@kubuild/components`)
+  - ⚙️ **Command Engine, Pipeline Executor & Undo/Redo** (`@kubuild/core`)
+  - 📐 **Zod Schemas & Document Types** (`@kubuild/schema`)
+- **Seamless Types & Re-exports**: Everything is re-exported from the top-level `@kubuild/react` module.
+- **Production Ready**: Fully tree-shakeable with ESM and CJS builds.
+
+---
+
+## 🚀 Quick Usage
+
+### Full Page Builder Application
+
+```tsx
+import React from 'react';
+import {
+  Editor,
+  Renderer,
+  PageDocumentSchema,
+  type PageDocument
+} from '@kubuild/react';
+
+const initialDoc: PageDocument = {
+  schema: 'stora.page',
+  version: '1.0.0',
+  metadata: {
+    title: 'Landing Page'
+  },
+  document: {
+    id: 'root-1',
+    type: 'container',
+    children: [
+      {
+        id: 'heading-1',
+        type: 'heading',
+        props: { content: 'Welcome to KUBUILD' },
+        styles: { fontSize: '2.5rem', fontWeight: 'bold' }
+      }
+    ]
+  }
+};
+
+export const App: React.FC = () => {
+  const [isEditing, setIsEditing] = React.useState(true);
+  const [doc, setDoc] = React.useState<PageDocument>(initialDoc);
+
+  return (
+    <div style={{ width: '100vw', height: '100vh' }}>
+      <button
+        onClick={() => setIsEditing(!isEditing)}
+        style={{ position: 'fixed', top: 12, right: 12, zIndex: 9999 }}
+      >
+        {isEditing ? 'Switch to Preview' : 'Back to Editor'}
+      </button>
+
+      {isEditing ? (
+        <Editor
+          initialDocument={doc}
+          onSave={(newDoc) => setDoc(newDoc)}
+        />
+      ) : (
+        <div style={{ padding: '2rem' }}>
+          <Renderer document={doc} />
+        </div>
+      )}
+    </div>
+  );
+};
+```
+
+---
+
+## 🏗️ Architecture
+
+`@kubuild/react` serves as the umbrella package for the KUBUILD ecosystem:
+
+```
+@kubuild/react
+├── @kubuild/editor      (Visual builder UI, canvas, inspector, action builder)
+├── @kubuild/renderer    (Recursive React renderer, action dispatcher, styles)
+├── @kubuild/components  (Registry, definitions, starter form templates)
+├── @kubuild/core        (Document engine, pipeline executor, state store)
+└── @kubuild/schema      (Zod validation schemas, TypeScript interfaces)
+```
+
+---
+
+## 📄 License
+
+MIT © [KUBUILD](https://github.com/kustora/kubuild)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubuild/react",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Unified React entrypoint for KUBUILD: editor, renderer, and document utilities",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -20,14 +20,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsup && tsc --emitDeclarationOnly",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src",
-    "test": "vitest run",
-    "prepublishOnly": "pnpm run build"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kustora/kubuild.git"
@@ -47,11 +39,11 @@
   },
   "homepage": "https://github.com/kustora/kubuild#readme",
   "dependencies": {
-    "@kubuild/components": "workspace:*",
-    "@kubuild/core": "workspace:*",
-    "@kubuild/editor": "workspace:*",
-    "@kubuild/renderer": "workspace:*",
-    "@kubuild/schema": "workspace:*"
+    "@kubuild/components": "0.2.0",
+    "@kubuild/renderer": "0.2.0",
+    "@kubuild/core": "0.2.0",
+    "@kubuild/editor": "0.2.0",
+    "@kubuild/schema": "0.2.0"
   },
   "peerDependencies": {
     "react": ">=18.0.0",
@@ -65,5 +57,12 @@
     "tsup": "^8.3.6",
     "typescript": "^6.0.0",
     "vitest": "^3.0.5"
+  },
+  "scripts": {
+    "build": "tsup && tsc --emitDeclarationOnly",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src",
+    "test": "vitest run"
   }
-}
+}