@dotcms/react 1.2.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/react",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "peerDependencies": {
     "react": ">=18",
     "react-dom": ">=18"

package/src/index.d.ts

@@ -5,3 +5,5 @@ export { useEditableDotCMSPage } from './lib/next/hooks/useEditableDotCMSPage';
 export { DotCMSEditableText } from './lib/next/components/DotCMSEditableText/DotCMSEditableText';
 export { DotCMSBlockEditorRenderer, BlockEditorRendererProps, CustomRenderer, CustomRendererProps } from './lib/next/components/DotCMSBlockEditorRenderer/DotCMSBlockEditorRenderer';
 export { DotCMSLayoutBodyProps } from './lib/next/components/DotCMSLayoutBody/DotCMSLayoutBody';
+export { useAISearch } from './lib/next/hooks/useAISearch';
+export type { DotCMSAISearchValue, DotCMSAISearchProps } from './lib/next/shared/types';

package/src/lib/next/hooks/useAISearch.d.ts

@@ -0,0 +1,30 @@
+import { DotCMSBasicContentlet } from '@dotcms/types';
+import { DotCMSAISearchProps, DotCMSAISearchValue } from '../shared/types';
+/**
+ * Hook to search for contentlets using AI.
+ * @template T - The type of the contentlet.
+ * @param client - The client to use for the search.
+ * @param indexName - The name of the index to search in.
+ * @param params - The parameters for the search.
+ * @returns The search results.
+ *
+ * @example
+ * ```typescript
+ * const { results, status, search, reset } = useAISearch<BlogPost>({
+ *   client: dotCMSClient,
+ *   indexName: 'blog-search-index',
+ *   params: {
+ *     query: {
+ *       limit: 10,
+ *       offset: 0,
+ *       contentType: 'Blog'
+ *     },
+ *     config: {
+ *       threshold: 0.5,
+ *       responseLength: 1024
+ *     }
+ *   }
+ * });
+ * ```
+ */
+export declare const useAISearch: <T extends DotCMSBasicContentlet>({ client, indexName, params }: DotCMSAISearchProps) => DotCMSAISearchValue<T>;

package/src/lib/next/shared/types.d.ts

@@ -0,0 +1,24 @@
+import { createDotCMSClient } from '@dotcms/client';
+import { DotCMSAISearchContentletData, DotCMSAISearchParams, DotCMSAISearchResponse, DotCMSBasicContentlet, DotCMSEntityStatus } from '@dotcms/types';
+/**
+ * Return type of the AI Search context
+ * @interface DotCMSAISearchContextValue
+ * @template T - The content type extending DotCMSBasicContentlet
+ */
+export interface DotCMSAISearchValue<T extends DotCMSBasicContentlet> {
+    response: DotCMSAISearchResponse<T> | null;
+    results: DotCMSAISearchContentletData<T>[];
+    status: DotCMSEntityStatus;
+    search: (prompt: string) => Promise<void>;
+    reset: () => void;
+}
+/**
+ * Props for the DotCMSAISearchProvider
+ * @interface DotCMSAISearchProviderProps
+ * @template T - The content type extending DotCMSBasicContentlet
+ */
+export interface DotCMSAISearchProps {
+    client: ReturnType<typeof createDotCMSClient>;
+    indexName: string;
+    params: DotCMSAISearchParams;
+}