Schema and registry

ModelRegistry for runtime schema metadata, schema hashing, and load strategy configuration.

Stores runtime metadata about models, properties, and relationships. Decorators populate it at import time; the sync engine reads from it at runtime.

ModelRegistry

Two modes: a static registry that decorators populate at import time, and an instance registry constructed from a serialized snapshot for server-side use.

Static API

Read from the global registry that decorators populate.


import { ModelRegistry } from "@stratasync/core";

const names = ModelRegistry.getModelNames();
// ["Workspace", "Project", "Task", ...]

const meta = ModelRegistry.

Schema and registry

ModelRegistry for runtime schema metadata, schema hashing, and load strategy configuration.

Stores runtime metadata about models, properties, and relationships. Decorators populate it at import time; the sync engine reads from it at runtime.

ModelRegistry

Two modes: a static registry that decorators populate at import time, and an instance registry constructed from a serialized snapshot for server-side use.

Static API

Read from the global registry that decorators populate.


import { ModelRegistry } from "@stratasync/core";

const names = ModelRegistry.getModelNames();
// ["Workspace", "Project", "Task", ...]

const meta = ModelRegistry.

Method	Return type	Description
`registerModel(name, ctor, meta)`	`void`	Registers a model (called by `@ClientModel`).
`registerProperty(target, name, meta)`	`void`	Registers a property (called by decorators).
`getModelNames()`	`string[]`	All registered model names.
`getModelMetadata(name)`	`ModelMetadata \| undefined`	Metadata for one model.
`getModelConstructor(name)`	`ModelConstructor \| undefined`	Constructor for a model name.
`getModelName(ctor)`	`string \| undefined`	Model name for a constructor.
`hasModel(name)`	`boolean`	Whether a model is registered.
`getModelMetadataEntries()`	`[string, ModelMetadata][]`	All metadata entries.
`getBootstrapModelNames()`	`string[]`	Models with `instant` load strategy.
`getPartialModelNames()`	`string[]`	Models with `partial` load strategy.
`getModelProperties(name)`	`Map<string, PropertyMetadata>`	Property metadata map for a model.
`getReferencedProperties(name)`	`Map<string, PropertyMetadata>`	Reference and collection properties only.
`getPropertyNames(name)`	`string[]`	Sorted property names.
`getSchemaHash()`	`string`	Deterministic hash of the full schema.
`snapshot()`	`ModelRegistrySnapshot`	Serializable snapshot of the registry.

Method	Return type	Description
`getModelNames()`	`string[]`	All model names.
`getModelMetadata(name)`	`ModelMetadata \| undefined`	Metadata for one model.
`hasModel(name)`	`boolean`	Whether a model exists.
`getModelMetadataEntries()`	`[string, ModelMetadata][]`	All metadata entries.
`getBootstrapModelNames()`	`string[]`	Models with `instant` load strategy.
`getPartialModelNames()`	`string[]`	Models with `partial` load strategy.
`getModelProperties(name)`	`Map<string, PropertyMetadata>`	Property metadata map.
`getPropertyNames(name)`	`string[]`	Sorted property names.
`getSchemaHash()`	`string`	Deterministic schema hash.
`snapshot()`	`ModelRegistrySnapshot`	Underlying snapshot data.
`getModel(name)`	`ModelDefinition \| undefined`	Full model definition.
`getAllModels()`	`ModelDefinition[]`	All model definitions.
`getBootstrapModels()`	`ModelDefinition[]`	Models for bootstrap loading.
`getPartialModels()`	`ModelDefinition[]`	Partially-loaded models.
`getPrimaryKey(name)`	`string`	Primary key field (defaults to `"id"`).

Strategy	Bootstrap	Best for
`"instant"`	Included	Core data needed on every page
`"lazy"` / `"partial"` / `"explicitlyRequested"` / `"local"`	Excluded	Data loaded on demand or kept local-only

Schema and registry

ModelRegistry

Static API

Schema and registry

ModelRegistry

Static API

Static method reference

Instance API

Instance method reference

computeSchemaHash

Load strategies

Schema types

ModelMetadata

PropertyMetadata

PropertyType

SchemaDefinition