@configdirector/server-sdk 1.7.0 → 1.9.0

package/dist/types-BqIJGXWv.d.mts

@@ -0,0 +1,292 @@
+//#region ../shared/src/types.d.ts
+declare const ConfigTypeList: readonly ["custom", "boolean", "string", "integer", "float", "enum", "url", "json"];
+type ConfigType = (typeof ConfigTypeList)[number];
+type ConfigEnumLikeType = {
+  [key: string]: string | number;
+};
+type ConfigValueType = string | number | boolean | object | ConfigEnumLikeType;
+type ConfigState = {
+  id: string;
+  key: string;
+  type: ConfigType;
+  value: string | undefined | null;
+  valueId?: string | undefined | null;
+};
+type ConfigDirectorLoggingLevel = "debug" | "info" | "warn" | "error" | "off";
+interface ConfigDirectorLogger {
+  debug(message: string, ...args: any): void;
+  info(message: string, ...args: any): void;
+  warn(message: string, ...args: any): void;
+  error(message: string, ...args: any): void;
+}
+interface ConfigDirectorLogMessageDecorator {
+  decorateMessage(message: string): string;
+}
+type EvaluationReason = "found-match" | "config-state-missing" | "client-not-ready" | "type-mismatch" | "value-missing" | "invalid-number" | "invalid-json" | "invalid-boolean";
+type ConfigEvaluation = {
+  key: string;
+  value: ConfigValueType;
+  valueId?: string;
+  isDefaultValue: boolean;
+  reason: EvaluationReason;
+  context?: ConfigDirectorContext;
+};
+/**
+ * The user's context to be sent to ConfigDirector. 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.
+   * 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.
+   */
+  id?: string;
+  /**
+   * The user'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.
+   */
+  traits?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Whether or not to treat the context as anonymous during evaluation. When `true`, the
+   * context values will be used for targeting rules evaluation but the context will not be
+   * persisted and will not appear in the dashboard.
+   *
+   * @default false
+   */
+  anonymous?: boolean;
+};
+/**
+ * Metadata about your application. It is recommended you include these values when configuring
+ * a ConfigDirector client so that you can use them in targeting rules.
+ */
+type ConfigDirectorMetaContext = {
+  appVersion?: string;
+  appName?: string;
+};
+type ConnectionMode = "streaming" | "polling";
+//#endregion
+//#region src/types.d.ts
+/**
+ * Configuration options for the {@link ConfigDirectorClient}
+ */
+type ConfigDirectorClientOptions = {
+  /**
+   * Application metadata that remains constant through the lifetime of the connection
+   */
+  metadata?: ConfigDirectorMetaContext;
+  /**
+   * Connection options
+   */
+  connection?: {
+    /**
+     * The connection mode to be used, one of `streaming` (default) or `polling`.
+     * If set to `streaming`, the connection will remain open and receive updates whenever
+     * config state is updated on the ConfigDirector dashboard.
+     * When set to `polling`, there will be an initial request to retrieve config state during
+     * initialization, and additional requests on a `pollingInterval`.
+     *
+     * Defaults to `streaming`
+     */
+    mode?: ConnectionMode;
+    /**
+     * The polling interval in _seconds_ when the `mode` is set to `polling`. This option has no
+     * effect when the `mode` is set to `streaming`.
+     *
+     * Defaults to 300 seconds (5 minutes). The minimum is 60 seconds. A value below the minimum is
+     * raised to the minimum and a warning is logged.
+     */
+    pollingInterval?: number;
+    /**
+     * The timeout, in milliseconds, to be used in initialization and when updating the context.
+     * If streaming is enabled, the operation (initialization or context update) may still succeed
+     * after it times out if no unrecoverable errors are encountered (like an invalid SDK key).
+     * If streaming is disabled, if the operation times out, it will not be retried.
+     *
+     * Defaults to 3,000 milliseconds (3 seconds)
+     */
+    timeout?: number;
+    /**
+     * The base URL to the ConfigDirector SDK server. To be used only when needing to route through a
+     * proxy to connect to the ConfigDirector SDK server. Please refer to the docs on how to configure
+     * a proxy for the client SDK.
+     */
+    url?: string;
+  };
+  /**
+   * A logger that implements {@link ConfigDirectorLogger}. It defaults to the ConfigDirector console
+   * logger set to 'warn' level.
+   *
+   * The log level of the default logger can be adjusted by creating a default logger with the desired
+   * level and providing it in this property:
+   * @example
+   * import { createClient, createConsoleLogger } from "@configdirector/server-sdk";
+   * const client = createClient(
+   *   "YOUR-SERVER-SDK-KEY",
+   *   { logger: createConsoleLogger("debug") },
+   * );
+   */
+  logger?: ConfigDirectorLogger;
+  /**
+   * Telemetry tunning. It is unlikely these settings need to be adjusted. However, in cases where
+   * your application has a large number of evaluations per second, you can adjust these settings
+   * to tune the memory footprint and frequency of telemetry requests.
+   * Keep in mind that ConfigDirector relies on these telemetry events to provide insights and features
+   * related to the configs being used.
+   */
+  telemetry?: {
+    /**
+     * The size limit of telemetry event queues. If the size limit is reached before the events are
+     * flushed to the network, older events will be dropped.
+     *
+     * ConfigDirector keeps a count of dropped events. If the number of dropped events is higher than
+     * 50% of the total events, ConfigDirector will issue a notification alert in the dashboard.
+     *
+     * A number between 100 and 100,000. Defaults to 5,000.
+     */
+    eventQueueLimit?: number;
+    /**
+     * How often events are flushed and sent over the network in milliseconds.
+     *
+     * Decrease this number if your application consistently captures a large number of events in short
+     * periods of time in order to reduce memory footprint from a large event queue.
+     *
+     * Defaults to 30,000 milliseconds (30 seconds)
+     */
+    flushInterval?: number;
+  };
+  /**
+   * Handlers for hooks/events emitted by the client. Each hook accepts either a single event handler or
+   * an array of event handlers.
+   *
+   * @example
+   * import { createClient, createConsoleLogger } from "@configdirector/server-sdk";
+   * const client = createClient(
+   *   "YOUR-SERVER-SDK-KEY",
+   *   {
+   *     hooks: {
+   *       configEvaluated: (event) => { console.log(event.evaluation); }
+   *     },
+   *   },
+   * );
+   */
+  hooks?: ClientHooks;
+};
+type ClientEvents = {
+  configsUpdated: {
+    keys: string[];
+    removedKeys: string[];
+  };
+  clientReady: undefined;
+  configEvaluated: {
+    evaluation: ConfigEvaluation;
+  };
+  connectionError: {
+    error: Error;
+  };
+};
+type ClientHooks = {
+  clientReady?: HookHandler<"clientReady"> | HookHandler<"clientReady">[];
+  configsUpdated?: HookHandler<"configsUpdated"> | HookHandler<"configsUpdated">[];
+  configEvaluated?: HookHandler<"configEvaluated"> | HookHandler<"configEvaluated">[];
+  connectionError?: HookHandler<"connectionError"> | HookHandler<"connectionError">[];
+};
+type HookHandler<TEvent extends keyof ClientEvents> = (payload: ClientEvents[TEvent]) => void;
+type WatchHandler<T extends ConfigValueType> = (message: T) => void;
+/**
+ * The ConfigDirector SDK client object.
+ *
+ * Applications should create a single instance of `ConfigDirectorClient`, and call
+ * {@link initialize} during application initialization.
+ */
+interface ConfigDirectorClient {
+  /**
+   * Initializes the connection to ConfigDirector to retrieve config definitions. Until
+   * initialization is successful, all flags will return their default value provided to
+   * {@link watch} or {@link getValue}.
+   *
+   * If the connection fails or is interrupted with a transient error (network error,
+   * internal server error, etc) the client will continue to attempt to connect. However,
+   * if the connection fails with a persistent error, like an invalid SDK key, the client will
+   * not attempt to re-connect and an error will be logged to the console or the provided
+   * logger.
+   */
+  initialize(): Promise<void>;
+  /**
+   * Returns whether or not the client is ready after calling {@link initialize}
+   *
+   * The definition of ready is that the connection to the server was successful, and config definitions
+   * were received.
+   */
+  get isReady(): boolean;
+  /**
+   * Evaluates a config and returns its value based on the current context and targeting rules
+   *
+   * @returns The evaluated config value, or the `defaultValue` if the config state was unavailable
+   * @param configKey The config key to evaluate
+   * @param defaultValue The default value to be returned if the config state is unavailable. For
+   * example, if the client cannot connect to the server due to network conditions, or if getValue
+   * is called before initialization is done.
+   * @param context The user's context to be used for targeting rules evaluation (optional)
+   */
+  getValue<T extends ConfigValueType>(configKey: string, defaultValue: T, context?: ConfigDirectorContext): T;
+  /**
+   * Watches for changes to a a config evaluation value. Whenever the config value changes, the
+   * provided callback function will be called with the new value. Changes can happen due to updates
+   * to the config in the ConfigDirector dashboard, or if the context is updated via {@link updateContext}.
+   *
+   * @returns An 'unwatch' function that can be called to remove the subscriber
+   *
+   * @param configKey The config key to watch
+   * @param defaultValue The default value to be referenced if the config state is unavailable
+   * @param callback The callback function to be called whenever the config value is updated
+   * @param context The user's context to be used for targeting rules evaluation (optional)
+   */
+  watch<T extends ConfigValueType>(configKey: string, defaultValue: T, callback: WatchHandler<T>, context?: ConfigDirectorContext): () => void;
+  /**
+   * Removes a particular subscriber to the given `configKey`, or all subscribers if no callback
+   * is provided.
+   *
+   * @param configKey The config key to remove subscribers from
+   * @param callback The subscriber to be removed. If not provided, all subscribers are removed for
+   * the given `configKey`.
+   */
+  unwatch<T extends ConfigValueType>(configKey: string, callback?: WatchHandler<T>): void;
+  /**
+   * Removes all subscribers from all config keys
+   */
+  unwatchAll(): void;
+  /**
+   * Returns the evaluated {@link ConfigState} for every known config key, or only the keys
+   * listed in `configKeys` when provided.
+   *
+   * Intended for SSR hydration — does NOT record telemetry events. Returns an empty object
+   * when the client is not yet ready.
+   */
+  getAllConfigs(options?: {
+    context?: ConfigDirectorContext;
+    configKeys?: string[];
+  }): Record<string, ConfigState>;
+  on<T extends keyof ClientEvents>(eventName: T, handler: (args: ClientEvents[T]) => void): void;
+  off<T extends keyof ClientEvents>(eventName: T, handler?: (args: ClientEvents[T]) => void): void;
+  /**
+   * Disposes of the client. All connections are closed, and all event and config key subscribers
+   * are removed.
+   *
+   * Intended to be called when your application shuts down
+   */
+  dispose(): void;
+}
+//#endregion
+export { ConfigDirectorLogger as a, ConfigValueType as c, ConfigDirectorLogMessageDecorator as i, ConfigDirectorClientOptions as n, ConfigDirectorLoggingLevel as o, ConfigDirectorContext as r, ConfigDirectorMetaContext as s, ConfigDirectorClient as t };
+//# sourceMappingURL=types-BqIJGXWv.d.mts.map

