@dxos/echo-protocol 0.8.1 → 0.8.2-main.10c050d

package/dist/types/src/index.d.ts

@@ -3,4 +3,6 @@ export * from './reference';
 export * from './space-doc-version';
 export * from './collection-sync';
 export * from './space-id';
+export * from './foreign-key';
+export * from './query';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC"}

package/dist/types/src/query/ast.d.ts

@@ -0,0 +1,194 @@
+import { Schema } from 'effect';
+/**
+ * Filter by object type and properties.
+ *
+ * Clauses are combined using logical AND.
+ */
+declare const FilterObject_: Schema.Struct<{
+    type: Schema.Literal<["object"]>;
+    typename: Schema.Union<[Schema.refine<string, typeof Schema.NonEmptyString>, typeof Schema.Null]>;
+    id: Schema.optional<Schema.Array$<import("@dxos/keys").ObjectIdClass>>;
+    /**
+     * Filter by property.
+     * Must not include object ID.
+     */
+    props: Schema.Record$<Schema.SchemaClass<string, string, never>, Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>>;
+    /**
+     * Objects that have any of the given foreign keys.
+     */
+    foreignKeys: Schema.optional<Schema.Array$<Schema.Schema<{
+        readonly source: string;
+        readonly id: string;
+    }, {
+        readonly source: string;
+        readonly id: string;
+    }, never>>>;
+}>;
+export interface FilterObject extends Schema.Schema.Type<typeof FilterObject_> {
+}
+export declare const FilterObject: Schema.Schema<FilterObject>;
+declare const FilterCompare_: Schema.Struct<{
+    type: Schema.Literal<["compare"]>;
+    operator: Schema.Literal<["eq", "neq", "gt", "gte", "lt", "lte"]>;
+    value: typeof Schema.Unknown;
+}>;
+export interface FilterCompare extends Schema.Schema.Type<typeof FilterCompare_> {
+}
+export declare const FilterCompare: Schema.Schema<FilterCompare>;
+declare const FilterIn_: Schema.Struct<{
+    type: Schema.Literal<["in"]>;
+    values: Schema.Array$<typeof Schema.Any>;
+}>;
+export interface FilterIn extends Schema.Schema.Type<typeof FilterIn_> {
+}
+export declare const FilterIn: Schema.Schema<FilterIn>;
+declare const FilterRange_: Schema.Struct<{
+    type: Schema.Literal<["range"]>;
+    from: typeof Schema.Any;
+    to: typeof Schema.Any;
+}>;
+export interface FilterRange extends Schema.Schema.Type<typeof FilterRange_> {
+}
+export declare const FilterRange: Schema.Schema<FilterRange>;
+declare const FilterTextSearch_: Schema.Struct<{
+    type: Schema.Literal<["text-search"]>;
+    text: typeof Schema.String;
+    searchKind: Schema.optional<Schema.Literal<["full-text", "vector"]>>;
+}>;
+export interface FilterTextSearch extends Schema.Schema.Type<typeof FilterTextSearch_> {
+}
+export declare const FilterTextSearch: Schema.Schema<FilterTextSearch>;
+declare const FilterNot_: Schema.Struct<{
+    type: Schema.Literal<["not"]>;
+    filter: Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>;
+}>;
+export interface FilterNot extends Schema.Schema.Type<typeof FilterNot_> {
+}
+export declare const FilterNot: Schema.Schema<FilterNot>;
+declare const FilterAnd_: Schema.Struct<{
+    type: Schema.Literal<["and"]>;
+    filters: Schema.Array$<Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>>;
+}>;
+export interface FilterAnd extends Schema.Schema.Type<typeof FilterAnd_> {
+}
+export declare const FilterAnd: Schema.Schema<FilterAnd>;
+declare const FilterOr_: Schema.Struct<{
+    type: Schema.Literal<["or"]>;
+    filters: Schema.Array$<Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>>;
+}>;
+export interface FilterOr extends Schema.Schema.Type<typeof FilterOr_> {
+}
+export declare const FilterOr: Schema.Schema<FilterOr>;
+export declare const Filter: Schema.Union<[Schema.Schema<FilterObject, FilterObject, never>, Schema.Schema<FilterTextSearch, FilterTextSearch, never>, Schema.Schema<FilterCompare, FilterCompare, never>, Schema.Schema<FilterIn, FilterIn, never>, Schema.Schema<FilterRange, FilterRange, never>, Schema.Schema<FilterNot, FilterNot, never>, Schema.Schema<FilterAnd, FilterAnd, never>, Schema.Schema<FilterOr, FilterOr, never>]>;
+export type Filter = Schema.Schema.Type<typeof Filter>;
+/**
+ * Query objects by type, id, and/or predicates.
+ */
+declare const QuerySelectClause_: Schema.Struct<{
+    type: Schema.Literal<["select"]>;
+    filter: Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>;
+}>;
+export interface QuerySelectClause extends Schema.Schema.Type<typeof QuerySelectClause_> {
+}
+export declare const QuerySelectClause: Schema.Schema<QuerySelectClause>;
+/**
+ * Filter objects from selection.
+ */
+declare const QueryFilterClause_: Schema.Struct<{
+    type: Schema.Literal<["filter"]>;
+    selection: Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>;
+    filter: Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>;
+}>;
+export interface QueryFilterClause extends Schema.Schema.Type<typeof QueryFilterClause_> {
+}
+export declare const QueryFilterClause: Schema.Schema<QueryFilterClause>;
+/**
+ * Traverse references from an anchor object.
+ */
+declare const QueryReferenceTraversalClause_: Schema.Struct<{
+    type: Schema.Literal<["reference-traversal"]>;
+    anchor: Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>;
+    property: typeof Schema.String;
+}>;
+export interface QueryReferenceTraversalClause extends Schema.Schema.Type<typeof QueryReferenceTraversalClause_> {
+}
+export declare const QueryReferenceTraversalClause: Schema.Schema<QueryReferenceTraversalClause>;
+/**
+ * Traverse incoming references to an anchor object.
+ */
+declare const QueryIncomingReferencesClause_: Schema.Struct<{
+    type: Schema.Literal<["incoming-references"]>;
+    anchor: Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>;
+    property: typeof Schema.String;
+    typename: Schema.Union<[Schema.refine<string, typeof Schema.NonEmptyString>, typeof Schema.Null]>;
+}>;
+export interface QueryIncomingReferencesClause extends Schema.Schema.Type<typeof QueryIncomingReferencesClause_> {
+}
+export declare const QueryIncomingReferencesClause: Schema.Schema<QueryIncomingReferencesClause>;
+/**
+ * Traverse relations connecting to an anchor object.
+ */
+declare const QueryRelationClause_: Schema.Struct<{
+    type: Schema.Literal<["relation"]>;
+    anchor: Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>;
+    /**
+     * outgoing: anchor is the source of the relation.
+     * incoming: anchor is the target of the relation.
+     * both: anchor is either the source or target of the relation.
+     */
+    direction: Schema.Literal<["outgoing", "incoming", "both"]>;
+    filter: Schema.optional<Schema.suspend<FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, FilterObject | FilterTextSearch | FilterCompare | FilterIn | FilterRange | FilterNot | FilterAnd | FilterOr, never>>;
+}>;
+export interface QueryRelationClause extends Schema.Schema.Type<typeof QueryRelationClause_> {
+}
+export declare const QueryRelationClause: Schema.Schema<QueryRelationClause>;
+/**
+ * Traverse into the source or target of a relation.
+ */
+declare const QueryRelationTraversalClause_: Schema.Struct<{
+    type: Schema.Literal<["relation-traversal"]>;
+    anchor: Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>;
+    direction: Schema.Literal<["source", "target", "both"]>;
+}>;
+export interface QueryRelationTraversalClause extends Schema.Schema.Type<typeof QueryRelationTraversalClause_> {
+}
+export declare const QueryRelationTraversalClause: Schema.Schema<QueryRelationTraversalClause>;
+/**
+ * Union of multiple queries.
+ */
+declare const QueryUnionClause_: Schema.Struct<{
+    type: Schema.Literal<["union"]>;
+    queries: Schema.Array$<Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>>;
+}>;
+export interface QueryUnionClause extends Schema.Schema.Type<typeof QueryUnionClause_> {
+}
+export declare const QueryUnionClause: Schema.Schema<QueryUnionClause>;
+/**
+ * Add options to a query.
+ */
+declare const QueryOptionsClause_: Schema.Struct<{
+    type: Schema.Literal<["options"]>;
+    query: Schema.suspend<QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, QuerySelectClause | QueryFilterClause | QueryReferenceTraversalClause | QueryIncomingReferencesClause | QueryRelationClause | QueryRelationTraversalClause | QueryUnionClause | QueryOptionsClause, never>;
+    options: Schema.suspend<{
+        readonly deleted?: "include" | "exclude" | "only" | undefined;
+        readonly spaceIds?: readonly string[] | undefined;
+    }, {
+        readonly deleted?: "include" | "exclude" | "only" | undefined;
+        readonly spaceIds?: readonly string[] | undefined;
+    }, never>;
+}>;
+export interface QueryOptionsClause extends Schema.Schema.Type<typeof QueryOptionsClause_> {
+}
+export declare const QueryOptionsClause: Schema.Schema<QueryOptionsClause>;
+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<QueryUnionClause, QueryUnionClause, never>, Schema.Schema<QueryOptionsClause, QueryOptionsClause, never>]>;
+export type Query = Schema.Schema.Type<typeof Query_>;
+export declare const Query: Schema.Schema<Query>;
+export declare const QueryOptions: Schema.Struct<{
+    spaceIds: Schema.optional<Schema.Array$<typeof Schema.String>>;
+    deleted: Schema.optional<Schema.Literal<["include", "exclude", "only"]>>;
+}>;
+export interface QueryOptions extends Schema.Schema.Type<typeof QueryOptions> {
+}
+export declare const visit: (query: Query, visitor: (node: Query) => void) => void;
+export {};
+//# sourceMappingURL=ast.d.ts.map

