@convertcom/js-sdk-rules 1.0.0 → 1.0.2

package/lib/legacy/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/legacy/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/legacy/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 {};

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

@@ -1,28 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-/**
- * Returns the value at path of object
- * @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;

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

@@ -1,20 +0,0 @@
-/**
- * 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/legacy/utils/src/types-utils.d.ts

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

package/lib/logger/index.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Convert JS SDK test
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export { LogManager } from './src/log-manager';
-export { LogManagerInterface } from './src/interfaces/log-manager';

package/lib/logger/src/interfaces/log-client.d.ts

@@ -1,13 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { LogLevel } from '@convertcom/js-sdk-enums';
-import { LogMethodMapInterface } from './log-method-map';
-export interface LogClientInterface {
-    sdk: any;
-    level: LogLevel;
-    mapper: LogMethodMapInterface;
-}

package/lib/logger/src/interfaces/log-manager.d.ts

@@ -1,18 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { LogLevel } from '@convertcom/js-sdk-enums';
-import { LogMethodMapInterface } from './log-method-map';
-export interface LogManagerInterface {
-    log(level: LogLevel, ...args: any[]): void;
-    trace(...args: any[]): void;
-    debug(...args: any[]): void;
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
-    addClient(client?: any, level?: LogLevel, methodMap?: LogMethodMapInterface): void;
-    setClientLevel(level: LogLevel, client?: any): void;
-}

package/lib/logger/src/interfaces/log-method-map.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { LogMethod } from '@convertcom/js-sdk-enums';
-export interface LogMethodMapInterface {
-    [LogMethod.LOG]?: string;
-    [LogMethod.DEBUG]?: string;
-    [LogMethod.INFO]?: string;
-    [LogMethod.WARN]?: string;
-    [LogMethod.ERROR]?: string;
-    [LogMethod.TRACE]?: string;
-}

package/lib/logger/src/log-manager.d.ts

@@ -1,64 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { LogLevel } from '@convertcom/js-sdk-enums';
-import { LogMethodMapInterface } from './interfaces/log-method-map';
-import { LogManagerInterface } from './interfaces/log-manager';
-/**
- * Provides logging logic
- * @category Modules
- * @constructor
- * @implements {LogManagerInterface}
- */
-export declare class LogManager implements LogManagerInterface {
-    private _clients;
-    private _defaultMapper;
-    /**
-     * @param {any} client
-     * @param {LogLevel=} level
-     * @param {LogMethodMapInterface=} mapper
-     */
-    constructor(client?: any, level?: LogLevel, mapper?: LogMethodMapInterface);
-    private _isValidLevel;
-    private _isValidMethod;
-    private _log;
-    /**
-     * @param {LogLevel} level
-     * @param {Array<any>} args
-     */
-    log(level: LogLevel, ...args: any[]): void;
-    /**
-     * @param {Array<any>} args
-     */
-    trace(...args: any[]): void;
-    /**
-     * @param {Array<any>} args
-     */
-    debug(...args: any[]): void;
-    /**
-     * @param {Array<any>} args
-     */
-    info(...args: any[]): void;
-    /**
-     * @param {Array<any>} args
-     */
-    warn(...args: any[]): void;
-    /**
-     * @param {Array<any>} args
-     */
-    error(...args: any[]): void;
-    /**
-     * @param {any=} client
-     * @param {LogLevel=} level
-     * @param {LogMethodMapInterface=} methodMap
-     */
-    addClient(client?: any, level?: LogLevel, methodMap?: LogMethodMapInterface): void;
-    /**
-     * @param {LogLevel=} level
-     * @param {any=} client
-     */
-    setClientLevel(level: LogLevel, client?: any): void;
-}

package/lib/rules/index.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Convert JS SDK test
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export { RuleManager } from './src/rule-manager';
-export { RuleManagerInterface } from './src/interfaces/rule-manager';

