@dotcms/client 0.0.1-alpha.2 → 0.0.1-alpha.21

package/src/lib/editor/models/listeners.model.js

@@ -0,0 +1,26 @@
+/**
+ * Actions received from the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+export var NOTIFY_CUSTOMER;
+(function (NOTIFY_CUSTOMER) {
+    /**
+     * Request to page to reload
+     */
+    NOTIFY_CUSTOMER["EMA_RELOAD_PAGE"] = "ema-reload-page";
+    /**
+     * Request the bounds for the elements
+     */
+    NOTIFY_CUSTOMER["EMA_REQUEST_BOUNDS"] = "ema-request-bounds";
+    /**
+     * Received pong from the editor
+     */
+    NOTIFY_CUSTOMER["EMA_EDITOR_PONG"] = "ema-editor-pong";
+    /**
+     * Received scroll event trigger from the editor
+     */
+    NOTIFY_CUSTOMER["EMA_SCROLL_INSIDE_IFRAME"] = "scroll-inside-iframe";
+})(NOTIFY_CUSTOMER || (NOTIFY_CUSTOMER = {}));
+//# sourceMappingURL=listeners.model.js.map

package/src/lib/editor/models/listeners.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listeners.model.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/models/listeners.model.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,eAkBX;AAlBD,WAAY,eAAe;IACvB;;OAEG;IACH,sDAAmC,CAAA;IACnC;;OAEG;IACH,4DAAyC,CAAA;IACzC;;OAEG;IACH,sDAAmC,CAAA;IACnC;;OAEG;IAEH,oEAAiD,CAAA;AACrD,CAAC,EAlBW,eAAe,KAAf,eAAe,QAkB1B"}

package/src/lib/editor/sdk-editor-vtl.d.ts

@@ -0,0 +1,6 @@
+declare global {
+    interface Window {
+        lastScrollYPosition: number;
+    }
+}
+export {};

package/src/lib/editor/sdk-editor-vtl.js

@@ -0,0 +1,21 @@
+import { listenEditorMessages, listenHoveredContentlet, pingEditor, preserveScrollOnIframe, scrollHandler } from './listeners/listeners';
+import { isInsideEditor, addClassToEmptyContentlets } from './sdk-editor';
+/**
+ * This is the main entry point for the SDK VTL.
+ * This is added to VTL Script in the EditPage
+ *
+ * @remarks
+ * This module sets up the necessary listeners and functionality for the SDK VTL.
+ * It checks if the script is running inside the editor and then initializes the client by pinging the editor,
+ * listening for editor messages, hovered contentlet changes, and content changes.
+ *
+ */
+if (isInsideEditor()) {
+    pingEditor();
+    listenEditorMessages();
+    scrollHandler();
+    preserveScrollOnIframe();
+    listenHoveredContentlet();
+    addClassToEmptyContentlets();
+}
+//# sourceMappingURL=sdk-editor-vtl.js.map

package/src/lib/editor/sdk-editor-vtl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk-editor-vtl.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/client/src/lib/editor/sdk-editor-vtl.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,EACV,sBAAsB,EACtB,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAQ1E;;;;;;;;;GASG;AACH,IAAI,cAAc,EAAE,EAAE,CAAC;IACnB,UAAU,EAAE,CAAC;IACb,oBAAoB,EAAE,CAAC;IACvB,aAAa,EAAE,CAAC;IAChB,sBAAsB,EAAE,CAAC;IACzB,uBAAuB,EAAE,CAAC;IAC1B,0BAA0B,EAAE,CAAC;AACjC,CAAC"}

package/src/lib/editor/sdk-editor.d.ts

