@adtrackify/at-tracking-event-types 3.5.17 → 3.5.18

package/dist/esm/types/event/context/event-context.d.ts

@@ -1,201 +1,201 @@
-import { EventIdentity as EventIdentity } from './event-context-identity.js';
-import { IResult } from 'ua-parser-js';
-export interface EventContext {
-    identity?: EventIdentity;
-    properties?: EventContextProperties;
-}
-export interface AnonymousPIIData {
-    sha256Emails?: string[];
-    sha256Phones?: string[];
-}
-export interface ThirdPartyPIIData {
-    emails?: string[];
-    phones?: string[];
-}
-export interface EventContextProperties {
-    click?: AdClickInfo;
-    campaign?: CampaignInfo;
-    page?: PageInfo;
-    device?: DeviceInfo;
-    locale?: string;
-    timezone?: string;
-    userAgent?: string;
-    ipAddress?: string;
-    ipv6Address?: string;
-    sessionId?: string;
-    shopify?: ShopifyInfo;
-    adBlockDetected?: boolean;
-    enrichment?: Enrichment;
-    anonymousPIIData?: AnonymousPIIData;
-    thirdPartyPIIData?: ThirdPartyPIIData;
-}
-export interface IPDataResponse {
-    ip?: string;
-    is_eu?: boolean;
-    city?: string;
-    region?: string;
-    region_code?: string;
-    country_name?: string;
-    country_code?: string;
-    continent_name?: string;
-    continent_code?: string;
-    latitude?: number;
-    longitude?: number;
-    postal?: string;
-    calling_code?: string;
-    flag?: string;
-    emoji_flag?: string;
-    emoji_unicode?: string;
-    asn: {
-        asn?: string;
-        name?: string;
-        domain?: string;
-        route?: string;
-        type?: string;
-    };
-    company?: {
-        name?: string;
-        domain?: string;
-        network?: string;
-        type?: string;
-    };
-    carrier?: {
-        name?: string;
-        mcc?: string;
-        mnc?: string;
-    };
-    languages?: {
-        name?: string;
-        native?: string;
-        code?: string;
-    }[];
-    currency?: {
-        name?: string;
-        code?: string;
-        symbol?: string;
-        native?: string;
-        plural?: string;
-    };
-    time_zone?: {
-        name?: string;
-        abbr?: string;
-        offset?: string;
-        is_dst?: boolean;
-        current_time?: string;
-    };
-    threat?: {
-        is_tor?: boolean;
-        is_vpn?: boolean;
-        is_icloud_relay?: boolean;
-        is_proxy?: boolean;
-        is_datacenter?: boolean;
-        is_anonymous?: boolean;
-        is_known_attacker?: boolean;
-        is_known_abuser?: boolean;
-        is_threat?: boolean;
-        is_bogon?: boolean;
-        blocklists?: {
-            name?: string;
-            site?: string;
-            type?: string;
-        }[];
-        scores?: {
-            vpn_score?: number;
-            proxy_score?: number;
-            threat_score?: number;
-            trust_score?: number;
-        };
-    };
-}
-export interface Enrichment {
-    landingHostname?: string;
-    landingPath?: string;
-    landingSearch?: string;
-    landingQsp?: object;
-    refrMedium?: string;
-    refrSource?: string;
-    refrTerm?: string;
-    utmCampaign?: string;
-    utmSource?: string;
-    utmMedium?: string;
-    utmTerm?: string;
-    utmContent?: string;
-    mktCampaign?: string;
-    mktSource?: string;
-    mktMedium?: string;
-    mktTerm?: string;
-    mktContent?: string;
-    mktCampaignId?: string;
-    mktAdSetId?: string;
-    mktAdId?: string;
-    mktClickParam?: string;
-    mktClickId?: string;
-    mktClickNetwork?: string;
-    mktPlacement?: string;
-    isMobile?: boolean;
-    isWirelessCarrier?: boolean;
-    ipLookupResponse?: IPDataResponse;
-    deviceInfo?: DeviceInfo;
-}
-export interface AdClickInfo {
-    fbp?: string;
-    fbpCollectedAt?: string;
-    fbc?: string;
-    fbcCollectedAt?: string;
-    fbclid?: string;
-    fbclidCollectedAt?: string;
-    gclid?: string;
-    gclidCollectedAt?: string;
-    googleClientInfos?: GoogleClientInfo[];
-    gbraid?: string;
-    gbraidCollectedAt?: string;
-    wbraid?: string;
-    wbraidCollectedAt?: string;
-    ttclid?: string;
-    ttclidCollectedAt?: string;
-    ttp?: string;
-    ttpCollectedAt?: string;
-    snapchatSCCid?: string;
-    snapchatSCCidCollectedAt?: string;
-    snapchatSCCookie?: string;
-    snapchatSCCookieCollectedAt?: string;
-    pinterestEpik?: string;
-    pinterestEpikCollectedAt?: string;
-    applovinAxwrt?: string;
-    applovinAxwrtCollectedAt?: string;
-    kx?: string;
-    kxCollectedAt?: string;
-    klaviyoCid?: string;
-    klaviyoCidCollectedAt?: string;
-    sendlaneCid?: string;
-    sendlaneCidCollectedAt?: string;
-    omnisendCid?: string;
-    omnisendCidCollectedAt?: string;
-}
-export interface GoogleClientInfo {
-    id: string;
-    clientId?: string;
-    clickId?: string;
-    sessionId?: string;
-}
-export interface CampaignInfo {
-    name?: string;
-    campaign?: string;
-    source?: string;
-    medium?: string;
-    term?: string;
-    content?: string;
-}
-export interface PageInfo {
-    path?: string;
-    referrer?: string;
-    search?: string;
-    title?: string;
-    url?: string;
-    qsp?: any;
-}
-export interface ShopifyInfo {
-    collections?: string;
-    tags?: string;
-}
-export declare type DeviceInfo = IResult;
+import { EventIdentity as EventIdentity } from './event-context-identity.js';
+import { IResult } from 'ua-parser-js';
+export interface EventContext {
+    identity?: EventIdentity;
+    properties?: EventContextProperties;
+}
+export interface AnonymousPIIData {
+    sha256Emails?: string[];
+    sha256Phones?: string[];
+}
+export interface ThirdPartyPIIData {
+    emails?: string[];
+    phones?: string[];
+}
+export interface EventContextProperties {
+    click?: AdClickInfo;
+    campaign?: CampaignInfo;
+    page?: PageInfo;
+    device?: DeviceInfo;
+    locale?: string;
+    timezone?: string;
+    userAgent?: string;
+    ipAddress?: string;
+    ipv6Address?: string;
+    sessionId?: string;
+    shopify?: ShopifyInfo;
+    adBlockDetected?: boolean;
+    enrichment?: Enrichment;
+    anonymousPIIData?: AnonymousPIIData;
+    thirdPartyPIIData?: ThirdPartyPIIData;
+}
+export interface IPDataResponse {
+    ip?: string;
+    is_eu?: boolean;
+    city?: string;
+    region?: string;
+    region_code?: string;
+    country_name?: string;
+    country_code?: string;
+    continent_name?: string;
+    continent_code?: string;
+    latitude?: number;
+    longitude?: number;
+    postal?: string;
+    calling_code?: string;
+    flag?: string;
+    emoji_flag?: string;
+    emoji_unicode?: string;
+    asn: {
+        asn?: string;
+        name?: string;
+        domain?: string;
+        route?: string;
+        type?: string;
+    };
+    company?: {
+        name?: string;
+        domain?: string;
+        network?: string;
+        type?: string;
+    };
+    carrier?: {
+        name?: string;
+        mcc?: string;
+        mnc?: string;
+    };
+    languages?: {
+        name?: string;
+        native?: string;
+        code?: string;
+    }[];
+    currency?: {
+        name?: string;
+        code?: string;
+        symbol?: string;
+        native?: string;
+        plural?: string;
+    };
+    time_zone?: {
+        name?: string;
+        abbr?: string;
+        offset?: string;
+        is_dst?: boolean;
+        current_time?: string;
+    };
+    threat?: {
+        is_tor?: boolean;
+        is_vpn?: boolean;
+        is_icloud_relay?: boolean;
+        is_proxy?: boolean;
+        is_datacenter?: boolean;
+        is_anonymous?: boolean;
+        is_known_attacker?: boolean;
+        is_known_abuser?: boolean;
+        is_threat?: boolean;
+        is_bogon?: boolean;
+        blocklists?: {
+            name?: string;
+            site?: string;
+            type?: string;
+        }[];
+        scores?: {
+            vpn_score?: number;
+            proxy_score?: number;
+            threat_score?: number;
+            trust_score?: number;
+        };
+    };
+}
+export interface Enrichment {
+    landingHostname?: string;
+    landingPath?: string;
+    landingSearch?: string;
+    landingQsp?: object;
+    refrMedium?: string;
+    refrSource?: string;
+    refrTerm?: string;
+    utmCampaign?: string;
+    utmSource?: string;
+    utmMedium?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    mktCampaign?: string;
+    mktSource?: string;
+    mktMedium?: string;
+    mktTerm?: string;
+    mktContent?: string;
+    mktCampaignId?: string;
+    mktAdSetId?: string;
+    mktAdId?: string;
+    mktClickParam?: string;
+    mktClickId?: string;
+    mktClickNetwork?: string;
+    mktPlacement?: string;
+    isMobile?: boolean;
+    isWirelessCarrier?: boolean;
+    ipLookupResponse?: IPDataResponse;
+    deviceInfo?: DeviceInfo;
+}
+export interface AdClickInfo {
+    fbp?: string;
+    fbpCollectedAt?: string;
+    fbc?: string;
+    fbcCollectedAt?: string;
+    fbclid?: string;
+    fbclidCollectedAt?: string;
+    gclid?: string;
+    gclidCollectedAt?: string;
+    googleClientInfos?: GoogleClientInfo[];
+    gbraid?: string;
+    gbraidCollectedAt?: string;
+    wbraid?: string;
+    wbraidCollectedAt?: string;
+    ttclid?: string;
+    ttclidCollectedAt?: string;
+    ttp?: string;
+    ttpCollectedAt?: string;
+    snapchatSCCid?: string;
+    snapchatSCCidCollectedAt?: string;
+    snapchatSCCookie?: string;
+    snapchatSCCookieCollectedAt?: string;
+    pinterestEpik?: string;
+    pinterestEpikCollectedAt?: string;
+    applovinAxwrt?: string;
+    applovinAxwrtCollectedAt?: string;
+    kx?: string;
+    kxCollectedAt?: string;
+    klaviyoCid?: string;
+    klaviyoCidCollectedAt?: string;
+    sendlaneCid?: string;
+    sendlaneCidCollectedAt?: string;
+    omnisendCid?: string;
+    omnisendCidCollectedAt?: string;
+}
+export interface GoogleClientInfo {
+    id: string;
+    clientId?: string;
+    clickId?: string;
+    sessionId?: string;
+}
+export interface CampaignInfo {
+    name?: string;
+    campaign?: string;
+    source?: string;
+    medium?: string;
+    term?: string;
+    content?: string;
+}
+export interface PageInfo {
+    path?: string;
+    referrer?: string;
+    search?: string;
+    title?: string;
+    url?: string;
+    qsp?: any;
+}
+export interface ShopifyInfo {
+    collections?: string;
+    tags?: string;
+}
+export declare type DeviceInfo = IResult;

