@usertour/helpers 0.0.11 → 0.0.13

package/dist/conditions.js

@@ -0,0 +1,50 @@
+import {
+  PRIORITIES,
+  activedContentCondition,
+  activedContentRulesConditions,
+  activedRulesConditions,
+  checklistIsDimissed,
+  checklistIsSeen,
+  completeEventMapping,
+  filterAutoStartContent,
+  findLatestEvent,
+  flowIsDismissed,
+  flowIsSeen,
+  isActive,
+  isActiveContent,
+  isActiveRulesByCurrentPage,
+  isActiveRulesByCurrentTime,
+  isDismissedEventMapping,
+  isHasActivedContents,
+  isSameContents,
+  isValidContent,
+  parseUrlParams,
+  rulesTypes,
+  wait
+} from "./chunk-SYVTGB2A.js";
+import "./chunk-FNQIIEWK.js";
+import "./chunk-XEO3YXBM.js";
+export {
+  PRIORITIES,
+  activedContentCondition,
+  activedContentRulesConditions,
+  activedRulesConditions,
+  checklistIsDimissed,
+  checklistIsSeen,
+  completeEventMapping,
+  filterAutoStartContent,
+  findLatestEvent,
+  flowIsDismissed,
+  flowIsSeen,
+  isActive,
+  isActiveContent,
+  isActiveRulesByCurrentPage,
+  isActiveRulesByCurrentTime,
+  isDismissedEventMapping,
+  isHasActivedContents,
+  isSameContents,
+  isValidContent,
+  parseUrlParams,
+  rulesTypes,
+  wait
+};

package/dist/index.cjs

