@dxos/echo-protocol 0.6.12 → 0.6.13-main.548ca8d

package/dist/lib/browser/index.mjs

@@ -1,5 +1,24 @@
 // packages/core/echo/echo-protocol/src/reference.ts
-import { DXN, LOCAL_SPACE_TAG } from "@dxos/keys";
+import { DXN, LOCAL_SPACE_TAG, PublicKey as PublicKey2 } from "@dxos/keys";
+
+// packages/core/echo/echo-protocol/src/space-id.ts
+import { subtleCrypto } from "@dxos/crypto";
+import { PublicKey, SpaceId } from "@dxos/keys";
+import { ComplexMap } from "@dxos/util";
+var SPACE_IDS_CACHE = new ComplexMap(PublicKey.hash);
+var createIdFromSpaceKey = async (spaceKey) => {
+  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);
+  if (cachedValue !== void 0) {
+    return cachedValue;
+  }
+  const digest = await subtleCrypto.digest("SHA-256", spaceKey.asUint8Array());
+  const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);
+  const spaceId = SpaceId.encode(bytes);
+  SPACE_IDS_CACHE.set(spaceKey, spaceId);
+  return spaceId;
+};
+
+// packages/core/echo/echo-protocol/src/reference.ts
 var Reference = class _Reference {
   static {
     /**
@@ -70,6 +89,17 @@ var encodeReference = (reference) => ({
 });
 var decodeReference = (value) => Reference.fromDXN(DXN.parse(value["/"]));
 var isEncodedReference = (value) => typeof value === "object" && value !== null && Object.keys(value).length === 1 && typeof value["/"] === "string";
+var convertLegacyReference = async (reference) => {
+  if (reference.protocol === Reference.TYPE_PROTOCOL) {
+    return encodeReference(Reference.fromLegacyTypename(reference.itemId));
+  }
+  if (!reference.itemId) {
+    throw new Error("Invalid reference");
+  }
+  const spaceKey = reference.host;
+  const spaceId = spaceKey != null ? await createIdFromSpaceKey(PublicKey2.fromHex(spaceKey)) : void 0;
+  return encodeReference(new Reference(reference.itemId, reference.protocol ?? void 0, spaceId));
+};
 
 // packages/core/echo/echo-protocol/src/space-doc-version.ts
 var SpaceDocVersion = Object.freeze({
@@ -93,6 +123,8 @@ export {
   REFERENCE_TYPE_TAG,
   Reference,
   SpaceDocVersion,
+  convertLegacyReference,
+  createIdFromSpaceKey,
   decodeReference,
   encodeReference,
   isEncodedReference,

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "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"]
+  "sources": ["../../../src/reference.ts", "../../../src/space-id.ts", "../../../src/space-doc-version.ts", "../../../src/legacy.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { DXN, LOCAL_SPACE_TAG, PublicKey } from '@dxos/keys';\nimport { type ObjectId } from '@dxos/protocols';\nimport { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';\n\nimport type { LegacyEncodedReferenceObject } from './legacy';\nimport { createIdFromSpaceKey } from './space-id';\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\nexport const convertLegacyReference = async (reference: LegacyEncodedReferenceObject): Promise<EncodedReference> => {\n  if (reference.protocol === Reference.TYPE_PROTOCOL) {\n    return encodeReference(Reference.fromLegacyTypename(reference.itemId));\n  }\n  if (!reference.itemId) {\n    throw new Error('Invalid reference');\n  }\n\n  const spaceKey = reference.host;\n  const spaceId = spaceKey != null ? await createIdFromSpaceKey(PublicKey.fromHex(spaceKey)) : undefined;\n  return encodeReference(new Reference(reference.itemId, reference.protocol ?? undefined, spaceId));\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport { subtleCrypto } from '@dxos/crypto';\nimport { PublicKey, SpaceId } from '@dxos/keys';\nimport { ComplexMap } from '@dxos/util';\n\nconst SPACE_IDS_CACHE = new ComplexMap<PublicKey, SpaceId>(PublicKey.hash);\n\n/**\n * Space keys are generated by creating a keypair, and then taking the first 20 bytes of the SHA-256 hash of the public key and encoding them to multibase RFC4648 base-32 format (prefixed with B, see Multibase Table).\n * Inspired by how ethereum addresses are derived.\n */\nexport const createIdFromSpaceKey = async (spaceKey: PublicKey): Promise<SpaceId> => {\n  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);\n  if (cachedValue !== undefined) {\n    return cachedValue;\n  }\n\n  const digest = await subtleCrypto.digest('SHA-256', spaceKey.asUint8Array());\n\n  const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);\n  const spaceId = SpaceId.encode(bytes);\n  SPACE_IDS_CACHE.set(spaceKey, spaceId);\n  return spaceId;\n};\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,iBAAiBC,aAAAA,kBAAiB;;;ACAhD,SAASC,oBAAoB;AAC7B,SAASC,WAAWC,eAAe;AACnC,SAASC,kBAAkB;AAE3B,IAAMC,kBAAkB,IAAIC,WAA+BC,UAAUC,IAAI;AAMlE,IAAMC,uBAAuB,OAAOC,aAAAA;AACzC,QAAMC,cAAcN,gBAAgBO,IAAIF,QAAAA;AACxC,MAAIC,gBAAgBE,QAAW;AAC7B,WAAOF;EACT;AAEA,QAAMG,SAAS,MAAMC,aAAaD,OAAO,WAAWJ,SAASM,aAAY,CAAA;AAEzE,QAAMC,QAAQ,IAAIC,WAAWJ,MAAAA,EAAQK,MAAM,GAAGC,QAAQC,UAAU;AAChE,QAAMC,UAAUF,QAAQG,OAAON,KAAAA;AAC/BZ,kBAAgBmB,IAAId,UAAUY,OAAAA;AAC9B,SAAOA;AACT;;;ADZO,IAAMG,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;AAEnG,IAAM6B,yBAAyB,OAAOR,cAAAA;AAC3C,MAAIA,UAAUnB,aAAaL,UAAUC,eAAe;AAClD,WAAOsB,gBAAgBvB,UAAUO,mBAAmBiB,UAAUS,MAAM,CAAA;EACtE;AACA,MAAI,CAACT,UAAUS,QAAQ;AACrB,UAAM,IAAIf,MAAM,mBAAA;EAClB;AAEA,QAAMgB,WAAWV,UAAUlB;AAC3B,QAAM6B,UAAUD,YAAY,OAAO,MAAME,qBAAqBC,WAAUC,QAAQJ,QAAAA,CAAAA,IAAajB;AAC7F,SAAOM,gBAAgB,IAAIvB,UAAUwB,UAAUS,QAAQT,UAAUnB,YAAYY,QAAWkB,OAAAA,CAAAA;AAC1F;;;AE9FO,IAAMI,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", "PublicKey", "subtleCrypto", "PublicKey", "SpaceId", "ComplexMap", "SPACE_IDS_CACHE", "ComplexMap", "PublicKey", "hash", "createIdFromSpaceKey", "spaceKey", "cachedValue", "get", "undefined", "digest", "subtleCrypto", "asUint8Array", "bytes", "Uint8Array", "slice", "SpaceId", "byteLength", "spaceId", "encode", "set", "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", "convertLegacyReference", "itemId", "spaceKey", "spaceId", "createIdFromSpaceKey", "PublicKey", "fromHex", "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":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}}}
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2528,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/space-id.ts":{"bytes":3580,"imports":[{"path":"@dxos/crypto","kind":"import-statement","external":true},{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":11612,"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"packages/core/echo/echo-protocol/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"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/collection-sync.ts":{"bytes":550,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":1017,"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"},{"path":"packages/core/echo/echo-protocol/src/collection-sync.ts","kind":"import-statement","original":"./collection-sync"},{"path":"packages/core/echo/echo-protocol/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":8975},"packages/core/echo/echo-protocol/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/crypto","kind":"import-statement","external":true},{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"exports":["LEGACY_REFERENCE_TYPE_TAG","LEGACY_TYPE_PROPERTIES","REFERENCE_TYPE_TAG","Reference","SpaceDocVersion","convertLegacyReference","createIdFromSpaceKey","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":2495},"packages/core/echo/echo-protocol/src/space-id.ts":{"bytesInOutput":604},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytesInOutput":179},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytesInOutput":257}},"bytes":4094}}}

