@dxos/echo-protocol 0.6.11-staging.e6894a4 → 0.6.12-main.5cc132e

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

@@ -0,0 +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.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";
+
+// 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,
+  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-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/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/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-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5988},"packages/core/echo/echo-protocol/dist/lib/node-esm/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-protocol",
-  "version": "0.6.11-staging.e6894a4",
+  "version": "0.6.12-main.5cc132e",
   "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,8 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/keys": "0.6.11-staging.e6894a4",
-    "@dxos/protocols": "0.6.11-staging.e6894a4"
+    "@dxos/keys": "0.6.12-main.5cc132e",
+    "@dxos/protocols": "0.6.12-main.5cc132e"
   },
   "publishConfig": {
     "access": "public"