@dxos/migrations 0.5.8 → 0.5.9-main.0a0e87d

package/dist/lib/browser/index.mjs

@@ -1,35 +1,193 @@
-// packages/sdk/migrations/src/migrations.ts
-import { SpaceState } from "@dxos/client/echo";
+// packages/sdk/migrations/src/migration-builder.ts
+import { getHeads } from "@dxos/automerge/automerge";
+import { CreateEpochRequest } from "@dxos/client/halo";
+import { ObjectCore } from "@dxos/echo-db";
+import { requireTypeReference } from "@dxos/echo-schema";
 import { invariant } from "@dxos/invariant";
-var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
+var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migration-builder.ts";
+var MigrationBuilder = class {
+  constructor(_space) {
+    this._space = _space;
+    this._newLinks = {};
+    this._flushStates = [];
+    this._deleteObjects = [];
+    this._newRoot = void 0;
+    this._repo = this._space.db.coreDatabase.automerge.repo;
+    this._automergeContext = this._space.db.coreDatabase.automerge;
+    this._rootDoc = this._space.db.coreDatabase._automergeDocLoader.getSpaceRootDocHandle().docSync();
+  }
+  async findObject(id) {
+    const documentId = this._rootDoc.links?.[id] || this._newLinks[id];
+    const docHandle = documentId && this._repo.find(documentId);
+    if (!docHandle) {
+      return void 0;
+    }
+    await docHandle.whenReady();
+    const doc = docHandle.docSync();
+    return doc.objects?.[id];
+  }
+  async migrateObject(id, migrate) {
+    const objectStructure = await this.findObject(id);
+    if (!objectStructure) {
+      return;
+    }
+    const { schema, props } = migrate(objectStructure);
+    this._createObject({
+      id,
+      schema,
+      props
+    });
+  }
+  addObject(schema, props) {
+    const core = this._createObject({
+      schema,
+      props
+    });
+    return core.id;
+  }
+  deleteObject(id) {
+    this._deleteObjects.push(id);
+  }
+  changeProperties(changeFn) {
+    if (!this._newRoot) {
+      this._buildNewRoot();
+    }
+    invariant(this._newRoot, "New root not created", {
+      F: __dxlog_file,
+      L: 74,
+      S: this,
+      A: [
+        "this._newRoot",
+        "'New root not created'"
+      ]
+    });
+    this._newRoot.change((doc) => {
+      const propertiesStructure = doc.objects?.[this._space.properties.id];
+      propertiesStructure && changeFn(propertiesStructure);
+    });
+    this._flushStates.push({
+      documentId: this._newRoot.documentId,
+      heads: getHeads(this._newRoot.docSync())
+    });
+  }
+  /**
+  * @internal
+  */
+  async _commit() {
+    if (!this._newRoot) {
+      this._buildNewRoot();
+    }
+    invariant(this._newRoot, "New root not created", {
+      F: __dxlog_file,
+      L: 93,
+      S: this,
+      A: [
+        "this._newRoot",
+        "'New root not created'"
+      ]
+    });
+    await this._automergeContext.flush({
+      states: this._flushStates
+    });
+    await this._space.internal.createEpoch({
+      migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,
+      automergeRootUrl: this._newRoot.url
+    });
+  }
+  _buildNewRoot() {
+    const previousLinks = {
+      ...this._rootDoc.links ?? {}
+    };
+    for (const id of this._deleteObjects) {
+      delete previousLinks[id];
+    }
+    this._newRoot = this._repo.create({
+      access: {
+        spaceKey: this._space.key.toHex()
+      },
+      objects: this._rootDoc.objects,
+      links: {
+        ...previousLinks,
+        ...this._newLinks
+      }
+    });
+    this._flushStates.push({
+      documentId: this._newRoot.documentId,
+      heads: getHeads(this._newRoot.docSync())
+    });
+  }
+  _createObject({ id, schema, props }) {
+    const core = new ObjectCore();
+    if (id) {
+      core.id = id;
+    }
+    core.initNewObject(props);
+    core.setType(requireTypeReference(schema));
+    const newHandle = this._repo.create({
+      access: {
+        spaceKey: this._space.key.toHex()
+      },
+      objects: {
+        [core.id]: core.getDoc()
+      }
+    });
+    this._newLinks[core.id] = newHandle.url;
+    this._flushStates.push({
+      documentId: newHandle.documentId,
+      heads: getHeads(newHandle.docSync())
+    });
+    return core;
+  }
+};
+
+// packages/sdk/migrations/src/migrations.ts
+import { create, SpaceState } from "@dxos/client/echo";
+import { invariant as invariant2 } from "@dxos/invariant";
+var __dxlog_file2 = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
 var Migrations = class {
   static {
     this.migrations = [];
   }
+  static {
+    this._state = create({
+      running: []
+    });
+  }
   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._state.running.includes(space.key.toHex());
+  }
   static define(namespace, migrations) {
     this.namespace = namespace;
     this.migrations = migrations;
   }
