@dotcms/types 0.0.1-beta.31 → 0.0.1-beta.33

package/package.json

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

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

@@ -1,7 +1,35 @@
+import { UVE_MODE } from '../editor/public';
 /**
- * The parameters for the Page API.
+ * The GraphQL parameters for a page request.
  * @public
  */
+export interface DotCMSGraphQLParams {
+    /**
+     * The GraphQL query for the page.
+     * @property {string} page - The GraphQL query for the page.
+     */
+    page?: string;
+    /**
+     * A record of GraphQL queries for content.
+     * @property {Record<string, string>} content - A record of GraphQL queries for content.
+     */
+    content?: Record<string, string>;
+    /**
+     * Variables for the GraphQL queries.
+     * @property {Record<string, string>} variables - Variables for the GraphQL queries.
+     */
+    variables?: Record<string, string>;
+    /**
+     * An array of GraphQL fragment strings.
+     * @property {string[]} fragments - An array of GraphQL fragment strings.
+     */
+    fragments?: string[];
+}
+/**
+ * Parameters for making a page request to DotCMS.
+ * @public
+ * @interface DotCMSPageRequestParams
+ */
 export interface DotCMSPageRequestParams {
     /**
      * The id of the site you want to interact with. Defaults to the one from the config if not provided.
@@ -10,7 +38,7 @@ export interface DotCMSPageRequestParams {
     /**
      * 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';
+    mode?: keyof typeof UVE_MODE;
     /**
      * The language id of the page you want to retrieve. Defaults to the site's default language if not provided.
      */
@@ -38,12 +66,7 @@ export interface DotCMSPageRequestParams {
     /**
      * The GraphQL options for the page.
      */
-    graphql?: {
-        page?: string;
-        content?: Record<string, string>;
-        variables?: Record<string, string>;
-        fragments?: string[];
-    };
+    graphql?: DotCMSGraphQLParams;
 }
 /**
  * Options for configuring fetch requests, excluding body and method properties.

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

@@ -197,14 +197,3 @@ export interface EditableContainerData {
     maxContentlets: number;
     variantId?: string;
 }
-/**
- * Configuration for the UVE
- * @interface DotCMSUVEConfig
- */
-export interface DotCMSUVEConfig {
-    graphql?: {
-        query: string;
-        variables: Record<string, unknown>;
-    };
-    params?: Record<string, unknown>;
-}

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

@@ -341,7 +341,7 @@ export interface DotCMSBasicContentlet {
     title: string;
     titleImage: string;
     text?: string;
-    url: string;
+    url?: string;
     working: boolean;
     body?: string;
     contentTypeIcon?: string;
@@ -349,15 +349,15 @@ export interface DotCMSBasicContentlet {
     widgetTitle?: string;
     onNumberOfPages?: string;
     __icon__?: string;
-    [key: string]: any;
+    _map?: Record<string, unknown>;
 }
 /**
  * Represents a navigation item in the DotCMS navigation structure
  *
- * @interface DotcmsNavigationItem
+ * @interface DotCMSNavigationItem
  * @property {string} [code] - Optional unique code identifier for the navigation item
  * @property {string} folder - The folder path where this navigation item is located
- * @property {DotcmsNavigationItem[]} [children] - Optional array of child navigation items
+ * @property {DotCMSNavigationItem[]} [children] - Optional array of child navigation items
  * @property {string} host - The host/site this navigation item belongs to
  * @property {number} languageId - The language ID for this navigation item
  * @property {string} href - The URL/link that this navigation item points to
@@ -367,10 +367,10 @@ export interface DotCMSBasicContentlet {
  * @property {string} target - The target attribute for the link (e.g. "_blank", "_self")
  * @property {number} order - The sort order position of this item in the navigation
  */
-export interface DotcmsNavigationItem {
+export interface DotCMSNavigationItem {
     code?: string;
     folder: string;
-    children?: DotcmsNavigationItem[];
+    children?: DotCMSNavigationItem[];
     host: string;
     languageId: number;
     href: string;