@dbx-tools/shared-search 0.6.9

package/README.md

@@ -0,0 +1,72 @@
+# @dbx-tools/shared-search
+
+Browser-safe AI Search (Databricks Vector Search) schemas and inferred types.
+
+Import this package when a UI, Mastra tool schema, server route, or test needs
+to validate the same search payloads that
+[`@dbx-tools/search`](../../node/search) reads and writes.
+
+Key features:
+
+- Shared `SearchRequest` / `SearchResult` contract with `{ id, score, fields }`
+  hits, so an autocomplete box, a docs lookup, and a Mastra tool speak one shape.
+- `SearchMode` (`hybrid` / `vector` / `keyword`) matching the serving query
+  types, with hybrid as the sensible default.
+- `UniversalSearchRequest` for federated search across several indexes at once.
+- `SearchDocument` / `UpsertResult` for adding and updating direct-access index
+  contents.
+- `SearchIndexInfo` / `SearchClientConfig` for the boot-time index catalogue a
+  search box reads with no server round-trip.
+- Model/tool-friendly schemas that avoid JSON Schema constraints known to cause
+  problems with some serving endpoints.
+
+## Validate A Search Request
+
+```ts
+import { search, type SearchRequest } from "@dbx-tools/shared-search";
+
+const request: SearchRequest = search.searchRequestSchema.parse({
+  query: "reset my password",
+  index: "main.support.docs",
+  limit: 5,
+  mode: "hybrid",
+  filter: { locale: "en", published: true },
+});
+```
+
+## Validate Search Results
+
+```ts
+const result = search.searchResultSchema.parse(await response.json());
+for (const hit of result.hits) {
+  console.log(hit.score, hit.id, hit.fields.title);
+}
+```
+
+`searchHitSchema` returns the requested columns under `fields`, keyed by column
+name, plus the primary-key `id` and a relevance `score`. A federated hit also
+carries the `index` it came from.
+
+## Read The Index Catalogue
+
+```ts
+const config = search.searchClientConfigSchema.parse(
+  await fetch("/api/search/indexes").then((r) => r.json()),
+);
+```
+
+`searchClientConfigSchema` is what a search box reads at boot to know which
+indexes it may query, which is the default, and the page size to request.
+
+## Module
+
+- `search` - `searchModeSchema`, `searchRequestSchema`, `searchHitSchema`,
+  `searchResultSchema`, `universalSearchRequestSchema`, `searchDocumentSchema`,
+  `upsertResultSchema`, `searchIndexInfoSchema`, `searchClientConfigSchema`, and
+  the flat inferred types (`SearchMode`, `SearchRequest`, `SearchHit`,
+  `SearchResult`, `UniversalSearchRequest`, `SearchDocument`, `UpsertResult`,
+  `SearchIndexInfo`, `SearchClientConfig`).
+
+Runtime search, index management, the Mastra tools, and the AppKit plugin live
+in [`@dbx-tools/search`](../../node/search). The React search box lives in
+[`@dbx-tools/ui-search`](../../ui/search).

package/index.ts

@@ -0,0 +1,7 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+
+export * as search from "./src/search.ts";
+export { searchModeSchema, searchRequestSchema, searchHitSchema, searchResultSchema, universalSearchRequestSchema, searchDocumentSchema, upsertResultSchema, searchIndexInfoSchema, searchClientConfigSchema, createIndexRequestSchema, syncIndexRequestSchema, indexInfoSchema } from "./src/search.ts";
+export type { SearchMode, SearchRequest, SearchHit, SearchResult, UniversalSearchRequest, SearchDocument, UpsertResult, SearchIndexInfo, SearchClientConfig, CreateIndexRequest, SyncIndexRequest, IndexInfo } from "./src/search.ts";

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * as search from "./src/search.ts";
+export { searchModeSchema, searchRequestSchema, searchHitSchema, searchResultSchema, universalSearchRequestSchema, searchDocumentSchema, upsertResultSchema, searchIndexInfoSchema, searchClientConfigSchema, createIndexRequestSchema, syncIndexRequestSchema, indexInfoSchema } from "./src/search.ts";
+export type { SearchMode, SearchRequest, SearchHit, SearchResult, UniversalSearchRequest, SearchDocument, UpsertResult, SearchIndexInfo, SearchClientConfig, CreateIndexRequest, SyncIndexRequest, IndexInfo } from "./src/search.ts";

package/lib/index.js

@@ -0,0 +1,6 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+export * as search from "./src/search.js";
+export { searchModeSchema, searchRequestSchema, searchHitSchema, searchResultSchema, universalSearchRequestSchema, searchDocumentSchema, upsertResultSchema, searchIndexInfoSchema, searchClientConfigSchema, createIndexRequestSchema, syncIndexRequestSchema, indexInfoSchema } from "./src/search.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxtQkFBbUIsRUFBRSxlQUFlLEVBQUUsa0JBQWtCLEVBQUUsNEJBQTRCLEVBQUUsb0JBQW9CLEVBQUUsa0JBQWtCLEVBQUUscUJBQXFCLEVBQUUsd0JBQXdCLEVBQUUsd0JBQXdCLEVBQUUsc0JBQXNCLEVBQUUsZUFBZSxFQUFFLE1BQU0saUJBQWlCLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBHRU5FUkFURUQgYnkgcHJvamVuIHdhdGNoIC0gRE8gTk9UIEVESVQuXG4vLyBSZWdlbmVyYXRlZCBmcm9tIHRoZSBleHBvcnRpbmcgbW9kdWxlcyBpbiAuL3NyYy5cbi8vIEhhbmQgZWRpdHMgYXJlIG92ZXJ3cml0dGVuIG9uIHRoZSBuZXh0IHdhdGNoOyB0aGlzIGZpbGUgaXMgcmVhZC1vbmx5LlxuXG5leHBvcnQgKiBhcyBzZWFyY2ggZnJvbSBcIi4vc3JjL3NlYXJjaC50c1wiO1xuZXhwb3J0IHsgc2VhcmNoTW9kZVNjaGVtYSwgc2VhcmNoUmVxdWVzdFNjaGVtYSwgc2VhcmNoSGl0U2NoZW1hLCBzZWFyY2hSZXN1bHRTY2hlbWEsIHVuaXZlcnNhbFNlYXJjaFJlcXVlc3RTY2hlbWEsIHNlYXJjaERvY3VtZW50U2NoZW1hLCB1cHNlcnRSZXN1bHRTY2hlbWEsIHNlYXJjaEluZGV4SW5mb1NjaGVtYSwgc2VhcmNoQ2xpZW50Q29uZmlnU2NoZW1hLCBjcmVhdGVJbmRleFJlcXVlc3RTY2hlbWEsIHN5bmNJbmRleFJlcXVlc3RTY2hlbWEsIGluZGV4SW5mb1NjaGVtYSB9IGZyb20gXCIuL3NyYy9zZWFyY2gudHNcIjtcbmV4cG9ydCB0eXBlIHsgU2VhcmNoTW9kZSwgU2VhcmNoUmVxdWVzdCwgU2VhcmNoSGl0LCBTZWFyY2hSZXN1bHQsIFVuaXZlcnNhbFNlYXJjaFJlcXVlc3QsIFNlYXJjaERvY3VtZW50LCBVcHNlcnRSZXN1bHQsIFNlYXJjaEluZGV4SW5mbywgU2VhcmNoQ2xpZW50Q29uZmlnLCBDcmVhdGVJbmRleFJlcXVlc3QsIFN5bmNJbmRleFJlcXVlc3QsIEluZGV4SW5mbyB9IGZyb20gXCIuL3NyYy9zZWFyY2gudHNcIjtcbiJdfQ==