@@ -0,0 +1,29 @@
+import { DotCMSPageEditorConfig } from './models/editor.model';
+/**
+ *
+ * Updates the navigation in the editor.
+ * @param {string} pathname - The pathname to update the navigation with.
+ * @memberof DotCMSPageEditor
+ */
+export declare function updateNavigation(pathname: string): void;
+/**
+ * Checks if the code is running inside an editor.
+ * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ */
+export declare function isInsideEditor(): boolean;
+/**
+ * Initializes the DotCMS page editor.
+ *
+ * @param conf - Optional configuration for the editor.
+ */
+export declare function initEditor(config?: DotCMSPageEditorConfig): void;
+/**
+ * Destroys the editor by removing event listeners and disconnecting observers.
+ */
+export declare function destroyEditor(): void;
+/**
+ * Adds a class to empty contentlets.
+ *
+ * @export
+ */
+export declare function addClassToEmptyContentlets(): void;

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

@@ -0,0 +1,68 @@
+import { listenEditorMessages, listenHoveredContentlet, pingEditor, scrollHandler, setPageEditorConfig, subscriptions } from './listeners/listeners';
+import { CUSTOMER_ACTIONS, postMessageToEditor } from './models/client.model';
+/**
+ *
+ * Updates the navigation in the editor.
+ * @param {string} pathname - The pathname to update the navigation with.
+ * @memberof DotCMSPageEditor
+ */
+export function updateNavigation(pathname) {
+    postMessageToEditor({
+        action: CUSTOMER_ACTIONS.NAVIGATION_UPDATE,
+        payload: {
+            url: pathname === '/' ? 'index' : pathname?.replace('/', '')
+        }
+    });
+}
+/**
+ * Checks if the code is running inside an editor.
+ * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ */
+export function isInsideEditor() {
+    if (typeof window === 'undefined') {
+        return false;
+    }
+    return window.parent !== window;
+}
+/**
+ * Initializes the DotCMS page editor.
+ *
+ * @param conf - Optional configuration for the editor.
+ */
+export function initEditor(config) {
+    if (config) {
+        setPageEditorConfig(config);
+    }
+    pingEditor();
+    listenEditorMessages();
+    listenHoveredContentlet();
+    scrollHandler();
+}
+/**
+ * Destroys the editor by removing event listeners and disconnecting observers.
+ */
+export function destroyEditor() {
+    subscriptions.forEach((subscription) => {
+        if (subscription.type === 'listener') {
+            window.removeEventListener(subscription.event, subscription.callback);
+        }
+        if (subscription.type === 'observer') {
+            subscription.observer.disconnect();
+        }
+    });
+}
+/**
+ * Adds a class to empty contentlets.
+ *
+ * @export
+ */
+export function addClassToEmptyContentlets() {
+    const contentlets = document.querySelectorAll('[data-dot-object="contentlet"]');
+    contentlets.forEach((contentlet) => {
+        if (contentlet.clientHeight) {
+            return;
+        }
+        contentlet.classList.add('empty-contentlet');
+    });
+}
+//# sourceMappingURL=sdk-editor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sdk-editor.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/client/src/lib/editor/sdk-editor.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,EACV,aAAa,EACb,mBAAmB,EACnB,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG9E;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC7C,mBAAmB,CAAC;QAChB,MAAM,EAAE,gBAAgB,CAAC,iBAAiB;QAC1C,OAAO,EAAE;YACL,GAAG,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;SAC/D;KACJ,CAAC,CAAC;AACP,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC1B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;AACpC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,MAA+B;IACtD,IAAI,MAAM,EAAE,CAAC;QACT,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,UAAU,EAAE,CAAC;IACb,oBAAoB,EAAE,CAAC;IACvB,uBAAuB,EAAE,CAAC;IAC1B,aAAa,EAAE,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IACzB,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;QACnC,IAAI,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACnC,MAAM,CAAC,mBAAmB,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,QAAyB,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACnC,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACvC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B;IACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAAC;IAEhF,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC/B,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;YAC1B,OAAO;QACX,CAAC;QAED,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACP,CAAC"}

