@dxos/echo 0.8.4-main.66e292d → 0.8.4-main.69d29f4

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

@@ -1,25 +1,40 @@
-import type { ObjectId } from '@dxos/keys';
-import { EntityKind, KindId } from './internal';
-export { KindId };
+import type { ForeignKey } from '@dxos/echo-protocol';
+import type { DXN, ObjectId } from '@dxos/keys';
+import { type ChangeCallback, EntityKind, KindId, type Mutable, type ObjectJSON, type ObjectMeta, type ReadonlyMeta, SnapshotKindId } from './internal';
+export { KindId, SnapshotKindId };
 export declare const Kind: typeof EntityKind;
 export type Kind = EntityKind;
 export declare const KindSchema: import("effect/Schema").Enums<typeof EntityKind>;
 /**
  * Assigns a kind to an Object or Relation instance.
+ * NOTE: Needed to make `isRelation` and `isObject` checks work.
  */
 export interface OfKind<K extends Kind> {
     readonly [KindId]: K;
     readonly id: ObjectId;
 }
+/**
+ * Assigns a snapshot kind to an Object or Relation snapshot.
+ */
+export interface SnapshotOfKind<K extends Kind> {
+    readonly [SnapshotKindId]: K;
+    readonly id: ObjectId;
+}
 /**
  * Obj or Relation with a specific set of properties.
  */
 export type Entity<Props> = OfKind<Kind> & Props;
 /**
- * Unknown Obj or Relation.
+ * Unknown Obj or Relation (reactive).
  */
 export interface Unknown extends OfKind<Kind> {
 }
+/**
+ * Snapshot of an Obj or Relation.
+ * Branded with SnapshotKindId instead of KindId.
+ */
+export interface Snapshot extends SnapshotOfKind<Kind> {
+}
 /**
  * Object with arbitrary properties.
  *
@@ -27,10 +42,101 @@ export interface Unknown extends OfKind<Kind> {
  * In that case, use `Obj.instanceOf` to check if an object is of a specific type.
  *
  * This type is very permissive and allows accessing any property on the object.
- * We should move to Obj.Any that is not permissive and requires explicit instanceof checks..
+ * We should move to Obj.Unknown that is not permissive and requires explicit instanceof checks..
  */
 export interface Any extends OfKind<Kind> {
     [key: string]: unknown;
 }
 export declare const getKind: (schema: import("effect/Schema").Schema.All) => EntityKind | undefined;
