@dotcms/client 0.0.1-beta.3 → 0.0.1-beta.30

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

@@ -1,5 +1,6 @@
-import { Equals } from '../../../query-builder/lucene-syntax';
-import { QueryBuilder } from '../../../query-builder/sdk-query-builder';
+import { Contentlet } from '@dotcms/types';
+import { Equals } from '../builders/query/lucene-syntax';
+import { QueryBuilder } from '../builders/query/query';
 /**
  * Model to sort by fields.
  */
@@ -21,48 +22,6 @@ export type SortBy = {
  * @returns {Equals} The built query.
  */
 export type BuildQuery = (qb: QueryBuilder) => Equals;
-/**
- * Main fields of a Contentlet (Inherited from the Content Type).
- */
-export interface ContentTypeMainFields {
-    hostName: string;
-    modDate: string;
-    publishDate: string;
-    title: string;
-    baseType: string;
-    inode: string;
-    archived: boolean;
-    ownerName: string;
-    host: string;
-    working: boolean;
-    locked: boolean;
-    stInode: string;
-    contentType: string;
-    live: boolean;
-    owner: string;
-    identifier: string;
-    publishUserName: string;
-    publishUser: string;
-    languageId: number;
-    creationDate: string;
-    url: string;
-    titleImage: string;
-    modUserName: string;
-    hasLiveVersion: boolean;
-    folder: string;
-    hasTitleImage: boolean;
-    sortOrder: number;
-    modUser: string;
-    __icon__: string;
-    contentTypeIcon: string;
-    variant: string;
-}
-/**
- * The contentlet has the main fields and the custom fields of the content type.
- *
- * @template T - The custom fields of the content type.
- */
-export type Contentlet<T> = T & ContentTypeMainFields;
 /**
  * Callback for a fulfilled promise.
  *

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

@@ -0,0 +1,14 @@
+import { DotCMSClientConfig, DotCMSNavigationRequestParams, RequestOptions } from '@dotcms/types';
+export declare class NavigationClient {
+    private requestOptions;
+    private BASE_URL;
+    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
+    /**
+     * 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 }`.
+     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+     * @throws {Error} - Throws an error if the options are not valid.
+     */
+    get(path: string, params?: DotCMSNavigationRequestParams): Promise<unknown>;
+    private mapToBackendParams;
+}

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

