@ht-sdks/events-sdk-js-browser 1.3.0 → 1.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ht-sdks/events-sdk-js-browser",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/ht-sdks/events-sdk-js-mono",

package/src/core/http-cookies/server-examples/node-aws-lambda.md

@@ -86,7 +86,7 @@ export const handler = async (event, context) => {
 };
 ```
 
-After creating the above Lambda Function, you'll need to setup an [API Gateway](https://aws.amazon.com/api-gateway/). Specifically, create a new `Route` and input the value of `/ht/{proxy}`. Then attach an `integration` for this route, and select your Lambda. Your HTTPCookieService lambda will now be callable over HTTP at `${ApiGatewayURL}.com/default/ht/renew`.
+After creating the above Lambda Function, you'll need to setup an [API Gateway](https://aws.amazon.com/api-gateway/). Specifically, create a new `Route` and input the value of `/ht/{proxy}`. Then attach an `integration` for this route, and select your Lambda. Be sure to select the "version 2" payload format. Your HTTPCookieService lambda will now be reachable via HTTP at `${ApiGatewayURL}.com/default/ht/renew`.
 
 However, the HTTPCookieService must live on the same domain and IP address as your website's HTML document.
 

package/src/generated/version.ts

@@ -1,2 +1,2 @@
 // This file is generated.
-export const version = '1.3.0'
+export const version = '1.3.1'

package/src/plugins/destinations/google-tag-manager.ts

@@ -1,19 +1,15 @@
 import type { Context } from '../../core/context'
+import type { HightouchEvent } from '../../core/events/interfaces'
 import type { DestinationFactory } from './types'
 import { Destination } from './destination'
 
 declare global {
   interface Window {
-    gtag: Function
+    dataLayer: Array<any>
   }
 }
 
 type GoogleTagManagerSettings = {
-  /**
-   * The Google measurement ID(s) to send events to (GA4, Ads)
-   */
-  measurementId?: string | string[]
-
   /**
    * If a `Viewed Page` event should be sent for all `htevents.page` calls
    */
@@ -34,42 +30,25 @@ type GoogleTagManagerSettings = {
  * https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/google-tag-manager/lib/index.js
  */
 const googleTagManager: DestinationFactory<GoogleTagManagerSettings> = ({
-  measurementId = [],
   trackAllPages = false,
   trackNamedPages = true,
   trackCategorizedPages = true,
 }) => {
-  const measurementIds = (
-    Array.isArray(measurementId) ? measurementId : [measurementId]
-  ).filter(Boolean)
-
-  const baseEvent = ({ event }: Context) => {
-    return {
+  const pushEvent = (event: HightouchEvent) => {
+    window.dataLayer.push({
       ...(event.userId && {
-        user_id: event.userId,
+        userId: event.userId,
       }),
       ...(event.anonymousId && {
-        hightouch_anonymous_id: event.anonymousId,
-      }),
-      ...(measurementIds.length > 0 && {
-        send_to: measurementIds,
+        hightouchAnonymousId: event.anonymousId,
       }),
+      event: event.event,
       ...event.properties,
-    }
+    })
   }
 
   return new Destination('Google Tag Manager', '0.0.1', {
-    identify: (ctx) => {
-      if (ctx.event.userId) {
-        measurementIds.forEach((measurementId) => {
-          window.gtag('config', measurementId, {
-            user_id: ctx.event.userId,
-          })
-        })
-      }
-    },
-
-    page: (ctx) => {
+    page: (ctx: Context) => {
       if (
         trackAllPages ||
         (trackNamedPages && ctx.event.name) ||
@@ -79,16 +58,16 @@ const googleTagManager: DestinationFactory<GoogleTagManagerSettings> = ({
           .filter(Boolean)
           .join(' ')
 
-        window.gtag('event', eventName, {
-          ...baseEvent(ctx),
+        pushEvent({
+          ...ctx.event,
+          type: 'track',
+          event: eventName,
         })
       }
     },
 
-    track: (ctx) => {
-      window.gtag('event', ctx.event.event, {
-        ...baseEvent(ctx),
-      })
+    track: (ctx: Context) => {
+      pushEvent(ctx.event)
     },
   })
 }

package/src/plugins/destinations/gtag.ts

@@ -0,0 +1,93 @@
+import type { Context } from '../../core/context'
+import type { DestinationFactory } from './types'
+import { Destination } from './destination'
+
+declare global {
+  interface Window {
+    gtag: Function
+  }
+}
+
+type GtagSettings = {
+  /**
+   * The Google measurement ID(s) to send events to (GA4, Ads)
+   */
+  measurementId?: string | string[]
+
+  /**
+   * If a `Viewed Page` event should be sent for all `htevents.page` calls
+   */
+  trackAllPages?: boolean
+
+  /**
+   * If a `Viewed <name> Page` event should be sent for `htevents.page('Name')` calls
+   */
+  trackNamedPages?: boolean
+
+  /**
+   * If a `Viewed <category> <name> Page` event should be sent for `htevents.page('Category', 'Name')` calls
+   */
+  trackCategorizedPages?: boolean
+}
+
+const gtag: DestinationFactory<GtagSettings> = ({
+  measurementId = [],
+  trackAllPages = false,
+  trackNamedPages = true,
+  trackCategorizedPages = true,
+}) => {
+  const measurementIds = (
+    Array.isArray(measurementId) ? measurementId : [measurementId]
+  ).filter(Boolean)
+
+  const baseEvent = ({ event }: Context) => {
+    return {
+      ...(event.userId && {
+        user_id: event.userId,
+      }),
+      ...(event.anonymousId && {
+        hightouch_anonymous_id: event.anonymousId,
+      }),
+      ...(measurementIds.length > 0 && {
+        send_to: measurementIds,
+      }),
+      ...event.properties,
+    }
+  }
+
+  return new Destination('gtag', '0.0.1', {
+    identify: (ctx) => {
+      if (ctx.event.userId) {
+        measurementIds.forEach((measurementId) => {
+          window.gtag('config', measurementId, {
+            user_id: ctx.event.userId,
+          })
+        })
+      }
+    },
+
+    page: (ctx) => {
+      if (
+        trackAllPages ||
+        (trackNamedPages && ctx.event.name) ||
+        (trackCategorizedPages && ctx.event.category)
+      ) {
+        const eventName = ['Viewed', ctx.event.category, ctx.event.name, 'Page']
+          .filter(Boolean)
+          .join(' ')
+
+        window.gtag('event', eventName, {
+          ...baseEvent(ctx),
+        })
+      }
+    },
+
+    track: (ctx) => {
+      window.gtag('event', ctx.event.event, {
+        ...baseEvent(ctx),
+      })
+    },
+  })
+}
+
+export default gtag

package/src/plugins/destinations/index.ts

@@ -9,6 +9,10 @@ export async function createDestination(
   settings: DestinationSettings
 ): Promise<Destination | undefined> {
   switch (name) {
+    case 'gtag':
+      return import(/* webpackChunkName: "gtag" */ './gtag').then((mod) =>
+        mod.default(settings as any)
+      )
     case 'Google Tag Manager':
       return import(
         /* webpackChunkName: "google-tag-manager" */ './google-tag-manager'

package/dist/umd/google-tag-manager.bundle.c27daab560c3298c04ca.js

@@ -1,2 +0,0 @@
-"use strict";(self.webpackChunk_ht_sdks_events_sdk_js_browser=self.webpackChunk_ht_sdks_events_sdk_js_browser||[]).push([[579],{4557:function(e,t,n){n.r(t),n.d(t,{default:function(){return d}});var i=n(5163),r=n(1494),o=n(3710),s=n(6338),a=function(){function e(e,t,n){this.name=e,this.version=t,this.actions=n,this.type="destination",this.middleware=[],this.alias=this._createMethod("alias"),this.group=this._createMethod("group"),this.identify=this._createMethod("identify"),this.page=this._createMethod("page"),this.screen=this._createMethod("screen"),this.track=this._createMethod("track")}return e.prototype.isLoaded=function(){return!0},e.prototype.load=function(){return console.debug("loaded destination plugin: ".concat(this.name," v").concat(this.version)),Promise.resolve()},e.prototype.addMiddleware=function(){for(var e,t=[],n=0;n<arguments.length;n++)t[n]=arguments[n];(e=this.middleware).push.apply(e,t)},e.prototype.transform=function(e){return(0,i.mG)(this,void 0,Promise,(function(){var t;return(0,i.Jh)(this,(function(n){switch(n.label){case 0:return[4,(0,s.applyDestinationMiddleware)(this.name,e.event,this.middleware)];case 1:return null==(t=n.sent())&&e.cancel(new r.Y({retry:!1,reason:"dropped by destination middleware"})),[2,new o._(t)]}}))}))},e.prototype._createMethod=function(e){var t=this;return function(n){return(0,i.mG)(t,void 0,Promise,(function(){var t;return(0,i.Jh)(this,(function(i){switch(i.label){case 0:return this.actions[e]?[4,this.transform(n)]:[2,n];case 1:return t=i.sent(),[4,this.actions[e](t)];case 2:return i.sent(),[2,n]}}))}))}},e}(),d=function(e){var t=e.measurementId,n=void 0===t?[]:t,r=e.trackAllPages,o=void 0!==r&&r,s=e.trackNamedPages,d=void 0===s||s,c=e.trackCategorizedPages,u=void 0===c||c,h=(Array.isArray(n)?n:[n]).filter(Boolean),p=function(e){var t=e.event;return(0,i.pi)((0,i.pi)((0,i.pi)((0,i.pi)({},t.userId&&{user_id:t.userId}),t.anonymousId&&{hightouch_anonymous_id:t.anonymousId}),h.length>0&&{send_to:h}),t.properties)};return new a("Google Tag Manager","0.0.1",{identify:function(e){e.event.userId&&h.forEach((function(t){window.gtag("config",t,{user_id:e.event.userId})}))},page:function(e){if(o||d&&e.event.name||u&&e.event.category){var t=["Viewed",e.event.category,e.event.name,"Page"].filter(Boolean).join(" ");window.gtag("event",t,(0,i.pi)({},p(e)))}},track:function(e){window.gtag("event",e.event.event,(0,i.pi)({},p(e)))}})}}}]);
-//# sourceMappingURL=google-tag-manager.bundle.c27daab560c3298c04ca.js.map

package/dist/umd/google-tag-manager.bundle.c27daab560c3298c04ca.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"google-tag-manager.bundle.c27daab560c3298c04ca.js","mappings":"8OAwBA,aAIE,WACWA,EACAC,EACAC,GAFA,KAAAF,KAAAA,EACA,KAAAC,QAAAA,EACA,KAAAC,QAAAA,EANF,KAAAC,KAAO,cACP,KAAAC,WAA8C,GAqBvD,KAAAC,MAAQC,KAAKC,cAAc,SAC3B,KAAAC,MAAQF,KAAKC,cAAc,SAC3B,KAAAE,SAAWH,KAAKC,cAAc,YAC9B,KAAAG,KAAOJ,KAAKC,cAAc,QAC1B,KAAAI,OAASL,KAAKC,cAAc,UAC5B,KAAAK,MAAQN,KAAKC,cAAc,QApBxB,CAoDL,OAlDE,YAAAM,SAAA,WACE,OAAO,CACT,EAEA,YAAAC,KAAA,WAEE,OADAC,QAAQC,MAAM,qCAA8BV,KAAKN,KAAI,aAAKM,KAAKL,UACxDgB,QAAQC,SACjB,EAEA,YAAAC,cAAA,W,UAAc,mDACZ,EAAAb,KAAKF,YAAWgB,KAAI,QAAIC,EAC1B,EASc,YAAAC,UAAd,SAAwBC,G,2BAAeN,SAAO,W,8DACtB,UAAM,IAAAO,4BAC1BlB,KAAKN,KACLuB,EAAIE,MACJnB,KAAKF,a,OAYP,OATqB,OANfsB,EAAgB,WAOpBH,EAAII,OACF,IAAI,IAAmB,CACrBC,OAAO,EACPC,OAAQ,uCAKP,CAAP,EAAO,IAAI,IAAQH,I,QAGb,YAAAnB,cAAR,SAAsBuB,GAAtB,WACE,OAAO,SAAOP,GAAY,wBAAGN,SAAO,W,8DAClC,OAAKX,KAAKJ,QAAQ4B,GAEK,GAAMxB,KAAKgB,UAAUC,IAFV,CAAP,EAAOA,G,OAIlC,OAFMQ,EAAiB,SAEvB,GAAMzB,KAAKJ,QAAQ4B,GAASC,I,OAE5B,OAFA,SAEO,CAAP,EAAOR,G,OAEX,EACF,EA5DA,GCuEA,EA5DuE,SAAC,G,IACtE,IAAAS,cAAAA,OAAa,IAAG,KAAE,EAClB,IAAAC,cAAAA,OAAa,IAAG,GAAK,EACrB,IAAAC,gBAAAA,OAAe,IAAG,GAAI,EACtB,IAAAC,sBAAAA,OAAqB,IAAG,GAAI,EAEtBC,GACJC,MAAMC,QAAQN,GAAiBA,EAAgB,CAACA,IAChDO,OAAOC,SAEHC,EAAY,SAAC,G,IAAEhB,EAAK,QACxB,OAAO,sCACDA,EAAMiB,QAAU,CAClBC,QAASlB,EAAMiB,SAEbjB,EAAMmB,aAAe,CACvBC,uBAAwBpB,EAAMmB,cAE5BR,EAAeU,OAAS,GAAK,CAC/BC,QAASX,IAERX,EAAMuB,WAEb,EAEA,OAAO,IAAIC,EAAY,qBAAsB,QAAS,CACpDxC,SAAU,SAACc,GACLA,EAAIE,MAAMiB,QACZN,EAAec,SAAQ,SAAClB,GACtBmB,OAAOC,KAAK,SAAUpB,EAAe,CACnCW,QAASpB,EAAIE,MAAMiB,QAEvB,GAEJ,EAEAhC,KAAM,SAACa,GACL,GACEU,GACCC,GAAmBX,EAAIE,MAAMzB,MAC7BmC,GAAyBZ,EAAIE,MAAM4B,SACpC,CACA,IAAMC,EAAY,CAAC,SAAU/B,EAAIE,MAAM4B,SAAU9B,EAAIE,MAAMzB,KAAM,QAC9DuC,OAAOC,SACPe,KAAK,KAERJ,OAAOC,KAAK,QAASE,GAAW,WAC3Bb,EAAUlB,I,CAGnB,EAEAX,MAAO,SAACW,GACN4B,OAAOC,KAAK,QAAS7B,EAAIE,MAAMA,OAAO,WACjCgB,EAAUlB,IAEjB,GAEJ,C","sources":["webpack://@ht-sdks/events-sdk-js-browser/./src/plugins/destinations/destination.ts","webpack://@ht-sdks/events-sdk-js-browser/./src/plugins/destinations/google-tag-manager.ts"],"sourcesContent":["import type { DestinationPlugin, Plugin } from '../../core/plugin'\nimport { Context, ContextCancelation } from '../../core/context'\nimport {\n  applyDestinationMiddleware,\n  DestinationMiddlewareFunction,\n} from '../middleware'\n\n// removes the return type from a function\ntype NoReturn<T> = T extends (...args: any[]) => any\n  ? (...args: Parameters<T>) => void | Promise<void>\n  : T\n\ntype PluginActions = Pick<\n  Plugin,\n  'alias' | 'group' | 'identify' | 'page' | 'screen' | 'track'\n>\n\ntype DestinationActions = {\n  [K in keyof PluginActions]: NoReturn<PluginActions[K]>\n}\n\n/**\n * Convenience class for writing 3rd party destination plugins\n */\nexport class Destination implements DestinationPlugin {\n  readonly type = 'destination'\n  readonly middleware: DestinationMiddlewareFunction[] = []\n\n  constructor(\n    readonly name: string,\n    readonly version: string,\n    readonly actions: DestinationActions\n  ) {}\n\n  isLoaded() {\n    return true\n  }\n\n  load() {\n    console.debug(`loaded destination plugin: ${this.name} v${this.version}`)\n    return Promise.resolve()\n  }\n\n  addMiddleware(...fn: DestinationMiddlewareFunction[]) {\n    this.middleware.push(...fn)\n  }\n\n  alias = this._createMethod('alias')\n  group = this._createMethod('group')\n  identify = this._createMethod('identify')\n  page = this._createMethod('page')\n  screen = this._createMethod('screen')\n  track = this._createMethod('track')\n\n  private async transform(ctx: Context): Promise<Context> {\n    const modifiedEvent = await applyDestinationMiddleware(\n      this.name,\n      ctx.event,\n      this.middleware\n    )\n\n    if (modifiedEvent == null) {\n      ctx.cancel(\n        new ContextCancelation({\n          retry: false,\n          reason: 'dropped by destination middleware',\n        })\n      )\n    }\n\n    return new Context(modifiedEvent)\n  }\n\n  private _createMethod(action: keyof DestinationActions) {\n    return async (ctx: Context): Promise<Context> => {\n      if (!this.actions[action]) return ctx\n\n      const transformedCtx = await this.transform(ctx)\n\n      await this.actions[action]!(transformedCtx)\n\n      return ctx\n    }\n  }\n}\n","import type { Context } from '../../core/context'\nimport type { DestinationFactory } from './types'\nimport { Destination } from './destination'\n\ndeclare global {\n  interface Window {\n    gtag: Function\n  }\n}\n\ntype GoogleTagManagerSettings = {\n  /**\n   * The Google measurement ID(s) to send events to (GA4, Ads)\n   */\n  measurementId?: string | string[]\n\n  /**\n   * If a `Viewed Page` event should be sent for all `htevents.page` calls\n   */\n  trackAllPages?: boolean\n\n  /**\n   * If a `Viewed <name> Page` event should be sent for `htevents.page('Name')` calls\n   */\n  trackNamedPages?: boolean\n\n  /**\n   * If a `Viewed <category> <name> Page` event should be sent for `htevents.page('Category', 'Name')` calls\n   */\n  trackCategorizedPages?: boolean\n}\n\n/**\n * https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/google-tag-manager/lib/index.js\n */\nconst googleTagManager: DestinationFactory<GoogleTagManagerSettings> = ({\n  measurementId = [],\n  trackAllPages = false,\n  trackNamedPages = true,\n  trackCategorizedPages = true,\n}) => {\n  const measurementIds = (\n    Array.isArray(measurementId) ? measurementId : [measurementId]\n  ).filter(Boolean)\n\n  const baseEvent = ({ event }: Context) => {\n    return {\n      ...(event.userId && {\n        user_id: event.userId,\n      }),\n      ...(event.anonymousId && {\n        hightouch_anonymous_id: event.anonymousId,\n      }),\n      ...(measurementIds.length > 0 && {\n        send_to: measurementIds,\n      }),\n      ...event.properties,\n    }\n  }\n\n  return new Destination('Google Tag Manager', '0.0.1', {\n    identify: (ctx) => {\n      if (ctx.event.userId) {\n        measurementIds.forEach((measurementId) => {\n          window.gtag('config', measurementId, {\n            user_id: ctx.event.userId,\n          })\n        })\n      }\n    },\n\n    page: (ctx) => {\n      if (\n        trackAllPages ||\n        (trackNamedPages && ctx.event.name) ||\n        (trackCategorizedPages && ctx.event.category)\n      ) {\n        const eventName = ['Viewed', ctx.event.category, ctx.event.name, 'Page']\n          .filter(Boolean)\n          .join(' ')\n\n        window.gtag('event', eventName, {\n          ...baseEvent(ctx),\n        })\n      }\n    },\n\n    track: (ctx) => {\n      window.gtag('event', ctx.event.event, {\n        ...baseEvent(ctx),\n      })\n    },\n  })\n}\n\nexport default googleTagManager\n"],"names":["name","version","actions","type","middleware","alias","this","_createMethod","group","identify","page","screen","track","isLoaded","load","console","debug","Promise","resolve","addMiddleware","push","fn","transform","ctx","applyDestinationMiddleware","event","modifiedEvent","cancel","retry","reason","action","transformedCtx","measurementId","trackAllPages","trackNamedPages","trackCategorizedPages","measurementIds","Array","isArray","filter","Boolean","baseEvent","userId","user_id","anonymousId","hightouch_anonymous_id","length","send_to","properties","Destination","forEach","window","gtag","category","eventName","join"],"sourceRoot":""}