@dxos/echo-protocol 0.5.9-main.bfee100 → 0.5.9-main.c2c4258

package/dist/lib/browser/index.mjs

@@ -1,44 +1,101 @@
 // packages/core/echo/echo-protocol/src/reference.ts
+import { DXN, LOCAL_SPACE_TAG } from "@dxos/keys";
 var Reference = class _Reference {
+  static {
+    /**
+    * Protocol references to runtime registered types.
+    */
+    this.TYPE_PROTOCOL = "protobuf";
+  }
   static fromValue(value) {
-    return new _Reference(value.itemId, value.protocol, value.host);
+    return new _Reference(value.objectId, value.protocol, value.host);
   }
   /**
   * @deprecated
   */
   // TODO(burdon): Document/remove?
   static fromLegacyTypename(type) {
-    return new _Reference(type, "protobuf", "dxos.org");
+    return new _Reference(type, _Reference.TYPE_PROTOCOL, "dxos.org");
+  }
+  static fromDXN(dxn) {
+    switch (dxn.kind) {
+      case DXN.kind.TYPE:
+        return _Reference.fromLegacyTypename(dxn.parts[0]);
+      case DXN.kind.ECHO:
+        if (dxn.parts[0] === LOCAL_SPACE_TAG) {
+          return new _Reference(dxn.parts[1]);
+        } else {
+          return new _Reference(dxn.parts[1], void 0, dxn.parts[0]);
+        }
+      default:
+        throw new Error(`Unsupported DXN kind: ${dxn.kind}`);
+    }
   }
   // prettier-ignore
-  constructor(itemId, protocol, host) {
-    this.itemId = itemId;
+  constructor(objectId, protocol, host) {
+    this.objectId = objectId;
     this.protocol = protocol;
     this.host = host;
   }
   encode() {
     return {
-      itemId: this.itemId,
+      objectId: this.objectId,
       host: this.host,
       protocol: this.protocol
     };
   }
+  toDXN() {
+    if (this.protocol === _Reference.TYPE_PROTOCOL) {
+      return new DXN(DXN.kind.TYPE, [
+        this.objectId
+      ]);
+    } else {
+      if (this.host) {
+        return new DXN(DXN.kind.ECHO, [
+          this.host,
+          this.objectId
+        ]);
+      } else {
+        return new DXN(DXN.kind.ECHO, [
+          LOCAL_SPACE_TAG,
+          this.objectId
+        ]);
+      }
+    }
+  }
 };
 var REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
 var encodeReference = (reference) => ({
-  "@type": REFERENCE_TYPE_TAG,
-  // NOTE: Automerge do not support undefined values, so we need to use null instead.
-  itemId: reference.itemId ?? null,
-  protocol: reference.protocol ?? null,
-  host: reference.host ?? null
+  "/": reference.toDXN().toString()
+});
+var decodeReference = (value) => Reference.fromDXN(DXN.parse(value["/"]));
+var isEncodedReference = (value) => typeof value === "object" && value !== null && Object.keys(value).length === 1 && typeof value["/"] === "string";
+
+// packages/core/echo/echo-protocol/src/space-doc-version.ts
+var SpaceDocVersion = Object.freeze({
+  /**
+  * For the documents created before the versioning was introduced.
+  */
+  LEGACY: 0,
+  /**
+  * Current version.
+  */
+  CURRENT: 1
 });
-var decodeReference = (value) => new Reference(value.itemId, value.protocol ?? void 0, value.host ?? void 0);
-var isEncodedReferenceObject = (value) => typeof value === "object" && value !== null && value["@type"] === REFERENCE_TYPE_TAG;
+
+// packages/core/echo/echo-protocol/src/legacy.ts
+var LEGACY_REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
+var isLegacyReference = (value) => typeof value === "object" && value !== null && value["@type"] === LEGACY_REFERENCE_TYPE_TAG;
+var LEGACY_TYPE_PROPERTIES = "dxos.sdk.client.Properties";
 export {
+  LEGACY_REFERENCE_TYPE_TAG,
+  LEGACY_TYPE_PROPERTIES,
   REFERENCE_TYPE_TAG,
   Reference,
+  SpaceDocVersion,
   decodeReference,
   encodeReference,
-  isEncodedReferenceObject
+  isEncodedReference,
+  isLegacyReference
 };
 //# sourceMappingURL=index.mjs.map

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../../src/reference.ts"],
-  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { type ItemID } from '@dxos/protocols';\nimport { type Reference as ReferenceValue } from '@dxos/protocols/proto/dxos/echo/model/document';\n\n// TODO(burdon): Comment.\nexport class Reference {\n  static fromValue(value: ReferenceValue): Reference {\n    return new Reference(value.itemId, value.protocol, value.host);\n  }\n\n  /**\n   * @deprecated\n   */\n  // TODO(burdon): Document/remove?\n  static fromLegacyTypename(type: string): Reference {\n    return new Reference(type, 'protobuf', 'dxos.org');\n  }\n\n  // prettier-ignore\n  constructor(\n    // TODO(burdon): Change to objectId (and typename).\n    public readonly itemId: ItemID,\n    public readonly protocol?: string,\n    public readonly host?: string\n  ) {}\n\n  encode(): ReferenceValue {\n    return { itemId: this.itemId, host: this.host, protocol: this.protocol };\n  }\n}\n\nexport const REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';\n\n/**\n * Reference as it is stored in Automerge document.\n */\nexport type EncodedReferenceObject = {\n  '@type': typeof REFERENCE_TYPE_TAG;\n  itemId: string | null;\n  protocol: string | null;\n  host: string | null;\n};\n\nexport const encodeReference = (reference: Reference): EncodedReferenceObject => ({\n  '@type': REFERENCE_TYPE_TAG,\n  // NOTE: Automerge do not support undefined values, so we need to use null instead.\n  itemId: reference.itemId ?? null,\n  protocol: reference.protocol ?? null,\n  host: reference.host ?? null,\n});\n\nexport const decodeReference = (value: any) =>\n  new Reference(value.itemId, value.protocol ?? undefined, value.host ?? undefined);\n\nexport const isEncodedReferenceObject = (value: any): value is EncodedReferenceObject =>\n  typeof value === 'object' && value !== null && value['@type'] === REFERENCE_TYPE_TAG;\n"],
-  "mappings": ";AAQO,IAAMA,YAAN,MAAMA,WAAAA;EACX,OAAOC,UAAUC,OAAkC;AACjD,WAAO,IAAIF,WAAUE,MAAMC,QAAQD,MAAME,UAAUF,MAAMG,IAAI;EAC/D;;;;;EAMA,OAAOC,mBAAmBC,MAAyB;AACjD,WAAO,IAAIP,WAAUO,MAAM,YAAY,UAAA;EACzC;;EAGAC,YAEkBL,QACAC,UACAC,MAChB;SAHgBF,SAAAA;SACAC,WAAAA;SACAC,OAAAA;EACf;EAEHI,SAAyB;AACvB,WAAO;MAAEN,QAAQ,KAAKA;MAAQE,MAAM,KAAKA;MAAMD,UAAU,KAAKA;IAAS;EACzE;AACF;AAEO,IAAMM,qBAAqB;AAY3B,IAAMC,kBAAkB,CAACC,eAAkD;EAChF,SAASF;;EAETP,QAAQS,UAAUT,UAAU;EAC5BC,UAAUQ,UAAUR,YAAY;EAChCC,MAAMO,UAAUP,QAAQ;AAC1B;AAEO,IAAMQ,kBAAkB,CAACX,UAC9B,IAAIF,UAAUE,MAAMC,QAAQD,MAAME,YAAYU,QAAWZ,MAAMG,QAAQS,MAAAA;AAElE,IAAMC,2BAA2B,CAACb,UACvC,OAAOA,UAAU,YAAYA,UAAU,QAAQA,MAAM,OAAA,MAAaQ;",
-  "names": ["Reference", "fromValue", "value", "itemId", "protocol", "host", "fromLegacyTypename", "type", "constructor", "encode", "REFERENCE_TYPE_TAG", "encodeReference", "reference", "decodeReference", "undefined", "isEncodedReferenceObject"]
+  "sources": ["../../../src/reference.ts", "../../../src/space-doc-version.ts", "../../../src/legacy.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { DXN, LOCAL_SPACE_TAG } from '@dxos/keys';\nimport { type ObjectId } from '@dxos/protocols';\nimport { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';\n\n/**\n * Runtime representation of object reference.\n */\nexport class Reference {\n  /**\n   * Protocol references to runtime registered types.\n   */\n  static TYPE_PROTOCOL = 'protobuf';\n\n  static fromValue(value: ReferenceProto): Reference {\n    return new Reference(value.objectId, value.protocol, value.host);\n  }\n\n  /**\n   * @deprecated\n   */\n  // TODO(burdon): Document/remove?\n  static fromLegacyTypename(type: string): Reference {\n    return new Reference(type, Reference.TYPE_PROTOCOL, 'dxos.org');\n  }\n\n  static fromDXN(dxn: DXN): Reference {\n    switch (dxn.kind) {\n      case DXN.kind.TYPE:\n        return Reference.fromLegacyTypename(dxn.parts[0]);\n      case DXN.kind.ECHO:\n        if (dxn.parts[0] === LOCAL_SPACE_TAG) {\n          return new Reference(dxn.parts[1]);\n        } else {\n          return new Reference(dxn.parts[1], undefined, dxn.parts[0]);\n        }\n      default:\n        throw new Error(`Unsupported DXN kind: ${dxn.kind}`);\n    }\n  }\n\n  // prettier-ignore\n  constructor(\n    public readonly objectId: ObjectId,\n    public readonly protocol?: string,\n    public readonly host?: string\n  ) {}\n\n  encode(): ReferenceProto {\n    return { objectId: this.objectId, host: this.host, protocol: this.protocol };\n  }\n\n  toDXN(): DXN {\n    if (this.protocol === Reference.TYPE_PROTOCOL) {\n      return new DXN(DXN.kind.TYPE, [this.objectId]);\n    } else {\n      if (this.host) {\n        // Host is assumed to be the space key.\n        // The DXN should actually have the space ID.\n        // TODO(dmaretskyi): Migrate to space id.\n        return new DXN(DXN.kind.ECHO, [this.host, this.objectId]);\n      } else {\n        return new DXN(DXN.kind.ECHO, [LOCAL_SPACE_TAG, this.objectId]);\n      }\n    }\n  }\n}\n\nexport const REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';\n\n/**\n * Reference as it is stored in Automerge document.\n */\nexport type EncodedReference = {\n  '/': string;\n};\n\nexport const encodeReference = (reference: Reference): EncodedReference => ({\n  '/': reference.toDXN().toString(),\n});\n\nexport const decodeReference = (value: any) => Reference.fromDXN(DXN.parse(value['/']));\n\nexport const isEncodedReference = (value: any): value is EncodedReference =>\n  typeof value === 'object' && value !== null && Object.keys(value).length === 1 && typeof value['/'] === 'string';\n", "//\n// Copyright 2024 DXOS.org\n//\n\n/**\n * Denotes the data version of the space automerge document as well as the leaf documents for each individual ECHO object.\n */\nexport type SpaceDocVersion = number & { __type: 'SpaceDocVersion' };\n\nexport const SpaceDocVersion = Object.freeze({\n  /**\n   * For the documents created before the versioning was introduced.\n   */\n  LEGACY: 0 as SpaceDocVersion,\n\n  /**\n   * Current version.\n   */\n  CURRENT: 1 as SpaceDocVersion,\n});\n", "//\n// Copyright 2024 DXOS.org\n//\n\nexport const LEGACY_REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';\n\n/**\n * Reference as it is stored in Automerge document.\n */\nexport type LegacyEncodedReferenceObject = {\n  '@type': typeof LEGACY_REFERENCE_TYPE_TAG;\n  itemId: string;\n  protocol?: string;\n  host?: string;\n};\n\nexport const isLegacyReference = (value: any): boolean =>\n  typeof value === 'object' && value !== null && value['@type'] === LEGACY_REFERENCE_TYPE_TAG;\n\nexport const LEGACY_TYPE_PROPERTIES = 'dxos.sdk.client.Properties';\n"],
+  "mappings": ";AAIA,SAASA,KAAKC,uBAAuB;AAO9B,IAAMC,YAAN,MAAMA,WAAAA;EAIX;;;;SAAOC,gBAAgB;;EAEvB,OAAOC,UAAUC,OAAkC;AACjD,WAAO,IAAIH,WAAUG,MAAMC,UAAUD,MAAME,UAAUF,MAAMG,IAAI;EACjE;;;;;EAMA,OAAOC,mBAAmBC,MAAyB;AACjD,WAAO,IAAIR,WAAUQ,MAAMR,WAAUC,eAAe,UAAA;EACtD;EAEA,OAAOQ,QAAQC,KAAqB;AAClC,YAAQA,IAAIC,MAAI;MACd,KAAKC,IAAID,KAAKE;AACZ,eAAOb,WAAUO,mBAAmBG,IAAII,MAAM,CAAA,CAAE;MAClD,KAAKF,IAAID,KAAKI;AACZ,YAAIL,IAAII,MAAM,CAAA,MAAOE,iBAAiB;AACpC,iBAAO,IAAIhB,WAAUU,IAAII,MAAM,CAAA,CAAE;QACnC,OAAO;AACL,iBAAO,IAAId,WAAUU,IAAII,MAAM,CAAA,GAAIG,QAAWP,IAAII,MAAM,CAAA,CAAE;QAC5D;MACF;AACE,cAAM,IAAII,MAAM,yBAAyBR,IAAIC,IAAI,EAAE;IACvD;EACF;;EAGAQ,YACkBf,UACAC,UACAC,MAChB;SAHgBF,WAAAA;SACAC,WAAAA;SACAC,OAAAA;EACf;EAEHc,SAAyB;AACvB,WAAO;MAAEhB,UAAU,KAAKA;MAAUE,MAAM,KAAKA;MAAMD,UAAU,KAAKA;IAAS;EAC7E;EAEAgB,QAAa;AACX,QAAI,KAAKhB,aAAaL,WAAUC,eAAe;AAC7C,aAAO,IAAIW,IAAIA,IAAID,KAAKE,MAAM;QAAC,KAAKT;OAAS;IAC/C,OAAO;AACL,UAAI,KAAKE,MAAM;AAIb,eAAO,IAAIM,IAAIA,IAAID,KAAKI,MAAM;UAAC,KAAKT;UAAM,KAAKF;SAAS;MAC1D,OAAO;AACL,eAAO,IAAIQ,IAAIA,IAAID,KAAKI,MAAM;UAACC;UAAiB,KAAKZ;SAAS;MAChE;IACF;EACF;AACF;AAEO,IAAMkB,qBAAqB;AAS3B,IAAMC,kBAAkB,CAACC,eAA4C;EAC1E,KAAKA,UAAUH,MAAK,EAAGI,SAAQ;AACjC;AAEO,IAAMC,kBAAkB,CAACvB,UAAeH,UAAUS,QAAQG,IAAIe,MAAMxB,MAAM,GAAA,CAAI,CAAA;AAE9E,IAAMyB,qBAAqB,CAACzB,UACjC,OAAOA,UAAU,YAAYA,UAAU,QAAQ0B,OAAOC,KAAK3B,KAAAA,EAAO4B,WAAW,KAAK,OAAO5B,MAAM,GAAA,MAAS;;;AC9EnG,IAAM6B,kBAAkBC,OAAOC,OAAO;;;;EAI3CC,QAAQ;;;;EAKRC,SAAS;AACX,CAAA;;;ACfO,IAAMC,4BAA4B;AAYlC,IAAMC,oBAAoB,CAACC,UAChC,OAAOA,UAAU,YAAYA,UAAU,QAAQA,MAAM,OAAA,MAAaF;AAE7D,IAAMG,yBAAyB;",
+  "names": ["DXN", "LOCAL_SPACE_TAG", "Reference", "TYPE_PROTOCOL", "fromValue", "value", "objectId", "protocol", "host", "fromLegacyTypename", "type", "fromDXN", "dxn", "kind", "DXN", "TYPE", "parts", "ECHO", "LOCAL_SPACE_TAG", "undefined", "Error", "constructor", "encode", "toDXN", "REFERENCE_TYPE_TAG", "encodeReference", "reference", "toString", "decodeReference", "parse", "isEncodedReference", "Object", "keys", "length", "SpaceDocVersion", "Object", "freeze", "LEGACY", "CURRENT", "LEGACY_REFERENCE_TYPE_TAG", "isLegacyReference", "value", "LEGACY_TYPE_PROPERTIES"]
 }

