@dotcms/experiments 1.4.0-next.2 → 1.4.0-next.3

package/src/lib/shared/parser/parser.d.ts

@@ -1,54 +0,0 @@
-import { Experiment, ExperimentParsed, FetchExperiments } from '../models';
-/**
- * This arrow function parses a given set of assigned experiments for analytics.
- *
- * This process involves iterating over the experiments, which are currently in the "Running" state as received from the DotCMS endpoint,
- * analyzing each experiment's relevant data such as running ID, variant name, and look back window value.
- * It also performs regular expression verification for both 'isExperimentPage' and 'isTargetPage' against the current URL.
- *
- * The parsed data is useful for tracking and understanding the user's interaction with the experiment-targeted components during their visit.
- *
- * Contains an object with experiments information.
- *
- * @param experiments
- * @param {Location} location - This parameter is the object representing the current location (URL) of the user.
- * Mostly employed for matching the regular expressions to detect whether the current page is an 'ExperimentPage' or a 'TargetPage'.
- *
- * @returns {ExperimentParsed} - The function returns an object with the original URL and an array of each experiment's comprehensive detail.
- * The return object is suitable for further analytical operations. Each experiment's detail includes the experiment ID, running ID, variant name,
- * look back window value, and booleans that represent whether current URL is 'isExperimentPage' or 'isTargetPage' for the respective experiment.
- */
-export declare const parseDataForAnalytics: (experiments: Experiment[], location: Location) => ExperimentParsed;
-/**
- * This utility function performs regular expression (regex) matching on a supplied URL.
- *
- * @param {string | null} regexToCheck - The regular expression to match against the URL.
- * @param {string} href - This is the target URL, which is aimed to be matched against the provided regular expression.
- * @returns {boolean} -The function returns a Boolean value.
- */
-export declare const verifyRegex: (regexToCheck: string | null, href: string) => boolean;
-/**
- * This function merges newly fetched data with the data stored from IndexedDB, preparing it for re-storage in IndexedDB.
- *
- * @param { AssignedExperiments | null } fetchExperiments - The experiment data fetched from the API.
- * @param { AssignedExperiments | null } storedExperiments - The experiment data currently stored in IndexedDB.
- *
- * @returns { AssignedExperiments } - The parsed experiment data ready for storing.
- *
- * Following cases are handled -
- * 1) When new Data is received without Old data. This is assumed to be the first time data is received.
- * 2) When only old data is received, implying that the timestamp hasn't expired and the data is available in IndexedDB.
- *    The data is verified and any expired experiment is removed before being assigned to dataToStorage.
- * 3) When both old data and new data is present. This implies that the record existed in IndexedDB but was fetched because the flag had expired.
- *    Additional operations are performed to add expiry time to experiments, merging all experiments, and storing them.
- *
- * There could be scenarios where none of these conditions are met, in that case, dataToStorage will be the default empty object.
- */
-export declare const parseData: (fetchExperiments: FetchExperiments, storedExperiments: Experiment[] | undefined) => Experiment[];
-/**
- * Retrieves the array of experiment IDs from the given AssignedExperiments..
- *
- * @returns {string[]} Returns an array of experiment IDs if available, otherwise an empty array.
- * @param experiments
- */
-export declare const getExperimentsIds: (experiments: Experiment[]) => string[];

package/src/lib/shared/persistence/index-db-database-handler.d.ts

@@ -1,87 +0,0 @@
-/**
- * Represents the configuration for a database connection.
- * @interface
- */
-interface DbConfig {
-    db_name: string;
-    db_store: string;
-    db_key_path: string;
-}
-/**
- * The `DatabaseHandler` class offers specific methods to store and get data
- * from IndexedDB.
- *
- * @example
- * // To fetch data from the IndexedDB
- * const data = await DatabaseHandler.getData();
- *
- * @example
- * // To store an object of type AssignedExperiments to IndexedDB
- * await DatabaseHandler.persistData(anAssignedExperiment);
- *
- * @example
- * // To get an object of type AssignedExperiments to IndexedDB
- * await DatabaseHandler.persistData(anAssignedExperiment);
- *
- */
-export declare class IndexDBDatabaseHandler {
-    private config;
-    constructor(config: DbConfig);
-    /**
-     * Saves the provided data to indexDB.
-     *
-     * @async
-     * @param {AssignedExperiments} data - The data to be saved.
-     * @returns {Promise<any>} - The result of the save operation.
-     */
-    persistData<T>(data: T): Promise<IDBValidKey>;
-    /**
-     * Retrieves data from the database using a specific key.
-     *
-     * @async
-     * @returns {Promise<any>} A promise that resolves with the data retrieved from the database.
-     */
-    getData<T>(): Promise<T>;
-    /**
-     * Deletes all the data from the IndexedDB store.
-     *
-     * @async
-     * @returns {Promise<void>} - The result of the delete operation.
-     */
-    clearData(): Promise<void>;
-    /**
-     * Sets the flag indicating that the experiment has already been checked.
-     *
-     * @function setFlagExperimentAlreadyChecked
-     * @returns {void}
-     */
-    setFlagExperimentAlreadyChecked(): void;
-    /**
-     * Sets the fetch expired time in the local storage.
-     *
-     * @return {void}
-     */
-    setFetchExpiredTime(): void;
-    /**
-     * Builds an error message based on the provided error object.
-     * @param {DOMException | null} error - The error object to build the message from.
-     * @returns {string} The constructed error message.
-     */
-    private getOnErrorMessage;
-    /**
-     * Creates or opens a IndexedDB database with the specified version.
-     *
-     *
-     * @returns {Promise<IDBDatabase>} A promise that resolves to the opened database.
-     * The promise will be rejected with an error message if there was a database error.
-     */
-    private openDB;
-    /**
-     * Retrieves the result of a database request from an Event object.
-     *
-     * @param {Event} event - The Event object containing the database request.
-     * @returns {IDBDatabase} - The result of the database request, casted as an IDBDatabase object.
-     */
-    private getRequestResult;
-}
-export {};

