@dotcms/react 0.0.1-beta.9 → 1.0.0-next.1

package/src/lib/deprecated/components/BlockEditorRenderer/BlockEditorRenderer.d.ts

@@ -1,37 +0,0 @@
-/// <reference types="react" />
-import { DotCMSContentlet } from '../../models';
-import { Block } from '../../models/blocks.interface';
-import { CustomRenderer } from '../../models/content-node.interface';
-interface BaseProps {
-    blocks: Block;
-    customRenderers?: CustomRenderer;
-    className?: string;
-    style?: React.CSSProperties;
-}
-interface EditableProps extends BaseProps {
-    editable: true;
-    contentlet: DotCMSContentlet;
-    fieldName: string;
-}
-interface NonEditableProps extends BaseProps {
-    editable?: false;
-    contentlet?: never;
-    fieldName?: never;
-}
-type BlockEditorRendererProps = EditableProps | NonEditableProps;
-/**
- * BlockEditorRenderer component for rendering block editor field.
- *
- * @component
- * @param {Object} props - The component props.
- * @param {Block} props.blocks - The blocks of content to render.
- * @param {CustomRenderer} [props.customRenderers] - Optional custom renderers for specific block types.
- * @param {string} [props.className] - Optional CSS class name for the container div.
- * @param {React.CSSProperties} [props.style] - Optional inline styles for the container div.
- * @param {boolean} props.editable - Flag to enable inline editing. When true, `contentlet` and `fieldName` are required. Note: Enterprise only feature.
- * @param {DotCMSContentlet} [props.contentlet] - Contentlet object for inline editing. Required when `editable` is true.
- * @param {string} [props.fieldName] - Field name for inline editing. Required when `editable` is true.
- * @returns {JSX.Element} A div containing the rendered blocks of content.
- */
-export declare const BlockEditorRenderer: ({ style, blocks, editable, fieldName, className, contentlet, customRenderers }: BlockEditorRendererProps) => import("react/jsx-runtime").JSX.Element | null;
-export {};

package/src/lib/deprecated/components/BlockEditorRenderer/blocks/Code.d.ts

@@ -1,17 +0,0 @@
-import { BlockProps } from '../../../models/blocks.interface';
-import { CodeBlockProps } from '../../../models/content-node.interface';
-/**
- * Renders a code block component.
- *
- * @param attrs - The attributes of the code block.
- * @param children - The content of the code block.
- * @returns The rendered code block component.
- */
-export declare const CodeBlock: ({ attrs, children }: CodeBlockProps) => import("react/jsx-runtime").JSX.Element;
-/**
- * Renders a blockquote component.
- *
- * @param children - The content to be rendered inside the blockquote.
- * @returns The rendered blockquote component.
- */
-export declare const BlockQuote: ({ children }: BlockProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/components/BlockEditorRenderer/blocks/Contentlet.d.ts

@@ -1,41 +0,0 @@
-import { DotContentProps } from '../../../models/content-node.interface';
-export interface Contentlet {
-    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;
-}
-/**
- * Renders a DotContent component.
- *
- * @param {DotContentProps} props - The props for the DotContent component.
- * @returns {JSX.Element} The rendered DotContent component.
- */
-export declare const DotContent: ({ customRenderers, ...props }: DotContentProps) => import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/components/BlockEditorRenderer/blocks/Image.d.ts

@@ -1,8 +0,0 @@
-import { ContentNode } from '../../../models/content-node.interface';
-/**
- * Renders an image component for dotCMS.
- *
- * @param props - The props for the DotCMSImage component.
- * @returns The rendered image component.
- */
-export declare const DotCMSImage: (props: ContentNode) => import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/components/BlockEditorRenderer/blocks/Video.d.ts

@@ -1,8 +0,0 @@
-import { ContentNode } from '../../../models/content-node.interface';
-/**
- * Renders a video component for displaying videos.
- *
- * @param props - The properties for the video component.
- * @returns The rendered video component.
- */
-export declare const DotCMSVideo: (props: ContentNode) => import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/components/Column/Column.d.ts

@@ -1,19 +0,0 @@
-import { DotCMSPageContext } from '../../models';
-/**
- * Props for Column component to render a column with its containers.
- *
- * @export
- * @interface ColumnProps
- */
-export interface ColumnProps {
-    readonly column: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0];
-}
-/**
- * Renders a Column with its containers using information provided by dotCMS Page API.
- *
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- * @export
- * @param {ColumnProps} { column }
- * @return {JSX.Element} Rendered column with containers
- */
-export declare function Column({ column }: ColumnProps): import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/components/Container/Container.d.ts