package/lib/rules/src/interfaces/rule-manager.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Rule, RuleSet } from '@convertcom/js-sdk-types';
-import { RuleError } from '@convertcom/js-sdk-enums';
-export interface RuleManagerInterface {
-    comparisonProcessor: Record<string, any>;
-    getComparisonProcessorMethods(): Array<string>;
-    isRuleMatched(data: Record<string, any>, ruleSet: RuleSet, logEntry?: string): boolean | RuleError;
-    isValidRule(rule: Rule): boolean;
-}

package/lib/rules/src/rule-manager.d.ts

@@ -1,75 +0,0 @@
-import { RuleManagerInterface } from './interfaces/rule-manager';
-import { Config, Rule, RuleSet } from '@convertcom/js-sdk-types';
-import { LogManagerInterface } from '@convertcom/js-sdk-logger';
-import { RuleError } from '@convertcom/js-sdk-enums';
-/**
- * Provides rule processing calculations with corresponding comparisons methods
- * @category Modules
- * @constructor
- * @implements {RuleManagerInterface}
- */
-export declare class RuleManager implements RuleManagerInterface {
-    private _comparisonProcessor;
-    private readonly _negation;
-    private readonly _keys_case_sensitive;
-    private _loggerManager;
-    /**
-     * @param {Config=} config
-     * @param {Object=} dependencies
-     * @param {LogManagerInterface=} dependencies.loggerManager
-     */
-    constructor(config?: Config, { loggerManager }?: {
-        loggerManager?: LogManagerInterface;
-    });
-    /**
-     * Setter for comparison processor
-     * @param {Record<string, any>} comparisonProcessor
-     */
-    set comparisonProcessor(comparisonProcessor: Record<string, any>);
-    /**
-     * Getter for comparison processor
-     */
-    get comparisonProcessor(): Record<string, any>;
-    /**
-     * Retrieve comparison methods from comparison processor
-     * @return {Array<string>} List of methods of comparison processor
-     */
-    getComparisonProcessorMethods(): Array<string>;
-    /**
-     * Check input data matching to rule set
-     * @param {Record<string, any>} data Single value or key-value data set to compare
-     * @param {RuleSet} ruleSet
-     * @return {boolean | RuleError}
-     */
-    isRuleMatched(data: Record<string, any>, ruleSet: RuleSet, logEntry?: string): boolean | RuleError;
-    /**
-     * Check is rule object valid
-     * @param {Rule} rule
-     * @return {boolean}
-     */
-    isValidRule(rule: Rule): boolean;
-    /**
-     * Process AND block of rule set. Return first false if found
-     * @param {Record<string, any>} data Single value or key-value data set to compare
-     * @param {RuleAnd} rulesSubset
-     * @return {boolean | RuleError}
-     * @private
-     */
-    private _processAND;
-    /**
-     * Process OR block of rule set. Return first true if found
-     * @param {Record<string, any>} data Single value or key-value data set to compare
-     * @param {RuleOrWhen} rulesSubset
-     * @return {boolean | RuleError}
-     * @private
-     */
-    private _processORWHEN;
-    /**
-     * Process single rule item
-     * @param {Record<string, any>} data Single value or key-value data set to compare
-     * @param {Rule} rule A single rule to compare
-     * @return {boolean | RuleError} Comparison result
-     * @private
-     */
-    private _processRuleItem;
-}

package/lib/types/index.d.ts

