@dxos/protocols 0.1.1 → 0.1.3

package/dist/src/proto/gen/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/proto/gen/index.ts"],"names":[],"mappings":";;;;;;AAAA,yDAA8C;AAyC9C,qEAA6C;AAsVhC,QAAA,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,i67GAAi67G,CAAC,CAAC;AAC377G,QAAA,MAAM,GAAG,uBAAM,CAAC,QAAQ,CAAkB,kBAAU,EAAE,uBAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/proto/gen/index.ts"],"names":[],"mappings":";;;;;;AAAA,yDAA8C;AAyC9C,qEAA6C;AAqWhC,QAAA,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,gjhHAAgjhH,CAAC,CAAC;AAC1khH,QAAA,MAAM,GAAG,uBAAM,CAAC,QAAQ,CAAkB,kBAAU,EAAE,uBAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -18,10 +18,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.1.1",
-    "@dxos/hypercore": "0.1.1",
-    "@dxos/keys": "0.1.1",
-    "@dxos/timeframe": "0.1.1",
+    "@dxos/codec-protobuf": "0.1.3",
+    "@dxos/hypercore": "0.1.3",
+    "@dxos/keys": "0.1.3",
+    "@dxos/timeframe": "0.1.3",
     "assert": "^2.0.0",
     "util": "^0.12.4"
   },

package/proto/dxos/client/services.d.ts

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

package/proto/dxos/{devtools/swarmLog.d.ts.map → client/services.d.ts.map}