package/src/lib/editor/utils/editor.utils.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Bound information for a contentlet.
+ *
+ * @interface ContentletBound
+ */
+interface ContentletBound {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    payload: string;
+}
+/**
+ * Bound information for a container.
+ *
+ * @interface ContainerBound
+ */
+interface ContainerBound {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    payload: string;
+    contentlets: ContentletBound[];
+}
+/**
+ * Calculates the bounding information for each page element within the given containers.
+ *
+ * @export
+ * @param {HTMLDivElement[]} containers
+ * @return {*} An array of objects containing the bounding information for each page element.
+ */
+export declare function getPageElementBound(containers: HTMLDivElement[]): ContainerBound[];
+/**
+ * An array of objects containing the bounding information for each contentlet inside a container.
+ *
+ * @export
+ * @param {DOMRect} containerRect
+ * @param {HTMLDivElement[]} contentlets
+ * @return {*}
+ */
+export declare function getContentletsBound(containerRect: DOMRect, contentlets: HTMLDivElement[]): ContentletBound[];
+/**
+ * Get container data from VTLS.
+ *
+ * @export
+ * @param {HTMLElement} container
+ * @return {*}
+ */
+export declare function getContainerData(container: HTMLElement): {
+    acceptTypes: string;
+    identifier: string;
+    maxContentlets: string;
+    uuid: string;
+};
+/**
+ * Get the closest container data from the contentlet.
+ *
+ * @export
+ * @param {Element} element
+ * @return {*}
+ */
+export declare function getClosestContainerData(element: Element): {
+    acceptTypes: string;
+    identifier: string;
+    maxContentlets: string;
+    uuid: string;
+} | null;
+/**
+ * Find the closest contentlet element based on HTMLElement.
+ *
+ * @export
+ * @param {(HTMLElement | null)} element
+ * @return {*}
+ */
+export declare function findDotElement(element: HTMLElement | null): HTMLElement | null;
+export declare function findDotVTLElement(element: HTMLElement | null): HTMLElement | null;
+export declare function findVTLData(target: HTMLElement): {
+    inode: string | undefined;
+    name: string | undefined;
+}[] | null;
+export declare function scrollIsInBottom(): boolean;
+export {};

package/src/lib/editor/utils/editor.utils.js

