@dxos/echo-protocol 0.8.4-main.ef1bc66f44 → 0.8.4-main.f466a3d56e

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

@@ -168,15 +168,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) => {
@@ -205,15 +197,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", "Invalid kind", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 45, S: void 0, A: ["kind === 'object' || kind === 'relation'", "'Invalid kind'"] });
     return kind;
   },
   isDeleted: (object) => {
@@ -289,33 +273,67 @@ var ObjectStructure = Object.freeze({
 var PROPERTY_ID = "id";
 var DATA_NAMESPACE = "data";
 
-// src/space-doc-version.ts
-var SpaceDocVersion = Object.freeze({
+// 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";
+var EchoFeedCodec = class _EchoFeedCodec {
+  static #encoder = new TextEncoder();
+  static #decoder = new TextDecoder();
   /**
-  * For the documents created before the versioning was introduced.
+  * Prepares a value for feed storage (strips queue position from metadata) and encodes to bytes.
   */
-  LEGACY: 0,
+  static encode(value2) {
+    const prepared = _EchoFeedCodec.#stripQueuePosition(value2);
+    return _EchoFeedCodec.#encoder.encode(JSON.stringify(prepared));
+  }
   /**
-  * Current version.
+  * Decodes feed block bytes to a JSON value.
+  * If position is provided, injects queue position into the decoded object's metadata.
   */
-  CURRENT: 1
-});
-
-// 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;
+  static decode(data, position) {
+    const decoded = JSON.parse(_EchoFeedCodec.#decoder.decode(data));
+    if (position !== void 0 && typeof decoded === "object" && decoded !== null) {
+      _EchoFeedCodec.#setQueuePosition(decoded, position);
+    }
+    return decoded;
+  }
+  static #stripQueuePosition(value2) {
+    if (typeof value2 !== "object" || value2 === null) {
+      return value2;
+    }
+    const obj = structuredClone(value2);
+    const meta = obj[ATTR_META];
+    if (meta?.keys?.some((key) => key.source === FeedProtocol.KEY_QUEUE_POSITION)) {
+      meta.keys = meta.keys.filter((key) => key.source !== FeedProtocol.KEY_QUEUE_POSITION);
+    }
+    return obj;
+  }
+  static #setQueuePosition(obj, position) {
+    obj[ATTR_META] ??= {
+      keys: []
+    };
+    obj[ATTR_META].keys ??= [];
+    const keys = obj[ATTR_META].keys;
+    for (let i = 0; i < keys.length; i++) {
+      if (keys[i].source === FeedProtocol.KEY_QUEUE_POSITION) {
+        keys.splice(i, 1);
+        i--;
+      }
+    }
+    keys.push({
+      source: FeedProtocol.KEY_QUEUE_POSITION,
+      id: position.toString()
+    });
   }
-  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;
 };
 
 // src/foreign-key.ts
@@ -343,6 +361,7 @@ var ast_exports = {};
 __export(ast_exports, {
   Filter: () => Filter,
   FilterAnd: () => FilterAnd,
+  FilterChildOf: () => FilterChildOf,
   FilterCompare: () => FilterCompare,
   FilterContains: () => FilterContains,
   FilterIn: () => FilterIn,
@@ -352,10 +371,13 @@ __export(ast_exports, {
   FilterRange: () => FilterRange,
   FilterTag: () => FilterTag,
   FilterTextSearch: () => FilterTextSearch,
+  FilterTimestamp: () => FilterTimestamp,
   Order: () => Order,
   OrderDirection: () => OrderDirection,
   Query: () => Query,
   QueryFilterClause: () => QueryFilterClause,
+  QueryFromClause: () => QueryFromClause,
+  QueryFromClause_: () => QueryFromClause_,
   QueryHierarchyTraversalClause: () => QueryHierarchyTraversalClause,
   QueryIncomingReferencesClause: () => QueryIncomingReferencesClause,
   QueryLimitClause: () => QueryLimitClause,
@@ -368,7 +390,9 @@ __export(ast_exports, {
   QuerySelectClause: () => QuerySelectClause,
   QuerySetDifferenceClause: () => QuerySetDifferenceClause,
   QueryUnionClause: () => QueryUnionClause,
+  Scope: () => Scope,
   fold: () => fold,
+  map: () => map,
   visit: () => visit
 });
 import * as Match from "effect/Match";
@@ -394,7 +418,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({
@@ -424,6 +457,13 @@ var FilterRange_ = Schema2.Struct({
   to: Schema2.Any
 });
 var FilterRange = FilterRange_;
+var FilterTimestamp_ = Schema2.Struct({
+  type: Schema2.Literal("timestamp"),
+  field: Schema2.Literal("createdAt", "updatedAt"),
+  operator: Schema2.Literal("gt", "gte", "lt", "lte"),
+  value: Schema2.Number
+});
+var FilterTimestamp = FilterTimestamp_;
 var FilterTextSearch_ = Schema2.Struct({
   type: Schema2.Literal("text-search"),
   text: Schema2.String,
@@ -445,8 +485,16 @@ var FilterOr_ = Schema2.Struct({
   filters: Schema2.Array(Schema2.suspend(() => Filter))
 });
 var FilterOr = FilterOr_;
-var Filter = Schema2.Union(FilterObject, FilterCompare, FilterIn, FilterContains, FilterTag, FilterRange, FilterTextSearch, FilterNot, FilterAnd, FilterOr).annotations({
-  identifier: "dxos.org/schema/Filter"
+var FilterChildOf_ = Schema2.Struct({
+  type: Schema2.Literal("child-of"),
+  /** Parent DXNs to match children of. */
+  parents: Schema2.Array(DXN2.Schema),
+  /** Whether to match transitively (grandchildren, etc.). Defaults to true. */
+  transitive: Schema2.Boolean
+});
+var FilterChildOf = FilterChildOf_;
+var Filter = Schema2.Union(FilterObject, FilterCompare, FilterIn, FilterContains, FilterTag, FilterRange, FilterTimestamp, FilterTextSearch, FilterChildOf, FilterNot, FilterAnd, FilterOr).annotations({
+  identifier: "org.dxos.schema.filter"
 });
 var QuerySelectClause_ = Schema2.Struct({
   type: Schema2.Literal("select"),
@@ -548,31 +596,47 @@ var QueryLimitClause_ = Schema2.Struct({
   limit: Schema2.Number
 });
 var QueryLimitClause = QueryLimitClause_;
-var Query_ = Schema2.Union(QuerySelectClause, QueryFilterClause, QueryReferenceTraversalClause, QueryIncomingReferencesClause, QueryRelationClause, QueryRelationTraversalClause, QueryHierarchyTraversalClause, QueryUnionClause, QuerySetDifferenceClause, QueryOrderClause, QueryOptionsClause, QueryLimitClause).annotations({
-  identifier: "dxos.org/schema/Query"
+var QueryFromClause_ = Schema2.Struct({
+  type: Schema2.Literal("from"),
+  query: Schema2.suspend(() => Query),
+  from: Schema2.Union(Schema2.TaggedStruct("scope", {
+    scope: Schema2.suspend(() => Scope)
+  }), Schema2.TaggedStruct("query", {
+    query: Schema2.suspend(() => Query)
+  }))
+});
+var QueryFromClause = QueryFromClause_;
+var Query_ = Schema2.Union(QuerySelectClause, QueryFilterClause, QueryReferenceTraversalClause, QueryIncomingReferencesClause, QueryRelationClause, QueryRelationTraversalClause, QueryHierarchyTraversalClause, QueryUnionClause, QuerySetDifferenceClause, QueryOrderClause, QueryOptionsClause, QueryLimitClause, QueryFromClause).annotations({
+  identifier: "org.dxos.schema.query"
 });
 var Query = Query_;
 var QueryOptions = Schema2.Struct({
+  /**
+  * Nested select statements will use this option to filter deleted objects.
+  */
+  deleted: Schema2.optional(Schema2.Literal("include", "exclude", "only")),
+  /**
+  * Diagnostics-only label for logs / tooling (not used by execution semantics).
+  */
+  debugLabel: Schema2.optional(Schema2.String)
+});
+var Scope = Schema2.Struct({
   /**
   * The nested select statemets will select from the given spaces.
   *
-  * NOTE: Spaces and queues are unioned together if both are specified.
+  * NOTE: Spaces and feeds are unioned together if both are specified.
   */
   spaceIds: Schema2.optional(Schema2.Array(Schema2.String)),
   /**
-  * If true, the nested select statements will select from all queues in the spaces specified by `spaceIds`.
+  * If true, the nested select statements will select from all feeds in the spaces specified by `spaceIds`.
   */
-  allQueuesFromSpaces: Schema2.optional(Schema2.Boolean),
+  allFeedsFromSpaces: Schema2.optional(Schema2.Boolean),
   /**
-  * The nested select statemets will select from the given queues.
+  * The nested select statemets will select from the given feeds (by underlying queue DXN).
   *
-  * NOTE: Spaces and queues are unioned together if both are specified.
+  * NOTE: Spaces and feeds are unioned together if both are specified.
   */
-  queues: Schema2.optional(Schema2.Array(DXN2.Schema)),
-  /**
-  * Nested select statements will use this option to filter deleted objects.
-  */
-  deleted: Schema2.optional(Schema2.Literal("include", "exclude", "only"))
+  feeds: Schema2.optional(Schema2.Array(DXN2.Schema))
 });
 var visit = (query, visitor) => {
   visitor(query);
@@ -602,10 +666,90 @@ var visit = (query, visitor) => {
   }, ({ query: query2 }) => visit(query2, visitor)), Match.when({
     type: "limit"
   }, ({ query: query2 }) => visit(query2, visitor)), Match.when({
+    type: "from"
+  }, (node) => {
+    visit(node.query, visitor);
+    if (node.from._tag === "query") {
+      visit(node.from.query, visitor);
+    }
+  }), Match.when({
     type: "select"
   }, () => {
   }), Match.exhaustive);
 };
+var map = (query, mapper) => {
+  const mapped = Match.value(query).pipe(Match.when({
+    type: "filter"
+  }, (node) => ({
+    ...node,
+    selection: map(node.selection, mapper)
+  })), Match.when({
+    type: "reference-traversal"
+  }, (node) => ({
+    ...node,
+    anchor: map(node.anchor, mapper)
+  })), Match.when({
+    type: "incoming-references"
+  }, (node) => ({
+    ...node,
+    anchor: map(node.anchor, mapper)
+  })), Match.when({
+    type: "relation"
+  }, (node) => ({
+    ...node,
+    anchor: map(node.anchor, mapper)
+  })), Match.when({
+    type: "relation-traversal"
+  }, (node) => ({
+    ...node,
+    anchor: map(node.anchor, mapper)
+  })), Match.when({
+    type: "hierarchy-traversal"
+  }, (node) => ({
+    ...node,
+    anchor: map(node.anchor, mapper)
+  })), Match.when({
+    type: "options"
+  }, (node) => ({
+    ...node,
+    query: map(node.query, mapper)
+  })), Match.when({
+    type: "order"
+  }, (node) => ({
+    ...node,
+    query: map(node.query, mapper)
+  })), Match.when({
+    type: "limit"
+  }, (node) => ({
+    ...node,
+    query: map(node.query, mapper)
+  })), Match.when({
+    type: "from"
+  }, (node) => ({
+    ...node,
+    query: map(node.query, mapper),
+    ...node.from._tag === "query" ? {
+      from: {
+        _tag: "query",
+        query: map(node.from.query, mapper)
+      }
+    } : {}
+  })), Match.when({
+    type: "union"
+  }, (node) => ({
+    ...node,
+    queries: node.queries.map((q) => map(q, mapper))
+  })), Match.when({
+    type: "set-difference"
+  }, (node) => ({
+    ...node,
+    source: map(node.source, mapper),
+    exclude: map(node.exclude, mapper)
+  })), Match.when({
+    type: "select"
+  }, (node) => node), Match.exhaustive);
+  return mapper(mapped);
+};
 var fold = (query, reducer) => {
   return Match.value(query).pipe(Match.withReturnType(), Match.when({
     type: "filter"
@@ -630,12 +774,50 @@ var fold = (query, reducer) => {
   }, ({ query: query2 }) => fold(query2, reducer)), Match.when({
     type: "limit"
   }, ({ query: query2 }) => fold(query2, reducer)), Match.when({
+    type: "from"
+  }, (node) => {
+    const results = fold(node.query, reducer);
+    if (node.from._tag === "query") {
+      return results.concat(fold(node.from.query, reducer));
+    }
+    return results;
+  }), Match.when({
     type: "select"
   }, () => []), Match.exhaustive);
 };
+
+// src/space-doc-version.ts
+var SpaceDocVersion = Object.freeze({
+  /**
+  * For the documents created before the versioning was introduced.
+  */
+  LEGACY: 0,
+  /**
+  * Current version.
+  */
+  CURRENT: 1
+});
+
+// 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;
+};
 export {
   DATA_NAMESPACE,
   DatabaseDirectory,
+  EchoFeedCodec,
   EncodedReference,
   ForeignKey,
   ObjectStructure,
@@ -647,6 +829,7 @@ export {
   createIdFromSpaceKey,
   decodeReference,
   encodeReference,
+  isEdgePeerId,
   isEncodedReference
 };
 //# sourceMappingURL=index.mjs.map