@dxos/migrations 0.10.0 → 0.11.0

package/dist/lib/index.mjs

@@ -0,0 +1,325 @@
+import * as Schema from "effect/Schema";
+import { Annotation, Obj } from "@dxos/echo";
+import { SpaceState } from "@dxos/client/echo";
+import { invariant } from "@dxos/invariant";
+import { next, toJS } from "@automerge/automerge";
+import { CreateEpochRequest } from "@dxos/client/halo";
+import { ObjectCore, migrateDocument } from "@dxos/echo-client/internal";
+import { EncodedReference, SpaceDocVersion } from "@dxos/echo-protocol";
+import { getSchemaURI } from "@dxos/echo/internal";
+import * as Type from "@dxos/echo/Type";
+import { EID, EntityId } from "@dxos/keys";
+import { Atom } from "@effect-atom/atom";
+import * as Registry from "@effect-atom/atom/Registry";
+import * as Option from "effect/Option";
+//#region src/annotations.ts
+/** Migration version stored on space properties meta. */
+var MigrationVersionAnnotation = Annotation.make({
+	id: "org.dxos.migrations.version",
+	schema: Schema.String
+});
+//#endregion
+//#region src/migration-builder.ts
+var __dxlog_file$2 = "/__w/dxos/dxos/packages/sdk/migrations/src/migration-builder.ts";
+var MigrationBuilder = class {
+	_space;
+	_repo;
+	_rootDoc;
+	_newLinks = {};
+	_flushIds = [];
+	_deleteObjects = [];
+	_newRoot = void 0;
+	constructor(_space) {
+		this._space = _space;
+		this._repo = this._space.internal.db._repo;
+		const rootDoc = this._space.internal.db._getSpaceRootDocHandle().doc();
+		invariant(rootDoc, "Space root document must be available when creating MigrationBuilder", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 51,
+			S: this,
+			A: ["rootDoc", "'Space root document must be available when creating MigrationBuilder'"]
+		});
+		this._rootDoc = rootDoc;
+	}
+	async findObject(id) {
+		const documentId = (this._rootDoc.links?.[id] || this._newLinks[id])?.toString();
+		const docHandle = documentId && this._repo.find(documentId);
+		if (!docHandle) return;
+		await docHandle.whenReady();
+		return docHandle.doc().objects?.[id];
+	}
+	async migrateObject(id, migrate) {
+		const objectStructure = await this.findObject(id);
+		if (!objectStructure) return;
+		const { type, props } = await migrate(objectStructure);
+		const schema = Type.getSchema(type);
+		const oldHandle = await this._findObjectContainingHandle(id);
+		invariant(oldHandle, void 0, {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 80,
+			S: this,
+			A: ["oldHandle", ""]
+		});
+		const newState = {
+			version: SpaceDocVersion.CURRENT,
+			access: this._makeAccess(),
+			objects: { [id]: {
+				system: { type: EncodedReference.fromURI(getSchemaURI(schema)) },
+				data: props,
+				meta: { keys: [] }
+			} }
+		};
+		const migratedDoc = migrateDocument(oldHandle.doc(), newState);
+		const newHandle = this._repo.import(next.save(migratedDoc));
+		await newHandle.whenReady();
+		invariant(newHandle.url, "Migrated document URL not available after whenReady", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 100,
+			S: this,
+			A: ["newHandle.url", "'Migrated document URL not available after whenReady'"]
+		});
+		this._newLinks[id] = newHandle.url;
+		this._addHandleToFlushList(newHandle.documentId);
+	}
+	async addObject(type, props) {
+		const resolved = Type.getSchema(type);
+		return (await this._createObject({
+			schema: resolved,
+			props
+		})).id;
+	}
+	createReference(id) {
+		invariant(EntityId.isValid(id), "Invalid EntityId.", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 112,
+			S: this,
+			A: ["EntityId.isValid(id)", "'Invalid EntityId.'"]
+		});
+		return EncodedReference.fromURI(EID.make({ entityId: id }));
+	}
+	deleteObject(id) {
+		this._deleteObjects.push(id);
+	}
+	/**
+	* Re-materializes linked object documents into fresh Automerge docs without history.
+	* Call {@link _commit} to publish a new space epoch with updated root links.
+	*/
+	async compactLinkedDocuments(objectIds) {
+		const linkIds = objectIds ?? Object.keys(this._rootDoc.links ?? {});
+		const compacted = [];
+		const skipped = [];
+		for (const id of linkIds) {
+			const oldHandle = await this._findObjectContainingHandle(id);
+			if (!oldHandle) {
+				skipped.push(id);
+				continue;
+			}
+			await oldHandle.whenReady();
+			const materialized = toJS(oldHandle.doc());
+			materialized.access = this._makeAccess();
+			const newHandle = this._repo.create(materialized);
+			await newHandle.whenReady();
+			invariant(newHandle.url, "Compacted document URL not available after whenReady", {
+				"~LogMeta": "~LogMeta",
+				F: __dxlog_file$2,
+				L: 142,
+				S: this,
+				A: ["newHandle.url", "'Compacted document URL not available after whenReady'"]
+			});
+			this._newLinks[id] = newHandle.url;
+			this._addHandleToFlushList(newHandle.documentId);
+			compacted.push(id);
+		}
+		return {
+			compacted,
+			skipped
+		};
+	}
+	async changeProperties(changeFn) {
+		if (!this._newRoot) await this._buildNewRoot();
+		invariant(this._newRoot, "New root not created", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 155,
+			S: this,
+			A: ["this._newRoot", "'New root not created'"]
+		});
+		this._newRoot.change((doc) => {
+			const propertiesStructure = doc.objects?.[this._space.properties.id];
+			propertiesStructure && changeFn(propertiesStructure);
+		});
+		await this._newRoot.whenReady();
+		this._addHandleToFlushList(this._newRoot.documentId);
+	}
+	/**
+	* @internal
+	*/
+	async _commit() {
+		if (!this._newRoot) await this._buildNewRoot();
+		invariant(this._newRoot, "New root not created", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 172,
+			S: this,
+			A: ["this._newRoot", "'New root not created'"]
+		});
+		await this._space.db.flush();
+		invariant(this._newRoot.url, "New root URL not available", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file$2,
+			L: 177,
+			S: this,
+			A: ["this._newRoot.url", "'New root URL not available'"]
+		});
+		await this._space.internal.createEpoch({
+			migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,
+			automergeRootUrl: this._newRoot.url
+		});
+	}
+	async _findObjectContainingHandle(id) {
+		const documentId = (this._rootDoc.links?.[id] || this._newLinks[id])?.toString();
+		const docHandle = documentId && this._repo.find(documentId);
+		if (!docHandle) return;
+		await docHandle.whenReady();
+		return docHandle;
+	}
+	async _buildNewRoot() {
+		const links = { ...this._rootDoc.links ?? {} };
+		for (const id of this._deleteObjects) delete links[id];
+		for (const [id, url] of Object.entries(this._newLinks)) links[id] = new next.RawString(url);
+		this._newRoot = this._repo.create({
+			version: SpaceDocVersion.CURRENT,
+			access: this._makeAccess(),
+			objects: this._rootDoc.objects,
+			links
+		});
+		await this._newRoot.whenReady();
+		this._addHandleToFlushList(this._newRoot.documentId);
+	}
+	async _createObject({ id, schema, props }) {
+		const core = new ObjectCore();
+		if (id) core.id = id;
+		core.initNewObject(props);
+		core.setType(EncodedReference.fromURI(getSchemaURI(schema)));
+		const newHandle = this._repo.create({
+			version: SpaceDocVersion.CURRENT,
+			access: this._makeAccess(),
+			objects: { [core.id]: core.getDoc() }
+		});
+		await newHandle.whenReady();
+		this._newLinks[core.id] = newHandle.url;
+		this._addHandleToFlushList(newHandle.documentId);
+		return core;
+	}
+	_makeAccess() {
+		return {
+			spaceId: this._space.id,
+			spaceKey: this._space.key.toHex()
+		};
+	}
+	_addHandleToFlushList(id) {
+		this._flushIds.push(id);
+	}
+};
+//#endregion
+//#region src/document-compaction.ts
+var __dxlog_file$1 = "/__w/dxos/dxos/packages/sdk/migrations/src/document-compaction.ts";
+/**
+* Re-materializes linked object documents into fresh Automerge docs (no history) and commits
+* a new space epoch with {@link CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT}.
+*/
+var compactDocumentsEpochMigration = async (space, options = {}) => {
+	invariant(space.state.get() === SpaceState.SPACE_READY, "Space must be open and ready before compaction.", {
+		"~LogMeta": "~LogMeta",
+		F: __dxlog_file$1,
+		L: 32,
+		S: void 0,
+		A: ["space.state.get() === SpaceState.SPACE_READY", "'Space must be open and ready before compaction.'"]
+	});
+	const builder = new MigrationBuilder(space);
+	const { compacted, skipped } = await builder.compactLinkedDocuments(options.objectIds);
+	await builder._commit();
+	const epochs = await space.internal.getEpochs();
+	return {
+		compacted,
+		skipped,
+		epochNumber: epochs[epochs.length - 1]?.subject.assertion.number ?? 0
+	};
+};
+//#endregion
+//#region src/migrations.ts
+var __dxlog_file = "/__w/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
+var Migrations = class {
+	static namespace;
+	static migrations = [];
+	static _registry = Registry.make();
+	static _stateAtom = Atom.make({ running: [] }).pipe(Atom.keepAlive);
+	/**
+	* @deprecated Use `MigrationVersionAnnotation` via `Annotation.get/set` on space properties.
+	*/
+	static get versionProperty() {
+		return this.namespace && `${this.namespace}.version`;
+	}
+	static get targetVersion() {
+		return this.migrations[this.migrations.length - 1]?.version;
+	}
+	static running(space) {
+		return this._registry.get(this._stateAtom).running.includes(space.key.toHex());
+	}
+	static define(namespace, migrations) {
+		this.namespace = namespace;
+		this.migrations = migrations;
+	}
+	static async migrate(space, targetVersion) {
+		invariant(!this.running(space), "Migration already running", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file,
+			L: 55,
+			S: this,
+			A: ["!this.running(space)", "'Migration already running'"]
+		});
+		invariant(space.state.get() === SpaceState.SPACE_READY, "Space not ready", {
+			"~LogMeta": "~LogMeta",
+			F: __dxlog_file,
+			L: 56,
+			S: this,
+			A: ["space.state.get() === SpaceState.SPACE_READY", "'Space not ready'"]
+		});
+		const currentVersion = Annotation.get(space.properties, MigrationVersionAnnotation).pipe(Option.getOrUndefined);
+		const currentIndex = this.migrations.findIndex((m) => m.version === currentVersion) + 1;
+		const i = this.migrations.findIndex((m) => m.version === targetVersion);
+		const targetIndex = i === -1 ? this.migrations.length : i + 1;
+		if (currentIndex === targetIndex) return false;
+		const spaceKey = space.key.toHex();
+		const currentState = this._registry.get(this._stateAtom);
+		this._registry.set(this._stateAtom, { running: [...currentState.running, spaceKey] });
+		try {
+			if (targetIndex > currentIndex) {
+				const migrations = this.migrations.slice(currentIndex, targetIndex);
+				for (const migration of migrations) {
+					const builder = new MigrationBuilder(space);
+					await migration.next({
+						space,
+						builder
+					});
+					await builder._commit();
+					Obj.update(space.properties, (properties) => {
+						Annotation.set(properties, MigrationVersionAnnotation, migration.version);
+					});
+				}
+			}
+		} finally {
+			const finalState = this._registry.get(this._stateAtom);
+			this._registry.set(this._stateAtom, { running: finalState.running.filter((key) => key !== spaceKey) });
+		}
+		return true;
+	}
+};
+//#endregion
+export { MigrationBuilder, MigrationVersionAnnotation, Migrations, compactDocumentsEpochMigration };
+
+//# sourceMappingURL=index.mjs.map

