@dxos/echo 0.8.4-staging.ac66bdf99f → 0.9.0

package/src/Entity.test.ts

@@ -4,19 +4,129 @@
 
 import { describe, expect, test } from 'vitest';
 
-import type * as Entity from './Entity';
+import * as Entity from './Entity';
 import * as Obj from './Obj';
 import * as Relation from './Relation';
 import { TestSchema } from './testing';
+import * as Type from './Type';
+
+const makeObject = () =>
+  Obj.make(TestSchema.Person, {
+    name: 'Test',
+    username: 'test',
+    email: 'test@example.com',
+    tasks: [],
+  });
+
+const makeRelation = (obj: TestSchema.Person) =>
+  Relation.make(TestSchema.HasManager, { [Relation.Source]: obj, [Relation.Target]: obj });
 
 describe('Entity', () => {
   test('Entity.Unknown accepts any object or relation', () => {
-    const obj = Obj.make(TestSchema.Person, { name: 'Test' });
-    const rel = Relation.make(TestSchema.HasManager, { [Relation.Source]: obj, [Relation.Target]: obj });
-    const doSomething = (entity: Entity.Unknown) => {
-      return entity;
-    };
+    const obj = makeObject();
+    const rel = makeRelation(obj);
+    const doSomething = (entity: Entity.Unknown) => entity;
     expect(doSomething(obj)).toBe(obj);
     expect(doSomething(rel)).toBe(rel);
   });
+
+  // `isEntity` is a bare brand check (`[KindId] !== undefined`). All three entity
+  // kinds — objects, relations, and type entities — carry the brand, so all three
+  // are recognised as entities. (Type entities brand with `EntityKind.Type`.)
+  describe('isEntity / isSnapshot', () => {
+    test('object instance is an entity', () => {
+      const obj = makeObject();
+      expect(Entity.isEntity(obj)).toBe(true);
+      expect(Entity.isSnapshot(obj)).toBe(false);
+    });
+
+    test('relation instance is an entity', () => {
+      const rel = makeRelation(makeObject());
+      expect(Entity.isEntity(rel)).toBe(true);
+      expect(Entity.isSnapshot(rel)).toBe(false);
+    });
+
+    test('type entity is an entity', () => {
+      expect(Entity.isEntity(TestSchema.Person)).toBe(true);
+      expect(Entity.isSnapshot(TestSchema.Person)).toBe(false);
+    });
+
+    test('non-entities are rejected', () => {
+      expect(Entity.isEntity(null)).toBe(false);
+      expect(Entity.isEntity({})).toBe(false);
+      expect(Entity.isEntity({ id: 'x' })).toBe(false);
+      expect(Entity.isEntity('string')).toBe(false);
+    });
+  });
+
+  // Object and relation instances behave identically across the Entity.* accessor
+  // surface: these accessors are written for runtime instances and read the
+  // instance's identity, type pointer and metadata.
+  describe.each([
+    ['object', () => makeObject(), 'com.example.type.person'],
+    ['relation', () => makeRelation(makeObject()), 'com.example.type.hasManager'],
+  ] as const)('instance accessors (%s)', (_label, make, typename) => {
+    test('getURI returns an echo URI', () => {
+      const entity = make();
+      expect(Entity.getURI(entity)).toMatch(/^echo:/);
+    });
+
+    test('getTypename returns the typename', () => {
+      expect(Entity.getTypename(make())).toBe(typename);
+    });
+
+    test('getTypeURI returns the type DXN', () => {
+      expect(Entity.getTypeURI(make())).toBe(`dxn:${typename}:0.1.0`);
+    });
+
+    test('getType resolves back to the type entity', () => {
+      const type = Entity.getType(make());
+      expect(type).toBeDefined();
+      expect(Type.getTypename(type!)).toBe(typename);
+    });
+
+    test('getMeta returns metadata', () => {
+      expect(Entity.getMeta(make())).toBeDefined();
+    });
+
+    test('isDeleted is false for a live entity', () => {
+      expect(Entity.isDeleted(make())).toBe(false);
+    });
+
+    test('toJSON serializes the entity', () => {
+      const json = Entity.toJSON(make());
+      expect(json).toMatchObject({ '@type': expect.stringContaining(typename) });
+    });
+  });
+
+  // Type entities are first-class entities: the Entity.* accessors work on them too.
+  // `getURI`/`getTypename` return the type's OWN identity, while `getType`/`getTypeURI`
+  // (which mean "the type this entity is an instance of") resolve to the meta-type
+  // `Type.Type`.
+  describe('type entity', () => {
+    test('isEntity / getMeta / isDeleted', () => {
+      expect(Entity.isEntity(TestSchema.Person)).toBe(true);
+      expect(Entity.getMeta(TestSchema.Person)).toBeDefined();
+      expect(Entity.isDeleted(TestSchema.Person)).toBe(false);
+    });
+
+    test('getURI / getTypename return the type entity’s own identity', () => {
+      expect(Entity.getURI(TestSchema.Person)).toBe('dxn:com.example.type.person:0.1.0');
+      expect(Entity.getTypename(TestSchema.Person)).toBe('com.example.type.person');
+    });
+
+    test('getType / getTypeURI resolve to the meta-type (Type.Type)', () => {
+      expect(Entity.getType(TestSchema.Person)).toBe(Type.Type);
+      expect(Entity.getTypeURI(TestSchema.Person)).toBe('dxn:org.dxos.type.schema:0.1.0');
+    });
+
+    test('Entity.* and Type.* agree on type identity', () => {
+      expect(Entity.getURI(TestSchema.Person)).toBe(Type.getURI(TestSchema.Person));
+      expect(Entity.getTypename(TestSchema.Person)).toBe(Type.getTypename(TestSchema.Person));
+      expect(Type.isType(TestSchema.Person)).toBe(true);
+      expect(Type.isObject(TestSchema.Person)).toBe(true);
+      expect(Type.isRelation(TestSchema.HasManager)).toBe(true);
+      expect(Type.getVersion(TestSchema.Person)).toBe('0.1.0');
+    });
+  });
 });