@@ -1,36 +0,0 @@
-/*!
- * Convert JS SDK test
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export * from './src/Audience';
-export * from './src/BucketedFeature';
-export * from './src/BucketedVariation';
-export * from './src/BucketingAttributes';
-export * from './src/Config';
-export * from './src/ConversionAttributes';
-export * from './src/Entity';
-export * from './src/Experience';
-export * from './src/Feature';
-export * from './src/Goal';
-export * from './src/Id';
-export * from './src/IndentityField';
-export * from './src/Integration';
-export * from './src/Location';
-export * from './src/Path';
-export * from './src/Project';
-export * from './src/RequireAtLeastOne';
-export * from './src/Rule';
-export * from './src/Segments';
-export * from './src/SegmentsAttributes';
-export * from './src/SegmentsData';
-export * from './src/StoreData';
-export * from './src/TrackingEvent';
-export * from './src/VariableType';
-export * from './src/Variation';
-export * from './src/VisitorsQueue';
-export * from './src/tracking/BucketingEvent';
-export * from './src/tracking/ConversionEvent';
-export * from './src/tracking/Visitor';
-export * from './src/tracking/VisitorEvent';

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

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

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

@@ -1,30 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { FeatureStatus } from '@convertcom/js-sdk-enums';
-import { RequireAtLeastOne } from './RequireAtLeastOne';
-type NotEnabledFeature = RequireAtLeastOne<{
-    experienceId?: Id;
-    experienceKey?: string;
-    experienceName?: string;
-    id?: Id;
-    key?: string;
-    name?: string;
-    status: FeatureStatus.DISABLED;
-    variables?: Record<string, any>;
-}, 'id' | 'key'>;
-export type BucketedFeature = {
-    experienceId?: Id;
-    experienceKey?: string;
-    experienceName?: string;
-    id?: Id;
-    key?: string;
-    name?: string;
-    status: FeatureStatus;
-    variables?: Record<string, any>;
-} | NotEnabledFeature;
-export {};

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

@@ -1,13 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Id } from './Id';
-import { Variation } from './Variation';
-export type BucketedVariation = Variation & {
-    experienceId?: Id;
-    experienceKey?: string;
-    experienceName?: string;
-};

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

@@ -1,13 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-export type BucketingAttributes = {
-    environment?: string;
-    locationProperties?: Record<any, any>;
-    visitorProperties?: Record<any, any>;
-    typeCasting?: boolean;
-    experienceKeys?: Array<string>;
-};

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

@@ -1,62 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Experience } from './Experience';
-import { Feature } from './Feature';
-import { Id } from './Id';
-import { Project } from './Project';
-import { Goal } from './Goal';
-import { Audience } from './Audience';
-import { Location } from './Location';
-import { LogLevel } from '@convertcom/js-sdk-enums';
-import { Segments } from './Segments';
-export type ConfigData = {
-    account_id: Id;
-    project: Project;
-    goals?: Array<Goal>;
-    locations?: Array<Location>;
-    audiences?: Array<Audience>;
-    experiences?: Array<Experience>;
-    archived_experiences?: Array<Id>;
-    features?: Array<Feature>;
-    segments?: Array<Segments>;
-};
-export type Config = {
-    environment: string;
-    api?: {
-        endpoint?: {
-            config?: string;
-            track?: string;
-        };
-    };
-    bucketing?: {
-        hash_seed?: number;
-        max_traffic?: number;
-    };
-    data: ConfigData;
-    dataStore?: object;
-    dataRefreshInterval?: number;
-    tracking?: boolean;
-    events?: {
-        batch_size?: number;
-        release_interval?: number;
-    };
-    rules?: {
-        comparisonProcessor?: Record<string, any>;
-        negation?: string;
-        keys_case_sensitive?: boolean;
-    };
-    sdkKey: string;
-    logger?: {
-        logLevel?: LogLevel;
-        file?: {
-            enabled?: boolean;
-            path?: string;
-            logLevel?: LogLevel;
-        };
-        customLoggers: Array<Record<string, any>>;
-    };
-};

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

@@ -1,11 +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';
-export type ConversionAttributes = {
-    ruleData?: Record<string, any>;
-    conversionData?: Array<Record<GoalDataKey, number>>;
-};

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

@@ -1,13 +0,0 @@
-/*!
- * Convert JS SDK
- * Version 1.0.0
- * Copyright(c) 2020 Convert Insights, Inc
- * License Apache-2.0
- */
-import { Experience } from './Experience';
-import { Feature } from './Feature';
-import { Audience } from './Audience';
-import { Location } from './Location';
-import { Segments } from './Segments';
-import { Goal } from './Goal';
-export type Entity = Experience | Feature | Audience | Location | Segments | Goal;