@configdirector/nuxt-sdk 0.1.0

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

@@ -0,0 +1,130 @@
+import * as _$h3 from "h3";
+
+//#region ../js-server-sdk/dist/configdirector-server.d.cts
+//#region ../shared/src/types.d.ts
+type ConfigEnumLikeType = {
+  [key: string]: string | number;
+};
+type ConfigValueType = string | number | boolean | object | ConfigEnumLikeType;
+/**
+ * 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;
+  };
+};
+/**
+ * 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 ClientEvents = {
+  configsUpdated: {
+    keys: string[];
+  };
+  clientReady: undefined;
+};
+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;
+  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
+//#region ../shared/src/logger.d.ts
+//#endregion
+//#region src/runtime/nitro/middleware.d.ts
+declare const _default: _$h3.EventHandler<_$h3.EventHandlerRequest, void>;
+declare module "h3" {
+  interface H3EventContext {
+    configDirectorClient: ConfigDirectorClient;
+  }
+}
+//#endregion
+export { _default as default };

package/dist/runtime/nitro/middleware.mjs

@@ -0,0 +1,8 @@
+import { useNitroApp } from "nitropack/runtime";
+import { defineEventHandler } from "h3";
+//#region src/runtime/nitro/middleware.ts
+var middleware_default = defineEventHandler((event) => {
+	event.context.configDirectorClient = useNitroApp().configDirectorClient;
+});
+//#endregion
+export { middleware_default as default };

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

@@ -0,0 +1,12 @@
+import { t as ConfigDirectorClient } from "../types-D9MFb76Q.mjs";
+import * as _$nitropack from "nitropack";
+
+//#region src/runtime/nitro/plugin.d.ts
+declare const _default: _$nitropack.NitroAppPlugin;
+declare module "nitropack" {
+  interface NitroApp {
+    configDirectorClient: ConfigDirectorClient;
+  }
+}
+//#endregion
+export { _default as default };

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

@@ -0,0 +1,12 @@
+import { t as ConfigDirectorClient } from "../types-D9MFb76Q.mjs";
+import * as _$nitropack from "nitropack";
+
+//#region src/runtime/nitro/plugin.d.ts
+declare const _default: _$nitropack.NitroAppPlugin;
+declare module "nitropack" {
+  interface NitroApp {
+    configDirectorClient: ConfigDirectorClient;
+  }
+}
+//#endregion
+export { _default as default };