@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
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import
|
|
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 { Schema } from 'effect';
|
|
|
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,10 +24,22 @@ 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
|
}
|
|
29
39
|
export declare const FilterObject: Schema.Schema<FilterObject>;
|
|
40
|
+
/**
|
|
41
|
+
* Compare.
|
|
42
|
+
*/
|
|
30
43
|
declare const FilterCompare_: Schema.Struct<{
|
|
31
44
|
type: Schema.Literal<["compare"]>;
|
|
32
45
|
operator: Schema.Literal<["eq", "neq", "gt", "gte", "lt", "lte"]>;
|
|
@@ -35,6 +48,9 @@ declare const FilterCompare_: Schema.Struct<{
|
|
|
35
48
|
export interface FilterCompare extends Schema.Schema.Type<typeof FilterCompare_> {
|
|
36
49
|
}
|
|
37
50
|
export declare const FilterCompare: Schema.Schema<FilterCompare>;
|
|
51
|
+
/**
|
|
52
|
+
* In.
|
|
53
|
+
*/
|
|
38
54
|
declare const FilterIn_: Schema.Struct<{
|
|
39
55
|
type: Schema.Literal<["in"]>;
|
|
40
56
|
values: Schema.Array$<typeof Schema.Any>;
|
|
@@ -42,6 +58,33 @@ declare const FilterIn_: Schema.Struct<{
|
|
|
42
58
|
export interface FilterIn extends Schema.Schema.Type<typeof FilterIn_> {
|
|
43
59
|
}
|
|
44
60
|
export declare const FilterIn: Schema.Schema<FilterIn>;
|
|
61
|
+
/**
|
|
62
|
+
* Contains.
|
|
63
|
+
*/
|
|
64
|
+
declare const FilterContains_: Schema.Struct<{
|
|
65
|
+
type: Schema.Literal<["contains"]>;
|
|
66
|
+
value: typeof Schema.Any;
|
|
67
|
+
}>;
|
|
68
|
+
export interface FilterContains extends Schema.Schema.Type<typeof FilterContains_> {
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Predicate for an array property to contain the provided value.
|
|
72
|
+
* Nested objects are matched using strict structural matching.
|
|
73
|
+
*/
|
|
74
|
+
export declare const FilterContains: Schema.Schema<FilterContains>;
|
|
75
|
+
/**
|
|
76
|
+
* Filters objects that have certain tag.
|
|
77
|
+
*/
|
|
78
|
+
declare const FilterTag_: Schema.Struct<{
|
|
79
|
+
type: Schema.Literal<["tag"]>;
|
|
80
|
+
tag: typeof Schema.String;
|
|
81
|
+
}>;
|
|
82
|
+
export interface FilterTag extends Schema.Schema.Type<typeof FilterTag_> {
|
|
83
|
+
}
|
|
84
|
+
export declare const FilterTag: Schema.Schema<FilterTag>;
|
|
85
|
+
/**
|
|
86
|
+
* Range.
|
|
87
|
+
*/
|
|
45
88
|
declare const FilterRange_: Schema.Struct<{
|
|
46
89
|
type: Schema.Literal<["range"]>;
|
|
47
90
|
from: typeof Schema.Any;
|
|
@@ -50,6 +93,22 @@ declare const FilterRange_: Schema.Struct<{
|
|
|
50
93
|
export interface FilterRange extends Schema.Schema.Type<typeof FilterRange_> {
|
|
51
94
|
}
|
|
52
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>;
|
|
109
|
+
/**
|
|
110
|
+
* Text search.
|
|
111
|
+
*/
|
|
53
112
|
declare const FilterTextSearch_: Schema.Struct<{
|
|
54
113
|
type: Schema.Literal<["text-search"]>;
|
|
55
114
|
text: typeof Schema.String;
|
|
@@ -58,35 +117,61 @@ declare const FilterTextSearch_: Schema.Struct<{
|
|
|
58
117
|
export interface FilterTextSearch extends Schema.Schema.Type<typeof FilterTextSearch_> {
|
|
59
118
|
}
|
|
60
119
|
export declare const FilterTextSearch: Schema.Schema<FilterTextSearch>;
|
|
120
|
+
/**
|
|
121
|
+
* Not.
|
|
122
|
+
*/
|
|
61
123
|
declare const FilterNot_: Schema.Struct<{
|
|
62
124
|
type: Schema.Literal<["not"]>;
|
|
63
|
-
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>;
|
|
64
126
|
}>;
|
|
65
127
|
export interface FilterNot extends Schema.Schema.Type<typeof FilterNot_> {
|
|
66
128
|
}
|
|
67
129
|
export declare const FilterNot: Schema.Schema<FilterNot>;
|
|
130
|
+
/**
|
|
131
|
+
* And.
|
|
132
|
+
*/
|
|
68
133
|
declare const FilterAnd_: Schema.Struct<{
|
|
69
134
|
type: Schema.Literal<["and"]>;
|
|
70
|
-
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>>;
|
|
71
136
|
}>;
|
|
72
137
|
export interface FilterAnd extends Schema.Schema.Type<typeof FilterAnd_> {
|
|
73
138
|
}
|
|
74
139
|
export declare const FilterAnd: Schema.Schema<FilterAnd>;
|
|
140
|
+
/**
|
|
141
|
+
* Or.
|
|
142
|
+
*/
|
|
75
143
|
declare const FilterOr_: Schema.Struct<{
|
|
76
144
|
type: Schema.Literal<["or"]>;
|
|
77
|
-
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>>;
|
|
78
146
|
}>;
|
|
79
147
|
export interface FilterOr extends Schema.Schema.Type<typeof FilterOr_> {
|
|
80
148
|
}
|
|
81
149
|
export declare const FilterOr: Schema.Schema<FilterOr>;
|
|
82
|
-
|
|
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>;
|
|
164
|
+
/**
|
|
165
|
+
* Union of filters.
|
|
166
|
+
*/
|
|
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>]>;
|
|
83
168
|
export type Filter = Schema.Schema.Type<typeof Filter>;
|
|
84
169
|
/**
|
|
85
170
|
* Query objects by type, id, and/or predicates.
|
|
86
171
|
*/
|
|
87
172
|
declare const QuerySelectClause_: Schema.Struct<{
|
|
88
173
|
type: Schema.Literal<["select"]>;
|
|
89
|
-
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>;
|
|
90
175
|
}>;
|
|
91
176
|
export interface QuerySelectClause extends Schema.Schema.Type<typeof QuerySelectClause_> {
|
|
92
177
|
}
|
|
@@ -96,8 +181,8 @@ export declare const QuerySelectClause: Schema.Schema<QuerySelectClause>;
|
|
|
96
181
|
*/
|
|
97
182
|
declare const QueryFilterClause_: Schema.Struct<{
|
|
98
183
|
type: Schema.Literal<["filter"]>;
|
|
99
|
-
selection: Schema.suspend<
|
|
100
|
-
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>;
|
|
101
186
|
}>;
|
|
102
187
|
export interface QueryFilterClause extends Schema.Schema.Type<typeof QueryFilterClause_> {
|
|
103
188
|
}
|
|
@@ -107,7 +192,7 @@ export declare const QueryFilterClause: Schema.Schema<QueryFilterClause>;
|
|
|
107
192
|
*/
|
|
108
193
|
declare const QueryReferenceTraversalClause_: Schema.Struct<{
|
|
109
194
|
type: Schema.Literal<["reference-traversal"]>;
|
|
110
|
-
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>;
|
|
111
196
|
property: typeof Schema.String;
|
|
112
197
|
}>;
|
|
113
198
|
export interface QueryReferenceTraversalClause extends Schema.Schema.Type<typeof QueryReferenceTraversalClause_> {
|
|
@@ -118,9 +203,13 @@ export declare const QueryReferenceTraversalClause: Schema.Schema<QueryReference
|
|
|
118
203
|
*/
|
|
119
204
|
declare const QueryIncomingReferencesClause_: Schema.Struct<{
|
|
120
205
|
type: Schema.Literal<["incoming-references"]>;
|
|
121
|
-
anchor: Schema.suspend<
|
|
122
|
-
|
|
123
|
-
|
|
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>;
|
|
207
|
+
/**
|
|
208
|
+
* Property path where the reference is located.
|
|
209
|
+
* If null, matches references from any property.
|
|
210
|
+
*/
|
|
211
|
+
property: Schema.NullOr<typeof Schema.String>;
|
|
212
|
+
typename: Schema.Union<[Schema.Schema<URI.URI, URI.URI, never>, typeof Schema.Null]>;
|
|
124
213
|
}>;
|
|
125
214
|
export interface QueryIncomingReferencesClause extends Schema.Schema.Type<typeof QueryIncomingReferencesClause_> {
|
|
126
215
|
}
|
|
@@ -130,14 +219,14 @@ export declare const QueryIncomingReferencesClause: Schema.Schema<QueryIncomingR
|
|
|
130
219
|
*/
|
|
131
220
|
declare const QueryRelationClause_: Schema.Struct<{
|
|
132
221
|
type: Schema.Literal<["relation"]>;
|
|
133
|
-
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>;
|
|
134
223
|
/**
|
|
135
224
|
* outgoing: anchor is the source of the relation.
|
|
136
225
|
* incoming: anchor is the target of the relation.
|
|
137
226
|
* both: anchor is either the source or target of the relation.
|
|
138
227
|
*/
|
|
139
228
|
direction: Schema.Literal<["outgoing", "incoming", "both"]>;
|
|
140
|
-
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>>;
|
|
141
230
|
}>;
|
|
142
231
|
export interface QueryRelationClause extends Schema.Schema.Type<typeof QueryRelationClause_> {
|
|
143
232
|
}
|
|
@@ -147,18 +236,33 @@ export declare const QueryRelationClause: Schema.Schema<QueryRelationClause>;
|
|
|
147
236
|
*/
|
|
148
237
|
declare const QueryRelationTraversalClause_: Schema.Struct<{
|
|
149
238
|
type: Schema.Literal<["relation-traversal"]>;
|
|
150
|
-
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>;
|
|
151
240
|
direction: Schema.Literal<["source", "target", "both"]>;
|
|
152
241
|
}>;
|
|
153
242
|
export interface QueryRelationTraversalClause extends Schema.Schema.Type<typeof QueryRelationTraversalClause_> {
|
|
154
243
|
}
|
|
155
244
|
export declare const QueryRelationTraversalClause: Schema.Schema<QueryRelationTraversalClause>;
|
|
245
|
+
/**
|
|
246
|
+
* Traverse parent-child hierarchy.
|
|
247
|
+
*/
|
|
248
|
+
declare const QueryHierarchyTraversalClause_: Schema.Struct<{
|
|
249
|
+
type: Schema.Literal<["hierarchy-traversal"]>;
|
|
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>;
|
|
251
|
+
/**
|
|
252
|
+
* to-parent: traverse from child to parent.
|
|
253
|
+
* to-children: traverse from parent to children.
|
|
254
|
+
*/
|
|
255
|
+
direction: Schema.Literal<["to-parent", "to-children"]>;
|
|
256
|
+
}>;
|
|
257
|
+
export interface QueryHierarchyTraversalClause extends Schema.Schema.Type<typeof QueryHierarchyTraversalClause_> {
|
|
258
|
+
}
|
|
259
|
+
export declare const QueryHierarchyTraversalClause: Schema.Schema<QueryHierarchyTraversalClause>;
|
|
156
260
|
/**
|
|
157
261
|
* Union of multiple queries.
|
|
158
262
|
*/
|
|
159
263
|
declare const QueryUnionClause_: Schema.Struct<{
|
|
160
264
|
type: Schema.Literal<["union"]>;
|
|
161
|
-
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>>;
|
|
162
266
|
}>;
|
|
163
267
|
export interface QueryUnionClause extends Schema.Schema.Type<typeof QueryUnionClause_> {
|
|
164
268
|
}
|
|
@@ -168,38 +272,196 @@ export declare const QueryUnionClause: Schema.Schema<QueryUnionClause>;
|
|
|
168
272
|
*/
|
|
169
273
|
declare const QuerySetDifferenceClause_: Schema.Struct<{
|
|
170
274
|
type: Schema.Literal<["set-difference"]>;
|
|
171
|
-
source: Schema.suspend<
|
|
172
|
-
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>;
|
|
173
277
|
}>;
|
|
174
278
|
export interface QuerySetDifferenceClause extends Schema.Schema.Type<typeof QuerySetDifferenceClause_> {
|
|
175
279
|
}
|
|
176
280
|
export declare const QuerySetDifferenceClause: Schema.Schema<QuerySetDifferenceClause>;
|
|
281
|
+
export declare const OrderDirection: Schema.Literal<["asc", "desc"]>;
|
|
282
|
+
export type OrderDirection = Schema.Schema.Type<typeof OrderDirection>;
|
|
283
|
+
declare const Order_: Schema.Union<[Schema.Struct<{
|
|
284
|
+
kind: Schema.Literal<["natural"]>;
|
|
285
|
+
}>, Schema.Struct<{
|
|
286
|
+
kind: Schema.Literal<["property"]>;
|
|
287
|
+
property: typeof Schema.String;
|
|
288
|
+
direction: Schema.Literal<["asc", "desc"]>;
|
|
289
|
+
}>, Schema.Struct<{
|
|
290
|
+
kind: Schema.Literal<["rank"]>;
|
|
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"]>;
|
|
296
|
+
}>]>;
|
|
297
|
+
export type Order = Schema.Schema.Type<typeof Order_>;
|
|
298
|
+
export declare const Order: Schema.Schema<Order>;
|
|
299
|
+
/**
|
|
300
|
+
* Order the query results.
|
|
301
|
+
* Left-to-right the orders dominate.
|
|
302
|
+
*/
|
|
303
|
+
declare const QueryOrderClause_: Schema.Struct<{
|
|
304
|
+
type: Schema.Literal<["order"]>;
|
|
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>;
|
|
306
|
+
order: Schema.Array$<Schema.Schema<{
|
|
307
|
+
readonly kind: "natural";
|
|
308
|
+
} | {
|
|
309
|
+
readonly kind: "property";
|
|
310
|
+
readonly property: string;
|
|
311
|
+
readonly direction: "asc" | "desc";
|
|
312
|
+
} | {
|
|
313
|
+
readonly kind: "rank";
|
|
314
|
+
readonly direction: "asc" | "desc";
|
|
315
|
+
} | {
|
|
316
|
+
readonly kind: "timestamp";
|
|
317
|
+
readonly field: "createdAt" | "updatedAt";
|
|
318
|
+
readonly direction: "asc" | "desc";
|
|
319
|
+
}, {
|
|
320
|
+
readonly kind: "natural";
|
|
321
|
+
} | {
|
|
322
|
+
readonly kind: "property";
|
|
323
|
+
readonly property: string;
|
|
324
|
+
readonly direction: "asc" | "desc";
|
|
325
|
+
} | {
|
|
326
|
+
readonly kind: "rank";
|
|
327
|
+
readonly direction: "asc" | "desc";
|
|
328
|
+
} | {
|
|
329
|
+
readonly kind: "timestamp";
|
|
330
|
+
readonly field: "createdAt" | "updatedAt";
|
|
331
|
+
readonly direction: "asc" | "desc";
|
|
332
|
+
}, never>>;
|
|
333
|
+
}>;
|
|
334
|
+
export interface QueryOrderClause extends Schema.Schema.Type<typeof QueryOrderClause_> {
|
|
335
|
+
}
|
|
336
|
+
export declare const QueryOrderClause: Schema.Schema<QueryOrderClause>;
|
|
177
337
|
/**
|
|
178
338
|
* Add options to a query.
|
|
179
339
|
*/
|
|
180
340
|
declare const QueryOptionsClause_: Schema.Struct<{
|
|
181
341
|
type: Schema.Literal<["options"]>;
|
|
182
|
-
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>;
|
|
183
343
|
options: Schema.suspend<{
|
|
184
|
-
readonly deleted?: "
|
|
185
|
-
readonly
|
|
344
|
+
readonly deleted?: "exclude" | "include" | "only" | undefined;
|
|
345
|
+
readonly debugLabel?: string | undefined;
|
|
186
346
|
}, {
|
|
187
|
-
readonly
|
|
188
|
-
readonly
|
|
347
|
+
readonly debugLabel?: string | undefined;
|
|
348
|
+
readonly deleted?: "exclude" | "include" | "only" | undefined;
|
|
189
349
|
}, never>;
|
|
190
350
|
}>;
|
|
191
351
|
export interface QueryOptionsClause extends Schema.Schema.Type<typeof QueryOptionsClause_> {
|
|
192
352
|
}
|
|
193
353
|
export declare const QueryOptionsClause: Schema.Schema<QueryOptionsClause>;
|
|
194
|
-
|
|
354
|
+
/**
|
|
355
|
+
* Limit the number of results.
|
|
356
|
+
*/
|
|
357
|
+
declare const QueryLimitClause_: Schema.Struct<{
|
|
358
|
+
type: Schema.Literal<["limit"]>;
|
|
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>;
|
|
360
|
+
limit: typeof Schema.Number;
|
|
361
|
+
}>;
|
|
362
|
+
export interface QueryLimitClause extends Schema.Schema.Type<typeof QueryLimitClause_> {
|
|
363
|
+
}
|
|
364
|
+
export declare const QueryLimitClause: Schema.Schema<QueryLimitClause>;
|
|
365
|
+
export declare const QueryFromClause_: Schema.Struct<{
|
|
366
|
+
type: Schema.Literal<["from"]>;
|
|
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>;
|
|
368
|
+
from: Schema.Union<[Schema.TaggedStruct<"scope", {
|
|
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";
|
|
379
|
+
}, {
|
|
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>>;
|
|
390
|
+
}>, Schema.TaggedStruct<"query", {
|
|
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>;
|
|
392
|
+
}>]>;
|
|
393
|
+
}>;
|
|
394
|
+
export interface QueryFromClause extends Schema.Schema.Type<typeof QueryFromClause_> {
|
|
395
|
+
}
|
|
396
|
+
export declare const QueryFromClause: Schema.Schema<QueryFromClause>;
|
|
397
|
+
declare const Query_: Schema.Union<[Schema.Schema<QuerySelectClause, QuerySelectClause, never>, Schema.Schema<QueryFilterClause, QueryFilterClause, never>, Schema.Schema<QueryReferenceTraversalClause, QueryReferenceTraversalClause, never>, Schema.Schema<QueryIncomingReferencesClause, QueryIncomingReferencesClause, never>, Schema.Schema<QueryRelationClause, QueryRelationClause, never>, Schema.Schema<QueryRelationTraversalClause, QueryRelationTraversalClause, never>, Schema.Schema<QueryHierarchyTraversalClause, QueryHierarchyTraversalClause, never>, Schema.Schema<QueryUnionClause, QueryUnionClause, never>, Schema.Schema<QuerySetDifferenceClause, QuerySetDifferenceClause, never>, Schema.Schema<QueryOrderClause, QueryOrderClause, never>, Schema.Schema<QueryOptionsClause, QueryOptionsClause, never>, Schema.Schema<QueryLimitClause, QueryLimitClause, never>, Schema.Schema<QueryFromClause, QueryFromClause, never>]>;
|
|
195
398
|
export type Query = Schema.Schema.Type<typeof Query_>;
|
|
196
399
|
export declare const Query: Schema.Schema<Query>;
|
|
197
400
|
export declare const QueryOptions: Schema.Struct<{
|
|
198
|
-
|
|
401
|
+
/**
|
|
402
|
+
* Nested select statements will use this option to filter deleted objects.
|
|
403
|
+
*/
|
|
199
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>;
|
|
200
409
|
}>;
|
|
201
410
|
export interface QueryOptions extends Schema.Schema.Type<typeof QueryOptions> {
|
|
202
411
|
}
|
|
412
|
+
/**
|
|
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.
|
|
418
|
+
*/
|
|
419
|
+
export declare const SpaceScope: Schema.TaggedStruct<"space", {
|
|
420
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
421
|
+
includeAllFeeds: Schema.optional<typeof Schema.Boolean>;
|
|
422
|
+
}>;
|
|
423
|
+
export interface SpaceScope extends Schema.Schema.Type<typeof SpaceScope> {
|
|
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>;
|
|
203
459
|
export declare const visit: (query: Query, visitor: (node: Query) => void) => void;
|
|
460
|
+
/**
|
|
461
|
+
* Recursively transforms a query tree bottom-up.
|
|
462
|
+
* The mapper receives each node with its children already transformed.
|
|
463
|
+
*/
|
|
464
|
+
export declare const map: (query: Query, mapper: (node: Query) => Query) => Query;
|
|
465
|
+
export declare const fold: <T>(query: Query, reducer: (node: Query) => T) => T[];
|
|
204
466
|
export {};
|
|
205
467
|
//# sourceMappingURL=ast.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../../../../src/query/ast.ts"],"names":[],"mappings":"
|
|
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,75 +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
|
-
|
|
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;
|
|
74
21
|
}>;
|
|
75
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"}
|