package/dist/types-BqIJGXWv.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BqIJGXWv.d.mts","names":[],"sources":["../../shared/src/types.ts","../src/types.ts"],"mappings":";cAAa,cAAA;AAAA,KAUD,UAAA,WAAqB,cAAA;AAAA,KAErB,kBAAA;EAAA,CAAwB,GAAA;AAAA;AAAA,KAExB,eAAA,wCAAuD,kBAAA;AAAA,KAEvD,WAAA;EACV,EAAA;EACA,GAAA;EACA,IAAA,EAAM,UAAA;EACN,KAAA;EACA,OAAA;AAAA;AAAA,KAQU,0BAAA;AAAA,UAEK,oBAAA;EACf,KAAA,CAAM,OAAA,aAAoB,IAAA;EAE1B,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,KAAA,CAAM,OAAA,aAAoB,IAAA;AAAA;AAAA,UAGX,iCAAA;EACf,eAAA,CAAgB,OAAA;AAAA;AAAA,KAGN,gBAAA;AAAA,KAUA,gBAAA;EACV,GAAA;EACA,KAAA,EAAO,eAAA;EACP,OAAA;EACA,cAAA;EACA,MAAA,EAAQ,gBAAA;EACR,OAAA,GAAU,qBAAA;AAAA;;;AA9BZ;;KAoCY,qBAAA;EApCyB;;;;;;;;EA6CnC,EAAA;EAxCyB;;;;EA8CzB,IAAA;EA5C8B;AAGhC;;;EA+CE,MAAA;IAAA,CAAY,GAAA;EAAA;EA3Cc;;;;AAU5B;;;EA0CE,SAAA;AAAA;;;;;KAOU,yBAAA;EACV,UAAA;EACA,OAAA;AAAA;AAAA,KAGU,cAAA;;;;;AAnGZ;KCkBY,2BAAA;;;;EAIV,QAAA,GAAW,yBAAA;EDpBiB;;;ECwB5B,UAAA;IDtBU;;;;;AAEZ;;;;IC8BI,IAAA,GAAO,cAAA;ID5BT;;;;;;;ICoCE,eAAA;IDzBkC;;;;AAEtC;;;;ICgCI,OAAA;ID/BI;;;;;ICqCJ,GAAA;EAAA;EDjCuB;;;;;;AAK3B;;;;;AAIA;;ECuCE,MAAA,GAAS,oBAAA;EDvCiB;;AAU5B;;;;;ECsCE,SAAA;IDhC+B;;;;;;;;;IC0C7B,eAAA;ID1CQ;;;AAMZ;;;;;IC8CI,aAAA;EAAA;EDzBU;;;;AAgBd;;;;;AAKA;;;;;;ECsBE,KAAA,GAAQ,WAAA;AAAA;AAAA,KAGE,YAAA;EACV,cAAA;IAAkB,IAAA;IAAgB,WAAA;EAAA;EAClC,WAAA;EACA,eAAA;IAAmB,UAAA,EAAY,gBAAA;EAAA;EAC/B,eAAA;IAAmB,KAAA,EAAO,KAAA;EAAA;AAAA;AAAA,KAGhB,WAAA;EACV,WAAA,GAAc,WAAA,kBAA6B,WAAA;EAC3C,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;EACnD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;AAAA;AAAA,KAGzC,WAAA,sBAAiC,YAAA,KAAiB,OAAA,EAAS,YAAA,CAAa,MAAA;AAAA,KAExE,YAAA,WAAuB,eAAA,KAAoB,OAAA,EAAS,CAAA;;;;;;AAhBhE;UAwBiB,oBAAA;;;;;;;;;;;;EAYf,UAAA,IAAc,OAAA;EAhCiB;;AAGjC;;;;EAHiC,IAwC3B,OAAA;EAnCa;;;;;;;;;;EA+CjB,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,OAAA,GAAU,qBAAA,GAAwB,CAAA;EA/C1G;;;;;;;;;;;AAKF;EAwDE,KAAA,WAAgB,eAAA,EACd,SAAA,UACA,YAAA,EAAc,CAAA,EACd,QAAA,EAAU,YAAA,CAAa,CAAA,GACvB,OAAA,GAAU,qBAAA;EA5DS;;;;;;;;EAuErB,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAvEI;;;EA4ElF,UAAA;EA1EU;;;;;;;EAmFV,aAAA,CAAc,OAAA;IACZ,OAAA,GAAU,qBAAA;IACV,UAAA;EAAA,IACE,MAAA,SAAe,WAAA;EAEnB,EAAA,iBAAmB,YAAA,EAAc,SAAA,EAAW,CAAA,EAAG,OAAA,GAAU,IAAA,EAAM,YAAA,CAAa,CAAA;EAE5E,GAAA,iBAAoB,YAAA,EAAc,SAAA,EAAW,CAAA,EAAG,OAAA,IAAW,IAAA,EAAM,YAAA,CAAa,CAAA;EAtEhE;;;;;;EA8Ed,OAAA;AAAA"}

