@convertcom/js-sdk-rules 2.1.0 → 2.1.3

package/lib/utils/src/string-utils.d.ts

@@ -18,3 +18,15 @@ export declare function camelCase(input: string): string;
  * @return {number}
  */
 export declare function generateHash(value: string, seed?: number): number;
+/**
+ * Check if a value is numeric
+ * @param {string | number} value
+ * @returns {boolean}
+ */
+export declare function isNumeric(value: string | number): boolean;
+/**
+ * Convert a string to a number
+ * @param {string | number} value
+ * @returns {number}
+ */
+export declare function toNumber(value: string | number): number;

package/package.json

@@ -69,11 +69,11 @@
     "typescript-eslint": "^7.13.1",
     "webpack": "^5.92.0"
   },
-  "version": "2.1.0",
+  "version": "2.1.3",
   "peerDependencies": {
-    "@convertcom/js-sdk-enums": ">=2.2.0",
-    "@convertcom/js-sdk-logger": ">=2.1.0",
-    "@convertcom/js-sdk-types": ">=3.4.0",
-    "@convertcom/js-sdk-utils": ">=2.1.0"
+    "@convertcom/js-sdk-enums": ">=2.3.0",
+    "@convertcom/js-sdk-logger": ">=2.1.2",
+    "@convertcom/js-sdk-types": ">=3.9.0",
+    "@convertcom/js-sdk-utils": ">=2.2.3"
   }
 }

package/lib/types/src/config/models/Base64Image.d.ts

@@ -1,6 +0,0 @@
-export type Base64Image = {
-    /**
-     * Image's content, base64 encoded
-     */
-    data?: string;
-};

package/lib/types/src/config/models/BaseMatch.d.ts

@@ -1,8 +0,0 @@
-export type BaseMatch = {
-    /**
-     * When true, the rule result is gonna be negated.
-     * example: `url contains "test"` with *negated* = true becomes `url does not contain "test"`
-     *
-     */
-    negated?: boolean;
-};

package/lib/types/src/config/models/BaseRule.d.ts

@@ -1,6 +0,0 @@
-export type BaseRule = {
-    /**
-     * It defines the type of the rule
-     */
-    rule_type: string;
-};

package/lib/types/src/config/models/BaseRuleWithBooleanValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithBooleanValue = (BaseRule & {
-    /**
-     * The value used to match against 'rule_type' using 'matching'
-     */
-    value?: boolean;
-});

package/lib/types/src/config/models/BaseRuleWithBrowserNameValue.d.ts

@@ -1,21 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithBrowserNameValue = (BaseRule & {
-    /**
-     * Browser name used for matching
-     */
-    value?: BaseRuleWithBrowserNameValue.value;
-});
-export declare namespace BaseRuleWithBrowserNameValue {
-    /**
-     * Browser name used for matching
-     */
-    enum value {
-        CHROME = "chrome",
-        MICROSOFT_IE = "microsoft_ie",
-        FIREFOX = "firefox",
-        MICROSOFT_EDGE = "microsoft_edge",
-        MOZILLA = "mozilla",
-        OPERA = "opera",
-        SAFARI = "safari"
-    }
-}

package/lib/types/src/config/models/BaseRuleWithCountryCodeValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithCountryCodeValue = (BaseRule & {
-    /**
-     * The 2 letter ISO country code used for matching
-     */
-    value?: string;
-});

package/lib/types/src/config/models/BaseRuleWithDayOfWeekValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithDayOfWeekValue = (BaseRule & {
-    /**
-     * Day of week used for matching
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithExperienceBucketedValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithExperienceBucketedValue = (BaseRule & {
-    /**
-     * ID of the experience used for matching
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithGoalTriggeredValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithGoalTriggeredValue = (BaseRule & {
-    /**
-     * ID of the goal used for matching
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithHourOfDayValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithHourOfDayValue = (BaseRule & {
-    /**
-     * Hour of day used for matching
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithJsCodeValue.d.ts

@@ -1,9 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithJsCodeValue = (BaseRule & {
-    /**
-     * The JS code that would be executed when rule is checked. The return value of this JS code is what is gonna be matched
-     * against **true**(or **false** if **matching.negated = true** is provided)
-     *
-     */
-    value?: string;
-});

