@dxos/echo 0.8.4-staging.ac66bdf99f → 0.9.0

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

@@ -1,29 +1,32 @@
+import * as Schema from 'effect/Schema';
 import type { ForeignKey } from '@dxos/echo-protocol';
-import type { DXN, ObjectId } from '@dxos/keys';
+import type { EntityId, URI } from '@dxos/keys';
 import * as internal from './internal';
+import type * as Ref from './Ref';
 import type * as Relation from './Relation';
-import type * as Type from './Type';
+import type * as Tag from './Tag';
+import * as Type from './Type';
 export declare const KindId: "~@dxos/echo/Kind";
 export type KindId = typeof internal.KindId;
 export declare const SnapshotKindId: "~@dxos/echo/SnapshotKind";
 export type SnapshotKindId = typeof internal.SnapshotKindId;
 export declare const Kind: typeof internal.EntityKind;
 export type Kind = internal.EntityKind;
-export declare const KindSchema: import("effect/Schema").Enums<typeof internal.EntityKind>;
+export declare const KindSchema: Schema.Enums<typeof internal.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;
+    readonly id: EntityId;
 }
 /**
  * Assigns a snapshot kind to an Object or Relation snapshot.
  */
 export interface SnapshotOfKind<K extends Kind> {
     readonly [SnapshotKindId]: K;
-    readonly id: ObjectId;
+    readonly id: EntityId;
 }
 /**
  * Obj or Relation with a specific set of properties.
@@ -34,6 +37,22 @@ export type Entity<Props> = OfKind<Kind> & Props;
  */
 export interface Unknown extends OfKind<Kind> {
 }
+/**
+ * Effect Schema for any ECHO entity (object or relation).
+ *
+ * Kind-agnostic counterpart to `Obj.Unknown` / `Relation.Unknown` — validates
+ * the structural shape (id + properties) without constraining `[KindId]`. Used
+ * in operation input schemas that accept any entity flavour (e.g.
+ * `Schema.Array(Entity.Unknown)`).
+ *
+ * The cast bridges the runtime structural schema to the branded `Unknown` type:
+ * `[KindId]` is a symbol brand that can't be expressed in a runtime `Struct`,
+ * so the entity guarantee is carried at the type level only (same approach as
+ * `Obj.Unknown` / `Relation.Unknown`). Unlike those, this is kind-agnostic so it
+ * isn't an `UnknownTypeSchema<_, K>` (there's no single `K`) and carries no
+ * `TypeAnnotation`.
+ */
+export declare const Unknown: Schema.Schema<Unknown>;
 /**
  * Snapshot of an Obj or Relation.
  * Branded with SnapshotKindId instead of KindId.
@@ -61,12 +80,29 @@ export type Properties<T> = Omit<T, 'id' | KindId | Relation.Source | Relation.T
  * Returns `false` for snapshots.
  */
 export declare const isEntity: (value: unknown) => value is Unknown;
+/**
+ * Test if a value is an instance of a given object or relation type.
+ *
+ * Kind-agnostic counterpart to `Obj.instanceOf` / `Relation.instanceOf` —
+ * use this when the caller's input type is `Type.AnyObj | Type.AnyRelation`.
+ *
+ * @example
+ * ```ts
+ * // Caller doesn't know whether `type` is object- or relation-kind.
+ * const matches = <T extends Type.AnyObj | Type.AnyRelation>(type: T, value: unknown) =>
+ *   Entity.instanceOf(type, value);
+ * ```
+ */
+export declare const instanceOf: {
+    <S extends Type.AnyEntity>(schema: S): (value: unknown) => value is Type.InstanceType<S>;
+    <S extends Type.AnyEntity>(schema: S, value: unknown): value is Type.InstanceType<S>;
+};
 /**
  * Check if a value is an ECHO entity snapshot.
  * Returns `false` for entities.
  */
 export declare const isSnapshot: (value: unknown) => value is Snapshot;
-export declare const getKind: (schema: import("effect/Schema").Schema.All) => internal.EntityKind | undefined;
+export declare const getKind: (schema: Schema.Schema.All) => internal.EntityKind | undefined;
 /**
  * Property that accesses metadata for an entity.
  */
@@ -80,22 +116,44 @@ export type Meta = typeof Meta;
  */
 export type JSON = internal.ObjectJSON;
 /**
- * Get the DXN of an entity (object or relation).
+ * Any value the read accessors operate on: a reactive entity or a snapshot.
+ * Type entities (`Type.AnyEntity`) are also accepted — they're first-class
+ * entities, and `Unknown`'s kind-agnostic brand already subsumes them.
  */
