@dxos/protocols 0.3.11-main.fbbdc2a → 0.3.11-main.fc97a54

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,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA6DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAghB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,iliGAAiliG,CAAC,CAAC,CAAC;AAC1oiG,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;AA6DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAohB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,oimGAAoimG,CAAC,CAAC,CAAC;AAC7lmG,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.3.11-main.fbbdc2a",
+  "version": "0.3.11-main.fc97a54",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/invariant": "0.3.11-main.fbbdc2a",
-    "@dxos/codec-protobuf": "0.3.11-main.fbbdc2a",
-    "@dxos/keys": "0.3.11-main.fbbdc2a",
-    "@dxos/timeframe": "0.3.11-main.fbbdc2a"
+    "@dxos/codec-protobuf": "0.3.11-main.fc97a54",
+    "@dxos/invariant": "0.3.11-main.fc97a54",
+    "@dxos/keys": "0.3.11-main.fc97a54",
+    "@dxos/timeframe": "0.3.11-main.fc97a54"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/errors/base-errors.ts

@@ -7,7 +7,11 @@
  * Errors can optionally include a JSON context object.
  */
 export class BaseError extends Error {
-  constructor(readonly code: string, message?: string, readonly context?: Record<string, any>) {
+  constructor(
+    readonly code: string,
+    message?: string,
+    readonly context?: Record<string, any>,
+  ) {
     super(message ?? code);
     this.name = code;
     // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).

package/src/errors/errors.ts

@@ -100,6 +100,14 @@ export class InvalidInvitationError extends DatabaseError {
 
 registerErrorMessageContext('INVALID_INVITATION', InvalidInvitationError);
 
+export class AlreadyJoinedError extends DatabaseError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('ALREADY_JOINED', message, context);
+  }
+}
+
+registerErrorMessageContext('ALREADY_JOINED', AlreadyJoinedError);
+
 export class ConnectionResetError extends BaseError {
   constructor(message?: string, context?: any) {
     super('CONNECTION_RESET', message, context);

package/src/proto/dxos/agent/echo-proxy.proto

@@ -6,6 +6,6 @@ syntax = "proto3";
 
 package dxos.agent.echoproxy;
 
-message EchoProxyConfig {
+message Config {
   optional int32 port = 1;
 }

package/src/proto/dxos/agent/query.proto

@@ -10,7 +10,6 @@ import "dxos/echo/object.proto";
 
 package dxos.agent.query;
 
-
 message QueryRequest {
   string queryId = 1;
   filter.Filter filter = 2;

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

@@ -19,6 +19,7 @@ import "dxos/mesh/signal.proto";
 import "dxos/mesh/teleport/gossip.proto";
 import "dxos/mesh/presence.proto";
 import "dxos/value.proto";
+import "dxos/devtools/swarm.proto";
 
 // TODO(burdon): Reorganize packages (e.g., client.services, echo.database).
 
@@ -63,6 +64,28 @@ message GetDiagnosticsResponse {
   google.protobuf.Struct diagnostics = 2;
 }
 
+message Platform {
+  enum PLATFORM_TYPE {
+    BROWSER = 0;
+    SHARED_WORKER = 1;
+    NODE = 2;
+  }
+
+  PLATFORM_TYPE type = 1;
+  /// The User-Agent string from a browser
+  optional string user_agent = 2;
+  /// e.g process.platform from node, e.g. 'darwin', 'linux', 'win32'
+  optional string platform = 3;
+  /// the Node.JS arch string, e.g. 'arm64', 'x64'
+  optional string arch = 4;
+  /// the node.js version string
+  optional string runtime = 5;
+  // TODO(nf): uint64? :)
+  /// the number of seconds the client has been up
+  optional uint32 uptime = 6;
+  /// e.g. NodeJS.MemoryUsage, subject to change
+  optional google.protobuf.Struct memory = 7;
+}
 //
 // System
 //
@@ -82,6 +105,9 @@ service SystemService {
 
   /// Reset the client.
   rpc Reset(google.protobuf.Empty) returns (google.protobuf.Empty);
+
+  /// Get platform Information
+  rpc GetPlatform(google.protobuf.Empty) returns (Platform);
 }
 
 //
@@ -107,9 +133,14 @@ message SignPresentationRequest {
   optional bytes nonce = 2;
 }
 
+message CreateIdentityRequest {
+  optional halo.credentials.ProfileDocument profile = 1;
+  optional bool use_automerge = 2;
+}
+
 // TODO(wittjosiah): Align pluralization with other services.
 service IdentityService {
-  rpc CreateIdentity(halo.credentials.ProfileDocument) returns (Identity);
+  rpc CreateIdentity(CreateIdentityRequest) returns (Identity);
   rpc RecoverIdentity(RecoverIdentityRequest) returns (Identity);
   rpc QueryIdentity(google.protobuf.Empty) returns (stream QueryIdentityResponse);
   rpc UpdateProfile(halo.credentials.ProfileDocument) returns (Identity);
@@ -407,6 +438,9 @@ message Invitation {
 
   /// Authentication code created by host (only present if auth_method is SHARED_SECRET).
   optional string auth_code = 10;
+
+  /// Path or identifier to navigate to after successful authentication.
+  optional string target = 11;
 }
 
 message AuthenticationRequest {
@@ -468,6 +502,7 @@ message NetworkStatus {
 
   ConnectionState swarm = 1;
   repeated Signal signaling = 2;
+  repeated dxos.devtools.swarm.SwarmInfo connection_info = 3;
 }
 
 message UpdateConfigRequest {

package/src/proto/dxos/config.proto

@@ -367,6 +367,12 @@ message Runtime {
       optional string username = 2;
       optional string password = 3;
     }
+    // TODO(nf): Set API version, authentication scheme, etc.
+    message AgentHosting {
+      // TODO(nf): read enum from yml?
+      optional string server = 1;
+      optional string type = 2;
+    }
 
     optional Kube kube = 1;
     optional AppServer app = 2;
@@ -380,6 +386,7 @@ message Runtime {
     optional Supervisor supervisor = 10; // TODO(burdon): Promote to 1; start others at 10.
     optional Tunneling tunneling = 11;
     optional Faasd faasd = 12;
+    optional AgentHosting agent_hosting = 13;
   }
 
   message Keys {

package/src/proto/dxos/iframe.proto

@@ -29,11 +29,19 @@ enum ShellDisplay {
 }
 
 message AppContextRequest {
-  /// The display mode that shell should use
+  /// The display mode that shell should use.
   optional ShellDisplay display = 1;
 
-  /// The key of the joined space
+  /// The key of the joined space.
   optional dxos.keys.PublicKey space_key = 2;
+  
+  /// Target to redirect to after a successful invitation.
+  optional string target = 3;
+
+  /// Reload the app.
+  /// Shell cannot reload the app from within an iframe.
+  /// Used after sign out/identity reset.
+  optional bool reload = 4;
 }
 
 /// App RPCs for the shell.
@@ -52,9 +60,17 @@ enum ShellLayout {
 }
 
 message LayoutRequest {
+  /// Determins which panel of the shell is opened.
   ShellLayout layout = 1;
+
+  /// Invitation code to join a space.
   optional string invitation_code = 2;
+
+  /// Key of the space to share.
   optional dxos.keys.PublicKey space_key = 3;
+
+  /// Target to include in an invitation for redirecting after a successful invitation.
+  optional string target = 4;
 }
 
 /// Shell UI RPCs.

package/src/proto/gen/dxos/agent/echoproxy.ts

@@ -63,7 +63,7 @@ import * as google_protobuf from "../../google/protobuf";
  * Defined in:
  *   {@link file://./../../../dxos/agent/echo-proxy.proto}
  */
-export interface EchoProxyConfig {
+export interface Config {
     /**
      * Options:
      *   - proto3_optional = true

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

@@ -297,6 +297,66 @@ export interface GetDiagnosticsResponse {
     timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
     diagnostics: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface Platform {
+    type: Platform.PLATFORM_TYPE;
+    /**
+     * The User-Agent string from a browser
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    userAgent?: string;
+    /**
+     * e.g process.platform from node, e.g. 'darwin', 'linux', 'win32'
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    platform?: string;
+    /**
+     * the Node.JS arch string, e.g. 'arm64', 'x64'
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    arch?: string;
+    /**
+     * the node.js version string
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    runtime?: string;
+    /**
+     * the number of seconds the client has been up
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    uptime?: number;
+    /**
+     * e.g. NodeJS.MemoryUsage, subject to change
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    memory?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+}
+export namespace Platform {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum PLATFORM_TYPE {
+        BROWSER = 0,
+        SHARED_WORKER = 1,
+        NODE = 2
+    }
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -322,6 +382,10 @@ export interface SystemService {
      * Reset the client.
      */
     reset: (request: void, options?: RequestOptions) => Promise<void>;
+    /**
+     * Get platform Information
+     */
+    getPlatform: (request: void, options?: RequestOptions) => Promise<Platform>;
 }
 /**
  * Defined in:
@@ -370,12 +434,28 @@ export interface SignPresentationRequest {
      */
     nonce?: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface CreateIdentityRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: dxos_halo_credentials.ProfileDocument;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    useAutomerge?: boolean;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface IdentityService {
-    createIdentity: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
+    createIdentity: (request: CreateIdentityRequest, options?: RequestOptions) => Promise<Identity>;
     recoverIdentity: (request: RecoverIdentityRequest, options?: RequestOptions) => Promise<Identity>;
     queryIdentity: (request: void, options?: RequestOptions) => Stream<QueryIdentityResponse>;
     updateProfile: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
@@ -798,6 +878,13 @@ export interface Invitation {
      *   - proto3_optional = true
      */
     authCode?: string;
+    /**
+     * Path or identifier to navigate to after successful authentication.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    target?: string;
 }
 export namespace Invitation {
     /**
@@ -917,6 +1004,7 @@ export enum ConnectionState {
 export interface NetworkStatus {
     swarm: ConnectionState;
     signaling?: NetworkStatus.Signal[];
+    connectionInfo?: dxos_devtools_swarm.SwarmInfo[];
 }
 export namespace NetworkStatus {
     /**

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

@@ -757,6 +757,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         faasd?: Runtime.Services.Faasd;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        agentHosting?: Runtime.Services.AgentHosting;
     }
     export namespace Services {
         /**
@@ -1006,6 +1011,22 @@ export namespace Runtime {
              */
             password?: string;
         }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        export interface AgentHosting {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            server?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            type?: string;
+        }
     }
     /**
      * Defined in:

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

@@ -97,19 +97,33 @@ export enum ShellDisplay {
  */
 export interface AppContextRequest {
     /**
-     * The display mode that shell should use
+     * The display mode that shell should use.
      *
      * Options:
      *   - proto3_optional = true
      */
     display?: ShellDisplay;
     /**
-     * The key of the joined space
+     * The key of the joined space.
      *
      * Options:
      *   - proto3_optional = true
      */
     spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Target to redirect to after a successful invitation.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    target?: string;
+    /**
+     * Used after sign out/identity reset.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    reload?: boolean;
 }
 /**
  * App RPCs for the shell.
@@ -138,17 +152,31 @@ export enum ShellLayout {
  *   {@link file://./../../dxos/iframe.proto}
  */
 export interface LayoutRequest {
+    /**
+     * Determins which panel of the shell is opened.
+     */
     layout: ShellLayout;
     /**
+     * Invitation code to join a space.
+     *
      * Options:
      *   - proto3_optional = true
      */
     invitationCode?: string;
     /**
+     * Key of the space to share.
+     *
      * Options:
      *   - proto3_optional = true
      */
     spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Target to include in an invitation for redirecting after a successful invitation.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    target?: string;
 }
 /**
  * Shell UI RPCs.

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

@@ -78,14 +78,14 @@ export enum NullValue {
 export interface ListValue {
     values?: Value[];
 }
-export interface Timestamp {
-    seconds: string;
-    nanos: number;
-}
 export interface Any {
     type_url: string;
     value: Uint8Array;
 }
+export interface Timestamp {
+    seconds: string;
+    nanos: number;
+}
 export interface FileDescriptorSet {
     file?: FileDescriptorProto[];
 }