@dotcms/client 1.0.6-next.3 → 1.0.6-next.4

package/src/lib/client/content/builders/collection/collection.d.ts

@@ -1,6 +1,5 @@
-import { DotCMSClientConfig } from '@dotcms/types';
-import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfilled, OnRejected } from '../../shared/types';
-export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
+import { DotHttpClient, DotRequestOptions, DotCMSClientConfig, DotErrorContent } from '@dotcms/types';
+import { GetCollectionResponse, BuildQuery, SortBy, OnFullfilled, OnRejected } from '../../shared/types';
 /**
  * Creates a Builder to filter and fetch content from the content API for a specific content type.
  *
@@ -15,9 +14,10 @@ export declare class CollectionBuilder<T = unknown> {
      * @param {ClientOptions} requestOptions Options for the client request.
      * @param {DotCMSClientConfig} config The client configuration.
      * @param {string} contentType The content type to fetch.
+     * @param {DotHttpClient} httpClient HTTP client for making requests.
      * @memberof CollectionBuilder
      */
-    constructor(requestOptions: ClientOptions, config: DotCMSClientConfig, contentType: string);
+    constructor(requestOptions: DotRequestOptions, config: DotCMSClientConfig, contentType: string, httpClient: DotHttpClient);
     /**
      * Returns the sort query in the format: field order, field order, ...
      *
@@ -211,10 +211,10 @@ export declare class CollectionBuilder<T = unknown> {
      *
      * @param {OnFullfilled} [onfulfilled] A callback that is called when the fetch is successful.
      * @param {OnRejected} [onrejected] A callback that is called when the fetch fails.
-     * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects with an error.
+     * @return {Promise<GetCollectionResponse<T> | DotErrorContent>} A promise that resolves to the content or rejects with an error.
      * @memberof CollectionBuilder
      */
-    then(onfulfilled?: OnFullfilled<T>, onrejected?: OnRejected): Promise<GetCollectionResponse<T> | GetCollectionError>;
+    then(onfulfilled?: OnFullfilled<T>, onrejected?: OnRejected): Promise<GetCollectionResponse<T> | DotErrorContent>;
     /**
      * Formats the response to the desired format.
      *
@@ -228,7 +228,8 @@ export declare class CollectionBuilder<T = unknown> {
      * Calls the content API to fetch the content.
      *
      * @private
-     * @return {Promise<Response>} The fetch response.
+     * @return {Promise<GetCollectionRawResponse<T>>} The fetch response data.
+     * @throws {DotHttpError} When the HTTP request fails.
      * @memberof CollectionBuilder
      */
     private fetch;

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

@@ -1,4 +1,4 @@
-import { DotCMSClientConfig, RequestOptions } from '@dotcms/types';
+import { DotRequestOptions, DotHttpClient, DotCMSClientConfig } from '@dotcms/types';
 import { CollectionBuilder } from './builders/collection/collection';
 /**
  * Creates a builder to filter and fetch a collection of content items.
@@ -53,10 +53,11 @@ export declare class Content {
     #private;
     /**
      * Creates an instance of Content.
-     * @param {RequestOptions} requestOptions - The options for the client request.
+     * @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: DotCMSClientConfig, requestOptions: RequestOptions);
+    constructor(config: DotCMSClientConfig, requestOptions: DotRequestOptions, httpClient: DotHttpClient);
     /**
      * Takes a content type and returns a builder to filter and fetch the collection.
      * @param {string} contentType - The content type to get the collection.

package/src/lib/client/content/shared/types.d.ts

@@ -1,4 +1,4 @@
-import { Contentlet } from '@dotcms/types';
+import { Contentlet, DotErrorContent } from '@dotcms/types';
 import { Equals } from '../builders/query/lucene-syntax';
 import { QueryBuilder } from '../builders/query/query';
 /**
@@ -28,17 +28,17 @@ export type BuildQuery = (qb: QueryBuilder) => Equals;
  * @template T - The type of the response.
  * @callback OnFullfilled
  * @param {GetCollectionResponse<T>} value - The response value.
- * @returns {GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void} The processed response or a promise.
+ * @returns {GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>>} The processed response or a promise.
  */
-export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void) | undefined | null;
+export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>>) | undefined | null;
 /**
  * Callback for a rejected promise.
  *
  * @callback OnRejected
- * @param {GetCollectionError} error - The error object.
- * @returns {GetCollectionError | PromiseLike<GetCollectionError> | void} The processed error or a promise.
+ * @param {DotErrorContent} error - The content error object.
+ * @returns {DotErrorContent | PromiseLike<DotErrorContent>} The processed error or a promise.
  */
-export type OnRejected = ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void) | undefined | null;
+export type OnRejected = ((error: DotErrorContent) => DotErrorContent | PromiseLike<DotErrorContent>) | undefined | null;
 /**
  * Response of the get collection method.
  *
@@ -85,13 +85,3 @@ export interface GetCollectionRawResponse<T> {
         resultsSize: number;
     };
 }
-/**
- * Error object for the get collection method.
- */
-export interface GetCollectionError {
-    /**
-     * The status code of the error.
-     */
-    status: number;
-    [key: string]: unknown;
-}

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