package/src/Entity.ts

@@ -4,12 +4,17 @@
 
 // @import-as-namespace
 
+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 * as objInternal from './internal/Obj';
+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';
 
 // Re-export KindId and SnapshotKindId from internal.
 export const KindId = internal.KindId;
@@ -31,7 +36,7 @@ export const KindSchema = internal.EntityKindSchema;
  */
 export interface OfKind<K extends Kind> {
   readonly [KindId]: K;
-  readonly id: ObjectId;
+  readonly id: EntityId;
 }
 
 /**
@@ -39,7 +44,7 @@ export interface OfKind<K extends Kind> {
  */
 export interface SnapshotOfKind<K extends Kind> {
   readonly [SnapshotKindId]: K;
-  readonly id: ObjectId;
+  readonly id: EntityId;
 }
 
 /**
@@ -52,6 +57,27 @@ 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 const Unknown: Schema.Schema<Unknown> = Schema.Struct({
+  id: Schema.String,
+}).pipe(
+  Schema.extend(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+) as unknown as Schema.Schema<Unknown>;
+
 /**
  * Snapshot of an Obj or Relation.
  * Branded with SnapshotKindId instead of KindId.
@@ -80,12 +106,30 @@ export type Properties<T> = Omit<T, 'id' | KindId | Relation.Source | Relation.T
  * Check if a value is an ECHO entity (object or relation).
  * Returns `false` for snapshots.
  */
