@dotcms/client 1.2.0-next.2 → 1.2.0-next.4

package/index.cjs.js

@@ -147,6 +147,362 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
 
+/**
+ * Utility functions for AI search parameter mapping and processing
+ */
+/**
+ * Appends mapped parameters to URLSearchParams based on a mapping configuration.
+ * Only includes parameters that have defined values.
+ *
+ * @param searchParams - The URLSearchParams object to append to
+ * @param sourceObject - The source object containing values
+ * @param mapping - Array of [targetKey, sourceKey] pairs for parameter mapping, or [key] to use same key
+ * @example
+ * ```typescript
+ * const params = new URLSearchParams();
+ * const query = { limit: 10, offset: 0, siteId: 'default', indexName: 'content' };
+ * const mapping = [
+ *   ['searchLimit', 'limit'],    // Maps limit -> searchLimit
+ *   ['searchOffset', 'offset'],  // Maps offset -> searchOffset
+ *   ['site', 'siteId'],          // Maps siteId -> site
+ *   ['indexName']                // Uses indexName -> indexName (same key)
+ * ];
+ * appendMappedParams(params, query, mapping);
+ * // Results in: searchLimit=10&searchOffset=0&site=default&indexName=content
+ * ```
+ */
+function appendMappedParams(searchParams, sourceObject, mapping) {
+    mapping.forEach((item) => {
+        const targetKey = item[0];
+        const sourceKey = item[1] ?? item[0];
+        const value = sourceObject[sourceKey];
+        if (value !== undefined) {
+            searchParams.append(targetKey, String(value));
+        }
+    });
+}
+
+var _BaseApiClient_requestOptions, _BaseApiClient_config, _BaseApiClient_httpClient;
+/**
+ * Base class for all DotCMS API clients.
+ * Provides common constructor parameters and properties that all API clients need.
+ * Uses JavaScript private fields (#) for true runtime privacy.
+ */
+class BaseApiClient {
+    /**
+     * Creates a new API client instance.
+     *
+     * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
+     * @param {DotRequestOptions} requestOptions - Options for fetch requests including authorization headers
+     * @param {DotHttpClient} httpClient - HTTP client for making requests
+     */
+    constructor(config, requestOptions = {}, httpClient) {
+        /**
+         * Request options including authorization headers.
+         * @private
+         */
+        _BaseApiClient_requestOptions.set(this, void 0);
+        /**
+         * DotCMS client configuration.
+         * @private
+         */
+        _BaseApiClient_config.set(this, void 0);
+        /**
+         * HTTP client for making requests.
+         * @private
+         */
+        _BaseApiClient_httpClient.set(this, void 0);
+        __classPrivateFieldSet(this, _BaseApiClient_config, {
+            siteId: '',
+            ...config
+        }, "f");
+        __classPrivateFieldSet(this, _BaseApiClient_requestOptions, {
+            ...requestOptions
+        }, "f");
+        __classPrivateFieldSet(this, _BaseApiClient_httpClient, httpClient, "f");
+    }
+    /**
+     * Gets the request options including authorization headers.
+     * @protected
+     */
+    get requestOptions() {
+        return __classPrivateFieldGet(this, _BaseApiClient_requestOptions, "f");
+    }
+    /**
+     * Gets the DotCMS client configuration.
+     * @protected
+     */
+    get config() {
+        return __classPrivateFieldGet(this, _BaseApiClient_config, "f");
+    }
+    /**
+     * Gets the HTTP client for making requests.
+     * @protected
+     */
+    get httpClient() {
+        return __classPrivateFieldGet(this, _BaseApiClient_httpClient, "f");
+    }
+    /**
+     * Gets the DotCMS URL from config.
+     * @protected
+     */
+    get dotcmsUrl() {
+        return __classPrivateFieldGet(this, _BaseApiClient_config, "f").dotcmsUrl;
+    }
+    /**
+     * Gets the site ID from config.
+     * @protected
+     */
+    get siteId() {
+        return __classPrivateFieldGet(this, _BaseApiClient_config, "f").siteId || '';
+    }
+}
+_BaseApiClient_requestOptions = new WeakMap(), _BaseApiClient_config = new WeakMap(), _BaseApiClient_httpClient = new WeakMap();
+
+/**
+ * Default values for AI configuration
+ */
+const DEFAULT_AI_CONFIG = {
+    threshold: 0.5,
+    distanceFunction: types.DISTANCE_FUNCTIONS.cosine,
+    responseLength: 1024
+};
+/**
+ * Default values for search query
+ */
+const DEFAULT_QUERY = {
+    limit: 1000,
+    offset: 0,
+    indexName: 'default'
+};
+
+var _AISearch_params, _AISearch_prompt, _AISearch_indexName;
+/**
+ * Class for executing AI searches.
+ *
+ * @template T - The type of the contentlet.
+ * @param config - The configuration for the client.
+ * @param requestOptions - The request options for the client.
+ * @param httpClient - The HTTP client for the client.
+ * @param params - The parameters for the search.
+ * @param prompt - The prompt for the search.
+ */
+class AISearch extends BaseApiClient {
+    constructor(config, requestOptions, httpClient, prompt, indexName, params = {}) {
+        super(config, requestOptions, httpClient);
+        _AISearch_params.set(this, void 0);
+        _AISearch_prompt.set(this, void 0);
+        _AISearch_indexName.set(this, void 0);
+        __classPrivateFieldSet(this, _AISearch_params, params, "f");
+        __classPrivateFieldSet(this, _AISearch_prompt, prompt, "f");
+        __classPrivateFieldSet(this, _AISearch_indexName, indexName, "f");
+    }
+    /**
+     * Executes the AI search and returns a promise with the search results.
+     *
+     * @param onfulfilled - Callback function to handle the search results.
+     * @param onrejected - Callback function to handle the search error.
+     * @returns Promise with the search results or the error.
+     * @example
+     * ```typescript
+     * const results = await client.ai.search('machine learning articles', 'content_index', {
+     *   query: {
+     *     limit: 20,
+     *     contentType: 'BlogPost',
+     *     languageId: '1' // or 1
+     *   },
+     *   config: {
+     *     threshold: 0.7
+     *   }
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * client.ai.search('machine learning articles', 'content_index', {
+     *   query: {
+     *     limit: 20,
+     *     contentType: 'BlogPost',
+     *     languageId: '1' // or 1
+     *   },
+     *   config: {
+     *     threshold: 0.7
+     *   }
+     * }).then((results) => {
+     *   console.log(results);
+     * }).catch((error) => {
+     *   console.error(error);
+     * });
+     * ```
+     */
+    then(onfulfilled, onrejected) {
+        return this.fetch().then((data) => {
+            if (typeof onfulfilled === 'function') {
+                const result = onfulfilled(data);
+                // Ensure we always return a value, fallback to formattedResponse if callback returns undefined
+                return result ?? data;
+            }
+            return data;
+        }, (error) => {
+            // Wrap error in DotCMSContentError
+            let contentError;
+            if (error instanceof types.DotHttpError) {
+                contentError = new types.DotErrorAISearch({
+                    message: `AI Search failed (fetch): ${error.message}`,
+                    httpError: error,
+                    params: __classPrivateFieldGet(this, _AISearch_params, "f"),
+                    prompt: __classPrivateFieldGet(this, _AISearch_prompt, "f"),
+                    indexName: __classPrivateFieldGet(this, _AISearch_indexName, "f")
+                });
+            }
+            else {
+                const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                contentError = new types.DotErrorAISearch({
+                    message: `AI Search failed (fetch): ${errorMessage}`,
+                    httpError: undefined,
+                    params: __classPrivateFieldGet(this, _AISearch_params, "f"),
+                    prompt: __classPrivateFieldGet(this, _AISearch_prompt, "f"),
+                    indexName: __classPrivateFieldGet(this, _AISearch_indexName, "f")
+                });
+            }
+            if (typeof onrejected === 'function') {
+                const result = onrejected(contentError);
+                // Ensure we always return a value, fallback to original error if callback returns undefined
+                return result ?? contentError;
+            }
+            // Throw the wrapped error to trigger .catch()
+            throw contentError;
+        });
+    }
+    fetch() {
+        const searchParams = this.buildSearchParams(__classPrivateFieldGet(this, _AISearch_prompt, "f"), __classPrivateFieldGet(this, _AISearch_params, "f"));
+        const url = new URL('/api/v1/ai/search', this.dotcmsUrl);
+        url.search = searchParams.toString();
+        return this.httpClient.request(url.toString(), {
+            ...this.requestOptions,
+            headers: {
+                ...this.requestOptions.headers
+            },
+            method: 'GET'
+        });
+    }
+    /**
+     * Builds URLSearchParams from the SDK interface, mapping to backend parameter names.
+     * Only includes parameters that have values.
+     *
+     * @param params - Search parameters with SDK naming
+     * @returns URLSearchParams with backend parameter names
+     * @private
+     */
+    buildSearchParams(prompt, params = {}) {
+        const searchParams = new URLSearchParams();
+        const { query = {}, config = {} } = params;
+        const combinedQuery = {
+            ...DEFAULT_QUERY,
+            siteId: this.siteId,
+            ...query
+        };
+        const combinedConfig = {
+            ...DEFAULT_AI_CONFIG,
+            ...config
+        };
+        const entriesQueryParameters = [
+            ['searchLimit', 'limit'],
+            ['searchOffset', 'offset'],
+            ['site', 'siteId'],
+            ['language', 'languageId'],
+            ['contentType']
+        ];
+        // Map SDK query parameters to backend parameter names
+        appendMappedParams(searchParams, combinedQuery, entriesQueryParameters);
+        // Map config parameters using the same key names
+        appendMappedParams(searchParams, combinedConfig, Object.keys(combinedConfig).map((key) => [key]));
+        // Add search-specific parameters
+        searchParams.append('indexName', __classPrivateFieldGet(this, _AISearch_indexName, "f"));
+        searchParams.append('query', prompt);
+        return searchParams;
+    }
+}
+_AISearch_params = new WeakMap(), _AISearch_prompt = new WeakMap(), _AISearch_indexName = new WeakMap();
+
+/**
+ * Client for interacting with the DotCMS AI API.
+ * Provides methods to interact with AI features.
+ * @experimental This client is experimental and may be subject to change.
+ */
+class AIClient extends BaseApiClient {
+    /**
+     * Creates a new AIClient instance.
+     *
+     * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
+     * @param {DotRequestOptions} requestOptions - Options for fetch requests including authorization headers
+     * @param {DotHttpClient} httpClient - HTTP client for making requests
+     * @example
+     * ```typescript
+     * const aiClient = new AIClient(
+     *   {
+     *     dotcmsUrl: 'https://demo.dotcms.com',
+     *     authToken: 'your-auth-token',
+     *     siteId: 'demo.dotcms.com'
+     *   },
+     *   {
+     *     headers: {
+     *       Authorization: 'Bearer your-auth-token'
+     *     }
+     *   },
+     *   httpClient
+     * );
+     * ```
+     */
+    constructor(config, requestOptions, httpClient) {
+        super(config, requestOptions, httpClient);
+    }
+    /**
+     * Performs an AI-powered search.
+     *
+     * @param params - Search parameters with query and AI configuration
+     * @returns Promise with search results
+     * @experimental This method is experimental and may be subject to change.
+     * @template T - The type of the contentlet.
+     * @param prompt - The prompt for the search.
+     * @param indexName - The name of the index you want to search in.
+     * @param params - Search parameters with query and AI configuration.
+     * @example
+     * @example
+     * ```typescript
+     * const results = await client.ai.search('machine learning articles', 'content_index', {
+     *   query: {
+     *     limit: 20,
+     *     contentType: 'BlogPost',
+     *     languageId: "1" // or 1
+     *   },
+     *   config: {
+     *     threshold: 0.7
+     *   }
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * client.ai.search('machine learning articles', 'content_index', {
+     *   query: {
+     *     limit: 20,
+     *     contentType: 'BlogPost',
+     *     languageId: "1" // or 1
+     *   },
+     *   config: {
+     *     threshold: 0.7,
+     *     distanceFunction: DISTANCE_FUNCTIONS.cosine
+     *   }
+     * }).then((results) => {
+     *   console.log(results);
+     * }).catch((error) => {
+     *   console.error(error);
+     * });
+     */
+    search(prompt, indexName, params = {}) {
+        return new AISearch(this.config, this.requestOptions, this.httpClient, prompt, indexName, params);
+    }
+}
+
 /**
  * Default variant identifier used in the application.
  */
