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

package/README.md

@@ -1,29 +1,96 @@
-# @dotcms/types
+# DotCMS Type Definition Library
 
-## Overview
+📦 [@dotcms/types on npm](https://www.npmjs.com/package/@dotcms/types)
+🛠️ [View source on GitHub](https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/types)
 
-This library contains shared TypeScript types and interfaces used across the dotCMS SDK libraries and the Universal Visual Editor. It serves as a central repository for type definitions to ensure consistency and type safety across the ecosystem.
+## Installation
 
-## Purpose
+```bash
+npm install @dotcms/types@next --save-dev
+```
 
-- Establish a single source of truth for common types
-- Maintain consistency across SDK libraries
-- Support the Universal Visual Editor with necessary type definitions
-- Reduce duplication and prevent drift between related interfaces
+## Overview
 
-## Usage
+This package contains TypeScript type definitions for the dotCMS ecosystem. Use it to enable type safety and an enhanced developer experience when working with dotCMS APIs and structured content.
 
-Import types directly from this library:
+## Commonly Used Types
 
-```typescript
-import { Block, Contentlet } from '@dotcms/types';
+```ts
+import {
+  DotCMSPageAsset,
+  DotCMSPageResponse,
+  UVEEventType,
+  DotCMSInlineEditingPayload
+} from '@dotcms/types';
 ```
 
-## Universal Visual Editor
+## Type Hierarchy (Jump to Definitions)
+
+### Page Types
+
+* [DotCMSPageAsset](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L18)
+
+  * [DotCMSPage](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L515)
+  * [DotCMSPageAssetContainer](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L138)
+  * [DotCMSSite](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L733)
+  * [DotCMSTemplate](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L432)
+  * [DotCMSViewAs](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L598)
+  * [DotCMSVanityUrl](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L80)
+  * [DotCMSURLContentMap](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L41)
+  * [DotCMSLayout](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L622)
+  * [DotCMSPageContainerContentlets](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1139)
+  * [DotCMSPageResponse](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1175)
+  * [DotCMSComposedPageAsset](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1189)
+  * [DotCMSComposedContent](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1195)
+  * [DotCMSComposedPageResponse](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1199)
+  * [DotCMSClientPageGetResponse](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1208)
+
+### Block Editor Types
+
+* [BlockEditorContent](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/components/block-editor-renderer/public.ts#L38)
+
+  * [BlockEditorNode](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/components/block-editor-renderer/public.ts#L18)
+  * [BlockEditorMark](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/components/block-editor-renderer/public.ts#L7)
+
+### Editor & UVE Types
+
+* [UVEState](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L30)
+
+  * [UVE\_MODE](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L55)
+* [UVEEventHandler](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L67)
+* [UVEEventSubscriber](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L90)
+
+  * [UVEEventSubscription](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L81)
+  * [UVEUnsubscribeFunction](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L73)
+* [UVEEventType](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L169)
+
+  * [UVEEventPayloadMap](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L199)
+* [DotCMSPageRendererMode](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L44)
+* [DotCMSUVEAction](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/editor/public.ts#L98)
+
+### Events
+
+* [DotCMSInlineEditingPayload](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/events/public.ts#L13)
+
+  * [DotCMSInlineEditingType](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/events/public.ts#L1)
+
+### Client Request Types
+
+* [DotCMSPageRequestParams](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/client/public.ts#L35)
+
+  * [DotCMSGraphQLParams](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/client/public.ts#L7)
+  * [RequestOptions](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/client/public.ts#L84)
+  * [DotCMSClientConfig](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/client/public.ts#L89)
+  * [DotCMSNavigationRequestParams](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/client/public.ts#L119)
+
+## About
+
+This package is maintained as part of the [dotCMS core repository](https://github.com/dotCMS/core).
 
-Types in this library provide the foundation for the Universal Visual Editor, including:
+### Keywords
 
-- Component definitions
-- Editor configuration schemas
-- Content type mappings
-- UI element specifications
+* dotcms
+* typescript
+* types
+* cms
+* content-management-system

package/package.json

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

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

@@ -1,3 +1,13 @@
+/**
+ * Represents a map of container identifiers to their container objects
+ *
+ * @interface DotCMSPageAssetContainers
+ * @property {string} [key] - The identifier of the container
+ * @property {DotCMSPageAssetContainer} [value] - The container object
+ */
+export interface DotCMSPageAssetContainers {
+    [key: string]: DotCMSPageAssetContainer;
+}
 /**
  * Represents a DotCMS page asset that contains all the components and configuration needed to render a page
  *
@@ -15,17 +25,17 @@
  */
 export interface DotCMSPageAsset {
     canCreateTemplate?: boolean;
-    containers: {
-        [key: string]: DotCMSPageAssetContainer;
-    };
+    numberContents?: number;
+    containers: DotCMSPageAssetContainers;
     layout: DotCMSLayout;
     page: DotCMSPage;
     site: DotCMSSite;
-    template: DotCMSTemplate;
+    template: DotCMSTemplate | Pick<DotCMSTemplate, 'drawed' | 'theme' | 'anonymous' | 'identifier'>;
     viewAs?: DotCMSViewAs;
     vanityUrl?: DotCMSVanityUrl;
     urlContentMap?: DotCMSURLContentMap;
     params?: Record<string, unknown>;
+    runningExperimentId?: string;
 }
 /**
  * Represents a URL to content mapping configuration that extends the basic contentlet
@@ -76,13 +86,15 @@ export interface DotCMSVanityUrl {
     pattern: string;
     vanityUrlId: string;
     url: string;
+    uri?: string;
+    action?: number;
     siteId: string;
     languageId: number;
     forwardTo: string;
     response: number;
     order: number;
-    temporaryRedirect: boolean;
-    permanentRedirect: boolean;
+    temporaryRedirect?: boolean;
+    permanentRedirect?: boolean;
     forward: boolean;
 }
 /**
@@ -417,7 +429,7 @@ export interface DotCMSNavigationItem {
  * @property {boolean} new - Whether template is new
  * @property {boolean} canEdit - Whether current user can edit template
  */
-interface DotCMSTemplate {
+export interface DotCMSTemplate {
     iDate: number;
     type: string;
     owner: string;
@@ -499,7 +511,7 @@ interface DotCMSTemplate {
  * @property {string} liveInode - Live version inode
  * @property {string} shortyLive - Short live version ID
  */
-interface DotCMSPage {
+export interface DotCMSPage {
     template: string;
     modDate: number;
     metadata: string;
@@ -531,6 +543,8 @@ interface DotCMSPage {
     folder: string;
     deleted: boolean;
     sortOrder: number;
+    rendered?: string;
+    contentType: string;
     modUser: string;
     pageUrl: string;
     workingInode: string;
@@ -543,31 +557,46 @@ interface DotCMSPage {
     lockedByName: string;
     liveInode: string;
     shortyLive: string;
+    canSeeRules?: boolean;
 }
 /**
- * Represents view configuration settings for preview/editing modes
+ * Represents the language configuration for a DotCMS page
  *
- * @interface DotCMSViewAs
- * @property {Object} language - Language configuration
- * @property {number} language.id - Language identifier
- * @property {string} language.languageCode - ISO language code
- * @property {string} language.countryCode - ISO country code
- * @property {string} language.language - Language name
- * @property {string} language.country - Country name
- * @property {string} mode - View mode (e.g. PREVIEW_MODE, EDIT_MODE, LIVE)
+ * @export
+ * @interface DotCMSViewAsLanguage
+ * @property {number} id - Unique identifier for the language
+ * @property {string} languageCode - ISO 639-1 language code (e.g. 'en', 'es')
+ * @property {string} countryCode - ISO 3166-1 country code (e.g. 'US', 'ES')
+ * @property {string} language - Full name of the language (e.g. 'English', 'Spanish')
+ * @property {string} country - Full name of the country (e.g. 'United States', 'Spain')
  */
+export interface DotCMSViewAsLanguage {
+    id: number;
+    languageCode: string;
+    countryCode: string;
+    language: string;
+    country: string;
+}
 /**
- * Represents view configuration settings for preview/editing modes
+ * Represents the persona configuration for a DotCMS page
  *
- * @interface DotCMSViewAs
- * @property {Object} language - Language configuration for the view
- * @property {number} language.id - Unique identifier for the language
- * @property {string} language.languageCode - ISO 639-1 language code (e.g. 'en', 'es')
- * @property {string} language.countryCode - ISO 3166-1 country code (e.g. 'US', 'ES')
- * @property {string} language.language - Full name of the language (e.g. 'English', 'Spanish')
- * @property {string} language.country - Full name of the country (e.g. 'United States', 'Spain')
- * @property {string} mode - View mode for the page ('PREVIEW_MODE' | 'EDIT_MODE' | 'LIVE')
+ * @export
+ * @interface DotCMSViewAsPersona
+ * @property {number} modDate - Last modification date timestamp
+ * @property {string} inode - Unique inode identifier
+ * @property {string} name - Name of the persona
+ * @property {string} identifier - Unique identifier
+ * @property {string} keyTag - Key tag for the persona
+ * @property {string} photo - Photo of the persona
  */
+export interface DotCMSViewAsPersona extends DotCMSBasicContentlet {
+    name: string;
+    keyTag: string;
+    personalized?: boolean;
+    photo?: {
+        versionPath: string;
+    };
+}
 /**
  * Represents view configuration settings for preview/editing modes
  *
@@ -580,15 +609,11 @@ interface DotCMSPage {
  * @property {string} language.country - Full name of the country (e.g. 'United States', 'Spain')
  * @property {string} mode - View mode for the page ('PREVIEW_MODE' | 'EDIT_MODE' | 'LIVE')
  */
-interface DotCMSViewAs {
-    language: {
-        id: number;
-        languageCode: string;
-        countryCode: string;
-        language: string;
-        country: string;
-    };
+export interface DotCMSViewAs {
+    language: DotCMSViewAsLanguage;
     mode: string;
+    persona?: DotCMSViewAsPersona;
+    variantId?: string;
 }
 /**
  * Represents the layout configuration for a DotCMS page
@@ -603,7 +628,7 @@ interface DotCMSViewAs {
  * @property {DotPageAssetLayoutBody} body - The main content body configuration
  * @property {DotPageAssetLayoutSidebar} sidebar - The sidebar configuration
  */
-interface DotCMSLayout {
+export interface DotCMSLayout {
     pageWidth: string;
     width: string;
     layout: string;
@@ -624,7 +649,7 @@ interface DotCMSLayout {
  * @property {string} code - Template code for rendering the structure
  * @property {string} contentTypeVar - Variable name of the content type
  */
-interface DotCMSContainerStructure {
+export interface DotCMSContainerStructure {
     id: string;
     structureId: string;
     containerInode: string;
@@ -710,7 +735,7 @@ interface DotPageAssetLayoutBody {
  * @property {number} sortOrder - Sort order position
  * @property {DotCMSSiteContentType} contentType - Content type configuration
  */
-interface DotCMSSite {
+export interface DotCMSSite {
     lowIndexPriority: boolean;
     name: string;
     default: boolean;
@@ -1036,7 +1061,8 @@ interface DotCMSSiteField {
  * @property {DotCMSLayout} layout - Layout configuration
  * @property {DotCMSViewAs} viewAs - View configuration
  * @property {DotCMSURLContentMap} urlContentMap - URL to content mapping
- * @property {DotCMSSite} site - Site information
+ * @property {Record<string, unknown>} host - Site information
+ * @property {Record<string, unknown>} vanityUrl - Vanity URL information
  * @property {Record<string, unknown>} _map - Additional mapping data
  */
 export interface DotCMSGraphQLPage {
@@ -1076,17 +1102,22 @@ export interface DotCMSGraphQLPage {
     live: boolean;
     isContentlet: boolean;
     statusIcons: string;
+    runningExperimentId?: string;
+    canSeeRules?: boolean;
     conLanguage: {
         id: number;
         language: string;
         languageCode: string;
     };
-    template: Partial<DotCMSTemplate>;
+    template: Pick<DotCMSTemplate, 'drawed' | 'theme' | 'anonymous' | 'identifier'>;
     containers: DotCMSGraphQLPageContainer[];
     layout: DotCMSLayout;
     viewAs: DotCMSViewAs;
-    urlContentMap: Record<string, unknown>;
-    site: DotCMSSite;
+    urlContentMap: {
+        _map: DotCMSURLContentMap;
+    };
+    host: DotCMSSite;
+    vanityUrl: DotCMSVanityUrl;
     _map: Record<string, unknown>;
 }
 /**
@@ -1142,7 +1173,7 @@ export interface DotCMSGraphQLPageResponse {
 export interface DotCMSPageResponse {
     pageAsset: DotCMSPageAsset;
     content?: Record<string, unknown> | unknown;
-    errors?: DotCMSGraphQLError;
+    error?: DotCMSGraphQLError;
     graphql: {
         query: string;
         variables: Record<string, unknown>;