@dxos/client 2.33.9-dev.002e8917 → 2.33.9-dev.227ba79d

package/src/{proto → packlets/proto}/gen/dxos/credentials.ts

@@ -11,25 +11,64 @@ import * as dxos_echo_timeframe from "./echo/timeframe";
 import * as dxos_halo_keys from "./halo/keys";
 import * as dxos_rpc from "./rpc";
 import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+ */
 export interface Message {
     payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
 }
 /**
  * A generic container message used whenever messages are signed (e.g. PartyCredential)
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
  */
 export interface SignedMessage {
+    /**
+     * The signed message contents.
+     */
     signed: SignedMessage.Signed;
+    /**
+     * An array of Signatures, one for each key that signed the message.
+     */
     signatures?: SignedMessage.Signature[];
 }
 export namespace SignedMessage {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+     */
     export interface Signed {
+        /**
+         * RFC-3339 datetime string.
+         */
         created: string;
         nonce: Uint8Array;
+        /**
+         * The payload to be signed.
+         */
         payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
     }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+     */
     export interface Signature {
+        /**
+         * The publicKey of the keypair that made this signature.
+         */
         key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * The bytes of the signature.
+         */
         signature: Uint8Array;
+        /**
+         * The certification chain of SignedMessages for this key.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
         keyChain?: dxos_halo_keys.KeyChain;
     }
 }

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

@@ -0,0 +1,442 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+import * as dxos_client from "./client";
+import * as dxos_config from "./config";
+import * as dxos_credentials from "./credentials";
+import * as dxos_echo_feed from "./echo/feed";
+import * as dxos_echo_invitation from "./echo/invitation";
+import * as dxos_echo_service from "./echo/service";
+import * as dxos_echo_snapshot from "./echo/snapshot";
+import * as dxos_echo_timeframe from "./echo/timeframe";
+import * as dxos_halo_keys from "./halo/keys";
+import * as dxos_rpc from "./rpc";
+import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface DevtoolsHost {
+    events: (request: void) => Stream<Event>;
+    getConfig: (request: void) => Promise<GetConfigResponse>;
+    resetStorage: (request: ResetStorageRequest) => Promise<void>;
+    enableDebugLogging: (request: EnableDebugLoggingRequest) => Promise<EnableDebugLoggingResponse>;
+    disableDebugLogging: (request: EnableDebugLoggingRequest) => Promise<EnableDebugLoggingResponse>;
+    subscribeToKeyringKeys: (request: SubscribeToKeyringKeysRequest) => Stream<SubscribeToKeyringKeysResponse>;
+    subscribeToCredentialMessages: (request: SubscribeToCredentialMessagesRequest) => Stream<SubscribeToCredentialMessagesResponse>;
+    subscribeToParties: (request: SubscribeToPartiesRequest) => Stream<SubscribeToPartiesResponse>;
+    subscribeToItems: (request: SubscribeToItemsRequest) => Stream<SubscribeToItemsResponse>;
+    subscribeToFeeds: (request: SubscribeToFeedsRequest) => Stream<SubscribeToFeedsResponse>;
+    subscribeToFeedBlocks: (request: SubscribeToFeedBlocksRequest) => Stream<SubscribeToFeedBlocksResponse>;
+    getPartySnapshot: (request: GetPartySnapshotRequest) => Promise<GetPartySnapshotResponse>;
+    savePartySnapshot: (request: SavePartySnapshotRequest) => Promise<SavePartySnapshotResponse>;
+    clearSnapshots: (request: ClearSnapshotsRequest) => Promise<void>;
+    getNetworkPeers: (request: GetNetworkPeersRequest) => Promise<GetNetworkPeersResponse>;
+    subscribeToNetworkTopics: (request: void) => Stream<SubscribeToNetworkTopicsResponse>;
+    subscribeToSignalStatus: (request: void) => Stream<SubscribeToSignalStatusResponse>;
+    subscribeToSignalTrace: (request: void) => Stream<SubscribeToSignalTraceResponse>;
+    subscribeToSwarmInfo: (request: SubscribeToSwarmInfoRequest) => Stream<SubscribeToSwarmInfoResponse>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface Event {
+    ready?: ReadyEvent;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface ReadyEvent {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface GetConfigResponse {
+    config: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface EnableDebugLoggingRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    namespaces?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface EnableDebugLoggingResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    enabledNamespaces?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface DisableDebugLoggingRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    namespaces?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface DisableDebugLoggingResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    enabledNamespaces?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToKeyringKeysRequest {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToKeyringKeysResponse {
+    keys?: dxos_halo_keys.KeyRecord[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToCredentialMessagesRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToCredentialMessagesResponse {
+    messages?: dxos_credentials.SignedMessage[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface ResetStorageRequest {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface GetNetworkPeersRequest {
+    topic: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface GetNetworkPeersResponse {
+    peers?: GetNetworkPeersResponse.PeerInfo[];
+}
+export namespace GetNetworkPeersResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface PeerInfo {
+        id: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        state: string;
+        connections?: Uint8Array[];
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToPartiesRequest {
+    partyKeys?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToPartiesResponse {
+    parties?: SubscribeToPartiesResponse.PartyInfo[];
+}
+export namespace SubscribeToPartiesResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface PartyInfo {
+        key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        isOpen: boolean;
+        isActive: boolean;
+        timeframe: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+        feeds?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
+        properties?: Partial<Record<string, string>>;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToItemsRequest {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToItemsResponse {
+    data: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToFeedsRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    feedKeys?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToFeedsResponse {
+    feeds?: SubscribeToFeedsResponse.Feed[];
+}
+export namespace SubscribeToFeedsResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface Feed {
+        feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        length: number;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToFeedBlocksRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    maxBlocks?: number;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToFeedBlocksResponse {
+    blocks?: SubscribeToFeedBlocksResponse.Block[];
+}
+export namespace SubscribeToFeedBlocksResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface Block {
+        key: Uint8Array;
+        seq: number;
+        sync: boolean;
+        path: string;
+        data: dxos_echo_feed.FeedMessage;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface GetPartySnapshotRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface GetPartySnapshotResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    snapshot?: dxos_echo_snapshot.PartySnapshot;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SavePartySnapshotRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SavePartySnapshotResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    snapshot?: dxos_echo_snapshot.PartySnapshot;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface ClearSnapshotsRequest {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToNetworkTopicsResponse {
+    topics?: SubscribeToNetworkTopicsResponse.Topic[];
+}
+export namespace SubscribeToNetworkTopicsResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface Topic {
+        topic: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        label?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToSignalStatusResponse {
+    servers?: SubscribeToSignalStatusResponse.SignalServer[];
+}
+export namespace SubscribeToSignalStatusResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface SignalServer {
+        host: string;
+        state: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        error?: string;
+        reconnectIn: number;
+        connectionStarted: number;
+        lastStateChange: number;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToSignalTraceResponse {
+    events?: string[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToSwarmInfoRequest {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SubscribeToSwarmInfoResponse {
+    data?: SubscribeToSwarmInfoResponse.SwarmInfo[];
+}
+export namespace SubscribeToSwarmInfoResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+     */
+    export interface SwarmInfo {
+        id: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        topic: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        label?: string;
+        isActive: boolean;
+        connections?: SubscribeToSwarmInfoResponse.SwarmInfo.ConnectionInfo[];
+    }
+    export namespace SwarmInfo {
+        /**
+         * Defined in:
+         *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+         */
+        export interface ConnectionInfo {
+            state: string;
+            sessionId: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+            remotePeerId: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            transport?: string;
+            protocolExtensions?: string[];
+            events?: ReturnType<(typeof substitutions)["dxos.devtools.SubscribeToSwarmInfoResponse.SwarmInfo.ConnectionInfo.Json"]["decode"]>[];
+        }
+        export namespace ConnectionInfo {
+            /**
+             * Defined in:
+             *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+             */
+            export interface Json {
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                data?: string;
+            }
+        }
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface TracingService {
+    setTracingOptions: (request: SetTracingOptionsRequest) => Promise<void>;
+    subscribeToRpcTrace: (request: void) => Stream<dxos_rpc.RpcMessage>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/devtools.proto}
+ */
+export interface SetTracingOptionsRequest {
+    enable: boolean;
+}

package/src/{proto → packlets/proto}/gen/dxos/echo/feed.ts

@@ -14,49 +14,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://./../../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
  */
 export interface FeedMessage {
-    timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+    timeframe: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
     halo?: ReturnType<(typeof substitutions)["dxos.echo.feed.CredentialsMessage"]["decode"]>;
     echo?: EchoEnvelope;
 }
 /**
  * A container for dxos.credentials.Message
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
  */
 export interface CredentialsMessage {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
 /**
  * Wrapper for all ECHO messages.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../../common/protocols/src/proto/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://./../../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
+ */
 export interface LinkData {
-    source?: string;
-    target?: string;
+    source: string;
+    target: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../../common/protocols/src/proto/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://./../../../../../../../../common/protocols/src/proto/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://./../../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
+     */
     export enum Action {
         NOOP = 0,
         DELETE = 1,

package/src/{proto → packlets/proto}/gen/dxos/echo/invitation.ts

@@ -11,20 +11,36 @@ import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
 import * as dxos_rpc from "../rpc";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../../common/protocols/src/proto/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://./../../../../../../../../common/protocols/src/proto/dxos/echo/invitation.proto}
+     */
     export enum Type {
         INTERACTIVE = 1,
         OFFLINE = 2