package/dist/types-CcUNxeqN.d.cts

@@ -0,0 +1,292 @@
+//#region ../shared/src/types.d.ts
+declare const ConfigTypeList: readonly ["custom", "boolean", "string", "integer", "float", "enum", "url", "json"];
+type ConfigType = (typeof ConfigTypeList)[number];
+type ConfigEnumLikeType = {
+  [key: string]: string | number;
+};
+type ConfigValueType = string | number | boolean | object | ConfigEnumLikeType;
+type ConfigState = {
+  id: string;
+  key: string;
+  type: ConfigType;
+  value: string | undefined | null;
+  valueId?: string | undefined | null;
+};
+type ConfigDirectorLoggingLevel = "debug" | "info" | "warn" | "error" | "off";
+interface ConfigDirectorLogger {
+  debug(message: string, ...args: any): void;
+  info(message: string, ...args: any): void;
+  warn(message: string, ...args: any): void;
+  error(message: string, ...args: any): void;
+}
+interface ConfigDirectorLogMessageDecorator {
+  decorateMessage(message: string): string;
+}
+type EvaluationReason = "found-match" | "config-state-missing" | "client-not-ready" | "type-mismatch" | "value-missing" | "invalid-number" | "invalid-json" | "invalid-boolean";
+type ConfigEvaluation = {
+  key: string;
+  value: ConfigValueType;
+  valueId?: string;
+  isDefaultValue: boolean;
+  reason: EvaluationReason;
+  context?: ConfigDirectorContext;
+};
+/**
+ * The user's context to be sent to ConfigDirector. 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.
+   * 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.
+   */
+  id?: string;
+  /**
+   * The user'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.
+   */
+  traits?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Whether or not to treat the context as anonymous during evaluation. When `true`, the
+   * context values will be used for targeting rules evaluation but the context will not be
+   * persisted and will not appear in the dashboard.
+   *
+   * @default false
+   */
+  anonymous?: boolean;
+};
+/**
+ * Metadata about your application. It is recommended you include these values when configuring
+ * a ConfigDirector client so that you can use them in targeting rules.
+ */
+type ConfigDirectorMetaContext = {
+  appVersion?: string;
+  appName?: string;
+};
+type ConnectionMode = "streaming" | "polling";
+//#endregion
+//#region src/types.d.ts
+/**
+ * Configuration options for the {@link ConfigDirectorClient}
+ */
+type ConfigDirectorClientOptions = {
+  /**
+   * Application metadata that remains constant through the lifetime of the connection
+   */
+  metadata?: ConfigDirectorMetaContext;
+  /**
+   * Connection options
+   */
+  connection?: {
+    /**
+     * The connection mode to be used, one of `streaming` (default) or `polling`.
+     * If set to `streaming`, the connection will remain open and receive updates whenever
+     * config state is updated on the ConfigDirector dashboard.
+     * When set to `polling`, there will be an initial request to retrieve config state during
+     * initialization, and additional requests on a `pollingInterval`.
+     *
+     * Defaults to `streaming`
+     */
+    mode?: ConnectionMode;
+    /**
+     * The polling interval in _seconds_ when the `mode` is set to `polling`. This option has no
+     * effect when the `mode` is set to `streaming`.
+     *
+     * Defaults to 300 seconds (5 minutes). The minimum is 60 seconds. A value below the minimum is
+     * raised to the minimum and a warning is logged.
+     */
+    pollingInterval?: number;
+    /**
+     * The timeout, in milliseconds, to be used in initialization and when updating the context.
+     * If streaming is enabled, the operation (initialization or context update) may still succeed
+     * after it times out if no unrecoverable errors are encountered (like an invalid SDK key).
+     * If streaming is disabled, if the operation times out, it will not be retried.
+     *
+     * Defaults to 3,000 milliseconds (3 seconds)
+     */
+    timeout?: number;
+    /**
+     * The base URL to the ConfigDirector SDK server. To be used only when needing to route through a
+     * proxy to connect to the ConfigDirector SDK server. Please refer to the docs on how to configure
+     * a proxy for the client SDK.
+     */
+    url?: string;
+  };
+  /**
+   * A logger that implements {@link ConfigDirectorLogger}. It defaults to the ConfigDirector console
+   * logger set to 'warn' level.
+   *
+   * The log level of the default logger can be adjusted by creating a default logger with the desired
+   * level and providing it in this property:
+   * @example
+   * import { createClient, createConsoleLogger } from "@configdirector/server-sdk";
+   * const client = createClient(
+   *   "YOUR-SERVER-SDK-KEY",
+   *   { logger: createConsoleLogger("debug") },
+   * );
+   */
+  logger?: ConfigDirectorLogger;
+  /**
+   * Telemetry tunning. It is unlikely these settings need to be adjusted. However, in cases where
+   * your application has a large number of evaluations per second, you can adjust these settings
+   * to tune the memory footprint and frequency of telemetry requests.
+   * Keep in mind that ConfigDirector relies on these telemetry events to provide insights and features
+   * related to the configs being used.
+   */
+  telemetry?: {
+    /**
+     * The size limit of telemetry event queues. If the size limit is reached before the events are
+     * flushed to the network, older events will be dropped.
+     *
+     * ConfigDirector keeps a count of dropped events. If the number of dropped events is higher than
+     * 50% of the total events, ConfigDirector will issue a notification alert in the dashboard.
+     *
+     * A number between 100 and 100,000. Defaults to 5,000.
+     */
+    eventQueueLimit?: number;
+    /**
+     * How often events are flushed and sent over the network in milliseconds.
+     *
+     * Decrease this number if your application consistently captures a large number of events in short
+     * periods of time in order to reduce memory footprint from a large event queue.
+     *
+     * Defaults to 30,000 milliseconds (30 seconds)
+     */
+    flushInterval?: number;
+  };
+  /**
+   * Handlers for hooks/events emitted by the client. Each hook accepts either a single event handler or
+   * an array of event handlers.
+   *
+   * @example
+   * import { createClient, createConsoleLogger } from "@configdirector/server-sdk";
+   * const client = createClient(
+   *   "YOUR-SERVER-SDK-KEY",
+   *   {
+   *     hooks: {
+   *       configEvaluated: (event) => { console.log(event.evaluation); }
+   *     },
+   *   },
+   * );
+   */
+  hooks?: ClientHooks;
+};
+type ClientEvents = {
+  configsUpdated: {
+    keys: string[];
+    removedKeys: string[];
+  };
+  clientReady: undefined;
+  configEvaluated: {
+    evaluation: ConfigEvaluation;
+  };
+  connectionError: {
+    error: Error;
+  };
+};
+type ClientHooks = {
+  clientReady?: HookHandler<"clientReady"> | HookHandler<"clientReady">[];
+  configsUpdated?: HookHandler<"configsUpdated"> | HookHandler<"configsUpdated">[];
+  configEvaluated?: HookHandler<"configEvaluated"> | HookHandler<"configEvaluated">[];
+  connectionError?: HookHandler<"connectionError"> | HookHandler<"connectionError">[];
+};
+type HookHandler<TEvent extends keyof ClientEvents> = (payload: ClientEvents[TEvent]) => void;
+type WatchHandler<T extends ConfigValueType> = (message: T) => void;
+/**
+ * The ConfigDirector SDK client object.
+ *
+ * Applications should create a single instance of `ConfigDirectorClient`, and call
+ * {@link initialize} during application initialization.
+ */
+interface ConfigDirectorClient {
+  /**
+   * Initializes the connection to ConfigDirector to retrieve config definitions. Until
+   * initialization is successful, all flags will return their default value provided to
+   * {@link watch} or {@link getValue}.
+   *
+   * If the connection fails or is interrupted with a transient error (network error,
+   * internal server error, etc) the client will continue to attempt to connect. However,
+   * if the connection fails with a persistent error, like an invalid SDK key, the client will
+   * not attempt to re-connect and an error will be logged to the console or the provided
+   * logger.
+   */
+  initialize(): Promise<void>;
+  /**
+   * Returns whether or not the client is ready after calling {@link initialize}
+   *
+   * The definition of ready is that the connection to the server was successful, and config definitions
+   * were received.
+   */
+  get isReady(): boolean;
+  /**
+   * Evaluates a config and returns its value based on the current context and targeting rules
+   *
+   * @returns The evaluated config value, or the `defaultValue` if the config state was unavailable
+   * @param configKey The config key to evaluate
+   * @param defaultValue The default value to be returned if the config state is unavailable. For
+   * example, if the client cannot connect to the server due to network conditions, or if getValue
+   * is called before initialization is done.
+   * @param context The user's context to be used for targeting rules evaluation (optional)
+   */
+  getValue<T extends ConfigValueType>(configKey: string, defaultValue: T, context?: ConfigDirectorContext): T;
+  /**
+   * Watches for changes to a a config evaluation value. Whenever the config value changes, the
+   * provided callback function will be called with the new value. Changes can happen due to updates
+   * to the config in the ConfigDirector dashboard, or if the context is updated via {@link updateContext}.
+   *
+   * @returns An 'unwatch' function that can be called to remove the subscriber
+   *
+   * @param configKey The config key to watch
+   * @param defaultValue The default value to be referenced if the config state is unavailable
+   * @param callback The callback function to be called whenever the config value is updated
+   * @param context The user's context to be used for targeting rules evaluation (optional)
+   */
+  watch<T extends ConfigValueType>(configKey: string, defaultValue: T, callback: WatchHandler<T>, context?: ConfigDirectorContext): () => void;
+  /**
+   * Removes a particular subscriber to the given `configKey`, or all subscribers if no callback
+   * is provided.
+   *
+   * @param configKey The config key to remove subscribers from
+   * @param callback The subscriber to be removed. If not provided, all subscribers are removed for
+   * the given `configKey`.
+   */
+  unwatch<T extends ConfigValueType>(configKey: string, callback?: WatchHandler<T>): void;
+  /**
+   * Removes all subscribers from all config keys
+   */
+  unwatchAll(): void;
+  /**
+   * Returns the evaluated {@link ConfigState} for every known config key, or only the keys
+   * listed in `configKeys` when provided.
+   *
+   * Intended for SSR hydration — does NOT record telemetry events. Returns an empty object
+   * when the client is not yet ready.
+   */
+  getAllConfigs(options?: {
+    context?: ConfigDirectorContext;
+    configKeys?: string[];
+  }): Record<string, ConfigState>;
+  on<T extends keyof ClientEvents>(eventName: T, handler: (args: ClientEvents[T]) => void): void;
+  off<T extends keyof ClientEvents>(eventName: T, handler?: (args: ClientEvents[T]) => void): void;
+  /**
+   * Disposes of the client. All connections are closed, and all event and config key subscribers
+   * are removed.
+   *
+   * Intended to be called when your application shuts down
+   */
+  dispose(): void;
+}
+//#endregion
+export { ConfigDirectorLogger as a, ConfigValueType as c, ConfigDirectorLogMessageDecorator as i, ConfigDirectorClientOptions as n, ConfigDirectorLoggingLevel as o, ConfigDirectorContext as r, ConfigDirectorMetaContext as s, ConfigDirectorClient as t };
+//# sourceMappingURL=types-CcUNxeqN.d.cts.map

