@dxos/protocols 0.4.8-main.c1d1c78 → 0.4.8-main.c2effdb

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;AAwhB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,qnpGAAqnpG,CAAC,CAAC,CAAC;AAC9qpG,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;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA4hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,y1qGAAy1qG,CAAC,CAAC,CAAC;AACl5qG,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.4.8-main.c1d1c78",
+  "version": "0.4.8-main.c2effdb",
   "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.4.8-main.c1d1c78",
-    "@dxos/invariant": "0.4.8-main.c1d1c78",
-    "@dxos/timeframe": "0.4.8-main.c1d1c78",
-    "@dxos/keys": "0.4.8-main.c1d1c78"
+    "@dxos/invariant": "0.4.8-main.c2effdb",
+    "@dxos/codec-protobuf": "0.4.8-main.c2effdb",
+    "@dxos/keys": "0.4.8-main.c2effdb",
+    "@dxos/timeframe": "0.4.8-main.c2effdb"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/indexing.ts

@@ -2,9 +2,14 @@
 // Copyright 2024 DXOS.org
 //
 
+export type IdDecoded = {
+  documentId: string;
+  objectId: string;
+};
+
 export const idCodec = {
-  encode: ({ documentId, objectId }: { documentId: string; objectId: string }) => `${documentId}|${objectId}`,
-  decode: (id: string) => {
+  encode: ({ documentId, objectId }: IdDecoded) => `${documentId}|${objectId}`,
+  decode: (id: string): IdDecoded => {
     const [documentId, objectId] = id.split('|');
     return { documentId, objectId };
   },

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

@@ -26,4 +26,3 @@ message QueryResponse {
   repeated QueryResult results = 2;
   repeated object.EchoObject objects = 3;
 }
-

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

@@ -10,6 +10,8 @@ import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
 import "dxos/config.proto";
+import "dxos/agent/query.proto";
+import "dxos/echo/indexing.proto";
 import "dxos/echo/metadata.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/error.proto";
@@ -379,6 +381,15 @@ service SpacesService {
   rpc CreateEpoch(CreateEpochRequest) returns (google.protobuf.Empty);
 }
 
+//
+// Indexing
+//
+
+service IndexService {
+  rpc SetConfig(dxos.echo.indexing.IndexConfig) returns (google.protobuf.Empty);
+  rpc Find(dxos.agent.query.QueryRequest) returns (dxos.agent.query.QueryResponse);
+}
+
 //
 // Invitations (Halo and Data Spaces).
 //

package/src/proto/dxos/config.proto

@@ -105,31 +105,34 @@ message Runtime {
       optional string data_root = 4;
       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;
-
+    
     /// Connect to and serve client services to a remote proxy.
     optional string devtools_proxy = 7;
+
+    /// Enable E.object api
+    optional bool use_reactive_object_api = 8;
   }
 
   message App {

package/src/proto/dxos/echo/indexing.proto

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+syntax = "proto3";
+
+package dxos.echo.indexing;
+
+message IndexKind {
+  enum Kind {
+    SCHEMA_MATCH = 0;
+    FIELD_MATCH = 1;
+    FULL_TEXT = 2;
+  }
+  
+  Kind kind = 1;
+  optional string field = 2;
+}
+
+message IndexConfig {
+  repeated IndexKind indexes = 1;
+}

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_blob from "./echo/blob";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_filter from "./echo/filter";
+import * as dxos_echo_indexing from "./echo/indexing";
 import * as dxos_echo_metadata from "./echo/metadata";
 import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
@@ -59,181 +60,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, options?: RequestOptions) => Promise<ControlMetricsResponse>;
-    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
-    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -832,6 +658,14 @@ export interface SpacesService {
     queryCredentials: (request: QueryCredentialsRequest, options?: RequestOptions) => Stream<dxos_halo_credentials.Credential>;
     createEpoch: (request: CreateEpochRequest, options?: RequestOptions) => Promise<void>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface IndexService {
+    setConfig: (request: dxos_echo_indexing.IndexConfig, options?: RequestOptions) => Promise<void>;
+    find: (request: dxos_agent_query.QueryRequest, options?: RequestOptions) => Promise<dxos_agent_query.QueryResponse>;
+}
 /**
  * Represents the invitation state passed between client and service.
  *
@@ -1089,3 +923,178 @@ export interface NetworkService {
     updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
     queryStatus: (request: void, options?: RequestOptions) => 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, options?: RequestOptions) => Promise<ControlMetricsResponse>;
+    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
+    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
+}

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_blob from "./echo/blob";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_filter from "./echo/filter";
+import * as dxos_echo_indexing from "./echo/indexing";
 import * as dxos_echo_metadata from "./echo/metadata";
 import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";
@@ -297,6 +298,13 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         devtoolsProxy?: string;
+        /**
+         * Enable E.object api
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        useReactiveObjectApi?: boolean;
     }
     export namespace Client {
         /**

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "./swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
@@ -59,6 +60,37 @@ 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}
@@ -481,34 +513,3 @@ 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;
-}