package/lib/types/src/config/models/BaseRuleWithLanguageCodeValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithLanguageCodeValue = (BaseRule & {
-    /**
-     * The 2 letter ISO language code used for matching
-     */
-    value?: string;
-});

package/lib/types/src/config/models/BaseRuleWithMinuteOfHourValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithMinuteOfHourValue = (BaseRule & {
-    /**
-     * Minute of hour used for matching
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithNumericValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithNumericValue = (BaseRule & {
-    /**
-     * The value used to match against 'rule_type' using 'matching'
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithOsValue.d.ts

@@ -1,21 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithOsValue = (BaseRule & {
-    /**
-     * Operating System name used for matching
-     */
-    value?: BaseRuleWithOsValue.value;
-});
-export declare namespace BaseRuleWithOsValue {
-    /**
-     * Operating System name used for matching
-     */
-    enum value {
-        ANDROID = "android",
-        IPHONE = "iphone",
-        IPOD = "ipod",
-        IPAD = "ipad",
-        WINDOWS = "windows",
-        MACOS = "macos",
-        LINUX = "linux"
-    }
-}

package/lib/types/src/config/models/BaseRuleWithSegmentBucketedValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithSegmentBucketedValue = (BaseRule & {
-    /**
-     * ID of the segment used for matching
-     */
-    value?: number;
-});

package/lib/types/src/config/models/BaseRuleWithStringValue.d.ts

@@ -1,7 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithStringValue = (BaseRule & {
-    /**
-     * The value used to match against 'rule_type' using 'matching'
-     */
-    value?: string;
-});

package/lib/types/src/config/models/BaseRuleWithVisitorTypeValue.d.ts

@@ -1,16 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithVisitorTypeValue = (BaseRule & {
-    /**
-     * Type of the visitors
-     */
-    value?: BaseRuleWithVisitorTypeValue.value;
-});
-export declare namespace BaseRuleWithVisitorTypeValue {
-    /**
-     * Type of the visitors
-     */
-    enum value {
-        NEW = "new",
-        RETURNING = "returning"
-    }
-}

package/lib/types/src/config/models/BaseRuleWithWeatherConditionValue.d.ts

@@ -1,34 +0,0 @@
-import type { BaseRule } from './BaseRule';
-export type BaseRuleWithWeatherConditionValue = (BaseRule & {
-    /**
-     * Weather Condition name used for matching. Full or partial condition.
-     * The weather provider used by Convert detects the following conditions:
-     * - Blizzard
-     * - Blowing snow
-     * - Cloudy
-     * - Fog
-     * - Freezing drizzle
-     * - Freezing fog
-     * - Heavy freezing drizzle
-     * - Heavy rain
-     * - Heavy rain at times
-     * - Light drizzle
-     * - Light freezing rain
-     * - Light rain
-     * - Mist
-     * - Moderate rain
-     * - Moderate rain at times
-     * - Overcast
-     * - Partly cloudy
-     * - Patchy freezing drizzle possible
-     * - Patchy light drizzle
-     * - Patchy light rain
-     * - Patchy rain possible
-     * - Patchy sleet possible
-     * - Patchy snow possible
-     * - Sunny
-     * - Thundery outbreaks possible
-     *
-     */
-    value?: string;
-});

package/lib/types/src/config/models/BoolMatchRulesTypes.d.ts

@@ -1,6 +0,0 @@
-export declare enum BoolMatchRulesTypes {
-    BUCKETED_INTO_EXPERIENCE = "bucketed_into_experience",
-    IS_DESKTOP = "is_desktop",
-    IS_MOBILE = "is_mobile",
-    IS_TABLET = "is_tablet"
-}

package/lib/types/src/config/models/BrowserNameMatchRule.d.ts