package/lib/src/search.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Wire-format contract for the AI Search add-on: the query a caller (a UI
+ * search box, a Mastra tool, a universal-search route) sends and the hits it
+ * gets back, plus the document shape used to add / update index contents.
+ *
+ * Pure (zod + inferred types, no Node-only imports) so the server-side client
+ * in `@dbx-tools/search`, the Mastra tool, the `POST /api/search` route,
+ * and the React search box all validate / type against ONE definition.
+ *
+ * "AI Search" is Databricks' current name for Vector Search: an index built
+ * from a Delta table (or written directly) that answers a natural-language
+ * query with the most relevant rows, combining vector similarity with BM25
+ * keyword matching (hybrid). This contract is index-agnostic - it names the
+ * index by its Unity Catalog path and returns hits as `{ id, score, fields }`
+ * so the same shape serves an autocomplete box, a docs lookup, and a
+ * federated search across many indexes.
+ *
+ * Array fields intentionally avoid `.min()` / `.nonempty()`: those emit
+ * `minItems` in the JSON schema, which some Model Serving endpoints reject
+ * when the schema is forwarded as a tool definition.
+ *
+ * @module
+ */
+import { z } from "zod";
+/**
+ * How a query is matched. `hybrid` (the default) fuses vector similarity with
+ * BM25 keyword ranking - the right choice for most search boxes and for source
+ * data with exact identifiers (SKUs, error codes). `vector` is pure semantic
+ * similarity; `keyword` is pure BM25 full-text (Beta on Databricks). The
+ * value maps onto the serving API's `query_type` (`ANN` / `HYBRID`).
+ */
+export declare const searchModeSchema: z.ZodEnum<{
+    hybrid: "hybrid";
+    vector: "vector";
+    keyword: "keyword";
+}>;
+/** How a query is matched (see {@link searchModeSchema}). */
+export type SearchMode = z.infer<typeof searchModeSchema>;
+/** Schema for a search request against a single index. */
+export declare const searchRequestSchema: z.ZodObject<{
+    query: z.ZodString;
+    index: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    mode: z.ZodOptional<z.ZodEnum<{
+        hybrid: "hybrid";
+        vector: "vector";
+        keyword: "keyword";
+    }>>;
+    columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    filter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    scoreThreshold: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/** A validated search request ({@link searchRequestSchema}). */
+export type SearchRequest = z.infer<typeof searchRequestSchema>;
+/** Schema for a single search hit. */
+export declare const searchHitSchema: z.ZodObject<{
+    id: z.ZodString;
+    score: z.ZodNumber;
+    fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    index: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** A single search hit ({@link searchHitSchema}). */
+export type SearchHit = z.infer<typeof searchHitSchema>;
+/** Schema for the result of a search. */
+export declare const searchResultSchema: z.ZodObject<{
+    query: z.ZodString;
+    hits: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        score: z.ZodNumber;
+        fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        index: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    index: z.ZodOptional<z.ZodString>;
+    count: z.ZodNumber;
+}, z.core.$strip>;
+/** The outcome of a search ({@link searchResultSchema}). */
+export type SearchResult = z.infer<typeof searchResultSchema>;
+/** Schema for a universal (federated) search across several indexes at once. */
+export declare const universalSearchRequestSchema: z.ZodObject<{
+    query: z.ZodString;
+    indexes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    mode: z.ZodOptional<z.ZodEnum<{
+        hybrid: "hybrid";
+        vector: "vector";
+        keyword: "keyword";
+    }>>;
+}, z.core.$strip>;
+/** A validated universal-search request ({@link universalSearchRequestSchema}). */
+export type UniversalSearchRequest = z.infer<typeof universalSearchRequestSchema>;
+/** Schema for a document written to a direct-access index. */
+export declare const searchDocumentSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+/** A document written to an index ({@link searchDocumentSchema}). */
+export type SearchDocument = z.infer<typeof searchDocumentSchema>;
+/** Schema for the result of adding / updating documents. */
+export declare const upsertResultSchema: z.ZodObject<{
+    index: z.ZodString;
+    count: z.ZodNumber;
+}, z.core.$strip>;
+/** The outcome of an add-documents call ({@link upsertResultSchema}). */
+export type UpsertResult = z.infer<typeof upsertResultSchema>;
+/**
+ * Schema for the boot-time index catalogue a UI reads to populate a search box
+ * (the payload of the plugin's client config / `GET /api/search/indexes`). An
+ * entry names an index, an optional short alias, and the columns worth
+ * showing, so a search box needs no server round-trip to render.
+ */
+export declare const searchIndexInfoSchema: z.ZodObject<{
+    name: z.ZodString;
+    alias: z.ZodOptional<z.ZodString>;
+    primaryKey: z.ZodOptional<z.ZodString>;
+    columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isDefault: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/** One entry in the index catalogue ({@link searchIndexInfoSchema}). */
+export type SearchIndexInfo = z.infer<typeof searchIndexInfoSchema>;
+/** Schema for the plugin's client config surfaced to a UI. */
+export declare const searchClientConfigSchema: z.ZodObject<{
+    indexes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        primaryKey: z.ZodOptional<z.ZodString>;
+        columns: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        isDefault: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    defaultIndex: z.ZodOptional<z.ZodString>;
+    pageSize: z.ZodNumber;
+    basePath: z.ZodString;
+}, z.core.$strip>;
+/** The plugin's client config ({@link searchClientConfigSchema}). */
+export type SearchClientConfig = z.infer<typeof searchClientConfigSchema>;
+/**
+ * Schema for creating an index (the `create_index` tool input / the
+ * `POST /api/search/index` body). Two shapes, both inferring aggressively:
+ * pass `sourceTable` for a Delta Sync index (Databricks computes embeddings and
+ * keeps it synced) or `embeddingDimension` for a direct-access index you write
+ * vectors to yourself.
+ */
+export declare const createIndexRequestSchema: z.ZodObject<{
+    name: z.ZodString;
+    sourceTable: z.ZodOptional<z.ZodString>;
+    primaryKey: z.ZodOptional<z.ZodString>;
+    embeddingSourceColumn: z.ZodOptional<z.ZodString>;
+    embeddingModel: z.ZodOptional<z.ZodString>;
+    endpoint: z.ZodOptional<z.ZodString>;
+    embeddingDimension: z.ZodOptional<z.ZodNumber>;
+    pipelineType: z.ZodOptional<z.ZodEnum<{
+        TRIGGERED: "TRIGGERED";
+        CONTINUOUS: "CONTINUOUS";
+    }>>;
+    columnsToSync: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/** A validated create-index request ({@link createIndexRequestSchema}). */
+export type CreateIndexRequest = z.infer<typeof createIndexRequestSchema>;
+/** Schema for the `sync_index` tool input / the `POST /api/search/index/sync` body. */
+export declare const syncIndexRequestSchema: z.ZodObject<{
+    index: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** A validated sync-index request ({@link syncIndexRequestSchema}). */
+export type SyncIndexRequest = z.infer<typeof syncIndexRequestSchema>;
+/** Schema for a resolved index definition (the create/get result). */
+export declare const indexInfoSchema: z.ZodObject<{
+    name: z.ZodString;
+    endpoint: z.ZodOptional<z.ZodString>;
+    primaryKey: z.ZodOptional<z.ZodString>;
+    columns: z.ZodArray<z.ZodString>;
+    ready: z.ZodBoolean;
+    rowCount: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/** A resolved index definition ({@link indexInfoSchema}). */
+export type IndexInfo = z.infer<typeof indexInfoSchema>;

package/lib/src/search.js

@@ -0,0 +1,189 @@
+/**
+ * Wire-format contract for the AI Search add-on: the query a caller (a UI
+ * search box, a Mastra tool, a universal-search route) sends and the hits it
+ * gets back, plus the document shape used to add / update index contents.
+ *
+ * Pure (zod + inferred types, no Node-only imports) so the server-side client
+ * in `@dbx-tools/search`, the Mastra tool, the `POST /api/search` route,
+ * and the React search box all validate / type against ONE definition.
+ *
+ * "AI Search" is Databricks' current name for Vector Search: an index built
+ * from a Delta table (or written directly) that answers a natural-language
+ * query with the most relevant rows, combining vector similarity with BM25
+ * keyword matching (hybrid). This contract is index-agnostic - it names the
+ * index by its Unity Catalog path and returns hits as `{ id, score, fields }`
+ * so the same shape serves an autocomplete box, a docs lookup, and a
+ * federated search across many indexes.
+ *
+ * Array fields intentionally avoid `.min()` / `.nonempty()`: those emit
+ * `minItems` in the JSON schema, which some Model Serving endpoints reject
+ * when the schema is forwarded as a tool definition.
+ *
+ * @module
+ */
+import { z } from "zod";
+/**
+ * How a query is matched. `hybrid` (the default) fuses vector similarity with
+ * BM25 keyword ranking - the right choice for most search boxes and for source
+ * data with exact identifiers (SKUs, error codes). `vector` is pure semantic
+ * similarity; `keyword` is pure BM25 full-text (Beta on Databricks). The
+ * value maps onto the serving API's `query_type` (`ANN` / `HYBRID`).
+ */
+export const searchModeSchema = z
+    .enum(["hybrid", "vector", "keyword"])
+    .describe("Match strategy: 'hybrid' fuses semantic similarity with keyword ranking (default, best for most searches), 'vector' is pure semantic, 'keyword' is pure full-text.");
+/** Schema for a search request against a single index. */
+export const searchRequestSchema = z.object({
+    query: z
+        .string()
+        .describe("What to search for, as natural language or keywords. Prefix fragments work for autocomplete."),
+    index: z
+        .string()
+        .optional()
+        .describe("Unity Catalog name of the index to search (catalog.schema.index). Defaults to the plugin's configured index. Accepts a short alias when one is configured."),
+    limit: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .describe("Maximum number of hits to return. Defaults to the plugin's configured page size."),
+    mode: searchModeSchema.optional(),
+    columns: z
+        .array(z.string())
+        .optional()
+        .describe("Which document columns to return per hit. Defaults to the plugin's configured columns (or all indexed columns)."),
+    filter: z
+        .record(z.string(), z.unknown())
+        .optional()
+        .describe('Attribute filters as { column: value } (a value, or an operator map like { ">=": 10 }). Combined with AND. Maps onto the index `filters_json`.'),
+    scoreThreshold: z
+        .number()
+        .optional()
+        .describe("Drop hits whose relevance score is below this value."),
+});
+/** Schema for a single search hit. */
+export const searchHitSchema = z.object({
+    id: z.string().describe("The document's primary-key value."),
+    score: z.number().describe("Relevance score; higher is more relevant."),
+    fields: z
+        .record(z.string(), z.unknown())
+        .describe("The returned columns for this document, keyed by column name."),
+    index: z
+        .string()
+        .optional()
+        .describe("Which index the hit came from (set on universal/federated results)."),
+});
+/** Schema for the result of a search. */
+export const searchResultSchema = z.object({
+    query: z.string().describe("Echo of the query that was searched."),
+    hits: z.array(searchHitSchema).describe("Matching documents, most relevant first."),
+    index: z.string().optional().describe("The index searched (omitted for a universal search)."),
+    count: z.number().int().describe("Number of hits returned."),
+});
+/** Schema for a universal (federated) search across several indexes at once. */
+export const universalSearchRequestSchema = z.object({
+    query: z.string().describe("What to search for across every configured index."),
+    indexes: z
+        .array(z.string())
+        .optional()
+        .describe("Which indexes to search. Defaults to every index the plugin knows about."),
+    limit: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .describe("Maximum hits PER index before results are merged and re-ranked."),
+    mode: searchModeSchema.optional(),
+});
+/** Schema for a document written to a direct-access index. */
+export const searchDocumentSchema = z
+    .record(z.string(), z.unknown())
+    .describe("A document as { column: value }. Must include the index primary-key column.");
+/** Schema for the result of adding / updating documents. */
+export const upsertResultSchema = z.object({
+    index: z.string().describe("The index the documents were written to."),
+    count: z.number().int().describe("Number of documents accepted."),
+});
+/**
+ * Schema for the boot-time index catalogue a UI reads to populate a search box
+ * (the payload of the plugin's client config / `GET /api/search/indexes`). An
+ * entry names an index, an optional short alias, and the columns worth
+ * showing, so a search box needs no server round-trip to render.
+ */
+export const searchIndexInfoSchema = z.object({
+    name: z.string().describe("Unity Catalog name of the index (catalog.schema.index)."),
+    alias: z.string().optional().describe("Short alias the plugin accepts in place of `name`."),
+    primaryKey: z.string().optional().describe("The index's primary-key column, when known."),
+    columns: z
+        .array(z.string())
+        .optional()
+        .describe("Columns returned by default, in display order."),
+    isDefault: z.boolean().optional().describe("True for the plugin's default index."),
+});
+/** Schema for the plugin's client config surfaced to a UI. */
+export const searchClientConfigSchema = z.object({
+    indexes: z.array(searchIndexInfoSchema).describe("Indexes the search UI may query."),
+    defaultIndex: z.string().optional().describe("The index a search box selects by default."),
+    pageSize: z.number().int().describe("Default number of hits a search returns."),
+    basePath: z
+        .string()
+        .describe("Base path the search routes are mounted under (e.g. /api/search)."),
+});
+/**
+ * Schema for creating an index (the `create_index` tool input / the
+ * `POST /api/search/index` body). Two shapes, both inferring aggressively:
+ * pass `sourceTable` for a Delta Sync index (Databricks computes embeddings and
+ * keeps it synced) or `embeddingDimension` for a direct-access index you write
+ * vectors to yourself.
+ */
+export const createIndexRequestSchema = z.object({
+    name: z.string().describe("Unity Catalog name for the new index (catalog.schema.index)."),
+    sourceTable: z
+        .string()
+        .optional()
+        .describe("Delta table (catalog.schema.table) to build a synced index from. Provide this OR embeddingDimension."),
+    primaryKey: z.string().optional().describe("Primary-key column. Defaults to 'id'."),
+    embeddingSourceColumn: z
+        .string()
+        .optional()
+        .describe("Text column embeddings are computed from (Delta Sync). Defaults to the first of text/content/body."),
+    embeddingModel: z
+        .string()
+        .optional()
+        .describe("Embedding model endpoint (name or loose name). Defaults to the app's embedding model, or the best embedding endpoint in the workspace."),
+    endpoint: z
+        .string()
+        .optional()
+        .describe("Vector Search endpoint to host the index on. Defaults to the app's configured endpoint."),
+    embeddingDimension: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .describe("For a direct-access index (no source table): the embedding vector dimension."),
+    pipelineType: z
+        .enum(["TRIGGERED", "CONTINUOUS"])
+        .optional()
+        .describe("Delta Sync mode: 'TRIGGERED' (default) syncs on demand; 'CONTINUOUS' keeps the index fresh."),
+    columnsToSync: z
+        .array(z.string())
+        .optional()
+        .describe("Extra columns to sync alongside the embedding source column (Delta Sync)."),
+});
+/** Schema for the `sync_index` tool input / the `POST /api/search/index/sync` body. */
+export const syncIndexRequestSchema = z.object({
+    index: z
+        .string()
+        .describe("The index to sync (name or configured alias). Defaults to the app's default index when omitted.")
+        .optional(),
+});
+/** Schema for a resolved index definition (the create/get result). */
+export const indexInfoSchema = z.object({
+    name: z.string().describe("Unity Catalog name of the index."),
+    endpoint: z.string().optional().describe("The Vector Search endpoint hosting the index."),
+    primaryKey: z.string().optional().describe("The index's primary-key column."),
+    columns: z.array(z.string()).describe("Columns available on the index."),
+    ready: z.boolean().describe("True when the index has finished provisioning and can be queried."),
+    rowCount: z.number().int().optional().describe("Number of indexed rows, when known."),
+});
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/search.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACrC,QAAQ,CACP,oKAAoK,CACrK,CAAC;AAKJ,0DAA0D;AAC1D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,CACP,8FAA8F,CAC/F;IACH,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,4JAA4J,CAC7J;IACH,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,kFAAkF,CAAC;IAC/F,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACjC,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CACP,iHAAiH,CAClH;IACH,MAAM,EAAE,CAAC;SACN,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC/B,QAAQ,EAAE;SACV,QAAQ,CACP,gJAAgJ,CACjJ;IACH,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;CACpE,CAAC,CAAC;AAKH,sCAAsC;AACtC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;IACvE,MAAM,EAAE,CAAC;SACN,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC/B,QAAQ,CAAC,+DAA+D,CAAC;IAC5E,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,qEAAqE,CAAC;CACnF,CAAC,CAAC;AAKH,yCAAyC;AACzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAClE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IACnF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;IAC7F,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;CAC7D,CAAC,CAAC;AAKH,gFAAgF;AAChF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mDAAmD,CAAC;IAC/E,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,0EAA0E,CAAC;IACvF,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,iEAAiE,CAAC;IAC9E,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAKH,8DAA8D;AAC9D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KAC/B,QAAQ,CAAC,6EAA6E,CAAC,CAAC;AAK3F,4DAA4D;AAC5D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IACtE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;CAClE,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yDAAyD,CAAC;IACpF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oDAAoD,CAAC;IAC3F,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;IACzF,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;CACnF,CAAC,CAAC;AAKH,8DAA8D;AAC9D,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACpF,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IAC1F,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IAC/E,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,CAAC,mEAAmE,CAAC;CACjF,CAAC,CAAC;AAKH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8DAA8D,CAAC;IACzF,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,sGAAsG,CACvG;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IACnF,qBAAqB,EAAE,CAAC;SACrB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,oGAAoG,CACrG;IACH,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,wIAAwI,CACzI;IACH,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yFAAyF,CAC1F;IACH,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,8EAA8E,CAAC;IAC3F,YAAY,EAAE,CAAC;SACZ,IAAI,CAAC,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;SACjC,QAAQ,EAAE;SACV,QAAQ,CACP,6FAA6F,CAC9F;IACH,aAAa,EAAE,CAAC;SACb,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,2EAA2E,CAAC;CACzF,CAAC,CAAC;AAKH,uFAAuF;AACvF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,CACP,iGAAiG,CAClG;SACA,QAAQ,EAAE;CACd,CAAC,CAAC;AAKH,sEAAsE;AACtE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+CAA+C,CAAC;IACzF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAC7E,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IACxE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,mEAAmE,CAAC;IAChG,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;CACtF,CAAC,CAAC","sourcesContent":["/**\n * Wire-format contract for the AI Search add-on: the query a caller (a UI\n * search box, a Mastra tool, a universal-search route) sends and the hits it\n * gets back, plus the document shape used to add / update index contents.\n *\n * Pure (zod + inferred types, no Node-only imports) so the server-side client\n * in `@dbx-tools/search`, the Mastra tool, the `POST /api/search` route,\n * and the React search box all validate / type against ONE definition.\n *\n * \"AI Search\" is Databricks' current name for Vector Search: an index built\n * from a Delta table (or written directly) that answers a natural-language\n * query with the most relevant rows, combining vector similarity with BM25\n * keyword matching (hybrid). This contract is index-agnostic - it names the\n * index by its Unity Catalog path and returns hits as `{ id, score, fields }`\n * so the same shape serves an autocomplete box, a docs lookup, and a\n * federated search across many indexes.\n *\n * Array fields intentionally avoid `.min()` / `.nonempty()`: those emit\n * `minItems` in the JSON schema, which some Model Serving endpoints reject\n * when the schema is forwarded as a tool definition.\n *\n * @module\n */\n\nimport { z } from \"zod\";\n\n/**\n * How a query is matched. `hybrid` (the default) fuses vector similarity with\n * BM25 keyword ranking - the right choice for most search boxes and for source\n * data with exact identifiers (SKUs, error codes). `vector` is pure semantic\n * similarity; `keyword` is pure BM25 full-text (Beta on Databricks). The\n * value maps onto the serving API's `query_type` (`ANN` / `HYBRID`).\n */\nexport const searchModeSchema = z\n  .enum([\"hybrid\", \"vector\", \"keyword\"])\n  .describe(\n    \"Match strategy: 'hybrid' fuses semantic similarity with keyword ranking (default, best for most searches), 'vector' is pure semantic, 'keyword' is pure full-text.\",\n  );\n\n/** How a query is matched (see {@link searchModeSchema}). */\nexport type SearchMode = z.infer<typeof searchModeSchema>;\n\n/** Schema for a search request against a single index. */\nexport const searchRequestSchema = z.object({\n  query: z\n    .string()\n    .describe(\n      \"What to search for, as natural language or keywords. Prefix fragments work for autocomplete.\",\n    ),\n  index: z\n    .string()\n    .optional()\n    .describe(\n      \"Unity Catalog name of the index to search (catalog.schema.index). Defaults to the plugin's configured index. Accepts a short alias when one is configured.\",\n    ),\n  limit: z\n    .number()\n    .int()\n    .positive()\n    .optional()\n    .describe(\"Maximum number of hits to return. Defaults to the plugin's configured page size.\"),\n  mode: searchModeSchema.optional(),\n  columns: z\n    .array(z.string())\n    .optional()\n    .describe(\n      \"Which document columns to return per hit. Defaults to the plugin's configured columns (or all indexed columns).\",\n    ),\n  filter: z\n    .record(z.string(), z.unknown())\n    .optional()\n    .describe(\n      'Attribute filters as { column: value } (a value, or an operator map like { \">=\": 10 }). Combined with AND. Maps onto the index `filters_json`.',\n    ),\n  scoreThreshold: z\n    .number()\n    .optional()\n    .describe(\"Drop hits whose relevance score is below this value.\"),\n});\n\n/** A validated search request ({@link searchRequestSchema}). */\nexport type SearchRequest = z.infer<typeof searchRequestSchema>;\n\n/** Schema for a single search hit. */\nexport const searchHitSchema = z.object({\n  id: z.string().describe(\"The document's primary-key value.\"),\n  score: z.number().describe(\"Relevance score; higher is more relevant.\"),\n  fields: z\n    .record(z.string(), z.unknown())\n    .describe(\"The returned columns for this document, keyed by column name.\"),\n  index: z\n    .string()\n    .optional()\n    .describe(\"Which index the hit came from (set on universal/federated results).\"),\n});\n\n/** A single search hit ({@link searchHitSchema}). */\nexport type SearchHit = z.infer<typeof searchHitSchema>;\n\n/** Schema for the result of a search. */\nexport const searchResultSchema = z.object({\n  query: z.string().describe(\"Echo of the query that was searched.\"),\n  hits: z.array(searchHitSchema).describe(\"Matching documents, most relevant first.\"),\n  index: z.string().optional().describe(\"The index searched (omitted for a universal search).\"),\n  count: z.number().int().describe(\"Number of hits returned.\"),\n});\n\n/** The outcome of a search ({@link searchResultSchema}). */\nexport type SearchResult = z.infer<typeof searchResultSchema>;\n\n/** Schema for a universal (federated) search across several indexes at once. */\nexport const universalSearchRequestSchema = z.object({\n  query: z.string().describe(\"What to search for across every configured index.\"),\n  indexes: z\n    .array(z.string())\n    .optional()\n    .describe(\"Which indexes to search. Defaults to every index the plugin knows about.\"),\n  limit: z\n    .number()\n    .int()\n    .positive()\n    .optional()\n    .describe(\"Maximum hits PER index before results are merged and re-ranked.\"),\n  mode: searchModeSchema.optional(),\n});\n\n/** A validated universal-search request ({@link universalSearchRequestSchema}). */\nexport type UniversalSearchRequest = z.infer<typeof universalSearchRequestSchema>;\n\n/** Schema for a document written to a direct-access index. */\nexport const searchDocumentSchema = z\n  .record(z.string(), z.unknown())\n  .describe(\"A document as { column: value }. Must include the index primary-key column.\");\n\n/** A document written to an index ({@link searchDocumentSchema}). */\nexport type SearchDocument = z.infer<typeof searchDocumentSchema>;\n\n/** Schema for the result of adding / updating documents. */\nexport const upsertResultSchema = z.object({\n  index: z.string().describe(\"The index the documents were written to.\"),\n  count: z.number().int().describe(\"Number of documents accepted.\"),\n});\n\n/** The outcome of an add-documents call ({@link upsertResultSchema}). */\nexport type UpsertResult = z.infer<typeof upsertResultSchema>;\n\n/**\n * Schema for the boot-time index catalogue a UI reads to populate a search box\n * (the payload of the plugin's client config / `GET /api/search/indexes`). An\n * entry names an index, an optional short alias, and the columns worth\n * showing, so a search box needs no server round-trip to render.\n */\nexport const searchIndexInfoSchema = z.object({\n  name: z.string().describe(\"Unity Catalog name of the index (catalog.schema.index).\"),\n  alias: z.string().optional().describe(\"Short alias the plugin accepts in place of `name`.\"),\n  primaryKey: z.string().optional().describe(\"The index's primary-key column, when known.\"),\n  columns: z\n    .array(z.string())\n    .optional()\n    .describe(\"Columns returned by default, in display order.\"),\n  isDefault: z.boolean().optional().describe(\"True for the plugin's default index.\"),\n});\n\n/** One entry in the index catalogue ({@link searchIndexInfoSchema}). */\nexport type SearchIndexInfo = z.infer<typeof searchIndexInfoSchema>;\n\n/** Schema for the plugin's client config surfaced to a UI. */\nexport const searchClientConfigSchema = z.object({\n  indexes: z.array(searchIndexInfoSchema).describe(\"Indexes the search UI may query.\"),\n  defaultIndex: z.string().optional().describe(\"The index a search box selects by default.\"),\n  pageSize: z.number().int().describe(\"Default number of hits a search returns.\"),\n  basePath: z\n    .string()\n    .describe(\"Base path the search routes are mounted under (e.g. /api/search).\"),\n});\n\n/** The plugin's client config ({@link searchClientConfigSchema}). */\nexport type SearchClientConfig = z.infer<typeof searchClientConfigSchema>;\n\n/**\n * Schema for creating an index (the `create_index` tool input / the\n * `POST /api/search/index` body). Two shapes, both inferring aggressively:\n * pass `sourceTable` for a Delta Sync index (Databricks computes embeddings and\n * keeps it synced) or `embeddingDimension` for a direct-access index you write\n * vectors to yourself.\n */\nexport const createIndexRequestSchema = z.object({\n  name: z.string().describe(\"Unity Catalog name for the new index (catalog.schema.index).\"),\n  sourceTable: z\n    .string()\n    .optional()\n    .describe(\n      \"Delta table (catalog.schema.table) to build a synced index from. Provide this OR embeddingDimension.\",\n    ),\n  primaryKey: z.string().optional().describe(\"Primary-key column. Defaults to 'id'.\"),\n  embeddingSourceColumn: z\n    .string()\n    .optional()\n    .describe(\n      \"Text column embeddings are computed from (Delta Sync). Defaults to the first of text/content/body.\",\n    ),\n  embeddingModel: z\n    .string()\n    .optional()\n    .describe(\n      \"Embedding model endpoint (name or loose name). Defaults to the app's embedding model, or the best embedding endpoint in the workspace.\",\n    ),\n  endpoint: z\n    .string()\n    .optional()\n    .describe(\n      \"Vector Search endpoint to host the index on. Defaults to the app's configured endpoint.\",\n    ),\n  embeddingDimension: z\n    .number()\n    .int()\n    .positive()\n    .optional()\n    .describe(\"For a direct-access index (no source table): the embedding vector dimension.\"),\n  pipelineType: z\n    .enum([\"TRIGGERED\", \"CONTINUOUS\"])\n    .optional()\n    .describe(\n      \"Delta Sync mode: 'TRIGGERED' (default) syncs on demand; 'CONTINUOUS' keeps the index fresh.\",\n    ),\n  columnsToSync: z\n    .array(z.string())\n    .optional()\n    .describe(\"Extra columns to sync alongside the embedding source column (Delta Sync).\"),\n});\n\n/** A validated create-index request ({@link createIndexRequestSchema}). */\nexport type CreateIndexRequest = z.infer<typeof createIndexRequestSchema>;\n\n/** Schema for the `sync_index` tool input / the `POST /api/search/index/sync` body. */\nexport const syncIndexRequestSchema = z.object({\n  index: z\n    .string()\n    .describe(\n      \"The index to sync (name or configured alias). Defaults to the app's default index when omitted.\",\n    )\n    .optional(),\n});\n\n/** A validated sync-index request ({@link syncIndexRequestSchema}). */\nexport type SyncIndexRequest = z.infer<typeof syncIndexRequestSchema>;\n\n/** Schema for a resolved index definition (the create/get result). */\nexport const indexInfoSchema = z.object({\n  name: z.string().describe(\"Unity Catalog name of the index.\"),\n  endpoint: z.string().optional().describe(\"The Vector Search endpoint hosting the index.\"),\n  primaryKey: z.string().optional().describe(\"The index's primary-key column.\"),\n  columns: z.array(z.string()).describe(\"Columns available on the index.\"),\n  ready: z.boolean().describe(\"True when the index has finished provisioning and can be queried.\"),\n  rowCount: z.number().int().optional().describe(\"Number of indexed rows, when known.\"),\n});\n\n/** A resolved index definition ({@link indexInfoSchema}). */\nexport type IndexInfo = z.infer<typeof indexInfoSchema>;\n"]}

package/lib/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/search.ts","../index.ts"],"version":"5.9.3"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@dbx-tools/shared-search",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/reggie-db/dbx-tools.git",
+    "directory": "packages/shared/search"
+  },
+  "devDependencies": {
+    "@types/node": "^24.6.0",
+    "tsx": "^4.23.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "zod": "4.3.6",
+    "@dbx-tools/shared-core": "0.6.9"
+  },
+  "main": "./lib/index.js",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.6.9",
+  "types": "./lib/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "index.ts",
+    "src",
+    "lib"
+  ],
+  "dbxToolsConfig": {
+    "tags": [
+      "shared"
+    ]
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"pnpm exec projen\".",
+  "scripts": {
+    "build": "projen build",
+    "compile": "projen compile",
+    "default": "projen default",
+    "package": "projen package",
+    "post-compile": "projen post-compile",
+    "pre-compile": "projen pre-compile",
+    "test": "projen test",
+    "watch": "projen watch",
+    "projen": "projen"
+  }
+}

package/src/search.ts

@@ -0,0 +1,259 @@
+/**
+ * Wire-format contract for the AI Search add-on: the query a caller (a UI
+ * search box, a Mastra tool, a universal-search route) sends and the hits it
+ * gets back, plus the document shape used to add / update index contents.
+ *
+ * Pure (zod + inferred types, no Node-only imports) so the server-side client
+ * in `@dbx-tools/search`, the Mastra tool, the `POST /api/search` route,
+ * and the React search box all validate / type against ONE definition.
+ *
+ * "AI Search" is Databricks' current name for Vector Search: an index built
+ * from a Delta table (or written directly) that answers a natural-language
+ * query with the most relevant rows, combining vector similarity with BM25
+ * keyword matching (hybrid). This contract is index-agnostic - it names the
+ * index by its Unity Catalog path and returns hits as `{ id, score, fields }`
+ * so the same shape serves an autocomplete box, a docs lookup, and a
+ * federated search across many indexes.
+ *
+ * Array fields intentionally avoid `.min()` / `.nonempty()`: those emit
+ * `minItems` in the JSON schema, which some Model Serving endpoints reject
+ * when the schema is forwarded as a tool definition.
+ *
+ * @module
+ */
+
+import { z } from "zod";
+
+/**
+ * How a query is matched. `hybrid` (the default) fuses vector similarity with
+ * BM25 keyword ranking - the right choice for most search boxes and for source
+ * data with exact identifiers (SKUs, error codes). `vector` is pure semantic
+ * similarity; `keyword` is pure BM25 full-text (Beta on Databricks). The
+ * value maps onto the serving API's `query_type` (`ANN` / `HYBRID`).
+ */
+export const searchModeSchema = z
+  .enum(["hybrid", "vector", "keyword"])
+  .describe(
+    "Match strategy: 'hybrid' fuses semantic similarity with keyword ranking (default, best for most searches), 'vector' is pure semantic, 'keyword' is pure full-text.",
+  );
+
+/** How a query is matched (see {@link searchModeSchema}). */
+export type SearchMode = z.infer<typeof searchModeSchema>;
+
+/** Schema for a search request against a single index. */
+export const searchRequestSchema = z.object({
+  query: z
+    .string()
+    .describe(
+      "What to search for, as natural language or keywords. Prefix fragments work for autocomplete.",
+    ),
+  index: z
+    .string()
+    .optional()
+    .describe(
+      "Unity Catalog name of the index to search (catalog.schema.index). Defaults to the plugin's configured index. Accepts a short alias when one is configured.",
+    ),
+  limit: z
+    .number()
+    .int()
+    .positive()
+    .optional()
+    .describe("Maximum number of hits to return. Defaults to the plugin's configured page size."),
+  mode: searchModeSchema.optional(),
+  columns: z
+    .array(z.string())
+    .optional()
+    .describe(
+      "Which document columns to return per hit. Defaults to the plugin's configured columns (or all indexed columns).",
+    ),
+  filter: z
+    .record(z.string(), z.unknown())
+    .optional()
+    .describe(
+      'Attribute filters as { column: value } (a value, or an operator map like { ">=": 10 }). Combined with AND. Maps onto the index `filters_json`.',
+    ),
+  scoreThreshold: z
+    .number()
+    .optional()
+    .describe("Drop hits whose relevance score is below this value."),
+});
+
+/** A validated search request ({@link searchRequestSchema}). */
+export type SearchRequest = z.infer<typeof searchRequestSchema>;
+
+/** Schema for a single search hit. */
+export const searchHitSchema = z.object({
+  id: z.string().describe("The document's primary-key value."),
+  score: z.number().describe("Relevance score; higher is more relevant."),
+  fields: z
+    .record(z.string(), z.unknown())
+    .describe("The returned columns for this document, keyed by column name."),
+  index: z
+    .string()
+    .optional()
+    .describe("Which index the hit came from (set on universal/federated results)."),
+});
+
+/** A single search hit ({@link searchHitSchema}). */
+export type SearchHit = z.infer<typeof searchHitSchema>;
+
+/** Schema for the result of a search. */
+export const searchResultSchema = z.object({
+  query: z.string().describe("Echo of the query that was searched."),
+  hits: z.array(searchHitSchema).describe("Matching documents, most relevant first."),
+  index: z.string().optional().describe("The index searched (omitted for a universal search)."),
+  count: z.number().int().describe("Number of hits returned."),
+});
+
+/** The outcome of a search ({@link searchResultSchema}). */
+export type SearchResult = z.infer<typeof searchResultSchema>;
+
+/** Schema for a universal (federated) search across several indexes at once. */
+export const universalSearchRequestSchema = z.object({
+  query: z.string().describe("What to search for across every configured index."),
+  indexes: z
+    .array(z.string())
+    .optional()
+    .describe("Which indexes to search. Defaults to every index the plugin knows about."),
+  limit: z
+    .number()
+    .int()
+    .positive()
+    .optional()
+    .describe("Maximum hits PER index before results are merged and re-ranked."),
+  mode: searchModeSchema.optional(),
+});
+
+/** A validated universal-search request ({@link universalSearchRequestSchema}). */
+export type UniversalSearchRequest = z.infer<typeof universalSearchRequestSchema>;
+
+/** Schema for a document written to a direct-access index. */
+export const searchDocumentSchema = z
+  .record(z.string(), z.unknown())
+  .describe("A document as { column: value }. Must include the index primary-key column.");
+
+/** A document written to an index ({@link searchDocumentSchema}). */
+export type SearchDocument = z.infer<typeof searchDocumentSchema>;
+
+/** Schema for the result of adding / updating documents. */
+export const upsertResultSchema = z.object({
+  index: z.string().describe("The index the documents were written to."),
+  count: z.number().int().describe("Number of documents accepted."),
+});
+
+/** The outcome of an add-documents call ({@link upsertResultSchema}). */
+export type UpsertResult = z.infer<typeof upsertResultSchema>;
+
+/**
+ * Schema for the boot-time index catalogue a UI reads to populate a search box
+ * (the payload of the plugin's client config / `GET /api/search/indexes`). An
+ * entry names an index, an optional short alias, and the columns worth
+ * showing, so a search box needs no server round-trip to render.
+ */
+export const searchIndexInfoSchema = z.object({
+  name: z.string().describe("Unity Catalog name of the index (catalog.schema.index)."),
+  alias: z.string().optional().describe("Short alias the plugin accepts in place of `name`."),
+  primaryKey: z.string().optional().describe("The index's primary-key column, when known."),
+  columns: z
+    .array(z.string())
+    .optional()
+    .describe("Columns returned by default, in display order."),
+  isDefault: z.boolean().optional().describe("True for the plugin's default index."),
+});
+
+/** One entry in the index catalogue ({@link searchIndexInfoSchema}). */
+export type SearchIndexInfo = z.infer<typeof searchIndexInfoSchema>;
+
+/** Schema for the plugin's client config surfaced to a UI. */
+export const searchClientConfigSchema = z.object({
+  indexes: z.array(searchIndexInfoSchema).describe("Indexes the search UI may query."),
+  defaultIndex: z.string().optional().describe("The index a search box selects by default."),
+  pageSize: z.number().int().describe("Default number of hits a search returns."),
+  basePath: z
+    .string()
+    .describe("Base path the search routes are mounted under (e.g. /api/search)."),
+});
+
+/** The plugin's client config ({@link searchClientConfigSchema}). */
+export type SearchClientConfig = z.infer<typeof searchClientConfigSchema>;
+
+/**
+ * Schema for creating an index (the `create_index` tool input / the
+ * `POST /api/search/index` body). Two shapes, both inferring aggressively:
+ * pass `sourceTable` for a Delta Sync index (Databricks computes embeddings and
+ * keeps it synced) or `embeddingDimension` for a direct-access index you write
+ * vectors to yourself.
+ */
+export const createIndexRequestSchema = z.object({
+  name: z.string().describe("Unity Catalog name for the new index (catalog.schema.index)."),
+  sourceTable: z
+    .string()
+    .optional()
+    .describe(
+      "Delta table (catalog.schema.table) to build a synced index from. Provide this OR embeddingDimension.",
+    ),
+  primaryKey: z.string().optional().describe("Primary-key column. Defaults to 'id'."),
+  embeddingSourceColumn: z
+    .string()
+    .optional()
+    .describe(
+      "Text column embeddings are computed from (Delta Sync). Defaults to the first of text/content/body.",
+    ),
+  embeddingModel: z
+    .string()
+    .optional()
+    .describe(
+      "Embedding model endpoint (name or loose name). Defaults to the app's embedding model, or the best embedding endpoint in the workspace.",
+    ),
+  endpoint: z
+    .string()
+    .optional()
+    .describe(
+      "Vector Search endpoint to host the index on. Defaults to the app's configured endpoint.",
+    ),
+  embeddingDimension: z
+    .number()
+    .int()
+    .positive()
+    .optional()
+    .describe("For a direct-access index (no source table): the embedding vector dimension."),
+  pipelineType: z
+    .enum(["TRIGGERED", "CONTINUOUS"])
+    .optional()
+    .describe(
+      "Delta Sync mode: 'TRIGGERED' (default) syncs on demand; 'CONTINUOUS' keeps the index fresh.",
+    ),
+  columnsToSync: z
+    .array(z.string())
+    .optional()
+    .describe("Extra columns to sync alongside the embedding source column (Delta Sync)."),
+});
+
+/** A validated create-index request ({@link createIndexRequestSchema}). */
+export type CreateIndexRequest = z.infer<typeof createIndexRequestSchema>;
+
+/** Schema for the `sync_index` tool input / the `POST /api/search/index/sync` body. */
+export const syncIndexRequestSchema = z.object({
+  index: z
+    .string()
+    .describe(
+      "The index to sync (name or configured alias). Defaults to the app's default index when omitted.",
+    )
+    .optional(),
+});
+
+/** A validated sync-index request ({@link syncIndexRequestSchema}). */
+export type SyncIndexRequest = z.infer<typeof syncIndexRequestSchema>;
+
+/** Schema for a resolved index definition (the create/get result). */
+export const indexInfoSchema = z.object({
+  name: z.string().describe("Unity Catalog name of the index."),
+  endpoint: z.string().optional().describe("The Vector Search endpoint hosting the index."),
+  primaryKey: z.string().optional().describe("The index's primary-key column."),
+  columns: z.array(z.string()).describe("Columns available on the index."),
+  ready: z.boolean().describe("True when the index has finished provisioning and can be queried."),
+  rowCount: z.number().int().optional().describe("Number of indexed rows, when known."),
+});
+
+/** A resolved index definition ({@link indexInfoSchema}). */
+export type IndexInfo = z.infer<typeof indexInfoSchema>;