package/dist/esm/types/event/context/event-context.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=event-context.js.map

package/dist/esm/types/event/context/index.d.ts

@@ -1,2 +1,2 @@
-export * from './event-context.js';
-export * from './event-context-identity.js';
+export * from './event-context.js';
+export * from './event-context-identity.js';

package/dist/esm/types/event/context/index.js

@@ -1,3 +1,3 @@
-export * from './event-context.js';
-export * from './event-context-identity.js';
+export * from './event-context.js';
+export * from './event-context-identity.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/types/event/index.d.ts

@@ -1,5 +1,6 @@
-export * from './base/index.js';
-export * from './context/index.js';
-export * from './tracking-event.js';
-export * from './metric-event.js';
-export * from './log-event.js';
+export * from './base/index.js';
+export * from './context/index.js';
+export * from './tracking-event.js';
+export * from './metric-event.js';
+export * from './log-event.js';
+export * from './saas-event-properties.js';

package/dist/esm/types/event/index.js

@@ -1,6 +1,7 @@
-export * from './base/index.js';
-export * from './context/index.js';
-export * from './tracking-event.js';
-export * from './metric-event.js';
-export * from './log-event.js';
+export * from './base/index.js';
+export * from './context/index.js';
+export * from './tracking-event.js';
+export * from './metric-event.js';
+export * from './log-event.js';
+export * from './saas-event-properties.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/types/event/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/event/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/event/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}

