@configdirector/nuxt-sdk 1.7.0 → 1.9.0

package/README.md

@@ -31,6 +31,40 @@ const { value: darkMode } = useConfigDirectorValue("dark-mode", false);
 
 Full details are in the [official documentation](https://docs.configdirector.com/sdks/meta/nuxt).
 
+## Test your code
+
+`@configdirector/nuxt-sdk/testing` creates a real client connected to an in-memory server that your
+test controls. Install it before the Nuxt app is created, at the top level of a test file or a
+vitest setup file, and the ConfigDirector plugin provides it to the app instead of building a
+client. Tests run in the `nuxt` environment of `@nuxt/test-utils` 4 (which needs vitest 4).
+
+```ts
+import { nextTick } from "vue";
+import { mountSuspended } from "@nuxt/test-utils/runtime";
+import { createTestClient, installTestClient } from "@configdirector/nuxt-sdk/testing";
+import Checkout from "~/components/Checkout.vue";
+
+const testClient = createTestClient({ values: { "dark-mode": true } });
+installTestClient(testClient);
+
+test("renders the dark mode", async () => {
+  const component = await mountSuspended(Checkout);
+  expect(component.text()).toContain("dark-mode: true");
+
+  testClient.setValue("dark-mode", false);
+  await nextTick();
+  expect(component.text()).toContain("dark-mode: false");
+});
+```
+
+`@nuxt/test-utils` 4 creates the app once per test file, inside a `beforeAll` hook, so install at
+module level rather than in a hook, and reset the values between tests with `replaceValues`.
+`@nuxt/test-utils` 3 creates the app before the test file loads, so the plugin cannot see a test
+client installed there; upgrade to use the testing entry. While
+installed, the plugin needs no `clientSdkKey`. Await `nextTick()` after `setValue`, `removeValue`,
+and `replaceValues`. The test client also holds or fails `initialize` and `updateContext`, and
+records every context in `contextUpdates`.
+
 ## Documentation
 
 Refer to the [official documentation for the Nuxt SDK](https://docs.configdirector.com/sdks/meta/nuxt).

package/dist/module.d.mts

@@ -92,6 +92,32 @@ interface ConfigDirectorPublicRuntimeConfig {
    * Can be set via the NUXT_PUBLIC_CONFIGDIRECTOR_BASE_URL environment variable.
    */
   baseUrl?: string;
+  /**
+   * Connection options for the browser client used on the client side.
+   */
+  connection?: {
+    /**
+     * The connection mode, one of `streaming` (default) or `polling`. In `streaming` mode the
+     * connection stays open and receives config updates as they happen. In `polling` mode configs
+     * are fetched once during initialization and then again on every `pollingInterval`.
+     * Can be set via the NUXT_PUBLIC_CONFIGDIRECTOR_CONNECTION_MODE environment variable.
+     */
+    mode?: ConnectionMode;
+    /**
+     * The polling interval in seconds when `mode` is `polling`. Has no effect in `streaming` mode.
+     * When omitted (or `0`), it defaults to 60 seconds. A value below the minimum of 30 seconds is
+     * raised to 30 seconds and a warning is logged.
+     * Can be set via the NUXT_PUBLIC_CONFIGDIRECTOR_CONNECTION_POLLING_INTERVAL environment variable.
+     */
+    pollingInterval?: number;
+    /**
+     * How long, in milliseconds, the browser client waits for its initial config payload during
+     * initialization before the app renders with default values. When omitted (or `0`), it defaults
+     * to 2000 milliseconds.
+     * Can be set via the NUXT_PUBLIC_CONFIGDIRECTOR_CONNECTION_TIMEOUT environment variable.
+     */
+    timeout?: number;
+  };
 }
 declare module "nuxt/schema" {
   interface RuntimeConfig {

package/dist/module.json

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

package/dist/module.mjs

@@ -25,14 +25,19 @@ var module_default = defineNuxtModule({
 			...serverDefaults,
 			logLevel: options.logLevel
 		} : serverDefaults);
-		nuxt.options.runtimeConfig.public.configdirector = defu(nuxt.options.runtimeConfig.public.configdirector, options.logLevel !== void 0 ? {
-			clientSdkKey: "",
-			logLevel: options.logLevel,
-			baseUrl: ""
-		} : {
+		const publicDefaults = {
 			clientSdkKey: "",
-			baseUrl: ""
-		});
+			baseUrl: "",
+			connection: {
+				mode: "streaming",
+				pollingInterval: 0,
+				timeout: 0
+			}
+		};
+		nuxt.options.runtimeConfig.public.configdirector = defu(nuxt.options.runtimeConfig.public.configdirector, options.logLevel !== void 0 ? {
+			...publicDefaults,
+			logLevel: options.logLevel
+		} : publicDefaults);
 		logger.debug("ConfigDirector Nuxt module setup complete");
 		addServerPlugin(resolver.resolve("./runtime/nitro/plugin"));
 		addServerHandler({

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

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../../types-BPvGEzJY.mjs";
+import { n as ConfigDirectorClient } from "../../types-CvmjergQ.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-BPvGEzJY.mjs";
+import { n as ConfigDirectorClient } from "../../types-CvmjergQ.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-BPvGEzJY.mjs";
+import { t as ClientHooks } from "../../types-CvmjergQ.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-BPvGEzJY.mjs";
+import { t as ClientHooks } from "../../types-CvmjergQ.mjs";
 
 //#region src/runtime/app/composables/useConfigDirectorClientHooks.d.ts
 declare const useConfigDirectorClientHooks: (hooks: ClientHooks) => void;

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

@@ -16,9 +16,14 @@ const useConfigDirectorContext = () => {
 		state.value = rawContext;
 		if (oldContext != newContext) {
 			const timeout = getEffectiveTimeout(options?.timeoutMilliseconds);
-			await Promise.race([client.updateContext(rawContext), new Promise((resolve) => {
-				setTimeout(() => resolve(), timeout);
-			})]);
+			let timer;
+			try {
+				await Promise.race([client.updateContext(rawContext), new Promise((resolve) => {
+					timer = setTimeout(() => resolve(), timeout);
+				})]);
+			} finally {
+				clearTimeout(timer);
+			}
 		}
 	};
 	return {

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

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../types-C54FjC1D.mjs";
+import { n as ConfigDirectorClient } from "../types-Bgx2-3dY.mjs";
 import * as _$nitropack from "nitropack";
 
 //#region src/runtime/nitro/plugin.d.ts

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

@@ -1,4 +1,4 @@
-import { n as ConfigDirectorClient } from "../types-C54FjC1D.mjs";
+import { n as ConfigDirectorClient } from "../types-Bgx2-3dY.mjs";
 import * as _$nitropack from "nitropack";
 
 //#region src/runtime/nitro/plugin.d.ts