+/**
+ * JSON representation of an entity.
+ */
+export type JSON = ObjectJSON;
+/**
+ * Get the DXN of an entity (object or relation).
+ */
+export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
+/**
+ * Get the DXN of an entity's type.
+ */
+export declare const getTypeDXN: (obj: import("./internal").AnyProperties) => DXN | undefined;
+/**
+ * Get the typename of an entity's type.
+ */
+export declare const getTypename: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Get the database an entity belongs to.
+ */
+export declare const getDatabase: (entity: Unknown | Snapshot) => any | undefined;
+/**
+ * Get the metadata for an entity.
+ * Returns mutable meta when passed a mutable entity (inside change callback).
+ * Returns read-only meta when passed a regular entity or snapshot.
+ */
+export declare function getMeta(entity: Mutable<Unknown>): ObjectMeta;
+export declare function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
+/**
+ * Get foreign keys for an entity from the specified source.
+ */
+export declare const getKeys: (entity: Unknown | Snapshot, source: string) => ForeignKey[];
+/**
+ * Check if an entity is deleted.
+ */
+export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
+/**
+ * Get the label of an entity.
+ */
+export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Get the description of an entity.
+ */
+export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Convert an entity to its JSON representation.
+ */
+export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
+/**
+ * Subscribe to changes on an entity (object or relation).
+ * @returns Unsubscribe function.
+ */
+export declare const subscribe: (entity: Unknown, callback: () => void) => (() => void);
+/**
+ * Used to provide a mutable view of an entity within `Entity.change`.
+ */
+export type { Mutable };
+/**
+ * Perform mutations on an entity (object or relation) within a change context.
+ *
+ * Entities are read-only by default. Mutations are batched and notifications fire
+ * when the callback completes. Direct mutations outside of `Entity.change` will throw
+ * at runtime.
+ *
+ * @param entity - The echo entity (object or relation) to mutate.
+ * @param callback - Receives a mutable view of the entity. All mutations must occur here.
+ *
+ * @example
+ * ```typescript
+ * // Mutate within Entity.change
+ * Entity.change(entity, (e) => {
+ *   e.name = 'Updated';
+ *   e.count = 42;
+ * });
+ *
+ * // Direct mutation throws
+ * entity.name = 'Bob'; // Error: Cannot modify outside Entity.change()
+ * ```
+ *
+ * Note: For type-specific operations, prefer `Obj.change` or `Relation.change`.
+ */
+export declare const change: <T extends Unknown>(entity: T, callback: ChangeCallback<T>) => void;
+/**
+ * Add a tag to an entity.
+ * Must be called within an `Entity.change`, `Obj.change`, or `Relation.change` callback.
+ */
+export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
+/**
+ * Remove a tag from an entity.
+ * Must be called within an `Entity.change`, `Obj.change`, or `Relation.change` callback.
+ */
+export declare const removeTag: (entity: Mutable<Unknown>, tag: string) => void;
 //# sourceMappingURL=Entity.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../src/Entity.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAoB,MAAM,EAAiB,MAAM,YAAY,CAAC;AAEjF,OAAO,EAAE,MAAM,EAAE,CAAC;AAMlB,eAAO,MAAM,IAAI,mBAAa,CAAC;AAC/B,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC;AAC9B,eAAO,MAAM,UAAU,kDAAmB,CAAC;AAE3C;;GAEG;AAEH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,IAAI;IACpC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,IAAI,CAAC;CAAG;AAEhD;;;;;;;;GAQG;AACH,MAAM,WAAW,GAAI,SAAQ,MAAM,CAAC,IAAI,CAAC;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,OAAO,wEAAgB,CAAC"}
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../src/Entity.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EACL,KAAK,cAAc,EACnB,UAAU,EAEV,MAAM,EACN,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,cAAc,EAgBf,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;AAMlC,eAAO,MAAM,IAAI,mBAAa,CAAC;AAC/B,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC;AAC9B,eAAO,MAAM,UAAU,kDAAmB,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,IAAI;IACpC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,IAAI;IAC5C,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,IAAI,CAAC;CAAG;AAEhD;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc,CAAC,IAAI,CAAC;CAAG;AAEzD;;;;;;;;GAQG;AACH,MAAM,WAAW,GAAI,SAAQ,MAAM,CAAC,IAAI,CAAC;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,OAAO,wEAAgB,CAAC;AAQrC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAAsB,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,UAAU,8DAAc,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAiC,CAAC;AAEpG;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAAG,GAAG,SAAiC,CAAC;AAEjG;;;;GAIG;AAEH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC;AAC9D,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,YAAY,CAAC;AAKlE;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,GAAG,QAAQ,EAAE,QAAQ,MAAM,KAAG,UAAU,EAA8B,CAAC;AAE9G;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA6B,CAAC;AAErF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAA8B,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAoC,CAAC;AAE1G;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,IAAuB,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,EAAE,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAE5E,CAAC;AAMF;;GAEG;AACH,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC,EAAE,UAAU,cAAc,CAAC,CAAC,CAAC,KAAG,IAElF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA4B,CAAC;AAE5F;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA+B,CAAC"}

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

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

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

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

package/dist/types/src/{errors.d.ts → Err.d.ts}