package/dist/esm/types/event/log-event.d.ts

@@ -1,35 +1,35 @@
-import { InternalEvent } from './base/event.js';
-export interface LogEvent extends InternalEvent {
-    data: LogEventData;
-}
-export interface LogEventData {
-    [x: string]: any;
-    source?: string;
-    service?: string;
-    logMessage: string;
-    logLevel: LogLevel;
-    logStorage?: LogStorage;
-    logGroup: LogGroup;
-}
-export interface LogStorage {
-    sendToDatadog?: boolean;
-    sendToEventDebugger?: boolean;
-    sendToSingleStore?: boolean;
-}
-export declare enum LogLevel {
-    debug = "debug",
-    error = "error",
-    info = "info",
-    trace = "trace",
-    warn = "warn"
-}
-export declare const LogLevelId: {
-    trace: number;
-    debug: number;
-    info: number;
-    warn: number;
-    error: number;
-};
-export declare enum LogGroup {
-    eventDebugger = "eventDebugger"
-}
+import { InternalEvent } from './base/event.js';
+export interface LogEvent extends InternalEvent {
+    data: LogEventData;
+}
+export interface LogEventData {
+    [x: string]: any;
+    source?: string;
+    service?: string;
+    logMessage: string;
+    logLevel: LogLevel;
+    logStorage?: LogStorage;
+    logGroup: LogGroup;
+}
+export interface LogStorage {
+    sendToDatadog?: boolean;
+    sendToEventDebugger?: boolean;
+    sendToSingleStore?: boolean;
+}
+export declare enum LogLevel {
+    debug = "debug",
+    error = "error",
+    info = "info",
+    trace = "trace",
+    warn = "warn"
+}
+export declare const LogLevelId: {
+    trace: number;
+    debug: number;
+    info: number;
+    warn: number;
+    error: number;
+};
+export declare enum LogGroup {
+    eventDebugger = "eventDebugger"
+}