@@ -1,10 +0,0 @@
-import type { BaseMatch } from './BaseMatch';
-import type { BaseRuleWithBrowserNameValue } from './BaseRuleWithBrowserNameValue';
-import type { BrowserNameMatchRulesTypes } from './BrowserNameMatchRulesTypes';
-import type { ChoiceMatchingOptions } from './ChoiceMatchingOptions';
-export type BrowserNameMatchRule = (BaseRuleWithBrowserNameValue & {
-    rule_type: BrowserNameMatchRulesTypes;
-    matching?: (BaseMatch & {
-        match_type?: ChoiceMatchingOptions;
-    });
-});

package/lib/types/src/config/models/BrowserNameMatchRulesTypes.d.ts

@@ -1,3 +0,0 @@
-export declare enum BrowserNameMatchRulesTypes {
-    BROWSER_NAME = "browser_name"
-}

package/lib/types/src/config/models/BucketingEvent.d.ts

@@ -1,15 +0,0 @@
-/**
- * Bucketing event data
- */
-export type BucketingEvent = {
-    /**
-     * Experience ID to which the visitor is bucketed. In case that **enrichData=true** flag is being sent, only unique events are gonna be recorded. Otherwise, it's
-     * up to the client to ensure that duplicates of the same event for the same visitor do not get sent to the tracking endpoint.
-     *
-     */
-    experienceId: string;
-    /**
-     * Variation ID corresponding to the experience identified by experienceID, that is assigned to the visitor.
-     */
-    variationId: string;
-};

package/lib/types/src/config/models/ChoiceContainsOptions.d.ts

@@ -1,3 +0,0 @@
-export declare enum ChoiceContainsOptions {
-    CONTAINS = "contains"
-}

package/lib/types/src/config/models/ChoiceMatchingOptions.d.ts

@@ -1,3 +0,0 @@
-export declare enum ChoiceMatchingOptions {
-    EQUALS = "equals"
-}

package/lib/types/src/config/models/ClicksElementGoal.d.ts

@@ -1,11 +0,0 @@
-import type { ClicksElementGoalSettings } from './ClicksElementGoalSettings';
-import type { ConfigGoalBase } from './ConfigGoalBase';
-export type ClicksElementGoal = (ConfigGoalBase & {
-    type?: ClicksElementGoal.type;
-    settings?: ClicksElementGoalSettings;
-});
-export declare namespace ClicksElementGoal {
-    enum type {
-        CLICKS_ELEMENT = "clicks_element"
-    }
-}

package/lib/types/src/config/models/ClicksElementGoalSettings.d.ts

@@ -1,6 +0,0 @@
-export type ClicksElementGoalSettings = {
-    /**
-     * Css selector that identifies the DOM element(s) on which will track clicks in order to fire the goal.
-     */
-    selector: string;
-};

package/lib/types/src/config/models/ClicksLinkGoal.d.ts

@@ -1,11 +0,0 @@
-import type { ClicksLinkGoalSettings } from './ClicksLinkGoalSettings';
-import type { ConfigGoalBase } from './ConfigGoalBase';
-export type ClicksLinkGoal = (ConfigGoalBase & {
-    type?: ClicksLinkGoal.type;
-    settings?: ClicksLinkGoalSettings;
-});
-export declare namespace ClicksLinkGoal {
-    enum type {
-        CLICKS_LINK = "clicks_link"
-    }
-}

package/lib/types/src/config/models/ClicksLinkGoalSettings.d.ts

@@ -1,6 +0,0 @@
-export type ClicksLinkGoalSettings = {
-    /**
-     * Url representing link's href attribute used to identify links which will be tracked for click event
-     */
-    href: string;
-};

package/lib/types/src/config/models/ConfigAudience.d.ts

@@ -1,21 +0,0 @@
-import type { ConfigAudienceTypes } from './ConfigAudienceTypes';
-import type { RuleObject } from './RuleObject';
-/**
- * Base Audience object
- */
-export type ConfigAudience = {
-    /**
-     * Audience ID
-     */
-    id?: string;
-    /**
-     * Audience unique key
-     */
-    key?: string;
-    /**
-     * Audience Name
-     */
-    name?: string;
-    type?: ConfigAudienceTypes;
-    rules?: RuleObject | null;
-};

