@hot-updater/plugin-insights 1.0.0-rc.40 → 1.0.0-rc.41

package/dist/client/index.cjs

@@ -21,16 +21,22 @@ const normalizeUserId = (user) => {
 * ```ts
 * import { HotUpdater, insights } from "@hot-updater/react-native";
 *
-* const analytics = insights();
-* HotUpdater.init({ baseURL, plugins: [analytics] });
-* analytics.setUser({ userId: "user-123" });
+* export const hotUpdater = HotUpdater.init({ baseURL, plugins: [insights()] });
+* hotUpdater.insights.setUser({ userId: "user-123" });
 * ```
 */
-const insights = (options = {}) => {
+const insights = (options = {}) => (0, _hot_updater_protocol.defineClientPlugin)({
+	id: "insights",
+	setup: (pluginContext) => setUpInsights(options, pluginContext)
+});
+/**
+* One instance's Insights: its context, device state, and delivery queue,
+* created by each `setup`, so a plugin object set up by two instances keeps
+* their reports apart.
+*/
+const setUpInsights = (options, pluginContext) => {
 	let context = null;
 	let state = null;
-	/** A user set before setup, applied once the plugin has storage. */
-	let pendingUser = null;
 	/** A download in this runtime: a later no-change report would hide it. */
 	let didDownload = false;
 	let lastDownloadedSelection = null;
@@ -217,37 +223,27 @@ const insights = (options = {}) => {
 		if (event.report !== null) state.recordReport(event.report);
 		else state.forgetReport();
 	};
-	return (0, _hot_updater_protocol.defineClientPlugin)({
-		id: "insights",
-		setup(pluginContext) {
-			context = pluginContext;
-			state = require_state.createInsightsState(pluginContext.storage);
-			if (pendingUser !== null) {
-				state.writeUserId(pendingUser.userId);
-				pendingUser = null;
-			}
-			if (pluginContext.isDebugBuild && options.debug !== true) return;
-			send = require_sender.createInsightsEventSender(pluginContext.fetch, {
-				admit,
-				settle
-			});
-			return {
-				onAppReady,
-				onUpdateCheck,
-				onBundleDownloaded,
-				onUpdateError,
-				onHttpResponse
-			};
-		},
-		setUser(user) {
-			const userId = normalizeUserId(user);
-			if (state === null) {
-				pendingUser = { userId };
-				return;
-			}
-			state.writeUserId(userId);
-		}
+	context = pluginContext;
+	const pluginState = require_state.createInsightsState(pluginContext.storage);
+	state = pluginState;
+	const api = Object.freeze({ setUser: (user) => {
+		pluginState.writeUserId(normalizeUserId(user));
+	} });
+	if (pluginContext.isDebugBuild && options.debug !== true) return { api };
+	send = require_sender.createInsightsEventSender(pluginContext.fetch, {
+		admit,
+		settle
 	});
+	return {
+		api,
+		hooks: {
+			onAppReady,
+			onUpdateCheck,
+			onBundleDownloaded,
+			onUpdateError,
+			onHttpResponse
+		}
+	};
 };
 //#endregion
 exports.insights = insights;

package/dist/client/index.d.cts

@@ -11,15 +11,16 @@ interface InsightsOptions {
 interface InsightsUser {
   readonly userId: string | number;
 }
-interface InsightsPlugin extends HotUpdaterClientPlugin {
-  readonly id: "insights";
+/** Insights on the instance `HotUpdater.init` returns, as `hotUpdater.insights`. */
+interface InsightsClient {
   /**
    * Attaches the signed-in user's id to later reports, or clears it with
-   * `null`. It persists on the device, sends nothing by itself, and can be
-   * called before `HotUpdater.init`.
+   * `null`. It persists on the device and sends nothing by itself.
    */
   setUser(user: InsightsUser | null): void;
 }
+/** The `insights()` plugin: it adds `hotUpdater.insights`. */
+type InsightsPlugin = HotUpdaterClientPlugin<"insights", InsightsClient>;
 /**
  * Reports update adoption to a server that runs the `insights()` server
  * plugin: launches (at most once a UTC day while nothing changes), downloads,
@@ -31,11 +32,10 @@ interface InsightsPlugin extends HotUpdaterClientPlugin {
  * ```ts
  * import { HotUpdater, insights } from "@hot-updater/react-native";
  *
- * const analytics = insights();
- * HotUpdater.init({ baseURL, plugins: [analytics] });
- * analytics.setUser({ userId: "user-123" });
+ * export const hotUpdater = HotUpdater.init({ baseURL, plugins: [insights()] });
+ * hotUpdater.insights.setUser({ userId: "user-123" });
  * ```
  */
 declare const insights: (options?: InsightsOptions) => InsightsPlugin;
 //#endregion
-export { InsightsOptions, InsightsPlugin, InsightsUser, insights };
+export { InsightsClient, InsightsOptions, InsightsPlugin, InsightsUser, insights };

package/dist/client/index.d.mts

@@ -11,15 +11,16 @@ interface InsightsOptions {
 interface InsightsUser {
   readonly userId: string | number;
 }
-interface InsightsPlugin extends HotUpdaterClientPlugin {
-  readonly id: "insights";
+/** Insights on the instance `HotUpdater.init` returns, as `hotUpdater.insights`. */
+interface InsightsClient {
   /**
    * Attaches the signed-in user's id to later reports, or clears it with
-   * `null`. It persists on the device, sends nothing by itself, and can be
-   * called before `HotUpdater.init`.
+   * `null`. It persists on the device and sends nothing by itself.
    */
   setUser(user: InsightsUser | null): void;
 }
+/** The `insights()` plugin: it adds `hotUpdater.insights`. */
+type InsightsPlugin = HotUpdaterClientPlugin<"insights", InsightsClient>;
 /**
  * Reports update adoption to a server that runs the `insights()` server
  * plugin: launches (at most once a UTC day while nothing changes), downloads,
@@ -31,11 +32,10 @@ interface InsightsPlugin extends HotUpdaterClientPlugin {
  * ```ts
  * import { HotUpdater, insights } from "@hot-updater/react-native";
  *
- * const analytics = insights();
- * HotUpdater.init({ baseURL, plugins: [analytics] });
- * analytics.setUser({ userId: "user-123" });
+ * export const hotUpdater = HotUpdater.init({ baseURL, plugins: [insights()] });
+ * hotUpdater.insights.setUser({ userId: "user-123" });
  * ```
  */
 declare const insights: (options?: InsightsOptions) => InsightsPlugin;
 //#endregion
-export { InsightsOptions, InsightsPlugin, InsightsUser, insights };
+export { InsightsClient, InsightsOptions, InsightsPlugin, InsightsUser, insights };

package/dist/client/index.mjs

@@ -20,16 +20,22 @@ const normalizeUserId = (user) => {
 * ```ts
 * import { HotUpdater, insights } from "@hot-updater/react-native";
 *
-* const analytics = insights();
-* HotUpdater.init({ baseURL, plugins: [analytics] });
-* analytics.setUser({ userId: "user-123" });
+* export const hotUpdater = HotUpdater.init({ baseURL, plugins: [insights()] });
+* hotUpdater.insights.setUser({ userId: "user-123" });
 * ```
 */
-const insights = (options = {}) => {
+const insights = (options = {}) => defineClientPlugin({
+	id: "insights",
+	setup: (pluginContext) => setUpInsights(options, pluginContext)
+});
+/**
+* One instance's Insights: its context, device state, and delivery queue,
+* created by each `setup`, so a plugin object set up by two instances keeps
+* their reports apart.
+*/
+const setUpInsights = (options, pluginContext) => {
 	let context = null;
 	let state = null;
-	/** A user set before setup, applied once the plugin has storage. */
-	let pendingUser = null;
 	/** A download in this runtime: a later no-change report would hide it. */
 	let didDownload = false;
 	let lastDownloadedSelection = null;
@@ -216,37 +222,27 @@ const insights = (options = {}) => {
 		if (event.report !== null) state.recordReport(event.report);
 		else state.forgetReport();
 	};
-	return defineClientPlugin({
-		id: "insights",
-		setup(pluginContext) {
-			context = pluginContext;
-			state = createInsightsState(pluginContext.storage);
-			if (pendingUser !== null) {
-				state.writeUserId(pendingUser.userId);
-				pendingUser = null;
-			}
-			if (pluginContext.isDebugBuild && options.debug !== true) return;
-			send = createInsightsEventSender(pluginContext.fetch, {
-				admit,
-				settle
-			});
-			return {
-				onAppReady,
-				onUpdateCheck,
-				onBundleDownloaded,
-				onUpdateError,
-				onHttpResponse
-			};
-		},
-		setUser(user) {
-			const userId = normalizeUserId(user);
-			if (state === null) {
-				pendingUser = { userId };
-				return;
-			}
-			state.writeUserId(userId);
-		}
+	context = pluginContext;
+	const pluginState = createInsightsState(pluginContext.storage);
+	state = pluginState;
+	const api = Object.freeze({ setUser: (user) => {
+		pluginState.writeUserId(normalizeUserId(user));
+	} });
+	if (pluginContext.isDebugBuild && options.debug !== true) return { api };
+	send = createInsightsEventSender(pluginContext.fetch, {
+		admit,
+		settle
 	});
+	return {
+		api,
+		hooks: {
+			onAppReady,
+			onUpdateCheck,
+			onBundleDownloaded,
+			onUpdateError,
+			onHttpResponse
+		}
+	};
 };
 //#endregion
 export { insights };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hot-updater/plugin-insights",
   "type": "module",
-  "version": "1.0.0-rc.40",
+  "version": "1.0.0-rc.41",
   "description": "Hot Updater's Insights plugin: launch, download, and update failure events, for the server and the React Native app",
   "exports": {
     "./client": {
@@ -33,10 +33,10 @@
     "package.json"
   ],
   "dependencies": {
-    "@hot-updater/protocol": "1.0.0-rc.40"
+    "@hot-updater/protocol": "1.0.0-rc.41"
   },
   "peerDependencies": {
-    "@hot-updater/plugin-core": "^1.0.0-rc.40"
+    "@hot-updater/plugin-core": "^1.0.0-rc.41"
   },
   "peerDependenciesMeta": {
     "@hot-updater/plugin-core": {
@@ -46,8 +46,8 @@
   "devDependencies": {
     "@types/node": "^20",
     "vitest": "4.1.4",
-    "@hot-updater/plugin-core": "1.0.0-rc.40",
-    "@hot-updater/test-utils": "1.0.0-rc.40"
+    "@hot-updater/test-utils": "1.0.0-rc.41",
+    "@hot-updater/plugin-core": "1.0.0-rc.41"
   },
   "nx": {
     "implicitDependencies": [