@legalplace/wizardx-core 2.6.3 → 2.7.0

package/src/libs/EventsTracking.ts

@@ -1,276 +0,0 @@
-import Cookies from "universal-cookie";
-import Globals from "../Globals";
-
-export type EventsPropsType = Record<
-  string,
-  string | number | boolean | Record<string, string | number | boolean>
->;
-
-const cookie = new Cookies();
-
-class _EventsTracking {
-  private initiated = false;
-
-  private queue: [string, any[]][] = [];
-
-  private queueTimer: ReturnType<typeof setTimeout> | null = null;
-
-  public track(eventName: string, eventProps?: EventsPropsType) {
-    if (!this.initiated) this.init();
-
-    // Mixpanel
-    this.trackMix(eventName, { ...eventProps });
-
-    // Facebook Pixel
-    this.trackFB(eventName, { ...eventProps });
-
-    // Google Analytics
-    this.trackGA(eventName, { ...eventProps });
-
-    // Sendinblue
-    this.trackSIB(eventName, { ...eventProps });
-  }
-
-  public register(props: EventsPropsType) {
-    if (!this.initiated) this.init();
-
-    // Mixpanel
-    this.registerMix(props);
-
-    // Facebook Pixel
-    this.registerFB(props);
-  }
-
-  public trigger(name: string) {
-    if (!this.initiated) this.init();
-
-    // Hotjar
-    this.triggerHj(name);
-  }
-
-  private init() {
-    this.initiated = true;
-    this.register({
-      "WizardX Build Commit":
-        process.env.REACT_APP_COMMIT || "Unkown build commit",
-      Environement: Globals.appEnv,
-      "Powered By": "WizardX",
-      ...this.getXSource(),
-      ...this.getXAbTests(),
-    });
-    this.trigger("wizardx");
-  }
-
-  private getXSource(): Record<string, string> {
-    const xSource = cookie.get("X-Source");
-
-    return typeof xSource === "string" && xSource.trim().length > 0
-      ? {
-          "X-Source": xSource,
-        }
-      : {};
-  }
-
-  private getXAbTests(): Record<string, string> {
-    const xAbTests = cookie.get("X-AbTests");
-
-    if (typeof xAbTests === "object") {
-      const xAbTestsFlattened: Record<string, string> = {};
-
-      Object.keys(xAbTests).forEach((abTestName) => {
-        xAbTestsFlattened[`X-AbTests[${abTestName}]`] = xAbTests[abTestName];
-      });
-
-      return xAbTestsFlattened;
-    }
-
-    return typeof xAbTests === "string" && xAbTests.trim().length > 0
-      ? {
-          "X-AbTests": xAbTests,
-        }
-      : {};
-  }
-
-  /**
-   * Executes events tracking queue
-   */
-  private executeQueue() {
-    for (let i = 0; i < this.queue.length; i += 1) {
-      const currentEvent = this.queue[i];
-      const args = [];
-      const [fnName] = currentEvent;
-      if (currentEvent.length > 1) {
-        for (let x = 0; x < currentEvent[1].length; x += 1)
-          args.push(currentEvent[1][x]);
-
-        args.push(true);
-
-        let fn: (...a: any) => any;
-
-        switch (fnName) {
-          case "trackMix":
-            fn = this.trackMix.bind(this);
-            break;
-          case "trackFB":
-            fn = this.trackFB.bind(this);
-            break;
-          case "trackGA":
-            fn = this.trackGA.bind(this);
-            break;
-          case "trackSIB":
-            fn = this.trackSIB.bind(this);
-            break;
-          case "registerMix":
-            fn = this.registerMix.bind(this);
-            break;
-          case "registerFB":
-            fn = this.registerFB.bind(this);
-            break;
-          case "triggerHj":
-            fn = this.triggerHj.bind(this);
-            break;
-          default:
-            throw new Error(
-              `Unkown function "${fnName}" found on events tracking queue`
-            );
-        }
-
-        // Getting function
-        const result = fn(...args);
-        if (result === true) {
-          this.queue.splice(i, 1);
-        }
-      }
-    }
-  }
-
-  private queueTimeout() {
-    if (this.queueTimer !== null) clearTimeout(this.queueTimer);
-
-    this.queueTimer = setTimeout(() => {
-      this.executeQueue();
-    }, 50);
-  }
-
-  public trackMix(
-    eventName: string,
-    eventProps?: EventsPropsType,
-    doNotPushToQueue = false
-  ) {
-    if (!this.initiated) this.init();
-
-    if (typeof window.mixpanel !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.mixpanel.track(eventName, eventProps);
-      return true;
-    }
-
-    if (doNotPushToQueue === false)
-      this.queue.push(["trackMix", [eventName, eventProps]]);
-
-    this.queueTimeout();
-    return false;
-  }
-
-  public trackSIB(
-    eventName: string,
-    eventProps?: EventsPropsType,
-    doNotPushToQueue = false
-  ) {
-    if (!this.initiated) this.init();
-
-    if (typeof window.sendinblue !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.sendinblue.track(eventName, eventProps);
-      return true;
-    }
-
-    if (doNotPushToQueue === false)
-      this.queue.push(["trackSIB", [eventName, eventProps]]);
-
-    this.queueTimeout();
-    return false;
-  }
-
-  private trackFB(
-    eventName: string,
-    eventProps?: EventsPropsType,
-    doNotPushToQueue = false
-  ) {
-    if (typeof window.fbq !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.fbq("trackCustom", eventName, eventProps);
-      return true;
-    }
-
-    if (doNotPushToQueue === false)
-      this.queue.push(["trackFB", [eventName, eventProps]]);
-
-    this.queueTimeout();
-    return false;
-  }
-
-  private trackGA(
-    eventName: string,
-    eventProps?: EventsPropsType,
-    doNotPushToQueue = false
-  ) {
-    if (typeof window.ga !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.ga(
-        "send",
-        "event",
-        "lpTracking",
-        "track",
-        eventName,
-        1,
-        eventProps
-      );
-      return true;
-    }
-
-    if (doNotPushToQueue === false)
-      this.queue.push(["trackGA", [eventName, eventProps]]);
-
-    this.queueTimeout();
-    return false;
-  }
-
-  private registerMix(props: EventsPropsType, doNotPushToQueue = false) {
-    if (typeof window.mixpanel !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.mixpanel.register(props);
-      return true;
-    }
-    if (doNotPushToQueue === false) this.queue.push(["registerMix", [props]]);
-
-    this.queueTimeout();
-    return false;
-  }
-
-  private registerFB(props: EventsPropsType, doNotPushToQueue = false) {
-    if (typeof window.fbq !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.fbq("trackCustom", "GeneralProps", props);
-      return true;
-    }
-    if (doNotPushToQueue === false) this.queue.push(["registerFB", [props]]);
-
-    this.queueTimeout();
-    return false;
-  }
-
-  private triggerHj(name: string, doNotPushToQueue = false) {
-    if (typeof window.hj !== "undefined") {
-      if (this.queue.length > 0 && !doNotPushToQueue) this.executeQueue();
-      window.hj("trigger", name);
-      return true;
-    }
-    if (doNotPushToQueue === false) this.queue.push(["triggerHj", [name]]);
-
-    this.queueTimeout();
-    return false;
-  }
-}
-
-export const EventsTracking = new _EventsTracking();

