@dxos/protocols 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

package/dist/src/FeedProtocol.js

@@ -0,0 +1,237 @@
+//
+// Copyright 2026 DXOS.org
+//
+export const KEY_QUEUE_POSITION = 'org.dxos.key.queue-position';
+import * as Schema from 'effect/Schema';
+import { invariant } from '@dxos/invariant';
+import { SpaceId } from '@dxos/keys';
+import { EdgeService } from './edge/edge.js';
+/**
+ * Opaque pagination cursor for feed queries.
+ */
+export const FeedCursor = Schema.String.pipe(Schema.brand('@dxos/feed/FeedCursor'));
+/**
+ * Replicated queue block payload and ordering metadata.
+ */
+export const Block = Schema.Struct({
+    /**
+     * Appears on blocks returned from query.
+     */
+    feedId: Schema.UndefinedOr(Schema.String),
+    /**
+     * Actor that produced this block.
+     */
+    actorId: Schema.String,
+    /**
+     * Per-feed monotonic sequence assigned by the actor.
+     */
+    sequence: Schema.Number,
+    /**
+     * Actor of the immediate predecessor block, if any.
+     */
+    prevActorId: Schema.NullOr(Schema.String),
+    /**
+     * Sequence of the immediate predecessor block, if any.
+     */
+    prevSequence: Schema.NullOr(Schema.Number),
+    /**
+     * Globally ordered position assigned by a position authority.
+     * Unlike `sequence` (per-feed causal order), this enables merged incremental reads across feeds.
+     */
+    position: Schema.NullOr(Schema.Number),
+    /**
+     * Milliseconds since Unix epoch when the block was created.
+     */
+    timestamp: Schema.Number,
+    /**
+     * Serialized application payload.
+     */
+    data: Schema.Uint8Array,
+    /**
+     * Local insertion ID.
+     * Not replicated.
+     */
+    // TODO(dmaretskyi): Remove. Use cursors.
+    insertionId: Schema.optional(Schema.Number),
+});
+//
+// RPC Schemas
+//
+/**
+ * Query parameters for retrieving blocks from one namespace in one space.
+ */
+export const QueryRequest = Schema.Struct({
+    /**
+     * Optional request correlation identifier.
+     */
+    requestId: Schema.optional(Schema.String),
+    /**
+     * Target space identifier.
+     */
+    spaceId: SpaceId,
+    /**
+     * Feed namespace to query.
+     */
+    feedNamespace: Schema.String,
+    query: Schema.optional(Schema.Union(Schema.Struct({
+        /**
+         * Explicit list of feed IDs to read from.
+         */
+        feedIds: Schema.Array(Schema.String),
+    }), Schema.Struct({
+        /**
+         * Existing subscription to resolve feed IDs from.
+         */
+        subscriptionId: Schema.String,
+    }))),
+    /**
+     * Get changes following this cursor (exclusive).
+     *
+     * Must not be used with `position`.
+     */
+    cursor: Schema.optional(FeedCursor),
+    /**
+     * Get changes following this position.
+     * Returned blocks have strictly greater position than this.
+     *
+     * Must not be used with `cursor`.
+     */
+    position: Schema.optional(Schema.Number),
+    /**
+     * Only return blocks that are not positioned.
+     *
+     * Must not be used with `cursor` or `position`.
+     */
+    unpositionedOnly: Schema.optional(Schema.Boolean),
+    /**
+     * Maximum number of blocks to return.
+     */
+    limit: Schema.optional(Schema.Number),
+});
+/**
+ * Result payload for a query operation.
+ */
+export const QueryResponse = Schema.Struct({
+    /**
+     * Echoed request correlation identifier.
+     */
+    requestId: Schema.optional(Schema.String),
+    /**
+     * Cursor to continue reading from this result boundary.
+     */
+    nextCursor: FeedCursor,
+    /**
+     * Indicates whether more matching blocks are available.
+     */
+    hasMore: Schema.Boolean,
+    /**
+     * Returned blocks for the current page.
+     */
+    blocks: Schema.Array(Block),
+});
+/**
+ * Parameters for creating or refreshing a feed subscription.
+ */
+export const SubscribeRequest = Schema.Struct({
+    /**
+     * Optional request correlation identifier.
+     */
+    requestId: Schema.optional(Schema.String),
+    /**
+     * Optional space scope for the subscription.
+     */
+    spaceId: Schema.optional(Schema.String),
+    /**
+     * Feeds to include in the subscription.
+     */
+    feedIds: Schema.Array(Schema.String),
+});
+/**
+ * Response payload for subscription creation.
+ */
+export const SubscribeResponse = Schema.Struct({
+    /**
+     * Echoed request correlation identifier.
+     */
+    requestId: Schema.optional(Schema.String),
+    /**
+     * Identifier to use in subsequent subscription queries.
+     */
+    subscriptionId: Schema.String,
+    /**
+     * Expiration timestamp in milliseconds since Unix epoch.
+     */
+    expiresAt: Schema.Number,
+});
+/**
+ * Request payload for appending one or more blocks.
+ */
+export const AppendRequest = Schema.Struct({
+    /**
+     * Optional request correlation identifier.
+     */
+    requestId: Schema.optional(Schema.String),
+    /**
+     * Target space identifier.
+     */
+    spaceId: Schema.String,
+    /**
+     * Namespace that all appended blocks belong to.
+     */
+    feedNamespace: Schema.String,
+    /**
+     * Blocks to append.
+     */
+    blocks: Schema.Array(Block),
+});
+/**
+ * Result payload for append operations.
+ */
+export const AppendResponse = Schema.Struct({
+    /**
+     * Echoed request correlation identifier.
+     */
+    requestId: Schema.optional(Schema.String),
+    /**
+     * Assigned global positions for appended blocks.
+     */
+    positions: Schema.Array(Schema.Number),
+});
+/**
+ * Tagged transport message union for queue protocol RPC traffic.
+ */
+export const ProtocolMessage = Schema.Union(Schema.TaggedStruct('QueryRequest', QueryRequest.fields), Schema.TaggedStruct('QueryResponse', QueryResponse.fields), Schema.TaggedStruct('SubscribeRequest', SubscribeRequest.fields), Schema.TaggedStruct('SubscribeResponse', SubscribeResponse.fields), Schema.TaggedStruct('AppendRequest', AppendRequest.fields), Schema.TaggedStruct('AppendResponse', AppendResponse.fields), Schema.TaggedStruct('Error', {
+    /**
+     * Human-readable error message.
+     */
+    message: Schema.String,
+})).pipe(Schema.extend(Schema.Struct({
+    senderPeerId: Schema.UndefinedOr(Schema.String),
+    /**
+     * Could be undefined if the recipient could be assumed from the context.
+     */
+    recipientPeerId: Schema.UndefinedOr(Schema.String),
+})));
+/**
+ * Reserved namespaces with protocol-level semantics.
+ */
+export const WellKnownNamespaces = {
+    data: 'data',
+    trace: 'trace',
+};
+export const isWellKnownNamespace = (namespace) => Object.values(WellKnownNamespaces).includes(namespace);
+/**
+ * Encodes queue replicator service identifier as `<service>:<namespace>:<spaceId>`.
+ */
+export const encodeServiceId = (namespace, spaceId) => `${EdgeService.QUEUE_REPLICATOR}:${namespace}:${spaceId}`;
+/**
+ * Decodes and validates queue replicator service identifier.
+ */
+export const decodeServiceId = (serviceId) => {
+    const [service, namespace, spaceId] = serviceId.split(':');
+    invariant(service === EdgeService.QUEUE_REPLICATOR, `Invalid service: ${service}`);
+    invariant(isWellKnownNamespace(namespace), `Invalid namespace: ${namespace}`);
+    invariant(SpaceId.isValid(spaceId), `Invalid spaceId: ${spaceId}`);
+    return { namespace: namespace, spaceId };
+};
+//# sourceMappingURL=FeedProtocol.js.map

