@dxos/protocols 0.6.2 → 0.6.3-main.0308ae2

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;AAgEhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAujB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,416GAA416G,CAAC,CAAC,CAAC;AACr56G,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;AAgEhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAyjB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,ow8GAAow8G,CAAC,CAAC,CAAC;AAC7z8G,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.6.2",
+  "version": "0.6.3-main.0308ae2",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -18,6 +18,12 @@
       "import": "./dist/esm/src/proto/gen/*.js",
       "require": "./dist/cjs/src/proto/gen/*.js",
       "node": "./dist/cjs/src/proto/gen/*.js"
+    },
+    "./buf/*": {
+      "browser": "./dist/esm/src/buf/gen/*.js",
+      "import": "./dist/esm/src/buf/gen/*.js",
+      "require": "./dist/cjs/src/buf/gen/*.js",
+      "node": "./dist/cjs/src/buf/gen/*.js"
     }
   },
   "types": "dist/esm/src/index.d.ts",
@@ -34,19 +40,22 @@
   ],
   "dependencies": {
     "@effect/schema": "^0.67.16",
-    "@dxos/codec-protobuf": "0.6.2",
-    "@dxos/keys": "0.6.2",
-    "@dxos/invariant": "0.6.2",
-    "@dxos/timeframe": "0.6.2",
-    "@dxos/util": "0.6.2"
+    "@dxos/codec-protobuf": "0.6.3-main.0308ae2",
+    "@dxos/invariant": "0.6.3-main.0308ae2",
+    "@dxos/timeframe": "0.6.3-main.0308ae2",
+    "@dxos/util": "0.6.3-main.0308ae2",
+    "@dxos/keys": "0.6.3-main.0308ae2"
   },
   "devDependencies": {
+    "@bufbuild/buf": "^1.32.2",
+    "@bufbuild/protoc-gen-es": "^1.10.0",
     "glob": "~7.1.6"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "tsc-cjs": "rm -rf dist/cjs; tsc --module commonjs --target es2018 --outdir ./dist/cjs"
+    "compile:buf": "buf generate",
+    "tsc:cjs": "rm -rf dist/cjs; tsc --module commonjs --target es2018 --outdir ./dist/cjs"
   }
 }

package/src/proto/dxos/agent/dashboard.proto

@@ -4,12 +4,13 @@
 
 syntax = "proto3";
 
-package dxos.agent.dashboard;
 import "google/protobuf/empty.proto";
 import "google/protobuf/struct.proto";
 
 import "dxos/config.proto";
 
