@dxos/protocols 2.33.9-dev.43c233c0 → 2.33.9-dev.46220a19

package/src/proto/dxos/halo/keys.proto

@@ -6,9 +6,10 @@ syntax = "proto3";
 
 package dxos.halo.keys;
 
-import "signed.proto";
 import "google/protobuf/any.proto";
 
+import "./signed.proto";
+
 //
 // The type/use of a public key.
 //
@@ -43,33 +44,33 @@ message KeyRecord {
   /**
    * The secret key as a Buffer (this will never be visible outside the Keyring).
    */
-  PrivKey secretKey = 3;
+  optional PrivKey secretKey = 3;
 
   /**
    * Is this key from a Greeting "hint"?
    */
-  bool hint = 4;
+  optional bool hint = 4;
 
   /**
    * Determines if this is our key?
    * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
    */
-  bool own = 5; // TODO(burdon): Rename "local" or "private".
+  optional bool own = 5; // TODO(burdon): Rename "local" or "private".
 
   /**
    * Is this key to be trusted?
    */
-  bool trusted = 6; // TODO(burdon): Rename "trust". How is this determined?
+  optional bool trusted = 6; // TODO(burdon): Rename "trust". How is this determined?
 
   /**
    * An RFC-3339 date/time string for when the key was added to the Keyring.
    */
-  string added = 7;
+  optional string added = 7;
 
   /**
    * An RFC-3339 date/time string for when the key was created.
    */
-  string created = 8;
+  optional string created = 8;
 }
 
 message KeyRecordList {

package/src/proto/dxos/halo/party.proto

@@ -6,10 +6,11 @@ syntax = "proto3";
 
 package dxos.credentials.party;
 
-import "keys.proto";
-import "signed.proto";
 import "google/protobuf/any.proto";
 
+import "./keys.proto";
+import "./signed.proto";
+
 //
 // Party Credentials are messages that, by virtue of their being signed by a key that is a
 // recognized authority, convey to the recipient that something should be allowed or done.

package/src/proto/dxos/halo/signed.proto

@@ -7,9 +7,10 @@ syntax = "proto3";
 // TODO(burdon): Rename dxos.halo?
 package dxos.credentials;
 
-import "keys.proto";
 import "google/protobuf/any.proto";
 
+import "./keys.proto";
+
 // TODO(burdon): Use default from codec-protobuf.
 message Message {
   required google.protobuf.Any payload = 1;
@@ -23,20 +24,27 @@ message SignedMessage {
   // Provides the common metadata needed for all signed objects.
   //
   message Signed {
-    required string created = 1;                    // RFC-3339 datetime string.
+    /// RFC-3339 datetime string.
+    required string created = 1;
     required bytes nonce = 2;
-    required google.protobuf.Any payload = 10;      // The payload to be signed.
+    /// The payload to be signed.
+    required google.protobuf.Any payload = 10;
   }
 
   //
   // The signature data itself.
   //
   message Signature {
-    required PubKey key = 1;                        // The publicKey of the keypair that made this signature.
-    required bytes signature = 2;                   // The bytes of the signature.
-    KeyChain keyChain = 3;                          // Optional. The certification chain of SignedMessages for this key.
+    /// The publicKey of the keypair that made this signature.
+    required PubKey key = 1;
+    /// The bytes of the signature.
+    required bytes signature = 2;
+    /// The certification chain of SignedMessages for this key.
+    optional KeyChain keyChain = 3;
   }
 
-  required Signed signed = 1;                       // The signed message contents.
-  repeated Signature signatures = 2;                // An array of Signatures, one for each key that signed the message.
+  /// The signed message contents.
+  required Signed signed = 1;
+  /// An array of Signatures, one for each key that signed the message.
+  repeated Signature signatures = 2;
 }

package/src/proto/dxos/rpc.proto

@@ -4,9 +4,11 @@
 
 syntax = "proto3";
 
+package dxos.rpc;
+
 import "google/protobuf/any.proto";
 
-package dxos.rpc;
+option go_package = "github.com/dxos/kube/go/dxrpc/pb";
 
 message RpcMessage {
   oneof content {
@@ -34,8 +36,16 @@ message Response {
   oneof content {
     google.protobuf.Any payload = 2;
     Error error = 3;
-    // Sent when stream is closed without an error.
+    /// Sent when stream is closed without an error.
     bool close = 4;
+
+    /**
+     * Sent when the server has processed a request with a streaming response.
+     *
+     * Can be skipped by the server.
+     * In this case the first payload should be treated as the server being ready.
+     */
+    bool stream_ready = 5;
   }
 }
 
@@ -45,9 +55,9 @@ message StreamClose {
 }
 
 message Error {
-  string name = 1;
-  string message = 2;
-  string stack = 3;
+  optional string name = 1;
+  optional string message = 2;
+  optional string stack = 3;
 }
 
 message MessageTrace {

package/src/proto/gen/dxos/bot.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/bot.proto}
+ */
 export interface BotPackageSpecifier {
     /**
      * DXN of the bot in the DXNS registry.
@@ -25,21 +29,60 @@ export interface BotPackageSpecifier {
     ipfsCid?: string;
     localPath?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface Bot {
-    id?: string;
+    id: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     status?: Bot.Status;
     /**
      * The state that the bot aims to be in. Can be only either RUNNING or STOPPED.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     desiredState?: Bot.Status;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     attemptsToAchieveDesiredState?: number;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     packageSpecifier?: BotPackageSpecifier;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     lastStart?: google_protobuf.Timestamp;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     partyKey?: dxos_halo_keys.PubKey;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     runtime?: Bot.Runtime;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     report?: BotReport;
 }
 export namespace Bot {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
     export enum Status {
         STOPPED = 0,
         STARTING = 1,
@@ -47,47 +90,119 @@ export namespace Bot {
         STOPPING = 3,
         SPAWNING = 4
     }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
     export interface Runtime {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
         exitCode?: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
         exitSignal?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
         error?: string;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface GetBotsResponse {
     bots?: Bot[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface SpawnBotRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     package?: BotPackageSpecifier;
     /**
      * Invitation for the bot to join the target party.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     invitation?: dxos_echo_invitation.InvitationDescriptor;
     /**
      * Key of the party bot is invited to.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     partyKey?: dxos_halo_keys.PubKey;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface SendCommandRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     botId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     command?: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface SendCommandResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     response?: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface GetLogsResponse {
-    chunk?: Uint8Array;
+    chunk: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface GetLogsRequest {
-    botId?: string;
+    botId: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface BotReport {
     /**
      * Details of the party the bot was spawned for.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     partyDetails?: dxos_client.PartyDetails;
 }
 /**
  * Service that is used by clients to communicate with bot factory.
+ *
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
  */
 export interface BotFactoryService {
     getBots: (request: void) => Promise<GetBotsResponse>;
@@ -99,28 +214,48 @@ export interface BotFactoryService {
     sendCommand: (request: SendCommandRequest) => Promise<SendCommandResponse>;
     removeAll: (request: void) => Promise<void>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface InitializeRequest {
     /**
      * Bot runtime configuration.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     config?: dxos_config.Config;
     /**
      * Invitation for the bot to join the target party.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     invitation?: dxos_echo_invitation.InvitationDescriptor;
     /**
      * ID of the bot.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     id?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
 export interface StartRequest {
     /**
      * Bot runtime configuration.
      */
-    config?: dxos_config.Config;
+    config: dxos_config.Config;
 }
 /**
  * Service that is used by bots communicating with bot factory.
+ *
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
  */
 export interface BotService {
     /**