package/dist/src/FeedProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FeedProtocol.js","sourceRoot":"","sources":["../../src/FeedProtocol.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAYF,MAAM,CAAC,MAAM,kBAAkB,GAAG,6BAA6B,CAAC;AAEhE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;AAGpF;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM;IAEvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IAE1C;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,UAAU;IAEvB;;;OAGG;IACH,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;CAC5C,CAAC,CAAC;AAGH,EAAE;AACF,cAAc;AACd,EAAE;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,OAAO;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM;IAE5B,KAAK,EAAE,MAAM,CAAC,QAAQ,CACpB,MAAM,CAAC,KAAK,CACV,MAAM,CAAC,MAAM,CAAC;QACZ;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;KACrC,CAAC,EACF,MAAM,CAAC,MAAM,CAAC;QACZ;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC,MAAM;KAC9B,CAAC,CACH,CACF;IAED;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;IAEnC;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAExC;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;IAEjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;CACtC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,UAAU;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,OAAO;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;CAC5B,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;CACrC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;CAC5B,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;CACvC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CACzC,MAAM,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC,EACxD,MAAM,CAAC,YAAY,CAAC,eAAe,EAAE,aAAa,CAAC,MAAM,CAAC,EAC1D,MAAM,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAChE,MAAM,CAAC,YAAY,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAClE,MAAM,CAAC,YAAY,CAAC,eAAe,EAAE,aAAa,CAAC,MAAM,CAAC,EAC1D,MAAM,CAAC,YAAY,CAAC,gBAAgB,EAAE,cAAc,CAAC,MAAM,CAAC,EAC5D,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM;CACvB,CAAC,CACH,CAAC,IAAI,CACJ,MAAM,CAAC,MAAM,CACX,MAAM,CAAC,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;IAC/C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;CACnD,CAAC,CACH,CACF,CAAC;AAGF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAE,EAAE,CACxD,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,QAAQ,CAAC,SAAgB,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAE,OAAgB,EAAE,EAAE,CACrE,GAAG,WAAW,CAAC,gBAAgB,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,SAAiB,EACkD,EAAE;IACrE,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3D,SAAS,CAAC,OAAO,KAAK,WAAW,CAAC,gBAAgB,EAAE,oBAAoB,OAAO,EAAE,CAAC,CAAC;IACnF,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,sBAAsB,SAAS,EAAE,CAAC,CAAC;IAC9E,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,oBAAoB,OAAO,EAAE,CAAC,CAAC;IACnE,OAAO,EAAE,SAAS,EAAE,SAA6C,EAAE,OAAO,EAAE,CAAC;AAC/E,CAAC,CAAC"}

