@adtrackify/at-tracking-event-types 1.0.58 → 1.0.60

package/dist/index.d.ts

@@ -164,33 +164,33 @@ declare module '@adtrackify/at-tracking-event-types/types/api/destinations/third
       enableConversionAPI: boolean;
       pixelId: string;
   }
-  export interface TiktokPixelConfiguration {
+  export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
       pixelId: string;
   }
-  export interface GoogleAnalytics4Configuration {
+  export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
       measurementId: string;
   }
-  export interface GoogleAdsConfiguration {
+  export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
       pixelId: string;
       conversionID: string;
   }
-  export interface HubspotPixelConfiguration {
+  export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
       hubspotId: string;
   }
-  export interface SnapchatPixelConfiguration {
+  export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
       snapchatPixelId: string;
   }
-  export interface TwitterPixelConfiguration {
+  export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
       twitterPixelId: string;
   }
-  export interface WebhookConfiguration {
+  export interface WebhookConfiguration extends UserDestinationConfiguration {
       webhookUrl: string;
   }
-  export interface CustomHTMLConfiguration {
+  export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
       html: string;
       location: CustomHTMLLocation;
   }
-  export interface CustomJSConfiguration {
+  export interface CustomJSConfiguration extends UserDestinationConfiguration {
       script: string;
       async: boolean;
       defer: boolean;
@@ -387,6 +387,7 @@ declare module '@adtrackify/at-tracking-event-types/types/tracking-event-type' {
       userAgent?: string;
       ipAddress?: string;
       ipv6Address?: string;
+      shopify?: ShopifyInfo;
   }
   export interface TrackingEventIdentity {
       gender?: string;
@@ -485,6 +486,10 @@ declare module '@adtrackify/at-tracking-event-types/types/tracking-event-type' {
       url?: string;
       qsp?: any;
   }
+  export interface ShopifyInfo {
+      collections?: string[];
+      tags?: string[];
+  }
   export type DeviceInfo = IResult;
   export const Currencies: string[];
 

package/dist/index.js

@@ -1,2 +1,2 @@
-var a=(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))(a||{});var y=["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 g=(n=>(n.PENDING="pending",n.ACTIVE="active",n.INACTIVE="inactive",n))(g||{});var c=(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))(c||{});var p=(n=>(n.HEADER="header",n.FOOTER="footer",n.BODY="body",n))(p||{});var d=(r=>(r.STARTED="started",r.COMPLETED="completed",r.UNINSTALLED="uninstalled",r.FAILED="failed",r.NONE="none",r))(d||{}),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||{});var f=(s=>(s.MONTHLY="monthly",s.YEARLY="yearly",s))(f||{}),m=(o=>(o.CURRENT="current",o.PAST_DUE="past_due",o.CANCELLED="cancelled",o.FAILED="failed",o))(m||{}),u=(e=>(e.ACTIVE="active",e.CANCELLED="cancelled",e.DECLINED="declined",e.EXPIRED="expired",e.FROZEN="frozen",e.PENDING="pending",e.NOT_SUBMITTED="na",e))(u||{}),x=(n=>(n.STRIPE="stripe",n.PAYPAL="paypal",n.SHOPIFY="shopify",n))(x||{});export{g as ACCOUNT_STATUS,a as ADTRACKIFY_STANDARD_EVENT,y as Currencies,p as CustomHTMLLocation,c as DESTINATIONS,x as PAYMENT_GATEWAY,m as PAYMENT_STATUS,f as PLAN_BILLING_FREQUENCY,u as SUBSCRIPTION_STATUS,d as ShopifyAppInstallStatus,l as ShopifyAppSubscriptionStatus};
+var a=(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))(a||{});var b=["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 g=(e=>(e.PENDING="pending",e.ACTIVE="active",e.INACTIVE="inactive",e))(g||{});var c=(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))(c||{});var d=(e=>(e.HEADER="header",e.FOOTER="footer",e.BODY="body",e))(d||{});var p=(r=>(r.STARTED="started",r.COMPLETED="completed",r.UNINSTALLED="uninstalled",r.FAILED="failed",r.NONE="none",r))(p||{}),f=(n=>(n.ACTIVE="active",n.CANCELLED="cancelled",n.DECLINED="declined",n.EXPIRED="expired",n.FROZEN="frozen",n.PENDING="pending",n.NOT_SUBMITTED="na",n))(f||{});var l=(s=>(s.MONTHLY="monthly",s.YEARLY="yearly",s))(l||{}),u=(o=>(o.CURRENT="current",o.PAST_DUE="past_due",o.CANCELLED="cancelled",o.FAILED="failed",o))(u||{}),m=(n=>(n.ACTIVE="active",n.CANCELLED="cancelled",n.DECLINED="declined",n.EXPIRED="expired",n.FROZEN="frozen",n.PENDING="pending",n.NOT_SUBMITTED="na",n))(m||{}),x=(e=>(e.STRIPE="stripe",e.PAYPAL="paypal",e.SHOPIFY="shopify",e))(x||{});export{g as ACCOUNT_STATUS,a as ADTRACKIFY_STANDARD_EVENT,b as Currencies,d as CustomHTMLLocation,c as DESTINATIONS,x as PAYMENT_GATEWAY,u as PAYMENT_STATUS,l as PLAN_BILLING_FREQUENCY,m as SUBSCRIPTION_STATUS,p as ShopifyAppInstallStatus,f as ShopifyAppSubscriptionStatus};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/types/adtrackify-standard-events.ts", "../src/types/tracking-event-type.ts", "../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"],
-  "sourcesContent": ["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  //\n  SELECT_SHIPPING_METHOD = 'select_shipping_method',\n  VIRTUALIZED_VIEWED_PAYMENT_FORM = 'virtualized_viewd_payment_form'\n}", "import { IResult } from 'ua-parser-js';\nimport { ADTRACKIFY_STANDARD_EVENT } from './adtrackify-standard-events';\n\n\nexport interface TrackingEvent {\n  id: string;\n  type: string;\n  name: ADTRACKIFY_STANDARD_EVENT;\n  pixelId: string;\n  context: TrackingEventContext;\n  data: TrackingEventData;\n  testCode?: string;\n  sentAtEpoch?: number;\n  collectedAt?: string;\n  version: string;\n}\n\nexport interface TrackingEventContext {\n  identity: TrackingEventIdentity;\n  click?: AdClickInfo;\n  campaign?: CampaignInfo;\n  page?: PageInfo;\n  device?: DeviceInfo;\n  locale?: string;\n  timezone?: string;\n  userAgent?: string;\n  ipAddress?: string;\n  ipv6Address?: string;\n}\n\nexport interface TrackingEventIdentity {\n  gender?: string;\n  dob?: string;\n  phone?: string;\n  id?: string;\n  firstName?: string;\n  lastName?: string;\n  email?: string;\n  address?: AddressInfo;\n  addresses?: AddressInfo[];\n}\n\nexport interface AdClickInfo {\n  fbp?: string;\n  fbc?: string;\n  fbclid?: string;\n  gclid?: string;\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 AddressInfo {\n  email?: string;\n  phone?: string;\n  firstName?: string;\n  lastName?: string;\n  company?: string;\n  address1?: string;\n  address2?: string;\n  city?: string;\n  province?: string;\n  provinceCode?: string;\n  country?: string;\n  countryCode?: string;\n  zip?: string;\n}\n\nexport interface CampaignInfo {\n  name?: string;\n  source?: string;\n  medium?: string;\n  term?: string;\n  content?: string;\n}\n\nexport interface PageInfo {\n  path?: string;\n  referrer?: string;\n  search?: string;\n  title?: string;\n  url?: string;\n  qsp?: any;\n}\n\nexport type DeviceInfo = IResult;\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' ];\n\n", "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\n// Destination Specific configurations below\nexport interface FacebookPixelConfiguration extends UserDestinationConfiguration {\n  apiAccessToken?: string;\n  enableConversionAPI: boolean;\n  pixelId: string;\n}\n\nexport interface TiktokPixelConfiguration {\n  pixelId: string;\n}\n\nexport interface GoogleAnalytics4Configuration {\n  measurementId: string;\n}\n\nexport interface GoogleAdsConfiguration {\n  pixelId: string;\n  conversionID: string;\n}\n\nexport interface HubspotPixelConfiguration {\n  hubspotId: string;\n}\n\nexport interface SnapchatPixelConfiguration {\n  snapchatPixelId: string;\n}\n\nexport interface TwitterPixelConfiguration {\n  twitterPixelId: string;\n}\n\nexport interface WebhookConfiguration {\n  webhookUrl: string;\n}\n\nexport interface CustomHTMLConfiguration {\n  html: string;\n  location: CustomHTMLLocation;\n}\n\nexport interface CustomJSConfiguration {\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"],
-  "mappings": "AAAO,IAAKA,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,eAIfA,EAAA,uBAAyB,yBACzBA,EAAA,gCAAkC,iCAxBxBA,OAAA,ICyIL,IAAMC,EAAuB,CAAE,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,KAAM,EC/Gpb,IAAKC,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,ICyCL,IAAKC,OACVA,EAAA,OAAS,SACTA,EAAA,OAAS,SACTA,EAAA,KAAO,OAHGA,OAAA,ICnCL,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",
+  "sourcesContent": ["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  //\n  SELECT_SHIPPING_METHOD = 'select_shipping_method',\n  VIRTUALIZED_VIEWED_PAYMENT_FORM = 'virtualized_viewd_payment_form'\n}", "import { IResult } from 'ua-parser-js';\nimport { ADTRACKIFY_STANDARD_EVENT } from './adtrackify-standard-events';\n\n\nexport interface TrackingEvent {\n  id: string;\n  type: string;\n  name: ADTRACKIFY_STANDARD_EVENT;\n  pixelId: string;\n  context: TrackingEventContext;\n  data: TrackingEventData;\n  testCode?: string;\n  sentAtEpoch?: number;\n  collectedAt?: string;\n  version: string;\n}\n\nexport interface TrackingEventContext {\n  identity: TrackingEventIdentity;\n  click?: AdClickInfo;\n  campaign?: CampaignInfo;\n  page?: PageInfo;\n  device?: DeviceInfo;\n  locale?: string;\n  timezone?: string;\n  userAgent?: string;\n  ipAddress?: string;\n  ipv6Address?: string;\n  shopify?: ShopifyInfo;\n}\n\nexport interface TrackingEventIdentity {\n  gender?: string;\n  dob?: string;\n  phone?: string;\n  id?: string;\n  firstName?: string;\n  lastName?: string;\n  email?: string;\n  address?: AddressInfo;\n  addresses?: AddressInfo[];\n}\n\nexport interface AdClickInfo {\n  fbp?: string;\n  fbc?: string;\n  fbclid?: string;\n  gclid?: string;\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 AddressInfo {\n  email?: string;\n  phone?: string;\n  firstName?: string;\n  lastName?: string;\n  company?: string;\n  address1?: string;\n  address2?: string;\n  city?: string;\n  province?: string;\n  provinceCode?: string;\n  country?: string;\n  countryCode?: string;\n  zip?: string;\n}\n\nexport interface CampaignInfo {\n  name?: string;\n  source?: string;\n  medium?: string;\n  term?: string;\n  content?: string;\n}\n\nexport interface PageInfo {\n  path?: string;\n  referrer?: string;\n  search?: string;\n  title?: string;\n  url?: string;\n  qsp?: any;\n}\n\nexport interface ShopifyInfo {\n  collections?: string[];\n  tags?: string[];\n}\n\nexport type DeviceInfo = IResult;\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' ];\n\n", "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\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  pixelId: string;\n}\n\nexport interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {\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"],
+  "mappings": "AAAO,IAAKA,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,eAIfA,EAAA,uBAAyB,yBACzBA,EAAA,gCAAkC,iCAxBxBA,OAAA,IC+IL,IAAMC,EAAuB,CAAE,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,MAAO,KAAM,ECrHpb,IAAKC,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,ICyCL,IAAKC,OACVA,EAAA,OAAS,SACTA,EAAA,OAAS,SACTA,EAAA,KAAO,OAHGA,OAAA,ICnCL,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",
   "names": ["ADTRACKIFY_STANDARD_EVENT", "Currencies", "ACCOUNT_STATUS", "DESTINATIONS", "CustomHTMLLocation", "ShopifyAppInstallStatus", "ShopifyAppSubscriptionStatus", "PLAN_BILLING_FREQUENCY", "PAYMENT_STATUS", "SUBSCRIPTION_STATUS", "PAYMENT_GATEWAY"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adtrackify/at-tracking-event-types",
-  "version": "1.0.58",
+  "version": "1.0.60",
   "description": "",
   "module": "./dist/index.js",
   "main": "./dist/index.js",

package/src/types/api/destinations/third-party-destination-configs.ts

@@ -11,41 +11,41 @@ export interface FacebookPixelConfiguration extends UserDestinationConfiguration
   pixelId: string;
 }
 
-export interface TiktokPixelConfiguration {
+export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
   pixelId: string;
 }
 
-export interface GoogleAnalytics4Configuration {
+export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
   measurementId: string;
 }
 
-export interface GoogleAdsConfiguration {
+export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
   pixelId: string;
   conversionID: string;
 }
 
-export interface HubspotPixelConfiguration {
+export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
   hubspotId: string;
 }
 
-export interface SnapchatPixelConfiguration {
+export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
   snapchatPixelId: string;
 }
 
-export interface TwitterPixelConfiguration {
+export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
   twitterPixelId: string;
 }
 
-export interface WebhookConfiguration {
+export interface WebhookConfiguration extends UserDestinationConfiguration {
   webhookUrl: string;
 }
 
-export interface CustomHTMLConfiguration {
+export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
   html: string;
   location: CustomHTMLLocation;
 }
 
-export interface CustomJSConfiguration {
+export interface CustomJSConfiguration extends UserDestinationConfiguration {
   script: string;
   async: boolean;
   defer: boolean;

package/src/types/tracking-event-type.ts

@@ -26,6 +26,7 @@ export interface TrackingEventContext {
   userAgent?: string;
   ipAddress?: string;
   ipv6Address?: string;
+  shopify?: ShopifyInfo;
 }
 
 export interface TrackingEventIdentity {
@@ -132,6 +133,11 @@ export interface PageInfo {
   qsp?: any;
 }
 
+export interface ShopifyInfo {
+  collections?: string[];
+  tags?: string[];
+}
+
 export type DeviceInfo = IResult;