-export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
+export type AnyInput = Unknown | Snapshot;
 /**
- * Get the DXN of an entity's type.
+ * Get the canonical URI of an entity (object, relation, or type). Returns `URI.URI` —
+ * an `EID` for object/relation instances and persisted types, or a typename
+ * `DXN` for static type entities; narrow with `EID.parse(uri)` or
+ * `DXN.tryMake(uri)` at the point of use.
+ *
+ * @param options.prefer - Controls the URI form (see {@link internal.GetURIOptions}).
+ */
+export declare const getURI: (entity: AnyInput, options?: internal.GetURIOptions) => URI.URI;
+/**
+ * Get the DXN of an entity's type. For object/relation instances this is the URI
+ * of the type they were created from; for a type entity it is the URI of the
+ * meta-type ({@link Type.Type}, `dxn:org.dxos.type.schema:0.1.0`).
  */
-export declare const getTypeDXN: (obj: internal.AnyProperties) => DXN | undefined;
+export declare const getTypeURI: (entity: AnyInput) => URI.URI | undefined;
 /**
- * Get the schema of an entity.
- * Returns the branded ECHO schema used to create the entity.
+ * Get the type entity (`Type.AnyEntity`) the instance was created from.
+ *
+ * Returns `undefined` when the entity's type isn't registered in this runtime
+ * (e.g. a freshly deserialized snapshot whose type entity hasn't been wired
+ * up yet, or an entity loaded from storage before its schema is known). To
+ * get the Effect Schema from the returned entity, use `Type.getSchema(...)`.
+ *
+ * For a type entity, returns the meta-type {@link Type.Type} (a type entity's
+ * type is "Type").
  */
-export declare const getSchema: (entity: Unknown | Snapshot) => Type.AnyEntity | undefined;
+export declare const getType: (entity: AnyInput) => Type.AnyEntity | undefined;
 /**
- * Get the typename of an entity's type.
+ * Get the typename of an entity's type. For object/relation instances this is the
+ * typename of the type they were created from; for a type entity it is the type's
+ * own typename (e.g. `com.example.type.person`).
  */
-export declare const getTypename: (entity: Unknown | Snapshot) => string | undefined;
+export declare const getTypename: (entity: AnyInput) => string | undefined;
 /**
  * Get the database an entity belongs to.
  */
@@ -105,7 +163,7 @@ export declare const getDatabase: (entity: Unknown | Snapshot) => any | undefine
  * 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>): internal.ObjectMeta;
+export declare function getMeta(entity: Mutable<Unknown>): internal.EntityMeta;
 export declare function getMeta(entity: Unknown | Snapshot): internal.ReadonlyMeta;
 /**
  * Get foreign keys for an entity from the specified source.
@@ -117,12 +175,26 @@ export declare const getKeys: (entity: Unknown | Snapshot, source: string) => Fo
 export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
 /**
  * Get the label of an entity.
+ *
+ * @param options.fallback `'typename'` returns the entity's typename when no
+ *   label is set (e.g. `org.dxos.type.table`).
+ */
+export declare const getLabel: (entity: Unknown | Snapshot, options?: internal.GetLabelOptions) => string | undefined;
+/**
+ * Set the label of an entity.
+ * Must be called within an `Entity.update` / `Obj.update` / `Relation.update` callback.
  */
-export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
+export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void;
 /**
  * Get the description of an entity.
  */
 export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Get the icon annotation for an entity (object or relation), resolved via its type-level
+ * `IconAnnotation`. Returns the full `{ icon, hue }` annotation so callers can use both
+ * the phosphor icon name and the suggested colour.
+ */
+export declare const getIcon: (entity: Unknown | Snapshot) => internal.IconAnnotation | undefined;
 /**
  * Convert an entity to its JSON representation.
  */
