@dxos/echo-protocol 0.5.1-main.1670c35

package/LICENSE

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

package/README.md

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

package/dist/lib/browser/index.mjs

@@ -0,0 +1,44 @@
+// packages/core/echo/echo-protocol/src/reference.ts
+var Reference = class _Reference {
+  static fromValue(value) {
+    return new _Reference(value.itemId, value.protocol, value.host);
+  }
+  /**
+  * @deprecated
+  */
+  // TODO(burdon): Document/remove?
+  static fromLegacyTypename(type) {
+    return new _Reference(type, "protobuf", "dxos.org");
+  }
+  // prettier-ignore
+  constructor(itemId, protocol, host) {
+    this.itemId = itemId;
+    this.protocol = protocol;
+    this.host = host;
+  }
+  encode() {
+    return {
+      itemId: this.itemId,
+      host: this.host,
+      protocol: this.protocol
+    };
+  }
+};
+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
+});
+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;
+export {
+  REFERENCE_TYPE_TAG,
+  Reference,
+  decodeReference,
+  encodeReference,
+  isEncodedReferenceObject
+};
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +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    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,YACkBL,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"]
+}

package/dist/lib/browser/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2324,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":5472,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":591,"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":2790},"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}}}

package/dist/lib/node/index.cjs

@@ -0,0 +1,71 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var node_exports = {};
+__export(node_exports, {
+  REFERENCE_TYPE_TAG: () => REFERENCE_TYPE_TAG,
+  Reference: () => Reference,
+  decodeReference: () => decodeReference,
+  encodeReference: () => encodeReference,
+  isEncodedReferenceObject: () => isEncodedReferenceObject
+});
+module.exports = __toCommonJS(node_exports);
+var Reference = class _Reference {
+  static fromValue(value) {
+    return new _Reference(value.itemId, value.protocol, value.host);
+  }
+  /**
+  * @deprecated
+  */
+  // TODO(burdon): Document/remove?
+  static fromLegacyTypename(type) {
+    return new _Reference(type, "protobuf", "dxos.org");
+  }
+  // prettier-ignore
+  constructor(itemId, protocol, host) {
+    this.itemId = itemId;
+    this.protocol = protocol;
+    this.host = host;
+  }
+  encode() {
+    return {
+      itemId: this.itemId,
+      host: this.host,
+      protocol: this.protocol
+    };
+  }
+};
+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
+});
+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;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  REFERENCE_TYPE_TAG,
+  Reference,
+  decodeReference,
+  encodeReference,
+  isEncodedReferenceObject
+});
+//# sourceMappingURL=index.cjs.map

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

@@ -0,0 +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    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,YACkBL,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"]
+}

package/dist/lib/node/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/core/echo/echo-protocol/src/document-structure.ts":{"bytes":2324,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/reference.ts":{"bytes":5472,"imports":[],"format":"esm"},"packages/core/echo/echo-protocol/src/index.ts":{"bytes":591,"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":2790},"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}}}

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

@@ -0,0 +1,67 @@
+import { type EncodedReferenceObject } from './reference';
+export type SpaceState = {
+    rootUrl?: string;
+};
+export interface SpaceDoc {
+    access?: {
+        spaceKey: string;
+    };
+    /**
+     * Objects inlined in the current document.
+     */
+    objects?: {
+        [key: string]: ObjectStructure;
+    };
+    /**
+     * Object id points to an automerge doc url where the object is embedded.
+     */
+    links?: {
+        [echoId: string]: string;
+    };
+}
+/**
+ * Representation of an ECHO object in an AM document.
+ */
+export type ObjectStructure = {
+    data: Record<string, any>;
+    meta: ObjectMeta;
+    system: ObjectSystem;
+};
+/**
+ * Echo object metadata.
+ */
+export type ObjectMeta = {
+    /**
+     * Foreign keys.
+     */
+    keys: ForeignKey[];
+};
+/**
+ * Reference to an object in a foreign database.
+ */
+export type ForeignKey = {
+    /**
+     * Name of the foreign database/system.
+     * E.g. `github.com`.
+     */
+    source?: string;
+    /**
+     * Id within the foreign database.
+     */
+    id?: string;
+};
+/**
+ * Automerge object system properties.
+ * (Is automerge specific.)
+ */
+export type ObjectSystem = {
+    /**
+     * Deletion marker.
+     */
+    deleted?: boolean;
+    /**
+     * Object reference ('protobuf' protocol) type.
+     */
+    type?: EncodedReferenceObject;
+};
+//# sourceMappingURL=document-structure.d.ts.map

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

@@ -0,0 +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;AAEF,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;KAChC,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,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACtB,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,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;CAC/B,CAAC"}

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

@@ -0,0 +1,3 @@
+export * from './document-structure';
+export * from './reference';
+//# sourceMappingURL=index.d.ts.map

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

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

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