package/dist/lib/node/index.cjs

@@ -23,6 +23,8 @@ __export(node_exports, {
   REFERENCE_TYPE_TAG: () => REFERENCE_TYPE_TAG,
   Reference: () => Reference,
   SpaceDocVersion: () => SpaceDocVersion,
+  convertLegacyReference: () => convertLegacyReference,
+  createIdFromSpaceKey: () => createIdFromSpaceKey,
   decodeReference: () => decodeReference,
   encodeReference: () => encodeReference,
   isEncodedReference: () => isEncodedReference,
@@ -30,6 +32,21 @@ __export(node_exports, {
 });
 module.exports = __toCommonJS(node_exports);
 var import_keys = require("@dxos/keys");
+var import_crypto = require("@dxos/crypto");
+var import_keys2 = require("@dxos/keys");
+var import_util = require("@dxos/util");
+var SPACE_IDS_CACHE = new import_util.ComplexMap(import_keys2.PublicKey.hash);
+var createIdFromSpaceKey = async (spaceKey) => {
+  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);
+  if (cachedValue !== void 0) {
+    return cachedValue;
+  }
+  const digest = await import_crypto.subtleCrypto.digest("SHA-256", spaceKey.asUint8Array());
+  const bytes = new Uint8Array(digest).slice(0, import_keys2.SpaceId.byteLength);
+  const spaceId = import_keys2.SpaceId.encode(bytes);
+  SPACE_IDS_CACHE.set(spaceKey, spaceId);
+  return spaceId;
+};
 var Reference = class _Reference {
   static {
     this.TYPE_PROTOCOL = "protobuf";
@@ -97,6 +114,17 @@ var encodeReference = (reference) => ({
 });
 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 convertLegacyReference = async (reference) => {
+  if (reference.protocol === Reference.TYPE_PROTOCOL) {
+    return encodeReference(Reference.fromLegacyTypename(reference.itemId));
+  }
+  if (!reference.itemId) {
+    throw new Error("Invalid reference");
+  }
+  const spaceKey = reference.host;
+  const spaceId = spaceKey != null ? await createIdFromSpaceKey(import_keys.PublicKey.fromHex(spaceKey)) : void 0;
+  return encodeReference(new Reference(reference.itemId, reference.protocol ?? void 0, spaceId));
+};
 var SpaceDocVersion = Object.freeze({
   /**
   * For the documents created before the versioning was introduced.
@@ -117,6 +145,8 @@ var LEGACY_TYPE_PROPERTIES = "dxos.sdk.client.Properties";
   REFERENCE_TYPE_TAG,
   Reference,
   SpaceDocVersion,
+  convertLegacyReference,
+  createIdFromSpaceKey,
   decodeReference,
   encodeReference,
   isEncodedReference,

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "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"]
+  "sources": ["../../../src/reference.ts", "../../../src/space-id.ts", "../../../src/space-doc-version.ts", "../../../src/legacy.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { DXN, LOCAL_SPACE_TAG, PublicKey } from '@dxos/keys';\nimport { type ObjectId } from '@dxos/protocols';\nimport { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';\n\nimport type { LegacyEncodedReferenceObject } from './legacy';\nimport { createIdFromSpaceKey } from './space-id';\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\nexport const convertLegacyReference = async (reference: LegacyEncodedReferenceObject): Promise<EncodedReference> => {\n  if (reference.protocol === Reference.TYPE_PROTOCOL) {\n    return encodeReference(Reference.fromLegacyTypename(reference.itemId));\n  }\n  if (!reference.itemId) {\n    throw new Error('Invalid reference');\n  }\n\n  const spaceKey = reference.host;\n  const spaceId = spaceKey != null ? await createIdFromSpaceKey(PublicKey.fromHex(spaceKey)) : undefined;\n  return encodeReference(new Reference(reference.itemId, reference.protocol ?? undefined, spaceId));\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport { subtleCrypto } from '@dxos/crypto';\nimport { PublicKey, SpaceId } from '@dxos/keys';\nimport { ComplexMap } from '@dxos/util';\n\nconst SPACE_IDS_CACHE = new ComplexMap<PublicKey, SpaceId>(PublicKey.hash);\n\n/**\n * Space keys are generated by creating a keypair, and then taking the first 20 bytes of the SHA-256 hash of the public key and encoding them to multibase RFC4648 base-32 format (prefixed with B, see Multibase Table).\n * Inspired by how ethereum addresses are derived.\n */\nexport const createIdFromSpaceKey = async (spaceKey: PublicKey): Promise<SpaceId> => {\n  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);\n  if (cachedValue !== undefined) {\n    return cachedValue;\n  }\n\n  const digest = await subtleCrypto.digest('SHA-256', spaceKey.asUint8Array());\n\n  const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);\n  const spaceId = SpaceId.encode(bytes);\n  SPACE_IDS_CACHE.set(spaceKey, spaceId);\n  return spaceId;\n};\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,kBAAgD;ACAhD,oBAA6B;AAC7B,IAAAA,eAAmC;AACnC,kBAA2B;AAE3B,IAAMC,kBAAkB,IAAIC,uBAA+BC,uBAAUC,IAAI;AAMlE,IAAMC,uBAAuB,OAAOC,aAAAA;AACzC,QAAMC,cAAcN,gBAAgBO,IAAIF,QAAAA;AACxC,MAAIC,gBAAgBE,QAAW;AAC7B,WAAOF;EACT;AAEA,QAAMG,SAAS,MAAMC,2BAAaD,OAAO,WAAWJ,SAASM,aAAY,CAAA;AAEzE,QAAMC,QAAQ,IAAIC,WAAWJ,MAAAA,EAAQK,MAAM,GAAGC,qBAAQC,UAAU;AAChE,QAAMC,UAAUF,qBAAQG,OAAON,KAAAA;AAC/BZ,kBAAgBmB,IAAId,UAAUY,OAAAA;AAC9B,SAAOA;AACT;ADZO,IAAMG,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,GAAI1B,QAAWsB,IAAII,MAAM,CAAA,CAAE;QAC5D;MACF;AACE,cAAM,IAAIG,MAAM,yBAAyBP,IAAIC,IAAI,EAAE;IACvD;EACF;;EAGAO,YACkBd,UACAC,UACAC,MAChB;SAHgBF,WAAAA;SACAC,WAAAA;SACAC,OAAAA;EACf;EAEHR,SAAyB;AACvB,WAAO;MAAEM,UAAU,KAAKA;MAAUE,MAAM,KAAKA;MAAMD,UAAU,KAAKA;IAAS;EAC7E;EAEAc,QAAa;AACX,QAAI,KAAKd,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,IAAMgB,qBAAqB;AAS3B,IAAMC,kBAAkB,CAACC,eAA4C;EAC1E,KAAKA,UAAUH,MAAK,EAAGI,SAAQ;AACjC;AAEO,IAAMC,kBAAkB,CAACrB,UAAeH,UAAUS,QAAQG,gBAAIa,MAAMtB,MAAM,GAAA,CAAI,CAAA;AAE9E,IAAMuB,qBAAqB,CAACvB,UACjC,OAAOA,UAAU,YAAYA,UAAU,QAAQwB,OAAOC,KAAKzB,KAAAA,EAAO0B,WAAW,KAAK,OAAO1B,MAAM,GAAA,MAAS;AAEnG,IAAM2B,yBAAyB,OAAOR,cAAAA;AAC3C,MAAIA,UAAUjB,aAAaL,UAAUC,eAAe;AAClD,WAAOoB,gBAAgBrB,UAAUO,mBAAmBe,UAAUS,MAAM,CAAA;EACtE;AACA,MAAI,CAACT,UAAUS,QAAQ;AACrB,UAAM,IAAId,MAAM,mBAAA;EAClB;AAEA,QAAMhC,WAAWqC,UAAUhB;AAC3B,QAAMT,UAAUZ,YAAY,OAAO,MAAMD,qBAAqBF,YAAAA,UAAUkD,QAAQ/C,QAAAA,CAAAA,IAAaG;AAC7F,SAAOiC,gBAAgB,IAAIrB,UAAUsB,UAAUS,QAAQT,UAAUjB,YAAYjB,QAAWS,OAAAA,CAAAA;AAC1F;AE9FO,IAAMoC,kBAAkBN,OAAOO,OAAO;;;;EAI3CC,QAAQ;;;;EAKRC,SAAS;AACX,CAAA;ACfO,IAAMC,4BAA4B;AAYlC,IAAMC,oBAAoB,CAACnC,UAChC,OAAOA,UAAU,YAAYA,UAAU,QAAQA,MAAM,OAAA,MAAakC;AAE7D,IAAME,yBAAyB;",
+  "names": ["import_keys", "SPACE_IDS_CACHE", "ComplexMap", "PublicKey", "hash", "createIdFromSpaceKey", "spaceKey", "cachedValue", "get", "undefined", "digest", "subtleCrypto", "asUint8Array", "bytes", "Uint8Array", "slice", "SpaceId", "byteLength", "spaceId", "encode", "set", "Reference", "TYPE_PROTOCOL", "fromValue", "value", "objectId", "protocol", "host", "fromLegacyTypename", "type", "fromDXN", "dxn", "kind", "DXN", "TYPE", "parts", "ECHO", "LOCAL_SPACE_TAG", "Error", "constructor", "toDXN", "REFERENCE_TYPE_TAG", "encodeReference", "reference", "toString", "decodeReference", "parse", "isEncodedReference", "Object", "keys", "length", "convertLegacyReference", "itemId", "fromHex", "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":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}}}
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2528,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/space-id.ts":{"bytes":3580,"imports":[{"path":"@dxos/crypto","kind":"import-statement","external":true},{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":11612,"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"packages/core/echo/echo-protocol/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"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/collection-sync.ts":{"bytes":550,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":1017,"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"},{"path":"packages/core/echo/echo-protocol/src/collection-sync.ts","kind":"import-statement","original":"./collection-sync"},{"path":"packages/core/echo/echo-protocol/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":8975},"packages/core/echo/echo-protocol/dist/lib/node/index.cjs":{"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/crypto","kind":"import-statement","external":true},{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"exports":["LEGACY_REFERENCE_TYPE_TAG","LEGACY_TYPE_PROPERTIES","REFERENCE_TYPE_TAG","Reference","SpaceDocVersion","convertLegacyReference","createIdFromSpaceKey","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":2495},"packages/core/echo/echo-protocol/src/space-id.ts":{"bytesInOutput":604},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytesInOutput":179},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytesInOutput":257}},"bytes":4094}}}

package/dist/lib/node-esm/index.mjs

@@ -0,0 +1,135 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+
+// packages/core/echo/echo-protocol/src/reference.ts
+import { DXN, LOCAL_SPACE_TAG, PublicKey as PublicKey2 } from "@dxos/keys";
+
+// packages/core/echo/echo-protocol/src/space-id.ts
+import { subtleCrypto } from "@dxos/crypto";
+import { PublicKey, SpaceId } from "@dxos/keys";
+import { ComplexMap } from "@dxos/util";
+var SPACE_IDS_CACHE = new ComplexMap(PublicKey.hash);
+var createIdFromSpaceKey = async (spaceKey) => {
+  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);
+  if (cachedValue !== void 0) {
+    return cachedValue;
+  }
+  const digest = await subtleCrypto.digest("SHA-256", spaceKey.asUint8Array());
+  const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);
+  const spaceId = SpaceId.encode(bytes);
+  SPACE_IDS_CACHE.set(spaceKey, spaceId);
+  return spaceId;
+};
+
+// packages/core/echo/echo-protocol/src/reference.ts
+var Reference = class _Reference {
+  static {
+    /**
+    * Protocol references to runtime registered types.
+    */
+    this.TYPE_PROTOCOL = "protobuf";
+  }
+  static fromValue(value) {
+    return new _Reference(value.objectId, value.protocol, value.host);
+  }
+  /**
+  * @deprecated
+  */
+  // TODO(burdon): Document/remove?
+  static fromLegacyTypename(type) {
+    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(objectId, protocol, host) {
+    this.objectId = objectId;
+    this.protocol = protocol;
+    this.host = host;
+  }
+  encode() {
+    return {
+      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) => ({
+  "/": 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";
+var convertLegacyReference = async (reference) => {
+  if (reference.protocol === Reference.TYPE_PROTOCOL) {
+    return encodeReference(Reference.fromLegacyTypename(reference.itemId));
+  }
+  if (!reference.itemId) {
+    throw new Error("Invalid reference");
+  }
+  const spaceKey = reference.host;
+  const spaceId = spaceKey != null ? await createIdFromSpaceKey(PublicKey2.fromHex(spaceKey)) : void 0;
+  return encodeReference(new Reference(reference.itemId, reference.protocol ?? void 0, spaceId));
+};
+
+// 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
+});
+
+// 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,
+  convertLegacyReference,
+  createIdFromSpaceKey,
+  decodeReference,
+  encodeReference,
+  isEncodedReference,
+  isLegacyReference
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/node-esm/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/reference.ts", "../../../src/space-id.ts", "../../../src/space-doc-version.ts", "../../../src/legacy.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { DXN, LOCAL_SPACE_TAG, PublicKey } from '@dxos/keys';\nimport { type ObjectId } from '@dxos/protocols';\nimport { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';\n\nimport type { LegacyEncodedReferenceObject } from './legacy';\nimport { createIdFromSpaceKey } from './space-id';\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\nexport const convertLegacyReference = async (reference: LegacyEncodedReferenceObject): Promise<EncodedReference> => {\n  if (reference.protocol === Reference.TYPE_PROTOCOL) {\n    return encodeReference(Reference.fromLegacyTypename(reference.itemId));\n  }\n  if (!reference.itemId) {\n    throw new Error('Invalid reference');\n  }\n\n  const spaceKey = reference.host;\n  const spaceId = spaceKey != null ? await createIdFromSpaceKey(PublicKey.fromHex(spaceKey)) : undefined;\n  return encodeReference(new Reference(reference.itemId, reference.protocol ?? undefined, spaceId));\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport { subtleCrypto } from '@dxos/crypto';\nimport { PublicKey, SpaceId } from '@dxos/keys';\nimport { ComplexMap } from '@dxos/util';\n\nconst SPACE_IDS_CACHE = new ComplexMap<PublicKey, SpaceId>(PublicKey.hash);\n\n/**\n * Space keys are generated by creating a keypair, and then taking the first 20 bytes of the SHA-256 hash of the public key and encoding them to multibase RFC4648 base-32 format (prefixed with B, see Multibase Table).\n * Inspired by how ethereum addresses are derived.\n */\nexport const createIdFromSpaceKey = async (spaceKey: PublicKey): Promise<SpaceId> => {\n  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);\n  if (cachedValue !== undefined) {\n    return cachedValue;\n  }\n\n  const digest = await subtleCrypto.digest('SHA-256', spaceKey.asUint8Array());\n\n  const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);\n  const spaceId = SpaceId.encode(bytes);\n  SPACE_IDS_CACHE.set(spaceKey, spaceId);\n  return spaceId;\n};\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,iBAAiBC,aAAAA,kBAAiB;;;ACAhD,SAASC,oBAAoB;AAC7B,SAASC,WAAWC,eAAe;AACnC,SAASC,kBAAkB;AAE3B,IAAMC,kBAAkB,IAAIC,WAA+BC,UAAUC,IAAI;AAMlE,IAAMC,uBAAuB,OAAOC,aAAAA;AACzC,QAAMC,cAAcN,gBAAgBO,IAAIF,QAAAA;AACxC,MAAIC,gBAAgBE,QAAW;AAC7B,WAAOF;EACT;AAEA,QAAMG,SAAS,MAAMC,aAAaD,OAAO,WAAWJ,SAASM,aAAY,CAAA;AAEzE,QAAMC,QAAQ,IAAIC,WAAWJ,MAAAA,EAAQK,MAAM,GAAGC,QAAQC,UAAU;AAChE,QAAMC,UAAUF,QAAQG,OAAON,KAAAA;AAC/BZ,kBAAgBmB,IAAId,UAAUY,OAAAA;AAC9B,SAAOA;AACT;;;ADZO,IAAMG,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;AAEnG,IAAM6B,yBAAyB,OAAOR,cAAAA;AAC3C,MAAIA,UAAUnB,aAAaL,UAAUC,eAAe;AAClD,WAAOsB,gBAAgBvB,UAAUO,mBAAmBiB,UAAUS,MAAM,CAAA;EACtE;AACA,MAAI,CAACT,UAAUS,QAAQ;AACrB,UAAM,IAAIf,MAAM,mBAAA;EAClB;AAEA,QAAMgB,WAAWV,UAAUlB;AAC3B,QAAM6B,UAAUD,YAAY,OAAO,MAAME,qBAAqBC,WAAUC,QAAQJ,QAAAA,CAAAA,IAAajB;AAC7F,SAAOM,gBAAgB,IAAIvB,UAAUwB,UAAUS,QAAQT,UAAUnB,YAAYY,QAAWkB,OAAAA,CAAAA;AAC1F;;;AE9FO,IAAMI,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", "PublicKey", "subtleCrypto", "PublicKey", "SpaceId", "ComplexMap", "SPACE_IDS_CACHE", "ComplexMap", "PublicKey", "hash", "createIdFromSpaceKey", "spaceKey", "cachedValue", "get", "undefined", "digest", "subtleCrypto", "asUint8Array", "bytes", "Uint8Array", "slice", "SpaceId", "byteLength", "spaceId", "encode", "set", "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", "convertLegacyReference", "itemId", "spaceKey", "spaceId", "createIdFromSpaceKey", "PublicKey", "fromHex", "SpaceDocVersion", "Object", "freeze", "LEGACY", "CURRENT", "LEGACY_REFERENCE_TYPE_TAG", "isLegacyReference", "value", "LEGACY_TYPE_PROPERTIES"]
+}

package/dist/lib/node-esm/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2528,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/space-id.ts":{"bytes":3580,"imports":[{"path":"@dxos/crypto","kind":"import-statement","external":true},{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":11612,"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"packages/core/echo/echo-protocol/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"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/collection-sync.ts":{"bytes":550,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":1017,"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"},{"path":"packages/core/echo/echo-protocol/src/collection-sync.ts","kind":"import-statement","original":"./collection-sync"},{"path":"packages/core/echo/echo-protocol/src/space-id.ts","kind":"import-statement","original":"./space-id"}],"format":"esm"}},"outputs":{"packages/core/echo/echo-protocol/dist/lib/node-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":8977},"packages/core/echo/echo-protocol/dist/lib/node-esm/index.mjs":{"imports":[{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/crypto","kind":"import-statement","external":true},{"path":"@dxos/keys","kind":"import-statement","external":true},{"path":"@dxos/util","kind":"import-statement","external":true}],"exports":["LEGACY_REFERENCE_TYPE_TAG","LEGACY_TYPE_PROPERTIES","REFERENCE_TYPE_TAG","Reference","SpaceDocVersion","convertLegacyReference","createIdFromSpaceKey","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":2495},"packages/core/echo/echo-protocol/src/space-id.ts":{"bytesInOutput":604},"packages/core/echo/echo-protocol/src/space-doc-version.ts":{"bytesInOutput":179},"packages/core/echo/echo-protocol/src/legacy.ts":{"bytesInOutput":257}},"bytes":4187}}}

