@dxos/protocols 0.1.58-main.fa022ee → 0.1.58-main.fc3ea9b

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;AA+e7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,gn0FAAgn0F,CAAC,CAAC,CAAC;AACzq0F,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.fa022ee",
+  "version": "0.1.58-main.fc3ea9b",
   "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.fa022ee",
-    "@dxos/invariant": "0.1.58-main.fa022ee",
-    "@dxos/keys": "0.1.58-main.fa022ee",
-    "@dxos/timeframe": "0.1.58-main.fa022ee"
+    "@dxos/codec-protobuf": "0.1.58-main.fc3ea9b",
+    "@dxos/invariant": "0.1.58-main.fc3ea9b",
+    "@dxos/keys": "0.1.58-main.fc3ea9b",
+    "@dxos/timeframe": "0.1.58-main.fc3ea9b"
   },
   "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

@@ -11,7 +11,11 @@ import type { ItemID } from '../types';
  * Errors can optionally include a JSON context object.
  */
 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).
@@ -121,14 +125,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 {

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

@@ -53,181 +53,6 @@ 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";
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface Metrics {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    values?: Metrics.KeyPair[];
-}
-export namespace Metrics {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface KeyPair {
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        key?: string;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        value?: dxos_value.Value;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        stats?: dxos_value.Stats;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    reset?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    record?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsResponse {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    recording?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    interval?: number;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsResponse {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    metrics: Metrics;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export enum LogLevel {
-    TRACE = 5,
-    DEBUG = 10,
-    INFO = 11,
-    WARN = 12,
-    ERROR = 13
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryLogsRequest {
-    filters?: QueryLogsRequest.Filter[];
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    options?: QueryLogsRequest.MatchingOptions;
-}
-export namespace QueryLogsRequest {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export enum MatchingOptions {
-        INCLUSIVE = 1,
-        EXPLICIT = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Filter {
-        level: LogLevel;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        pattern?: string;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LogEntry {
-    level: LogLevel;
-    message: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    meta?: LogEntry.Meta;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    error?: dxos_error.Error;
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-}
-export namespace LogEntry {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Meta {
-        file: string;
-        line: number;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        resourceId?: number;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LoggingService {
-    controlMetrics: (request: ControlMetricsRequest) => Promise<ControlMetricsResponse>;
-    queryMetrics: (request: QueryMetricsRequest) => Stream<QueryMetricsResponse>;
-    queryLogs: (request: QueryLogsRequest) => Stream<LogEntry>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -922,3 +747,178 @@ export interface NetworkService {
     updateConfig: (request: UpdateConfigRequest) => Promise<void>;
     queryStatus: (request: void) => Stream<NetworkStatus>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface Metrics {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    values?: Metrics.KeyPair[];
+}
+export namespace Metrics {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface KeyPair {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        key?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        value?: dxos_value.Value;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        stats?: dxos_value.Stats;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    reset?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    record?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    recording?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    interval?: number;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsResponse {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    metrics: Metrics;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export enum LogLevel {
+    TRACE = 5,
+    DEBUG = 10,
+    INFO = 11,
+    WARN = 12,
+    ERROR = 13
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryLogsRequest {
+    filters?: QueryLogsRequest.Filter[];
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    options?: QueryLogsRequest.MatchingOptions;
+}
+export namespace QueryLogsRequest {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export enum MatchingOptions {
+        INCLUSIVE = 1,
+        EXPLICIT = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Filter {
+        level: LogLevel;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        pattern?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    meta?: LogEntry.Meta;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: dxos_error.Error;
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+}
+export namespace LogEntry {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Meta {
+        file: string;
+        line: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        resourceId?: number;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LoggingService {
+    controlMetrics: (request: ControlMetricsRequest) => Promise<ControlMetricsResponse>;
+    queryMetrics: (request: QueryMetricsRequest) => Stream<QueryMetricsResponse>;
+    queryLogs: (request: QueryLogsRequest) => Stream<LogEntry>;
+}

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 {
             /**

package/src/proto/gen/dxos/devtools/host.ts

@@ -53,37 +53,6 @@ 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";
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface Services {
-    spaces?: SpaceStats[];
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface SpaceStats {
-    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    peers?: PeerStats[];
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface PeerStats {
-    controlFeed: FeedStats;
-    dataFeed: FeedStats;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface FeedStats {
-    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    length: number;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/devtools/host.proto}
@@ -506,3 +475,34 @@ export interface SubscribeToSwarmInfoRequest {
 export interface SubscribeToSwarmInfoResponse {
     data?: dxos_devtools_swarm.SwarmInfo[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface Services {
+    spaces?: SpaceStats[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface SpaceStats {
+    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    peers?: PeerStats[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface PeerStats {
+    controlFeed: FeedStats;
+    dataFeed: FeedStats;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface FeedStats {
+    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    length: number;
+}