@dxos/echo-protocol 0.8.4-staging.ac66bdf99f → 0.9.0

package/LICENSE

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

package/README.md

@@ -18,4 +18,4 @@ pnpm i @dxos/echo-protocol
 
 Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
 
-License: [MIT](./LICENSE) Copyright 2022 © DXOS
+License: [FSL-1.1-Apache-2.0](./LICENSE) Copyright 2022 © DXOS

package/dist/lib/neutral/index.mjs

@@ -10,148 +10,24 @@ import { visitValues } from "@dxos/util";
 
 // src/reference.ts
 import { assertArgument } from "@dxos/invariant";
-import { DXN, LOCAL_SPACE_TAG } from "@dxos/keys";
-var Reference = class _Reference {
-  _objectId;
-  _protocol;
-  _host;
-  _dxn;
-  /**
-  * Protocol references to runtime registered types.
-  * @deprecated
-  */
-  static TYPE_PROTOCOL = "protobuf";
-  static fromDXN(dxn) {
-    switch (dxn.kind) {
-      case DXN.kind.TYPE:
-        return new _Reference(dxn.parts[0], _Reference.TYPE_PROTOCOL, "dxos.org", dxn);
-      case DXN.kind.ECHO:
-        if (dxn.parts[0] === LOCAL_SPACE_TAG) {
-          return new _Reference(dxn.parts[1], void 0, void 0, dxn);
-        } else {
-          return new _Reference(dxn.parts[1], void 0, dxn.parts[0], dxn);
-        }
-      default:
-        return new _Reference(dxn.parts[0], void 0, dxn.parts[0], dxn);
-    }
-  }
-  static fromValue(value2) {
-    return new _Reference(value2.objectId, value2.protocol, value2.host);
-  }
-  /**
-  * Reference an object in the local space.
-  */
-  static localObjectReference(objectId) {
-    return new _Reference(objectId);
-  }
-  /**
-  * @deprecated
-  */
-  // TODO(dmaretskyi): Remove.
-  static fromLegacyTypename(type) {
-    return new _Reference(type, _Reference.TYPE_PROTOCOL, "dxos.org");
-  }
-  /**
-  * @deprecated
-  */
-  // TODO(dmaretskyi): Remove
-  static fromObjectIdAndSpaceKey(objectId, spaceKey) {
-    return new _Reference(objectId, void 0, spaceKey.toHex());
-  }
-  // prettier-ignore
-  constructor(_objectId, _protocol, _host, _dxn) {
-    this._objectId = _objectId;
-    this._protocol = _protocol;
-    this._host = _host;
-    this._dxn = _dxn;
-  }
-  get dxn() {
-    return this._dxn;
-  }
-  /**
-  * @deprecated
-  */
-  // TODO(dmaretskyi): Remove.
-  get objectId() {
-    return this._objectId;
-  }
-  /**
-  * @deprecated
-  */
-  // TODO(dmaretskyi): Remove.
-  get protocol() {
-    return this._protocol;
-  }
-  /**
-  * @deprecated
-  */
-  // TODO(dmaretskyi): Remove.
-  get host() {
-    return this._host;
-  }
-  encode() {
-    return {
-      objectId: this.objectId,
-      host: this.host,
-      protocol: this.protocol
-    };
-  }
-  // TODO(dmaretskyi): Remove in favor of `reference.dxn`.
-  toDXN() {
-    if (this._dxn) {
-      return this._dxn;
-    }
-    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 = (value2) => {
-  if (typeof value2 !== "object" || value2 === null || typeof value2["/"] !== "string") {
-    throw new Error("Invalid reference");
-  }
-  const dxnString = value2["/"];
-  if (dxnString.length % 2 === 0 && dxnString.slice(0, dxnString.length / 2) === dxnString.slice(dxnString.length / 2) && dxnString.includes("dxn:echo")) {
-    throw new Error("Automerge bug detected!");
-  }
-  return Reference.fromDXN(DXN.parse(dxnString));
-};
 var isEncodedReference = (value2) => typeof value2 === "object" && value2 !== null && Object.keys(value2).length === 1 && typeof value2["/"] === "string";
 var EncodedReference = Object.freeze({
   isEncodedReference,
-  getReferenceString: (value2) => {
+  /**
+  * Returns the opaque URI stored in the encoded reference (any scheme: `echo:` or `dxn:`).
+  * Consumers can narrow with `EID.isEID(uri)` / `DXN.isDXN(uri)`.
+  */
+  toURI: (value2) => {
     assertArgument(isEncodedReference(value2), "value", "invalid reference");
     return value2["/"];
   },
-  toDXN: (value2) => {
-    return DXN.parse(EncodedReference.getReferenceString(value2));
-  },
-  fromDXN: (dxn) => {
-    return {
-      "/": dxn.toString()
-    };
-  },
-  fromLegacyTypename: (typename) => {
+  /**
+  * Creates an encoded reference from an opaque URI.
+  */
+  fromURI: (uri) => {
     return {
-      "/": DXN.fromTypename(typename).toString()
+      "/": uri
     };
   }
 });
@@ -168,15 +44,7 @@ var DatabaseDirectory = Object.freeze({
       return null;
     }
     const rawKey = String(rawSpaceKey);
-    invariant(!rawKey.startsWith("0x"), "Space key must not start with 0x", {
-      F: __dxlog_file,
-      L: 66,
-      S: void 0,
-      A: [
-        "!rawKey.startsWith('0x')",
-        "'Space key must not start with 0x'"
-      ]
-    });
+    invariant(!rawKey.startsWith("0x"), "Space key must not start with 0x", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 17, S: void 0, A: ["!rawKey.startsWith('0x')", "'Space key must not start with 0x'"] });
     return rawKey;
   },
   getInlineObject: (doc, id) => {
@@ -193,7 +61,7 @@ var DatabaseDirectory = Object.freeze({
     links: links ?? {}
   })
 });
-var ObjectStructure = Object.freeze({
+var EntityStructure = Object.freeze({
   /**
   * @throws On invalid object structure.
   */
@@ -205,15 +73,7 @@ var ObjectStructure = Object.freeze({
   */
   getEntityKind: (object) => {
     const kind = object.system?.kind ?? "object";
-    invariant(kind === "object" || kind === "relation", "Invalid kind", {
-      F: __dxlog_file,
-      L: 124,
-      S: void 0,
-      A: [
-        "kind === 'object' || kind === 'relation'",
-        "'Invalid kind'"
-      ]
-    });
+    invariant(kind === "object" || kind === "relation" || kind === "type", "Invalid kind", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 45, S: void 0, A: ["kind === 'object' || kind === 'relation' || kind === 'type'", "'Invalid kind'"] });
     return kind;
   },
   isDeleted: (object) => {
@@ -284,11 +144,34 @@ var ObjectStructure = Object.freeze({
       },
       data: data ?? {}
     };
+  },
+  makeType: ({ type, keys, data }) => {
+    return {
+      system: {
+        kind: "type",
+        type: {
+          "/": type
+        }
+      },
+      meta: {
+        keys: keys ?? []
+      },
+      data: data ?? {}
+    };
   }
 });
 var PROPERTY_ID = "id";
 var DATA_NAMESPACE = "data";
 
+// src/edge-peer.ts
+import { EdgeService } from "@dxos/protocols";
+import { compositeKey } from "@dxos/util";
+var isEdgePeerId = (peerId, spaceId) => {
+  const automergePrefix = spaceId !== void 0 ? compositeKey(EdgeService.AUTOMERGE_REPLICATOR, spaceId) : `${EdgeService.AUTOMERGE_REPLICATOR}:`;
+  const subductionPrefix = spaceId !== void 0 ? compositeKey(EdgeService.SUBDUCTION_REPLICATOR, spaceId) : `${EdgeService.SUBDUCTION_REPLICATOR}:`;
+  return peerId.startsWith(automergePrefix) || peerId.startsWith(subductionPrefix);
+};
+
 // src/echo-feed-codec.ts
 import { FeedProtocol } from "@dxos/protocols";
 var ATTR_META = "@meta";
@@ -366,6 +249,7 @@ var ForeignKey = ForeignKey_;
 // src/query/ast.ts
 var ast_exports = {};
 __export(ast_exports, {
+  FeedScope: () => FeedScope,
   Filter: () => Filter,
   FilterAnd: () => FilterAnd,
   FilterChildOf: () => FilterChildOf,
@@ -397,21 +281,21 @@ __export(ast_exports, {
   QuerySelectClause: () => QuerySelectClause,
   QuerySetDifferenceClause: () => QuerySetDifferenceClause,
   QueryUnionClause: () => QueryUnionClause,
+  RegistryScope: () => RegistryScope,
   Scope: () => Scope,
+  SpaceScope: () => SpaceScope,
   fold: () => fold,
   map: () => map,
   visit: () => visit
 });
 import * as Match from "effect/Match";
 import * as Schema2 from "effect/Schema";
-import { DXN as DXN2, ObjectId } from "@dxos/keys";
-var TypenameSpecifier = Schema2.Union(DXN2.Schema, Schema2.Null).annotations({
-  description: "DXN or null; null matches any type"
-});
+import { EID, EntityId, URI } from "@dxos/keys";
+var TypenameSpecifier = Schema2.Union(URI.Schema, Schema2.Null);
 var FilterObject_ = Schema2.Struct({
   type: Schema2.Literal("object"),
   typename: TypenameSpecifier,
-  id: Schema2.optional(Schema2.Array(ObjectId)),
+  id: Schema2.optional(Schema2.Array(EntityId)),
   /**
   * Filter by property.
   * Must not include object ID.
@@ -425,7 +309,16 @@ var FilterObject_ = Schema2.Struct({
   /**
   * Objects that have any of the given foreign keys.
   */
-  foreignKeys: Schema2.optional(Schema2.Array(ForeignKey))
+  foreignKeys: Schema2.optional(Schema2.Array(ForeignKey)),
+  /**
+  * Match objects whose meta `key` equals this fully-qualified registry key (FQN format).
+  */
+  metaKey: Schema2.optional(Schema2.String),
+  /**
+  * Semver range matched against the object's meta `version`.
+  * Only consulted when {@link metaKey} is set. Objects with no `version` do not satisfy a version-constrained filter.
+  */
+  metaVersion: Schema2.optional(Schema2.String)
 });
 var FilterObject = FilterObject_;
 var FilterCompare_ = Schema2.Struct({
@@ -486,7 +379,7 @@ var FilterOr = FilterOr_;
 var FilterChildOf_ = Schema2.Struct({
   type: Schema2.Literal("child-of"),
   /** Parent DXNs to match children of. */
-  parents: Schema2.Array(DXN2.Schema),
+  parents: Schema2.Array(EID.Schema),
   /** Whether to match transitively (grandchildren, etc.). Defaults to true. */
   transitive: Schema2.Boolean
 });
@@ -574,6 +467,11 @@ var Order_ = Schema2.Union(Schema2.Struct({
   // Default direction is 'desc' (higher rank = better match first).
   kind: Schema2.Literal("rank"),
   direction: OrderDirection
+}), Schema2.Struct({
+  // Order by system timestamp (createdAt / updatedAt) from the object meta index.
+  kind: Schema2.Literal("timestamp"),
+  field: Schema2.Literal("createdAt", "updatedAt"),
+  direction: OrderDirection
 }));
 var Order = Order_;
 var QueryOrderClause_ = Schema2.Struct({
@@ -598,7 +496,7 @@ var QueryFromClause_ = Schema2.Struct({
   type: Schema2.Literal("from"),
   query: Schema2.suspend(() => Query),
   from: Schema2.Union(Schema2.TaggedStruct("scope", {
-    scope: Schema2.suspend(() => Scope)
+    scopes: Schema2.Array(Schema2.suspend(() => Scope))
   }), Schema2.TaggedStruct("query", {
     query: Schema2.suspend(() => Query)
   }))
@@ -612,26 +510,23 @@ var QueryOptions = Schema2.Struct({
   /**
   * Nested select statements will use this option to filter deleted objects.
   */
-  deleted: Schema2.optional(Schema2.Literal("include", "exclude", "only"))
-});
-var Scope = Schema2.Struct({
+  deleted: Schema2.optional(Schema2.Literal("include", "exclude", "only")),
   /**
-  * The nested select statemets will select from the given spaces.
-  *
-  * NOTE: Spaces and queues are unioned together if both are specified.
+  * Diagnostics-only label for logs / tooling (not used by execution semantics).
   */
-  spaceIds: Schema2.optional(Schema2.Array(Schema2.String)),
-  /**
-  * If true, the nested select statements will select from all queues in the spaces specified by `spaceIds`.
-  */
-  allQueuesFromSpaces: Schema2.optional(Schema2.Boolean),
-  /**
-  * The nested select statemets will select from the given queues.
-  *
-  * NOTE: Spaces and queues are unioned together if both are specified.
-  */
-  queues: Schema2.optional(Schema2.Array(DXN2.Schema))
+  debugLabel: Schema2.optional(Schema2.String)
+});
+var SpaceScope = Schema2.TaggedStruct("space", {
+  spaceId: Schema2.optional(Schema2.String),
+  includeAllFeeds: Schema2.optional(Schema2.Boolean)
+});
+var FeedScope = Schema2.TaggedStruct("feed", {
+  feedUri: Schema2.String
+});
+var RegistryScope = Schema2.TaggedStruct("registry", {
+  location: Schema2.Literal("local", "remote")
 });
+var Scope = Schema2.Union(SpaceScope, FeedScope, RegistryScope);
 var visit = (query, visitor) => {
   visitor(query);
   Match.value(query).pipe(Match.when({
@@ -813,16 +708,14 @@ export {
   DatabaseDirectory,
   EchoFeedCodec,
   EncodedReference,
+  EntityStructure,
   ForeignKey,
-  ObjectStructure,
   PROPERTY_ID,
   ast_exports as QueryAST,
   REFERENCE_TYPE_TAG,
-  Reference,
   SpaceDocVersion,
   createIdFromSpaceKey,
-  decodeReference,
-  encodeReference,
+  isEdgePeerId,
   isEncodedReference
 };
 //# sourceMappingURL=index.mjs.map