Introduce Client Hints API

packages/browser/src/core/analytics/index.ts

@@ -48,6 +48,7 @@ import { version } from '../../generated/version'
 import { PriorityQueue } from '../../lib/priority-queue'
 import { getGlobal } from '../../lib/get-global'
 import { AnalyticsClassic, AnalyticsCore } from './interfaces'
+import { HighEntropyValues } from '../../plugins/segmentio/normalize'
 
 const deprecationWarning =
   'This is being deprecated and will be not be available in future releases of Analytics JS'
@@ -102,6 +103,7 @@ export interface InitOptions {
         aid?: RegExp
         uid?: RegExp
       }
+  highEntropyValues?: HighEntropyValues[]
 }
 
 /* analytics-classic stubs */

packages/browser/src/plugins/segmentio/index.ts

@@ -103,11 +103,10 @@ export function segmentio(
       json = onAlias(analytics, json)
     }
 
+    const event = await normalize(analytics, json, settings, integrations)
+
     return client
-      .dispatch(
-        `${remote}/${path}`,
-        normalize(analytics, json, settings, integrations)
-      )
+      .dispatch(`${remote}/${path}`, event)
       .then(() => ctx)
       .catch(() => {
         buffer.pushWithBackoff(ctx)

packages/browser/src/plugins/segmentio/normalize.ts

@@ -9,6 +9,42 @@ import { SegmentioSettings } from './index'
 import { version } from '../../generated/version'
 import { getAvailableStorageOptions, UniversalStorage } from '../../core/user'
 
+declare global {
+  interface Navigator {
+    userAgentData: UserAgentData
+  }
+}
+
+interface Brand {
+  brand: string
+  version: string
+}
+
+export type HighEntropyValues =
+  | 'architecture'
+  | 'bitness'
+  | 'model'
+  | 'platformVersion'
+  | 'fullVersionList'
+
+export interface UserAgentData {
+  brands: Brand[]
+  mobile: boolean
+  platform: string
+  getHighEntropyValues: Function
+}
+
+interface UserAgentDataContext {
+  brands: Brand[]
+  mobile: boolean
+  platform: string
+  platformVersion?: string
+  architecture?: string
+  bitness?: string
+  model?: string
+  fullVersionList?: Brand[]
+}
+
 let cookieOptions: jar.CookieAttributes | undefined
 function getCookieOptions(): jar.CookieAttributes {
   if (cookieOptions) {
@@ -118,12 +154,35 @@ function referrerId(
   storage.set('s:context.referrer', ad)
 }
 
-export function normalize(
+async function clientHints(
+  hints: HighEntropyValues[] | undefined
+): Promise<UserAgentDataContext> {
+  const userAgentData = navigator.userAgentData
+
+  let userAgentDataContext: UserAgentDataContext = {
+    brands: userAgentData.brands,
+    mobile: userAgentData.mobile,
+    platform: userAgentData.platform,
+  }
+
+  if (hints) {
+    try {
+      // this also includes the low entropy values, so we can overwrite here
+      userAgentDataContext = await userAgentData.getHighEntropyValues(hints)
+    } catch (_) {
+      return userAgentDataContext
+    }
+  }
+
+  return userAgentDataContext
+}
+
+export async function normalize(
   analytics: Analytics,
   json: ReturnType<SegmentFacade['json']>,
   settings?: SegmentioSettings,
   integrations?: LegacySettings['integrations']
-): object {
+): Promise<object> {
   const user = analytics.user()
 
   // context should always exist here (see page enrichment)? ... and why would we default to json.options? todo: delete this
@@ -136,6 +195,9 @@ export function normalize(
   delete json.options
   json.writeKey = settings?.apiKey
   ctx.userAgent = window.navigator.userAgent
+  if (window.navigator.userAgentData) {
+    ctx.userAgentData = await clientHints(analytics.options.highEntropyValues)
+  }
 
   // @ts-ignore
   const locale = navigator.userLanguage || navigator.language