@convertcom/js-sdk-rules 1.0.2 → 2.1.0

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

@@ -0,0 +1,39 @@
+import type { VisitorSegments } from './VisitorSegments';
+import type { VisitorTrackingEvents } from './VisitorTrackingEvents';
+/**
+ * Tracking Request's data
+ */
+export type SendTrackingEventsRequestData = {
+    /**
+     * ID of the account under which the project is setup
+     */
+    accountId?: string;
+    /**
+     * ID of the project under which the tracking occurs
+     */
+    projectId?: string;
+    /**
+     * Flag to determine whether the data is gonna be enriched before the events are stored for reporting.
+     * For example, in case of a conversion event, if this flag is on and bucketing is not provided, the bucketing stored on the backend datastore for the given visitor
+     * ID would be used. Same applies for segments.
+     *
+     * *Note*: this flag is only available for some plans
+     *
+     */
+    enrichData?: boolean;
+    /**
+     * List of visitors tracked. Each visitor can have multiple events.
+     *
+     */
+    visitors?: Array<{
+        segments?: VisitorSegments;
+        /**
+         * Id of the visitor tracked
+         */
+        visitorId?: string;
+        /**
+         * List of events fired for the given visitor
+         */
+        events?: Array<VisitorTrackingEvents>;
+    }>;
+};

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

@@ -0,0 +1,3 @@
+export declare enum SetMatchingOptions {
+    IS_IN = "isIn"
+}

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

@@ -0,0 +1,21 @@
+export type SortDirection = {
+    /**
+     * Data sorting direction using "sort_by" field. "asc" for ascending direction, "desc" for descending direction
+     *
+     * Defaults to **desc** when not sent in a request
+     *
+     */
+    sort_direction?: SortDirection.sort_direction | null;
+};
+export declare namespace SortDirection {
+    /**
+     * Data sorting direction using "sort_by" field. "asc" for ascending direction, "desc" for descending direction
+     *
+     * Defaults to **desc** when not sent in a request
+     *
+     */
+    enum sort_direction {
+        ASC = "asc",
+        DESC = "desc"
+    }
+}

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

@@ -0,0 +1,11 @@
+import type { ConfigGoalBase } from './ConfigGoalBase';
+import type { SubmitsFormGoalSettings } from './SubmitsFormGoalSettings';
+export type SubmitsFormGoal = (ConfigGoalBase & {
+    type?: SubmitsFormGoal.type;
+    settings?: SubmitsFormGoalSettings;
+});
+export declare namespace SubmitsFormGoal {
+    enum type {
+        SUBMITS_FORM = "submits_form"
+    }
+}

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

@@ -0,0 +1,6 @@
+export type SubmitsFormGoalSettings = {
+    /**
+     * Url representing form's action attribute used to identify forms which will be tracked for submit event.
+     */
+    action: string;
+};

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

@@ -0,0 +1,4 @@
+export type SuccessData = {
+    code?: number;
+    message?: string;
+};

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

@@ -0,0 +1,23 @@
+export declare enum TextMatchRulesTypes {
+    URL = "url",
+    URL_WITH_QUERY = "url_with_query",
+    QUERY_STRING = "query_string",
+    CAMPAIGN = "campaign",
+    KEYWORD = "keyword",
+    MEDIUM = "medium",
+    SOURCE_NAME = "source_name",
+    CITY = "city",
+    REGION = "region",
+    BROWSER_VERSION = "browser_version",
+    USER_AGENT = "user_agent",
+    PAGE_TAG_PAGE_TYPE = "page_tag_page_type",
+    PAGE_TAG_CATEGORY_ID = "page_tag_category_id",
+    PAGE_TAG_CATEGORY_NAME = "page_tag_category_name",
+    PAGE_TAG_PRODUCT_SKU = "page_tag_product_sku",
+    PAGE_TAG_PRODUCT_NAME = "page_tag_product_name",
+    PAGE_TAG_CUSTOMER_ID = "page_tag_customer_id",
+    PAGE_TAG_CUSTOM_1 = "page_tag_custom_1",
+    PAGE_TAG_CUSTOM_2 = "page_tag_custom_2",
+    PAGE_TAG_CUSTOM_3 = "page_tag_custom_3",
+    PAGE_TAG_CUSTOM_4 = "page_tag_custom_4"
+}

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

@@ -0,0 +1,7 @@
+export declare enum TextMatchingOptions {
+    MATCHES = "matches",
+    REGEX_MATCHES = "regexMatches",
+    CONTAINS = "contains",
+    ENDS_WITH = "endsWith",
+    STARTS_WITH = "startsWith"
+}

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

@@ -0,0 +1,4 @@
+/**
+ * Offset in seconds, from UTC time, for the give timezone
+ */
+export type UTC_Offset = number;

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