@@ -0,0 +1,96 @@
+import { DotCMSClientConfig, DotCMSComposedPageResponse, DotCMSExtendedPageResponse, DotCMSPageResponse, DotCMSPageRequestParams, RequestOptions } from '@dotcms/types';
+/**
+ * Client for interacting with the DotCMS Page API.
+ * Provides methods to retrieve and manipulate pages.
+ */
+export declare class PageClient {
+    #private;
+    /**
+     * Request options including authorization headers.
+     * @private
+     */
+    private requestOptions;
+    /**
+     * Site ID for page requests.
+     * @private
+     */
+    private siteId;
+    /**
+     * DotCMS URL for page requests.
+     * @private
+     */
+    private dotcmsUrl;
+    /**
+     * Creates a new PageClient instance.
+     *
+     * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
+     * @param {RequestOptions} requestOptions - Options for fetch requests including authorization headers
+     * @example
+     * ```typescript
+     * const pageClient = new PageClient(
+     *   {
+     *     dotcmsUrl: 'https://demo.dotcms.com',
+     *     authToken: 'your-auth-token',
+     *     siteId: 'demo.dotcms.com'
+     *   },
+     *   {
+     *     headers: {
+     *       Authorization: 'Bearer your-auth-token'
+     *     }
+     *   }
+     * );
+     * ```
+     */
+    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
+    /**
+     * Retrieves a page from DotCMS using GraphQL.
+     *
+     * @param {string} url - The URL of the page to retrieve
+     * @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
+     *
+     * @example Using GraphQL
+     * ```typescript
+     * const page = await pageClient.get<{ page: MyPageWithBanners; content: { blogPosts: { blogTitle: string } } }>(
+     *     '/index',
+     *     {
+     *         languageId: '1',
+     *         mode: 'LIVE',
+     *         graphql: {
+     *             page: `
+     *              containers {
+     *                  containerContentlets {
+     *                      contentlets {
+     *                          ... on 	Banner {
+     *                              ...bannerFragment
+     *                          }
+     *                      }
+     *                  }
+     *              `,
+     *              content: {
+     *                  blogPosts: `
+     *                      BlogCollection(limit: 3) {
+     *                          ...blogFragment
+     *                      }
+     *                  `,
+     *              },
+     *              fragments: [
+     *                  `
+     *                      fragment bannerFragment on Banner {
+     *                          caption
+     *                      }
+     *                  `,
+     *                  `
+     *                      fragment blogFragment on Blog {
+     *                          title
+     *                          urlTitle
+     *                      }
+     *                  `
+     *              ]
+     *          }
+     *      });
+     * ```
+     */
+    get<T extends DotCMSExtendedPageResponse = DotCMSPageResponse>(url: string, options?: DotCMSPageRequestParams): Promise<DotCMSComposedPageResponse<T>>;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * Builds a GraphQL query for retrieving page content from DotCMS.
+ *
+ * @param {string} pageQuery - Custom fragment fields to include in the ClientPage fragment
+ * @param {string} additionalQueries - Additional GraphQL queries to include in the main query
+ * @returns {string} Complete GraphQL query string for page content
+ */
+export declare const buildPageQuery: ({ page, fragments, additionalQueries }: {
+    page?: string;
+    fragments?: string[];
+    additionalQueries?: string;
+}) => string;
+/**
+ * Converts a record of query strings into a single GraphQL query string.
+ *
+ * @param {Record<string, string>} queryData - Object containing named query strings
+ * @returns {string} Combined query string or empty string if no queryData provided
+ */
+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 {string[]} keys - Array of keys to extract from the response data
+ * @returns {Record<string, string>} New object containing only the specified keys
+ */
+export declare function mapResponseData(responseData: Record<string, string>, keys: string[]): Record<string, string>;
+/**
+ * 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
+ */
+export declare function fetchGraphQL({ baseURL, body, headers }: {
+    baseURL: string;
+    body: string;
+    headers: Record<string, string>;
+}): Promise<any>;

package/src/lib/{editor → deprecated/editor}/models/client.model.d.ts

@@ -95,4 +95,17 @@ export interface DotUVE {
     reorderMenu: typeof reorderMenu;
     lastScrollYPosition: number;
 }
+/**
+ * Represents a listener for DotcmsClientListener.
+ *
+ * @typedef {Object} DotcmsClientListener
+ * @property {string} action - The action that triggers the event.
+ * @property {string} event - The name of the event.
+ * @property {function(...args: any[]): void} callback - The callback function to handle the event.
+ */
+export type DotcmsClientListener = {
+    action: string;
+    event: string;
+    callback: (...args: any[]) => void;
+};
 export {};

package/src/lib/{editor → deprecated/editor}/sdk-editor.d.ts

@@ -1,6 +1,6 @@
+import { Contentlet } from '@dotcms/types';
 import { DotCMSPageEditorConfig, ReorderMenuConfig } from './models/editor.model';
 import { INLINE_EDITING_EVENT_KEY, InlineEditEventData } from './models/inline-event.model';
-import { Contentlet } from '../client/content/shared/types';
 /**
  * Updates the navigation in the editor.
  *

package/src/lib/{client → deprecated}/sdk-js-client.d.ts

@@ -1,4 +1,4 @@
-import { Content } from './content/content-api';
+import { Content } from '../client/content/content-api';
 export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
 export interface ClientConfig {
     /**

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

@@ -1,14 +1,4 @@
-/**
- * Represents the response from a GraphQL query for a page.
- *
- * @interface GraphQLPageResponse
- * @property {Record<string, unknown>} page - The main page data.
- * @property {unknown} [key: string] - Additional properties that may be included in the response.
- */
-interface GraphQLPageResponse {
-    page: Record<string, unknown>;
-    [key: string]: unknown;
-}
+import { DotCMSGraphQLPageResponse } from '@dotcms/types';
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -20,5 +10,4 @@ interface GraphQLPageResponse {
  * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
  * ```
  */
-export declare const graphqlToPageEntity: (graphQLPageResponse: GraphQLPageResponse) => any;
-export {};
+export declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => any;

package/src/lib/utils/page/common-utils.d.ts

@@ -1,4 +1,4 @@
-import { PageApiOptions } from '../../client/sdk-js-client';
+import { PageApiOptions } from '../../deprecated/sdk-js-client';
 /**
  * Interface representing the properties for page request parameters.
  *

package/src/next.d.ts

@@ -0,0 +1 @@
+export { createDotCMSClient } from './lib/client/client';