@dxos/protocols 0.1.54 → 0.1.55-main.0618d91

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;AAqDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA2c7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,gzmFAAgzmF,CAAC,CAAC,CAAC;AACz2mF,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;AAsDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAmd7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,irqFAAirqF,CAAC,CAAC,CAAC;AAC1uqF,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.54",
+  "version": "0.1.55-main.0618d91",
   "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.54",
-    "@dxos/hypercore": "0.1.54",
-    "@dxos/keys": "0.1.54",
-    "@dxos/timeframe": "0.1.54"
+    "@dxos/codec-protobuf": "0.1.55-main.0618d91",
+    "@dxos/hypercore": "0.1.55-main.0618d91",
+    "@dxos/keys": "0.1.55-main.0618d91",
+    "@dxos/timeframe": "0.1.55-main.0618d91"
   },
   "devDependencies": {
     "glob": "~7.1.6"

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

@@ -0,0 +1,98 @@
+//
+// 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/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/value.proto";
+
+package dxos.client.services;
+
+//
+// Development Tooling
+//
+
+message Metrics {
+  message KeyPair {
+    optional string key = 1;
+    optional dxos.value.Value value = 2;
+    optional dxos.value.Stats stats = 3;
+  }
+
+  google.protobuf.Timestamp timestamp = 1;
+  repeated KeyPair values = 10;
+}
+
+message ControlMetricsRequest {
+  optional bool reset = 1;
+  optional bool record = 2;
+}
+
+message ControlMetricsResponse {
+  optional bool recording = 1;
+}
+
+message QueryMetricsRequest {
+  optional int32 interval = 1;
+}
+
+// NOTE: Keep aligned with LogLevel in @dxos/log.
+enum LogLevel {
+  TRACE = 5;
+  DEBUG = 10;
+  INFO = 11;
+  WARN = 12;
+  ERROR = 13;
+}
+
+message QueryLogsRequest {
+  enum MatchingOptions {
+    /// Filters match all log levels above. Default behaviour for the logger.
+    INCLUSIVE = 1;
+
+    /// Explicitly specify all desired log levels.
+    EXPLICIT = 2;
+  }
+
+  message Filter {
+    LogLevel level = 1;
+    optional string pattern = 2;
+  }
+
+  repeated Filter filters = 1;
+  optional MatchingOptions options = 10;
+}
+
+message LogEntry {
+  message Meta {
+    string file = 1;
+    int32 line = 2;
+    optional google.protobuf.Struct scope = 3;
+  }
+
+  LogLevel level = 1;
+  string message = 2;
+  optional google.protobuf.Struct context = 3;
+  optional Meta meta = 4;
+  optional dxos.error.Error error = 5;
+  google.protobuf.Timestamp timestamp = 6;
+}
+
+service LoggingService {
+  rpc ControlMetrics(ControlMetricsRequest) returns (ControlMetricsResponse);
+  rpc QueryMetrics(QueryMetricsRequest) returns (stream Metrics);
+  rpc QueryLogs(QueryLogsRequest) returns (stream LogEntry);
+}

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

@@ -4,14 +4,20 @@
 
 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/halo/credentials.proto";
-import "dxos/mesh/teleport/gossip.proto";
-import "dxos/keys.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/value.proto";
 
 // TODO(burdon): Reorganize packages (e.g., client.services, echo.database).
 
@@ -29,11 +35,15 @@ enum SystemStatus {
   INACTIVE = 1;
 }
 
-message UpdateSystemStatusRequest {
+message UpdateStatusRequest {
   SystemStatus status = 1;
 }
 
-message SystemStatusResponse {
+message QueryStatusRequest {
+  optional int32 interval = 1;
+}
+
+message QueryStatusResponse {
   SystemStatus status = 1;
 }
 
@@ -46,10 +56,10 @@ service SystemService {
   rpc GetConfig(google.protobuf.Empty) returns (dxos.config.Config);
 
   /// Update the status of the client. Used to re-activate an inactive client.
-  rpc UpdateStatus(UpdateSystemStatusRequest) returns (google.protobuf.Empty);
+  rpc UpdateStatus(UpdateStatusRequest) returns (google.protobuf.Empty);
 
   /// Stream the status of the client.
-  rpc QueryStatus(google.protobuf.Empty) returns (stream SystemStatusResponse);
+  rpc QueryStatus(QueryStatusRequest) returns (stream QueryStatusResponse);
 
   /// Reset the client.
   rpc Reset(google.protobuf.Empty) returns (google.protobuf.Empty);
@@ -151,12 +161,10 @@ enum SpaceState {
   /// Space is active. Swarming and replication will be done.
   ACTIVE = 6;
 
-
   ///
   /// Runtime states:
   ///
 
-
   /// Space is closed.
   CLOSED = 1;
 
@@ -171,9 +179,9 @@ enum SpaceState {
 
   /// Space errored.
   ERROR = 5;
-  
 }
 
+// TODO(burdon): Rename SpaceInfo?
 message Space {
   message Metrics {
     optional google.protobuf.Timestamp open = 1;
@@ -190,41 +198,43 @@ message Space {
     optional dxos.keys.PublicKey control_feed_key = 1;
     optional dxos.keys.PublicKey data_feed_key = 2;
 
+    /// Remote feeds.
+    /// TODO(burdon): Normalize _key suffix.
     repeated dxos.keys.PublicKey control_feeds = 18;
     repeated dxos.keys.PublicKey data_feeds = 19;
 
     /// Last processed epoch. Might now have been applied yet.
-    optional dxos.halo.Credential current_epoch = 20;
+    optional dxos.halo.credentials.Credential current_epoch = 20;
 
     /// Epoch that is currently applied.
-    optional dxos.halo.Credential applied_epoch = 21;
+    optional dxos.halo.credentials.Credential applied_epoch = 21;
 
     /// Mutations already processed.
-    optional timeframe.TimeframeVector current_control_timeframe = 10;
+    optional dxos.echo.timeframe.TimeframeVector current_control_timeframe = 10;
 
     /// Minimum timeframe to consider the state to be up-to-date.
-    optional timeframe.TimeframeVector target_control_timeframe = 11;
+    optional dxos.echo.timeframe.TimeframeVector target_control_timeframe = 11;
 
     /// All mutations stored in feeds.
-    optional timeframe.TimeframeVector total_control_timeframe = 14;
+    optional dxos.echo.timeframe.TimeframeVector total_control_timeframe = 14;
 
     /// All mutations known to exist on the network.
-    optional timeframe.TimeframeVector known_control_timeframe = 15;
+    optional dxos.echo.timeframe.TimeframeVector known_control_timeframe = 15;
 
     /// Start timeframe of the pipeline.
-    optional timeframe.TimeframeVector start_data_timeframe = 100;
+    optional dxos.echo.timeframe.TimeframeVector start_data_timeframe = 100;
 
     /// Mutations already processed.
-    optional timeframe.TimeframeVector current_data_timeframe = 12;
+    optional dxos.echo.timeframe.TimeframeVector current_data_timeframe = 12;
 
     /// Minimum timeframe to consider the state to be up-to-date.
-    optional timeframe.TimeframeVector target_data_timeframe = 13;
+    optional dxos.echo.timeframe.TimeframeVector target_data_timeframe = 13;
 
     /// All mutations stored in feeds.
-    optional timeframe.TimeframeVector total_data_timeframe = 16;
+    optional dxos.echo.timeframe.TimeframeVector total_data_timeframe = 16;
 
     /// All mutations known to exist on the network.
-    optional timeframe.TimeframeVector known_data_timeframe = 17;
+    optional dxos.echo.timeframe.TimeframeVector known_data_timeframe = 17;
   }
 
   dxos.keys.PublicKey space_key = 1;
@@ -281,7 +291,7 @@ service SpacesService {
   rpc UpdateSpace(UpdateSpaceRequest) returns (google.protobuf.Empty);
   rpc QuerySpaces(google.protobuf.Empty) returns (stream QuerySpacesResponse);
 
-  /// Broadcast an emphemeral message to the space swarm.
+  /// Broadcast an ephemeral message to the space swarm.
   rpc PostMessage(PostMessageRequest) returns (google.protobuf.Empty);
   /// Subscribe to messages from the space swarm.
   rpc SubscribeMessages(SubscribeMessagesRequest) returns (stream dxos.mesh.teleport.gossip.GossipMessage);
@@ -317,7 +327,7 @@ message Invitation {
   }
 
   enum AuthMethod {
-    /// No authnetication is required. Guest should not call `Authenticate`.
+    /// No authentication is required. Guest should not call `Authenticate`.
     NONE = 0;
 
     /// Guest should call `Authenticate` with the shared secret.
@@ -420,6 +430,7 @@ enum ConnectionState {
 message NetworkStatus {
   message Signal {
     string server = 1;
+    // TODO(burdon): Where is this defined?
     dxos.mesh.signal.SignalState state = 2;
   }
 
@@ -436,54 +447,3 @@ service NetworkService {
   rpc UpdateConfig(UpdateConfigRequest) returns (google.protobuf.Empty);
   rpc QueryStatus(google.protobuf.Empty) returns (stream NetworkStatus);
 }
-
-//
-// Development Tooling
-//
-
-// NOTE: Keep aligned with LogLevel in @dxos/log.
-enum LogLevel {
-  TRACE = 5;
-
-  DEBUG = 10;
-  INFO = 11;
-  WARN = 12;
-  ERROR = 13;
-}
-
-message QueryLogsRequest {
-  enum MatchingOptions {
-    /// Filters match all log levels above. Default behaviour for the logger.
-    INCLUSIVE = 1;
-
-    /// Explicitly specify all desired log levels.
-    EXPLICIT = 2;
-  }
-
-  message Filter {
-    LogLevel level = 1;
-    optional string pattern = 2;
-  }
-
-  repeated Filter filters = 1;
-  optional MatchingOptions options = 10;
-}
-
-message LogEntry {
-  message Meta {
-    string file = 1;
-    int32 line = 2;
-    optional google.protobuf.Struct scope = 3;
-  }
-
-  LogLevel level = 1;
-  string message = 2;
-  optional google.protobuf.Struct context = 3;
-  optional Meta meta = 4;
-  optional Error error = 5;
-  google.protobuf.Timestamp timestamp = 6;
-}
-
-service LoggingService {
-  rpc QueryLogs(QueryLogsRequest) returns (stream LogEntry);
-}

package/src/proto/dxos/config.proto

@@ -129,6 +129,7 @@ message Runtime {
       optional string commit_hash = 2;
       /// Version from package.json.
       optional string version = 3;
+      optional string branch = 4;
     }
 
     optional string org = 1;

package/src/proto/dxos/devtools/swarm.proto

@@ -22,6 +22,7 @@ message ConnectionInfo {
     string tag = 2;
     uint32 bytesSent = 3;
     uint32 bytesReceived = 4;
+    optional string contentType = 5;
   }
 
   string state = 1;

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

@@ -6,6 +6,7 @@ syntax = "proto3";
 
 import "google/protobuf/any.proto";
 
+import "dxos/keys.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/echo/timeframe.proto";
 
@@ -23,12 +24,12 @@ message EchoObject {
 
   message Snapshot {
     // TODO(dmaretskyi): Change to enum?
-    optional bool deleted = 1; 
+    optional bool deleted = 1;
 
     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 {
@@ -42,7 +43,7 @@ message EchoObject {
 
     /// Set parent id
     optional string parent_id = 10;
-    
+
     optional Action action = 11;
 
     // Encoded model mutation, format is defined by model's codec.
@@ -54,11 +55,11 @@ message EchoObject {
   /// Metadata for the genesis mutation.
   optional MutationMeta meta = 2;
 
-  /// Present in mutations creating new items and snapshots. 
+  /// Present in mutations creating new items and snapshots.
   optional Genesis genesis = 10;
 
   optional Snapshot snapshot = 13;
-  
+
   /// May be present in snapshots. In that case the mutations must be applied on top of the snapshot.
   repeated Mutation mutations = 14;
 }
@@ -76,4 +77,4 @@ message MutationMeta {
 
 message EchoObjectBatch {
   repeated EchoObject objects = 1;
-}
+}

package/src/proto/dxos/halo/credentials.proto

@@ -6,14 +6,14 @@ syntax = "proto3";
 
 package dxos.halo.credentials;
 
+option go_package = "github.com/dxos/kube/proto/def/dxos/halo/credentials";
+
 import "google/protobuf/any.proto";
 import "google/protobuf/timestamp.proto";
 
 import "dxos/echo/timeframe.proto";
 import "dxos/keys.proto";
 
-option go_package = "github.com/dxos/kube/proto/def/dxos/halo/credentials";
-
 //
 // TODO(burdon): Reference/extract these notes to the design doc commentary.
 // Peers maintain Feeds that are admitted to HALO and ECHO Spaces.
@@ -86,6 +86,7 @@ message AdmittedFeed {
 
   /// Owning identity.
   dxos.keys.PublicKey identity_key = 2; // Could be derived.
+
   /// Owning device.
   dxos.keys.PublicKey device_key = 3;
 

package/src/proto/dxos/value.proto

@@ -0,0 +1,23 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+package dxos.value;
+
+message Value {
+  optional bool bool = 1;
+  optional string string = 2;
+  optional int32 int = 3;
+  optional float float = 4;
+}
+
+message Stats {
+  optional float min = 1;
+  optional float max = 2;
+  optional float mean = 3;
+  optional float median = 4;
+  optional float total = 5;
+  optional float count = 6;
+}

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

@@ -48,6 +48,7 @@ import * as dxos_service_publisher from "../service/publisher";
 import * as dxos_service_supervisor from "../service/supervisor";
 import * as dxos_service_tunnel from "../service/tunnel";
 import * as dxos_type from "../type";
+import * as dxos_value from "../value";
 import * as example_testing_data from "../../example/testing/data";
 import * as example_testing_rpc from "../../example/testing/rpc";
 import * as google_protobuf from "../../google/protobuf";

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

@@ -48,6 +48,7 @@ import * as dxos_service_publisher from "./service/publisher";
 import * as dxos_service_supervisor from "./service/supervisor";
 import * as dxos_service_tunnel from "./service/tunnel";
 import * as dxos_type from "./type";
+import * as dxos_value from "./value";
 import * as example_testing_data from "../example/testing/data";
 import * as example_testing_rpc from "../example/testing/rpc";
 import * as google_protobuf from "../google/protobuf";