saasco-sdk 0.1.30 → 0.1.31

package/index.cjs.js

@@ -7,7 +7,7 @@ var uuid = require('@lukeed/uuid');
 var psl = require('psl');
 var zod = require('zod');
 
-var version = "0.1.30";
+var version = "0.1.31";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -466,6 +466,68 @@ function getBrowserContext() {
   const $utmCampaignId = params.get('utm_campaign_id');
   const $utmCreativeFormat = params.get('utm_creative_format');
   const $utmMarketingTactic = params.get('utm_marketing_tactic');
+  let $utmAdSource = params.get('utm_ad_source');
+  let $utmAdId = params.get('utm_ad_id');
+  // If the adId is not set directly attempt to get it from each ad network
+  // Also set the ad source to the ad network if it's not set
+  if (!$utmAdId) {
+    const fbAdId = params.get('fbadid');
+    if (fbAdId) {
+      $utmAdId = fbAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'facebook';
+      }
+    }
+    const googleAdId = params.get('gadid');
+    if (googleAdId) {
+      $utmAdId = googleAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'google';
+      }
+    }
+    const xAdId = params.get('xadid');
+    if (xAdId) {
+      $utmAdId = xAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'x';
+      }
+    }
+    const pinterestAdId = params.get('padid');
+    if (pinterestAdId) {
+      $utmAdId = pinterestAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'pinterest';
+      }
+    }
+    const tiktokAdId = params.get('ttadid');
+    if (tiktokAdId) {
+      $utmAdId = tiktokAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'tiktok';
+      }
+    }
+    const snapchatAdId = params.get('scadid');
+    if (snapchatAdId) {
+      $utmAdId = snapchatAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'snapchat';
+      }
+    }
+    const redditAdId = params.get('radid');
+    if (redditAdId) {
+      $utmAdId = redditAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'reddit';
+      }
+    }
+    const linkedinAdId = params.get('liadid');
+    if (linkedinAdId) {
+      $utmAdId = linkedinAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'linkedin';
+      }
+    }
+  }
   return {
     $locale,
     $location,
@@ -486,7 +548,9 @@ function getBrowserContext() {
     $utmSourcePlatform,
     $utmCampaignId,
     $utmCreativeFormat,
-    $utmMarketingTactic
+    $utmMarketingTactic,
+    $utmAdSource,
+    $utmAdId
   };
 }
 
@@ -653,7 +717,7 @@ function setSuperContext(superContext) {
 }
 function updateSuperContext(browserContext) {
   const existingSuperContext = getSuperContext();
-  const defaultSuperContextKeys = ['$utmSource', '$utmMedium', '$utmCampaign', '$utmTerm', '$utmContent', '$utmId', '$utmSourcePlatform', '$utmCampaignId', '$utmCreativeFormat', '$utmMarketingTactic'];
+  const defaultSuperContextKeys = ['$utmSource', '$utmMedium', '$utmCampaign', '$utmTerm', '$utmContent', '$utmId', '$utmSourcePlatform', '$utmCampaignId', '$utmCreativeFormat', '$utmMarketingTactic', '$utmAdSource', '$utmAdId'];
   const superContext = defaultSuperContextKeys.reduce((acc, key) => {
     const value = Object.assign({}, browserContext)[key];
     if (value) acc[key] = value;
@@ -985,7 +1049,9 @@ const browserContextSchema = zod.z.object({
   $utmSourcePlatform: zod.z.string().nullable(),
   $utmCampaignId: zod.z.string().nullable(),
   $utmCreativeFormat: zod.z.string().nullable(),
-  $utmMarketingTactic: zod.z.string().nullable()
+  $utmMarketingTactic: zod.z.string().nullable(),
+  $utmAdSource: zod.z.string().nullable(),
+  $utmAdId: zod.z.string().nullable()
 });
 
 exports.Saasco = Saasco;

package/index.esm.js

@@ -3,7 +3,7 @@ import { v4 } from '@lukeed/uuid';
 import { isValid, parse } from 'psl';
 import { z } from 'zod';
 
-var version = "0.1.30";
+var version = "0.1.31";
 
 const timezones = {
   'Asia/Barnaul': 'RU',
@@ -462,6 +462,68 @@ function getBrowserContext() {
   const $utmCampaignId = params.get('utm_campaign_id');
   const $utmCreativeFormat = params.get('utm_creative_format');
   const $utmMarketingTactic = params.get('utm_marketing_tactic');
+  let $utmAdSource = params.get('utm_ad_source');
+  let $utmAdId = params.get('utm_ad_id');
+  // If the adId is not set directly attempt to get it from each ad network
+  // Also set the ad source to the ad network if it's not set
+  if (!$utmAdId) {
+    const fbAdId = params.get('fbadid');
+    if (fbAdId) {
+      $utmAdId = fbAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'facebook';
+      }
+    }
+    const googleAdId = params.get('gadid');
+    if (googleAdId) {
+      $utmAdId = googleAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'google';
+      }
+    }
+    const xAdId = params.get('xadid');
+    if (xAdId) {
+      $utmAdId = xAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'x';
+      }
+    }
+    const pinterestAdId = params.get('padid');
+    if (pinterestAdId) {
+      $utmAdId = pinterestAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'pinterest';
+      }
+    }
+    const tiktokAdId = params.get('ttadid');
+    if (tiktokAdId) {
+      $utmAdId = tiktokAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'tiktok';
+      }
+    }
+    const snapchatAdId = params.get('scadid');
+    if (snapchatAdId) {
+      $utmAdId = snapchatAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'snapchat';
+      }
+    }
+    const redditAdId = params.get('radid');
+    if (redditAdId) {
+      $utmAdId = redditAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'reddit';
+      }
+    }
+    const linkedinAdId = params.get('liadid');
+    if (linkedinAdId) {
+      $utmAdId = linkedinAdId;
+      if (!$utmAdSource) {
+        $utmAdSource = 'linkedin';
+      }
+    }
+  }
   return {
     $locale,
     $location,
@@ -482,7 +544,9 @@ function getBrowserContext() {
     $utmSourcePlatform,
     $utmCampaignId,
     $utmCreativeFormat,
-    $utmMarketingTactic
+    $utmMarketingTactic,
+    $utmAdSource,
+    $utmAdId
   };
 }
 
