@dxos/protocols 0.8.4-staging.ac66bdf99f → 0.9.0

package/src/proto/gen/dxos/echo/model/document.ts

@@ -68,8 +68,7 @@ import * as google_protobuf from "../../../google/protobuf.js";
 /**
  * Generic value.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface Value {
     null?: boolean;
@@ -87,8 +86,7 @@ export interface Value {
 /**
  * Ordered collection of values.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface Array {
     values?: Value[];
@@ -96,8 +94,7 @@ export interface Array {
 /**
  * Key x Value tuple.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface KeyValue {
     key: string;
@@ -106,8 +103,7 @@ export interface KeyValue {
 /**
  * Object data definition.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface KeyValueObject {
     properties?: KeyValue[];
@@ -115,8 +111,7 @@ export interface KeyValueObject {
 /**
  * Reference to an Item.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface Reference {
     objectId: string;
@@ -138,8 +133,7 @@ export interface Reference {
 /**
  * Query predicate.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface Predicate {
     op: Predicate.Operation;
@@ -177,8 +171,7 @@ export namespace Predicate {
 /**
  * Query.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface Query {
     root: Predicate;
@@ -186,8 +179,7 @@ export interface Query {
 /**
  * State snapshot.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface ObjectSnapshot {
     /**
@@ -210,8 +202,7 @@ export interface ObjectSnapshot {
 /**
  * Atomic mutation.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface ObjectMutation {
     operation: ObjectMutation.Operation;
@@ -242,8 +233,7 @@ export namespace ObjectMutation {
     }
 }
 /**
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface YJS {
     id: Uint8Array;
@@ -252,8 +242,7 @@ export interface YJS {
 /**
  * Set of mutations.
  *
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/document.proto}
+ * Defined in: `../../../../dxos/echo/model/document.proto`
  */
 export interface ObjectMutationSet {
     /**

package/src/proto/gen/dxos/echo/model/messenger.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../../example/testing/data.js";
 import * as example_testing_rpc from "../../../example/testing/rpc.js";
 import * as google_protobuf from "../../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/messenger.proto}
+ * Defined in: `../../../../dxos/echo/model/messenger.proto`
  */
 export interface Message {
     timestamp: string;

package/src/proto/gen/dxos/echo/model/text.ts

@@ -74,8 +74,7 @@ export enum TextKind {
     RICH = 1
 }
 /**
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/text.proto}
+ * Defined in: `../../../../dxos/echo/model/text.proto`
  */
 export interface TextMutation {
     /**
@@ -100,8 +99,7 @@ export interface TextMutation {
     field?: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../../dxos/echo/model/text.proto}
+ * Defined in: `../../../../dxos/echo/model/text.proto`
  */
 export interface TextSnapshot {
     data: Uint8Array;

package/src/proto/gen/dxos/echo/object.ts

@@ -68,8 +68,7 @@ import * as google_protobuf from "../../google/protobuf.js";
 /**
  * Wrapper for all ECHO messages.
  *
- * Defined in:
- *   {@link file://./../../../dxos/echo/object.proto}
+ * Defined in: `../../../dxos/echo/object.proto`
  */
 export interface EchoObject {
     objectId: string;
@@ -99,8 +98,7 @@ export interface EchoObject {
 }
 export namespace EchoObject {
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/object.proto}
+     * Defined in: `../../../dxos/echo/object.proto`
      */
     export interface Genesis {
         modelType: string;
@@ -111,8 +109,7 @@ export namespace EchoObject {
         modelVersion?: string;
     }
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/object.proto}
+     * Defined in: `../../../dxos/echo/object.proto`
      */
     export interface Snapshot {
         /**
@@ -135,8 +132,7 @@ export namespace EchoObject {
         model?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
     }
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/object.proto}
+     * Defined in: `../../../dxos/echo/object.proto`
      */
     export interface Mutation {
         /**
@@ -176,8 +172,7 @@ export namespace EchoObject {
     }
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/object.proto}
+ * Defined in: `../../../dxos/echo/object.proto`
  */
 export interface MutationMeta {
     /**
@@ -206,8 +201,7 @@ export interface MutationMeta {
     clientTag?: string[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/object.proto}
+ * Defined in: `../../../dxos/echo/object.proto`
  */
 export interface EchoObjectBatch {
     objects?: EchoObject[];

package/src/proto/gen/dxos/echo/query.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/query.proto}
+ * Defined in: `../../../dxos/echo/query.proto`
  */
 export interface QueryRequest {
     /**
@@ -93,15 +92,13 @@ export interface QueryRequest {
  * Used for encoding in Index metadata store.
  * @see https://automerge.org/automerge-repo/types/_automerge_automerge_repo.Heads.html
  *
- * Defined in:
- *   {@link file://./../../../dxos/echo/query.proto}
+ * Defined in: `../../../dxos/echo/query.proto`
  */
 export interface Heads {
     hashes?: string[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/query.proto}
+ * Defined in: `../../../dxos/echo/query.proto`
  */
 export interface QueryResult {
     id: string;
@@ -151,8 +148,7 @@ export enum QueryReactivity {
     REACTIVE = 1
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/query.proto}
+ * Defined in: `../../../dxos/echo/query.proto`
  */
 export interface QueryResponse {
     /**

package/src/proto/gen/dxos/echo/service.ts

@@ -66,31 +66,27 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface SubscribeRequest {
     subscriptionId: string;
     spaceId: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface BatchedDocumentUpdates {
     updates?: DocumentUpdate[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface UpdateRequest {
     subscriptionId: string;
     updates?: DocumentUpdate[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface UpdateSubscriptionRequest {
     /**
@@ -110,8 +106,7 @@ export interface UpdateSubscriptionRequest {
     removeIds?: string[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface FlushRequest {
     /**
@@ -120,8 +115,7 @@ export interface FlushRequest {
     documentIds?: string[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface DocumentUpdate {
     /**
@@ -131,20 +125,36 @@ export interface DocumentUpdate {
     /**
      * Automerge document incremental update.
      * Value returned by `Automerge.saveSince()`.
+     * Optional: if absent, the update only carries a transition signal (e.g.
+     * `requesting`) and not new bytes.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    mutation?: Uint8Array;
+    /**
+     * Set by the worker when the disk probe for this document completes
+     * negative — i.e. the document is not on local storage, and the worker
+     * has started a network fetch. The client moves the corresponding
+     * `DocHandleProxy` from `'pending'` to `'requesting'`. Once the bytes
+     * eventually arrive, a normal `mutation` update follows and the handle
+     * transitions to `'ready'`. Used by query-driven (disk-only) callers to
+     * give up on a load without waiting on the network.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
-    mutation: Uint8Array;
+    requesting?: boolean;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface DocHeadsList {
     entries?: DocHeadsList.Entry[];
 }
 export namespace DocHeadsList {
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/service.proto}
+     * Defined in: `../../../dxos/echo/service.proto`
      */
     export interface Entry {
         documentId: string;
@@ -152,36 +162,31 @@ export namespace DocHeadsList {
     }
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface GetDocumentHeadsRequest {
     documentIds?: string[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface GetDocumentHeadsResponse {
     heads: DocHeadsList;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface WaitUntilHeadsReplicatedRequest {
     heads: DocHeadsList;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface ReIndexHeadsRequest {
     documentIds?: string[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface CreateDocumentRequest {
     /**
@@ -198,8 +203,7 @@ export interface CreateDocumentRequest {
     initialValue?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface CreateDocumentResponse {
     /**
@@ -208,23 +212,20 @@ export interface CreateDocumentResponse {
     documentId: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface GetSpaceSyncStateRequest {
     spaceId: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
+ * Defined in: `../../../dxos/echo/service.proto`
  */
 export interface SpaceSyncState {
     peers?: SpaceSyncState.PeerState[];
 }
 export namespace SpaceSyncState {
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/service.proto}
+     * Defined in: `../../../dxos/echo/service.proto`
      */
     export interface PeerState {
         peerId: string;

package/src/proto/gen/dxos/echo/snapshot.ts

@@ -73,8 +73,7 @@ import * as google_protobuf from "../../google/protobuf.js";
  * The timeframe defines the set of feed messages that have already been processed.
  * When loading from the snapshot, application would skip all of the feed messages up to (and including) the provided timeframe.
  *
- * Defined in:
- *   {@link file://./../../../dxos/echo/snapshot.proto}
+ * Defined in: `../../../dxos/echo/snapshot.proto`
  */
 export interface SpaceSnapshot {
     spaceKey: Uint8Array;
@@ -93,8 +92,7 @@ export interface SpaceSnapshot {
 /**
  * Database Snapshot
  *
- * Defined in:
- *   {@link file://./../../../dxos/echo/snapshot.proto}
+ * Defined in: `../../../dxos/echo/snapshot.proto`
  */
 export interface EchoSnapshot {
     items?: dxos_echo_object.EchoObject[];

package/src/proto/gen/dxos/echo/timeframe.ts

@@ -68,16 +68,14 @@ import * as google_protobuf from "../../google/protobuf.js";
 /**
  * Vector timestamp used to order messages.
  *
- * Defined in:
- *   {@link file://./../../../dxos/echo/timeframe.proto}
+ * Defined in: `../../../dxos/echo/timeframe.proto`
  */
 export interface TimeframeVector {
     frames?: TimeframeVector.Frame[];
 }
 export namespace TimeframeVector {
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/timeframe.proto}
+     * Defined in: `../../../dxos/echo/timeframe.proto`
      */
     export interface Frame {
         feedKey: Uint8Array;

package/src/proto/gen/dxos/edge/calls.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/calls.proto}
+ * Defined in: `../../../dxos/edge/calls.proto`
  */
 export interface Tracks {
     /**
@@ -102,8 +101,7 @@ export interface Tracks {
     screenshareEnabled?: boolean;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/calls.proto}
+ * Defined in: `../../../dxos/edge/calls.proto`
  */
 export interface UserState {
     id: string;
@@ -123,8 +121,7 @@ export interface UserState {
  * Activity state.
  * It will be merged across all users in the room based on the Lamport timestamp (last one wins).
  *
- * Defined in:
- *   {@link file://./../../../dxos/edge/calls.proto}
+ * Defined in: `../../../dxos/edge/calls.proto`
  */
 export interface Activity {
     lamportTimestamp: LamportTimestamp;
@@ -135,8 +132,7 @@ export interface Activity {
  *
  * Used to encode/decode the Any payload of a call activity for the meeting plugin.
  *
- * Defined in:
- *   {@link file://./../../../dxos/edge/calls.proto}
+ * Defined in: `../../../dxos/edge/calls.proto`
  */
 export interface MeetingPayload {
     meetingId: string;
@@ -147,8 +143,7 @@ export interface MeetingPayload {
  * Lamport Timestamp.
  * @see https://en.wikipedia.org/wiki/Lamport_timestamp
  *
- * Defined in:
- *   {@link file://./../../../dxos/edge/calls.proto}
+ * Defined in: `../../../dxos/edge/calls.proto`
  */
 export interface LamportTimestamp {
     version: number;

package/src/proto/gen/dxos/edge/messenger.ts

@@ -75,8 +75,7 @@ export enum ConnectionState {
     DISCONNECTED_ABRUPT = 2
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/messenger.proto}
+ * Defined in: `../../../dxos/edge/messenger.proto`
  */
 export interface Peer {
     /**
@@ -120,8 +119,7 @@ export interface Peer {
     state?: Uint8Array;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/messenger.proto}
+ * Defined in: `../../../dxos/edge/messenger.proto`
  */
 export interface Message {
     /**
@@ -156,8 +154,7 @@ export interface Message {
 /**
  * W3C Trace Context propagation (https://www.w3.org/TR/trace-context/).
  *
- * Defined in:
- *   {@link file://./../../../dxos/edge/messenger.proto}
+ * Defined in: `../../../dxos/edge/messenger.proto`
  */
 export interface TraceContext {
     /**
@@ -173,8 +170,7 @@ export interface TraceContext {
     tracestate?: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/messenger.proto}
+ * Defined in: `../../../dxos/edge/messenger.proto`
  */
 export interface SwarmRequest {
     /**
@@ -196,8 +192,7 @@ export namespace SwarmRequest {
     }
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/messenger.proto}
+ * Defined in: `../../../dxos/edge/messenger.proto`
  */
 export interface SwarmResponse {
     swarmKey: string;
@@ -211,8 +206,7 @@ export interface SwarmResponse {
     inactivePeers?: Peer[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/messenger.proto}
+ * Defined in: `../../../dxos/edge/messenger.proto`
  */
 export interface TextMessage {
     /**

package/src/proto/gen/dxos/edge/signal.ts

@@ -66,31 +66,27 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/signal.proto}
+ * Defined in: `../../../dxos/edge/signal.proto`
  */
 export interface JoinRequest {
     topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     peer: dxos_edge_messenger.Peer;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/signal.proto}
+ * Defined in: `../../../dxos/edge/signal.proto`
  */
 export interface LeaveRequest {
     topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     peer: dxos_edge_messenger.Peer;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/signal.proto}
+ * Defined in: `../../../dxos/edge/signal.proto`
  */
 export interface QueryRequest {
     topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/edge/signal.proto}
+ * Defined in: `../../../dxos/edge/signal.proto`
  */
 export interface Message {
     author: dxos_edge_messenger.Peer;
@@ -100,8 +96,7 @@ export interface Message {
 /**
  * Goes on Pub/Sub swarm topic and as a Join stream in RPC.
  *
- * Defined in:
- *   {@link file://./../../../dxos/edge/signal.proto}
+ * Defined in: `../../../dxos/edge/signal.proto`
  */
 export interface SwarmEvent {
     topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
@@ -116,8 +111,7 @@ export interface SwarmEvent {
 }
 export namespace SwarmEvent {
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/edge/signal.proto}
+     * Defined in: `../../../dxos/edge/signal.proto`
      */
     export interface PeerAvailable {
         peer: dxos_edge_messenger.Peer;
@@ -136,8 +130,7 @@ export namespace SwarmEvent {
         announceBackToHost?: Uint8Array;
     }
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/edge/signal.proto}
+     * Defined in: `../../../dxos/edge/signal.proto`
      */
     export interface PeerLeft {
         peer: dxos_edge_messenger.Peer;

package/src/proto/gen/dxos/error.ts

@@ -68,8 +68,7 @@ import * as google_protobuf from "../google/protobuf.js";
 /**
  * Serialized error.
  *
- * Defined in:
- *   {@link file://./../../dxos/error.proto}
+ * Defined in: `../../dxos/error.proto`
  */
 export interface Error {
     /**