@dotcms/client 1.0.1 → 1.0.2

package/src/lib/client/content/builders/query/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/client/content/builders/query/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/client/content/builders/query/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/client/content/builders/query/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/client/content/builders/query/{query.ts → query.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/client/content/builders/query/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/client/content/{content-api.ts → content-api.d.ts}

@@ -1,7 +1,5 @@
 import { RequestOptions } from '@dotcms/types';
-
 import { CollectionBuilder } from './builders/collection/collection';
-
 /**
  * Creates a builder to filter and fetch a collection of content items.
  * @param contentType - The content type to retrieve.
@@ -51,20 +49,14 @@ import { CollectionBuilder } from './builders/collection/collection';
  * });
  * ```
  */
-export class Content {
-    #requestOptions: RequestOptions;
-    #serverUrl: string;
-
+export declare class Content {
+    #private;
     /**
      * Creates an instance of Content.
      * @param {RequestOptions} requestOptions - The options for the client request.
      * @param {string} serverUrl - The server URL.
      */
-    constructor(requestOptions: RequestOptions, serverUrl: string) {
-        this.#requestOptions = requestOptions;
-        this.#serverUrl = serverUrl;
-    }
-
+    constructor(requestOptions: RequestOptions, serverUrl: string);
     /**
      * Takes a content type and returns a builder to filter and fetch the collection.
      * @param {string} contentType - The content type to get the collection.
@@ -130,7 +122,5 @@ export class Content {
      * ```
      *
      */
-    getCollection<T = unknown>(contentType: string): CollectionBuilder<T> {
-        return new CollectionBuilder<T>(this.#requestOptions, this.#serverUrl, contentType);
-    }
+    getCollection<T = unknown>(contentType: string): CollectionBuilder<T>;
 }

package/src/lib/client/content/shared/{const.ts → const.d.ts}

@@ -1,15 +1,13 @@
 /**
  * Default variant identifier used in the application.
  */
-export const DEFAULT_VARIANT_ID = 'DEFAULT';
-
+export declare const DEFAULT_VARIANT_ID = "DEFAULT";
 /**
  * Fields that should not be formatted when sanitizing the query.
  * These fields are essential for maintaining the integrity of the content type.
  */
-export const CONTENT_TYPE_MAIN_FIELDS: string[] = ['live', 'variant', 'contentType', 'languageId'];
-
+export declare const CONTENT_TYPE_MAIN_FIELDS: string[];
 /**
  * URL endpoint for the content API search functionality.
  */
-export const CONTENT_API_URL = '/api/content/_search';
+export declare const CONTENT_API_URL = "/api/content/_search";

package/src/lib/client/content/shared/{types.ts → types.d.ts}

@@ -1,8 +1,6 @@
 import { Contentlet } from '@dotcms/types';
-
 import { Equals } from '../builders/query/lucene-syntax';
 import { QueryBuilder } from '../builders/query/query';
-
 /**
  * Model to sort by fields.
  */
@@ -16,7 +14,6 @@ export type SortBy = {
      */
     order: 'asc' | 'desc';
 };
-
 /**
  * Callback to build a query.
  *
@@ -25,7 +22,6 @@ export type SortBy = {
  * @returns {Equals} The built query.
  */
 export type BuildQuery = (qb: QueryBuilder) => Equals;
-
 /**
  * Callback for a fulfilled promise.
  *
@@ -34,13 +30,7 @@ export type BuildQuery = (qb: QueryBuilder) => Equals;
  * @param {GetCollectionResponse<T>} value - The response value.
  * @returns {GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void} The processed response or a promise.
  */
-export type OnFullfilled<T> =
-    | ((
-          value: GetCollectionResponse<T>
-      ) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void)
-    | undefined
-    | null;
-
+export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void) | undefined | null;
 /**
  * Callback for a rejected promise.
  *
@@ -48,11 +38,7 @@ export type OnFullfilled<T> =
  * @param {GetCollectionError} error - The error object.
  * @returns {GetCollectionError | PromiseLike<GetCollectionError> | void} The processed error or a promise.
  */
-export type OnRejected =
-    | ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void)
-    | undefined
-    | null;
-
+export type OnRejected = ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void) | undefined | null;
 /**
  * Response of the get collection method.
  *
@@ -80,7 +66,6 @@ export interface GetCollectionResponse<T> {
      */
     sortedBy?: SortBy[];
 }
-
 /**
  * Raw response of the get collection method.
  *
@@ -100,7 +85,6 @@ export interface GetCollectionRawResponse<T> {
         resultsSize: number;
     };
 }
-
 /**
  * Error object for the get collection method.
  */

package/src/lib/client/content/shared/{utils.ts → utils.d.ts}

@@ -1,5 +1,3 @@
-import { CONTENT_TYPE_MAIN_FIELDS } from './const';
-
 /**
  * @description
  * Sanitizes the query for the given content type.
@@ -19,10 +17,4 @@ import { CONTENT_TYPE_MAIN_FIELDS } from './const';
  * @param {string} contentType - The content type to be used for formatting the fields.
  * @returns {string} The sanitized query string.
  */
-export function sanitizeQueryForContentType(query: string, contentType: string): string {
-    return query.replace(/\+([^+:]*?):/g, (original, field) => {
-        return !CONTENT_TYPE_MAIN_FIELDS.includes(field) // Fields that are not content type fields
-            ? `+${contentType}.${field}:` // Should have this format: +contentTypeVar.field:
-            : original; // Return the field if it is a content type field
-    });
-}
+export declare function sanitizeQueryForContentType(query: string, contentType: string): string;

package/src/lib/client/models/{index.ts → index.d.ts}

@@ -9,11 +9,4 @@
  * @property {string} 502 - Bad Gateway. Try again later.
  * @property {string} 503 - Service Unavailable. Try again later.
  */
-export const ErrorMessages: Record<number, string> = {
-    401: 'Unauthorized. Check the token and try again.',
-    403: 'Forbidden. Check the permissions and try again.',
-    404: 'Not Found. Check the URL and try again.',
-    500: 'Internal Server Error. Try again later.',
-    502: 'Bad Gateway. Try again later.',
-    503: 'Service Unavailable. Try again later.'
-};
+export declare const ErrorMessages: Record<number, string>;

package/src/lib/client/navigation/navigation-api.d.ts

@@ -0,0 +1,14 @@
+import { DotCMSClientConfig, DotCMSNavigationRequestParams, RequestOptions, DotCMSNavigationItem } from '@dotcms/types';
+export declare class NavigationClient {
+    private requestOptions;
+    private BASE_URL;
+    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
+    /**
+     * Retrieves information about the dotCMS file and folder tree.
+     * @param {NavigationApiOptions} options - The options for the Navigation API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
+     * @returns {Promise<DotCMSNavigationItem[]>} - A Promise that resolves to the response from the DotCMS API.
+     * @throws {Error} - Throws an error if the options are not valid.
+     */
+    get(path: string, params?: DotCMSNavigationRequestParams): Promise<DotCMSNavigationItem[]>;
+    private mapToBackendParams;
+}