@configdirector/nuxt-sdk 1.9.2 → 1.11.0

package/dist/runtime/plugin.server.mjs

@@ -14,6 +14,50 @@ const useConfigDirectorClient = () => {
 	return { client: $configDirectorClient };
 };
 //#endregion
+//#region ../shared/src/context-kind.ts
+const CONTEXT_KIND_MAXIMUM_LENGTH = 64;
+const KIND_SAMPLE_MAXIMUM_CHARACTERS = 128;
+const isContextKindCharacter = (character) => character >= "a" && character <= "z" || character >= "0" && character <= "9" || character === "-" || character === "_";
+const isValidContextKind = (kind) => {
+	if (kind.length < 1 || kind.length > CONTEXT_KIND_MAXIMUM_LENGTH) return false;
+	for (const character of kind) if (!isContextKindCharacter(character)) return false;
+	return true;
+};
+const isAcceptedKind = (kind) => kind === void 0 || kind === null || typeof kind === "string" && isValidContextKind(kind);
+const stringFormOf = (kind) => {
+	if (typeof kind === "string") return kind;
+	try {
+		return String(kind);
+	} catch {
+		return Object.prototype.toString.call(kind);
+	}
+};
+const firstCharactersOf = (text, maximumCharacters) => {
+	let sample = "";
+	let characterCount = 0;
+	for (const character of text) {
+		if (characterCount === maximumCharacters) break;
+		sample += character;
+		characterCount += 1;
+	}
+	return sample;
+};
+const admittedContextOrNone = (context) => {
+	const admission = admitContext(context);
+	return admission.outcome === "admitted" ? admission.context : void 0;
+};
+const admitContext = (context) => {
+	const kind = context?.kind;
+	if (isAcceptedKind(kind)) return {
+		outcome: "admitted",
+		context
+	};
+	return {
+		outcome: "ignored",
+		kindSample: firstCharactersOf(stringFormOf(kind), KIND_SAMPLE_MAXIMUM_CHARACTERS)
+	};
+};
+//#endregion
 //#region src/runtime/app/composables/useConfigDirectorContext.ts
 const DEFAULT_TIMEOUT = 3e3;
 const getEffectiveTimeout = (option) => {
@@ -26,7 +70,7 @@ const useConfigDirectorContext = () => {
 		const rawContext = toRaw(context);
 		const oldContext = JSON.stringify(state.value);
 		const newContext = JSON.stringify(rawContext);
-		state.value = rawContext;
+		state.value = admittedContextOrNone(rawContext);
 		if (oldContext != newContext) {
 			const timeout = getEffectiveTimeout(options?.timeoutMilliseconds);
 			let timer;
@@ -65,19 +109,19 @@ var plugin_server_default = defineNuxtPlugin((nuxtApp) => {
 	} };
 });
 var SsrClient = class {
-	currentContext;
+	suppliedContext;
 	constructor(serverClient) {
 		this.serverClient = serverClient;
 		this.serverClient = serverClient;
 	}
 	async initialize(context) {
-		this.currentContext = context;
+		this.suppliedContext = context;
 	}
 	async updateContext(context) {
-		this.currentContext = context;
+		this.suppliedContext = context;
 	}
 	get context() {
-		return this.currentContext;
+		return admittedContextOrNone(this.suppliedContext);
 	}
 	get isReady() {
 		return this.serverClient.isReady;
@@ -86,7 +130,7 @@ var SsrClient = class {
 		return false;
 	}
 	getValue(configKey, defaultValue) {
-		return this.serverClient.getValue(configKey, defaultValue, this.currentContext);
+		return this.serverClient.getValue(configKey, defaultValue, this.suppliedContext);
 	}
 	watch() {
 		return () => {};

package/dist/runtime/server/composables/useConfigDirectorServerClient.d.mts

@@ -0,0 +1,6 @@
+import { n as ConfigDirectorClient } from "../../types-CS7AMNWe.mjs";
+
+//#region src/runtime/server/composables/useConfigDirectorServerClient.d.ts
+declare const useConfigDirectorServerClient: () => ConfigDirectorClient;
+//#endregion
+export { useConfigDirectorServerClient };

package/dist/runtime/server/composables/useConfigDirectorServerClient.d.ts

@@ -0,0 +1,6 @@
+import { n as ConfigDirectorClient } from "../../types-CS7AMNWe.mjs";
+
+//#region src/runtime/server/composables/useConfigDirectorServerClient.d.ts
+declare const useConfigDirectorServerClient: () => ConfigDirectorClient;
+//#endregion
+export { useConfigDirectorServerClient };

package/dist/runtime/server/composables/{useConfigDirectorClient.mjs → useConfigDirectorServerClient.mjs}

@@ -1,9 +1,9 @@
 import { useNitroApp } from "nitropack/runtime";
-//#region src/runtime/server/composables/useConfigDirectorClient.ts
-const useConfigDirectorClient = () => {
+//#region src/runtime/server/composables/useConfigDirectorServerClient.ts
+const useConfigDirectorServerClient = () => {
 	const serverSdkClient = useNitroApp().configDirectorClient;
 	if (!serverSdkClient) throw "The nitro ConfigDirector plugin was not initialized";
 	return serverSdkClient;
 };
 //#endregion
-export { useConfigDirectorClient };
+export { useConfigDirectorServerClient };

package/dist/runtime/server/composables/useConfigDirectorServerHooks.d.mts

@@ -1,4 +1,4 @@
-import { t as ClientHooks } from "../../types-Bgx2-3dY.mjs";
+import { t as ClientHooks } from "../../types-CS7AMNWe.mjs";
 
 //#region src/runtime/server/composables/useConfigDirectorServerHooks.d.ts
 declare const useConfigDirectorServerHooks: (hooks: ClientHooks) => void;

package/dist/runtime/server/composables/useConfigDirectorServerHooks.d.ts

@@ -1,4 +1,4 @@
-import { t as ClientHooks } from "../../types-Bgx2-3dY.mjs";
+import { t as ClientHooks } from "../../types-CS7AMNWe.mjs";
 
 //#region src/runtime/server/composables/useConfigDirectorServerHooks.d.ts
 declare const useConfigDirectorServerHooks: (hooks: ClientHooks) => void;

package/dist/runtime/{types-Bgx2-3dY.d.mts → types-CS7AMNWe.d.mts}

@@ -1,4 +1,4 @@
-import { i as ConfigValueType, n as ConfigEvaluation, r as ConfigState, t as ConfigDirectorContext } from "./types-CHmsCChN.mjs";
+import { a as ConfigValueType, i as ConfigState, n as ConfigDirectorContext, r as ConfigEvaluation } from "./native-values-BV2k_xR2.mjs";
 
 //#region ../js-server-sdk/src/types.d.ts
 type ClientEvents = {

package/dist/runtime/{types-CvmjergQ.d.mts → types-Dt3bENKf.d.mts}

@@ -1,4 +1,4 @@
-import { i as ConfigValueType, n as ConfigEvaluation, t as ConfigDirectorContext } from "./types-CHmsCChN.mjs";
+import { a as ConfigValueType, n as ConfigDirectorContext, r as ConfigEvaluation } from "./native-values-BV2k_xR2.mjs";
 
 //#region ../js-client-core/src/Emitter.d.ts
 type EventType = string | symbol;
@@ -60,17 +60,25 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
    * not attempt to re-connect and an error will be logged to the console or the provided
    * logger.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (optional).
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, and the client connects as if no context had been provided.
+   *
+   * @param context The current context to be used for evaluating targeting rules (optional).
    */
   initialize(context?: ConfigDirectorContext): Promise<void>;
   /**
-   * Updates the user's context and re-evaluates all config and flag values based on the new context.
+   * Updates the context and re-evaluates all config and flag values based on the new context.
+   *
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, the previous context is no longer used, and the client connects as if no context had been
+   * provided.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
+   * @param context The current context to be used for evaluating targeting rules (required).
    */
   updateContext(context: ConfigDirectorContext): Promise<void>;
   /**
-   * Returns the current context the client is configured with, or undefined if there is no context.
+   * Returns the current context the client is configured with, or undefined if there is no context,
+   * including after a context with an invalid kind was ignored.
    *
    * Note that the value returned does not updated immediately after calling {@link updateContext}. Only
    * once the underlying connection was successful or timed out, the current context is updated. This is

package/dist/testing.d.mts

@@ -29,27 +29,40 @@ type ConfigEvaluation = {
   context?: ConfigDirectorContext;
 };
 /**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
+ * The context to be sent to ConfigDirector: the user or other entity, such as a device or an
+ * organization, that configs are evaluated for. This context will be used for targeting rules
+ * evaluation.
  */
 type ConfigDirectorContext = {
   /**
-   * The user's identifier. This should be a value that uniquely identifies an application
-   * user.
+   * 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 users in percentage rollouts, and changes to the {@link id}
-   * could result in the user being assigned to a different percentile.
+   * 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;
   /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
+   * The kind of entity this context represents, such as `user`, `device`, `organization`,
+   * `tenant` or `listing`. You can use any other kind that fits your application. A kind has 1
+   * to 64 characters, using only lowercase letters (`a`-`z`), digits, `-` and `_`. It is used
+   * exactly as given, without trimming or changing its case.
+   *
+   * A context with an invalid kind is ignored as a whole: the SDK logs an error and evaluates
+   * as if no context had been provided.
+   *
+   * @default "user"
+   */
+  kind?: string;
+  /**
+   * The context's display name. This will be shown in the ConfigDirector dashboard and may be
    * used for targeting rules.
    */
   name?: string;
   /**
-   * Any arbitrary traits for the current user. They will be shown in the ConfigDirector
-   * dashboard and may be used for targeting rules.
+   * Any arbitrary traits for the context. They will be shown in the ConfigDirector dashboard
+   * and may be used for targeting rules.
    */
   traits?: {
     [key: string]: unknown;
@@ -64,6 +77,15 @@ type ConfigDirectorContext = {
   anonymous?: boolean;
 };
 //#endregion
+//#region ../shared/src/native-values.d.ts
+type NativeJsonValue = boolean | number | string | null | NativeJsonValue[] | {
+  [key: string]: NativeJsonValue;
+};
+type NativeValue = boolean | number | string | NativeJsonValue[] | {
+  [key: string]: NativeJsonValue;
+};
+type NativeValues = Record<string, NativeValue>;
+//#endregion
 //#region ../js-client-core/src/types.d.ts
 type ClientConnectAction = "initialization" | "context update" | "network resume";
 type ClientEvents = {
@@ -106,17 +128,25 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
    * not attempt to re-connect and an error will be logged to the console or the provided
    * logger.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (optional).
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, and the client connects as if no context had been provided.
+   *
+   * @param context The current context to be used for evaluating targeting rules (optional).
    */
   initialize(context?: ConfigDirectorContext): Promise<void>;
   /**
-   * Updates the user's context and re-evaluates all config and flag values based on the new context.
+   * Updates the context and re-evaluates all config and flag values based on the new context.
+   *
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, the previous context is no longer used, and the client connects as if no context had been
+   * provided.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
+   * @param context The current context to be used for evaluating targeting rules (required).
    */
   updateContext(context: ConfigDirectorContext): Promise<void>;
   /**
-   * Returns the current context the client is configured with, or undefined if there is no context.
+   * Returns the current context the client is configured with, or undefined if there is no context,
+   * including after a context with an invalid kind was ignored.
    *
    * Note that the value returned does not updated immediately after calling {@link updateContext}. Only
    * once the underlying connection was successful or timed out, the current context is updated. This is
@@ -196,15 +226,6 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
   dispose(): void;
 }
 //#endregion
-//#region ../shared/src/testing/values.d.ts
-type TestJsonValue = boolean | number | string | null | TestJsonValue[] | {
-  [key: string]: TestJsonValue;
-};
-type TestValue = boolean | number | string | TestJsonValue[] | {
-  [key: string]: TestJsonValue;
-};
-type TestValues = Record<string, TestValue>;
-//#endregion
 //#region ../js-client-core/src/testing/TestClient.d.ts
 /**
  * Options for {@link createTestClient}. Every option is optional.
@@ -215,7 +236,7 @@ type TestClientOptions = {
    * config type follows from each value: a boolean, an integral number (`integer`), any other
    * number (`float`), a string, or a plain object or array (`json`).
    */
-  values?: TestValues;
+  values?: NativeValues;
   /**
    * The connection timeout of the SDK client, in milliseconds. It bounds how long a held
    * `initialize` or `updateContext` waits. Defaults to the SDK's production timeout.
@@ -244,7 +265,7 @@ interface TestClient {
    * Stores `value` under `key` and, when the client is connected, delivers it as an update, so
    * reads, watchers, and `configsUpdated` handlers see it.
    */
-  setValue(key: string, value: TestValue): void;
+  setValue(key: string, value: NativeValue): void;
   /**
    * Removes `key` and, when the client is connected, delivers a full update without it, so reads
    * fall back to the in-code default value and watchers of `key` receive that default.
@@ -254,7 +275,7 @@ interface TestClient {
    * Replaces every stored value with `values`, disarms any armed hold or failure, and, when the
    * client is connected, delivers the new values as a full update.
    */
-  replaceValues(values: TestValues): void;
+  replaceValues(values: NativeValues): void;
   /**
    * Makes the next `initialize` wait until {@link completeInitialization} or
    * {@link failInitialization} is called, or until the client's timeout elapses.
@@ -287,7 +308,8 @@ interface TestClient {
   failContextUpdate(): void;
   /**
    * The context of every `initialize` and `updateContext` call, in call order. `initialize` without
-   * a context records an empty context. Resumes are not recorded.
+   * a context records an empty context, and so does a call whose context has an invalid kind, since
+   * the client connects without it. Resumes are not recorded.
    */
   readonly contextUpdates: ConfigDirectorContext[];
 }
@@ -349,4 +371,4 @@ declare class ConfigDirectorValidationError extends Error {
  */
 declare const createTestClient: (options?: TestClientOptions) => TestClient;
 //#endregion
-export { ConfigDirectorConnectionError, ConfigDirectorValidationError, type TestClient, type TestClientOptions, type TestJsonValue, type TestValue, type TestValues, createTestClient, installTestClient };
+export { ConfigDirectorConnectionError, ConfigDirectorValidationError, type TestClient, type TestClientOptions, type NativeJsonValue as TestJsonValue, type NativeValue as TestValue, type NativeValues as TestValues, createTestClient, installTestClient };