package/dist/types/src/collection-sync.d.ts

@@ -0,0 +1,4 @@
+export type CollectionId = string & {
+    __CollectionId: true;
+};
+//# sourceMappingURL=collection-sync.d.ts.map

package/dist/types/src/collection-sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-sync.d.ts","sourceRoot":"","sources":["../../../src/collection-sync.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,cAAc,EAAE,IAAI,CAAA;CAAE,CAAC"}

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

@@ -2,4 +2,6 @@ export * from './document-structure';
 export * from './reference';
 export * from './space-doc-version';
 export * from './legacy';
+export * from './collection-sync';
+export * from './space-id';
 //# 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;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,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;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

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

@@ -1,6 +1,7 @@
 import { DXN } from '@dxos/keys';
 import { type ObjectId } from '@dxos/protocols';
 import { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';
+import type { LegacyEncodedReferenceObject } from './legacy';
 /**
  * Runtime representation of object reference.
  */
@@ -32,4 +33,5 @@ export type EncodedReference = {
 export declare const encodeReference: (reference: Reference) => EncodedReference;
 export declare const decodeReference: (value: any) => Reference;
 export declare const isEncodedReference: (value: any) => value is EncodedReference;
+export declare const convertLegacyReference: (reference: LegacyEncodedReferenceObject) => Promise<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,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,EAAE,MAAM;aACjB,IAAI,CAAC,EAAE,MAAM;IApC/B;;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,EAAE,MAAM,YAAA,EACjB,IAAI,CAAC,EAAE,MAAM,YAAA;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,KAAG,KAAK,IAAI,gBACyD,CAAC"}
+{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAA8B,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,SAAS,IAAI,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAElG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAG7D;;GAEG;AACH,qBAAa,SAAS;aAmCF,QAAQ,EAAE,QAAQ;aAClB,QAAQ,CAAC,EAAE,MAAM;aACjB,IAAI,CAAC,EAAE,MAAM;IApC/B;;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,EAAE,MAAM,YAAA,EACjB,IAAI,CAAC,EAAE,MAAM,YAAA;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,KAAG,KAAK,IAAI,gBACyD,CAAC;AAEnH,eAAO,MAAM,sBAAsB,cAAqB,4BAA4B,KAAG,OAAO,CAAC,gBAAgB,CAW9G,CAAC"}

package/dist/types/src/space-id.d.ts

@@ -0,0 +1,7 @@
+import { PublicKey, SpaceId } from '@dxos/keys';
+/**
+ * Space keys are generated by creating a keypair, and then taking the first 20 bytes of the SHA-256 hash of the public key and encoding them to multibase RFC4648 base-32 format (prefixed with B, see Multibase Table).
+ * Inspired by how ethereum addresses are derived.
+ */
+export declare const createIdFromSpaceKey: (spaceKey: PublicKey) => Promise<SpaceId>;
+//# sourceMappingURL=space-id.d.ts.map

package/dist/types/src/space-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"space-id.d.ts","sourceRoot":"","sources":["../../../src/space-id.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKhD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,aAAoB,SAAS,KAAG,OAAO,CAAC,OAAO,CAY/E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-protocol",
-  "version": "0.6.12",
+  "version": "0.6.13-main.548ca8d",
   "description": "Core ECHO APIs.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -11,7 +11,8 @@
     ".": {
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
-        "default": "./dist/lib/node/index.cjs"
+        "require": "./dist/lib/node/index.cjs",
+        "default": "./dist/lib/node-esm/index.mjs"
       },
       "types": "./dist/types/src/index.d.ts"
     }
@@ -25,8 +26,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/keys": "0.6.12",
-    "@dxos/protocols": "0.6.12"
+    "@dxos/crypto": "0.6.13-main.548ca8d",
+    "@dxos/keys": "0.6.13-main.548ca8d",
+    "@dxos/util": "0.6.13-main.548ca8d",
+    "@dxos/protocols": "0.6.13-main.548ca8d"
   },
   "publishConfig": {
     "access": "public"

package/src/collection-sync.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export type CollectionId = string & { __CollectionId: true };

package/src/index.ts

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

package/src/reference.ts

@@ -2,10 +2,13 @@
 // Copyright 2022 DXOS.org
 //
 
-import { DXN, LOCAL_SPACE_TAG } from '@dxos/keys';
+import { DXN, LOCAL_SPACE_TAG, PublicKey } from '@dxos/keys';
 import { type ObjectId } from '@dxos/protocols';
 import { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';
 
+import type { LegacyEncodedReferenceObject } from './legacy';
+import { createIdFromSpaceKey } from './space-id';
+
 /**
  * Runtime representation of object reference.
  */
@@ -86,3 +89,16 @@ export const decodeReference = (value: any) => Reference.fromDXN(DXN.parse(value
 
 export const isEncodedReference = (value: any): value is EncodedReference =>
   typeof value === 'object' && value !== null && Object.keys(value).length === 1 && typeof value['/'] === 'string';
+
+export const convertLegacyReference = async (reference: LegacyEncodedReferenceObject): Promise<EncodedReference> => {
+  if (reference.protocol === Reference.TYPE_PROTOCOL) {
+    return encodeReference(Reference.fromLegacyTypename(reference.itemId));
+  }
+  if (!reference.itemId) {
+    throw new Error('Invalid reference');
+  }
+
+  const spaceKey = reference.host;
+  const spaceId = spaceKey != null ? await createIdFromSpaceKey(PublicKey.fromHex(spaceKey)) : undefined;
+  return encodeReference(new Reference(reference.itemId, reference.protocol ?? undefined, spaceId));
+};

package/src/space-id.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { subtleCrypto } from '@dxos/crypto';
+import { PublicKey, SpaceId } from '@dxos/keys';
+import { ComplexMap } from '@dxos/util';
+
+const SPACE_IDS_CACHE = new ComplexMap<PublicKey, SpaceId>(PublicKey.hash);
+
+/**
+ * Space keys are generated by creating a keypair, and then taking the first 20 bytes of the SHA-256 hash of the public key and encoding them to multibase RFC4648 base-32 format (prefixed with B, see Multibase Table).
+ * Inspired by how ethereum addresses are derived.
+ */
+export const createIdFromSpaceKey = async (spaceKey: PublicKey): Promise<SpaceId> => {
+  const cachedValue = SPACE_IDS_CACHE.get(spaceKey);
+  if (cachedValue !== undefined) {
+    return cachedValue;
+  }
+
+  const digest = await subtleCrypto.digest('SHA-256', spaceKey.asUint8Array());
+
+  const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);
+  const spaceId = SpaceId.encode(bytes);
+  SPACE_IDS_CACHE.set(spaceKey, spaceId);
+  return spaceId;
+};