@dxos/protocols 0.1.58-main.f5feb2a → 0.1.58-main.f69fa2f

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;AAuDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA+e7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,qm0FAAqm0F,CAAC,CAAC,CAAC;AAC9p0F,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;AAuDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAgf7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,6s2FAA6s2F,CAAC,CAAC,CAAC;AACtw2F,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/dist/esm/src/storage.d.ts

@@ -1,7 +1,6 @@
 /**
  * Version for the schema of the stored data as defined in dxos.echo.metadata.EchoMetadata.
- *
- * Should be incremented every time there's a breaking change to the stored data.
+ * update when making breaking changes to the protocols or other stored data.
  */
-export declare const STORAGE_VERSION = 1;
+export declare const STORAGE_VERSION = 2;
 //# sourceMappingURL=storage.d.ts.map

package/dist/esm/src/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC"}

package/dist/esm/src/storage.js

@@ -3,8 +3,7 @@
 //
 /**
  * Version for the schema of the stored data as defined in dxos.echo.metadata.EchoMetadata.
- *
- * Should be incremented every time there's a breaking change to the stored data.
+ * update when making breaking changes to the protocols or other stored data.
  */
-export const STORAGE_VERSION = 1;
+export const STORAGE_VERSION = 2;
 //# sourceMappingURL=storage.js.map

package/dist/esm/src/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC"}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.1.58-main.f5feb2a",
+  "version": "0.1.58-main.f69fa2f",
   "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.58-main.f5feb2a",
-    "@dxos/invariant": "0.1.58-main.f5feb2a",
-    "@dxos/keys": "0.1.58-main.f5feb2a",
-    "@dxos/timeframe": "0.1.58-main.f5feb2a"
+    "@dxos/codec-protobuf": "0.1.58-main.f69fa2f",
+    "@dxos/invariant": "0.1.58-main.f69fa2f",
+    "@dxos/keys": "0.1.58-main.f69fa2f",
+    "@dxos/timeframe": "0.1.58-main.f69fa2f"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/errors/encoding.ts

@@ -2,8 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
 import { reconstructError } from './helpers';
