@mnjs/data

Observable Model and ordered Collection sources for Marionette v5. This package uses @mnjs/utils and works without Marionette core or a DOM. Its nonoptional Utils peer is ^5.0.1, so Data does not need an identical core version. Share one Utils instance across core, Radio, and Data: their event graph must not mix separately installed copies.

It is a workable but incomplete application data layer. Supply fetching, persistence, validation, and server synchronization through an API layer, or use another data solution with a compatible Marionette provider. Models and Collections do not include fetch, save, or HTTP deletion methods.

Standalone use

Install Data; modern npm supplies its nonoptional Utils peer automatically. With core already installed, its matching Utils satisfies the peer:

npm install --ignore-scripts --save-exact @mnjs/[email protected]

import { Collection, Model } from '@mnjs/data';

const item = new Model({ id: 'a', title: 'First item' });
const items = new Collection([item]);

item.on('change:title', (model, title) => console.log(title));
item.set('title', 'Updated item');
items.add({ id: 'b', title: 'Second item' });
items.toArray(); // Shallow attribute copies for serialization.

Attribute mutations publish synchronous change events. Collection membership and order changes publish structural events. Existing Models retain their identity; raw attribute objects construct Models. reset replaces membership, while add, remove, move, and updates to existing Models preserve retained members.

destroy() ends the local event lifetime. Destroying a Collection releases its subscriptions without destroying its Models. Removing an item from a Collection also leaves the Model alive.

Marionette integration

For a new application, add core and its matching Radio package:

npm install --ignore-scripts --save-exact [email protected] @mnjs/[email protected]

Configure providers before constructing consumers:

import { setDataApi, setStateApi } from 'marionette';
import { DataApi, StateApi } from '@mnjs/data';

setDataApi(DataApi);
setStateApi(StateApi);

DataApi connects Models and Collections to Views and CollectionViews. StateApi connects observable state and its ownership lifecycle. Rendering is configured separately. Views borrow their data; state returned by createState is owned.

Version-matched reference

The matching marionette package includes the canonical reference. If you have installed it, open these files from your project directory:

• node_modules/marionette/docs/packages/data.md: all Model/Collection methods, configuration, events, identity, disposal, and exported TypeScript types.
• node_modules/marionette/docs/integrations/setup.md: renderer and provider setup.
• node_modules/marionette/docs/api/providers/data.md: integration contracts for native and alternative data solutions.

Standalone use of @mnjs/data does not require core. General project information is available on the Marionette website.