package/dist/types-CcUNxeqN.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-CcUNxeqN.d.cts","names":[],"sources":["../../shared/src/types.ts","../src/types.ts"],"mappings":";cAAa,cAAA;AAAA,KAUD,UAAA,WAAqB,cAAA;AAAA,KAErB,kBAAA;EAAA,CAAwB,GAAA;AAAA;AAAA,KAExB,eAAA,wCAAuD,kBAAA;AAAA,KAEvD,WAAA;EACV,EAAA;EACA,GAAA;EACA,IAAA,EAAM,UAAA;EACN,KAAA;EACA,OAAA;AAAA;AAAA,KAQU,0BAAA;AAAA,UAEK,oBAAA;EACf,KAAA,CAAM,OAAA,aAAoB,IAAA;EAE1B,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,KAAA,CAAM,OAAA,aAAoB,IAAA;AAAA;AAAA,UAGX,iCAAA;EACf,eAAA,CAAgB,OAAA;AAAA;AAAA,KAGN,gBAAA;AAAA,KAUA,gBAAA;EACV,GAAA;EACA,KAAA,EAAO,eAAA;EACP,OAAA;EACA,cAAA;EACA,MAAA,EAAQ,gBAAA;EACR,OAAA,GAAU,qBAAA;AAAA;;;AA9BZ;;KAoCY,qBAAA;EApCyB;;;;;;;;EA6CnC,EAAA;EAxCyB;;;;EA8CzB,IAAA;EA5C8B;AAGhC;;;EA+CE,MAAA;IAAA,CAAY,GAAA;EAAA;EA3Cc;;;;AAU5B;;;EA0CE,SAAA;AAAA;;;;;KAOU,yBAAA;EACV,UAAA;EACA,OAAA;AAAA;AAAA,KAGU,cAAA;;;;;AAnGZ;KCkBY,2BAAA;;;;EAIV,QAAA,GAAW,yBAAA;EDpBiB;;;ECwB5B,UAAA;IDtBU;;;;;AAEZ;;;;IC8BI,IAAA,GAAO,cAAA;ID5BT;;;;;;;ICoCE,eAAA;IDzBkC;;;;AAEtC;;;;ICgCI,OAAA;ID/BI;;;;;ICqCJ,GAAA;EAAA;EDjCuB;;;;;;AAK3B;;;;;AAIA;;ECuCE,MAAA,GAAS,oBAAA;EDvCiB;;AAU5B;;;;;ECsCE,SAAA;IDhC+B;;;;;;;;;IC0C7B,eAAA;ID1CQ;;;AAMZ;;;;;IC8CI,aAAA;EAAA;EDzBU;;;;AAgBd;;;;;AAKA;;;;;;ECsBE,KAAA,GAAQ,WAAA;AAAA;AAAA,KAGE,YAAA;EACV,cAAA;IAAkB,IAAA;IAAgB,WAAA;EAAA;EAClC,WAAA;EACA,eAAA;IAAmB,UAAA,EAAY,gBAAA;EAAA;EAC/B,eAAA;IAAmB,KAAA,EAAO,KAAA;EAAA;AAAA;AAAA,KAGhB,WAAA;EACV,WAAA,GAAc,WAAA,kBAA6B,WAAA;EAC3C,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;EACnD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;AAAA;AAAA,KAGzC,WAAA,sBAAiC,YAAA,KAAiB,OAAA,EAAS,YAAA,CAAa,MAAA;AAAA,KAExE,YAAA,WAAuB,eAAA,KAAoB,OAAA,EAAS,CAAA;;;;;;AAhBhE;UAwBiB,oBAAA;;;;;;;;;;;;EAYf,UAAA,IAAc,OAAA;EAhCiB;;AAGjC;;;;EAHiC,IAwC3B,OAAA;EAnCa;;;;;;;;;;EA+CjB,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,OAAA,GAAU,qBAAA,GAAwB,CAAA;EA/C1G;;;;;;;;;;;AAKF;EAwDE,KAAA,WAAgB,eAAA,EACd,SAAA,UACA,YAAA,EAAc,CAAA,EACd,QAAA,EAAU,YAAA,CAAa,CAAA,GACvB,OAAA,GAAU,qBAAA;EA5DS;;;;;;;;EAuErB,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAvEI;;;EA4ElF,UAAA;EA1EU;;;;;;;EAmFV,aAAA,CAAc,OAAA;IACZ,OAAA,GAAU,qBAAA;IACV,UAAA;EAAA,IACE,MAAA,SAAe,WAAA;EAEnB,EAAA,iBAAmB,YAAA,EAAc,SAAA,EAAW,CAAA,EAAG,OAAA,GAAU,IAAA,EAAM,YAAA,CAAa,CAAA;EAE5E,GAAA,iBAAoB,YAAA,EAAc,SAAA,EAAW,CAAA,EAAG,OAAA,IAAW,IAAA,EAAM,YAAA,CAAa,CAAA;EAtEhE;;;;;;EA8Ed,OAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configdirector/server-sdk",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "Javascript server SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",
@@ -30,10 +30,27 @@
         "types": "./dist/configdirector-server.d.mts",
         "default": "./dist/configdirector-server.mjs"
       }
+    },
+    "./testing": {
+      "require": {
+        "types": "./dist/configdirector-server-testing.d.cts",
+        "default": "./dist/configdirector-server-testing.cjs"
+      },
+      "default": {
+        "types": "./dist/configdirector-server-testing.d.mts",
+        "default": "./dist/configdirector-server-testing.mjs"
+      }
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "testing": [
+        "./dist/configdirector-server-testing.d.mts"
+      ]
     }
   },
   "files": [
-    "dist/*server.*"
+    "dist"
   ],
   "types": "dist/configdirector-server.d.mts",
   "module": "dist/configdirector-server.mjs",
@@ -73,7 +90,6 @@
     "vitest": "^4.1.8"
   },
   "dependencies": {
-    "@jsonjoy.com/json-pointer": "^18.1.0",
     "luxon": ">=1.28.0 <4.0.0",
     "rapidhash-js": "^3.0.0",
     "semver": "^7.7.4"