package/dist/types/src/query/ast.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../../../../src/query/ast.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAYhC;;;;GAIG;AAEH,QAAA,MAAM,aAAa;;;;IAOjB;;;OAGG;;IAMH;;OAEG;;;;;;;;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,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,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,QAAA,MAAM,YAAY;;;;EAIhB,CAAC;AACH,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,QAAA,MAAM,iBAAiB;;;;EAIrB,CAAC;AACH,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,QAAA,MAAM,UAAU;;;EAGd,CAAC;AACH,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,QAAA,MAAM,UAAU;;;EAGd,CAAC;AACH,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,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,eAAO,MAAM,MAAM,4YASlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC;AAEvD;;GAEG;AACH,QAAA,MAAM,kBAAkB;;;EAGtB,CAAC;AACH,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;AACH,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;AACH,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;;;;;EAKlC,CAAC;AACH,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;AACH,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;AACH,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,iBAAiB;;;EAGrB,CAAC;AACH,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;AACH,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,QAAA,MAAM,MAAM,0jBASX,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,eAAO,MAAM,YAAY;;;EAGvB,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC;CAAG;AAEhF,eAAO,MAAM,KAAK,GAAI,OAAO,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,SAwBjE,CAAC"}

package/dist/types/src/query/index.d.ts

@@ -0,0 +1,2 @@
+export * as QueryAST from './ast';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/query/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/query/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAC"}

