@dxos/echo-protocol 0.8.4-main.40e3dcdf1b → 0.8.4-main.43cb759274
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 +87 -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 +69 -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 +133 -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 +81 -37
- package/src/edge-peer.ts +27 -0
- package/src/index.ts +1 -0
- package/src/query/ast.ts +89 -25
- 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
|
}
|
|
@@ -83,6 +93,19 @@ declare const FilterRange_: Schema.Struct<{
|
|
|
83
93
|
export interface FilterRange extends Schema.Schema.Type<typeof FilterRange_> {
|
|
84
94
|
}
|
|
85
95
|
export declare const FilterRange: Schema.Schema<FilterRange>;
|
|
96
|
+
/**
|
|
97
|
+
* Filter by system timestamp (createdAt / updatedAt).
|
|
98
|
+
* Timestamps are unix milliseconds stored in the object meta index.
|
|
99
|
+
*/
|
|
100
|
+
declare const FilterTimestamp_: Schema.Struct<{
|
|
101
|
+
type: Schema.Literal<["timestamp"]>;
|
|
102
|
+
field: Schema.Literal<["createdAt", "updatedAt"]>;
|
|
103
|
+
operator: Schema.Literal<["gt", "gte", "lt", "lte"]>;
|
|
104
|
+
value: typeof Schema.Number;
|
|
105
|
+
}>;
|
|
106
|
+
export interface FilterTimestamp extends Schema.Schema.Type<typeof FilterTimestamp_> {
|
|
107
|
+
}
|
|
108
|
+
export declare const FilterTimestamp: Schema.Schema<FilterTimestamp>;
|
|
86
109
|
/**
|
|
87
110
|
* Text search.
|
|
88
111
|
*/
|
|
@@ -99,7 +122,7 @@ export declare const FilterTextSearch: Schema.Schema<FilterTextSearch>;
|
|
|
99
122
|
*/
|
|
100
123
|
declare const FilterNot_: Schema.Struct<{
|
|
101
124
|
type: Schema.Literal<["not"]>;
|
|
102
|
-
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>;
|
|
103
126
|
}>;
|
|
104
127
|
export interface FilterNot extends Schema.Schema.Type<typeof FilterNot_> {
|
|
105
128
|
}
|
|
@@ -109,7 +132,7 @@ export declare const FilterNot: Schema.Schema<FilterNot>;
|
|
|
109
132
|
*/
|
|
110
133
|
declare const FilterAnd_: Schema.Struct<{
|
|
111
134
|
type: Schema.Literal<["and"]>;
|
|
112
|
-
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>>;
|
|
113
136
|
}>;
|
|
114
137
|
export interface FilterAnd extends Schema.Schema.Type<typeof FilterAnd_> {
|
|
115
138
|
}
|
|
@@ -119,22 +142,36 @@ export declare const FilterAnd: Schema.Schema<FilterAnd>;
|
|
|
119
142
|
*/
|
|
120
143
|
declare const FilterOr_: Schema.Struct<{
|
|
121
144
|
type: Schema.Literal<["or"]>;
|
|
122
|
-
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>>;
|
|
123
146
|
}>;
|
|
124
147
|
export interface FilterOr extends Schema.Schema.Type<typeof FilterOr_> {
|
|
125
148
|
}
|
|
126
149
|
export declare const FilterOr: Schema.Schema<FilterOr>;
|
|
150
|
+
/**
|
|
151
|
+
* Filter objects that are children of the specified parents.
|
|
152
|
+
* With transitive=true (default), matches grandchildren and beyond.
|
|
153
|
+
*/
|
|
154
|
+
declare const FilterChildOf_: Schema.Struct<{
|
|
155
|
+
type: Schema.Literal<["child-of"]>;
|
|
156
|
+
/** Parent DXNs to match children of. */
|
|
157
|
+
parents: Schema.Array$<Schema.Schema<EID.EID, EID.EID, never>>;
|
|
158
|
+
/** Whether to match transitively (grandchildren, etc.). Defaults to true. */
|
|
159
|
+
transitive: typeof Schema.Boolean;
|
|
160
|
+
}>;
|
|
161
|
+
export interface FilterChildOf extends Schema.Schema.Type<typeof FilterChildOf_> {
|
|
162
|
+
}
|
|
163
|
+
export declare const FilterChildOf: Schema.Schema<FilterChildOf>;
|
|
127
164
|
/**
|
|
128
165
|
* Union of filters.
|
|
129
166
|
*/
|
|
130
|
-
export declare const Filter: Schema.Union<[Schema.Schema<FilterObject, FilterObject, never>, Schema.Schema<FilterCompare, FilterCompare, never>, Schema.Schema<FilterIn, FilterIn, never>, Schema.Schema<FilterContains, FilterContains, never>, Schema.Schema<FilterTag, FilterTag, never>, Schema.Schema<FilterRange, FilterRange, never>, Schema.Schema<FilterTextSearch, FilterTextSearch, never>, Schema.Schema<FilterNot, FilterNot, never>, Schema.Schema<FilterAnd, FilterAnd, never>, Schema.Schema<FilterOr, FilterOr, never>]>;
|
|
167
|
+
export declare const Filter: Schema.Union<[Schema.Schema<FilterObject, FilterObject, never>, Schema.Schema<FilterCompare, FilterCompare, never>, Schema.Schema<FilterIn, FilterIn, never>, Schema.Schema<FilterContains, FilterContains, never>, Schema.Schema<FilterTag, FilterTag, never>, Schema.Schema<FilterRange, FilterRange, never>, Schema.Schema<FilterTimestamp, FilterTimestamp, never>, Schema.Schema<FilterTextSearch, FilterTextSearch, never>, Schema.Schema<FilterChildOf, FilterChildOf, never>, Schema.Schema<FilterNot, FilterNot, never>, Schema.Schema<FilterAnd, FilterAnd, never>, Schema.Schema<FilterOr, FilterOr, never>]>;
|
|
131
168
|
export type Filter = Schema.Schema.Type<typeof Filter>;
|
|
132
169
|
/**
|
|
133
170
|
* Query objects by type, id, and/or predicates.
|
|
134
171
|
*/
|
|
135
172
|
declare const QuerySelectClause_: Schema.Struct<{
|
|
136
173
|
type: Schema.Literal<["select"]>;
|
|
137
|
-
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>;
|
|
138
175
|
}>;
|
|
139
176
|
export interface QuerySelectClause extends Schema.Schema.Type<typeof QuerySelectClause_> {
|
|
140
177
|
}
|
|
@@ -144,8 +181,8 @@ export declare const QuerySelectClause: Schema.Schema<QuerySelectClause>;
|
|
|
144
181
|
*/
|
|
145
182
|
declare const QueryFilterClause_: Schema.Struct<{
|
|
146
183
|
type: Schema.Literal<["filter"]>;
|
|
147
|
-
selection: Schema.suspend<
|
|
148
|
-
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>;
|
|
149
186
|
}>;
|
|
150
187
|
export interface QueryFilterClause extends Schema.Schema.Type<typeof QueryFilterClause_> {
|
|
151
188
|
}
|
|
@@ -155,7 +192,7 @@ export declare const QueryFilterClause: Schema.Schema<QueryFilterClause>;
|
|
|
155
192
|
*/
|
|
156
193
|
declare const QueryReferenceTraversalClause_: Schema.Struct<{
|
|
157
194
|
type: Schema.Literal<["reference-traversal"]>;
|
|
158
|
-
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>;
|
|
159
196
|
property: typeof Schema.String;
|
|
160
197
|
}>;
|
|
161
198
|
export interface QueryReferenceTraversalClause extends Schema.Schema.Type<typeof QueryReferenceTraversalClause_> {
|
|
@@ -166,13 +203,13 @@ export declare const QueryReferenceTraversalClause: Schema.Schema<QueryReference
|
|
|
166
203
|
*/
|
|
167
204
|
declare const QueryIncomingReferencesClause_: Schema.Struct<{
|
|
168
205
|
type: Schema.Literal<["incoming-references"]>;
|
|
169
|
-
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>;
|
|
170
207
|
/**
|
|
171
208
|
* Property path where the reference is located.
|
|
172
209
|
* If null, matches references from any property.
|
|
173
210
|
*/
|
|
174
211
|
property: Schema.NullOr<typeof Schema.String>;
|
|
175
|
-
typename: Schema.Union<[Schema.
|
|
212
|
+
typename: Schema.Union<[Schema.Schema<URI.URI, URI.URI, never>, typeof Schema.Null]>;
|
|
176
213
|
}>;
|
|
177
214
|
export interface QueryIncomingReferencesClause extends Schema.Schema.Type<typeof QueryIncomingReferencesClause_> {
|
|
178
215
|
}
|
|
@@ -182,14 +219,14 @@ export declare const QueryIncomingReferencesClause: Schema.Schema<QueryIncomingR
|
|
|
182
219
|
*/
|
|
183
220
|
declare const QueryRelationClause_: Schema.Struct<{
|
|
184
221
|
type: Schema.Literal<["relation"]>;
|
|
185
|
-
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>;
|
|
186
223
|
/**
|
|
187
224
|
* outgoing: anchor is the source of the relation.
|
|
188
225
|
* incoming: anchor is the target of the relation.
|
|
189
226
|
* both: anchor is either the source or target of the relation.
|
|
190
227
|
*/
|
|
191
228
|
direction: Schema.Literal<["outgoing", "incoming", "both"]>;
|
|
192
|
-
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>>;
|
|
193
230
|
}>;
|
|
194
231
|
export interface QueryRelationClause extends Schema.Schema.Type<typeof QueryRelationClause_> {
|
|
195
232
|
}
|
|
@@ -199,7 +236,7 @@ export declare const QueryRelationClause: Schema.Schema<QueryRelationClause>;
|
|
|
199
236
|
*/
|
|
200
237
|
declare const QueryRelationTraversalClause_: Schema.Struct<{
|
|
201
238
|
type: Schema.Literal<["relation-traversal"]>;
|
|
202
|
-
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>;
|
|
203
240
|
direction: Schema.Literal<["source", "target", "both"]>;
|
|
204
241
|
}>;
|
|
205
242
|
export interface QueryRelationTraversalClause extends Schema.Schema.Type<typeof QueryRelationTraversalClause_> {
|
|
@@ -210,7 +247,7 @@ export declare const QueryRelationTraversalClause: Schema.Schema<QueryRelationTr
|
|
|
210
247
|
*/
|
|
211
248
|
declare const QueryHierarchyTraversalClause_: Schema.Struct<{
|
|
212
249
|
type: Schema.Literal<["hierarchy-traversal"]>;
|
|
213
|
-
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>;
|
|
214
251
|
/**
|
|
215
252
|
* to-parent: traverse from child to parent.
|
|
216
253
|
* to-children: traverse from parent to children.
|
|
@@ -225,7 +262,7 @@ export declare const QueryHierarchyTraversalClause: Schema.Schema<QueryHierarchy
|
|
|
225
262
|
*/
|
|
226
263
|
declare const QueryUnionClause_: Schema.Struct<{
|
|
227
264
|
type: Schema.Literal<["union"]>;
|
|
228
|
-
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>>;
|
|
229
266
|
}>;
|
|
230
267
|
export interface QueryUnionClause extends Schema.Schema.Type<typeof QueryUnionClause_> {
|
|
231
268
|
}
|
|
@@ -235,8 +272,8 @@ export declare const QueryUnionClause: Schema.Schema<QueryUnionClause>;
|
|
|
235
272
|
*/
|
|
236
273
|
declare const QuerySetDifferenceClause_: Schema.Struct<{
|
|
237
274
|
type: Schema.Literal<["set-difference"]>;
|
|
238
|
-
source: Schema.suspend<
|
|
239
|
-
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>;
|
|
240
277
|
}>;
|
|
241
278
|
export interface QuerySetDifferenceClause extends Schema.Schema.Type<typeof QuerySetDifferenceClause_> {
|
|
242
279
|
}
|
|
@@ -261,7 +298,7 @@ export declare const Order: Schema.Schema<Order>;
|
|
|
261
298
|
*/
|
|
262
299
|
declare const QueryOrderClause_: Schema.Struct<{
|
|
263
300
|
type: Schema.Literal<["order"]>;
|
|
264
|
-
query: Schema.suspend<
|
|
301
|
+
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>;
|
|
265
302
|
order: Schema.Array$<Schema.Schema<{
|
|
266
303
|
readonly kind: "natural";
|
|
267
304
|
} | {
|
|
@@ -290,11 +327,13 @@ export declare const QueryOrderClause: Schema.Schema<QueryOrderClause>;
|
|
|
290
327
|
*/
|
|
291
328
|
declare const QueryOptionsClause_: Schema.Struct<{
|
|
292
329
|
type: Schema.Literal<["options"]>;
|
|
293
|
-
query: Schema.suspend<
|
|
330
|
+
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>;
|
|
294
331
|
options: Schema.suspend<{
|
|
295
|
-
readonly deleted?: "
|
|
332
|
+
readonly deleted?: "exclude" | "include" | "only" | undefined;
|
|
333
|
+
readonly debugLabel?: string | undefined;
|
|
296
334
|
}, {
|
|
297
|
-
readonly
|
|
335
|
+
readonly debugLabel?: string | undefined;
|
|
336
|
+
readonly deleted?: "exclude" | "include" | "only" | undefined;
|
|
298
337
|
}, never>;
|
|
299
338
|
}>;
|
|
300
339
|
export interface QueryOptionsClause extends Schema.Schema.Type<typeof QueryOptionsClause_> {
|
|
@@ -305,7 +344,7 @@ export declare const QueryOptionsClause: Schema.Schema<QueryOptionsClause>;
|
|
|
305
344
|
*/
|
|
306
345
|
declare const QueryLimitClause_: Schema.Struct<{
|
|
307
346
|
type: Schema.Literal<["limit"]>;
|
|
308
|
-
query: Schema.suspend<
|
|
347
|
+
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>;
|
|
309
348
|
limit: typeof Schema.Number;
|
|
310
349
|
}>;
|
|
311
350
|
export interface QueryLimitClause extends Schema.Schema.Type<typeof QueryLimitClause_> {
|
|
@@ -313,19 +352,31 @@ export interface QueryLimitClause extends Schema.Schema.Type<typeof QueryLimitCl
|
|
|
313
352
|
export declare const QueryLimitClause: Schema.Schema<QueryLimitClause>;
|
|
314
353
|
export declare const QueryFromClause_: Schema.Struct<{
|
|
315
354
|
type: Schema.Literal<["from"]>;
|
|
316
|
-
query: Schema.suspend<
|
|
355
|
+
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>;
|
|
317
356
|
from: Schema.Union<[Schema.TaggedStruct<"scope", {
|
|
318
|
-
|
|
319
|
-
readonly
|
|
320
|
-
readonly
|
|
321
|
-
readonly
|
|
357
|
+
scopes: Schema.Array$<Schema.suspend<{
|
|
358
|
+
readonly _tag: "space";
|
|
359
|
+
readonly spaceId?: string | undefined;
|
|
360
|
+
readonly includeAllFeeds?: boolean | undefined;
|
|
361
|
+
} | {
|
|
362
|
+
readonly _tag: "feed";
|
|
363
|
+
readonly feedUri: string;
|
|
364
|
+
} | {
|
|
365
|
+
readonly _tag: "registry";
|
|
366
|
+
readonly location: "local" | "remote";
|
|
322
367
|
}, {
|
|
323
|
-
readonly
|
|
324
|
-
readonly
|
|
325
|
-
readonly
|
|
326
|
-
}
|
|
368
|
+
readonly _tag: "space";
|
|
369
|
+
readonly includeAllFeeds?: boolean | undefined;
|
|
370
|
+
readonly spaceId?: string | undefined;
|
|
371
|
+
} | {
|
|
372
|
+
readonly _tag: "feed";
|
|
373
|
+
readonly feedUri: string;
|
|
374
|
+
} | {
|
|
375
|
+
readonly _tag: "registry";
|
|
376
|
+
readonly location: "local" | "remote";
|
|
377
|
+
}, never>>;
|
|
327
378
|
}>, Schema.TaggedStruct<"query", {
|
|
328
|
-
query: Schema.suspend<
|
|
379
|
+
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>;
|
|
329
380
|
}>]>;
|
|
330
381
|
}>;
|
|
331
382
|
export interface QueryFromClause extends Schema.Schema.Type<typeof QueryFromClause_> {
|
|
@@ -339,32 +390,60 @@ export declare const QueryOptions: Schema.Struct<{
|
|
|
339
390
|
* Nested select statements will use this option to filter deleted objects.
|
|
340
391
|
*/
|
|
341
392
|
deleted: Schema.optional<Schema.Literal<["include", "exclude", "only"]>>;
|
|
393
|
+
/**
|
|
394
|
+
* Diagnostics-only label for logs / tooling (not used by execution semantics).
|
|
395
|
+
*/
|
|
396
|
+
debugLabel: Schema.optional<typeof Schema.String>;
|
|
342
397
|
}>;
|
|
343
398
|
export interface QueryOptions extends Schema.Schema.Type<typeof QueryOptions> {
|
|
344
399
|
}
|
|
345
400
|
/**
|
|
346
|
-
*
|
|
401
|
+
* Selects from a space (automerge documents).
|
|
402
|
+
* When `spaceId` is omitted, targets the owning space — i.e. the space of whichever
|
|
403
|
+
* database executes the query. This lets callers reference "this space" without
|
|
404
|
+
* having to look up its id.
|
|
405
|
+
* When `includeAllFeeds` is true, also selects from all feeds belonging to that space.
|
|
347
406
|
*/
|
|
348
|
-
export declare const
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
*
|
|
352
|
-
* NOTE: Spaces and queues are unioned together if both are specified.
|
|
353
|
-
*/
|
|
354
|
-
spaceIds: Schema.optional<Schema.Array$<typeof Schema.String>>;
|
|
355
|
-
/**
|
|
356
|
-
* If true, the nested select statements will select from all queues in the spaces specified by `spaceIds`.
|
|
357
|
-
*/
|
|
358
|
-
allQueuesFromSpaces: Schema.optional<typeof Schema.Boolean>;
|
|
359
|
-
/**
|
|
360
|
-
* The nested select statemets will select from the given queues.
|
|
361
|
-
*
|
|
362
|
-
* NOTE: Spaces and queues are unioned together if both are specified.
|
|
363
|
-
*/
|
|
364
|
-
queues: Schema.optional<Schema.Array$<Schema.refine<string, typeof Schema.NonEmptyString>>>;
|
|
407
|
+
export declare const SpaceScope: Schema.TaggedStruct<"space", {
|
|
408
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
409
|
+
includeAllFeeds: Schema.optional<typeof Schema.Boolean>;
|
|
365
410
|
}>;
|
|
366
|
-
export interface
|
|
411
|
+
export interface SpaceScope extends Schema.Schema.Type<typeof SpaceScope> {
|
|
367
412
|
}
|
|
413
|
+
/**
|
|
414
|
+
* Selects from a specific feed (by its underlying queue DXN).
|
|
415
|
+
*/
|
|
416
|
+
export declare const FeedScope: Schema.TaggedStruct<"feed", {
|
|
417
|
+
feedUri: typeof Schema.String;
|
|
418
|
+
}>;
|
|
419
|
+
export interface FeedScope extends Schema.Schema.Type<typeof FeedScope> {
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Selects from a code-shipped object registry.
|
|
423
|
+
*
|
|
424
|
+
* - `'local'` — the in-process registry attached to the hypergraph.
|
|
425
|
+
* - `'remote'` — a future remote registry service (not yet implemented).
|
|
426
|
+
*
|
|
427
|
+
* To include both, add two separate `RegistryScope` entries to the `scopes` array.
|
|
428
|
+
*/
|
|
429
|
+
export declare const RegistryScope: Schema.TaggedStruct<"registry", {
|
|
430
|
+
location: Schema.Literal<["local", "remote"]>;
|
|
431
|
+
}>;
|
|
432
|
+
export interface RegistryScope extends Schema.Schema.Type<typeof RegistryScope> {
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* Specifies the scope of the data to query from.
|
|
436
|
+
* A `from` clause may carry multiple scopes; results are unioned across them.
|
|
437
|
+
*/
|
|
438
|
+
export declare const Scope: Schema.Union<[Schema.TaggedStruct<"space", {
|
|
439
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
440
|
+
includeAllFeeds: Schema.optional<typeof Schema.Boolean>;
|
|
441
|
+
}>, Schema.TaggedStruct<"feed", {
|
|
442
|
+
feedUri: typeof Schema.String;
|
|
443
|
+
}>, Schema.TaggedStruct<"registry", {
|
|
444
|
+
location: Schema.Literal<["local", "remote"]>;
|
|
445
|
+
}>]>;
|
|
446
|
+
export type Scope = Schema.Schema.Type<typeof Scope>;
|
|
368
447
|
export declare const visit: (query: Query, visitor: (node: Query) => void) => void;
|
|
369
448
|
/**
|
|
370
449
|
* 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;;;;;;;;;IAgBX,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"}
|