@convertcom/js-sdk-rules 0.0.1 → 1.0.0

package/lib/types/index.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,3 @@
+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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -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;