package/dist/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/annotations.ts","../../src/migration-builder.ts","../../src/document-compaction.ts","../../src/migrations.ts"],"sourcesContent":["//\n// Copyright 2026 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\n\nimport { Annotation } from '@dxos/echo';\n\n/** Migration version stored on space properties meta. */\nexport const MigrationVersionAnnotation = Annotation.make({\n  id: 'org.dxos.migrations.version',\n  schema: Schema.String,\n});\n","//\n// Copyright 2024 DXOS.org\n//\n\nimport { next as A, type Doc, toJS } from '@automerge/automerge';\nimport { type AnyDocumentId, type DocumentId } from '@automerge/automerge-repo';\nimport type * as Schema from 'effect/Schema';\n\nimport { type Space } from '@dxos/client/echo';\nimport { CreateEpochRequest } from '@dxos/client/halo';\nimport { type DocHandleProxy, ObjectCore, type RepoProxy, migrateDocument } from '@dxos/echo-client/internal';\nimport { type DatabaseDirectory, EncodedReference, type EntityStructure, SpaceDocVersion } from '@dxos/echo-protocol';\nimport { getSchemaURI } from '@dxos/echo/internal';\nimport * as Type from '@dxos/echo/Type';\nimport { invariant } from '@dxos/invariant';\nimport { EID, EntityId } from '@dxos/keys';\nimport { type MaybePromise } from '@dxos/util';\n\n/*\n\nConsidering a better API for this:\n\n```ts\nconst migration = space.db.beginMigration(); // all actions are not visible to queries and are only applied once you call `apply`\n\nmigration.applyObjectMigration(defineMigration(From, To, { ... }));\n\nmigration.delete(id);\nmigration.add(obj);\n\nawait migration.apply(); // Will create new epoch.\n```\n\n*/\n\n// TODO(dmaretskyi): We no longer need to hook into ECHO internals, with the changes to echo APIs.\nexport class MigrationBuilder {\n  private readonly _repo: RepoProxy;\n  private readonly _rootDoc: Doc<DatabaseDirectory>;\n\n  // echoUri -> automergeUrl\n  private readonly _newLinks: Record<string, string> = {};\n  private readonly _flushIds: DocumentId[] = [];\n  private readonly _deleteObjects: string[] = [];\n\n  private _newRoot?: DocHandleProxy<DatabaseDirectory> = undefined;\n\n  constructor(private readonly _space: Space) {\n    this._repo = this._space.internal.db._repo;\n    const rootDoc = this._space.internal.db._getSpaceRootDocHandle().doc();\n    invariant(rootDoc, 'Space root document must be available when creating MigrationBuilder');\n    this._rootDoc = rootDoc;\n  }\n\n  async findObject(id: string): Promise<EntityStructure | undefined> {\n    const documentId = (this._rootDoc.links?.[id] || this._newLinks[id])?.toString() as AnyDocumentId | undefined;\n    const docHandle = documentId && this._repo.find(documentId);\n    if (!docHandle) {\n      return undefined;\n    }\n\n    await docHandle.whenReady();\n    const doc = docHandle.doc() as Doc<DatabaseDirectory>;\n    return doc.objects?.[id];\n  }\n\n  async migrateObject(\n    id: string,\n    migrate: (objectStructure: EntityStructure) => MaybePromise<{ type: Type.AnyEntity; props: any }>,\n  ): Promise<void> {\n    const objectStructure = await this.findObject(id);\n    if (!objectStructure) {\n      return;\n    }\n\n    const { type, props } = await migrate(objectStructure);\n    const schema = Type.getSchema(type);\n\n    const oldHandle = await this._findObjectContainingHandle(id);\n    invariant(oldHandle);\n\n    const newState: DatabaseDirectory = {\n      version: SpaceDocVersion.CURRENT,\n      access: this._makeAccess(),\n      objects: {\n        [id]: {\n          system: {\n            type: EncodedReference.fromURI(getSchemaURI(schema)!),\n          },\n          data: props,\n          meta: {\n            keys: [],\n          },\n        },\n      },\n    };\n    const migratedDoc = migrateDocument(oldHandle.doc() as Doc<DatabaseDirectory>, newState);\n    const newHandle = this._repo.import<DatabaseDirectory>(A.save(migratedDoc));\n    await newHandle.whenReady();\n    invariant(newHandle.url, 'Migrated document URL not available after whenReady');\n    this._newLinks[id] = newHandle.url;\n    this._addHandleToFlushList(newHandle.documentId!);\n  }\n\n  async addObject(type: Type.AnyEntity, props: any): Promise<string> {\n    const resolved = Type.getSchema(type);\n    const core = await this._createObject({ schema: resolved, props });\n    return core.id;\n  }\n\n  createReference(id: string) {\n    invariant(EntityId.isValid(id), 'Invalid EntityId.');\n    return EncodedReference.fromURI(EID.make({ entityId: id }));\n  }\n\n  deleteObject(id: string): void {\n    this._deleteObjects.push(id);\n  }\n\n  /**\n   * Re-materializes linked object documents into fresh Automerge docs without history.\n   * Call {@link _commit} to publish a new space epoch with updated root links.\n   */\n  async compactLinkedDocuments(objectIds?: string[]): Promise<{ compacted: string[]; skipped: string[] }> {\n    const linkIds = objectIds ?? Object.keys(this._rootDoc.links ?? {});\n    const compacted: string[] = [];\n    const skipped: string[] = [];\n\n    for (const id of linkIds) {\n      const oldHandle = await this._findObjectContainingHandle(id);\n      if (!oldHandle) {\n        skipped.push(id);\n        continue;\n      }\n\n      await oldHandle.whenReady();\n      const materialized = toJS(oldHandle.doc()!) as DatabaseDirectory;\n      // Re-stamp access so documents that predate access.spaceId pick it up during compaction.\n      materialized.access = this._makeAccess();\n      const newHandle = this._repo.create<DatabaseDirectory>(materialized);\n      await newHandle.whenReady();\n      invariant(newHandle.url, 'Compacted document URL not available after whenReady');\n      this._newLinks[id] = newHandle.url;\n      this._addHandleToFlushList(newHandle.documentId!);\n      compacted.push(id);\n    }\n\n    return { compacted, skipped };\n  }\n\n  async changeProperties(changeFn: (properties: EntityStructure) => void): Promise<void> {\n    if (!this._newRoot) {\n      await this._buildNewRoot();\n    }\n    invariant(this._newRoot, 'New root not created');\n\n    this._newRoot.change((doc: DatabaseDirectory) => {\n      const propertiesStructure = doc.objects?.[this._space.properties.id];\n      propertiesStructure && changeFn(propertiesStructure);\n    });\n    await this._newRoot.whenReady();\n    this._addHandleToFlushList(this._newRoot.documentId!);\n  }\n\n  /**\n   * @internal\n   */\n  async _commit(): Promise<void> {\n    if (!this._newRoot) {\n      await this._buildNewRoot();\n    }\n    invariant(this._newRoot, 'New root not created');\n\n    await this._space.db.flush();\n\n    // Create new epoch.\n    invariant(this._newRoot.url, 'New root URL not available');\n    await this._space.internal.createEpoch({\n      migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,\n      automergeRootUrl: this._newRoot.url,\n    });\n  }\n\n  private async _findObjectContainingHandle(id: string): Promise<DocHandleProxy<DatabaseDirectory> | undefined> {\n    const documentId = (this._rootDoc.links?.[id] || this._newLinks[id])?.toString() as AnyDocumentId | undefined;\n    const docHandle = documentId && this._repo.find(documentId);\n    if (!docHandle) {\n      return undefined;\n    }\n\n    await docHandle.whenReady();\n    return docHandle;\n  }\n\n  private async _buildNewRoot(): Promise<void> {\n    const links = { ...(this._rootDoc.links ?? {}) };\n    for (const id of this._deleteObjects) {\n      delete links[id];\n    }\n\n    for (const [id, url] of Object.entries(this._newLinks)) {\n      links[id] = new A.RawString(url);\n    }\n\n    this._newRoot = this._repo.create<DatabaseDirectory>({\n      version: SpaceDocVersion.CURRENT,\n      access: this._makeAccess(),\n      objects: this._rootDoc.objects,\n      links,\n    });\n    await this._newRoot.whenReady();\n    this._addHandleToFlushList(this._newRoot.documentId!);\n  }\n\n  private async _createObject({\n    id,\n    schema,\n    props,\n  }: {\n    id?: string;\n    schema: Schema.Schema.AnyNoContext;\n    props: any;\n  }): Promise<ObjectCore> {\n    const core = new ObjectCore();\n    if (id) {\n      core.id = id;\n    }\n\n    core.initNewObject(props);\n    core.setType(EncodedReference.fromURI(getSchemaURI(schema)!));\n    const newHandle = this._repo.create<DatabaseDirectory>({\n      version: SpaceDocVersion.CURRENT,\n      access: this._makeAccess(),\n      objects: {\n        [core.id]: core.getDoc() as EntityStructure,\n      },\n    });\n    await newHandle.whenReady();\n    this._newLinks[core.id] = newHandle.url!;\n    this._addHandleToFlushList(newHandle.documentId!);\n\n    return core;\n  }\n\n  private _makeAccess(): NonNullable<DatabaseDirectory['access']> {\n    return {\n      spaceId: this._space.id,\n      // spaceKey is deprecated but still written so older clients can resolve the owning space.\n      spaceKey: this._space.key.toHex(),\n    };\n  }\n\n  private _addHandleToFlushList(id: DocumentId): void {\n    this._flushIds.push(id);\n  }\n}\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { type Space, SpaceState } from '@dxos/client/echo';\nimport { invariant } from '@dxos/invariant';\n\nimport { MigrationBuilder } from './migration-builder';\n\nexport type CompactDocumentsOptions = {\n  /**\n   * Entity ids whose linked Automerge documents should be compacted.\n   * Defaults to all ids in the space root `links` map.\n   */\n  objectIds?: string[];\n};\n\nexport type CompactDocumentsResult = {\n  compacted: string[];\n  skipped: string[];\n  epochNumber: number;\n};\n\n/**\n * Re-materializes linked object documents into fresh Automerge docs (no history) and commits\n * a new space epoch with {@link CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT}.\n */\nexport const compactDocumentsEpochMigration = async (\n  space: Space,\n  options: CompactDocumentsOptions = {},\n): Promise<CompactDocumentsResult> => {\n  invariant(space.state.get() === SpaceState.SPACE_READY, 'Space must be open and ready before compaction.');\n\n  const builder = new MigrationBuilder(space);\n  const { compacted, skipped } = await builder.compactLinkedDocuments(options.objectIds);\n  await builder._commit();\n\n  const epochs = await space.internal.getEpochs();\n  const lastEpoch = epochs[epochs.length - 1];\n  const epochNumber = lastEpoch?.subject.assertion.number ?? 0;\n\n  return { compacted, skipped, epochNumber };\n};\n","//\n// Copyright 2023 DXOS.org\n//\n\nimport { Atom } from '@effect-atom/atom';\nimport * as Registry from '@effect-atom/atom/Registry';\nimport * as Option from 'effect/Option';\n\nimport { type Space, SpaceState } from '@dxos/client/echo';\nimport { Annotation, Obj } from '@dxos/echo';\nimport { invariant } from '@dxos/invariant';\nimport { type MaybePromise } from '@dxos/util';\n\nimport { MigrationVersionAnnotation } from './annotations';\nimport { MigrationBuilder } from './migration-builder';\n\nexport type MigrationContext = {\n  space: Space;\n  builder: MigrationBuilder;\n};\n\nexport type Migration = {\n  version: string;\n  next: (context: MigrationContext) => MaybePromise<void>;\n};\n\nexport class Migrations {\n  static namespace?: string;\n  static migrations: Migration[] = [];\n  private static _registry = Registry.make();\n  private static _stateAtom = Atom.make<{ running: string[] }>({ running: [] }).pipe(Atom.keepAlive);\n\n  /**\n   * @deprecated Use `MigrationVersionAnnotation` via `Annotation.get/set` on space properties.\n   */\n  static get versionProperty() {\n    return this.namespace && `${this.namespace}.version`;\n  }\n\n  static get targetVersion() {\n    return this.migrations[this.migrations.length - 1]?.version;\n  }\n\n  static running(space: Space): boolean {\n    const state = this._registry.get(this._stateAtom);\n    return state.running.includes(space.key.toHex());\n  }\n\n  static define(namespace: string, migrations: Migration[]): void {\n    this.namespace = namespace;\n    this.migrations = migrations;\n  }\n\n  static async migrate(space: Space, targetVersion?: string | number): Promise<boolean> {\n    invariant(!this.running(space), 'Migration already running');\n    invariant(space.state.get() === SpaceState.SPACE_READY, 'Space not ready');\n    const currentVersion = Annotation.get(space.properties, MigrationVersionAnnotation).pipe(Option.getOrUndefined);\n    const currentIndex = this.migrations.findIndex((m) => m.version === currentVersion) + 1;\n    const i = this.migrations.findIndex((m) => m.version === targetVersion);\n    const targetIndex = i === -1 ? this.migrations.length : i + 1;\n    if (currentIndex === targetIndex) {\n      return false;\n    }\n\n    const spaceKey = space.key.toHex();\n    const currentState = this._registry.get(this._stateAtom);\n    this._registry.set(this._stateAtom, { running: [...currentState.running, spaceKey] });\n    try {\n      if (targetIndex > currentIndex) {\n        const migrations = this.migrations.slice(currentIndex, targetIndex);\n        for (const migration of migrations) {\n          const builder = new MigrationBuilder(space);\n          await migration.next({ space, builder });\n          await builder._commit();\n          Obj.update(space.properties, (properties) => {\n            Annotation.set(properties, MigrationVersionAnnotation, migration.version);\n          });\n        }\n      }\n    } finally {\n      const finalState = this._registry.get(this._stateAtom);\n      this._registry.set(this._stateAtom, { running: finalState.running.filter((key) => key !== spaceKey) });\n    }\n\n    return true;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AASA,IAAa,6BAA6B,WAAW,KAAK;CACxD,IAAI;CACJ,QAAQ,OAAO;AACjB,CAAC;;;;ACwBD,IAAa,mBAAb,MAA8B;CAWC;CAV7B;CACA;CAGA,YAAqD,CAAC;CACtD,YAA2C,CAAC;CAC5C,iBAA4C,CAAC;CAE7C,WAAuD,KAAA;CAEvD,YAAY,QAAgC;EAAf,KAAA,SAAA;EAC3B,KAAK,QAAQ,KAAK,OAAO,SAAS,GAAG;EACrC,MAAM,UAAU,KAAK,OAAO,SAAS,GAAG,uBAAuB,CAAC,CAAC,IAAI;EACrE,UAAU,SAAS,wEAAqE;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,WAAA,wEAAA;EAAA,CAAC;EACzF,KAAK,WAAW;CAClB;CAEA,MAAM,WAAW,IAAkD;EACjE,MAAM,cAAc,KAAK,SAAS,QAAQ,OAAO,KAAK,UAAU,IAAA,EAAM,SAAS;EAC/E,MAAM,YAAY,cAAc,KAAK,MAAM,KAAK,UAAU;EAC1D,IAAI,CAAC,WACH;EAGF,MAAM,UAAU,UAAU;EAE1B,OADY,UAAU,IACf,CAAA,CAAI,UAAU;CACvB;CAEA,MAAM,cACJ,IACA,SACe;EACf,MAAM,kBAAkB,MAAM,KAAK,WAAW,EAAE;EAChD,IAAI,CAAC,iBACH;EAGF,MAAM,EAAE,MAAM,UAAU,MAAM,QAAQ,eAAe;EACrD,MAAM,SAAS,KAAK,UAAU,IAAI;EAElC,MAAM,YAAY,MAAM,KAAK,4BAA4B,EAAE;EAC3D,UAAU,WAAQ,KAAA,GAAA;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,aAAA,EAAA;EAAA,CAAC;EAEnB,MAAM,WAA8B;GAClC,SAAS,gBAAgB;GACzB,QAAQ,KAAK,YAAY;GACzB,SAAS,GACN,KAAK;IACJ,QAAQ,EACN,MAAM,iBAAiB,QAAQ,aAAa,MAAM,CAAE,EACtD;IACA,MAAM;IACN,MAAM,EACJ,MAAM,CAAC,EACT;GACF,EACF;EACF;EACA,MAAM,cAAc,gBAAgB,UAAU,IAAI,GAA6B,QAAQ;EACvF,MAAM,YAAY,KAAK,MAAM,OAA0B,KAAE,KAAK,WAAW,CAAC;EAC1E,MAAM,UAAU,UAAU;EAC1B,UAAU,UAAU,KAAK,uDAAoD;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,iBAAA,uDAAA;EAAA,CAAC;EAC9E,KAAK,UAAU,MAAM,UAAU;EAC/B,KAAK,sBAAsB,UAAU,UAAW;CAClD;CAEA,MAAM,UAAU,MAAsB,OAA6B;EACjE,MAAM,WAAW,KAAK,UAAU,IAAI;EAEpC,QAAO,MADY,KAAK,cAAc;GAAE,QAAQ;GAAU;EAAM,CAAC,EAAA,CACrD;CACd;CAEA,gBAAgB,IAAY;EAC1B,UAAU,SAAS,QAAQ,EAAE,GAAG,qBAAkB;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,wBAAA,qBAAA;EAAA,CAAC;EACnD,OAAO,iBAAiB,QAAQ,IAAI,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC;CAC5D;CAEA,aAAa,IAAkB;EAC7B,KAAK,eAAe,KAAK,EAAE;CAC7B;;;;;CAMA,MAAM,uBAAuB,WAA2E;EACtG,MAAM,UAAU,aAAa,OAAO,KAAK,KAAK,SAAS,SAAS,CAAC,CAAC;EAClE,MAAM,YAAsB,CAAC;EAC7B,MAAM,UAAoB,CAAC;EAE3B,KAAK,MAAM,MAAM,SAAS;GACxB,MAAM,YAAY,MAAM,KAAK,4BAA4B,EAAE;GAC3D,IAAI,CAAC,WAAW;IACd,QAAQ,KAAK,EAAE;IACf;GACF;GAEA,MAAM,UAAU,UAAU;GAC1B,MAAM,eAAe,KAAK,UAAU,IAAI,CAAE;GAE1C,aAAa,SAAS,KAAK,YAAY;GACvC,MAAM,YAAY,KAAK,MAAM,OAA0B,YAAY;GACnE,MAAM,UAAU,UAAU;GAC1B,UAAU,UAAU,KAAK,wDAAqD;IAAA,YAAA;IAAA,GAAA;IAAA,GAAA;IAAA,GAAA;IAAA,GAAA,CAAA,iBAAA,wDAAA;GAAA,CAAC;GAC/E,KAAK,UAAU,MAAM,UAAU;GAC/B,KAAK,sBAAsB,UAAU,UAAW;GAChD,UAAU,KAAK,EAAE;EACnB;EAEA,OAAO;GAAE;GAAW;EAAQ;CAC9B;CAEA,MAAM,iBAAiB,UAAgE;EACrF,IAAI,CAAC,KAAK,UACR,MAAM,KAAK,cAAc;EAE3B,UAAU,KAAK,UAAU,wBAAqB;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,iBAAA,wBAAA;EAAA,CAAC;EAE/C,KAAK,SAAS,QAAQ,QAA2B;GAC/C,MAAM,sBAAsB,IAAI,UAAU,KAAK,OAAO,WAAW;GACjE,uBAAuB,SAAS,mBAAmB;EACrD,CAAC;EACD,MAAM,KAAK,SAAS,UAAU;EAC9B,KAAK,sBAAsB,KAAK,SAAS,UAAW;CACtD;;;;CAKA,MAAM,UAAyB;EAC7B,IAAI,CAAC,KAAK,UACR,MAAM,KAAK,cAAc;EAE3B,UAAU,KAAK,UAAU,wBAAqB;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,iBAAA,wBAAA;EAAA,CAAC;EAE/C,MAAM,KAAK,OAAO,GAAG,MAAM;EAG3B,UAAU,KAAK,SAAS,KAAK,8BAA2B;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,qBAAA,8BAAA;EAAA,CAAC;EACzD,MAAM,KAAK,OAAO,SAAS,YAAY;GACrC,WAAW,mBAAmB,UAAU;GACxC,kBAAkB,KAAK,SAAS;EAClC,CAAC;CACH;CAEA,MAAc,4BAA4B,IAAoE;EAC5G,MAAM,cAAc,KAAK,SAAS,QAAQ,OAAO,KAAK,UAAU,IAAA,EAAM,SAAS;EAC/E,MAAM,YAAY,cAAc,KAAK,MAAM,KAAK,UAAU;EAC1D,IAAI,CAAC,WACH;EAGF,MAAM,UAAU,UAAU;EAC1B,OAAO;CACT;CAEA,MAAc,gBAA+B;EAC3C,MAAM,QAAQ,EAAE,GAAI,KAAK,SAAS,SAAS,CAAC,EAAG;EAC/C,KAAK,MAAM,MAAM,KAAK,gBACpB,OAAO,MAAM;EAGf,KAAK,MAAM,CAAC,IAAI,QAAQ,OAAO,QAAQ,KAAK,SAAS,GACnD,MAAM,MAAM,IAAI,KAAE,UAAU,GAAG;EAGjC,KAAK,WAAW,KAAK,MAAM,OAA0B;GACnD,SAAS,gBAAgB;GACzB,QAAQ,KAAK,YAAY;GACzB,SAAS,KAAK,SAAS;GACvB;EACF,CAAC;EACD,MAAM,KAAK,SAAS,UAAU;EAC9B,KAAK,sBAAsB,KAAK,SAAS,UAAW;CACtD;CAEA,MAAc,cAAc,EAC1B,IACA,QACA,SAKsB;EACtB,MAAM,OAAO,IAAI,WAAW;EAC5B,IAAI,IACF,KAAK,KAAK;EAGZ,KAAK,cAAc,KAAK;EACxB,KAAK,QAAQ,iBAAiB,QAAQ,aAAa,MAAM,CAAE,CAAC;EAC5D,MAAM,YAAY,KAAK,MAAM,OAA0B;GACrD,SAAS,gBAAgB;GACzB,QAAQ,KAAK,YAAY;GACzB,SAAS,GACN,KAAK,KAAK,KAAK,OAAO,EACzB;EACF,CAAC;EACD,MAAM,UAAU,UAAU;EAC1B,KAAK,UAAU,KAAK,MAAM,UAAU;EACpC,KAAK,sBAAsB,UAAU,UAAW;EAEhD,OAAO;CACT;CAEA,cAAgE;EAC9D,OAAO;GACL,SAAS,KAAK,OAAO;GAErB,UAAU,KAAK,OAAO,IAAI,MAAM;EAClC;CACF;CAEA,sBAA8B,IAAsB;EAClD,KAAK,UAAU,KAAK,EAAE;CACxB;AACF;;;;;;;;ACpOA,IAAa,iCAAiC,OAC5C,OACA,UAAmC,CAAC,MACA;CACpC,UAAU,MAAM,MAAM,IAAI,MAAM,WAAW,aAAa,mDAAgD;EAAA,YAAA;EAAA,GAAA;EAAA,GAAA;EAAA,GAAA,KAAA;EAAA,GAAA,CAAA,gDAAA,mDAAA;CAAA,CAAC;CAEzG,MAAM,UAAU,IAAI,iBAAiB,KAAK;CAC1C,MAAM,EAAE,WAAW,YAAY,MAAM,QAAQ,uBAAuB,QAAQ,SAAS;CACrF,MAAM,QAAQ,QAAQ;CAEtB,MAAM,SAAS,MAAM,MAAM,SAAS,UAAU;CAI9C,OAAO;EAAE;EAAW;EAAS,aAHX,OAAO,OAAO,SAAS,EACrB,EAAW,QAAQ,UAAU,UAAU;CAElB;AAC3C;;;;AChBA,IAAa,aAAb,MAAwB;CACtB,OAAO;CACP,OAAO,aAA0B,CAAC;CAClC,OAAe,YAAY,SAAS,KAAK;CACzC,OAAe,aAAa,KAAK,KAA4B,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS;;;;CAKjG,WAAW,kBAAkB;EAC3B,OAAO,KAAK,aAAa,GAAG,KAAK,UAAU;CAC7C;CAEA,WAAW,gBAAgB;EACzB,OAAO,KAAK,WAAW,KAAK,WAAW,SAAS,EAAE,EAAE;CACtD;CAEA,OAAO,QAAQ,OAAuB;EAEpC,OADc,KAAK,UAAU,IAAI,KAAK,UAC/B,CAAA,CAAM,QAAQ,SAAS,MAAM,IAAI,MAAM,CAAC;CACjD;CAEA,OAAO,OAAO,WAAmB,YAA+B;EAC9D,KAAK,YAAY;EACjB,KAAK,aAAa;CACpB;CAEA,aAAa,QAAQ,OAAc,eAAmD;EACpF,UAAU,CAAC,KAAK,QAAQ,KAAK,GAAG,6BAA0B;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,wBAAA,6BAAA;EAAA,CAAC;EAC3D,UAAU,MAAM,MAAM,IAAI,MAAM,WAAW,aAAa,mBAAgB;GAAA,YAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA;GAAA,GAAA,CAAA,gDAAA,mBAAA;EAAA,CAAC;EACzE,MAAM,iBAAiB,WAAW,IAAI,MAAM,YAAY,0BAA0B,CAAC,CAAC,KAAK,OAAO,cAAc;EAC9G,MAAM,eAAe,KAAK,WAAW,WAAW,MAAM,EAAE,YAAY,cAAc,IAAI;EACtF,MAAM,IAAI,KAAK,WAAW,WAAW,MAAM,EAAE,YAAY,aAAa;EACtE,MAAM,cAAc,MAAM,KAAK,KAAK,WAAW,SAAS,IAAI;EAC5D,IAAI,iBAAiB,aACnB,OAAO;EAGT,MAAM,WAAW,MAAM,IAAI,MAAM;EACjC,MAAM,eAAe,KAAK,UAAU,IAAI,KAAK,UAAU;EACvD,KAAK,UAAU,IAAI,KAAK,YAAY,EAAE,SAAS,CAAC,GAAG,aAAa,SAAS,QAAQ,EAAE,CAAC;EACpF,IAAI;GACF,IAAI,cAAc,cAAc;IAC9B,MAAM,aAAa,KAAK,WAAW,MAAM,cAAc,WAAW;IAClE,KAAK,MAAM,aAAa,YAAY;KAClC,MAAM,UAAU,IAAI,iBAAiB,KAAK;KAC1C,MAAM,UAAU,KAAK;MAAE;MAAO;KAAQ,CAAC;KACvC,MAAM,QAAQ,QAAQ;KACtB,IAAI,OAAO,MAAM,aAAa,eAAe;MAC3C,WAAW,IAAI,YAAY,4BAA4B,UAAU,OAAO;KAC1E,CAAC;IACH;GACF;EACF,UAAU;GACR,MAAM,aAAa,KAAK,UAAU,IAAI,KAAK,UAAU;GACrD,KAAK,UAAU,IAAI,KAAK,YAAY,EAAE,SAAS,WAAW,QAAQ,QAAQ,QAAQ,QAAQ,QAAQ,EAAE,CAAC;EACvG;EAEA,OAAO;CACT;AACF"}

