@adtrackify/at-tracking-event-types 1.1.8 → 1.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.editorconfig +1 -0
- package/.husky/pre-push +4 -4
- package/dist/index.d.ts +36 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +2 -2
- package/package.json +2 -2
- package/src/types/adtrackify-standard-events.ts +3 -0
- package/src/types/api/destinations/destinations.ts +66 -66
- package/src/types/api/destinations/third-party-destination-configs.ts +71 -71
- package/src/types/common/logger.ts +28 -0
- package/src/types/tracking-events/tracking-event-type.ts +69 -4
package/.editorconfig
CHANGED
package/.husky/pre-push
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
-
|
|
4
|
-
npm run build
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
+
|
|
4
|
+
npm run build
|
package/dist/index.d.ts
CHANGED
|
@@ -52,7 +52,8 @@ declare module '@adtrackify/at-tracking-event-types/types/adtrackify-standard-ev
|
|
|
52
52
|
SELECT_SHIPPING_METHOD = "select_shipping_method",
|
|
53
53
|
VIRTUALIZED_VIEWED_PAYMENT_FORM = "virtualized_viewd_payment_form",
|
|
54
54
|
METRIC = "metric",
|
|
55
|
-
WEB_VITAL = "web_vital"
|
|
55
|
+
WEB_VITAL = "web_vital",
|
|
56
|
+
LOG = "log"
|
|
56
57
|
}
|
|
57
58
|
|
|
58
59
|
}
|
|
@@ -388,6 +389,34 @@ declare module '@adtrackify/at-tracking-event-types/types/common/address' {
|
|
|
388
389
|
declare module '@adtrackify/at-tracking-event-types/types/common/index' {
|
|
389
390
|
export * from '@adtrackify/at-tracking-event-types/types/common/address';
|
|
390
391
|
|
|
392
|
+
}
|
|
393
|
+
declare module '@adtrackify/at-tracking-event-types/types/common/logger' {
|
|
394
|
+
export interface LogContext {
|
|
395
|
+
[x: string]: LogContextValue;
|
|
396
|
+
}
|
|
397
|
+
export type LogContextValue = string | number | boolean | LogContext | LogContextArray | undefined | null;
|
|
398
|
+
export interface LogContextArray extends Array<LogContextValue> {
|
|
399
|
+
}
|
|
400
|
+
export enum LogLevel {
|
|
401
|
+
debug = "debug",
|
|
402
|
+
error = "error",
|
|
403
|
+
info = "info",
|
|
404
|
+
trace = "trace",
|
|
405
|
+
warn = "warn"
|
|
406
|
+
}
|
|
407
|
+
export const LogLevelId: {
|
|
408
|
+
trace: number;
|
|
409
|
+
debug: number;
|
|
410
|
+
info: number;
|
|
411
|
+
warn: number;
|
|
412
|
+
error: number;
|
|
413
|
+
};
|
|
414
|
+
export interface LogMessage {
|
|
415
|
+
message: string;
|
|
416
|
+
logLevel: LogLevel;
|
|
417
|
+
context?: LogContext;
|
|
418
|
+
}
|
|
419
|
+
|
|
391
420
|
}
|
|
392
421
|
declare module '@adtrackify/at-tracking-event-types/types/index' {
|
|
393
422
|
export * from '@adtrackify/at-tracking-event-types/types/api/index';
|
|
@@ -498,6 +527,7 @@ declare module '@adtrackify/at-tracking-event-types/types/tracking-events/tracki
|
|
|
498
527
|
import { AddressInfo } from '@adtrackify/at-tracking-event-types/types/common/address';
|
|
499
528
|
import { TrackingEventContext } from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-context';
|
|
500
529
|
import { TrackingEventIdentity } from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-identity';
|
|
530
|
+
import { LogMessage } from '@adtrackify/at-tracking-event-types/types/common/logger';
|
|
501
531
|
export interface Event {
|
|
502
532
|
id: string;
|
|
503
533
|
type: ADTRACKIFY_EVENT_TYPE;
|
|
@@ -516,6 +546,9 @@ declare module '@adtrackify/at-tracking-event-types/types/tracking-events/tracki
|
|
|
516
546
|
export interface MetricEvent extends Event {
|
|
517
547
|
data: MetricEventData;
|
|
518
548
|
}
|
|
549
|
+
export interface LogEvent extends Event {
|
|
550
|
+
data: LogEventData;
|
|
551
|
+
}
|
|
519
552
|
export interface TrackingEventData {
|
|
520
553
|
[key: string]: any;
|
|
521
554
|
firstName?: string;
|
|
@@ -566,6 +599,8 @@ declare module '@adtrackify/at-tracking-event-types/types/tracking-events/tracki
|
|
|
566
599
|
category4?: string;
|
|
567
600
|
category5?: string;
|
|
568
601
|
}
|
|
602
|
+
export interface LogEventData extends LogMessage {
|
|
603
|
+
}
|
|
569
604
|
export interface MetricEventData {
|
|
570
605
|
[key: string]: any;
|
|
571
606
|
name: string;
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var s=(n=>(n.PENDING="pending",n.ACTIVE="active",n.INACTIVE="inactive",n))(s||{});var g=(i=>(i.FACEBOOK="facebook",i.TIKTOK="tiktok",i.GOOGLE_ADS="googleAds",i.GOOGLE_ANALYTICS_4="googleAnalytics4",i.HUBSPOT="hubspot",i.WEBHOOK="webhook",i.CUSTOM_HTML="customHTML",i.CUSTOM_JS="customJS",i.SNAPCHAT="snapchat",i.TWITTER="twitter",i.REDDIT="reddit",i))(g||{});var c=(n=>(n.HEADER="header",n.FOOTER="footer",n.BODY="body",n))(c||{});var p=(o=>(o.STARTED="started",o.COMPLETED="completed",o.UNINSTALLED="uninstalled",o.FAILED="failed",o.NONE="none",o))(p||{}),d=(e=>(e.ACTIVE="active",e.CANCELLED="cancelled",e.DECLINED="declined",e.EXPIRED="expired",e.FROZEN="frozen",e.PENDING="pending",e.NOT_SUBMITTED="na",e))(d||{});var f=(a=>(a.MONTHLY="monthly",a.YEARLY="yearly",a))(f||{}),m=(r=>(r.CURRENT="current",r.PAST_DUE="past_due",r.CANCELLED="cancelled",r.FAILED="failed",r))(m||{}),l=(e=>(e.ACTIVE="active",e.CANCELLED="cancelled",e.DECLINED="declined",e.EXPIRED="expired",e.FROZEN="frozen",e.PENDING="pending",e.NOT_SUBMITTED="na",e))(l||{}),u=(n=>(n.STRIPE="stripe",n.PAYPAL="paypal",n.SHOPIFY="shopify",n))(u||{});var x=(t=>(t.ADD_PAYMENT_INFO="add_payment_info",t.ADD_SHIPPING_INFO="add_shipping_info",t.ADD_TO_CART="add_to_cart",t.ADD_TO_WISHLIST="add_to_wishlist",t.INITIATE_CHECKOUT="initiate_checkout",t.LEAD="lead",t.LOGIN="login",t.PAGE_VIEW="page_view",t.PURCHASE="purchase",t.REFUND="refund",t.SEARCH="search",t.SIGN_UP="sign_up",t.VIEW_CART="view_cart",t.VIEW_CONTENT="view_content",t.SELECT_SHIPPING_METHOD="select_shipping_method",t.VIRTUALIZED_VIEWED_PAYMENT_FORM="virtualized_viewd_payment_form",t.METRIC="metric",t.WEB_VITAL="web_vital",t))(x||{});var U=["AED","ARS","AUD","BDT","BIF","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DZD","EGP","EUR","GBP","GTQ","HKD","HNL","HUF","IDR","ILS","INR","ISK","JPY","KES","KRW","KWD","KZT","MAD","MOP","MXN","MYR","NGN","NIO","NOK","NZD","PEN","PHP","PKR","PLN","PYG","QAR","RON","RUB","SAR","SEK","SGD","THB","TRY","TWD","USD","VES","VND","ZAR"];var
|
|
1
|
+
var s=(n=>(n.PENDING="pending",n.ACTIVE="active",n.INACTIVE="inactive",n))(s||{});var g=(i=>(i.FACEBOOK="facebook",i.TIKTOK="tiktok",i.GOOGLE_ADS="googleAds",i.GOOGLE_ANALYTICS_4="googleAnalytics4",i.HUBSPOT="hubspot",i.WEBHOOK="webhook",i.CUSTOM_HTML="customHTML",i.CUSTOM_JS="customJS",i.SNAPCHAT="snapchat",i.TWITTER="twitter",i.REDDIT="reddit",i))(g||{});var c=(n=>(n.HEADER="header",n.FOOTER="footer",n.BODY="body",n))(c||{});var p=(o=>(o.STARTED="started",o.COMPLETED="completed",o.UNINSTALLED="uninstalled",o.FAILED="failed",o.NONE="none",o))(p||{}),d=(e=>(e.ACTIVE="active",e.CANCELLED="cancelled",e.DECLINED="declined",e.EXPIRED="expired",e.FROZEN="frozen",e.PENDING="pending",e.NOT_SUBMITTED="na",e))(d||{});var f=(a=>(a.MONTHLY="monthly",a.YEARLY="yearly",a))(f||{}),m=(r=>(r.CURRENT="current",r.PAST_DUE="past_due",r.CANCELLED="cancelled",r.FAILED="failed",r))(m||{}),l=(e=>(e.ACTIVE="active",e.CANCELLED="cancelled",e.DECLINED="declined",e.EXPIRED="expired",e.FROZEN="frozen",e.PENDING="pending",e.NOT_SUBMITTED="na",e))(l||{}),u=(n=>(n.STRIPE="stripe",n.PAYPAL="paypal",n.SHOPIFY="shopify",n))(u||{});var x=(t=>(t.ADD_PAYMENT_INFO="add_payment_info",t.ADD_SHIPPING_INFO="add_shipping_info",t.ADD_TO_CART="add_to_cart",t.ADD_TO_WISHLIST="add_to_wishlist",t.INITIATE_CHECKOUT="initiate_checkout",t.LEAD="lead",t.LOGIN="login",t.PAGE_VIEW="page_view",t.PURCHASE="purchase",t.REFUND="refund",t.SEARCH="search",t.SIGN_UP="sign_up",t.VIEW_CART="view_cart",t.VIEW_CONTENT="view_content",t.SELECT_SHIPPING_METHOD="select_shipping_method",t.VIRTUALIZED_VIEWED_PAYMENT_FORM="virtualized_viewd_payment_form",t.METRIC="metric",t.WEB_VITAL="web_vital",t.LOG="log",t))(x||{});var U=["AED","ARS","AUD","BDT","BIF","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DZD","EGP","EUR","GBP","GTQ","HKD","HNL","HUF","IDR","ILS","INR","ISK","JPY","KES","KRW","KWD","KZT","MAD","MOP","MXN","MYR","NGN","NIO","NOK","NZD","PEN","PHP","PKR","PLN","PYG","QAR","RON","RUB","SAR","SEK","SGD","THB","TRY","TWD","USD","VES","VND","ZAR"];var b=(r=>(r.TRACKING="tracking",r.METRIC="metric",r.IDENTIFY="identify",r.LOG="log",r))(b||{});export{s as ACCOUNT_STATUS,b as ADTRACKIFY_EVENT_TYPE,x as ADTRACKIFY_STANDARD_EVENT,U as Currencies,c as CustomHTMLLocation,g as DESTINATIONS,u as PAYMENT_GATEWAY,m as PAYMENT_STATUS,f as PLAN_BILLING_FREQUENCY,l as SUBSCRIPTION_STATUS,p as ShopifyAppInstallStatus,d as ShopifyAppSubscriptionStatus};
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/types/api/account.ts", "../src/types/api/destinations/destinations.ts", "../src/types/api/destinations/third-party-destination-configs.ts", "../src/types/api/shopify-app-install.ts", "../src/types/api/subscription.ts", "../src/types/adtrackify-standard-events.ts", "../src/types/tracking-events/tracking-event-type.ts", "../src/types/adtrackify-event-types.ts"],
|
|
4
|
-
"sourcesContent": ["import { Subscription } from './subscription';\n\nexport interface Account {\n id: string,\n accountName: string,\n companyName?: string,\n accountStatus: ACCOUNT_STATUS,\n primaryEmail: string,\n publicApiKey?: string,\n subscriptionId?: string,\n pixels?: Pixel[],\n subscription?: Subscription;\n ownerId?: string,\n createdAt: string,\n updatedAt: string;\n}\n\n\nexport interface Pixel {\n id: string;\n accountId: string;\n name: string;\n createdAt: string,\n updatedAt: string;\n}\n\nexport enum ACCOUNT_STATUS {\n PENDING = 'pending',\n ACTIVE = 'active',\n INACTIVE = 'inactive'\n}", "\r\nexport interface Destination {\r\n id: string,\r\n accountId: string,\r\n pixelId: string,\r\n destination: string;\r\n displayName?: string,\r\n enabled: boolean;\r\n configuration?: UserDestinationConfiguration,\r\n createdAt: string,\r\n updatedAt: string;\r\n}\r\n\r\nexport enum DESTINATIONS {\r\n FACEBOOK = 'facebook',\r\n TIKTOK = 'tiktok',\r\n GOOGLE_ADS = 'googleAds',\r\n GOOGLE_ANALYTICS_4 = 'googleAnalytics4',\r\n HUBSPOT = 'hubspot',\r\n WEBHOOK = 'webhook',\r\n CUSTOM_HTML = 'customHTML',\r\n CUSTOM_JS = 'customJS',\r\n SNAPCHAT = 'snapchat',\r\n TWITTER = 'twitter',\r\n REDDIT = 'reddit'\r\n}\r\n\r\nexport interface UserDestinationConfiguration {\r\n [ key: string ]: any;\r\n eventBlacklist?: string[];\r\n events?: EventConfiguration[];\r\n trigger?: DestinationTriggerConfiguration;\r\n}\r\n\r\nexport interface DestinationTriggerConfiguration {\r\n shopify?: ShopifyTriggerConfiguration;\r\n exludeDomains?: string[];\r\n excludePages?: string[];\r\n domains?: string[];\r\n pages?: string[];\r\n}\r\n\r\nexport interface ShopifyTriggerConfiguration {\r\n enabled: boolean;\r\n collections?: string[];\r\n tags?: string[];\r\n}\r\n\r\n\r\nexport interface EventConfiguration {\r\n sourceEventName: string;\r\n exclude?: boolean;\r\n sample: EventSampleConfiguration;\r\n transformations?: EventTransformation[];\r\n}\r\n\r\nexport interface EventTransformation {\r\n transformationEventName: string;\r\n enabled: boolean;\r\n}\r\n\r\nexport interface EventSampleConfiguration {\r\n enabled: boolean;\r\n rate: number;\r\n}\r\n\r\n", "import { Destination, UserDestinationConfiguration } from './destinations';\r\n\r\nexport interface AdTrackifyFacebookDestination extends Destination {\r\n configuration: FacebookPixelConfiguration;\r\n}\r\n\r\nexport interface AdTrackifyTikTokDestination extends Destination {\r\n configuration: TiktokPixelConfiguration;\r\n}\r\n\r\nexport interface AdTrackifyGoogleAnalytics4Destination extends Destination {\r\n configuration: GoogleAnalytics4Configuration;\r\n}\r\n\r\n// Destination Specific configurations below\r\nexport interface FacebookPixelConfiguration extends UserDestinationConfiguration {\r\n apiAccessToken?: string;\r\n enableConversionAPI: boolean;\r\n pixelId: string;\r\n}\r\n\r\nexport interface TiktokPixelConfiguration extends UserDestinationConfiguration {\r\n apiAccessToken?: string;\r\n enableConversionAPI: boolean;\r\n pixelId: string;\r\n}\r\n\r\nexport interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {\r\n apiSecret: string;\r\n measurementId: string;\r\n}\r\n\r\nexport interface GoogleAdsConfiguration extends UserDestinationConfiguration {\r\n pixelId: string;\r\n conversionID: string;\r\n}\r\n\r\nexport interface HubspotPixelConfiguration extends UserDestinationConfiguration {\r\n hubspotId: string;\r\n}\r\n\r\nexport interface SnapchatPixelConfiguration extends UserDestinationConfiguration {\r\n snapchatPixelId: string;\r\n}\r\n\r\nexport interface TwitterPixelConfiguration extends UserDestinationConfiguration {\r\n twitterPixelId: string;\r\n}\r\n\r\nexport interface WebhookConfiguration extends UserDestinationConfiguration {\r\n webhookUrl: string;\r\n}\r\n\r\nexport interface CustomHTMLConfiguration extends UserDestinationConfiguration {\r\n html: string;\r\n location: CustomHTMLLocation;\r\n}\r\n\r\nexport interface CustomJSConfiguration extends UserDestinationConfiguration {\r\n script: string;\r\n async: boolean;\r\n defer: boolean;\r\n location: CustomHTMLLocation;\r\n}\r\n\r\nexport enum CustomHTMLLocation {\r\n HEADER = 'header',\r\n FOOTER = 'footer',\r\n BODY = 'body'\r\n}\r\n\r\n", "export interface ShopifyAppInstall {\n shopifyAppInstallId: string;\n shop: string;\n accessToken?: string;\n appStatus?: string;\n appSubscriptionStatus?: ShopifyAppSubscriptionStatus;\n code?: string;\n hmac?: string;\n host?: string;\n installRequest?: ShopifyInstallRequest;\n isAppEnabled?: boolean;\n pixelId?: string;\n shopInfo?: any;\n state?: string;\n timestamp?: number;\n createdAt: string;\n updatedAt: string;\n}\n\nexport enum ShopifyAppInstallStatus {\n STARTED = 'started',\n COMPLETED = 'completed',\n UNINSTALLED = 'uninstalled',\n FAILED = 'failed',\n NONE = 'none'\n}\nexport enum ShopifyAppSubscriptionStatus {\n ACTIVE = 'active', // approved and billed to shop\n CANCELLED = 'cancelled', // cancelled, uninstalled or cancellation\n DECLINED = 'declined', // subscription declined by merchant\n EXPIRED = 'expired', //wasn't approved within two days of being created\n FROZEN = 'frozen', //on hold due to not payment\n PENDING = 'pending', // pending approval\n NOT_SUBMITTED = 'na' // billing has not yet been attempted\n}\n\nexport interface ShopifyInstallRequest {\n shop?: string;\n session?: string;\n hmac?: string;\n host?: string;\n nonce?: string;\n timestamp?: string;\n status?: string;\n}\n\nexport interface ShopifyStoreInfo {\n // TBD based on shopify api\n [ key: string ]: any;\n}", "\nexport interface Subscription {\n id: string,\n accountId?: string,\n shopifyAppInstallId?: string,\n shopifyDomain?: string,\n stripeCustomerId?: string,\n stripeSubscriptionId?: string,\n stripeCompletedCheckoutSession?: any;\n shopifyChargeId?: string;\n subscriptionPlan?: SubscriptionPlan,\n status?: SUBSCRIPTION_STATUS,\n paymentStatus?: PAYMENT_STATUS,\n paymentGateway?: PAYMENT_GATEWAY,\n createdAt: string,\n updatedAt: string,\n\n}\nexport interface SubscriptionPlan {\n id: number;\n planName: string;\n displayName: string;\n description: string;\n sku: string;\n price: string;\n displayPrice: string;\n billingFrequency: PLAN_BILLING_FREQUENCY;\n trialLengthDays?: number;\n trialRequiresCreditCard?: boolean;\n planDesc?: string[];\n unitPriceText?: string;\n isHighlighted?: boolean;\n isBanner?: boolean;\n bannerText?: string;\n bannerColor?: string;\n stripePriceId?: string;\n stripeProductId?: string;\n}\n\nexport enum PLAN_BILLING_FREQUENCY {\n MONTHLY = 'monthly',\n YEARLY = 'yearly'\n}\n\nexport enum PAYMENT_STATUS {\n CURRENT = 'current',\n PAST_DUE = 'past_due',\n CANCELLED = 'cancelled',\n FAILED = 'failed'\n}\n\nexport enum SUBSCRIPTION_STATUS {\n ACTIVE = 'active', // approved and billed to shop\n CANCELLED = 'cancelled', // cancelled, uninstalled or cancellation\n DECLINED = 'declined', // subscription declined by merchant\n EXPIRED = 'expired', //wasn't approved within two days of being created\n FROZEN = 'frozen', //on hold due to not payment\n PENDING = 'pending', // pending approval\n NOT_SUBMITTED = 'na' // billing has not yet been attempted\n}\nexport enum PAYMENT_GATEWAY {\n STRIPE = 'stripe',\n PAYPAL = 'paypal',\n SHOPIFY = 'shopify'\n}\n", "export enum ADTRACKIFY_STANDARD_EVENT {\n ADD_PAYMENT_INFO = 'add_payment_info',\n ADD_SHIPPING_INFO = 'add_shipping_info',\n ADD_TO_CART = 'add_to_cart',\n ADD_TO_WISHLIST = 'add_to_wishlist',\n // COMPLETE_REGISTRATION: 'complete_registration',\n // CONTACT: 'contact',\n INITIATE_CHECKOUT = 'initiate_checkout',\n LEAD = 'lead',\n LOGIN = 'login',\n PAGE_VIEW = 'page_view',\n PURCHASE = 'purchase',\n REFUND = 'refund',\n SEARCH = 'search',\n // START_TRIAL: 'start_trial',\n // SUBMIT_APPLICATION: 'submit_application',\n // SUBSCRIBE: 'subscribe',\n SIGN_UP = 'sign_up',\n VIEW_CART = 'view_cart',\n VIEW_CONTENT = 'view_content',\n\n //\n SELECT_SHIPPING_METHOD = 'select_shipping_method',\n VIRTUALIZED_VIEWED_PAYMENT_FORM = 'virtualized_viewd_payment_form',\n\n METRIC = 'metric',\n WEB_VITAL = 'web_vital',\n}\n", "import { ADTRACKIFY_STANDARD_EVENT } from '../adtrackify-standard-events';\nimport { ADTRACKIFY_EVENT_TYPE } from '../adtrackify-event-types';\nimport { AddressInfo } from '../common/address';\nimport { TrackingEventContext } from './tracking-event-context';\nimport { TrackingEventIdentity } from './tracking-event-identity';\n\nexport interface Event {\n id: string;\n type: ADTRACKIFY_EVENT_TYPE;\n name: ADTRACKIFY_STANDARD_EVENT;\n pixelId: string;\n sentAtEpoch?: number;\n collectedAt?: string;\n version: string;\n context?: TrackingEventContext;\n}\n\nexport interface TrackingEvent extends Event {\n identity?: TrackingEventIdentity;\n data?: TrackingEventData;\n testCode?: string;\n}\n\nexport interface MetricEvent extends Event {\n data: MetricEventData;\n}\n\nexport interface TrackingEventData {\n [ key: string ]: any;\n firstName?: string;\n lastName?: string;\n email?: string;\n phone?: string;\n addresses?: AddressInfo[];\n cartId?: string;\n transactionId?: string;\n affiliation?: string;\n currency?: string;\n price?: number;\n subtotalPrice?: number;\n value?: number;\n tax?: number;\n shipping?: number;\n coupon?: string;\n paymentType?: string;\n shippingTier?: string;\n creativeName?: string;\n creativeSlot?: string;\n locationId?: string;\n promotionId?: string;\n promotionName?: string;\n items?: GenericContent[];\n}\n\nexport interface GenericContent {\n [ key: string ]: any;\n content_type?: string;\n id?: string;\n name?: string;\n sku?: string;\n brand?: string;\n variant?: string;\n coupon?: string;\n currency?: string;\n discount?: number;\n index?: number;\n value?: number;\n price?: number;\n quantity?: number;\n url?: string;\n locationId?: string;\n imageUrl?: string;\n category?: string;\n category2?: string;\n category3?: string;\n category4?: string;\n category5?: string;\n}\n\nexport interface MetricEventData {\n [ key: string ]: any;\n name: string;\n value: number;\n}\n\nexport const Currencies: string[] = [ 'AED', 'ARS', 'AUD', 'BDT', 'BIF', 'BOB', 'BRL', 'CAD', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CZK', 'DKK', 'DZD', 'EGP', 'EUR', 'GBP', 'GTQ', 'HKD', 'HNL', 'HUF', 'IDR', 'ILS', 'INR', 'ISK', 'JPY', 'KES', 'KRW', 'KWD', 'KZT', 'MAD', 'MOP', 'MXN', 'MYR', 'NGN', 'NIO', 'NOK', 'NZD', 'PEN', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RUB', 'SAR', 'SEK', 'SGD', 'THB', 'TRY', 'TWD', 'USD', 'VES', 'VND', 'ZAR' ];", "export enum ADTRACKIFY_EVENT_TYPE {\n TRACKING = 'tracking',\n METRIC = 'metric',\n IDENTIFY = 'identify',\n LOG = 'log',\n}\n"],
|
|
5
|
-
"mappings": "AA0BO,IAAKA,OACVA,EAAA,QAAU,UACVA,EAAA,OAAS,SACTA,EAAA,SAAW,WAHDA,OAAA,ICbL,IAAKC,OACVA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,WAAa,YACbA,EAAA,mBAAqB,mBACrBA,EAAA,QAAU,UACVA,EAAA,QAAU,UACVA,EAAA,YAAc,aACdA,EAAA,UAAY,WACZA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,OAAS,SAXCA,OAAA,ICoDL,IAAKC,OACVA,EAAA,OAAS,SACTA,EAAA,OAAS,SACTA,EAAA,KAAO,OAHGA,OAAA,IC9CL,IAAKC,OACVA,EAAA,QAAU,UACVA,EAAA,UAAY,YACZA,EAAA,YAAc,cACdA,EAAA,OAAS,SACTA,EAAA,KAAO,OALGA,OAAA,IAOAC,OACVA,EAAA,OAAS,SACTA,EAAA,UAAY,YACZA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,OAAS,SACTA,EAAA,QAAU,UACVA,EAAA,cAAgB,KAPNA,OAAA,ICaL,IAAKC,OACVA,EAAA,QAAU,UACVA,EAAA,OAAS,SAFCA,OAAA,IAKAC,OACVA,EAAA,QAAU,UACVA,EAAA,SAAW,WACXA,EAAA,UAAY,YACZA,EAAA,OAAS,SAJCA,OAAA,IAOAC,OACVA,EAAA,OAAS,SACTA,EAAA,UAAY,YACZA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,OAAS,SACTA,EAAA,QAAU,UACVA,EAAA,cAAgB,KAPNA,OAAA,IASAC,OACVA,EAAA,OAAS,SACTA,EAAA,OAAS,SACTA,EAAA,QAAU,UAHAA,OAAA,IC5DL,IAAKC,OACVA,EAAA,iBAAmB,mBACnBA,EAAA,kBAAoB,oBACpBA,EAAA,YAAc,cACdA,EAAA,gBAAkB,kBAGlBA,EAAA,kBAAoB,oBACpBA,EAAA,KAAO,OACPA,EAAA,MAAQ,QACRA,EAAA,UAAY,YACZA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,OAAS,SAITA,EAAA,QAAU,UACVA,EAAA,UAAY,YACZA,EAAA,aAAe,eAGfA,EAAA,uBAAyB,yBACzBA,EAAA,gCAAkC,iCAElCA,EAAA,OAAS,SACTA,EAAA,UAAY,
|
|
4
|
+
"sourcesContent": ["import { Subscription } from './subscription';\n\nexport interface Account {\n id: string,\n accountName: string,\n companyName?: string,\n accountStatus: ACCOUNT_STATUS,\n primaryEmail: string,\n publicApiKey?: string,\n subscriptionId?: string,\n pixels?: Pixel[],\n subscription?: Subscription;\n ownerId?: string,\n createdAt: string,\n updatedAt: string;\n}\n\n\nexport interface Pixel {\n id: string;\n accountId: string;\n name: string;\n createdAt: string,\n updatedAt: string;\n}\n\nexport enum ACCOUNT_STATUS {\n PENDING = 'pending',\n ACTIVE = 'active',\n INACTIVE = 'inactive'\n}", "\nexport interface Destination {\n id: string,\n accountId: string,\n pixelId: string,\n destination: string;\n displayName?: string,\n enabled: boolean;\n configuration?: UserDestinationConfiguration,\n createdAt: string,\n updatedAt: string;\n}\n\nexport enum DESTINATIONS {\n FACEBOOK = 'facebook',\n TIKTOK = 'tiktok',\n GOOGLE_ADS = 'googleAds',\n GOOGLE_ANALYTICS_4 = 'googleAnalytics4',\n HUBSPOT = 'hubspot',\n WEBHOOK = 'webhook',\n CUSTOM_HTML = 'customHTML',\n CUSTOM_JS = 'customJS',\n SNAPCHAT = 'snapchat',\n TWITTER = 'twitter',\n REDDIT = 'reddit'\n}\n\nexport interface UserDestinationConfiguration {\n [ key: string ]: any;\n eventBlacklist?: string[];\n events?: EventConfiguration[];\n trigger?: DestinationTriggerConfiguration;\n}\n\nexport interface DestinationTriggerConfiguration {\n shopify?: ShopifyTriggerConfiguration;\n exludeDomains?: string[];\n excludePages?: string[];\n domains?: string[];\n pages?: string[];\n}\n\nexport interface ShopifyTriggerConfiguration {\n enabled: boolean;\n collections?: string[];\n tags?: string[];\n}\n\n\nexport interface EventConfiguration {\n sourceEventName: string;\n exclude?: boolean;\n sample: EventSampleConfiguration;\n transformations?: EventTransformation[];\n}\n\nexport interface EventTransformation {\n transformationEventName: string;\n enabled: boolean;\n}\n\nexport interface EventSampleConfiguration {\n enabled: boolean;\n rate: number;\n}\n\n", "import { Destination, UserDestinationConfiguration } from './destinations';\n\nexport interface AdTrackifyFacebookDestination extends Destination {\n configuration: FacebookPixelConfiguration;\n}\n\nexport interface AdTrackifyTikTokDestination extends Destination {\n configuration: TiktokPixelConfiguration;\n}\n\nexport interface AdTrackifyGoogleAnalytics4Destination extends Destination {\n configuration: GoogleAnalytics4Configuration;\n}\n\n// Destination Specific configurations below\nexport interface FacebookPixelConfiguration extends UserDestinationConfiguration {\n apiAccessToken?: string;\n enableConversionAPI: boolean;\n pixelId: string;\n}\n\nexport interface TiktokPixelConfiguration extends UserDestinationConfiguration {\n apiAccessToken?: string;\n enableConversionAPI: boolean;\n pixelId: string;\n}\n\nexport interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {\n apiSecret: string;\n measurementId: string;\n}\n\nexport interface GoogleAdsConfiguration extends UserDestinationConfiguration {\n pixelId: string;\n conversionID: string;\n}\n\nexport interface HubspotPixelConfiguration extends UserDestinationConfiguration {\n hubspotId: string;\n}\n\nexport interface SnapchatPixelConfiguration extends UserDestinationConfiguration {\n snapchatPixelId: string;\n}\n\nexport interface TwitterPixelConfiguration extends UserDestinationConfiguration {\n twitterPixelId: string;\n}\n\nexport interface WebhookConfiguration extends UserDestinationConfiguration {\n webhookUrl: string;\n}\n\nexport interface CustomHTMLConfiguration extends UserDestinationConfiguration {\n html: string;\n location: CustomHTMLLocation;\n}\n\nexport interface CustomJSConfiguration extends UserDestinationConfiguration {\n script: string;\n async: boolean;\n defer: boolean;\n location: CustomHTMLLocation;\n}\n\nexport enum CustomHTMLLocation {\n HEADER = 'header',\n FOOTER = 'footer',\n BODY = 'body'\n}\n\n", "export interface ShopifyAppInstall {\n shopifyAppInstallId: string;\n shop: string;\n accessToken?: string;\n appStatus?: string;\n appSubscriptionStatus?: ShopifyAppSubscriptionStatus;\n code?: string;\n hmac?: string;\n host?: string;\n installRequest?: ShopifyInstallRequest;\n isAppEnabled?: boolean;\n pixelId?: string;\n shopInfo?: any;\n state?: string;\n timestamp?: number;\n createdAt: string;\n updatedAt: string;\n}\n\nexport enum ShopifyAppInstallStatus {\n STARTED = 'started',\n COMPLETED = 'completed',\n UNINSTALLED = 'uninstalled',\n FAILED = 'failed',\n NONE = 'none'\n}\nexport enum ShopifyAppSubscriptionStatus {\n ACTIVE = 'active', // approved and billed to shop\n CANCELLED = 'cancelled', // cancelled, uninstalled or cancellation\n DECLINED = 'declined', // subscription declined by merchant\n EXPIRED = 'expired', //wasn't approved within two days of being created\n FROZEN = 'frozen', //on hold due to not payment\n PENDING = 'pending', // pending approval\n NOT_SUBMITTED = 'na' // billing has not yet been attempted\n}\n\nexport interface ShopifyInstallRequest {\n shop?: string;\n session?: string;\n hmac?: string;\n host?: string;\n nonce?: string;\n timestamp?: string;\n status?: string;\n}\n\nexport interface ShopifyStoreInfo {\n // TBD based on shopify api\n [ key: string ]: any;\n}", "\nexport interface Subscription {\n id: string,\n accountId?: string,\n shopifyAppInstallId?: string,\n shopifyDomain?: string,\n stripeCustomerId?: string,\n stripeSubscriptionId?: string,\n stripeCompletedCheckoutSession?: any;\n shopifyChargeId?: string;\n subscriptionPlan?: SubscriptionPlan,\n status?: SUBSCRIPTION_STATUS,\n paymentStatus?: PAYMENT_STATUS,\n paymentGateway?: PAYMENT_GATEWAY,\n createdAt: string,\n updatedAt: string,\n\n}\nexport interface SubscriptionPlan {\n id: number;\n planName: string;\n displayName: string;\n description: string;\n sku: string;\n price: string;\n displayPrice: string;\n billingFrequency: PLAN_BILLING_FREQUENCY;\n trialLengthDays?: number;\n trialRequiresCreditCard?: boolean;\n planDesc?: string[];\n unitPriceText?: string;\n isHighlighted?: boolean;\n isBanner?: boolean;\n bannerText?: string;\n bannerColor?: string;\n stripePriceId?: string;\n stripeProductId?: string;\n}\n\nexport enum PLAN_BILLING_FREQUENCY {\n MONTHLY = 'monthly',\n YEARLY = 'yearly'\n}\n\nexport enum PAYMENT_STATUS {\n CURRENT = 'current',\n PAST_DUE = 'past_due',\n CANCELLED = 'cancelled',\n FAILED = 'failed'\n}\n\nexport enum SUBSCRIPTION_STATUS {\n ACTIVE = 'active', // approved and billed to shop\n CANCELLED = 'cancelled', // cancelled, uninstalled or cancellation\n DECLINED = 'declined', // subscription declined by merchant\n EXPIRED = 'expired', //wasn't approved within two days of being created\n FROZEN = 'frozen', //on hold due to not payment\n PENDING = 'pending', // pending approval\n NOT_SUBMITTED = 'na' // billing has not yet been attempted\n}\nexport enum PAYMENT_GATEWAY {\n STRIPE = 'stripe',\n PAYPAL = 'paypal',\n SHOPIFY = 'shopify'\n}\n", "export enum ADTRACKIFY_STANDARD_EVENT {\n ADD_PAYMENT_INFO = 'add_payment_info',\n ADD_SHIPPING_INFO = 'add_shipping_info',\n ADD_TO_CART = 'add_to_cart',\n ADD_TO_WISHLIST = 'add_to_wishlist',\n // COMPLETE_REGISTRATION: 'complete_registration',\n // CONTACT: 'contact',\n INITIATE_CHECKOUT = 'initiate_checkout',\n LEAD = 'lead',\n LOGIN = 'login',\n PAGE_VIEW = 'page_view',\n PURCHASE = 'purchase',\n REFUND = 'refund',\n SEARCH = 'search',\n // START_TRIAL: 'start_trial',\n // SUBMIT_APPLICATION: 'submit_application',\n // SUBSCRIBE: 'subscribe',\n SIGN_UP = 'sign_up',\n VIEW_CART = 'view_cart',\n VIEW_CONTENT = 'view_content',\n\n //\n SELECT_SHIPPING_METHOD = 'select_shipping_method',\n VIRTUALIZED_VIEWED_PAYMENT_FORM = 'virtualized_viewd_payment_form',\n\n METRIC = 'metric',\n WEB_VITAL = 'web_vital',\n\n // LOG\n LOG = 'log',\n}\n", "import { ADTRACKIFY_STANDARD_EVENT } from '../adtrackify-standard-events';\nimport { ADTRACKIFY_EVENT_TYPE } from '../adtrackify-event-types';\nimport { AddressInfo } from '../common/address';\nimport { TrackingEventContext } from './tracking-event-context';\nimport { TrackingEventIdentity } from './tracking-event-identity';\nimport { LogMessage } from '../common/logger';\n\nexport interface Event {\n id: string;\n type: ADTRACKIFY_EVENT_TYPE;\n name: ADTRACKIFY_STANDARD_EVENT;\n pixelId: string;\n sentAtEpoch?: number;\n collectedAt?: string;\n version: string;\n context?: TrackingEventContext;\n}\n\nexport interface TrackingEvent extends Event {\n identity?: TrackingEventIdentity;\n data?: TrackingEventData;\n testCode?: string;\n}\n\nexport interface MetricEvent extends Event {\n data: MetricEventData;\n}\n\nexport interface LogEvent extends Event {\n data: LogEventData;\n}\n\nexport interface TrackingEventData {\n [key: string]: any;\n firstName?: string;\n lastName?: string;\n email?: string;\n phone?: string;\n addresses?: AddressInfo[];\n cartId?: string;\n transactionId?: string;\n affiliation?: string;\n currency?: string;\n price?: number;\n subtotalPrice?: number;\n value?: number;\n tax?: number;\n shipping?: number;\n coupon?: string;\n paymentType?: string;\n shippingTier?: string;\n creativeName?: string;\n creativeSlot?: string;\n locationId?: string;\n promotionId?: string;\n promotionName?: string;\n items?: GenericContent[];\n}\n\nexport interface GenericContent {\n [key: string]: any;\n content_type?: string;\n id?: string;\n name?: string;\n sku?: string;\n brand?: string;\n variant?: string;\n coupon?: string;\n currency?: string;\n discount?: number;\n index?: number;\n value?: number;\n price?: number;\n quantity?: number;\n url?: string;\n locationId?: string;\n imageUrl?: string;\n category?: string;\n category2?: string;\n category3?: string;\n category4?: string;\n category5?: string;\n}\n\nexport interface LogEventData extends LogMessage {}\nexport interface MetricEventData {\n [key: string]: any;\n name: string;\n value: number;\n}\n\nexport const Currencies: string[] = [\n 'AED',\n 'ARS',\n 'AUD',\n 'BDT',\n 'BIF',\n 'BOB',\n 'BRL',\n 'CAD',\n 'CHF',\n 'CLP',\n 'CNY',\n 'COP',\n 'CRC',\n 'CZK',\n 'DKK',\n 'DZD',\n 'EGP',\n 'EUR',\n 'GBP',\n 'GTQ',\n 'HKD',\n 'HNL',\n 'HUF',\n 'IDR',\n 'ILS',\n 'INR',\n 'ISK',\n 'JPY',\n 'KES',\n 'KRW',\n 'KWD',\n 'KZT',\n 'MAD',\n 'MOP',\n 'MXN',\n 'MYR',\n 'NGN',\n 'NIO',\n 'NOK',\n 'NZD',\n 'PEN',\n 'PHP',\n 'PKR',\n 'PLN',\n 'PYG',\n 'QAR',\n 'RON',\n 'RUB',\n 'SAR',\n 'SEK',\n 'SGD',\n 'THB',\n 'TRY',\n 'TWD',\n 'USD',\n 'VES',\n 'VND',\n 'ZAR',\n];\n", "export enum ADTRACKIFY_EVENT_TYPE {\n TRACKING = 'tracking',\n METRIC = 'metric',\n IDENTIFY = 'identify',\n LOG = 'log',\n}\n"],
|
|
5
|
+
"mappings": "AA0BO,IAAKA,OACVA,EAAA,QAAU,UACVA,EAAA,OAAS,SACTA,EAAA,SAAW,WAHDA,OAAA,ICbL,IAAKC,OACVA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,WAAa,YACbA,EAAA,mBAAqB,mBACrBA,EAAA,QAAU,UACVA,EAAA,QAAU,UACVA,EAAA,YAAc,aACdA,EAAA,UAAY,WACZA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,OAAS,SAXCA,OAAA,ICoDL,IAAKC,OACVA,EAAA,OAAS,SACTA,EAAA,OAAS,SACTA,EAAA,KAAO,OAHGA,OAAA,IC9CL,IAAKC,OACVA,EAAA,QAAU,UACVA,EAAA,UAAY,YACZA,EAAA,YAAc,cACdA,EAAA,OAAS,SACTA,EAAA,KAAO,OALGA,OAAA,IAOAC,OACVA,EAAA,OAAS,SACTA,EAAA,UAAY,YACZA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,OAAS,SACTA,EAAA,QAAU,UACVA,EAAA,cAAgB,KAPNA,OAAA,ICaL,IAAKC,OACVA,EAAA,QAAU,UACVA,EAAA,OAAS,SAFCA,OAAA,IAKAC,OACVA,EAAA,QAAU,UACVA,EAAA,SAAW,WACXA,EAAA,UAAY,YACZA,EAAA,OAAS,SAJCA,OAAA,IAOAC,OACVA,EAAA,OAAS,SACTA,EAAA,UAAY,YACZA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,OAAS,SACTA,EAAA,QAAU,UACVA,EAAA,cAAgB,KAPNA,OAAA,IASAC,OACVA,EAAA,OAAS,SACTA,EAAA,OAAS,SACTA,EAAA,QAAU,UAHAA,OAAA,IC5DL,IAAKC,OACVA,EAAA,iBAAmB,mBACnBA,EAAA,kBAAoB,oBACpBA,EAAA,YAAc,cACdA,EAAA,gBAAkB,kBAGlBA,EAAA,kBAAoB,oBACpBA,EAAA,KAAO,OACPA,EAAA,MAAQ,QACRA,EAAA,UAAY,YACZA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,OAAS,SAITA,EAAA,QAAU,UACVA,EAAA,UAAY,YACZA,EAAA,aAAe,eAGfA,EAAA,uBAAyB,yBACzBA,EAAA,gCAAkC,iCAElCA,EAAA,OAAS,SACTA,EAAA,UAAY,YAGZA,EAAA,IAAM,MA7BIA,OAAA,IC2FL,IAAMC,EAAuB,CAClC,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,KACF,ECtJO,IAAKC,OACVA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,SAAW,WACXA,EAAA,IAAM,MAJIA,OAAA",
|
|
6
6
|
"names": ["ACCOUNT_STATUS", "DESTINATIONS", "CustomHTMLLocation", "ShopifyAppInstallStatus", "ShopifyAppSubscriptionStatus", "PLAN_BILLING_FREQUENCY", "PAYMENT_STATUS", "SUBSCRIPTION_STATUS", "PAYMENT_GATEWAY", "ADTRACKIFY_STANDARD_EVENT", "Currencies", "ADTRACKIFY_EVENT_TYPE"]
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adtrackify/at-tracking-event-types",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.9",
|
|
4
4
|
"description": "",
|
|
5
5
|
"module": "./dist/index.js",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -74,4 +74,4 @@
|
|
|
74
74
|
"author": "",
|
|
75
75
|
"license": "ISC",
|
|
76
76
|
"homepage": "https://bitbucket.org/eacap/at-tracking-event-types#readme"
|
|
77
|
-
}
|
|
77
|
+
}
|
|
@@ -1,66 +1,66 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Destination {
|
|
3
|
-
id: string,
|
|
4
|
-
accountId: string,
|
|
5
|
-
pixelId: string,
|
|
6
|
-
destination: string;
|
|
7
|
-
displayName?: string,
|
|
8
|
-
enabled: boolean;
|
|
9
|
-
configuration?: UserDestinationConfiguration,
|
|
10
|
-
createdAt: string,
|
|
11
|
-
updatedAt: string;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export enum DESTINATIONS {
|
|
15
|
-
FACEBOOK = 'facebook',
|
|
16
|
-
TIKTOK = 'tiktok',
|
|
17
|
-
GOOGLE_ADS = 'googleAds',
|
|
18
|
-
GOOGLE_ANALYTICS_4 = 'googleAnalytics4',
|
|
19
|
-
HUBSPOT = 'hubspot',
|
|
20
|
-
WEBHOOK = 'webhook',
|
|
21
|
-
CUSTOM_HTML = 'customHTML',
|
|
22
|
-
CUSTOM_JS = 'customJS',
|
|
23
|
-
SNAPCHAT = 'snapchat',
|
|
24
|
-
TWITTER = 'twitter',
|
|
25
|
-
REDDIT = 'reddit'
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export interface UserDestinationConfiguration {
|
|
29
|
-
[ key: string ]: any;
|
|
30
|
-
eventBlacklist?: string[];
|
|
31
|
-
events?: EventConfiguration[];
|
|
32
|
-
trigger?: DestinationTriggerConfiguration;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
export interface DestinationTriggerConfiguration {
|
|
36
|
-
shopify?: ShopifyTriggerConfiguration;
|
|
37
|
-
exludeDomains?: string[];
|
|
38
|
-
excludePages?: string[];
|
|
39
|
-
domains?: string[];
|
|
40
|
-
pages?: string[];
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
export interface ShopifyTriggerConfiguration {
|
|
44
|
-
enabled: boolean;
|
|
45
|
-
collections?: string[];
|
|
46
|
-
tags?: string[];
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
export interface EventConfiguration {
|
|
51
|
-
sourceEventName: string;
|
|
52
|
-
exclude?: boolean;
|
|
53
|
-
sample: EventSampleConfiguration;
|
|
54
|
-
transformations?: EventTransformation[];
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
export interface EventTransformation {
|
|
58
|
-
transformationEventName: string;
|
|
59
|
-
enabled: boolean;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export interface EventSampleConfiguration {
|
|
63
|
-
enabled: boolean;
|
|
64
|
-
rate: number;
|
|
65
|
-
}
|
|
66
|
-
|
|
1
|
+
|
|
2
|
+
export interface Destination {
|
|
3
|
+
id: string,
|
|
4
|
+
accountId: string,
|
|
5
|
+
pixelId: string,
|
|
6
|
+
destination: string;
|
|
7
|
+
displayName?: string,
|
|
8
|
+
enabled: boolean;
|
|
9
|
+
configuration?: UserDestinationConfiguration,
|
|
10
|
+
createdAt: string,
|
|
11
|
+
updatedAt: string;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export enum DESTINATIONS {
|
|
15
|
+
FACEBOOK = 'facebook',
|
|
16
|
+
TIKTOK = 'tiktok',
|
|
17
|
+
GOOGLE_ADS = 'googleAds',
|
|
18
|
+
GOOGLE_ANALYTICS_4 = 'googleAnalytics4',
|
|
19
|
+
HUBSPOT = 'hubspot',
|
|
20
|
+
WEBHOOK = 'webhook',
|
|
21
|
+
CUSTOM_HTML = 'customHTML',
|
|
22
|
+
CUSTOM_JS = 'customJS',
|
|
23
|
+
SNAPCHAT = 'snapchat',
|
|
24
|
+
TWITTER = 'twitter',
|
|
25
|
+
REDDIT = 'reddit'
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface UserDestinationConfiguration {
|
|
29
|
+
[ key: string ]: any;
|
|
30
|
+
eventBlacklist?: string[];
|
|
31
|
+
events?: EventConfiguration[];
|
|
32
|
+
trigger?: DestinationTriggerConfiguration;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface DestinationTriggerConfiguration {
|
|
36
|
+
shopify?: ShopifyTriggerConfiguration;
|
|
37
|
+
exludeDomains?: string[];
|
|
38
|
+
excludePages?: string[];
|
|
39
|
+
domains?: string[];
|
|
40
|
+
pages?: string[];
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export interface ShopifyTriggerConfiguration {
|
|
44
|
+
enabled: boolean;
|
|
45
|
+
collections?: string[];
|
|
46
|
+
tags?: string[];
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
export interface EventConfiguration {
|
|
51
|
+
sourceEventName: string;
|
|
52
|
+
exclude?: boolean;
|
|
53
|
+
sample: EventSampleConfiguration;
|
|
54
|
+
transformations?: EventTransformation[];
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export interface EventTransformation {
|
|
58
|
+
transformationEventName: string;
|
|
59
|
+
enabled: boolean;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface EventSampleConfiguration {
|
|
63
|
+
enabled: boolean;
|
|
64
|
+
rate: number;
|
|
65
|
+
}
|
|
66
|
+
|
|
@@ -1,71 +1,71 @@
|
|
|
1
|
-
import { Destination, UserDestinationConfiguration } from './destinations';
|
|
2
|
-
|
|
3
|
-
export interface AdTrackifyFacebookDestination extends Destination {
|
|
4
|
-
configuration: FacebookPixelConfiguration;
|
|
5
|
-
}
|
|
6
|
-
|
|
7
|
-
export interface AdTrackifyTikTokDestination extends Destination {
|
|
8
|
-
configuration: TiktokPixelConfiguration;
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
|
|
12
|
-
configuration: GoogleAnalytics4Configuration;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
// Destination Specific configurations below
|
|
16
|
-
export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
|
|
17
|
-
apiAccessToken?: string;
|
|
18
|
-
enableConversionAPI: boolean;
|
|
19
|
-
pixelId: string;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
|
|
23
|
-
apiAccessToken?: string;
|
|
24
|
-
enableConversionAPI: boolean;
|
|
25
|
-
pixelId: string;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
|
|
29
|
-
apiSecret: string;
|
|
30
|
-
measurementId: string;
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
|
|
34
|
-
pixelId: string;
|
|
35
|
-
conversionID: string;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
|
|
39
|
-
hubspotId: string;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
|
|
43
|
-
snapchatPixelId: string;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
|
|
47
|
-
twitterPixelId: string;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
export interface WebhookConfiguration extends UserDestinationConfiguration {
|
|
51
|
-
webhookUrl: string;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
|
|
55
|
-
html: string;
|
|
56
|
-
location: CustomHTMLLocation;
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
export interface CustomJSConfiguration extends UserDestinationConfiguration {
|
|
60
|
-
script: string;
|
|
61
|
-
async: boolean;
|
|
62
|
-
defer: boolean;
|
|
63
|
-
location: CustomHTMLLocation;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export enum CustomHTMLLocation {
|
|
67
|
-
HEADER = 'header',
|
|
68
|
-
FOOTER = 'footer',
|
|
69
|
-
BODY = 'body'
|
|
70
|
-
}
|
|
71
|
-
|
|
1
|
+
import { Destination, UserDestinationConfiguration } from './destinations';
|
|
2
|
+
|
|
3
|
+
export interface AdTrackifyFacebookDestination extends Destination {
|
|
4
|
+
configuration: FacebookPixelConfiguration;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
export interface AdTrackifyTikTokDestination extends Destination {
|
|
8
|
+
configuration: TiktokPixelConfiguration;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
|
|
12
|
+
configuration: GoogleAnalytics4Configuration;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
// Destination Specific configurations below
|
|
16
|
+
export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
|
|
17
|
+
apiAccessToken?: string;
|
|
18
|
+
enableConversionAPI: boolean;
|
|
19
|
+
pixelId: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
|
|
23
|
+
apiAccessToken?: string;
|
|
24
|
+
enableConversionAPI: boolean;
|
|
25
|
+
pixelId: string;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
|
|
29
|
+
apiSecret: string;
|
|
30
|
+
measurementId: string;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
|
|
34
|
+
pixelId: string;
|
|
35
|
+
conversionID: string;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
|
|
39
|
+
hubspotId: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
|
|
43
|
+
snapchatPixelId: string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
|
|
47
|
+
twitterPixelId: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface WebhookConfiguration extends UserDestinationConfiguration {
|
|
51
|
+
webhookUrl: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
|
|
55
|
+
html: string;
|
|
56
|
+
location: CustomHTMLLocation;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export interface CustomJSConfiguration extends UserDestinationConfiguration {
|
|
60
|
+
script: string;
|
|
61
|
+
async: boolean;
|
|
62
|
+
defer: boolean;
|
|
63
|
+
location: CustomHTMLLocation;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export enum CustomHTMLLocation {
|
|
67
|
+
HEADER = 'header',
|
|
68
|
+
FOOTER = 'footer',
|
|
69
|
+
BODY = 'body'
|
|
70
|
+
}
|
|
71
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface LogContext {
|
|
2
|
+
[x: string]: LogContextValue;
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
export type LogContextValue = string | number | boolean | LogContext | LogContextArray | undefined | null;
|
|
6
|
+
|
|
7
|
+
export interface LogContextArray extends Array<LogContextValue> {}
|
|
8
|
+
|
|
9
|
+
export enum LogLevel {
|
|
10
|
+
debug = 'debug',
|
|
11
|
+
error = 'error',
|
|
12
|
+
info = 'info',
|
|
13
|
+
trace = 'trace',
|
|
14
|
+
warn = 'warn',
|
|
15
|
+
}
|
|
16
|
+
export const LogLevelId = {
|
|
17
|
+
trace: 0,
|
|
18
|
+
debug: 1,
|
|
19
|
+
info: 2,
|
|
20
|
+
warn: 3,
|
|
21
|
+
error: 4,
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
export interface LogMessage {
|
|
25
|
+
message: string;
|
|
26
|
+
logLevel: LogLevel;
|
|
27
|
+
context?: LogContext;
|
|
28
|
+
}
|
|
@@ -3,6 +3,7 @@ import { ADTRACKIFY_EVENT_TYPE } from '../adtrackify-event-types';
|
|
|
3
3
|
import { AddressInfo } from '../common/address';
|
|
4
4
|
import { TrackingEventContext } from './tracking-event-context';
|
|
5
5
|
import { TrackingEventIdentity } from './tracking-event-identity';
|
|
6
|
+
import { LogMessage } from '../common/logger';
|
|
6
7
|
|
|
7
8
|
export interface Event {
|
|
8
9
|
id: string;
|
|
@@ -25,8 +26,12 @@ export interface MetricEvent extends Event {
|
|
|
25
26
|
data: MetricEventData;
|
|
26
27
|
}
|
|
27
28
|
|
|
29
|
+
export interface LogEvent extends Event {
|
|
30
|
+
data: LogEventData;
|
|
31
|
+
}
|
|
32
|
+
|
|
28
33
|
export interface TrackingEventData {
|
|
29
|
-
[
|
|
34
|
+
[key: string]: any;
|
|
30
35
|
firstName?: string;
|
|
31
36
|
lastName?: string;
|
|
32
37
|
email?: string;
|
|
@@ -53,7 +58,7 @@ export interface TrackingEventData {
|
|
|
53
58
|
}
|
|
54
59
|
|
|
55
60
|
export interface GenericContent {
|
|
56
|
-
[
|
|
61
|
+
[key: string]: any;
|
|
57
62
|
content_type?: string;
|
|
58
63
|
id?: string;
|
|
59
64
|
name?: string;
|
|
@@ -77,10 +82,70 @@ export interface GenericContent {
|
|
|
77
82
|
category5?: string;
|
|
78
83
|
}
|
|
79
84
|
|
|
85
|
+
export interface LogEventData extends LogMessage {}
|
|
80
86
|
export interface MetricEventData {
|
|
81
|
-
[
|
|
87
|
+
[key: string]: any;
|
|
82
88
|
name: string;
|
|
83
89
|
value: number;
|
|
84
90
|
}
|
|
85
91
|
|
|
86
|
-
export const Currencies: string[] = [
|
|
92
|
+
export const Currencies: string[] = [
|
|
93
|
+
'AED',
|
|
94
|
+
'ARS',
|
|
95
|
+
'AUD',
|
|
96
|
+
'BDT',
|
|
97
|
+
'BIF',
|
|
98
|
+
'BOB',
|
|
99
|
+
'BRL',
|
|
100
|
+
'CAD',
|
|
101
|
+
'CHF',
|
|
102
|
+
'CLP',
|
|
103
|
+
'CNY',
|
|
104
|
+
'COP',
|
|
105
|
+
'CRC',
|
|
106
|
+
'CZK',
|
|
107
|
+
'DKK',
|
|
108
|
+
'DZD',
|
|
109
|
+
'EGP',
|
|
110
|
+
'EUR',
|
|
111
|
+
'GBP',
|
|
112
|
+
'GTQ',
|
|
113
|
+
'HKD',
|
|
114
|
+
'HNL',
|
|
115
|
+
'HUF',
|
|
116
|
+
'IDR',
|
|
117
|
+
'ILS',
|
|
118
|
+
'INR',
|
|
119
|
+
'ISK',
|
|
120
|
+
'JPY',
|
|
121
|
+
'KES',
|
|
122
|
+
'KRW',
|
|
123
|
+
'KWD',
|
|
124
|
+
'KZT',
|
|
125
|
+
'MAD',
|
|
126
|
+
'MOP',
|
|
127
|
+
'MXN',
|
|
128
|
+
'MYR',
|
|
129
|
+
'NGN',
|
|
130
|
+
'NIO',
|
|
131
|
+
'NOK',
|
|
132
|
+
'NZD',
|
|
133
|
+
'PEN',
|
|
134
|
+
'PHP',
|
|
135
|
+
'PKR',
|
|
136
|
+
'PLN',
|
|
137
|
+
'PYG',
|
|
138
|
+
'QAR',
|
|
139
|
+
'RON',
|
|
140
|
+
'RUB',
|
|
141
|
+
'SAR',
|
|
142
|
+
'SEK',
|
|
143
|
+
'SGD',
|
|
144
|
+
'THB',
|
|
145
|
+
'TRY',
|
|
146
|
+
'TWD',
|
|
147
|
+
'USD',
|
|
148
|
+
'VES',
|
|
149
|
+
'VND',
|
|
150
|
+
'ZAR',
|
|
151
|
+
];
|