@dotcms/client 0.0.1-alpha.38 → 0.0.1-alpha.39

package/src/lib/client/content/builders/collection/{collection.d.ts → collection.ts}

@@ -1,5 +1,18 @@
+import { Equals } from '../../../../query-builder/lucene-syntax';
+import { QueryBuilder } from '../../../../query-builder/sdk-query-builder';
 import { ClientOptions } from '../../../sdk-js-client';
-import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfilled, OnRejected } from '../../shared/types';
+import { CONTENT_API_URL } from '../../shared/const';
+import {
+    GetCollectionResponse,
+    BuildQuery,
+    SortBy,
+    GetCollectionRawResponse,
+    GetCollectionError,
+    OnFullfilled,
+    OnRejected
+} from '../../shared/types';
+import { sanitizeQueryForContentType } from '../../shared/utils';
+
 /**
  * Creates a Builder to filter and fetch content from the content API for a specific content type.
  *
@@ -7,8 +20,22 @@ import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfi
  * @class CollectionBuilder
  * @template T Represents the type of the content type to fetch. Defaults to unknown.
  */
-export declare class CollectionBuilder<T = unknown> {
-    #private;
+export class CollectionBuilder<T = unknown> {
+    #page = 1;
+    #limit = 10;
+    #depth = 0;
+    #render = false;
+    #sortBy?: SortBy[];
+    #contentType: string;
+    #defaultQuery: Equals;
+    #query?: Equals;
+    #rawQuery?: string;
+    #languageId: number | string = 1;
+    #draft = false;
+
+    #serverUrl: string;
+    #requestOptions: ClientOptions;
+
     /**
      * Creates an instance of CollectionBuilder.
      * @param {ClientOptions} requestOptions Options for the client request.
@@ -16,7 +43,15 @@ export declare class CollectionBuilder<T = unknown> {
      * @param {string} contentType The content type to fetch.
      * @memberof CollectionBuilder
      */
-    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string);
+    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string) {
+        this.#requestOptions = requestOptions;
+        this.#serverUrl = serverUrl;
+        this.#contentType = contentType;
+
+        // Build the default query with the contentType field
+        this.#defaultQuery = new QueryBuilder().field('contentType').equals(this.#contentType);
+    }
+
     /**
      * Returns the sort query in the format: field order, field order, ...
      *
@@ -24,7 +59,10 @@ export declare class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get sort();
+    private get sort() {
+        return this.#sortBy?.map((sort) => `${sort.field} ${sort.order}`).join(',');
+    }
+
     /**
      * Returns the offset for pagination.
      *
@@ -32,7 +70,10 @@ export declare class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get offset();
+    private get offset() {
+        return this.#limit * (this.#page - 1);
+    }
+
     /**
      * Returns the full URL for the content API.
      *
@@ -40,7 +81,10 @@ export declare class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get url();
+    private get url() {
+        return `${this.#serverUrl}${CONTENT_API_URL}`;
+    }
+
     /**
      * Returns the current query built.
      *
@@ -48,7 +92,10 @@ export declare class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get currentQuery();
+    private get currentQuery() {
+        return this.#query ?? this.#defaultQuery;
+    }
+
     /**
      * Filters the content by the specified language ID.
      *
@@ -63,7 +110,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    language(languageId: number | string): this;
+    language(languageId: number | string): this {
+        this.#languageId = languageId;
+
+        return this;
+    }
+
     /**
      * Setting this to true will server side render (using velocity) any widgets that are returned by the content query.
      *
@@ -72,7 +124,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    render(): this;
+    render(): this {
+        this.#render = true;
+
+        return this;
+    }
+
     /**
      * Sorts the content by the specified fields and orders.
      *
@@ -88,7 +145,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    sortBy(sortBy: SortBy[]): this;
+    sortBy(sortBy: SortBy[]): this {
+        this.#sortBy = sortBy;
+
+        return this;
+    }
+
     /**
      * Sets the maximum amount of content to fetch.
      *
@@ -96,7 +158,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    limit(limit: number): this;
+    limit(limit: number): this {
+        this.#limit = limit;
+
+        return this;
+    }
+
     /**
      * Sets the page number to fetch.
      *
@@ -104,7 +171,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    page(page: number): this;
+    page(page: number): this {
+        this.#page = page;
+
+        return this;
+    }
+
     /**
      * Filters the content by a Lucene query string.
      *
@@ -113,6 +185,7 @@ export declare class CollectionBuilder<T = unknown> {
      * @memberof CollectionBuilder
      */
     query(query: string): this;
