@dotcms/client 0.0.1-alpha.40 → 0.0.1-alpha.41

package/src/lib/editor/utils/{editor.utils.ts → editor.utils.d.ts}

@@ -15,7 +15,6 @@ interface ContentletBound {
     height: number;
     payload: string;
 }
-
 /**
  * Bound information for a container.
  *
@@ -35,7 +34,6 @@ interface ContainerBound {
     payload: string;
     contentlets: ContentletBound[];
 }
-
 /**
  * Calculates the bounding information for each page element within the given containers.
  *
@@ -49,26 +47,7 @@ interface ContainerBound {
  * console.log(bounds);
  * ```
  */
-export function getPageElementBound(containers: HTMLDivElement[]): ContainerBound[] {
-    return containers.map((container) => {
-        const containerRect = container.getBoundingClientRect();
-        const contentlets = Array.from(
-            container.querySelectorAll('[data-dot-object="contentlet"]')
-        ) as HTMLDivElement[];
-
-        return {
-            x: containerRect.x,
-            y: containerRect.y,
-            width: containerRect.width,
-            height: containerRect.height,
-            payload: JSON.stringify({
-                container: getContainerData(container)
-            }),
-            contentlets: getContentletsBound(containerRect, contentlets)
-        };
-    });
-}
-
+export declare function getPageElementBound(containers: HTMLDivElement[]): ContainerBound[];
 /**
  * Calculates the bounding information for each contentlet inside a container.
  *
@@ -84,33 +63,7 @@ export function getPageElementBound(containers: HTMLDivElement[]): ContainerBoun
  * console.log(bounds); // Element bounds within the container
  * ```
  */
-export function getContentletsBound(
-    containerRect: DOMRect,
-    contentlets: HTMLDivElement[]
-): ContentletBound[] {
-    return contentlets.map((contentlet) => {
-        const contentletRect = contentlet.getBoundingClientRect();
-
-        return {
-            x: 0,
-            y: contentletRect.y - containerRect.y,
-            width: contentletRect.width,
-            height: contentletRect.height,
-            payload: JSON.stringify({
-                container: contentlet.dataset?.['dotContainer']
-                    ? JSON.parse(contentlet.dataset?.['dotContainer'])
-                    : getClosestContainerData(contentlet),
-                contentlet: {
-                    identifier: contentlet.dataset?.['dotIdentifier'],
-                    title: contentlet.dataset?.['dotTitle'],
-                    inode: contentlet.dataset?.['dotInode'],
-                    contentType: contentlet.dataset?.['dotType']
-                }
-            })
-        };
-    });
-}
-
+export declare function getContentletsBound(containerRect: DOMRect, contentlets: HTMLDivElement[]): ContentletBound[];
 /**
  * Get container data from VTLS.
  *
@@ -124,15 +77,12 @@ export function getContentletsBound(
  * console.log(data);
  * ```
  */
-export function getContainerData(container: HTMLElement) {
-    return {
-        acceptTypes: container.dataset?.['dotAcceptTypes'] || '',
-        identifier: container.dataset?.['dotIdentifier'] || '',
-        maxContentlets: container.dataset?.['maxContentlets'] || '',
-        uuid: container.dataset?.['dotUuid'] || ''
-    };
-}
-
+export declare function getContainerData(container: HTMLElement): {
+    acceptTypes: string;
+    identifier: string;
+    maxContentlets: string;
+    uuid: string;
+};
 /**
  * Get the closest container data from the contentlet.
  *
@@ -146,22 +96,12 @@ export function getContainerData(container: HTMLElement) {
  * console.log(data);
  * ```
  */
-export function getClosestContainerData(element: Element) {
-    // Find the closest ancestor element with data-dot-object="container" attribute
-    const container = element.closest('[data-dot-object="container"]') as HTMLElement;
-
-    // If a container element is found
-    if (container) {
-        // Return the dataset of the container element
-        return getContainerData(container);
-    } else {
-        // If no container element is found, return null
-        console.warn('No container found for the contentlet');
-
-        return null;
-    }
-}
-
+export declare function getClosestContainerData(element: Element): {
+    acceptTypes: string;
+    identifier: string;
+    maxContentlets: string;
+    uuid: string;
+} | null;
 /**
  * Find the closest contentlet element based on HTMLElement.
  *
@@ -173,19 +113,7 @@ export function getClosestContainerData(element: Element) {
  * const contentlet = findDotElement(element);
  * console.log(contentlet);
  */
