@dotcms/client 1.2.0-next.5 → 1.2.0-next.6

package/README.md

@@ -241,17 +241,17 @@ Before using AI-powered search, ensure your dotCMS instance is properly configur
 #### Basic AI Search
 ```typescript
 // Search for content semantically related to your query
-const results = await client.ai.search(
+const response = await client.ai.search(
     'articles about machine learning',
     'content_index'
 );
-console.log(results.dotCMSResults);
+console.log(response.results);
 ```
 
 #### Customizing Search Parameters
 ```typescript
 // Fine-tune search with query parameters
-const results = await client.ai.search(
+const response = await client.ai.search(
     'artificial intelligence tutorials',
     'content_index',
     {
@@ -270,7 +270,7 @@ const results = await client.ai.search(
 import { DISTANCE_FUNCTIONS } from '@dotcms/types';
 
 // Customize AI search behavior with threshold and distance function
-const results = await client.ai.search(
+const response = await client.ai.search(
     'deep learning concepts',
     'content_index',
     {
@@ -286,7 +286,7 @@ const results = await client.ai.search(
 #### Complete Example with All Options
 ```typescript
 // Combine query and AI parameters for precise control
-const results = await client.ai.search(
+const response = await client.ai.search(
     'best practices for content management',
     'articles_index',
     {
@@ -306,7 +306,7 @@ const results = await client.ai.search(
 );
 
 // Access results with match scores
-results.dotCMSResults.forEach(result => {
+resp[onse].results.forEach(result => {
     console.log(result.title);
     console.log('Matches:', result.matches); // Distance and extracted text
 });
@@ -416,7 +416,7 @@ interface Article extends DotCMSBasicContentlet {
 }
 
 // Type-safe AI search
-const results: DotCMSAISearchResponse<Article> = await client.ai.search<Article>(
+const response: DotCMSAISearchResponse<Article> = await client.ai.search<Article>(
     'machine learning tutorials',
     'content_index',
     {
@@ -432,7 +432,7 @@ const results: DotCMSAISearchResponse<Article> = await client.ai.search<Article>
 );
 
 // Access typed results with match information
-results.dotCMSResults.forEach(article => {
+response.results.forEach(article => {
     console.log(article.title);           // ✅ Type-safe: string
     console.log(article.category);        // ✅ Type-safe: string
 
@@ -818,7 +818,7 @@ search<T extends DotCMSBasicContentlet>(
 
 ```typescript
 interface DotCMSAISearchResponse<T> {
-    dotCMSResults: Array<T & {
+    results: Array<T & {
         matches?: Array<{
             distance: number;      // Similarity score
             extractedText: string; // Matched text excerpt
@@ -867,9 +867,9 @@ client.ai.search(
         query: { limit: 10 },
         config: { threshold: 0.8 }
     }
-).then((results) => {
-    console.log('Found:', results.dotCMSResults.length);
-    return results;
+).then((response) => {
+    console.log('Found:', response.results.length);
+    return response;
 }).catch((error) => {
     console.error('Search failed:', error.message);
 });

package/index.cjs.js

@@ -336,12 +336,16 @@ class AISearch extends BaseApiClient {
      */
     then(onfulfilled, onrejected) {
         return this.fetch().then((data) => {
+            const response = {
+                ...data,
+                results: data.dotCMSResults
+            };
             if (typeof onfulfilled === 'function') {
-                const result = onfulfilled(data);
-                // Ensure we always return a value, fallback to formattedResponse if callback returns undefined
-                return result ?? data;
+                const result = onfulfilled(response);
+                // Ensure we always return a value, fallback to data if callback returns undefined
+                return result ?? response;
             }
-            return data;
+            return response;
         }, (error) => {
             // Wrap error in DotCMSContentError
             let contentError;
@@ -469,7 +473,7 @@ class AIClient extends BaseApiClient {
      * @example
      * @example
      * ```typescript
-     * const results = await client.ai.search('machine learning articles', 'content_index', {
+     * const response = await client.ai.search('machine learning articles', 'content_index', {
      *   query: {
      *     limit: 20,
      *     contentType: 'BlogPost',
@@ -492,8 +496,8 @@ class AIClient extends BaseApiClient {
      *     threshold: 0.7,
      *     distanceFunction: DISTANCE_FUNCTIONS.cosine
      *   }
-     * }).then((results) => {
-     *   console.log(results);
+     * }).then((response) => {
+     *   console.log(response.results);
      * }).catch((error) => {
      *   console.error(error);
      * });

package/index.esm.js

@@ -334,12 +334,16 @@ class AISearch extends BaseApiClient {
      */
     then(onfulfilled, onrejected) {
         return this.fetch().then((data) => {
+            const response = {
+                ...data,
+                results: data.dotCMSResults
+            };
             if (typeof onfulfilled === 'function') {
-                const result = onfulfilled(data);
-                // Ensure we always return a value, fallback to formattedResponse if callback returns undefined
-                return result ?? data;
+                const result = onfulfilled(response);
+                // Ensure we always return a value, fallback to data if callback returns undefined
+                return result ?? response;
             }
-            return data;
+            return response;
         }, (error) => {
             // Wrap error in DotCMSContentError
             let contentError;
@@ -467,7 +471,7 @@ class AIClient extends BaseApiClient {
      * @example
      * @example
      * ```typescript
-     * const results = await client.ai.search('machine learning articles', 'content_index', {
+     * const response = await client.ai.search('machine learning articles', 'content_index', {
      *   query: {
      *     limit: 20,
      *     contentType: 'BlogPost',
@@ -490,8 +494,8 @@ class AIClient extends BaseApiClient {
      *     threshold: 0.7,
      *     distanceFunction: DISTANCE_FUNCTIONS.cosine
      *   }
-     * }).then((results) => {
-     *   console.log(results);
+     * }).then((response) => {
+     *   console.log(response.results);
      * }).catch((error) => {
      *   console.error(error);
      * });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/client",
-  "version": "1.2.0-next.5",
+  "version": "1.2.0-next.6",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",

package/src/lib/client/ai/ai-api.d.ts

@@ -44,7 +44,7 @@ export declare class AIClient extends BaseApiClient {
      * @example
      * @example
      * ```typescript
-     * const results = await client.ai.search('machine learning articles', 'content_index', {
+     * const response = await client.ai.search('machine learning articles', 'content_index', {
      *   query: {
      *     limit: 20,
      *     contentType: 'BlogPost',
@@ -67,8 +67,8 @@ export declare class AIClient extends BaseApiClient {
      *     threshold: 0.7,
      *     distanceFunction: DISTANCE_FUNCTIONS.cosine
      *   }
-     * }).then((results) => {
-     *   console.log(results);
+     * }).then((response) => {
+     *   console.log(response.results);
      * }).catch((error) => {
      *   console.error(error);
      * });