@ht-sdks/events-sdk-js-browser 1.0.4 → 1.2.0

package/dist/umd/legacyVideos.bundle.6250709892bb05b68333.js.map

@@ -1 +1 @@
-{"version":3,"file":"legacyVideos.bundle.6250709892bb05b68333.js","mappings":"+NAEO,SAAeA,EACpBC,G,2BACCC,SAAO,W,8DACQ,SAAM,oC,cAAhBC,EAAU,SAShBF,EAAUG,SAAWD,E","sources":["webpack://@ht-sdks/events-sdk-js-browser/./src/plugins/legacy-video-plugins/index.ts"],"sourcesContent":["import { Analytics } from '../../core/analytics'\n\nexport async function loadLegacyVideoPlugins(\n  analytics: Analytics\n): Promise<void> {\n  const plugins = await import(\n    // @ts-expect-error\n    '@segment/analytics.js-video-plugins/dist/index.umd.js'\n  )\n\n  // This is super gross, but we need to support the `window.analytics.plugins` namespace\n  // that is linked in the segment docs in order to be backwards compatible with ajs-classic\n\n  // @ts-expect-error\n  analytics._plugins = plugins\n}\n"],"names":["loadLegacyVideoPlugins","analytics","Promise","plugins","_plugins"],"sourceRoot":""}
+{"version":3,"file":"legacyVideos.bundle.6250709892bb05b68333.js","mappings":"+NAEO,SAAeA,EACpBC,G,2BACCC,SAAO,W,8DACQ,SAAM,oC,cAAhBC,EAAU,SAShBF,EAASG,SAAWD,E","sources":["webpack://@ht-sdks/events-sdk-js-browser/./src/plugins/legacy-video-plugins/index.ts"],"sourcesContent":["import { Analytics } from '../../core/analytics'\n\nexport async function loadLegacyVideoPlugins(\n  htevents: Analytics\n): Promise<void> {\n  const plugins = await import(\n    // @ts-expect-error\n    '@segment/analytics.js-video-plugins/dist/index.umd.js'\n  )\n\n  // This is super gross, but we need to support the `window.htevents.plugins` namespace\n  // that is linked in the hightouch docs in order to be backwards compatible with ajs-classic\n\n  // @ts-expect-error\n  htevents._plugins = plugins\n}\n"],"names":["loadLegacyVideoPlugins","htevents","Promise","plugins","_plugins"],"sourceRoot":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ht-sdks/events-sdk-js-browser",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/ht-sdks/events-sdk-js-mono",
@@ -49,7 +49,7 @@
     }
   ],
   "dependencies": {
-    "@ht-sdks/events-sdk-js-core": "^1.0.0",
+    "@ht-sdks/events-sdk-js-core": "^1.1.0",
     "@lukeed/uuid": "^2.0.0",
     "@segment/analytics.js-video-plugins": "^0.2.1",
     "@segment/facade": "^3.4.9",
@@ -86,7 +86,7 @@
     "jest-dev-server": "^6.0.3",
     "jest-environment-jsdom": "^28.1.1",
     "jquery": "^3.5.1",
-    "jsdom": "^19.0.0",
+    "jsdom": "^20.0.0",
     "lighthouse": "^9.6.3",
     "log-update": "^4.0.0",
     "micro-memoize": "^4.0.9",

package/src/browser/index.ts

@@ -4,6 +4,7 @@ import { getCDN, setGlobalCDNUrl } from '../lib/parse-cdn'
 import { fetch } from '../lib/fetch'
 import { Analytics, AnalyticsSettings, InitOptions } from '../core/analytics'
 import { Context } from '../core/context'
+import { HTTPCookieService } from '../core/http-cookies'
 import { Plan } from '../core/events'
 import { Plugin } from '../core/plugin'
 import { MetricsOptions } from '../core/stats/remote-metrics'
@@ -53,7 +54,7 @@ export interface LegacyIntegrationConfiguration {
     categories: string[]
   }
 
-  // Segment.io specific
+  // Hightouch.io specific
   retryQueue?: boolean
 
   // any extra unknown settings
@@ -92,15 +93,15 @@ export interface LegacySettings {
   }
 }
 