@@ -133,14 +205,14 @@ export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
  */
 export declare const subscribe: (entity: Unknown, callback: () => void) => (() => void);
 /**
- * Used to provide a mutable view of an entity within `Entity.change`.
+ * Used to provide a mutable view of an entity within `Entity.update`.
  */
 export type Mutable<T> = internal.Mutable<T>;
 /**
  * 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
+ * when the callback completes. Direct mutations outside of `Entity.update` will throw
  * at runtime.
  *
  * @param entity - The echo entity (object or relation) to mutate.
@@ -148,27 +220,28 @@ export type Mutable<T> = internal.Mutable<T>;
  *
  * @example
  * ```typescript
- * // Mutate within Entity.change
- * Entity.change(entity, (obj) => {
+ * // Mutate within Entity.update
+ * Entity.update(entity, (obj) => {
  *   obj.name = 'Updated';
  *   obj.count = 42;
  * });
  *
  * // Direct mutation throws
- * entity.name = 'Bob'; // Error: Cannot modify outside Entity.change()
+ * entity.name = 'Bob'; // Error: Cannot modify outside Entity.update()
  * ```
  *
- * Note: For type-specific operations, prefer `Obj.change` or `Relation.change`.
+ * Note: For type-specific operations, prefer `Obj.update` or `Relation.update`.
  */
-export declare const change: <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>) => void;
+export declare const update: <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>) => void;
 /**
  * Add a tag to an entity.
- * Must be called within an `Entity.change`, `Obj.change`, or `Relation.change` callback.
+ * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
  */
-export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
+export declare const addTag: (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>) => void;
 /**
  * Remove a tag from an entity.
- * Must be called within an `Entity.change`, `Obj.change`, or `Relation.change` callback.
+ * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
  */
-export declare const removeTag: (entity: Mutable<Unknown>, tag: string) => void;
+export declare const removeTag: (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>) => void;
+export declare const atom: <T extends Unknown>(entity: T) => import("@effect-atom/atom/Atom").Atom<Snapshot>;
 //# 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":"AAMA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAGpC,eAAO,MAAM,MAAM,oBAAkB,CAAC;AACtC,MAAM,MAAM,MAAM,GAAG,OAAO,QAAQ,CAAC,MAAM,CAAC;AAC5C,eAAO,MAAM,cAAc,4BAA0B,CAAC;AACtD,MAAM,MAAM,cAAc,GAAG,OAAO,QAAQ,CAAC,cAAc,CAAC;AAM5D,eAAO,MAAM,IAAI,4BAAsB,CAAC;AACxC,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;AACvC,eAAO,MAAM,UAAU,2DAA4B,CAAC;AAEpD;;;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;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAKlD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,QAKpD,CAAC;AAGF,eAAO,MAAM,OAAO,iFAAyB,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,OAAO,MAA+B,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC;AAQ/B;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAA8B,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,UAAU,kDAAsB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,KAAK,IAAI,CAAC,SAAS,GAAG,SAAqC,CAAC;AAE/G;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAyC,CAAC;AAE5G;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAAG,GAAG,SAAyC,CAAC;AAEzG;;;;GAIG;AAEH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC;AACvE,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC;AAK3E;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,GAAG,QAAQ,EAAE,QAAQ,MAAM,KAAG,UAAU,EAAsC,CAAC;AAEtH;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAAqC,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAsC,CAAC;AAEtG;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAA4C,CAAC;AAElH;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,IAAqC,CAAC;AAE1F;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,EAAE,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAE5E,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC,EAAE,UAAU,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAG,IAE3F,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAAoC,CAAC;AAEpG;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAAuC,CAAC"}
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../src/Entity.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAEvC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAG/B,eAAO,MAAM,MAAM,oBAAkB,CAAC;AACtC,MAAM,MAAM,MAAM,GAAG,OAAO,QAAQ,CAAC,MAAM,CAAC;AAC5C,eAAO,MAAM,cAAc,4BAA0B,CAAC;AACtD,MAAM,MAAM,cAAc,GAAG,OAAO,QAAQ,CAAC,cAAc,CAAC;AAM5D,eAAO,MAAM,IAAI,4BAAsB,CAAC;AACxC,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;AACvC,eAAO,MAAM,UAAU,0CAA4B,CAAC;AAEpD;;;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;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAIL,CAAC;AAEvC;;;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;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAA2B,CAAC;AAEhF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAM9E,CAAC;AAEV;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,QAKpD,CAAC;AAGF,eAAO,MAAM,OAAO,gEAAyB,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,OAAO,MAA+B,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC;AAQ/B;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;AAUvC;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1C;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,WAAY,QAAQ,YAAY,QAAQ,CAAC,aAAa,KAAG,GAAG,CAAC,GAC4B,CAAC;AAE7G;;;;GAIG;AACH,eAAO,MAAM,UAAU,WAAY,QAAQ,KAAG,GAAG,CAAC,GAAG,GAAG,SACgC,CAAC;AAEzF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,OAAO,WAAY,QAAQ,KAAG,IAAI,CAAC,SAAS,GAAG,SACiC,CAAC;AAE9F;;;;GAIG;AACH,eAAO,MAAM,WAAW,WAAY,QAAQ,KAAG,MAAM,GAAG,SACqD,CAAC;AAE9G;;GAEG;AACH,eAAO,MAAM,WAAW,WAAY,OAAO,GAAG,QAAQ,KAAG,GAAG,GAAG,SAAyC,CAAC;AAEzG;;;;GAIG;AAEH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC;AACvE,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC;AAK3E;;GAEG;AACH,eAAO,MAAM,OAAO,WAAY,OAAO,GAAG,QAAQ,UAAU,MAAM,KAAG,UAAU,EAAsC,CAAC;AAEtH;;GAEG;AACH,eAAO,MAAM,SAAS,WAAY,OAAO,GAAG,QAAQ,KAAG,OAAqC,CAAC;AAE7F;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,WAAY,OAAO,GAAG,QAAQ,YAAY,QAAQ,CAAC,eAAe,KAAG,MAAM,GAAG,SAC/D,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,QAAQ,WAAY,OAAO,CAAC,OAAO,CAAC,SAAS,MAAM,KAAG,IAAwC,CAAC;AAE5G;;GAEG;AACH,eAAO,MAAM,cAAc,WAAY,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAA4C,CAAC;AAElH;;;;GAIG;AACH,eAAO,MAAM,OAAO,WAAY,OAAO,GAAG,QAAQ,KAAG,QAAQ,CAAC,cAAc,GAAG,SAAqC,CAAC;AAErH;;GAEG;AACH,eAAO,MAAM,MAAM,WAAY,OAAO,GAAG,QAAQ,KAAG,IAAqC,CAAC;AAE1F;;;GAGG;AACH,eAAO,MAAM,SAAS,WAAY,OAAO,YAAY,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAE5E,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,UAAU,CAAC,YAAY,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,KAAG,IAE3F,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,WAAY,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAG,IAAoC,CAAC;AAE9G;;;GAGG;AACH,eAAO,MAAM,SAAS,WAAY,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAG,IAAuC,CAAC;AAMpH,eAAO,MAAM,IAAI,mFAAyB,CAAC"}

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