@@ -1,9 +1,9 @@
 {
   "version": 3,
-  "file": "swarmLog.d.ts",
+  "file": "services.d.ts",
   "sourceRoot": "",
   "sources": [
-    "../../../src/proto/dxos/devtools/swarmLog.proto"
+    "../../../src/proto/dxos/client/services.proto"
   ],
   "names": [],
   "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"

package/proto/dxos/client/services.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/client/services');

package/proto/dxos/devtools/diagnostics.d.ts

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

package/proto/dxos/devtools/diagnostics.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "diagnostics.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/devtools/diagnostics.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/devtools/diagnostics.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/devtools/diagnostics');

package/proto/dxos/devtools/swarm.d.ts

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

package/proto/dxos/{halo/credentials/party.d.ts.map → devtools/swarm.d.ts.map}

@@ -1,9 +1,9 @@
 {
   "version": 3,
-  "file": "party.d.ts",
+  "file": "swarm.d.ts",
   "sourceRoot": "",
   "sources": [
-    "../../../../src/proto/dxos/halo/credentials/party.proto"
+    "../../../src/proto/dxos/devtools/swarm.proto"
   ],
   "names": [],
   "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"

package/proto/dxos/devtools/{swarmLog.js → swarm.js}

@@ -1,2 +1,2 @@
 // Generated file: do not edit.
-module.exports = require('../../../dist/src/proto/gen/dxos/devtools/swarmLog');
+module.exports = require('../../../dist/src/proto/gen/dxos/devtools/swarm');

package/src/proto/dxos/bot.proto

@@ -8,8 +8,8 @@ import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
 
 import "dxos/client.proto";
+import "dxos/client/services.proto";
 import "dxos/config.proto";
-import "dxos/halo/invitations.proto";
 import "dxos/keys.proto";
 
 package dxos.bot;
@@ -47,7 +47,7 @@ message Bot {
 
   optional BotPackageSpecifier package_specifier = 3;
   optional google.protobuf.Timestamp last_start = 4;
-  optional dxos.keys.PublicKey party_key = 5;
+  optional dxos.keys.PublicKey space_key = 5;
 
   message Runtime {
     optional int32 exit_code = 1;
@@ -66,11 +66,11 @@ message GetBotsResponse {
 message SpawnBotRequest {
   optional BotPackageSpecifier package = 1;
 
-  /// Invitation for the bot to join the target party.
-  optional dxos.halo.invitations.InvitationDescriptor invitation = 2;
+  /// Invitation for the bot to join the target space.
+  optional dxos.client.services.Invitation invitation = 2;
 
-  /// Key of the party bot is invited to.
-  optional dxos.keys.PublicKey party_key = 3;
+  /// Key of the space bot is invited to.
+  optional dxos.keys.PublicKey space_key = 3;
 }
 
 message SendCommandRequest {
@@ -92,8 +92,8 @@ message GetLogsRequest {
 }
 
 message BotReport {
-  /// Details of the party the bot was spawned for.
-  optional dxos.client.PartyDetails party_details = 1;
+  /// Details of the space the bot was spawned for.
+  optional dxos.client.SpaceDetails space_details = 1;
 }
 
 /// Service that is used by clients to communicate with bot factory.
@@ -120,8 +120,8 @@ message InitializeRequest {
   /// Bot runtime configuration.
   optional dxos.config.Config config = 1;
 
-  /// Invitation for the bot to join the target party.
-  optional dxos.halo.invitations.InvitationDescriptor invitation = 2;
+  /// Invitation for the bot to join the target space.
+  optional dxos.client.services.Invitation invitation = 2;
 
   /// ID of the bot.
   optional string id = 3;
@@ -134,7 +134,7 @@ message StartRequest {
 
 /// Service that is used by bots communicating with bot factory.
 service BotService {
-  /// Initialize Client, create profile, and join a party.
+  /// Initialize Client, create profile, and join a space.
   rpc Initialize(InitializeRequest) returns (google.protobuf.Empty);
 
   /// Start an initialized bot.

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

@@ -0,0 +1,197 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+import "dxos/config.proto";
+import "dxos/halo/credentials.proto";
+import "dxos/keys.proto";
+
+// TODO(burdon): Restructure all services.
+// TODO(burdon): Reorganize packages (e.g., client.services, echo.database).
+
+package dxos.client.services;
+
+//
+// Design notes:
+// - Basic CRUD methods for records (streaming queries).
+// - Custom Request/Response objects for complex operations; otherwise generic structs for simplicity.
+// - Normalize records for performance (e.g., Space members separate from Space metadata).
+//
+
+//
+// System
+//
+
+service SystemService {
+  rpc GetConfig(google.protobuf.Empty) returns (dxos.config.Config); // TODO(burdon): Stream?
+  rpc Reset(google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+//
+// Signing
+// TODO(burdon): Rename Crypto/KeystoreService?
+//
+
+// TODO(burdon): Metadata (e.g., added, expired).
+message KeyRecord {
+  dxos.keys.PublicKey public_key = 1;
+}
+
+message SignRequest {
+  dxos.keys.PublicKey public_key = 1;
+  bytes payload = 2;
+}
+
+message SignResponse {
+  bytes signed = 2;
+}
+
+service SigningService {
+  rpc UpdateKeyRecord(KeyRecord) returns (KeyRecord);
+  rpc Sign(SignRequest) returns (SignResponse);
+}
+
+//
+// Halo
+//
+
+message Identity {
+  dxos.keys.PublicKey identity_key = 1;
+  halo.credentials.ProfileDocument profile = 2;
+}
+
+message RecoverProfileRequest {
+  bytes recovery_key = 1;
+}
+
+service HaloService {
+  rpc RecoverProfile(RecoverProfileRequest) returns (Identity);
+  rpc UpdateProfile(Identity) returns (google.protobuf.Empty);
+  rpc QueryProfile(google.protobuf.Empty) returns (stream Identity);
+}
+
+//
+// Devices
+//
+
+// TODO(burdon): Preferences (in database).
+message Device {
+  dxos.keys.PublicKey device_key = 1;
+}
+
+message QueryDevicesResponse {
+  repeated Device devices = 1;
+}
+
+service DevicesService {
+  rpc UpdateDevice(google.protobuf.Empty) returns (Device);
+  rpc QueryDevices(google.protobuf.Empty) returns (stream QueryDevicesResponse);
+}
+
+//
+// Contacts
+//
+
+message Contact {
+  halo.credentials.ProfileDocument profile = 1;
+}
+
+service ContactsService {
+  rpc UpdateContact(google.protobuf.Empty) returns (Contact);
+  rpc QueryContacts(google.protobuf.Empty) returns (stream Contact);
+}
+
+//
+// Data Spaces
+// TODO(burdon): Move to dxos.echo? Or rename dxos.echo => dxos.database?
+//
+
+// TODO(burdon): Preferences (in database).
+message Space {
+  dxos.keys.PublicKey space_key = 1;
+}
+
+message QueryMembersRequest {}
+message QueryMembersResponse {
+  dxos.halo.credentials.IdentityProfile members = 1;
+}
+
+service SpacesService {
+  rpc CreateSpace(google.protobuf.Empty) returns (Space);
+  rpc QuerySpaces(google.protobuf.Empty) returns (stream Space);
+  rpc QueryMembers(QueryMembersRequest) returns (stream QueryMembersResponse);
+}
+
+//
+// Invitations (Halo and Data Spaces).
+//
+
+/**
+ * Represents the invitation state passed between client and service.
+ */
+message Invitation {
+  enum Type {
+    /// Requires both to be online with OTP to complete key exchange.
+    INTERACTIVE = 0;
+    /// Interactive without OTP.
+    INTERACTIVE_TESTING = 1;
+    /// Guest's identity key is known; invitation can be accepted by any valid peer.
+    OFFLINE = 2;
+  }
+
+  enum State {
+    INIT = 0;
+    CONNECTING = 1;
+    CONNECTED = 2;
+    AUTHENTICATING = 3;
+    SUCCESS = 4;
+    CANCELLED = 5;
+    TIMEOUT = 6;
+    ERROR = 7;
+  }
+
+  /// Local identifier.
+  optional string invitation_id = 1;
+
+  /// Determined when created.
+  optional Type type = 2;
+
+  /// Local state.
+  optional State state = 3;
+
+  /// Local error code.
+  optional int32 error_code = 4;
+
+  /// Swarm rendezvous (random).
+  optional dxos.keys.PublicKey swarm_key = 5;
+
+  /// Guest's identity (only present if OFFLINE).
+  optional dxos.keys.PublicKey identity_key = 6;
+
+  /// Authentication code created by host.
+  optional string authentication_code = 7;
+
+  /// Space key (if data invitation).
+  optional dxos.keys.PublicKey space_key = 8;
+}
+
+message AuthenticationRequest {
+  string invitation_id = 1;
+  string authentication_code = 2;
+}
+
+message CancelInvitationRequest {
+  string invitation_id = 1;
+}
+
+// TODO(burdon): Separate implementations for HALO/Data Spaces.
+service InvitationsService {
+  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);
+}

package/src/proto/dxos/client.proto

@@ -6,10 +6,10 @@ syntax = "proto3";
 
 import "google/protobuf/empty.proto";
 
+import "dxos/client/services.proto";
 import "dxos/config.proto";
 import "dxos/echo/snapshot.proto";
 import "dxos/echo/timeframe.proto";
-import "dxos/halo/invitations.proto";
 import "dxos/halo/keys.proto";
 import "dxos/keys.proto";
 
@@ -26,7 +26,6 @@ service SystemService {
 
 //
 // Invitations shared across HALO and ECHO.
-// TODO(burdon): Consolidate with invitation protobufs.
 //
 
 enum InvitationState {
@@ -38,7 +37,7 @@ enum InvitationState {
 
 /// Invitation process created by sender.
 message InvitationRequest {
-  optional dxos.halo.invitations.InvitationDescriptor descriptor = 1;
+  optional dxos.client.services.Invitation descriptor = 1;
 
   InvitationState state = 2;
 
@@ -55,8 +54,8 @@ message RedeemedInvitation {
   /// Only if state == ERROR.
   optional string error = 3;
 
-  /// Only on party invitations that are finished.
-  optional dxos.keys.PublicKey party_key = 4;
+  /// Only on space invitations that are finished.
+  optional dxos.keys.PublicKey space_key = 4;
 }
 
 message AuthenticateInvitationRequest {
@@ -70,8 +69,9 @@ message AuthenticateInvitationRequest {
 //
 
 message Profile {
-  dxos.keys.PublicKey public_key = 1;
-  optional string username = 2;
+  // TODO(burdon): Remove identity from Profile (space of identity).
+  dxos.keys.PublicKey identity_key = 1;
+  optional string displayName = 2;
 }
 
 message SubscribeProfileResponse {
@@ -79,14 +79,16 @@ message SubscribeProfileResponse {
 }
 
 message CreateProfileRequest {
-  optional string username = 1;
-  optional bytes public_key = 2;
-  optional bytes secret_key = 3;
+  optional bytes public_key = 1;
+  optional bytes secret_key = 2;
+  // TODO(burdon): Profile.
+  optional string displayName = 3;
 }
 
 message RecoverProfileRequest {
   string seed_phrase = 1;
 }
+
 message Contact {
   dxos.keys.PublicKey public_key = 1;
   optional string display_name = 2;
@@ -102,7 +104,7 @@ service ProfileService {
   rpc SubscribeProfile (google.protobuf.Empty) returns (stream SubscribeProfileResponse);
 
   rpc CreateInvitation(google.protobuf.Empty) returns (stream InvitationRequest);
-  rpc AcceptInvitation(dxos.halo.invitations.InvitationDescriptor) returns (stream RedeemedInvitation);
+  rpc AcceptInvitation(dxos.client.services.Invitation) returns (stream RedeemedInvitation);
   rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
 }
 
@@ -154,54 +156,56 @@ service HaloService {
 //
 
 // TODO(burdon): Rename Space.
-message Party {
-  message Member {
-    dxos.keys.PublicKey public_key = 1;
-    optional string display_name = 2;
-  }
-
+message Space {
   dxos.keys.PublicKey public_key = 1;
   bool is_open = 2;
   bool is_active = 3;
 
-  repeated Member members = 4;
+  repeated SpaceMember members = 4;
 }
 
-message SubscribePartyRequest {
-  dxos.keys.PublicKey party_key = 1;
+message SubscribeSpaceRequest {
+  dxos.keys.PublicKey space_key = 1;
 }
 
-message GetPartyDetailsRequest {
-  dxos.keys.PublicKey party_key = 1;
+message GetSpaceDetailsRequest {
+  dxos.keys.PublicKey space_key = 1;
 }
 
-message PartyDetails {
+message SpaceDetails {
   /// The timeframe of mutations processed by the client.
   dxos.echo.timeframe.TimeframeVector processed_timeframe = 1;
 }
 
-message SubscribePartyResponse {
-  optional Party party = 1;
+// TODO(burdon): Reconcile with dxos.halo.credentials.SpaceMember.
+// TODO(burdon): Reconcile with Profile.
+message SpaceMember {
+  dxos.keys.PublicKey identity_key = 1;
+  optional Profile profile = 2;
+}
+
+message SubscribeSpaceResponse {
+  optional Space space = 1;
 }
 
-message SubscribePartiesResponse {
-  repeated Party parties = 1;
+message SubscribeSpacesResponse {
+  repeated Space spaces = 1;
 }
 
 message CreateInvitationRequest {
-  dxos.keys.PublicKey party_key = 1;
+  dxos.keys.PublicKey space_key = 1;
 
   /// When specified the invitation will be of OFFLINE type, not requiring secret exchange.
   optional dxos.keys.PublicKey invitee_key = 2;
 }
 
-message PartyActivationOptions {
+message SpaceActivationOptions {
   bool global = 1;
   bool device = 2;
 }
 
-message SetPartyStateRequest {
-  dxos.keys.PublicKey party_key = 1;
+message SetSpaceStateRequest {
+  dxos.keys.PublicKey space_key = 1;
 
   optional bool open = 2;
   optional bool active_global = 3;
@@ -209,46 +213,36 @@ message SetPartyStateRequest {
 }
 
 message SubscribeMembersRequest {
-  dxos.keys.PublicKey party_key = 1;
+  dxos.keys.PublicKey space_key = 1;
 }
 
 message SubscribeMembersResponse {
-  message PartyMember {
-    dxos.keys.PublicKey public_key = 1; // TODO(burdon): Rename xxx_key.
-    optional string display_name = 2;
-  }
-
-  repeated PartyMember members = 1;
+  repeated SpaceMember members = 1;
 }
 
 message CreateSnapshotRequest {
-  dxos.keys.PublicKey party_key = 1;
+  dxos.keys.PublicKey space_key = 1;
 }
 
 //
 // Service definition
 //
 
-// TODO(burdon): Rename SpaceService.
-service PartyService {
-  rpc SubscribeToParty (SubscribePartyRequest) returns (stream SubscribePartyResponse);
-  rpc SubscribeParties (google.protobuf.Empty) returns (stream SubscribePartiesResponse);
+service SpaceService {
+  rpc SubscribeToSpace (SubscribeSpaceRequest) returns (stream SubscribeSpaceResponse);
+  rpc SubscribeSpaces (google.protobuf.Empty) returns (stream SubscribeSpacesResponse);
 
-  rpc GetPartyDetails(GetPartyDetailsRequest) returns (PartyDetails);
+  rpc GetSpaceDetails(GetSpaceDetailsRequest) returns (SpaceDetails);
 
-  rpc CreateParty(google.protobuf.Empty) returns (Party);
-  rpc CloneParty(dxos.echo.snapshot.PartySnapshot) returns (Party);
+  rpc CreateSpace(google.protobuf.Empty) returns (Space);
+  rpc CloneSpace(dxos.echo.snapshot.SpaceSnapshot) returns (Space);
 
-  /// Open and close or activate and deactivate a party.
-  rpc SetPartyState(SetPartyStateRequest) returns (Party);
-
-  // TODO(burdon): Rename.
-  rpc CreateInvitation(CreateInvitationRequest) returns (stream InvitationRequest);
-  rpc AcceptInvitation(dxos.halo.invitations.InvitationDescriptor) returns (stream RedeemedInvitation);
-  rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
+  /// Open and close or activate and deactivate a space.
+  rpc SetSpaceState(SetSpaceStateRequest) returns (Space);
 
-  // TODO(rzadp): Remove and join with Subscribing to Party.
+  // TODO(rzadp): Remove and join with Subscribing to Space.
+  // Deprecated.
   rpc SubscribeMembers (SubscribeMembersRequest) returns (stream SubscribeMembersResponse);
 
-  rpc CreateSnapshot(CreateSnapshotRequest) returns (echo.snapshot.PartySnapshot);
+  rpc CreateSnapshot(CreateSnapshotRequest) returns (echo.snapshot.SpaceSnapshot);
 }

package/src/proto/dxos/config.proto

@@ -62,18 +62,6 @@ message Module {
 
 message Runtime {
   message Client {
-    /// Whether the client services are local with ClientServiceHost or remote and need to be accessed via ClientServiceProxy. Defaults to AUTOMATIC.
-    enum Mode {
-      /// Connects to the browser wallet if avialable, otherwise runs services in the local mode.
-      AUTOMATIC = 0;
-
-      /// Run services in the local mode.
-      LOCAL = 1;
-
-      /// Connect to the browser wallet or to the remote services through the RPC port.
-      REMOTE = 2;
-    }
-
     message Storage {
       enum StorageDriver {
         RAM = 0;
@@ -104,9 +92,8 @@ message Runtime {
     /// Milliseconds
     optional int32 invitation_expiration = 5;
 
-    optional Mode mode = 6;
-
-    optional string remote_source = 7;
+    // TODO(burdon): Remove?
+    optional string remote_source = 6;
   }
 
   message App {

package/src/proto/dxos/devtools/diagnostics.proto

@@ -0,0 +1,28 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+import "dxos/keys.proto";
+
+package dxos.devtools.host;
+
+message Services {
+  repeated SpaceStats spaces = 1;
+}
+
+message SpaceStats {
+  dxos.keys.PublicKey key = 1;
+  repeated PeerStats peers = 2;
+}
+
+message PeerStats {
+  FeedStats control_feed = 1;
+  FeedStats data_feed = 2;
+}
+
+message FeedStats {
+  dxos.keys.PublicKey key = 1;
+  int32 length = 2;
+}