@convertcom/js-sdk-rules 1.0.2 → 2.1.0

package/README.md

@@ -4,8 +4,8 @@
 
 ## About
 
-This repository contains the **Rules Manager** dependency for **JavaScript SDK** needed to integrate Convert.com's **Fullstack Product (feature tests, feature flags, feature rollouts)** inside third-party apps. This is maintained by the Convert.com team.
+This repository contains the **Rules Manager** dependency for the **JavaScript SDK** needed to integrate Convert.com's **Fullstack Product (feature tests, feature flags, feature rollouts)** inside third-party apps. This is maintained by the Convert.com team.
 
 ## Credits
 
-Copyright(c) 2023 Convert Insights, Inc.
+Copyright (c) 2023 Convert Insights, Inc.

package/lib/enums/index.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Convert JS SDK test
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export * from './src/bucketing-error';
+export * from './src/conversion-setting-key';
+export * from './src/data-enitites';
+export * from './src/dictionary';
+export * from './src/do-not-track';
+export * from './src/entity-type';
+export * from './src/feature-status';
+export * from './src/goal-data-key';
+export * from './src/log-level';
+export * from './src/log-method';
+export * from './src/project-type';
+export * from './src/rule-error';
+export * from './src/system-events';
+export * from './src/variable-types';
+export * from './src/variation-change-type';
+export * from './src/segments/browser-type';
+export * from './src/segments/device-type';
+export * from './src/segments/segments-keys';
+export * from './src/segments/source-type';
+export * from './src/segments/visitor-type';

package/lib/enums/src/bucketing-error.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum BucketingError {
+    VARIAION_NOT_DECIDED = "convert.com_variation_not_decided"
+}

package/lib/enums/src/conversion-setting-key.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum ConversionSettingKey {
+    FORCE_MULTIPLE_TRANSACTIONS = "forceMultipleTransactions"
+}

package/lib/enums/src/data-enitites.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare const DATA_ENTITIES: string[];
+export declare const DATA_ENTITIES_MAP: {
+    goal: string;
+    audience: string;
+    location: string;
+    segment: string;
+    experience: string;
+    variation: string;
+    feature: string;
+};

package/lib/enums/src/dictionary.d.ts

@@ -0,0 +1,65 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare const ERROR_MESSAGES: {
+    SDK_KEY_MISSING: string;
+    DATA_OBJECT_MISSING: string;
+    CONFIG_DATA_NOT_VALID: string;
+    SDK_OR_DATA_OBJECT_REQUIRED: string;
+    RULE_NOT_VALID: string;
+    RULE_DATA_NOT_VALID: string;
+    RULE_MATCH_TYPE_NOT_SUPPORTED: string;
+    RULE_ERROR: string;
+    DATA_STORE_NOT_VALID: string;
+    VISITOR_ID_REQUIRED: string;
+    GOAL_DATA_NOT_VALID: string;
+    UNABLE_TO_SELECT_BUCKET_FOR_VISITOR: string;
+    UNABLE_TO_PERFORM_NETWORK_REQUEST: string;
+    UNSUPPORTED_RESPONSE_TYPE: string;
+};
+export declare const MESSAGES: {
+    CONFIG_DATA_UPDATED: string;
+    CORE_CONSTRUCTOR: string;
+    CORE_INITIALIZED: string;
+    EXPERIENCE_CONSTRUCTOR: string;
+    EXPERIENCE_NOT_FOUND: string;
+    EXPERIENCE_RULES_MATCHED: string;
+    VARIATIONS_NOT_FOUND: string;
+    VARIATION_CHANGE_NOT_SUPPORTED: string;
+    FEATURE_CONSTRUCTOR: string;
+    FEATURE_NOT_FOUND: string;
+    FEATURE_VARIABLES_NOT_FOUND: string;
+    FEATURE_VARIABLES_TYPE_NOT_FOUND: string;
+    BUCKETING_CONSTRUCTOR: string;
+    DATA_CONSTRUCTOR: string;
+    RULE_CONSTRUCTOR: string;
+    PROCESSING_ENTITY: string;
+    LOCATION_MATCH: string;
+    LOCATION_NOT_MATCH: string;
+    LOCATION_NOT_RESTRICTED: string;
+    AUDIENCE_MATCH: string;
+    AUDIENCE_NOT_MATCH: string;
+    NON_PERMANENT_AUDIENCE_NOT_RESTRICTED: string;
+    AUDIENCE_NOT_RESTRICTED: string;
+    SEGMENTATION_MATCH: string;
+    SEGMENTATION_NOT_RESTRICTED: string;
+    RULE_NOT_MATCH: string;
+    RULE_MATCH: string;
+    RULE_MATCH_AND: string;
+    RULE_MATCH_START: string;
+    LOCATION_ACTIVATED: string;
+    LOCATION_DEACTIVATED: string;
+    BUCKETED_VISITOR_FOUND: string;
+    BUCKETED_VISITOR_FORCED: string;
+    BUCKETED_VISITOR: string;
+    GOAL_NOT_FOUND: string;
+    GOAL_RULE_NOT_MATCH: string;
+    GOAL_FOUND: string;
+    SEGMENTS_NOT_FOUND: string;
+    SEGMENTS_RULE_NOT_MATCH: string;
+    CUSTOM_SEGMENTS_KEY_FOUND: string;
+    SEND_BEACON_SUCCESS: string;
+};

