@convertcom/js-sdk-rules 1.0.0 → 1.0.2

package/lib/types/src/Experience.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { ExperienceType } from '@convertcom/js-sdk-enums';
-import { Id } from './Id';
-import { RuleSet } from './Rule';
-import { Variation } from './Variation';
-import { Integration } from './Integration';
-export type MultipagePages = {
-    id: Id;
-    url: string;
-};
-export type Experience = {
-    id: Id;
-    name: string;
-    key: string;
-    site_area?: RuleSet;
-    locations?: Array<Id>;
-    audiences?: Array<Id>;
-    goals?: Array<Id>;
-    type: ExperienceType;
-    version: number;
-    url: string;
-    global_js?: string;
-    global_css?: string;
-    multipage_pages?: Array<MultipagePages>;
-    variations: Array<Variation>;
-    environments: Array<string>;
-    settings?: {
-        min_order_value?: number;
-        max_order_value?: number;
-    };
-    integrations?: Array<Integration>;
-};

package/lib/types/src/Feature.d.ts

@@ -1,18 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { VariableType } from './VariableType';
-export type FeatureVariableDefinition = {
-    key: string;
-    type?: VariableType;
-};
-export type Feature = {
-    id: Id;
-    name: string;
-    key: string;
-    variables: Array<FeatureVariableDefinition>;
-};

package/lib/types/src/Goal.d.ts

@@ -1,30 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { RuleSet } from './Rule';
-import { Id } from './Id';
-import { GoalType, GoalRevenueTriggeringType } from '@convertcom/js-sdk-enums';
-export type GoalTrackedItem = {
-    event: string;
-    selector: string;
-};
-export type GoalSettings = {
-    percentage?: number;
-    tracked_items?: Array<GoalTrackedItem>;
-    triggering_type?: GoalRevenueTriggeringType;
-    selector?: string;
-    href?: string;
-    action?: string;
-    ga_event?: string;
-};
-export type Goal = {
-    id: Id;
-    rules?: RuleSet;
-    type: GoalType;
-    settings?: GoalSettings;
-    name: string;
-    key: string;
-};

package/lib/types/src/Id.d.ts

@@ -1,10 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-/**
- * A type which describes identification. String or number
- */
-export type Id = string | number;

package/lib/types/src/IndentityField.d.ts

@@ -1,7 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export type IdentityField = 'id' | 'key';

package/lib/types/src/Integration.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { GoogleAnalyticsType, IntegrationProvider } from '@convertcom/js-sdk-enums';
-export type Integration = {
-    provider: IntegrationProvider;
-    enabled?: boolean;
-    custom_dimension?: string;
-    type?: GoogleAnalyticsType;
-    measurementId?: string;
-    property_UA?: string;
-    evar?: string;
-};

package/lib/types/src/Location.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { RuleSet } from './Rule';
-import { Id } from './Id';
-export type Location = {
-    id: Id;
-    name: string;
-    key: string;
-    rules: RuleSet;
-};

package/lib/types/src/Path.d.ts

@@ -1,10 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export type Path = {
-    base: string;
-    route: string;
-};

package/lib/types/src/Project.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { DoNotTrack, GoogleAnalyticsType, ProjectType } from '@convertcom/js-sdk-enums';
-export type Project = {
-    id: Id;
-    name: string;
-    type: ProjectType;
-    environments: Record<string, string>;
-    utc_offset: number;
-    domains: Array<Record<string, any>>;
-    global_javascript?: string | ((...args: any) => any | undefined);
-    settings: {
-        auto_link: boolean;
-        data_anonymization: boolean;
-        do_not_track: DoNotTrack;
-        include_jquery: boolean;
-        min_order_value?: number;
-        max_order_value?: number;
-        integrations?: {
-            google_analytics?: {
-                enabled: boolean;
-                type: GoogleAnalyticsType;
-                measurementId?: string;
-                property_UA?: string;
-                auto_revenue_tracking: boolean;
-            };
-            kissmetrics?: {
-                enabled: boolean;
-            };
-        };
-    };
-};

package/lib/types/src/RequireAtLeastOne.d.ts

@@ -1,3 +0,0 @@
-export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
-}[Keys];

package/lib/types/src/Rule.d.ts

@@ -1,24 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export type Rule = {
-    rule_type?: string;
-    key?: string;
-    matching: {
-        match_type: string;
-        negated?: boolean;
-    };
-    value: string | number | boolean | ((...args: any) => any | undefined);
-};
-export type RuleOrWhen = {
-    OR_WHEN: Array<Rule>;
-};
-export type RuleAnd = {
-    AND: Array<RuleOrWhen>;
-};
-export type RuleSet = {
-    OR: Array<RuleAnd>;
-};

package/lib/types/src/Segments.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { RuleSet } from './Rule';
-import { Id } from './Id';
-export type Segments = {
-    id: Id;
-    rules: RuleSet;
-    name: string;
-    key: string;
-};

package/lib/types/src/SegmentsAttributes.d.ts

@@ -1,9 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export type SegmentsAttributes = {
-    ruleData?: Record<string, any>;
-};