@@ -0,0 +1,134 @@
+/**
+ * Calculates the bounding information for each page element within the given containers.
+ *
+ * @export
+ * @param {HTMLDivElement[]} containers
+ * @return {*} An array of objects containing the bounding information for each page element.
+ */
+export function getPageElementBound(containers) {
+    return containers.map((container) => {
+        const containerRect = container.getBoundingClientRect();
+        const contentlets = Array.from(container.querySelectorAll('[data-dot-object="contentlet"]'));
+        return {
+            x: containerRect.x,
+            y: containerRect.y,
+            width: containerRect.width,
+            height: containerRect.height,
+            payload: JSON.stringify({
+                container: getContainerData(container)
+            }),
+            contentlets: getContentletsBound(containerRect, contentlets)
+        };
+    });
+}
+/**
+ * An array of objects containing the bounding information for each contentlet inside a container.
+ *
+ * @export
+ * @param {DOMRect} containerRect
+ * @param {HTMLDivElement[]} contentlets
+ * @return {*}
+ */
+export function getContentletsBound(containerRect, contentlets) {
+    return contentlets.map((contentlet) => {
+        const contentletRect = contentlet.getBoundingClientRect();
+        return {
+            x: 0,
+            y: contentletRect.y - containerRect.y,
+            width: contentletRect.width,
+            height: contentletRect.height,
+            payload: JSON.stringify({
+                container: contentlet.dataset?.['dotContainer']
+                    ? JSON.parse(contentlet.dataset?.['dotContainer'])
+                    : getClosestContainerData(contentlet),
+                contentlet: {
+                    identifier: contentlet.dataset?.['dotIdentifier'],
+                    title: contentlet.dataset?.['dotTitle'],
+                    inode: contentlet.dataset?.['dotInode'],
+                    contentType: contentlet.dataset?.['dotType']
+                }
+            })
+        };
+    });
+}
+/**
+ * Get container data from VTLS.
+ *
+ * @export
+ * @param {HTMLElement} container
+ * @return {*}
+ */
+export function getContainerData(container) {
+    return {
+        acceptTypes: container.dataset?.['dotAcceptTypes'] || '',
+        identifier: container.dataset?.['dotIdentifier'] || '',
+        maxContentlets: container.dataset?.['maxContentlets'] || '',
+        uuid: container.dataset?.['dotUuid'] || ''
+    };
+}
+/**
+ * Get the closest container data from the contentlet.
+ *
+ * @export
+ * @param {Element} element
+ * @return {*}
+ */
+export function getClosestContainerData(element) {
+    // Find the closest ancestor element with data-dot-object="container" attribute
+    const container = element.closest('[data-dot-object="container"]');
+    // If a container element is found
+    if (container) {
+        // Return the dataset of the container element
+        return getContainerData(container);
+    }
+    else {
+        // If no container element is found, return null
+        console.warn('No container found for the contentlet');
+        return null;
+    }
+}
+/**
+ * Find the closest contentlet element based on HTMLElement.
+ *
+ * @export
+ * @param {(HTMLElement | null)} element
+ * @return {*}
+ */
+export function findDotElement(element) {
+    if (!element)
+        return null;
+    if (element?.dataset?.['dotObject'] === 'contentlet' ||
+        (element?.dataset?.['dotObject'] === 'container' && element.children.length === 0)) {
+        return element;
+    }
+    return findDotElement(element?.['parentElement']);
+}
+export function findDotVTLElement(element) {
+    if (!element)
+        return null;
+    if (element.dataset && element.dataset?.['dotObject'] === 'vtl-file') {
+        return element;
+    }
+    else {
+        return findDotElement(element?.['parentElement']);
+    }
+}
+export function findVTLData(target) {
+    const vltElements = target.querySelectorAll('[data-dot-object="vtl-file"]');
+    if (!vltElements.length) {
+        return null;
+    }
+    return Array.from(vltElements).map((vltElement) => {
+        return {
+            inode: vltElement.dataset?.['dotInode'],
+            name: vltElement.dataset?.['dotUrl']
+        };
+    });
+}
+export function scrollIsInBottom() {
+    const documentHeight = document.documentElement.scrollHeight;
+    const viewportHeight = window.innerHeight;
+    const scrollY = window.scrollY;
+    return scrollY + viewportHeight >= documentHeight;
+}
+//# sourceMappingURL=editor.utils.js.map

package/src/lib/editor/utils/editor.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.utils.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/utils/editor.utils.ts"],"names":[],"mappings":"AA2BA;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAA4B;IAC5D,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAChC,MAAM,aAAa,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACxD,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAC1B,SAAS,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAC3C,CAAC;QAEtB,OAAO;YACH,CAAC,EAAE,aAAa,CAAC,CAAC;YAClB,CAAC,EAAE,aAAa,CAAC,CAAC;YAClB,KAAK,EAAE,aAAa,CAAC,KAAK;YAC1B,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC;aACzC,CAAC;YACF,WAAW,EAAE,mBAAmB,CAAC,aAAa,EAAE,WAAW,CAAC;SAC/D,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAC/B,aAAsB,EACtB,WAA6B;IAE7B,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,UAAU,CAAC,qBAAqB,EAAE,CAAC;QAE1D,OAAO;YACH,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC;YACrC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,cAAc,CAAC,MAAM;YAC7B,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,SAAS,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC;oBAC3C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;oBAClD,CAAC,CAAC,uBAAuB,CAAC,UAAU,CAAC;gBACzC,UAAU,EAAE;oBACR,UAAU,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC;oBACjD,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;oBACvC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;oBACvC,WAAW,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC;iBAC/C;aACJ,CAAC;SACL,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAsB;IACnD,OAAO;QACH,WAAW,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE;QACxD,UAAU,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE;QACtD,cAAc,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE;QAC3D,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE;KAC7C,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAgB;IACpD,+EAA+E;IAC/E,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,+BAA+B,CAAgB,CAAC;IAElF,kCAAkC;IAClC,IAAI,SAAS,EAAE,CAAC;QACZ,8CAA8C;QAC9C,OAAO,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACJ,gDAAgD;QAChD,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,OAA2B;IACtD,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAE1B,IACI,OAAO,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,YAAY;QAChD,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,EACpF,CAAC;QACC,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAA2B;IACzD,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAE1B,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,UAAU,EAAE,CAAC;QACnE,OAAO,OAAO,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IACtD,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAmB;IAC3C,MAAM,WAAW,GAAG,MAAM,CAAC,gBAAgB,CACvC,8BAA8B,CACN,CAAC;IAE7B,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAC9C,OAAO;YACH,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;YACvC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC;SACvC,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC5B,MAAM,cAAc,GAAG,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC;IAC7D,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC;IAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAE/B,OAAO,OAAO,GAAG,cAAc,IAAI,cAAc,CAAC;AACtD,CAAC"}