package/dist/types/src/reference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAAmB,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,SAAS,IAAI,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAElG;;;GAGG;AACH,qBAAa,SAAS;IAqDlB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IAvDxB;;;OAGG;IACH,MAAM,CAAC,aAAa,SAAc;IAElC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS;IAenC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIlD;;OAEG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS;IAI1D;;OAEG;IAEH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAIlD;;OAEG;IAEH,MAAM,CAAC,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,GAAG,SAAS;IAMlF,OAAO;IAQP,IAAI,GAAG,IAAI,GAAG,GAAG,SAAS,CAEzB;IAED;;OAEG;IAEH,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;OAEG;IAEH,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED;;OAEG;IAEH,IAAI,IAAI,IAAI,MAAM,GAAG,SAAS,CAE7B;IAED,MAAM,IAAI,cAAc;IAKxB,KAAK,IAAI,GAAG;CAkBb;AAED,eAAO,MAAM,kBAAkB,uCAAuC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,eAAe,cAAe,SAAS,KAAG,gBAErD,CAAC;AAEH,eAAO,MAAM,eAAe,UAAW,GAAG,cAA6C,CAAC;AAExF,eAAO,MAAM,kBAAkB,UAAW,GAAG,KAAG,KAAK,IAAI,gBACyD,CAAC"}
+{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/reference.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAAmB,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,SAAS,IAAI,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAElG;;;GAGG;AACH,qBAAa,SAAS;IAqDlB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IAvDxB;;;OAGG;IACH,MAAM,CAAC,aAAa,SAAc;IAElC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS;IAenC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIlD;;OAEG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS;IAI1D;;OAEG;IAEH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAIlD;;OAEG;IAEH,MAAM,CAAC,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,GAAG,SAAS;IAMlF,OAAO;IAQP,IAAI,GAAG,IAAI,GAAG,GAAG,SAAS,CAEzB;IAED;;OAEG;IAEH,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;OAEG;IAEH,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED;;OAEG;IAEH,IAAI,IAAI,IAAI,MAAM,GAAG,SAAS,CAE7B;IAED,MAAM,IAAI,cAAc;IAKxB,KAAK,IAAI,GAAG;CAkBb;AAED,eAAO,MAAM,kBAAkB,uCAAuC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,WAAW,SAAS,KAAG,gBAErD,CAAC;AAEH,eAAO,MAAM,eAAe,GAAI,OAAO,GAAG,cAezC,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,OAAO,GAAG,KAAG,KAAK,IAAI,gBACyD,CAAC"}

package/dist/types/src/space-id.d.ts.map

@@ -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,aAAoB,SAAS,KAAG,OAAO,CAAC,OAAO,CAY/E,CAAC"}
+{"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,GAAU,UAAU,SAAS,KAAG,OAAO,CAAC,OAAO,CAY/E,CAAC"}

package/dist/types/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"version":"5.7.3"}
+{"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-protocol",
-  "version": "0.8.1",
+  "version": "0.8.2-main.10c050d",
   "description": "Core ECHO APIs.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -25,10 +25,12 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/crypto": "0.8.1",
-    "@dxos/keys": "0.8.1",
-    "@dxos/protocols": "0.8.1",
-    "@dxos/util": "0.8.1"
+    "effect": "3.14.21",
+    "@dxos/keys": "0.8.2-main.10c050d",
+    "@dxos/invariant": "0.8.2-main.10c050d",
+    "@dxos/crypto": "0.8.2-main.10c050d",
+    "@dxos/protocols": "0.8.2-main.10c050d",
+    "@dxos/util": "0.8.2-main.10c050d"
   },
   "publishConfig": {
     "access": "public"

package/src/document-structure.ts

@@ -2,8 +2,13 @@
 // Copyright 2024 DXOS.org
 //
 
+import { invariant } from '@dxos/invariant';
+import type { DXN, ObjectId } from '@dxos/keys';
+import { visitValues } from '@dxos/util';
+
 import { type RawString } from './automerge';
-import { type EncodedReference } from './reference';
+import type { ForeignKey } from './foreign-key';
+import { isEncodedReference, type EncodedReference } from './reference';
 import { type SpaceDocVersion } from './space-doc-version';
 
 export type SpaceState = {
@@ -11,8 +16,16 @@ export type SpaceState = {
   rootUrl?: string;
 };
 
-// TODO(dmaretskyi): Rename DatabaseRootDoc.
-export interface SpaceDoc {
+/**
+ * Array indexes get converted to strings.
+ */
+export type ObjectProp = string;
+export type ObjectPropPath = ObjectProp[];
+
+/**
+ * Link to all documents that hold objects in the space.
+ */
+export interface DatabaseDirectory {
   version?: SpaceDocVersion;
 
   access?: {
@@ -30,41 +43,177 @@ export interface SpaceDoc {
   links?: {
     [echoId: string]: string | RawString;
   };
+
+  /**
+   * @deprecated
+   * For backward compatibility.
+   */
+  experimental_spaceKey?: string;
 }
 
+export const DatabaseDirectory = Object.freeze({
+  /**
+   * @returns Space key in hex of the space that owns the document. In hex format. Without 0x prefix.
+   */
+  getSpaceKey: (doc: DatabaseDirectory): string | null => {
+    // experimental_spaceKey is set on old documents, new ones are created with doc.access.spaceKey
+    const rawSpaceKey = doc.access?.spaceKey ?? doc.experimental_spaceKey;
+    if (rawSpaceKey == null) {
+      return null;
+    }
+
+    const rawKey = String(rawSpaceKey);
+    invariant(!rawKey.startsWith('0x'), 'Space key must not start with 0x');
+    return rawKey;
+  },
+
+  getInlineObject: (doc: DatabaseDirectory, id: ObjectId): ObjectStructure | undefined => {
+    return doc.objects?.[id];
+  },
+
+  getLink: (doc: DatabaseDirectory, id: ObjectId): string | undefined => {
+    return doc.links?.[id]?.toString();
+  },
+
+  make: ({
+    spaceKey,
+    objects,
+    links,
+  }: {
+    spaceKey: string;
+    objects?: Record<string, ObjectStructure>;
+    links?: Record<string, RawString>;
+  }): DatabaseDirectory => ({
+    access: {
+      spaceKey,
+    },
+    objects: objects ?? {},
+    links: links ?? {},
+  }),
+});
+
 /**
  * Representation of an ECHO object in an AM document.
  */
 export type ObjectStructure = {
-  system: ObjectSystem;
+  // TODO(dmaretskyi): Missing in some cases.
+  system?: ObjectSystem;
+
   meta: ObjectMeta;
+  /**
+   * User-defined data.
+   * Adheres to schema in `system.type`
+   */
   data: Record<string, any>;
 };
 
-/**
- * Echo object metadata.
- */
-export type ObjectMeta = {
+// Helper methods to interact with the {@link ObjectStructure}.
+export const ObjectStructure = Object.freeze({
   /**
-   * Foreign keys.
+   * @throws On invalid object structure.
    */
-  keys: ForeignKey[];
-};
+  getTypeReference: (object: ObjectStructure): EncodedReference | undefined => {
+    return object.system?.type;
+  },
+
+  /**
+   * @throws On invalid object structure.
+   */
+  getEntityKind: (object: ObjectStructure): 'object' | 'relation' => {
+    const kind = object.system?.kind ?? 'object';
+    invariant(kind === 'object' || kind === 'relation', 'Invalid kind');
+    return kind;
+  },
+
+  isDeleted: (object: ObjectStructure): boolean => {
+    return object.system?.deleted ?? false;
+  },
+
+  getRelationSource: (object: ObjectStructure): EncodedReference | undefined => {
+    return object.system?.source;
+  },
+
+  getRelationTarget: (object: ObjectStructure): EncodedReference | undefined => {
+    return object.system?.target;
+  },
 
-/**
- * Reference to an object in a foreign database.
- */
-export type ForeignKey = {
   /**
-   * Name of the foreign database/system.
-   * E.g., `github.com`.
+   * @returns All references in the data section of the object.
    */
-  readonly source: string;
+  getAllOutgoingReferences: (object: ObjectStructure): { path: ObjectPropPath; reference: EncodedReference }[] => {
+    const references: { path: ObjectPropPath; reference: EncodedReference }[] = [];
+    const visit = (path: ObjectPropPath, value: unknown) => {
+      if (isEncodedReference(value)) {
+        references.push({ path, reference: value });
+      } else {
+        visitValues(value, (value, key) => visit([...path, String(key)], value));
+      }
+    };
+    visitValues(object.data, (value, key) => visit([String(key)], value));
+    return references;
+  },
+
+  makeObject: ({
+    type,
+    data,
+    keys,
+  }: {
+    type: DXN.String;
+    deleted?: boolean;
+    keys?: ForeignKey[];
+    data?: unknown;
+  }): ObjectStructure => {
+    return {
+      system: {
+        kind: 'object',
+        type: { '/': type },
+      },
+      meta: {
+        keys: keys ?? [],
+      },
+      data: data ?? {},
+    };
+  },
 
+  makeRelation: ({
+    type,
+    source,
+    target,
+    deleted,
+    keys,
+    data,
+  }: {
+    type: DXN.String;
+    source: EncodedReference;
+    target: EncodedReference;
+    deleted?: boolean;
+    keys?: ForeignKey[];
+    data?: unknown;
+  }): ObjectStructure => {
+    return {
+      system: {
+        kind: 'relation',
+        type: { '/': type },
+        source,
+        target,
+        deleted: deleted ?? false,
+      },
+      meta: {
+        keys: keys ?? [],
+      },
+      data: data ?? {},
+    };
+  },
+});
+
+/**
+ * Echo object metadata.
+ */
+export type ObjectMeta = {
   /**
-   * Id within the foreign database.
+   * Foreign keys.
    */
-  readonly id: string;
+  keys: ForeignKey[];
 };
 
 /**
@@ -93,7 +242,7 @@ export type ObjectSystem = {
   source?: EncodedReference;
 
   /**
-   * Only for relations.
+   * Only for relations.w
    */
   target?: EncodedReference;
 };

package/src/foreign-key.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Schema, SchemaAST } from 'effect';
+
+const ForeignKey_ = Schema.Struct({
+  /**
+   * Name of the foreign database/system.
+   * E.g., `github.com`.
+   */
+  source: Schema.String,
+
+  /**
+   * Id within the foreign database.
+   */
+  // TODO(wittjosiah): This annotation is currently used to ensure id field shows up in forms.
+  // TODO(dmaretskyi): `false` is not a valid value for the annotation.
+  id: Schema.String.annotations({ [SchemaAST.IdentifierAnnotationId]: false }),
+});
+
+export type ForeignKey = Schema.Schema.Type<typeof ForeignKey_>;
+
+/**
+ * Reference to an object in a foreign database.
+ */
+export const ForeignKey: Schema.Schema<ForeignKey> = ForeignKey_;

package/src/index.ts

@@ -7,3 +7,5 @@ export * from './reference';
 export * from './space-doc-version';
 export * from './collection-sync';
 export * from './space-id';
+export * from './foreign-key';
+export * from './query';