package/src/libs/Extracts.ts

@@ -1,159 +0,0 @@
-import type { ExtractV3 } from "@legalplace/models-v3-types";
-import { selectCustomizationMeta } from "../redux/selectors/app";
-import { selectUserEmail } from "../redux/selectors/user";
-import {
-  selectOptionInput,
-  selectVariableInput,
-} from "../redux/selectors/inputs";
-import {
-  selectOptionReference,
-  selectVariableReference,
-} from "../redux/selectors/references";
-import { EventsTracking } from "./EventsTracking";
-
-export interface ExtractObject {
-  name: string;
-  value: string;
-}
-
-class Extracts {
-  private extracts: Readonly<ExtractV3[]> = [];
-
-  private slackExtracts: {
-    [k: string]: ExtractObject[];
-  } = {};
-
-  private sendinblueExtracts: { [k: string]: string } = {};
-
-  private mixpanelExtracts: { [k: string]: string } = {};
-
-  extractData() {
-    const customizationMeta = selectCustomizationMeta();
-    if (
-      !(
-        typeof customizationMeta === "object" &&
-        Array.isArray(customizationMeta.extracts) &&
-        customizationMeta.extracts.length > 0
-      )
-    )
-      return;
-    this.extracts = customizationMeta.extracts;
-    this.prepareExtracts();
-    this.sendSlackMessages();
-    // this.sendSendinblue(); Remove SIB data sent there we send all in the identify
-    this.sendMixpanel();
-  }
-
-  getSibExtractedData() {
-    return this.sendinblueExtracts;
-  }
-
-  private prepareExtracts() {
-    this.extracts.forEach((extract) => {
-      const { id, type, destination } = extract;
-      let inputs: Readonly<string[]>;
-      let defaultName: string;
-
-      // Getting inputs
-      if (type === "option") {
-        inputs = selectOptionInput(id).map((value) =>
-          value === true ? "True" : "False"
-        );
-        defaultName = selectOptionReference(id).meta.label;
-      } else if (type === "variable") {
-        inputs = selectVariableInput(id).map((value) => value.toString());
-        defaultName = selectVariableReference(id, true).label;
-      } else {
-        throw new Error(`Unkown extract type ${type}`);
-      }
-
-      // Making sure default name is never empty
-      defaultName =
-        defaultName.trim().length > 0 ? defaultName : `${type} ${id}`;
-
-      // Joining inputs
-      const value =
-        inputs.length > 1 ? inputs.join(", ").slice(0, -2) : inputs[0];
-
-      // Slack
-      if (
-        typeof destination.slack === "object" &&
-        typeof destination.slack.channel === "string" &&
-        destination.slack.channel.trim().length > 0
-      ) {
-        const { name, channel } = destination.slack;
-
-        if (this.slackExtracts[channel] === undefined)
-          this.slackExtracts[channel] = [];
-
-        this.slackExtracts[channel].push({
-          name: name || defaultName,
-          value,
-        });
-      }
-
-      // Sendinblue
-      if (typeof destination.sendinblue === "object" && value && value.trim()) {
-        const name = destination.sendinblue.name || defaultName;
-
-        this.sendinblueExtracts = {
-          ...this.sendinblueExtracts,
-          [name]: value,
-        };
-      }
-
-      // Mixpanel
-      if (typeof destination.mixpanel === "object") {
-        const name = destination.mixpanel.name || defaultName;
-
-        this.mixpanelExtracts = {
-          ...this.mixpanelExtracts,
-          [name]: value,
-        };
-      }
-    });
-  }
-
-  private sendSlackMessages() {
-    const channels = Object.keys(this.slackExtracts);
-    channels.forEach((currentChannel) => {
-      const text = this.formatSlackMessage(currentChannel);
-      const json = {
-        username: "WizardX Extract Bot",
-        icon_emoji: ":robot_face:",
-        channel: currentChannel,
-        attachments: [
-          {
-            text,
-          },
-        ],
-      };
-
-      // Sending Slack Message
-      fetch(
-        "https://hooks.slack.com/services/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",
-        {
-          body: JSON.stringify(json),
-          method: "POST",
-        }
-      ).catch(async (err) => {
-        throw new Error(err);
-      });
-    });
-  }
-
-  private sendMixpanel() {
-    EventsTracking.trackMix("Variable Extraction", this.mixpanelExtracts);
-  }
-
-  private formatSlackMessage(channel: string) {
-    const lines = [`Email: ${selectUserEmail()}`];
-    this.slackExtracts[channel].forEach((extract) => {
-      const { name, value } = extract;
-      lines.push(`*${name}:* ${value}`);
-    });
-    return lines.join("\n");
-  }
-}
-
-export default new Extracts();

