@wireai/activation 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -18,6 +18,41 @@ Historical entries below the rename keep the old package name on purpose.
 - Version reset to `0.1.0` to mark the start of the new package line. The GitHub repository
   stays `chohra-med/wireai-onboarding`.
 
+## [Unreleased]
+
+### Added: "device" is now fully automatic — auto-minted, persisted per-install `device_key`
+
+- The analytics façade (`createAnalytics`) now auto-mints a stable, NON-PII per-install `device_key`
+  when the host supplies none via `WireUserContext.deviceKey`. It is minted ONCE (`context/deviceId.ts`
+  — `mintDeviceId`, dependency-free time+random, no `uuid`), PERSISTED via the host's existing
+  `storage` (`WireOnboardingStorage`) under `deviceIdStorageKey(appId)`, and REUSED on every open;
+  with no storage it falls back to an in-memory id. Result: `user_context.device_key` is ALWAYS
+  present, so the server's review/questionnaire gating + A/B stickiness (both key on `device_key`)
+  work out of the box with zero host wiring. A host-supplied `deviceKey` still WINS (and opts out of
+  auto-minting). New exports: `mintDeviceId`, `deviceIdStorageKey`, `AUTO_DEVICE_ID_PREFIX`.
+
+### Fixed: `WireUserContext.appVersion` now flows into `device.appVersion` (not just `user_context`)
+
+- A host that set the app version ONLY inside `userContext` previously got it in
+  `user_context.app_version` but left `device.appVersion` on the auto-detected value — and the
+  server's `by_app_version` breakdown reads `device.appVersion`. The façade's context-envelope
+  provider now feeds `userContext.appVersion ?? config.appVersion` into `buildContextEnvelope`, so an
+  explicit `WireUserContext.appVersion` populates BOTH surfaces (explicit still wins over auto-detect).
+
+### Added: best-effort iOS `device.model`
+
+- `device.model` was Android-only (`Platform.constants.Model`); iOS `Platform.constants` exposes no
+  model. `collectDeviceContext` now fills iOS `model` best-effort via `detectNativeModel`
+  (`device/deviceModel.ts`), reading `expo-device`'s `modelName`/`modelId` through the SAME guarded,
+  variable-specifier require the kit already uses for `appVersion` — so it adds NO dependency and is
+  simply omitted when `expo-device` is absent. It reads a device CLASS (not a unique id / not the
+  user-set device name), so it changes no App Privacy / Data Safety declaration. ASYMMETRY documented
+  in the `DeviceContext.model` TSDoc: without `expo-device`, iOS `model` stays omitted; no native
+  dependency is added for it.
+
+- Backward compatible: no existing export renamed or removed; zero new dependencies. The one
+  behavior change is intentional — events now carry an auto `device_key` when the host omits one.
+
 ## [0.7.0] — Unreleased
 
 ### Added: `WireUserContext` — one rich user-context object → every event's `user_context`

package/dist/analytics/index.d.mts

@@ -1,6 +1,6 @@
 export { R as ReportAppEventOptions, r as reportAppEvent } from '../transport-BeO_Brcu.mjs';
-import { W as WireUserContext, E as EventQueueOptions } from '../currentSession-BJBB7i4-.mjs';
-export { A as AnalyticsEvent, C as ClientEvent, a as ClientEventTarget, b as ClientEventType, c as ContextEnvelope, d as ContextEnvelopeInput, e as EnvelopeSource, f as EventQueue, g as WIRE_ONBOARDING_EVENTS, h as WireOnboardingEventName, i as buildContextEnvelope, j as createEventQueue, k as getCurrentSessionId, m as makeSessionId, r as reportClientEvent, l as reportClientEvents, n as resetCurrentSessionId, s as setCurrentSessionId, t as toAnalyticsEvent } from '../currentSession-BJBB7i4-.mjs';
+import { W as WireUserContext, E as EventQueueOptions } from '../currentSession-d9CrBxwe.mjs';
+export { A as AnalyticsEvent, C as ClientEvent, a as ClientEventTarget, b as ClientEventType, c as ContextEnvelope, d as ContextEnvelopeInput, e as EnvelopeSource, f as EventQueue, g as WIRE_ONBOARDING_EVENTS, h as WireOnboardingEventName, i as buildContextEnvelope, j as createEventQueue, k as getCurrentSessionId, m as makeSessionId, r as reportClientEvent, l as reportClientEvents, n as resetCurrentSessionId, s as setCurrentSessionId, t as toAnalyticsEvent } from '../currentSession-d9CrBxwe.mjs';
 import '../types-A6pTxIZV.mjs';
 import '../types-BKfpdZzX.mjs';
 import '../types-GL_hQ0TN.mjs';