package/lib/types/src/config/models/ConfigAudienceTypes.d.ts

@@ -1,10 +0,0 @@
-/**
- * Type of the Audience. Can be one of the following: `permanent`, `transient`. For full-stack projects, `transient` is the only valid option, the rest will be ignored.
- * * **permanent** - A permanent audience is one that is checked only at the time the user is being bucketed into the experience
- * * **transient** - A transient audience is one that is checked every time the user is being bucketed into the experience
- *
- */
-export declare enum ConfigAudienceTypes {
-    PERMANENT = "permanent",
-    TRANSIENT = "transient"
-}

package/lib/types/src/config/models/ConfigExperience.d.ts

@@ -1,98 +0,0 @@
-import type { ExperienceIntegrationBaidu } from './ExperienceIntegrationBaidu';
-import type { ExperienceIntegrationClicktale } from './ExperienceIntegrationClicktale';
-import type { ExperienceIntegrationClicky } from './ExperienceIntegrationClicky';
-import type { ExperienceIntegrationCnzz } from './ExperienceIntegrationCnzz';
-import type { ExperienceIntegrationCrazyegg } from './ExperienceIntegrationCrazyegg';
-import type { ExperienceIntegrationEconda } from './ExperienceIntegrationEconda';
-import type { ExperienceIntegrationEulerian } from './ExperienceIntegrationEulerian';
-import type { ExperienceIntegrationGAServing } from './ExperienceIntegrationGAServing';
-import type { ExperienceIntegrationGosquared } from './ExperienceIntegrationGosquared';
-import type { ExperienceIntegrationHeapanalytics } from './ExperienceIntegrationHeapanalytics';
-import type { ExperienceIntegrationHotjar } from './ExperienceIntegrationHotjar';
-import type { ExperienceIntegrationMixpanel } from './ExperienceIntegrationMixpanel';
-import type { ExperienceIntegrationMouseflow } from './ExperienceIntegrationMouseflow';
-import type { ExperienceIntegrationPiwik } from './ExperienceIntegrationPiwik';
-import type { ExperienceIntegrationSegmentio } from './ExperienceIntegrationSegmentio';
-import type { ExperienceIntegrationSitecatalyst } from './ExperienceIntegrationSitecatalyst';
-import type { ExperienceIntegrationWoopra } from './ExperienceIntegrationWoopra';
-import type { ExperienceIntegrationYsance } from './ExperienceIntegrationYsance';
-import type { ExperienceTypes } from './ExperienceTypes';
-import type { ExperienceVariationConfig } from './ExperienceVariationConfig';
-import type { RuleObject } from './RuleObject';
-export type ConfigExperience = {
-    /**
-     * Experience ID
-     */
-    id?: string;
-    /**
-     * Experience Name
-     */
-    name?: string;
-    /**
-     * Experience readable key that uniquely identifies this experience
-     */
-    key?: string;
-    /**
-     * List of locations IDs on which this experience is presented. Either this or **site_area** is given but should not be both.
-     */
-    locations?: Array<string> | null;
-    /**
-     * Rules that define where the experience is gonna run. Either this or **locations** is given but should not be both.
-     */
-    site_area?: RuleObject | null;
-    /**
-     * List of audiences IDs to which this experience is presented to
-     */
-    audiences?: Array<string> | null;
-    /**
-     * List of goals IDs to which will be tracked for this experience
-     */
-    goals?: Array<string>;
-    /**
-     * Global Experience's JavaScript that will run for this experience before its changes are applied
-     *
-     */
-    global_js?: string;
-    /**
-     * Global Experience's StyleSheet that will run for this experience before its changes are applied
-     *
-     */
-    global_css?: string;
-    type?: ExperienceTypes;
-    /**
-     * Experience's version number
-     */
-    version?: number;
-    /**
-     * Experience's variations list
-     */
-    variations?: Array<ExperienceVariationConfig>;
-    /**
-     * List of integrations that this experience's data is sent to
-     */
-    integrations?: Array<(ExperienceIntegrationBaidu | ExperienceIntegrationClicktale | ExperienceIntegrationClicky | ExperienceIntegrationCnzz | ExperienceIntegrationCrazyegg | ExperienceIntegrationEconda | ExperienceIntegrationEulerian | ExperienceIntegrationGAServing | ExperienceIntegrationGosquared | ExperienceIntegrationHeapanalytics | ExperienceIntegrationHotjar | ExperienceIntegrationMixpanel | ExperienceIntegrationMouseflow | ExperienceIntegrationPiwik | ExperienceIntegrationSegmentio | ExperienceIntegrationSitecatalyst | ExperienceIntegrationWoopra | ExperienceIntegrationYsance)>;
-    /**
-     * List of environments that this experience is supposed to run on. The full list of available environments is defined at
-     * project level. If this list is empty, the experience will run on all environments.
-     *
-     * @deprecated
-     */
-    environments?: Array<string>;
-    /**
-     * The environment where this experience will run. It has to be one of the environments defined at the project level
-     */
-    environment?: string;
-    /**
-     * Various experience's settings
-     */
-    settings?: {
-        /**
-         * Minimum order value for transactions outliers
-         */
-        min_order_value?: number;
-        /**
-         * Maximum order value for transactions outliers
-         */
-        max_order_value?: number;
-    };
-};

