@databricks/appkit 0.23.0 → 0.24.0

package/dist/type-generator/vite-plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"vite-plugin.js","names":[],"sources":["../../src/type-generator/vite-plugin.ts"],"sourcesContent":["import { existsSync } from \"node:fs\";\nimport path from \"node:path\";\nimport type { Plugin } from \"vite\";\nimport { createLogger } from \"../logging/logger\";\nimport { generateFromEntryPoint } from \"./index\";\n\nconst logger = createLogger(\"type-generator:vite-plugin\");\n\n/**\n * Options for the AppKit types plugin.\n */\ninterface AppKitTypesPluginOptions {\n  /* Path to the output d.ts file (relative to client folder). */\n  outFile?: string;\n  /** Folders to watch for changes. */\n  watchFolders?: string[];\n}\n\n/**\n * Vite plugin to generate types for AppKit queries.\n * Calls generateFromEntryPoint under the hood.\n * @param options - Options to override default values.\n * @returns Vite plugin to generate types for AppKit queries.\n */\nexport function appKitTypesPlugin(options?: AppKitTypesPluginOptions): Plugin {\n  let root: string;\n  let outFile: string;\n  let watchFolders: string[];\n\n  async function generate() {\n    try {\n      const warehouseId = process.env.DATABRICKS_WAREHOUSE_ID || \"\";\n\n      if (!warehouseId) {\n        logger.debug(\"Warehouse ID not found. Skipping type generation.\");\n        return;\n      }\n\n      await generateFromEntryPoint({\n        outFile,\n        queryFolder: watchFolders[0],\n        warehouseId,\n        noCache: false,\n      });\n    } catch (error) {\n      // throw in production to fail the build\n      if (process.env.NODE_ENV === \"production\") {\n        throw error;\n      }\n      logger.error(\"Error generating types: %O\", error);\n    }\n  }\n\n  return {\n    name: \"appkit-types\",\n\n    apply() {\n      const warehouseId = process.env.DATABRICKS_WAREHOUSE_ID || \"\";\n\n      if (!warehouseId) {\n        logger.debug(\"Warehouse ID not found. Skipping type generation.\");\n        return false;\n      }\n\n      if (!existsSync(path.join(process.cwd(), \"config\", \"queries\"))) {\n        return false;\n      }\n\n      return true;\n    },\n\n    configResolved(config) {\n      root = config.root;\n      outFile = path.resolve(root, options?.outFile ?? \"src/appKitTypes.d.ts\");\n      watchFolders = options?.watchFolders ?? [\n        path.join(process.cwd(), \"config\", \"queries\"),\n      ];\n    },\n\n    buildStart() {\n      generate();\n    },\n\n    configureServer(server) {\n      server.watcher.add(watchFolders);\n\n      server.watcher.on(\"change\", (changedFile) => {\n        const isWatchedFile = watchFolders.some((folder) =>\n          changedFile.startsWith(folder),\n        );\n\n        if (isWatchedFile && changedFile.endsWith(\".sql\")) {\n          generate();\n        }\n      });\n    },\n  };\n}\n"],"mappings":";;;;;;AAMA,MAAM,SAAS,aAAa,6BAA6B;;;;;;;AAkBzD,SAAgB,kBAAkB,SAA4C;CAC5E,IAAI;CACJ,IAAI;CACJ,IAAI;CAEJ,eAAe,WAAW;AACxB,MAAI;GACF,MAAM,cAAc,QAAQ,IAAI,2BAA2B;AAE3D,OAAI,CAAC,aAAa;AAChB,WAAO,MAAM,oDAAoD;AACjE;;AAGF,SAAM,uBAAuB;IAC3B;IACA,aAAa,aAAa;IAC1B;IACA,SAAS;IACV,CAAC;WACK,OAAO;AAEd,OAAI,QAAQ,IAAI,aAAa,aAC3B,OAAM;AAER,UAAO,MAAM,8BAA8B,MAAM;;;AAIrD,QAAO;EACL,MAAM;EAEN,QAAQ;AAGN,OAAI,EAFgB,QAAQ,IAAI,2BAA2B,KAEzC;AAChB,WAAO,MAAM,oDAAoD;AACjE,WAAO;;AAGT,OAAI,CAAC,WAAW,KAAK,KAAK,QAAQ,KAAK,EAAE,UAAU,UAAU,CAAC,CAC5D,QAAO;AAGT,UAAO;;EAGT,eAAe,QAAQ;AACrB,UAAO,OAAO;AACd,aAAU,KAAK,QAAQ,MAAM,SAAS,WAAW,uBAAuB;AACxE,kBAAe,SAAS,gBAAgB,CACtC,KAAK,KAAK,QAAQ,KAAK,EAAE,UAAU,UAAU,CAC9C;;EAGH,aAAa;AACX,aAAU;;EAGZ,gBAAgB,QAAQ;AACtB,UAAO,QAAQ,IAAI,aAAa;AAEhC,UAAO,QAAQ,GAAG,WAAW,gBAAgB;AAK3C,QAJsB,aAAa,MAAM,WACvC,YAAY,WAAW,OAAO,CAC/B,IAEoB,YAAY,SAAS,OAAO,CAC/C,WAAU;KAEZ;;EAEL"}
+{"version":3,"file":"vite-plugin.js","names":[],"sources":["../../src/type-generator/vite-plugin.ts"],"sourcesContent":["import { existsSync } from \"node:fs\";\nimport path from \"node:path\";\nimport type { Plugin } from \"vite\";\nimport { createLogger } from \"../logging/logger\";\nimport {\n  ANALYTICS_TYPES_FILE,\n  generateFromEntryPoint,\n  TYPES_DIR,\n} from \"./index\";\n\nconst logger = createLogger(\"type-generator:vite-plugin\");\n\n/**\n * Options for the AppKit types plugin.\n */\ninterface AppKitTypesPluginOptions {\n  /* Path to the output d.ts file (relative to client folder). */\n  outFile?: string;\n  /** Folders to watch for changes. */\n  watchFolders?: string[];\n}\n\n/**\n * Vite plugin to generate types for AppKit queries.\n * Calls generateFromEntryPoint under the hood.\n * @param options - Options to override default values.\n * @returns Vite plugin to generate types for AppKit queries.\n */\nexport function appKitTypesPlugin(options?: AppKitTypesPluginOptions): Plugin {\n  let outFile: string;\n  let watchFolders: string[];\n\n  async function generate() {\n    try {\n      const warehouseId = process.env.DATABRICKS_WAREHOUSE_ID || \"\";\n\n      if (!warehouseId) {\n        logger.debug(\"Warehouse ID not found. Skipping type generation.\");\n        return;\n      }\n\n      await generateFromEntryPoint({\n        outFile,\n        queryFolder: watchFolders[0],\n        warehouseId,\n        noCache: false,\n      });\n    } catch (error) {\n      // throw in production to fail the build\n      if (process.env.NODE_ENV === \"production\") {\n        throw error;\n      }\n      logger.error(\"Error generating types: %O\", error);\n    }\n  }\n\n  return {\n    name: \"appkit-types\",\n\n    apply() {\n      const warehouseId = process.env.DATABRICKS_WAREHOUSE_ID || \"\";\n\n      if (!warehouseId) {\n        logger.debug(\"Warehouse ID not found. Skipping type generation.\");\n        return false;\n      }\n\n      if (!existsSync(path.join(process.cwd(), \"config\", \"queries\"))) {\n        return false;\n      }\n\n      return true;\n    },\n\n    configResolved(config) {\n      const projectRoot = path.resolve(config.root, \"..\");\n      outFile = path.resolve(\n        projectRoot,\n        options?.outFile ?? `shared/${TYPES_DIR}/${ANALYTICS_TYPES_FILE}`,\n      );\n      watchFolders = options?.watchFolders ?? [\n        path.join(process.cwd(), \"config\", \"queries\"),\n      ];\n    },\n\n    buildStart() {\n      generate();\n    },\n\n    configureServer(server) {\n      server.watcher.add(watchFolders);\n\n      server.watcher.on(\"change\", (changedFile) => {\n        const isWatchedFile = watchFolders.some((folder) =>\n          changedFile.startsWith(folder),\n        );\n\n        if (isWatchedFile && changedFile.endsWith(\".sql\")) {\n          generate();\n        }\n      });\n    },\n  };\n}\n"],"mappings":";;;;;;AAUA,MAAM,SAAS,aAAa,6BAA6B;;;;;;;AAkBzD,SAAgB,kBAAkB,SAA4C;CAC5E,IAAI;CACJ,IAAI;CAEJ,eAAe,WAAW;AACxB,MAAI;GACF,MAAM,cAAc,QAAQ,IAAI,2BAA2B;AAE3D,OAAI,CAAC,aAAa;AAChB,WAAO,MAAM,oDAAoD;AACjE;;AAGF,SAAM,uBAAuB;IAC3B;IACA,aAAa,aAAa;IAC1B;IACA,SAAS;IACV,CAAC;WACK,OAAO;AAEd,OAAI,QAAQ,IAAI,aAAa,aAC3B,OAAM;AAER,UAAO,MAAM,8BAA8B,MAAM;;;AAIrD,QAAO;EACL,MAAM;EAEN,QAAQ;AAGN,OAAI,EAFgB,QAAQ,IAAI,2BAA2B,KAEzC;AAChB,WAAO,MAAM,oDAAoD;AACjE,WAAO;;AAGT,OAAI,CAAC,WAAW,KAAK,KAAK,QAAQ,KAAK,EAAE,UAAU,UAAU,CAAC,CAC5D,QAAO;AAGT,UAAO;;EAGT,eAAe,QAAQ;GACrB,MAAM,cAAc,KAAK,QAAQ,OAAO,MAAM,KAAK;AACnD,aAAU,KAAK,QACb,aACA,SAAS,WAAW,UAAU,UAAU,GAAG,uBAC5C;AACD,kBAAe,SAAS,gBAAgB,CACtC,KAAK,KAAK,QAAQ,KAAK,EAAE,UAAU,UAAU,CAC9C;;EAGH,aAAa;AACX,aAAU;;EAGZ,gBAAgB,QAAQ;AACtB,UAAO,QAAQ,IAAI,aAAa;AAEhC,UAAO,QAAQ,GAAG,WAAW,gBAAgB;AAK3C,QAJsB,aAAa,MAAM,WACvC,YAAY,WAAW,OAAO,CAC/B,IAEoB,YAAY,SAAS,OAAO,CAC/C,WAAU;KAEZ;;EAEL"}