@@ -1,28 +1,28 @@
 import { BaseError, type BaseErrorOptions } from '@dxos/errors';
-import { type DXN } from '@dxos/keys';
+import { type URI } from '@dxos/keys';
 declare const SchemaNotFoundError_base: {
     new (options?: BaseErrorOptions): {
+        cause?: unknown;
+        stack?: string;
         name: "SchemaNotFoundError";
         context: Record<string, unknown>;
         readonly message: string;
         readonly _tag: "SchemaNotFoundError";
-        stack?: string;
-        cause?: unknown;
     };
+    isError(error: unknown): error is Error;
     name: "SchemaNotFoundError";
     is(error: unknown): error is BaseError;
-    wrap(options?: Omit<BaseErrorOptions, "cause"> & {
+    wrap(options?: Omit<BaseErrorOptions, 'cause'> & {
         ifTypeDiffers?: boolean;
     }): (error: unknown) => {
+        cause?: unknown;
+        stack?: string;
         name: "SchemaNotFoundError";
         context: Record<string, unknown>;
         readonly message: string;
         readonly _tag: "SchemaNotFoundError";
-        stack?: string;
-        cause?: unknown;
     };
     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;
     stackTraceLimit: number;
@@ -30,35 +30,35 @@ declare const SchemaNotFoundError_base: {
 export declare class SchemaNotFoundError extends SchemaNotFoundError_base {
     constructor(schema: string, options?: BaseErrorOptions);
 }
-declare const ObjectNotFoundError_base: {
+declare const EntityNotFoundError_base: {
     new (options?: BaseErrorOptions): {
-        name: "ObjectNotFoundError";
+        cause?: unknown;
+        stack?: string;
+        name: "EntityNotFoundError";
         context: Record<string, unknown>;
         readonly message: string;
-        readonly _tag: "ObjectNotFoundError";
-        stack?: string;
-        cause?: unknown;
+        readonly _tag: "EntityNotFoundError";
     };
-    name: "ObjectNotFoundError";
+    isError(error: unknown): error is Error;
+    name: "EntityNotFoundError";
     is(error: unknown): error is BaseError;
-    wrap(options?: Omit<BaseErrorOptions, "cause"> & {
+    wrap(options?: Omit<BaseErrorOptions, 'cause'> & {
         ifTypeDiffers?: boolean;
     }): (error: unknown) => {
-        name: "ObjectNotFoundError";
+        cause?: unknown;
+        stack?: string;
+        name: "EntityNotFoundError";
         context: Record<string, unknown>;
         readonly message: string;
-        readonly _tag: "ObjectNotFoundError";
-        stack?: string;
-        cause?: unknown;
+        readonly _tag: "EntityNotFoundError";
     };
     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;
     stackTraceLimit: number;
 };
-export declare class ObjectNotFoundError extends ObjectNotFoundError_base {
-    constructor(dxn: DXN, options?: BaseErrorOptions);
+export declare class EntityNotFoundError extends EntityNotFoundError_base {
+    constructor(uri: URI.URI, options?: BaseErrorOptions);
 }
 /**
  * Reason why getting a reactive object from a snapshot failed.
@@ -68,27 +68,27 @@ export declare class ObjectNotFoundError extends ObjectNotFoundError_base {
 export type GetReactiveErrorReason = 'no-database' | 'object-not-found';
 declare const GetReactiveError_base: {
     new (options?: BaseErrorOptions): {
+        cause?: unknown;
+        stack?: string;
         name: "GetReactiveError";
         context: Record<string, unknown>;
         readonly message: string;
         readonly _tag: "GetReactiveError";
-        stack?: string;
-        cause?: unknown;
     };
+    isError(error: unknown): error is Error;
     name: "GetReactiveError";
     is(error: unknown): error is BaseError;
-    wrap(options?: Omit<BaseErrorOptions, "cause"> & {
+    wrap(options?: Omit<BaseErrorOptions, 'cause'> & {
         ifTypeDiffers?: boolean;
     }): (error: unknown) => {
+        cause?: unknown;
+        stack?: string;
         name: "GetReactiveError";
         context: Record<string, unknown>;
         readonly message: string;
         readonly _tag: "GetReactiveError";
-        stack?: string;
-        cause?: unknown;
     };
     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;
     stackTraceLimit: number;

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

@@ -1 +1 @@
-{"version":3,"file":"Err.d.ts","sourceRoot":"","sources":["../../../src/Err.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;qBA0BvB,CAAC;;;;;;;;;;;;;;;AAxBhB,qBAAa,mBAAoB,SAAQ,wBAA2D;gBACtF,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;CAGvD;;;;;;;;;;;;;qBAoBc,CAAC;;;;;;;;;;;;;;;AAlBhB,qBAAa,mBAAoB,SAAQ,wBAA2D;gBACtF,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,gBAAgB;CAGjD;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,kBAAkB,CAAC;;;;;;;;;;;;;qBAOzD,CAAC;;;;;;;;;;;;;;;AALhB;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,qBAGrC;gBACa,OAAO,EAAE;QAAE,MAAM,EAAE,sBAAsB,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,gBAAgB;CAGhG"}
+{"version":3,"file":"Err.d.ts","sourceRoot":"","sources":["../../../src/Err.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtC,qBAAa,mBAAoB,SAAQ,wBAA2D;IAClG,YAAY,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAErD;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,qBAAa,mBAAoB,SAAQ,wBAA2D;IAClG,YAAY,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEnD;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,kBAAkB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAExE;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,qBAGrC;IACC,YAAY,OAAO,EAAE;QAAE,MAAM,EAAE,sBAAsB,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,gBAAgB,EAE9F;CACF"}

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

@@ -3,7 +3,7 @@ import * as Effect from 'effect/Effect';
 import * as Layer from 'effect/Layer';
 import type * as Option from 'effect/Option';
 import * as Schema from 'effect/Schema';
-import { DXN } from '@dxos/keys';
+import { EID } from '@dxos/keys';
 import type * as Entity from './Entity';
 import type * as Filter from './Filter';
 import * as Obj from './Obj';
@@ -19,15 +19,14 @@ import * as Type from './Type';
  * ```
  */
 export declare const Feed: Type.Obj<{
-    readonly kind?: string | undefined;
     readonly name?: string | undefined;
+    readonly kind?: string | undefined;
     readonly namespace?: "data" | "trace" | undefined;
 }, Schema.Struct.Fields>;
 /**
  * TypeScript instance type for a Feed object.
  */
-export interface Feed extends Schema.Schema.Type<typeof Feed> {
-}
+export type Feed = Type.InstanceType<typeof Feed>;
 /**
  * Opaque cursor for iterating over feed items.
  */
@@ -41,6 +40,27 @@ export interface RetentionOptions {
     /** Retain items after this cursor position. */
     cursor?: string;
 }
+/**
+ * Sync options for a feed.
+ */
+export interface SyncOptions {
+    /** Push local changes to the server. Defaults to true. */
+    shouldPush?: boolean;
+    /** Pull remote changes from the server. Defaults to true. */
+    shouldPull?: boolean;
+}
+/**
+ * Queue replication backlog for a feed namespace.
+ * `0` / `0` means caught up on pull and push.
+ */
+export interface SyncState {
+    /** Blocks still to pull from remote. */
+    blocksToPull: number;
+    /** Unpositioned blocks still to push to remote. */
+    blocksToPush: number;
+    /** Total blocks stored locally for the feed namespace. */
+    totalBlocks: number;
+}
 /**
  * Creates a new feed object.
  *
@@ -51,23 +71,11 @@ export interface RetentionOptions {
  */
 export declare const make: (props?: Obj.MakeProps<typeof Feed>) => Feed;
 /**
- * Derives the queue DXN from the feed object's DXN.
- * Returns `undefined` when the feed is not stored in a space yet.
+ * Returns the feed object's EID when the feed is stored in a space.
  *
  * Used internally by the feed service layer.
  */
-export declare const getQueueDxn: (feed: Feed) => DXN | undefined;
-/**
- * Creates a Feed object from a queue DXN, inferring the feed's id and namespace from the DXN parts.
- *
- * The resulting Feed, when added to the same space as the queue, will have a queue DXN
- * equal to the input (see `Feed.getQueueDxn`). Useful when migrating `Ref(Queue)` fields to
- * `Ref(Feed.Feed)`.
- *
- * @remarks Unsafe because the caller must ensure the queue DXN's space matches the database
- * the feed is added to; the feed id is set from the queue id, bypassing id generation.
- */
-export declare const unsafeFromQueueDXN: (queueDxn: DXN) => Feed;
+export declare const getQueueUri: (feed: Feed) => EID.EID | undefined;
 declare const FeedService_base: Context.TagClass<FeedService, "@dxos/echo/Feed/FeedService", {
     /**
      * Appends items to a feed.
@@ -84,6 +92,14 @@ declare const FeedService_base: Context.TagClass<FeedService, "@dxos/echo/Feed/F
         <Q extends Query.Any>(feed: Feed, query: Q): QueryResult.QueryResult<Query.Type<Q>>;
         <F extends Filter.Any>(feed: Feed, filter: F): QueryResult.QueryResult<Filter.Type<F>>;
     };
+    /**
+     * Syncs the feed with the server.
+     */
+    sync(feed: Feed, options?: SyncOptions): Promise<void>;
+    /**
+     * Returns queue replication backlog for the feed's namespace.
+     */
+    getSyncState(feed: Feed): Promise<SyncState>;
 }>;
 /**
  * Effect service for feed operations.
@@ -100,6 +116,18 @@ export type Service = FeedService;
  * @deprecated Use `FeedService` instead.
  */
 export declare const Service: typeof FeedService;
+declare const ContextFeedService_base: Context.TagClass<ContextFeedService, "@dxos/echo/Feed/ContextFeedService", {
+    readonly feed: Feed;
+}>;
+/**
+ * Effect context service that holds the current feed for a scoped operation.
+ *
+ * @deprecated Prefer threading a `Feed.Feed` explicitly through function signatures
+ * over hiding it behind a context service.
+ */
+export declare class ContextFeedService extends ContextFeedService_base {
+    static layer: (feed: Feed) => Layer.Layer<ContextFeedService>;
+}
 /**
  * Layer that provides a Feed service that throws when accessed.
  * Useful as a default layer when no feed service is available.
@@ -147,6 +175,25 @@ export declare const runQuery: {
     <Q extends Query.Any>(feed: Feed, query: Q): Effect.Effect<Query.Type<Q>[], never, FeedService>;
     <F extends Filter.Any>(feed: Feed, filter: F): Effect.Effect<Filter.Type<F>[], never, FeedService>;
 };
+/**
+ * Syncs the feed with the server.
+ *
+ * @example
+ * ```ts
+ * yield* Feed.sync(feed);
+ * yield* Feed.sync(feed, { shouldPush: false });
+ * ```
+ */
+export declare const sync: (feed: Feed, options?: SyncOptions) => Effect.Effect<void, never, FeedService>;
+/**
+ * Returns queue replication backlog for the feed's namespace.
+ *
+ * @example
+ * ```ts
+ * const { blocksToPull, blocksToPush } = yield* Feed.getSyncState(feed);
+ * ```
+ */
+export declare const getSyncState: (feed: Feed) => Effect.Effect<SyncState, never, FeedService>;
 /**
  * Creates a cursor for iterating over feed items.
  * Currently stubbed — cursor operations are not yet implemented.
@@ -170,7 +217,7 @@ export declare const next: <T = Obj.Snapshot>(_cursor: Cursor<T>) => Effect.Effe
 export declare const nextOption: <T = Obj.Snapshot>(_cursor: Cursor<T>) => Effect.Effect<Option.Option<T>, never, FeedService>;
 /**
  * Sets the local retention policy for a feed.
- * Currently stubbed — queues do not yet support retention.
+ * Currently stubbed — feeds do not yet support retention.
  *
  * @example
  * ```ts

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

@@ -1 +1 @@
-{"version":3,"file":"Feed.d.ts","sourceRoot":"","sources":["../../../src/Feed.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,GAAG,EAAiB,MAAM,YAAY,CAAC;AAGhD,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,WAAW,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI;;;;wBAuBhB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC;CAAG;AAMhE;;GAEG;AAEH,MAAM,WAAW,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ;IACtC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAE/C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD;;;;;;;GAOG;AAEH,eAAO,MAAM,IAAI,GAAI,QAAO,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,CAAM,KAAG,IAA6B,CAAC;AAE5F;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,IAAI,KAAG,GAAG,GAAG,SAM9C,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,GAAG,KAAG,IASlD,CAAC;;IAcE;;OAEG;iBACU,IAAI,SAAS,MAAM,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1D;;OAEG;iBAEU,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhD;;OAEG;WACI;QACL,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;KACxF;;AAzBL;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,gBAsB9B;CAAG;AAEN;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,WAAW,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,OAAO,oBAAc,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAUZ,CAAC;AAMvC;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,IAAI,EAAE,OAAO,MAAM,CAAC,OAAO,EAAE,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAI/F,CAAC;AAEL;;;;;;;GAOG;AAEH,eAAO,MAAM,MAAM,GAAI,MAAM,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAKhH,CAAC;AAEL;;;;;;;GAOG;AAMH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAClB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,CAAC,GACP,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAC7E,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EACnB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,CAAC,GACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;CAEsC,CAAC;AAEvH;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAChG,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;CAEa,CAAC;AAEnH;;;;;;;;;GASG;AAEH,eAAO,MAAM,MAAM,GAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,OAAO,IAAI,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CACjD,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,SAAS,MAAM,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAC/C,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,SAAS,MAAM,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAC9D,CAAC;AAEvD;;;;;;;;GAQG;AAEH,eAAO,MAAM,YAAY,GAAI,OAAO,IAAI,EAAE,UAAU,gBAAgB,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAChG,CAAC"}
+{"version":3,"file":"Feed.d.ts","sourceRoot":"","sources":["../../../src/Feed.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAO,GAAG,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,WAAW,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI;;;;wBAiBhB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,IAAI,CAAC,CAAC;AAMlD;;GAEG;AAEH,MAAM,WAAW,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ;IACtC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAE/C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,0DAA0D;IAC1D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,WAAW,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;;GAOG;AAEH,eAAO,MAAM,IAAI,WAAW,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,KAAQ,IAA6B,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,WAAW,SAAU,IAAI,KAAG,GAAG,CAAC,GAAG,GAAG,SAA2C,CAAC;;IAc3F;;OAEG;iBACU,IAAI,SAAS,MAAM,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1D;;OAEG;iBACU,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhD;;OAEG;WACI;QACL,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;KACxF;IAED;;OAEG;eACQ,IAAI,YAAY,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtD;;OAEG;uBACgB,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;;AAlChD;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,gBA+B9B;CAAG;AAEN;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,WAAW,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,OAAO,oBAAc,CAAC;;mBAWhB,IAAI;;AATvB;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,uBAKrC;IACD,MAAM,CAAC,KAAK,SAAU,IAAI,KAAG,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAgD;CAC7G;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAgBZ,CAAC;AAMvC;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,SAAU,IAAI,SAAS,MAAM,CAAC,OAAO,EAAE,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAI/F,CAAC;AAEL;;;;;;;GAOG;AAEH,eAAO,MAAM,MAAM,SAAU,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAKhH,CAAC;AAEL;;;;;;;GAOG;AAMH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAClB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,CAAC,GACP,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAC7E,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EACnB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,CAAC,GACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;CAEsC,CAAC;AAEvH;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAChG,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;CAEa,CAAC;AAEnH;;;;;;;;GAQG;AACH,eAAO,MAAM,IAAI,SAAU,IAAI,YAAY,WAAW,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAI3F,CAAC;AAEL;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,SAAU,IAAI,KAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,WAAW,CAIjF,CAAC;AAEL;;;;;;;;;GASG;AAEH,eAAO,MAAM,MAAM,GAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,SAAS,IAAI,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CACjD,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,WAAW,MAAM,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAC/C,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,WAAW,MAAM,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAC9D,CAAC;AAEvD;;;;;;;;GAQG;AAEH,eAAO,MAAM,YAAY,UAAW,IAAI,YAAY,gBAAgB,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAChG,CAAC"}

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

@@ -1,9 +1,11 @@
 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';
+import { EntityId, type URI } from '@dxos/keys';
+import * as internal from './internal';
 import type * as Obj from './Obj';
 import * as Ref from './Ref';
+import type * as Type$ from './Type';
 export interface Filter<T> {
     '~Filter': {
         value: Types.Covariant<T>;
@@ -34,23 +36,47 @@ export declare const everything: () => FilterClass;
  * Filter that matches no objects.
  */
 export declare const nothing: () => FilterClass;
-export declare const id: (...ids: ObjectId[]) => Any;
+export declare const id: (...ids: EntityId[]) => 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>>;
+ *
+ * Accepts a `Type.Type` entity (the value produced by `Type.makeObject` /
+ * `Type.makeRelation`), a `Schema.Union` of such entities (for filtering across a
+ * union of ECHO types), or a fully-qualified type URI — an `echo:` EID (stored schema)
+ * or a `dxn:` DXN (static schema). To filter by a bare typename, wrap it: `DXN.make(typename)`.
+ */
+export declare const type: {
+    <T extends Type$.AnyEntity>(type: T, props?: Props<Type$.InstanceType<T>>): Filter<Type$.InstanceType<T>>;
+    <S extends internal.UnknownTypeSchema<any, any>>(schema: S, props?: Props<Schema.Schema.Type<S>>): Filter<Schema.Schema.Type<S>>;
+    <S extends Schema.Union<readonly Schema.Schema.AnyNoContext[]>>(union: S, props?: Props<Schema.Schema.Type<S>>): Filter<Schema.Schema.Type<S>>;
+    (uri: URI.URI, props?: Props<unknown>): Filter<any>;
+    (input: Type$.AnyEntity | URI.URI, props?: Props<unknown>): Filter<unknown>;
+};
 /**
- * Filter by non-qualified typename.
+ * Filter by tag.
  */
-export declare const typename: (typename: string) => Any;
+export declare const tag: (tag: string) => Any;
 /**
- * Filter by fully qualified type DXN.
+ * Options for {@link key} filter.
  */
-export declare const typeDXN: (dxn: DXN) => Any;
+export type KeyFilterOptions = {
+    /**
+     * Optional semver range expression (e.g. `^1.2.3`, `~2.0.0`, `>=1.0.0 <2.0.0`).
+     * Matches the object's meta `version` field against the range.
+     * If omitted, matches any version (including objects with no version).
+     */
+    version?: string;
+};
 /**
- * Filter by tag.
+ * Filter by registry key stored in object meta.
+ *
+ * @example
+ * ```ts
+ * Filter.key('org.example.type.foo');
+ * Filter.key('org.example.type.foo', { version: '^1.2.3' });
+ * ```
  */
-export declare const tag: (tag: string) => Any;
+export declare const key: (key: string, options?: KeyFilterOptions) => Any;
 /**
  * Filter by properties.
  */
@@ -65,7 +91,7 @@ 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>>;
+export declare const foreignKeys: <S extends Type$.AnyEntity | URI.URI>(schema: S, keys: ForeignKey[]) => Filter<S extends Type$.AnyEntity ? Type$.InstanceType<S> : unknown>;
 /**
  * Predicate for property to be equal to the provided value.
  */
@@ -126,7 +152,7 @@ export type ChildOfOptions = {
 /**
  * Filter objects that are children of the specified parent(s).
  * Accepts ECHO objects, Refs, or arrays of either.
- * Refs are resolved to DXNs without loading; objects use {@link Obj.getDXN}.
+ * Refs are resolved to DXNs without loading; objects use {@link Obj.getURI}.
  * With transitive=true (default), also matches grandchildren and beyond.
  */
 export declare const childOf: (parents: Obj.Unknown | Ref.Unknown | readonly (Obj.Unknown | Ref.Unknown)[], options?: ChildOfOptions) => Any;