@dxos/protocols 0.1.25 → 0.1.27-next.a0dff21

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAkD9C,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA6Z7C,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,i+qIAAi+qI,CAAC,CAAC;AACxgrI,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAiDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAqY7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,o9pEAAo9pE,CAAC,CAAC,CAAC;AAC7gqE,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.1.25",
+  "version": "0.1.27-next.a0dff21",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.1.25",
-    "@dxos/hypercore": "0.1.25",
-    "@dxos/keys": "0.1.25",
-    "@dxos/timeframe": "0.1.25"
+    "@dxos/codec-protobuf": "0.1.27-next.a0dff21",
+    "@dxos/hypercore": "0.1.27-next.a0dff21",
+    "@dxos/keys": "0.1.27-next.a0dff21",
+    "@dxos/timeframe": "0.1.27-next.a0dff21"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",

package/src/proto/dxos/bot.proto

@@ -7,7 +7,6 @@ syntax = "proto3";
 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/keys.proto";
@@ -93,7 +92,7 @@ message GetLogsRequest {
 
 message BotReport {
   /// Details of the space the bot was spawned for.
-  optional dxos.client.SpaceDetails space_details = 1;
+  optional dxos.echo.timeframe.TimeframeVector processed_timeframe = 1;
 }
 
 /// Service that is used by clients to communicate with bot factory.

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

@@ -8,6 +8,7 @@ import "google/protobuf/empty.proto";
 
 import "dxos/config.proto";
 import "dxos/halo/credentials.proto";
+import "dxos/halo/invitations.proto";
 import "dxos/keys.proto";
 
 // TODO(burdon): Restructure all services.
@@ -22,37 +23,35 @@ package dxos.client.services;
 // - Normalize records for performance (e.g., Space members separate from Space metadata).
 //
 
-//
-// System
-//
+enum SystemStatus {
+  ACTIVE = 0;
+  INACTIVE = 1;
+}
 
-service SystemService {
-  rpc GetConfig(google.protobuf.Empty) returns (dxos.config.Config);
-  rpc Reset(google.protobuf.Empty) returns (google.protobuf.Empty);
+message UpdateSystemStatusRequest {
+  SystemStatus status = 1;
+}
+
+message SystemStatusResponse {
+  SystemStatus status = 1;
 }
 
 //
-// Signing
-// TODO(burdon): Rename Crypto/KeystoreService?
+// System
 //
 
-// TODO(burdon): Metadata (e.g., added, expired).
-message KeyRecord {
-  dxos.keys.PublicKey public_key = 1;
-}
+service SystemService {
+  /// Get the static config of the client.
+  rpc GetConfig(google.protobuf.Empty) returns (dxos.config.Config);
 
-message SignRequest {
-  dxos.keys.PublicKey public_key = 1;
-  bytes payload = 2;
-}
+  /// Update the status of the client. Used to re-activate an inactive client.
+  rpc UpdateStatus(UpdateSystemStatusRequest) returns (google.protobuf.Empty);
 
-message SignResponse {
-  bytes signed = 2;
-}
+  /// Stream the status of the client.
+  rpc QueryStatus(google.protobuf.Empty) returns (stream SystemStatusResponse);
 
-service SigningService {
-  rpc UpdateKeyRecord(KeyRecord) returns (KeyRecord);
-  rpc Sign(SignRequest) returns (SignResponse);
+  /// Reset the client.
+  rpc Reset(google.protobuf.Empty) returns (google.protobuf.Empty);
 }
 
 //
@@ -61,26 +60,45 @@ service SigningService {
 
 message Identity {
   dxos.keys.PublicKey identity_key = 1;
-  halo.credentials.ProfileDocument profile = 2;
+  optional dxos.keys.PublicKey space_key = 2;
+  optional halo.credentials.ProfileDocument profile = 3;
 }
 
-message RecoverProfileRequest {
+message RecoverIdentityRequest {
   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);
+message QueryIdentityResponse {
+  optional Identity identity = 1;
+}
+
+message SignPresentationRequest {
+  dxos.halo.credentials.Presentation presentation = 1;
+  optional bytes nonce = 2;
+}
+
+service IdentityService {
+  rpc CreateIdentity(halo.credentials.ProfileDocument) returns (Identity);
+  rpc RecoverIdentity(RecoverIdentityRequest) returns (Identity);
+  rpc QueryIdentity(google.protobuf.Empty) returns (stream QueryIdentityResponse);
+
+  rpc SignPresentation(SignPresentationRequest) returns (dxos.halo.credentials.Presentation);
 }
 
 //
 // Devices
 //
 
+enum DeviceKind {
+  CURRENT = 0;
+  TRUSTED = 1;
+}
+
 // TODO(burdon): Preferences (in database).
 message Device {
   dxos.keys.PublicKey device_key = 1;
+  DeviceKind kind = 2;
+  optional halo.credentials.ProfileDocument profile = 3;
 }
 
 message QueryDevicesResponse {
@@ -88,7 +106,7 @@ message QueryDevicesResponse {
 }
 
 service DevicesService {
-  rpc UpdateDevice(google.protobuf.Empty) returns (Device);
+  rpc UpdateDevice(halo.credentials.ProfileDocument) returns (Device);
   rpc QueryDevices(google.protobuf.Empty) returns (stream QueryDevicesResponse);
 }
 
@@ -110,13 +128,34 @@ service ContactsService {
 // TODO(burdon): Move to dxos.echo? Or rename dxos.echo => dxos.database?
 //
 
+message SpaceMember {
+  enum PresenceState {
+    OFFLINE = 0;
+    ONLINE = 1;
+  }
+
+  Identity identity = 1;
+  PresenceState presence = 2;
+}
+
+enum SpaceStatus {
+  ACTIVE = 0;
+  INACTIVE = 1;
+}
+
 message Space {
   dxos.keys.PublicKey space_key = 1;
+  SpaceStatus status = 2;
+
+  repeated SpaceMember members = 10;
+}
+
+message UpdateSpaceRequest {
+  optional Status status = 1;
 }
 
-message QueryMembersRequest {}
-message QueryMembersResponse {
-  dxos.halo.credentials.IdentityProfile members = 1;
+message QuerySpacesResponse {
+  repeated Space spaces = 1;
 }
 
 message WriteCredentialsRequest {
@@ -130,12 +169,12 @@ message QueryCredentialsRequest {
 
 service SpacesService {
   rpc CreateSpace(google.protobuf.Empty) returns (Space);
-  rpc QuerySpaces(google.protobuf.Empty) returns (stream Space);
+  rpc UpdateSpace(UpdateSpaceRequest) returns (google.protobuf.Empty);
+  rpc QuerySpaces(google.protobuf.Empty) returns (stream QuerySpacesResponse);
 
-  // TODO(dmaretskyi): I dont think we need a separate method here. We can include members in the Space object.
-  rpc QueryMembers(QueryMembersRequest) returns (stream QueryMembersResponse);
-  
+  /// Write credentials to the space control feed.
   rpc WriteCredentials(WriteCredentialsRequest) returns (google.protobuf.Empty);
+  /// Query credentials from the space control feed.
   rpc QueryCredentials(QueryCredentialsRequest) returns (stream dxos.halo.credentials.Credential);
 }
 
@@ -151,6 +190,7 @@ message Invitation {
     /// Requires both to be online with OTP to complete key exchange.
     INTERACTIVE = 0;
     /// Interactive without OTP.
+    /// @deprecated Use authMethod.
     INTERACTIVE_TESTING = 1;
     /// Guest's identity key is known; invitation can be accepted by any valid peer.
     OFFLINE = 2;
@@ -183,6 +223,8 @@ message Invitation {
   /// Determined when created.
   optional Type type = 2;
 
+  optional dxos.halo.invitations.AuthMethod auth_method = 10; // TODO: Fix numbering.
+
   /// Local state.
   optional State state = 3;
 
@@ -217,7 +259,7 @@ message CancelInvitationRequest {
 // Common TS interface.
 // TODO(burdon): Reconcile with halo/invitations.proto (e.g., common defs like error vs superset of services?)
 
-service HaloInvitationsService {
+service DeviceInvitationsService {
   rpc CreateInvitation(Invitation) returns (stream Invitation);
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
   rpc AcceptInvitation(Invitation) returns (stream Invitation);

package/src/proto/dxos/config.proto

@@ -104,6 +104,7 @@ message Runtime {
     /// Milliseconds
     optional int32 invitation_expiration = 5;
 
+    /// Location of the remote client host.
     optional string remote_source = 6;
   }
 

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

@@ -23,11 +23,20 @@ message AuthenticationResponse {
     OK = 0;
     INVALID_OTP = 1;
     INVALID_OPT_ATTEMPTS = 2;
+    INTERNAL_ERROR = 3;
   }
 
   optional Status status = 1;
 }
 
+enum AuthMethod {
+  /// No authnetication is required. Guest should not call `Authenticate`.
+  NONE = 0;
+
+  /// Guest should call `Authenticate` with the shared secret.
+  SHARED_SECRET = 1;
+}
+
 //
 // HALO device invitations.
 //
@@ -64,6 +73,13 @@ message Introduction {
   optional halo.credentials.ProfileDocument profile = 1;
 }
 
+message IntroductionResponse {
+  /// Only present for testing invitation types.
+  optional dxos.keys.PublicKey space_key = 1;
+
+  AuthMethod auth_method = 2;
+}
+
 message SpaceAdmissionRequest {
   dxos.keys.PublicKey identity_key = 1;
   dxos.keys.PublicKey device_key = 2;
@@ -75,13 +91,16 @@ message SpaceAdmissionCredentials {
   /// Credential of type `SpaceMember` that grants Guest's identity access to the space.
   dxos.halo.credentials.Credential credential = 1;
 
+  /// Hint to the guest about the current control timeframe.
   optional dxos.echo.timeframe.TimeframeVector control_timeframe = 2;
+
+  /// Hint to the guest about the current data timeframe.
   optional dxos.echo.timeframe.TimeframeVector data_timeframe = 3;
 }
 
 service SpaceHostService {
   /// Introduce Guest to the host.
-  rpc Introduce(Introduction) returns (google.protobuf.Empty);
+  rpc Introduce(Introduction) returns (IntroductionResponse);
 
   /// Authenticate request.
   rpc Authenticate(AuthenticationRequest) returns (AuthenticationResponse);

package/src/proto/dxos/iframe.proto

@@ -6,6 +6,8 @@ syntax = "proto3";
 
 import "google/protobuf/empty.proto";
 
+import "dxos/keys.proto";
+
 package dxos.iframe;
 
 message StartRequest {
@@ -21,4 +23,38 @@ service IframeService {
 service WorkerService {
   rpc Start(StartRequest) returns (google.protobuf.Empty);
   rpc Stop(google.protobuf.Empty) returns (google.protobuf.Empty);
-}
+}
+
+enum ShellDisplay {
+  NONE = 0;
+  FULLSCREEN = 1;
+}
+
+message AppContextRequest {
+  ShellDisplay display = 1;
+  optional dxos.keys.PublicKey space_key = 2;
+}
+
+/// App RPCs for the shell.
+service AppService {
+  rpc SetContext(AppContextRequest) returns (google.protobuf.Empty);
+}
+
+enum ShellLayout {
+  DEFAULT = 0;
+  INITIALIZE_IDENTITY = 1;
+  DEVICE_INVITATIONS = 2;
+  SPACE_INVITATIONS = 3;
+  JOIN_SPACE = 4;
+}
+
+message LayoutRequest {
+  ShellLayout layout = 1;
+  optional string invitation_code = 2;
+  optional dxos.keys.PublicKey space_key = 3;
+}
+
+/// Shell UI RPCs.
+service ShellService {
+  rpc SetLayout(LayoutRequest) returns (google.protobuf.Empty);
+}

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

@@ -1,6 +1,5 @@
 import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../substitutions";
-import * as dxos_client from "./client";
 import * as dxos_client_services from "./client/services";
 import * as dxos_config from "./config";
 import * as dxos_devtools_host from "./devtools/host";
@@ -227,7 +226,7 @@ export interface BotReport {
      * Options:
      *   - proto3_optional = true
      */
-    spaceDetails?: dxos_client.SpaceDetails;
+    processedTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
 }
 /**
  * Service that is used by clients to communicate with bot factory.

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

@@ -1,7 +1,6 @@
 import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../../substitutions";
 import * as dxos_bot from "../bot";
-import * as dxos_client from "../client";
 import * as dxos_config from "../config";
 import * as dxos_devtools_host from "../devtools/host";
 import * as dxos_devtools_swarm from "../devtools/swarm";
@@ -52,63 +51,110 @@ import * as google_protobuf from "../../google/protobuf";
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface SystemService {
-    getConfig: (request: void) => Promise<dxos_config.Config>;
-    reset: (request: void) => Promise<void>;
+export enum SystemStatus {
+    ACTIVE = 0,
+    INACTIVE = 1
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface UpdateSystemStatusRequest {
+    status: SystemStatus;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface KeyRecord {
-    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface SystemStatusResponse {
+    status: SystemStatus;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface SignRequest {
-    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    payload: Uint8Array;
+export interface SystemService {
+    /**
+     * Get the static config of the client.
+     */
+    getConfig: (request: void) => Promise<dxos_config.Config>;
+    /**
+     * Update the status of the client. Used to re-activate an inactive client.
+     */
+    updateStatus: (request: UpdateSystemStatusRequest) => Promise<void>;
+    /**
+     * Stream the status of the client.
+     */
+    queryStatus: (request: void) => Stream<SystemStatusResponse>;
+    /**
+     * Reset the client.
+     */
+    reset: (request: void) => Promise<void>;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface SignResponse {
-    signed: Uint8Array;
+export interface Identity {
+    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: dxos_halo_credentials.ProfileDocument;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface SigningService {
-    updateKeyRecord: (request: KeyRecord) => Promise<KeyRecord>;
-    sign: (request: SignRequest) => Promise<SignResponse>;
+export interface RecoverIdentityRequest {
+    recoveryKey: Uint8Array;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface Identity {
-    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    profile: dxos_halo_credentials.ProfileDocument;
+export interface QueryIdentityResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    identity?: Identity;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface RecoverProfileRequest {
-    recoveryKey: Uint8Array;
+export interface SignPresentationRequest {
+    presentation: dxos_halo_credentials.Presentation;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    nonce?: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface IdentityService {
+    createIdentity: (request: dxos_halo_credentials.ProfileDocument) => Promise<Identity>;
+    recoverIdentity: (request: RecoverIdentityRequest) => Promise<Identity>;
+    queryIdentity: (request: void) => Stream<QueryIdentityResponse>;
+    signPresentation: (request: SignPresentationRequest) => Promise<dxos_halo_credentials.Presentation>;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface HaloService {
-    recoverProfile: (request: RecoverProfileRequest) => Promise<Identity>;
-    updateProfile: (request: Identity) => Promise<void>;
-    queryProfile: (request: void) => Stream<Identity>;
+export enum DeviceKind {
+    CURRENT = 0,
+    TRUSTED = 1
 }
 /**
  * Defined in:
@@ -116,6 +162,12 @@ export interface HaloService {
  */
 export interface Device {
     deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    kind: DeviceKind;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: dxos_halo_credentials.ProfileDocument;
 }
 /**
  * Defined in:
@@ -129,7 +181,7 @@ export interface QueryDevicesResponse {
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface DevicesService {
-    updateDevice: (request: void) => Promise<Device>;
+    updateDevice: (request: dxos_halo_credentials.ProfileDocument) => Promise<Device>;
     queryDevices: (request: void) => Stream<QueryDevicesResponse>;
 }
 /**
@@ -147,25 +199,58 @@ export interface ContactsService {
     updateContact: (request: void) => Promise<Contact>;
     queryContacts: (request: void) => Stream<Contact>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SpaceMember {
+    identity: Identity;
+    presence: SpaceMember.PresenceState;
+}
+export namespace SpaceMember {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum PresenceState {
+        OFFLINE = 0,
+        ONLINE = 1
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export enum SpaceStatus {
+    ACTIVE = 0,
+    INACTIVE = 1
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface Space {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    status: SpaceStatus;
+    members?: SpaceMember[];
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface QueryMembersRequest {
+export interface UpdateSpaceRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    status?: dxos_bot.Bot.Status;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface QueryMembersResponse {
-    members: dxos_halo_credentials.IdentityProfile;
+export interface QuerySpacesResponse {
+    spaces?: Space[];
 }
 /**
  * Defined in:
@@ -188,9 +273,15 @@ export interface QueryCredentialsRequest {
  */
 export interface SpacesService {
     createSpace: (request: void) => Promise<Space>;
-    querySpaces: (request: void) => Stream<Space>;
-    queryMembers: (request: QueryMembersRequest) => Stream<QueryMembersResponse>;
+    updateSpace: (request: UpdateSpaceRequest) => Promise<void>;
+    querySpaces: (request: void) => Stream<QuerySpacesResponse>;
+    /**
+     * Write credentials to the space control feed.
+     */
     writeCredentials: (request: WriteCredentialsRequest) => Promise<void>;
+    /**
+     * Query credentials from the space control feed.
+     */
     queryCredentials: (request: QueryCredentialsRequest) => Stream<dxos_halo_credentials.Credential>;
 }
 /**
@@ -214,6 +305,11 @@ export interface Invitation {
      *   - proto3_optional = true
      */
     type?: Invitation.Type;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    authMethod?: dxos_halo_invitations.AuthMethod;
     /**
      * Local state.
      *
@@ -320,7 +416,7 @@ export interface CancelInvitationRequest {
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface HaloInvitationsService {
+export interface DeviceInvitationsService {
     createInvitation: (request: Invitation) => Stream<Invitation>;
     authenticate: (request: AuthenticationRequest) => Promise<void>;
     acceptInvitation: (request: Invitation) => Stream<Invitation>;

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

@@ -1,7 +1,6 @@
 import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../substitutions";
 import * as dxos_bot from "./bot";
-import * as dxos_client from "./client";
 import * as dxos_client_services from "./client/services";
 import * as dxos_devtools_host from "./devtools/host";
 import * as dxos_devtools_swarm from "./devtools/swarm";
@@ -269,6 +268,8 @@ export namespace Runtime {
          */
         invitationExpiration?: number;
         /**
+         * Location of the remote client host.
+         *
          * Options:
          *   - proto3_optional = true
          */