@dxos/migrations 0.3.9-main.16d375f

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# @dxos/echo-signals
+
+## Installation
+
+```bash
+pnpm i @dxos/echo-signals
+```
+
+## DXOS Resources
+
+- [Website](https://dxos.org)
+- [Developer Documentation](https://docs.dxos.org)
+- Talk to us on [Discord](https://discord.gg/eXVfryv3sW)
+
+## Contributions
+
+Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
+
+License: [MIT](./LICENSE) Copyright 2022 © DXOS

package/dist/lib/browser/index.mjs

@@ -0,0 +1,70 @@
+// packages/sdk/migrations/src/migrations.ts
+import { SpaceState } from "@dxos/client/echo";
+import { invariant } from "@dxos/invariant";
+var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
+var Migrations = class {
+  static {
+    this.migrations = [];
+  }
+  static get versionProperty() {
+    return this.namespace && `${this.namespace}.version`;
+  }
+  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: 35,
+      S: this,
+      A: [
+        "this.versionProperty",
+        "'Migrations namespace not set'"
+      ]
+    });
+    invariant(space.state.get() === SpaceState.READY, "Space not ready", {
+      F: __dxlog_file,
+      L: 36,
+      S: this,
+      A: [
+        "space.state.get() === SpaceState.READY",
+        "'Space not ready'"
+      ]
+    });
+    const currentVersion = space.properties[this.versionProperty];
+    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;
+    }
+    if (targetIndex > currentIndex) {
+      const migrations = this.migrations.slice(currentIndex, targetIndex);
+      for (const migration of migrations) {
+        await migration.up({
+          version: migration.version,
+          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({
+          version: migration.version,
+          space
+        });
+        const index = this.migrations.indexOf(migration);
+        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;
+      }
+    }
+    return true;
+  }
+};
+export {
+  Migrations
+};
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +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\nexport type MigrationContext = {\n  version: string | number;\n  space: Space;\n};\n\ntype 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 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({ version: migration.version, 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({ version: migration.version, 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;;AAcnB,IAAMC,aAAN,MAAMA;EAEX;SAAOC,aAA0B,CAAA;;EAEjC,WAAWC,kBAAkB;AAC3B,WAAO,KAAKC,aAAa,GAAG,KAAKA,SAAS;EAC5C;EAEA,OAAOC,OAAOD,WAAmBF,YAAyB;AACxD,SAAKE,YAAYA;AACjB,SAAKF,aAAaA;EACpB;;EAGA,aAAaI,QAAQC,OAAcC,eAAiC;AAClER,cAAU,KAAKG,iBAAiB,gCAAA;;;;;;;;;AAChCH,cAAUO,MAAME,MAAMC,IAAG,MAAOX,WAAWY,OAAO,mBAAA;;;;;;;;;AAClD,UAAMC,iBAAiBL,MAAMM,WAAW,KAAKV,eAAe;AAC5D,UAAMW,eAAe,KAAKZ,WAAWa,UAAU,CAACC,MAAMA,EAAEC,YAAYL,cAAAA,IAAkB;AACtF,UAAMM,IAAI,KAAKhB,WAAWa,UAAU,CAACC,MAAMA,EAAEC,YAAYT,aAAAA;AACzD,UAAMW,cAAcD,MAAM,KAAK,KAAKhB,WAAWkB,SAASF,IAAI;AAC5D,QAAIJ,iBAAiBK,aAAa;AAChC,aAAO;IACT;AAEA,QAAIA,cAAcL,cAAc;AAC9B,YAAMZ,aAAa,KAAKA,WAAWmB,MAAMP,cAAcK,WAAAA;AACvD,iBAAWG,aAAapB,YAAY;AAClC,cAAMoB,UAAUC,GAAG;UAAEN,SAASK,UAAUL;UAASV;QAAM,CAAA;AACvDA,cAAMM,WAAW,KAAKV,eAAe,IAAImB,UAAUL;MACrD;IACF,OAAO;AACL,YAAMf,aAAa,KAAKA,WAAWmB,MAAMF,aAAaL,YAAAA;AACtDZ,iBAAWsB,QAAO;AAClB,iBAAWF,aAAapB,YAAY;AAClC,cAAMoB,UAAUG,KAAK;UAAER,SAASK,UAAUL;UAASV;QAAM,CAAA;AACzD,cAAMmB,QAAQ,KAAKxB,WAAWyB,QAAQL,SAAAA;AACtCf,cAAMM,WAAW,KAAKV,eAAe,IAAI,KAAKD,WAAWwB,QAAQ,CAAA,GAAIT;MACvE;IACF;AAEA,WAAO;EACT;AACF;",
+  "names": ["SpaceState", "invariant", "Migrations", "migrations", "versionProperty", "namespace", "define", "migrate", "space", "targetVersion", "state", "get", "READY", "currentVersion", "properties", "currentIndex", "findIndex", "m", "version", "i", "targetIndex", "length", "slice", "migration", "up", "reverse", "down", "index", "indexOf"]
+}

package/dist/lib/browser/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/sdk/migrations/src/migrations.ts":{"bytes":7881,"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":469,"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":3742},"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":2140},"packages/sdk/migrations/src/index.ts":{"bytesInOutput":0}},"bytes":2245}}}

package/dist/lib/node/index.cjs

@@ -0,0 +1,93 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var node_exports = {};
+__export(node_exports, {
+  Migrations: () => Migrations
+});
+module.exports = __toCommonJS(node_exports);
+var import_echo = require("@dxos/client/echo");
+var import_invariant = require("@dxos/invariant");
+var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
+var Migrations = class {
+  static {
+    this.migrations = [];
+  }
+  static get versionProperty() {
+    return this.namespace && `${this.namespace}.version`;
+  }
+  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: 35,
+      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: 36,
+      S: this,
+      A: [
+        "space.state.get() === SpaceState.READY",
+        "'Space not ready'"
+      ]
+    });
+    const currentVersion = space.properties[this.versionProperty];
+    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;
+    }
+    if (targetIndex > currentIndex) {
+      const migrations = this.migrations.slice(currentIndex, targetIndex);
+      for (const migration of migrations) {
+        await migration.up({
+          version: migration.version,
+          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({
+          version: migration.version,
+          space
+        });
+        const index = this.migrations.indexOf(migration);
+        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;
+      }
+    }
+    return true;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Migrations
+});
+//# sourceMappingURL=index.cjs.map

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

@@ -0,0 +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\nexport type MigrationContext = {\n  version: string | number;\n  space: Space;\n};\n\ntype 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 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({ version: migration.version, 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({ version: migration.version, 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;;AAcnB,IAAMA,aAAN,MAAMA;EAEX,OAAA;SAAOC,aAA0B,CAAA;;EAEjC,WAAWC,kBAAkB;AAC3B,WAAO,KAAKC,aAAa,GAAG,KAAKA,SAAS;EAC5C;EAEA,OAAOC,OAAOD,WAAmBF,YAAyB;AACxD,SAAKE,YAAYA;AACjB,SAAKF,aAAaA;EACpB;;EAGA,aAAaI,QAAQC,OAAcC,eAAiC;AAClEC,oCAAU,KAAKN,iBAAiB,gCAAA;;;;;;;;;AAChCM,oCAAUF,MAAMG,MAAMC,IAAG,MAAOC,uBAAWC,OAAO,mBAAA;;;;;;;;;AAClD,UAAMC,iBAAiBP,MAAMQ,WAAW,KAAKZ,eAAe;AAC5D,UAAMa,eAAe,KAAKd,WAAWe,UAAU,CAACC,MAAMA,EAAEC,YAAYL,cAAAA,IAAkB;AACtF,UAAMM,IAAI,KAAKlB,WAAWe,UAAU,CAACC,MAAMA,EAAEC,YAAYX,aAAAA;AACzD,UAAMa,cAAcD,MAAM,KAAK,KAAKlB,WAAWoB,SAASF,IAAI;AAC5D,QAAIJ,iBAAiBK,aAAa;AAChC,aAAO;IACT;AAEA,QAAIA,cAAcL,cAAc;AAC9B,YAAMd,aAAa,KAAKA,WAAWqB,MAAMP,cAAcK,WAAAA;AACvD,iBAAWG,aAAatB,YAAY;AAClC,cAAMsB,UAAUC,GAAG;UAAEN,SAASK,UAAUL;UAASZ;QAAM,CAAA;AACvDA,cAAMQ,WAAW,KAAKZ,eAAe,IAAIqB,UAAUL;MACrD;IACF,OAAO;AACL,YAAMjB,aAAa,KAAKA,WAAWqB,MAAMF,aAAaL,YAAAA;AACtDd,iBAAWwB,QAAO;AAClB,iBAAWF,aAAatB,YAAY;AAClC,cAAMsB,UAAUG,KAAK;UAAER,SAASK,UAAUL;UAASZ;QAAM,CAAA;AACzD,cAAMqB,QAAQ,KAAK1B,WAAW2B,QAAQL,SAAAA;AACtCjB,cAAMQ,WAAW,KAAKZ,eAAe,IAAI,KAAKD,WAAW0B,QAAQ,CAAA,GAAIT;MACvE;IACF;AAEA,WAAO;EACT;AACF;",
+  "names": ["Migrations", "migrations", "versionProperty", "namespace", "define", "migrate", "space", "targetVersion", "invariant", "state", "get", "SpaceState", "READY", "currentVersion", "properties", "currentIndex", "findIndex", "m", "version", "i", "targetIndex", "length", "slice", "migration", "up", "reverse", "down", "index", "indexOf"]
+}

package/dist/lib/node/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/sdk/migrations/src/migrations.ts":{"bytes":7881,"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":469,"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":3742},"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":2140},"packages/sdk/migrations/src/index.ts":{"bytesInOutput":0}},"bytes":2245}}}

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

@@ -0,0 +1,2 @@
+export * from './migrations';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC"}

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

@@ -0,0 +1,20 @@
+import { type Space } from '@dxos/client/echo';
+import type { MaybePromise } from '@dxos/util';
+export type MigrationContext = {
+    version: string | number;
+    space: Space;
+};
+type Migration = {
+    version: string | number;
+    up: (context: MigrationContext) => MaybePromise<void>;
+    down: (context: MigrationContext) => MaybePromise<void>;
+};
+export declare class Migrations {
+    static namespace?: string;
+    static migrations: Migration[];
+    static get versionProperty(): string | undefined;
+    static define(namespace: string, migrations: Migration[]): void;
+    static migrate(space: Space, targetVersion?: string | number): Promise<boolean>;
+}
+export {};
+//# sourceMappingURL=migrations.d.ts.map

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

@@ -0,0 +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,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,KAAK,SAAS,GAAG;IACf,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,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"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=migrations.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.test.d.ts","sourceRoot":"","sources":["../../../src/migrations.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@dxos/migrations",
+  "version": "0.3.9-main.16d375f",
+  "description": "",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "license": "MIT",
+  "author": "info@dxos.org",
+  "exports": {
+    ".": {
+      "browser": "./dist/lib/browser/index.mjs",
+      "import": "./dist/lib/browser/index.mjs",
+      "require": "./dist/lib/node/index.cjs",
+      "node": "./dist/lib/node/index.cjs"
+    }
+  },
+  "types": "dist/types/src/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@dxos/invariant": "0.3.9-main.16d375f",
+    "@dxos/util": "0.3.9-main.16d375f",
+    "@dxos/client": "0.3.9-main.16d375f"
+  },
+  "devDependencies": {},
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './migrations';

package/src/migrations.test.ts

@@ -0,0 +1,119 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { Client } from '@dxos/client';
+import { Expando, type Space } from '@dxos/client/echo';
+import { TestBuilder } from '@dxos/client/testing';
+import { describe, test, beforeEach, beforeAll, afterAll } from '@dxos/test';
+
+import { Migrations } from './migrations';
+
+Migrations.define('test', [
+  {
+    version: 1,
+    up: async ({ space }) => {
+      space.db.add(new Expando({ namespace: 'test', count: 1 }));
+    },
+    down: async ({ space }) => {
+      const { objects } = space.db.query({ namespace: 'test' });
+      for (const object of objects) {
+        space.db.remove(object);
+      }
+    },
+  },
+  {
+    version: 2,
+    up: async ({ space }) => {
+      const { objects } = space.db.query({ namespace: 'test' });
+      for (const object of objects) {
+        object.count = 2;
+      }
+    },
+    down: async () => {
+      // No-op.
+    },
+  },
+  {
+    version: 3,
+    up: async ({ space }) => {
+      const { objects } = space.db.query({ namespace: 'test' });
+      for (const object of objects) {
+        object.count *= 3;
+      }
+    },
+    down: async ({ space }) => {
+      const { objects } = space.db.query({ namespace: 'test' });
+      for (const object of objects) {
+        object.count /= 3;
+      }
+    },
+  },
+]);
+
+describe('Migrations', () => {
+  let client: Client;
+  let space: Space;
+
+  beforeAll(async () => {
+    const testBuilder = new TestBuilder();
+    client = new Client({ services: testBuilder.createLocal() });
+    await client.initialize();
+    await client.halo.createIdentity();
+  });
+
+  afterAll(async () => {
+    await client.destroy();
+  });
+
+  beforeEach(async () => {
+    space = await client.spaces.create();
+  });
+
+  test('if no migrations have been run before, runs all migrations', async () => {
+    await Migrations.migrate(space);
+    const { objects } = space.db.query({ namespace: 'test' });
+    expect(objects).to.have.length(1);
+    expect(objects[0].count).to.equal(6);
+    expect(space.properties['test.version']).to.equal(3);
+  });
+
+  test('if some migrations have been run before, runs only the remaining migrations', async () => {
+    space.properties['test.version'] = 2;
+    space.db.add(new Expando({ namespace: 'test', count: 5 }));
+    await Migrations.migrate(space);
+    const { objects } = space.db.query({ namespace: 'test' });
+    expect(objects).to.have.length(1);
+    expect(objects[0].count).to.equal(15);
+    expect(space.properties['test.version']).to.equal(3);
+  });
+
+  test('if all migrations have been run before, does nothing', async () => {
+    space.properties['test.version'] = 3;
+    await Migrations.migrate(space);
+    const { objects } = space.db.query({ namespace: 'test' });
+    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 } = space.db.query({ namespace: 'test' });
+    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 () => {
+    const query = space.db.query({ namespace: 'test' });
+    await Migrations.migrate(space);
+    expect(query.objects).to.have.length(1);
+    expect(query.objects[0].count).to.equal(6);
+    expect(space.properties['test.version']).to.equal(3);
+    await Migrations.migrate(space, 1);
+    expect(query.objects).to.have.length(1);
+    expect(query.objects[0].count).to.equal(2);
+    expect(space.properties['test.version']).to.equal(1);
+  });
+});

package/src/migrations.ts

@@ -0,0 +1,63 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Space, SpaceState } from '@dxos/client/echo';
+import { invariant } from '@dxos/invariant';
+import type { MaybePromise } from '@dxos/util';
+
+export type MigrationContext = {
+  version: string | number;
+  space: Space;
+};
+
+type Migration = {
+  version: string | number;
+  up: (context: MigrationContext) => MaybePromise<void>;
+  down: (context: MigrationContext) => MaybePromise<void>;
+};
+
+export class Migrations {
+  static namespace?: string;
+  static migrations: Migration[] = [];
+
+  static get versionProperty() {
+    return this.namespace && `${this.namespace}.version`;
+  }
+
+  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.versionProperty, 'Migrations namespace not set');
+    invariant(space.state.get() === SpaceState.READY, 'Space not ready');
+    const currentVersion = space.properties[this.versionProperty];
+    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;
+    }
+
+    if (targetIndex > currentIndex) {
+      const migrations = this.migrations.slice(currentIndex, targetIndex);
+      for (const migration of migrations) {
+        await migration.up({ version: migration.version, 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({ version: migration.version, space });
+        const index = this.migrations.indexOf(migration);
+        space.properties[this.versionProperty] = this.migrations[index - 1]?.version;
+      }
+    }
+
+    return true;
+  }
+}