@@ -1,19 +0,0 @@
-import { DotCMSPageContext } from '../../models';
-/**
- * Props for the Container component.
- *
- * @export
- * @interface ContainerProps
- */
-export interface ContainerProps {
-    readonly containerRef: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0]['containers'][0];
-}
-/**
- * Renders a Container with its content using information provided by dotCMS Page API.
- *
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- * @export
- * @param {ContainerProps} { containerRef }
- * @return {JSX.Element} Rendered container with content
- */
-export declare function Container({ containerRef }: ContainerProps): import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/components/DotcmsLayout/DotcmsLayout.d.ts

@@ -1,34 +0,0 @@
-import { DotCMSPageEditorConfig } from '@dotcms/client';
-import { DotCMSPageContext } from '../../models';
-/**
- * `DotcmsPageProps` is a type that defines the properties for the `DotcmsLayout` component.
- * It includes a readonly `entity` property that represents the context for a DotCMS page.
- *
- * @typedef {Object} DotcmsPageProps
- *
- * @property {DotCMSPageContext} entity - The context for a DotCMS page.
- * @readonly
- */
-export type DotcmsPageProps = {
-    /**
-     * `pageContext` is a readonly property of the `DotcmsPageProps` type.
-     * It represents the context for a DotCMS page and is of type `PageProviderContext`.
-     *
-     * @property {PageProviderContext} pageContext
-     * @memberof DotcmsPageProps
-     * @type {DotCMSPageContext}
-     * @readonly
-     */
-    readonly pageContext: DotCMSPageContext;
-    readonly config: DotCMSPageEditorConfig;
-};
-/**
- * `DotcmsLayout` is a functional component that renders a layout for a DotCMS page.
- * It takes a `DotcmsPageProps` object as a parameter and returns a JSX element.
- *
- * @category Components
- * @param {DotcmsPageProps} props - The properties for the DotCMS page.
- * @returns {JSX.Element} - A JSX element that represents the layout for a DotCMS page.
- * @deprecated Use {@link https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/react/src/lib/next/components/DotCMSLayoutBody/DotCMSLayoutBody.tsx DotCMSLayoutBody} instead.
- */
-export declare function DotcmsLayout(dotPageProps: DotcmsPageProps): JSX.Element;

package/src/lib/deprecated/components/PageProvider/PageProvider.d.ts

@@ -1,14 +0,0 @@
-import { ReactNode } from 'react';
-export interface PageProviderProps {
-    readonly pageContext: any;
-    readonly children: ReactNode;
-}
-/**
- * `PageProvider` is a functional component that provides a context for a DotCMS page.
- * It takes a `PageProviderProps` object as a parameter and returns a JSX element.
- *
- * @category Components
- * @param {PageProviderProps} props - The properties for the PageProvider. Includes an `entity` and `children`.
- * @returns {JSX.Element} - A JSX element that provides a context for a DotCMS page.
- */
-export declare function PageProvider(props: PageProviderProps): JSX.Element;

package/src/lib/deprecated/components/Row/Row.d.ts

@@ -1,26 +0,0 @@
-/// <reference types="react" />
-import { DotCMSPageContext } from '../../models';
-/**
- * Props for the row component
- *
- * @interface RowProps
- *
- */
-export interface RowProps {
-    /**
-     * Row data
-     *
-     * @type {DotCMSPageContext['layout']['body']['rows'][0]}
-     * @memberof RowProps
-     */
-    row: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0];
-}
-/**
- * This component renders a row with all it's content using the layout provided by dotCMS Page API.
- *
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- * @category Components
- * @param {React.ForwardedRef<HTMLDivElement, RowProps>} ref
- * @return {JSX.Element} Rendered rows with columns
- */
-export declare const Row: import("react").ForwardRefExoticComponent<RowProps & import("react").RefAttributes<HTMLDivElement>>;