package/src/lib/shared/utils/DotLogger.d.ts

@@ -1,15 +0,0 @@
-/**
- * Logger for the dotCMS SDK
- */
-export declare class DotLogger {
-    private readonly isDebug;
-    private readonly packageName;
-    constructor(isDebug: boolean, packageName: string);
-    group(label: string): void;
-    groupEnd(): void;
-    time(label: string): void;
-    timeEnd(label: string): void;
-    log(message: string): void;
-    warn(message: string): void;
-    error(message: string): void;
-}

package/src/lib/shared/utils/memoize.d.ts

@@ -1,7 +0,0 @@
-/**
- * Memoizes an object and returns the memoized object.
- * Mantaing the same reference if the object is the same independently if is called inside any component.
- * @param object
- * @returns
- */
-export declare function useMemoizedObject<T extends object>(object: T): T;

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

@@ -1,73 +0,0 @@
-import { DotExperimentConfig, Experiment, Variant } from '../models';
-/**
- * Returns the first script element that includes the experiment script identifier.
- *
- * @return {HTMLScriptElement|undefined} - The found script element or undefined if none is found.
- */
-export declare const getExperimentScriptTag: () => HTMLScriptElement;
-/**
- * Retrieves experiment attributes from a given script element.
- *
- *
- * @return {DotExperimentConfig | null} - The experiment attributes or null if there are no valid attributes present.
- */
-export declare const getDataExperimentAttributes: (location: Location) => DotExperimentConfig | null;
-/**
- * Retrieves the data attributes from the experiment script tag.
- *
- * @example
- * Given the custom script tag in your HTML:
- * <script src="/dot-experiments.iife.js"
- *        defer=""
- *        data-experiment-api-key="api-token"
- *        data-experiment-server="http://localhost:8080/"
- *        data-experiment-debug>
- * </script>
- *
- * @returns {DotExperimentConfig | null} The data attributes of the experiment script tag, or null if no experiment script is found.
- */
-export declare const getScriptDataAttributes: (location: Location) => DotExperimentConfig | null;
-/**
- * Checks the flag indicating whether the experiment has already been checked.
- *
- * @function checkFlagExperimentAlreadyChecked
- * @returns {boolean} - returns true if experiment has already been checked, otherwise false.
- */
-export declare const checkFlagExperimentAlreadyChecked: () => boolean;
-/**
- * Checks if the data needs to be invalidated based on the creation date.
- *
- * @returns {boolean} - True if the data needs to be invalidated, false otherwise.
- */
-export declare const isDataCreateValid: () => boolean;
-/**
- * Ad to an absolute path the baseUrl depending on the location.
- *
- * @param {string | null} absolutePath - The absolute path of the URL.
- * @param {Location} location - The location object representing the current URL.
- * @returns {string | null} - The full URL or null if absolutePath is null.
- */
-export declare const getFullUrl: (location: Location, absolutePath: string | null) => string | null;
-/**
- * Updates the URL with the queryParam with the experiment variant name.
- *
- * @param {Location|string} location - The current location object or the URL string.
- * @param {Variant} variant - The experiment variant to update the URL with.
- * @returns {string} The updated URL string.
- */
-export declare const updateUrlWithExperimentVariant: (location: Location | string, variant: Variant | null) => string;
-/**
- * Check if two arrays of Experiment objects are equal.
- *
- * @param {Experiment[]} obj1 - The first array of Experiment objects.
- * @param {Experiment[]} obj2 - The second array of Experiment objects.
- * @return {boolean} - True if the arrays are equal, false otherwise.
- */
-export declare const objectsAreEqual: (obj1: Experiment[], obj2: Experiment[]) => boolean;
-/**
- * A function to redirect the user to a new URL.
- *
- * @param {string} href - The URL to redirect to.
- * @returns {void}
- */
-export declare const defaultRedirectFn: (href: string) => string;

package/src/lib/standalone.d.ts

@@ -1,7 +0,0 @@
-import { DotExperiments } from './dot-experiments';
-import { EXPERIMENT_WINDOWS_KEY } from './shared/constants';
-declare global {
-    interface Window {
-        [EXPERIMENT_WINDOWS_KEY]: DotExperiments;
-    }
-}