@dotcms/experiments 0.0.1-alpha.14 → 0.0.1-alpha.16

package/index.esm.js

@@ -317,10 +317,10 @@ var SHARED = '__core-js_shared__';
 var store$3 = sharedStore.exports = globalThis$1[SHARED] || defineGlobalProperty$2(SHARED, {});
 
 (store$3.versions || (store$3.versions = [])).push({
-  version: '3.37.0',
+  version: '3.37.1',
   mode: 'global',
   copyright: '© 2014-2024 Denis Pushkarev (zloirock.ru)',
-  license: 'https://github.com/zloirock/core-js/blob/v3.37.0/LICENSE',
+  license: 'https://github.com/zloirock/core-js/blob/v3.37.1/LICENSE',
   source: 'https://github.com/zloirock/core-js'
 });
 
@@ -3803,6 +3803,28 @@ var DEBUG_LEVELS;
 })(DEBUG_LEVELS || (DEBUG_LEVELS = {}));
 const PAGE_VIEW_EVENT_NAME = 'pageview';
 
+var $$3 = _export;
+var $includes = arrayIncludes.includes;
+var fails$2 = fails$l;
+var addToUnscopables = addToUnscopables$2;
+
+// FF99+ bug
+var BROKEN_ON_SPARSE = fails$2(function () {
+  // eslint-disable-next-line es/no-array-prototype-includes -- detection
+  return !Array(1).includes();
+});
+
+// `Array.prototype.includes` method
+// https://tc39.es/ecma262/#sec-array.prototype.includes
+$$3({ target: 'Array', proto: true, forced: BROKEN_ON_SPARSE }, {
+  includes: function includes(el /* , fromIndex = 0 */) {
+    return $includes(this, el, arguments.length > 1 ? arguments[1] : undefined);
+  }
+});
+
+// https://tc39.es/ecma262/#sec-array.prototype-@@unscopables
+addToUnscopables('includes');
+
 var isCallable = isCallable$m;
 var isObject$1 = isObject$d;
 var setPrototypeOf = objectSetPrototypeOf;
@@ -3873,7 +3895,7 @@ var getRegExpFlags$1 = regexpGetFlags;
 var stickyHelpers = regexpStickyHelpers;
 var proxyAccessor = proxyAccessor$1;
 var defineBuiltIn$2 = defineBuiltIn$b;
-var fails$2 = fails$l;
+var fails$1 = fails$l;
 var hasOwn$1 = hasOwnProperty_1;
 var enforceInternalState = internalState.enforce;
 var setSpecies = setSpecies$2;
@@ -3902,7 +3924,7 @@ var MISSED_STICKY = stickyHelpers.MISSED_STICKY;
 var UNSUPPORTED_Y = stickyHelpers.UNSUPPORTED_Y;
 
 var BASE_FORCED = DESCRIPTORS$2 &&
