@dotcms/client 0.0.1-alpha.4 → 0.0.1-alpha.40

package/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "extends": ["../../../.eslintrc.base.json"],
+    "ignorePatterns": ["!**/*"],
+    "overrides": [
+        {
+            "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.ts", "*.tsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.js", "*.jsx"],
+            "rules": {}
+        }
+    ]
+}

package/README.md

@@ -26,12 +26,24 @@ yarn add @dotcms/client
 
 ## Usage
 
-First, initialize the client with your DotCMS instance details.
+`@dotcms/client` supports both ES modules and CommonJS. You can import it using either syntax:
+
+### ES Modules
+
+```javascript
+import { DotCmsClient } from '@dotcms/client';
+```
+
+### CommonJS
 
 ```javascript
-import { dotcmsClient } from '@dotcms/client';
+const { DotCmsClient } = require('@dotcms/client');
+```
 
-const client = dotcmsClient.init({
+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'
@@ -70,7 +82,7 @@ console.log(navData);
 
 Detailed documentation of the `@dotcms/client` methods, parameters, and types can be found below:
 
-### `dotcmsClient.init(config: ClientConfig): DotCmsClient`
+### `DotCmsClient.init(config: ClientConfig): DotCmsClient`
 
 Initializes the DotCMS client with the specified configuration.
 
@@ -105,7 +117,6 @@ Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/
 | 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/)                         |
-| Code Examples   | [Codeshare](https://dotcms.com/codeshare/)                          |
 | Forums/Listserv | [via Google Groups](https://groups.google.com/forum/#!forum/dotCMS) |
 | Twitter         | @dotCMS                                                             |
-| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |
+| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |

package/jest.config.ts

@@ -0,0 +1,15 @@
+/* eslint-disable */
+export default {
+    displayName: 'sdk-client',
+    preset: '../../../jest.preset.js',
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json'
+        }
+    },
+    transform: {
+        '^.+\\.[tj]s$': 'ts-jest'
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+    coverageDirectory: '../../../coverage/libs/sdk/client'
+};

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-alpha.4",
-  "type": "module",
+  "version": "0.0.1-alpha.40",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dotCMS/core.git#master"
   },
+  "scripts": {
+    "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
+  },
   "keywords": [
     "dotCMS",
     "CMS",
@@ -19,7 +21,5 @@
   "bugs": {
     "url": "https://github.com/dotCMS/core/issues"
   },
-  "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md",
-  "module": "./src/index.js",
-  "main": "./src/index.js"
+  "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md"
 }

package/project.json

@@ -0,0 +1,72 @@
+{
+    "name": "sdk-client",
+    "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "libs/sdk/client/src",
+    "projectType": "library",
+    "targets": {
+        "build": {
+            "executor": "@nx/rollup:rollup",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "format": ["esm", "cjs"],
+                "compiler": "tsc",
+                "generateExportsField": true,
+                "assets": [{ "input": "libs/sdk/client", "output": ".", "glob": "*.md" }],
+                "outputPath": "dist/libs/sdk/client",
+                "main": "libs/sdk/client/src/index.ts",
+                "tsConfig": "libs/sdk/client/tsconfig.lib.json"
+            }
+        },
+        "build:js": {
+            "executor": "@nx/esbuild:esbuild",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "outputPath": "../dotCMS/src/main/webapp/html/js/editor-js",
+                "outputFileName": "sdk-editor",
+                "format": ["esm"],
+                "tsConfig": "libs/sdk/client/tsconfig.lib.json",
+                "project": "libs/sdk/client/package.json",
+                "entryFile": "libs/sdk/client/src/lib/editor/sdk-editor-vtl.ts",
+                "external": ["react/jsx-runtime"],
+                "rollupConfig": "@nrwl/react/plugins/bundle-rollup",
+                "compiler": "tsc",
+                "extractCss": false,
+                "minify": true
+            }
+        },
+        "publish": {
+            "executor": "nx:run-commands",
+            "options": {
+                "command": "node tools/scripts/publish.mjs sdk-client {args.ver} {args.tag}"
+            },
+            "dependsOn": ["build"]
+        },
+        "nx-release-publish": {
+            "options": {
+                "packageRoot": "dist/libs/sdk/client"
+            }
+        },
+        "lint": {
+            "executor": "@nx/eslint:lint",
+            "outputs": ["{options.outputFile}"],
+            "options": {
+                "lintFilePatterns": ["libs/sdk/client/**/*.ts"]
+            }
+        },
+        "test": {
+            "executor": "@nrwl/jest:jest",
+            "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+            "options": {
+                "jestConfig": "libs/sdk/client/jest.config.ts",
+                "passWithNoTests": true
+            },
+            "configurations": {
+                "ci": {
+                    "ci": true,
+                    "codeCoverage": true
+                }
+            }
+        }
+    },
+    "tags": []
+}

package/src/index.ts

@@ -0,0 +1,30 @@
+import { ClientConfig, DotCmsClient } from './lib/client/sdk-js-client';
+import { CUSTOMER_ACTIONS, postMessageToEditor } from './lib/editor/models/client.model';
+import {
+    CustomClientParams,
+    DotCMSPageEditorConfig,
+    EditorConfig
+} from './lib/editor/models/editor.model';
+import {
+    destroyEditor,
+    initEditor,
+    isInsideEditor,
+    updateNavigation
+} from './lib/editor/sdk-editor';
+import { getPageRequestParams, graphqlToPageEntity } from './lib/utils';
+
+export {
+    graphqlToPageEntity,
+    getPageRequestParams,
+    isInsideEditor,
+    DotCmsClient,
+    DotCMSPageEditorConfig,
+    CUSTOMER_ACTIONS,
+    CustomClientParams,
+    postMessageToEditor,
+    EditorConfig,
+    initEditor,
+    updateNavigation,
+    destroyEditor,
+    ClientConfig
+};