@dxos/echo 0.8.4-main.ef1bc66f44 → 0.8.4-main.f466a3d56e

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

@@ -1,10 +1,13 @@
 import type * as EffectArray from 'effect/Array';
 import type * as Schema from 'effect/Schema';
 import { type QueryAST } from '@dxos/echo-protocol';
+import * as Database from './Database';
+import type * as Dataset from './Dataset';
+import * as Feed from './Feed';
 import * as Filter from './Filter';
 import type * as Order from './Order';
 import type * as Ref from './Ref';
-import type * as Type$ from './Type';
+import type * as Relation from './Relation';
 /**
  * All property paths inside T that are references.
  */
@@ -19,74 +22,142 @@ export interface Query<T> {
      * @param filter - Filter to select the objects.
      * @returns Query for the selected objects.
      */
-    select(filter: Filter.Filter<T>): Query<T>;
-    select(props: Filter.Props<T>): Query<T>;
+    'select'(filter: Filter.Filter<T>): Query<T>;
+    'select'(props: Filter.Props<T>): Query<T>;
     /**
      * Traverse an outgoing reference.
      * @param key - Property path inside T that is a reference or optional reference.
      * @returns Query for the target of the reference.
      */
-    reference<K extends RefPropKey<T>>(key: K): Query<T[K] extends Ref.Unknown ? Ref.Target<T[K]> : T[K] extends Ref.Unknown | undefined ? Ref.Target<Exclude<T[K], undefined>> : never>;
+    'reference'<K extends RefPropKey<T>>(key: K): Query<T[K] extends Ref.Unknown ? Ref.Target<T[K]> : T[K] extends Ref.Unknown | undefined ? Ref.Target<Exclude<T[K], undefined>> : never>;
     /**
      * Find objects referencing this object.
      * @param target - Schema of the referencing object. If not provided, matches any type.
      * @param key - Property path inside the referencing object that is a reference. If not provided, matches any property.
      * @returns Query for the referencing objects.
      */
-    referencedBy<S extends Schema.Schema.All>(target: S | string, key: RefPropKey<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
-    referencedBy<S extends Schema.Schema.All>(target: S | string): Query<Schema.Schema.Type<S>>;
-    referencedBy(): Query<any>;
+    'referencedBy'<S extends Schema.Schema.All>(target: S | string, key: RefPropKey<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
+    'referencedBy'<S extends Schema.Schema.All>(target: S | string): Query<Schema.Schema.Type<S>>;
+    'referencedBy'(): Query<any>;
     /**
      * Find relations where this object is the source.
      * @returns Query for the relation objects.
      * @param relation - Schema of the relation.
      * @param predicates - Predicates to filter the relation objects.
      */
-    sourceOf<S extends Schema.Schema.All>(relation: S | string, predicates?: Filter.Props<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
+    'sourceOf'<S extends Schema.Schema.All>(relation?: S | string, predicates?: Filter.Props<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
     /**
      * Find relations where this object is the target.
      * @returns Query for the relation objects.
      * @param relation - Schema of the relation.
      * @param predicates - Predicates to filter the relation objects.
      */
-    targetOf<S extends Schema.Schema.All>(relation: S | string, predicates?: Filter.Props<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
+    'targetOf'<S extends Schema.Schema.All>(relation?: S | string, predicates?: Filter.Props<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
     /**
      * For a query for relations, get the source objects.
      * @returns Query for the source objects.
      */
-    source(): Query<Type$.Relation.Source<T>>;
+    'source'(): Query<Relation.SourceOf<T>>;
     /**
      * For a query for relations, get the target objects.
      * @returns Query for the target objects.
      */
-    target(): Query<Type$.Relation.Target<T>>;
+    'target'(): Query<Relation.TargetOf<T>>;
     /**
      * Get the parent object of the current selection.
      * @returns Query for the parent objects.
      */
-    parent(): Query<any>;
+    'parent'(): Query<any>;
     /**
      * Get all child objects of the current selection.
      * @returns Query for the child objects.
      */
-    children(): Query<any>;
+    'children'(): Query<any>;
     /**
      * Order the query results.
      * Orders are specified in priority order. The first order will be applied first, etc.
      * @param order - Order to sort the results.
      * @returns Query for the ordered results.
      */
-    orderBy(...order: EffectArray.NonEmptyArray<Order.Order<T>>): Query<T>;
+    'orderBy'(...order: EffectArray.NonEmptyArray<Order.Order<T>>): Query<T>;
     /**
      * Limit the number of results.
      * @param limit - Maximum number of results to return.
      * @returns Query for the limited results.
      */
-    limit(limit: number): Query<T>;
+    'limit'(limit: number): Query<T>;
+    /**
+     * Query from selected databases only.
+     *
+     * Example:
+     *
+     * ```ts
+     * Query.select(Filter.type(Person)).from(db);
+     * ```
+     *
+     * @param options.includeFeeds [false] - Whether to include feeds in the query. Default is to query from automerge documents only.
+     */
+    'from'(database: Database.Database | Database.Database[], options?: {
+        includeFeeds?: boolean;
+    }): Query<T>;
+    /**
+     * Query from selected feeds only.
+     *
+     * Example:
+     *
+     * ```ts
+     * Query.select(Filter.type(Person)).from(feed);
+     * ```
+     *
+     */
+    'from'(feeds: Feed.Feed | Feed.Feed[]): Query<T>;
+    /**
+     * Query from all accessible spaces.
+     *
+     * Example:
+     *
+     * ```ts
+     * Query.select(Filter.type(Person)).from('all-accessible-spaces');
+     * ```
+     *
+     * @param options.includeFeeds [false] - Whether to include feeds in the query. Default is to query from automerge documents only.
+     */
+    'from'(allSpaces: 'all-accessible-spaces', options?: {
+        includeFeeds?: boolean;
+    }): Query<T>;
+    /**
+     * Query from a dataset.
+     * Currently only feeds are supported.
+     *
+     * Example:
+     *
+     * ```ts
+     * Query.type(Person).from(feed);
+     * ```
+     */
+    'from'(dataset: Dataset.Dataset): Query<T>;
+    /**
+     * Query from the results of another query.
+     *
+     * Example:
+     *
+     * ```ts
+     * Query.select(Filter.props({ foo: 'foo' })).from(Query.select(Filter.type(Contact)).reference('org'));
+     * ```
+     */
+    'from'(query: Any): Query<T>;
+    /**
+     * Query from a raw scope specification.
+     */
+    'from'(scope: QueryAST.Scope): Query<T>;
     /**
      * Add options to a query.
      */
-    options(options: QueryAST.QueryOptions): Query<T>;
+    'options'(options: QueryAST.QueryOptions): Query<T>;
+    /**
+     * Attach a diagnostic label for logs and tooling (execution semantics unchanged).
+     */
+    'debugLabel'(label: string): Query<T>;
 }
 export type Any = Query<any>;
 export type Type<Q extends Any> = Q extends Query<infer T> ? T : never;
@@ -107,7 +178,10 @@ export declare const select: <F extends Filter.Any>(filter: F) => Query<Filter.T
  *
  * Shorthand for: `Query.select(Filter.type(schema, predicates))`.
  */
-export declare const type: (schema: Schema.Schema.All | string, predicates?: Filter.Props<unknown>) => Any;
+export declare const type: {
+    <S extends Schema.Schema.All>(schema: S, predicates?: Filter.Props<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
+    (schema: string, predicates?: Filter.Props<unknown>): Query<any>;
+};
 /**
  * Combine results of multiple queries.
  * @param queries - Queries to combine.
@@ -121,5 +195,19 @@ export declare const all: (...queries: Any[]) => Any;
  * @returns Query for the results of the source query minus the results of the exclude query.
  */
 export declare const without: <T>(source: Query<T>, exclude: Query<T>) => Query<T>;
+/**
+ * Create a query scoped to a data source.
+ * The returned query selects everything from the source; chain `.select()` to narrow results.
+ *
+ * @param source - Data source: database, feed, 'all-accessible-spaces', or another query.
+ * @returns Query scoped to the given source.
+ */
+export declare const from: (source: Database.Database | Database.Database[] | Feed.Feed | Feed.Feed[] | Any | QueryAST.Scope | 'all-accessible-spaces', options?: {
+    includeFeeds?: boolean;
+}) => Any;
+/**
+ * Returns a human-readable string representation of a Query AST.
+ */
+export declare const pretty: (query: Any) => string;
 export {};
 //# sourceMappingURL=Query.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/Query.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,WAAW,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,KAAK,MAAM,QAAQ,CAAC;AAMrC;;GAEG;AAEH,KAAK,UAAU,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AAGtC,MAAM,WAAW,KAAK,CAAC,CAAC;IAEtB,QAAQ,EAAE;QAAE,KAAK,EAAE,CAAC,CAAA;KAAE,CAAC;IAEvB,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;IAEpB;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzC;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,EAC/B,GAAG,EAAE,CAAC,GACL,KAAK,CACN,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GACpB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAChB,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GAAG,SAAS,GAClC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GACpC,KAAK,CACZ,CAAC;IAEF;;;;;OAKG;IAGH,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACtC,MAAM,EAAE,CAAC,GAAG,MAAM,EAClB,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GACrC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,YAAY,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAClC,QAAQ,EAAE,CAAC,GAAG,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAClC,QAAQ,EAAE,CAAC,GAAG,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC;;;OAGG;IACH,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C;;;OAGG;IACH,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C;;;OAGG;IACH,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAErB;;;OAGG;IACH,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;CACnD;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;AAE7B,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAsHvE,eAAO,MAAM,EAAE,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,GAE5C,CAAC;AAEF,qCAAqC;AACrC,eAAO,MAAM,OAAO,GAAI,KAAK,QAAQ,CAAC,KAAK,KAAG,GAE7C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAK5E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,EAAE,aAAa,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAG,GAK7F,CAAC;AAEF;;;;GAIG;AAEH,eAAO,MAAM,GAAG,GAAI,GAAG,SAAS,GAAG,EAAE,KAAG,GAUvC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,KAAK,CAAC,CAAC,CAAC,KAAG,KAAK,CAAC,CAAC,CAMvE,CAAC"}
+{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/Query.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,WAAW,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAGpD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,OAAO,MAAM,WAAW,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAGnC,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAO5C;;GAEG;AAEH,KAAK,UAAU,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AAGtC,MAAM,WAAW,KAAK,CAAC,CAAC;IAEtB,QAAQ,EAAE;QAAE,KAAK,EAAE,CAAC,CAAA;KAAE,CAAC;IAEvB,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3C;;;;OAIG;IACH,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,EACjC,GAAG,EAAE,CAAC,GACL,KAAK,CACN,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GACpB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAChB,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GAAG,SAAS,GAClC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GACpC,KAAK,CACZ,CAAC;IAEF;;;;;OAKG;IAGH,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACxC,MAAM,EAAE,CAAC,GAAG,MAAM,EAClB,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GACrC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9F,cAAc,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACpC,QAAQ,CAAC,EAAE,CAAC,GAAG,MAAM,EACrB,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACpC,QAAQ,CAAC,EAAE,CAAC,GAAG,MAAM,EACrB,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC;;;OAGG;IACH,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC;;;OAGG;IACH,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC;;;OAGG;IACH,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvB;;;OAGG;IACH,UAAU,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,SAAS,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzE;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEjC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE1G;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3F;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEpD;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;AAE7B,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAgPvE,eAAO,MAAM,EAAE,UAAW,OAAO,KAAG,KAAK,IAAI,GAE5C,CAAC;AAEF,qCAAqC;AACrC,eAAO,MAAM,OAAO,QAAS,QAAQ,CAAC,KAAK,KAAG,GAE7C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,UAAU,CAAC,KAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAK5E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC1B,MAAM,EAAE,CAAC,EACT,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;CAMlE,CAAC;AAEF;;;;GAIG;AAEH,eAAO,MAAM,GAAG,eAAgB,GAAG,EAAE,KAAG,GAUvC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,KAAG,KAAK,CAAC,CAAC,CAMvE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,WAEX,QAAQ,CAAC,QAAQ,GACjB,QAAQ,CAAC,QAAQ,EAAE,GACnB,IAAI,CAAC,IAAI,GACT,IAAI,CAAC,IAAI,EAAE,GACX,GAAG,GACH,QAAQ,CAAC,KAAK,GACd,uBAAuB,YACjB;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,KACnC,GAOF,CAAC;AAYF;;GAEG;AACH,eAAO,MAAM,MAAM,UAAW,GAAG,KAAG,MAAyC,CAAC"}

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

@@ -1,23 +1,72 @@
+import type * as Schema from 'effect/Schema';
 import * as SchemaAST from 'effect/SchemaAST';
-import { Ref as Ref$, type RefResolver } from './internal';
+import type * as Entity from './Entity';
+import * as refInternal from './internal/Ref';
 import type * as Obj from './Obj';
-export type Ref<T> = Ref$<T>;
-export type Unknown = Ref$<Obj.Unknown>;
+/**
+ * Instance type for a reference.
+ *
+ * Reference can point to any object or relation.
+ * References are lazy loaded.
+ *
+ * `ref.dxn` is the DXN of the referenced object.
+ *
+ * @example
+ * ```ts
+ * const taskRef: Ref<Task> = Ref.make(task);
+ *
+ * await taskRef.load(); // Returns Promise<Task>
+ * yield* Database.load(taskRef); // Effectful version.
+ *
+ * database.makeRef(dxn); // Create a ref from a DXN.
+ * ```
+ */
+export type Ref<T> = refInternal.Ref<T>;
+export type Unknown = refInternal.Ref<Obj.Unknown>;
+/**
+ * Factory function to create a Ref schema for the given target schema.
+ * Use this in schema definitions to declare reference fields.
+ *
+ * @example
+ * ```ts
+ * const Task = Schema.Struct({
+ *   assignee: Ref.Ref(Person),  // Creates a Ref schema
+ * }).pipe(Type.object({ typename: 'Task', version: '0.1.0' }));
+ * ```
+ */
+export declare const Ref: <S extends Schema.Schema.Any>(schema: S) => RefSchema<Schema.Schema.Type<S>>;
 export declare const Array: Readonly<{
-    targets: <T extends import("./internal").AnyEntity>(refs: readonly Ref$<T>[]) => T[];
-    loadAll: <T extends import("./internal").AnyEntity>(refs: readonly Ref$<T>[]) => Promise<T[]>;
-    removeById: (refs: Ref$<import("./internal").AnyEntity>[], id: import("@dxos/keys").ObjectId) => void;
+    targets: <T extends import("./internal").AnyEntity>(refs: readonly refInternal.Ref<T>[]) => T[];
+    loadAll: <T extends import("./internal").AnyEntity>(refs: readonly refInternal.Ref<T>[]) => Promise<T[]>;
+    removeById: (refs: refInternal.Ref<import("./internal").AnyEntity>[], id: import("@dxos/keys").ObjectId) => void;
 }>;
+/**
+ * TypeScript type for a Ref schema.
+ * This is the type of the SCHEMA itself, not the runtime ref instance.
+ * For the instance type, use `Ref.Ref<T>` from the Ref module.
+ *
+ * @example
+ * ```ts
+ * // Schema type annotation (rarely needed, usually inferred):
+ * const refSchema: Ref.RefSchema<typeof Task> = Ref.Ref(Task);
+ *
+ * // Instance type annotation (use Ref.Ref instead):
+ * const refInstance: Ref.Ref<Task> = Ref.make(task);
+ * ```
+ */
+export interface RefSchema<T extends Entity.Unknown> extends refInternal.RefSchema<T> {
+}
 /**
  * Extract reference target.
  */
-export type Target<R extends Unknown> = R extends Ref$<infer T> ? T : never;
+export type Target<R extends Unknown> = R extends refInternal.Ref<infer T> ? T : never;
 /**
  * Reference resolver.
  */
-export type Resolver = RefResolver;
+export type Resolver = refInternal.RefResolver;
 export declare const isRef: (value: unknown) => value is Unknown;
-export declare const make: <T extends import("./internal").AnyEntity>(object: T) => Ref$<T>;
-export declare const fromDXN: (dxn: import("@dxos/keys").DXN) => Ref$<any>;
+export declare const make: <T extends import("./internal").AnyEntity>(object: T) => refInternal.Ref<T>;
+export declare const fromDXN: (dxn: import("@dxos/keys").DXN) => refInternal.Ref<any>;
+export declare const hasObjectId: (id: import("@dxos/keys").ObjectId) => (ref: refInternal.Ref<any>) => boolean;
 export declare const isRefType: (ast: SchemaAST.AST) => boolean;
 //# sourceMappingURL=Ref.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Ref.d.ts","sourceRoot":"","sources":["../../../src/Ref.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,GAAG,IAAI,IAAI,EAAY,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAGrE,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAElC,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7B,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAExC,eAAO,MAAM,KAAK;;;;EAAW,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,eAAO,MAAM,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAAoB,CAAC;AAEtE,eAAO,MAAM,IAAI,kEAAY,CAAC;AAG9B,eAAO,MAAM,OAAO,8CAAe,CAAC;AAGpC,eAAO,MAAM,SAAS,GAAI,KAAK,SAAS,CAAC,GAAG,KAAG,OAS9C,CAAC"}
+{"version":3,"file":"Ref.d.ts","sourceRoot":"","sources":["../../../src/Ref.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAE9C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAE9C,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAElC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACxC,MAAM,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAEnD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,GAAG,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAmB,CAAC;AAEjH,eAAO,MAAM,KAAK;;;;EAAuB,CAAC;AAE1C;;;;;;;;;;;;;GAaG;AAIH,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,CAAE,SAAQ,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;CAAG;AAExF;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC;AAE/C,eAAO,MAAM,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAA+B,CAAC;AAEjF,eAAO,MAAM,IAAI,6EAAuB,CAAC;AAGzC,eAAO,MAAM,OAAO,yDAA0B,CAAC;AAE/C,eAAO,MAAM,WAAW,+EAA8B,CAAC;AAGvD,eAAO,MAAM,SAAS,QAAS,SAAS,CAAC,GAAG,KAAG,OAS9C,CAAC"}

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

@@ -1,16 +1,20 @@
-import type * as Schema from 'effect/Schema';
+import * as Schema from 'effect/Schema';
 import type { ForeignKey } from '@dxos/echo-protocol';
 import { DXN, type ObjectId } from '@dxos/keys';
 import type * as Database from './Database';
 import * as Entity from './Entity';
-import { type ObjectJSON as APIJSON, type AnyEntity, type Comparator as ApiComparator, type Meta as ApiMeta, type ReadonlyMeta as ApiReadonlyMeta, type EntityVersion as ApiVersion, type ChangeCallback, EntityKind, type KindId, MetaId, type Mutable, type ObjectMeta, SnapshotKindId, VersionTypeId, isVersion } from './internal';
-import type * as Obj from './Obj';
+import * as internal from './internal';
+import * as Obj from './Obj';
 import type * as Type from './Type';
+export type Endpoints<Source, Target> = {
+    [Source]: Source;
+    [Target]: Target;
+};
 /**
  * Base type for all ECHO relations.
  * @private
  */
-interface BaseRelation<Source, Target> extends AnyEntity, Type.Relation.Endpoints<Source, Target>, Entity.OfKind<EntityKind.Relation> {
+interface BaseRelation<Source, Target> extends internal.AnyEntity, Endpoints<Source, Target>, Entity.OfKind<internal.EntityKind.Relation> {
 }
 /**
  * Relation with no known properties beyond id, kind, source, and target.
@@ -21,42 +25,75 @@ interface BaseRelation<Source, Target> extends AnyEntity, Type.Relation.Endpoint
  */
 export interface Unknown extends BaseRelation<Obj.Unknown, Obj.Unknown> {
 }
+/**
+ * Runtime Effect schema for any ECHO relation.
+ * Use for validation, parsing, or as a reference target for collections.
+ * A relation has `id`, source, and target fields plus any additional properties.
+ *
+ * NOTE: `Schema.is(Type.Relation)` does STRUCTURAL validation only (checks for `id` field).
+ * Use `Relation.isRelation()` for proper ECHO instance type guards that check the KindId brand.
+ *
+ * @example
+ * ```ts
+ * // Structural type guard (accepts any object with id field)
+ * if (Schema.is(Type.Relation)(unknownValue)) { ... }
+ *
+ * // ECHO instance type guard (checks KindId brand)
+ * if (Relation.isRelation(unknownValue)) { ... }
+ * ```
+ */
+export declare const Unknown: Type.Relation<Unknown, Obj.Any, Obj.Any>;
 /**
  * Relation type with specific source and target types.
  */
-export type Relation<Source extends Obj.Unknown, Target extends Obj.Unknown, Props> = BaseRelation<Source, Target> & Props;
+export type OfShape<Source extends Obj.Unknown, Target extends Obj.Unknown, Props> = BaseRelation<Source, Target> & Props;
 /**
  * Base type for snapshot relations (has SnapshotKindId instead of KindId).
  */
-interface BaseRelationSnapshot<Source, Target> extends AnyEntity, Type.Relation.Endpoints<Source, Target> {
-    readonly [SnapshotKindId]: EntityKind.Relation;
+interface BaseRelationSnapshot<Source, Target> extends internal.AnyEntity, Endpoints<Source, Target> {
+    readonly [Entity.SnapshotKindId]: internal.EntityKind.Relation;
     readonly id: ObjectId;
 }
+/**
+ * JSON-encoded properties for relations.
+ */
+export interface BaseRelationJson {
+    id: string;
+    [internal.ATTR_RELATION_SOURCE]: string;
+    [internal.ATTR_RELATION_TARGET]: string;
+}
 /**
  * Immutable snapshot of an ECHO relation.
  * Branded with SnapshotKindId (not KindId).
  * Property values are frozen at the time the snapshot was created.
  * Returned by getSnapshot() and hooks.
  */
-export type Snapshot<T extends Unknown = Unknown> = Omit<T, KindId> & BaseRelationSnapshot<Obj.Unknown, Obj.Unknown>;
+export type Snapshot<T extends Unknown = Unknown> = Omit<T, Entity.KindId> & BaseRelationSnapshot<Obj.Unknown, Obj.Unknown>;
 export declare const Source: unique symbol;
 export type Source = typeof Source;
 export declare const Target: unique symbol;
 export type Target = typeof Target;
+/**
+ * Get relation source type.
+ */
+export type SourceOf<A> = A extends Endpoints<infer S, infer _T> ? S : never;
+/**
+ * Get relation target type.
+ */
+export type TargetOf<A> = A extends Endpoints<infer _S, infer T> ? T : never;
 /**
  * Internal props type for relation instance creation.
  */
-type RelationMakeProps<T extends Unknown> = {
+type MakePropsInternal<T extends Unknown> = {
     id?: ObjectId;
-    [MetaId]?: ObjectMeta;
     [Source]: T[Source];
     [Target]: T[Target];
-} & Type.Properties<T>;
+} & Entity.Properties<T>;
 /**
  * Props type for relation creation with a given schema.
  * Takes a schema type (created with Type.Relation) and extracts the props type.
  */
-export type MakeProps<S extends Type.Relation.Any> = RelationMakeProps<Schema.Schema.Type<S>>;
+export type MakeProps<S extends Type.AnyRelation> = MakePropsInternal<Schema.Schema.Type<S>>;
 /**
  * Creates new relation.
  * @param schema - Relation schema.
@@ -64,12 +101,13 @@ export type MakeProps<S extends Type.Relation.Any> = RelationMakeProps<Schema.Sc
  * @param meta - Relation metadata. (deprecated; use [Obj.Meta] instead)
  * @returns
  */
-export declare const make: <S extends Type.Relation.Any>(schema: S, props: NoInfer<RelationMakeProps<Schema.Schema.Type<S>>>, meta?: ObjectMeta) => Schema.Schema.Type<S> & Entity.OfKind<typeof Entity.Kind.Relation>;
+export declare const make: <S extends Type.AnyRelation>(schema: S, props: NoInfer<MakeProps<S>>) => Schema.Schema.Type<S> & Entity.OfKind<typeof Entity.Kind.Relation>;
 /**
  * Type guard for relations.
  * Returns true for both reactive relations and relation snapshots.
  */
 export declare const isRelation: (value: unknown) => value is Unknown;
+export declare const isSnapshot: (value: unknown) => value is Snapshot;
 /**
  * @returns Relation source DXN.
  * Accepts both reactive relations and snapshots.
@@ -87,26 +125,26 @@ export declare const getTargetDXN: (value: Unknown | Snapshot) => DXN;
  * Accepts both reactive relations and snapshots.
  * @throws If the object is not a relation.
  */
-export declare const getSource: <T extends Unknown | Snapshot>(relation: T) => Type.Relation.Source<T>;
+export declare const getSource: <T extends Unknown | Snapshot>(relation: T) => SourceOf<T>;
 /**
  * @returns Relation target.
  * Accepts both reactive relations and snapshots.
  * @throws If the object is not a relation.
  */
-export declare const getTarget: <T extends Unknown | Snapshot>(relation: T) => Type.Relation.Target<T>;
+export declare const getTarget: <T extends Unknown | Snapshot>(relation: T) => TargetOf<T>;
 /**
  * Makes all properties mutable recursively.
- * Used to provide a mutable view of a relation within `Relation.change`.
+ * Used to provide a mutable view of a relation within `Relation.update`.
  */
-export type { Mutable };
+export type Mutable<T> = internal.Mutable<T>;
 /**
  * Perform mutations on an echo relation within a controlled context.
  *
  * All mutations within the callback are batched and trigger a single notification
- * when the callback completes. Direct mutations outside of `Relation.change` will throw
+ * when the callback completes. Direct mutations outside of `Relation.update` will throw
  * an error for echo relations.
  *
- * @param relation - The echo relation to mutate. Use `Obj.change` for objects.
+ * @param relation - The echo relation to mutate. Use `Obj.update` for objects.
  * @param callback - The callback that performs mutations on the relation.
  *
  * @example
@@ -117,15 +155,15 @@ export type { Mutable };
  *   role: 'Engineer',
  * });
  *
- * // Mutate within Relation.change
- * Relation.change(worksFor, (r) => {
- *   r.role = 'Senior Engineer';
+ * // Mutate within Relation.update
+ * Relation.update(worksFor, (obj) => {
+ *   obj.role = 'Senior Engineer';
  * });
  * ```
  *
- * Note: Only accepts relations. Use `Obj.change` for objects.
+ * Note: Only accepts relations. Use `Obj.update` for objects.
  */
-export declare const change: <T extends Unknown>(relation: T, callback: ChangeCallback<T>) => void;
+export declare const update: <T extends Unknown>(relation: T, callback: internal.ChangeCallback<T>) => void;
 /**
  * Returns an immutable snapshot of a relation.
  * The snapshot is branded with SnapshotKindId instead of KindId,
@@ -146,7 +184,7 @@ export declare const subscribe: (rel: Unknown, callback: () => void) => (() => v
 export declare const getValue: (rel: Unknown | Snapshot, path: readonly (string | number)[]) => any;
 /**
  * Set a deeply nested property on a relation.
- * Must be called within a `Relation.change` callback.
+ * Must be called within a `Relation.update` callback.
  *
  * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
  * parameters, so there is no compile-time error. Enforcement is runtime-only.
@@ -160,12 +198,12 @@ export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
 /**
  * @returns The DXN of the relation's type.
  */
-export declare const getTypeDXN: (obj: import("./internal").AnyProperties) => DXN | undefined;
+export declare const getTypeDXN: (obj: internal.AnyProperties) => DXN | undefined;
 /**
  * Get the schema of the relation.
  * Returns the branded ECHO schema used to create the relation.
  */
-export declare const getSchema: (rel: unknown | undefined) => Type.Entity.Any | undefined;
+export declare const getSchema: (rel: unknown | undefined) => Type.AnyEntity | undefined;
 /**
  * @returns The typename of the relation's type.
  * Accepts both reactive relations and snapshots.
@@ -176,17 +214,23 @@ export declare const getTypename: (entity: Unknown | Snapshot) => string | undef
  * Accepts both reactive relations and snapshots.
  */
 export declare const getDatabase: (entity: Unknown | Snapshot) => Database.Database | undefined;
+/**
+ * Property that accesses metadata for an entity.
+ *
+ * Alias for `Entity.Meta`.
+ */
+export declare const Meta: symbol;
 /**
  * Deeply read-only version of ObjectMeta.
  */
-export type ReadonlyMeta = ApiReadonlyMeta;
+export type ReadonlyMeta = internal.ReadonlyMeta;
 /**
- * Mutable meta type returned by `Relation.getMeta` inside a `Relation.change` callback.
+ * Mutable meta type returned by `Relation.getMeta` inside a `Relation.update` callback.
  */
-export type Meta = ApiMeta;
+export type Meta = internal.Meta;
 /**
  * Get the metadata for a relation.
- * Returns mutable meta when passed a mutable relation (inside `Relation.change` callback).
+ * Returns mutable meta when passed a mutable relation (inside `Relation.update` callback).
  * Returns read-only meta when passed a regular relation or snapshot.
  */
 export declare function getMeta(entity: Mutable<Unknown>): Meta;
@@ -198,7 +242,7 @@ export declare function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
 export declare const getKeys: (entity: Unknown | Snapshot, source: string) => ForeignKey[];
 /**
  * Delete all keys from the relation for the specified source.
- * Must be called within a `Relation.change` callback.
+ * Must be called within a `Relation.update` callback.
  *
  * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
  * parameters, so there is no compile-time error. Enforcement is runtime-only.
@@ -206,7 +250,7 @@ export declare const getKeys: (entity: Unknown | Snapshot, source: string) => Fo
 export declare const deleteKeys: (entity: Mutable<Unknown>, source: string) => void;
 /**
  * Add a tag to the relation.
- * Must be called within a `Relation.change` callback.
+ * Must be called within a `Relation.update` callback.
  *
  * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
  * parameters, so there is no compile-time error. Enforcement is runtime-only.
@@ -214,7 +258,7 @@ export declare const deleteKeys: (entity: Mutable<Unknown>, source: string) => v
 export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
 /**
  * Remove a tag from the relation.
- * Must be called within a `Relation.change` callback.
+ * Must be called within a `Relation.update` callback.
  *
  * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
  * parameters, so there is no compile-time error. Enforcement is runtime-only.
@@ -232,7 +276,7 @@ export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
 export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
 /**
  * Set the label of the relation.
- * Must be called within a `Relation.change` callback.
+ * Must be called within a `Relation.update` callback.
  *
  * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
  * parameters, so there is no compile-time error. Enforcement is runtime-only.
@@ -245,7 +289,7 @@ export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void
 export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
 /**
  * Set the description of the relation.
- * Must be called within a `Relation.change` callback.
+ * Must be called within a `Relation.update` callback.
  *
  * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
  * parameters, so there is no compile-time error. Enforcement is runtime-only.
@@ -254,7 +298,7 @@ export declare const setDescription: (entity: Mutable<Unknown>, description: str
 /**
  * JSON representation of a relation.
  */
-export type JSON = APIJSON;
+export type JSON = internal.ObjectJSON;
 /**
  * Converts relation to its JSON representation.
  * Accepts both reactive relations and snapshots.
@@ -264,18 +308,20 @@ export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
  * Comparator function type for sorting relations.
  * Accepts both reactive relations and snapshots.
  */
-export type Comparator = ApiComparator<Unknown | Snapshot>;
+export type Comparator = internal.Comparator<Unknown | Snapshot>;
 export declare const sortByLabel: Comparator;
 export declare const sortByTypename: Comparator;
 export declare const sort: (...comparators: Comparator[]) => Comparator;
-export { VersionTypeId, isVersion };
+export declare const VersionTypeId: "~@dxos/echo/VersionTypeId";
+export declare const isVersion: (entity: unknown) => entity is internal.EntityVersion;
 /**
  * Represent relation version.
  */
-export type Version = ApiVersion;
+export type Version = internal.EntityVersion;
 /**
  * Returns the version of the relation.
  * Accepts both reactive relations and snapshots.
  */
 export declare const version: (entity: Unknown | Snapshot) => Version;
+export {};
 //# sourceMappingURL=Relation.d.ts.map