@dotcms/uve 0.0.1-beta.0

package/README.md

@@ -0,0 +1,7 @@
+# sdk-uve
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test sdk-uve` to execute the unit tests via [Jest](https://jestjs.io).

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/public/index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,58 @@
+'use strict';
+
+var types = require('./types.cjs.js');
+
+/**
+ * Gets the current state of the Universal Visual Editor (UVE).
+ *
+ * This function checks if the code is running inside the DotCMS Universal Visual Editor
+ * and returns information about its current state, including the editor mode.
+ *
+ * @export
+ * @return {UVEState | undefined} Returns the UVE state object if running inside the editor,
+ * undefined otherwise.
+ *
+ * The state includes:
+ * - mode: The current editor mode (preview, edit, live)
+ * - languageId: The language ID of the current page setted on the UVE
+ * - persona: The persona of the current page setted on the UVE
+ * - variantName: The name of the current variant
+ * - experimentId: The ID of the current experiment
+ * - publishDate: The publish date of the current page setted on the UVE
+ *
+ * @note The absence of any of these properties means that the value is the default one.
+ *
+ * @example
+ * ```ts
+ * const editorState = getUVEState();
+ * if (editorState?.mode === 'edit') {
+ *   // Enable editing features
+ * }
+ * ```
+ */
+function getUVEState() {
+    if (typeof window === 'undefined' || window.parent === window || !window.location) {
+        return;
+    }
+    const url = new URL(window.location.href);
+    const possibleModes = Object.values(types.UVE_MODE);
+    let mode = url.searchParams.get('mode') ?? types.UVE_MODE.EDIT;
+    const languageId = url.searchParams.get('language_id');
+    const persona = url.searchParams.get('personaId');
+    const variantName = url.searchParams.get('variantName');
+    const experimentId = url.searchParams.get('experimentId');
+    const publishDate = url.searchParams.get('publishDate');
+    if (!possibleModes.includes(mode)) {
+        mode = types.UVE_MODE.EDIT;
+    }
+    return {
+        mode,
+        languageId,
+        persona,
+        variantName,
+        experimentId,
+        publishDate
+    };
+}
+
+exports.getUVEState = getUVEState;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/public/index";

package/index.esm.js

@@ -0,0 +1,56 @@
+import { UVE_MODE } from './types.esm.js';
+
+/**
+ * Gets the current state of the Universal Visual Editor (UVE).
+ *
+ * This function checks if the code is running inside the DotCMS Universal Visual Editor
+ * and returns information about its current state, including the editor mode.
+ *
+ * @export
+ * @return {UVEState | undefined} Returns the UVE state object if running inside the editor,
+ * undefined otherwise.
+ *
+ * The state includes:
+ * - mode: The current editor mode (preview, edit, live)
+ * - languageId: The language ID of the current page setted on the UVE
+ * - persona: The persona of the current page setted on the UVE
+ * - variantName: The name of the current variant
+ * - experimentId: The ID of the current experiment
+ * - publishDate: The publish date of the current page setted on the UVE
+ *
+ * @note The absence of any of these properties means that the value is the default one.
+ *
+ * @example
+ * ```ts
+ * const editorState = getUVEState();
+ * if (editorState?.mode === 'edit') {
+ *   // Enable editing features
+ * }
+ * ```
+ */
+function getUVEState() {
+    if (typeof window === 'undefined' || window.parent === window || !window.location) {
+        return;
+    }
+    const url = new URL(window.location.href);
+    const possibleModes = Object.values(UVE_MODE);
+    let mode = url.searchParams.get('mode') ?? UVE_MODE.EDIT;
+    const languageId = url.searchParams.get('language_id');
+    const persona = url.searchParams.get('personaId');
+    const variantName = url.searchParams.get('variantName');
+    const experimentId = url.searchParams.get('experimentId');
+    const publishDate = url.searchParams.get('publishDate');
+    if (!possibleModes.includes(mode)) {
+        mode = UVE_MODE.EDIT;
+    }
+    return {
+        mode,
+        languageId,
+        persona,
+        variantName,
+        experimentId,
+        publishDate
+    };
+}
+
+export { getUVEState };

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@dotcms/uve",
+  "version": "0.0.1-beta.0",
+  "description": "Official JavaScript library for interacting with Universal Visual Editor (UVE)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dotCMS/core.git#main"
+  },
+  "keywords": [
+    "dotCMS",
+    "CMS",
+    "Content Management",
+    "UVE",
+    "Universal Visual Editor"
+  ],
+  "author": "dotcms <dev@dotcms.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dotCMS/core/issues"
+  },
+  "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/client/README.md",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.esm.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    },
+    "./types": {
+      "module": "./types.esm.js",
+      "types": "./types.esm.d.ts",
+      "import": "./types.cjs.mjs",
+      "default": "./types.cjs.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.esm.d.ts"
+}

package/src/lib/types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Represents the state of the Universal Visual Editor (UVE)
+ * @interface
+ * @property {UVE_MODE} mode - The current mode of operation for UVE (EDIT, PREVIEW, LIVE, or UNKNOWN)
+ * @property {string | null} persona - The selected persona for content personalization
+ * @property {string | null} variantName - The name of the current content variant
+ * @property {string | null} experimentId - The identifier for the current A/B testing experiment
+ * @property {string | null} publishDate - The scheduled publish date for content
+ * @property {string | null} languageId - The identifier for the current language selection
+ */
+export interface UVEState {
+    mode: UVE_MODE;
+    persona: string | null;
+    variantName: string | null;
+    experimentId: string | null;
+    publishDate: string | null;
+    languageId: string | null;
+}
+/**
+ * Possible modes of UVE (Universal Visual Editor)
+ * @enum {string}
+ *
+ * @property {string} LIVE - Shows published and future content
+ * @property {string} PREVIEW - Shows published and working content
+ * @property {string} EDIT - Enables content editing functionality in UVE
+ * @property {string} UNKNOWN - Error state, UVE should not remain in this mode
+ */
+export declare enum UVE_MODE {
+    EDIT = "EDIT_MODE",
+    PREVIEW = "PREVIEW_MODE",
+    LIVE = "LIVE",
+    UNKNOWN = "UNKNOWN"
+}

package/src/lib/utils.d.ts

@@ -0,0 +1,30 @@
+import { UVEState } from './types';
+/**
+ * Gets the current state of the Universal Visual Editor (UVE).
+ *
+ * This function checks if the code is running inside the DotCMS Universal Visual Editor
+ * and returns information about its current state, including the editor mode.
+ *
+ * @export
+ * @return {UVEState | undefined} Returns the UVE state object if running inside the editor,
+ * undefined otherwise.
+ *
+ * The state includes:
+ * - mode: The current editor mode (preview, edit, live)
+ * - languageId: The language ID of the current page setted on the UVE
+ * - persona: The persona of the current page setted on the UVE
+ * - variantName: The name of the current variant
+ * - experimentId: The ID of the current experiment
+ * - publishDate: The publish date of the current page setted on the UVE
+ *
+ * @note The absence of any of these properties means that the value is the default one.
+ *
+ * @example
+ * ```ts
+ * const editorState = getUVEState();
+ * if (editorState?.mode === 'edit') {
+ *   // Enable editing features
+ * }
+ * ```
+ */
+export declare function getUVEState(): UVEState | undefined;

package/src/public/index.d.ts

@@ -0,0 +1,2 @@
+import { getUVEState } from '../lib/utils';
+export { getUVEState };

package/src/public/types.d.ts

@@ -0,0 +1,2 @@
+import { UVE_MODE, UVEState } from '../lib/types';
+export { UVE_MODE, UVEState };

package/types.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/public/types";

package/types.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./types.cjs.js').default;

package/types.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+/**
+ * Possible modes of UVE (Universal Visual Editor)
+ * @enum {string}
+ *
+ * @property {string} LIVE - Shows published and future content
+ * @property {string} PREVIEW - Shows published and working content
+ * @property {string} EDIT - Enables content editing functionality in UVE
+ * @property {string} UNKNOWN - Error state, UVE should not remain in this mode
+ */
+exports.UVE_MODE = void 0;
+(function (UVE_MODE) {
+    UVE_MODE["EDIT"] = "EDIT_MODE";
+    UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
+    UVE_MODE["LIVE"] = "LIVE";
+    UVE_MODE["UNKNOWN"] = "UNKNOWN";
+})(exports.UVE_MODE || (exports.UVE_MODE = {}));

package/types.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './types.cjs.js';
+export { _default as default } from './types.cjs.default.js';

package/types.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/public/types";

package/types.esm.js

@@ -0,0 +1,18 @@
+/**
+ * Possible modes of UVE (Universal Visual Editor)
+ * @enum {string}
+ *
+ * @property {string} LIVE - Shows published and future content
+ * @property {string} PREVIEW - Shows published and working content
+ * @property {string} EDIT - Enables content editing functionality in UVE
+ * @property {string} UNKNOWN - Error state, UVE should not remain in this mode
+ */
+var UVE_MODE;
+(function (UVE_MODE) {
+    UVE_MODE["EDIT"] = "EDIT_MODE";
+    UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
+    UVE_MODE["LIVE"] = "LIVE";
+    UVE_MODE["UNKNOWN"] = "UNKNOWN";
+})(UVE_MODE || (UVE_MODE = {}));
+
+export { UVE_MODE };