package/lib/types/src/SegmentsData.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { BrowserType, DeviceType, SegmentsKeys, SourceType, VisitorType } from '@convertcom/js-sdk-enums';
-export type SegmentsData = {
-    [SegmentsKeys.COUNTRY]?: string;
-    [SegmentsKeys.BROWSER]?: BrowserType;
-    [SegmentsKeys.DEVICES]?: Array<DeviceType>;
-    [SegmentsKeys.SOURCE]?: SourceType;
-    [SegmentsKeys.CAMPAIGN]?: string;
-    [SegmentsKeys.VISITOR_TYPE]?: VisitorType;
-    [SegmentsKeys.CUSTOM_SEGMENTS]?: Array<string>;
-};

package/lib/types/src/StoreData.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { SegmentsData } from './SegmentsData';
-export type StoreData = {
-    bucketing?: Record<string, Id>;
-    locations?: Array<Id>;
-    segments?: SegmentsData;
-    goals?: Record<string, boolean>;
-};

package/lib/types/src/TrackingEvent.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { Visitor } from './tracking/Visitor';
-export type TrackingEvent = {
-    accountId?: Id;
-    projectId?: Id;
-    enrichData?: boolean;
-    visitors: Array<Visitor>;
-};

package/lib/types/src/VariableType.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { VARIABLE_TYPES } from '@convertcom/js-sdk-enums';
-export type VariableType = (typeof VARIABLE_TYPES)[number];

package/lib/types/src/Variation.d.ts

@@ -1,49 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { VariationChangeType } from '@convertcom/js-sdk-enums';
-import { Id } from './Id';
-export type RichStructureChange = {
-    js?: string;
-    selector: string;
-    page_id: string;
-};
-export type CustomCodeChange = {
-    css?: string;
-    js?: string;
-    page_id: string;
-};
-export type DefaultCodeChange = {
-    css?: string;
-    js?: string;
-    custom_js?: string;
-};
-export type DefaultCodeMultipageChange = {
-    css?: string;
-    js?: string;
-    custom_js?: string;
-    page_id: string;
-};
-export type DefaultRedirectChange = {
-    original_pattern: string;
-    variation_pattern: string;
-};
-export type FullStackFeatureChange = {
-    feature_id: Id;
-    variables_data: Record<string, any>;
-};
-export type VariationChange = {
-    id: Id;
-    type: VariationChangeType;
-    data: RichStructureChange | CustomCodeChange | DefaultCodeChange | DefaultCodeMultipageChange | DefaultRedirectChange | FullStackFeatureChange;
-};
-export type Variation = {
-    id: Id;
-    key: string;
-    name: string;
-    changes: Array<VariationChange>;
-    traffic_allocation?: number;
-};

package/lib/types/src/VisitorsQueue.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { SegmentsData } from './SegmentsData';
-import { Visitor } from './tracking/Visitor';
-import { VisitorEvent } from './tracking/VisitorEvent';
-export type VisitorsQueue = {
-    length: number;
-    items: Array<Visitor>;
-    push: (visitorId: Id, eventRequest: VisitorEvent, segments?: SegmentsData) => void;
-    reset: () => void;
-};

package/lib/types/src/tracking/BucketingEvent.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from '../Id';
-export type BucketingEvent = {
-    experienceId: Id;
-    variationId: Id;
-};

package/lib/types/src/tracking/ConversionEvent.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { GoalDataKey } from '@convertcom/js-sdk-enums';
-import { Id } from '../Id';
-export type GoalData = {
-    [key in GoalDataKey]?: Id;
-};
-export type ConversionEvent = {
-    goalId: Id;
-    goalData?: Array<GoalData>;
-    bucketingData?: Record<string, Id>;
-};

package/lib/types/src/tracking/Visitor.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from '../Id';
-import { SegmentsData } from '../SegmentsData';
-import { VisitorEvent } from './VisitorEvent';
-export type Visitor = {
-    visitorId: Id;
-    segments?: SegmentsData;
-    events: Array<VisitorEvent>;
-};

package/lib/types/src/tracking/VisitorEvent.d.ts

@@ -1,13 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { EventType } from '@convertcom/js-sdk-enums';
-import { BucketingEvent } from './BucketingEvent';
-import { ConversionEvent } from './ConversionEvent';
-export type VisitorEvent = {
-    eventType: EventType;
-    data?: BucketingEvent | ConversionEvent;
-};

package/lib/utils/index.d.ts

@@ -1,14 +0,0 @@
-/*!
- * 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

@@ -1,11 +0,0 @@
-/*!
- * 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

@@ -1,22 +0,0 @@
-/*!
- * 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

@@ -1,39 +0,0 @@
-/*!
- * 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

@@ -1,40 +0,0 @@
-/**
- * @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

@@ -1,102 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-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>;
-}
-export declare const serialize: (params: Record<string, any>, method: string) => string;
-/**
- * Provide http client for newtork requests
- * @param {HttpRequest}
- * @returns {HttpClient}
- */
-export declare const HttpClient: HttpClientInterface;
-export {};