@@ -0,0 +1,2 @@
+import type { ExperienceChangeAdd } from './ExperienceChangeAdd';
+export type UpdateExperienceChangeRequestData = ExperienceChangeAdd;

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

@@ -0,0 +1,7 @@
+/**
+ * Variation status
+ */
+export declare enum VariationStatuses {
+    STOPPED = "stopped",
+    RUNNING = "running"
+}

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

@@ -0,0 +1,78 @@
+/**
+ * Segments under which this visitor is placed. Some defaults keys are accepted and any other free field **key value** could be used
+ * for fullstack projects
+ *
+ */
+export type VisitorSegments = {
+    /**
+     * Browser used:
+     * IE - Internet Explorer
+     * CH - Chrome
+     * FF - Firefox
+     * OP - Opera
+     * SF - Safari
+     * OTH - Other
+     *
+     */
+    browser?: VisitorSegments.browser;
+    /**
+     * List of device classes that the visitor device falls into
+     */
+    devices?: Array<'ALLPH' | 'IPH' | 'OTHPH' | 'ALLTAB' | 'IPAD' | 'OTHTAB' | 'DESK' | 'OTHDEV'>;
+    /**
+     * Traffic source
+     */
+    source?: VisitorSegments.source;
+    /**
+     * Campaign string
+     */
+    campaign?: string;
+    /**
+     * Type of the visitor
+     */
+    visitorType?: VisitorSegments.visitorType;
+    /**
+     * Two ISO country code for visitor's country
+     */
+    country?: string;
+    /**
+     * Custom Segments as defined inside Convert app. This will be the list of segments' IDs
+     */
+    customSegments?: Array<string>;
+};
+export declare namespace VisitorSegments {
+    /**
+     * Browser used:
+     * IE - Internet Explorer
+     * CH - Chrome
+     * FF - Firefox
+     * OP - Opera
+     * SF - Safari
+     * OTH - Other
+     *
+     */
+    enum browser {
+        IE = "IE",
+        CH = "CH",
+        FF = "FF",
+        OP = "OP",
+        SF = "SF",
+        OTH = "OTH"
+    }
+    /**
+     * Traffic source
+     */
+    enum source {
+        CAMPAIGN = "campaign",
+        SEARCH = "search",
+        REFERRAL = "referral",
+        DIRECT = "direct"
+    }
+    /**
+     * Type of the visitor
+     */
+    enum visitorType {
+        NEW = "new",
+        RETURNING = "returning"
+    }
+}

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

@@ -0,0 +1,21 @@
+import type { BucketingEvent } from './BucketingEvent';
+import type { ConversionEvent } from './ConversionEvent';
+/**
+ * Tracking events related to the same user ID
+ */
+export type VisitorTrackingEvents = {
+    /**
+     * Type of the event. It can be a bucketing or a conversion event
+     */
+    eventType?: VisitorTrackingEvents.eventType;
+    data?: (BucketingEvent | ConversionEvent);
+};
+export declare namespace VisitorTrackingEvents {
+    /**
+     * Type of the event. It can be a bucketing or a conversion event
+     */
+    enum eventType {
+        BUCKETING = "bucketing",
+        CONVERSION = "conversion"
+    }
+}

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

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

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

@@ -0,0 +1,3 @@
+export declare enum VisitorTypeMatchRulesTypes {
+    VISITOR_TYPE = "visitor_type"
+}

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

@@ -0,0 +1,10 @@
+import type { BaseMatch } from './BaseMatch';
+import type { BaseRuleWithWeatherConditionValue } from './BaseRuleWithWeatherConditionValue';
+import type { TextMatchingOptions } from './TextMatchingOptions';
+import type { WeatherConditionMatchRulesTypes } from './WeatherConditionMatchRulesTypes';
+export type WeatherConditionMatchRule = (BaseRuleWithWeatherConditionValue & {
+    rule_type: WeatherConditionMatchRulesTypes;
+    matching?: (BaseMatch & {
+        match_type?: TextMatchingOptions;
+    });
+});

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

@@ -0,0 +1,3 @@
+export declare enum WeatherConditionMatchRulesTypes {
+    WEATHER_CONDITION = "weather_condition"
+}

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