-export function findDotElement(element: HTMLElement | null): HTMLElement | null {
-    if (!element) return null;
-
-    if (
-        element?.dataset?.['dotObject'] === 'contentlet' ||
-        (element?.dataset?.['dotObject'] === 'container' && element.children.length === 0)
-    ) {
-        return element;
-    }
-
-    return findDotElement(element?.['parentElement']);
-}
-
+export declare function findDotElement(element: HTMLElement | null): HTMLElement | null;
 /**
  * Find the closest VTL file element based on HTMLElement.
  *
@@ -197,16 +125,7 @@ export function findDotElement(element: HTMLElement | null): HTMLElement | null
  * const vtlFile = findDotVTLElement(element);
  * console.log(vtlFile);
  */
-export function findDotVTLElement(element: HTMLElement | null): HTMLElement | null {
-    if (!element) return null;
-
-    if (element.dataset && element.dataset?.['dotObject'] === 'vtl-file') {
-        return element;
-    } else {
-        return findDotElement(element?.['parentElement']);
-    }
-}
-
+export declare function findDotVTLElement(element: HTMLElement | null): HTMLElement | null;
 /**
  * Find VTL data within a target element.
  *
@@ -220,23 +139,10 @@ export function findDotVTLElement(element: HTMLElement | null): HTMLElement | nu
  * console.log(vtlData);
  * ```
  */
-export function findVTLData(target: HTMLElement) {
-    const vltElements = target.querySelectorAll(
-        '[data-dot-object="vtl-file"]'
-    ) as NodeListOf<HTMLElement>;
-
-    if (!vltElements.length) {
-        return null;
-    }
-
-    return Array.from(vltElements).map((vltElement) => {
-        return {
-            inode: vltElement.dataset?.['dotInode'],
-            name: vltElement.dataset?.['dotUrl']
-        };
-    });
-}
-
+export declare function findVTLData(target: HTMLElement): {
+    inode: string | undefined;
+    name: string | undefined;
+}[] | null;
 /**
  * Check if the scroll position is at the bottom of the page.
  *
@@ -249,10 +155,5 @@ export function findVTLData(target: HTMLElement) {
  * }
  * ```
  */
-export function scrollIsInBottom() {
-    const documentHeight = document.documentElement.scrollHeight;
-    const viewportHeight = window.innerHeight;
-    const scrollY = window.scrollY;
-
-    return scrollY + viewportHeight >= documentHeight;
-}
+export declare function scrollIsInBottom(): boolean;
+export {};

package/src/lib/query-builder/lucene-syntax/{Equals.ts → Equals.d.ts}

@@ -1,17 +1,6 @@
 import { Field } from './Field';
 import { NotOperand } from './NotOperand';
 import { Operand } from './Operand';
-
-import {
-    OPERAND,
-    buildExcludeField,
-    buildField,
-    buildNotOperand,
-    buildOperand,
-    buildRawEquals,
-    sanitizeQuery
-} from '../utils';
-
 /**
  * 'Equal' Is a Typescript class that provides the ability to use terms in the lucene query string.
  * A term is a value used to search for a specific value in a document. It can be a word or a phrase.
@@ -21,13 +10,10 @@ import {
  * @export
  * @class Equal
  */
