@dxos/echo 0.8.4-main.548089c → 0.8.4-main.59c2e9b

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

@@ -1,44 +1,70 @@
 import * as Schema from 'effect/Schema';
-import { type DXN } from '@dxos/keys';
-import * as LiveObject from '@dxos/live-object';
-import * as EchoSchema from './internal';
+import type { ForeignKey } from '@dxos/echo-protocol';
+import { type DXN, ObjectId } from '@dxos/keys';
+import type * as Database from './Database';
+import * as Entity from './Entity';
+import { type ObjectJSON as APIJSON, type AnyEntity, type AnyProperties, type Comparator as ApiComparator, type Meta as ApiMeta, type ReadonlyMeta as ApiReadonlyMeta, type EntityVersion as ApiVersion, type ChangeCallback, type KindId, type Mutable, type ObjectMeta, type SnapshotKindId, type VersionCompareResult, VersionTypeId, compareVersions, decodeVersion, encodeVersion, isVersion, versionValid } from './internal';
 import type * as Ref from './Ref';
-import type * as Relation from './Relation';
-import * as Type from './Type';
+import type * as Type from './Type';
 /**
- * NOTE: Don't export: Obj.Any and Obj.Obj form the public API.
+ * Base type for all ECHO objects.
  */
-interface BaseObj extends EchoSchema.HasId, Type.OfKind<EchoSchema.EntityKind.Object> {
+interface BaseObj extends AnyEntity, Entity.OfKind<typeof Entity.Kind.Object> {
 }
 /**
  * Object type with specific properties.
  */
 export type Obj<Props> = BaseObj & Props;
 /**
- * Base type for all ECHO objects.
- * This type does not define any properties.
+ * Object with no known properties beyond id and kind.
+ * Use this when the object's schema/properties are not known.
+ * For objects with arbitrary properties, use `Obj.AnyProps`.
+ *
+ * NOTE: This is a TypeScript type only, not a schema.
+ * To validate that a value is an ECHO object, use `Schema.is(Type.Obj)`.
  */
-export interface Any extends BaseObj {
+export interface Unknown extends BaseObj {
 }
 /**
  * Object with arbitrary properties.
  *
- * NOTE: Due to how typescript works, this type is not assignable to a specific schema type.
+ * NOTE: Due to how TypeScript works, this type is not assignable to a specific schema type.
  * In that case, use `Obj.instanceOf` to check if an object is of a specific type.
+ *
+ * Prefer using `Obj.Unknown` when you don't need to access arbitrary properties.
  */
-export interface AnyProps extends BaseObj {
-    [key: string]: any;
+export interface Any extends BaseObj, AnyProperties {
 }
-export declare const Any: Type.obj<Schema.Struct<{}>>;
+/**
+ * Base type for snapshot objects (has SnapshotKindId instead of KindId).
+ */
+interface BaseSnapshot extends AnyEntity {
+    readonly [SnapshotKindId]: typeof Entity.Kind.Object;
+    readonly id: ObjectId;
+}
+/**
+ * Immutable snapshot of an ECHO object.
+ * Branded with SnapshotKindId (not KindId).
+ * Property values are frozen at the time the snapshot was created.
+ * Returned by getSnapshot() and hooks like useObject().
+ *
+ * Snapshots are structurally identical to reactive objects but have a different brand,
+ * making them distinguishable at the TypeScript level. Neither is assignable to the other.
+ */
+export type Snapshot<T extends Unknown = Unknown> = Omit<T, KindId> & BaseSnapshot;
 type Props<T = any> = {
-    id?: EchoSchema.ObjectId;
+    id?: ObjectId;
+    [Meta]?: Partial<ObjectMeta>;
 } & Type.Properties<T>;
-export type MakeProps<T extends Type.Obj.Any> = NoInfer<Props<Schema.Schema.Type<T>>> & {
-    [Meta]?: Partial<EchoSchema.ObjectMeta>;
-};
-export declare const Meta: unique symbol;
 /**
- * Creates new object.
+ * Props type for object creation with a given schema.
+ */
+export type MakeProps<S extends Schema.Schema.AnyNoContext> = {
+    id?: ObjectId;
+    [Meta]?: Partial<ObjectMeta>;
+} & NoInfer<Props<Schema.Schema.Type<S>>>;
+/**
+ * Creates a new echo object of the given schema.
  * @param schema - Object schema.
  * @param props - Object properties.
  * @param meta - Object metadata (deprecated) -- pass with Obj.Meta.
@@ -49,16 +75,143 @@ export declare const Meta: unique symbol;
  * ```ts
  * const obj = Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' });
  * ```
+ *
+ * Note: Only accepts object schemas, not relation schemas. Use `Relation.make` for relations.
+ */
+export declare const make: {
+    <S extends Type.Obj.Any>(schema: S, props: MakeProps<S>): Obj<Schema.Schema.Type<S>>;
+    /**
+     * @deprecated Pass meta as in the example: `Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' })`.
+     */
+    <S extends Type.Obj.Any>(schema: S, props: MakeProps<S>, meta: Partial<ObjectMeta>): Obj<Schema.Schema.Type<S>>;
+};
+/**
+ * Determine if object is an ECHO object.
  */
-export declare const make: <S extends Type.Obj.Any>(schema: S, props: MakeProps<S>, meta?: Partial<EchoSchema.ObjectMeta>) => LiveObject.Live<Schema.Schema.Type<S>>;
-export declare const isObject: (obj: unknown) => obj is Any;
+export declare const isObject: (obj: unknown) => obj is Unknown;
+/**
+ * Subscribe to object updates.
+ * The callback is called synchronously when the object is modified.
+ * Only accepts reactive objects (not snapshots).
+ * @returns Unsubscribe function.
+ */
+export declare const subscribe: (obj: Unknown, callback: () => void) => (() => void);
+/**
+ * Returns an immutable snapshot of an object.
+ * The snapshot is branded with SnapshotKindId instead of KindId,
+ * making it distinguishable from the reactive object at the type level.
+ */
+export declare const getSnapshot: <T extends Unknown>(obj: T) => Snapshot<T>;
+export type CloneOptions = {
+    /**
+     * Retain the original object's ID.
+     * @default false
+     */
+    retainId?: boolean;
+    /**
+     * Recursively clone referenced objects.
+     * @default false
+     */
+    deep?: boolean;
+};
+/**
+ * Clones an object or relation.
+ * This does not clone referenced objects, only the properties in the object.
+ * @returns A new object with the same schema and properties.
+ */
+export declare const clone: <T extends Unknown>(obj: T, opts?: CloneOptions) => T;
+/**
+ * Makes all properties mutable recursively.
+ * Used to provide a mutable view of an object within `Obj.change`.
+ */
+export type { Mutable };
+/**
+ * Perform mutations on an echo object within a controlled context.
+ *
+ * All mutations within the callback are batched and trigger a single notification
+ * when the callback completes. Direct mutations outside of `Obj.change` will throw
+ * an error for echo objects.
+ *
+ * This function also works with nested objects within echo objects (e.g., Template structs)
+ * that are reactive at runtime.
+ *
+ * @param obj - The echo object to mutate. Use `Relation.change` for relations.
+ * @param callback - The callback that performs mutations on the object.
+ *
+ * @example
+ * ```ts
+ * const person = Obj.make(Person, { name: 'John', age: 25 });
+ *
+ * // Mutate within Obj.change
+ * Obj.change(person, (p) => {
+ *   p.name = 'Jane';
+ *   p.age = 30;
+ * });
+ * // ONE notification fires here
+ *
+ * // Direct mutation throws
+ * person.name = 'Bob'; // Error: Cannot modify outside Obj.change()
+ * ```
+ *
+ * Note: Only accepts objects. Use `Relation.change` for relations.
+ */
+export declare const change: <T extends Unknown>(obj: T, callback: ChangeCallback<T>) => void;
+/**
+ * Get a deeply nested property from an object.
+ *
+ * Similar to lodash.get and getDeep from @dxos/util.
+ * This is the complementary function to setValue.
+ * Accepts both reactive objects and snapshots.
+ *
+ * @param obj - The ECHO object to get the property from.
+ * @param path - Path to the property (array of keys).
+ * @returns The value at the path, or undefined if not found.
+ *
+ * @example
+ * ```ts
+ * const person = Obj.make(Person, {
+ *   name: 'John',
+ *   addresses: [{ street: '123 Main St' }]
+ * });
+ *
+ * Obj.getValue(person, ['addresses', 0, 'street']); // '123 Main St'
+ * Obj.getValue(person, ['addresses', 1, 'street']); // undefined
+ * ```
+ */
+export declare const getValue: (obj: Unknown | Snapshot, path: readonly (string | number)[]) => any;
+/**
+ * Set a deeply nested property on an object, using the object's schema to determine
+ * whether to initialize nested data as an empty object or array.
+ *
+ * Similar to lodash.set and setDeep from @dxos/util, but schema-aware.
+ * Must be called within an `Obj.change` 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.
+ *
+ * @param obj - The mutable ECHO object to set the property on.
+ * @param path - Path to the property (array of keys).
+ * @param value - Value to set.
+ * @returns The value that was set.
+ *
+ * @example
+ * ```ts
+ * const person = Obj.make(Person, { name: 'John' });
+ * // Person schema has: addresses: Schema.mutable(Schema.Array(Address))
+ * Obj.change(person, (p) => {
+ *   Obj.setValue(p, ['addresses', 0, 'street'], '123 Main St');
+ * });
+ * // Creates: person.addresses = [{ street: '123 Main St' }]
+ * ```
+ */
+export declare const setValue: (obj: Mutable<Unknown>, path: readonly (string | number)[], value: any) => void;
+export declare const ID: import("@dxos/keys").ObjectIdClass;
+export type ID = ObjectId;
 /**
  * Test if object or relation is an instance of a schema.
  * @example
  * ```ts
  * const john = Obj.make(Person, { name: 'John' });
- * const johnIsPerson = Obj.instanceOf(Person)(john);
- *
  * const isPerson = Obj.instanceOf(Person);
  * if (isPerson(john)) {
  *   // john is Person
@@ -66,61 +219,144 @@ export declare const isObject: (obj: unknown) => obj is Any;
  * ```
  */
 export declare const instanceOf: {
-    <S extends Type.Relation.Any | Type.Obj.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
-    <S extends Type.Relation.Any | Type.Obj.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
+    <S extends Type.Entity.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
+    <S extends Type.Entity.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
 };
-export declare const getSchema: (obj: unknown | undefined) => Schema.Schema.AnyNoContext | undefined;
-export declare const getDXN: (obj: Any | Relation.Any) => DXN;
+/**
+ * Get the DXN of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
 /**
  * @returns The DXN of the object's type.
  * @example dxn:example.com/type/Person:1.0.0
  */
-export declare const getTypeDXN: (obj: EchoSchema.BaseObject) => DXN | undefined;
+export declare const getTypeDXN: (obj: unknown | undefined) => DXN | undefined;
+/**
+ * Get the schema of the object.
+ * Returns the branded ECHO schema used to create the object.
+ */
+export declare const getSchema: (obj: unknown | undefined) => Type.Entity.Any | undefined;
 /**
  * @returns The typename of the object's type.
+ * Accepts both reactive objects and snapshots.
  * @example `example.com/type/Person`
  */
-export declare const getTypename: (obj: Any | Relation.Any) => string | undefined;
-export declare const getMeta: (obj: Any | Relation.Any) => EchoSchema.ObjectMeta;
+export declare const getTypename: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Get the database the object belongs to.
+ * Accepts both reactive objects and snapshots.
+ */
+export declare const getDatabase: (entity: Unknown | Snapshot) => Database.Database | undefined;
+export declare const Meta: unique symbol;
+/**
+ * Deeply read-only version of ObjectMeta.
+ * Prevents mutation at all nesting levels (e.g., `meta.keys.push()` is a TypeScript error).
+ */
+export type ReadonlyMeta = ApiReadonlyMeta;
+/**
+ * Mutable meta type returned by `Obj.getMeta` inside an `Obj.change` callback.
+ */
+export type Meta = ApiMeta;
+/**
+ * Get the metadata for an object.
+ * Returns mutable meta when passed a mutable object (inside `Obj.change` callback).
+ * Returns read-only meta when passed a regular object or snapshot.
+ *
+ * @example
+ * ```ts
+ * // Read-only access outside change callback
+ * const meta = Obj.getMeta(person);  // ReadonlyMeta
+ *
+ * // Mutable access inside change callback
+ * Obj.change(person, (p) => {
+ *   const meta = Obj.getMeta(p);     // ObjectMeta (mutable)
+ *   meta.tags ??= [];
+ *   meta.tags.push('important');
+ * });
+ * ```
+ */
+export declare function getMeta(entity: Mutable<Unknown>): ObjectMeta;
+export declare function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
 /**
  * @returns Foreign keys for the object from the specified source.
+ * Accepts both reactive objects and snapshots.
  */
 export declare const getKeys: {
-    (obj: Any | Relation.Any, source: string): EchoSchema.ForeignKey[];
-    (source: string): (obj: Any | Relation.Any) => EchoSchema.ForeignKey[];
+    (entity: Unknown | Snapshot, source: string): ForeignKey[];
+    (source: string): (entity: Unknown | Snapshot) => ForeignKey[];
 };
 /**
  * Delete all keys from the object for the specified source.
- * @param obj
- * @param source
- */
-export declare const deleteKeys: (obj: Any | Relation.Any, source: string) => void;
-export declare const isDeleted: (obj: Any | Relation.Any) => boolean;
-export declare const getLabel: (obj: Any | Relation.Any) => string | undefined;
-export declare const setLabel: (obj: Any | Relation.Any, label: string) => void;
-export declare const getDescription: (obj: Any | Relation.Any) => string | undefined;
-export declare const setDescription: (obj: Any | Relation.Any, description: string) => void;
-export declare const addTag: (obj: Any | Relation.Any, tag: string) => void;
-export declare const removeTag: (obj: Any | Relation.Any, tag: string) => void;
-export type Comparator = (a: Any, b: Any) => number;
-export declare const sortByLabel: Comparator;
-export declare const sortByTypename: Comparator;
-export declare const sort: (...comparators: Comparator[]) => Comparator;
+ * Must be called within an `Obj.change` 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.
+ */
+export declare const deleteKeys: (entity: Mutable<Unknown>, source: string) => void;
+/**
+ * Add a tag to the object.
+ * Must be called within an `Obj.change` 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.
+ */
+export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
+/**
+ * Remove a tag from the object.
+ * Must be called within an `Obj.change` 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.
+ */
+export declare const removeTag: (entity: Mutable<Unknown>, tag: string) => void;
+/**
+ * Check if the object is deleted.
+ * Accepts both reactive objects and snapshots.
+ */
+export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
+/**
+ * Get the label of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Set the label of the object.
+ * Must be called within an `Obj.change` 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.
+ */
+export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void;
+/**
+ * Get the description of the object.
+ * Accepts both reactive objects and snapshots.
+ */
+export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Set the description of the object.
+ * Must be called within an `Obj.change` 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.
+ */
+export declare const setDescription: (entity: Mutable<Unknown>, description: string) => void;
 /**
  * JSON representation of an object.
  */
-export type JSON = EchoSchema.ObjectJSON;
+export type JSON = APIJSON;
 /**
  * Converts object to its JSON representation.
+ * Accepts both reactive objects and snapshots.
  *
  * The same algorithm is used when calling the standard `JSON.stringify(obj)` function.
  */
-export declare const toJSON: (obj: Any | Relation.Any) => JSON;
+export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
 /**
  * Creates an object from its json representation, performing schema validation.
  * References and schemas will be resolvable if the `refResolver` is provided.
  *
- * The function need to be async to support resolving the schema as well as the relation endpoints.
+ * The function must be async to support resolving the schema as well as the relation endpoints.
  *
  * @param options.refResolver - Resolver for references. Produces hydrated references that can be resolved.
  * @param options.dxn - Override object DXN. Changes the result of `Obj.getDXN`.
@@ -128,62 +364,27 @@ export declare const toJSON: (obj: Any | Relation.Any) => JSON;
 export declare const fromJSON: (json: unknown, options?: {
     refResolver?: Ref.Resolver;
     dxn?: DXN;
-}) => Promise<Any>;
+}) => Promise<Unknown>;
 /**
- * Returns an immutable snapshot of an object.
+ * Comparator function type for sorting objects.
+ * Accepts both reactive objects and snapshots.
  */
-export declare const getSnapshot: <T extends Any>(obj: Obj<T>) => T;
-export type CloneOptions = {
-    /**
-     * Retain the original object's ID.
-     * @default false
-     */
-    retainId?: boolean;
-};
-/**
- * Clones an object or relation.
- * This does not clone referenced objects, only the properties in the object.
- * @returns A new object with the same schema and properties.
- */
-export declare const clone: <T extends Any | Relation.Any>(obj: T, opts?: CloneOptions) => T;
-export declare const VersionTypeId: symbol;
-export type VersionType = typeof VersionTypeId;
+export type Comparator = ApiComparator<Unknown | Snapshot>;
+export declare const sortByLabel: Comparator;
+export declare const sortByTypename: Comparator;
+export declare const sort: (...comparators: Comparator[]) => Comparator;
+export { VersionTypeId };
+export type { VersionCompareResult };
 /**
  * Represent object version.
  * May be backed by Automerge.
  * Objects with no history are not versioned.
  */
-export interface Version {
-    /**
-     * Whether the object is versioned.
-     */
-    versioned: boolean;
-    /**
-     * Automerge heads.
-     */
-    automergeHeads?: string[];
-}
-/**
- * Checks that `obj` is a version object.
- */
-export declare const isVersion: (obj: unknown) => obj is Version;
+export type Version = ApiVersion;
+export { isVersion, versionValid, compareVersions, encodeVersion, decodeVersion };
 /**
  * Returns the version of the object.
+ * Accepts both reactive objects and snapshots.
  */
-export declare const version: (obj: Any | Relation.Any) => Version;
-/**
- * Checks that `version` is a valid version object.
- */
-export declare const versionValid: (version: Version) => boolean;
-export type VersionCompareResult = 'unversioned' | 'equal' | 'different';
-/**
- * Compares two versions.
- * @param version1
- * @param version2
- * @returns 'unversioned' if either object is unversioned, 'equal' if the versions are equal, 'different' if the versions are different.
- */
-export declare const compareVersions: (version1: Version, version2: Version) => VersionCompareResult;
-export declare const encodeVersion: (version: Version) => string;
-export declare const decodeVersion: (version: string) => Version;
-export {};
+export declare const version: (entity: Unknown | Snapshot) => Version;
 //# sourceMappingURL=Obj.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Obj.d.ts","sourceRoot":"","sources":["../../../src/Obj.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAIhD,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,UAAU,OAAQ,SAAQ,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;CAAG;AAExF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,KAAK,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,GAAI,SAAQ,OAAO;CAAG;AAEvC;;;;;GAKG;AACH,MAAM,WAAW,QAAS,SAAQ,OAAO;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,eAAO,MAAM,GAAG,6BAKf,CAAC;AAEF,KAAK,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI;IAAE,EAAE,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAA;CAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAExE,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IACtF,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;CACzC,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,OAAO,MAAiC,CAAC;AAM5D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,EACzC,QAAQ,CAAC,EACT,OAAO,SAAS,CAAC,CAAC,CAAC,EACnB,OAAO,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,KACpC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAgBvC,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,GAG9C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CASjG,CAAC;AAEV,eAAO,MAAM,SAAS,sEAAuB,CAAC;AAG9C,eAAO,MAAM,MAAM,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,GAKhD,CAAC;AAEF;;;GAGG;AAEH,eAAO,MAAM,UAAU,iDAAqB,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAAM,GAAG,SAQ9D,CAAC;AAGF,eAAO,MAAM,OAAO,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,UAAU,CAAC,UAI5D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC;IACnE,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAK,UAAU,CAAC,UAAU,EAAE,CAAC;CAKvE,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,QAAQ,MAAM,SAQjE,CAAC;AAGF,eAAO,MAAM,SAAS,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,OAInD,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAAM,GAAG,SAK3D,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,OAAO,MAAM,SAK9D,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAAM,GAAG,SAKjE,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,aAAa,MAAM,SAK1E,CAAC;AAEF,eAAO,MAAM,MAAM,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,MAAM,SAI1D,CAAC;AAEF,eAAO,MAAM,SAAS,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,MAAM,SAW7D,CAAC;AAcF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC;AAEpD,eAAO,MAAM,WAAW,EAAE,UAAkE,CAAC;AAC7F,eAAO,MAAM,cAAc,EAAE,UAAwE,CAAC;AACtG,eAAO,MAAM,IAAI,GAAI,GAAG,aAAa,UAAU,EAAE,KAAG,UAWnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;AAEzC;;;;GAIG;AAEH,eAAO,MAAM,MAAM,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,IAAoC,CAAC;AAEtF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;IAAE,WAAW,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC;IAAC,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,KAAK,OAAO,CAAC,GAAG,CACxE,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAA0B,CAAC;AAErF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,OAAO,YAAY,KAAG,CAqBjF,CAAC;AAEF,eAAO,MAAM,aAAa,QAA2B,CAAC;AACtD,MAAM,MAAM,WAAW,GAAG,OAAO,aAAa,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,OAAO;IAGtB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAOD;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,KAAK,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,OAMjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,OAAO,KAAG,OAG/C,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG,OAAO,GAAG,WAAW,CAAC;AAEzE;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,OAAO,EAAE,UAAU,OAAO,KAAG,oBAgBtE,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,SAAS,OAAO,KAAG,MAEhD,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,SAAS,MAAM,KAAG,OAI/C,CAAC"}
+{"version":3,"file":"Obj.d.ts","sourceRoot":"","sources":["../../../src/Obj.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EACL,KAAK,UAAU,IAAI,OAAO,EAC1B,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,UAAU,IAAI,aAAa,EAChC,KAAK,IAAI,IAAI,OAAO,EACpB,KAAK,YAAY,IAAI,eAAe,EACpC,KAAK,aAAa,IAAI,UAAU,EAChC,KAAK,cAAc,EAEnB,KAAK,MAAM,EAEX,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,aAAa,EAIb,eAAe,EACf,aAAa,EAEb,aAAa,EAcb,SAAS,EAaT,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,UAAU,OAAQ,SAAQ,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,KAAK,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAM,WAAW,OAAQ,SAAQ,OAAO;CAAG;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,GAAI,SAAQ,OAAO,EAAE,aAAa;CAAG;AAEtD;;GAEG;AACH,UAAU,YAAa,SAAQ,SAAS;IACtC,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;IACrD,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;AAMnF,KAAK,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI;IACpB,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAGvB;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,IAAI;IAC5D,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB,CAAC,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF;;OAEG;IACH,CAAC,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAqBjH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,OAG9C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,OAAO,EAAE,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAEzE,CAAC;AAMF;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAuB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,CAAU,CAAC;AAMnF;;;GAGG;AACH,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,EAAE,KAAK,CAAC,EAAE,UAAU,cAAc,CAAC,CAAC,CAAC,KAAG,IAE/E,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,OAAO,GAAG,QAAQ,EAAE,MAAM,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAG,GAEtF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,eAAO,MAAM,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,KAAK,IAChF,CAAC;AAOnB,eAAO,MAAM,EAAE,oCAAW,CAAC;AAC3B,MAAM,MAAM,EAAE,GAAG,QAAQ,CAAC;AAE1B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAOhF,CAAC;AAGV;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAGnD,CAAC;AAEF;;;GAGG;AAEH,eAAO,MAAM,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,KAAK,GAAG,GAAG,SAA8B,CAAC;AAE5F;;;GAGG;AAEH,eAAO,MAAM,SAAS,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,SAA6B,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAiC,CAAC;AAMpG;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,QAAQ,CAAC,QAAQ,GAAG,SAAiC,CAAC;AAM/G,eAAO,MAAM,IAAI,EAAE,OAAO,MAAsB,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAI3B;;;;;;;;;;;;;;;;;GAiBG;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;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAC3D,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,KAAK,UAAU,EAAE,CAAC;CAC6C,CAAC;AAE/G;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,MAAM,KAAG,IAAmC,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA4B,CAAC;AAE5F;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA+B,CAAC;AAElG;;;GAGG;AAEH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA6B,CAAC;AAMrF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAA8B,CAAC;AAE9F;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,MAAM,KAAG,IAAgC,CAAC;AAEpG;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAoC,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,MAAM,KAAG,IACzC,CAAC;AAMvC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAE3B;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,IAAuB,CAAC;AAE5E;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;IAAE,WAAW,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC;IAAC,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,KAAK,OAAO,CAAC,OAAO,CACvF,CAAC;AAMxB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAC,CAAC;AAE3D,eAAO,MAAM,WAAW,EAAE,UAAuC,CAAC;AAClE,eAAO,MAAM,cAAc,EAAE,UAA0C,CAAC;AACxE,eAAO,MAAM,IAAI,GAAI,GAAG,aAAa,UAAU,EAAE,KAAG,UAAiD,CAAC;AAMtG,OAAO,EAAE,aAAa,EAAE,CAAC;AACzB,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC;AAEjC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA2B,CAAC"}

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

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

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":"AAIA,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"}