-  // TODO(wittjosiah): Multi-space migrations.
   static async migrate(space, targetVersion) {
-    invariant(this.versionProperty, "Migrations namespace not set", {
-      F: __dxlog_file,
-      L: 40,
+    invariant2(!this.running(space), "Migration already running", {
+      F: __dxlog_file2,
+      L: 44,
+      S: this,
+      A: [
+        "!this.running(space)",
+        "'Migration already running'"
+      ]
+    });
+    invariant2(this.versionProperty, "Migrations namespace not set", {
+      F: __dxlog_file2,
+      L: 45,
       S: this,
       A: [
         "this.versionProperty",
         "'Migrations namespace not set'"
       ]
     });
-    invariant(space.state.get() === SpaceState.READY, "Space not ready", {
-      F: __dxlog_file,
-      L: 41,
+    invariant2(space.state.get() === SpaceState.READY, "Space not ready", {
+      F: __dxlog_file2,
+      L: 46,
       S: this,
       A: [
         "space.state.get() === SpaceState.READY",
@@ -43,29 +201,36 @@ var Migrations = class {
     if (currentIndex === targetIndex) {
       return false;
     }
+    this._state.running.push(space.key.toHex());
     if (targetIndex > currentIndex) {
       const migrations = this.migrations.slice(currentIndex, targetIndex);
       for (const migration of migrations) {
-        await migration.up({
-          space
+        const builder = new MigrationBuilder(space);
+        await migration.next({
+          space,
+          builder
         });
-        space.properties[this.versionProperty] = migration.version;
-      }
-    } else {
-      const migrations = this.migrations.slice(targetIndex, currentIndex);
-      migrations.reverse();
-      for (const migration of migrations) {
-        await migration.down({
-          space
+        builder.changeProperties((propertiesStructure) => {
+          invariant2(this.versionProperty, "Migrations namespace not set", {
+            F: __dxlog_file2,
+            L: 62,
+            S: this,
+            A: [
+              "this.versionProperty",
+              "'Migrations namespace not set'"
+            ]
+          });
+          propertiesStructure.data[this.versionProperty] = migration.version;
         });
-        const index = this.migrations.indexOf(migration);
-        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;
+        await builder._commit();
       }
     }
+    this._state.running.splice(this._state.running.indexOf(space.key.toHex()), 1);
     return true;
   }
 };
 export {
+  MigrationBuilder,
   Migrations
 };
 //# sourceMappingURL=index.mjs.map

package/dist/lib/browser/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../../src/migrations.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Space, SpaceState } from '@dxos/client/echo';\nimport { invariant } from '@dxos/invariant';\nimport { type MaybePromise } from '@dxos/util';\n\n// TODO(burdon): Merge with successor to serialization mechanism in braneframe/types.\n\nexport type MigrationContext = {\n  space: Space;\n};\n\nexport type Migration = {\n  version: string | number;\n  up: (context: MigrationContext) => MaybePromise<void>;\n  down: (context: MigrationContext) => MaybePromise<void>;\n};\n\nexport class Migrations {\n  static namespace?: string;\n  static migrations: Migration[] = [];\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 define(namespace: string, migrations: Migration[]) {\n    this.namespace = namespace;\n    this.migrations = migrations;\n  }\n\n  // TODO(wittjosiah): Multi-space migrations.\n  static async migrate(space: Space, targetVersion?: string | number) {\n    invariant(this.versionProperty, 'Migrations namespace not set');\n    invariant(space.state.get() === SpaceState.READY, 'Space not ready');\n    const currentVersion = space.properties[this.versionProperty];\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    if (targetIndex > currentIndex) {\n      const migrations = this.migrations.slice(currentIndex, targetIndex);\n      for (const migration of migrations) {\n        await migration.up({ space });\n        space.properties[this.versionProperty] = migration.version;\n      }\n    } else {\n      const migrations = this.migrations.slice(targetIndex, currentIndex);\n      migrations.reverse();\n      for (const migration of migrations) {\n        await migration.down({ space });\n        const index = this.migrations.indexOf(migration);\n        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;\n      }\n    }\n\n    return true;\n  }\n}\n"],
-  "mappings": ";AAIA,SAAqBA,kBAAkB;AACvC,SAASC,iBAAiB;;AAenB,IAAMC,aAAN,MAAMA;EAEX;SAAOC,aAA0B,CAAA;;EAEjC,WAAWC,kBAAkB;AAC3B,WAAO,KAAKC,aAAa,GAAG,KAAKA,SAAS;EAC5C;EAEA,WAAWC,gBAAgB;AACzB,WAAO,KAAKH,WAAW,KAAKA,WAAWI,SAAS,CAAA,EAAGC;EACrD;EAEA,OAAOC,OAAOJ,WAAmBF,YAAyB;AACxD,SAAKE,YAAYA;AACjB,SAAKF,aAAaA;EACpB;;EAGA,aAAaO,QAAQC,OAAcL,eAAiC;AAClEL,cAAU,KAAKG,iBAAiB,gCAAA;;;;;;;;;AAChCH,cAAUU,MAAMC,MAAMC,IAAG,MAAOb,WAAWc,OAAO,mBAAA;;;;;;;;;AAClD,UAAMC,iBAAiBJ,MAAMK,WAAW,KAAKZ,eAAe;AAC5D,UAAMa,eAAe,KAAKd,WAAWe,UAAU,CAACC,MAAMA,EAAEX,YAAYO,cAAAA,IAAkB;AACtF,UAAMK,IAAI,KAAKjB,WAAWe,UAAU,CAACC,MAAMA,EAAEX,YAAYF,aAAAA;AACzD,UAAMe,cAAcD,MAAM,KAAK,KAAKjB,WAAWI,SAASa,IAAI;AAC5D,QAAIH,iBAAiBI,aAAa;AAChC,aAAO;IACT;AAEA,QAAIA,cAAcJ,cAAc;AAC9B,YAAMd,aAAa,KAAKA,WAAWmB,MAAML,cAAcI,WAAAA;AACvD,iBAAWE,aAAapB,YAAY;AAClC,cAAMoB,UAAUC,GAAG;UAAEb;QAAM,CAAA;AAC3BA,cAAMK,WAAW,KAAKZ,eAAe,IAAImB,UAAUf;MACrD;IACF,OAAO;AACL,YAAML,aAAa,KAAKA,WAAWmB,MAAMD,aAAaJ,YAAAA;AACtDd,iBAAWsB,QAAO;AAClB,iBAAWF,aAAapB,YAAY;AAClC,cAAMoB,UAAUG,KAAK;UAAEf;QAAM,CAAA;AAC7B,cAAMgB,QAAQ,KAAKxB,WAAWyB,QAAQL,SAAAA;AACtCZ,cAAMK,WAAW,KAAKZ,eAAe,IAAI,KAAKD,WAAWwB,QAAQ,CAAA,GAAInB;MACvE;IACF;AAEA,WAAO;EACT;AACF;",
-  "names": ["SpaceState", "invariant", "Migrations", "migrations", "versionProperty", "namespace", "targetVersion", "length", "version", "define", "migrate", "space", "state", "get", "READY", "currentVersion", "properties", "currentIndex", "findIndex", "m", "i", "targetIndex", "slice", "migration", "up", "reverse", "down", "index", "indexOf"]
+  "sources": ["../../../src/migration-builder.ts", "../../../src/migrations.ts"],
+  "sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport { getHeads, type Doc } from '@dxos/automerge/automerge';\nimport { type AnyDocumentId, type DocHandle, type Repo } from '@dxos/automerge/automerge-repo';\nimport { type Space } from '@dxos/client/echo';\nimport { CreateEpochRequest } from '@dxos/client/halo';\nimport { type AutomergeContext, ObjectCore } from '@dxos/echo-db';\nimport { type ObjectStructure, type SpaceDoc } from '@dxos/echo-protocol';\nimport { requireTypeReference, type S } from '@dxos/echo-schema';\nimport { invariant } from '@dxos/invariant';\nimport { type FlushRequest } from '@dxos/protocols/proto/dxos/echo/service';\n\nexport class MigrationBuilder {\n  private readonly _repo: Repo;\n  private readonly _automergeContext: AutomergeContext;\n  private readonly _rootDoc: Doc<SpaceDoc>;\n\n  // echoId -> automergeUrl\n  private readonly _newLinks: Record<string, string> = {};\n  private readonly _flushStates: FlushRequest.DocState[] = [];\n  private readonly _deleteObjects: string[] = [];\n\n  private _newRoot?: DocHandle<SpaceDoc> = undefined;\n\n  constructor(private readonly _space: Space) {\n    this._repo = this._space.db.coreDatabase.automerge.repo;\n    this._automergeContext = this._space.db.coreDatabase.automerge;\n    // TODO(wittjosiah): Accessing private API.\n    this._rootDoc = (this._space.db.coreDatabase as any)._automergeDocLoader\n      .getSpaceRootDocHandle()\n      .docSync() as Doc<SpaceDoc>;\n  }\n\n  async findObject(id: string): Promise<ObjectStructure | undefined> {\n    const documentId = (this._rootDoc.links?.[id] || this._newLinks[id]) 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.docSync() as Doc<SpaceDoc>;\n    return doc.objects?.[id];\n  }\n\n  async migrateObject(\n    id: string,\n    migrate: (objectStructure: ObjectStructure) => { schema: S.Schema<any>; props: any },\n  ) {\n    const objectStructure = await this.findObject(id);\n    if (!objectStructure) {\n      return;\n    }\n\n    const { schema, props } = migrate(objectStructure);\n    this._createObject({ id, schema, props });\n  }\n\n  addObject(schema: S.Schema<any>, props: any) {\n    const core = this._createObject({ schema, props });\n    return core.id;\n  }\n\n  deleteObject(id: string) {\n    this._deleteObjects.push(id);\n  }\n\n  changeProperties(changeFn: (properties: ObjectStructure) => void) {\n    if (!this._newRoot) {\n      this._buildNewRoot();\n    }\n    invariant(this._newRoot, 'New root not created');\n\n    this._newRoot.change((doc: SpaceDoc) => {\n      const propertiesStructure = doc.objects?.[this._space.properties.id];\n      propertiesStructure && changeFn(propertiesStructure);\n    });\n    this._flushStates.push({\n      documentId: this._newRoot.documentId,\n      heads: getHeads(this._newRoot.docSync()),\n    });\n  }\n\n  /**\n   * @internal\n   */\n  async _commit() {\n    if (!this._newRoot) {\n      this._buildNewRoot();\n    }\n    invariant(this._newRoot, 'New root not created');\n\n    await this._automergeContext.flush({\n      states: this._flushStates,\n    });\n\n    // Create new epoch.\n    await this._space.internal.createEpoch({\n      migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,\n      automergeRootUrl: this._newRoot.url,\n    });\n  }\n\n  private _buildNewRoot() {\n    const previousLinks = { ...(this._rootDoc.links ?? {}) };\n    for (const id of this._deleteObjects) {\n      delete previousLinks[id];\n    }\n\n    this._newRoot = this._repo.create<SpaceDoc>({\n      access: {\n        spaceKey: this._space.key.toHex(),\n      },\n      objects: this._rootDoc.objects,\n      links: {\n        ...previousLinks,\n        ...this._newLinks,\n      },\n    });\n    this._flushStates.push({\n      documentId: this._newRoot.documentId,\n      heads: getHeads(this._newRoot.docSync()),\n    });\n  }\n\n  private _createObject({ id, schema, props }: { id?: string; schema: S.Schema<any>; props: any }) {\n    const core = new ObjectCore();\n    if (id) {\n      core.id = id;\n    }\n\n    core.initNewObject(props);\n    core.setType(requireTypeReference(schema));\n    const newHandle = this._repo.create<SpaceDoc>({\n      access: {\n        spaceKey: this._space.key.toHex(),\n      },\n      objects: {\n        [core.id]: core.getDoc(),\n      },\n    });\n    this._newLinks[core.id] = newHandle.url;\n    this._flushStates.push({\n      documentId: newHandle.documentId,\n      heads: getHeads(newHandle.docSync()),\n    });\n\n    return core;\n  }\n}\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Space, create, SpaceState } from '@dxos/client/echo';\nimport { invariant } from '@dxos/invariant';\nimport { type MaybePromise } from '@dxos/util';\n\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 _state = create<{ running: string[] }>({ running: [] });\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) {\n    return this._state.running.includes(space.key.toHex());\n  }\n\n  static define(namespace: string, migrations: Migration[]) {\n    this.namespace = namespace;\n    this.migrations = migrations;\n  }\n\n  static async migrate(space: Space, targetVersion?: string | number) {\n    invariant(!this.running(space), 'Migration already running');\n    invariant(this.versionProperty, 'Migrations namespace not set');\n    invariant(space.state.get() === SpaceState.READY, 'Space not ready');\n    const currentVersion = space.properties[this.versionProperty];\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    this._state.running.push(space.key.toHex());\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        builder.changeProperties((propertiesStructure) => {\n          invariant(this.versionProperty, 'Migrations namespace not set');\n          propertiesStructure.data[this.versionProperty] = migration.version;\n        });\n        await builder._commit();\n      }\n    }\n    this._state.running.splice(this._state.running.indexOf(space.key.toHex()), 1);\n\n    return true;\n  }\n}\n"],
+  "mappings": ";AAIA,SAASA,gBAA0B;AAGnC,SAASC,0BAA0B;AACnC,SAAgCC,kBAAkB;AAElD,SAASC,4BAAoC;AAC7C,SAASC,iBAAiB;;AAGnB,IAAMC,mBAAN,MAAMA;EAYXC,YAA6BC,QAAe;SAAfA,SAAAA;SANZC,YAAoC,CAAC;SACrCC,eAAwC,CAAA;SACxCC,iBAA2B,CAAA;SAEpCC,WAAiCC;AAGvC,SAAKC,QAAQ,KAAKN,OAAOO,GAAGC,aAAaC,UAAUC;AACnD,SAAKC,oBAAoB,KAAKX,OAAOO,GAAGC,aAAaC;AAErD,SAAKG,WAAY,KAAKZ,OAAOO,GAAGC,aAAqBK,oBAClDC,sBAAqB,EACrBC,QAAO;EACZ;EAEA,MAAMC,WAAWC,IAAkD;AACjE,UAAMC,aAAc,KAAKN,SAASO,QAAQF,EAAAA,KAAO,KAAKhB,UAAUgB,EAAAA;AAChE,UAAMG,YAAYF,cAAc,KAAKZ,MAAMe,KAAKH,UAAAA;AAChD,QAAI,CAACE,WAAW;AACd,aAAOf;IACT;AAEA,UAAMe,UAAUE,UAAS;AACzB,UAAMC,MAAMH,UAAUL,QAAO;AAC7B,WAAOQ,IAAIC,UAAUP,EAAAA;EACvB;EAEA,MAAMQ,cACJR,IACAS,SACA;AACA,UAAMC,kBAAkB,MAAM,KAAKX,WAAWC,EAAAA;AAC9C,QAAI,CAACU,iBAAiB;AACpB;IACF;AAEA,UAAM,EAAEC,QAAQC,MAAK,IAAKH,QAAQC,eAAAA;AAClC,SAAKG,cAAc;MAAEb;MAAIW;MAAQC;IAAM,CAAA;EACzC;EAEAE,UAAUH,QAAuBC,OAAY;AAC3C,UAAMG,OAAO,KAAKF,cAAc;MAAEF;MAAQC;IAAM,CAAA;AAChD,WAAOG,KAAKf;EACd;EAEAgB,aAAahB,IAAY;AACvB,SAAKd,eAAe+B,KAAKjB,EAAAA;EAC3B;EAEAkB,iBAAiBC,UAAiD;AAChE,QAAI,CAAC,KAAKhC,UAAU;AAClB,WAAKiC,cAAa;IACpB;AACAxC,cAAU,KAAKO,UAAU,wBAAA;;;;;;;;;AAEzB,SAAKA,SAASkC,OAAO,CAACf,QAAAA;AACpB,YAAMgB,sBAAsBhB,IAAIC,UAAU,KAAKxB,OAAOwC,WAAWvB,EAAE;AACnEsB,6BAAuBH,SAASG,mBAAAA;IAClC,CAAA;AACA,SAAKrC,aAAagC,KAAK;MACrBhB,YAAY,KAAKd,SAASc;MAC1BuB,OAAOhD,SAAS,KAAKW,SAASW,QAAO,CAAA;IACvC,CAAA;EACF;;;;EAKA,MAAM2B,UAAU;AACd,QAAI,CAAC,KAAKtC,UAAU;AAClB,WAAKiC,cAAa;IACpB;AACAxC,cAAU,KAAKO,UAAU,wBAAA;;;;;;;;;AAEzB,UAAM,KAAKO,kBAAkBgC,MAAM;MACjCC,QAAQ,KAAK1C;IACf,CAAA;AAGA,UAAM,KAAKF,OAAO6C,SAASC,YAAY;MACrCC,WAAWrD,mBAAmBsD,UAAUC;MACxCC,kBAAkB,KAAK9C,SAAS+C;IAClC,CAAA;EACF;EAEQd,gBAAgB;AACtB,UAAMe,gBAAgB;MAAE,GAAI,KAAKxC,SAASO,SAAS,CAAC;IAAG;AACvD,eAAWF,MAAM,KAAKd,gBAAgB;AACpC,aAAOiD,cAAcnC,EAAAA;IACvB;AAEA,SAAKb,WAAW,KAAKE,MAAM+C,OAAiB;MAC1CC,QAAQ;QACNC,UAAU,KAAKvD,OAAOwD,IAAIC,MAAK;MACjC;MACAjC,SAAS,KAAKZ,SAASY;MACvBL,OAAO;QACL,GAAGiC;QACH,GAAG,KAAKnD;MACV;IACF,CAAA;AACA,SAAKC,aAAagC,KAAK;MACrBhB,YAAY,KAAKd,SAASc;MAC1BuB,OAAOhD,SAAS,KAAKW,SAASW,QAAO,CAAA;IACvC,CAAA;EACF;EAEQe,cAAc,EAAEb,IAAIW,QAAQC,MAAK,GAAwD;AAC/F,UAAMG,OAAO,IAAIrC,WAAAA;AACjB,QAAIsB,IAAI;AACNe,WAAKf,KAAKA;IACZ;AAEAe,SAAK0B,cAAc7B,KAAAA;AACnBG,SAAK2B,QAAQ/D,qBAAqBgC,MAAAA,CAAAA;AAClC,UAAMgC,YAAY,KAAKtD,MAAM+C,OAAiB;MAC5CC,QAAQ;QACNC,UAAU,KAAKvD,OAAOwD,IAAIC,MAAK;MACjC;MACAjC,SAAS;QACP,CAACQ,KAAKf,EAAE,GAAGe,KAAK6B,OAAM;MACxB;IACF,CAAA;AACA,SAAK5D,UAAU+B,KAAKf,EAAE,IAAI2C,UAAUT;AACpC,SAAKjD,aAAagC,KAAK;MACrBhB,YAAY0C,UAAU1C;MACtBuB,OAAOhD,SAASmE,UAAU7C,QAAO,CAAA;IACnC,CAAA;AAEA,WAAOiB;EACT;AACF;;;ACnJA,SAAqB8B,QAAQC,kBAAkB;AAC/C,SAASC,aAAAA,kBAAiB;;AAenB,IAAMC,aAAN,MAAMA;EAEX;SAAOC,aAA0B,CAAA;;EACjC;SAAeC,SAASC,OAA8B;MAAEC,SAAS,CAAA;IAAG,CAAA;;EAEpE,WAAWC,kBAAkB;AAC3B,WAAO,KAAKC,aAAa,GAAG,KAAKA,SAAS;EAC5C;EAEA,WAAWC,gBAAgB;AACzB,WAAO,KAAKN,WAAW,KAAKA,WAAWO,SAAS,CAAA,EAAGC;EACrD;EAEA,OAAOL,QAAQM,OAAc;AAC3B,WAAO,KAAKR,OAAOE,QAAQO,SAASD,MAAME,IAAIC,MAAK,CAAA;EACrD;EAEA,OAAOC,OAAOR,WAAmBL,YAAyB;AACxD,SAAKK,YAAYA;AACjB,SAAKL,aAAaA;EACpB;EAEA,aAAac,QAAQL,OAAcH,eAAiC;AAClES,IAAAA,WAAU,CAAC,KAAKZ,QAAQM,KAAAA,GAAQ,6BAAA;;;;;;;;;AAChCM,IAAAA,WAAU,KAAKX,iBAAiB,gCAAA;;;;;;;;;AAChCW,IAAAA,WAAUN,MAAMO,MAAMC,IAAG,MAAOC,WAAWC,OAAO,mBAAA;;;;;;;;;AAClD,UAAMC,iBAAiBX,MAAMY,WAAW,KAAKjB,eAAe;AAC5D,UAAMkB,eAAe,KAAKtB,WAAWuB,UAAU,CAACC,MAAMA,EAAEhB,YAAYY,cAAAA,IAAkB;AACtF,UAAMK,IAAI,KAAKzB,WAAWuB,UAAU,CAACC,MAAMA,EAAEhB,YAAYF,aAAAA;AACzD,UAAMoB,cAAcD,MAAM,KAAK,KAAKzB,WAAWO,SAASkB,IAAI;AAC5D,QAAIH,iBAAiBI,aAAa;AAChC,aAAO;IACT;AAEA,SAAKzB,OAAOE,QAAQwB,KAAKlB,MAAME,IAAIC,MAAK,CAAA;AACxC,QAAIc,cAAcJ,cAAc;AAC9B,YAAMtB,aAAa,KAAKA,WAAW4B,MAAMN,cAAcI,WAAAA;AACvD,iBAAWG,aAAa7B,YAAY;AAClC,cAAM8B,UAAU,IAAIC,iBAAiBtB,KAAAA;AACrC,cAAMoB,UAAUG,KAAK;UAAEvB;UAAOqB;QAAQ,CAAA;AACtCA,gBAAQG,iBAAiB,CAACC,wBAAAA;AACxBnB,UAAAA,WAAU,KAAKX,iBAAiB,gCAAA;;;;;;;;;AAChC8B,8BAAoBC,KAAK,KAAK/B,eAAe,IAAIyB,UAAUrB;QAC7D,CAAA;AACA,cAAMsB,QAAQM,QAAO;MACvB;IACF;AACA,SAAKnC,OAAOE,QAAQkC,OAAO,KAAKpC,OAAOE,QAAQmC,QAAQ7B,MAAME,IAAIC,MAAK,CAAA,GAAK,CAAA;AAE3E,WAAO;EACT;AACF;",
+  "names": ["getHeads", "CreateEpochRequest", "ObjectCore", "requireTypeReference", "invariant", "MigrationBuilder", "constructor", "_space", "_newLinks", "_flushStates", "_deleteObjects", "_newRoot", "undefined", "_repo", "db", "coreDatabase", "automerge", "repo", "_automergeContext", "_rootDoc", "_automergeDocLoader", "getSpaceRootDocHandle", "docSync", "findObject", "id", "documentId", "links", "docHandle", "find", "whenReady", "doc", "objects", "migrateObject", "migrate", "objectStructure", "schema", "props", "_createObject", "addObject", "core", "deleteObject", "push", "changeProperties", "changeFn", "_buildNewRoot", "change", "propertiesStructure", "properties", "heads", "_commit", "flush", "states", "internal", "createEpoch", "migration", "Migration", "REPLACE_AUTOMERGE_ROOT", "automergeRootUrl", "url", "previousLinks", "create", "access", "spaceKey", "key", "toHex", "initNewObject", "setType", "newHandle", "getDoc", "create", "SpaceState", "invariant", "Migrations", "migrations", "_state", "create", "running", "versionProperty", "namespace", "targetVersion", "length", "version", "space", "includes", "key", "toHex", "define", "migrate", "invariant", "state", "get", "SpaceState", "READY", "currentVersion", "properties", "currentIndex", "findIndex", "m", "i", "targetIndex", "push", "slice", "migration", "builder", "MigrationBuilder", "next", "changeProperties", "propertiesStructure", "data", "_commit", "splice", "indexOf"]
 }

package/dist/lib/browser/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/sdk/migrations/src/migrations.ts":{"bytes":8236,"imports":[{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"format":"esm"},"packages/sdk/migrations/src/index.ts":{"bytes":501,"imports":[{"path":"packages/sdk/migrations/src/migrations.ts","kind":"import-statement","original":"./migrations"}],"format":"esm"}},"outputs":{"packages/sdk/migrations/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3895},"packages/sdk/migrations/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"exports":["Migrations"],"entryPoint":"packages/sdk/migrations/src/index.ts","inputs":{"packages/sdk/migrations/src/migrations.ts":{"bytesInOutput":2163},"packages/sdk/migrations/src/index.ts":{"bytesInOutput":0}},"bytes":2268}}}
+{"inputs":{"packages/sdk/migrations/src/migration-builder.ts":{"bytes":16903,"imports":[{"path":"@dxos/automerge/automerge","kind":"import-statement","external":true},{"path":"@dxos/client/halo","kind":"import-statement","external":true},{"path":"@dxos/echo-db","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"format":"esm"},"packages/sdk/migrations/src/migrations.ts":{"bytes":9817,"imports":[{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"packages/sdk/migrations/src/migration-builder.ts","kind":"import-statement","original":"./migration-builder"}],"format":"esm"},"packages/sdk/migrations/src/index.ts":{"bytes":698,"imports":[{"path":"packages/sdk/migrations/src/migration-builder.ts","kind":"import-statement","original":"./migration-builder"},{"path":"packages/sdk/migrations/src/migrations.ts","kind":"import-statement","original":"./migrations"}],"format":"esm"}},"outputs":{"packages/sdk/migrations/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":12698},"packages/sdk/migrations/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/automerge/automerge","kind":"import-statement","external":true},{"path":"@dxos/client/halo","kind":"import-statement","external":true},{"path":"@dxos/echo-db","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"exports":["MigrationBuilder","Migrations"],"entryPoint":"packages/sdk/migrations/src/index.ts","inputs":{"packages/sdk/migrations/src/migration-builder.ts":{"bytesInOutput":3783},"packages/sdk/migrations/src/index.ts":{"bytesInOutput":0},"packages/sdk/migrations/src/migrations.ts":{"bytesInOutput":2745}},"bytes":6706}}}

package/dist/lib/node/index.cjs

@@ -18,40 +18,197 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var node_exports = {};
 __export(node_exports, {
+  MigrationBuilder: () => MigrationBuilder,
   Migrations: () => Migrations
 });
 module.exports = __toCommonJS(node_exports);
-var import_echo = require("@dxos/client/echo");
+var import_automerge = require("@dxos/automerge/automerge");
+var import_halo = require("@dxos/client/halo");
+var import_echo_db = require("@dxos/echo-db");
+var import_echo_schema = require("@dxos/echo-schema");
 var import_invariant = require("@dxos/invariant");
-var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
+var import_echo = require("@dxos/client/echo");
+var import_invariant2 = require("@dxos/invariant");
+var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migration-builder.ts";
+var MigrationBuilder = class {
+  constructor(_space) {
+    this._space = _space;
+    this._newLinks = {};
+    this._flushStates = [];
+    this._deleteObjects = [];
+    this._newRoot = void 0;
+    this._repo = this._space.db.coreDatabase.automerge.repo;
+    this._automergeContext = this._space.db.coreDatabase.automerge;
+    this._rootDoc = this._space.db.coreDatabase._automergeDocLoader.getSpaceRootDocHandle().docSync();
+  }
+  async findObject(id) {
+    const documentId = this._rootDoc.links?.[id] || this._newLinks[id];
+    const docHandle = documentId && this._repo.find(documentId);
+    if (!docHandle) {
+      return void 0;
+    }
+    await docHandle.whenReady();
+    const doc = docHandle.docSync();
+    return doc.objects?.[id];
+  }
+  async migrateObject(id, migrate) {
+    const objectStructure = await this.findObject(id);
+    if (!objectStructure) {
+      return;
+    }
+    const { schema, props } = migrate(objectStructure);
+    this._createObject({
+      id,
+      schema,
+      props
+    });
+  }
+  addObject(schema, props) {
+    const core = this._createObject({
+      schema,
+      props
+    });
+    return core.id;
+  }
+  deleteObject(id) {
+    this._deleteObjects.push(id);
+  }
+  changeProperties(changeFn) {
+    if (!this._newRoot) {
+      this._buildNewRoot();
+    }
+    (0, import_invariant.invariant)(this._newRoot, "New root not created", {
+      F: __dxlog_file,
+      L: 74,
+      S: this,
+      A: [
+        "this._newRoot",
+        "'New root not created'"
+      ]
+    });
+    this._newRoot.change((doc) => {
+      const propertiesStructure = doc.objects?.[this._space.properties.id];
+      propertiesStructure && changeFn(propertiesStructure);
+    });
+    this._flushStates.push({
+      documentId: this._newRoot.documentId,
+      heads: (0, import_automerge.getHeads)(this._newRoot.docSync())
+    });
+  }
+  /**
+  * @internal
+  */
+  async _commit() {
+    if (!this._newRoot) {
+      this._buildNewRoot();
+    }
+    (0, import_invariant.invariant)(this._newRoot, "New root not created", {
+      F: __dxlog_file,
+      L: 93,
+      S: this,
+      A: [
+        "this._newRoot",
+        "'New root not created'"
+      ]
+    });
+    await this._automergeContext.flush({
+      states: this._flushStates
+    });
+    await this._space.internal.createEpoch({
+      migration: import_halo.CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,
+      automergeRootUrl: this._newRoot.url
+    });
+  }
+  _buildNewRoot() {
+    const previousLinks = {
+      ...this._rootDoc.links ?? {}
+    };
+    for (const id of this._deleteObjects) {
+      delete previousLinks[id];
+    }
+    this._newRoot = this._repo.create({
+      access: {
+        spaceKey: this._space.key.toHex()
+      },
+      objects: this._rootDoc.objects,
+      links: {
+        ...previousLinks,
+        ...this._newLinks
+      }
+    });
+    this._flushStates.push({
+      documentId: this._newRoot.documentId,
+      heads: (0, import_automerge.getHeads)(this._newRoot.docSync())
+    });
+  }
+  _createObject({ id, schema, props }) {
+    const core = new import_echo_db.ObjectCore();
+    if (id) {
+      core.id = id;
+    }
+    core.initNewObject(props);
+    core.setType((0, import_echo_schema.requireTypeReference)(schema));
+    const newHandle = this._repo.create({
+      access: {
+        spaceKey: this._space.key.toHex()
+      },
+      objects: {
+        [core.id]: core.getDoc()
+      }
+    });
+    this._newLinks[core.id] = newHandle.url;
+    this._flushStates.push({
+      documentId: newHandle.documentId,
+      heads: (0, import_automerge.getHeads)(newHandle.docSync())
+    });
+    return core;
+  }
+};
+var __dxlog_file2 = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
 var Migrations = class {
   static {
     this.migrations = [];
   }
+  static {
+    this._state = (0, import_echo.create)({
+      running: []
+    });
+  }
   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._state.running.includes(space.key.toHex());
+  }
   static define(namespace, migrations) {
     this.namespace = namespace;
     this.migrations = migrations;
   }
-  // TODO(wittjosiah): Multi-space migrations.
   static async migrate(space, targetVersion) {
-    (0, import_invariant.invariant)(this.versionProperty, "Migrations namespace not set", {
-      F: __dxlog_file,
-      L: 40,
+    (0, import_invariant2.invariant)(!this.running(space), "Migration already running", {
+      F: __dxlog_file2,
+      L: 44,
+      S: this,
+      A: [
+        "!this.running(space)",
+        "'Migration already running'"
+      ]
+    });
+    (0, import_invariant2.invariant)(this.versionProperty, "Migrations namespace not set", {
+      F: __dxlog_file2,
+      L: 45,
       S: this,
       A: [
         "this.versionProperty",
         "'Migrations namespace not set'"
       ]
     });
-    (0, import_invariant.invariant)(space.state.get() === import_echo.SpaceState.READY, "Space not ready", {
-      F: __dxlog_file,
-      L: 41,
+    (0, import_invariant2.invariant)(space.state.get() === import_echo.SpaceState.READY, "Space not ready", {
+      F: __dxlog_file2,
+      L: 46,
       S: this,
       A: [
         "space.state.get() === SpaceState.READY",
@@ -65,30 +222,37 @@ var Migrations = class {
     if (currentIndex === targetIndex) {
       return false;
     }
+    this._state.running.push(space.key.toHex());
     if (targetIndex > currentIndex) {
       const migrations = this.migrations.slice(currentIndex, targetIndex);
       for (const migration of migrations) {
-        await migration.up({
-          space
+        const builder = new MigrationBuilder(space);
+        await migration.next({
+          space,
+          builder
         });
-        space.properties[this.versionProperty] = migration.version;
-      }
-    } else {
-      const migrations = this.migrations.slice(targetIndex, currentIndex);
-      migrations.reverse();
-      for (const migration of migrations) {
-        await migration.down({
-          space
+        builder.changeProperties((propertiesStructure) => {
+          (0, import_invariant2.invariant)(this.versionProperty, "Migrations namespace not set", {
+            F: __dxlog_file2,
+            L: 62,
+            S: this,
+            A: [
+              "this.versionProperty",
+              "'Migrations namespace not set'"
+            ]
+          });
+          propertiesStructure.data[this.versionProperty] = migration.version;
         });
-        const index = this.migrations.indexOf(migration);
-        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;
+        await builder._commit();
       }
     }
+    this._state.running.splice(this._state.running.indexOf(space.key.toHex()), 1);
     return true;
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  MigrationBuilder,
   Migrations
 });
 //# sourceMappingURL=index.cjs.map

package/dist/lib/node/index.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../../src/migrations.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Space, SpaceState } from '@dxos/client/echo';\nimport { invariant } from '@dxos/invariant';\nimport { type MaybePromise } from '@dxos/util';\n\n// TODO(burdon): Merge with successor to serialization mechanism in braneframe/types.\n\nexport type MigrationContext = {\n  space: Space;\n};\n\nexport type Migration = {\n  version: string | number;\n  up: (context: MigrationContext) => MaybePromise<void>;\n  down: (context: MigrationContext) => MaybePromise<void>;\n};\n\nexport class Migrations {\n  static namespace?: string;\n  static migrations: Migration[] = [];\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 define(namespace: string, migrations: Migration[]) {\n    this.namespace = namespace;\n    this.migrations = migrations;\n  }\n\n  // TODO(wittjosiah): Multi-space migrations.\n  static async migrate(space: Space, targetVersion?: string | number) {\n    invariant(this.versionProperty, 'Migrations namespace not set');\n    invariant(space.state.get() === SpaceState.READY, 'Space not ready');\n    const currentVersion = space.properties[this.versionProperty];\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    if (targetIndex > currentIndex) {\n      const migrations = this.migrations.slice(currentIndex, targetIndex);\n      for (const migration of migrations) {\n        await migration.up({ space });\n        space.properties[this.versionProperty] = migration.version;\n      }\n    } else {\n      const migrations = this.migrations.slice(targetIndex, currentIndex);\n      migrations.reverse();\n      for (const migration of migrations) {\n        await migration.down({ space });\n        const index = this.migrations.indexOf(migration);\n        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;\n      }\n    }\n\n    return true;\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAIA,kBAAuC;AACvC,uBAA0B;;AAenB,IAAMA,aAAN,MAAMA;EAEX,OAAA;SAAOC,aAA0B,CAAA;;EAEjC,WAAWC,kBAAkB;AAC3B,WAAO,KAAKC,aAAa,GAAG,KAAKA,SAAS;EAC5C;EAEA,WAAWC,gBAAgB;AACzB,WAAO,KAAKH,WAAW,KAAKA,WAAWI,SAAS,CAAA,EAAGC;EACrD;EAEA,OAAOC,OAAOJ,WAAmBF,YAAyB;AACxD,SAAKE,YAAYA;AACjB,SAAKF,aAAaA;EACpB;;EAGA,aAAaO,QAAQC,OAAcL,eAAiC;AAClEM,oCAAU,KAAKR,iBAAiB,gCAAA;;;;;;;;;AAChCQ,oCAAUD,MAAME,MAAMC,IAAG,MAAOC,uBAAWC,OAAO,mBAAA;;;;;;;;;AAClD,UAAMC,iBAAiBN,MAAMO,WAAW,KAAKd,eAAe;AAC5D,UAAMe,eAAe,KAAKhB,WAAWiB,UAAU,CAACC,MAAMA,EAAEb,YAAYS,cAAAA,IAAkB;AACtF,UAAMK,IAAI,KAAKnB,WAAWiB,UAAU,CAACC,MAAMA,EAAEb,YAAYF,aAAAA;AACzD,UAAMiB,cAAcD,MAAM,KAAK,KAAKnB,WAAWI,SAASe,IAAI;AAC5D,QAAIH,iBAAiBI,aAAa;AAChC,aAAO;IACT;AAEA,QAAIA,cAAcJ,cAAc;AAC9B,YAAMhB,aAAa,KAAKA,WAAWqB,MAAML,cAAcI,WAAAA;AACvD,iBAAWE,aAAatB,YAAY;AAClC,cAAMsB,UAAUC,GAAG;UAAEf;QAAM,CAAA;AAC3BA,cAAMO,WAAW,KAAKd,eAAe,IAAIqB,UAAUjB;MACrD;IACF,OAAO;AACL,YAAML,aAAa,KAAKA,WAAWqB,MAAMD,aAAaJ,YAAAA;AACtDhB,iBAAWwB,QAAO;AAClB,iBAAWF,aAAatB,YAAY;AAClC,cAAMsB,UAAUG,KAAK;UAAEjB;QAAM,CAAA;AAC7B,cAAMkB,QAAQ,KAAK1B,WAAW2B,QAAQL,SAAAA;AACtCd,cAAMO,WAAW,KAAKd,eAAe,IAAI,KAAKD,WAAW0B,QAAQ,CAAA,GAAIrB;MACvE;IACF;AAEA,WAAO;EACT;AACF;",
-  "names": ["Migrations", "migrations", "versionProperty", "namespace", "targetVersion", "length", "version", "define", "migrate", "space", "invariant", "state", "get", "SpaceState", "READY", "currentVersion", "properties", "currentIndex", "findIndex", "m", "i", "targetIndex", "slice", "migration", "up", "reverse", "down", "index", "indexOf"]
+  "sources": ["../../../src/migration-builder.ts", "../../../src/migrations.ts"],
+  "sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport { getHeads, type Doc } from '@dxos/automerge/automerge';\nimport { type AnyDocumentId, type DocHandle, type Repo } from '@dxos/automerge/automerge-repo';\nimport { type Space } from '@dxos/client/echo';\nimport { CreateEpochRequest } from '@dxos/client/halo';\nimport { type AutomergeContext, ObjectCore } from '@dxos/echo-db';\nimport { type ObjectStructure, type SpaceDoc } from '@dxos/echo-protocol';\nimport { requireTypeReference, type S } from '@dxos/echo-schema';\nimport { invariant } from '@dxos/invariant';\nimport { type FlushRequest } from '@dxos/protocols/proto/dxos/echo/service';\n\nexport class MigrationBuilder {\n  private readonly _repo: Repo;\n  private readonly _automergeContext: AutomergeContext;\n  private readonly _rootDoc: Doc<SpaceDoc>;\n\n  // echoId -> automergeUrl\n  private readonly _newLinks: Record<string, string> = {};\n  private readonly _flushStates: FlushRequest.DocState[] = [];\n  private readonly _deleteObjects: string[] = [];\n\n  private _newRoot?: DocHandle<SpaceDoc> = undefined;\n\n  constructor(private readonly _space: Space) {\n    this._repo = this._space.db.coreDatabase.automerge.repo;\n    this._automergeContext = this._space.db.coreDatabase.automerge;\n    // TODO(wittjosiah): Accessing private API.\n    this._rootDoc = (this._space.db.coreDatabase as any)._automergeDocLoader\n      .getSpaceRootDocHandle()\n      .docSync() as Doc<SpaceDoc>;\n  }\n\n  async findObject(id: string): Promise<ObjectStructure | undefined> {\n    const documentId = (this._rootDoc.links?.[id] || this._newLinks[id]) 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.docSync() as Doc<SpaceDoc>;\n    return doc.objects?.[id];\n  }\n\n  async migrateObject(\n    id: string,\n    migrate: (objectStructure: ObjectStructure) => { schema: S.Schema<any>; props: any },\n  ) {\n    const objectStructure = await this.findObject(id);\n    if (!objectStructure) {\n      return;\n    }\n\n    const { schema, props } = migrate(objectStructure);\n    this._createObject({ id, schema, props });\n  }\n\n  addObject(schema: S.Schema<any>, props: any) {\n    const core = this._createObject({ schema, props });\n    return core.id;\n  }\n\n  deleteObject(id: string) {\n    this._deleteObjects.push(id);\n  }\n\n  changeProperties(changeFn: (properties: ObjectStructure) => void) {\n    if (!this._newRoot) {\n      this._buildNewRoot();\n    }\n    invariant(this._newRoot, 'New root not created');\n\n    this._newRoot.change((doc: SpaceDoc) => {\n      const propertiesStructure = doc.objects?.[this._space.properties.id];\n      propertiesStructure && changeFn(propertiesStructure);\n    });\n    this._flushStates.push({\n      documentId: this._newRoot.documentId,\n      heads: getHeads(this._newRoot.docSync()),\n    });\n  }\n\n  /**\n   * @internal\n   */\n  async _commit() {\n    if (!this._newRoot) {\n      this._buildNewRoot();\n    }\n    invariant(this._newRoot, 'New root not created');\n\n    await this._automergeContext.flush({\n      states: this._flushStates,\n    });\n\n    // Create new epoch.\n    await this._space.internal.createEpoch({\n      migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,\n      automergeRootUrl: this._newRoot.url,\n    });\n  }\n\n  private _buildNewRoot() {\n    const previousLinks = { ...(this._rootDoc.links ?? {}) };\n    for (const id of this._deleteObjects) {\n      delete previousLinks[id];\n    }\n\n    this._newRoot = this._repo.create<SpaceDoc>({\n      access: {\n        spaceKey: this._space.key.toHex(),\n      },\n      objects: this._rootDoc.objects,\n      links: {\n        ...previousLinks,\n        ...this._newLinks,\n      },\n    });\n    this._flushStates.push({\n      documentId: this._newRoot.documentId,\n      heads: getHeads(this._newRoot.docSync()),\n    });\n  }\n\n  private _createObject({ id, schema, props }: { id?: string; schema: S.Schema<any>; props: any }) {\n    const core = new ObjectCore();\n    if (id) {\n      core.id = id;\n    }\n\n    core.initNewObject(props);\n    core.setType(requireTypeReference(schema));\n    const newHandle = this._repo.create<SpaceDoc>({\n      access: {\n        spaceKey: this._space.key.toHex(),\n      },\n      objects: {\n        [core.id]: core.getDoc(),\n      },\n    });\n    this._newLinks[core.id] = newHandle.url;\n    this._flushStates.push({\n      documentId: newHandle.documentId,\n      heads: getHeads(newHandle.docSync()),\n    });\n\n    return core;\n  }\n}\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Space, create, SpaceState } from '@dxos/client/echo';\nimport { invariant } from '@dxos/invariant';\nimport { type MaybePromise } from '@dxos/util';\n\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 _state = create<{ running: string[] }>({ running: [] });\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) {\n    return this._state.running.includes(space.key.toHex());\n  }\n\n  static define(namespace: string, migrations: Migration[]) {\n    this.namespace = namespace;\n    this.migrations = migrations;\n  }\n\n  static async migrate(space: Space, targetVersion?: string | number) {\n    invariant(!this.running(space), 'Migration already running');\n    invariant(this.versionProperty, 'Migrations namespace not set');\n    invariant(space.state.get() === SpaceState.READY, 'Space not ready');\n    const currentVersion = space.properties[this.versionProperty];\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    this._state.running.push(space.key.toHex());\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        builder.changeProperties((propertiesStructure) => {\n          invariant(this.versionProperty, 'Migrations namespace not set');\n          propertiesStructure.data[this.versionProperty] = migration.version;\n        });\n        await builder._commit();\n      }\n    }\n    this._state.running.splice(this._state.running.indexOf(space.key.toHex()), 1);\n\n    return true;\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAIA,uBAAmC;AAGnC,kBAAmC;AACnC,qBAAkD;AAElD,yBAA6C;AAC7C,uBAA0B;ACP1B,kBAA+C;AAC/C,IAAAA,oBAA0B;;ADSnB,IAAMC,mBAAN,MAAMA;EAYXC,YAA6BC,QAAe;SAAfA,SAAAA;SANZC,YAAoC,CAAC;SACrCC,eAAwC,CAAA;SACxCC,iBAA2B,CAAA;SAEpCC,WAAiCC;AAGvC,SAAKC,QAAQ,KAAKN,OAAOO,GAAGC,aAAaC,UAAUC;AACnD,SAAKC,oBAAoB,KAAKX,OAAOO,GAAGC,aAAaC;AAErD,SAAKG,WAAY,KAAKZ,OAAOO,GAAGC,aAAqBK,oBAClDC,sBAAqB,EACrBC,QAAO;EACZ;EAEA,MAAMC,WAAWC,IAAkD;AACjE,UAAMC,aAAc,KAAKN,SAASO,QAAQF,EAAAA,KAAO,KAAKhB,UAAUgB,EAAAA;AAChE,UAAMG,YAAYF,cAAc,KAAKZ,MAAMe,KAAKH,UAAAA;AAChD,QAAI,CAACE,WAAW;AACd,aAAOf;IACT;AAEA,UAAMe,UAAUE,UAAS;AACzB,UAAMC,MAAMH,UAAUL,QAAO;AAC7B,WAAOQ,IAAIC,UAAUP,EAAAA;EACvB;EAEA,MAAMQ,cACJR,IACAS,SACA;AACA,UAAMC,kBAAkB,MAAM,KAAKX,WAAWC,EAAAA;AAC9C,QAAI,CAACU,iBAAiB;AACpB;IACF;AAEA,UAAM,EAAEC,QAAQC,MAAK,IAAKH,QAAQC,eAAAA;AAClC,SAAKG,cAAc;MAAEb;MAAIW;MAAQC;IAAM,CAAA;EACzC;EAEAE,UAAUH,QAAuBC,OAAY;AAC3C,UAAMG,OAAO,KAAKF,cAAc;MAAEF;MAAQC;IAAM,CAAA;AAChD,WAAOG,KAAKf;EACd;EAEAgB,aAAahB,IAAY;AACvB,SAAKd,eAAe+B,KAAKjB,EAAAA;EAC3B;EAEAkB,iBAAiBC,UAAiD;AAChE,QAAI,CAAC,KAAKhC,UAAU;AAClB,WAAKiC,cAAa;IACpB;AACAC,oCAAU,KAAKlC,UAAU,wBAAA;;;;;;;;;AAEzB,SAAKA,SAASmC,OAAO,CAAChB,QAAAA;AACpB,YAAMiB,sBAAsBjB,IAAIC,UAAU,KAAKxB,OAAOyC,WAAWxB,EAAE;AACnEuB,6BAAuBJ,SAASI,mBAAAA;IAClC,CAAA;AACA,SAAKtC,aAAagC,KAAK;MACrBhB,YAAY,KAAKd,SAASc;MAC1BwB,WAAOC,2BAAS,KAAKvC,SAASW,QAAO,CAAA;IACvC,CAAA;EACF;;;;EAKA,MAAM6B,UAAU;AACd,QAAI,CAAC,KAAKxC,UAAU;AAClB,WAAKiC,cAAa;IACpB;AACAC,oCAAU,KAAKlC,UAAU,wBAAA;;;;;;;;;AAEzB,UAAM,KAAKO,kBAAkBkC,MAAM;MACjCC,QAAQ,KAAK5C;IACf,CAAA;AAGA,UAAM,KAAKF,OAAO+C,SAASC,YAAY;MACrCC,WAAWC,+BAAmBC,UAAUC;MACxCC,kBAAkB,KAAKjD,SAASkD;IAClC,CAAA;EACF;EAEQjB,gBAAgB;AACtB,UAAMkB,gBAAgB;MAAE,GAAI,KAAK3C,SAASO,SAAS,CAAC;IAAG;AACvD,eAAWF,MAAM,KAAKd,gBAAgB;AACpC,aAAOoD,cAActC,EAAAA;IACvB;AAEA,SAAKb,WAAW,KAAKE,MAAMkD,OAAiB;MAC1CC,QAAQ;QACNC,UAAU,KAAK1D,OAAO2D,IAAIC,MAAK;MACjC;MACApC,SAAS,KAAKZ,SAASY;MACvBL,OAAO;QACL,GAAGoC;QACH,GAAG,KAAKtD;MACV;IACF,CAAA;AACA,SAAKC,aAAagC,KAAK;MACrBhB,YAAY,KAAKd,SAASc;MAC1BwB,WAAOC,2BAAS,KAAKvC,SAASW,QAAO,CAAA;IACvC,CAAA;EACF;EAEQe,cAAc,EAAEb,IAAIW,QAAQC,MAAK,GAAwD;AAC/F,UAAMG,OAAO,IAAI6B,0BAAAA;AACjB,QAAI5C,IAAI;AACNe,WAAKf,KAAKA;IACZ;AAEAe,SAAK8B,cAAcjC,KAAAA;AACnBG,SAAK+B,YAAQC,yCAAqBpC,MAAAA,CAAAA;AAClC,UAAMqC,YAAY,KAAK3D,MAAMkD,OAAiB;MAC5CC,QAAQ;QACNC,UAAU,KAAK1D,OAAO2D,IAAIC,MAAK;MACjC;MACApC,SAAS;QACP,CAACQ,KAAKf,EAAE,GAAGe,KAAKkC,OAAM;MACxB;IACF,CAAA;AACA,SAAKjE,UAAU+B,KAAKf,EAAE,IAAIgD,UAAUX;AACpC,SAAKpD,aAAagC,KAAK;MACrBhB,YAAY+C,UAAU/C;MACtBwB,WAAOC,2BAASsB,UAAUlD,QAAO,CAAA;IACnC,CAAA;AAEA,WAAOiB;EACT;AACF;;ACnIO,IAAMmC,aAAN,MAAMA;EAEX,OAAA;SAAOC,aAA0B,CAAA;;EACjC,OAAA;SAAeC,aAASb,oBAA8B;MAAEc,SAAS,CAAA;IAAG,CAAA;;EAEpE,WAAWC,kBAAkB;AAC3B,WAAO,KAAKC,aAAa,GAAG,KAAKA,SAAS;EAC5C;EAEA,WAAWC,gBAAgB;AACzB,WAAO,KAAKL,WAAW,KAAKA,WAAWM,SAAS,CAAA,EAAGC;EACrD;EAEA,OAAOL,QAAQM,OAAc;AAC3B,WAAO,KAAKP,OAAOC,QAAQO,SAASD,MAAMjB,IAAIC,MAAK,CAAA;EACrD;EAEA,OAAOkB,OAAON,WAAmBJ,YAAyB;AACxD,SAAKI,YAAYA;AACjB,SAAKJ,aAAaA;EACpB;EAEA,aAAa1C,QAAQkD,OAAcH,eAAiC;AAClEnC,0BAAAA,WAAU,CAAC,KAAKgC,QAAQM,KAAAA,GAAQ,6BAAA;;;;;;;;;AAChCtC,0BAAAA,WAAU,KAAKiC,iBAAiB,gCAAA;;;;;;;;;AAChCjC,0BAAAA,WAAUsC,MAAMG,MAAMC,IAAG,MAAOC,uBAAWC,OAAO,mBAAA;;;;;;;;;AAClD,UAAMC,iBAAiBP,MAAMnC,WAAW,KAAK8B,eAAe;AAC5D,UAAMa,eAAe,KAAKhB,WAAWiB,UAAU,CAACC,MAAMA,EAAEX,YAAYQ,cAAAA,IAAkB;AACtF,UAAMI,IAAI,KAAKnB,WAAWiB,UAAU,CAACC,MAAMA,EAAEX,YAAYF,aAAAA;AACzD,UAAMe,cAAcD,MAAM,KAAK,KAAKnB,WAAWM,SAASa,IAAI;AAC5D,QAAIH,iBAAiBI,aAAa;AAChC,aAAO;IACT;AAEA,SAAKnB,OAAOC,QAAQpC,KAAK0C,MAAMjB,IAAIC,MAAK,CAAA;AACxC,QAAI4B,cAAcJ,cAAc;AAC9B,YAAMhB,aAAa,KAAKA,WAAWqB,MAAML,cAAcI,WAAAA;AACvD,iBAAWvC,aAAamB,YAAY;AAClC,cAAMsB,UAAU,IAAI5F,iBAAiB8E,KAAAA;AACrC,cAAM3B,UAAU0C,KAAK;UAAEf;UAAOc;QAAQ,CAAA;AACtCA,gBAAQvD,iBAAiB,CAACK,wBAAAA;AACxBF,gCAAAA,WAAU,KAAKiC,iBAAiB,gCAAA;;;;;;;;;AAChC/B,8BAAoBoD,KAAK,KAAKrB,eAAe,IAAItB,UAAU0B;QAC7D,CAAA;AACA,cAAMe,QAAQ9C,QAAO;MACvB;IACF;AACA,SAAKyB,OAAOC,QAAQuB,OAAO,KAAKxB,OAAOC,QAAQwB,QAAQlB,MAAMjB,IAAIC,MAAK,CAAA,GAAK,CAAA;AAE3E,WAAO;EACT;AACF;",
+  "names": ["import_invariant", "MigrationBuilder", "constructor", "_space", "_newLinks", "_flushStates", "_deleteObjects", "_newRoot", "undefined", "_repo", "db", "coreDatabase", "automerge", "repo", "_automergeContext", "_rootDoc", "_automergeDocLoader", "getSpaceRootDocHandle", "docSync", "findObject", "id", "documentId", "links", "docHandle", "find", "whenReady", "doc", "objects", "migrateObject", "migrate", "objectStructure", "schema", "props", "_createObject", "addObject", "core", "deleteObject", "push", "changeProperties", "changeFn", "_buildNewRoot", "invariant", "change", "propertiesStructure", "properties", "heads", "getHeads", "_commit", "flush", "states", "internal", "createEpoch", "migration", "CreateEpochRequest", "Migration", "REPLACE_AUTOMERGE_ROOT", "automergeRootUrl", "url", "previousLinks", "create", "access", "spaceKey", "key", "toHex", "ObjectCore", "initNewObject", "setType", "requireTypeReference", "newHandle", "getDoc", "Migrations", "migrations", "_state", "running", "versionProperty", "namespace", "targetVersion", "length", "version", "space", "includes", "define", "state", "get", "SpaceState", "READY", "currentVersion", "currentIndex", "findIndex", "m", "i", "targetIndex", "slice", "builder", "next", "data", "splice", "indexOf"]
 }

package/dist/lib/node/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/sdk/migrations/src/migrations.ts":{"bytes":8236,"imports":[{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"format":"esm"},"packages/sdk/migrations/src/index.ts":{"bytes":501,"imports":[{"path":"packages/sdk/migrations/src/migrations.ts","kind":"import-statement","original":"./migrations"}],"format":"esm"}},"outputs":{"packages/sdk/migrations/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3895},"packages/sdk/migrations/dist/lib/node/index.cjs":{"imports":[{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"exports":["Migrations"],"entryPoint":"packages/sdk/migrations/src/index.ts","inputs":{"packages/sdk/migrations/src/migrations.ts":{"bytesInOutput":2163},"packages/sdk/migrations/src/index.ts":{"bytesInOutput":0}},"bytes":2268}}}
+{"inputs":{"packages/sdk/migrations/src/migration-builder.ts":{"bytes":16903,"imports":[{"path":"@dxos/automerge/automerge","kind":"import-statement","external":true},{"path":"@dxos/client/halo","kind":"import-statement","external":true},{"path":"@dxos/echo-db","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"format":"esm"},"packages/sdk/migrations/src/migrations.ts":{"bytes":9817,"imports":[{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"packages/sdk/migrations/src/migration-builder.ts","kind":"import-statement","original":"./migration-builder"}],"format":"esm"},"packages/sdk/migrations/src/index.ts":{"bytes":698,"imports":[{"path":"packages/sdk/migrations/src/migration-builder.ts","kind":"import-statement","original":"./migration-builder"},{"path":"packages/sdk/migrations/src/migrations.ts","kind":"import-statement","original":"./migrations"}],"format":"esm"}},"outputs":{"packages/sdk/migrations/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":12698},"packages/sdk/migrations/dist/lib/node/index.cjs":{"imports":[{"path":"@dxos/automerge/automerge","kind":"import-statement","external":true},{"path":"@dxos/client/halo","kind":"import-statement","external":true},{"path":"@dxos/echo-db","kind":"import-statement","external":true},{"path":"@dxos/echo-schema","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true},{"path":"@dxos/client/echo","kind":"import-statement","external":true},{"path":"@dxos/invariant","kind":"import-statement","external":true}],"exports":["MigrationBuilder","Migrations"],"entryPoint":"packages/sdk/migrations/src/index.ts","inputs":{"packages/sdk/migrations/src/migration-builder.ts":{"bytesInOutput":3783},"packages/sdk/migrations/src/index.ts":{"bytesInOutput":0},"packages/sdk/migrations/src/migrations.ts":{"bytesInOutput":2745}},"bytes":6706}}}

package/dist/types/src/index.d.ts

@@ -1,2 +1,4 @@
+export type { ObjectStructure } from '@dxos/echo-protocol';
+export * from './migration-builder';
 export * from './migrations';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,YAAY,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}

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

@@ -0,0 +1,25 @@
+import { type Space } from '@dxos/client/echo';
+import { type ObjectStructure } from '@dxos/echo-protocol';
+import { type S } from '@dxos/echo-schema';
+export declare class MigrationBuilder {
+    private readonly _space;
+    private readonly _repo;
+    private readonly _automergeContext;
+    private readonly _rootDoc;
+    private readonly _newLinks;
+    private readonly _flushStates;
+    private readonly _deleteObjects;
+    private _newRoot?;
+    constructor(_space: Space);
+    findObject(id: string): Promise<ObjectStructure | undefined>;
+    migrateObject(id: string, migrate: (objectStructure: ObjectStructure) => {
+        schema: S.Schema<any>;
+        props: any;
+    }): Promise<void>;
+    addObject(schema: S.Schema<any>, props: any): string;
+    deleteObject(id: string): void;
+    changeProperties(changeFn: (properties: ObjectStructure) => void): void;
+    private _buildNewRoot;
+    private _createObject;
+}
+//# sourceMappingURL=migration-builder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"migration-builder.d.ts","sourceRoot":"","sources":["../../../src/migration-builder.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG/C,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAwB,KAAK,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAIjE,qBAAa,gBAAgB;IAYf,OAAO,CAAC,QAAQ,CAAC,MAAM;IAXnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAC7B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IACrD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAGzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8B;IACxD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA+B;IAC5D,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAE/C,OAAO,CAAC,QAAQ,CAAC,CAAkC;gBAEtB,MAAM,EAAE,KAAK;IASpC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAY5D,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK;QAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE;IAWtF,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG;IAK3C,YAAY,CAAC,EAAE,EAAE,MAAM;IAIvB,gBAAgB,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,eAAe,KAAK,IAAI;IAoChE,OAAO,CAAC,aAAa;IAsBrB,OAAO,CAAC,aAAa;CAwBtB"}

package/dist/types/src/migrations.d.ts

@@ -1,18 +1,21 @@
 import { type Space } from '@dxos/client/echo';
 import { type MaybePromise } from '@dxos/util';
+import { MigrationBuilder } from './migration-builder';
 export type MigrationContext = {
     space: Space;
+    builder: MigrationBuilder;
 };
 export type Migration = {
-    version: string | number;
-    up: (context: MigrationContext) => MaybePromise<void>;
-    down: (context: MigrationContext) => MaybePromise<void>;
+    version: string;
+    next: (context: MigrationContext) => MaybePromise<void>;
 };
 export declare class Migrations {
     static namespace?: string;
     static migrations: Migration[];
+    private static _state;
     static get versionProperty(): string | undefined;
-    static get targetVersion(): string | number;
+    static get targetVersion(): string;
+    static running(space: Space): boolean;
     static define(namespace: string, migrations: Migration[]): void;
     static migrate(space: Space, targetVersion?: string | number): Promise<boolean>;
 }

package/dist/types/src/migrations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../../../src/migrations.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAc,MAAM,mBAAmB,CAAC;AAE3D,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAI/C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,EAAE,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IACtD,IAAI,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CACzD,CAAC;AAEF,qBAAa,UAAU;IACrB,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,CAAM;IAEpC,MAAM,KAAK,eAAe,uBAEzB;IAED,MAAM,KAAK,aAAa,oBAEvB;IAED,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE;WAM3C,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM;CA6BnE"}
+{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../../../src/migrations.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAsB,MAAM,mBAAmB,CAAC;AAEnE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CACzD,CAAC;AAEF,qBAAa,UAAU;IACrB,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,CAAM;IACpC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAkD;IAEvE,MAAM,KAAK,eAAe,uBAEzB;IAED,MAAM,KAAK,aAAa,WAEvB;IAED,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK;IAI3B,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE;WAK3C,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM;CA6BnE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/migrations",
-  "version": "0.5.8",
+  "version": "0.5.9-main.0a0e87d",
   "description": "",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -20,10 +20,15 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/client": "0.5.8",
-    "@dxos/echo-schema": "0.5.8",
-    "@dxos/invariant": "0.5.8",
-    "@dxos/util": "0.5.8"
+    "@dxos/client": "0.5.9-main.0a0e87d",
+    "@dxos/echo-db": "0.5.9-main.0a0e87d",
+    "@dxos/automerge": "0.5.9-main.0a0e87d",
+    "@dxos/echo-schema": "0.5.9-main.0a0e87d",
+    "@dxos/log": "0.5.9-main.0a0e87d",
+    "@dxos/protocols": "0.5.9-main.0a0e87d",
+    "@dxos/echo-protocol": "0.5.9-main.0a0e87d",
+    "@dxos/invariant": "0.5.9-main.0a0e87d",
+    "@dxos/util": "0.5.9-main.0a0e87d"
   },
   "devDependencies": {},
   "publishConfig": {

package/src/index.ts

@@ -2,4 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+export type { ObjectStructure } from '@dxos/echo-protocol';
+
+export * from './migration-builder';
 export * from './migrations';

package/src/migration-builder.ts

@@ -0,0 +1,152 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { getHeads, type Doc } from '@dxos/automerge/automerge';
+import { type AnyDocumentId, type DocHandle, type Repo } from '@dxos/automerge/automerge-repo';
+import { type Space } from '@dxos/client/echo';
+import { CreateEpochRequest } from '@dxos/client/halo';
+import { type AutomergeContext, ObjectCore } from '@dxos/echo-db';
+import { type ObjectStructure, type SpaceDoc } from '@dxos/echo-protocol';
+import { requireTypeReference, type S } from '@dxos/echo-schema';
+import { invariant } from '@dxos/invariant';
+import { type FlushRequest } from '@dxos/protocols/proto/dxos/echo/service';
+
+export class MigrationBuilder {
+  private readonly _repo: Repo;
+  private readonly _automergeContext: AutomergeContext;
+  private readonly _rootDoc: Doc<SpaceDoc>;
+
+  // echoId -> automergeUrl
+  private readonly _newLinks: Record<string, string> = {};
+  private readonly _flushStates: FlushRequest.DocState[] = [];
+  private readonly _deleteObjects: string[] = [];
+
+  private _newRoot?: DocHandle<SpaceDoc> = undefined;
+
+  constructor(private readonly _space: Space) {
+    this._repo = this._space.db.coreDatabase.automerge.repo;
+    this._automergeContext = this._space.db.coreDatabase.automerge;
+    // TODO(wittjosiah): Accessing private API.
+    this._rootDoc = (this._space.db.coreDatabase as any)._automergeDocLoader
+      .getSpaceRootDocHandle()
+      .docSync() as Doc<SpaceDoc>;
+  }
+
+  async findObject(id: string): Promise<ObjectStructure | undefined> {
+    const documentId = (this._rootDoc.links?.[id] || this._newLinks[id]) as AnyDocumentId | undefined;
+    const docHandle = documentId && this._repo.find(documentId);
+    if (!docHandle) {
+      return undefined;
+    }
+
+    await docHandle.whenReady();
+    const doc = docHandle.docSync() as Doc<SpaceDoc>;
+    return doc.objects?.[id];
+  }
+
+  async migrateObject(
+    id: string,
+    migrate: (objectStructure: ObjectStructure) => { schema: S.Schema<any>; props: any },
+  ) {
+    const objectStructure = await this.findObject(id);
+    if (!objectStructure) {
+      return;
+    }
+
+    const { schema, props } = migrate(objectStructure);
+    this._createObject({ id, schema, props });
+  }
+
+  addObject(schema: S.Schema<any>, props: any) {
+    const core = this._createObject({ schema, props });
+    return core.id;
+  }
+
+  deleteObject(id: string) {
+    this._deleteObjects.push(id);
+  }
+
+  changeProperties(changeFn: (properties: ObjectStructure) => void) {
+    if (!this._newRoot) {
+      this._buildNewRoot();
+    }
+    invariant(this._newRoot, 'New root not created');
+
+    this._newRoot.change((doc: SpaceDoc) => {
+      const propertiesStructure = doc.objects?.[this._space.properties.id];
+      propertiesStructure && changeFn(propertiesStructure);
+    });
+    this._flushStates.push({
+      documentId: this._newRoot.documentId,
+      heads: getHeads(this._newRoot.docSync()),
+    });
+  }
+
+  /**
+   * @internal
+   */
+  async _commit() {
+    if (!this._newRoot) {
+      this._buildNewRoot();
+    }
+    invariant(this._newRoot, 'New root not created');
+
+    await this._automergeContext.flush({
+      states: this._flushStates,
+    });
+
+    // Create new epoch.
+    await this._space.internal.createEpoch({
+      migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,
+      automergeRootUrl: this._newRoot.url,
+    });
+  }
+
+  private _buildNewRoot() {
+    const previousLinks = { ...(this._rootDoc.links ?? {}) };
+    for (const id of this._deleteObjects) {
+      delete previousLinks[id];
+    }
+
+    this._newRoot = this._repo.create<SpaceDoc>({
+      access: {
+        spaceKey: this._space.key.toHex(),
+      },
+      objects: this._rootDoc.objects,
+      links: {
+        ...previousLinks,
+        ...this._newLinks,
+      },
+    });
+    this._flushStates.push({
+      documentId: this._newRoot.documentId,
+      heads: getHeads(this._newRoot.docSync()),
+    });
+  }
+
+  private _createObject({ id, schema, props }: { id?: string; schema: S.Schema<any>; props: any }) {
+    const core = new ObjectCore();
+    if (id) {
+      core.id = id;
+    }
+
+    core.initNewObject(props);
+    core.setType(requireTypeReference(schema));
+    const newHandle = this._repo.create<SpaceDoc>({
+      access: {
+        spaceKey: this._space.key.toHex(),
+      },
+      objects: {
+        [core.id]: core.getDoc(),
+      },
+    });
+    this._newLinks[core.id] = newHandle.url;
+    this._flushStates.push({
+      documentId: newHandle.documentId,
+      heads: getHeads(newHandle.docSync()),
+    });
+
+    return core;
+  }
+}

package/src/migrations.test.ts

@@ -5,7 +5,7 @@
 import { expect } from 'chai';
 
 import { Client } from '@dxos/client';
-import { type Space } from '@dxos/client/echo';
+import { Filter, type Space } from '@dxos/client/echo';
 import { TestBuilder } from '@dxos/client/testing';
 import { Expando, create } from '@dxos/echo-schema';
 import { describe, test, beforeEach, beforeAll, afterAll } from '@dxos/test';
@@ -14,41 +14,32 @@ import { Migrations } from './migrations';
 
 Migrations.define('test', [
   {
-    version: 1,
-    up: async ({ space }) => {
-      space.db.add(create(Expando, { namespace: 'test', count: 1 }));
-    },
-    down: async ({ space }) => {
-      const { objects } = await space.db.query({ namespace: 'test' }).run();
-      for (const object of objects) {
-        space.db.remove(object);
-      }
+    version: '1970-01-01',
+    next: async ({ builder }) => {
+      builder.addObject(Expando, { namespace: 'test', count: 1 });
     },
   },
   {
-    version: 2,
-    up: async ({ space }) => {
+    version: '1970-01-02',
+    next: async ({ space, builder }) => {
       const { objects } = await space.db.query({ namespace: 'test' }).run();
       for (const object of objects) {
-        object.count = 2;
+        await builder.migrateObject(object.id, ({ data }) => ({
+          schema: Expando,
+          props: { namespace: data.namespace, count: 2 },
+        }));
       }
     },
-    down: async () => {
-      // No-op.
-    },
   },
   {
-    version: 3,
-    up: async ({ space }) => {
-      const { objects } = await space.db.query({ namespace: 'test' }).run();
-      for (const object of objects) {
-        object.count *= 3;
-      }
-    },
-    down: async ({ space }) => {
+    version: '1970-01-03',
+    next: async ({ space, builder }) => {
       const { objects } = await space.db.query({ namespace: 'test' }).run();
       for (const object of objects) {
-        object.count /= 3;
+        await builder.migrateObject(object.id, ({ data }) => ({
+          schema: Expando,
+          props: { namespace: data.namespace, count: data.count * 3 },
+        }));
       }
     },
   },
@@ -75,47 +66,34 @@ describe('Migrations', () => {
 
   test('if no migrations have been run before, runs all migrations', async () => {
     await Migrations.migrate(space);
-    const { objects } = await space.db.query({ namespace: 'test' }).run();
+    const { objects } = await space.db.query(Filter.schema(Expando, { namespace: 'test' })).run();
     expect(objects).to.have.length(1);
     expect(objects[0].count).to.equal(6);
-    expect(space.properties['test.version']).to.equal(3);
+    expect(space.properties['test.version']).to.equal('1970-01-03');
   });
 
   test('if some migrations have been run before, runs only the remaining migrations', async () => {
-    space.properties['test.version'] = 2;
+    space.properties['test.version'] = '1970-01-02';
     space.db.add(create(Expando, { namespace: 'test', count: 5 }));
     await Migrations.migrate(space);
-    const { objects } = await space.db.query({ namespace: 'test' }).run();
+    const { objects } = await space.db.query(Filter.schema(Expando, { namespace: 'test' })).run();
     expect(objects).to.have.length(1);
     expect(objects[0].count).to.equal(15);
-    expect(space.properties['test.version']).to.equal(3);
+    expect(space.properties['test.version']).to.equal('1970-01-03');
   });
 
   test('if all migrations have been run before, does nothing', async () => {
-    space.properties['test.version'] = 3;
+    space.properties['test.version'] = '1970-01-03';
     await Migrations.migrate(space);
-    const { objects } = await space.db.query({ namespace: 'test' }).run();
+    const { objects } = await space.db.query(Filter.schema(Expando, { namespace: 'test' })).run();
     expect(objects).to.have.length(0);
   });
 
   test('if target version is specified, runs only the migrations up to that version', async () => {
-    await Migrations.migrate(space, 2);
-    const { objects } = await space.db.query({ namespace: 'test' }).run();
+    await Migrations.migrate(space, '1970-01-02');
+    const { objects } = await space.db.query(Filter.schema(Expando, { namespace: 'test' })).run();
     expect(objects).to.have.length(1);
     expect(objects[0].count).to.equal(2);
-    expect(space.properties['test.version']).to.equal(2);
-  });
-
-  test('if target version is specified and is lower than current version, runs the down migrations', async () => {
-    await Migrations.migrate(space);
-    const beforeDowngrade = await space.db.query({ namespace: 'test' }).run();
-    expect(beforeDowngrade.objects).to.have.length(1);
-    expect(beforeDowngrade.objects[0].count).to.equal(6);
-    expect(space.properties['test.version']).to.equal(3);
-    await Migrations.migrate(space, 1);
-    const afterDowngrade = await space.db.query({ namespace: 'test' }).run();
-    expect(afterDowngrade.objects).to.have.length(1);
-    expect(afterDowngrade.objects[0].count).to.equal(2);
-    expect(space.properties['test.version']).to.equal(1);
+    expect(space.properties['test.version']).to.equal('1970-01-02');
   });
 });

package/src/migrations.ts

@@ -2,25 +2,26 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Space, SpaceState } from '@dxos/client/echo';
+import { type Space, create, SpaceState } from '@dxos/client/echo';
 import { invariant } from '@dxos/invariant';
 import { type MaybePromise } from '@dxos/util';
 
-// TODO(burdon): Merge with successor to serialization mechanism in braneframe/types.
+import { MigrationBuilder } from './migration-builder';
 
 export type MigrationContext = {
   space: Space;
+  builder: MigrationBuilder;
 };
 
 export type Migration = {
-  version: string | number;
-  up: (context: MigrationContext) => MaybePromise<void>;
-  down: (context: MigrationContext) => MaybePromise<void>;
+  version: string;
+  next: (context: MigrationContext) => MaybePromise<void>;
 };
 
 export class Migrations {
   static namespace?: string;
   static migrations: Migration[] = [];
+  private static _state = create<{ running: string[] }>({ running: [] });
 
   static get versionProperty() {
     return this.namespace && `${this.namespace}.version`;
@@ -30,13 +31,17 @@ export class Migrations {
     return this.migrations[this.migrations.length - 1].version;
   }
 
+  static running(space: Space) {
+    return this._state.running.includes(space.key.toHex());
+  }
+
   static define(namespace: string, migrations: Migration[]) {
     this.namespace = namespace;
     this.migrations = migrations;
   }
 
-  // TODO(wittjosiah): Multi-space migrations.
   static async migrate(space: Space, targetVersion?: string | number) {
+    invariant(!this.running(space), 'Migration already running');
     invariant(this.versionProperty, 'Migrations namespace not set');
     invariant(space.state.get() === SpaceState.READY, 'Space not ready');
     const currentVersion = space.properties[this.versionProperty];
@@ -47,21 +52,20 @@ export class Migrations {
       return false;
     }
 
+    this._state.running.push(space.key.toHex());
     if (targetIndex > currentIndex) {
       const migrations = this.migrations.slice(currentIndex, targetIndex);
       for (const migration of migrations) {
-        await migration.up({ space });
-        space.properties[this.versionProperty] = migration.version;
-      }
-    } else {
-      const migrations = this.migrations.slice(targetIndex, currentIndex);
-      migrations.reverse();
-      for (const migration of migrations) {
-        await migration.down({ space });
-        const index = this.migrations.indexOf(migration);
-        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;
+        const builder = new MigrationBuilder(space);
+        await migration.next({ space, builder });
+        builder.changeProperties((propertiesStructure) => {
+          invariant(this.versionProperty, 'Migrations namespace not set');
+          propertiesStructure.data[this.versionProperty] = migration.version;
+        });
+        await builder._commit();
       }
     }
+    this._state.running.splice(this._state.running.indexOf(space.key.toHex()), 1);
 
     return true;
   }