package/src/lib/deprecated/contexts/PageContext.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="react" />
-import { DotCMSPageContext } from '../models';
-/**
- * The `PageContext` is a React context that provides access to the DotCMS page context.
- *
- * @category Contexts
- */
-export declare const PageContext: import("react").Context<DotCMSPageContext | null>;

package/src/lib/deprecated/deprecated_api.d.ts

@@ -1,7 +0,0 @@
-export * from './components/DotcmsLayout/DotcmsLayout';
-export * from './components/DotEditableText/DotEditableText';
-export * from './components/PageProvider/PageProvider';
-export * from './components/Row/Row';
-export * from './hooks/useDotcmsPageContext';
-export * from './components/BlockEditorRenderer/BlockEditorRenderer';
-export * from './models/content-node.interface';

package/src/lib/deprecated/hooks/useCheckHaveContent.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-export declare const useCheckHaveContent: () => {
-    contentletDivRef: import("react").MutableRefObject<HTMLDivElement | null>;
-    haveContent: boolean;
-};

package/src/lib/deprecated/hooks/useDotcmsEditor.d.ts

@@ -1,13 +0,0 @@
-import { DotcmsPageProps } from '../components/DotcmsLayout/DotcmsLayout';
-import { DotCMSPageContext } from '../models';
-/**
- * Custom Hook to handle the DotCMS editor interaction with the page.
- *
- * @category Hooks
- * @param {DotcmsPageProps} props {
- *     pageContext,
- *     config,
- * }
- * @returns {DotCMSPageContext} The context for a DotCMS page provided by the editor.
- */
-export declare const useDotcmsEditor: ({ pageContext, config }: DotcmsPageProps) => DotCMSPageContext;

package/src/lib/deprecated/hooks/useDotcmsPageContext.d.ts

@@ -1,9 +0,0 @@
-import { DotCMSPageContext } from '../models';
-/**
- * `useDotcmsPageContext` is a custom React hook that provides access to the `PageProviderContext`.
- * It takes no parameters and returns the context value or `null` if it's not available.
- *
- * @category Hooks
- * @returns {DotCMSPageContext | null} - The context value or `null` if it's not available.
- */
-export declare function useDotcmsPageContext(): DotCMSPageContext | null;

package/src/lib/deprecated/mocks/index.d.ts

@@ -1 +0,0 @@
-export * from './mockPageContext';

package/src/lib/deprecated/mocks/mockPageContext.d.ts

@@ -1,7 +0,0 @@
-import { DotCMSPageContext, DotCMSContentlet } from '../models';
-export declare const dotcmsContentletMock: DotCMSContentlet;
-export declare const mockPageContext: DotCMSPageContext;
-export declare const MockContextRender: ({ children, mockContext }: {
-    children: JSX.Element;
-    mockContext: Partial<DotCMSPageContext>;
-}) => import("react/jsx-runtime").JSX.Element;

package/src/lib/deprecated/models/blocks.interface.d.ts

@@ -1,89 +0,0 @@
-/// <reference types="react" />
-import { ContentNode } from './content-node.interface';
-/**
- * Represents a Block of content provided by the Block Editor
- *
- * @export
- * @interface Block
- */
-export interface Block {
-    content: ContentNode[];
-    type: string;
-}
-/**
- * Props for a contentlet inside the Block Editor
- *
- * @export
- * @interface DotContentletProps
- */
-export interface DotContentletProps {
-    title: string;
-    baseType: string;
-    inode: string;
-    archived: boolean;
-    working: boolean;
-    locked: boolean;
-    contentType: string;
-    live: boolean;
-    identifier: string;
-    image: string;
-    imageContentAsset: string;
-    urlTitle: string;
-    url: string;
-    titleImage: string;
-    urlMap: string;
-    hasLiveVersion: boolean;
-    hasTitleImage: boolean;
-    sortOrder: number;
-    modUser: string;
-    __icon__: string;
-    contentTypeIcon: string;
-    language: string;
-    description: string;
-    shortDescription: string;
-    salePrice: string;
-    retailPrice: string;
-    mimeType: string;
-    thumbnail?: string;
-}
-/**
- * Props for a block inside the Block Editor Component
- *
- * @export
- * @interface BlockProps
- */
-export interface BlockProps {
-    children: React.ReactNode;
-}
-/**
- * Represents the different types of Blocks that can be used in the Block Editor
- *
- * @export
- * @enum {number}
- */
-export declare enum Blocks {
-    PARAGRAPH = "paragraph",
-    HEADING = "heading",
-    TEXT = "text",
-    BULLET_LIST = "bulletList",
-    ORDERED_LIST = "orderedList",
-    LIST_ITEM = "listItem",
-    BLOCK_QUOTE = "blockquote",
-    CODE_BLOCK = "codeBlock",
-    HARDBREAK = "hardBreak",
-    HORIZONTAL_RULE = "horizontalRule",
-    DOT_IMAGE = "dotImage",
-    DOT_VIDEO = "dotVideo",
-    TABLE = "table",
-    DOT_CONTENT = "dotContent"
-}
-/**
- * Represents the validation state of a Block Editor instance
- *
- * @interface BlockEditorState
- * @property {boolean} isValid - Whether the blocks structure is valid
- * @property {string | null} error - Error message if blocks are invalid, null otherwise
- */
-export interface BlockEditorState {
-    error: string | null;
-}

