@dotcms/client 1.0.0 → 1.0.1

package/src/lib/client/content/builders/query/query.spec.ts

@@ -0,0 +1,159 @@
+import { QueryBuilder } from './query';
+
+describe('QueryBuilder', () => {
+    let queryBuilder: QueryBuilder;
+
+    beforeEach(() => {
+        queryBuilder = new QueryBuilder();
+    });
+
+    it('should return a query with a simple term', () => {
+        const queryForBlogs = queryBuilder.field('contentType').equals('Blog').build();
+
+        expect(queryForBlogs).toBe('+contentType:Blog');
+    });
+
+    it('should return a query with multiple fields with a simple term ', () => {
+        const queryForBlogsInSuperCoolSite = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .field('conhost')
+            .equals('my-super-cool-site')
+            .build();
+
+        expect(queryForBlogsInSuperCoolSite).toBe('+contentType:Blog +conhost:my-super-cool-site');
+    });
+
+    it('should return a query with an "OR" operand', () => {
+        const queryForBlogsOrArticles = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .or()
+            .equals('Article')
+            .build();
+
+        expect(queryForBlogsOrArticles).toBe('+contentType:Blog OR Article');
+    });
+
+    it('should return a query with an "AND" operand', () => {
+        const queryForBlogsAndArticles = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .and()
+            .equals('Article')
+            .build();
+
+        expect(queryForBlogsAndArticles).toBe('+contentType:Blog AND Article');
+    });
+
+    it('should return a query with a "NOT" operand', () => {
+        const queryForSkiingTripsNotInSwissAlps = queryBuilder
+            .field('summary')
+            .equals('Skiing trip')
+            .not()
+            .equals('Swiss Alps')
+            .build();
+
+        expect(queryForSkiingTripsNotInSwissAlps).toBe(`+summary:'Skiing trip' NOT 'Swiss Alps'`);
+    });
+
+    it('should return a query with an exclusion field', () => {
+        const queryForFootballBlogsWithoutMessi = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .field('title')
+            .equals('Football')
+            .excludeField('summary')
+            .equals('Lionel Messi')
+            .build();
+
+        expect(queryForFootballBlogsWithoutMessi).toBe(
+            `+contentType:Blog +title:Football -summary:'Lionel Messi'`
+        );
+    });
+
+    it('should build a raw query from the query builder', () => {
+        const queryForBlogs = queryBuilder
+            .raw('+summary:Snowboard')
+            .not()
+            .equals('Swiss Alps')
+            .field('contentType')
+            .equals('Blog')
+            .build();
+
+        expect(queryForBlogs).toBe(`+summary:Snowboard NOT 'Swiss Alps' +contentType:Blog`);
+    });
+
+    it('should return a query with a raw query appended', () => {
+        const queryForBlogs = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .raw('+summary:Snowboard')
+            .not()
+            .equals('Swiss Alps')
+            .build();
+
+        expect(queryForBlogs).toBe(`+contentType:Blog +summary:Snowboard NOT 'Swiss Alps'`);
+    });
+
+    it('should return a query with a raw query created with a queryBuilder appended and a term', () => {
+        const anotherQueryBuilder = new QueryBuilder();
+
+        const snowboardInCanada = anotherQueryBuilder
+            .field('summary')
+            .equals('Snowboard')
+            .field('country')
+            .equals('Canada')
+            .build();
+
+        const queryForBlogs = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .raw(snowboardInCanada)
+            .build();
+
+        expect(queryForBlogs).toBe('+contentType:Blog +summary:Snowboard +country:Canada');
+    });
+
+    it('should return a query with all possible combinations', () => {
+        const blogOrActivity = queryBuilder
+            .field('contentType')
+            .equals('Blog')
+            .or()
+            .equals('Activity');
+
+        const customIdSiteOrCoolSite = blogOrActivity
+            .field('conhost')
+            .equals('48190c8c-42c4-46af-8d1a-0cd5db894797')
+            .or()
+            .equals('cool-site');
+
+        const englishAndSpanish = customIdSiteOrCoolSite
+            .field('languageId')
+            .equals('1')
+            .and()
+            .equals('2');
+
+        const notDeleted = englishAndSpanish.field('deleted').equals('false');
+
+        const currentlyWorking = notDeleted.field('working').equals('true');
+
+        const defaultVariant = currentlyWorking.field('variant').equals('default');
+
+        const snowboardOutsideSwissAlps = defaultVariant
+            .field('title')
+            .equals('Snowboard')
+            .excludeField('summary')
+            .equals('Swiss Alps');
+
+        const writtenByJohnDoe = snowboardOutsideSwissAlps.field('authors').equals('John Doe');
+
+        const withoutJaneDoeHelp = writtenByJohnDoe.not().equals('Jane Doe');
+
+        const query = withoutJaneDoeHelp.build();
+
+        expect(query).toBe(
+            `+contentType:Blog OR Activity +conhost:48190c8c-42c4-46af-8d1a-0cd5db894797 OR cool-site +languageId:1 AND 2 +deleted:false +working:true +variant:default +title:Snowboard -summary:'Swiss Alps' +authors:'John Doe' NOT 'Jane Doe'`
+        );
+    });
+});

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

@@ -1,4 +1,6 @@
 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
@@ -27,8 +29,9 @@ import { Equals, Field } from './lucene-syntax/index';
  * @export
  * @class QueryBuilder
  */