@@ -123,8 +123,12 @@ type CreateAnalyticsConfig = {
     /**
      * The rich {@link WireUserContext} to stamp onto every event's `user_context` (device key, opaque
      * user id, opt-in email, arbitrary `extra`). Passed ONCE here at init; updatable post-mount via
-     * {@link Analytics.setUserContext} (e.g. attach `userId`/`userEmail` at login). Optional — omit it
-     * and events carry only the device context, exactly as before.
+     * {@link Analytics.setUserContext} (e.g. attach `userId`/`userEmail` at login). Optional.
+     *
+     * NOTE on `deviceKey`: you do NOT need to supply one. When omitted, the kit auto-mints a stable,
+     * non-PII per-install `device_key`, persists it via `storage`, and reuses it every open (in-memory
+     * fallback without storage) — so `user_context.device_key` is ALWAYS present for the server's
+     * review/questionnaire gating + A/B stickiness. Supply `deviceKey` only to use your OWN id (it wins).
      */
     userContext?: WireUserContext;
 };

package/dist/analytics/index.d.ts

@@ -1,6 +1,6 @@
 export { R as ReportAppEventOptions, r as reportAppEvent } from '../transport-DLpd1v5_.js';
-import { W as WireUserContext, E as EventQueueOptions } from '../currentSession-CxnP7gAa.js';
-export { A as AnalyticsEvent, C as ClientEvent, a as ClientEventTarget, b as ClientEventType, c as ContextEnvelope, d as ContextEnvelopeInput, e as EnvelopeSource, f as EventQueue, g as WIRE_ONBOARDING_EVENTS, h as WireOnboardingEventName, i as buildContextEnvelope, j as createEventQueue, k as getCurrentSessionId, m as makeSessionId, r as reportClientEvent, l as reportClientEvents, n as resetCurrentSessionId, s as setCurrentSessionId, t as toAnalyticsEvent } from '../currentSession-CxnP7gAa.js';
+import { W as WireUserContext, E as EventQueueOptions } from '../currentSession-f7LWcdWG.js';
+export { A as AnalyticsEvent, C as ClientEvent, a as ClientEventTarget, b as ClientEventType, c as ContextEnvelope, d as ContextEnvelopeInput, e as EnvelopeSource, f as EventQueue, g as WIRE_ONBOARDING_EVENTS, h as WireOnboardingEventName, i as buildContextEnvelope, j as createEventQueue, k as getCurrentSessionId, m as makeSessionId, r as reportClientEvent, l as reportClientEvents, n as resetCurrentSessionId, s as setCurrentSessionId, t as toAnalyticsEvent } from '../currentSession-f7LWcdWG.js';
 import '../types-BhpXJGlg.js';
 import '../types-BKfpdZzX.js';
 import '../types-GL_hQ0TN.js';
@@ -123,8 +123,12 @@ type CreateAnalyticsConfig = {
     /**
      * The rich {@link WireUserContext} to stamp onto every event's `user_context` (device key, opaque
      * user id, opt-in email, arbitrary `extra`). Passed ONCE here at init; updatable post-mount via
-     * {@link Analytics.setUserContext} (e.g. attach `userId`/`userEmail` at login). Optional — omit it
-     * and events carry only the device context, exactly as before.
+     * {@link Analytics.setUserContext} (e.g. attach `userId`/`userEmail` at login). Optional.
+     *
+     * NOTE on `deviceKey`: you do NOT need to supply one. When omitted, the kit auto-mints a stable,
+     * non-PII per-install `device_key`, persists it via `storage`, and reuses it every open (in-memory
+     * fallback without storage) — so `user_context.device_key` is ALWAYS present for the server's
+     * review/questionnaire gating + A/B stickiness. Supply `deviceKey` only to use your OWN id (it wins).
      */
     userContext?: WireUserContext;
 };

package/dist/analytics/index.js

@@ -214,6 +214,47 @@ var detectAppVersion = (requireModule = runtimeRequire) => {
   return void 0;
 };
 
+// src/device/deviceModel.ts
+var coerceModel = (value) => {
+  if (typeof value !== "string") return void 0;
+  const trimmed = value.trim();
+  return trimmed.length > 0 ? trimmed : void 0;
+};
+var runtimeRequire2 = (moduleName) => {
+  try {
+    if (typeof __require !== "function") return void 0;
+    return __require(moduleName);
+  } catch {
+    return void 0;
+  }
+};
+var interop2 = (mod) => {
+  if (!mod || typeof mod !== "object") return void 0;
+  const def = mod.default;
+  if (def && typeof def === "object") return def;
+  return mod;
+};
+var safeInterop2 = (requireModule, moduleName) => {
+  try {
+    return interop2(requireModule(moduleName));
+  } catch {
+    return void 0;
+  }
+};
+var detectNativeModel = (requireModule = runtimeRequire2) => {
+  try {
+    const device = safeInterop2(requireModule, "expo-device");
+    if (device) {
+      const modelName = coerceModel(device.modelName);
+      if (modelName) return modelName;
+      const modelId = coerceModel(device.modelId);
+      if (modelId) return modelId;
+    }
+  } catch {
+  }
+  return void 0;
+};
+
 // src/device/deviceContext.ts
 var deriveFormFactor = (iosIdiom, width, height) => {
   if (iosIdiom === "pad") return "tablet";
@@ -260,6 +301,8 @@ var collectDeviceContext = () => {
         ctx.interfaceIdiom = idiom;
         iosIdiom = idiom;
       }
+      const iosModel = detectNativeModel();
+      if (iosModel) ctx.model = iosModel;
     }
   } catch {
   }
