@configdirector/nuxt-sdk 0.1.0 → 0.1.1

package/README.md

@@ -59,6 +59,21 @@ const { value } = useConfigDirectorValue<string>("my-config", "default value");
 </template>
 ```
 
+The `value` returned is a ShallowRef that will update whenever the config value is updated in the ConfigDirector dashboard, or if it evaluates to a different value due to targeting rules (for example, if the user context is updated). Keep in mind that it is a ShallowRef when accessing it in scripts:
+
+```ts
+<script setup lang="ts">
+const { value: myConfigValue } = useConfigDirectorValue<string>("my-config", "default value");
+
+const someOtherDerivedValue = computed(() => `Hello ${myConfigValue.value}`);
+</script>
+
+<template>
+  <div>my-config is : {{ someOtherDerivedValue }}</div>
+</template>
+```
+
+
 You can also determine if the client is still initializing, so rather than transition from the default value to the evaluated value, you can show a loading state until the client is ready and config values are evaluated:
 
 ```ts
@@ -72,7 +87,7 @@ const { value, loading } = useConfigDirectorValue<string>("my-config", "default
 </template>
 ```
 
-Alternatively, you can also use the `useConfigDirectorStatus` composable to retrieve just the status:
+Additionally, you can also use the `useConfigDirectorStatus` composable to retrieve just the status:
 
 ```ts
 <script setup lang="ts">
@@ -120,7 +135,7 @@ export default defineEventHandler(async (_event) => {
 });
 ```
 
-`getValue` can also accepts an optional user context:
+`getValue` also accepts an optional user context:
 
 ```ts
 export default defineEventHandler(async (_event) => {

package/dist/module.json

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

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

@@ -1,10 +1,10 @@
 import { n as ConfigValueType } from "../../types-CQWNx-gI.mjs";
 import { t as ClientStatus } from "../../types-CkzBXJwA.mjs";
-import { Ref, ShallowRef } from "vue";
+import { DeepReadonly, Ref, ShallowRef } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorValue.d.ts
 declare const useConfigDirectorValue: <T extends ConfigValueType>(configKey: string, defaultValue: T) => {
-  value: ShallowRef<T>;
+  value: DeepReadonly<ShallowRef<T>>;
   readyStatus: Readonly<Ref<ClientStatus>>;
   loading: Readonly<Ref<boolean>>;
 };

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

@@ -1,10 +1,10 @@
 import { n as ConfigValueType } from "../../types-CQWNx-gI.mjs";
 import { t as ClientStatus } from "../../types-CkzBXJwA.mjs";
-import { Ref, ShallowRef } from "vue";
+import { DeepReadonly, Ref, ShallowRef } from "vue";
 
 //#region src/runtime/app/composables/useConfigDirectorValue.d.ts
 declare const useConfigDirectorValue: <T extends ConfigValueType>(configKey: string, defaultValue: T) => {
-  value: ShallowRef<T>;
+  value: DeepReadonly<ShallowRef<T>>;
   readyStatus: Readonly<Ref<ClientStatus>>;
   loading: Readonly<Ref<boolean>>;
 };

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

@@ -1,6 +1,6 @@
 import { useConfigDirectorClient } from "./useConfigDirectorClient.mjs";
 import { useConfigDirectorStatus } from "./useConfigDirectorStatus.mjs";
-import { onBeforeUnmount, shallowRef } from "vue";
+import { onBeforeUnmount, readonly, shallowRef } from "vue";
 //#region src/runtime/app/composables/useConfigDirectorValue.ts
 const useConfigDirectorValue = (configKey, defaultValue) => {
 	const { client } = useConfigDirectorClient();
@@ -10,7 +10,7 @@ const useConfigDirectorValue = (configKey, defaultValue) => {
 	client.watch(configKey, defaultValue, watcher);
 	onBeforeUnmount(() => client.unwatch(configKey, watcher));
 	return {
-		value: configValue,
+		value: readonly(configValue),
 		readyStatus,
 		loading
 	};

package/dist/runtime/nitro/plugin.mjs

@@ -1385,7 +1385,7 @@ var plugin_default = defineNitroPlugin((nitroApp) => {
 	const { serverSdkKey, baseUrl } = runtimeConfig.configdirector;
 	const client = new DefaultConfigDirectorClient(serverSdkKey, {
 		sdkName: "nuxt-sdk",
-		sdkVersion: "0.1.0"
+		sdkVersion: "0.1.1"
 	}, {
 		logger,
 		...baseUrl ? { connection: { url: baseUrl } } : {}

package/dist/runtime/plugin.client.mjs

@@ -1130,7 +1130,7 @@ var plugin_client_default = defineNuxtPlugin((nuxtApp) => {
 	const { clientSdkKey, appName, appVersion, baseUrl } = runtimeConfig.public.configdirector;
 	const client = createBrowserClient(clientSdkKey, {
 		sdkName: "nuxt-sdk",
-		sdkVersion: "0.1.0"
+		sdkVersion: "0.1.1"
 	}, {
 		metadata: {
 			appName,

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@configdirector/nuxt-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Nuxt SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",
   "keywords": [
     "configdirector",
-    "configdirector vue",
+    "configdirector nuxt",
     "config",
     "configuration",
     "remote config",