package/src/libs/InputsInitiator.ts

@@ -1,136 +0,0 @@
-import { StateType } from "../types/State.type";
-
-export type OVC_TYPE = {
-  options: {
-    [key: string]: boolean[];
-  };
-  variables: {
-    [key: string]: (number | string)[];
-  };
-};
-export class IntputsInitiator {
-  private inputs: StateType.Inputs = {
-    options: {},
-    variables: {},
-  };
-
-  private references: StateType.References;
-
-  private ovc: OVC_TYPE | null;
-
-  /**
-   * InitalConditions Constructor
-   * @param references References object
-   */
-  constructor(references: StateType.References, ovc: OVC_TYPE | null) {
-    this.references = references;
-    this.ovc = ovc;
-
-    // Setting multiples
-    this.setMultiples();
-
-    // Initiating inputs
-    this.initOptionsInputs();
-    this.initVariablesInputs();
-  }
-
-  public getInputs() {
-    return this.inputs;
-  }
-
-  private setMultiples() {
-    if (this.ovc === null) return;
-    Object.keys(this.ovc.options).forEach((id) => {
-      if (this.ovc === null) return;
-      const inputs = this.ovc.options[id];
-
-      if (inputs.length > 1) {
-        // Getting parents
-        const parentsTree = this.references.relations.options[id].parents;
-
-        // root parent
-        const rootOptionId =
-          parentsTree.length > 0 ? parentsTree[parentsTree.length - 1] : id;
-
-        if (!this.ovc.options[rootOptionId]) {
-          // root Option reference
-          const rootReference = this.references.options[rootOptionId];
-          if (rootReference.meta.type === "static") {
-            this.ovc.options[rootOptionId] = new Array(inputs.length).fill(
-              true
-            );
-          }
-        }
-      }
-    });
-  }
-
-  /**
-   * Initates options inputs
-   */
-  private initOptionsInputs() {
-    // Options
-    const optionsIds = Object.keys(this.references.options);
-    for (let i = 0; i < optionsIds.length; i += 1) {
-      const optionId = optionsIds[i];
-      const option = this.references.options[optionId];
-
-      let values = [false];
-      if (
-        this.ovc &&
-        Object.prototype.hasOwnProperty.call(this.ovc.options, optionId)
-      ) {
-        if (
-          [
-            "static",
-            "hidden",
-            "brut-text",
-            "repeated",
-            "box",
-            "separator",
-          ].includes(option.meta.type)
-        ) {
-          values = new Array(this.ovc.options[optionId].length).fill(true);
-        } else {
-          values = this.ovc.options[optionId];
-        }
-      } else if (
-        [
-          "static",
-          "hidden",
-          "brut-text",
-          "repeated",
-          "box",
-          "separator",
-        ].includes(option.meta.type)
-      ) {
-        values = [true];
-      }
-
-      this.inputs.options[optionId] = values;
-    }
-  }
-
-  /**
-   * Initates variables inputs
-   */
-  private initVariablesInputs() {
-    const variablesIds = Object.keys(this.references.variables);
-    for (let i = 0; i < variablesIds.length; i += 1) {
-      const variableId = variablesIds[i];
-
-      let values: (string | number)[] = [""];
-      if (
-        this.ovc &&
-        Object.prototype.hasOwnProperty.call(this.ovc.variables, variableId)
-      ) {
-        values = this.ovc.variables[variableId];
-      } else {
-        const defaultValue = "";
-        values = [defaultValue];
-      }
-
-      this.inputs.variables[variableId] = values;
-    }
-  }
-}