package/src/lib/deprecated/models/content-node.interface.d.ts

@@ -1,82 +0,0 @@
-/// <reference types="react" />
-import { BlockProps } from './blocks.interface';
-/**
- * Represents a Mark used by text content in the Block Editor
- *
- * @export
- * @interface Mark
- */
-export interface Mark {
-    type: string;
-    attrs: Record<string, string>;
-}
-/**
- * Represents a Content Node used by the Block Editor
- *
- * @export
- * @interface ContentNode
- */
-export interface ContentNode {
-    type: string;
-    content: ContentNode[];
-    attrs?: Record<string, string>;
-    marks?: Mark[];
-    text?: string;
-}
-/**
- * Represents a Custom Renderer used by the Block Editor Component
- *
- * @export
- * @interface CustomRenderer
- */
-export type CustomRenderer<T = any> = Record<string, React.FC<T>>;
-/**
- * Represents a CodeBlock used by the Block Editor Component
- * @export
- * @interface CodeBlockProps
- */
-export type CodeBlockProps = BlockProps & ContentNode;
-/**
- * Represents a Heading used by the Block Editor Component
- * @export
- * @interface HeadingProps
- */
-export type HeadingProps = BlockProps & ContentNode;
-/**
- * Represents a Link used by the Block Editor Component
- * @export
- * @interface LinkProps
- */
-export type LinkProps = BlockProps & {
-    attrs?: Mark['attrs'];
-};
-/**
- * Represents a Paragraph used by the Block Editor Component
- * @export
- * @interface ParagraphProps
- */
-export type ParagraphProps = BlockProps & ContentNode;
-/**
- * Represents a DotCMSVideo used by the Block Editor Component
- * @export
- * @interface DotCMSVideoProps
- */
-export type DotCMSVideoProps = ContentNode['attrs'] & {
-    data?: Record<string, string>;
-};
-/**
- * Represents a DotCMSImage used by the Block Editor Component
- * @export
- * @interface DotCMSImageProps
- */
-export type DotCMSImageProps = ContentNode['attrs'] & {
-    data?: Record<string, unknown>;
-};
-/**
- * Represents a DotContent used by the Block Editor Component
- * @export
- * @interface DotContentProps
- */
-export type DotContentProps = ContentNode & {
-    customRenderers?: CustomRenderer;
-};

package/src/lib/deprecated/models/index.d.ts

