@encorekit/web-sdk 2.1.1 → 2.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@encorekit/web-sdk",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "type": "module",
   "description": "Encore SDK for web applications - display targeted offers and manage user entitlements",
   "main": "./dist/cjs/index.cjs",

package/types/analytics/transport.d.ts

@@ -8,8 +8,8 @@
 import type { AnalyticsEvent, EventEnvelope } from './models';
 /**
  * Wrap an event in the analytics wire envelope, injecting the shared web metadata
- * (platform, sdk_version, app_bundle_id). `eventId` defaults to a fresh UUID;
- * callers needing idempotent retries pass a stable id.
+ * (platform, agent_type, device_os, sdk_version, app_bundle_id). `eventId` defaults to a
+ * fresh UUID; callers needing idempotent retries pass a stable id.
  */
 export declare function buildEnvelope(event: AnalyticsEvent, eventId?: string): EventEnvelope;
 /**

package/types/analytics/transport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../src/analytics/transport.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAiD9D;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,GAAE,MAAuB,GAAG,aAAa,CAcpG;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GAChC,OAAO,CAAC,QAAQ,CAAC,CAWnB"}
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../src/analytics/transport.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAkD9D;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,GAAE,MAAuB,GAAG,aAAa,CAqBpG;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GAChC,OAAO,CAAC,QAAQ,CAAC,CAWnB"}

package/types/core/version.d.ts

@@ -1,3 +1,3 @@
 /** SDK version — single source of truth (also kept in sync with package.json via scripts/update-version.sh) */
-export declare const SDK_VERSION = "2.1.1";
+export declare const SDK_VERSION = "2.1.2";
 //# sourceMappingURL=version.d.ts.map

package/types/utils/deviceOs.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Device OS Detection
+ *
+ * The end user's device OS, reported on every analytics event. Named
+ * `device_os`, never `platform`: `platform` here is always the literal `web`,
+ * the SDK's own runtime, and cannot answer iOS vs Android.
+ *
+ * Vocabulary is the backend click classifier's, plus the two values only a page
+ * can resolve, so one warehouse query reads both lanes. See
+ * `docs/architecture/platform-divergence/web.md` #5.
+ */
+/** What kind of thing made the request. Always stamped, mirrors the backend. */
+export declare const AgentType: {
+    readonly Browser: "browser";
+    readonly Bot: "bot";
+    readonly HttpClient: "http_client";
+    readonly Unknown: "unknown";
+};
+export type AgentType = (typeof AgentType)[keyof typeof AgentType];
+/** The end user's OS. ONLY operating systems: null when there is none to name. */
+export declare const DeviceOs: {
+    /** iPhone or iPod touch. */
+    readonly Ios: "ios";
+    readonly Android: "android";
+    /** An iPad, separated from a Mac by touch points. Never emitted server-side. */
+    readonly IpadOs: "ipados";
+    /** A Mac, separated from an iPad by touch points. Never emitted server-side. */
+    readonly MacOs: "macos";
+    /** An Apple desktop-class UA we could NOT split, matching the backend's bucket. */
+    readonly MacOsOrIpadOs: "macos_or_ipados";
+    readonly Windows: "windows";
+    /** Parsed, none of the above (Linux desktop, ChromeOS). */
+    readonly Other: "other";
+};
+export type DeviceOs = (typeof DeviceOs)[keyof typeof DeviceOs];
+export interface AgentClassification {
+    agentType: AgentType;
+    /** Non-null if and only if `agentType` is `browser`. */
+    deviceOs: DeviceOs | null;
+}
+/** Memoized: the user agent cannot change for the life of the page. */
+export declare function detectAgent(): AgentClassification;
+/** Test seam only: clears the memo so a stubbed navigator is re-read. */
+export declare function resetDeviceOsCache(): void;
+//# sourceMappingURL=deviceOs.d.ts.map

package/types/utils/deviceOs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceOs.d.ts","sourceRoot":"","sources":["../../src/utils/deviceOs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,gFAAgF;AAChF,eAAO,MAAM,SAAS;;;;;CAKZ,CAAC;AACX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEnE,kFAAkF;AAClF,eAAO,MAAM,QAAQ;IACnB,4BAA4B;;;IAG5B,gFAAgF;;IAEhF,gFAAgF;;IAEhF,mFAAmF;;;IAGnF,2DAA2D;;CAEnD,CAAC;AACX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAoFhE,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,SAAS,CAAC;IACrB,wDAAwD;IACxD,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC3B;AA6DD,uEAAuE;AACvE,wBAAgB,WAAW,IAAI,mBAAmB,CAGjD;AAED,yEAAyE;AACzE,wBAAgB,kBAAkB,IAAI,IAAI,CAEzC"}