@dxos/migrations 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-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:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-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.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/README.md

@@ -1,9 +1,9 @@
-# @dxos/echo-signals
+# @dxos/migrations
 
 ## Installation
 
 ```bash
-pnpm i @dxos/echo-signals
+pnpm i @dxos/migrations
 ```
 
 ## DXOS Resources
@@ -16,4 +16,4 @@ pnpm i @dxos/echo-signals
 
 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
+License: [FSL-1.1-Apache-2.0](./LICENSE) Copyright 2022 © DXOS

package/dist/lib/browser/index.mjs

@@ -1,28 +1,40 @@
+// src/annotations.ts
+import * as Schema from "effect/Schema";
+import { Annotation } from "@dxos/echo";
+var MigrationVersionAnnotation = Annotation.make({
+  id: "org.dxos.migrations.version",
+  schema: Schema.String
+});
+
+// src/document-compaction.ts
+import { SpaceState } from "@dxos/client/echo";
+import { invariant as invariant2 } from "@dxos/invariant";
+
 // src/migration-builder.ts
-import { next as am } from "@automerge/automerge";
+import { next as A, toJS } from "@automerge/automerge";
 import { CreateEpochRequest } from "@dxos/client/halo";
-import { ObjectCore, migrateDocument } from "@dxos/echo-db";
-import { Reference, SpaceDocVersion, encodeReference } from "@dxos/echo-protocol";
-import { requireTypeReference } from "@dxos/echo-schema";
+import { ObjectCore, migrateDocument } from "@dxos/echo-client/internal";
+import { EncodedReference, SpaceDocVersion } from "@dxos/echo-protocol";
+import { getSchemaURI } from "@dxos/echo/internal";
+import * as Type from "@dxos/echo/Type";
 import { invariant } from "@dxos/invariant";