package/dist/esm/types/event/log-event.js

@@ -1,20 +1,20 @@
-export var LogLevel;
-(function (LogLevel) {
-    LogLevel["debug"] = "debug";
-    LogLevel["error"] = "error";
-    LogLevel["info"] = "info";
-    LogLevel["trace"] = "trace";
-    LogLevel["warn"] = "warn";
-})(LogLevel || (LogLevel = {}));
-export const LogLevelId = {
-    trace: 0,
-    debug: 1,
-    info: 2,
-    warn: 3,
-    error: 4,
-};
-export var LogGroup;
-(function (LogGroup) {
-    LogGroup["eventDebugger"] = "eventDebugger";
-})(LogGroup || (LogGroup = {}));
+export var LogLevel;
+(function (LogLevel) {
+    LogLevel["debug"] = "debug";
+    LogLevel["error"] = "error";
+    LogLevel["info"] = "info";
+    LogLevel["trace"] = "trace";
+    LogLevel["warn"] = "warn";
+})(LogLevel || (LogLevel = {}));
+export const LogLevelId = {
+    trace: 0,
+    debug: 1,
+    info: 2,
+    warn: 3,
+    error: 4,
+};
+export var LogGroup;
+(function (LogGroup) {
+    LogGroup["eventDebugger"] = "eventDebugger";
+})(LogGroup || (LogGroup = {}));
 //# sourceMappingURL=log-event.js.map