@@ -0,0 +1,28 @@
+import { type ItemID } from '@dxos/protocols';
+import { type Reference as ReferenceValue } from '@dxos/protocols/proto/dxos/echo/model/document';
+export declare class Reference {
+    readonly itemId: ItemID;
+    readonly protocol?: string | undefined;
+    readonly host?: string | undefined;
+    static fromValue(value: ReferenceValue): Reference;
+    /**
+     * @deprecated
+     */
+    static fromLegacyTypename(type: string): Reference;
+    constructor(itemId: ItemID, protocol?: string | undefined, host?: string | undefined);
+    encode(): ReferenceValue;
+}
+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 declare const encodeReference: (reference: Reference) => EncodedReferenceObject;
+export declare const decodeReference: (value: any) => Reference;
+export declare const isEncodedReferenceObject: (value: any) => value is EncodedReferenceObject;
+//# sourceMappingURL=reference.d.ts.map

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

@@ -0,0 +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;aAeF,MAAM,EAAE,MAAM;aACd,QAAQ,CAAC;aACT,IAAI,CAAC;IAhBvB,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIlD;;OAEG;IAEH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;gBAMhC,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"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@dxos/echo-protocol",
+  "version": "0.5.1-main.1670c35",
+  "description": "Core ECHO APIs.",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": "github:dxos/dxos",
+  "license": "MIT",
+  "author": "DXOS.org",
+  "exports": {
+    ".": {
+      "browser": "./dist/lib/browser/index.mjs",
+      "import": "./dist/lib/browser/index.mjs",
+      "require": "./dist/lib/node/index.cjs",
+      "node": "./dist/lib/node/index.cjs"
+    }
+  },
+  "main": "dist/lib/node/index.cjs",
+  "types": "dist/types/src/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@dxos/protocols": "0.5.1-main.1670c35"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/document-structure.ts

@@ -0,0 +1,79 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type EncodedReferenceObject } from './reference';
+
+export type SpaceState = {
+  // Url of the root automerge document.
+  rootUrl?: string;
+};
+
+export interface SpaceDoc {
+  access?: {
+    spaceKey: string;
+  };
+  /**
+   * Objects inlined in the current document.
+   */
+  objects?: {
+    [key: string]: ObjectStructure;
+  };
+  /**
+   * Object id points to an automerge doc url where the object is embedded.
+   */
+  links?: {
+    [echoId: string]: string;
+  };
+}
+
+/**
+ * Representation of an ECHO object in an AM document.
+ */
+export type ObjectStructure = {
+  data: Record<string, any>;
+  meta: ObjectMeta;
+  system: ObjectSystem;
+};
+
+/**
+ * Echo object metadata.
+ */
+export type ObjectMeta = {
+  /**
+   * Foreign keys.
+   */
+  keys: ForeignKey[];
+};
+
+/**
+ * Reference to an object in a foreign database.
+ */
+export type ForeignKey = {
+  /**
+   * Name of the foreign database/system.
+   * E.g. `github.com`.
+   */
+  source?: string;
+
+  /**
+   * Id within the foreign database.
+   */
+  id?: string;
+};
+
+/**
+ * Automerge object system properties.
+ * (Is automerge specific.)
+ */
+export type ObjectSystem = {
+  /**
+   * Deletion marker.
+   */
+  deleted?: boolean;
+
+  /**
+   * Object reference ('protobuf' protocol) type.
+   */
+  type?: EncodedReferenceObject;
+};

package/src/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './document-structure';
+export * from './reference';

package/src/reference.ts

@@ -0,0 +1,58 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { type ItemID } from '@dxos/protocols';
+import { type Reference as ReferenceValue } from '@dxos/protocols/proto/dxos/echo/model/document';
+
+// TODO(burdon): Comment.
+export class Reference {
+  static fromValue(value: ReferenceValue): Reference {
+    return new Reference(value.itemId, value.protocol, value.host);
+  }
+
+  /**
+   * @deprecated
+   */
+  // TODO(burdon): Document/remove?
+  static fromLegacyTypename(type: string): Reference {
+    return new Reference(type, 'protobuf', 'dxos.org');
+  }
+
+  // prettier-ignore
+  constructor(
+    public readonly itemId: ItemID,
+    public readonly protocol?: string,
+    public readonly host?: string
+  ) {}
+
+  encode(): ReferenceValue {
+    return { itemId: this.itemId, host: this.host, protocol: this.protocol };
+  }
+}
+
+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 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 decodeReference = (value: any) =>
+  new Reference(value.itemId, value.protocol ?? undefined, value.host ?? undefined);
+
+export const isEncodedReferenceObject = (value: any): value is EncodedReferenceObject =>
+  typeof value === 'object' && value !== null && value['@type'] === REFERENCE_TYPE_TAG;