package/dist/src/FunctionProtocol.d.ts

@@ -0,0 +1,82 @@
+import { type SpaceId } from '@dxos/keys';
+import type * as QueryProto from '@dxos/protocols/proto/dxos/echo/query';
+import type * as DataProto from '@dxos/protocols/proto/dxos/echo/service';
+import { type EdgeFunctionEnv } from './edge';
+import type * as FeedProtocol from './FeedProtocol';
+/**
+ * Function implementation.
+ * This is a contract between the user-defined function and the runtime.
+ */
+export interface Func {
+    readonly meta: Meta;
+    readonly handler: Handler;
+}
+/**
+ * Function metadata.
+ */
+export interface Meta {
+    readonly key: string;
+    name?: string;
+    description?: string;
+    /**
+     * Required services.
+     */
+    readonly services: readonly string[];
+    /**
+     * JSON schema format
+     */
+    readonly inputSchema: unknown;
+    /**
+     * JSON schema format.
+     */
+    readonly outputSchema?: unknown;
+}
+/**
+ * Function handler.
+ * Executed by the runtime
+ */
+export type Handler = (opts: {
+    data: unknown;
+    context: Context;
+}) => Promise<unknown>;
+/**
+ * Function context.
+ */
+export interface Context {
+    services: {
+        /**
+         * Query service.
+         * Available if the function is invoked in context of a space.
+         */
+        queryService?: QueryProto.QueryService;
+        /**
+         * Data service.
+         * Available if the function is invoked in context of a space.
+         */
+        dataService?: DataProto.DataService;
+        /**
+         * Queue service.
+         * Available if the function is invoked in context of a space.
+         */
+        queueService?: FeedProtocol.QueueService;
+        /**
+         * Functions service.
+         * Available if the function is invoked in context of a space.
+         */
+        functionsAiService?: EdgeFunctionEnv.FunctionsAiService;
+    };
+    /**
+     * That space that the function is invoked in context of.
+     */
+    spaceId?: SpaceId;
+    /**
+     * Hex-encoded space key.
+     * @deprecated We need to remove this but ECHO keeps dragging this in.
+     */
+    spaceKey?: string;
+    /**
+     * Automerge URL of the space-root document.
+     */
+    spaceRootUrl?: string;
+}
+//# sourceMappingURL=FunctionProtocol.d.ts.map

