@voltro/plugin-search 0.1.0

package/dist/rpc.js

@@ -0,0 +1,56 @@
+import { Schema as e } from "effect";
+import { defineAction as t } from "@voltro/protocol";
+//#region src/rpc.ts
+var n = e.Union(e.String, e.Number, e.Boolean), r = e.Struct({
+	field: e.String,
+	op: e.Literal("eq", "neq", "gt", "gte", "lt", "lte", "in", "nin"),
+	value: e.Union(n, e.Array(n))
+}), i = e.Struct({
+	fields: e.optional(e.Array(e.String)),
+	preTag: e.optional(e.String),
+	postTag: e.optional(e.String)
+}), a = e.Struct({
+	doc: e.Record({
+		key: e.String,
+		value: e.Unknown
+	}),
+	highlights: e.optional(e.Record({
+		key: e.String,
+		value: e.String
+	}))
+}), o = t({
+	name: "search.query",
+	input: e.Struct({
+		index: e.String,
+		q: e.String,
+		limit: e.optional(e.Number),
+		offset: e.optional(e.Number),
+		filters: e.optional(e.Array(r)),
+		facets: e.optional(e.Array(e.String)),
+		highlight: e.optional(i),
+		fuzziness: e.optional(e.Union(e.Number, e.Literal("auto"))),
+		engineParams: e.optional(e.Record({
+			key: e.String,
+			value: e.Unknown
+		}))
+	}),
+	output: e.Struct({
+		hits: e.Array(a),
+		facets: e.Record({
+			key: e.String,
+			value: e.Record({
+				key: e.String,
+				value: e.Number
+			})
+		})
+	})
+}), s = [{
+	tag: "search.query",
+	kind: "action",
+	import: {
+		module: "@voltro/plugin-search/rpc",
+		name: "queryDescriptor"
+	}
+}];
+//#endregion
+export { r as SearchFilterSchema, o as queryDescriptor, s as searchRpcClientImports };

package/dist/web.d.ts

@@ -0,0 +1,52 @@
+/** One clause on the wire — equality/negation/range/set membership. */
+export declare interface SearchFilterInput {
+    readonly field: string;
+    readonly op: 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin';
+    readonly value: string | number | boolean | ReadonlyArray<string | number | boolean>;
+}
+
+export declare interface SearchHitOut<Doc> {
+    readonly doc: Doc;
+    readonly highlights?: Record<string, string>;
+}
+
+export declare interface SearchOptions {
+    readonly limit?: number;
+    readonly offset?: number;
+    /** Clauses ANDed together — equality, range, negation, set. */
+    readonly filters?: ReadonlyArray<SearchFilterInput>;
+    /** Facet-count fields (returned in `facets`). */
+    readonly facets?: ReadonlyArray<string>;
+    /** Matched-term highlighting (returned per-hit). */
+    readonly highlight?: {
+        readonly fields?: ReadonlyArray<string>;
+        readonly preTag?: string;
+        readonly postTag?: string;
+    };
+    /** Typo tolerance — a max edit distance (0 = exact) or `'auto'`. */
+    readonly fuzziness?: number | 'auto';
+    /** Escape hatch — forwarded verbatim to the underlying engine. */
+    readonly engineParams?: Record<string, unknown>;
+}
+
+export declare interface SearchResultOut<Doc> {
+    readonly hits: ReadonlyArray<SearchHitOut<Doc>>;
+    readonly facets: Record<string, Record<string, number>>;
+}
+
+export declare interface UseSearch<Doc> {
+    readonly run: (q: string, opts?: SearchOptions) => Promise<SearchResultOut<Doc>>;
+    /** Hit documents from the last run (unwrapped for the common list case). */
+    readonly results: ReadonlyArray<Doc>;
+    /** Facet counts from the last run. */
+    readonly facets: Record<string, Record<string, number>>;
+    readonly pending: boolean;
+    readonly error: unknown;
+}
+
+/** Imperative search hook bound to an index. Calls the `search.query` action;
+ *  tenant scoping is applied server-side. Pass `opts` for paging, filters,
+ *  facets, highlighting, fuzziness, and engine-param passthrough. */
+export declare const useSearch: <Doc = Record<string, unknown>>(index: string, apiName?: string) => UseSearch<Doc>;
+
+export { }

package/dist/web.js

@@ -0,0 +1,18 @@
+import { useAction as e } from "@voltro/client";
+//#region src/web.ts
+var t = (t, n = "app") => {
+	let r = e(n, "search.query"), i = r.lastResult;
+	return {
+		run: (e, n) => r.run({
+			index: t,
+			q: e,
+			...n ?? {}
+		}),
+		results: (i?.hits ?? []).map((e) => e.doc),
+		facets: i?.facets ?? {},
+		pending: r.pending,
+		error: r.error
+	};
+};
+//#endregion
+export { t as useSearch };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@voltro/plugin-search",
+  "version": "0.1.0",
+  "description": "Keep an external search index (Typesense / Meilisearch / Algolia) in sync with framework tables via the post-commit ChangeEvent tap, then query it — tenant-scoped, with a backfill path and a useSearch() hook.",
+  "keywords": [
+    "voltro",
+    "typescript",
+    "framework"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://voltro.dev",
+  "bugs": {
+    "email": "support@voltro.dev"
+  },
+  "author": {
+    "name": "Voltro UG",
+    "url": "https://voltro.dev"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./web": {
+      "types": "./dist/web.d.ts",
+      "import": "./dist/web.js",
+      "default": "./dist/web.js"
+    },
+    "./rpc": {
+      "types": "./dist/rpc.d.ts",
+      "import": "./dist/rpc.js",
+      "default": "./dist/rpc.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "@voltro/client": "0.1.0",
+    "@voltro/database": "0.1.0",
+    "@voltro/protocol": "0.1.0"
+  },
+  "optionalDependencies": {
+    "algoliasearch": "^5.55.2",
+    "meilisearch": "^0.59.0",
+    "typesense": "^3.0.6"
+  },
+  "peerDependencies": {
+    "effect": "^3.21.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}