@dxos/echo 0.8.4-main.fffef41 → 0.8.4-staging.ac66bdf99f

package/dist/types/src/Obj.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Obj.test.d.ts","sourceRoot":"","sources":["../../../src/Obj.test.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,16 @@
+import { type QueryAST } from '@dxos/echo-protocol';
+export interface Order<T> {
+    '~Order': {
+        value: T;
+    };
+    ast: QueryAST.Order;
+}
+export type Any = Order<any>;
+export declare const natural: Order<any>;
+export declare const property: <T>(property: keyof T & string, direction: QueryAST.OrderDirection) => Order<T>;
+/**
+ * Order by relevance rank (for FTS/vector search results).
+ * Higher rank = better match. Default direction is 'desc' (best matches first).
+ */
+export declare const rank: <T>(direction?: QueryAST.OrderDirection) => Order<T>;
+//# sourceMappingURL=Order.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../../src/Order.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,WAAW,KAAK,CAAC,CAAC;IAEtB,QAAQ,EAAE;QAAE,KAAK,EAAE,CAAC,CAAA;KAAE,CAAC;IAEvB,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;CACrB;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;AAc7B,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC,GAAG,CAAuC,CAAC;AACvE,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,UAAU,MAAM,CAAC,GAAG,MAAM,EAAE,WAAW,QAAQ,CAAC,cAAc,KAAG,KAAK,CAAC,CAAC,CAKhG,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,YAAW,QAAQ,CAAC,cAAuB,KAAG,KAAK,CAAC,CAAC,CAIzE,CAAC"}

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

@@ -0,0 +1,209 @@
+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 Relation from './Relation';
+/**
+ * All property paths inside T that are references.
+ */
+type RefPropKey<T> = keyof T & string;
+export interface Query<T> {
+    '~Query': {
+        value: T;
+    };
+    ast: QueryAST.Query;
+    /**
+     * Filter the current selection based on a filter.
+     * @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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>>;
+    /**
+     * 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>>;
+    /**
+     * For a query for relations, get the source objects.
+     * @returns Query for the source objects.
+     */
+    'source'(): Query<Relation.SourceOf<T>>;
+    /**
+     * For a query for relations, get the target objects.
+     * @returns Query for the target objects.
+     */
+    'target'(): Query<Relation.TargetOf<T>>;
+    /**
+     * Get the parent object of the current selection.
+     * @returns Query for the parent objects.
+     */
+    'parent'(): Query<any>;
+    /**
+     * Get all child objects of the current selection.
+     * @returns Query for the child objects.
+     */
+    '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>;
+    /**
+     * Limit the number of results.
+     * @param limit - Maximum number of results to return.
+     * @returns Query for the limited results.
+     */
+    '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>;
+}
+export type Any = Query<any>;
+export type Type<Q extends Any> = Q extends Query<infer T> ? T : never;
+export declare const is: (value: unknown) => value is Any;
+/** Construct a query from an ast. */
+export declare const fromAst: (ast: QueryAST.Query) => Any;
+/**
+ * Select objects based on a filter.
+ * @param filter - Filter to select the objects.
+ * @returns Query for the selected objects.
+ */
+export declare const select: <F extends Filter.Any>(filter: F) => Query<Filter.Type<F>>;
+/**
+ * Query for objects of a given schema.
+ * @param schema - Schema of the objects.
+ * @param predicates - Predicates to filter the objects.
+ * @returns Query for the objects.
+ *
+ * Shorthand for: `Query.select(Filter.type(schema, predicates))`.
+ */
+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.
+ * @returns Query for the combined results.
+ */
+export declare const all: (...queries: Any[]) => Any;
+/**
+ * Subtract one query from another.
+ * @param source - Query to subtract from.
+ * @param exclude - Query to subtract.
+ * @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

@@ -0,0 +1 @@
+{"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;CACrD;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;AA4NvE,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,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,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;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,GACf,QACI,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,EAC3B,UAAU;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,KACnC,GAOF,CAAC;AAYF;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,GAAG,KAAG,MAAyC,CAAC"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Query.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Query.test.d.ts","sourceRoot":"","sources":["../../../src/Query.test.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,80 @@
+import { type CleanupFn } from '@dxos/async';
+import type * as Entity from './Entity';
+/**
+ * Individual query result entry.
+ */
+export type Entry<T> = {
+    id: string;
+    /**
+     * May not be present for remote results.
+     */
+    result?: T;
+    match?: {
+        /**
+         * Higher means better match.
+         */
+        rank: number;
+    };
+    /**
+     * Query resolution metadata.
+     */
+    resolution?: {
+        source: 'remote' | 'local' | 'index';
+        /**
+         * Query resolution time in milliseconds.
+         */
+        time: number;
+    };
+};
+/**
+ * Invidual query result entry for a database Entity.
+ */
+export type EntityEntry<T extends Entity.Unknown = Entity.Unknown> = Entry<T>;
+export type RunOptions = {
+    timeout?: number;
+};
+export type SubscriptionOptions = {
+    /**
+     * Fire the callback immediately.
+     */
+    fire?: boolean;
+};
+export interface QueryResult<T> {
+    /**
+     * Currently available results along with their match metadata.
+     */
+    readonly entries: Entry<T>[];
+    /**
+     * Currently available results.
+     */
+    readonly results: T[];
+    /**
+     * Returns all known results.
+     */
+    run(opts?: RunOptions): Promise<T[]>;
+    /**
+     * Returns all known results along with their match metadata.
+     */
+    runEntries(opts?: RunOptions): Promise<Entry<T>[]>;
+    /**
+     * Returns currently available results synchronously.
+     */
+    runSync(): T[];
+    /**
+     * Returns currently available results synchronously along with their match metadata.
+     */
+    runSyncEntries(): Entry<T>[];
+    /**
+     * Returns first result.
+     */
+    first(opts?: RunOptions): Promise<T>;
+    /**
+     * Returns first result if there is one.
+     */
+    firstOrUndefined(opts?: RunOptions): Promise<T | undefined>;
+    /**
+     * Subscribes to changes in query results.
+     */
+    subscribe(callback?: (query: QueryResult<T>) => void, opts?: SubscriptionOptions): CleanupFn;
+}
+//# sourceMappingURL=QueryResult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"QueryResult.d.ts","sourceRoot":"","sources":["../../../src/QueryResult.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;IACrB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC;IAEX,KAAK,CAAC,EAAE;QAGN;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF;;OAEG;IAEH,UAAU,CAAC,EAAE;QAEX,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;QAErC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;AAE9E,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAGF,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf;;OAEG;IACH,cAAc,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7B;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErC;;OAEG;IACH,gBAAgB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAE5D;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CAC9F"}

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