@@ -2,28 +2,26 @@ import { BaseError, type BaseErrorOptions } from '@dxos/errors';
 import { type DXN } from '@dxos/keys';
 declare const SchemaNotFoundError_base: {
     new (options?: BaseErrorOptions): {
-        code: "SCHEMA_NOT_FOUND";
+        name: "SchemaNotFoundError";
         context: Record<string, unknown>;
-        readonly name: "SCHEMA_NOT_FOUND";
         readonly message: string;
-        readonly _tag: "SCHEMA_NOT_FOUND";
+        readonly _tag: "SchemaNotFoundError";
         stack?: string;
         cause?: unknown;
     };
-    code: "SCHEMA_NOT_FOUND";
+    name: "SchemaNotFoundError";
     is(error: unknown): error is BaseError;
     wrap(options?: Omit<BaseErrorOptions, "cause"> & {
         ifTypeDiffers?: boolean;
     }): (error: unknown) => {
-        code: "SCHEMA_NOT_FOUND";
+        name: "SchemaNotFoundError";
         context: Record<string, unknown>;
-        readonly name: "SCHEMA_NOT_FOUND";
         readonly message: string;
-        readonly _tag: "SCHEMA_NOT_FOUND";
+        readonly _tag: "SchemaNotFoundError";
         stack?: string;
         cause?: unknown;
     };
-    extend<Code extends string = string>(code: Code, message?: string): any;
+    extend<Name extends string = string>(name: Name, message?: string): any;
     isError(error: unknown): error is Error;
     captureStackTrace(targetObject: object, constructorOpt?: Function): void;
     prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
@@ -34,28 +32,26 @@ export declare class SchemaNotFoundError extends SchemaNotFoundError_base {
 }
 declare const ObjectNotFoundError_base: {
     new (options?: BaseErrorOptions): {
-        code: "OBJECT_NOT_FOUND";
+        name: "ObjectNotFoundError";
         context: Record<string, unknown>;
-        readonly name: "OBJECT_NOT_FOUND";
         readonly message: string;
-        readonly _tag: "OBJECT_NOT_FOUND";
+        readonly _tag: "ObjectNotFoundError";
         stack?: string;
         cause?: unknown;
     };
-    code: "OBJECT_NOT_FOUND";
+    name: "ObjectNotFoundError";
     is(error: unknown): error is BaseError;
     wrap(options?: Omit<BaseErrorOptions, "cause"> & {
         ifTypeDiffers?: boolean;
     }): (error: unknown) => {
-        code: "OBJECT_NOT_FOUND";
+        name: "ObjectNotFoundError";
         context: Record<string, unknown>;
-        readonly name: "OBJECT_NOT_FOUND";
         readonly message: string;
-        readonly _tag: "OBJECT_NOT_FOUND";
+        readonly _tag: "ObjectNotFoundError";
         stack?: string;
         cause?: unknown;
     };
-    extend<Code extends string = string>(code: Code, message?: string): any;
+    extend<Name extends string = string>(name: Name, message?: string): any;
     isError(error: unknown): error is Error;
     captureStackTrace(targetObject: object, constructorOpt?: Function): void;
     prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
@@ -65,4 +61,4 @@ export declare class ObjectNotFoundError extends ObjectNotFoundError_base {
     constructor(dxn: DXN, options?: BaseErrorOptions);
 }
 export {};
-//# sourceMappingURL=errors.d.ts.map
+//# sourceMappingURL=Err.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Err.d.ts","sourceRoot":"","sources":["../../../src/Err.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;qBAawgB,CAAC;;;;;;;;;;;;;;;AAX/iB,qBAAa,mBAAoB,SAAQ,wBAA2D;gBACtF,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;CAGvD;;;;;;;;;;;;;qBAO6iB,CAAC;;;;;;;;;;;;;;;AAL/iB,qBAAa,mBAAoB,SAAQ,wBAA2D;gBACtF,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,gBAAgB;CAGjD"}

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

@@ -0,0 +1,120 @@
+import * as Schema from 'effect/Schema';
+import type * as Types from 'effect/Types';
+import { type ForeignKey, type QueryAST } from '@dxos/echo-protocol';
+import { DXN, ObjectId } from '@dxos/keys';
+export interface Filter<T> {
+    '~Filter': {
+        value: Types.Contravariant<T>;
+    };
+    ast: QueryAST.Filter;
+}
+export type Props<T> = {
+    [K in keyof T & string]?: Filter<T[K]> | T[K];
+};
+export type Any = Filter<any>;
+export type Type<F extends Any> = F extends Filter<infer T> ? T : never;
+declare class FilterClass implements Any {
+    readonly ast: QueryAST.Filter;
+    private static variance;
+    constructor(ast: QueryAST.Filter);
+    '~Filter': {
+        value: Types.Contravariant<any>;
+    };
+}
+export declare const is: (value: unknown) => value is Any;
+/** Construct a filter from an ast. */
+export declare const fromAst: (ast: QueryAST.Filter) => Any;
+/**
+ * Filter that matches all objects.
+ */
+export declare const everything: () => FilterClass;
+/**
+ * Filter that matches no objects.
+ */
+export declare const nothing: () => FilterClass;
+export declare const id: (...ids: ObjectId[]) => Any;
+/**
+ * Filter by type.
+ */
+export declare const type: <S extends Schema.Schema.All>(schema: S | string, props?: Props<Schema.Schema.Type<S>>) => Filter<Schema.Schema.Type<S>>;
+/**
+ * Filter by non-qualified typename.
+ */
+export declare const typename: (typename: string) => Any;
+/**
+ * Filter by fully qualified type DXN.
+ */
+export declare const typeDXN: (dxn: DXN) => Any;
+/**
+ * Filter by tag.
+ */
+export declare const tag: (tag: string) => Any;
+/**
+ * Filter by properties.
+ */
+export declare const props: <T>(props: Props<T>) => Filter<T>;
+export type TextSearchOptions = {
+    type?: 'full-text' | 'vector';
+};
+/**
+ * Full-text or vector search.
+ */
+export declare const text: (text: string, options?: TextSearchOptions) => Any;
+/**
+ * Filter by foreign keys.
+ */
+export declare const foreignKeys: <S extends Schema.Schema.All>(schema: S | string, keys: ForeignKey[]) => Filter<Schema.Schema.Type<S>>;
+/**
+ * Predicate for property to be equal to the provided value.
+ */
+export declare const eq: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be not equal to the provided value.
+ */
+export declare const neq: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be greater than the provided value.
+ */
+export declare const gt: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be greater than or equal to the provided value.
+ */
+export declare const gte: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be less than the provided value.
+ */
+export declare const lt: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be less than or equal to the provided value.
+ */
+export declare const lte: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be in the provided array.
+ * @param values - Values to check against.
+ */
+declare const in$: <T>(...values: T[]) => Filter<T | undefined>;
+export { in$ as in };
+/**
+ * Predicate for an array property to contain the provided value.
+ * @param value - Value to check against.
+ */
+export declare const contains: <T>(value: T) => Filter<readonly T[] | undefined>;
+/**
+ * Predicate for property to be in the provided range.
+ * @param from - Start of the range (inclusive).
+ * @param to - End of the range (exclusive).
+ */
+export declare const between: <T>(from: T, to: T) => Filter<unknown>;
+/**
+ * Negate the filter.
+ */
+export declare const not: <F extends Any>(filter: F) => Filter<Type<F>>;
+/**
+ * Combine filters with a logical AND.
+ */
+export declare const and: <Filters extends readonly Any[]>(...filters: Filters) => Filter<Type<Filters[number]>>;
+/**
+ * Combine filters with a logical OR.
+ */
+export declare const or: <Filters extends readonly Any[]>(...filters: Filters) => Filter<Type<Filters[number]>>;
+//# sourceMappingURL=Filter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Filter.d.ts","sourceRoot":"","sources":["../../../src/Filter.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAErE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAK3C,MAAM,WAAW,MAAM,CAAC,CAAC;IAEvB,SAAS,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAE7C,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;KAEpB,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAE9B,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAExE,cAAM,WAAY,YAAW,GAAG;aAGF,GAAG,EAAE,QAAQ,CAAC,MAAM;IAFhD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAwC;gBAEnC,GAAG,EAAE,QAAQ,CAAC,MAAM;IAEhD,SAAS;;MAAwB;CAClC;AAED,eAAO,MAAM,EAAE,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,GAE5C,CAAC;AAEF,sCAAsC;AACtC,eAAO,MAAM,OAAO,GAAI,KAAK,QAAQ,CAAC,MAAM,KAAG,GAE9C,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,UAAU,QAAO,WAM7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,QAAO,WAS1B,CAAC;AAKF,eAAO,MAAM,EAAE,GAAI,GAAG,KAAK,QAAQ,EAAE,KAAG,GAiBvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9C,QAAQ,CAAC,GAAG,MAAM,EAClB,QAAQ,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAO9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,UAAU,MAAM,KAAG,GAO3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,KAAK,GAAG,KAAG,GAMlC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,KAAK,MAAM,KAAG,GAKjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,CAMlD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAEf,MAAM,MAAM,EACZ,UAAU,iBAAiB,KAC1B,GAMF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACrD,QAAQ,CAAC,GAAG,MAAM,EAClB,MAAM,UAAU,EAAE,KACjB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAQ9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAUpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,GAAG,GAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAKpD,CAAC;AACF,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;AAErB;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,SAAS,CAKrE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,KAAG,MAAM,CAAC,OAAO,CAMzD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,GAAG,EAAE,QAAQ,CAAC,KAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAK5D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,OAAO,SAAS,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,OAAO,KAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAKrG,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,OAAO,SAAS,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,OAAO,KAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAKpG,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Format.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,UAAU,IAAI,MAAM,EAAE,MAAM,YAAY,CAAC;AAIvD,cAAc,oBAAoB,CAAC;AAEnC,YAAY,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Format.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,UAAU,IAAI,MAAM,EAAE,MAAM,YAAY,CAAC;AAEvD,cAAc,oBAAoB,CAAC;AAEnC,YAAY,EAAE,MAAM,EAAE,CAAC"}

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

@@ -0,0 +1,60 @@
+import { type DXN } from '@dxos/keys';
+import type * as Database from './Database';
+import type * as Entity from './Entity';
+import { type AnyProperties } from './internal';
+import type * as Key from './Key';
+import type * as Ref from './Ref';
+import type * as SchemaRegistry from './SchemaRegistry';
+/**
+ * Resolution context.
+ * Affects how non-absolute DXNs are resolved.
+ */
+export interface RefResolutionContext {
+    /**
+     * Space that the resolution is happening from.
+     */
+    space?: Key.SpaceId;
+    /**
+     * Queue that the resolution is happening from.
+     * This queue will be searched first, and then the space it belongs to.
+     */
+    queue?: DXN;
+}
+export interface RefResolverOptions {
+    /**
+     * Resolution context.
+     * Affects how non-absolute DXNs are resolved.
+     */
+    context?: RefResolutionContext;
+    /**
+     * Middleware to change the resolved object before returning it.
+     * @deprecated On track to be removed.
+     */
+    middleware?: (obj: AnyProperties) => AnyProperties;
+}
+/**
+ *
+ */
+export interface Hypergraph extends Database.Queryable {
+    get schemaRegistry(): SchemaRegistry.SchemaRegistry;
+    /**
+     * Query objects.
+     */
+    query: Database.QueryFn;
+    /**
+     * Creates a reference to an existing object in the database.
+     *
+     * NOTE: The reference may be dangling if the object is not present in the database.
+     * NOTE: Difference from `Ref.fromDXN`
+     * `Ref.fromDXN(dxn)` returns an unhydrated reference. The `.load` and `.target` APIs will not work.
+     * `db.makeRef(dxn)` is preferable in cases with access to the database.
+     */
+    makeRef<T extends Entity.Unknown = Entity.Unknown>(dxn: DXN): Ref.Ref<T>;
+    /**
+     * @param hostDb Host database for reference resolution.
+     * @param middleware Called with the loaded object. The caller may change the object.
+     * @returns Result of `onLoad`.
+     */
+    createRefResolver(options: RefResolverOptions): Ref.Resolver;
+}
+//# sourceMappingURL=Hypergraph.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Hypergraph.d.ts","sourceRoot":"","sources":["../../../src/Hypergraph.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,cAAc,MAAM,kBAAkB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAE/B;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,aAAa,CAAC;CACpD;AAED;;GAEG;AAEH,MAAM,WAAW,UAAW,SAAQ,QAAQ,CAAC,SAAS;IACpD,IAAI,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC;IAEpD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;IAExB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEzE;;;;OAIG;IAEH,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,GAAG,CAAC,QAAQ,CAAC;CAC9D"}