@configdirector/nuxt-sdk 1.11.0 → 1.12.0

package/dist/module.d.mts

@@ -173,6 +173,19 @@ interface ConfigDirectorPublicRuntimeConfig {
      */
     timeout?: number;
   };
+  /**
+   * Whether the browser client waits for its first context before it connects. With it on, the client
+   * opens no connection and `useConfigDirectorStatus` reports `loading` until the app calls
+   * `updateContext` from `useConfigDirectorContext`; that first call starts the client with the context
+   * it was given. A context set during server-side rendering starts the client when the app is created,
+   * as with the option off. Turn it on when the app knows its context only after startup, such as with
+   * `ssr: false` or a context fetched in the browser, so the first connection carries the context
+   * instead of a connection with no context, whose visitor counts as a monthly active user on its own.
+   * It has no effect in `offline` mode, where the client is ready at once.
+   *
+   * Defaults to `false`. Can be set via the NUXT_PUBLIC_CONFIGDIRECTOR_DEFER_INITIALIZATION environment variable.
+   */
+  deferInitialization?: boolean;
   /**
    * The connection mode the server runs in, written by the module on every request so the browser
    * knows whether to follow the server into `offline` mode. Not an option: any value set here is

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": ">=4.0.0"
   },
-  "version": "1.11.0"
+  "version": "1.12.0"
 }

package/dist/module.mjs

@@ -36,7 +36,8 @@ var module_default = defineNuxtModule({
 				mode: "",
 				pollingInterval: 0,
 				timeout: 0
-			}
+			},
+			deferInitialization: false
 		};
 		nuxt.options.runtimeConfig.public.configdirector = defu(nuxt.options.runtimeConfig.public.configdirector, options.logLevel !== void 0 ? {
 			...publicDefaults,

package/dist/runtime/app/composables/useConfigDirectorClient.d.mts

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../../types-Dt3bENKf.mjs";
+import { n as ConfigDirectorClient } from "../../types-CuzrFq9I.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClient.d.ts
 declare const useConfigDirectorClient: () => {

package/dist/runtime/app/composables/useConfigDirectorClient.d.ts

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../../types-Dt3bENKf.mjs";
+import { n as ConfigDirectorClient } from "../../types-CuzrFq9I.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClient.d.ts
 declare const useConfigDirectorClient: () => {

package/dist/runtime/app/composables/useConfigDirectorClientHooks.d.mts

@@ -1,4 +1,4 @@
-import { t as ClientHooks } from "../../types-Dt3bENKf.mjs";
+import { t as ClientHooks } from "../../types-CuzrFq9I.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClientHooks.d.ts
 declare const useConfigDirectorClientHooks: (hooks: ClientHooks) => void;

package/dist/runtime/app/composables/useConfigDirectorClientHooks.d.ts

@@ -1,4 +1,4 @@
-import { t as ClientHooks } from "../../types-Dt3bENKf.mjs";
+import { t as ClientHooks } from "../../types-CuzrFq9I.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClientHooks.d.ts
 declare const useConfigDirectorClientHooks: (hooks: ClientHooks) => void;

package/dist/runtime/app/composables/useConfigDirectorContext.d.mts

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorContext } from "../../native-values-BV2k_xR2.mjs";
+import { n as ConfigDirectorContext } from "../../native-values-ChQdi7c7.mjs";
 import { Ref } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorContext.d.ts

package/dist/runtime/app/composables/useConfigDirectorContext.d.ts

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorContext } from "../../native-values-BV2k_xR2.mjs";
+import { n as ConfigDirectorContext } from "../../native-values-ChQdi7c7.mjs";
 import { Ref } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorContext.d.ts

package/dist/runtime/app/composables/useConfigDirectorContext.mjs

@@ -1,7 +1,38 @@
 import { useConfigDirectorClient } from "./useConfigDirectorClient.mjs";
 import { n as admittedContextOrNone } from "../../context-kind-D6YBNij2.mjs";
-import { useState } from "#app";
+import { useNuxtApp, useState } from "#app";
 import { readonly, toRaw } from "vue";
+//#region ../shared/src/deepEqual.ts
+const deepEqual = (left, right) => {
+	if (Object.is(left, right)) return true;
+	if (typeof left !== "object" || typeof right !== "object" || left === null || right === null) return false;
+	if (Object.getPrototypeOf(left) !== Object.getPrototypeOf(right)) return false;
+	if (left instanceof Date && right instanceof Date) return left.getTime() === right.getTime();
+	if (Array.isArray(left) && Array.isArray(right)) return left.length === right.length && left.every((item, index) => deepEqual(item, right[index]));
+	if (!isPlainObject(left) || !isPlainObject(right)) return false;
+	const leftKeys = Object.keys(left);
+	const rightKeys = Object.keys(right);
+	return leftKeys.length === rightKeys.length && leftKeys.every((key) => Object.prototype.hasOwnProperty.call(right, key) && deepEqual(left[key], right[key]));
+};
+const isPlainObject = (value) => {
+	const prototype = Object.getPrototypeOf(value);
+	return prototype === Object.prototype || prototype === null;
+};
+//#endregion
+//#region ../js-client-core/src/mountAction.ts
+const decideMountAction = (client, context) => {
+	if (client.isInitializing) return "none";
+	if (!client.isReady) return "initialize";
+	if (context !== void 0 && !deepEqual(context, client.context)) return "updateContext";
+	return "none";
+};
+//#endregion
+//#region src/runtime/client-startup.ts
+const decideContextUpdateAction = (client, context, waitsForFirstContext) => {
+	if (waitsForFirstContext && decideMountAction(client, context) === "initialize") return "startClient";
+	return "updateContext";
+};
+//#endregion
 //#region src/runtime/app/composables/useConfigDirectorContext.ts
 const DEFAULT_TIMEOUT = 3e3;
 const getEffectiveTimeout = (option) => {
@@ -10,6 +41,14 @@ const getEffectiveTimeout = (option) => {
 const useConfigDirectorContext = () => {
 	const state = useState("configdirector-context");
 	const { client } = useConfigDirectorClient();
+	const { $configDirectorClientStartup } = useNuxtApp();
+	const startup = $configDirectorClientStartup;
+	const handContextToClient = (rawContext) => {
+		switch (decideContextUpdateAction(client, rawContext, startup.waitsForFirstContext)) {
+			case "startClient": return startup.start(rawContext);
+			case "updateContext": return client.updateContext(rawContext);
+		}
+	};
 	const updateContext = async (context, options) => {
 		const rawContext = toRaw(context);
 		const oldContext = JSON.stringify(state.value);
@@ -19,7 +58,7 @@ const useConfigDirectorContext = () => {
 			const timeout = getEffectiveTimeout(options?.timeoutMilliseconds);
 			let timer;
 			try {
-				await Promise.race([client.updateContext(rawContext), new Promise((resolve) => {
+				await Promise.race([handContextToClient(rawContext), new Promise((resolve) => {
 					timer = setTimeout(() => resolve(), timeout);
 				})]);
 			} finally {

package/dist/runtime/app/composables/useConfigDirectorValue.d.mts

@@ -1,4 +1,4 @@
-import { a as ConfigValueType } from "../../native-values-BV2k_xR2.mjs";
+import { a as ConfigValueType } from "../../native-values-ChQdi7c7.mjs";
 import { t as ClientStatus } from "../../types-C30VJ25l.mjs";
 import { DeepReadonly, Ref, ShallowRef } from "vue";
 

package/dist/runtime/app/composables/useConfigDirectorValue.d.ts

@@ -1,4 +1,4 @@
-import { a as ConfigValueType } from "../../native-values-BV2k_xR2.mjs";
+import { a as ConfigValueType } from "../../native-values-ChQdi7c7.mjs";
 import { t as ClientStatus } from "../../types-C30VJ25l.mjs";
 import { DeepReadonly, Ref, ShallowRef } from "vue";
 

package/dist/runtime/{native-values-BV2k_xR2.d.mts → native-values-ChQdi7c7.d.mts}

@@ -12,7 +12,7 @@ type ConfigState = {
   value: string | undefined | null;
   valueId?: string | undefined | null;
 };
-type EvaluationReason = "found-match" | "config-state-missing" | "client-not-ready" | "type-mismatch" | "value-missing" | "invalid-number" | "invalid-json" | "invalid-boolean";
+type EvaluationReason = "found-match" | "config-state-missing" | "client-not-ready" | "type-mismatch" | "value-missing" | "invalid-number" | "invalid-json" | "invalid-boolean" | "cached";
 type ConfigEvaluation = {
   key: string;
   value: ConfigValueType;
@@ -31,9 +31,11 @@ type ConfigDirectorContext = {
    * The context's identifier. This should be a value that uniquely identifies the user or other
    * entity among contexts of the same {@link kind}.
    * In the case of anonymous users, you could generate a UUID or alternatively not provide
-   * the {@link id} and the SDK will generate a random UUID. However, keep in mind that this
-   * value is used for segmenting contexts in percentage rollouts, and changes to the {@link id}
-   * could result in the context being assigned to a different percentile.
+   * the {@link id}. In a client SDK, ConfigDirector then derives an identifier from an ID the SDK
+   * stores for the app install or the website, so it stays the same until the app is uninstalled
+   * or the site's data is cleared. However, keep in mind that this value is used for segmenting
+   * contexts in percentage rollouts, and changes to the {@link id} could result in the context
+   * being assigned to a different percentile.
    */
   id?: string;
   /**

package/dist/runtime/nitro/offline-values.d.mts

@@ -1,4 +1,4 @@
-import { t as NativeValues } from "../native-values-BV2k_xR2.mjs";
+import { t as NativeValues } from "../native-values-ChQdi7c7.mjs";
 import * as _$h3 from "h3";
 
 //#region src/runtime/nitro/offline-values.d.ts

package/dist/runtime/nitro/offline-values.d.ts

@@ -1,4 +1,4 @@
-import { t as NativeValues } from "../native-values-BV2k_xR2.mjs";
+import { t as NativeValues } from "../native-values-ChQdi7c7.mjs";
 import * as _$h3 from "h3";
 
 //#region src/runtime/nitro/offline-values.d.ts

package/dist/runtime/nitro/plugin.d.mts

@@ -1,5 +1,5 @@
-import { o as ConnectionMode } from "../native-values-BV2k_xR2.mjs";
-import { n as ConfigDirectorClient } from "../types-CS7AMNWe.mjs";
+import { o as ConnectionMode } from "../native-values-ChQdi7c7.mjs";
+import { n as ConfigDirectorClient } from "../types-BoDJiQsr.mjs";
 import * as _$nitropack from "nitropack";
 
 //#region src/runtime/nitro/plugin.d.ts

package/dist/runtime/nitro/plugin.d.ts

@@ -1,5 +1,5 @@
-import { o as ConnectionMode } from "../native-values-BV2k_xR2.mjs";
-import { n as ConfigDirectorClient } from "../types-CS7AMNWe.mjs";
+import { o as ConnectionMode } from "../native-values-ChQdi7c7.mjs";
+import { n as ConfigDirectorClient } from "../types-BoDJiQsr.mjs";
 import * as _$nitropack from "nitropack";
 
 //#region src/runtime/nitro/plugin.d.ts

package/dist/runtime/nitro/plugin.mjs

@@ -8452,7 +8452,7 @@ var plugin_default = defineNitroPlugin((nitroApp) => {
 	logger.debug("Initializing ConfigDirector Nitro plugin");
 	const client = new DefaultConfigDirectorClient(serverSdkKey || void 0, {
 		sdkName: "nuxt-sdk",
-		sdkVersion: "1.11.0"
+		sdkVersion: "1.12.0"
 	}, {
 		logger,
 		connection: {