@dotcms/types 0.0.1-beta.27 → 0.0.1-beta.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/types",
-  "version": "0.0.1-beta.27",
+  "version": "0.0.1-beta.29",
   "keywords": [
     "dotCMS",
     "CMS",

package/src/index.d.ts

@@ -2,3 +2,4 @@ export * from './lib/components/block-editor-renderer/public';
 export * from './lib/editor/public';
 export * from './lib/events/public';
 export * from './lib/page/public';
+export * from './lib/client/public';

package/src/lib/client/public.d.ts

@@ -0,0 +1,96 @@
+/**
+ * The parameters for the Page API.
+ * @public
+ */
+export interface DotCMSPageRequestParams {
+    /**
+     * The id of the site you want to interact with. Defaults to the one from the config if not provided.
+     */
+    siteId?: string;
+    /**
+     * The mode of the page you want to retrieve. Defaults to the site's default mode if not provided.
+     */
+    mode?: 'EDIT_MODE' | 'PREVIEW_MODE' | 'LIVE';
+    /**
+     * The language id of the page you want to retrieve. Defaults to the site's default language if not provided.
+     */
+    languageId?: number | string;
+    /**
+     * The id of the persona for which you want to retrieve the page.
+     */
+    personaId?: string;
+    /**
+     * Whether to fire the rules set on the page.
+     */
+    fireRules?: boolean | string;
+    /**
+     * Allows access to related content via the Relationship fields of contentlets on a Page; 0 (default).
+     */
+    depth?: 0 | 1 | 2 | 3 | '0' | '1' | '2' | '3';
+    /**
+     * The publish date of the page you want to retrieve.
+     */
+    publishDate?: string;
+    /**
+     * The variant name of the page you want to retrieve.
+     */
+    variantName?: string;
+    /**
+     * The GraphQL options for the page.
+     */
+    graphql?: {
+        page?: string;
+        content?: Record<string, string>;
+        variables?: Record<string, string>;
+        fragments?: string[];
+    };
+}
+/**
+ * Options for configuring fetch requests, excluding body and method properties.
+ */
+export type RequestOptions = Omit<RequestInit, 'body' | 'method'>;
+/**
+ * Configuration options for the DotCMS client.
+ */
+export interface DotCMSClientConfig {
+    /**
+     * The URL of the dotCMS instance.
+     * Ensure to include the protocol (http or https).
+     * @example `https://demo.dotcms.com`
+     */
+    dotcmsUrl: string;
+    /**
+     * The authentication token for requests.
+     * Obtainable from the dotCMS UI.
+     */
+    authToken: string;
+    /**
+     * The id of the site you want to interact with. Defaults to the default site if not provided.
+     */
+    siteId?: string;
+    /**
+     * Additional options for the fetch request.
+     * @example `{ headers: { 'Content-Type': 'application/json' } }`
+     */
+    requestOptions?: RequestOptions;
+}
+/**
+ * The parameters for the Navigation API.
+ * @public
+ */
+export interface DotCMSNavigationRequestParams {
+    /**
+     * The depth of the folder tree to return.
+     * @example
+     * `1` returns only the element specified in the path.
+     * `2` returns the element specified in the path, and if that element is a folder, returns all direct children of that folder.
+     * `3` returns all children and grandchildren of the element specified in the path.
+     */
+    depth?: number;
+    /**
+     * The language ID of content to return.
+     * @example
+     * `1` (or unspecified) returns content in the default language of the site.
+     */
+    languageId?: number;
+}

package/src/lib/editor/public.d.ts

@@ -1,5 +1,5 @@
 import { DotCMSContainerBound } from './internal';
-import { DotCMSBasicContentlet, DotCMSEditablePage } from '../page/public';
+import { DotCMSBasicContentlet, DotCMSPageResponse } from '../page/public';
 /**
  * Development mode
  *
@@ -179,7 +179,7 @@ export declare enum UVEEventType {
  * Type definitions for each event's payload
  */
 export type UVEEventPayloadMap = {
-    [UVEEventType.CONTENT_CHANGES]: DotCMSEditablePage;
+    [UVEEventType.CONTENT_CHANGES]: DotCMSPageResponse;
     [UVEEventType.PAGE_RELOAD]: undefined;
     [UVEEventType.REQUEST_BOUNDS]: DotCMSContainerBound[];
     [UVEEventType.IFRAME_SCROLL]: 'up' | 'down';

package/src/lib/page/public.d.ts

@@ -987,9 +987,9 @@ interface DotCMSSiteField {
     versionType: string;
 }
 /**
- * Represents a basic page object returned from GraphQL queries
+ * Represents a basic page object from the GraphQL API
  *
- * @interface DotCMSBasicGraphQLPage
+ * @interface DotCMSGraphQLPage
  * @property {string} publishDate - The date the page was published
  * @property {string} type - The type of the page
  * @property {boolean} httpsRequired - Whether HTTPS is required to access the page
@@ -1032,14 +1032,14 @@ interface DotCMSSiteField {
  * @property {string} conLanguage.languageCode - Language code
  * @property {Object} template - Template information
  * @property {boolean} template.drawed - Whether template is drawn
- * @property {DotCMSPageGraphQLContainer[]} containers - Array of containers on the page
+ * @property {DotCMSPageContainer[]} containers - Array of containers on the page
  * @property {DotCMSLayout} layout - Layout configuration
  * @property {DotCMSViewAs} viewAs - View configuration
- * @property {Record<string, unknown>} urlContentMap - URL to content mapping
+ * @property {DotCMSURLContentMap} urlContentMap - URL to content mapping
  * @property {DotCMSSite} site - Site information
  * @property {Record<string, unknown>} _map - Additional mapping data
  */
-export interface DotCMSBasicGraphQLPage {
+export interface DotCMSGraphQLPage {
     publishDate: string;
     type: string;
     httpsRequired: boolean;
@@ -1081,10 +1081,8 @@ export interface DotCMSBasicGraphQLPage {
         language: string;
         languageCode: string;
     };
-    template: {
-        drawed: boolean;
-    };
-    containers: DotCMSPageGraphQLContainer[];
+    template: Partial<DotCMSTemplate>;
+    containers: DotCMSGraphQLPageContainer[];
     layout: DotCMSLayout;
     viewAs: DotCMSViewAs;
     urlContentMap: Record<string, unknown>;
@@ -1092,16 +1090,16 @@ export interface DotCMSBasicGraphQLPage {
     _map: Record<string, unknown>;
 }
 /**
- * Represents a container in a GraphQL page response
+ * Represents a container in a page
  *
- * @interface DotCMSPageGraphQLContainer
+ * @interface DotCMSGraphQLPageContainer
  * @property {string} path - The path/location of the container in the page
  * @property {string} identifier - Unique identifier for the container
  * @property {number} [maxContentlets] - Optional maximum number of content items allowed in container
  * @property {DotCMSContainerStructure[]} containerStructures - Array of content type structures allowed in container
  * @property {DotCMSPageContainerContentlets[]} containerContentlets - Array of content items in container
  */
-export interface DotCMSPageGraphQLContainer {
+export interface DotCMSGraphQLPageContainer {
     path: string;
     identifier: string;
     maxContentlets?: number;
@@ -1127,14 +1125,11 @@ export interface DotCMSGraphQLError {
     };
 }
 /**
- * Represents the complete response from a GraphQL page query
- *
- * @template TContent - The type of the content data
- * @template TNav - The type of the navigation data
+ * Represents the complete response from a page query from the GraphQL API
  */
-export interface DotCMSGraphQLPageResponse<TContent = Record<string, any>> {
-    page: DotCMSBasicGraphQLPage;
-    content?: TContent;
+export interface DotCMSGraphQLPageResponse {
+    page: DotCMSGraphQLPage;
+    content?: Record<string, unknown> | unknown;
     errors?: DotCMSGraphQLError;
     graphql: {
         query: string;
@@ -1142,8 +1137,23 @@ export interface DotCMSGraphQLPageResponse<TContent = Record<string, any>> {
     };
 }
 /**
- * Payload for initializing the UVE
- * @interface DotCMSEditablePage
+ * Represents the complete response from a page query
  */
-export type DotCMSEditablePage = DotCMSGraphQLPageResponse | DotCMSPageAsset;
+export interface DotCMSPageResponse {
+    pageAsset: DotCMSPageAsset;
+    content?: Record<string, unknown> | unknown;
+    errors?: DotCMSGraphQLError;
+    graphql: {
+        query: string;
+        variables: Record<string, unknown>;
+    };
+}
+export type DotCMSExtendedPageResponse = Partial<Pick<DotCMSPageResponse, 'pageAsset' | 'content'>>;
+export type DotCMSComposedPageAsset<T extends DotCMSExtendedPageResponse> = T['pageAsset'] extends DotCMSPageResponse['pageAsset'] ? DotCMSPageResponse['pageAsset'] & T['pageAsset'] : DotCMSPageResponse['pageAsset'];
+export type DotCMSComposedContent<T extends Pick<DotCMSPageResponse, 'content'>> = T['content'] extends undefined ? DotCMSPageResponse['content'] : T['content'];
+export type DotCMSComposedPageResponse<T extends DotCMSExtendedPageResponse> = Omit<DotCMSPageResponse, 'pageAsset' | 'content'> & {
+    pageAsset: DotCMSComposedPageAsset<T>;
+    content?: DotCMSComposedContent<T>;
+};
+export type DotCMSClientPageGetResponse<T extends DotCMSExtendedPageResponse> = Promise<DotCMSComposedPageResponse<T>>;
 export {};