@lexion-rte/core 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# @lexion-rte/core
+
+## 0.1.2
+
+### Patch Changes
+
+- Refresh package metadata links and expand package-level README documentation.
+
+## 0.1.1
+
+### Patch Changes
+
+- Update package metadata and documentation for the `@lexion-rte` package set.
+
+  - Align repository/homepage/bugs metadata with the current GitHub repository owner.
+  - Add package-level README files with package purpose and usage examples.

package/README.md

@@ -0,0 +1,112 @@
+# @lexion-rte/core
+
+Headless editor runtime for the Lexion platform.
+
+## Overview
+
+`@lexion-rte/core` provides:
+
+- editor state and schema management
+- command registration/execution
+- extension lifecycle hooks (`onCreate`, `onDestroy`)
+- JSON document input/output
+
+This package does not render UI by itself. Pair it with `@lexion-rte/extensions` and optionally an adapter package.
+
+## Install
+
+```bash
+pnpm add @lexion-rte/core
+```
+
+Typical pairing:
+
+```bash
+pnpm add @lexion-rte/core @lexion-rte/extensions
+```
+
+## Quick Start
+
+```ts
+import { LexionEditor } from "@lexion-rte/core";
+import { starterKitExtension, starterKitCommandNames } from "@lexion-rte/extensions";
+
+const editor = new LexionEditor({
+  extensions: [starterKitExtension]
+});
+
+editor.execute(starterKitCommandNames.toggleBold);
+console.log(editor.getJSON());
+```
+
+## Editor Options
+
+`LexionEditor` accepts:
+
+- `schema?: Schema`
+- `doc?: JSONDocument`
+- `extensions?: LexionExtension[]`
+- `plugins?: LexionPlugin[]` (alias for extensions)
+- `commands?: CommandMap`
+
+## Core API
+
+Main instance members:
+
+- `schema`
+- `state`
+- `doc`
+- `getJSON()`
+- `setJSON(document)`
+- `dispatchTransaction(transaction)`
+- `execute(command, ...args)`
+- `registerCommand(name, handler)`
+- `unregisterCommand(name)`
+- `use(extension)`
+- `removePlugin(key)`
+- `destroy()`
+
+## Custom Command Example
+
+```ts
+import { LexionEditor } from "@lexion-rte/core";
+import { starterKitExtension } from "@lexion-rte/extensions";
+
+const editor = new LexionEditor({ extensions: [starterKitExtension] });
+
+editor.registerCommand("insertTimestamp", ({ state, dispatch }) => {
+  const { from, to } = state.selection;
+  dispatch(state.tr.insertText(new Date().toISOString(), from, to));
+  return true;
+});
+
+editor.execute("insertTimestamp");
+```
+
+## Extension Lifecycle Example
+
+```ts
+import type { LexionExtension } from "@lexion-rte/core";
+
+const auditExtension: LexionExtension = {
+  key: "audit",
+  onCreate: ({ editor }) => {
+    console.log("created", editor.getJSON());
+  },
+  onDestroy: () => {
+    console.log("destroyed");
+  }
+};
+```
+
+## Error Behavior
+
+- Executing an unknown command throws `Unknown command: <name>`.
+- Using an editor after `destroy()` throws an error.
+- Registering duplicate command names throws.
+
+## Related Packages
+
+- `@lexion-rte/extensions` for starter-kit, AI, and collaboration features
+- `@lexion-rte/tools` for HTML/text conversions
+- adapter packages (`web`, `react`, `vue`, etc.) for UI integration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexion-rte/core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Headless core runtime for the Lexion editor platform.",
   "private": false,
   "type": "module",
@@ -15,12 +15,12 @@
   "license": "GPL-3.0-only",
   "repository": {
     "type": "git",
-    "url": "https://github.com/lexion-rte/lexion.git",
+    "url": "https://github.com/dariusve/lexion.git",
     "directory": "packages/core"
   },
-  "homepage": "https://github.com/lexion-rte/lexion/tree/main/packages/core",
+  "homepage": "https://github.com/dariusve/lexion/tree/main/packages/core",
   "bugs": {
-    "url": "https://github.com/lexion-rte/lexion/issues"
+    "url": "https://github.com/dariusve/lexion/issues"
   },
   "keywords": [
     "lexion",