package/dist/esm/types/event/metric-event.d.ts

@@ -1,13 +1,13 @@
-import { InternalEvent } from './base/event.js';
-export interface MetricEvent extends InternalEvent {
-    data: MetricEventData[];
-}
-export interface MetricEventData {
-    [key: string]: any;
-    recordId: string;
-    recordName: string;
-    recordValue: number;
-    displayName: string;
-    detail?: string;
-    detailCode?: number;
-}
+import { InternalEvent } from './base/event.js';
+export interface MetricEvent extends InternalEvent {
+    data: MetricEventData[];
+}
+export interface MetricEventData {
+    [key: string]: any;
+    recordId: string;
+    recordName: string;
+    recordValue: number;
+    displayName: string;
+    detail?: string;
+    detailCode?: number;
+}

package/dist/esm/types/event/metric-event.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=metric-event.js.map

package/dist/esm/types/event/saas-event-properties.d.ts

@@ -0,0 +1,47 @@
+import { USER_ROLES } from '../api/user-account.js';
+export declare enum BILLING_INTERVAL {
+    DAY = "day",
+    WEEK = "week",
+    MONTH = "month",
+    YEAR = "year"
+}
+export interface SaaSEventProperties {
+    accountId?: string;
+    accountName?: string;
+    accountCreatedAt?: string;
+    userId?: string;
+    userEmail?: string;
+    userRole?: USER_ROLES;
+    subscriptionId?: string;
+    planId?: string;
+    planName?: string;
+    billingInterval?: BILLING_INTERVAL;
+    mrr?: number;
+    arr?: number;
+    mrrDelta?: number;
+    ltv?: number;
+    trialStartDate?: string;
+    trialEndDate?: string;
+    trialDaysRemaining?: number;
+    usageInfo?: {
+        currentUsage?: number;
+        limit?: number;
+        usagePercentage?: number;
+    };
+    invoiceId?: string;
+    amount?: number;
+    currency?: string;
+    failureReason?: string;
+    seatCount?: number;
+    seatDelta?: number;
+    addonId?: string;
+    addonName?: string;
+    featureId?: string;
+    featureName?: string;
+    milestoneId?: string;
+    milestoneName?: string;
+    inactiveDays?: number;
+    cancelReason?: string;
+    cancelFeedback?: string;
+    cancelledAt?: string;
+}

package/dist/esm/types/event/saas-event-properties.js

@@ -0,0 +1,8 @@
+export var BILLING_INTERVAL;
+(function (BILLING_INTERVAL) {
+    BILLING_INTERVAL["DAY"] = "day";
+    BILLING_INTERVAL["WEEK"] = "week";
+    BILLING_INTERVAL["MONTH"] = "month";
+    BILLING_INTERVAL["YEAR"] = "year";
+})(BILLING_INTERVAL || (BILLING_INTERVAL = {}));
+//# sourceMappingURL=saas-event-properties.js.map

package/dist/esm/types/event/saas-event-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"saas-event-properties.js","sourceRoot":"","sources":["../../../../src/types/event/saas-event-properties.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,iCAAa,CAAA;AACf,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B"}