package/dist/lib/browser/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2420,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":5696,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":623,"imports":[{"path":"packages/core/echo/echo-protocol/src/document-structure.ts","kind":"import-statement","original":"./document-structure"},{"path":"packages/core/echo/echo-protocol/src/reference.ts","kind":"import-statement","original":"./reference"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":2847},"packages/core/echo/echo-protocol/dist/lib/browser/index.mjs":{"imports":[],"exports":["REFERENCE_TYPE_TAG","Reference","decodeReference","encodeReference","isEncodedReferenceObject"],"entryPoint":"packages/core/echo/echo-protocol/src/index.ts","inputs":{"packages/core/echo/echo-protocol/src/index.ts":{"bytesInOutput":0},"packages/core/echo/echo-protocol/src/reference.ts":{"bytesInOutput":1128}},"bytes":1328}}}
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2528,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":9351,"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true}],"format":"esm"},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytes":1591,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytes":1719,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":818,"imports":[{"path":"packages/core/echo/echo-protocol/src/document-structure.ts","kind":"import-statement","original":"./document-structure"},{"path":"packages/core/echo/echo-protocol/src/reference.ts","kind":"import-statement","original":"./reference"},{"path":"packages/core/echo/echo-protocol/src/space-doc-version.ts","kind":"import-statement","original":"./space-doc-version"},{"path":"packages/core/echo/echo-protocol/src/legacy.ts","kind":"import-statement","original":"./legacy"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5988},"packages/core/echo/echo-protocol/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true}],"exports":["LEGACY_REFERENCE_TYPE_TAG","LEGACY_TYPE_PROPERTIES","REFERENCE_TYPE_TAG","Reference","SpaceDocVersion","decodeReference","encodeReference","isEncodedReference","isLegacyReference"],"entryPoint":"packages/core/echo/echo-protocol/src/index.ts","inputs":{"packages/core/echo/echo-protocol/src/index.ts":{"bytesInOutput":0},"packages/core/echo/echo-protocol/src/reference.ts":{"bytesInOutput":1969},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytesInOutput":179},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytesInOutput":257}},"bytes":2807}}}

