Fix built-in context typing for newTracker (fix snowplow#1089)

PR snowplow#1090

Author: igneel64

common/changes/@snowplow/browser-tracker-core/issue-1089-built-in-context-typing_2022-08-24-17-10.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker-core",
+      "comment": "Fix newTracker built-in context typing",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker-core"
+}

common/changes/@snowplow/browser-tracker-core/issue-1089-built-in-context-typing_2022-08-24-17-46.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker-core",
+      "comment": "Added BuiltInContexts type",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker-core"
+}

common/changes/@snowplow/browser-tracker/issue-1089-built-in-context-typing_2022-08-24-17-46.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker",
+      "comment": "Fix newTracker built-in context typing",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker"
+}

libraries/browser-tracker-core/src/tracker/types.ts

@@ -37,6 +37,18 @@ import {
 } from '@snowplow/tracker-core';
 import { SharedState } from '../state';
 
+type RequireAtLeastOne<T> = { [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>> }[keyof T];
+
+/* Available built-in contexts */
+export type BuiltInContexts =
+  | RequireAtLeastOne<{
+      /* Toggles the web_page context */
+      webPage: boolean;
+      /* Toggles the session context */
+      session: boolean;
+    }>
+  | Record<string, never>;
+
 /* Configuration for Anonymous Tracking */
 export type AnonymousTrackingOptions = boolean | { withSessionTracking?: boolean; withServerAnonymisation?: boolean };
 /* Available configurations for different storage strategies */
@@ -139,7 +151,7 @@ export type TrackerConfiguration = {
   bufferSize?: number;
   /**
    * Configure the cross domain linker which will add user identifiers to
-   * links becaused on the callback
+   * links on the callback
    */
   crossDomainLinker?: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean;
   /**
@@ -162,7 +174,7 @@ export type TrackerConfiguration = {
    */
   discoverRootDomain?: boolean;
   /**
-   * The storage strategy which the tracker will use for storing user and session identifers
+   * The storage strategy which the tracker will use for storing user and session identifiers
    * and if local storage is allowed for buffering the events
    * @defaultValue cookieAndLocalStorage
    */
@@ -189,15 +201,15 @@ export type TrackerConfiguration = {
    */
   connectionTimeout?: number;
   /**
-   * Condifugration for Anonymous Tracking
+   * Configuration for Anonymous Tracking
    * @defaultValue false
    */
   anonymousTracking?: AnonymousTrackingOptions;
   /**
    * Use to configure built in contexts
    * @defaultValue `{ webPage: true, session: false }`
    */
-  contexts?: { webPage: boolean; session: boolean };
+  contexts?: BuiltInContexts;
   /**
    * Inject plugins which will be evaluated for each event
    * @defaultValue []
@@ -432,7 +444,7 @@ export interface BrowserTracker {
   newSession: () => void;
 
   /**
-   * Enable querystring decoration for links pasing a filter
+   * Enable querystring decoration for links passing a filter
    *
    * @param crossDomainLinkerCriterion - Function used to determine which links to decorate
    */

trackers/browser-tracker/docs/browser-tracker.api.md

@@ -98,6 +98,16 @@ export interface BrowserTracker {
     updatePageActivity: () => void;
 }
 
+// Warning: (ae-forgotten-export) The symbol "RequireAtLeastOne" needs to be exported by the entry point index.module.d.ts
+//
+// @public (undocumented)
+export type BuiltInContexts = RequireAtLeastOne<{
+    /* Toggles the web_page context */
+    webPage: boolean;
+    /* Toggles the session context */
+    session: boolean;
+}> | Record<string, never>;
+
 // @public
 export function clearGlobalContexts(trackers?: Array<string>): void;
 
@@ -329,10 +339,7 @@ export type TrackerConfiguration = {
     resetActivityTrackingOnPageView?: boolean;
     connectionTimeout?: number;
     anonymousTracking?: AnonymousTrackingOptions;
-    contexts?: {
-        webPage: boolean;
-        session: boolean;
-    };
+    contexts?: BuiltInContexts;
     plugins?: Array<BrowserPlugin>;
     customHeaders?: Record<string, string>;
     retryStatusCodes?: number[];

trackers/browser-tracker/src/api.ts

@@ -36,6 +36,7 @@ import {
   ActivityCallbackData,
   BrowserPlugin,
   BrowserPluginConfiguration,
+  BuiltInContexts,
   DisableAnonymousTrackingConfiguration,
   EnableAnonymousTrackingConfiguration,
   AnonymousTrackingOptions,
@@ -67,6 +68,7 @@ export {
   ActivityCallbackData,
   BrowserPlugin,
   BrowserPluginConfiguration,
+  BuiltInContexts,
   FlushBufferConfiguration,
   PageViewEvent,
   EnableAnonymousTrackingConfiguration,