@@ -1,13 +1,15 @@
-import { DotCMSClientConfig, DotCMSNavigationRequestParams, RequestOptions, DotCMSNavigationItem } from '@dotcms/types';
+import { DotCMSClientConfig, DotCMSNavigationRequestParams, DotRequestOptions, DotCMSNavigationItem, DotHttpClient } from '@dotcms/types';
 export declare class NavigationClient {
     private requestOptions;
     private BASE_URL;
-    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
+    private httpClient;
+    constructor(config: DotCMSClientConfig, requestOptions: DotRequestOptions, httpClient: DotHttpClient);
     /**
      * Retrieves information about the dotCMS file and folder tree.
-     * @param {NavigationApiOptions} options - The options for the Navigation API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
+     * @param {string} path - The path to retrieve navigation for.
+     * @param {DotCMSNavigationRequestParams} params - The options for the Navigation API call.
      * @returns {Promise<DotCMSNavigationItem[]>} - A Promise that resolves to the response from the DotCMS API.
-     * @throws {Error} - Throws an error if the options are not valid.
+     * @throws {DotErrorNavigation} - Throws a navigation-specific error if the request fails.
      */
     get(path: string, params?: DotCMSNavigationRequestParams): Promise<DotCMSNavigationItem[]>;
     private mapToBackendParams;

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

@@ -1,4 +1,4 @@
-import { DotCMSClientConfig, DotCMSComposedPageResponse, DotCMSExtendedPageResponse, DotCMSPageResponse, DotCMSPageRequestParams, RequestOptions } from '@dotcms/types';
+import { DotCMSClientConfig, DotCMSPageRequestParams, DotCMSPageResponse, DotCMSExtendedPageResponse, DotCMSComposedPageResponse, DotHttpClient, DotRequestOptions } from '@dotcms/types';
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
@@ -19,11 +19,17 @@ export declare class PageClient {
      * @private
      */
     private dotcmsUrl;
+    /**
+     * HTTP client for making requests.
+     * @private
+     */
+    private httpClient;
     /**
      * Creates a new PageClient instance.
      *
      * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
-     * @param {RequestOptions} requestOptions - Options for fetch requests including authorization headers
+     * @param {DotRequestOptions} requestOptions - Options for fetch requests including authorization headers
+     * @param {DotHttpClient} httpClient - HTTP client for making requests
      * @example
      * ```typescript
      * const pageClient = new PageClient(
@@ -36,11 +42,12 @@ export declare class PageClient {
      *     headers: {
      *       Authorization: 'Bearer your-auth-token'
      *     }
-     *   }
+     *   },
+     *   httpClient
      * );
      * ```
      */
-    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
+    constructor(config: DotCMSClientConfig, requestOptions: DotRequestOptions, httpClient: DotHttpClient);
     /**
      * Retrieves a page from DotCMS using GraphQL.
      *
@@ -48,6 +55,7 @@ export declare class PageClient {
      * @param {DotCMSPageRequestParams} [options] - Options for the request
      * @template T - The type of the page and content, defaults to DotCMSBasicPage and Record<string, unknown> | unknown
      * @returns {Promise<DotCMSComposedPageResponse<T>>} A Promise that resolves to the page data
+     * @throws {DotErrorPage} - Throws a page-specific error if the request fails or page is not found
      *
      * @example Using GraphQL
      * ```typescript

package/src/lib/client/page/utils.d.ts

@@ -1,3 +1,4 @@
+import { DotHttpClient, DotGraphQLApiResponse } from '@dotcms/types';
 /**
  * Builds a GraphQL query for retrieving page content from DotCMS.
  *
@@ -20,22 +21,24 @@ export declare function buildQuery(queryData: Record<string, string>): string;
 /**
  * Filters response data to include only specified keys.
  *
- * @param {Record<string, string>} responseData - Original response data object
+ * @param {Record<string, unknown> | undefined} responseData - Original response data object
  * @param {string[]} keys - Array of keys to extract from the response data
- * @returns {Record<string, string>} New object containing only the specified keys
+ * @returns {Record<string, unknown> | undefined} New object containing only the specified keys
  */
-export declare function mapResponseData(responseData: Record<string, string>, keys: string[]): Record<string, string>;
+export declare function mapContentResponse(responseData: Record<string, unknown> | undefined, keys: string[]): Record<string, unknown> | undefined;
 /**
  * Executes a GraphQL query against the DotCMS API.
  *
  * @param {Object} options - Options for the fetch request
  * @param {string} options.body - GraphQL query string
  * @param {Record<string, string>} options.headers - HTTP headers for the request
- * @returns {Promise<any>} Parsed JSON response from the GraphQL API
- * @throws {Error} If the HTTP response is not successful
+ * @param {DotHttpClient} options.httpClient - HTTP client for making requests
+ * @returns {Promise<DotGraphQLApiResponse>} Parsed JSON response from the GraphQL API
+ * @throws {DotHttpError} If the HTTP request fails (non-2xx status or network error)
  */
-export declare function fetchGraphQL({ baseURL, body, headers }: {
+export declare function fetchGraphQL({ baseURL, body, headers, httpClient }: {
     baseURL: string;
     body: string;
-    headers: Record<string, string>;
-}): Promise<any>;
+    headers?: HeadersInit;
+    httpClient: DotHttpClient;
+}): Promise<DotGraphQLApiResponse>;

package/src/lib/utils/graphql/transforms.d.ts

@@ -1,4 +1,4 @@
-import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '@dotcms/types';
+import { DotCMSGraphQLPage, DotCMSPageAsset } from '@dotcms/types';
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -10,4 +10,4 @@ import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '@dotcms/types';
  * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
  * ```
  */
-export declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => DotCMSPageAsset | null;
+export declare const graphqlToPageEntity: (page: DotCMSGraphQLPage) => DotCMSPageAsset | null;