@dxos/protocols 0.1.5 → 0.1.7

package/proto/dxos/type.d.ts

@@ -1,2 +1,5 @@
-// Generated file: do not edit.
+/**
+ * @generated
+ */
+
 export * from '../../dist/src/proto/gen/dxos/type';

package/proto/dxos/type.js

@@ -1,2 +1,5 @@
-// Generated file: do not edit.
+/**
+ * @generated
+ */
+
 module.exports = require('../../dist/src/proto/gen/dxos/type');

package/proto/example/testing/data.d.ts

@@ -1,2 +1,5 @@
-// Generated file: do not edit.
+/**
+ * @generated
+ */
+
 export * from '../../../dist/src/proto/gen/example/testing/data';

package/proto/example/testing/data.js

@@ -1,2 +1,5 @@
-// Generated file: do not edit.
+/**
+ * @generated
+ */
+
 module.exports = require('../../../dist/src/proto/gen/example/testing/data');

package/proto/example/testing/rpc.d.ts

@@ -1,2 +1,5 @@
-// Generated file: do not edit.
+/**
+ * @generated
+ */
+
 export * from '../../../dist/src/proto/gen/example/testing/rpc';

package/proto/example/testing/rpc.js

@@ -1,2 +1,5 @@
-// Generated file: do not edit.
+/**
+ * @generated
+ */
+
 module.exports = require('../../../dist/src/proto/gen/example/testing/rpc');

package/proto/google/protobuf.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @generated
+ */
+
+export * from '../../dist/src/proto/gen/google/protobuf';

package/proto/google/protobuf.js

@@ -0,0 +1,5 @@
+/**
+ * @generated
+ */
+
+module.exports = require('../../dist/src/proto/gen/google/protobuf');

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