-export const isEntity = (value: unknown): value is Unknown => {
-  if (typeof value !== 'object' || value === null) {
-    return false;
+export const isEntity: (value: unknown) => value is Unknown = internal.isEntity;
+
+/**
+ * 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 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>;
+} = ((...args: [schema: Type.AnyEntity, value?: unknown]) => {
+  if (args.length === 1) {
+    return (entity: unknown) => internal.isInstanceOf(args[0], entity);
   }
-  return (value as any)[KindId] !== undefined;
-};
+  return internal.isInstanceOf(args[0], args[1]);
+}) as any;
 
 /**
  * Check if a value is an ECHO entity snapshot.
@@ -123,25 +167,60 @@ export type Meta = typeof Meta;
 export type JSON = internal.ObjectJSON;
 
 /**
- * Get the DXN of an entity (object or relation).
+ * Whether the entity is a type-kind entity (a `Type.Type` produced by
+ * `Type.makeObject` / `Type.makeRelation`, or a persisted schema). Type entities
+ * carry their identity (typename/version) on themselves rather than referencing a
+ * separate type, so the accessors below route them through the `Type.*` module.
+ */
+const isTypeEntity = (entity: unknown): boolean => internal.getEntityKindBrand(entity) === internal.EntityKind.Type;
+
+/**
+ * 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 const getDXN = (entity: Unknown | Snapshot): DXN => internal.getDXN(entity);
+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 const getTypeDXN = internal.getTypeDXN;
+export const getURI = (entity: AnyInput, options?: internal.GetURIOptions): URI.URI =>
+  isTypeEntity(entity) ? Type.getURI(entity as Type.AnyEntity) : internal.getUri(entity as Unknown, options);
 
 /**
- * Get the schema of an entity.
- * Returns the branded ECHO schema used to create the entity.
+ * 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 const getSchema: (entity: Unknown | Snapshot) => Type.AnyEntity | undefined = internal.getSchema as any;
+export const getTypeURI = (entity: AnyInput): URI.URI | undefined =>
+  isTypeEntity(entity) ? Type.getURI(Type.Type) : internal.getTypeURI(entity as Unknown);
 
 /**
- * Get the typename of an entity's type.
+ * 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 const getTypename = (entity: Unknown | Snapshot): string | undefined => internal.getTypename(entity);
+export const getType = (entity: AnyInput): Type.AnyEntity | undefined =>
+  isTypeEntity(entity) ? Type.Type : (internal.getType(entity) as Type.AnyEntity | undefined);
+
+/**
+ * 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 const getTypename = (entity: AnyInput): string | undefined =>
+  isTypeEntity(entity) ? Type.getTypename(entity as Type.AnyEntity) : internal.getTypename(entity as Unknown);
 
 /**
  * Get the database an entity belongs to.
@@ -154,9 +233,9 @@ export const getDatabase = (entity: Unknown | Snapshot): any | undefined => inte
  * Returns read-only meta when passed a regular entity or snapshot.
  */
 // TODO(wittjosiah): When passed a Snapshot, should return a snapshot of meta, not the live meta proxy.
-export function getMeta(entity: Mutable<Unknown>): internal.ObjectMeta;
+export function getMeta(entity: Mutable<Unknown>): internal.EntityMeta;
 export function getMeta(entity: Unknown | Snapshot): internal.ReadonlyMeta;
-export function getMeta(entity: Unknown | Snapshot | Mutable<Unknown>): internal.ObjectMeta | internal.ReadonlyMeta {
+export function getMeta(entity: Unknown | Snapshot | Mutable<Unknown>): internal.EntityMeta | internal.ReadonlyMeta {
   return internal.getMetaChecked(entity);
 }
 
@@ -172,14 +251,31 @@ export const isDeleted = (entity: Unknown | Snapshot): boolean => internal.isDel
 
 /**
  * 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 const getLabel = (entity: Unknown | Snapshot, options?: internal.GetLabelOptions): string | undefined =>
+  internal.getLabel(entity, options);
+
+/**
+ * Set the label of an entity.
+ * Must be called within an `Entity.update` / `Obj.update` / `Relation.update` callback.
  */
-export const getLabel = (entity: Unknown | Snapshot): string | undefined => internal.getLabel(entity);
+export const setLabel = (entity: Mutable<Unknown>, label: string): void => internal.setLabel(entity, label);
 
 /**
  * Get the description of an entity.
  */
 export const getDescription = (entity: Unknown | Snapshot): string | undefined => internal.getDescription(entity);
 
+/**
+ * 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 const getIcon = (entity: Unknown | Snapshot): internal.IconAnnotation | undefined => internal.getIcon(entity);
+
 /**
  * Convert an entity to its JSON representation.
  */
@@ -198,7 +294,7 @@ export 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>;
 
@@ -206,7 +302,7 @@ 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.
@@ -214,30 +310,36 @@ 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 const change = <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>): void => {
+export const update = <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>): void => {
   internal.change(entity, callback);
 };
 
 /**
  * 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 const addTag = (entity: Mutable<Unknown>, tag: string): void => internal.addTag(entity, tag);
+export const addTag = (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>): void => internal.addTag(entity, tag);
 
 /**
  * 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 const removeTag = (entity: Mutable<Unknown>, tag: string): void => internal.removeTag(entity, tag);
+export const removeTag = (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>): void => internal.removeTag(entity, tag);
+
+//
+// Atoms
+//
+
+export const atom = objInternal.makeEntity;

package/src/Err.ts

@@ -5,7 +5,7 @@
 // @import-as-namespace
 
 import { BaseError, type BaseErrorOptions } from '@dxos/errors';
-import { type DXN } from '@dxos/keys';
+import { type URI } from '@dxos/keys';
 
 export class SchemaNotFoundError extends BaseError.extend('SchemaNotFoundError', 'Schema not found') {
   constructor(schema: string, options?: BaseErrorOptions) {
@@ -13,9 +13,9 @@ export class SchemaNotFoundError extends BaseError.extend('SchemaNotFoundError',
   }
 }
 
-export class ObjectNotFoundError extends BaseError.extend('ObjectNotFoundError', 'Object not found') {
-  constructor(dxn: DXN, options?: BaseErrorOptions) {
-    super({ context: { dxn }, ...options });
+export class EntityNotFoundError extends BaseError.extend('EntityNotFoundError', 'Entity not found') {
+  constructor(uri: URI.URI, options?: BaseErrorOptions) {
+    super({ context: { uri }, ...options });
   }
 }
 

package/src/Feed.ts

@@ -10,7 +10,7 @@ import * as Layer from 'effect/Layer';
 import type * as Option from 'effect/Option';
 import * as Schema from 'effect/Schema';
 
-import { DXN, type ObjectId } from '@dxos/keys';
+import { DXN, EID } from '@dxos/keys';
 
 import * as Annotation from './Annotation';
 import type * as Entity from './Entity';
@@ -43,21 +43,15 @@ export const Feed = Schema.Struct({
    */
   namespace: Schema.optional(Schema.Literal('data', 'trace')),
 }).pipe(
-  Type.object({
-    typename: 'org.dxos.type.feed',
-    version: '0.1.0',
-  }),
-  internal.SystemTypeAnnotation.set(true),
-  Annotation.IconAnnotation.set({
-    icon: 'ph--rows--regular',
-    hue: 'yellow',
-  }),
+  internal.HiddenAnnotation.set(true),
+  Annotation.IconAnnotation.set({ icon: 'ph--rows--regular', hue: 'yellow' }),
+  Type.makeObject(DXN.make('org.dxos.type.feed', '0.1.0')),
 );
 
 /**
  * TypeScript instance type for a Feed object.
  */