package/src/lib/query-builder/lucene-syntax/Equals.d.ts

@@ -0,0 +1,83 @@
+import { Field } from './Field';
+import { NotOperand } from './NotOperand';
+import { Operand } from './Operand';
+/**
+ * 'Equal' Is a Typescript class that provides the ability to use terms in the lucene query string.
+ * A term is a value used to search for a specific value in a document. It can be a word or a phrase.
+ *
+ * Ex: myValue or "My Value"
+ *
+ * @export
+ * @class Equal
+ */
+export declare class Equals {
+    #private;
+    private query;
+    constructor(query: string);
+    /**
+     * This method appends to the query a term that should be excluded in the search.
+     *
+     * Ex: "-myValue"
+     *
+     * @param {string} field - The field that should be excluded in the search.
+     * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
+     * @memberof Equal
+     */
+    excludeField(field: string): Field;
+    /**
+     * This method appends to the query a field that should be included in the search.
+     *
+     * Ex: "+myField:"
+     *
+     * @param {string} field - The field that should be included in the search.
+     * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
+     * @memberof Equal
+     */
+    field(field: string): Field;
+    /**
+     * This method appends to the query an operand to use logic operators in the query.
+     *
+     * Ex: "OR"
+     *
+     * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
+     * @memberof Equal
+     */
+    or(): Operand;
+    /**
+     * This method appends to the query an operand to use logic operators in the query.
+     *
+     * Ex: "AND"
+     *
+     * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
+     * @memberof Equal
+     */
+    and(): Operand;
+    /**
+     * This method appends to the query an operand to use logic operators in the query.
+     *
+     * Ex: "NOT"
+     *
+     * @return {*}  {NotOperand} - An instance of a Lucene Not Operand. A not operand is a logical operator used to exclude terms or phrases in a query.
+     * @memberof Equal
+     */
+    not(): NotOperand;
+    /**
+     * This method allows to pass a raw query string to the query builder.
+     * This raw query should end in a Lucene Equal.
+     * This method is useful when you want to append a complex query or an already written query to the query builder.
+     *
+     * Ex: "+myField: value AND (someOtherValue OR anotherValue)"
+     *
+     * @param {string} query - A raw query string.
+     * @return {*}  {Equal} - An instance of a Lucene Equal. A term is a value used to search for a specific value in a document.
+     * @memberof QueryBuilder
+     */
+    raw(query: string): Equals;
+    /**
+     * This method returns the final query string.
+     *
+     * @return {*}  {string} - The final query string.
+     * @memberof Equal
+     */
+    build(): string;
+}

package/src/lib/query-builder/lucene-syntax/Equals.js

