Skip to main content

@barocss/model

Version in this checkout: 1.0.3. npm · Source

Document operations, transaction helpers, positions, and selection context.

Purpose​

Use the model layer to build document trees and apply structured edits through the editor transaction system.

Install​

npm install @barocss/model @barocss/editor-core

The published package provides ES modules and TypeScript declarations. Use a bundler that supports package exports.

Public entry points​

ImportRole
@barocss/modelPublic JavaScript and TypeScript API

Import only these public paths. Source paths such as @barocss/model/src/... are not part of the published API.

Usage​

import { node, textNode, mark } from '@barocss/model';

const paragraph = node('paragraph', {}, [
  textNode('inline-text', 'A clear heading', [mark('bold')]),
]);
console.log(paragraph.content); // Pass the tree to your document loader.

Peer dependencies​

  • @barocss/editor-core: workspace:*.

Integration notes​

Tree builders return model data; constructing a node does not insert it into a live document. Apply edits through a transaction or an editor command so history and selection mapping can participate.

Live edits and transaction results​

Use transaction(editor, operations).commit() for a group of document operations. Await the result and check success before reporting an edit as successful. The transaction builder runs extension onBeforeTransaction hooks in priority order; returning null cancels the request. It then passes operations to the transaction manager.

Local undo and redo use the same FIFO model lock as ordinary edits. They select the history entry under that lock and move the history cursor only after the model commits. A failed replay leaves the document, selection, and history unchanged. If a notification or hook fails after commit, undo or redo still returns true; do not replay the committed edit. This local history contract does not cover file snapshots or actor-safe collaborative undo. See the editor history contract.

Tree construction, direct store access, and loading a document are different paths. They are not interchangeable with an undoable user edit. A client-side hook is also not a server authorization boundary. The editor-core command example shows a complete operation-to-command integration.

Documentation​

License​

MIT. The published archive includes the license in dist/LICENSE.