@@ -1,21 +1,71 @@
-import * as EchoSchema from './internal';
+import type * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import type * as Entity from './Entity';
+import * as refInternal from './internal/Ref';
 import type * as Obj from './Obj';
-export type Ref<T> = EchoSchema.Ref<T>;
-export type Any = EchoSchema.Ref<Obj.Any>;
+/**
+ * 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 EchoSchema.AnyEchoObject>(refs: readonly EchoSchema.Ref<T>[]) => T[];
-    loadAll: <T extends EchoSchema.AnyEchoObject>(refs: readonly EchoSchema.Ref<T>[]) => Promise<T[]>;
-    removeById: (refs: EchoSchema.Ref<EchoSchema.AnyEchoObject>[], id: EchoSchema.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 Any> = R extends EchoSchema.Ref<infer T> ? T : never;
+export type Target<R extends Unknown> = R extends refInternal.Ref<infer T> ? T : never;
 /**
  * Reference resolver.
  */
-export type Resolver = EchoSchema.RefResolver;
-export declare const isRef: (value: unknown) => value is Any;
-export declare const make: <T extends EchoSchema.WithId>(object: T) => EchoSchema.Ref<T>;
-export declare const fromDXN: (dxn: import("@dxos/keys").DXN) => EchoSchema.Ref<any>;
+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) => refInternal.Ref<T>;
+export declare const fromDXN: (dxn: import("@dxos/keys").DXN) => refInternal.Ref<any>;
+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":"AAIA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAElC,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACvC,MAAM,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE1C,eAAO,MAAM,KAAK;;;;EAAsB,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,CAAC;AAE9C,eAAO,MAAM,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,GAA0B,CAAC;AAE5E,eAAO,MAAM,IAAI,+DAAsB,CAAC;AAGxC,eAAO,MAAM,OAAO,wDAAyB,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;AAG/C,eAAO,MAAM,SAAS,GAAI,KAAK,SAAS,CAAC,GAAG,KAAG,OAS9C,CAAC"}