package/dist/lib/node/index.cjs

@@ -18,54 +18,108 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var node_exports = {};
 __export(node_exports, {
+  LEGACY_REFERENCE_TYPE_TAG: () => LEGACY_REFERENCE_TYPE_TAG,
+  LEGACY_TYPE_PROPERTIES: () => LEGACY_TYPE_PROPERTIES,
   REFERENCE_TYPE_TAG: () => REFERENCE_TYPE_TAG,
   Reference: () => Reference,
+  SpaceDocVersion: () => SpaceDocVersion,
   decodeReference: () => decodeReference,
   encodeReference: () => encodeReference,
-  isEncodedReferenceObject: () => isEncodedReferenceObject
+  isEncodedReference: () => isEncodedReference,
+  isLegacyReference: () => isLegacyReference
 });
 module.exports = __toCommonJS(node_exports);
+var import_keys = require("@dxos/keys");
 var Reference = class _Reference {
+  static {
+    this.TYPE_PROTOCOL = "protobuf";
+  }
   static fromValue(value) {
-    return new _Reference(value.itemId, value.protocol, value.host);
+    return new _Reference(value.objectId, value.protocol, value.host);
   }
   /**
   * @deprecated
   */
   // TODO(burdon): Document/remove?
   static fromLegacyTypename(type) {
-    return new _Reference(type, "protobuf", "dxos.org");
+    return new _Reference(type, _Reference.TYPE_PROTOCOL, "dxos.org");
+  }
+  static fromDXN(dxn) {
+    switch (dxn.kind) {
+      case import_keys.DXN.kind.TYPE:
+        return _Reference.fromLegacyTypename(dxn.parts[0]);
+      case import_keys.DXN.kind.ECHO:
+        if (dxn.parts[0] === import_keys.LOCAL_SPACE_TAG) {
+          return new _Reference(dxn.parts[1]);
+        } else {
+          return new _Reference(dxn.parts[1], void 0, dxn.parts[0]);
+        }
+      default:
+        throw new Error(`Unsupported DXN kind: ${dxn.kind}`);
+    }
   }
   // prettier-ignore
-  constructor(itemId, protocol, host) {
-    this.itemId = itemId;
+  constructor(objectId, protocol, host) {
+    this.objectId = objectId;
     this.protocol = protocol;
     this.host = host;
   }
   encode() {
     return {
-      itemId: this.itemId,
+      objectId: this.objectId,
       host: this.host,
       protocol: this.protocol
     };
   }
+  toDXN() {
+    if (this.protocol === _Reference.TYPE_PROTOCOL) {
+      return new import_keys.DXN(import_keys.DXN.kind.TYPE, [
+        this.objectId
+      ]);
+    } else {
+      if (this.host) {
+        return new import_keys.DXN(import_keys.DXN.kind.ECHO, [
+          this.host,
+          this.objectId
+        ]);
+      } else {
+        return new import_keys.DXN(import_keys.DXN.kind.ECHO, [
+          import_keys.LOCAL_SPACE_TAG,
+          this.objectId
+        ]);
+      }
+    }
+  }
 };
 var REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
 var encodeReference = (reference) => ({
-  "@type": REFERENCE_TYPE_TAG,
-  // NOTE: Automerge do not support undefined values, so we need to use null instead.
-  itemId: reference.itemId ?? null,
-  protocol: reference.protocol ?? null,
-  host: reference.host ?? null
+  "/": reference.toDXN().toString()
+});
+var decodeReference = (value) => Reference.fromDXN(import_keys.DXN.parse(value["/"]));
+var isEncodedReference = (value) => typeof value === "object" && value !== null && Object.keys(value).length === 1 && typeof value["/"] === "string";
+var SpaceDocVersion = Object.freeze({
+  /**
+  * For the documents created before the versioning was introduced.
+  */
+  LEGACY: 0,
+  /**
+  * Current version.
+  */
+  CURRENT: 1
 });
-var decodeReference = (value) => new Reference(value.itemId, value.protocol ?? void 0, value.host ?? void 0);
-var isEncodedReferenceObject = (value) => typeof value === "object" && value !== null && value["@type"] === REFERENCE_TYPE_TAG;
+var LEGACY_REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
+var isLegacyReference = (value) => typeof value === "object" && value !== null && value["@type"] === LEGACY_REFERENCE_TYPE_TAG;
+var LEGACY_TYPE_PROPERTIES = "dxos.sdk.client.Properties";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  LEGACY_REFERENCE_TYPE_TAG,
+  LEGACY_TYPE_PROPERTIES,
   REFERENCE_TYPE_TAG,
   Reference,
+  SpaceDocVersion,
   decodeReference,
   encodeReference,
-  isEncodedReferenceObject
+  isEncodedReference,
+  isLegacyReference
 });
 //# sourceMappingURL=index.cjs.map

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../../src/reference.ts"],
-  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { type ItemID } from '@dxos/protocols';\nimport { type Reference as ReferenceValue } from '@dxos/protocols/proto/dxos/echo/model/document';\n\n// TODO(burdon): Comment.\nexport class Reference {\n  static fromValue(value: ReferenceValue): Reference {\n    return new Reference(value.itemId, value.protocol, value.host);\n  }\n\n  /**\n   * @deprecated\n   */\n  // TODO(burdon): Document/remove?\n  static fromLegacyTypename(type: string): Reference {\n    return new Reference(type, 'protobuf', 'dxos.org');\n  }\n\n  // prettier-ignore\n  constructor(\n    // TODO(burdon): Change to objectId (and typename).\n    public readonly itemId: ItemID,\n    public readonly protocol?: string,\n    public readonly host?: string\n  ) {}\n\n  encode(): ReferenceValue {\n    return { itemId: this.itemId, host: this.host, protocol: this.protocol };\n  }\n}\n\nexport const REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';\n\n/**\n * Reference as it is stored in Automerge document.\n */\nexport type EncodedReferenceObject = {\n  '@type': typeof REFERENCE_TYPE_TAG;\n  itemId: string | null;\n  protocol: string | null;\n  host: string | null;\n};\n\nexport const encodeReference = (reference: Reference): EncodedReferenceObject => ({\n  '@type': REFERENCE_TYPE_TAG,\n  // NOTE: Automerge do not support undefined values, so we need to use null instead.\n  itemId: reference.itemId ?? null,\n  protocol: reference.protocol ?? null,\n  host: reference.host ?? null,\n});\n\nexport const decodeReference = (value: any) =>\n  new Reference(value.itemId, value.protocol ?? undefined, value.host ?? undefined);\n\nexport const isEncodedReferenceObject = (value: any): value is EncodedReferenceObject =>\n  typeof value === 'object' && value !== null && value['@type'] === REFERENCE_TYPE_TAG;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAQO,IAAMA,YAAN,MAAMA,WAAAA;EACX,OAAOC,UAAUC,OAAkC;AACjD,WAAO,IAAIF,WAAUE,MAAMC,QAAQD,MAAME,UAAUF,MAAMG,IAAI;EAC/D;;;;;EAMA,OAAOC,mBAAmBC,MAAyB;AACjD,WAAO,IAAIP,WAAUO,MAAM,YAAY,UAAA;EACzC;;EAGAC,YAEkBL,QACAC,UACAC,MAChB;SAHgBF,SAAAA;SACAC,WAAAA;SACAC,OAAAA;EACf;EAEHI,SAAyB;AACvB,WAAO;MAAEN,QAAQ,KAAKA;MAAQE,MAAM,KAAKA;MAAMD,UAAU,KAAKA;IAAS;EACzE;AACF;AAEO,IAAMM,qBAAqB;AAY3B,IAAMC,kBAAkB,CAACC,eAAkD;EAChF,SAASF;;EAETP,QAAQS,UAAUT,UAAU;EAC5BC,UAAUQ,UAAUR,YAAY;EAChCC,MAAMO,UAAUP,QAAQ;AAC1B;AAEO,IAAMQ,kBAAkB,CAACX,UAC9B,IAAIF,UAAUE,MAAMC,QAAQD,MAAME,YAAYU,QAAWZ,MAAMG,QAAQS,MAAAA;AAElE,IAAMC,2BAA2B,CAACb,UACvC,OAAOA,UAAU,YAAYA,UAAU,QAAQA,MAAM,OAAA,MAAaQ;",
-  "names": ["Reference", "fromValue", "value", "itemId", "protocol", "host", "fromLegacyTypename", "type", "constructor", "encode", "REFERENCE_TYPE_TAG", "encodeReference", "reference", "decodeReference", "undefined", "isEncodedReferenceObject"]
+  "sources": ["../../../src/reference.ts", "../../../src/space-doc-version.ts", "../../../src/legacy.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { DXN, LOCAL_SPACE_TAG } from '@dxos/keys';\nimport { type ObjectId } from '@dxos/protocols';\nimport { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';\n\n/**\n * Runtime representation of object reference.\n */\nexport class Reference {\n  /**\n   * Protocol references to runtime registered types.\n   */\n  static TYPE_PROTOCOL = 'protobuf';\n\n  static fromValue(value: ReferenceProto): Reference {\n    return new Reference(value.objectId, value.protocol, value.host);\n  }\n\n  /**\n   * @deprecated\n   */\n  // TODO(burdon): Document/remove?\n  static fromLegacyTypename(type: string): Reference {\n    return new Reference(type, Reference.TYPE_PROTOCOL, 'dxos.org');\n  }\n\n  static fromDXN(dxn: DXN): Reference {\n    switch (dxn.kind) {\n      case DXN.kind.TYPE:\n        return Reference.fromLegacyTypename(dxn.parts[0]);\n      case DXN.kind.ECHO:\n        if (dxn.parts[0] === LOCAL_SPACE_TAG) {\n          return new Reference(dxn.parts[1]);\n        } else {\n          return new Reference(dxn.parts[1], undefined, dxn.parts[0]);\n        }\n      default:\n        throw new Error(`Unsupported DXN kind: ${dxn.kind}`);\n    }\n  }\n\n  // prettier-ignore\n  constructor(\n    public readonly objectId: ObjectId,\n    public readonly protocol?: string,\n    public readonly host?: string\n  ) {}\n\n  encode(): ReferenceProto {\n    return { objectId: this.objectId, host: this.host, protocol: this.protocol };\n  }\n\n  toDXN(): DXN {\n    if (this.protocol === Reference.TYPE_PROTOCOL) {\n      return new DXN(DXN.kind.TYPE, [this.objectId]);\n    } else {\n      if (this.host) {\n        // Host is assumed to be the space key.\n        // The DXN should actually have the space ID.\n        // TODO(dmaretskyi): Migrate to space id.\n        return new DXN(DXN.kind.ECHO, [this.host, this.objectId]);\n      } else {\n        return new DXN(DXN.kind.ECHO, [LOCAL_SPACE_TAG, this.objectId]);\n      }\n    }\n  }\n}\n\nexport const REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';\n\n/**\n * Reference as it is stored in Automerge document.\n */\nexport type EncodedReference = {\n  '/': string;\n};\n\nexport const encodeReference = (reference: Reference): EncodedReference => ({\n  '/': reference.toDXN().toString(),\n});\n\nexport const decodeReference = (value: any) => Reference.fromDXN(DXN.parse(value['/']));\n\nexport const isEncodedReference = (value: any): value is EncodedReference =>\n  typeof value === 'object' && value !== null && Object.keys(value).length === 1 && typeof value['/'] === 'string';\n", "//\n// Copyright 2024 DXOS.org\n//\n\n/**\n * Denotes the data version of the space automerge document as well as the leaf documents for each individual ECHO object.\n */\nexport type SpaceDocVersion = number & { __type: 'SpaceDocVersion' };\n\nexport const SpaceDocVersion = Object.freeze({\n  /**\n   * For the documents created before the versioning was introduced.\n   */\n  LEGACY: 0 as SpaceDocVersion,\n\n  /**\n   * Current version.\n   */\n  CURRENT: 1 as SpaceDocVersion,\n});\n", "//\n// Copyright 2024 DXOS.org\n//\n\nexport const LEGACY_REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';\n\n/**\n * Reference as it is stored in Automerge document.\n */\nexport type LegacyEncodedReferenceObject = {\n  '@type': typeof LEGACY_REFERENCE_TYPE_TAG;\n  itemId: string;\n  protocol?: string;\n  host?: string;\n};\n\nexport const isLegacyReference = (value: any): boolean =>\n  typeof value === 'object' && value !== null && value['@type'] === LEGACY_REFERENCE_TYPE_TAG;\n\nexport const LEGACY_TYPE_PROPERTIES = 'dxos.sdk.client.Properties';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kBAAqC;AAO9B,IAAMA,YAAN,MAAMA,WAAAA;EAIX,OAAA;SAAOC,gBAAgB;;EAEvB,OAAOC,UAAUC,OAAkC;AACjD,WAAO,IAAIH,WAAUG,MAAMC,UAAUD,MAAME,UAAUF,MAAMG,IAAI;EACjE;;;;;EAMA,OAAOC,mBAAmBC,MAAyB;AACjD,WAAO,IAAIR,WAAUQ,MAAMR,WAAUC,eAAe,UAAA;EACtD;EAEA,OAAOQ,QAAQC,KAAqB;AAClC,YAAQA,IAAIC,MAAI;MACd,KAAKC,gBAAID,KAAKE;AACZ,eAAOb,WAAUO,mBAAmBG,IAAII,MAAM,CAAA,CAAE;MAClD,KAAKF,gBAAID,KAAKI;AACZ,YAAIL,IAAII,MAAM,CAAA,MAAOE,6BAAiB;AACpC,iBAAO,IAAIhB,WAAUU,IAAII,MAAM,CAAA,CAAE;QACnC,OAAO;AACL,iBAAO,IAAId,WAAUU,IAAII,MAAM,CAAA,GAAIG,QAAWP,IAAII,MAAM,CAAA,CAAE;QAC5D;MACF;AACE,cAAM,IAAII,MAAM,yBAAyBR,IAAIC,IAAI,EAAE;IACvD;EACF;;EAGAQ,YACkBf,UACAC,UACAC,MAChB;SAHgBF,WAAAA;SACAC,WAAAA;SACAC,OAAAA;EACf;EAEHc,SAAyB;AACvB,WAAO;MAAEhB,UAAU,KAAKA;MAAUE,MAAM,KAAKA;MAAMD,UAAU,KAAKA;IAAS;EAC7E;EAEAgB,QAAa;AACX,QAAI,KAAKhB,aAAaL,WAAUC,eAAe;AAC7C,aAAO,IAAIW,gBAAIA,gBAAID,KAAKE,MAAM;QAAC,KAAKT;OAAS;IAC/C,OAAO;AACL,UAAI,KAAKE,MAAM;AAIb,eAAO,IAAIM,gBAAIA,gBAAID,KAAKI,MAAM;UAAC,KAAKT;UAAM,KAAKF;SAAS;MAC1D,OAAO;AACL,eAAO,IAAIQ,gBAAIA,gBAAID,KAAKI,MAAM;UAACC;UAAiB,KAAKZ;SAAS;MAChE;IACF;EACF;AACF;AAEO,IAAMkB,qBAAqB;AAS3B,IAAMC,kBAAkB,CAACC,eAA4C;EAC1E,KAAKA,UAAUH,MAAK,EAAGI,SAAQ;AACjC;AAEO,IAAMC,kBAAkB,CAACvB,UAAeH,UAAUS,QAAQG,gBAAIe,MAAMxB,MAAM,GAAA,CAAI,CAAA;AAE9E,IAAMyB,qBAAqB,CAACzB,UACjC,OAAOA,UAAU,YAAYA,UAAU,QAAQ0B,OAAOC,KAAK3B,KAAAA,EAAO4B,WAAW,KAAK,OAAO5B,MAAM,GAAA,MAAS;AC9EnG,IAAM6B,kBAAkBH,OAAOI,OAAO;;;;EAI3CC,QAAQ;;;;EAKRC,SAAS;AACX,CAAA;ACfO,IAAMC,4BAA4B;AAYlC,IAAMC,oBAAoB,CAAClC,UAChC,OAAOA,UAAU,YAAYA,UAAU,QAAQA,MAAM,OAAA,MAAaiC;AAE7D,IAAME,yBAAyB;",
+  "names": ["Reference", "TYPE_PROTOCOL", "fromValue", "value", "objectId", "protocol", "host", "fromLegacyTypename", "type", "fromDXN", "dxn", "kind", "DXN", "TYPE", "parts", "ECHO", "LOCAL_SPACE_TAG", "undefined", "Error", "constructor", "encode", "toDXN", "REFERENCE_TYPE_TAG", "encodeReference", "reference", "toString", "decodeReference", "parse", "isEncodedReference", "Object", "keys", "length", "SpaceDocVersion", "freeze", "LEGACY", "CURRENT", "LEGACY_REFERENCE_TYPE_TAG", "isLegacyReference", "LEGACY_TYPE_PROPERTIES"]
 }