-  (!CORRECT_NEW || MISSED_STICKY || UNSUPPORTED_DOT_ALL || UNSUPPORTED_NCG || fails$2(function () {
+  (!CORRECT_NEW || MISSED_STICKY || UNSUPPORTED_DOT_ALL || UNSUPPORTED_NCG || fails$1(function () {
     re2[MATCH$1] = false;
     // RegExp constructor can alter flags and IsRegExp works correct with @@match
     return NativeRegExp(re1) !== re1 || NativeRegExp(re2) === re2 || String(NativeRegExp(re1, 'i')) !== '/a/i';
@@ -4054,14 +4076,14 @@ var PROPER_FUNCTION_NAME = functionName.PROPER;
 var defineBuiltIn$1 = defineBuiltIn$b;
 var anObject$1 = anObject$f;
 var $toString$1 = toString$6;
-var fails$1 = fails$l;
+var fails = fails$l;
 var getRegExpFlags = regexpGetFlags;
 
 var TO_STRING = 'toString';
 var RegExpPrototype = RegExp.prototype;
 var nativeToString = RegExpPrototype[TO_STRING];
 
-var NOT_GENERIC = fails$1(function () { return nativeToString.call({ source: 'a', flags: 'b' }) !== '/a/b'; });
+var NOT_GENERIC = fails(function () { return nativeToString.call({ source: 'a', flags: 'b' }) !== '/a/b'; });
 // FF44- RegExp#toString has a wrong name
 var INCORRECT_NAME = PROPER_FUNCTION_NAME && nativeToString.name !== TO_STRING;
 
@@ -4076,18 +4098,65 @@ if (NOT_GENERIC || INCORRECT_NAME) {
   }, { unsafe: true });
 }
 
+var isRegExp = isRegexp;
+
+var $TypeError = TypeError;
+
+var notARegexp = function (it) {
+  if (isRegExp(it)) {
+    throw new $TypeError("The method doesn't accept regular expressions");
+  } return it;
+};
+
+var wellKnownSymbol = wellKnownSymbol$k;
+
+var MATCH = wellKnownSymbol('match');
+
+var correctIsRegexpLogic = function (METHOD_NAME) {
+  var regexp = /./;
+  try {
+    '/./'[METHOD_NAME](regexp);
+  } catch (error1) {
+    try {
+      regexp[MATCH] = false;
+      return '/./'[METHOD_NAME](regexp);
+    } catch (error2) { /* empty */ }
+  } return false;
+};
+
+var $$2 = _export;
 var uncurryThis$3 = functionUncurryThis;
-var toIntegerOrInfinity = toIntegerOrInfinity$3;
-var toString$2 = toString$6;
+var notARegExp = notARegexp;
 var requireObjectCoercible$1 = requireObjectCoercible$6;
+var toString$2 = toString$6;
+var correctIsRegExpLogic = correctIsRegexpLogic;
+
+var stringIndexOf = uncurryThis$3(''.indexOf);
 
-var charAt$2 = uncurryThis$3(''.charAt);
-var charCodeAt$1 = uncurryThis$3(''.charCodeAt);
-var stringSlice$1 = uncurryThis$3(''.slice);
+// `String.prototype.includes` method
+// https://tc39.es/ecma262/#sec-string.prototype.includes
+$$2({ target: 'String', proto: true, forced: !correctIsRegExpLogic('includes') }, {
+  includes: function includes(searchString /* , position = 0 */) {
+    return !!~stringIndexOf(
+      toString$2(requireObjectCoercible$1(this)),
+      toString$2(notARegExp(searchString)),
+      arguments.length > 1 ? arguments[1] : undefined
+    );
+  }
+});
+
+var uncurryThis$2 = functionUncurryThis;
+var toIntegerOrInfinity = toIntegerOrInfinity$3;
+var toString$1 = toString$6;
+var requireObjectCoercible = requireObjectCoercible$6;
+
+var charAt$2 = uncurryThis$2(''.charAt);
+var charCodeAt$1 = uncurryThis$2(''.charCodeAt);
+var stringSlice$1 = uncurryThis$2(''.slice);
 
 var createMethod = function (CONVERT_TO_STRING) {
   return function ($this, pos) {
-    var S = toString$2(requireObjectCoercible$1($this));
+    var S = toString$1(requireObjectCoercible($this));
     var position = toIntegerOrInfinity(pos);
     var size = S.length;
     var first, second;
@@ -4114,7 +4183,7 @@ var stringMultibyte = {
 };
 
 var charAt$1 = stringMultibyte.charAt;
-var toString$1 = toString$6;
+var toString = toString$6;
 var InternalStateModule$1 = internalState;
 var defineIterator = iteratorDefine;
 var createIterResultObject = createIterResultObject$3;
@@ -4128,7 +4197,7 @@ var getInternalState = InternalStateModule$1.getterFor(STRING_ITERATOR);
 defineIterator(String, 'String', function (iterated) {
   setInternalState$1(this, {
     type: STRING_ITERATOR,
-    string: toString$1(iterated),
+    string: toString(iterated),
     index: 0
   });
 // `%StringIteratorPrototype%.next` method
@@ -4212,7 +4281,7 @@ var arrayFrom$1 = function from(arrayLike /* , mapfn = undefined, thisArg = unde
 };
 
 // based on https://github.com/bestiejs/punycode.js/blob/master/punycode.js
-var uncurryThis$2 = functionUncurryThis;
+var uncurryThis$1 = functionUncurryThis;
 
 var maxInt = 2147483647; // aka. 0x7FFFFFFF or 2^31-1
 var base = 36;
@@ -4229,15 +4298,15 @@ var OVERFLOW_ERROR = 'Overflow: input needs wider integers to process';
 var baseMinusTMin = base - tMin;
 
 var $RangeError = RangeError;
-var exec$1 = uncurryThis$2(regexSeparators.exec);
+var exec$1 = uncurryThis$1(regexSeparators.exec);
 var floor$1 = Math.floor;
 var fromCharCode = String.fromCharCode;
-var charCodeAt = uncurryThis$2(''.charCodeAt);
-var join$1 = uncurryThis$2([].join);
-var push$1 = uncurryThis$2([].push);
-var replace$1 = uncurryThis$2(''.replace);
-var split$1 = uncurryThis$2(''.split);
-var toLowerCase$1 = uncurryThis$2(''.toLowerCase);
+var charCodeAt = uncurryThis$1(''.charCodeAt);
+var join$1 = uncurryThis$1([].join);
+var push$1 = uncurryThis$1([].push);
+var replace$1 = uncurryThis$1(''.replace);
+var split$1 = uncurryThis$1(''.split);
+var toLowerCase$1 = uncurryThis$1(''.toLowerCase);
 
 /**
  * Creates an array containing the numeric code points of each Unicode
@@ -4394,12 +4463,12 @@ var stringPunycodeToAscii = function (input) {
 
 // TODO: in core-js@4, move /modules/ dependencies to public entries for better optimization by tools like `preset-env`
 
-var $$3 = _export;
+var $$1 = _export;
 var DESCRIPTORS = descriptors;
 var USE_NATIVE_URL = urlConstructorDetection;
 var global$1 = global$o;
 var bind = functionBindContext;
-var uncurryThis$1 = functionUncurryThis;
+var uncurryThis = functionUncurryThis;
 var defineBuiltIn = defineBuiltIn$b;
 var defineBuiltInAccessor = defineBuiltInAccessor$3;
 var anInstance = anInstance$3;
@@ -4425,18 +4494,18 @@ var TypeError$1 = global$1.TypeError;
 var parseInt = global$1.parseInt;
 var floor = Math.floor;
 var pow = Math.pow;
-var charAt = uncurryThis$1(''.charAt);
-var exec = uncurryThis$1(/./.exec);
-var join = uncurryThis$1([].join);
-var numberToString = uncurryThis$1(1.0.toString);
-var pop = uncurryThis$1([].pop);
-var push = uncurryThis$1([].push);
-var replace = uncurryThis$1(''.replace);
-var shift = uncurryThis$1([].shift);
-var split = uncurryThis$1(''.split);
-var stringSlice = uncurryThis$1(''.slice);
-var toLowerCase = uncurryThis$1(''.toLowerCase);
-var unshift = uncurryThis$1([].unshift);
+var charAt = uncurryThis(''.charAt);
+var exec = uncurryThis(/./.exec);
+var join = uncurryThis([].join);
+var numberToString = uncurryThis(1.0.toString);
+var pop = uncurryThis([].pop);
+var push = uncurryThis([].push);
+var replace = uncurryThis(''.replace);
+var shift = uncurryThis([].shift);
+var split = uncurryThis(''.split);
+var stringSlice = uncurryThis(''.slice);
+var toLowerCase = uncurryThis(''.toLowerCase);
+var unshift = uncurryThis([].unshift);
 
 var INVALID_AUTHORITY = 'Invalid authority';
 var INVALID_SCHEME = 'Invalid scheme';
@@ -5436,16 +5505,16 @@ if (NativeURL) {
 
 setToStringTag(URLConstructor, 'URL');
 
-$$3({ global: true, constructor: true, forced: !USE_NATIVE_URL, sham: !DESCRIPTORS }, {
+$$1({ global: true, constructor: true, forced: !USE_NATIVE_URL, sham: !DESCRIPTORS }, {
   URL: URLConstructor
 });
 
-var $$2 = _export;
+var $ = _export;
 var call = functionCall;
 
 // `URL.prototype.toJSON` method
 // https://url.spec.whatwg.org/#dom-url-tojson
-$$2({ target: 'URL', proto: true, enumerable: true }, {
+$({ target: 'URL', proto: true, enumerable: true }, {
   toJSON: function toJSON() {
     return call(URL.prototype.toString, this);
   }
@@ -5524,20 +5593,23 @@ const verifyRegex = (regexToCheck, href) => {
  */
 const parseData = (fetchExperiments, storedExperiments) => {
   let dataToStorage = {};
+  const {
+    excludedExperimentIdsEnded
+  } = fetchExperiments;
   if (fetchExperiments && !storedExperiments) {
     // TODO: Use fetchExperiment instead fetchExperimentsNoNoneExperimentID when the endpoint dont retrieve NONE experiment
     // https://github.com/dotCMS/core/issues/27905
-    const fetchExperimentsNoNoneExperimentID = fetchExperiments ? fetchExperiments.filter(experiment => experiment.id !== 'NONE') : [];
+    const fetchExperimentsNoNoneExperimentID = fetchExperiments.experiments ? fetchExperiments.experiments.filter(experiment => experiment.id !== 'NONE') : [];
     dataToStorage = addExpireTimeToExperiments(fetchExperimentsNoNoneExperimentID);
   }
   if (!fetchExperiments && storedExperiments) {
-    dataToStorage = getUnexpiredExperiments(storedExperiments);
+    dataToStorage = getUnexpiredExperiments(storedExperiments, excludedExperimentIdsEnded);
   }
   if (fetchExperiments && storedExperiments) {
     // TODO: Use fetchExperiment instead fetchExperimentsNoNoneExperimentID when the endpoint dont retrieve NONE experiment
     // https://github.com/dotCMS/core/issues/27905
-    const fetchExperimentsNoNoneExperimentID = fetchExperiments ? fetchExperiments.filter(experiment => experiment.id !== 'NONE') : [];
-    dataToStorage = [...addExpireTimeToExperiments(fetchExperimentsNoNoneExperimentID), ...getUnexpiredExperiments(storedExperiments)];
+    const fetchExperimentsNoNoneExperimentID = fetchExperiments.experiments ? fetchExperiments.experiments.filter(experiment => experiment.id !== 'NONE') : [];
+    dataToStorage = [...addExpireTimeToExperiments(fetchExperimentsNoNoneExperimentID), ...getUnexpiredExperiments(storedExperiments, excludedExperimentIdsEnded)];
   }
   return dataToStorage;
 };
@@ -5567,14 +5639,15 @@ const addExpireTimeToExperiments = experiments => {
  * Returns an array of experiments that have not expired yet.
  *
  * @param {Experiment[]} experiments - An array of experiments to filter.
+ * @param excludedExperimentIdsEnded -  Array of Experiments ids that have been manually ended.
  * @returns {Experiment[]} An array of unexpired experiments.
  */
-const getUnexpiredExperiments = experiments => {
+const getUnexpiredExperiments = (experiments, excludedExperimentIdsEnded) => {
   const now = Date.now();
   return experiments.filter(experiment => {
     var _experiment$lookBackW;
     const expireTime = (_experiment$lookBackW = experiment.lookBackWindow) == null ? void 0 : _experiment$lookBackW.expireTime;
-    return expireTime ? expireTime > now : false;
+    return expireTime ? expireTime > now && !excludedExperimentIdsEnded.includes(experiment.id) : false;
   });
 };
 
@@ -5793,75 +5866,6 @@ class DotLogger {
   }
 }
 
-var $$1 = _export;
-var $includes = arrayIncludes.includes;
-var fails = fails$l;
-var addToUnscopables = addToUnscopables$2;
-
-// FF99+ bug
-var BROKEN_ON_SPARSE = fails(function () {
-  // eslint-disable-next-line es/no-array-prototype-includes -- detection
-  return !Array(1).includes();
-});
-
-// `Array.prototype.includes` method
-// https://tc39.es/ecma262/#sec-array.prototype.includes
-$$1({ target: 'Array', proto: true, forced: BROKEN_ON_SPARSE }, {
-  includes: function includes(el /* , fromIndex = 0 */) {
-    return $includes(this, el, arguments.length > 1 ? arguments[1] : undefined);
-  }
-});
-
-// https://tc39.es/ecma262/#sec-array.prototype-@@unscopables
-addToUnscopables('includes');
-
-var isRegExp = isRegexp;
-
-var $TypeError = TypeError;
-
-var notARegexp = function (it) {
-  if (isRegExp(it)) {
-    throw new $TypeError("The method doesn't accept regular expressions");
-  } return it;
-};
-
-var wellKnownSymbol = wellKnownSymbol$k;
-
-var MATCH = wellKnownSymbol('match');
-
-var correctIsRegexpLogic = function (METHOD_NAME) {
-  var regexp = /./;
-  try {
-    '/./'[METHOD_NAME](regexp);
-  } catch (error1) {
-    try {
-      regexp[MATCH] = false;
-      return '/./'[METHOD_NAME](regexp);
-    } catch (error2) { /* empty */ }
-  } return false;
-};
-
-var $ = _export;
-var uncurryThis = functionUncurryThis;
-var notARegExp = notARegexp;
-var requireObjectCoercible = requireObjectCoercible$6;
-var toString = toString$6;
-var correctIsRegExpLogic = correctIsRegexpLogic;
-
-var stringIndexOf = uncurryThis(''.indexOf);
-
-// `String.prototype.includes` method
-// https://tc39.es/ecma262/#sec-string.prototype.includes
-$({ target: 'String', proto: true, forced: !correctIsRegExpLogic('includes') }, {
-  includes: function includes(searchString /* , position = 0 */) {
-    return !!~stringIndexOf(
-      toString(requireObjectCoercible(this)),
-      toString(notARegExp(searchString)),
-      arguments.length > 1 ? arguments[1] : undefined
-    );
-  }
-});
-
 /**
  * Checks the flag indicating whether the experiment has already been checked.
  *
@@ -6204,11 +6208,16 @@ class DotExperiments {
    */
   shouldTrackPageView() {
     if (!this.config.trackPageView) {
+      this.logger.log(`No send pageView. Tracking disabled. Config: ${this.config.trackPageView}.`);
+      return false;
+    }
+    if (this.experimentsAssigned.length === 0) {
+      this.logger.log(`No send pageView. No experiments to track.`);
       return false;
     }
     // If the previous location is the same as the current location, we don't need to track the page view
     if (this.prevLocation === this.currentLocation.href) {
-      this.logger.log(`No shouldTrackPageView, preview location is the same as current location.`);
+      this.logger.log(`No send pageView. Same location.`);
       return false;
     }
     return true;
@@ -6268,7 +6277,7 @@ class DotExperiments {
     this.logger.group('Fetch Experiments');
     this.logger.time('Fetch Time');
     try {
-      var _responseJson$entity;
+      var _responseJson$entity$, _responseJson$entity, _responseJson$entity$2, _responseJson$entity2;
       const body = {
         exclude: this.experimentsAssigned ? getExperimentsIds(this.experimentsAssigned) : []
       };
@@ -6285,10 +6294,15 @@ class DotExperiments {
         throw new Error(`HTTP error! status: ${response.status}, body: ${responseText}`);
       }
       const responseJson = await response.json();
-      const experiments = responseJson == null || (_responseJson$entity = responseJson.entity) == null ? void 0 : _responseJson$entity.experiments;
+      const experiments = (_responseJson$entity$ = responseJson == null || (_responseJson$entity = responseJson.entity) == null ? void 0 : _responseJson$entity.experiments) != null ? _responseJson$entity$ : [];
+      const excludedExperimentIdsEnded = (_responseJson$entity$2 = responseJson == null || (_responseJson$entity2 = responseJson.entity) == null ? void 0 : _responseJson$entity2.excludedExperimentIdsEnded) != null ? _responseJson$entity$2 : [];
       this.logger.log(`Experiment data get successfully `);
       this.persistenceHandler.setFlagExperimentAlreadyChecked();
-      return experiments != null ? experiments : [];
+      this.persistenceHandler.setFetchExpiredTime();
+      return {
+        experiments,
+        excludedExperimentIdsEnded
+      };
     } catch (error) {
       this.logger.error(`An error occurred while trying to fetch the experiments: ${error.message}`);
       throw error;
@@ -6314,13 +6328,14 @@ class DotExperiments {
    */
   async verifyExperimentData() {
     try {
-      let fetchedExperiments = undefined;
+      let fetchedExperiments = {
+        excludedExperimentIdsEnded: [],
+        experiments: []
+      };
       const storedExperiments = this.experimentsAssigned ? this.experimentsAssigned : [];
       // Checks whether fetching experiment data from the server is necessary.
       if (this.shouldFetchNewData()) {
         fetchedExperiments = await this.getExperimentsFromServer();
-        this.persistenceHandler.setFlagExperimentAlreadyChecked();
-        this.persistenceHandler.setFetchExpiredTime();
       }
       const dataToPersist = parseData(fetchedExperiments, storedExperiments);
       // If my stored data is equal to my parsed data, I don't need to persist again
@@ -6454,11 +6469,12 @@ class DotExperiments {
       this.logger.log(`${EXPERIMENT_ALREADY_CHECKED_KEY} not found, fetch data from Analytics`);
       return true;
     }
-    if (!this.experimentsAssigned) {
+    if (!this.experimentsAssigned || this.experimentsAssigned.length === 0) {
+      this.logger.log(`No experiments assigned to the client, fetch data from Analytics`);
       return true;
     }
     if (!isDataCreateValid()) {
-      this.logger.log(`Persistence not valid, fetch data from Analytics`);
+      this.logger.log(`The validity period of the persistence has passed, fetch data from Analytics`);
       return true;
     }
     this.logger.log(`Not should Check Analytics by now...`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/experiments",
-  "version": "0.0.1-alpha.14",
+  "version": "0.0.1-alpha.16",
   "description": "Official JavaScript library to use Experiments with DotCMS.",
   "repository": {
     "type": "git",
@@ -25,7 +25,7 @@
   "peerDependencies": {
     "react": ">=18",
     "react-dom": ">=18",
-    "@dotcms/client": "0.0.1-alpha.14"
+    "@dotcms/client": "0.0.1-alpha.16"
   },
   "module": "./index.esm.js",
   "type": "module",

package/src/lib/shared/mocks/mock.d.ts

@@ -9,6 +9,8 @@ import { Experiment, ExperimentEvent, IsUserIncludedApiResponse } from '../model
  */
 export declare const IsUserIncludedResponse: IsUserIncludedApiResponse;
 export declare const NewIsUserIncludedResponse: IsUserIncludedApiResponse;
+export declare const After15DaysIsUserIncludedResponse: IsUserIncludedApiResponse;
+export declare const NoExperimentsIsUserIncludedResponse: IsUserIncludedApiResponse;
 export declare const MOCK_CURRENT_TIMESTAMP = 1704096000000;
 export declare const TIME_15_DAYS_MILLISECONDS: number;
 export declare const TIME_5_DAYS_MILLISECONDS: number;

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

@@ -128,7 +128,15 @@ export interface AssignedExperiments {
      * The ids of the experiments included in the assignment.
      */
     includedExperimentIds: string[];
+    /**
+     * The ids of the experiments that are excluded in the request and have ended.
+     */
+    excludedExperimentIdsEnded: string[];
 }
+/**
+ * Represents the response from the backend when fetching an experiment and the excludedExperimentIdsEnded.
+ */
+export type FetchExperiments = Pick<AssignedExperiments, 'excludedExperimentIdsEnded' | 'experiments'>;
 /**
  * Represents the response from backend holding information about running experiments and variant assignment.
  *

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

@@ -1,4 +1,4 @@
-import { Experiment, ExperimentParsed } from '../models';
+import { Experiment, ExperimentParsed, FetchExperiments } from '../models';
 /**
  * This arrow function parses a given set of assigned experiments for analytics.
  *
@@ -44,7 +44,7 @@ export declare const verifyRegex: (regexToCheck: string | null, href: string) =>
  *
  * 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: Experiment[] | undefined, storedExperiments: Experiment[] | undefined) => Experiment[];
+export declare const parseData: (fetchExperiments: FetchExperiments, storedExperiments: Experiment[] | undefined) => Experiment[];
 /**
  * Retrieves the array of experiment IDs from the given AssignedExperiments..
  *