package/src/libs/NumAuto.test.ts

@@ -1,55 +0,0 @@
-import { NumAuto } from './NumAuto';
-
-describe('NumAuto Test Suit', () => {
-  it('Resets properly', () => {
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(1);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(2);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(3);
-    NumAuto.resetNums();
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(1);
-    NumAuto.resetNums();
-  });
-
-  it('It increments indexes correctly', () => {
-    NumAuto.resetNums();
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(1);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(2);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(1);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(3);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(2);
-  });
-
-  it('It tags properly', () => {
-    NumAuto.resetNums();
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(1);
-    expect(NumAuto.getNum('myTestIndex', 'myTestTag')).toEqual(2);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(3);
-
-    // Getting tag
-    expect(NumAuto.getNumPre('myTestTag', 0, 0)).toEqual(2);
-    expect(NumAuto.getNum('myTestTag', null)).toEqual(2);
-  });
-
-  it('It returns previous indexes correctly', () => {
-    NumAuto.resetNums();
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(1);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(2);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(1);
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(3);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(2);
-
-    // NumPre
-    expect(NumAuto.getNumPre('myTestIndex', 0, 1)).toEqual(3);
-    expect(NumAuto.getNumPre('myOtherTestIndex', 0, 0)).toEqual(2);
-
-    // Incrementing again
-    expect(NumAuto.getNum('myTestIndex', null)).toEqual(4);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(3);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(4);
-    expect(NumAuto.getNum('myOtherTestIndex', null)).toEqual(5);
-
-    // NumPre
-    expect(NumAuto.getNumPre('myTestIndex', 0, 0)).toEqual(4);
-    expect(NumAuto.getNumPre('myOtherTestIndex', 0, 1)).toEqual(5);
-  });
-});