@@ -39,9 +39,12 @@ __export(src_exports, {
   ArrayProto: () => ArrayProto,
   XMLHttpRequest: () => XMLHttpRequest,
   absoluteUrl: () => absoluteUrl,
+  activedContentRulesConditions: () => activedContentRulesConditions,
   assignableWindow: () => assignableWindow,
   autoStartConditions: () => autoStartConditions,
   buildConfig: () => buildConfig,
+  checklistIsDimissed: () => checklistIsDimissed,
+  checklistIsSeen: () => checklistIsSeen,
   cn: () => cn,
   conditionsIsSame: () => conditionsIsSame,
   convertSettings: () => convertSettings,
@@ -53,6 +56,9 @@ __export(src_exports, {
   document: () => document,
   evalCode: () => evalCode,
   fetch: () => fetch,
+  filterAutoStartContent: () => filterAutoStartContent,
+  flowIsDismissed: () => flowIsDismissed,
+  flowIsSeen: () => flowIsSeen,
   formatDate: () => formatDate,
   generateAutoStateColors: () => generateAutoStateColors,
   getAuthToken: () => getAuthToken,
@@ -75,6 +81,7 @@ __export(src_exports, {
   hexToHSLString: () => hexToHSLString,
   hexToRGBStr: () => hexToRGBStr,
   hexToRgb: () => hexToRgb,
+  isActiveRulesByCurrentTime: () => isActiveRulesByCurrentTime,
   isArray: () => isArray,
   isBoolean: () => isBoolean,
   isDark: () => isDark,
@@ -97,12 +104,14 @@ __export(src_exports, {
   isUint8Array: () => isUint8Array,
   isUndefined: () => isUndefined,
   isUrl: () => isUrl,
+  isValidContent: () => isValidContent,
   isValidSelector: () => isValidSelector,
-  location: () => location,
+  location: () => location2,
   mergeThemeDefaultSettings: () => mergeThemeDefaultSettings,
   nativeForEach: () => nativeForEach,
   nativeIndexOf: () => nativeIndexOf,
   navigator: () => navigator,
+  parseUrlParams: () => parseUrlParams,
   removeAuthToken: () => removeAuthToken,
   setAuthToken: () => setAuthToken,
   storage: () => storage,
@@ -812,7 +821,7 @@ var nativeForEach = ArrayProto.forEach;
 var nativeIndexOf = ArrayProto.indexOf;
 var navigator = global == null ? void 0 : global.navigator;
 var document = global == null ? void 0 : global.document;
-var location = global == null ? void 0 : global.location;
+var location2 = global == null ? void 0 : global.location;
 var fetch = global == null ? void 0 : global.fetch;
 var XMLHttpRequest = (global == null ? void 0 : global.XMLHttpRequest) && "withCredentials" in new global.XMLHttpRequest() ? global.XMLHttpRequest : void 0;
 var AbortController = global == null ? void 0 : global.AbortController;
@@ -1086,15 +1095,335 @@ var getRandomColor = () => {
   ];
   return colors[Math.floor(Math.random() * colors.length)];
 };
+
+// src/conditions.ts
+var import_types4 = require("@usertour/types");
+var import_date_fns = require("date-fns");
+var PRIORITIES = [
+  import_types4.ContentPriority.HIGHEST,
+  import_types4.ContentPriority.HIGH,
+  import_types4.ContentPriority.MEDIUM,
+  import_types4.ContentPriority.LOW,
+  import_types4.ContentPriority.LOWEST
+];
+var rulesTypes = Object.values(import_types4.RulesType);
+var isActiveRulesByCurrentTime = (rules) => {
+  const { endDate, endDateHour, endDateMinute, startDate, startDateHour, startDateMinute } = rules.data;
+  const startTime = /* @__PURE__ */ new Date(`${startDate} ${startDateHour}:${startDateMinute}:00`);
+  const endTime = /* @__PURE__ */ new Date(`${endDate} ${endDateHour}:${endDateMinute}:00`);
+  const now = /* @__PURE__ */ new Date();
+  if (!endDate) {
+    return (0, import_date_fns.isAfter)(now, startTime);
+  }
+  return (0, import_date_fns.isAfter)(now, startTime) && (0, import_date_fns.isBefore)(now, endTime);
+};
+var isActivedContentRulesCondition = (rules, contentSession) => {
+  const { contentId, logic } = rules.data;
+  const { latestSession, seenSessions, completedSessions } = contentSession;
+  if (!contentId || !logic || contentId !== contentSession.contentId) {
+    return false;
+  }
+  if (logic === import_types4.ContentConditionLogic.ACTIVED || logic === import_types4.ContentConditionLogic.UNACTIVED) {
+    if (!latestSession) {
+      return logic === import_types4.ContentConditionLogic.UNACTIVED;
+    }
+    const isActived = !(flowIsDismissed(latestSession) || checklistIsDimissed(latestSession));
+    return logic === import_types4.ContentConditionLogic.ACTIVED ? isActived : !isActived;
+  }
+  const isSeen = seenSessions > 0;
+  const isCompleted = completedSessions > 0;
+  if (logic === import_types4.ContentConditionLogic.SEEN || logic === import_types4.ContentConditionLogic.UNSEEN) {
+    return logic === import_types4.ContentConditionLogic.SEEN ? isSeen : !isSeen;
+  }
+  if (logic === import_types4.ContentConditionLogic.COMPLETED || logic === import_types4.ContentConditionLogic.UNCOMPLETED) {
+    return logic === import_types4.ContentConditionLogic.COMPLETED ? isCompleted : !isCompleted;
+  }
+  return false;
+};
+var activedContentRulesConditions = async (conditions, contents) => {
+  const rulesCondition = [...conditions];
+  for (let j = 0; j < rulesCondition.length; j++) {
+    const rules = rulesCondition[j];
+    if (rules.type !== "group") {
+      if (rules.type === import_types4.RulesType.CONTENT) {
+        const content = contents.find((c) => c.contentId === rules.data.contentId);
+        if (content) {
+          const contentSession = {
+            contentId: content.contentId,
+            latestSession: content.latestSession,
+            totalSessions: content.totalSessions,
+            dismissedSessions: content.dismissedSessions,
+            completedSessions: content.completedSessions,
+            seenSessions: content.seenSessions
+          };
+          rulesCondition[j].actived = isActivedContentRulesCondition(rules, contentSession);
+        }
+      }
+    } else if (rules.conditions) {
+      rulesCondition[j].conditions = await activedContentRulesConditions(
+        rules.conditions,
+        contents
+      );
+    }
+  }
+  return rulesCondition;
+};
+var isActive = (autoStartRules) => {
+  if (!autoStartRules || autoStartRules.length === 0) {
+    return false;
+  }
+  const operator = autoStartRules[0].operators;
+  const actives = autoStartRules.filter((rule) => {
+    if (!rule.conditions) {
+      return rule.actived;
+    }
+    return isActive(rule.conditions);
+  });
+  return operator === "and" ? actives.length === autoStartRules.length : actives.length > 0;
+};
+var isActiveContent = (content) => {
+  const { enabledAutoStartRules, autoStartRules } = content.config;
+  if (!enabledAutoStartRules || !isActive(autoStartRules)) {
+    return false;
+  }
+  return true;
+};
+var priorityCompare = (a, b) => {
+  var _a, _b, _c, _d;
+  const a1 = (_b = (_a = a == null ? void 0 : a.config) == null ? void 0 : _a.autoStartRulesSetting) == null ? void 0 : _b.priority;
+  const a2 = (_d = (_c = b == null ? void 0 : b.config) == null ? void 0 : _c.autoStartRulesSetting) == null ? void 0 : _d.priority;
+  if (!a1 || !a2) {
+    return 0;
+  }
+  const index1 = PRIORITIES.indexOf(a1);
+  const index2 = PRIORITIES.indexOf(a2);
+  if (index1 > index2) {
+    return 1;
+  }
+  if (index1 < index2) {
+    return -1;
+  }
+  return 0;
+};
+var filterAutoStartContent = (contents, type) => {
+  return contents.filter((content) => {
+    const isActive2 = isActiveContent(content);
+    const isValid = isValidContent(content, contents);
+    return content.type === type && isActive2 && isValid;
+  }).sort(priorityCompare);
+};
+var getLatestEvent = (currentContent, contents, eventCodeName) => {
+  var _a;
+  const bizEvents = [];
+  const contentId = currentContent.id;
+  const contentType = currentContent.type;
+  for (let index = 0; index < contents.length; index++) {
+    const content = contents[index];
+    if (content.id === contentId || content.type !== contentType) {
+      continue;
+    }
+    const sessionBizEvents = (_a = content.latestSession) == null ? void 0 : _a.bizEvent;
+    if (sessionBizEvents && sessionBizEvents.length > 0) {
+      bizEvents.push(...sessionBizEvents.filter((e) => {
+        var _a2;
+        return ((_a2 = e == null ? void 0 : e.event) == null ? void 0 : _a2.codeName) === eventCodeName;
+      }));
+    }
+  }
+  return findLatestEvent(bizEvents);
+};
+var findLatestEvent = (bizEvents) => {
+  const initialValue = bizEvents[0];
+  const lastEvent = bizEvents.reduce(
+    (accumulator, currentValue) => {
+      if ((0, import_date_fns.isAfter)(new Date(currentValue.createdAt), new Date(accumulator.createdAt))) {
+        return currentValue;
+      }
+      return accumulator;
+    },
+    initialValue
+  );
+  return lastEvent;
+};
+var completeEventMapping = {
+  [import_types4.ContentDataType.FLOW]: import_types4.BizEvents.FLOW_COMPLETED,
+  [import_types4.ContentDataType.LAUNCHER]: import_types4.BizEvents.LAUNCHER_ACTIVATED,
+  [import_types4.ContentDataType.CHECKLIST]: import_types4.BizEvents.CHECKLIST_COMPLETED
+};
+var showEventMapping = {
+  [import_types4.ContentDataType.FLOW]: import_types4.BizEvents.FLOW_STEP_SEEN,
+  [import_types4.ContentDataType.LAUNCHER]: import_types4.BizEvents.LAUNCHER_SEEN,
+  [import_types4.ContentDataType.CHECKLIST]: import_types4.BizEvents.CHECKLIST_SEEN
+};
+var isDismissedEventMapping = {
+  [import_types4.ContentDataType.FLOW]: import_types4.BizEvents.FLOW_ENDED,
+  [import_types4.ContentDataType.LAUNCHER]: import_types4.BizEvents.LAUNCHER_DISMISSED,
+  [import_types4.ContentDataType.CHECKLIST]: import_types4.BizEvents.CHECKLIST_DISMISSED
+};
+var isGreaterThenDuration = (dateLeft, dateRight, unit, duration) => {
+  switch (unit) {
+    case import_types4.FrequencyUnits.SECONDS: {
+      if ((0, import_date_fns.differenceInSeconds)(dateLeft, dateRight) >= duration) {
+        return true;
+      }
+      return false;
+    }
+    case import_types4.FrequencyUnits.MINUTES:
+      if ((0, import_date_fns.differenceInMinutes)(dateLeft, dateRight) >= duration) {
+        return true;
+      }
+      return false;
+    case import_types4.FrequencyUnits.HOURS:
+      if ((0, import_date_fns.differenceInHours)(dateLeft, dateRight) >= duration) {
+        return true;
+      }
+      return false;
+    case import_types4.FrequencyUnits.DAYES:
+      if ((0, import_date_fns.differenceInDays)(dateLeft, dateRight) >= duration) {
+        return true;
+      }
+      return false;
+    default:
+      return false;
+  }
+};
+var checklistIsDimissed = (latestSession) => {
+  var _a;
+  return (_a = latestSession == null ? void 0 : latestSession.bizEvent) == null ? void 0 : _a.find(
+    (event) => {
+      var _a2;
+      return ((_a2 = event == null ? void 0 : event.event) == null ? void 0 : _a2.codeName) === import_types4.BizEvents.CHECKLIST_DISMISSED;
+    }
+  );
+};
+var flowIsDismissed = (latestSession) => {
+  var _a;
+  return (_a = latestSession == null ? void 0 : latestSession.bizEvent) == null ? void 0 : _a.find((event) => {
+    var _a2;
+    return ((_a2 = event == null ? void 0 : event.event) == null ? void 0 : _a2.codeName) === import_types4.BizEvents.FLOW_ENDED;
+  });
+};
+var flowIsSeen = (latestSession) => {
+  var _a;
+  return (_a = latestSession == null ? void 0 : latestSession.bizEvent) == null ? void 0 : _a.find(
+    (event) => {
+      var _a2;
+      return ((_a2 = event == null ? void 0 : event.event) == null ? void 0 : _a2.codeName) === import_types4.BizEvents.FLOW_STEP_SEEN;
+    }
+  );
+};
+var checklistIsSeen = (latestSession) => {
+  var _a;
+  return (_a = latestSession == null ? void 0 : latestSession.bizEvent) == null ? void 0 : _a.find(
+    (event) => {
+      var _a2;
+      return ((_a2 = event == null ? void 0 : event.event) == null ? void 0 : _a2.codeName) === import_types4.BizEvents.CHECKLIST_SEEN;
+    }
+  );
+};
+var isValidContent = (content, contents) => {
+  var _a;
+  const now = /* @__PURE__ */ new Date();
+  if (content.type === import_types4.ContentDataType.FLOW) {
+    if (!content.steps || content.steps.length === 0) {
+      return false;
+    }
+  } else {
+    if (!content.data) {
+      return false;
+    }
+  }
+  if (!content.config.autoStartRulesSetting) {
+    return true;
+  }
+  const { frequency, startIfNotComplete } = content.config.autoStartRulesSetting;
+  const completedSessions = content.completedSessions;
+  const dismissedSessions = content.dismissedSessions;
+  if (startIfNotComplete && completedSessions > 0) {
+    return false;
+  }
+  if (!frequency) {
+    return true;
+  }
+  const contentType = content.type;
+  const lastEventName = showEventMapping[contentType];
+  const lastEvent = getLatestEvent(content, contents, lastEventName);
+  const contentEvents = (_a = content.latestSession) == null ? void 0 : _a.bizEvent;
+  if (lastEvent && frequency && frequency.atLeast && !isGreaterThenDuration(
+    now,
+    new Date(lastEvent.createdAt),
+    frequency.atLeast.unit,
+    frequency.atLeast.duration
+  )) {
+    return false;
+  }
+  if (frequency.frequency === import_types4.Frequency.ONCE) {
+    if (dismissedSessions > 0) {
+      return false;
+    }
+    return true;
+  }
+  const showEventName = showEventMapping[contentType];
+  const showEvents = contentEvents == null ? void 0 : contentEvents.filter(
+    (e) => {
+      var _a2, _b;
+      return ((_a2 = e == null ? void 0 : e.event) == null ? void 0 : _a2.codeName) === showEventName && (contentType === import_types4.ContentDataType.FLOW ? ((_b = e == null ? void 0 : e.data) == null ? void 0 : _b.flow_step_number) === 0 : true);
+    }
+  );
+  if (!showEvents || showEvents.length === 0) {
+    return true;
+  }
+  const lastShowEvent = findLatestEvent(showEvents);
+  const lastShowEventDate = new Date(lastShowEvent.createdAt);
+  if (frequency.frequency === import_types4.Frequency.MULTIPLE) {
+    if (frequency.every.times && dismissedSessions >= frequency.every.times) {
+      return false;
+    }
+  }
+  if (frequency.frequency === import_types4.Frequency.MULTIPLE || frequency.frequency === import_types4.Frequency.UNLIMITED) {
+    if (!isGreaterThenDuration(now, lastShowEventDate, frequency.every.unit, frequency.every.duration)) {
+      return false;
+    }
+  }
+  return true;
+};
+var parseUrlParams = (url, paramName) => {
+  if (!url || !paramName) {
+    return null;
+  }
+  try {
+    const urlObj = new URL(url);
+    const searchParams = new URLSearchParams(urlObj.search);
+    if (searchParams.has(paramName)) {
+      return searchParams.get(paramName);
+    }
+    if (urlObj.hash) {
+      const hashSearch = urlObj.hash.split("?")[1];
+      if (hashSearch) {
+        const hashParams = new URLSearchParams(hashSearch);
+        if (hashParams.has(paramName)) {
+          return hashParams.get(paramName);
+        }
+      }
+    }
+    return null;
+  } catch (error) {
+    console.error("Error parsing URL:", error);
+    return null;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AbortController,
   ArrayProto,
   XMLHttpRequest,
   absoluteUrl,
+  activedContentRulesConditions,
   assignableWindow,
   autoStartConditions,
   buildConfig,
+  checklistIsDimissed,
+  checklistIsSeen,
   cn,
   conditionsIsSame,
   convertSettings,
@@ -1106,6 +1435,9 @@ var getRandomColor = () => {
   document,
   evalCode,
   fetch,
+  filterAutoStartContent,
+  flowIsDismissed,
+  flowIsSeen,
   formatDate,
   generateAutoStateColors,
   getAuthToken,
@@ -1128,6 +1460,7 @@ var getRandomColor = () => {
   hexToHSLString,
   hexToRGBStr,
   hexToRgb,
+  isActiveRulesByCurrentTime,
   isArray,
   isBoolean,
   isDark,
@@ -1150,12 +1483,14 @@ var getRandomColor = () => {
   isUint8Array,
   isUndefined,
   isUrl,
+  isValidContent,
   isValidSelector,
   location,
   mergeThemeDefaultSettings,
   nativeForEach,
   nativeIndexOf,
   navigator,
+  parseUrlParams,
   removeAuthToken,
   setAuthToken,
   storage,

package/dist/index.d.cts

@@ -11,6 +11,7 @@ export { isPublishedAtLeastOneEnvironment, isPublishedInAllEnvironments } from '
 export { deepClone } from './utils.cjs';
 export { generateAutoStateColors, hexToHSLString, hexToRGBStr } from './color.cjs';
 export { absoluteUrl, cn, cuid, evalCode, formatDate, getRandomColor, hexToRgb, isDark, uuidV4 } from './helper.cjs';
+export { activedContentRulesConditions, checklistIsDimissed, checklistIsSeen, filterAutoStartContent, flowIsDismissed, flowIsSeen, isActiveRulesByCurrentTime, isValidContent, parseUrlParams } from './conditions.cjs';
 export { default as isEqual } from 'fast-deep-equal';
 import '@usertour/types';
 import './storage.cjs';

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export { isPublishedAtLeastOneEnvironment, isPublishedInAllEnvironments } from '
 export { deepClone } from './utils.js';
 export { generateAutoStateColors, hexToHSLString, hexToRGBStr } from './color.js';
 export { absoluteUrl, cn, cuid, evalCode, formatDate, getRandomColor, hexToRgb, isDark, uuidV4 } from './helper.js';
+export { activedContentRulesConditions, checklistIsDimissed, checklistIsSeen, filterAutoStartContent, flowIsDismissed, flowIsSeen, isActiveRulesByCurrentTime, isValidContent, parseUrlParams } from './conditions.js';
 export { default as isEqual } from 'fast-deep-equal';
 import '@usertour/types';
 import './storage.js';

package/dist/index.js

@@ -25,6 +25,31 @@ import {
   storage
 } from "./chunk-FGFMTWFT.js";
 import "./chunk-3ZGH3NRU.js";
+import {
+  AbortController,
+  ArrayProto,
+  XMLHttpRequest,
+  assignableWindow,
+  document,
+  fetch,
+  location,
+  nativeForEach,
+  nativeIndexOf,
+  navigator,
+  userAgent,
+  win
+} from "./chunk-H7VA3ML2.js";
+import {
+  activedContentRulesConditions,
+  checklistIsDimissed,
+  checklistIsSeen,
+  filterAutoStartContent,
+  flowIsDismissed,
+  flowIsSeen,
+  isActiveRulesByCurrentTime,
+  isValidContent,
+  parseUrlParams
+} from "./chunk-SYVTGB2A.js";
 import {
   conditionsIsSame,
   isEqual,
@@ -85,29 +110,18 @@ import {
   hasError,
   isValidSelector
 } from "./chunk-G5P7KULU.js";
-import {
-  AbortController,
-  ArrayProto,
-  XMLHttpRequest,
-  assignableWindow,
-  document,
-  fetch,
-  location,
-  nativeForEach,
-  nativeIndexOf,
-  navigator,
-  userAgent,
-  win
-} from "./chunk-H7VA3ML2.js";
 import "./chunk-XEO3YXBM.js";
 export {
   AbortController,
   ArrayProto,
   XMLHttpRequest,
   absoluteUrl,
+  activedContentRulesConditions,
   assignableWindow,
   autoStartConditions,
   buildConfig,
+  checklistIsDimissed,
+  checklistIsSeen,
   cn,
   conditionsIsSame,
   convertSettings,
@@ -119,6 +133,9 @@ export {
   document,
   evalCode,
   fetch,
+  filterAutoStartContent,
+  flowIsDismissed,
+  flowIsSeen,
   formatDate,
   generateAutoStateColors,
   getAuthToken,
@@ -141,6 +158,7 @@ export {
   hexToHSLString,
   hexToRGBStr,
   hexToRgb,
+  isActiveRulesByCurrentTime,
   isArray,
   isBoolean,
   isDark,
@@ -163,12 +181,14 @@ export {
   isUint8Array,
   isUndefined,
   isUrl,
+  isValidContent,
   isValidSelector,
   location,
   mergeThemeDefaultSettings,
   nativeForEach,
   nativeIndexOf,
   navigator,
+  parseUrlParams,
   removeAuthToken,
   setAuthToken,
   storage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usertour/helpers",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "description": "Utility functions and helpers shared across the UserTour project",
   "homepage": "https://www.usertour.io",
@@ -26,7 +26,7 @@
     "prepublishOnly": "pnpm build"
   },
   "dependencies": {
-    "@usertour/types": "^0.0.4",
+    "@usertour/types": "^0.0.6",
     "fast-deep-equal": "^3.1.3",
     "chroma-js": "^3.1.2",
     "deepmerge-ts": "^7.1.3",
@@ -34,6 +34,7 @@
     "class-variance-authority": "^0.4.0",
     "clsx": "^1.2.1",
     "tailwind-merge": "^1.13.2",
+    "date-fns": "^2.30.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {