@upstash/react-redis-browser 0.2.14-rc.9 → 0.2.14

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Redis } from '@upstash/redis';
 
 type DarkModeOption = "dark" | "light";
 
@@ -13,6 +14,24 @@ type RedisCredentials = {
     token?: string;
 };
 
+type RedisSearchDescribeFunc = ReturnType<Redis["search"]["index"]>["describe"];
+type SearchIndex = NonNullable<Awaited<ReturnType<RedisSearchDescribeFunc>>>;
+
+type SampleDataItem = {
+    key: string;
+    data: Record<string, any> | string | null;
+};
+type QueryWizardContext = {
+    prompt: string;
+    searchIndex: SearchIndex | undefined;
+    sampleData: SampleDataItem[];
+    searchTypes: string;
+};
+type QueryWizardResponse = {
+    query: any;
+};
+type UseQueryWizard = (context: QueryWizardContext) => Promise<QueryWizardResponse>;
+
 /**
  * Persistence storage interface for the Databrowser.
  */
@@ -21,7 +40,7 @@ type RedisBrowserStorage = {
     get: () => string | null;
 };
 type TabType = "keys" | "search" | "all";
-declare const RedisBrowser: ({ url, token, hideTabs, tabType, storage, disableTelemetry, onFullScreenClick, theme, allowSearch, }: RedisCredentials & {
+declare const RedisBrowser: ({ url, token, hideTabs, tabType, storage, disableTelemetry, onFullScreenClick, theme, allowSearch, useQueryWizard, }: RedisCredentials & {
     /**
      * Whether to disable telemetry.
      *
@@ -84,6 +103,33 @@ declare const RedisBrowser: ({ url, token, hideTabs, tabType, storage, disableTe
      * @default true
      */
     allowSearch?: boolean;
+    /**
+     * AI Query Wizard function for generating Redis search queries from natural language.
+     * When provided, a wizard button (🪄) appears in the Search tab that allows users to
+     * generate queries using AI.
+     *
+     * The function receives:
+     * - prompt: User's natural language query
+     * - schema: Current index schema
+     * - sampleData: First ~10 items from the database
+     * - searchTypes: Redis search type definitions
+     *
+     * And should return a query object.
+     *
+     * @example
+     * ```tsx
+     * <RedisBrowser
+     *   useQueryWizard={async ({ prompt, schema, sampleData, searchTypes }) => {
+     *     const response = await fetch('/api/generate-query', {
+     *       method: 'POST',
+     *       body: JSON.stringify({ prompt, schema, sampleData, searchTypes }),
+     *     })
+     *     return await response.json()
+     *   }}
+     * />
+     * ```
+     */
+    useQueryWizard?: UseQueryWizard;
 }) => react_jsx_runtime.JSX.Element;
 
-export { type DarkModeOption, RedisBrowser, type RedisBrowserStorage };
+export { type DarkModeOption, type QueryWizardContext, type QueryWizardResponse, RedisBrowser, type RedisBrowserStorage, type SampleDataItem, type UseQueryWizard };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Redis } from '@upstash/redis';
 
 type DarkModeOption = "dark" | "light";
 
@@ -13,6 +14,24 @@ type RedisCredentials = {
     token?: string;
 };
 
+type RedisSearchDescribeFunc = ReturnType<Redis["search"]["index"]>["describe"];
+type SearchIndex = NonNullable<Awaited<ReturnType<RedisSearchDescribeFunc>>>;
+
+type SampleDataItem = {
+    key: string;
+    data: Record<string, any> | string | null;
+};
+type QueryWizardContext = {
+    prompt: string;
+    searchIndex: SearchIndex | undefined;
+    sampleData: SampleDataItem[];
+    searchTypes: string;
+};
+type QueryWizardResponse = {
+    query: any;
+};
+type UseQueryWizard = (context: QueryWizardContext) => Promise<QueryWizardResponse>;
+
 /**
  * Persistence storage interface for the Databrowser.
  */
@@ -21,7 +40,7 @@ type RedisBrowserStorage = {
     get: () => string | null;
 };
 type TabType = "keys" | "search" | "all";
-declare const RedisBrowser: ({ url, token, hideTabs, tabType, storage, disableTelemetry, onFullScreenClick, theme, allowSearch, }: RedisCredentials & {
+declare const RedisBrowser: ({ url, token, hideTabs, tabType, storage, disableTelemetry, onFullScreenClick, theme, allowSearch, useQueryWizard, }: RedisCredentials & {
     /**
      * Whether to disable telemetry.
      *
@@ -84,6 +103,33 @@ declare const RedisBrowser: ({ url, token, hideTabs, tabType, storage, disableTe
      * @default true
      */
     allowSearch?: boolean;
+    /**
+     * AI Query Wizard function for generating Redis search queries from natural language.
+     * When provided, a wizard button (🪄) appears in the Search tab that allows users to
+     * generate queries using AI.
+     *
+     * The function receives:
+     * - prompt: User's natural language query
+     * - schema: Current index schema
+     * - sampleData: First ~10 items from the database
+     * - searchTypes: Redis search type definitions
+     *
+     * And should return a query object.
+     *
+     * @example
+     * ```tsx
+     * <RedisBrowser
+     *   useQueryWizard={async ({ prompt, schema, sampleData, searchTypes }) => {
+     *     const response = await fetch('/api/generate-query', {
+     *       method: 'POST',
+     *       body: JSON.stringify({ prompt, schema, sampleData, searchTypes }),
+     *     })
+     *     return await response.json()
+     *   }}
+     * />
+     * ```
+     */
+    useQueryWizard?: UseQueryWizard;
 }) => react_jsx_runtime.JSX.Element;
 
-export { type DarkModeOption, RedisBrowser, type RedisBrowserStorage };
+export { type DarkModeOption, type QueryWizardContext, type QueryWizardResponse, RedisBrowser, type RedisBrowserStorage, type SampleDataItem, type UseQueryWizard };