package/lib/enums/src/do-not-track.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum DoNotTrack {
+    OFF = "OFF",
+    EU_ONLY = "EU ONLY",
+    EEA_ONLY = "EEA ONLY",
+    WORLDWIDE = "Worldwide"
+}

package/lib/enums/src/entity-type.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum EntityType {
+    AUDIENCE = "audience",
+    LOCATION = "location",
+    SEGMENT = "segment",
+    FEATURE = "feature",
+    GOAL = "goal",
+    EXPERIENCE = "experience",
+    VARIATION = "variation"
+}

package/lib/enums/src/feature-status.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum FeatureStatus {
+    ENABLED = "enabled",
+    DISABLED = "disabled"
+}

package/lib/enums/src/goal-data-key.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum GoalDataKey {
+    AMOUNT = "amount",
+    PRODUCTS_COUNT = "productsCount",
+    TRANSACTION_ID = "transactionId"
+}

package/lib/enums/src/log-level.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum LogLevel {
+    TRACE = 0,
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4,
+    SILENT = 5
+}

package/lib/enums/src/log-method.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum LogMethod {
+    LOG = "log",
+    TRACE = "trace",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}

package/lib/enums/src/project-type.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum ProjectType {
+    WEB = "web",
+    FULLSTACK = "fullstack"
+}

package/lib/enums/src/rule-error.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum RuleError {
+    NO_DATA_FOUND = "convert.com_no_data_found",
+    NEED_MORE_DATA = "convert.com_need_more_data"
+}

package/lib/enums/src/segments/browser-type.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum BrowserType {
+    IE = "IE",
+    CH = "CH",
+    FF = "FF",
+    OP = "OP",
+    SF = "SF",
+    EDG = "EDG",
+    MO = "MO",
+    NS = "NS",
+    OTH = "OTH"
+}

package/lib/enums/src/segments/device-type.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum DeviceType {
+    ALLPH = "ALLPH",
+    IPH = "IPH",
+    OTHPH = "OTHPH",
+    ALLTAB = "ALLTAB",
+    IPAD = "IPAD",
+    OTHTAB = "OTHTAB",
+    DESK = "DESK",
+    OTHDEV = "OTHDEV"
+}

package/lib/enums/src/segments/segments-keys.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum SegmentsKeys {
+    COUNTRY = "country",
+    BROWSER = "browser",
+    DEVICES = "devices",
+    SOURCE = "source",
+    CAMPAIGN = "campaign",
+    VISITOR_TYPE = "visitorType",
+    CUSTOM_SEGMENTS = "customSegments"
+}