@@ -0,0 +1,101 @@
+var _Equals_query;
+import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
+import { OPERAND, buildExcludeField, buildField, buildNotOperand, buildOperand, buildRawEquals, sanitizeQuery } from '../utils';
+/**
+ * 'Equal' Is a Typescript class that provides the ability to use terms in the lucene query string.
+ * A term is a value used to search for a specific value in a document. It can be a word or a phrase.
+ *
+ * Ex: myValue or "My Value"
+ *
+ * @export
+ * @class Equal
+ */
+export class Equals {
+    constructor(query) {
+        this.query = query;
+        _Equals_query.set(this, '');
+        __classPrivateFieldSet(this, _Equals_query, this.query, "f");
+    }
+    /**
+     * This method appends to the query a term that should be excluded in the search.
+     *
+     * Ex: "-myValue"
+     *
+     * @param {string} field - The field that should be excluded in the search.
+     * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
+     * @memberof Equal
+     */
+    excludeField(field) {
+        return buildExcludeField(__classPrivateFieldGet(this, _Equals_query, "f"), field);
+    }
+    /**
+     * This method appends to the query a field that should be included in the search.
+     *
+     * Ex: "+myField:"
+     *
+     * @param {string} field - The field that should be included in the search.
+     * @return {*}  {Field} - An instance of a Lucene Field. A field is a key used to search for a specific value in a document.
+     * @memberof Equal
+     */
+    field(field) {
+        return buildField(__classPrivateFieldGet(this, _Equals_query, "f"), field);
+    }
+    /**
+     * This method appends to the query an operand to use logic operators in the query.
+     *
+     * Ex: "OR"
+     *
+     * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
+     * @memberof Equal
+     */
+    or() {
+        return buildOperand(__classPrivateFieldGet(this, _Equals_query, "f"), OPERAND.OR);
+    }
+    /**
+     * This method appends to the query an operand to use logic operators in the query.
+     *
+     * Ex: "AND"
+     *
+     * @return {*}  {Operand} - An instance of a Lucene Operand. An operand is a logical operator used to combine terms or phrases in a query.
+     * @memberof Equal
+     */
+    and() {
+        return buildOperand(__classPrivateFieldGet(this, _Equals_query, "f"), OPERAND.AND);
+    }
+    /**
+     * This method appends to the query an operand to use logic operators in the query.
+     *
+     * Ex: "NOT"
+     *
+     * @return {*}  {NotOperand} - An instance of a Lucene Not Operand. A not operand is a logical operator used to exclude terms or phrases in a query.
+     * @memberof Equal
+     */
+    not() {
+        return buildNotOperand(__classPrivateFieldGet(this, _Equals_query, "f"));
+    }
+    /**
+     * This method allows to pass a raw query string to the query builder.
+     * This raw query should end in a Lucene Equal.
+     * This method is useful when you want to append a complex query or an already written query to the query builder.
+     *
+     * Ex: "+myField: value AND (someOtherValue OR anotherValue)"
+     *
+     * @param {string} query - A raw query string.
+     * @return {*}  {Equal} - An instance of a Lucene Equal. A term is a value used to search for a specific value in a document.
+     * @memberof QueryBuilder
+     */
+    raw(query) {
+        return buildRawEquals(__classPrivateFieldGet(this, _Equals_query, "f"), query);
+    }
+    /**
+     * This method returns the final query string.
+     *
+     * @return {*}  {string} - The final query string.
+     * @memberof Equal
+     */
+    build() {
+        return sanitizeQuery(__classPrivateFieldGet(this, _Equals_query, "f"));
+    }
+}
+_Equals_query = new WeakMap();
+//# sourceMappingURL=Equals.js.map

