@dxos/protocols 2.33.9-dev.e605934d → 2.33.9-dev.eb69ac10

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

@@ -17,6 +17,10 @@ import * as dxos_halo_keys from "./halo/keys";
 import * as dxos_rpc from "./rpc";
 import * as dxos_test_echo from "./test/echo";
 import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface DevtoolsHost {
     events: (request: void) => Stream<Event>;
     getConfig: (request: void) => Promise<GetConfigResponse>;
@@ -38,175 +42,407 @@ export interface DevtoolsHost {
     subscribeToSignalTrace: (request: void) => Stream<SubscribeToSignalTraceResponse>;
     subscribeToSwarmInfo: (request: SubscribeToSwarmInfoRequest) => Stream<SubscribeToSwarmInfoResponse>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface Event {
     ready?: ReadyEvent;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface ReadyEvent {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface GetConfigResponse {
-    config?: string;
+    config: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface EnableDebugLoggingRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     namespaces?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface EnableDebugLoggingResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     enabledNamespaces?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface DisableDebugLoggingRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     namespaces?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface DisableDebugLoggingResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     enabledNamespaces?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToKeyringKeysRequest {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToKeyringKeysResponse {
     keys?: dxos_halo_keys.KeyRecord[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToCredentialMessagesRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     partyKey?: dxos_halo_keys.PubKey;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToCredentialMessagesResponse {
     messages?: dxos_credentials.SignedMessage[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface ResetStorageRequest {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface GetNetworkPeersRequest {
-    topic?: Uint8Array;
+    topic: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface GetNetworkPeersResponse {
     peers?: GetNetworkPeersResponse.PeerInfo[];
 }
 export namespace GetNetworkPeersResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface PeerInfo {
-        id?: dxos_halo_keys.PubKey;
-        state?: string;
+        id: dxos_halo_keys.PubKey;
+        state: string;
         connections?: Uint8Array[];
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToPartiesRequest {
     partyKeys?: dxos_halo_keys.PubKey[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToPartiesResponse {
     parties?: SubscribeToPartiesResponse.PartyInfo[];
 }
 export namespace SubscribeToPartiesResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface PartyInfo {
-        key?: dxos_halo_keys.PubKey;
-        isOpen?: boolean;
-        isActive?: boolean;
-        timeframe?: dxos_echo_timeframe.TimeframeVector;
+        key: dxos_halo_keys.PubKey;
+        isOpen: boolean;
+        isActive: boolean;
+        timeframe: dxos_echo_timeframe.TimeframeVector;
         feeds?: dxos_halo_keys.PubKey[];
         properties?: Partial<Record<string, string>>;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToItemsRequest {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToItemsResponse {
-    data?: string;
+    data: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToFeedsRequest {
-    partyKey?: dxos_halo_keys.PubKey;
+    partyKey: dxos_halo_keys.PubKey;
     feedKeys?: dxos_halo_keys.PubKey[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToFeedsResponse {
     feeds?: SubscribeToFeedsResponse.Feed[];
 }
 export namespace SubscribeToFeedsResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface Feed {
-        feedKey?: dxos_halo_keys.PubKey;
-        length?: number;
+        feedKey: dxos_halo_keys.PubKey;
+        length: number;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToFeedBlocksRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     partyKey?: dxos_halo_keys.PubKey;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     feedKey?: dxos_halo_keys.PubKey;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     maxBlocks?: number;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToFeedBlocksResponse {
     blocks?: SubscribeToFeedBlocksResponse.Block[];
 }
 export namespace SubscribeToFeedBlocksResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface Block {
-        key?: Uint8Array;
-        seq?: number;
-        sync?: boolean;
-        path?: string;
-        data?: dxos_echo_feed.FeedMessage;
+        key: Uint8Array;
+        seq: number;
+        sync: boolean;
+        path: string;
+        data: dxos_echo_feed.FeedMessage;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface GetPartySnapshotRequest {
     partyKey: dxos_halo_keys.PubKey;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface GetPartySnapshotResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     snapshot?: dxos_echo_snapshot.PartySnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SavePartySnapshotRequest {
     partyKey: dxos_halo_keys.PubKey;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SavePartySnapshotResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     snapshot?: dxos_echo_snapshot.PartySnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface ClearSnapshotsRequest {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToNetworkTopicsResponse {
     topics?: SubscribeToNetworkTopicsResponse.Topic[];
 }
 export namespace SubscribeToNetworkTopicsResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface Topic {
-        topic?: dxos_halo_keys.PubKey;
+        topic: dxos_halo_keys.PubKey;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
         label?: string;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToSignalStatusResponse {
     servers?: SubscribeToSignalStatusResponse.SignalServer[];
 }
 export namespace SubscribeToSignalStatusResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface SignalServer {
-        host?: string;
-        state?: string;
+        host: string;
+        state: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
         error?: string;
-        reconnectIn?: number;
-        connectionStarted?: number;
-        lastStateChange?: number;
+        reconnectIn: number;
+        connectionStarted: number;
+        lastStateChange: number;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToSignalTraceResponse {
     events?: string[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToSwarmInfoRequest {
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SubscribeToSwarmInfoResponse {
     data?: SubscribeToSwarmInfoResponse.SwarmInfo[];
 }
 export namespace SubscribeToSwarmInfoResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/devtools.proto}
+     */
     export interface SwarmInfo {
-        id?: dxos_halo_keys.PubKey;
-        topic?: dxos_halo_keys.PubKey;
+        id: dxos_halo_keys.PubKey;
+        topic: dxos_halo_keys.PubKey;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
         label?: string;
-        isActive?: boolean;
+        isActive: boolean;
         connections?: SubscribeToSwarmInfoResponse.SwarmInfo.ConnectionInfo[];
     }
     export namespace SwarmInfo {
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/devtools.proto}
+         */
         export interface ConnectionInfo {
-            state?: string;
-            sessionId?: dxos_halo_keys.PubKey;
-            remotePeerId?: dxos_halo_keys.PubKey;
+            state: string;
+            sessionId: dxos_halo_keys.PubKey;
+            remotePeerId: dxos_halo_keys.PubKey;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
             transport?: string;
             protocolExtensions?: string[];
             events?: SubscribeToSwarmInfoResponse.SwarmInfo.ConnectionInfo.Json[];
         }
         export namespace ConnectionInfo {
+            /**
+             * Defined in:
+             *   {@link file://./../../dxos/devtools.proto}
+             */
             export interface Json {
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
                 data?: string;
             }
         }
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface TracingService {
     setTracingOptions: (request: SetTracingOptionsRequest) => Promise<void>;
     subscribeToRpcTrace: (request: void) => Stream<dxos_rpc.RpcMessage>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/devtools.proto}
+ */
 export interface SetTracingOptionsRequest {
-    enable?: boolean;
+    enable: boolean;
 }

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

@@ -20,49 +20,108 @@ import * as google_protobuf from "../../google/protobuf";
 /**
  * Outer message type decoded by Codec.
  * This is what is written to the feeds.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/feed.proto}
  */
 export interface FeedMessage {
-    timeframe?: dxos_echo_timeframe.TimeframeVector;
+    timeframe: dxos_echo_timeframe.TimeframeVector;
     halo?: CredentialsMessage;
     echo?: EchoEnvelope;
 }
 /**
  * A container for dxos.credentials.Message
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/feed.proto}
  */
 export interface CredentialsMessage {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
 /**
  * Wrapper for all ECHO messages.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/feed.proto}
  */
 export interface EchoEnvelope {
-    itemId?: string;
+    itemId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     genesis?: ItemGenesis;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     itemMutation?: ItemMutation;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     mutation?: Uint8Array;
     /**
      * Set the model to the provided snapshot.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     snapshot?: dxos_echo_snapshot.ModelSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/feed.proto}
+ */
 export interface LinkData {
-    source?: string;
-    target?: string;
+    source: string;
+    target: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/feed.proto}
+ */
 export interface ItemGenesis {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     itemType?: string;
-    modelType?: string;
+    modelType: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     modelVersion?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     link?: LinkData;
 }
 /**
  * Item mutation.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/feed.proto}
  */
 export interface ItemMutation {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     parentId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     action?: ItemMutation.Action;
 }
 export namespace ItemMutation {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/echo/feed.proto}
+     */
     export enum Action {
         NOOP = 0,
         DELETE = 1,

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

@@ -17,20 +17,36 @@ import * as dxos_halo_keys from "../halo/keys";
 import * as dxos_rpc from "../rpc";
 import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/invitation.proto}
+ */
 export interface InvitationDescriptor {
-    type?: InvitationDescriptor.Type;
-    swarmKey?: Uint8Array;
-    invitation?: Uint8Array;
+    type: InvitationDescriptor.Type;
+    swarmKey: Uint8Array;
+    invitation: Uint8Array;
     /**
      * Only present if type == OFFLINE.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     identityKey?: Uint8Array;
     /**
      * Must be stripped out when passing to another peer.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     secret?: Uint8Array;
 }
 export namespace InvitationDescriptor {
+    /**
+     * Defines an invitation type.
+     *
+     * Defined in:
+     *   {@link file://./../../../dxos/echo/invitation.proto}
+     */
     export enum Type {
         INTERACTIVE = 1,
         OFFLINE = 2

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

@@ -17,6 +17,10 @@ import * as dxos_halo_keys from "../halo/keys";
 import * as dxos_rpc from "../rpc";
 import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/metadata.proto}
+ */
 export interface EchoMetadata {
     /**
      * Version number that is inceremnted every time there's a breaking change to the storage schema.
@@ -24,25 +28,43 @@ export interface EchoMetadata {
      * This is used to detect if the storage schema has changed since the last time the client was run.
      * Loading data from a different version will might result in an error.
      */
-    version?: number;
+    version: number;
     parties?: PartyMetadata[];
-    created?: google_protobuf.Timestamp;
-    updated?: google_protobuf.Timestamp;
+    created: google_protobuf.Timestamp;
+    updated: google_protobuf.Timestamp;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/metadata.proto}
+ */
 export interface PartyMetadata {
     /**
      * Party key.
      */
-    key?: dxos_halo_keys.PubKey;
+    key: dxos_halo_keys.PubKey;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     genesisFeedKey?: dxos_halo_keys.PubKey;
     /**
      * Key of the wriatable control feed.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     controlFeedKey?: dxos_halo_keys.PubKey;
     /**
      * Key of the wriatable data feed.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     dataFeedKey?: dxos_halo_keys.PubKey;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     latestTimeframe?: dxos_echo_timeframe.TimeframeVector;
     /**
      * List of all feed associated with the party.