package/dist/lib/node/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2420,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":5696,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":623,"imports":[{"path":"packages/core/echo/echo-protocol/src/document-structure.ts","kind":"import-statement","original":"./document-structure"},{"path":"packages/core/echo/echo-protocol/src/reference.ts","kind":"import-statement","original":"./reference"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":2847},"packages/core/echo/echo-protocol/dist/lib/node/index.cjs":{"imports":[],"exports":["REFERENCE_TYPE_TAG","Reference","decodeReference","encodeReference","isEncodedReferenceObject"],"entryPoint":"packages/core/echo/echo-protocol/src/index.ts","inputs":{"packages/core/echo/echo-protocol/src/index.ts":{"bytesInOutput":0},"packages/core/echo/echo-protocol/src/reference.ts":{"bytesInOutput":1128}},"bytes":1328}}}
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2528,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":9351,"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true}],"format":"esm"},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytes":1591,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytes":1719,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":818,"imports":[{"path":"packages/core/echo/echo-protocol/src/document-structure.ts","kind":"import-statement","original":"./document-structure"},{"path":"packages/core/echo/echo-protocol/src/reference.ts","kind":"import-statement","original":"./reference"},{"path":"packages/core/echo/echo-protocol/src/space-doc-version.ts","kind":"import-statement","original":"./space-doc-version"},{"path":"packages/core/echo/echo-protocol/src/legacy.ts","kind":"import-statement","original":"./legacy"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5988},"packages/core/echo/echo-protocol/dist/lib/node/index.cjs":{"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true}],"exports":["LEGACY_REFERENCE_TYPE_TAG","LEGACY_TYPE_PROPERTIES","REFERENCE_TYPE_TAG","Reference","SpaceDocVersion","decodeReference","encodeReference","isEncodedReference","isLegacyReference"],"entryPoint":"packages/core/echo/echo-protocol/src/index.ts","inputs":{"packages/core/echo/echo-protocol/src/index.ts":{"bytesInOutput":0},"packages/core/echo/echo-protocol/src/reference.ts":{"bytesInOutput":1969},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytesInOutput":179},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytesInOutput":257}},"bytes":2807}}}