-export class Equals {
-    #query = '';
-
-    constructor(private query: string) {
-        this.#query = this.query;
-    }
-
+export declare class Equals {
+    #private;
+    private query;
+    constructor(query: string);
     /**
      * This method appends to the query a term that should be excluded in the search.
      *
@@ -41,10 +27,7 @@ export class Equals {
      * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
      * @memberof Equal
      */
-    excludeField(field: string): Field {
-        return buildExcludeField(this.#query, field);
-    }
-
+    excludeField(field: string): Field;
     /**
      * This method appends to the query a field that should be included in the search.
      *
@@ -57,10 +40,7 @@ export class Equals {
      * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
      * @memberof Equal
      */
-    field(field: string): Field {
-        return buildField(this.#query, field);
-    }
-
+    field(field: string): Field;
     /**
      * This method appends to the query an operand to use logic operators in the query.
      *
@@ -74,10 +54,7 @@ export class Equals {
      * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
      * @memberof Equal
      */
-    or(): Operand {
-        return buildOperand(this.#query, OPERAND.OR);
-    }
-
+    or(): Operand;
     /**
      * This method appends to the query an operand to use logic operators in the query.
      *
@@ -90,10 +67,7 @@ export class Equals {
      * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
      * @memberof Equal
      */
-    and(): Operand {
-        return buildOperand(this.#query, OPERAND.AND);
-    }
-
+    and(): Operand;
     /**
      * This method appends to the query an operand to use logic operators in the query.
      *
@@ -106,10 +80,7 @@ export class Equals {
      * @return {*}  {NotOperand} - An instance of a Lucene Not Operand. A not operand is a logical operator used to exclude terms or phrases in a query.
      * @memberof Equal
      */
-    not(): NotOperand {
-        return buildNotOperand(this.#query);
-    }
-
+    not(): NotOperand;
     /**
      * This method allows to pass a raw query string to the query builder.
      * This raw query should end in a Lucene Equal.
@@ -126,10 +97,7 @@ export class Equals {
      * @return {*}  {Equal} - An instance of a Lucene Equal. A term is a value used to search for a specific value in a document.
      * @memberof QueryBuilder
      */
-    raw(query: string): Equals {
-        return buildRawEquals(this.#query, query);
-    }
-
+    raw(query: string): Equals;
     /**
      * This method returns the final query string.
      *
@@ -142,7 +110,5 @@ export class Equals {
      * @return {*}  {string} - The final query string.
      * @memberof Equal
      */
-    build(): string {
-        return sanitizeQuery(this.#query);
-    }
+    build(): string;
 }

package/src/lib/query-builder/lucene-syntax/{Field.ts → Field.d.ts}

@@ -1,7 +1,4 @@
 import { Equals } from './Equals';
-
-import { buildEquals } from '../utils';
-
 /**
  * The `Field` class is used to build a query with a specific field.
  * A Lucene Field is a key used to search for a specific value in a document.
@@ -9,18 +6,15 @@ import { buildEquals } from '../utils';
  * @export
  * @class Field
  */
-export class Field {
-    #query = '';
-
+export declare class Field {
+    #private;
+    private query;
     /**
      * Creates an instance of the `Field` class.
      *
      * @param {string} query - The initial query string.
      */
-    constructor(private query: string) {
-        this.#query = this.query;
-    }
-
+    constructor(query: string);
     /**
      * Appends a term to the query that should be included in the search.
      *
@@ -34,7 +28,5 @@ export class Field {
      * @return {Equals} - An instance of `Equals`.
      * @memberof Field
      */
-    equals(term: string): Equals {
-        return buildEquals(this.#query, term);
-    }
+    equals(term: string): Equals;
 }

package/src/lib/query-builder/lucene-syntax/{NotOperand.ts → NotOperand.d.ts}

@@ -1,20 +1,14 @@
 import { Equals } from './Equals';
-
-import { buildEquals } from '../utils';
-
 /**
  * 'NotOperand' Is a Typescript class that provides the ability to use the NOT operand in the lucene query string.
  *
  * @export
  * @class NotOperand
  */
-export class NotOperand {
-    #query = '';
-
-    constructor(private query: string) {
-        this.#query = this.query;
-    }
-
+export declare class NotOperand {
+    #private;
+    private query;
+    constructor(query: string);
     /**
      * This method appends to the query a term that should be included in the search.
      *
@@ -28,7 +22,5 @@ export class NotOperand {
      * @return {*}  {Equals} - An instance of Equals.
      * @memberof NotOperand
      */
-    equals(term: string): Equals {
-        return buildEquals(this.#query, term);
-    }
+    equals(term: string): Equals;
 }

package/src/lib/query-builder/lucene-syntax/{Operand.ts → Operand.d.ts}

@@ -1,8 +1,5 @@
 import { Equals } from './Equals';
 import { Field } from './Field';
-
-import { buildExcludeField, buildField, buildEquals } from '../utils';
-
 /**
  * 'Operand' Is a Typescript class that provides the ability to use operands in the lucene query string.}
  * An operand is a logical operator used to join two or more conditions in a query.
@@ -10,13 +7,10 @@ import { buildExcludeField, buildField, buildEquals } from '../utils';
  * @export
  * @class Operand
  */
-export class Operand {
-    #query = '';
-
-    constructor(private query: string) {
-        this.#query = this.query;
-    }
-
+export declare class Operand {
+    #private;
+    private query;
+    constructor(query: string);
     /**
      * This method appends to the query a term that should be excluded in the search.
      *
@@ -26,10 +20,7 @@ export class Operand {
      * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
      * @memberof Operand
      */
-    excludeField(field: string): Field {
-        return buildExcludeField(this.#query, field);
-    }
-
+    excludeField(field: string): Field;
     /**
      * This method appends to the query a field that should be included in the search.
      *
@@ -39,10 +30,7 @@ export class Operand {
      * @return {*}  {Field} -  An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
      * @memberof Operand
      */
-    field(field: string): Field {
-        return buildField(this.#query, field);
-    }
-
+    field(field: string): Field;
     /**
      * This method appends to the query a term that should be included in the search.
      *
@@ -52,7 +40,5 @@ export class Operand {
      * @return {*}  {Equals} - An instance of Equals.
      * @memberof Operand
      */
-    equals(term: string): Equals {
-        return buildEquals(this.#query, term);
-    }
+    equals(term: string): Equals;
 }

package/src/lib/query-builder/{sdk-query-builder.ts → sdk-query-builder.d.ts}

@@ -1,6 +1,4 @@
 import { Equals, Field } from './lucene-syntax/index';
-import { buildExcludeField, buildField, buildRawEquals } from './utils';
-
 /**
  * 'QueryBuilder' Is a Typescript class that provides the ability to build a query string using the Lucene syntax in a more readable way.
  * @example
@@ -29,9 +27,8 @@ import { buildExcludeField, buildField, buildRawEquals } from './utils';
  * @export
  * @class QueryBuilder
  */
-export class QueryBuilder {
-    #query = '';
-
+export declare class QueryBuilder {
+    #private;
     /**
      * This method appends to the query a field that should be included in the search.
      *
@@ -45,10 +42,7 @@ export class QueryBuilder {
      * @return {*}  {Field} -  An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
      * @memberof QueryBuilder
      */
-    field(field: string): Field {
-        return buildField(this.#query, field);
-    }
-
+    field(field: string): Field;
     /**
      * This method appends to the query a field that should be excluded from the search.
      *
@@ -62,10 +56,7 @@ export class QueryBuilder {
      * @return {*}  {Field} -  An instance of a Lucene Exclude Field. An exclude field is a key used to exclude for a specific value in a document.
      * @memberof QueryBuilder
      */
-    excludeField(field: string): Field {
-        return buildExcludeField(this.#query, field);
-    }
-
+    excludeField(field: string): Field;
     /**
      * This method allows to pass a raw query string to the query builder.
      * This raw query should end in Equals.
@@ -81,7 +72,5 @@ export class QueryBuilder {
      * @return {*}  {Equals} - An instance of Equals. A term is a value used to search for a specific value in a document.
      * @memberof QueryBuilder
      */
-    raw(query: string): Equals {
-        return buildRawEquals(this.#query, query);
-    }
+    raw(query: string): Equals;
 }

package/src/lib/query-builder/utils/{index.ts → index.d.ts}

@@ -2,19 +2,17 @@ import { Equals } from '../lucene-syntax/Equals';
 import { Field } from '../lucene-syntax/Field';
 import { NotOperand } from '../lucene-syntax/NotOperand';
 import { Operand } from '../lucene-syntax/Operand';
-
 /**
  * Enum for common Operands
  *
  * @export
  * @enum {number}
  */
-export enum OPERAND {
-    OR = 'OR',
-    AND = 'AND',
-    NOT = 'NOT'
+export declare enum OPERAND {
+    OR = "OR",
+    AND = "AND",
+    NOT = "NOT"
 }
-
 /**
  * This function removes extra spaces from a string.
  *
@@ -27,10 +25,7 @@ export enum OPERAND {
  * @param {string} str
  * @return {*}  {string}
  */
-export function sanitizeQuery(str: string): string {
-    return str.replace(/\s{2,}/g, ' ').trim();
-}
-
+export declare function sanitizeQuery(str: string): string;
 /**
  * This function sanitizes a term by adding quotes if it contains spaces.
  * In lucene, a term with spaces should be enclosed in quotes.
@@ -45,10 +40,7 @@ export function sanitizeQuery(str: string): string {
  * @param {string} term
  * @return {*}  {string}
  */
-export function sanitizePhrases(term: string): string {
-    return term.includes(' ') ? `"${term}"` : term;
-}
-
+export declare function sanitizePhrases(term: string): string;
 /**
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the term before adding it to the query.
@@ -63,12 +55,7 @@ export function sanitizePhrases(term: string): string {
  * @param {string} term
  * @return {*}  {Equals}
  */
-export function buildEquals(query: string, term: string): Equals {
-    const newQuery = query + sanitizePhrases(term);
-
-    return new Equals(newQuery);
-}
-
+export declare function buildEquals(query: string, term: string): Equals;
 /**
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the raw query before adding it to the query.
@@ -84,12 +71,7 @@ export function buildEquals(query: string, term: string): Equals {
  * @param {string} raw
  * @return {*}  {Equals}
  */
-export function buildRawEquals(query: string, raw: string): Equals {
-    const newQuery = query + ` ${raw}`;
-
-    return new Equals(sanitizeQuery(newQuery));
-}
-
+export declare function buildRawEquals(query: string, raw: string): Equals;
 /**
  * This function builds a field to be used in a lucene query.
  * We need to format the field before adding it to the query.
@@ -104,12 +86,7 @@ export function buildRawEquals(query: string, raw: string): Equals {
  * @param {string} field
  * @return {*}  {Field}
  */
-export function buildField(query: string, field: string): Field {
-    const newQuery = query + ` +${field}:`;
-
-    return new Field(newQuery);
-}
-
+export declare function buildField(query: string, field: string): Field;
 /**
  * This function builds an exclude field to be used in a lucene query.
  * We need to format the field before adding it to the query.
@@ -125,12 +102,7 @@ export function buildField(query: string, field: string): Field {
  * @param {string} field
  * @return {*}  {Field}
  */
-export function buildExcludeField(query: string, field: string): Field {
-    const newQuery = query + ` -${field}:`;
-
-    return new Field(newQuery);
-}
-
+export declare function buildExcludeField(query: string, field: string): Field;
 /**
  * This function builds an operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
@@ -152,12 +124,7 @@ export function buildExcludeField(query: string, field: string): Field {
  * @param {OPERAND} operand
  * @return {*}  {Operand}
  */
-export function buildOperand(query: string, operand: OPERAND): Operand {
-    const newQuery = query + ` ${operand} `;
-
-    return new Operand(newQuery);
-}
-
+export declare function buildOperand(query: string, operand: OPERAND): Operand;
 /**
  * This function builds a NOT operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
@@ -172,8 +139,4 @@ export function buildOperand(query: string, operand: OPERAND): Operand {
  * @param {string} query
  * @return {*}  {NotOperand}
  */
-export function buildNotOperand(query: string): NotOperand {
-    const newQuery = query + ` ${OPERAND.NOT} `;
-
-    return new NotOperand(newQuery);
-}
+export declare function buildNotOperand(query: string): NotOperand;

package/src/lib/utils/graphql/transforms.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Represents the response from a GraphQL query for a page.
+ *
+ * @interface GraphQLPageResponse
+ * @property {Record<string, unknown>} page - The main page data.
+ * @property {unknown} [key: string] - Additional properties that may be included in the response.
+ */
+interface GraphQLPageResponse {
+    page: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/**
+ * Transforms a GraphQL Page response to a Page Entity.
+ *
+ * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
+ * @returns {object|null} The transformed Page Entity or null if the page is not present.
+ *
+ * @example
+ * ```ts
+ * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
+ * ```
+ */
+export declare const graphqlToPageEntity: (graphQLPageResponse: GraphQLPageResponse) => any;
+export {};

package/src/lib/utils/page/common-utils.d.ts

@@ -0,0 +1,33 @@
+import { PageApiOptions } from '../../client/sdk-js-client';
+/**
+ * Interface representing the properties for page request parameters.
+ *
+ * @export
+ * @interface PageRequestParamsProps
+ */
+export interface PageRequestParamsProps {
+    /**
+     * The API endpoint path.
+     * @type {string}
+     */
+    path: string;
+    /**
+     * The query parameters for the API request.
+     * Can be an object with key-value pairs or a URLSearchParams instance.
+     * @type {{ [key: string]: unknown } | URLSearchParams}
+     */
+    params: {
+        [key: string]: unknown;
+    } | URLSearchParams;
+}
+/**
+ * Generates the page request parameters to be used in the API call.
+ *
+ * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
+ * @returns {PageApiOptions} The options for the page API.
+ * @example
+ * ```ts
+ * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
+ * ```
+ */
+export declare const getPageRequestParams: ({ path, params }: PageRequestParamsProps) => PageApiOptions;