package/docs/api/appkit/TypeAlias.ServingFactory.md

@@ -1,15 +1,19 @@
 # Type Alias: ServingFactory
 
 ```ts
-type ServingFactory = keyof ServingEndpointRegistry extends never ? (alias?: string) => ServingEndpointHandle : <K>(alias: K) => ServingEndpointHandle<ServingEndpointRegistry[K]["request"], ServingEndpointRegistry[K]["response"]>;
+type ServingFactory = keyof ServingEndpointRegistry extends never ? (alias?: string) => ServingEndpointHandle : true extends IsUnion<keyof ServingEndpointRegistry> ? <K>(alias: K) => ServingEndpointHandle<ServingEndpointRegistry[K]["request"], ServingEndpointRegistry[K]["response"]> : {
+<K>  (alias: K): ServingEndpointHandle<ServingEndpointRegistry[K]["request"], ServingEndpointRegistry[K]["response"]>;
+  (): ServingEndpointHandle<never, never>;
+};
 
 ```
 
 Factory function returned by `AppKit.serving`.
 
-This is a conditional type that adapts based on whether `ServingEndpointRegistry` has been populated via module augmentation (generated by `appKitServingTypesPlugin()`):
+Adapts based on the `ServingEndpointRegistry` state:
 
-* **Registry empty (default):** `(alias?: string) => ServingEndpointHandle` — accepts any alias string with untyped request/response.
-* **Registry populated:** `<K>(alias: K) => ServingEndpointHandle<...>` — restricts `alias` to known endpoint keys and infers typed request/response from the registry entry.
+* **Empty (default):** `(alias?: string) => ServingEndpointHandle` — any string, untyped.
+* **Single key:** alias optional — `serving()` returns the typed handle for the only endpoint.
+* **Multiple keys:** alias required — must specify which endpoint.
 