package/src/libs/NumAuto.ts

@@ -1,56 +0,0 @@
-class _NumAuto {
-  numsList: Record<string, any> = {};
-
-  tagsCatalog: Record<string, number> = {};
-
-  /**
-   * Increments the given catalog by 1 and
-   * returns the count
-   * @param catalog Catalog name
-   */
-  getNum = (catalog: string, tag: string | null): number => {
-    // In case the catalog doesn't exist
-    if (!Object.prototype.hasOwnProperty.call(this.numsList, catalog)) {
-      // Let's first make sure it's not a tag and return it if it is
-      if (Object.prototype.hasOwnProperty.call(this.tagsCatalog, catalog))
-        return this.tagsCatalog[catalog];
-
-      // Otherwise we set a new catalog
-      this.numsList[catalog] = 0;
-    }
-
-    this.numsList[catalog] += 1;
-
-    if (typeof tag === "string") this.tagsCatalog[tag] = this.numsList[catalog];
-
-    return this.numsList[catalog];
-  };
-
-  /**
-   * Returns the current count of the given catalog
-   * @param catalog Catalog name
-   */
-  getNumPre = (
-    catalog: string,
-    index: number,
-    siblingsCount: number
-  ): number => {
-    // In case the catalog doesn't exist
-    if (!Object.prototype.hasOwnProperty.call(this.numsList, catalog)) {
-      // Let's first make sure it's not a tag and return it if it is
-      if (Object.prototype.hasOwnProperty.call(this.tagsCatalog, catalog))
-        return siblingsCount > 0
-          ? this.tagsCatalog[catalog] - (siblingsCount - (index + 1))
-          : this.tagsCatalog[catalog];
-    }
-    return siblingsCount > 0
-      ? this.numsList[catalog] - (siblingsCount - (index + 1))
-      : this.numsList[catalog];
-  };
-
-  resetNums = () => {
-    this.numsList = {};
-  };
-}
-
-export const NumAuto = new _NumAuto();