-export interface AnalyticsBrowserSettings extends AnalyticsSettings {
+export interface HtEventsBrowserSettings extends AnalyticsSettings {
   /**
-   * The settings for the Segment Source.
-   * If provided, `AnalyticsBrowser` will not fetch remote settings
+   * The settings for the Hightouch Source.
+   * If provided, `HtEventsBrowser` will not fetch remote settings
    * for the source.
    */
   cdnSettings?: LegacySettings & Record<string, unknown>
   /**
-   * If provided, will override the default Segment CDN (https://cdn.hightouch-events.com) for this application.
+   * If provided, will override the default Hightouch CDN (https://cdn.hightouch-events.com) for this application.
    */
   cdnURL?: string
 }
@@ -321,7 +322,7 @@ const defaultSettings: LegacySettings = {
 }
 
 async function loadAnalytics(
-  settings: AnalyticsBrowserSettings,
+  settings: HtEventsBrowserSettings,
   options: InitOptions = {},
   preInitBuffer: PreInitMethodCallBuffer
 ): Promise<[Analytics, Context]> {
@@ -359,6 +360,12 @@ async function loadAnalytics(
   const retryQueue: boolean =
     legacySettings.integrations['Hightouch.io']?.retryQueue ?? true
 
+  if (!options.disableClientPersistence && options.httpCookieServiceOptions) {
+    options.httpCookieService = await HTTPCookieService.load(
+      options.httpCookieServiceOptions
+    )
+  }
+
   const opts: InitOptions = { retryQueue, ...options }
   const analytics = new Analytics(settings, opts)
 
@@ -406,24 +413,24 @@ async function loadAnalytics(
 }
 
 /**
- * The public browser interface for Segment Analytics
+ * The public browser interface for Hightouch Events
  *
  * @example
  * ```ts
- *  export const analytics = new AnalyticsBrowser()
- *  analytics.load({ writeKey: 'foo' })
+ *  export const htevents = new HtEventsBrowser()
+ *  htevents.load({ writeKey: 'foo' })
  * ```
  * @link https://github.com/ht-sdks/events-sdk-js-mono/tree/master/packages/browser#readme
  */
-export class AnalyticsBrowser extends AnalyticsBuffered {
+export class HtEventsBrowser extends AnalyticsBuffered {
   private _resolveLoadStart: (
-    settings: AnalyticsBrowserSettings,
+    settings: HtEventsBrowserSettings,
     options: InitOptions
   ) => void
 
   constructor() {
     const { promise: loadStart, resolve: resolveLoadStart } =
-      createDeferred<Parameters<AnalyticsBrowser['load']>>()
+      createDeferred<Parameters<HtEventsBrowser['load']>>()
 
     super((buffer) =>
       loadStart.then(([settings, options]) =>
@@ -447,14 +454,14 @@ export class AnalyticsBrowser extends AnalyticsBuffered {
    *
    * @example
    * ```ts
-   * export const analytics = new AnalyticsBrowser()
+   * export const analytics = new HtEventsBrowser()
    * analytics.load({ writeKey: 'foo' })
    * ```
    */
   load(
-    settings: AnalyticsBrowserSettings,
+    settings: HtEventsBrowserSettings,
     options: InitOptions = {}
-  ): AnalyticsBrowser {
+  ): HtEventsBrowser {
     this._resolveLoadStart(settings, options)
     return this
   }
@@ -464,23 +471,23 @@ export class AnalyticsBrowser extends AnalyticsBuffered {
    *
    * @example
    * ```ts
-   * const ajs = AnalyticsBrowser.load({ writeKey: '<YOUR_WRITE_KEY>' })
+   * const ajs = HtEventsBrowser.load({ writeKey: '<YOUR_WRITE_KEY>' })
    *
    * ajs.track("foo")
    * ...
    * ```
    */
   static load(
-    settings: AnalyticsBrowserSettings,
+    settings: HtEventsBrowserSettings,
     options: InitOptions = {}
-  ): AnalyticsBrowser {
-    return new AnalyticsBrowser().load(settings, options)
+  ): HtEventsBrowser {
+    return new HtEventsBrowser().load(settings, options)
   }
 
   static standalone(
     writeKey: string,
     options?: InitOptions
   ): Promise<Analytics> {
-    return AnalyticsBrowser.load({ writeKey }, options).then((res) => res[0])
+    return HtEventsBrowser.load({ writeKey }, options).then((res) => res[0])
   }
 }

package/src/browser/standalone-analytics.ts

@@ -1,6 +1,6 @@
-import { AnalyticsBrowser } from '.'
+import { HtEventsBrowser } from '.'
 import { embeddedWriteKey } from '../lib/embedded-write-key'
-import { AnalyticsSnippet } from './standalone-interface'
+import { HtEventsSnippet } from './standalone-interface'
 import {
   getGlobalAnalytics,
   setGlobalAnalytics,
@@ -57,6 +57,6 @@ export async function install(): Promise<void> {
   }
 
   setGlobalAnalytics(
-    (await AnalyticsBrowser.standalone(writeKey, options)) as AnalyticsSnippet
+    (await HtEventsBrowser.standalone(writeKey, options)) as HtEventsSnippet
   )
 }

package/src/browser/standalone-interface.ts

@@ -1,6 +1,6 @@
 import { Analytics, InitOptions } from '../core/analytics'
 
-export interface AnalyticsSnippet extends AnalyticsStandalone {
+export interface HtEventsSnippet extends AnalyticsStandalone {
   load: (writeKey: string, options?: InitOptions) => void
 }
 

package/src/core/analytics/index.ts

@@ -20,7 +20,7 @@ import {
   Integrations,
   Plan,
   EventProperties,
-  SegmentEvent,
+  HightouchEvent,
 } from '../events'
 import type { Plugin } from '../plugin'
 import { EventQueue } from '../queue/event-queue'
@@ -55,6 +55,10 @@ import {
 import { PluginFactory } from '../../plugins/remote-loader'
 import { setGlobalAnalytics } from '../../lib/global-analytics-helper'
 import { popPageContext } from '../buffer'
+import type {
+  HTTPCookieService,
+  HTTPCookieServiceOptions,
+} from '../http-cookies'
 
 const deprecationWarning =
   'This is being deprecated and will be not be available in future releases of Analytics JS'
@@ -124,11 +128,20 @@ export interface InitOptions {
    */
   highEntropyValuesClientHints?: HighEntropyHint[]
   /**
-   * When using the snippet, this is the key that points to the global analytics instance (e.g. window.analytics).
+   * When using the snippet, this is the key that points to the global analytics instance (e.g. window.htevents).
    * default: analytics
    */
   globalAnalyticsKey?: string
 
+  /**
+   * When setting httpCookieServiceOptions, an HTTPCookieService is automatically created
+   */
+  httpCookieServiceOptions?: HTTPCookieServiceOptions
+  /**
+   * When not setting httpCookieServiceOptions, you may pass your own instance of HTTPCookieService
+   */
+  httpCookieService?: HTTPCookieService
+
   /**
    * Shortcuts for overriding the default Hightouch.io integration settings
    */
@@ -191,6 +204,7 @@ export class Analytics
         {
           persist: !disablePersistance,
           storage: options?.storage,
+          httpCookieService: options?.httpCookieService,
           // Any User specific options override everything else
           ...options?.user,
         },
@@ -481,7 +495,7 @@ export class Analytics
   }
 
   private async _dispatch(
-    event: SegmentEvent,
+    event: HightouchEvent,
     callback?: Callback
   ): Promise<DispatchedEvent> {
     const ctx = new Context(event)
@@ -577,7 +591,7 @@ export class Analytics
     return this
   }
 
-  normalize(msg: SegmentEvent): SegmentEvent {
+  normalize(msg: HightouchEvent): HightouchEvent {
     console.warn(deprecationWarning)
     return this.eventFactory.normalize(msg)
   }

package/src/core/analytics/interfaces.ts

@@ -9,7 +9,7 @@ import type {
   GroupParams,
 } from '../arguments-resolver'
 import type { Context } from '../context'
-import type { SegmentEvent } from '../events'
+import type { HightouchEvent } from '../events'
 import type { Group, User } from '../user'
 import type { LegacyIntegration } from '../../plugins/ajs-destination/types'
 import { CoreAnalytics } from '@ht-sdks/events-sdk-js-core'
@@ -58,7 +58,7 @@ export interface AnalyticsClassic extends AnalyticsClassicStubs {
   noConflict(): Analytics
 
   /** @deprecated */
-  normalize(msg: SegmentEvent): SegmentEvent
+  normalize(msg: HightouchEvent): HightouchEvent
 
   /** @deprecated */
   readonly failedInitializations: string[]
@@ -74,7 +74,7 @@ export interface AnalyticsClassic extends AnalyticsClassicStubs {
 }
 
 /**
- * Interface implemented by concrete Analytics class (commonly accessible if you use "await" on AnalyticsBrowser.load())
+ * Interface implemented by concrete Analytics class (commonly accessible if you use "await" on HtEventsBrowser.load())
  */
 export interface AnalyticsCore extends CoreAnalytics {
   track(...args: EventParams): Promise<DispatchedEvent>
@@ -91,9 +91,9 @@ export interface AnalyticsCore extends CoreAnalytics {
 }
 
 /**
- * Interface implemented by AnalyticsBrowser (buffered version of analytics) (commonly accessible through AnalyticsBrowser.load())
+ * Interface implemented by HtEventsBrowser (buffered version of analytics) (commonly accessible through HtEventsBrowser.load())
  */
-export type AnalyticsBrowserCore = Omit<AnalyticsCore, 'group' | 'user'> & {
+export type HtEventsBrowserCore = Omit<AnalyticsCore, 'group' | 'user'> & {
   group(): Promise<Group>
   group(...args: GroupParams): Promise<DispatchedEvent>
   user(): Promise<User>

package/src/core/arguments-resolver/index.ts

@@ -10,7 +10,7 @@ import {
   JSONObject,
   Options,
   EventProperties,
-  SegmentEvent,
+  HightouchEvent,
   Traits,
   GroupTraits,
   UserTraits,
@@ -21,7 +21,7 @@ import { ID, User } from '../user'
  * Helper for the track method
  */
 export function resolveArguments(
-  eventName: string | SegmentEvent,
+  eventName: string | HightouchEvent,
   properties?: EventProperties | Callback,
   options?: Options | Callback,
   callback?: Callback

package/src/core/buffer/index.ts

@@ -1,7 +1,7 @@
 import { Analytics } from '../analytics'
 import { Context } from '../context'
 import { isThenable } from '../../lib/is-thenable'
-import { AnalyticsBrowserCore } from '../analytics/interfaces'
+import { HtEventsBrowserCore } from '../analytics/interfaces'
 import { version } from '../../generated/version'
 import { getGlobalAnalytics } from '../../lib/global-analytics-helper'
 import {
@@ -13,7 +13,7 @@ import {
 } from '../page'
 
 /**
- * The names of any AnalyticsBrowser methods that also exist on Analytics
+ * The names of any HtEventsBrowser methods that also exist on Analytics
  */
 export type PreInitMethodName =
   | 'screen'
@@ -264,7 +264,7 @@ export type AnalyticsLoader = (
 ) => Promise<[Analytics, Context]>
 
 export class AnalyticsBuffered
-  implements PromiseLike<[Analytics, Context]>, AnalyticsBrowserCore
+  implements PromiseLike<[Analytics, Context]>, HtEventsBrowserCore
 {
   instance?: Analytics
   ctx?: Context
@@ -317,7 +317,7 @@ export class AnalyticsBuffered
   pageView = this._createMethod('pageview')
   identify = this._createMethod('identify')
   reset = this._createMethod('reset')
-  group = this._createMethod('group') as AnalyticsBrowserCore['group']
+  group = this._createMethod('group') as HtEventsBrowserCore['group']
   track = this._createMethod('track')
   ready = this._createMethod('ready')
   alias = this._createMethod('alias')

package/src/core/context/index.ts

@@ -5,14 +5,14 @@ import {
   SerializedContext,
   CancelationOptions,
 } from '@ht-sdks/events-sdk-js-core'
-import { SegmentEvent } from '../events/interfaces'
+import { HightouchEvent } from '../events/interfaces'
 import { Stats } from '../stats'
 
-export class Context extends CoreContext<SegmentEvent> {
+export class Context extends CoreContext<HightouchEvent> {
   static override system() {
     return new this({ type: 'track', event: 'system' })
   }
-  constructor(event: SegmentEvent, id?: string) {
+  constructor(event: HightouchEvent, id?: string) {
     super(event, id, new Stats())
   }
 }

package/src/core/events/index.ts

@@ -6,7 +6,7 @@ import {
   Integrations,
   EventProperties,
   Traits,
-  SegmentEvent,
+  HightouchEvent,
 } from './interfaces'
 import md5 from 'spark-md5'
 import { addPageContext, PageContext } from '../page'
@@ -22,7 +22,7 @@ export class EventFactory {
     options?: Options,
     globalIntegrations?: Integrations,
     pageCtx?: PageContext
-  ): SegmentEvent {
+  ): HightouchEvent {
     return this.normalize(
       {
         ...this.baseEvent(),
@@ -43,8 +43,8 @@ export class EventFactory {
     options?: Options,
     globalIntegrations?: Integrations,
     pageCtx?: PageContext
-  ): SegmentEvent {
-    const event: Partial<SegmentEvent> = {
+  ): HightouchEvent {
+    const event: Partial<HightouchEvent> = {
       type: 'page' as const,
       properties: { ...properties },
       options: { ...options },
@@ -65,7 +65,7 @@ export class EventFactory {
       {
         ...this.baseEvent(),
         ...event,
-      } as SegmentEvent,
+      } as HightouchEvent,
       pageCtx
     )
   }
@@ -77,8 +77,8 @@ export class EventFactory {
     options?: Options,
     globalIntegrations?: Integrations,
     pageCtx?: PageContext
-  ): SegmentEvent {
-    const event: Partial<SegmentEvent> = {
+  ): HightouchEvent {
+    const event: Partial<HightouchEvent> = {
       type: 'screen' as const,
       properties: { ...properties },
       options: { ...options },
@@ -96,7 +96,7 @@ export class EventFactory {
       {
         ...this.baseEvent(),
         ...event,
-      } as SegmentEvent,
+      } as HightouchEvent,
       pageCtx
     )
   }
@@ -107,7 +107,7 @@ export class EventFactory {
     options?: Options,
     globalIntegrations?: Integrations,
     pageCtx?: PageContext
-  ): SegmentEvent {
+  ): HightouchEvent {
     return this.normalize(
       {
         ...this.baseEvent(),
@@ -127,7 +127,7 @@ export class EventFactory {
     options?: Options,
     globalIntegrations?: Integrations,
     pageCtx?: PageContext
-  ): SegmentEvent {
+  ): HightouchEvent {
     return this.normalize(
       {
         ...this.baseEvent(),
@@ -147,8 +147,8 @@ export class EventFactory {
     options?: Options,
     globalIntegrations?: Integrations,
     pageCtx?: PageContext
-  ): SegmentEvent {
-    const base: Partial<SegmentEvent> = {
+  ): HightouchEvent {
+    const base: Partial<HightouchEvent> = {
       userId: to,
       type: 'alias' as const,
       options: { ...options },
@@ -163,20 +163,20 @@ export class EventFactory {
       return this.normalize({
         ...base,
         ...this.baseEvent(),
-      } as SegmentEvent)
+      } as HightouchEvent)
     }
 
     return this.normalize(
       {
         ...this.baseEvent(),
         ...base,
-      } as SegmentEvent,
+      } as HightouchEvent,
       pageCtx
     )
   }
 
-  private baseEvent(): Partial<SegmentEvent> {
-    const base: Partial<SegmentEvent> = {
+  private baseEvent(): Partial<HightouchEvent> {
+    const base: Partial<HightouchEvent> = {
       integrations: {},
       options: {},
     }
@@ -198,7 +198,7 @@ export class EventFactory {
    * Builds the context part of an event based on "foreign" keys that
    * are provided in the `Options` parameter for an Event
    */
-  private context(event: SegmentEvent): [object, object] {
+  private context(event: HightouchEvent): [object, object] {
     const optionsKeys = ['integrations', 'anonymousId', 'timestamp', 'userId']
 
     const options = event.options ?? {}
@@ -224,7 +224,10 @@ export class EventFactory {
     return [context, overrides]
   }
 
-  public normalize(event: SegmentEvent, pageCtx?: PageContext): SegmentEvent {
+  public normalize(
+    event: HightouchEvent,
+    pageCtx?: PageContext
+  ): HightouchEvent {
     // set anonymousId globally if we encounter an override
     event.options?.anonymousId &&
       this.user.anonymousId(event.options.anonymousId)
@@ -254,7 +257,7 @@ export class EventFactory {
     const [context, overrides] = this.context(event)
     const { options, ...rest } = event
 
-    const newEvent: SegmentEvent = {
+    const newEvent: HightouchEvent = {
       timestamp: new Date(),
       ...rest,
       context,

package/src/core/events/interfaces.ts

@@ -1,6 +1,6 @@
 import {
   CoreOptions,
-  CoreSegmentEvent,
+  CoreHightouchEvent,
   Callback,
   Integrations,
   Plan,
@@ -21,7 +21,7 @@ export type { GroupTraits, UserTraits, Traits }
 
 export type EventProperties = Record<string, any>
 
-export interface SegmentEvent extends CoreSegmentEvent {}
+export interface HightouchEvent extends CoreHightouchEvent {}
 
 export type {
   Integrations,