@dotcms/client 0.0.1-alpha.1 → 0.0.1-alpha.11

package/src/lib/sdk-js-client.d.ts

@@ -1,171 +0,0 @@
-export interface ClientConfig {
-    /**
-     * The URL of the dotCMS instance.
-     *
-     * @description This is the URL of the dotCMS instance you want to interact with. Ensure to include the protocol (http or https).
-     * @example `https://demo.dotcms.com`
-     * @type {string}
-     * @required
-     */
-    dotcmsUrl: string;
-    /**
-     * The id of the site you want to interact with.
-     *
-     * @description to get the site id, go to the site you want to interact with and copy the id from the History tab
-     *
-     * @type {string}
-     * @required
-     */
-    siteId?: string;
-    /**
-     * The authentication token to use for the requests. If not provided, it will fallback to default site.
-     *
-     * @description you can get the auth token from our UI {@link https://www.dotcms.com/docs/latest/rest-api-authentication#creating-an-api-token-in-the-ui}
-     *
-     * @type {string}
-     * @required
-     */
-    authToken: string;
-}
-type PageApiOptions = {
-    /**
-     * The path of the page you want to retrieve.
-     *
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The id of the site you want to interact with. If not provided, the one from the config will be used.
-     *
-     * @type {number}
-     */
-    siteId?: string;
-    /**
-     * The language id of the page you want to retrieve. If not provided will use the default language of the site.
-     *
-     * @type {number}
-     */
-    language_id?: number;
-    /**
-     * The id of the persona you want to retrieve the page for.
-     *
-     * @type {string}
-     */
-    personaId?: string;
-    /**
-     * If you want to fire the rules set on the page
-     *
-     * @type {boolean}
-     */
-    fireRules?: boolean;
-    /**
-     * Allows access to related content via the Relationship fields of contentlets on a Page; 0 (default)
-     *
-     * @type {number}
-     */
-    depth?: number;
-};
-type NavApiOptions = {
-    /**
-     * The root path to begin traversing the folder tree.
-     *
-     * @example
-     * `/api/v1/nav/` starts from the root of the site
-     * @example
-     * `/about-us` starts from the "About Us" folder
-     *
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The depth of the folder tree to return.
-     * @example
-     * `1` returns only the element specified in the path.
-     * @example
-     * `2` returns the element specified in the path, and if that element is a folder, returns all direct children of that folder.
-     * @example
-     * `3` returns all children and grandchildren of the element specified in the path.
-     *
-     * @type {number}
-     */
-    depth?: number;
-    /**
-     * The language ID of content to return.
-     * @example
-     * `1` (or unspecified) returns content in the default language of the site.
-     *
-     * @link https://www.dotcms.com/docs/latest/system-language-properties#DefaultLanguage
-     * @link https://www.dotcms.com/docs/latest/adding-and-editing-languages#LanguageID
-     * @type {number}
-     */
-    languageId?: number;
-};
-/**
- * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
- * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
- *
- * @class DotCmsClient
- *
- * @property {ClientConfig} config - The configuration object for the DotCMS client.
- *
- * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
- *
- * @method getPage(options: PageApiOptions): Promise<unknown> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
- *
- * @method getNav(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
- *
- */
-export declare class DotCmsClient {
-    private config;
-    constructor(config: ClientConfig);
-    /**
-     * `getPage` is an asynchronous method of the `DotCmsClient` class that retrieves all the elements of any Page in your dotCMS system in JSON format.
-     * It takes a `PageApiOptions` object as a parameter and returns a Promise that resolves to the response from the DotCMS API.
-     *
-     * The Page API enables you to retrieve all the elements of any Page in your dotCMS system.
-     * The elements may be retrieved in JSON format.
-     *
-     * @link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas
-     * @method getPage
-     * @async
-     * @param {PageApiOptions} options - The options for the Page API call.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
-     * @throws {Error} - Throws an error if the options are not valid.
-     */
-    getPage(options: PageApiOptions): Promise<unknown>;
-    /**
-     * `getNav` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
-     * It takes a `NavApiOptions` object as a parameter (with default values) and returns a Promise that resolves to the response from the DotCMS API.
-     *
-     * The navigation REST API enables you to retrieve information about the dotCMS file and folder tree through REST API calls.
-     * @link https://www.dotcms.com/docs/latest/navigation-rest-api
-     * @method getNav
-     * @async
-     * @param {NavApiOptions} options - The options for the Nav API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
-     * @throws {Error} - Throws an error if the options are not valid.
-     */
-    getNav(options?: NavApiOptions): Promise<unknown>;
-    private validatePageOptions;
-    private validateNavOptions;
-}
-/**
- * `dotcmsClient` is an object that provides a method to initialize the DotCMS SDK client.
- * It has a single method `init` which takes a configuration object and returns an instance of the `DotCmsClient` class.
- *
- * @namespace dotcmsClient
- *
- * @method init(config: ClientConfig): DotCmsClient - Initializes the SDK client.
- */
-export declare const dotcmsClient: {
-    /**
-     * `init` is a method of the `dotcmsClient` object that initializes the SDK client.
-     * It takes a configuration object as a parameter and returns an instance of the `DotCmsClient` class.
-     *
-     * @method init
-     * @param {ClientConfig} config - The configuration object for the DotCMS client.
-     * @returns {DotCmsClient} - An instance of the {@link DotCmsClient} class.
-     */
-    init: (config: ClientConfig) => DotCmsClient;
-};
-export {};