-Run `appKitServingTypesPlugin()` in your Vite config to generate the registry augmentation and enable full type safety.
+Run `npx appkit generate-types` or start the dev server to generate the registry.

package/docs/development/type-generation.md

@@ -4,7 +4,9 @@ AppKit can automatically generate TypeScript types for your SQL queries, providi
 
 ## Goal[​](#goal "Direct link to Goal")
 
-Generate `client/src/appKitTypes.d.ts` so query keys, parameters, and result rows are type-safe.
+Generate type-safe TypeScript declarations for query keys, parameters, and result rows.
+
+All generated files live in `shared/appkit-types/`, one per plugin (e.g. `analytics.d.ts`). They use [`declare module`](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation) to augment existing interfaces, so the types apply globally — you never need to import them. TypeScript auto-discovers them through `"include": ["shared/appkit-types"]` in your tsconfig.
 
 ## Vite plugin: `appKitTypesPlugin`[​](#vite-plugin-appkittypesplugin "Direct link to vite-plugin-appkittypesplugin")
 
@@ -12,7 +14,7 @@ The recommended approach is to use the Vite plugin, which watches your SQL files
 
 ### Configuration[​](#configuration "Direct link to Configuration")
 
-* `outFile?: string` - Output file path (default: `src/appKitTypes.d.ts`)
+* `outFile?: string` - Output file path (default: `shared/appkit-types/analytics.d.ts`)
 * `watchFolders?: string[]` - Folders to watch for SQL files (default: `["../config/queries"]`)
 
 ### Example[​](#example "Direct link to Example")