@@ -175,8 +175,11 @@ message Invitation {
   /// Authentication code created by host.
   optional string authentication_code = 7;
 
+  /// Timeout (ms).
+  optional int32 timeout = 8;
+
   /// Space key (if data invitation).
-  optional dxos.keys.PublicKey space_key = 8;
+  optional dxos.keys.PublicKey space_key = 9;
 }
 
 message AuthenticationRequest {
@@ -188,8 +191,16 @@ message CancelInvitationRequest {
   string invitation_id = 1;
 }
 
-// TODO(burdon): Separate implementations for HALO/Data Spaces.
-service InvitationsService {
+// Common TS interface.
+
+service HaloInvitationsService {
+  rpc CreateInvitation(Invitation) returns (stream Invitation);
+  rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
+  rpc AcceptInvitation(Invitation) returns (stream Invitation);
+  rpc CancelInvitation(CancelInvitationRequest) returns (google.protobuf.Empty);
+}
+
+service SpaceInvitationsService {
   rpc CreateInvitation(Invitation) returns (stream Invitation);
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
   rpc AcceptInvitation(Invitation) returns (stream Invitation);

package/src/proto/dxos/client.proto

@@ -20,6 +20,8 @@ package dxos.client;
 //
 
 service SystemService {
+  /// Called at the start of the session. Service should block until it is fully initialized.
+  rpc InitSession (google.protobuf.Empty) returns (google.protobuf.Empty);
   rpc GetConfig(google.protobuf.Empty) returns (dxos.config.Config);
   rpc Reset (google.protobuf.Empty) returns (google.protobuf.Empty);
 }
@@ -102,10 +104,6 @@ service ProfileService {
   rpc CreateProfile(CreateProfileRequest) returns (Profile);
   rpc RecoverProfile(RecoverProfileRequest) returns (Profile);
   rpc SubscribeProfile (google.protobuf.Empty) returns (stream SubscribeProfileResponse);
-
-  rpc CreateInvitation(google.protobuf.Empty) returns (stream InvitationRequest);
-  rpc AcceptInvitation(dxos.client.services.Invitation) returns (stream RedeemedInvitation);
-  rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
 }
 
 message AddKeyRecordRequest {
@@ -113,9 +111,7 @@ message AddKeyRecordRequest {
 }
 
 message SignRequest {
-  /**
-   * - The public key of the key that is supposed to be used for signing.
-   */
+  /// The public key of the key that is supposed to be used for signing.
   dxos.keys.PublicKey public_key = 1;
 
   bytes payload = 2;

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

@@ -18,9 +18,11 @@ message AuthenticationRequest {
 // HALO device invitations.
 //
 
-// TODO(burdon): ALL invitation messages should be handled over encrypted sessions.
-// TODO(burdon): Or contain some form of signed credential.
-// TODO(burdon): Calls should include some request context (e.g., halo/space key).
+message HaloAdmissionOffer {
+  dxos.keys.PublicKey identity_key = 1;
+  dxos.keys.PublicKey halo_space_key = 2;
+  dxos.keys.PublicKey genesis_feed_key = 3;
+}
 
 message HaloAdmissionCredentials {
   dxos.keys.PublicKey device_key = 1;
@@ -28,26 +30,26 @@ message HaloAdmissionCredentials {
   dxos.keys.PublicKey data_feed_key = 3;
 }
 
-message HaloAdmissionOffer {
-  dxos.keys.PublicKey identity_key = 1;
-  dxos.keys.PublicKey halo_space_key = 2;
-  dxos.keys.PublicKey genesis_feed_key = 3;
-}
-
 service HaloHostService {
+  /// Process admission offer from host.
+  rpc RequestAdmission(google.protobuf.Empty) returns (HaloAdmissionOffer);
+
+  /// Authenticate request.
+  rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
+
   /// Process admission request from guest.
   rpc PresentAdmissionCredentials(HaloAdmissionCredentials) returns (google.protobuf.Empty);
 }
 
-service HaloGuestService {
-  /// Process admission offer from host.
-  rpc PresentAdmissionOffer(HaloAdmissionOffer) returns (google.protobuf.Empty);
-}
-
 //
 // Space agent invitations.
 //
 
+message SpaceAdmissionOffer {
+  dxos.keys.PublicKey space_key = 1;
+  dxos.keys.PublicKey genesis_feed_key = 3;
+}
+
 message SpaceAdmissionCredentials {
   dxos.keys.PublicKey identity_key = 1;
   dxos.keys.PublicKey device_key = 2;
@@ -55,11 +57,6 @@ message SpaceAdmissionCredentials {
   dxos.keys.PublicKey data_feed_key = 4;
 }
 
-message SpaceAdmissionOffer {
-  dxos.keys.PublicKey space_key = 1;
-  dxos.keys.PublicKey genesis_feed_key = 3;
-}
-
 service SpaceHostService {
   /// Process admission request.
   rpc RequestAdmission(google.protobuf.Empty) returns (SpaceAdmissionOffer);

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

@@ -223,6 +223,13 @@ export interface Invitation {
      *   - proto3_optional = true
      */
     authenticationCode?: string;
+    /**
+     * Timeout (ms).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    timeout?: number;
     /**
      * Space key (if data invitation).
      *
@@ -275,7 +282,17 @@ export interface CancelInvitationRequest {
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface InvitationsService {
+export interface HaloInvitationsService {
+    createInvitation: (request: Invitation) => Stream<Invitation>;
+    authenticate: (request: AuthenticationRequest) => Promise<void>;
+    acceptInvitation: (request: Invitation) => Stream<Invitation>;
+    cancelInvitation: (request: CancelInvitationRequest) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SpaceInvitationsService {
     createInvitation: (request: Invitation) => Stream<Invitation>;
     authenticate: (request: AuthenticationRequest) => Promise<void>;
     acceptInvitation: (request: Invitation) => Stream<Invitation>;

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

@@ -44,6 +44,10 @@ import * as google_protobuf from "../google/protobuf";
  *   {@link file://./../../dxos/client.proto}
  */
 export interface SystemService {
+    /**
+     * Called at the start of the session. Service should block until it is fully initialized.
+     */
+    initSession: (request: void) => Promise<void>;
     getConfig: (request: void) => Promise<dxos_config.Config>;
     reset: (request: void) => Promise<void>;
 }
@@ -191,9 +195,6 @@ export interface ProfileService {
     createProfile: (request: CreateProfileRequest) => Promise<Profile>;
     recoverProfile: (request: RecoverProfileRequest) => Promise<Profile>;
     subscribeProfile: (request: void) => Stream<SubscribeProfileResponse>;
-    createInvitation: (request: void) => Stream<InvitationRequest>;
-    acceptInvitation: (request: dxos_client_services.Invitation) => Stream<RedeemedInvitation>;
-    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
 }
 /**
  * Defined in:
@@ -208,7 +209,7 @@ export interface AddKeyRecordRequest {
  */
 export interface SignRequest {
     /**
-     * - The public key of the key that is supposed to be used for signing.
+     * The public key of the key that is supposed to be used for signing.
      */
     publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     payload: Uint8Array;

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

@@ -50,25 +50,33 @@ export interface AuthenticationRequest {
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}
  */
-export interface HaloAdmissionCredentials {
-    deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    dataFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface HaloAdmissionOffer {
+    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    haloSpaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    genesisFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}
  */
-export interface HaloAdmissionOffer {
-    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    haloSpaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    genesisFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface HaloAdmissionCredentials {
+    deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    dataFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}
  */
 export interface HaloHostService {
+    /**
+     * Process admission offer from host.
+     */
+    requestAdmission: (request: void) => Promise<HaloAdmissionOffer>;
+    /**
+     * Authenticate request.
+     */
+    authenticate: (request: AuthenticationRequest) => Promise<void>;
     /**
      * Process admission request from guest.
      */
@@ -78,11 +86,9 @@ export interface HaloHostService {
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}
  */
-export interface HaloGuestService {
-    /**
-     * Process admission offer from host.
-     */
-    presentAdmissionOffer: (request: HaloAdmissionOffer) => Promise<void>;
+export interface SpaceAdmissionOffer {
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    genesisFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
@@ -94,14 +100,6 @@ export interface SpaceAdmissionCredentials {
     controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     dataFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
-/**
- * Defined in:
- *   {@link file://./../../../dxos/halo/invitations.proto}
- */
-export interface SpaceAdmissionOffer {
-    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    genesisFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}