+package dxos.agent.dashboard;
+
 message AgentStatus {
   enum Status {
     ON = 0;
@@ -23,7 +24,7 @@ message AgentStatus {
     string free = 2;
     string ram_usage = 3;
   }
-  
+
   Status status = 1;
   optional Memory memory = 2;
   repeated PluginState plugins = 3;

package/src/proto/dxos/bot.proto

@@ -7,8 +7,9 @@ syntax = "proto3";
 import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
 
-import "dxos/client/services.proto";
+import "dxos/client/invitation.proto";
 import "dxos/config.proto";
+import "dxos/echo/timeframe.proto";
 import "dxos/keys.proto";
 
 package dxos.bot;

package/src/proto/dxos/client/invitation.proto

@@ -0,0 +1,171 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+
+import "dxos/config.proto";
+import "dxos/devtools/swarm.proto";
+import "dxos/echo/timeframe.proto";
+import "dxos/error.proto";
+import "dxos/halo/credentials.proto";
+import "dxos/keys.proto";
+import "dxos/mesh/signal.proto";
+import "dxos/mesh/presence.proto";
+import "dxos/mesh/teleport/gossip.proto";
+import "dxos/value.proto";
+
+// TODO(burdon): Reorganize packages (e.g., client.services, echo.database).
+
+package dxos.client.services;
+
+message AdmissionKeypair {
+  dxos.keys.PublicKey public_key = 1;
+  optional dxos.keys.PrivateKey private_key = 2;
+}
+
+/// Runtime state of the space object.
+enum SpaceState {
+  INVALID = 0;
+
+  ///
+  /// Persistent states.
+  ///
+
+  /// Space is inactive. No swarming or replication will be done.
+  SPACE_INACTIVE = 2;
+
+  /// Space is active. Swarming and replication will be done.
+  SPACE_ACTIVE = 6;
+
+  ///
+  /// Runtime states:
+  ///
+
+  /// Space is closed.
+  SPACE_CLOSED = 1;
+
+  /// Data pipeline is inactive.
+  SPACE_CONTROL_ONLY = 7;
+
+  /// Data pipeline is initializing.
+  SPACE_INITIALIZING = 4;
+
+  /// Data pipeline is ready.
+  SPACE_READY = 3;
+
+  /// Space errored.
+  SPACE_ERROR = 5;
+
+  /// Data migration is required.
+  SPACE_REQUIRES_MIGRATION = 8;
+}
+
+/**
+ * Represents the invitation state passed between client and service.
+ */
+message Invitation {
+  enum Type {
+    /// Requires both to be online to complete key exchange.
+    INTERACTIVE = 0;
+
+    /// Invitation can be accepted by any valid peer.
+    DELEGATED = 1;
+
+    /**
+     * Multi-use interactive invitations.
+     * @deprecated use multiUse flag with type=interactive instead.
+     */
+    MULTIUSE = 2;
+  }
+
+  enum Kind {
+    DEVICE = 0;
+    SPACE = 1;
+  }
+
+  enum AuthMethod {
+    /// No authentication is required. Guest should not call `Authenticate`.
+    NONE = 0;
+
+    /// Guest should call `Authenticate` with the shared secret.
+    SHARED_SECRET = 1;
+
+    /// Guest should prove they possess a private key corresponding to the known public key recorded in an invitation.
+    KNOWN_PUBLIC_KEY = 2;
+  }
+
+  enum State {
+    INIT = 0;
+    CONNECTING = 1;
+    CONNECTED = 2;
+    READY_FOR_AUTHENTICATION = 3;
+    AUTHENTICATING = 4;
+    SUCCESS = 5;
+    CANCELLED = 6;
+    TIMEOUT = 7;
+    ERROR = 8;
+    EXPIRED = 9;
+  }
+
+  /// Local identifier (random).
+  string invitation_id = 1;
+
+  /// Determines the behavior of the invitation.
+  Type type = 2;
+
+  /// Kind of access the invitation will grant.
+  Kind kind = 3;
+
+  /// How the invitation is authenticated.
+  AuthMethod auth_method = 4;
+
+  /// Swarm rendezvous (random).
+  dxos.keys.PublicKey swarm_key = 5;
+
+  /// Local state.
+  State state = 6;
+
+  /// Timeout for guest to complete invitation once connected (ms).
+  optional int32 timeout = 7;
+
+  /// Guest's identity.
+  optional dxos.keys.PublicKey identity_key = 8;
+
+  /// Space to join (only present if kind is SPACE).
+  optional dxos.keys.PublicKey space_key = 9;
+
+  /// 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;
+
+  // TODO(nf): should these exist elsewhere since they only have meaning to the host?
+  /// Host should resume invitation on startup until timeout.
+  optional bool persistent = 12;
+
+  optional google.protobuf.Timestamp created = 13;
+
+  /// Number of seconds the host will honor the invitation. 0 means the invitation persists forever.
+  // TODO(nf): some feedback mechanism or GC for immortal invitations?
+  // TODO(nf): should the creator have a way to make an invitation last as long as the client? this was the previous behavior.
+  optional int32 lifetime = 14;
+
+  /// Whether an invitation can be used multiple times.
+  optional bool multi_use = 15;
+
+  /// Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+  optional AdmissionKeypair guest_keypair = 16;
+
+  /// Present on Type.DELEGATED invitations.
+  optional dxos.keys.PublicKey delegation_credential_id = 17;
+
+  /// Role of the admitted member, defaults to ADMIN.
+  optional dxos.halo.credentials.SpaceMember.Role role = 18;
+}

package/src/proto/dxos/client/logging.proto

@@ -57,6 +57,7 @@ message QueryMetricsResponse {
 
 // NOTE: Keep aligned with LogLevel in @dxos/log.
 enum LogLevel {
+  NONE = 0;
   TRACE = 5;
   DEBUG = 10;
   INFO = 11;
@@ -66,6 +67,8 @@ enum LogLevel {
 
 message QueryLogsRequest {
   enum MatchingOptions {
+    NONE = 0;
+
     /// Filters match all log levels above. Default behaviour for the logger.
     INCLUSIVE = 1;
 

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

@@ -9,17 +9,18 @@ import "google/protobuf/empty.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
+import "dxos/client/invitation.proto";
 import "dxos/config.proto";
+import "dxos/devtools/swarm.proto";
 import "dxos/echo/metadata.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/error.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/keys.proto";
 import "dxos/mesh/signal.proto";
-import "dxos/mesh/teleport/gossip.proto";
 import "dxos/mesh/presence.proto";
+import "dxos/mesh/teleport/gossip.proto";
 import "dxos/value.proto";
-import "dxos/devtools/swarm.proto";
 
 // TODO(burdon): Reorganize packages (e.g., client.services, echo.database).
 
@@ -33,6 +34,7 @@ package dxos.client.services;
 //
 
 enum SystemStatus {
+  // TODO(burdon): INACTIVE SHOULD BE ZERO!
   ACTIVE = 0;
   INACTIVE = 1;
 }
@@ -166,6 +168,7 @@ message Device {
     ONLINE = 1;
     REMOVED = 2;
   }
+
   dxos.keys.PublicKey device_key = 1;
   DeviceKind kind = 2;
   optional halo.credentials.DeviceProfileDocument profile = 3;
@@ -217,41 +220,6 @@ message SpaceMember {
   dxos.halo.credentials.SpaceMember.Role role = 4;
 }
 
-/// Runtime state of the space object.
-enum SpaceState {
-  ///
-  /// Persistent states.
-  ///
-
-  /// Space is inactive. No swarming or replication will be done.
-  INACTIVE = 2;
-
-  /// Space is active. Swarming and replication will be done.
-  ACTIVE = 6;
-
-  ///
-  /// Runtime states:
-  ///
-
-  /// Space is closed.
-  CLOSED = 1;
-
-  /// Data pipeline is inactive.
-  CONTROL_ONLY = 7;
-
-  /// Data pipeline is initializing.
-  INITIALIZING = 4;
-
-  /// Data pipeline is ready.
-  READY = 3;
-
-  /// Space errored.
-  ERROR = 5;
-
-  /// Data migration is required.
-  REQUIRES_MIGRATION = 8;
-}
-
 // TODO(burdon): Rename SpaceInfo?
 message Space {
   message Metrics {
@@ -374,7 +342,7 @@ message CreateEpochRequest {
     /// Replace the current automerge root with a new one specified by the user.
     REPLACE_AUTOMERGE_ROOT = 4;
 
-    /// Upgrade references data strucutre 
+    /// Upgrade references data structure
     MIGRATE_REFERENCES_TO_DXN = 5;
   }
 
@@ -389,6 +357,8 @@ message CreateEpochRequest {
 message CreateEpochResponse {
   /// Credential of the new epoch.
   optional dxos.halo.credentials.Credential epoch_credential = 1;
+  /// Control pipeline timeframe.
+  optional dxos.echo.timeframe.TimeframeVector control_timeframe = 2;
 }
 
 message UpdateMemberRoleRequest {
@@ -442,112 +412,10 @@ service SpacesService {
 // Invitations (Halo and Data Spaces).
 //
 
-/**
- * Represents the invitation state passed between client and service.
- */
-message Invitation {
-  enum Type {
-    /// Requires both to be online to complete key exchange.
-    INTERACTIVE = 0;
-    /// Invitation can be accepted by any valid peer.
-    DELEGATED = 1;
-    /**
-     * Multi-use interactive invitations.
-     * @deprecated use multiUse flag with type=interactive instead.
-     */
-    MULTIUSE = 2;
-  }
-
-  enum Kind {
-    DEVICE = 0;
-    SPACE = 1;
-  }
-
-  enum AuthMethod {
-    /// No authentication is required. Guest should not call `Authenticate`.
-    NONE = 0;
-
-    /// Guest should call `Authenticate` with the shared secret.
-    SHARED_SECRET = 1;
-
-    /// Guest should prove they possess a private key corresponding to the known public key recorded in an invitation.
-    KNOWN_PUBLIC_KEY = 2;
-  }
-
-  enum State {
-    INIT = 0;
-    CONNECTING = 1;
-    CONNECTED = 2;
-    READY_FOR_AUTHENTICATION = 3;
-    AUTHENTICATING = 4;
-    SUCCESS = 5;
-    CANCELLED = 6;
-    TIMEOUT = 7;
-    ERROR = 8;
-    EXPIRED = 9;
-  }
-
-  /// Local identifier (random).
-  string invitation_id = 1;
-
-  /// Determines the behavior of the invitation.
-  Type type = 2;
-
-  /// Kind of access the invitation will grant.
-  Kind kind = 3;
-
-  /// How the invitation is authenticated.
-  AuthMethod auth_method = 4;
-
-  /// Swarm rendezvous (random).
-  dxos.keys.PublicKey swarm_key = 5;
-
-  /// Local state.
-  State state = 6;
-
-  /// Timeout for guest to complete invitation once connected (ms).
-  optional int32 timeout = 7;
-
-  /// Guest's identity.
-  optional dxos.keys.PublicKey identity_key = 8;
-
-  /// Space to join (only present if kind is SPACE).
-  optional dxos.keys.PublicKey space_key = 9;
-
-  /// 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;
-
-  // TODO(nf): should these exist elsewhere since they only have meaning to the host?
-  /// Host should resume invitation on startup until timeout.
-  optional bool persistent = 12;
-
-  optional google.protobuf.Timestamp created = 13;
-
-  /// Number of seconds the host will honor the invitation. 0 means the invitation persists forever.
-  // TODO(nf): some feedback mechanism or GC for immortal invitations?
-  // TODO(nf): should the creator have a way to make an invitation last as long as the client? this was the previous behavior.
-  optional int32 lifetime = 14;
-
-  /// Whether an invitation can be used multiple times.
-  optional bool multi_use = 15;
-
-  /// Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
-  optional AdmissionKeypair guest_keypair = 16;
-
-  /// Present on Type.DELEGATED invitations.
-  optional dxos.keys.PublicKey delegation_credential_id = 17;
-
-  /// Role of the admitted member, defaults to ADMIN.
-  optional dxos.halo.credentials.SpaceMember.Role role = 18;
-}
-
-message AdmissionKeypair {
-  dxos.keys.PublicKey public_key = 1;
-  optional dxos.keys.PrivateKey private_key = 2;
-}
+//message AdmissionKeypair {
+//  dxos.keys.PublicKey public_key = 1;
+//  optional dxos.keys.PrivateKey private_key = 2;
+//}
 
 message AcceptInvitationRequest {
   Invitation invitation = 1;

package/src/proto/dxos/config.proto

@@ -13,7 +13,7 @@ package dxos.config;
 option go_package = "github.com/dxos/kube/proto/def/dxos/config";
 
 extend google.protobuf.FieldOptions {
-    optional string env_var = 1000;
+  optional string env_var = 1000;
 }
 
 message Config {
@@ -103,31 +103,31 @@ message Runtime {
       optional StorageDriver key_store = 2;
       optional StorageDriver data_store = 3;
       optional string data_root = 4;
-      
+
       /**
        * @deprecated
        */
       optional bool space_fragmentation = 5;
     }
-    
+
     message Log {
       optional string filter = 1 [(env_var) = "LOG_FILTER"];
       optional string prefix = 2 [(env_var) = "LOG_PREFIX"];
     }
-    
+
     optional Log log = 1;
     optional Storage storage = 2;
-    
+
     // TODO(burdon): Structure snapshot/epoch related props.
-    
+
     optional bool enable_snapshots = 3;
-    
+
     /// Milliseconds
     optional int32 snapshot_interval = 4;
-    
+
     /// Milliseconds
     optional int32 invitation_expiration = 5;
-    
+
     /// Location of the remote client host.
     // TODO(burdon): Rename vault_endpoint (generalize http/ws; drop vault.html).
     optional string remote_source = 6;
@@ -166,7 +166,7 @@ message Runtime {
       string id = 1;
       optional string name = 2;
       optional bool enabled = 3;
-      optional google.protobuf.Any config = 10; 
+      optional google.protobuf.Any config = 10;
     }
 
     repeated Plugin plugins = 1;

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

@@ -6,9 +6,10 @@ syntax = "proto3";
 
 import "google/protobuf/timestamp.proto";
 
-import "dxos/client/services.proto";
+import "dxos/client/invitation.proto";
 import "dxos/echo/model/document.proto";
 import "dxos/echo/timeframe.proto";
+import "dxos/halo/credentials.proto";
 import "dxos/keys.proto";
 
 package dxos.echo.metadata;
@@ -16,7 +17,7 @@ package dxos.echo.metadata;
 /// Main metadata record.
 message 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.
    */
@@ -31,13 +32,12 @@ message EchoMetadata {
   /// List of the data spaces.
   repeated SpaceMetadata spaces = 11;
 
+  // TODO(burdon): Circular dep.
   repeated dxos.client.services.Invitation invitations = 12;
 }
 
 /// Per-space metadata. Frequent updates. Keep small.
-message SmallSpaceMetadata {
-
-}
+message SmallSpaceMetadata {}
 
 /// Per-space metadata. Infrequent updates.
 message LargeSpaceMetadata {
@@ -54,22 +54,20 @@ message SpaceMetadata {
   /// Space key.
   dxos.keys.PublicKey key = 1;
 
-
   /// ACTIVE, INACTIVE, etc.
-  optional SpaceState state = 10;
+  optional dxos.client.services.SpaceState state = 10;
 
   optional dxos.keys.PublicKey genesis_feed_key = 6;
 
-  /// Key of the wriatable control feed.
+  /// Key of the writable control feed.
   optional dxos.keys.PublicKey control_feed_key = 4;
 
   /// List of all feed associated with the space.
   repeated dxos.keys.PublicKey feed_keys = 2;
 
-  /// Key of the wriatable data feed.
+  /// Key of the writable data feed.
   optional dxos.keys.PublicKey data_feed_key = 3;
 
-
   // Latest control timeframe reached while processing space messages.
   optional timeframe.TimeframeVector control_timeframe = 8;
 
@@ -88,15 +86,13 @@ message ControlPipelineSnapshot {
   /// Timeframe of the last message included in the snapshot.
   timeframe.TimeframeVector timeframe = 1;
 
-
-  repeated ControlMessage messages = 2;  
+  repeated ControlMessage messages = 2;
 }
 
 /// Information needed to bootstrap an Identity.
 message IdentityRecord {
   dxos.keys.PublicKey identity_key = 1;
   dxos.keys.PublicKey device_key = 2;
-
   SpaceMetadata halo_space = 3;
 
   /// Public profile information.
@@ -104,5 +100,5 @@ message IdentityRecord {
   optional SpaceMetadata profile_space = 4;
 
   /// Cached profile.
-  optional ProfileDocument profile = 5;
+  optional dxos.halo.credentials.ProfileDocument profile = 5;
 }

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

@@ -5,7 +5,9 @@
 syntax = "proto3";
 
 import "google/protobuf/any.proto";
+import "google/protobuf/descriptor.proto";
 
+import "dxos/field_options.proto";
 import "dxos/keys.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/echo/timeframe.proto";
@@ -29,7 +31,7 @@ message EchoObject {
     optional string parent_id = 2;
 
     /// Set the model to the provided snapshot.
-    optional google.protobuf.Any model = 10 [preserve_any = true];
+    optional google.protobuf.Any model = 10 [(preserve_any) = true];
   }
 
   message Mutation {
@@ -47,7 +49,7 @@ message EchoObject {
     optional Action action = 11;
 
     // Encoded model mutation, format is defined by model's codec.
-    optional google.protobuf.Any model = 12 [preserve_any = true];
+    optional google.protobuf.Any model = 12 [(preserve_any) = true];
   }
 
   string object_id = 1;

package/src/proto/dxos/echo/service.proto

@@ -93,6 +93,19 @@ message ReIndexHeadsRequest {
   repeated string document_ids = 1;
 }
 
+message GetSpaceSyncStateRequest {
+  string space_id = 1;
+}
+
+message SpaceSyncState {
+  message PeerState {
+    string peer_id = 1;
+    int32 documents_to_reconcile = 2;
+  }
+
+  repeated PeerState peers = 1;
+}
+
 service DataService {
   /**
    * Subscribe to incremental updates of multiple automerge socuments. 
@@ -123,4 +136,7 @@ service DataService {
 
   /// Wait for any pending index updates.
   rpc UpdateIndexes(google.protobuf.Empty) returns (google.protobuf.Empty);
+
+  // TODO(dmaretskyi): Stream subscription.
+  rpc GetSpaceSyncState(GetSpaceSyncStateRequest) returns (SpaceSyncState);
 }