@dotcms/client 0.0.1-alpha.34 → 0.0.1-alpha.36

package/README.md

@@ -1,48 +1,122 @@
-# DotCMS Frontend
+# @dotcms/client
 
-This folder contains the frontend infrastructure for the DotCMS admin system, includes the main app and all the internal libraries.
+`@dotcms/client` is the official dotCMS JavaScript library designed to simplify interactions with the DotCMS REST APIs.
 
-## Content
+This client library provides a streamlined, promise-based interface to fetch pages and navigation API.
 
-| Name                                                                                               | Type | Location                     | Build with | Description                                                 |
-| -------------------------------------------------------------------------------------------------- | ---- | ---------------------------- | ---------- | ----------------------------------------------------------- |
-| [dotcms-ui](https://github.com/dotCMS/core-web/tree/master/apps/dotcms-ui)                         | app  | `apps/dotcms-ui`             | Angular    | Main UI application                                         |
-| [dotcdn](https://github.com/dotCMS/core-web/tree/master/apps/dotcdn)                               | app  | `apps/dotcdn`                | Angular    | App for the dotCDN plugin                                   |
-| [dotcms-block-editor](https://github.com/dotCMS/core-web/tree/master/apps/dotcms-block-editor)     | app  | `apps/dotcms-block-editor`   | Angular    | App to build de block-editor as a Web Component             |
-| [dotcms](https://github.com/dotCMS/core-web/tree/master/libs/dotcms)                               | lib  | `libs/dotcms`                | Typescript | JavaScript SDK for DotCMS API's                             |
-| [dot-layout-grid](https://github.com/dotCMS/core-web/tree/master/libs/dot-layout-grid)             | lib  | `libs/dot-layout-grid`       | Angular    | Components for layout editor                                |
-| [block-editor](https://github.com/dotCMS/core-web/tree/master/libs/block-editor)                   | lib  | `libs/block-editor`          | TitTap     | Block editor components                                     |
-| [dot-rules](https://github.com/dotCMS/core-web/tree/master/libs/dot-rules)                         | lib  | `libs/dot-rules`             | Angular    | Components and services for rules                           |
-| [dotcms-field-elements](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-field-elements) | lib  | `libs/dotcms-field-elements` | Stenciljs  | Web components for form builder (deprecated)                |
-| [dotcms-js](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-js)                         | lib  | `libs/dotcms-js`             | Angular    | Angular @injectables for DotCMS API                         |
-| [dotcms-models](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-models)                 | lib  | `libs/dotcms-models`         | Typescript | DotCMS interfaces and types                                 |
-| [dotcms-scss](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-scss)                     | lib  | `libs/dotcms-scss`           | SCSS       | SCSS shared files for theme Angular PrimeNG and Dijit Theme |
+## Features
 
-## dotCMS core-web Monorepo
+-   Easy-to-use methods to interact with the [DotCMS Page](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and [Navigation APIs](https://www.dotcms.com/docs/latest/navigation-rest-api).
+-   Support for custom actions to communicate with the DotCMS page editor.
+-   Comprehensive TypeScript typings for better development experience.
 
-This monorepo, powered by [Nx](https://nx.dev), contains everything related to the frontend development for dotCMS.
+## Installation
 
-### Installing Dependencies
+Install the package via npm:
 
-Run `yarn install` to install all project dependencies.
+```bash
+npm install @dotcms/client
+```
 
-### Development Server
+Or using Yarn:
 
-To start the development server, run `nx serve dotcms-ui`. Visit [http://localhost:4200/](http://localhost:4200/). The app will automatically reload if you make any changes to the source files. We have set up a proxy to the backend server (on port 8080), allowing you to run both the backend server (by building the master branch or using Docker) and the frontend server simultaneously.
+```bash
+yarn add @dotcms/client
+```
 
-### Building the Project
+## Usage
 
-We have three main applications to build:
-- **dotcms-ui**: Run `nx build dotcms-ui`.
-- **dotcms-block-editor**: Run `nx build dotcms-block-editor`.
-- **dotcms-binary-field-builder**: Run `nx build dotcms-binary-field-builder`.
+`@dotcms/client` supports both ES modules and CommonJS. You can import it using either syntax:
 
-### Running Unit Tests
+### ES Modules
 
-To run all unit tests for projects currently testable, use `yarn run test:dotcms`. To test a specific app or library, run `nx test {name-of-the-app-or-lib}`.
+```javascript
+import { dotcmsClient } from '@dotcms/client';
+```
 
-Use `nx affected:test` to execute the unit tests affected by recent changes.
+### CommonJS
 
-### Understanding Your Workspace
+```javascript
+const { dotcmsClient } = require('@dotcms/client');
+```
 
-Run `nx dep-graph` to see a diagram of your projects' dependencies. This will help you better understand the structure and relationships in your monorepo.
+First, initialize the client with your DotCMS instance details.
+
+```javascript
+const client = dotcmsClient.init({
+    dotcmsUrl: 'https://your-dotcms-instance.com',
+    authToken: 'your-auth-token',
+    siteId: 'your-site-id'
+});
+```
+
+### Fetching a Page
+
+Retrieve the elements of any page in your DotCMS system in JSON format.
+
+```javascript
+const pageData = await client.page.get({
+    path: '/your-page-path',
+    language_id: 1,
+    personaId: 'optional-persona-id'
+});
+
+console.log(pageData);
+```
+
+### Fetching Navigation
+
+Retrieve information about the DotCMS file and folder tree.
+
+```javascript
+const navData = await client.nav.get({
+    path: '/',
+    depth: 2,
+    languageId: 1
+});
+
+console.log(navData);
+```
+
+## API Reference
+
+Detailed documentation of the `@dotcms/client` methods, parameters, and types can be found below:
+
+### `dotcmsClient.init(config: ClientConfig): DotCmsClient`
+
+Initializes the DotCMS client with the specified configuration.
+
+### `DotCmsClient.page.get(options: PageApiOptions): Promise<unknown>`
+
+Retrieves the specified page's elements from your DotCMS system in JSON format.
+
+### `DotCmsClient.nav.get(options: NavApiOptions): Promise<unknown>`
+
+Retrieves information about the DotCMS file and folder tree.
+
+## Contributing
+
+GitHub pull requests are the preferred method to contribute code to dotCMS. Before any pull requests can be accepted, an automated tool will ask you to agree to the [dotCMS Contributor's Agreement](https://gist.github.com/wezell/85ef45298c48494b90d92755b583acb3).
+
+## Licensing
+
+dotCMS comes in multiple editions and as such is dual licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds a number of enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see [the feature page](http://dotcms.com/cms-platform/features).
+
+## Support
+
+If you need help or have any questions, please [open an issue](https://github.com/dotCMS/core/issues/new/choose) in the GitHub repository.
+
+## Documentation
+
+Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/latest/) for comprehensive guides and API references.
+
+## Getting Help
+
+| Source          | Location                                                            |
+| --------------- | ------------------------------------------------------------------- |
+| Installation    | [Installation](https://dotcms.com/docs/latest/installation)         |
+| Documentation   | [Documentation](https://dotcms.com/docs/latest/table-of-contents)   |
+| Videos          | [Helpful Videos](http://dotcms.com/videos/)                         |
+| Forums/Listserv | [via Google Groups](https://groups.google.com/forum/#!forum/dotCMS) |
+| Twitter         | @dotCMS                                                             |
+| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |

package/index.cjs.js

@@ -1459,19 +1459,20 @@ const parseContentletsToUuidMap = (containerContentlets) => {
 };
 
 const getPageRequestParams = ({ path = '', params = {} }) => {
+    const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
     const finalParams = {};
-    const dotMarketingPersonaId = params['com.dotmarketing.persona.id'] || '';
-    if (params['mode']) {
-        finalParams['mode'] = params['mode'];
+    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
+    if (copiedParams['mode']) {
+        finalParams['mode'] = copiedParams['mode'];
     }
-    if (params['language_id']) {
-        finalParams['language_id'] = params['language_id'];
+    if (copiedParams['language_id']) {
+        finalParams['language_id'] = copiedParams['language_id'];
     }
-    if (params['variantName']) {
-        finalParams['variantName'] = params['variantName'];
+    if (copiedParams['variantName']) {
+        finalParams['variantName'] = copiedParams['variantName'];
     }
-    if (params['personaId'] || dotMarketingPersonaId) {
-        finalParams['personaId'] = params['personaId'] || dotMarketingPersonaId;
+    if (copiedParams['personaId'] || dotMarketingPersonaId) {
+        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
     }
     return {
         path,

package/index.esm.js

@@ -1457,19 +1457,20 @@ const parseContentletsToUuidMap = (containerContentlets) => {
 };
 
 const getPageRequestParams = ({ path = '', params = {} }) => {
+    const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
     const finalParams = {};
-    const dotMarketingPersonaId = params['com.dotmarketing.persona.id'] || '';
-    if (params['mode']) {
-        finalParams['mode'] = params['mode'];
+    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
+    if (copiedParams['mode']) {
+        finalParams['mode'] = copiedParams['mode'];
     }
-    if (params['language_id']) {
-        finalParams['language_id'] = params['language_id'];
+    if (copiedParams['language_id']) {
+        finalParams['language_id'] = copiedParams['language_id'];
     }
-    if (params['variantName']) {
-        finalParams['variantName'] = params['variantName'];
+    if (copiedParams['variantName']) {
+        finalParams['variantName'] = copiedParams['variantName'];
     }
-    if (params['personaId'] || dotMarketingPersonaId) {
-        finalParams['personaId'] = params['personaId'] || dotMarketingPersonaId;
+    if (copiedParams['personaId'] || dotMarketingPersonaId) {
+        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
     }
     return {
         path,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-alpha.34",
+  "version": "0.0.1-alpha.36",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",

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

@@ -2,9 +2,10 @@ interface PageRequestParamsProps {
     path: string;
     params: {
         [key: string]: any;
-    } | undefined;
+    } | undefined | URLSearchParams;
 }
 export declare const getPageRequestParams: ({ path, params }: PageRequestParamsProps) => {
     path: string;
+    [key: string]: string | number;
 };
 export {};