-export declare class QueryBuilder {
-    #private;
+export class QueryBuilder {
+    #query = '';
+
     /**
      * This method appends to the query a field that should be included in the search.
      *
@@ -42,7 +45,10 @@ export declare 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;
+    field(field: string): Field {
+        return buildField(this.#query, field);
+    }
+
     /**
      * This method appends to the query a field that should be excluded from the search.
      *
@@ -56,7 +62,10 @@ export declare 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;
+    excludeField(field: string): Field {
+        return buildExcludeField(this.#query, field);
+    }
+
     /**
      * This method allows to pass a raw query string to the query builder.
      * This raw query should end in Equals.
@@ -72,5 +81,7 @@ export declare 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;
+    raw(query: string): Equals {
+        return buildRawEquals(this.#query, query);
+    }
 }

package/src/lib/client/content/builders/query/utils/{index.d.ts → index.ts}

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

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

@@ -1,5 +1,7 @@
 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.
@@ -49,14 +51,20 @@ import { CollectionBuilder } from './builders/collection/collection';
  * });
  * ```
  */
-export declare class Content {
-    #private;
+export class Content {
+    #requestOptions: RequestOptions;
+    #serverUrl: string;
+
     /**
      * 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);
+    constructor(requestOptions: RequestOptions, 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.
@@ -122,5 +130,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,6 +1,8 @@
 import { Contentlet } from '@dotcms/types';
+
 import { Equals } from '../builders/query/lucene-syntax';
 import { QueryBuilder } from '../builders/query/query';
+
 /**
  * Model to sort by fields.
  */
@@ -14,6 +16,7 @@ export type SortBy = {
      */
     order: 'asc' | 'desc';
 };
+
 /**
  * Callback to build a query.
  *
@@ -22,6 +25,7 @@ export type SortBy = {
  * @returns {Equals} The built query.
  */
 export type BuildQuery = (qb: QueryBuilder) => Equals;
+
 /**
  * Callback for a fulfilled promise.
  *
@@ -30,7 +34,13 @@ 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.
  *
@@ -38,7 +48,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.
  *
@@ -66,6 +80,7 @@ export interface GetCollectionResponse<T> {
      */
     sortedBy?: SortBy[];
 }
+
 /**
  * Raw response of the get collection method.
  *
@@ -85,6 +100,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/navigation/navigation-api.spec.ts

@@ -0,0 +1,167 @@
+import { DotCMSClientConfig, RequestOptions } from '@dotcms/types';
+
+import { NavigationClient } from './navigation-api';
+
+describe('NavigationClient', () => {
+    const mockFetch = jest.fn();
+    const originalFetch = global.fetch;
+
+    const validConfig: DotCMSClientConfig = {
+        dotcmsUrl: 'https://demo.dotcms.com',
+        authToken: 'test-token',
+        siteId: 'test-site'
+    };
+
+    const requestOptions: RequestOptions = {
+        headers: {
+            Authorization: 'Bearer test-token'
+        }
+    };
+
+    const mockNavigationData = {
+        entity: {
+            title: 'Main Navigation',
+            items: [
+                { label: 'Home', url: '/' },
+                { label: 'About', url: '/about' },
+                { label: 'Contact', url: '/contact' }
+            ]
+        }
+    };
+
+    beforeEach(() => {
+        mockFetch.mockReset();
+        global.fetch = mockFetch;
+        mockFetch.mockResolvedValue({
+            ok: true,
+            json: async () => mockNavigationData
+        });
+    });
+
+    afterAll(() => {
+        global.fetch = originalFetch;
+    });
+
+    it('should fetch navigation successfully', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+        const result = await navClient.get('/');
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/',
+            requestOptions
+        );
+
+        expect(result).toEqual(mockNavigationData.entity);
+    });
+
+    it('should fetch navigation with custom path', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+        const path = '/products';
+
+        await navClient.get(path);
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/products',
+            expect.anything()
+        );
+    });
+
+    it('should fetch navigation with custom depth', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+        const depth = 3;
+
+        await navClient.get('/', { depth });
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/?depth=3',
+            expect.anything()
+        );
+    });
+
+    it('should normalize path by removing leading slash', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+
+        await navClient.get('/about/');
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/about/',
+            expect.anything()
+        );
+    });
+
+    it('should handle root path correctly', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+
+        await navClient.get('/');
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/',
+            expect.anything()
+        );
+    });
+
+    it('should handle fetch errors', async () => {
+        mockFetch.mockRejectedValue(new Error('Network error'));
+
+        const navClient = new NavigationClient(validConfig, requestOptions);
+
+        await expect(navClient.get('/')).rejects.toThrow('Network error');
+    });
+
+    it('should handle non-OK responses', async () => {
+        mockFetch.mockResolvedValue({
+            ok: false,
+            status: 404,
+            statusText: 'Not Found'
+        });
+
+        const navClient = new NavigationClient(validConfig, requestOptions);
+
+        await expect(navClient.get('/')).rejects.toThrow(
+            `Failed to fetch navigation data: Not Found - 404`
+        );
+    });
+
+    it('should include authorization headers in request', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+
+        await navClient.get('/');
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            expect.any(String),
+            expect.objectContaining({
+                headers: expect.objectContaining({
+                    Authorization: 'Bearer test-token'
+                })
+            })
+        );
+    });
+
+    it('should merge additional request options', async () => {
+        const optionsWithCache: RequestOptions = {
+            ...requestOptions,
+            cache: 'no-cache',
+            credentials: 'include'
+        };
+
+        const navClient = new NavigationClient(validConfig, optionsWithCache);
+
+        await navClient.get('/');
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/',
+            optionsWithCache
+        );
+    });
+
+    it('should fetch navigation with multiple options', async () => {
+        const navClient = new NavigationClient(validConfig, requestOptions);
+
+        await navClient.get('/', { depth: 3, languageId: 2 });
+
+        expect(mockFetch).toHaveBeenCalledWith(
+            'https://demo.dotcms.com/api/v1/nav/?depth=3&language_id=2',
+            requestOptions
+        );
+    });
+});