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