package/src/lib/sdk-js-client.js

@@ -1,150 +0,0 @@
-import { __awaiter, __rest } from "tslib";
-function isValidUrl(url) {
-    try {
-        new URL(url);
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-/**
- * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
- * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
- *
- * @class DotCmsClient
- *
- * @property {ClientConfig} config - The configuration object for the DotCMS client.
- *
- * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
- *
- * @method getPage(options: PageApiOptions): Promise<unknown> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
- *
- * @method getNav(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
- *
- */
-export class DotCmsClient {
-    constructor(config) {
-        if (!config.dotcmsUrl) {
-            throw new Error("Invalid configuration - 'dotcmsUrl' is required");
-        }
-        if (!isValidUrl(config.dotcmsUrl)) {
-            throw new Error("Invalid configuration - 'dotcmsUrl' must be a valid URL");
-        }
-        if (!config.authToken) {
-            throw new Error("Invalid configuration - 'authToken' is required");
-        }
-        this.config = config;
-    }
-    /**
-     * `getPage` is an asynchronous method of the `DotCmsClient` class that retrieves all the elements of any Page in your dotCMS system in JSON format.
-     * It takes a `PageApiOptions` object as a parameter and returns a Promise that resolves to the response from the DotCMS API.
-     *
-     * The Page API enables you to retrieve all the elements of any Page in your dotCMS system.
-     * The elements may be retrieved in JSON format.
-     *
-     * @link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas
-     * @method getPage
-     * @async
-     * @param {PageApiOptions} options - The options for the Page API call.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
-     * @throws {Error} - Throws an error if the options are not valid.
-     */
-    getPage(options) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            this.validatePageOptions(options);
-            const queryParamsObj = {};
-            for (const [key, value] of Object.entries(options)) {
-                if (value === undefined || key === 'path' || key === 'siteId')
-                    continue;
-                if (key === 'personaId') {
-                    queryParamsObj['com.dotmarketing.persona.id'] = String(value);
-                }
-                else {
-                    queryParamsObj[key] = String(value);
-                }
-            }
-            const queryHostId = (_b = (_a = options.siteId) !== null && _a !== void 0 ? _a : this.config.siteId) !== null && _b !== void 0 ? _b : '';
-            if (queryHostId) {
-                queryParamsObj['host_id'] = queryHostId;
-            }
-            const queryParams = new URLSearchParams(queryParamsObj).toString();
-            const formattedPath = options.path.startsWith('/') ? options.path : `/${options.path}`;
-            const url = `${this.config.dotcmsUrl}/api/v1/page/json${formattedPath}${queryParams ? `?${queryParams}` : ''}`;
-            const response = yield fetch(url, {
-                headers: {
-                    Authorization: `Bearer ${this.config.authToken}`
-                }
-            });
-            return response.json();
-        });
-    }
-    /**
-     * `getNav` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
-     * It takes a `NavApiOptions` object as a parameter (with default values) and returns a Promise that resolves to the response from the DotCMS API.
-     *
-     * The navigation REST API enables you to retrieve information about the dotCMS file and folder tree through REST API calls.
-     * @link https://www.dotcms.com/docs/latest/navigation-rest-api
-     * @method getNav
-     * @async
-     * @param {NavApiOptions} options - The options for the Nav API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
-     * @throws {Error} - Throws an error if the options are not valid.
-     */
-    getNav(options = { depth: 0, path: '/', languageId: 1 }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.validateNavOptions(options);
-            // Extract the 'path' from the options and prepare the rest as query parameters
-            const { path } = options, queryParamsOptions = __rest(options, ["path"]);
-            const queryParamsObj = {};
-            Object.entries(queryParamsOptions).forEach(([key, value]) => {
-                if (value !== undefined) {
-                    queryParamsObj[key] = String(value);
-                }
-            });
-            const queryParams = new URLSearchParams(queryParamsObj).toString();
-            // Format the URL correctly depending on the 'path' value
-            const formattedPath = path === '/' ? '/' : `/${path}`;
-            const url = `${this.config.dotcmsUrl}/api/v1/nav${formattedPath}${queryParams ? `?${queryParams}` : ''}`;
-            const response = yield fetch(url, {
-                headers: {
-                    Authorization: `Bearer ${this.config.authToken}`
-                }
-            });
-            return response.json();
-        });
-    }
-    validatePageOptions(options) {
-        if (!options.path) {
-            throw new Error("The 'path' parameter is required for the Page API");
-        }
-    }
-    validateNavOptions(options) {
-        if (!options.path) {
-            throw new Error("The 'path' parameter is required for the Nav API");
-        }
-    }
-}
-/**
- * `dotcmsClient` is an object that provides a method to initialize the DotCMS SDK client.
- * It has a single method `init` which takes a configuration object and returns an instance of the `DotCmsClient` class.
- *
- * @namespace dotcmsClient
- *
- * @method init(config: ClientConfig): DotCmsClient - Initializes the SDK client.
- */
-export const dotcmsClient = {
-    /**
-     * `init` is a method of the `dotcmsClient` object that initializes the SDK client.
-     * It takes a configuration object as a parameter and returns an instance of the `DotCmsClient` class.
-     *
-     * @method init
-     * @param {ClientConfig} config - The configuration object for the DotCMS client.
-     * @returns {DotCmsClient} - An instance of the {@link DotCmsClient} class.
-     */
-    init: (config) => {
-        return new DotCmsClient(config);
-    }
-};
-//# sourceMappingURL=sdk-js-client.js.map