package/dist/types/src/migration-builder.d.ts

@@ -31,6 +31,7 @@ export declare class MigrationBuilder {
     private _findObjectContainingHandle;
     private _buildNewRoot;
     private _createObject;
+    private _makeAccess;
     private _addHandleToFlushList;
 }
 //# sourceMappingURL=migration-builder.d.ts.map

package/dist/types/src/migration-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration-builder.d.ts","sourceRoot":"","sources":["../../../src/migration-builder.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG/C,OAAO,EAA0B,gBAAgB,EAAE,KAAK,eAAe,EAAmB,MAAM,qBAAqB,CAAC;AAEtH,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAGxC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAoB/C,qBAAa,gBAAgB;IAWf,OAAO,CAAC,QAAQ,CAAC,MAAM;IAVnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyB;IAGlD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8B;IACxD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAE/C,OAAO,CAAC,QAAQ,CAAC,CAAgD;IAEjE,YAA6B,MAAM,EAAE,KAAK,EAKzC;IAEK,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAUjE;IAEK,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,YAAY,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC,GAChG,OAAO,CAAC,IAAI,CAAC,CAmCf;IAEK,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAIjE;IAED,eAAe,CAAC,EAAE,EAAE,MAAM,oBAGzB;IAED,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAE7B;IAED;;;OAGG;IACG,sBAAsB,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAuBtG;IAEK,gBAAgB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAYrF;YAqBa,2BAA2B;YAW3B,aAAa;YAsBb,aAAa;IAgC3B,OAAO,CAAC,qBAAqB;CAG9B"}
+{"version":3,"file":"migration-builder.d.ts","sourceRoot":"","sources":["../../../src/migration-builder.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG/C,OAAO,EAA0B,gBAAgB,EAAE,KAAK,eAAe,EAAmB,MAAM,qBAAqB,CAAC;AAEtH,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAGxC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAoB/C,qBAAa,gBAAgB;IAWf,OAAO,CAAC,QAAQ,CAAC,MAAM;IAVnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyB;IAGlD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8B;IACxD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAE/C,OAAO,CAAC,QAAQ,CAAC,CAAgD;IAEjE,YAA6B,MAAM,EAAE,KAAK,EAKzC;IAEK,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAUjE;IAEK,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,YAAY,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC,GAChG,OAAO,CAAC,IAAI,CAAC,CAiCf;IAEK,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAIjE;IAED,eAAe,CAAC,EAAE,EAAE,MAAM,oBAGzB;IAED,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAE7B;IAED;;;OAGG;IACG,sBAAsB,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAyBtG;IAEK,gBAAgB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAYrF;YAqBa,2BAA2B;YAW3B,aAAa;YAoBb,aAAa;IA8B3B,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,qBAAqB;CAG9B"}