@@ -746,7 +1102,7 @@ class QueryBuilder {
 }
 _QueryBuilder_query = new WeakMap();
 
-var _CollectionBuilder_page, _CollectionBuilder_limit, _CollectionBuilder_depth, _CollectionBuilder_render, _CollectionBuilder_sortBy, _CollectionBuilder_contentType, _CollectionBuilder_defaultQuery, _CollectionBuilder_query, _CollectionBuilder_rawQuery, _CollectionBuilder_languageId, _CollectionBuilder_draft, _CollectionBuilder_requestOptions, _CollectionBuilder_httpClient, _CollectionBuilder_config;
+var _CollectionBuilder_page, _CollectionBuilder_limit, _CollectionBuilder_depth, _CollectionBuilder_render, _CollectionBuilder_sortBy, _CollectionBuilder_contentType, _CollectionBuilder_defaultQuery, _CollectionBuilder_query, _CollectionBuilder_rawQuery, _CollectionBuilder_languageId, _CollectionBuilder_draft;
 /**
  * Creates a Builder to filter and fetch content from the content API for a specific content type.
  *
@@ -754,7 +1110,7 @@ var _CollectionBuilder_page, _CollectionBuilder_limit, _CollectionBuilder_depth,
  * @class CollectionBuilder
  * @template T Represents the type of the content type to fetch. Defaults to unknown.
  */
