@dotcms/types 0.0.1-beta.32 → 0.0.1-beta.34

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.32",
+  "version": "0.0.1-beta.34",
   "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;