@@ -593,20 +636,46 @@ var resolveUserContext = (ctx = {}, opts = {}) => {
   return result;
 };
 
+// src/context/deviceId.ts
+var AUTO_DEVICE_ID_PREFIX = "wdev_";
+var deviceIdStorageKey = (appId) => `wireai:analytics:deviceKey:${appId != null ? appId : "default"}`;
+var randomChunk = () => Math.floor(Math.random() * 4294967296).toString(36).padStart(6, "0");
+var mintDeviceId = () => {
+  const time = Date.now().toString(36);
+  return `${AUTO_DEVICE_ID_PREFIX}${time}_${randomChunk()}${randomChunk()}`;
+};
+
 // src/analytics/analyticsFacade.ts
 var createAnalytics = (config, options = {}) => {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e;
   const instanceSessionId = (_a = config.sessionId) != null ? _a : makeSessionId();
   const resolveSessionId = () => {
     var _a2, _b2;
     return (_b2 = (_a2 = config.sessionId) != null ? _a2 : getCurrentSessionId()) != null ? _b2 : instanceSessionId;
   };
-  const envelope = () => buildContextEnvelope({
-    sessionId: resolveSessionId(),
-    appVersion: config.appVersion,
-    appBuild: config.appBuild,
-    networkType: config.networkType
-  });
+  let userContext = { ...(_b = config.userContext) != null ? _b : {} };
+  const hostDeviceKeyAtInit = typeof ((_c = config.userContext) == null ? void 0 : _c.deviceKey) === "string" && config.userContext.deviceKey.trim() ? config.userContext.deviceKey.trim() : void 0;
+  let autoDeviceKey = mintDeviceId();
+  if (config.storage && !hostDeviceKeyAtInit) {
+    const storage = config.storage;
+    const deviceKey = deviceIdStorageKey(config.appId);
+    void storage.getItem(deviceKey).then((saved) => {
+      const persisted = typeof saved === "string" && saved.trim() ? saved.trim() : void 0;
+      if (persisted) autoDeviceKey = persisted;
+      else void storage.setItem(deviceKey, autoDeviceKey).catch(() => {
+      });
+    }).catch(() => {
+    });
+  }
+  const envelope = () => {
+    var _a2;
+    return buildContextEnvelope({
+      sessionId: resolveSessionId(),
+      appVersion: (_a2 = userContext.appVersion) != null ? _a2 : config.appVersion,
+      appBuild: config.appBuild,
+      networkType: config.networkType
+    });
+  };
   const queue = createEventQueue({
     target: { serverUrl: config.serverUrl, apiKey: config.apiKey },
     storage: config.storage,
@@ -614,9 +683,8 @@ var createAnalytics = (config, options = {}) => {
     envelope,
     ...options
   });
-  let userContext = { ...(_b = config.userContext) != null ? _b : {} };
-  let boundUserId = sanitizeUserId((_c = config.userContext) == null ? void 0 : _c.userId);
-  const storageKey = `wireai:analytics:userId:${(_d = config.appId) != null ? _d : "default"}`;
+  let boundUserId = sanitizeUserId((_d = config.userContext) == null ? void 0 : _d.userId);
+  const storageKey = `wireai:analytics:userId:${(_e = config.appId) != null ? _e : "default"}`;
   if (config.storage) {
     void config.storage.getItem(storageKey).then((saved) => {
       if (saved && !boundUserId) boundUserId = saved;
@@ -625,7 +693,11 @@ var createAnalytics = (config, options = {}) => {
   }
   const applyContext = (event) => {
     var _a2;
-    const resolved = resolveUserContext(userContext, { autoAppVersion: config.appVersion });
+    const hostDeviceKey = typeof userContext.deviceKey === "string" && userContext.deviceKey.trim() ? userContext.deviceKey : void 0;
+    const resolved = resolveUserContext(
+      { ...userContext, deviceKey: hostDeviceKey != null ? hostDeviceKey : autoDeviceKey },
+      { autoAppVersion: config.appVersion }
+    );
     if (resolved.userContext) {
       event.user_context = { ...resolved.userContext, ...(_a2 = event.user_context) != null ? _a2 : {} };
     }