@@ -0,0 +1,30 @@
+/**
+ * Weather Conditions
+ */
+export declare enum WeatherConditions {
+    BLIZZARD = "Blizzard",
+    BLOWING_SNOW = "Blowing snow",
+    CLOUDY = "Cloudy",
+    FOG = "Fog",
+    FREEZING_DRIZZLE = "Freezing drizzle",
+    FREEZING_FOG = "Freezing fog",
+    HEAVY_FREEZING_DRIZZLE = "Heavy freezing drizzle",
+    HEAVY_RAIN = "Heavy rain",
+    HEAVY_RAIN_AT_TIMES = "Heavy rain at times",
+    LIGHT_DRIZZLE = "Light drizzle",
+    LIGHT_FREEZING_RAIN = "Light freezing rain",
+    LIGHT_RAIN = "Light rain",
+    MIST = "Mist",
+    MODERATE_RAIN = "Moderate rain",
+    MODERATE_RAIN_AT_TIMES = "Moderate rain at times",
+    OVERCAST = "Overcast",
+    PARTLY_CLOUDY = "Partly cloudy",
+    PATCHY_FREEZING_DRIZZLE_POSSIBLE = "Patchy freezing drizzle possible",
+    PATCHY_LIGHT_DRIZZLE = "Patchy light drizzle",
+    PATCHY_LIGHT_RAIN = "Patchy light rain",
+    PATCHY_RAIN_POSSIBLE = "Patchy rain possible",
+    PATCHY_SLEET_POSSIBLE = "Patchy sleet possible",
+    PATCHY_SNOW_POSSIBLE = "Patchy snow possible",
+    SUNNY = "Sunny",
+    THUNDERY_OUTBREAKS_POSSIBLE = "Thundery outbreaks possible"
+}

package/lib/utils/index.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Convert JS SDK test
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export * from './src/array-utils';
+export * from './src/comparisons';
+export * from './src/data-store';
+export * from './src/file-logger';
+export * from './src/http-client';
+export * from './src/object-utils';
+export * from './src/string-utils';
+export * from './src/types-utils';

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

@@ -0,0 +1,11 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Validates variable is array and not empty
+ * @param array
+ */
+export declare function arrayNotEmpty(array: Array<unknown>): boolean;

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