+import { EID, EntityId } from "@dxos/keys";
 var __dxlog_file = "/__w/dxos/dxos/packages/sdk/migrations/src/migration-builder.ts";
 var MigrationBuilder = class {
   _space;
   _repo;
   _rootDoc;
-  // echoId -> automergeUrl
-  _newLinks;
-  _flushIds;
-  _deleteObjects;
-  _newRoot;
+  // echoUri -> automergeUrl
+  _newLinks = {};
+  _flushIds = [];
+  _deleteObjects = [];
+  _newRoot = void 0;
   constructor(_space) {
     this._space = _space;
-    this._newLinks = {};
-    this._flushIds = [];
-    this._deleteObjects = [];
-    this._newRoot = void 0;
-    this._repo = this._space.db.coreDatabase._repo;
-    this._rootDoc = this._space.db.coreDatabase._automergeDocLoader.getSpaceRootDocHandle().doc();
+    this._repo = this._space.internal.db._repo;
+    const rootDoc = this._space.internal.db._getSpaceRootDocHandle().doc();
+    invariant(rootDoc, "Space root document must be available when creating MigrationBuilder", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 41, S: this, A: ["rootDoc", "'Space root document must be available when creating MigrationBuilder'"] });
+    this._rootDoc = rootDoc;
   }
   async findObject(id) {
     const documentId = (this._rootDoc.links?.[id] || this._newLinks[id])?.toString();
@@ -39,17 +51,10 @@ var MigrationBuilder = class {
     if (!objectStructure) {
       return;
     }
-    const { schema, props } = await migrate(objectStructure);
+    const { type, props } = await migrate(objectStructure);
+    const schema = Type.getSchema(type);
     const oldHandle = await this._findObjectContainingHandle(id);
-    invariant(oldHandle, void 0, {
-      F: __dxlog_file,
-      L: 84,
-      S: this,
-      A: [
-        "oldHandle",
-        ""
-      ]
-    });
+    invariant(oldHandle, void 0, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 62, S: this, A: ["oldHandle", ""] });
     const newState = {
       version: SpaceDocVersion.CURRENT,
       access: {
@@ -58,7 +63,7 @@ var MigrationBuilder = class {
       objects: {
         [id]: {
           system: {
-            type: encodeReference(requireTypeReference(schema))
+            type: EncodedReference.fromURI(getSchemaURI(schema))
           },
           data: props,
           meta: {
@@ -68,59 +73,79 @@ var MigrationBuilder = class {
       }
     };
     const migratedDoc = migrateDocument(oldHandle.doc(), newState);
-    const newHandle = this._repo.import(am.save(migratedDoc));
+    const newHandle = this._repo.import(A.save(migratedDoc));
+    await newHandle.whenReady();
+    invariant(newHandle.url, "Migrated document URL not available after whenReady", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 83, S: this, A: ["newHandle.url", "'Migrated document URL not available after whenReady'"] });
     this._newLinks[id] = newHandle.url;
-    this._addHandleToFlushList(newHandle);
+    this._addHandleToFlushList(newHandle.documentId);
   }
-  async addObject(schema, props) {
-    const core = this._createObject({
-      schema,
+  async addObject(type, props) {
+    const resolved = Type.getSchema(type);
+    const core = await this._createObject({
+      schema: resolved,
       props
     });
     return core.id;
   }
   createReference(id) {
-    return encodeReference(Reference.localObjectReference(id));
+    invariant(EntityId.isValid(id), "Invalid EntityId.", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 96, S: this, A: ["EntityId.isValid(id)", "'Invalid EntityId.'"] });
+    return EncodedReference.fromURI(EID.make({
+      entityId: id
+    }));
   }
   deleteObject(id) {
     this._deleteObjects.push(id);
   }
-  changeProperties(changeFn) {
+  /**
+  * Re-materializes linked object documents into fresh Automerge docs without history.
+  * Call {@link _commit} to publish a new space epoch with updated root links.
+  */
+  async compactLinkedDocuments(objectIds) {
+    const linkIds = objectIds ?? Object.keys(this._rootDoc.links ?? {});
+    const compacted = [];
+    const skipped = [];
+    for (const id of linkIds) {
+      const oldHandle = await this._findObjectContainingHandle(id);
+      if (!oldHandle) {
+        skipped.push(id);
+        continue;
+      }
+      await oldHandle.whenReady();
+      const materialized = toJS(oldHandle.doc());
+      const newHandle = this._repo.create(materialized);
+      await newHandle.whenReady();
+      invariant(newHandle.url, "Compacted document URL not available after whenReady", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 121, S: this, A: ["newHandle.url", "'Compacted document URL not available after whenReady'"] });
+      this._newLinks[id] = newHandle.url;
+      this._addHandleToFlushList(newHandle.documentId);
+      compacted.push(id);
+    }
+    return {
+      compacted,
+      skipped
+    };
+  }
+  async changeProperties(changeFn) {
     if (!this._newRoot) {
-      this._buildNewRoot();
+      await this._buildNewRoot();
     }
-    invariant(this._newRoot, "New root not created", {
-      F: __dxlog_file,
-      L: 126,
-      S: this,
-      A: [
-        "this._newRoot",
-        "'New root not created'"
-      ]
-    });
+    invariant(this._newRoot, "New root not created", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 135, 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._addHandleToFlushList(this._newRoot);
+    await this._newRoot.whenReady();
+    this._addHandleToFlushList(this._newRoot.documentId);
   }
   /**
   * @internal
   */
   async _commit() {
     if (!this._newRoot) {
-      this._buildNewRoot();
+      await this._buildNewRoot();
     }
-    invariant(this._newRoot, "New root not created", {
-      F: __dxlog_file,
-      L: 142,
-      S: this,
-      A: [
-        "this._newRoot",
-        "'New root not created'"
-      ]
-    });
+    invariant(this._newRoot, "New root not created", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 149, S: this, A: ["this._newRoot", "'New root not created'"] });
     await this._space.db.flush();
+    invariant(this._newRoot.url, "New root URL not available", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 152, S: this, A: ["this._newRoot.url", "'New root URL not available'"] });
     await this._space.internal.createEpoch({
       migration: CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT,
       automergeRootUrl: this._newRoot.url
@@ -135,7 +160,7 @@ var MigrationBuilder = class {
     await docHandle.whenReady();
     return docHandle;
   }
-  _buildNewRoot() {
+  async _buildNewRoot() {
     const links = {
       ...this._rootDoc.links ?? {}
     };
@@ -143,7 +168,7 @@ var MigrationBuilder = class {
       delete links[id];
     }
     for (const [id, url] of Object.entries(this._newLinks)) {
-      links[id] = new am.RawString(url);
+      links[id] = new A.RawString(url);
     }
     this._newRoot = this._repo.create({
       version: SpaceDocVersion.CURRENT,
@@ -153,15 +178,16 @@ var MigrationBuilder = class {
       objects: this._rootDoc.objects,
       links
     });
-    this._addHandleToFlushList(this._newRoot);
+    await this._newRoot.whenReady();
+    this._addHandleToFlushList(this._newRoot.documentId);
   }
-  _createObject({ id, schema, props }) {
+  async _createObject({ id, schema, props }) {
     const core = new ObjectCore();
     if (id) {
       core.id = id;
     }
     core.initNewObject(props);
-    core.setType(requireTypeReference(schema));
+    core.setType(EncodedReference.fromURI(getSchemaURI(schema)));
     const newHandle = this._repo.create({
       version: SpaceDocVersion.CURRENT,
       access: {
@@ -171,25 +197,51 @@ var MigrationBuilder = class {
         [core.id]: core.getDoc()
       }
     });
+    await newHandle.whenReady();
     this._newLinks[core.id] = newHandle.url;
-    this._addHandleToFlushList(newHandle);
+    this._addHandleToFlushList(newHandle.documentId);
     return core;
   }
-  _addHandleToFlushList(handle) {
-    this._flushIds.push(handle.documentId);
+  _addHandleToFlushList(id) {
+    this._flushIds.push(id);
   }
 };
 
+// src/document-compaction.ts
+var __dxlog_file2 = "/__w/dxos/dxos/packages/sdk/migrations/src/document-compaction.ts";
+var compactDocumentsEpochMigration = async (space, options = {}) => {
+  invariant2(space.state.get() === SpaceState.SPACE_READY, "Space must be open and ready before compaction.", { "~LogMeta": "~LogMeta", F: __dxlog_file2, L: 11, S: void 0, A: ["space.state.get() === SpaceState.SPACE_READY", "'Space must be open and ready before compaction.'"] });
+  const builder = new MigrationBuilder(space);
+  const { compacted, skipped } = await builder.compactLinkedDocuments(options.objectIds);
+  await builder._commit();
+  const epochs = await space.internal.getEpochs();
+  const lastEpoch = epochs[epochs.length - 1];
+  const epochNumber = lastEpoch?.subject.assertion.number ?? 0;
+  return {
+    compacted,
+    skipped,
+    epochNumber
+  };
+};
+
 // src/migrations.ts
-import { SpaceState, live } from "@dxos/client/echo";
-import { invariant as invariant2 } from "@dxos/invariant";
-var __dxlog_file2 = "/__w/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
+import { Atom } from "@effect-atom/atom";
+import * as Registry from "@effect-atom/atom/Registry";
+import * as Option from "effect/Option";
+import { SpaceState as SpaceState2 } from "@dxos/client/echo";
+import { Annotation as Annotation2, Obj } from "@dxos/echo";
+import { invariant as invariant3 } from "@dxos/invariant";
+var __dxlog_file3 = "/__w/dxos/dxos/packages/sdk/migrations/src/migrations.ts";
 var Migrations = class {
   static namespace;
   static migrations = [];
-  static _state = live({
+  static _registry = Registry.make();
+  static _stateAtom = Atom.make({
     running: []
-  });
+  }).pipe(Atom.keepAlive);
+  /**
+  * @deprecated Use `MigrationVersionAnnotation` via `Annotation.get/set` on space properties.
+  */
   static get versionProperty() {
     return this.namespace && `${this.namespace}.version`;
   }
@@ -197,77 +249,59 @@ var Migrations = class {
     return this.migrations[this.migrations.length - 1]?.version;
   }
   static running(space) {
-    return this._state.running.includes(space.key.toHex());
+    const state = this._registry.get(this._stateAtom);
+    return state.running.includes(space.key.toHex());
   }
   static define(namespace, migrations) {
     this.namespace = namespace;
     this.migrations = migrations;
   }
   static async migrate(space, targetVersion) {
-    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'"
-      ]
-    });
-    invariant2(space.state.get() === SpaceState.SPACE_READY, "Space not ready", {
-      F: __dxlog_file2,
-      L: 46,
-      S: this,
-      A: [
-        "space.state.get() === SpaceState.SPACE_READY",
-        "'Space not ready'"
-      ]
-    });
-    const currentVersion = space.properties[this.versionProperty];
+    invariant3(!this.running(space), "Migration already running", { "~LogMeta": "~LogMeta", F: __dxlog_file3, L: 36, S: this, A: ["!this.running(space)", "'Migration already running'"] });
+    invariant3(space.state.get() === SpaceState2.SPACE_READY, "Space not ready", { "~LogMeta": "~LogMeta", F: __dxlog_file3, L: 37, S: this, A: ["space.state.get() === SpaceState.SPACE_READY", "'Space not ready'"] });
+    const currentVersion = Annotation2.get(space.properties, MigrationVersionAnnotation).pipe(Option.getOrUndefined);
     const currentIndex = this.migrations.findIndex((m) => m.version === currentVersion) + 1;
     const i = this.migrations.findIndex((m) => m.version === targetVersion);
     const targetIndex = i === -1 ? this.migrations.length : i + 1;
     if (currentIndex === targetIndex) {
       return false;
     }
-    this._state.running.push(space.key.toHex());
-    if (targetIndex > currentIndex) {
-      const migrations = this.migrations.slice(currentIndex, targetIndex);
-      for (const migration of migrations) {
-        const builder = new MigrationBuilder(space);
-        await migration.next({
-          space,
-          builder
-        });
-        builder.changeProperties((propertiesStructure) => {
-          invariant2(this.versionProperty, "Migrations namespace not set", {
-            F: __dxlog_file2,
-            L: 62,
-            S: this,
-            A: [
-              "this.versionProperty",
-              "'Migrations namespace not set'"
-            ]
+    const spaceKey = space.key.toHex();
+    const currentState = this._registry.get(this._stateAtom);
+    this._registry.set(this._stateAtom, {
+      running: [
+        ...currentState.running,
+        spaceKey
+      ]
+    });
+    try {
+      if (targetIndex > currentIndex) {
+        const migrations = this.migrations.slice(currentIndex, targetIndex);
+        for (const migration of migrations) {
+          const builder = new MigrationBuilder(space);
+          await migration.next({
+            space,
+            builder
+          });
+          await builder._commit();
+          Obj.update(space.properties, (properties) => {
+            Annotation2.set(properties, MigrationVersionAnnotation, migration.version);
           });
-          propertiesStructure.data[this.versionProperty] = migration.version;
-        });
-        await builder._commit();
+        }
       }
+    } finally {
+      const finalState = this._registry.get(this._stateAtom);
+      this._registry.set(this._stateAtom, {
+        running: finalState.running.filter((key) => key !== spaceKey)
+      });
     }
-    this._state.running.splice(this._state.running.indexOf(space.key.toHex()), 1);
     return true;
   }
 };
 export {
   MigrationBuilder,
-  Migrations
+  MigrationVersionAnnotation,
+  Migrations,
+  compactDocumentsEpochMigration
 };
 //# sourceMappingURL=index.mjs.map