+
     /**
      * Filters the content by building a query using a QueryBuilder function.
      *
@@ -130,6 +203,33 @@ export declare class CollectionBuilder<T = unknown> {
      * @memberof CollectionBuilder
      */
     query(buildQuery: BuildQuery): this;
+    query(arg: unknown): this {
+        if (typeof arg === 'string') {
+            this.#rawQuery = arg;
+
+            return this;
+        }
+
+        if (typeof arg !== 'function') {
+            throw new Error(
+                `Parameter for query method should be a buildQuery function or a string.\nExample:\nclient.content.getCollection('Activity').query((queryBuilder) => queryBuilder.field('title').equals('Hello World'))\nor\nclient.content.getCollection('Activity').query('+Activity.title:"Hello World"') \nSee documentation for more information.`
+            );
+        }
+
+        const builtQuery = arg(new QueryBuilder());
+
+        // This can be use in Javascript so we cannot rely on the type checking
+        if (builtQuery instanceof Equals) {
+            this.#query = builtQuery.raw(this.currentQuery.build());
+        } else {
+            throw new Error(
+                'Provided query is not valid. A query should end in an equals method call.\nExample:\n(queryBuilder) => queryBuilder.field("title").equals("Hello World")\nSee documentation for more information.'
+            );
+        }
+
+        return this;
+    }
+
     /**
      * Retrieves draft content.
      * @example
@@ -145,7 +245,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    draft(): this;
+    draft(): this {
+        this.#draft = true;
+
+        return this;
+    }
+
     /**
      * Filters the content by a variant ID for [Experiments](https://www.dotcms.com/docs/latest/experiments-and-a-b-testing)
      *
@@ -165,7 +270,12 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    variant(variantId: string): this;
+    variant(variantId: string): this {
+        this.#query = this.currentQuery.field('variant').equals(variantId);
+
+        return this;
+    }
+
     /**
      * Sets the depth of the relationships of the content.
      * Specifies the depth of related content to return in the results.
@@ -186,7 +296,16 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    depth(depth: number): this;
+    depth(depth: number): this {
+        if (depth < 0 || depth > 3) {
+            throw new Error('Depth value must be between 0 and 3');
+        }
+
+        this.#depth = depth;
+
+        return this;
+    }
+
     /**
      * Executes the fetch and returns a promise that resolves to the content or rejects with an error.
      *
@@ -205,7 +324,30 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects with an error.
      * @memberof CollectionBuilder
      */
-    then(onfulfilled?: OnFullfilled<T>, onrejected?: OnRejected): Promise<GetCollectionResponse<T> | GetCollectionError>;
+    then(
+        onfulfilled?: OnFullfilled<T>,
+        onrejected?: OnRejected
+    ): Promise<GetCollectionResponse<T> | GetCollectionError> {
+        return this.fetch().then(async (response) => {
+            const data = await response.json();
+            if (response.ok) {
+                const formattedResponse = this.formatResponse<T>(data);
+
+                const finalResponse =
+                    typeof onfulfilled === 'function'
+                        ? onfulfilled(formattedResponse)
+                        : formattedResponse;
+
+                return finalResponse;
+            } else {
+                return {
+                    status: response.status,
+                    ...data
+                };
+            }
+        }, onrejected);
+    }
+
     /**
      * Formats the response to the desired format.
      *
@@ -214,7 +356,25 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {GetCollectionResponse<T>} The formatted response.
      * @memberof CollectionBuilder
      */
-    private formatResponse;
+    private formatResponse<T>(data: GetCollectionRawResponse<T>): GetCollectionResponse<T> {
+        const contentlets = data.entity.jsonObjectView.contentlets;
+        const total = data.entity.resultsSize;
+
+        const mappedResponse: GetCollectionResponse<T> = {
+            contentlets,
+            total,
+            page: this.#page,
+            size: contentlets.length
+        };
+
+        return this.#sortBy
+            ? {
+                  ...mappedResponse,
+                  sortedBy: this.#sortBy
+              }
+            : mappedResponse;
+    }
+
     /**
      * Calls the content API to fetch the content.
      *
@@ -222,5 +382,35 @@ export declare class CollectionBuilder<T = unknown> {
      * @return {Promise<Response>} The fetch response.
      * @memberof CollectionBuilder
      */