package/lib/types/src/config/models/ConfigFeature.d.ts

@@ -1,22 +0,0 @@
-import type { FeatureVariableItemData } from './FeatureVariableItemData';
-/**
- * Base Feature Object
- */
-export type ConfigFeature = {
-    /**
-     * Feature ID
-     */
-    id?: string;
-    /**
-     * A name given to the feature to identify it easily
-     */
-    name?: string;
-    /**
-     * A unique per project level identifier
-     */
-    key?: string;
-    /**
-     * An array of user-defined variables of a feature.
-     */
-    variables?: Array<FeatureVariableItemData>;
-};

package/lib/types/src/config/models/ConfigGoal.d.ts

@@ -1,9 +0,0 @@
-import type { ClicksElementGoal } from './ClicksElementGoal';
-import type { ClicksLinkGoal } from './ClicksLinkGoal';
-import type { DomInteractionGoal } from './DomInteractionGoal';
-import type { GaGoal } from './GaGoal';
-import type { NoSettingsGoal } from './NoSettingsGoal';
-import type { RevenueGoal } from './RevenueGoal';
-import type { ScrollPercentageGoal } from './ScrollPercentageGoal';
-import type { SubmitsFormGoal } from './SubmitsFormGoal';
-export type ConfigGoal = (DomInteractionGoal | ScrollPercentageGoal | RevenueGoal | NoSettingsGoal | GaGoal | SubmitsFormGoal | ClicksLinkGoal | ClicksElementGoal);

package/lib/types/src/config/models/ConfigGoalBase.d.ts

@@ -1,24 +0,0 @@
-import type { GoalTypes } from './GoalTypes';
-import type { RuleObject } from './RuleObject';
-/**
- * Goal item to be tracked  inside a project
- */
-export type ConfigGoalBase = {
-    /**
-     * Goal ID
-     */
-    id?: string;
-    /**
-     * Goal Name.
-     */
-    name?: string;
-    /**
-     * Goal Key
-     */
-    key?: string;
-    /**
-     * List of goal types to be returned
-     */
-    type?: Array<GoalTypes>;
-    rules?: RuleObject | null;
-};

package/lib/types/src/config/models/ConfigLocation.d.ts

@@ -1,21 +0,0 @@
-import type { LocationTrigger } from './LocationTrigger';
-import type { RuleObject } from './RuleObject';
-/**
- * Base Location object
- */
-export type ConfigLocation = {
-    /**
-     * Location ID
-     */
-    id?: string;
-    /**
-     * Location unique key
-     */
-    key?: string;
-    /**
-     * Location Name
-     */
-    name?: string;
-    trigger?: (Record<string, any> & LocationTrigger) | null;
-    rules?: RuleObject | null;
-};