package/src/lib/sdk-js-client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sdk-js-client.js","sourceRoot":"","sources":["../../../../../../libs/sdk/client/src/lib/sdk-js-client.ts"],"names":[],"mappings":";AAyGA,SAAS,UAAU,CAAC,GAAW;IAC3B,IAAI;QACA,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAEb,OAAO,IAAI,CAAC;KACf;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,KAAK,CAAC;KAChB;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,YAAY;IAGrB,YAAY,MAAoB;QAC5B,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACtE;QAED,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;SAC9E;QAED,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACtE;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,OAAuB;;;YACjC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAElC,MAAM,cAAc,GAA2B,EAAE,CAAC;YAClD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBAChD,IAAI,KAAK,KAAK,SAAS,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ;oBAAE,SAAS;gBAExE,IAAI,GAAG,KAAK,WAAW,EAAE;oBACrB,cAAc,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;iBACjE;qBAAM;oBACH,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;iBACvC;aACJ;YAED,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,MAAM,mCAAI,IAAI,CAAC,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC;YAE/D,IAAI,WAAW,EAAE;gBACb,cAAc,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;aAC3C;YAED,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;YAEnE,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACvF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,oBAAoB,aAAa,GACjE,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;YAEH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC9B,OAAO,EAAE;oBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;iBACnD;aACJ,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;;KAC1B;IAED;;;;;;;;;;;OAWG;IACG,MAAM,CACR,UAAyB,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE;;YAE/D,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEjC,+EAA+E;YAC/E,MAAM,EAAE,IAAI,KAA4B,OAAO,EAA9B,kBAAkB,UAAK,OAAO,EAAzC,QAA+B,CAAU,CAAC;YAChD,MAAM,cAAc,GAA2B,EAAE,CAAC;YAClD,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACxD,IAAI,KAAK,KAAK,SAAS,EAAE;oBACrB,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;iBACvC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;YAEnE,yDAAyD;YACzD,MAAM,aAAa,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACtD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,cAAc,aAAa,GAC3D,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;YAEH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC9B,OAAO,EAAE;oBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;iBACnD;aACJ,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;KAAA;IAEO,mBAAmB,CAAC,OAAuB;QAC/C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;SACxE;IACL,CAAC;IAEO,kBAAkB,CAAC,OAAsB;QAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACvE;IACL,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB;;;;;;;OAOG;IACH,IAAI,EAAE,CAAC,MAAoB,EAAgB,EAAE;QACzC,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ,CAAC"}