package/dist/types/src/document-structure.d.ts

@@ -1,8 +1,10 @@
-import { type EncodedReferenceObject } from './reference';
+import { type EncodedReference } from './reference';
+import type { SpaceDocVersion } from './space-doc-version';
 export type SpaceState = {
     rootUrl?: string;
 };
 export interface SpaceDoc {
+    version?: SpaceDocVersion;
     access?: {
         spaceKey: string;
     };
@@ -58,7 +60,7 @@ export type ObjectSystem = {
     /**
      * Object reference ('protobuf' protocol) type.
      */
-    type?: EncodedReferenceObject;
+    type?: EncodedReference;
     /**
      * Deletion marker.
      */

package/dist/types/src/document-structure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-structure.d.ts","sourceRoot":"","sources":["../../../src/document-structure.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,MAAM,UAAU,GAAG;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC;KAC/B,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
+{"version":3,"file":"document-structure.d.ts","sourceRoot":"","sources":["../../../src/document-structure.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,MAAM,MAAM,UAAU,GAAG;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF,MAAM,WAAW,QAAQ;IACvB,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B,MAAM,CAAC,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC;KAC/B,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

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

@@ -1,3 +1,5 @@
 export * from './document-structure';
 export * from './reference';
+export * from './space-doc-version';
+export * from './legacy';
 //# 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,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC"}

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

@@ -0,0 +1,13 @@
+export declare const LEGACY_REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
+/**
+ * Reference as it is stored in Automerge document.
+ */
+export type LegacyEncodedReferenceObject = {
+    '@type': typeof LEGACY_REFERENCE_TYPE_TAG;
+    itemId: string;
+    protocol?: string;
+    host?: string;
+};
+export declare const isLegacyReference: (value: any) => boolean;
+export declare const LEGACY_TYPE_PROPERTIES = "dxos.sdk.client.Properties";
+//# sourceMappingURL=legacy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"legacy.d.ts","sourceRoot":"","sources":["../../../src/legacy.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,yBAAyB,uCAAuC,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,OAAO,yBAAyB,CAAC;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,eAAO,MAAM,iBAAiB,UAAW,GAAG,KAAG,OAC8C,CAAC;AAE9F,eAAO,MAAM,sBAAsB,+BAA+B,CAAC"}

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

@@ -1,28 +1,35 @@
-import { type ItemID } from '@dxos/protocols';
-import { type Reference as ReferenceValue } from '@dxos/protocols/proto/dxos/echo/model/document';
+import { DXN } from '@dxos/keys';
+import { type ObjectId } from '@dxos/protocols';
+import { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';
+/**
+ * Runtime representation of object reference.
+ */
 export declare class Reference {
-    readonly itemId: ItemID;
+    readonly objectId: ObjectId;
     readonly protocol?: string | undefined;
     readonly host?: string | undefined;
-    static fromValue(value: ReferenceValue): Reference;
+    /**
+     * Protocol references to runtime registered types.
+     */
+    static TYPE_PROTOCOL: string;
+    static fromValue(value: ReferenceProto): Reference;
     /**
      * @deprecated
      */
     static fromLegacyTypename(type: string): Reference;
-    constructor(itemId: ItemID, protocol?: string | undefined, host?: string | undefined);
-    encode(): ReferenceValue;
+    static fromDXN(dxn: DXN): Reference;
+    constructor(objectId: ObjectId, protocol?: string | undefined, host?: string | undefined);
+    encode(): ReferenceProto;
+    toDXN(): DXN;
 }
 export declare const REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
 /**
  * Reference as it is stored in Automerge document.
  */
-export type EncodedReferenceObject = {
-    '@type': typeof REFERENCE_TYPE_TAG;
-    itemId: string | null;
-    protocol: string | null;
-    host: string | null;
+export type EncodedReference = {
+    '/': string;
 };
-export declare const encodeReference: (reference: Reference) => EncodedReferenceObject;
+export declare const encodeReference: (reference: Reference) => EncodedReference;
 export declare const decodeReference: (value: any) => Reference;
-export declare const isEncodedReferenceObject: (value: any) => value is EncodedReferenceObject;
+export declare const isEncodedReference: (value: any) => value is EncodedReference;
 //# sourceMappingURL=reference.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,KAAK,SAAS,IAAI,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAGlG,qBAAa,SAAS;aAgBF,MAAM,EAAE,MAAM;aACd,QAAQ,CAAC;aACT,IAAI,CAAC;IAjBvB,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIlD;;OAEG;IAEH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;gBAOhC,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,oBAAQ,EACjB,IAAI,CAAC,oBAAQ;IAG/B,MAAM,IAAI,cAAc;CAGzB;AAED,eAAO,MAAM,kBAAkB,uCAAuC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,eAAe,cAAe,SAAS,KAAG,sBAMrD,CAAC;AAEH,eAAO,MAAM,eAAe,UAAW,GAAG,cACyC,CAAC;AAEpF,eAAO,MAAM,wBAAwB,UAAW,GAAG,oCACmC,CAAC"}
+{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAAmB,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,SAAS,IAAI,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAElG;;GAEG;AACH,qBAAa,SAAS;aAmCF,QAAQ,EAAE,QAAQ;aAClB,QAAQ,CAAC;aACT,IAAI,CAAC;IApCvB;;OAEG;IACH,MAAM,CAAC,aAAa,SAAc;IAElC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIlD;;OAEG;IAEH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAIlD,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS;gBAiBjB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,CAAC,oBAAQ,EACjB,IAAI,CAAC,oBAAQ;IAG/B,MAAM,IAAI,cAAc;IAIxB,KAAK,IAAI,GAAG;CAcb;AAED,eAAO,MAAM,kBAAkB,uCAAuC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,eAAe,cAAe,SAAS,KAAG,gBAErD,CAAC;AAEH,eAAO,MAAM,eAAe,UAAW,GAAG,cAA6C,CAAC;AAExF,eAAO,MAAM,kBAAkB,UAAW,GAAG,8BACqE,CAAC"}

package/dist/types/src/space-doc-version.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Denotes the data version of the space automerge document as well as the leaf documents for each individual ECHO object.
+ */
+export type SpaceDocVersion = number & {
+    __type: 'SpaceDocVersion';
+};
+export declare const SpaceDocVersion: Readonly<{
+    /**
+     * For the documents created before the versioning was introduced.
+     */
+    LEGACY: SpaceDocVersion;
+    /**
+     * Current version.
+     */
+    CURRENT: SpaceDocVersion;
+}>;
+//# sourceMappingURL=space-doc-version.d.ts.map

package/dist/types/src/space-doc-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"space-doc-version.d.ts","sourceRoot":"","sources":["../../../src/space-doc-version.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAErE,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAGH;;OAEG;;EAEH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-protocol",
-  "version": "0.5.9-main.bfee100",
+  "version": "0.5.9-main.c2c4258",
   "description": "Core ECHO APIs.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -22,7 +22,8 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/protocols": "0.5.9-main.bfee100"
+    "@dxos/keys": "0.5.9-main.c2c4258",
+    "@dxos/protocols": "0.5.9-main.c2c4258"
   },
   "publishConfig": {
     "access": "public"

package/src/document-structure.ts

@@ -2,7 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type EncodedReferenceObject } from './reference';
+import { type EncodedReference } from './reference';
+import type { SpaceDocVersion } from './space-doc-version';
 
 export type SpaceState = {
   // Url of the root automerge document.
@@ -11,6 +12,8 @@ export type SpaceState = {
 
 // TODO(dmaretskyi): Rename DatabaseRootDoc.
 export interface SpaceDoc {
+  version?: SpaceDocVersion;
+
   access?: {
     spaceKey: string;
   };
@@ -71,7 +74,7 @@ export type ObjectSystem = {
   /**
    * Object reference ('protobuf' protocol) type.
    */
-  type?: EncodedReferenceObject;
+  type?: EncodedReference;
 
   /**
    * Deletion marker.

package/src/index.ts

@@ -4,3 +4,5 @@
 
 export * from './document-structure';
 export * from './reference';
+export * from './space-doc-version';
+export * from './legacy';

package/src/legacy.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export const LEGACY_REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';
+
+/**
+ * Reference as it is stored in Automerge document.
+ */
+export type LegacyEncodedReferenceObject = {
+  '@type': typeof LEGACY_REFERENCE_TYPE_TAG;
+  itemId: string;
+  protocol?: string;
+  host?: string;
+};
+
+export const isLegacyReference = (value: any): boolean =>
+  typeof value === 'object' && value !== null && value['@type'] === LEGACY_REFERENCE_TYPE_TAG;
+
+export const LEGACY_TYPE_PROPERTIES = 'dxos.sdk.client.Properties';

package/src/reference.ts

@@ -2,13 +2,21 @@
 // Copyright 2022 DXOS.org
 //
 
-import { type ItemID } from '@dxos/protocols';
-import { type Reference as ReferenceValue } from '@dxos/protocols/proto/dxos/echo/model/document';
+import { DXN, LOCAL_SPACE_TAG } from '@dxos/keys';
+import { type ObjectId } from '@dxos/protocols';
+import { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';
 
-// TODO(burdon): Comment.
+/**
+ * Runtime representation of object reference.
+ */
 export class Reference {
-  static fromValue(value: ReferenceValue): Reference {
-    return new Reference(value.itemId, value.protocol, value.host);
+  /**
+   * Protocol references to runtime registered types.
+   */
+  static TYPE_PROTOCOL = 'protobuf';
+
+  static fromValue(value: ReferenceProto): Reference {
+    return new Reference(value.objectId, value.protocol, value.host);
   }
 
   /**
@@ -16,19 +24,48 @@ export class Reference {
    */
   // TODO(burdon): Document/remove?
   static fromLegacyTypename(type: string): Reference {
-    return new Reference(type, 'protobuf', 'dxos.org');
+    return new Reference(type, Reference.TYPE_PROTOCOL, 'dxos.org');
+  }
+
+  static fromDXN(dxn: DXN): Reference {
+    switch (dxn.kind) {
+      case DXN.kind.TYPE:
+        return Reference.fromLegacyTypename(dxn.parts[0]);
+      case DXN.kind.ECHO:
+        if (dxn.parts[0] === LOCAL_SPACE_TAG) {
+          return new Reference(dxn.parts[1]);
+        } else {
+          return new Reference(dxn.parts[1], undefined, dxn.parts[0]);
+        }
+      default:
+        throw new Error(`Unsupported DXN kind: ${dxn.kind}`);
+    }
   }
 
   // prettier-ignore
   constructor(
-    // TODO(burdon): Change to objectId (and typename).
-    public readonly itemId: ItemID,
+    public readonly objectId: ObjectId,
     public readonly protocol?: string,
     public readonly host?: string
   ) {}
 
-  encode(): ReferenceValue {
-    return { itemId: this.itemId, host: this.host, protocol: this.protocol };
+  encode(): ReferenceProto {
+    return { objectId: this.objectId, host: this.host, protocol: this.protocol };
+  }
+
+  toDXN(): DXN {
+    if (this.protocol === Reference.TYPE_PROTOCOL) {
+      return new DXN(DXN.kind.TYPE, [this.objectId]);
+    } else {
+      if (this.host) {
+        // Host is assumed to be the space key.
+        // The DXN should actually have the space ID.
+        // TODO(dmaretskyi): Migrate to space id.
+        return new DXN(DXN.kind.ECHO, [this.host, this.objectId]);
+      } else {
+        return new DXN(DXN.kind.ECHO, [LOCAL_SPACE_TAG, this.objectId]);
+      }
+    }
   }
 }
 
@@ -37,23 +74,15 @@ export const REFERENCE_TYPE_TAG = 'dxos.echo.model.document.Reference';
 /**
  * Reference as it is stored in Automerge document.
  */
-export type EncodedReferenceObject = {
-  '@type': typeof REFERENCE_TYPE_TAG;
-  itemId: string | null;
-  protocol: string | null;
-  host: string | null;
+export type EncodedReference = {
+  '/': string;
 };
 
-export const encodeReference = (reference: Reference): EncodedReferenceObject => ({
-  '@type': REFERENCE_TYPE_TAG,
-  // NOTE: Automerge do not support undefined values, so we need to use null instead.
-  itemId: reference.itemId ?? null,
-  protocol: reference.protocol ?? null,
-  host: reference.host ?? null,
+export const encodeReference = (reference: Reference): EncodedReference => ({
+  '/': reference.toDXN().toString(),
 });
 
-export const decodeReference = (value: any) =>
-  new Reference(value.itemId, value.protocol ?? undefined, value.host ?? undefined);
+export const decodeReference = (value: any) => Reference.fromDXN(DXN.parse(value['/']));
 
-export const isEncodedReferenceObject = (value: any): value is EncodedReferenceObject =>
-  typeof value === 'object' && value !== null && value['@type'] === REFERENCE_TYPE_TAG;
+export const isEncodedReference = (value: any): value is EncodedReference =>
+  typeof value === 'object' && value !== null && Object.keys(value).length === 1 && typeof value['/'] === 'string';

package/src/space-doc-version.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+/**
+ * Denotes the data version of the space automerge document as well as the leaf documents for each individual ECHO object.
+ */
+export type SpaceDocVersion = number & { __type: 'SpaceDocVersion' };
+
+export const SpaceDocVersion = Object.freeze({
+  /**
+   * For the documents created before the versioning was introduced.
+   */
+  LEGACY: 0 as SpaceDocVersion,
+
+  /**
+   * Current version.
+   */
+  CURRENT: 1 as SpaceDocVersion,
+});