@dbx-tools/shared-search 0.9.129 → 0.9.132

package/README.md

@@ -1,12 +1,11 @@
 # @dbx-tools/shared-search
 
-Browser-safe schemas and extension types for AppKit-compatible AI Search
-providers.
+Validate Databricks AI Search requests, results, index catalogs, and document
+writes in browser and server code. It defines the browser-safe extension
+contracts shared by [@dbx-tools/search](../../node/search), Mastra tools, and
+[@dbx-tools/ui/search](../../ui/appkit).
 
-Use these schemas in UIs, Mastra tools, routes, and tests that exchange payloads
-with [`@dbx-tools/search`](../../node/search).
-
-## Quick Start
+## Quick start
 
 ```ts
 import { searchSchemas } from "@dbx-tools/shared-search";
@@ -18,7 +17,7 @@ const request = searchSchemas.searchRequestSchema.parse({
 });
 ```
 
-Key features:
+The schemas cover:
 
 - Shared `SearchRequest` / `SearchResult` contract with `{ id, score, fields }`
   hits, so an autocomplete box, a docs lookup, and a Mastra tool speak one shape.
@@ -27,12 +26,12 @@ Key features:
 - `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
+- `SearchIndexInfo` / `SearchClientConfig` for the boot-time index catalog 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.
 
-## Request Options
+## Validate request options
 
 ```ts
 import { searchSchemas, type SearchRequest } from "@dbx-tools/shared-search";
@@ -46,40 +45,52 @@ const request: SearchRequest = searchSchemas.searchRequestSchema.parse({
 });
 ```
 
-## Validate Search Results
+## 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);
-}
+import { searchSchemas } from "@dbx-tools/shared-search";
+
+const response = await fetch("/api/ai-search/docs/query", {
+  method: "POST",
+  headers: { "content-type": "application/json" },
+  body: JSON.stringify({ query: "reset my password", limit: 5 }),
+});
+if (!response.ok) throw new Error(`Search failed with ${response.status}`);
+const result = searchSchemas.searchResultSchema.parse(await response.json());
+const titles = result.hits.map((hit) => 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
+## Read the index catalog
 
 ```ts