-class CollectionBuilder {
+class CollectionBuilder extends BaseApiClient {
     /**
      * Creates an instance of CollectionBuilder.
      * @param {ClientOptions} requestOptions Options for the client request.
@@ -764,6 +1120,7 @@ class CollectionBuilder {
      * @memberof CollectionBuilder
      */
     constructor(requestOptions, config, contentType, httpClient) {
+        super(config, requestOptions, httpClient);
         _CollectionBuilder_page.set(this, 1);
         _CollectionBuilder_limit.set(this, 10);
         _CollectionBuilder_depth.set(this, 0);
@@ -775,14 +1132,7 @@ class CollectionBuilder {
         _CollectionBuilder_rawQuery.set(this, void 0);
         _CollectionBuilder_languageId.set(this, 1);
         _CollectionBuilder_draft.set(this, false);
-        _CollectionBuilder_requestOptions.set(this, void 0);
-        _CollectionBuilder_httpClient.set(this, void 0);
-        _CollectionBuilder_config.set(this, void 0);
-        __classPrivateFieldSet(this, _CollectionBuilder_requestOptions, requestOptions, "f");
-        __classPrivateFieldSet(this, _CollectionBuilder_config, config, "f");
         __classPrivateFieldSet(this, _CollectionBuilder_contentType, contentType, "f");
-        __classPrivateFieldSet(this, _CollectionBuilder_httpClient, httpClient, "f");
-        __classPrivateFieldSet(this, _CollectionBuilder_config, config, "f");
         // Build the default query with the contentType field
         __classPrivateFieldSet(this, _CollectionBuilder_defaultQuery, new QueryBuilder().field('contentType').equals(__classPrivateFieldGet(this, _CollectionBuilder_contentType, "f")), "f");
     }
@@ -814,17 +1164,7 @@ class CollectionBuilder {
      * @memberof CollectionBuilder
      */
     get url() {
-        return `${__classPrivateFieldGet(this, _CollectionBuilder_config, "f").dotcmsUrl}${CONTENT_API_URL}`;
-    }
-    /**
-     * Returns the site ID from the configuration.
-     *
-     * @readonly
-     * @private
-     * @memberof CollectionBuilder
-     */
-    get siteId() {
-        return __classPrivateFieldGet(this, _CollectionBuilder_config, "f").siteId;
+        return `${this.config.dotcmsUrl}${CONTENT_API_URL}`;
     }
     /**
      * Returns the current query built.
@@ -1076,11 +1416,11 @@ class CollectionBuilder {
         const finalQuery = this.getFinalQuery();
         const sanitizedQuery = sanitizeQueryForContentType(finalQuery, __classPrivateFieldGet(this, _CollectionBuilder_contentType, "f"));
         const query = __classPrivateFieldGet(this, _CollectionBuilder_rawQuery, "f") ? `${sanitizedQuery} ${__classPrivateFieldGet(this, _CollectionBuilder_rawQuery, "f")}` : sanitizedQuery;
-        return __classPrivateFieldGet(this, _CollectionBuilder_httpClient, "f").request(this.url, {
-            ...__classPrivateFieldGet(this, _CollectionBuilder_requestOptions, "f"),
+        return this.httpClient.request(this.url, {
+            ...this.requestOptions,
             method: 'POST',
             headers: {
-                ...__classPrivateFieldGet(this, _CollectionBuilder_requestOptions, "f").headers,
+                ...this.requestOptions.headers,
                 'Content-Type': 'application/json'
             },
             body: JSON.stringify({
@@ -1148,9 +1488,8 @@ class CollectionBuilder {
         return baseQuery;
     }
 }
-_CollectionBuilder_page = new WeakMap(), _CollectionBuilder_limit = new WeakMap(), _CollectionBuilder_depth = new WeakMap(), _CollectionBuilder_render = new WeakMap(), _CollectionBuilder_sortBy = new WeakMap(), _CollectionBuilder_contentType = new WeakMap(), _CollectionBuilder_defaultQuery = new WeakMap(), _CollectionBuilder_query = new WeakMap(), _CollectionBuilder_rawQuery = new WeakMap(), _CollectionBuilder_languageId = new WeakMap(), _CollectionBuilder_draft = new WeakMap(), _CollectionBuilder_requestOptions = new WeakMap(), _CollectionBuilder_httpClient = new WeakMap(), _CollectionBuilder_config = new WeakMap();
+_CollectionBuilder_page = new WeakMap(), _CollectionBuilder_limit = new WeakMap(), _CollectionBuilder_depth = new WeakMap(), _CollectionBuilder_render = new WeakMap(), _CollectionBuilder_sortBy = new WeakMap(), _CollectionBuilder_contentType = new WeakMap(), _CollectionBuilder_defaultQuery = new WeakMap(), _CollectionBuilder_query = new WeakMap(), _CollectionBuilder_rawQuery = new WeakMap(), _CollectionBuilder_languageId = new WeakMap(), _CollectionBuilder_draft = new WeakMap();
 
-var _Content_requestOptions, _Content_httpClient, _Content_config;
 /**
  * Creates a builder to filter and fetch a collection of content items.
  * @param contentType - The content type to retrieve.
@@ -1200,20 +1539,15 @@ var _Content_requestOptions, _Content_httpClient, _Content_config;
  * });
  * ```
  */
-class Content {
+class Content extends BaseApiClient {
     /**
      * Creates an instance of Content.
+     * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
      * @param {DotRequestOptions} requestOptions - The options for the client request.
-     * @param {string} serverUrl - The server URL.
      * @param {DotHttpClient} httpClient - HTTP client for making requests.
      */
     constructor(config, requestOptions, httpClient) {
-        _Content_requestOptions.set(this, void 0);
-        _Content_httpClient.set(this, void 0);
-        _Content_config.set(this, void 0);
-        __classPrivateFieldSet(this, _Content_requestOptions, requestOptions, "f");
-        __classPrivateFieldSet(this, _Content_config, config, "f");
-        __classPrivateFieldSet(this, _Content_httpClient, httpClient, "f");
+        super(config, requestOptions, httpClient);
     }
     /**
      * Takes a content type and returns a builder to filter and fetch the collection.
@@ -1281,16 +1615,20 @@ class Content {
      *
      */
     getCollection(contentType) {
-        return new CollectionBuilder(__classPrivateFieldGet(this, _Content_requestOptions, "f"), __classPrivateFieldGet(this, _Content_config, "f"), contentType, __classPrivateFieldGet(this, _Content_httpClient, "f"));
+        return new CollectionBuilder(this.requestOptions, this.config, contentType, this.httpClient);
     }
 }
-_Content_requestOptions = new WeakMap(), _Content_httpClient = new WeakMap(), _Content_config = new WeakMap();
 
-class NavigationClient {
+class NavigationClient extends BaseApiClient {
+    /**
+     * Creates a new NavigationClient instance.
+     * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
+     * @param {DotRequestOptions} requestOptions - Options for fetch requests including authorization headers
+     * @param {DotHttpClient} httpClient - HTTP client for making requests
+     */
     constructor(config, requestOptions, httpClient) {
-        this.requestOptions = requestOptions;
+        super(config, requestOptions, httpClient);
         this.BASE_URL = `${config?.dotcmsUrl}/api/v1/nav`;
-        this.httpClient = httpClient;
     }
     /**
      * Retrieves information about the dotCMS file and folder tree.
@@ -1588,7 +1926,7 @@ async function fetchGraphQL({ baseURL, body, headers, httpClient }) {
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
  */
-class PageClient {
+class PageClient extends BaseApiClient {
     /**
      * Creates a new PageClient instance.
      *
@@ -1613,10 +1951,7 @@ class PageClient {
      * ```
      */
     constructor(config, requestOptions, httpClient) {
-        this.requestOptions = requestOptions;
-        this.siteId = config.siteId || '';
-        this.dotcmsUrl = config.dotcmsUrl;
-        this.httpClient = httpClient;
+        super(config, requestOptions, httpClient);
     }
     /**
      * Retrieves a page from DotCMS using GraphQL.
@@ -1781,6 +2116,7 @@ class DotCMSClient {
         this.page = new PageClient(this.config, this.requestOptions, this.httpClient);
         this.nav = new NavigationClient(this.config, this.requestOptions, this.httpClient);
         this.content = new Content(this.config, this.requestOptions, this.httpClient);
+        this.ai = new AIClient(this.config, this.requestOptions, this.httpClient);
     }
     /**
      * Creates request options with authentication headers.