-    private fetch;
+    private fetch(): Promise<Response> {
+        const finalQuery = this.currentQuery
+            .field('languageId')
+            .equals(this.#languageId.toString())
+            .field('live')
+            .equals((!this.#draft).toString())
+            .build();
+
+        const sanitizedQuery = sanitizeQueryForContentType(finalQuery, this.#contentType);
+
+        const query = this.#rawQuery ? `${sanitizedQuery} ${this.#rawQuery}` : sanitizedQuery;
+
+        return fetch(this.url, {
+            ...this.#requestOptions,
+            method: 'POST',
+            headers: {
+                ...this.#requestOptions.headers,
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({
+                query,
+                render: this.#render,
+                sort: this.sort,
+                limit: this.#limit,
+                offset: this.offset,
+                depth: this.#depth
+                //userId: This exist but we currently don't use it
+                //allCategoriesInfo: This exist but we currently don't use it
+            })
+        });
+    }
 }

package/src/lib/client/content/{content-api.d.ts → content-api.ts}

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

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

@@ -1,13 +1,15 @@
 /**
  * Default variant identifier used in the application.
  */
-export declare const DEFAULT_VARIANT_ID = "DEFAULT";
+export 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 declare const CONTENT_TYPE_MAIN_FIELDS: string[];
+export const CONTENT_TYPE_MAIN_FIELDS: string[] = ['live', 'variant', 'contentType', 'languageId'];
+
 /**
  * URL endpoint for the content API search functionality.
  */
-export declare const CONTENT_API_URL = "/api/content/_search";
+export const CONTENT_API_URL = '/api/content/_search';

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

@@ -1,5 +1,6 @@
 import { Equals } from '../../../query-builder/lucene-syntax';
 import { QueryBuilder } from '../../../query-builder/sdk-query-builder';
+
 /**
  * Model to sort by fields.
  */
@@ -13,6 +14,7 @@ export type SortBy = {
      */
     order: 'asc' | 'desc';
 };
+
 /**
  * Callback to build a query.
  *
@@ -21,6 +23,7 @@ export type SortBy = {
  * @returns {Equals} The built query.
  */
 export type BuildQuery = (qb: QueryBuilder) => Equals;
+
 /**
  * Main fields of a Contentlet (Inherited from the Content Type).
  */
@@ -57,12 +60,14 @@ export interface ContentTypeMainFields {
     contentTypeIcon: string;
     variant: string;
 }
+
 /**
  * The contentlet has the main fields and the custom fields of the content type.
  *
  * @template T - The custom fields of the content type.
  */
 export type Contentlet<T> = T & ContentTypeMainFields;
+
 /**
  * Callback for a fulfilled promise.
  *
@@ -71,7 +76,13 @@ export type Contentlet<T> = T & ContentTypeMainFields;
  * @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.
  *
@@ -79,7 +90,11 @@ export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectio
  * @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.
  *
@@ -107,6 +122,7 @@ export interface GetCollectionResponse<T> {
      */
     sortedBy?: SortBy[];
 }
+
 /**
  * Raw response of the get collection method.
  *
@@ -126,6 +142,7 @@ export interface GetCollectionRawResponse<T> {
         resultsSize: number;
     };
 }
+
 /**
  * Error object for the get collection method.
  */

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

@@ -1,3 +1,5 @@
+import { CONTENT_TYPE_MAIN_FIELDS } from './const';
+
 /**
  * @description
  * Sanitizes the query for the given content type.
@@ -17,4 +19,10 @@
  * @param {string} contentType - The content type to be used for formatting the fields.
  * @returns {string} The sanitized query string.
  */
-export declare function sanitizeQueryForContentType(query: string, contentType: string): 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
+    });
+}

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

@@ -9,4 +9,11 @@
  * @property {string} 502 - Bad Gateway. Try again later.
  * @property {string} 503 - Service Unavailable. Try again later.
  */
-export declare const ErrorMessages: Record<number, string>;
+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.'
+};

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

@@ -9,5 +9,6 @@
 export type DotcmsClientListener = {
     action: string;
     event: string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     callback: (...args: any[]) => void;
 };