@dxos/protocols 0.3.5-main.f910495 → 0.3.5-main.fa2fc5b

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;AA2DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAggB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,6/6FAA6/6F,CAAC,CAAC,CAAC;AACtj7F,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;AA4DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAkgB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,kx9FAAkx9F,CAAC,CAAC,CAAC;AAC309F,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

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

@@ -0,0 +1,5 @@
+/**
+ * Channel name that will be used to query spaces from agent.
+ */
+export declare const QUERY_CHANNEL = "dxos.org/agent/plugin/query";
+//# sourceMappingURL=query.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/query.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,aAAa,gCAAgC,CAAC"}

package/dist/esm/src/query.js

@@ -0,0 +1,8 @@
+//
+// Copyright 2023 DXOS.org
+//
+/**
+ * Channel name that will be used to query spaces from agent.
+ */
+export const QUERY_CHANNEL = 'dxos.org/agent/plugin/query';
+//# sourceMappingURL=query.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/query.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,6BAA6B,CAAC"}

package/package.json

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

package/src/index.ts

@@ -8,3 +8,4 @@ export * from './storage';
 export * from './testing';
 export * from './tracing';
 export * from './types';
+export * from './query';

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

@@ -0,0 +1,30 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+syntax = "proto3";
+
+import "dxos/echo/filter.proto";
+import "dxos/keys.proto";
+import "dxos/echo/object.proto";
+
+package dxos.agent.query;
+
+
+message QueryRequest {
+  string queryId = 1;
+  filter.Filter filter = 2;
+}
+
+message QueryResult {
+  string id = 1;
+  keys.PublicKey spaceKey = 2;
+  float rank = 3;
+}
+
+message QueryResponse {
+  string queryId = 1;
+  repeated QueryResult results = 2;
+  repeated object.EchoObject objects = 3;
+}
+

package/src/proto/dxos/echo/filter.proto

@@ -0,0 +1,65 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+
+import "dxos/keys.proto";
+import "dxos/echo/model/document.proto";
+
+package dxos.echo.filter;
+
+message QueryOptions {
+  enum ShowDeletedOption {
+    /// Do not return deleted items. Default behaviour.
+    HIDE_DELETED = 0;
+
+    /// Return deleted and regular items.
+    SHOW_DELETED = 1;
+
+    /// Return only deleted items.
+    SHOW_DELETED_ONLY = 2;
+  }
+
+  /// Controls how deleted items are filtered.
+  optional ShowDeletedOption deleted = 1;
+
+  /**
+   * Filter by model.
+   * @default * Only DocumentModel.
+   * To querty all models, use `models: ["*"]`.
+   */
+  repeated string models = 2;
+
+  /**
+   * Query only in specific spaces.
+   */
+  repeated dxos.keys.PublicKey spaces = 3;
+
+  enum DataLocation {
+    ALL = 0;
+    LOCAL = 1;
+    REMOTE = 2;
+  }
+
+  /**
+    * Query only local spaces, or remote on agent.
+    * @default `QueryOptions.DataLocation.LOCAL`
+    */
+  optional DataLocation data_location = 4;
+}
+
+/**
+ * Protocol for ephemeral Filter serialization.
+ */
+message Filter {
+  optional google.protobuf.Struct properties = 1;
+  optional dxos.echo.model.document.Reference type = 2;
+  optional string text = 3;
+  optional bool not = 4;
+  repeated Filter and = 5; 
+  repeated Filter or = 6;
+  optional QueryOptions options = 7; 
+}

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

@@ -3,7 +3,7 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_echoproxy from "./echoproxy";
 import * as dxos_agent_epoch from "./epoch";
 import * as dxos_agent_functions from "./functions";
-import * as dxos_agent_search from "./search";
+import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -11,6 +11,7 @@ import * as dxos_devtools_host from "../devtools/host";
 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_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

@@ -3,7 +3,7 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_dashboard from "./dashboard";
 import * as dxos_agent_epoch from "./epoch";
 import * as dxos_agent_functions from "./functions";
-import * as dxos_agent_search from "./search";
+import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -11,6 +11,7 @@ import * as dxos_devtools_host from "../devtools/host";
 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_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

@@ -3,7 +3,7 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_dashboard from "./dashboard";
 import * as dxos_agent_echoproxy from "./echoproxy";
 import * as dxos_agent_functions from "./functions";
-import * as dxos_agent_search from "./search";
+import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -11,6 +11,7 @@ import * as dxos_devtools_host from "../devtools/host";
 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_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

@@ -3,7 +3,7 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_dashboard from "./dashboard";
 import * as dxos_agent_echoproxy from "./echoproxy";
 import * as dxos_agent_epoch from "./epoch";
-import * as dxos_agent_search from "./search";
+import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -11,6 +11,7 @@ import * as dxos_devtools_host from "../devtools/host";
 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_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/{search.ts → query.ts}

@@ -11,6 +11,7 @@ import * as dxos_devtools_host from "../devtools/host";
 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_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,47 +60,27 @@ import * as example_testing_rpc from "../../example/testing/rpc";
 import * as google_protobuf from "../../google/protobuf";
 /**
  * Defined in:
- *   {@link file://./../../../dxos/agent/search.proto}
+ *   {@link file://./../../../dxos/agent/query.proto}
  */
-export interface SearchRequest {
-    query: string;
-    type: SearchRequest.Type;
-}
-export namespace SearchRequest {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/agent/search.proto}
-     */
-    export enum Type {
-        EXACT = 0,
-        FUZZY = 1
-    }
+export interface QueryRequest {
+    queryId: string;
+    filter: dxos_echo_filter.Filter;
 }
 /**
  * Defined in:
- *   {@link file://./../../../dxos/agent/search.proto}
+ *   {@link file://./../../../dxos/agent/query.proto}
  */
-export interface SearchResponse {
-    results?: SearchResponse.Result[];
+export interface QueryResult {
+    id: string;
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    rank: number;
 }
-export namespace SearchResponse {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/agent/search.proto}
-     */
-    export interface Result {
-        spaceKey: string;
-        objectId: string;
-        score: number;
-        matches?: SearchResponse.Result.Match[];
-    }
-    export namespace Result {
-        /**
-         * Defined in:
-         *   {@link file://./../../../dxos/agent/search.proto}
-         */
-        export interface Match {
-            term: string;
-        }
-    }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/agent/query.proto}
+ */
+export interface QueryResponse {
+    queryId: string;
+    results?: QueryResult[];
+    objects?: dxos_echo_object.EchoObject[];
 }

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

@@ -4,13 +4,14 @@ import * as dxos_agent_dashboard from "./agent/dashboard";
 import * as dxos_agent_echoproxy from "./agent/echoproxy";
 import * as dxos_agent_epoch from "./agent/epoch";
 import * as dxos_agent_functions from "./agent/functions";
-import * as dxos_agent_search from "./agent/search";
+import * as dxos_agent_query from "./agent/query";
 import * as dxos_client_services from "./client/services";
 import * as dxos_config from "./config";
 import * as dxos_devtools_host from "./devtools/host";
 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_metadata from "./echo/metadata";
 import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";