+import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
 
 export const encodeError = (err: any): SerializedErrorProto => {
   if (typeof err === 'object' && err?.message) {

package/src/errors/errors.ts

@@ -121,14 +121,14 @@ export class TimeoutError extends BaseError {
   }
 }
 
-// General protocol error
+// General protocol error.
 export class ProtocolError extends BaseError {
   constructor(message?: string, context?: any) {
     super('PROTOCOL_ERROR', message, context);
   }
 }
 
-// General connectivity errors
+// General connectivity errors.
 export class ConnectivityError extends BaseError {
   constructor(message?: string, context?: any) {
     super('CONNECTIVITY_ERROR', message, context);

package/src/errors/helpers.ts

@@ -5,7 +5,6 @@
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 
-import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
 import {
   CancelledError,
   ConnectionResetError,
@@ -28,6 +27,7 @@ import {
   UnknownModelError,
   UnknownProtocolError,
 } from './errors';
+import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
 
 export const reconstructError = (error: SerializedErrorProto) => {
   const { name, message, context } = error;

package/src/index.ts

@@ -2,9 +2,9 @@
 // Copyright 2021 DXOS.org
 //
 
+export * from './errors';
 export * from './proto';
 export * from './storage';
 export * from './testing';
-export * from './types';
 export * from './tracing';
-export * from './errors';
+export * from './types';

package/src/proto/dxos/config.proto

@@ -45,6 +45,9 @@ message Repo {
   optional string version = 3;
 }
 
+//
+// Unit of deployment.
+//
 message Module {
   message Build {
     optional string command = 1;
@@ -55,22 +58,23 @@ message Module {
     optional google.protobuf.Struct env = 10;
   }
 
-  optional string name = 1;   // TODO(burdon): Replace with id (or key?)
   optional string id = 8;     // TODO(burdon): Ensured FQ (e.g., 'dxos.app.xxx')
-  optional string type = 2;   // TODO(burdon): Define namespace (e.g., 'dxos:type/frame' vs. 'dxos.type.frame')
+  optional string name = 1;   // TODO(burdon): Replace with id (or key?)
+  optional string type = 2;   // TODO(burdon): Define namespace (e.g., 'dxos.org/type/frame' vs. 'dxos.type.frame')
 
   // TODO(burdon): Developer info message.
 
+  // TODO(burdon): Start at 10.
   optional string display_name = 3;
   optional string description = 4;
   repeated string tags = 5;
-  optional bytes bundle = 6;
+  optional bytes bundle = 6; // TODO(burdon): ???
 
   // TODO(burdon): Remove.
   optional bool tunnel = 7;
 
+  // TODO(burdon): Start at 100.
   repeated Module deps = 10;  // TODO(burdon): E.g., types.
-
   optional Build build = 100;
   repeated Repo repos = 101;
 
@@ -90,15 +94,15 @@ message Runtime {
         NODE = 4;
         WEBFS = 5;
 
-        // Key storage only
+        // Key storage only.
         LEVELJS = 11;
         JSONDOWN = 12;
       }
 
-      optional bool persistent = 1;               // TODO(burdon): Replace with type.
-      optional StorageDriver key_storage = 3;     // TODO(burdon): Rename key_store.
-      optional StorageDriver storage_type = 2;    // TODO(burdon): Rename data_store.
-      optional string path = 4;                   // TODO(burdon): Rename data_path.
+      optional bool persistent = 1;
+      optional StorageDriver key_store = 2;
+      optional StorageDriver data_store = 3;
+      optional string data_root = 4;
     }
 
     message Log {
@@ -152,7 +156,25 @@ message Runtime {
         int32 port = 1;
       }
 
+      /// Automatic epoch creation.
+      message EpochMontior {
+        optional bool enabled = 5;
+
+        /// Number of mutations required since last epoch to trigger a new epoch.
+        optional int32 minMessagesBetweenEpochs = 1;
+
+        /// Amount of time (in milliseconds) required to pass since last epoch to trigger a new epoch.
+        optional int32 minTimeBetweenEpochs = 2;
+
+        /// Amount of time (in milliseconds) required to pass since last mutation to trigger a new epoch.
+        optional int32 minInactivityBeforeEpoch = 3;
+
+        /// Maximum amount of time (in milliseconds) to wait for an inactivity period before triggering a new epoch.
+        optional int32 maxInactivityDelay = 4;
+      }
+
       optional Functions functions = 1;
+      optional EpochMontior epoch_monitor = 2;
     }
 
     optional Plugins plugins = 1;

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

@@ -117,12 +117,12 @@ export interface Module {
      * Options:
      *   - proto3_optional = true
      */
-    name?: string;
+    id?: string;
     /**
      * Options:
      *   - proto3_optional = true
      */
-    id?: string;
+    name?: string;
     /**
      * Options:
      *   - proto3_optional = true
@@ -307,17 +307,17 @@ export namespace Runtime {
              * Options:
              *   - proto3_optional = true
              */
-            keyStorage?: Runtime.Client.Storage.StorageDriver;
+            keyStore?: Runtime.Client.Storage.StorageDriver;
             /**
              * Options:
              *   - proto3_optional = true
              */
-            storageType?: Runtime.Client.Storage.StorageDriver;
+            dataStore?: Runtime.Client.Storage.StorageDriver;
             /**
              * Options:
              *   - proto3_optional = true
              */
-            path?: string;
+            dataRoot?: string;
         }
         export namespace Storage {
             /**
@@ -445,6 +445,11 @@ export namespace Runtime {
              *   - proto3_optional = true
              */
             functions?: Runtime.Agent.Plugins.Functions;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            epochMonitor?: Runtime.Agent.Plugins.EpochMontior;
         }
         export namespace Plugins {
             /**
@@ -454,6 +459,47 @@ export namespace Runtime {
             export interface Functions {
                 port: number;
             }
+            /**
+             * Automatic epoch creation.
+             *
+             * Defined in:
+             *   {@link file://./../../dxos/config.proto}
+             */
+            export interface EpochMontior {
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                enabled?: boolean;
+                /**
+                 * Number of mutations required since last epoch to trigger a new epoch.
+                 *
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                minMessagesBetweenEpochs?: number;
+                /**
+                 * Amount of time (in milliseconds) required to pass since last epoch to trigger a new epoch.
+                 *
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                minTimeBetweenEpochs?: number;
+                /**
+                 * Amount of time (in milliseconds) required to pass since last mutation to trigger a new epoch.
+                 *
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                minInactivityBeforeEpoch?: number;
+                /**
+                 * Maximum amount of time (in milliseconds) to wait for an inactivity period before triggering a new epoch.
+                 *
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                maxInactivityDelay?: number;
+            }
         }
     }
     /**