package/lib/enums/src/segments/source-type.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum SourceType {
+    CAMPAIGN = "campaign",
+    SEARCH = "search",
+    REFERRAL = "referral",
+    DIRECT = "direct"
+}

package/lib/enums/src/segments/visitor-type.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum VisitorType {
+    NEW = "new",
+    RETURNING = "returning"
+}

package/lib/enums/src/system-events.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * SDK system events. Possible values: 'ready' | 'queue-released'
+ * or custom visitor's event
+ */
+export declare enum SystemEvents {
+    READY = "ready",
+    CONFIG_UPDATED = "config.updated",
+    API_QUEUE_RELEASED = "api.queue.released",
+    BUCKETING = "bucketing",
+    CONVERSION = "conversion",
+    SEGMENTS = "segments",
+    LOCATION_ACTIVATED = "location.activated",
+    LOCATION_DEACTIVATED = "location.deactivated",
+    AUDIENCES = "audiences",
+    DATA_STORE_QUEUE_RELEASED = "datastore.queue.released"
+}

package/lib/enums/src/variable-types.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare const VARIABLE_TYPES: readonly ["boolean", "float", "json", "integer", "string"];

package/lib/enums/src/variation-change-type.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export declare enum VariationChangeType {
+    RICH_STRUCTURE = "richStructure",
+    CUSTOM_CODE = "customCode",
+    DEFAULT_CODE = "defaultCode",
+    DEFAULT_CODE_MULTIPAGE = "defaultCodeMultipage",
+    DEFAULT_REDIRECT = "defaultRedirect",
+    FULLSTACK_FEATURE = "fullStackFeature"
+}

package/lib/index.d.ts

@@ -1,6 +1,6 @@
-import { RuleSet, Rule, Config } from '@convertcom/js-sdk-types';
-import { RuleError } from '@convertcom/js-sdk-enums';
-import { LogManagerInterface } from '@convertcom/js-sdk-logger';
+import { RuleObject, RuleElement, Config } from './types';
+import { RuleError } from './enums';
+import { LogManagerInterface } from './logger';
 
 /*!
  * Convert JS SDK
@@ -12,8 +12,8 @@ import { LogManagerInterface } from '@convertcom/js-sdk-logger';
 interface RuleManagerInterface {
     comparisonProcessor: Record<string, any>;
     getComparisonProcessorMethods(): Array<string>;
-    isRuleMatched(data: Record<string, any>, ruleSet: RuleSet, logEntry?: string): boolean | RuleError;
-    isValidRule(rule: Rule): boolean;
+    isRuleMatched(data: Record<string, any>, ruleSet: RuleObject, logEntry?: string): boolean | RuleError;
+    isValidRule(rule: RuleElement): boolean;
 }
 
 /**
@@ -53,16 +53,16 @@ declare class RuleManager implements RuleManagerInterface {
     /**
      * Check input data matching to rule set
      * @param {Record<string, any>} data Single value or key-value data set to compare
-     * @param {RuleSet} ruleSet
+     * @param {RuleObject} ruleSet
      * @return {boolean | RuleError}
      */
-    isRuleMatched(data: Record<string, any>, ruleSet: RuleSet, logEntry?: string): boolean | RuleError;
+    isRuleMatched(data: Record<string, any>, ruleSet: RuleObject, logEntry?: string): boolean | RuleError;
     /**
      * Check is rule object valid
-     * @param {Rule} rule
+     * @param {RuleElement} rule
      * @return {boolean}
      */
-    isValidRule(rule: Rule): boolean;
+    isValidRule(rule: RuleElement): 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
@@ -82,7 +82,7 @@ declare class RuleManager implements RuleManagerInterface {
     /**
      * 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
+     * @param {RuleElement} rule A single rule to compare
      * @return {boolean | RuleError} Comparison result
      * @private
      */