@@ -0,0 +1,22 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Comparison Processor. Provides comparison methods for rules validation
+ */
+export declare class Comparisons {
+    static equals(value: string | number | boolean | Array<string | number | boolean> | Record<string, string | number | boolean>, testAgainst: string | number | boolean, negation?: boolean): boolean;
+    static equalsNumber: typeof Comparisons.equals;
+    static matches: typeof Comparisons.equals;
+    static less(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static lessEqual(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static contains(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static isIn(values: string | number, testAgainst: Array<string | number> | string, negation?: boolean, splitter?: string): boolean;
+    static startsWith(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static endsWith(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static regexMatches(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    private static _returnNegationCheck;
+}

package/lib/utils/src/data-store.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Example of Data Store implementation with simple database Based JSON file.
+ * It's not recommended to use it in production as it can be memory and CPU intensive.
+ * @param {string} file
+ * @param {module} fs
+ */
+declare class DataStore {
+    private _file;
+    private _fs;
+    /**
+     * @param {string} file
+     * @param {module} fs
+     */
+    constructor(file: string, fs: any);
+    /**
+     * Get value by key
+     * @param {string} key
+     * @return {any}
+     */
+    get(key: string): any;
+    /**
+     * Store value by key
+     * @param {string} key
+     * @param {any} value
+     */
+    set(key: string, value: any): void;
+    /**
+     * Delete value by key
+     * @param {string} key
+     */
+    delete(key: string): void;
+}
+export { DataStore };

package/lib/utils/src/file-logger.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @param {string} file
+ * @param {module} fs
+ * @param {string=} appendMethod Defaults to 'appendFileSync'
+ * @example new FileLogger('./convert.log', require('fs'), 'appendFileSync')
+ * @constructor
+ */
+declare class FileLogger {
+    private _file;
+    private _fs;
+    private _appendMethod;
+    /**
+     * @param {string} file
+     * @param {module} fs
+     * @param {string=} appendMethod
+     */
+    constructor(file: string, fs: any, appendMethod?: string);
+    private _write;
+    /**
+     * @param {Array<any>} args
+     */
+    log(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    info(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    debug(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    warn(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    error(...args: any): Promise<void>;
+}
+export { FileLogger };

package/lib/utils/src/http-client.d.ts

@@ -0,0 +1,115 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+export type HttpMethod = 'GET' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH';
+export type HttpResponseType = 'json' | 'arraybuffer' | 'text';
+export type HttpRequest = {
+    baseURL: string;
+    path?: string;
+    method?: HttpMethod;
+    headers?: {
+        [x: string]: any;
+    };
+    responseType?: HttpResponseType;
+    data?: Record<string, any>;
+};
+declare enum HttpStatusCode {
+    Continue = 100,
+    SwitchingProtocols = 101,
+    Processing = 102,
+    EarlyHints = 103,
+    Ok = 200,
+    Created = 201,
+    Accepted = 202,
+    NonAuthoritativeInformation = 203,
+    NoContent = 204,
+    ResetContent = 205,
+    PartialContent = 206,
+    MultiStatus = 207,
+    AlreadyReported = 208,
+    ImUsed = 226,
+    MultipleChoices = 300,
+    MovedPermanently = 301,
+    Found = 302,
+    SeeOther = 303,
+    NotModified = 304,
+    UseProxy = 305,
+    Unused = 306,
+    TemporaryRedirect = 307,
+    PermanentRedirect = 308,
+    BadRequest = 400,
+    Unauthorized = 401,
+    PaymentRequired = 402,
+    Forbidden = 403,
+    NotFound = 404,
+    MethodNotAllowed = 405,
+    NotAcceptable = 406,
+    ProxyAuthenticationRequired = 407,
+    RequestTimeout = 408,
+    Conflict = 409,
+    Gone = 410,
+    LengthRequired = 411,
+    PreconditionFailed = 412,
+    PayloadTooLarge = 413,
+    UriTooLong = 414,
+    UnsupportedMediaType = 415,
+    RangeNotSatisfiable = 416,
+    ExpectationFailed = 417,
+    ImATeapot = 418,
+    MisdirectedRequest = 421,
+    UnprocessableEntity = 422,
+    Locked = 423,
+    FailedDependency = 424,
+    TooEarly = 425,
+    UpgradeRequired = 426,
+    PreconditionRequired = 428,
+    TooManyRequests = 429,
+    RequestHeaderFieldsTooLarge = 431,
+    UnavailableForLegalReasons = 451,
+    InternalServerError = 500,
+    NotImplemented = 501,
+    BadGateway = 502,
+    ServiceUnavailable = 503,
+    GatewayTimeout = 504,
+    HttpVersionNotSupported = 505,
+    VariantAlsoNegotiates = 506,
+    InsufficientStorage = 507,
+    LoopDetected = 508,
+    NotExtended = 510,
+    NetworkAuthenticationRequired = 511
+}
+export type HttpResponse = {
+    data: any;
+    status: HttpStatusCode;
+    statusText: string;
+    headers?: {
+        [x: string]: any;
+    };
+};
+interface HttpClientInterface {
+    request(config: HttpRequest): Promise<HttpResponse>;
+}
+type RuntimeResult = {
+    runtime: 'browser' | 'server-with-fetch' | 'unknown';
+} | {
+    runtime: 'old-nodejs';
+    url: typeof import('url');
+    http: typeof import('http');
+    https: typeof import('https');
+    queryString: typeof import('querystring');
+};
+export declare const serialize: (params: Record<string, any>, method: string, runtimeResult: RuntimeResult) => string;
+/**
+ * Provide http client for newtork requests
+ * @param {HttpRequest}
+ * @returns {HttpClient}
+ */
+export declare const HttpClient: HttpClientInterface;
+export {};

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

@@ -0,0 +1,35 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Returns the value at path of object
+ * TODO: get this utility to work with the optional mapper() helper from config
+ * @param {Record<string, any>} object
+ * @param {string} path
+ * @param {any=} defaultValue
+ * @param {boolean=} truthy Should Number 0 number and Boolean false be considered as normal value
+ * @return {any}
+ */
+export declare function objectDeepValue(object: Record<string, any>, path: string, defaultValue?: any, truthy?: boolean): any;
+/**
+ * Deep merge objects and their keys and nested objects
+ * Accepts arrays
+ *
+ * @param {...Record<any, any>} objects Objects to merge
+ * @return {Record<any, any>}
+ */
+export declare function objectDeepMerge(...objects: any[]): any;
+/**
+ * Validates variable is object and not empty
+ * @param object
+ */
+export declare function objectNotEmpty(object: any): boolean;
+/**
+ * Compare two objects
+ * @param a
+ * @param b
+ */
+export declare const objectDeepEqual: (a: any, b: any) => boolean;

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

@@ -0,0 +1,20 @@
+/**
+ * String formatter tool. Use %s for string %d for digit and %j for JSON formatting
+ * @param {string} template
+ * @param {Array<string>} args
+ * @return {string}
+ */
+export declare function stringFormat(template: string, ...args: any[]): string;
+/**
+ * String formatter tool. Transforms a space-separated string into camelCase
+ * @param {string} input
+ * @return {string}
+ */
+export declare function camelCase(input: string): string;
+/**
+ * Generate numeric hash based on seed
+ * @param {string} value
+ * @param {number=} seed
+ * @return {number}
+ */
+export declare function generateHash(value: string, seed?: number): number;

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

@@ -0,0 +1,12 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Transform value type. Does not do any JSON validation
+ * @param value
+ * @param type
+ */
+export declare function castType(value: any, type: string): any;