-const config = search.searchClientConfigSchema.parse(
+import { searchSchemas } from "@dbx-tools/shared-search";
+
+const config = searchSchemas.searchClientConfigSchema.parse(
   await fetch("/api/search/indexes").then((r) => r.json()),
 );
 ```
 
-`searchClientConfigSchema` is the extension catalogue for universal search.
-Single-index UI queries read native `aiSearch` client config instead.
+`searchClientConfigSchema` validates the extension catalog used for universal
+search. Single-index UI queries read AppKit's published `aiSearch` client
+configuration instead.
+
+## Runtime boundary
 
-## Module
+This package doesn't query indexes, read Databricks credentials, or choose a
+search backend. Use [@dbx-tools/search](../../node/search) for runtime search,
+index management, Mastra tools, and the AppKit plugin. Use
+[@dbx-tools/ui/search](../../ui/appkit) for React controls.
 
-- `search` - `searchModeSchema`, `searchRequestSchema`, `searchHitSchema`,
+## Package exports
+
+- `searchSchemas`: `searchModeSchema`, `searchRequestSchema`, `searchHitSchema`,
   `searchResultSchema`, `universalSearchRequestSchema`, `searchDocumentSchema`,
   `upsertResultSchema`, `searchIndexInfoSchema`, `searchClientConfigSchema`, and
-  `toAiSearchQueryType`,
+  `toAiSearchQueryType`, 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/appkit).

package/index.ts

@@ -3,7 +3,7 @@
 // Hand edits are overwritten on the next watch; this file is read-only.
 
 export const PACKAGE_IDENTIFIER = "@dbx-tools/shared-search";
-export const PACKAGE_VERSION = "0.9.129";
+export const PACKAGE_VERSION = "0.9.132";
 export * as searchSchemas from "./src/search-schemas.ts";
 export { searchModeSchema, aiSearchQueryTypeSchema, searchRequestSchema, searchHitSchema, searchResultSchema, universalSearchRequestSchema, searchDocumentSchema, upsertResultSchema, searchIndexInfoSchema, searchClientConfigSchema, createIndexRequestSchema, syncIndexRequestSchema, indexInfoSchema } from "./src/search-schemas.ts";
 export type { SearchMode, AiSearchQueryType, SearchRequest, SearchHit, SearchResult, UniversalSearchRequest, SearchDocument, UpsertResult, SearchIndexInfo, SearchClientConfig, CreateIndexRequest, SyncIndexRequest, IndexInfo } from "./src/search-schemas.ts";

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 export declare const PACKAGE_IDENTIFIER = "@dbx-tools/shared-search";
-export declare const PACKAGE_VERSION = "0.9.129";
+export declare const PACKAGE_VERSION = "0.9.132";
 export * as searchSchemas from "./src/search-schemas.ts";
 export { searchModeSchema, aiSearchQueryTypeSchema, searchRequestSchema, searchHitSchema, searchResultSchema, universalSearchRequestSchema, searchDocumentSchema, upsertResultSchema, searchIndexInfoSchema, searchClientConfigSchema, createIndexRequestSchema, syncIndexRequestSchema, indexInfoSchema } from "./src/search-schemas.ts";
 export type { SearchMode, AiSearchQueryType, SearchRequest, SearchHit, SearchResult, UniversalSearchRequest, SearchDocument, UpsertResult, SearchIndexInfo, SearchClientConfig, CreateIndexRequest, SyncIndexRequest, IndexInfo } from "./src/search-schemas.ts";

package/lib/index.js

@@ -2,7 +2,7 @@
 // Regenerated from the exporting modules in ./src.
 // Hand edits are overwritten on the next watch; this file is read-only.
 export const PACKAGE_IDENTIFIER = "@dbx-tools/shared-search";
-export const PACKAGE_VERSION = "0.9.129";
+export const PACKAGE_VERSION = "0.9.132";
 export * as searchSchemas from "./src/search-schemas.js";
 export { searchModeSchema, aiSearchQueryTypeSchema, searchRequestSchema, searchHitSchema, searchResultSchema, universalSearchRequestSchema, searchDocumentSchema, upsertResultSchema, searchIndexInfoSchema, searchClientConfigSchema, createIndexRequestSchema, syncIndexRequestSchema, indexInfoSchema } from "./src/search-schemas.js";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRywwQkFBMEIsQ0FBQztBQUM3RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxhQUFhLE1BQU0seUJBQXlCLENBQUM7QUFDekQsT0FBTyxFQUFFLGdCQUFnQixFQUFFLHVCQUF1QixFQUFFLG1CQUFtQixFQUFFLGVBQWUsRUFBRSxrQkFBa0IsRUFBRSw0QkFBNEIsRUFBRSxvQkFBb0IsRUFBRSxrQkFBa0IsRUFBRSxxQkFBcUIsRUFBRSx3QkFBd0IsRUFBRSx3QkFBd0IsRUFBRSxzQkFBc0IsRUFBRSxlQUFlLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvc2hhcmVkLXNlYXJjaFwiO1xuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfVkVSU0lPTiA9IFwiMC45LjEyOVwiO1xuZXhwb3J0ICogYXMgc2VhcmNoU2NoZW1hcyBmcm9tIFwiLi9zcmMvc2VhcmNoLXNjaGVtYXMudHNcIjtcbmV4cG9ydCB7IHNlYXJjaE1vZGVTY2hlbWEsIGFpU2VhcmNoUXVlcnlUeXBlU2NoZW1hLCBzZWFyY2hSZXF1ZXN0U2NoZW1hLCBzZWFyY2hIaXRTY2hlbWEsIHNlYXJjaFJlc3VsdFNjaGVtYSwgdW5pdmVyc2FsU2VhcmNoUmVxdWVzdFNjaGVtYSwgc2VhcmNoRG9jdW1lbnRTY2hlbWEsIHVwc2VydFJlc3VsdFNjaGVtYSwgc2VhcmNoSW5kZXhJbmZvU2NoZW1hLCBzZWFyY2hDbGllbnRDb25maWdTY2hlbWEsIGNyZWF0ZUluZGV4UmVxdWVzdFNjaGVtYSwgc3luY0luZGV4UmVxdWVzdFNjaGVtYSwgaW5kZXhJbmZvU2NoZW1hIH0gZnJvbSBcIi4vc3JjL3NlYXJjaC1zY2hlbWFzLnRzXCI7XG5leHBvcnQgdHlwZSB7IFNlYXJjaE1vZGUsIEFpU2VhcmNoUXVlcnlUeXBlLCBTZWFyY2hSZXF1ZXN0LCBTZWFyY2hIaXQsIFNlYXJjaFJlc3VsdCwgVW5pdmVyc2FsU2VhcmNoUmVxdWVzdCwgU2VhcmNoRG9jdW1lbnQsIFVwc2VydFJlc3VsdCwgU2VhcmNoSW5kZXhJbmZvLCBTZWFyY2hDbGllbnRDb25maWcsIENyZWF0ZUluZGV4UmVxdWVzdCwgU3luY0luZGV4UmVxdWVzdCwgSW5kZXhJbmZvIH0gZnJvbSBcIi4vc3JjL3NlYXJjaC1zY2hlbWFzLnRzXCI7XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRywwQkFBMEIsQ0FBQztBQUM3RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxhQUFhLE1BQU0seUJBQXlCLENBQUM7QUFDekQsT0FBTyxFQUFFLGdCQUFnQixFQUFFLHVCQUF1QixFQUFFLG1CQUFtQixFQUFFLGVBQWUsRUFBRSxrQkFBa0IsRUFBRSw0QkFBNEIsRUFBRSxvQkFBb0IsRUFBRSxrQkFBa0IsRUFBRSxxQkFBcUIsRUFBRSx3QkFBd0IsRUFBRSx3QkFBd0IsRUFBRSxzQkFBc0IsRUFBRSxlQUFlLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvc2hhcmVkLXNlYXJjaFwiO1xuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfVkVSU0lPTiA9IFwiMC45LjEzMlwiO1xuZXhwb3J0ICogYXMgc2VhcmNoU2NoZW1hcyBmcm9tIFwiLi9zcmMvc2VhcmNoLXNjaGVtYXMudHNcIjtcbmV4cG9ydCB7IHNlYXJjaE1vZGVTY2hlbWEsIGFpU2VhcmNoUXVlcnlUeXBlU2NoZW1hLCBzZWFyY2hSZXF1ZXN0U2NoZW1hLCBzZWFyY2hIaXRTY2hlbWEsIHNlYXJjaFJlc3VsdFNjaGVtYSwgdW5pdmVyc2FsU2VhcmNoUmVxdWVzdFNjaGVtYSwgc2VhcmNoRG9jdW1lbnRTY2hlbWEsIHVwc2VydFJlc3VsdFNjaGVtYSwgc2VhcmNoSW5kZXhJbmZvU2NoZW1hLCBzZWFyY2hDbGllbnRDb25maWdTY2hlbWEsIGNyZWF0ZUluZGV4UmVxdWVzdFNjaGVtYSwgc3luY0luZGV4UmVxdWVzdFNjaGVtYSwgaW5kZXhJbmZvU2NoZW1hIH0gZnJvbSBcIi4vc3JjL3NlYXJjaC1zY2hlbWFzLnRzXCI7XG5leHBvcnQgdHlwZSB7IFNlYXJjaE1vZGUsIEFpU2VhcmNoUXVlcnlUeXBlLCBTZWFyY2hSZXF1ZXN0LCBTZWFyY2hIaXQsIFNlYXJjaFJlc3VsdCwgVW5pdmVyc2FsU2VhcmNoUmVxdWVzdCwgU2VhcmNoRG9jdW1lbnQsIFVwc2VydFJlc3VsdCwgU2VhcmNoSW5kZXhJbmZvLCBTZWFyY2hDbGllbnRDb25maWcsIENyZWF0ZUluZGV4UmVxdWVzdCwgU3luY0luZGV4UmVxdWVzdCwgSW5kZXhJbmZvIH0gZnJvbSBcIi4vc3JjL3NlYXJjaC1zY2hlbWFzLnRzXCI7XG4iXX0=

package/package.json

@@ -46,7 +46,7 @@
       "./package.json": "./package.json"
     }
   },
-  "version": "0.9.129",
+  "version": "0.9.132",
   "types": "./lib/index.d.ts",
   "dbxToolsConfig": {
     "tags": [