package/dist/src/FunctionProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionProtocol.d.ts","sourceRoot":"","sources":["../../src/FunctionProtocol.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,KAAK,UAAU,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,KAAK,SAAS,MAAM,yCAAyC,CAAC;AAE1E,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,KAAK,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAWpD;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,EAAE;QACR;;;WAGG;QACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;QAEvC;;;WAGG;QACH,WAAW,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC;QAEpC;;;WAGG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;QAEzC;;;WAGG;QACH,kBAAkB,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC;KACzD,CAAC;IAEF;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/src/FunctionProtocol.js

@@ -0,0 +1,4 @@
+//
+// Copyright 2025 DXOS.org
+//
+//# sourceMappingURL=FunctionProtocol.js.map

package/dist/src/FunctionProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionProtocol.js","sourceRoot":"","sources":["../../src/FunctionProtocol.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE"}

package/dist/src/automerge.d.ts

@@ -12,6 +12,7 @@ export type LeaveProtocolMessage = {
     type: 'leave';
     targetId?: PeerId;
     senderId: PeerId;
+    metadata?: Record<string, unknown>;
 };
 export type PeerProtocolMessage = {
     type: 'peer';
@@ -33,6 +34,7 @@ export type RequestProtocolMessage = {
     targetId: PeerId;
     documentId: string;
     data: Uint8Array;
+    metadata?: Record<string, unknown>;
 };
 /**
  * A sync message for a particular document
@@ -43,6 +45,7 @@ export type SyncProtocolMessage = {
     targetId: PeerId;
     documentId: string;
     data: Uint8Array;
+    metadata?: Record<string, unknown>;
 };
 /**
  * Sent by a {@link Repo} to indicate that it does not have the document and none of its connected
@@ -53,6 +56,7 @@ export type UnavailableProtocolMessage = {
     senderId: PeerId;
     targetId: PeerId;
     documentId: string;
+    metadata?: Record<string, unknown>;
 };
 /**
  * An ephemeral message.
@@ -73,12 +77,14 @@ export type EphemeralProtocolMessage = {
     sessionId: string;
     documentId: string;
     data: Uint8Array;
+    metadata?: Record<string, unknown>;
 };
 export type ErrorProtocolMessage = {
     type: 'error';
     senderId?: PeerId;
     targetId?: PeerId;
     message: string;
+    metadata?: Record<string, unknown>;
 };
 export declare const MESSAGE_TYPE_COLLECTION_QUERY = "collection-query";
 export type CollectionQueryMessage = {
@@ -91,6 +97,7 @@ export type CollectionQueryMessage = {
      * Remote peer will skip sending the state if it has the same tag.
      */
     stateTag?: string;
+    metadata?: Record<string, unknown>;
 };
 export declare const MESSAGE_TYPE_COLLECTION_STATE = "collection-state";
 export type CollectionStateMessage = {
@@ -106,6 +113,7 @@ export type CollectionStateMessage = {
      * Identifier of the current state.
      */
     stateTag?: string;
+    metadata?: Record<string, unknown>;
 };
 export type AutomergeProtocolMessage = JoinProtocolMessage | PeerProtocolMessage | LeaveProtocolMessage | RequestProtocolMessage | SyncProtocolMessage | UnavailableProtocolMessage | EphemeralProtocolMessage | ErrorProtocolMessage | CollectionQueryMessage | CollectionStateMessage;
 //# sourceMappingURL=automerge.d.ts.map

package/dist/src/automerge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automerge.d.ts","sourceRoot":"","sources":["../../src/automerge.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;KAUK;AACL,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,6BAA6B,qBAAqB,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,6BAA6B,qBAAqB,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAChC,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,0BAA0B,GAC1B,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,CAAC"}
+{"version":3,"file":"automerge.d.ts","sourceRoot":"","sources":["../../src/automerge.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;KAUK;AACL,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,eAAO,MAAM,6BAA6B,qBAAqB,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,eAAO,MAAM,6BAA6B,qBAAqB,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,OAAO,6BAA6B,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAChC,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,0BAA0B,GAC1B,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,CAAC"}

package/dist/src/automerge.js.map

@@ -1 +1 @@
-{"version":3,"file":"automerge.js","sourceRoot":"","sources":["../../src/automerge.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AA2FF,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC;AAehE,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"automerge.js","sourceRoot":"","sources":["../../src/automerge.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAiGF,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC;AAgBhE,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC"}

package/dist/src/buf/proto/gen/dxos/agent/dashboard_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { EmptySchema } from "@bufbuild/protobuf/wkt";
 import type { Runtime_Agent_Plugin } from "../config_pb.js";
 import type { Message } from "@bufbuild/protobuf";

package/dist/src/buf/proto/gen/dxos/agent/dashboard_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2023 DXOS.org
 //
-import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
+import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_empty, file_google_protobuf_struct } from "@bufbuild/protobuf/wkt";
 import { file_dxos_config } from "../config_pb.js";
 /**

package/dist/src/buf/proto/gen/dxos/agent/echo-proxy_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 /**
  * Describes the file dxos/agent/echo-proxy.proto.

package/dist/src/buf/proto/gen/dxos/agent/echo-proxy_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2023 DXOS.org
 //
-import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
 /**
  * Describes the file dxos/agent/echo-proxy.proto.
  */

package/dist/src/buf/proto/gen/dxos/agent/epoch_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 /**
  * Describes the file dxos/agent/epoch.proto.

package/dist/src/buf/proto/gen/dxos/agent/epoch_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2023 DXOS.org
 //
-import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
 /**
  * Describes the file dxos/agent/epoch.proto.
  */

package/dist/src/buf/proto/gen/dxos/agent/functions_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { EmptySchema } from "@bufbuild/protobuf/wkt";
 import type { Message } from "@bufbuild/protobuf";
 /**

package/dist/src/buf/proto/gen/dxos/agent/functions_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2023 DXOS.org
 //
-import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
+import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_empty } from "@bufbuild/protobuf/wkt";
 /**
  * Describes the file dxos/agent/functions.proto.

package/dist/src/buf/proto/gen/dxos/bot_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { EmptySchema, Timestamp } from "@bufbuild/protobuf/wkt";
 import type { Invitation } from "./client/invitation_pb.js";
 import type { Config } from "./config_pb.js";

package/dist/src/buf/proto/gen/dxos/bot_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2020 DXOS.org
 //
-import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
+import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_empty, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
 import { file_dxos_client_invitation } from "./client/invitation_pb.js";
 import { file_dxos_config } from "./config_pb.js";

package/dist/src/buf/proto/gen/dxos/client/invitation_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Timestamp } from "@bufbuild/protobuf/wkt";
 import type { SpaceMember_Role } from "../halo/credentials_pb.js";
 import type { PrivateKey, PublicKey } from "../keys_pb.js";

package/dist/src/buf/proto/gen/dxos/client/invitation_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2021 DXOS.org
 //
-import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
+import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_any, file_google_protobuf_empty, file_google_protobuf_struct, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
 import { file_dxos_config } from "../config_pb.js";
 import { file_dxos_devtools_swarm } from "../devtools/swarm_pb.js";

package/dist/src/buf/proto/gen/dxos/client/logging_pb.d.ts

@@ -1,4 +1,4 @@
-import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { Timestamp } from "@bufbuild/protobuf/wkt";
 import type { Error } from "../error_pb.js";
 import type { Stats, Value } from "../value_pb.js";

package/dist/src/buf/proto/gen/dxos/client/logging_pb.js

@@ -1,7 +1,7 @@
 //
 // Copyright 2021 DXOS.org
 //
-import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
+import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_any, file_google_protobuf_empty, file_google_protobuf_struct, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
 import { file_dxos_config } from "../config_pb.js";
 import { file_dxos_echo_metadata } from "../echo/metadata_pb.js";