@@ -649,7 +713,7 @@ function setSuperContext(superContext) {
 }
 function updateSuperContext(browserContext) {
   const existingSuperContext = getSuperContext();
-  const defaultSuperContextKeys = ['$utmSource', '$utmMedium', '$utmCampaign', '$utmTerm', '$utmContent', '$utmId', '$utmSourcePlatform', '$utmCampaignId', '$utmCreativeFormat', '$utmMarketingTactic'];
+  const defaultSuperContextKeys = ['$utmSource', '$utmMedium', '$utmCampaign', '$utmTerm', '$utmContent', '$utmId', '$utmSourcePlatform', '$utmCampaignId', '$utmCreativeFormat', '$utmMarketingTactic', '$utmAdSource', '$utmAdId'];
   const superContext = defaultSuperContextKeys.reduce((acc, key) => {
     const value = Object.assign({}, browserContext)[key];
     if (value) acc[key] = value;
@@ -981,7 +1045,9 @@ const browserContextSchema = z.object({
   $utmSourcePlatform: z.string().nullable(),
   $utmCampaignId: z.string().nullable(),
   $utmCreativeFormat: z.string().nullable(),
-  $utmMarketingTactic: z.string().nullable()
+  $utmMarketingTactic: z.string().nullable(),
+  $utmAdSource: z.string().nullable(),
+  $utmAdId: z.string().nullable()
 });
 
 export { Saasco, browserContextSchema, getBrowserContext, timezones };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.30",
+  "version": "0.1.31",
   "dependencies": {
     "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",

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

@@ -20,6 +20,8 @@ export declare const browserContextSchema: z.ZodObject<{
     $utmCampaignId: z.ZodNullable<z.ZodString>;
     $utmCreativeFormat: z.ZodNullable<z.ZodString>;
     $utmMarketingTactic: z.ZodNullable<z.ZodString>;
+    $utmAdSource: z.ZodNullable<z.ZodString>;
+    $utmAdId: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     $locale: string;
     $location: string;
@@ -41,6 +43,8 @@ export declare const browserContextSchema: z.ZodObject<{
     $utmCampaignId: string | null;
     $utmCreativeFormat: string | null;
     $utmMarketingTactic: string | null;
+    $utmAdSource: string | null;
+    $utmAdId: string | null;
 }, {
     $locale: string;
     $location: string;
@@ -62,6 +66,8 @@ export declare const browserContextSchema: z.ZodObject<{
     $utmCampaignId: string | null;
     $utmCreativeFormat: string | null;
     $utmMarketingTactic: string | null;
+    $utmAdSource: string | null;
+    $utmAdId: string | null;
 }>;
 export type BrowserContext = z.infer<typeof browserContextSchema>;
 export type SuperContext = Record<string, any>;