package/src/lib/query-builder/lucene-syntax/Equals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Equals.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/query-builder/lucene-syntax/Equals.ts"],"names":[],"mappings":";;AAIA,OAAO,EACH,OAAO,EACP,iBAAiB,EACjB,UAAU,EACV,eAAe,EACf,YAAY,EACZ,cAAc,EACd,aAAa,EAChB,MAAM,UAAU,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,OAAO,MAAM;IAGf,YAAoB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;QAFjC,wBAAS,EAAE,EAAC;QAGR,uBAAA,IAAI,iBAAU,IAAI,CAAC,KAAK,MAAA,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,KAAa;QACtB,OAAO,iBAAiB,CAAC,uBAAA,IAAI,qBAAO,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAa;QACf,OAAO,UAAU,CAAC,uBAAA,IAAI,qBAAO,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACH,EAAE;QACE,OAAO,YAAY,CAAC,uBAAA,IAAI,qBAAO,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,GAAG;QACC,OAAO,YAAY,CAAC,uBAAA,IAAI,qBAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,GAAG;QACC,OAAO,eAAe,CAAC,uBAAA,IAAI,qBAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAa;QACb,OAAO,cAAc,CAAC,uBAAA,IAAI,qBAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACD,OAAO,aAAa,CAAC,uBAAA,IAAI,qBAAO,CAAC,CAAC;IACtC,CAAC;CACJ"}

package/src/lib/query-builder/lucene-syntax/Field.d.ts

@@ -0,0 +1,23 @@
+import { Equals } from './Equals';
+/**
+ * 'Field' class is used to build a query with a field.
+ * A Lucene Field is a key used to search for a specific value in a document.
+ *
+ * @export
+ * @class Field
+ */
+export declare class Field {
+    #private;
+    private query;
+    constructor(query: string);
+    /**
+     * This method appends to the query a term that should be included in the search..
+     *
+     * Ex: myValue or "My value"
+     *
+     * @param {string} term - The term that should be included in the search.
+     * @return {*}  {Equals} - An instance of Equals.
+     * @memberof Field
+     */
+    equals(term: string): Equals;
+}

package/src/lib/query-builder/lucene-syntax/Field.js

@@ -0,0 +1,31 @@
+var _Field_query;
+import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
+import { buildEquals } from '../utils';
+/**
+ * 'Field' class is used to build a query with a field.
+ * A Lucene Field is a key used to search for a specific value in a document.
+ *
+ * @export
+ * @class Field
+ */
+export class Field {
+    constructor(query) {
+        this.query = query;
+        _Field_query.set(this, '');
+        __classPrivateFieldSet(this, _Field_query, this.query, "f");
+    }
+    /**
+     * This method appends to the query a term that should be included in the search..
+     *
+     * Ex: myValue or "My value"
+     *
+     * @param {string} term - The term that should be included in the search.
+     * @return {*}  {Equals} - An instance of Equals.
+     * @memberof Field
+     */
+    equals(term) {
+        return buildEquals(__classPrivateFieldGet(this, _Field_query, "f"), term);
+    }
+}
+_Field_query = new WeakMap();
+//# sourceMappingURL=Field.js.map

package/src/lib/query-builder/lucene-syntax/Field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Field.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/query-builder/lucene-syntax/Field.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,OAAO,KAAK;IAEd,YAAoB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;QADjC,uBAAS,EAAE,EAAC;QAER,uBAAA,IAAI,gBAAU,IAAI,CAAC,KAAK,MAAA,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAY;QACf,OAAO,WAAW,CAAC,uBAAA,IAAI,oBAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;CACJ"}

package/src/lib/query-builder/lucene-syntax/NotOperand.d.ts

@@ -0,0 +1,22 @@
+import { Equals } from './Equals';
+/**
+ * 'NotOperand' Is a Typescript class that provides the ability to use the NOT operand in the lucene query string.
+ *
+ * @export
+ * @class NotOperand
+ */
+export declare class NotOperand {
+    #private;
+    private query;
+    constructor(query: string);
+    /**
+     * This method appends to the query a term that should be included in the search.
+     *
+     * Ex: myValue or "My value"
+     *
+     * @param {string} term - The term that should be included in the search.
+     * @return {*}  {Equals} - An instance of Equals.
+     * @memberof NotOperand
+     */
+    equals(term: string): Equals;
+}