@dxos/echo-protocol 0.8.3 → 0.8.4-main.05e74ebcff

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/LICENSE +102 -5
  2. package/README.md +1 -1
  3. package/dist/lib/neutral/index.mjs +825 -0
  4. package/dist/lib/neutral/index.mjs.map +7 -0
  5. package/dist/lib/neutral/meta.json +1 -0
  6. package/dist/types/src/document-structure.d.ts +26 -2
  7. package/dist/types/src/document-structure.d.ts.map +1 -1
  8. package/dist/types/src/echo-feed-codec.d.ts +17 -0
  9. package/dist/types/src/echo-feed-codec.d.ts.map +1 -0
  10. package/dist/types/src/foreign-key.d.ts +1 -1
  11. package/dist/types/src/foreign-key.d.ts.map +1 -1
  12. package/dist/types/src/index.d.ts +4 -3
  13. package/dist/types/src/index.d.ts.map +1 -1
  14. package/dist/types/src/query/ast.d.ts +238 -25
  15. package/dist/types/src/query/ast.d.ts.map +1 -1
  16. package/dist/types/src/reference.d.ts +17 -0
  17. package/dist/types/src/reference.d.ts.map +1 -1
  18. package/dist/types/src/space-id.d.ts.map +1 -1
  19. package/dist/types/tsconfig.tsbuildinfo +1 -1
  20. package/package.json +15 -15
  21. package/src/document-structure.ts +36 -2
  22. package/src/echo-feed-codec.ts +67 -0
  23. package/src/foreign-key.ts +4 -3
  24. package/src/index.ts +4 -3
  25. package/src/query/ast.ts +326 -34
  26. package/src/reference.ts +29 -0
  27. package/src/space-id.ts +1 -1
  28. package/dist/lib/browser/index.mjs +0 -509
  29. package/dist/lib/browser/index.mjs.map +0 -7
  30. package/dist/lib/browser/meta.json +0 -1
  31. package/dist/lib/node/index.cjs +0 -527
  32. package/dist/lib/node/index.cjs.map +0 -7
  33. package/dist/lib/node/meta.json +0 -1
  34. package/dist/lib/node-esm/index.mjs +0 -510
  35. package/dist/lib/node-esm/index.mjs.map +0 -7
  36. package/dist/lib/node-esm/meta.json +0 -1