@@ -1,127 +0,0 @@
-/// <reference types="react" />
-export interface ContainerData {
-    [key: string]: {
-        container: {
-            path: string;
-            identifier: string;
-            maxContentlets: number;
-            parentPermissionable: Record<string, string>;
-        };
-        containerStructures: {
-            contentTypeVar: string;
-        }[];
-        contentlets: {
-            [key: string]: {
-                contentType: string;
-                identifier: string;
-                title: string;
-                inode: string;
-                onNumberOfPages: number;
-                widgetTitle?: string;
-                baseType: string;
-            }[];
-        };
-    };
-}
-export interface DotCMSPageContext {
-    /**
-     * `components` is a property of the `PageProviderProps` type.
-     * It is an object that maps content type variables to their corresponding React components.
-     *
-     * It will be use to render the contentlets in the page.
-     *
-     * @property {Object} components
-     * @memberof PageProviderProps
-     * @type {Object.<string, React.ElementType>}
-     */
-    components: {
-        [contentTypeVariable: string]: React.ElementType;
-    };
-    pageAsset: {
-        containers: ContainerData;
-        layout: {
-            header: boolean;
-            footer: boolean;
-            body: {
-                rows: {
-                    styleClass: string;
-                    columns: {
-                        styleClass: string;
-                        width: number;
-                        leftOffset: number;
-                        containers: {
-                            identifier: string;
-                            uuid: string;
-                        }[];
-                    }[];
-                }[];
-            };
-        };
-        page: {
-            title: string;
-            identifier: string;
-        };
-        viewAs: {
-            language: {
-                id: string;
-            };
-            persona: {
-                keyTag: string;
-            };
-            variantId: string;
-        };
-        vanityUrl?: {
-            pattern: string;
-            vanityUrlId: string;
-            url: string;
-            siteId: string;
-            languageId: number;
-            forwardTo: string;
-            response: number;
-            order: number;
-            temporaryRedirect: boolean;
-            permanentRedirect: boolean;
-            forward: boolean;
-        };
-    };
-    isInsideEditor: boolean;
-}
-export interface DotCMSContentlet {
-    archived: boolean;
-    binaryContentAsset?: string;
-    deleted?: boolean;
-    baseType: string;
-    binary?: string;
-    binaryVersion?: string;
-    file?: string;
-    contentType: string;
-    hasLiveVersion?: boolean;
-    folder: string;
-    hasTitleImage: boolean;
-    hostName: string;
-    host: string;
-    inode: string;
-    identifier: string;
-    languageId: number;
-    image?: string;
-    locked: boolean;
-    language?: string;
-    mimeType?: string;
-    modUser: string;
-    modDate: string;
-    live: boolean;
-    sortOrder: number;
-    owner: string;
-    title: string;
-    stInode: string;
-    titleImage: string;
-    modUserName: string;
-    text?: string;
-    working: boolean;
-    url: string;
-    contentTypeIcon?: string;
-    body?: string;
-    variant?: string;
-    __icon__?: string;
-    [key: string]: any;
-}

package/src/lib/deprecated/utils/utils.d.ts

@@ -1,58 +0,0 @@
-import { ContainerData, DotCMSPageContext } from '../models';
-import { Block, BlockEditorState } from '../models/blocks.interface';
-/**
- * Get the container data from the containers object using the current container reference obtained from the layout.
- *
- * @param {ContainerData} containers
- * @param {DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0]['containers'][0]} containerRef
- * @returns {Object} Container with all the data it has.
- */
-export declare const getContainersData: (containers: ContainerData, containerRef: DotCMSPageContext['pageAsset']['layout']['body']['rows'][0]['columns'][0]['containers'][0]) => {
-    acceptTypes: string;
-    contentlets: {
-        contentType: string;
-        identifier: string;
-        title: string;
-        inode: string;
-        onNumberOfPages: number;
-        widgetTitle?: string | undefined;
-        baseType: string;
-    }[];
-    variantId: string;
-    path: string;
-    identifier: string;
-    maxContentlets: number;
-    parentPermissionable: Record<string, string>;
-};
-/**
- * Combine classes into a single string.
- *
- * @param {string[]} classes
- * @returns {string} Combined classes
- */
-export declare const combineClasses: (classes: string[]) => string;
-/**
- * Get the start and end classes for the column based on the left offset and width.
- *
- * @param {number} start
- * @param {number} end
- * @returns {Object} Start and end classes
- */
-export declare const getPositionStyleClasses: (start: number, end: number) => {
-    startClass: string;
-    endClass: string;
-};
-/**
- * Validates the structure of a Block Editor block.
- *
- * This function checks that:
- * 1. The blocks parameter is a valid object
- * 2. The block has a 'doc' type
- * 3. The block has a valid content array that is not empty
- *
- * @param {Block} blocks - The blocks structure to validate
- * @returns {BlockEditorState} Object containing validation state and any error message
- * @property {boolean} BlockEditorState.isValid - Whether the blocks structure is valid
- * @property {string | null} BlockEditorState.error - Error message if invalid, null if valid
- */
-export declare const isValidBlocks: (blocks: Block) => BlockEditorState;