@@ -27,7 +29,6 @@ export default defineConfig({
   plugins: [
     react(),
     appKitTypesPlugin({
-      outFile: "src/appKitTypes.d.ts",
       watchFolders: ["../config/queries"],
     }),
   ],
@@ -54,14 +55,14 @@ npx @databricks/appkit generate-types [rootDir] [outFile] [warehouseId]
 * Generate types using warehouse ID from environment
 
   ```bash
-  npx @databricks/appkit generate-types . client/src/appKitTypes.d.ts
+  npx @databricks/appkit generate-types . shared/appkit-types/analytics.d.ts
 
   ```
 
 * Generate types using warehouse ID explicitly
 
   ```bash
-  npx @databricks/appkit generate-types . client/src/appKitTypes.d.ts abc123...
+  npx @databricks/appkit generate-types . shared/appkit-types/analytics.d.ts abc123...
 
   ```
 

package/docs/plugins/analytics.md

@@ -139,7 +139,7 @@ function SpendTable() {
 Augment the `QueryRegistry` interface to get full type inference on parameters and results:
 
 ```ts
-// config/appKitTypes.d.ts
+// shared/appkit-types/analytics.d.ts
 declare module "@databricks/appkit-ui/react" {
   interface QueryRegistry {
     spend_summary: {

package/docs/plugins/custom-plugins.md

@@ -3,8 +3,12 @@
 If you need custom API routes or background logic, implement an AppKit plugin. The fastest way is to use the CLI:
 
 ```bash
+# Interactive
 npx @databricks/appkit plugin create
 
+# Non-interactive
+npx @databricks/appkit plugin create --placement in-repo --path plugins/my-plugin --name my-plugin --description "My plugin" --force
+
 ```
 
 For a deeper understanding of the plugin structure, read on.

package/docs/plugins/plugin-management.md

@@ -6,19 +6,30 @@ AppKit includes a CLI for managing plugins. All commands are available under `np
 
 ## Create a plugin[​](#create-a-plugin "Direct link to Create a plugin")
 
-Scaffold a new plugin interactively:
+Scaffold a new plugin interactively or via flags:
 
 ```bash
+# Interactive mode (prompts for all options)
 npx @databricks/appkit plugin create
 
+# Non-interactive mode (all required flags provided)
+npx @databricks/appkit plugin create \
+  --placement in-repo \
+  --path plugins/my-plugin \
+  --name my-plugin \
+  --description "My custom plugin" \
+  --resources sql_warehouse \
+  --force
+
 ```
 
-The wizard walks you through:
+In interactive mode, the wizard walks you through:
 
 * **Placement**: In your repository (e.g. `plugins/my-plugin`) or as a standalone package
 * **Metadata**: Name, display name, description
 * **Resources**: Which Databricks resources the plugin needs (SQL Warehouse, Secret, etc.) and whether each is required or optional
-* **Optional fields**: Author, version, license
+
+In non-interactive mode, `--placement`, `--path`, `--name`, and `--description` are required. Resources can be specified as a comma-separated list (`--resources sql_warehouse,volume`) or as JSON for full control (`--resources-json '[{"type":"sql_warehouse","permission":"CAN_MANAGE"}]'`). For all available options, run `npx @databricks/appkit plugin create --help`.
 
 The command generates a complete plugin scaffold with `manifest.json` and a TypeScript plugin class that imports the manifest directly — ready to register in your app.
 
@@ -91,12 +102,17 @@ npx @databricks/appkit plugin list --json
 
 ## Add a resource to a plugin[​](#add-a-resource-to-a-plugin "Direct link to Add a resource to a plugin")
 
-Interactively add a new resource requirement to an existing plugin manifest. **Requires `manifest.json`** in the plugin directory (the command edits it in place; it does not modify `manifest.js`):
+Add a new resource requirement to an existing plugin manifest. **Requires `manifest.json`** in the plugin directory (the command edits it in place; it does not modify `manifest.js`):
 
 ```bash
+# Interactive mode
 npx @databricks/appkit plugin add-resource
-
-# Or specify the plugin directory
 npx @databricks/appkit plugin add-resource --path plugins/my-plugin
 
+# Non-interactive mode (--type triggers flag-based mode)
+npx @databricks/appkit plugin add-resource --path plugins/my-plugin --type sql_warehouse
+npx @databricks/appkit plugin add-resource --path plugins/my-plugin --type volume --no-required --dry-run
+
 ```
+
+In non-interactive mode, only `--type` is required — all other fields (permission, resource key, field env vars) default to sensible values from the schema. Use `--dry-run` to preview the updated manifest without writing. For all available options, run `npx @databricks/appkit plugin add-resource --help`.

package/docs/plugins/vector-search.md

@@ -0,0 +1,247 @@
+# Vector Search plugin
+
+Query Databricks Vector Search indexes with hybrid search, reranking, and cursor pagination from your AppKit application.
+
+**Key features:**
+
+* Named index aliases for multiple Vector Search indexes
+* Hybrid, ANN, and full-text query modes
+* Optional reranking with column-level control
+* Cursor-based pagination for large result sets
+* Service principal (default) and on-behalf-of-user auth
+* Self-managed embedding indexes via custom `embeddingFn`
+
+## Basic usage[​](#basic-usage "Direct link to Basic usage")
+
+```ts
+import { createApp, vectorSearch, server } from "@databricks/appkit";
+
+await createApp({
+  plugins: [
+    server(),
+    vectorSearch({
+      indexes: {
+        products: {
+          indexName: "catalog.schema.products_idx",
+          columns: ["id", "name", "description"],
+          queryType: "hybrid",
+          numResults: 20,
+        },
+      },
+    }),
+  ],
+});
+
+```
+
+## Configuration options[​](#configuration-options "Direct link to Configuration options")
+
+| Option    | Type                          | Default | Description                                              |
+| --------- | ----------------------------- | ------- | -------------------------------------------------------- |
+| `indexes` | `Record<string, IndexConfig>` | —       | **Required.** Map of alias names to index configurations |
+| `timeout` | `number`                      | `30000` | Query timeout in ms                                      |
+
+### Index aliases[​](#index-aliases "Direct link to Index aliases")
+
+Index aliases let you reference multiple Vector Search indexes by name. The alias is used in API routes and programmatic calls:
+
+```ts
+vectorSearch({
+  indexes: {
+    products: {
+      indexName: "catalog.schema.products_idx",
+      columns: ["id", "name", "description"],
+    },
+    docs: {
+      indexName: "catalog.schema.docs_idx",
+      columns: ["id", "title", "content", "url"],
+      queryType: "full_text",
+    },
+  },
+});
+
+```
+
+## IndexConfig[​](#indexconfig "Direct link to IndexConfig")
+
+| Field          | Type                                         | Default               | Description                                                                     |
+| -------------- | -------------------------------------------- | --------------------- | ------------------------------------------------------------------------------- |
+| `indexName`    | `string`                                     | —                     | **Required.** Three-level Unity Catalog name (`catalog.schema.index`)           |
+| `columns`      | `string[]`                                   | —                     | **Required.** Columns to return in query results                                |
+| `queryType`    | `"ann" \| "hybrid" \| "full_text"`           | `"hybrid"`            | Search mode                                                                     |
+| `numResults`   | `number`                                     | `20`                  | Maximum results per query                                                       |
+| `reranker`     | `boolean \| { columnsToRerank: string[] }`   | —                     | Enable reranking. Pass `true` to rerank all result columns, or specify a subset |
+| `auth`         | `"service-principal" \| "on-behalf-of-user"` | `"service-principal"` | Authentication mode for query execution                                         |
+| `pagination`   | `boolean`                                    | —                     | Enable cursor-based pagination                                                  |
+| `endpointName` | `string`                                     | —                     | Vector Search endpoint name. Required when `pagination` is `true`               |
+| `embeddingFn`  | `(text: string) => Promise<number[]>`        | —                     | Custom embedding function for self-managed embedding indexes                    |
+
+### Query types[​](#query-types "Direct link to Query types")
+
+* **`hybrid`** — Combines vector similarity and keyword search. Best for general-purpose retrieval.
+* **`ann`** — Approximate nearest neighbor search using embeddings only. Best for semantic similarity.
+* **`full_text`** — Keyword-based search with no embedding required.
+
+### Reranking[​](#reranking "Direct link to Reranking")
+
+Reranking improves result relevance by running a second-stage model over the initial candidates:
+
+```ts
+vectorSearch({
+  indexes: {
+    products: {
+      indexName: "catalog.schema.products_idx",
+      columns: ["id", "name", "description", "category"],
+      reranker: { columnsToRerank: ["name", "description"] },
+    },
+  },
+});
+
+```
+
+Pass `reranker: true` to rerank across all returned columns.
+
+### On-behalf-of-user auth[​](#on-behalf-of-user-auth "Direct link to On-behalf-of-user auth")
+
+By default, queries run as the app's service principal. Set `auth: "on-behalf-of-user"` to execute queries as the signed-in user instead:
+
+```ts
+vectorSearch({
+  indexes: {
+    documents: {
+      indexName: "catalog.schema.documents_idx",
+      columns: ["id", "title", "body"],
+      auth: "on-behalf-of-user",
+    },
+  },
+});
+
+```
+
+### Pagination[​](#pagination "Direct link to Pagination")
+
+Enable cursor pagination to page through large result sets:
+
+```ts
+vectorSearch({
+  indexes: {
+    products: {
+      indexName: "catalog.schema.products_idx",
+      columns: ["id", "name", "description"],
+      pagination: true,
+      endpointName: "my-vector-search-endpoint",
+    },
+  },
+});
+
+```
+
+`endpointName` is required when `pagination` is `true`. Use the `/:alias/next-page` route to fetch subsequent pages.
+
+### Self-managed embedding indexes[​](#self-managed-embedding-indexes "Direct link to Self-managed embedding indexes")
+
+For indexes that manage their own embeddings, provide an `embeddingFn` that takes a query string and returns a vector:
+
+```ts
+import { embed } from "./my-embedding-client";
+
+vectorSearch({
+  indexes: {
+    products: {
+      indexName: "catalog.schema.products_idx",
+      columns: ["id", "name", "description"],
+      queryType: "ann",
+      embeddingFn: (text) => embed(text),
+    },
+  },
+});
+
+```
+
+## HTTP routes[​](#http-routes "Direct link to HTTP routes")
+
+Routes are mounted at `/api/vector-search`.
+
+| Method | Path                | Description                                                  |
+| ------ | ------------------- | ------------------------------------------------------------ |
+| `POST` | `/:alias/query`     | Query an index by alias                                      |
+| `POST` | `/:alias/next-page` | Fetch the next page of results (requires `pagination: true`) |
+| `GET`  | `/:alias/config`    | Return the resolved config for an index alias                |
+
+### Query an index[​](#query-an-index "Direct link to Query an index")
+
+```text
+POST /api/vector-search/:alias/query
+Content-Type: application/json
+
+{
+  "queryText": "machine learning guide",
+  "numResults": 10
+}
+
+```
+
+Response:
+
+```json
+{
+  "results": [
+    { "id": "42", "name": "Intro to ML", "description": "..." }
+  ],
+  "nextPageToken": "eyJvZmZzZXQiOjEwfQ=="
+}
+
+```
+
+`nextPageToken` is only present when `pagination` is enabled and more results are available.
+
+### Fetch the next page[​](#fetch-the-next-page "Direct link to Fetch the next page")
+
+```text
+POST /api/vector-search/:alias/next-page
+Content-Type: application/json
+
+{
+  "queryText": "machine learning guide",
+  "pageToken": "eyJvZmZzZXQiOjEwfQ=="
+}
+
+```
+
+### Get index config[​](#get-index-config "Direct link to Get index config")
+
+```text
+GET /api/vector-search/:alias/config
+
+```
+
+Returns the resolved `IndexConfig` for the alias (excluding `embeddingFn`).
+
+## Programmatic access[​](#programmatic-access "Direct link to Programmatic access")
+
+The plugin exposes a `query` method for server-side use:
+
+```ts
+const AppKit = await createApp({
+  plugins: [
+    server(),
+    vectorSearch({
+      indexes: {
+        products: {
+          indexName: "catalog.schema.products_idx",
+          columns: ["id", "name", "description"],
+        },
+      },
+    }),
+  ],
+});
+
+const result = await AppKit.vectorSearch.query("products", {
+  queryText: "machine learning guide",
+});
+
+console.log(result.results);
+
+```
+
+Pass optional overrides as a second argument to `query` to adjust `numResults` or other per-call settings.

package/llms.txt

@@ -52,6 +52,7 @@ npx @databricks/appkit docs <query>
 - [Plugin management](./docs/plugins/plugin-management.md): AppKit includes a CLI for managing plugins. All commands are available under npx @databricks/appkit plugin.
 - [Server plugin](./docs/plugins/server.md): Provides HTTP server capabilities with development and production modes.
 - [Serving plugin](./docs/plugins/serving.md): Provides an authenticated proxy to Databricks Model Serving endpoints, with invoke and streaming support.
+- [Vector Search plugin](./docs/plugins/vector-search.md): Query Databricks Vector Search indexes with hybrid search, reranking, and cursor pagination from your AppKit application.
 
 ## appkit API reference [collapsed]
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@databricks/appkit",
   "type": "module",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "packageManager": "pnpm@10.21.0",