@@ -0,0 +1,825 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __export = (target, all) => {
3
+ for (var name in all)
4
+ __defProp(target, name, { get: all[name], enumerable: true });
5
+ };
6
+
7
+ // src/document-structure.ts
8
+ import { invariant } from "@dxos/invariant";
9
+ import { visitValues } from "@dxos/util";
10
+
11
+ // src/reference.ts
12
+ import { assertArgument } from "@dxos/invariant";
13
+ import { DXN, LOCAL_SPACE_TAG } from "@dxos/keys";
14
+ var Reference = class _Reference {
15
+ _objectId;
16
+ _protocol;
17
+ _host;
18
+ _dxn;
19
+ /**
20
+ * Protocol references to runtime registered types.
21
+ * @deprecated
22
+ */
23
+ static TYPE_PROTOCOL = "protobuf";
24
+ static fromDXN(dxn) {
25
+ switch (dxn.kind) {
26
+ case DXN.kind.TYPE:
27
+ return new _Reference(dxn.parts[0], _Reference.TYPE_PROTOCOL, "dxos.org", dxn);
28
+ case DXN.kind.ECHO:
29
+ if (dxn.parts[0] === LOCAL_SPACE_TAG) {
30
+ return new _Reference(dxn.parts[1], void 0, void 0, dxn);
31
+ } else {
32
+ return new _Reference(dxn.parts[1], void 0, dxn.parts[0], dxn);
33
+ }
34
+ default:
35
+ return new _Reference(dxn.parts[0], void 0, dxn.parts[0], dxn);
36
+ }
37
+ }
38
+ static fromValue(value2) {
39
+ return new _Reference(value2.objectId, value2.protocol, value2.host);
40
+ }
41
+ /**
42
+ * Reference an object in the local space.
43
+ */
44
+ static localObjectReference(objectId) {
45
+ return new _Reference(objectId);
46
+ }
47
+ /**
48
+ * @deprecated
49
+ */
50
+ // TODO(dmaretskyi): Remove.
51
+ static fromLegacyTypename(type) {
52
+ return new _Reference(type, _Reference.TYPE_PROTOCOL, "dxos.org");
53
+ }
54
+ /**
55
+ * @deprecated
56
+ */
57
+ // TODO(dmaretskyi): Remove
58
+ static fromObjectIdAndSpaceKey(objectId, spaceKey) {
59
+ return new _Reference(objectId, void 0, spaceKey.toHex());
60
+ }
61
+ // prettier-ignore
62
+ constructor(_objectId, _protocol, _host, _dxn) {
63
+ this._objectId = _objectId;
64
+ this._protocol = _protocol;
65
+ this._host = _host;
66
+ this._dxn = _dxn;
67
+ }
68
+ get dxn() {
69
+ return this._dxn;
70
+ }
71
+ /**
72
+ * @deprecated
73
+ */
74
+ // TODO(dmaretskyi): Remove.
75
+ get objectId() {
76
+ return this._objectId;
77
+ }
78
+ /**
79
+ * @deprecated
80
+ */
81
+ // TODO(dmaretskyi): Remove.
82
+ get protocol() {
83
+ return this._protocol;
84
+ }
85
+ /**
86
+ * @deprecated
87
+ */
88
+ // TODO(dmaretskyi): Remove.
89
+ get host() {
90
+ return this._host;
91
+ }
92
+ encode() {
93
+ return {
94
+ objectId: this.objectId,
95
+ host: this.host,
96
+ protocol: this.protocol
97
+ };
98
+ }
99
+ // TODO(dmaretskyi): Remove in favor of `reference.dxn`.
100
+ toDXN() {
101
+ if (this._dxn) {
102
+ return this._dxn;
103
+ }
104
+ if (this.protocol === _Reference.TYPE_PROTOCOL) {
105
+ return new DXN(DXN.kind.TYPE, [
106
+ this.objectId
107
+ ]);
108
+ } else {
109
+ if (this.host) {
110
+ return new DXN(DXN.kind.ECHO, [
111
+ this.host,
112
+ this.objectId
113
+ ]);
114
+ } else {
115
+ return new DXN(DXN.kind.ECHO, [
116
+ LOCAL_SPACE_TAG,
117
+ this.objectId
118
+ ]);
119
+ }
120
+ }
121
+ }
122
+ };
123
+ var REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
124
+ var encodeReference = (reference) => ({
125
+ "/": reference.toDXN().toString()
126
+ });
127
+ var decodeReference = (value2) => {
128
+ if (typeof value2 !== "object" || value2 === null || typeof value2["/"] !== "string") {
129
+ throw new Error("Invalid reference");
130
+ }
131
+ const dxnString = value2["/"];
132
+ if (dxnString.length % 2 === 0 && dxnString.slice(0, dxnString.length / 2) === dxnString.slice(dxnString.length / 2) && dxnString.includes("dxn:echo")) {
133
+ throw new Error("Automerge bug detected!");
134
+ }
135
+ return Reference.fromDXN(DXN.parse(dxnString));
136
+ };
137
+ var isEncodedReference = (value2) => typeof value2 === "object" && value2 !== null && Object.keys(value2).length === 1 && typeof value2["/"] === "string";
138
+ var EncodedReference = Object.freeze({
139
+ isEncodedReference,
140
+ getReferenceString: (value2) => {
141
+ assertArgument(isEncodedReference(value2), "value", "invalid reference");
142
+ return value2["/"];
143
+ },
144
+ toDXN: (value2) => {
145
+ return DXN.parse(EncodedReference.getReferenceString(value2));
146
+ },
147
+ fromDXN: (dxn) => {
148
+ return {
149
+ "/": dxn.toString()
150
+ };
151
+ },
152
+ fromLegacyTypename: (typename) => {
153
+ return {
154
+ "/": DXN.fromTypename(typename).toString()
155
+ };
156
+ }
157
+ });
158
+
159
+ // src/document-structure.ts
160
+ var __dxlog_file = "/__w/dxos/dxos/packages/core/echo/echo-protocol/src/document-structure.ts";
161
+ var DatabaseDirectory = Object.freeze({
162
+ /**
163
+ * @returns Space key in hex of the space that owns the document. In hex format. Without 0x prefix.
164
+ */
165
+ getSpaceKey: (doc) => {
166
+ const rawSpaceKey = doc.access?.spaceKey ?? doc.experimental_spaceKey;
167
+ if (rawSpaceKey == null) {
168
+ return null;
169
+ }
170
+ const rawKey = String(rawSpaceKey);
171
+ 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'"] });
172
+ return rawKey;
173
+ },
174
+ getInlineObject: (doc, id) => {
175
+ return doc.objects?.[id];
176
+ },
177
+ getLink: (doc, id) => {
178
+ return doc.links?.[id]?.toString();
179
+ },
180
+ make: ({ spaceKey, objects, links }) => ({
181
+ access: {
182
+ spaceKey
183
+ },
184
+ objects: objects ?? {},
185
+ links: links ?? {}
186
+ })
187
+ });
188
+ var ObjectStructure = Object.freeze({
189
+ /**
190
+ * @throws On invalid object structure.
191
+ */
192
+ getTypeReference: (object) => {
193
+ return object.system?.type;
194
+ },
195
+ /**
196
+ * @throws On invalid object structure.
197
+ */
198
+ getEntityKind: (object) => {
199
+ const kind = object.system?.kind ?? "object";
200
+ invariant(kind === "object" || kind === "relation", "Invalid kind", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 45, S: void 0, A: ["kind === 'object' || kind === 'relation'", "'Invalid kind'"] });
201
+ return kind;
202
+ },
203
+ isDeleted: (object) => {
204
+ return object.system?.deleted ?? false;
205
+ },
206
+ getRelationSource: (object) => {
207
+ return object.system?.source;
208
+ },
209
+ getRelationTarget: (object) => {
210
+ return object.system?.target;
211
+ },
212
+ getParent: (object) => {
213
+ return object.system?.parent;
214
+ },
215
+ /**
216
+ * @returns All references in the data section of the object.
217
+ */
218
+ getAllOutgoingReferences: (object) => {
219
+ const references = [];
220
+ const visit2 = (path, value2) => {
221
+ if (isEncodedReference(value2)) {
222
+ references.push({
223
+ path,
224
+ reference: value2
225
+ });
226
+ } else {
227
+ visitValues(value2, (value3, key) => visit2([
228
+ ...path,
229
+ String(key)
230
+ ], value3));
231
+ }
232
+ };
233
+ visitValues(object.data, (value2, key) => visit2([
234
+ String(key)
235
+ ], value2));
236
+ return references;
237
+ },
238
+ getTags: (object) => {
239
+ return object.meta.tags ?? [];
240
+ },
241
+ makeObject: ({ type, data, keys }) => {
242
+ return {
243
+ system: {
244
+ kind: "object",
245
+ type: {
246
+ "/": type
247
+ }
248
+ },
249
+ meta: {
250
+ keys: keys ?? []
251
+ },
252
+ data: data ?? {}
253
+ };
254
+ },
255
+ makeRelation: ({ type, source, target, deleted, keys, data }) => {
256
+ return {
257
+ system: {
258
+ kind: "relation",
259
+ type: {
260
+ "/": type
261
+ },
262
+ source,
263
+ target,
264
+ deleted: deleted ?? false
265
+ },
266
+ meta: {
267
+ keys: keys ?? []
268
+ },
269
+ data: data ?? {}
270
+ };
271
+ }
272
+ });
273
+ var PROPERTY_ID = "id";
274
+ var DATA_NAMESPACE = "data";
275
+
276
+ // src/echo-feed-codec.ts
277
+ import { FeedProtocol } from "@dxos/protocols";
278
+ var ATTR_META = "@meta";
279
+ var EchoFeedCodec = class _EchoFeedCodec {
280
+ static #encoder = new TextEncoder();
281
+ static #decoder = new TextDecoder();
282
+ /**
283
+ * Prepares a value for feed storage (strips queue position from metadata) and encodes to bytes.
284
+ */
285
+ static encode(value2) {
286
+ const prepared = _EchoFeedCodec.#stripQueuePosition(value2);
287
+ return _EchoFeedCodec.#encoder.encode(JSON.stringify(prepared));
288
+ }
289
+ /**
290
+ * Decodes feed block bytes to a JSON value.
291
+ * If position is provided, injects queue position into the decoded object's metadata.
292
+ */
293
+ static decode(data, position) {
294
+ const decoded = JSON.parse(_EchoFeedCodec.#decoder.decode(data));
295
+ if (position !== void 0 && typeof decoded === "object" && decoded !== null) {
296
+ _EchoFeedCodec.#setQueuePosition(decoded, position);
297
+ }
298
+ return decoded;
299
+ }
300
+ static #stripQueuePosition(value2) {
301
+ if (typeof value2 !== "object" || value2 === null) {
302
+ return value2;
303
+ }
304
+ const obj = structuredClone(value2);
305
+ const meta = obj[ATTR_META];
306
+ if (meta?.keys?.some((key) => key.source === FeedProtocol.KEY_QUEUE_POSITION)) {
307
+ meta.keys = meta.keys.filter((key) => key.source !== FeedProtocol.KEY_QUEUE_POSITION);
308
+ }
309
+ return obj;
310
+ }
311
+ static #setQueuePosition(obj, position) {
312
+ obj[ATTR_META] ??= {
313
+ keys: []
314
+ };
315
+ obj[ATTR_META].keys ??= [];
316
+ const keys = obj[ATTR_META].keys;
317
+ for (let i = 0; i < keys.length; i++) {
318
+ if (keys[i].source === FeedProtocol.KEY_QUEUE_POSITION) {
319
+ keys.splice(i, 1);
320
+ i--;
321
+ }
322
+ }
323
+ keys.push({
324
+ source: FeedProtocol.KEY_QUEUE_POSITION,
325
+ id: position.toString()
326
+ });
327
+ }
328
+ };
329
+
330
+ // src/foreign-key.ts
331
+ import * as Schema from "effect/Schema";
332
+ import * as SchemaAST from "effect/SchemaAST";
333
+ var ForeignKey_ = Schema.Struct({
334
+ /**
335
+ * Name of the foreign database/system.
336
+ * E.g., `github.com`.
337
+ */
338
+ source: Schema.String,
339
+ /**
340
+ * Id within the foreign database.
341
+ */
342
+ // TODO(wittjosiah): This annotation is currently used to ensure id field shows up in forms.
343
+ // TODO(dmaretskyi): `false` is not a valid value for the annotation. Use a different annotation.
344
+ id: Schema.String.annotations({
345
+ [SchemaAST.IdentifierAnnotationId]: "false"
346
+ })
347
+ });
348
+ var ForeignKey = ForeignKey_;
349
+
350
+ // src/query/ast.ts
351
+ var ast_exports = {};
352
+ __export(ast_exports, {
353
+ Filter: () => Filter,
354
+ FilterAnd: () => FilterAnd,
355
+ FilterChildOf: () => FilterChildOf,
356
+ FilterCompare: () => FilterCompare,
357
+ FilterContains: () => FilterContains,
358
+ FilterIn: () => FilterIn,
359
+ FilterNot: () => FilterNot,
360
+ FilterObject: () => FilterObject,
361
+ FilterOr: () => FilterOr,
362
+ FilterRange: () => FilterRange,
363
+ FilterTag: () => FilterTag,
364
+ FilterTextSearch: () => FilterTextSearch,
365
+ FilterTimestamp: () => FilterTimestamp,
366
+ Order: () => Order,
367
+ OrderDirection: () => OrderDirection,
368
+ Query: () => Query,
369
+ QueryFilterClause: () => QueryFilterClause,
370
+ QueryFromClause: () => QueryFromClause,
371
+ QueryFromClause_: () => QueryFromClause_,
372
+ QueryHierarchyTraversalClause: () => QueryHierarchyTraversalClause,
373
+ QueryIncomingReferencesClause: () => QueryIncomingReferencesClause,
374
+ QueryLimitClause: () => QueryLimitClause,
375
+ QueryOptions: () => QueryOptions,
376
+ QueryOptionsClause: () => QueryOptionsClause,
377
+ QueryOrderClause: () => QueryOrderClause,
378
+ QueryReferenceTraversalClause: () => QueryReferenceTraversalClause,
379
+ QueryRelationClause: () => QueryRelationClause,
380
+ QueryRelationTraversalClause: () => QueryRelationTraversalClause,
381
+ QuerySelectClause: () => QuerySelectClause,
382
+ QuerySetDifferenceClause: () => QuerySetDifferenceClause,
383
+ QueryUnionClause: () => QueryUnionClause,
384
+ Scope: () => Scope,
385
+ fold: () => fold,
386
+ map: () => map,
387
+ visit: () => visit
388
+ });
389
+ import * as Match from "effect/Match";
390
+ import * as Schema2 from "effect/Schema";
391
+ import { DXN as DXN2, ObjectId } from "@dxos/keys";
392
+ var TypenameSpecifier = Schema2.Union(DXN2.Schema, Schema2.Null).annotations({
393
+ description: "DXN or null; null matches any type"
394
+ });
395
+ var FilterObject_ = Schema2.Struct({
396
+ type: Schema2.Literal("object"),
397
+ typename: TypenameSpecifier,
398
+ id: Schema2.optional(Schema2.Array(ObjectId)),
399
+ /**
400
+ * Filter by property.
401
+ * Must not include object ID.
402
+ */
403
+ props: Schema2.Record({
404
+ key: Schema2.String.annotations({
405
+ description: "Property name"
406
+ }),
407
+ value: Schema2.suspend(() => Filter)
408
+ }),
409
+ /**
410
+ * Objects that have any of the given foreign keys.
411
+ */
412
+ foreignKeys: Schema2.optional(Schema2.Array(ForeignKey)),
413
+ /**
414
+ * Match objects whose meta `key` equals this fully-qualified registry key (FQN format).
415
+ */
416
+ metaKey: Schema2.optional(Schema2.String),
417
+ /**
418
+ * Semver range matched against the object's meta `version`.
419
+ * Only consulted when {@link metaKey} is set. Objects with no `version` do not satisfy a version-constrained filter.
420
+ */
421
+ metaVersion: Schema2.optional(Schema2.String)
422
+ });
423
+ var FilterObject = FilterObject_;
424
+ var FilterCompare_ = Schema2.Struct({
425
+ type: Schema2.Literal("compare"),
426
+ operator: Schema2.Literal("eq", "neq", "gt", "gte", "lt", "lte"),
427
+ value: Schema2.Unknown
428
+ });
429
+ var FilterCompare = FilterCompare_;
430
+ var FilterIn_ = Schema2.Struct({
431
+ type: Schema2.Literal("in"),
432
+ values: Schema2.Array(Schema2.Any)
433
+ });
434
+ var FilterIn = FilterIn_;
435
+ var FilterContains_ = Schema2.Struct({
436
+ type: Schema2.Literal("contains"),
437
+ value: Schema2.Any
438
+ });
439
+ var FilterContains = FilterContains_;
440
+ var FilterTag_ = Schema2.Struct({
441
+ type: Schema2.Literal("tag"),
442
+ tag: Schema2.String
443
+ });
444
+ var FilterTag = FilterTag_;
445
+ var FilterRange_ = Schema2.Struct({
446
+ type: Schema2.Literal("range"),
447
+ from: Schema2.Any,
448
+ to: Schema2.Any
449
+ });
450
+ var FilterRange = FilterRange_;
451
+ var FilterTimestamp_ = Schema2.Struct({
452
+ type: Schema2.Literal("timestamp"),
453
+ field: Schema2.Literal("createdAt", "updatedAt"),
454
+ operator: Schema2.Literal("gt", "gte", "lt", "lte"),
455
+ value: Schema2.Number
456
+ });
457
+ var FilterTimestamp = FilterTimestamp_;
458
+ var FilterTextSearch_ = Schema2.Struct({
459
+ type: Schema2.Literal("text-search"),
460
+ text: Schema2.String,
461
+ searchKind: Schema2.optional(Schema2.Literal("full-text", "vector"))
462
+ });
463
+ var FilterTextSearch = FilterTextSearch_;
464
+ var FilterNot_ = Schema2.Struct({
465
+ type: Schema2.Literal("not"),
466
+ filter: Schema2.suspend(() => Filter)
467
+ });
468
+ var FilterNot = FilterNot_;
469
+ var FilterAnd_ = Schema2.Struct({
470
+ type: Schema2.Literal("and"),
471
+ filters: Schema2.Array(Schema2.suspend(() => Filter))
472
+ });
473
+ var FilterAnd = FilterAnd_;
474
+ var FilterOr_ = Schema2.Struct({
475
+ type: Schema2.Literal("or"),
476
+ filters: Schema2.Array(Schema2.suspend(() => Filter))
477
+ });
478
+ var FilterOr = FilterOr_;
479
+ var FilterChildOf_ = Schema2.Struct({
480
+ type: Schema2.Literal("child-of"),
481
+ /** Parent DXNs to match children of. */
482
+ parents: Schema2.Array(DXN2.Schema),
483
+ /** Whether to match transitively (grandchildren, etc.). Defaults to true. */
484
+ transitive: Schema2.Boolean
485
+ });
486
+ var FilterChildOf = FilterChildOf_;
487
+ var Filter = Schema2.Union(FilterObject, FilterCompare, FilterIn, FilterContains, FilterTag, FilterRange, FilterTimestamp, FilterTextSearch, FilterChildOf, FilterNot, FilterAnd, FilterOr).annotations({
488
+ identifier: "org.dxos.schema.filter"
489
+ });
490
+ var QuerySelectClause_ = Schema2.Struct({
491
+ type: Schema2.Literal("select"),
492
+ filter: Schema2.suspend(() => Filter)
493
+ });
494
+ var QuerySelectClause = QuerySelectClause_;
495
+ var QueryFilterClause_ = Schema2.Struct({
496
+ type: Schema2.Literal("filter"),
497
+ selection: Schema2.suspend(() => Query),
498
+ filter: Schema2.suspend(() => Filter)
499
+ });
500
+ var QueryFilterClause = QueryFilterClause_;
501
+ var QueryReferenceTraversalClause_ = Schema2.Struct({
502
+ type: Schema2.Literal("reference-traversal"),
503
+ anchor: Schema2.suspend(() => Query),
504
+ property: Schema2.String
505
+ });
506
+ var QueryReferenceTraversalClause = QueryReferenceTraversalClause_;
507
+ var QueryIncomingReferencesClause_ = Schema2.Struct({
508
+ type: Schema2.Literal("incoming-references"),
509
+ anchor: Schema2.suspend(() => Query),
510
+ /**
511
+ * Property path where the reference is located.
512
+ * If null, matches references from any property.
513
+ */
514
+ property: Schema2.NullOr(Schema2.String),
515
+ typename: TypenameSpecifier
516
+ });
517
+ var QueryIncomingReferencesClause = QueryIncomingReferencesClause_;
518
+ var QueryRelationClause_ = Schema2.Struct({
519
+ type: Schema2.Literal("relation"),
520
+ anchor: Schema2.suspend(() => Query),
521
+ /**
522
+ * outgoing: anchor is the source of the relation.
523
+ * incoming: anchor is the target of the relation.
524
+ * both: anchor is either the source or target of the relation.
525
+ */
526
+ direction: Schema2.Literal("outgoing", "incoming", "both"),
527
+ filter: Schema2.optional(Schema2.suspend(() => Filter))
528
+ });
529
+ var QueryRelationClause = QueryRelationClause_;
530
+ var QueryRelationTraversalClause_ = Schema2.Struct({
531
+ type: Schema2.Literal("relation-traversal"),
532
+ anchor: Schema2.suspend(() => Query),
533
+ direction: Schema2.Literal("source", "target", "both")
534
+ });
535
+ var QueryRelationTraversalClause = QueryRelationTraversalClause_;
536
+ var QueryHierarchyTraversalClause_ = Schema2.Struct({
537
+ type: Schema2.Literal("hierarchy-traversal"),
538
+ anchor: Schema2.suspend(() => Query),
539
+ /**
540
+ * to-parent: traverse from child to parent.
541
+ * to-children: traverse from parent to children.
542
+ */
543
+ direction: Schema2.Literal("to-parent", "to-children")
544
+ });
545
+ var QueryHierarchyTraversalClause = QueryHierarchyTraversalClause_;
546
+ var QueryUnionClause_ = Schema2.Struct({
547
+ type: Schema2.Literal("union"),
548
+ queries: Schema2.Array(Schema2.suspend(() => Query))
549
+ });
550
+ var QueryUnionClause = QueryUnionClause_;
551
+ var QuerySetDifferenceClause_ = Schema2.Struct({
552
+ type: Schema2.Literal("set-difference"),
553
+ source: Schema2.suspend(() => Query),
554
+ exclude: Schema2.suspend(() => Query)
555
+ });
556
+ var QuerySetDifferenceClause = QuerySetDifferenceClause_;
557
+ var OrderDirection = Schema2.Literal("asc", "desc");
558
+ var Order_ = Schema2.Union(Schema2.Struct({
559
+ // How database wants to order them (in practice - by id).
560
+ kind: Schema2.Literal("natural")
561
+ }), Schema2.Struct({
562
+ kind: Schema2.Literal("property"),
563
+ property: Schema2.String,
564
+ direction: OrderDirection
565
+ }), Schema2.Struct({
566
+ // Order by relevance rank (for FTS/vector search results).
567
+ // Default direction is 'desc' (higher rank = better match first).
568
+ kind: Schema2.Literal("rank"),
569
+ direction: OrderDirection
570
+ }));
571
+ var Order = Order_;
572
+ var QueryOrderClause_ = Schema2.Struct({
573
+ type: Schema2.Literal("order"),
574
+ query: Schema2.suspend(() => Query),
575
+ order: Schema2.Array(Order)
576
+ });
577
+ var QueryOrderClause = QueryOrderClause_;
578
+ var QueryOptionsClause_ = Schema2.Struct({
579
+ type: Schema2.Literal("options"),
580
+ query: Schema2.suspend(() => Query),
581
+ options: Schema2.suspend(() => QueryOptions)
582
+ });
583
+ var QueryOptionsClause = QueryOptionsClause_;
584
+ var QueryLimitClause_ = Schema2.Struct({
585
+ type: Schema2.Literal("limit"),
586
+ query: Schema2.suspend(() => Query),
587
+ limit: Schema2.Number
588
+ });
589
+ var QueryLimitClause = QueryLimitClause_;
590
+ var QueryFromClause_ = Schema2.Struct({
591
+ type: Schema2.Literal("from"),
592
+ query: Schema2.suspend(() => Query),
593
+ from: Schema2.Union(Schema2.TaggedStruct("scope", {
594
+ scope: Schema2.suspend(() => Scope)
595
+ }), Schema2.TaggedStruct("query", {
596
+ query: Schema2.suspend(() => Query)
597
+ }))
598
+ });
599
+ var QueryFromClause = QueryFromClause_;
600
+ var Query_ = Schema2.Union(QuerySelectClause, QueryFilterClause, QueryReferenceTraversalClause, QueryIncomingReferencesClause, QueryRelationClause, QueryRelationTraversalClause, QueryHierarchyTraversalClause, QueryUnionClause, QuerySetDifferenceClause, QueryOrderClause, QueryOptionsClause, QueryLimitClause, QueryFromClause).annotations({
601
+ identifier: "org.dxos.schema.query"
602
+ });
603
+ var Query = Query_;
604
+ var QueryOptions = Schema2.Struct({
605
+ /**
606
+ * Nested select statements will use this option to filter deleted objects.
607
+ */
608
+ deleted: Schema2.optional(Schema2.Literal("include", "exclude", "only")),
609
+ /**
610
+ * Diagnostics-only label for logs / tooling (not used by execution semantics).
611
+ */
612
+ debugLabel: Schema2.optional(Schema2.String)
613
+ });
614
+ var Scope = Schema2.Struct({
615
+ /**
616
+ * The nested select statemets will select from the given spaces.
617
+ *
618
+ * NOTE: Spaces and feeds are unioned together if both are specified.
619
+ */
620
+ spaceIds: Schema2.optional(Schema2.Array(Schema2.String)),
621
+ /**
622
+ * If true, the nested select statements will select from all feeds in the spaces specified by `spaceIds`.
623
+ */
624
+ allFeedsFromSpaces: Schema2.optional(Schema2.Boolean),
625
+ /**
626
+ * The nested select statemets will select from the given feeds (by underlying queue DXN).
627
+ *
628
+ * NOTE: Spaces and feeds are unioned together if both are specified.
629
+ */
630
+ feeds: Schema2.optional(Schema2.Array(DXN2.Schema))
631
+ });
632
+ var visit = (query, visitor) => {
633
+ visitor(query);
634
+ Match.value(query).pipe(Match.when({
635
+ type: "filter"
636
+ }, ({ selection }) => visit(selection, visitor)), Match.when({
637
+ type: "reference-traversal"
638
+ }, ({ anchor }) => visit(anchor, visitor)), Match.when({
639
+ type: "incoming-references"
640
+ }, ({ anchor }) => visit(anchor, visitor)), Match.when({
641
+ type: "relation"
642
+ }, ({ anchor }) => visit(anchor, visitor)), Match.when({
643
+ type: "options"
644
+ }, ({ query: query2 }) => visit(query2, visitor)), Match.when({
645
+ type: "relation-traversal"
646
+ }, ({ anchor }) => visit(anchor, visitor)), Match.when({
647
+ type: "hierarchy-traversal"
648
+ }, ({ anchor }) => visit(anchor, visitor)), Match.when({
649
+ type: "union"
650
+ }, ({ queries }) => queries.forEach((q) => visit(q, visitor))), Match.when({
651
+ type: "set-difference"
652
+ }, ({ source, exclude }) => {
653
+ visit(source, visitor);
654
+ visit(exclude, visitor);
655
+ }), Match.when({
656
+ type: "order"
657
+ }, ({ query: query2 }) => visit(query2, visitor)), Match.when({
658
+ type: "limit"
659
+ }, ({ query: query2 }) => visit(query2, visitor)), Match.when({
660
+ type: "from"
661
+ }, (node) => {
662
+ visit(node.query, visitor);
663
+ if (node.from._tag === "query") {
664
+ visit(node.from.query, visitor);
665
+ }
666
+ }), Match.when({
667
+ type: "select"
668
+ }, () => {
669
+ }), Match.exhaustive);
670
+ };
671
+ var map = (query, mapper) => {
672
+ const mapped = Match.value(query).pipe(Match.when({
673
+ type: "filter"
674
+ }, (node) => ({
675
+ ...node,
676
+ selection: map(node.selection, mapper)
677
+ })), Match.when({
678
+ type: "reference-traversal"
679
+ }, (node) => ({
680
+ ...node,
681
+ anchor: map(node.anchor, mapper)
682
+ })), Match.when({
683
+ type: "incoming-references"
684
+ }, (node) => ({
685
+ ...node,
686
+ anchor: map(node.anchor, mapper)
687
+ })), Match.when({
688
+ type: "relation"
689
+ }, (node) => ({
690
+ ...node,
691
+ anchor: map(node.anchor, mapper)
692
+ })), Match.when({
693
+ type: "relation-traversal"
694
+ }, (node) => ({
695
+ ...node,
696
+ anchor: map(node.anchor, mapper)
697
+ })), Match.when({
698
+ type: "hierarchy-traversal"
699
+ }, (node) => ({
700
+ ...node,
701
+ anchor: map(node.anchor, mapper)
702
+ })), Match.when({
703
+ type: "options"
704
+ }, (node) => ({
705
+ ...node,
706
+ query: map(node.query, mapper)
707
+ })), Match.when({
708
+ type: "order"
709
+ }, (node) => ({
710
+ ...node,
711
+ query: map(node.query, mapper)
712
+ })), Match.when({
713
+ type: "limit"
714
+ }, (node) => ({
715
+ ...node,
716
+ query: map(node.query, mapper)
717
+ })), Match.when({
718
+ type: "from"
719
+ }, (node) => ({
720
+ ...node,
721
+ query: map(node.query, mapper),
722
+ ...node.from._tag === "query" ? {
723
+ from: {
724
+ _tag: "query",
725
+ query: map(node.from.query, mapper)
726
+ }
727
+ } : {}
728
+ })), Match.when({
729
+ type: "union"
730
+ }, (node) => ({
731
+ ...node,
732
+ queries: node.queries.map((q) => map(q, mapper))
733
+ })), Match.when({
734
+ type: "set-difference"
735
+ }, (node) => ({
736
+ ...node,
737
+ source: map(node.source, mapper),
738
+ exclude: map(node.exclude, mapper)
739
+ })), Match.when({
740
+ type: "select"
741
+ }, (node) => node), Match.exhaustive);
742
+ return mapper(mapped);
743
+ };
744
+ var fold = (query, reducer) => {
745
+ return Match.value(query).pipe(Match.withReturnType(), Match.when({
746
+ type: "filter"
747
+ }, ({ selection }) => fold(selection, reducer)), Match.when({
748
+ type: "reference-traversal"
749
+ }, ({ anchor }) => fold(anchor, reducer)), Match.when({
750
+ type: "incoming-references"
751
+ }, ({ anchor }) => fold(anchor, reducer)), Match.when({
752
+ type: "relation"
753
+ }, ({ anchor }) => fold(anchor, reducer)), Match.when({
754
+ type: "options"
755
+ }, ({ query: query2 }) => fold(query2, reducer)), Match.when({
756
+ type: "relation-traversal"
757
+ }, ({ anchor }) => fold(anchor, reducer)), Match.when({
758
+ type: "hierarchy-traversal"
759
+ }, ({ anchor }) => fold(anchor, reducer)), Match.when({
760
+ type: "union"
761
+ }, ({ queries }) => queries.flatMap((q) => fold(q, reducer))), Match.when({
762
+ type: "set-difference"
763
+ }, ({ source, exclude }) => fold(source, reducer).concat(fold(exclude, reducer))), Match.when({
764
+ type: "order"
765
+ }, ({ query: query2 }) => fold(query2, reducer)), Match.when({
766
+ type: "limit"
767
+ }, ({ query: query2 }) => fold(query2, reducer)), Match.when({
768
+ type: "from"
769
+ }, (node) => {
770
+ const results = fold(node.query, reducer);
771
+ if (node.from._tag === "query") {
772
+ return results.concat(fold(node.from.query, reducer));
773
+ }
774
+ return results;
775
+ }), Match.when({
776
+ type: "select"
777
+ }, () => []), Match.exhaustive);
778
+ };
779
+
780
+ // src/space-doc-version.ts
781
+ var SpaceDocVersion = Object.freeze({
782
+ /**
783
+ * For the documents created before the versioning was introduced.
784
+ */
785
+ LEGACY: 0,
786
+ /**
787
+ * Current version.
788
+ */
789
+ CURRENT: 1
790
+ });
791
+
792
+ // src/space-id.ts
793
+ import { subtleCrypto } from "@dxos/crypto";
794
+ import { PublicKey, SpaceId } from "@dxos/keys";
795
+ import { ComplexMap } from "@dxos/util";
796
+ var SPACE_IDS_CACHE = new ComplexMap(PublicKey.hash);
797
+ var createIdFromSpaceKey = async (spaceKey) => {
798
+ const cachedValue = SPACE_IDS_CACHE.get(spaceKey);
799
+ if (cachedValue !== void 0) {
800
+ return cachedValue;
801
+ }
802
+ const digest = await subtleCrypto.digest("SHA-256", spaceKey.asUint8Array());
803
+ const bytes = new Uint8Array(digest).slice(0, SpaceId.byteLength);
804
+ const spaceId = SpaceId.encode(bytes);
805
+ SPACE_IDS_CACHE.set(spaceKey, spaceId);
806
+ return spaceId;
807
+ };
808
+ export {
809
+ DATA_NAMESPACE,
810
+ DatabaseDirectory,
811
+ EchoFeedCodec,
812
+ EncodedReference,
813
+ ForeignKey,
814
+ ObjectStructure,
815
+ PROPERTY_ID,
816
+ ast_exports as QueryAST,
817
+ REFERENCE_TYPE_TAG,
818
+ Reference,
819
+ SpaceDocVersion,
820
+ createIdFromSpaceKey,
821
+ decodeReference,
822
+ encodeReference,
823
+ isEncodedReference
824
+ };
825
+ //# sourceMappingURL=index.mjs.map