-export interface Feed extends Schema.Schema.Type<typeof Feed> {}
+export type Feed = Type.InstanceType<typeof Feed>;
 
 //
 // Types
@@ -80,6 +74,29 @@ export interface RetentionOptions {
   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;
+}
+
 //
 // Factory
 //
@@ -96,39 +113,11 @@ export interface RetentionOptions {
 export const make = (props: Obj.MakeProps<typeof Feed> = {}): Feed => Obj.make(Feed, props);
 
 /**
- * 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 const getQueueDxn = (feed: Feed): DXN | undefined => {
-  const self = Obj.getDXN(feed).asEchoDXN();
-  if (!self || !self.spaceId) {
-    return undefined;
-  }
-  return new DXN(DXN.kind.QUEUE, [feed.namespace ?? 'data', self.spaceId, self.echoId]);
-};
-
-/**
- * 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 const unsafeFromQueueDXN = (queueDxn: DXN): Feed => {
-  const parts = queueDxn.asQueueDXN();
-  if (!parts) {
-    throw new Error(`Expected a queue DXN, got: ${queueDxn.toString()}`);
-  }
-  return Obj.make(Feed, {
-    id: parts.queueId as ObjectId,
-    namespace: parts.subspaceTag === 'trace' ? 'trace' : undefined,
-  });
-};
+export const getQueueUri = (feed: Feed): EID.EID | undefined => EID.tryParse(Obj.getURI(feed));
 
 //
 // Service
@@ -150,7 +139,6 @@ export class FeedService extends Context.Tag('@dxos/echo/Feed/FeedService')<
     /**
      * Removes items from a feed by ID.
      */
-    // TODO(dmaretskyi): Change type to ObjectId.
     remove(feed: Feed, ids: string[]): Promise<void>;
 
     /**
@@ -160,6 +148,16 @@ export class FeedService extends Context.Tag('@dxos/echo/Feed/FeedService')<
       <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>;
   }
 >() {}
 
@@ -173,6 +171,21 @@ export type Service = FeedService;
  */
 export const Service = FeedService;
 
+/**
+ * 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 class ContextFeedService extends Context.Tag('@dxos/echo/Feed/ContextFeedService')<
+  ContextFeedService,
+  {
+    readonly feed: Feed;
+  }
+>() {
+  static layer = (feed: Feed): Layer.Layer<ContextFeedService> => Layer.succeed(ContextFeedService, { feed });
+}
+
 /**
  * Layer that provides a Feed service that throws when accessed.
  * Useful as a default layer when no feed service is available.
@@ -187,6 +200,12 @@ export const notAvailable: Layer.Layer<FeedService> = Layer.succeed(FeedService,
   query: () => {
     throw new Error('Feed.FeedService not available');
   },
+  sync: () => {
+    throw new Error('Feed.FeedService not available');
+  },
+  getSyncState: () => {
+    throw new Error('Feed.FeedService not available');
+  },
 } as Context.Tag.Service<FeedService>);
 
 //
@@ -262,6 +281,35 @@ export const runQuery: {
 } = (feed: Feed, queryOrFilter: Query.Any | Filter.Any) =>
   query(feed, queryOrFilter as any).pipe(Effect.flatMap((queryResult) => Effect.promise(() => queryResult.run())));
 
+/**
+ * Syncs the feed with the server.
+ *
+ * @example
+ * ```ts
+ * yield* Feed.sync(feed);
+ * yield* Feed.sync(feed, { shouldPush: false });
+ * ```
+ */
+export const sync = (feed: Feed, options?: SyncOptions): Effect.Effect<void, never, FeedService> =>
+  Effect.gen(function* () {
+    const service = yield* FeedService;
+    yield* Effect.promise(() => service.sync(feed, options));
+  });
+
+/**
+ * Returns queue replication backlog for the feed's namespace.
+ *
+ * @example
+ * ```ts
+ * const { blocksToPull, blocksToPush } = yield* Feed.getSyncState(feed);
+ * ```
+ */
+export const getSyncState = (feed: Feed): Effect.Effect<SyncState, never, FeedService> =>
+  Effect.gen(function* () {
+    const service = yield* FeedService;
+    return yield* Effect.promise(() => service.getSyncState(feed));
+  });
+
 /**
  * Creates a cursor for iterating over feed items.
  * Currently stubbed — cursor operations are not yet implemented.
@@ -292,13 +340,13 @@ export const nextOption = <T = Obj.Snapshot>(_cursor: Cursor<T>): Effect.Effect<
 
 /**
  * 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
  * yield* Feed.setRetention(feed, { count: 1000 });
  * ```
  */
-// TODO(feed): Implement when queue retention is supported.
+// TODO(dmaretskyi): Implement when feed retention is supported.
 export const setRetention = (_feed: Feed, _options: RetentionOptions): Effect.Effect<void, never, FeedService> =>
   Effect.void;