@dxos/echo-protocol 0.8.4-staging.ac66bdf99f → 0.9.1-main.c7dcc2e112
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 +75 -182
- package/dist/lib/neutral/index.mjs.map +4 -4
- package/dist/lib/neutral/meta.json +1 -1
- package/dist/types/src/document-structure.d.ts +75 -34
- package/dist/types/src/document-structure.d.ts.map +1 -1
- package/dist/types/src/echo-feed-codec.d.ts.map +1 -1
- 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/index.d.ts +1 -0
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/query/ast.d.ts +118 -54
- package/dist/types/src/query/ast.d.ts.map +1 -1
- package/dist/types/src/reference.d.ts +11 -65
- 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 +8 -11
- package/src/document-structure.ts +88 -37
- package/src/edge-peer.ts +27 -0
- package/src/index.ts +1 -0
- package/src/query/ast.ts +65 -26
- package/src/reference.ts +12 -160
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as Schema from 'effect/Schema';
|
|
2
|
+
import { EID, URI } from '@dxos/keys';
|
|
2
3
|
/**
|
|
3
4
|
* Filter by object type and properties.
|
|
4
5
|
*
|
|
@@ -6,13 +7,13 @@ import * as Schema from 'effect/Schema';
|
|
|
6
7
|
*/
|
|
7
8
|
declare const FilterObject_: Schema.Struct<{
|
|
8
9
|
type: Schema.Literal<["object"]>;
|
|
9
|
-
typename: Schema.Union<[Schema.
|
|
10
|
-
id: Schema.optional<Schema.Array$<import("@dxos/keys").
|
|
10
|
+
typename: Schema.Union<[Schema.Schema<URI.URI, URI.URI, never>, typeof Schema.Null]>;
|
|
11
|
+
id: Schema.optional<Schema.Array$<import("@dxos/keys").EntityIdClass>>;
|
|
11
12
|
/**
|
|
12
13
|
* Filter by property.
|
|
13
14
|
* Must not include object ID.
|
|
14
15
|
*/
|
|
15
|
-
props: Schema.Record$<Schema.SchemaClass<string, string, never>, Schema.suspend<
|
|
16
|
+
props: Schema.Record$<Schema.SchemaClass<string, string, never>, Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>>;
|
|
16
17
|
/**
|
|
17
18
|
* Objects that have any of the given foreign keys.
|
|
18
19
|
*/
|
|
@@ -23,6 +24,15 @@ declare const FilterObject_: Schema.Struct<{
|
|
|
23
24
|
readonly source: string;
|
|
24
25
|
readonly id: string;
|
|
25
26
|
}, never>>>;
|
|
27
|
+
/**
|
|
28
|
+
* Match objects whose meta `key` equals this fully-qualified registry key (FQN format).
|
|
29
|
+
*/
|
|
30
|
+
metaKey: Schema.optional<typeof Schema.String>;
|
|
31
|
+
/**
|
|
32
|
+
* Semver range matched against the object's meta `version`.
|
|
33
|
+
* Only consulted when {@link metaKey} is set. Objects with no `version` do not satisfy a version-constrained filter.
|
|
34
|
+
*/
|
|
35
|
+
metaVersion: Schema.optional<typeof Schema.String>;
|
|
26
36
|
}>;
|
|
27
37
|
export interface FilterObject extends Schema.Schema.Type<typeof FilterObject_> {
|
|
28
38
|
}
|
|
@@ -112,7 +122,7 @@ export declare const FilterTextSearch: Schema.Schema<FilterTextSearch>;
|
|
|
112
122
|
*/
|
|
113
123
|
declare const FilterNot_: Schema.Struct<{
|
|
114
124
|
type: Schema.Literal<["not"]>;
|
|
115
|
-
filter: Schema.suspend<
|
|
125
|
+
filter: Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>;
|
|
116
126
|
}>;
|
|
117
127
|
export interface FilterNot extends Schema.Schema.Type<typeof FilterNot_> {
|
|
118
128
|
}
|
|
@@ -122,7 +132,7 @@ export declare const FilterNot: Schema.Schema<FilterNot>;
|
|
|
122
132
|
*/
|
|
123
133
|
declare const FilterAnd_: Schema.Struct<{
|
|
124
134
|
type: Schema.Literal<["and"]>;
|
|
125
|
-
filters: Schema.Array$<Schema.suspend<
|
|
135
|
+
filters: Schema.Array$<Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>>;
|
|
126
136
|
}>;
|
|
127
137
|
export interface FilterAnd extends Schema.Schema.Type<typeof FilterAnd_> {
|
|
128
138
|
}
|
|
@@ -132,7 +142,7 @@ export declare const FilterAnd: Schema.Schema<FilterAnd>;
|
|
|
132
142
|
*/
|
|
133
143
|
declare const FilterOr_: Schema.Struct<{
|
|
134
144
|
type: Schema.Literal<["or"]>;
|
|
135
|
-
filters: Schema.Array$<Schema.suspend<
|
|
145
|
+
filters: Schema.Array$<Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>>;
|
|
136
146
|
}>;
|
|
137
147
|
export interface FilterOr extends Schema.Schema.Type<typeof FilterOr_> {
|
|
138
148
|
}
|
|
@@ -144,7 +154,7 @@ export declare const FilterOr: Schema.Schema<FilterOr>;
|
|
|
144
154
|
declare const FilterChildOf_: Schema.Struct<{
|
|
145
155
|
type: Schema.Literal<["child-of"]>;
|
|
146
156
|
/** Parent DXNs to match children of. */
|
|
147
|
-
parents: Schema.Array$<Schema.
|
|
157
|
+
parents: Schema.Array$<Schema.Schema<EID.EID, EID.EID, never>>;
|
|
148
158
|
/** Whether to match transitively (grandchildren, etc.). Defaults to true. */
|
|
149
159
|
transitive: typeof Schema.Boolean;
|
|
150
160
|
}>;
|
|
@@ -161,7 +171,7 @@ export type Filter = Schema.Schema.Type<typeof Filter>;
|
|
|
161
171
|
*/
|
|
162
172
|
declare const QuerySelectClause_: Schema.Struct<{
|
|
163
173
|
type: Schema.Literal<["select"]>;
|
|
164
|
-
filter: Schema.suspend<
|
|
174
|
+
filter: Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>;
|
|
165
175
|
}>;
|
|
166
176
|
export interface QuerySelectClause extends Schema.Schema.Type<typeof QuerySelectClause_> {
|
|
167
177
|
}
|
|
@@ -171,8 +181,8 @@ export declare const QuerySelectClause: Schema.Schema<QuerySelectClause>;
|
|
|
171
181
|
*/
|
|
172
182
|
declare const QueryFilterClause_: Schema.Struct<{
|
|
173
183
|
type: Schema.Literal<["filter"]>;
|
|
174
|
-
selection: Schema.suspend<
|
|
175
|
-
filter: Schema.suspend<
|
|
184
|
+
selection: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
185
|
+
filter: Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>;
|
|
176
186
|
}>;
|
|
177
187
|
export interface QueryFilterClause extends Schema.Schema.Type<typeof QueryFilterClause_> {
|
|
178
188
|
}
|
|
@@ -182,7 +192,7 @@ export declare const QueryFilterClause: Schema.Schema<QueryFilterClause>;
|
|
|
182
192
|
*/
|
|
183
193
|
declare const QueryReferenceTraversalClause_: Schema.Struct<{
|
|
184
194
|
type: Schema.Literal<["reference-traversal"]>;
|
|
185
|
-
anchor: Schema.suspend<
|
|
195
|
+
anchor: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
186
196
|
property: typeof Schema.String;
|
|
187
197
|
}>;
|
|
188
198
|
export interface QueryReferenceTraversalClause extends Schema.Schema.Type<typeof QueryReferenceTraversalClause_> {
|
|
@@ -193,13 +203,13 @@ export declare const QueryReferenceTraversalClause: Schema.Schema<QueryReference
|
|
|
193
203
|
*/
|
|
194
204
|
declare const QueryIncomingReferencesClause_: Schema.Struct<{
|
|
195
205
|
type: Schema.Literal<["incoming-references"]>;
|
|
196
|
-
anchor: Schema.suspend<
|
|
206
|
+
anchor: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
197
207
|
/**
|
|
198
208
|
* Property path where the reference is located.
|
|
199
209
|
* If null, matches references from any property.
|
|
200
210
|
*/
|
|
201
211
|
property: Schema.NullOr<typeof Schema.String>;
|
|
202
|
-
typename: Schema.Union<[Schema.
|
|
212
|
+
typename: Schema.Union<[Schema.Schema<URI.URI, URI.URI, never>, typeof Schema.Null]>;
|
|
203
213
|
}>;
|
|
204
214
|
export interface QueryIncomingReferencesClause extends Schema.Schema.Type<typeof QueryIncomingReferencesClause_> {
|
|
205
215
|
}
|
|
@@ -209,14 +219,14 @@ export declare const QueryIncomingReferencesClause: Schema.Schema<QueryIncomingR
|
|
|
209
219
|
*/
|
|
210
220
|
declare const QueryRelationClause_: Schema.Struct<{
|
|
211
221
|
type: Schema.Literal<["relation"]>;
|
|
212
|
-
anchor: Schema.suspend<
|
|
222
|
+
anchor: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
213
223
|
/**
|
|
214
224
|
* outgoing: anchor is the source of the relation.
|
|
215
225
|
* incoming: anchor is the target of the relation.
|
|
216
226
|
* both: anchor is either the source or target of the relation.
|
|
217
227
|
*/
|
|
218
228
|
direction: Schema.Literal<["outgoing", "incoming", "both"]>;
|
|
219
|
-
filter: Schema.optional<Schema.suspend<
|
|
229
|
+
filter: Schema.optional<Schema.suspend<FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, FilterAnd | FilterChildOf | FilterCompare | FilterContains | FilterIn | FilterNot | FilterObject | FilterOr | FilterRange | FilterTag | FilterTextSearch | FilterTimestamp, never>>;
|
|
220
230
|
}>;
|
|
221
231
|
export interface QueryRelationClause extends Schema.Schema.Type<typeof QueryRelationClause_> {
|
|
222
232
|
}
|
|
@@ -226,7 +236,7 @@ export declare const QueryRelationClause: Schema.Schema<QueryRelationClause>;
|
|
|
226
236
|
*/
|
|
227
237
|
declare const QueryRelationTraversalClause_: Schema.Struct<{
|
|
228
238
|
type: Schema.Literal<["relation-traversal"]>;
|
|
229
|
-
anchor: Schema.suspend<
|
|
239
|
+
anchor: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
230
240
|
direction: Schema.Literal<["source", "target", "both"]>;
|
|
231
241
|
}>;
|
|
232
242
|
export interface QueryRelationTraversalClause extends Schema.Schema.Type<typeof QueryRelationTraversalClause_> {
|
|
@@ -237,7 +247,7 @@ export declare const QueryRelationTraversalClause: Schema.Schema<QueryRelationTr
|
|
|
237
247
|
*/
|
|
238
248
|
declare const QueryHierarchyTraversalClause_: Schema.Struct<{
|
|
239
249
|
type: Schema.Literal<["hierarchy-traversal"]>;
|
|
240
|
-
anchor: Schema.suspend<
|
|
250
|
+
anchor: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
241
251
|
/**
|
|
242
252
|
* to-parent: traverse from child to parent.
|
|
243
253
|
* to-children: traverse from parent to children.
|
|
@@ -252,7 +262,7 @@ export declare const QueryHierarchyTraversalClause: Schema.Schema<QueryHierarchy
|
|
|
252
262
|
*/
|
|
253
263
|
declare const QueryUnionClause_: Schema.Struct<{
|
|
254
264
|
type: Schema.Literal<["union"]>;
|
|
255
|
-
queries: Schema.Array$<Schema.suspend<
|
|
265
|
+
queries: Schema.Array$<Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>>;
|
|
256
266
|
}>;
|
|
257
267
|
export interface QueryUnionClause extends Schema.Schema.Type<typeof QueryUnionClause_> {
|
|
258
268
|
}
|
|
@@ -262,8 +272,8 @@ export declare const QueryUnionClause: Schema.Schema<QueryUnionClause>;
|
|
|
262
272
|
*/
|
|
263
273
|
declare const QuerySetDifferenceClause_: Schema.Struct<{
|
|
264
274
|
type: Schema.Literal<["set-difference"]>;
|
|
265
|
-
source: Schema.suspend<
|
|
266
|
-
exclude: Schema.suspend<
|
|
275
|
+
source: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
276
|
+
exclude: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
267
277
|
}>;
|
|
268
278
|
export interface QuerySetDifferenceClause extends Schema.Schema.Type<typeof QuerySetDifferenceClause_> {
|
|
269
279
|
}
|
|
@@ -279,6 +289,10 @@ declare const Order_: Schema.Union<[Schema.Struct<{
|
|
|
279
289
|
}>, Schema.Struct<{
|
|
280
290
|
kind: Schema.Literal<["rank"]>;
|
|
281
291
|
direction: Schema.Literal<["asc", "desc"]>;
|
|
292
|
+
}>, Schema.Struct<{
|
|
293
|
+
kind: Schema.Literal<["timestamp"]>;
|
|
294
|
+
field: Schema.Literal<["createdAt", "updatedAt"]>;
|
|
295
|
+
direction: Schema.Literal<["asc", "desc"]>;
|
|
282
296
|
}>]>;
|
|
283
297
|
export type Order = Schema.Schema.Type<typeof Order_>;
|
|
284
298
|
export declare const Order: Schema.Schema<Order>;
|
|
@@ -288,7 +302,7 @@ export declare const Order: Schema.Schema<Order>;
|
|
|
288
302
|
*/
|
|
289
303
|
declare const QueryOrderClause_: Schema.Struct<{
|
|
290
304
|
type: Schema.Literal<["order"]>;
|
|
291
|
-
query: Schema.suspend<
|
|
305
|
+
query: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
292
306
|
order: Schema.Array$<Schema.Schema<{
|
|
293
307
|
readonly kind: "natural";
|
|
294
308
|
} | {
|
|
@@ -298,6 +312,10 @@ declare const QueryOrderClause_: Schema.Struct<{
|
|
|
298
312
|
} | {
|
|
299
313
|
readonly kind: "rank";
|
|
300
314
|
readonly direction: "asc" | "desc";
|
|
315
|
+
} | {
|
|
316
|
+
readonly kind: "timestamp";
|
|
317
|
+
readonly field: "createdAt" | "updatedAt";
|
|
318
|
+
readonly direction: "asc" | "desc";
|
|
301
319
|
}, {
|
|
302
320
|
readonly kind: "natural";
|
|
303
321
|
} | {
|
|
@@ -307,6 +325,10 @@ declare const QueryOrderClause_: Schema.Struct<{
|
|
|
307
325
|
} | {
|
|
308
326
|
readonly kind: "rank";
|
|
309
327
|
readonly direction: "asc" | "desc";
|
|
328
|
+
} | {
|
|
329
|
+
readonly kind: "timestamp";
|
|
330
|
+
readonly field: "createdAt" | "updatedAt";
|
|
331
|
+
readonly direction: "asc" | "desc";
|
|
310
332
|
}, never>>;
|
|
311
333
|
}>;
|
|
312
334
|
export interface QueryOrderClause extends Schema.Schema.Type<typeof QueryOrderClause_> {
|
|
@@ -317,11 +339,13 @@ export declare const QueryOrderClause: Schema.Schema<QueryOrderClause>;
|
|
|
317
339
|
*/
|
|
318
340
|
declare const QueryOptionsClause_: Schema.Struct<{
|
|
319
341
|
type: Schema.Literal<["options"]>;
|
|
320
|
-
query: Schema.suspend<
|
|
342
|
+
query: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
321
343
|
options: Schema.suspend<{
|
|
322
|
-
readonly deleted?: "
|
|
344
|
+
readonly deleted?: "exclude" | "include" | "only" | undefined;
|
|
345
|
+
readonly debugLabel?: string | undefined;
|
|
323
346
|
}, {
|
|
324
|
-
readonly
|
|
347
|
+
readonly debugLabel?: string | undefined;
|
|
348
|
+
readonly deleted?: "exclude" | "include" | "only" | undefined;
|
|
325
349
|
}, never>;
|
|
326
350
|
}>;
|
|
327
351
|
export interface QueryOptionsClause extends Schema.Schema.Type<typeof QueryOptionsClause_> {
|
|
@@ -332,7 +356,7 @@ export declare const QueryOptionsClause: Schema.Schema<QueryOptionsClause>;
|
|
|
332
356
|
*/
|
|
333
357
|
declare const QueryLimitClause_: Schema.Struct<{
|
|
334
358
|
type: Schema.Literal<["limit"]>;
|
|
335
|
-
query: Schema.suspend<
|
|
359
|
+
query: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
336
360
|
limit: typeof Schema.Number;
|
|
337
361
|
}>;
|
|
338
362
|
export interface QueryLimitClause extends Schema.Schema.Type<typeof QueryLimitClause_> {
|
|
@@ -340,19 +364,31 @@ export interface QueryLimitClause extends Schema.Schema.Type<typeof QueryLimitCl
|
|
|
340
364
|
export declare const QueryLimitClause: Schema.Schema<QueryLimitClause>;
|
|
341
365
|
export declare const QueryFromClause_: Schema.Struct<{
|
|
342
366
|
type: Schema.Literal<["from"]>;
|
|
343
|
-
query: Schema.suspend<
|
|
367
|
+
query: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
344
368
|
from: Schema.Union<[Schema.TaggedStruct<"scope", {
|
|
345
|
-
|
|
346
|
-
readonly
|
|
347
|
-
readonly
|
|
348
|
-
readonly
|
|
369
|
+
scopes: Schema.Array$<Schema.suspend<{
|
|
370
|
+
readonly _tag: "space";
|
|
371
|
+
readonly spaceId?: string | undefined;
|
|
372
|
+
readonly includeAllFeeds?: boolean | undefined;
|
|
373
|
+
} | {
|
|
374
|
+
readonly _tag: "feed";
|
|
375
|
+
readonly feedUri: string;
|
|
376
|
+
} | {
|
|
377
|
+
readonly _tag: "registry";
|
|
378
|
+
readonly location: "local" | "remote";
|
|
349
379
|
}, {
|
|
350
|
-
readonly
|
|
351
|
-
readonly
|
|
352
|
-
readonly
|
|
353
|
-
}
|
|
380
|
+
readonly _tag: "space";
|
|
381
|
+
readonly includeAllFeeds?: boolean | undefined;
|
|
382
|
+
readonly spaceId?: string | undefined;
|
|
383
|
+
} | {
|
|
384
|
+
readonly _tag: "feed";
|
|
385
|
+
readonly feedUri: string;
|
|
386
|
+
} | {
|
|
387
|
+
readonly _tag: "registry";
|
|
388
|
+
readonly location: "local" | "remote";
|
|
389
|
+
}, never>>;
|
|
354
390
|
}>, Schema.TaggedStruct<"query", {
|
|
355
|
-
query: Schema.suspend<
|
|
391
|
+
query: Schema.suspend<QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, QueryFilterClause | QueryFromClause | QueryHierarchyTraversalClause | QueryIncomingReferencesClause | QueryLimitClause | QueryOptionsClause | QueryOrderClause | QueryReferenceTraversalClause | QueryRelationClause | QueryRelationTraversalClause | QuerySelectClause | QuerySetDifferenceClause | QueryUnionClause, never>;
|
|
356
392
|
}>]>;
|
|
357
393
|
}>;
|
|
358
394
|
export interface QueryFromClause extends Schema.Schema.Type<typeof QueryFromClause_> {
|
|
@@ -366,32 +402,60 @@ export declare const QueryOptions: Schema.Struct<{
|
|
|
366
402
|
* Nested select statements will use this option to filter deleted objects.
|
|
367
403
|
*/
|
|
368
404
|
deleted: Schema.optional<Schema.Literal<["include", "exclude", "only"]>>;
|
|
405
|
+
/**
|
|
406
|
+
* Diagnostics-only label for logs / tooling (not used by execution semantics).
|
|
407
|
+
*/
|
|
408
|
+
debugLabel: Schema.optional<typeof Schema.String>;
|
|
369
409
|
}>;
|
|
370
410
|
export interface QueryOptions extends Schema.Schema.Type<typeof QueryOptions> {
|
|
371
411
|
}
|
|
372
412
|
/**
|
|
373
|
-
*
|
|
413
|
+
* Selects from a space (automerge documents).
|
|
414
|
+
* When `spaceId` is omitted, targets the owning space — i.e. the space of whichever
|
|
415
|
+
* database executes the query. This lets callers reference "this space" without
|
|
416
|
+
* having to look up its id.
|
|
417
|
+
* When `includeAllFeeds` is true, also selects from all feeds belonging to that space.
|
|
374
418
|
*/
|
|
375
|
-
export declare const
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
*
|
|
379
|
-
* NOTE: Spaces and queues are unioned together if both are specified.
|
|
380
|
-
*/
|
|
381
|
-
spaceIds: Schema.optional<Schema.Array$<typeof Schema.String>>;
|
|
382
|
-
/**
|
|
383
|
-
* If true, the nested select statements will select from all queues in the spaces specified by `spaceIds`.
|
|
384
|
-
*/
|
|
385
|
-
allQueuesFromSpaces: Schema.optional<typeof Schema.Boolean>;
|
|
386
|
-
/**
|
|
387
|
-
* The nested select statemets will select from the given queues.
|
|
388
|
-
*
|
|
389
|
-
* NOTE: Spaces and queues are unioned together if both are specified.
|
|
390
|
-
*/
|
|
391
|
-
queues: Schema.optional<Schema.Array$<Schema.refine<string, typeof Schema.NonEmptyString>>>;
|
|
419
|
+
export declare const SpaceScope: Schema.TaggedStruct<"space", {
|
|
420
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
421
|
+
includeAllFeeds: Schema.optional<typeof Schema.Boolean>;
|
|
392
422
|
}>;
|
|
393
|
-
export interface
|
|
423
|
+
export interface SpaceScope extends Schema.Schema.Type<typeof SpaceScope> {
|
|
394
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* Selects from a specific feed (by its underlying queue DXN).
|
|
427
|
+
*/
|
|
428
|
+
export declare const FeedScope: Schema.TaggedStruct<"feed", {
|
|
429
|
+
feedUri: typeof Schema.String;
|
|
430
|
+
}>;
|
|
431
|
+
export interface FeedScope extends Schema.Schema.Type<typeof FeedScope> {
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* Selects from a code-shipped object registry.
|
|
435
|
+
*
|
|
436
|
+
* - `'local'` — the in-process registry attached to the hypergraph.
|
|
437
|
+
* - `'remote'` — a future remote registry service (not yet implemented).
|
|
438
|
+
*
|
|
439
|
+
* To include both, add two separate `RegistryScope` entries to the `scopes` array.
|
|
440
|
+
*/
|
|
441
|
+
export declare const RegistryScope: Schema.TaggedStruct<"registry", {
|
|
442
|
+
location: Schema.Literal<["local", "remote"]>;
|
|
443
|
+
}>;
|
|
444
|
+
export interface RegistryScope extends Schema.Schema.Type<typeof RegistryScope> {
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* Specifies the scope of the data to query from.
|
|
448
|
+
* A `from` clause may carry multiple scopes; results are unioned across them.
|
|
449
|
+
*/
|
|
450
|
+
export declare const Scope: Schema.Union<[Schema.TaggedStruct<"space", {
|
|
451
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
452
|
+
includeAllFeeds: Schema.optional<typeof Schema.Boolean>;
|
|
453
|
+
}>, Schema.TaggedStruct<"feed", {
|
|
454
|
+
feedUri: typeof Schema.String;
|
|
455
|
+
}>, Schema.TaggedStruct<"registry", {
|
|
456
|
+
location: Schema.Literal<["local", "remote"]>;
|
|
457
|
+
}>]>;
|
|
458
|
+
export type Scope = Schema.Schema.Type<typeof Scope>;
|
|
395
459
|
export declare const visit: (query: Query, visitor: (node: Query) => void) => void;
|
|
396
460
|
/**
|
|
397
461
|
* Recursively transforms a query tree bottom-up.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../../../../src/query/ast.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../../../../src/query/ast.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,GAAG,EAAY,GAAG,EAAE,MAAM,YAAY,CAAC;AAWhD;;;;GAIG;AAEH,QAAA,MAAM,aAAa;;;;IAOjB;;;OAGG;;IAMH;;OAEG;;;;;;;;IAGH;;OAEG;;IAGH;;;OAGG;;EAIH,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC;CAAG;AACjF,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAiB,CAAC;AAEvE;;GAEG;AACH,QAAA,MAAM,cAAc;;;;EAIlB,CAAC;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC;CAAG;AACnF,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAkB,CAAC;AAE1E;;GAEG;AACH,QAAA,MAAM,SAAS;;;EAGb,CAAC;AACH,MAAM,WAAW,QAAS,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,SAAS,CAAC;CAAG;AACzE,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAa,CAAC;AAE3D;;GAEG;AACH,QAAA,MAAM,eAAe;;;EAGnB,CAAC;AAEH,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC;CAAG;AAErF;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAmB,CAAC;AAE7E;;GAEG;AACH,QAAA,MAAM,UAAU;;;EAGd,CAAC;AAEH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAC3E,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAc,CAAC;AAE9D;;GAEG;AACH,QAAA,MAAM,YAAY;;;;EAIhB,CAAC;AAEH,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC;CAAG;AAC/E,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAgB,CAAC;AAEpE;;;GAGG;AACH,QAAA,MAAM,gBAAgB;;;;;EAKpB,CAAC;AAEH,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC;CAAG;AACvF,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAoB,CAAC;AAEhF;;GAEG;AACH,QAAA,MAAM,iBAAiB;;;;EAIrB,CAAC;AAEH,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC;CAAG;AACzF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAqB,CAAC;AAEnF;;GAEG;AACH,QAAA,MAAM,UAAU;;;EAGd,CAAC;AAEH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAC3E,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAc,CAAC;AAE9D;;GAEG;AACH,QAAA,MAAM,UAAU;;;EAGd,CAAC;AAEH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAC3E,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAc,CAAC;AAE9D;;GAEG;AACH,QAAA,MAAM,SAAS;;;EAGb,CAAC;AAEH,MAAM,WAAW,QAAS,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,SAAS,CAAC;CAAG;AACzE,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAa,CAAC;AAE3D;;;GAGG;AACH,QAAA,MAAM,cAAc;;IAElB,wCAAwC;;IAExC,6EAA6E;;EAE7E,CAAC;AAEH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC;CAAG;AACnF,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAkB,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,MAAM,0lBAaoC,CAAC;AAExD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC;AAEvD;;GAEG;AACH,QAAA,MAAM,kBAAkB;;;EAGtB,CAAC;AAEH,MAAM,WAAW,iBAAkB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC;CAAG;AAC3F,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAsB,CAAC;AAEtF;;GAEG;AACH,QAAA,MAAM,kBAAkB;;;;EAItB,CAAC;AAEH,MAAM,WAAW,iBAAkB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC;CAAG;AAC3F,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAsB,CAAC;AAEtF;;GAEG;AACH,QAAA,MAAM,8BAA8B;;;;EAIlC,CAAC;AAEH,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,8BAA8B,CAAC;CAAG;AACnH,eAAO,MAAM,6BAA6B,EAAE,MAAM,CAAC,MAAM,CAAC,6BAA6B,CACvD,CAAC;AAEjC;;GAEG;AACH,QAAA,MAAM,8BAA8B;;;IAGlC;;;OAGG;;;EAGH,CAAC;AAEH,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,8BAA8B,CAAC;CAAG;AACnH,eAAO,MAAM,6BAA6B,EAAE,MAAM,CAAC,MAAM,CAAC,6BAA6B,CACvD,CAAC;AAEjC;;GAEG;AACH,QAAA,MAAM,oBAAoB;;;IAGxB;;;;OAIG;;;EAGH,CAAC;AAEH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC;CAAG;AAC/F,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAwB,CAAC;AAE5F;;GAEG;AACH,QAAA,MAAM,6BAA6B;;;;EAIjC,CAAC;AAEH,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,6BAA6B,CAAC;CAAG;AACjH,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAAC,MAAM,CAAC,4BAA4B,CAAiC,CAAC;AAEvH;;GAEG;AACH,QAAA,MAAM,8BAA8B;;;IAGlC;;;OAGG;;EAEH,CAAC;AAEH,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,8BAA8B,CAAC;CAAG;AACnH,eAAO,MAAM,6BAA6B,EAAE,MAAM,CAAC,MAAM,CAAC,6BAA6B,CACvD,CAAC;AAEjC;;GAEG;AACH,QAAA,MAAM,iBAAiB;;;EAGrB,CAAC;AAEH,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC;CAAG;AACzF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAqB,CAAC;AAEnF;;GAEG;AACH,QAAA,MAAM,yBAAyB;;;;EAI7B,CAAC;AAEH,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,yBAAyB,CAAC;CAAG;AACzG,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAA6B,CAAC;AAE3G,eAAO,MAAM,cAAc,iCAAgC,CAAC;AAC5D,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC,CAAC;AAEvE,QAAA,MAAM,MAAM;;;;;;;;;;;;;IAsBX,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC;AACtD,eAAO,MAAM,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAU,CAAC;AAElD;;;GAGG;AACH,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIrB,CAAC;AAEH,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC;CAAG;AACzF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAqB,CAAC;AAEnF;;GAEG;AACH,QAAA,MAAM,mBAAmB;;;;;;;;;;EAIvB,CAAC;AAEH,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC;CAAG;AAC7F,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAuB,CAAC;AAEzF;;GAEG;AACH,QAAA,MAAM,iBAAiB;;;;EAIrB,CAAC;AAEH,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC;CAAG;AACzF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAqB,CAAC;AAEnF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW3B,CAAC;AACH,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC;CAAG;AACvF,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAoB,CAAC;AAEhF,QAAA,MAAM,MAAM,o4BAc0C,CAAC;AAEvD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC;AACtD,eAAO,MAAM,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAU,CAAC;AAElD,eAAO,MAAM,YAAY;IACvB;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AAEH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC;CAAG;AAEhF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;;;EAGrB,CAAC;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAE5E;;GAEG;AACH,eAAO,MAAM,SAAS;;EAEpB,CAAC;AACH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,SAAS,CAAC;CAAG;AAE1E;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;EAExB,CAAC;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC;CAAG;AAElF;;;GAGG;AACH,eAAO,MAAM,KAAK;;;;;;;IAAqD,CAAC;AACxE,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC;AAErD,eAAO,MAAM,KAAK,UAAW,KAAK,WAAW,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,SA2BjE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,GAAG,UAAW,KAAK,UAAU,CAAC,IAAI,EAAE,KAAK,KAAK,KAAK,KAAG,KA0BlE,CAAC;AAEF,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,KAAK,WAAW,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC,KAAG,CAAC,EA0BpE,CAAC"}
|
|
@@ -1,76 +1,22 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { type ObjectId } from '@dxos/protocols';
|
|
3
|
-
import { type Reference as ReferenceProto } from '@dxos/protocols/proto/dxos/echo/model/document';
|
|
4
|
-
/**
|
|
5
|
-
* Runtime representation of an reference in ECHO.
|
|
6
|
-
* Implemented as a DXN, but we might extend it to other URIs in the future.
|
|
7
|
-
* @deprecated Use `EncodedReference` instead.
|
|
8
|
-
*/
|
|
9
|
-
export declare class Reference {
|
|
10
|
-
private readonly _objectId;
|
|
11
|
-
private readonly _protocol?;
|
|
12
|
-
private readonly _host?;
|
|
13
|
-
private readonly _dxn?;
|
|
14
|
-
/**
|
|
15
|
-
* Protocol references to runtime registered types.
|
|
16
|
-
* @deprecated
|
|
17
|
-
*/
|
|
18
|
-
static TYPE_PROTOCOL: string;
|
|
19
|
-
static fromDXN(dxn: DXN): Reference;
|
|
20
|
-
static fromValue(value: ReferenceProto): Reference;
|
|
21
|
-
/**
|
|
22
|
-
* Reference an object in the local space.
|
|
23
|
-
*/
|
|
24
|
-
static localObjectReference(objectId: ObjectId): Reference;
|
|
25
|
-
/**
|
|
26
|
-
* @deprecated
|
|
27
|
-
*/
|
|
28
|
-
static fromLegacyTypename(type: string): Reference;
|
|
29
|
-
/**
|
|
30
|
-
* @deprecated
|
|
31
|
-
*/
|
|
32
|
-
static fromObjectIdAndSpaceKey(objectId: ObjectId, spaceKey: PublicKey): Reference;
|
|
33
|
-
private constructor();
|
|
34
|
-
get dxn(): DXN | undefined;
|
|
35
|
-
/**
|
|
36
|
-
* @deprecated
|
|
37
|
-
*/
|
|
38
|
-
get objectId(): ObjectId;
|
|
39
|
-
/**
|
|
40
|
-
* @deprecated
|
|
41
|
-
*/
|
|
42
|
-
get protocol(): string | undefined;
|
|
43
|
-
/**
|
|
44
|
-
* @deprecated
|
|
45
|
-
*/
|
|
46
|
-
get host(): string | undefined;
|
|
47
|
-
encode(): ReferenceProto;
|
|
48
|
-
toDXN(): DXN;
|
|
49
|
-
}
|
|
1
|
+
import { URI } from '@dxos/keys';
|
|
50
2
|
export declare const REFERENCE_TYPE_TAG = "dxos.echo.model.document.Reference";
|
|
51
3
|
/**
|
|
52
4
|
* Reference as it is stored in Automerge document.
|
|
53
5
|
*/
|
|
54
6
|
export type EncodedReference = {
|
|
55
|
-
'/':
|
|
7
|
+
'/': URI.URI;
|
|
56
8
|
};
|
|
57
|
-
/**
|
|
58
|
-
* @deprecated Use `EncodedReference.fromDXN` instead.
|
|
59
|
-
*/
|
|
60
|
-
export declare const encodeReference: (reference: Reference) => EncodedReference;
|
|
61
|
-
/**
|
|
62
|
-
* @deprecated Use `EncodedReference.toDXN` instead.
|
|
63
|
-
*/
|
|
64
|
-
export declare const decodeReference: (value: any) => Reference;
|
|
65
|
-
/**
|
|
66
|
-
* @deprecated Use `EncodedReference.isEncodedReference` instead.
|
|
67
|
-
*/
|
|
68
9
|
export declare const isEncodedReference: (value: any) => value is EncodedReference;
|
|
69
10
|
export declare const EncodedReference: Readonly<{
|
|
70
11
|
isEncodedReference: (value: any) => value is EncodedReference;
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
12
|
+
/**
|
|
13
|
+
* Returns the opaque URI stored in the encoded reference (any scheme: `echo:` or `dxn:`).
|
|
14
|
+
* Consumers can narrow with `EID.isEID(uri)` / `DXN.isDXN(uri)`.
|
|
15
|
+
*/
|
|
16
|
+
toURI: (value: EncodedReference) => URI.URI;
|
|
17
|
+
/**
|
|
18
|
+
* Creates an encoded reference from an opaque URI.
|
|
19
|
+
*/
|
|
20
|
+
fromURI: (uri: URI.URI) => EncodedReference;
|
|
75
21
|
}>;
|
|
76
22
|
//# sourceMappingURL=reference.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,
|
|
1
|
+
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAGjC,eAAO,MAAM,kBAAkB,uCAAuC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC;CACd,CAAC;AAEF,eAAO,MAAM,kBAAkB,UAAW,GAAG,KAAG,KAAK,IAAI,gBACyD,CAAC;AAEnH,eAAO,MAAM,gBAAgB;gCAHa,GAAG,KAAG,KAAK,IAAI,gBAAgB;IAKvE;;;OAGG;mBACY,gBAAgB,KAAG,GAAG,CAAC,GAAG;IAIzC;;OAEG;mBACY,GAAG,CAAC,GAAG,KAAG,gBAAgB;EAGzC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"space-id.d.ts","sourceRoot":"","sources":["../../../src/space-id.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKhD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,
|
|
1
|
+
{"version":3,"file":"space-id.d.ts","sourceRoot":"","sources":["../../../src/space-id.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKhD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,aAAoB,SAAS,KAAG,OAAO,CAAC,OAAO,CAY/E,CAAC"}
|