@dxos/protocols 0.6.3-main.9e4e207 → 0.6.3-main.a95c491

package/src/proto/dxos/halo/invitations.proto

@@ -7,14 +7,14 @@ syntax = "proto3";
 import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
 
-import "dxos/client/services.proto";
+import "dxos/client/invitation.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/keys.proto";
 
 package dxos.halo.invitations;
 
-message Options {
+message InvitationOptions {
   enum Role {
     GUEST = 0;
     HOST = 1;
@@ -127,7 +127,7 @@ message AdmissionResponse {
 // TODO(dmaretskyi): Rename to InvitationExtensionService.
 service InvitationHostService {
   /// Both peers must call this method before any other.
-  rpc Options(Options) returns (google.protobuf.Empty);
+  rpc Options(InvitationOptions) returns (google.protobuf.Empty);
 
   /// Introduce guest to the host. Only on the host.
   rpc Introduce(IntroductionRequest) returns (IntroductionResponse);

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

@@ -5,7 +5,6 @@
 syntax = "proto3";
 
 import "dxos/keys.proto";
-import "dxos/halo/signed.proto";
 
 package dxos.halo.keys;
 
@@ -70,14 +69,3 @@ message KeyRecord {
 message KeyRecordList {
   repeated KeyRecord keys = 1;
 }
-
-//
-// A key which includes its parent keys and SignedMessages leading back to the root of its authority.
-// For example, if IdentityA signed for DeviceA, which signed for DeviceB, which signed for DeviceC the chain
-// would comprised: DeviceC->DeviceB->DeviceA->IdentityA moving from tip to root.
-//
-message KeyChain {
-  dxos.keys.PublicKey public_key = 1;
-  dxos.halo.signed.SignedMessage message = 2; // TODO(burdon): Circular dep.
-  repeated KeyChain parents = 3;
-}

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

@@ -6,15 +6,19 @@ syntax = "proto3";
 
 import "google/protobuf/any.proto";
 
-import "dxos/halo/keys.proto";
 import "dxos/keys.proto";
 
 package dxos.halo.signed;
 
-// TODO(burdon): Rename (too generic).
-// TODO(burdon): Use default from codec-protobuf.
-message Message {
-  google.protobuf.Any payload = 1;
+//
+// A key which includes its parent keys and SignedMessages leading back to the root of its authority.
+// For example, if IdentityA signed for DeviceA, which signed for DeviceB, which signed for DeviceC the chain
+// would comprised: DeviceC->DeviceB->DeviceA->IdentityA moving from tip to root.
+//
+message KeyChain {
+  dxos.keys.PublicKey public_key = 1;
+  SignedMessage message = 2;
+  repeated KeyChain parents = 3;
 }
 
 /**
@@ -41,7 +45,7 @@ message SignedMessage {
     /// The bytes of the signature.
     bytes signature = 2;
     /// The certification chain of SignedMessages for this key.
-    optional keys.KeyChain key_chain = 3;
+    optional KeyChain key_chain = 3;
   }
 
   /// The signed message contents.

package/src/proto/dxos/mesh/presence.proto

@@ -4,6 +4,8 @@
 
 syntax = "proto3";
 
+import "dxos/keys.proto";
+
 package dxos.mesh.presence;
 
 // Even though those definitions don't use Any the schema can be added dynamically later.
@@ -12,7 +14,7 @@ import "google/protobuf/any.proto";
 
 message PeerState {
   /// Will be used to build network graph
-  repeated dxos.keys.PublicKey connections = 1; 
+  repeated dxos.keys.PublicKey connections = 1;
 
   // TODO(mykola): Remove once IdentityKey can be obtained from DeviceKey.
   dxos.keys.PublicKey identity_key = 2;

package/src/proto/dxos/mesh/teleport/gossip.proto

@@ -6,13 +6,15 @@ syntax = "proto3";
 
 import "google/protobuf/empty.proto";
 import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
+
 import "dxos/keys.proto";
 
 package dxos.mesh.teleport.gossip;
 
 message GossipMessage {
   dxos.keys.PublicKey peer_id = 1;
-  /// Used to route differnt payload types to correct listeners.
+  /// Used to route different payload types to correct listeners.
   string channel_id = 2;
   /// Peer tracks what had been sent by message id.
   dxos.keys.PublicKey message_id = 3;

package/src/proto/gen/dxos/client/services.ts

@@ -144,6 +144,7 @@ export interface QueryMetricsResponse {
  *   {@link file://./../../../dxos/client/logging.proto}
  */
 export enum LogLevel {
+    NONE = 0,
     TRACE = 5,
     DEBUG = 10,
     INFO = 11,
@@ -168,6 +169,7 @@ export namespace QueryLogsRequest {
      *   {@link file://./../../../dxos/client/logging.proto}
      */
     export enum MatchingOptions {
+        NONE = 0,
         INCLUSIVE = 1,
         EXPLICIT = 2
     }
@@ -237,6 +239,191 @@ export interface LoggingService {
     queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
     queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/invitation.proto}
+ */
+export interface AdmissionKeypair {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
+}
+/**
+ * Runtime state of the space object.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/client/invitation.proto}
+ */
+export enum SpaceState {
+    INVALID = 0,
+    SPACE_INACTIVE = 2,
+    SPACE_ACTIVE = 6,
+    SPACE_CLOSED = 1,
+    SPACE_CONTROL_ONLY = 7,
+    SPACE_INITIALIZING = 4,
+    SPACE_READY = 3,
+    SPACE_ERROR = 5,
+    SPACE_REQUIRES_MIGRATION = 8
+}
+/**
+ * Represents the invitation state passed between client and service.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/client/invitation.proto}
+ */
+export interface Invitation {
+    /**
+     * Local identifier (random).
+     */
+    invitationId: string;
+    /**
+     * Determines the behavior of the invitation.
+     */
+    type: Invitation.Type;
+    /**
+     * Kind of access the invitation will grant.
+     */
+    kind: Invitation.Kind;
+    /**
+     * How the invitation is authenticated.
+     */
+    authMethod: Invitation.AuthMethod;
+    /**
+     * Swarm rendezvous (random).
+     */
+    swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Local state.
+     */
+    state: Invitation.State;
+    /**
+     * Timeout for guest to complete invitation once connected (ms).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    timeout?: number;
+    /**
+     * Guest's identity.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Space to join (only present if kind is SPACE).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Authentication code created by host (only present if auth_method is SHARED_SECRET).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    authCode?: string;
+    /**
+     * Path or identifier to navigate to after successful authentication.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    target?: string;
+    /**
+     * Host should resume invitation on startup until timeout.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    persistent?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    lifetime?: number;
+    /**
+     * Whether an invitation can be used multiple times.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    multiUse?: boolean;
+    /**
+     * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    guestKeypair?: AdmissionKeypair;
+    /**
+     * Present on Type.DELEGATED invitations.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Role of the admitted member, defaults to ADMIN.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    role?: dxos_halo_credentials.SpaceMember.Role;
+}
+export namespace Invitation {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum Type {
+        INTERACTIVE = 0,
+        DELEGATED = 1,
+        MULTIUSE = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum Kind {
+        DEVICE = 0,
+        SPACE = 1
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum AuthMethod {
+        NONE = 0,
+        SHARED_SECRET = 1,
+        KNOWN_PUBLIC_KEY = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum State {
+        INIT = 0,
+        CONNECTING = 1,
+        CONNECTED = 2,
+        READY_FOR_AUTHENTICATION = 3,
+        AUTHENTICATING = 4,
+        SUCCESS = 5,
+        CANCELLED = 6,
+        TIMEOUT = 7,
+        ERROR = 8,
+        EXPIRED = 9
+    }
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -560,22 +747,6 @@ export namespace SpaceMember {
         ONLINE = 1
     }
 }
-/**
- * Runtime state of the space object.
- *
- * Defined in:
- *   {@link file://./../../../dxos/client/services.proto}
- */
-export enum SpaceState {
-    INACTIVE = 2,
-    ACTIVE = 6,
-    CLOSED = 1,
-    CONTROL_ONLY = 7,
-    INITIALIZING = 4,
-    READY = 3,
-    ERROR = 5,
-    REQUIRES_MIGRATION = 8
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -929,174 +1100,6 @@ export interface SpacesService {
     queryCredentials: (request: QueryCredentialsRequest, options?: RequestOptions) => Stream<dxos_halo_credentials.Credential>;
     createEpoch: (request: CreateEpochRequest, options?: RequestOptions) => Promise<CreateEpochResponse>;
 }
-/**
- * Represents the invitation state passed between client and service.
- *
- * Defined in:
- *   {@link file://./../../../dxos/client/services.proto}
- */
-export interface Invitation {
-    /**
-     * Local identifier (random).
-     */
-    invitationId: string;
-    /**
-     * Determines the behavior of the invitation.
-     */
-    type: Invitation.Type;
-    /**
-     * Kind of access the invitation will grant.
-     */
-    kind: Invitation.Kind;
-    /**
-     * How the invitation is authenticated.
-     */
-    authMethod: Invitation.AuthMethod;
-    /**
-     * Swarm rendezvous (random).
-     */
-    swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Local state.
-     */
-    state: Invitation.State;
-    /**
-     * Timeout for guest to complete invitation once connected (ms).
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    timeout?: number;
-    /**
-     * Guest's identity.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Space to join (only present if kind is SPACE).
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Authentication code created by host (only present if auth_method is SHARED_SECRET).
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    authCode?: string;
-    /**
-     * Path or identifier to navigate to after successful authentication.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    target?: string;
-    /**
-     * Host should resume invitation on startup until timeout.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    persistent?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    lifetime?: number;
-    /**
-     * Whether an invitation can be used multiple times.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    multiUse?: boolean;
-    /**
-     * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    guestKeypair?: AdmissionKeypair;
-    /**
-     * Present on Type.DELEGATED invitations.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Role of the admitted member, defaults to ADMIN.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    role?: dxos_halo_credentials.SpaceMember.Role;
-}
-export namespace Invitation {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/services.proto}
-     */
-    export enum Type {
-        INTERACTIVE = 0,
-        DELEGATED = 1,
-        MULTIUSE = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/services.proto}
-     */
-    export enum Kind {
-        DEVICE = 0,
-        SPACE = 1
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/services.proto}
-     */
-    export enum AuthMethod {
-        NONE = 0,
-        SHARED_SECRET = 1,
-        KNOWN_PUBLIC_KEY = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/services.proto}
-     */
-    export enum State {
-        INIT = 0,
-        CONNECTING = 1,
-        CONNECTED = 2,
-        READY_FOR_AUTHENTICATION = 3,
-        AUTHENTICATING = 4,
-        SUCCESS = 5,
-        CANCELLED = 6,
-        TIMEOUT = 7,
-        ERROR = 8,
-        EXPIRED = 9
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/services.proto}
- */
-export interface AdmissionKeypair {
-    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}

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

@@ -70,7 +70,7 @@ import * as google_protobuf from "../../google/protobuf";
  */
 export interface EchoMetadata {
     /**
-     * Version number that is inceremnted every time there's a breaking change to the storage schema.
+     * Version number that is incremented every time there's a breaking change to the storage schema.
      * 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.
      */
@@ -144,7 +144,7 @@ export interface SpaceMetadata {
      */
     genesisFeedKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
-     * Key of the wriatable control feed.
+     * Key of the writable control feed.
      *
      * Options:
      *   - proto3_optional = true
@@ -155,7 +155,7 @@ export interface SpaceMetadata {
      */
     feedKeys?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
     /**
-     * Key of the wriatable data feed.
+     * Key of the writable data feed.
      *
      * Options:
      *   - proto3_optional = true

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

@@ -126,7 +126,7 @@ export namespace EchoObject {
          * Set the model to the provided snapshot.
          *
          * Options:
-         *   - preserve_any = true
+         *   - (preserve_any) = true
          *   - proto3_optional = true
          */
         model?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
@@ -155,7 +155,7 @@ export namespace EchoObject {
         action?: EchoObject.Mutation.Action;
         /**
          * Options:
-         *   - preserve_any = true
+         *   - (preserve_any) = true
          *   - proto3_optional = true
          */
         model?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;

package/src/proto/gen/dxos/halo/invitations.ts

@@ -66,13 +66,13 @@ import * as google_protobuf from "../../google/protobuf";
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}
  */
-export interface Options {
+export interface InvitationOptions {
     /**
      * Role of the peer.
      */
-    role: Options.Role;
+    role: InvitationOptions.Role;
 }
-export namespace Options {
+export namespace InvitationOptions {
     /**
      * Defined in:
      *   {@link file://./../../../dxos/halo/invitations.proto}
@@ -281,7 +281,7 @@ export interface InvitationHostService {
     /**
      * Both peers must call this method before any other.
      */
-    options: (request: Options, options?: RequestOptions) => Promise<void>;
+    options: (request: InvitationOptions, options?: RequestOptions) => Promise<void>;
     /**
      * Introduce guest to the host. Only on the host.
      */

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

@@ -138,12 +138,3 @@ export interface KeyRecord {
 export interface KeyRecordList {
     keys?: KeyRecord[];
 }
-/**
- * Defined in:
- *   {@link file://./../../../dxos/halo/keys.proto}
- */
-export interface KeyChain {
-    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    message: dxos_halo_signed.SignedMessage;
-    parents?: KeyChain[];
-}

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

@@ -66,8 +66,10 @@ import * as google_protobuf from "../../google/protobuf";
  * Defined in:
  *   {@link file://./../../../dxos/halo/signed.proto}
  */
-export interface Message {
-    payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+export interface KeyChain {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    message: SignedMessage;
+    parents?: KeyChain[];
 }
 /**
  * A generic container message used whenever messages are signed (e.g. SpaceCredential)
@@ -120,6 +122,6 @@ export namespace SignedMessage {
          * Options:
          *   - proto3_optional = true
          */
-        keyChain?: dxos_halo_keys.KeyChain;
+        keyChain?: KeyChain;
     }
 }

package/src/proto/gen/dxos/mesh/teleport/gossip.ts

@@ -69,7 +69,7 @@ import * as google_protobuf from "../../../google/protobuf";
 export interface GossipMessage {
     peerId: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
-     * Used to route differnt payload types to correct listeners.
+     * Used to route different payload types to correct listeners.
      */
     channelId: string;
     /**

package/src/proto/gen/google/protobuf.ts

@@ -262,6 +262,11 @@ export interface FieldOptions {
      *   - proto3_optional = true
      */
     ".dxos.config.envVar"?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    ".preserveAny"?: boolean;
 }
 export namespace FieldOptions {
     export enum CType {