@configdirector/nextjs-sdk 1.6.1 → 1.8.0

package/dist/server/testing.d.mts

@@ -0,0 +1,119 @@
+import { a as ConfigDirectorLogger, t as ConfigDirectorClient } from "./types-qIeNbtNf.mjs";
+
+//#region ../shared/src/errors.d.ts
+declare class ConfigDirectorConnectionError extends Error {
+  readonly name: string;
+  readonly status?: number;
+  constructor(message: string, status?: number);
+}
+declare class ConfigDirectorValidationError extends Error {
+  readonly name: string;
+  constructor(message: string);
+}
+//#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-server-sdk/src/testing/TestClient.d.ts
+/**
+ * Options for {@link createTestClient}. Every option is optional.
+ */
+type TestClientOptions = {
+  /**
+   * The config values the test client serves once its client connects, keyed by config key. The
+   * 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`). Every context receives the
+   * same value.
+   */
+  values?: TestValues;
+  /**
+   * The connection timeout of the SDK client, in milliseconds. It bounds how long a held
+   * `initialize` waits. Defaults to the SDK's production timeout.
+   */
+  timeout?: number;
+  /**
+   * The logger the SDK client uses. Defaults to the SDK's console logger at `warn` level.
+   */
+  logger?: ConfigDirectorLogger;
+};
+/**
+ * A real ConfigDirector client connected to an in-memory server that the test controls.
+ *
+ * The client under {@link TestClient.client} is the SDK's production client: value parsing,
+ * targeting evaluation, watchers, events, and readiness behave as they do against ConfigDirector.
+ * Only the network connection and telemetry are replaced, so no request is ever made and nothing
+ * is left running after the client is disposed.
+ */
+interface TestClient {
+  /**
+   * The SDK client to hand to the code under test. It starts uninitialized, like a production
+   * client; `initialize` completes at once with the seeded values unless initialization is held.
+   */
+  readonly client: ConfigDirectorClient;
+  /**
+   * 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;
+  /**
+   * 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.
+   */
+  removeValue(key: string): void;
+  /**
+   * 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;
+  /**
+   * Makes the next `initialize` wait until {@link completeInitialization} or
+   * {@link failInitialization} is called, or until the client's timeout elapses.
+   */
+  holdInitialization(): void;
+  /**
+   * Delivers the stored values to a held `initialize`, so it completes with the client ready. When
+   * a hold is armed but no `initialize` has started, it disarms the hold instead.
+   */
+  completeInitialization(): void;
+  /**
+   * Fails a held `initialize` with an unrecoverable connection error, or arms the next `initialize`
+   * to fail. `initialize` completes promptly with the client not ready and `connectionError` fires.
+   */
+  failInitialization(): void;
+}
+//#endregion
+//#region src/server/testing.d.ts
+/**
+ * Creates a {@link TestClient}: a real server `ConfigDirectorClient` connected to an in-memory
+ * server that the test controls. No network connection is opened and no telemetry is sent. Put it
+ * where `register()` would put the server singleton with {@link installServerTestClient}.
+ *
+ * @param options {@link TestClientOptions}: the initial values, the client's timeout, and its logger
+ * @returns A {@link TestClient} whose `client` is passed to the code under test
+ *
+ * @example
+ * import { createTestClient, installServerTestClient } from "@configdirector/nextjs-sdk/server/testing";
+ *
+ * const testClient = createTestClient({ values: { "new-checkout": true } });
+ * const uninstall = installServerTestClient(testClient);
+ * await testClient.client.initialize();
+ */
+declare const createTestClient: (options?: TestClientOptions) => TestClient;
+/**
+ * Puts `testClient.client` where `register()` puts the server singleton, so `getConfigClient()`,
+ * `generateSsrConfigSet()`, and the server `ConfigDirectorProvider` serve its values. It does not
+ * initialize the client: call `await testClient.client.initialize()`, as `register()` would.
+ *
+ * @param testClient The server test client whose `client` to install
+ * @returns A function that restores the client installed before
+ */
+declare const installServerTestClient: (testClient: TestClient) => (() => void);
+//#endregion
+export { ConfigDirectorConnectionError, ConfigDirectorValidationError, type TestClient, type TestClientOptions, type TestJsonValue, type TestValue, type TestValues, createTestClient, installServerTestClient };
+//# sourceMappingURL=testing.d.mts.map

package/dist/server/testing.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.mts","names":[],"sources":["../../../shared/src/errors.ts","../../../shared/src/testing/values.ts","../../../js-server-sdk/src/testing/TestClient.ts","../../src/server/testing.ts"],"mappings":";;;cAAa,6BAAA,SAAsC,KAAA;EAAA,SACxB,IAAA;EAAA,SACT,MAAA;cAEJ,OAAA,UAAiB,MAAA;AAAA;AAAA,cAQlB,6BAAA,SAAsC,KAAA;EAAA,SACxB,IAAA;cAEb,OAAA;AAAA;;;KCZF,aAAA,sCAAmD,aAAA;EAAA,CAAqB,GAAA,WAAc,aAAA;AAAA;AAAA,KAEtF,SAAA,+BAAwC,aAAA;EAAA,CAAqB,GAAA,WAAc,aAAA;AAAA;AAAA,KAE3E,UAAA,GAAa,MAAA,SAAe,SAAA;;;;ADPxC;;KEYY,iBAAA;EFZ4C;;;;;;EEmBtD,MAAA,GAAS,UAAA;EFfmC;;AAQ9C;;EEYE,OAAA;EFZsD;;;EEgBtD,MAAA,GAAS,oBAAA;AAAA;;;;;;ADzBX;;;UCoCiB,UAAA;EDpC8C;;;;EAAA,SCyCpD,MAAA,EAAQ,oBAAA;EDvCP;;;;EC6CV,QAAA,CAAS,GAAA,UAAa,KAAA,EAAO,SAAA;ED7C0C;;;;ECmDvE,WAAA,CAAY,GAAA;EDjDQ;;;;ECuDpB,aAAA,CAAc,MAAA,EAAQ,UAAA;;;AAlDxB;;EAwDE,kBAAA;EAxC6B;;;;EA8C7B,sBAAA;EA9CS;;;AAWX;EAyCE,kBAAA;AAAA;;;;;;;;;;;;;;AFpEF;;;;cGUa,gBAAA,GAAoB,OAAA,GAAU,iBAAA,KAAoB,UAAA;;;;;;;;;cAYlD,uBAAA,GAA2B,UAAA,EAAY,UAAA"}

package/dist/server/testing.mjs

@@ -0,0 +1,2 @@
+import{r as e,t}from"./DefaultConfigDirectorClient-BhyVJv6Z.mjs";import{r as n,t as r}from"./errors-BGpFuqOO.mjs";import i from"node:events";const a=(e,t)=>{if(e.trim().length==0)throw new n(`Invalid config key. The key of a test value cannot be empty.`);return o(e,t)},o=(e,t)=>{switch(typeof t){case`boolean`:return{type:`boolean`,value:t?`true`:`false`};case`number`:return s(e,t);case`string`:return{type:`string`,value:t};case`object`:if(t!==null)return l(e,t,``),{type:`json`,value:JSON.stringify(t)}}throw new n(`Invalid test value for '${e}': ${f(t)}. Use a boolean, a number, a string, a plain object, or an array.`)},s=(e,t)=>{if(!Number.isFinite(t))throw new n(`Invalid test value for '${e}': ${f(t)} is not a finite number.`);if(Number.isInteger(t)){if(!Number.isSafeInteger(t))throw new n(`Invalid test value for '${e}': ${t} is not a safe integer, so the SDK could not read it back exactly.`);return{type:`integer`,value:String(t)}}return{type:`float`,value:c(t)}},c=e=>{let t=String(e),n=t.indexOf(`e-`);if(n<0)return t;let r=t.startsWith(`-`)?`-`:``,[i=``,a=``]=t.slice(r.length,n).split(`.`),o=Number(t.slice(n+2))-i.length;return`${r}0.${`0`.repeat(o)}${i}${a}`},l=(e,t,n)=>{if(!(t===null||typeof t==`boolean`||typeof t==`string`)){if(typeof t==`number`){if(!Number.isFinite(t))throw u(e,n,`${f(t)} is not a finite number`);return}if(Array.isArray(t)){t.forEach((t,r)=>l(e,t,`${n}[${r}]`));return}if(d(t)){for(let[r,i]of Object.entries(t))l(e,i,n?`${n}.${r}`:r);return}throw u(e,n,`${f(t)} cannot be encoded as JSON`)}},u=(e,t,r)=>new n(`Invalid test value for '${e}'${t?` at '${t}'`:``}: ${r}. JSON contents can hold booleans, finite numbers, strings, null, arrays, and plain objects.`),d=e=>{if(typeof e!=`object`||!e)return!1;let t=Object.getPrototypeOf(e);return t===Object.prototype||t===null},f=e=>e===null?`null`:typeof e==`function`?`a function`:typeof e==`object`?`a ${e.constructor?.name??`object`} instance`:typeof e==`symbol`?`a symbol`:String(e),p=(e,t)=>{let n=a(e,t);return{id:`test-config:${e}`,key:e,type:n.type,variations:[{name:null,value:n.value}],target:{defaultValue:n.value,rules:[]}}},m={environmentId:`test-environment`,projectId:`test-project`};var h=class{constructor(e,t){this.logger=e,this.emitter=new i,this.configs=new Map,this.pendingDeliveries=[],this.armed=`nothing`,this.connected=!1,this.delivering=!1,this.encodeAll(t).forEach((e,t)=>this.configs.set(t,e))}setValue(e,t){let n=p(e,t);this.configs.set(e,n),this.deliverIfConnected({...m,kind:`delta`,configs:{[e]:n}})}removeValue(e){this.configs.delete(e),this.deliverIfConnected(this.fullUpdate())}replaceValues(e){let t=this.encodeAll(e);this.configs.clear(),t.forEach((e,t)=>this.configs.set(t,e)),this.armed=`nothing`,this.deliverIfConnected(this.fullUpdate())}hold(){this.armed=`hold`}complete(){this.pendingHold?this.pendingHold.complete():this.armed===`hold`&&(this.armed=`nothing`)}fail(){this.pendingHold?this.pendingHold.fail():this.armed=`failure`}connect(e){this.endAttempt();let t=this.armed;switch(this.armed=`nothing`,t){case`failure`:return this.failNow();case`hold`:return this.holdNow(e);default:return this.connectNow(),Promise.resolve(this)}}get isConnected(){return this.connected}on(e,t){this.emitter.on(e,t)}off(e,t){t?this.emitter.off(e,t):this.emitter.removeAllListeners(e)}close(){this.endAttempt()}dispose(){this.close(),this.emitter.removeAllListeners()}endAttempt(){this.connected=!1,this.pendingHold?.end()}connectNow(){this.connected=!0,this.deliver(this.fullUpdate())}holdNow(e){return new Promise((t,n)=>{let r=setTimeout(()=>this.pendingHold?.end(),e),i=()=>{clearTimeout(r),this.pendingHold=void 0};this.pendingHold={end:()=>{i(),t(this)},complete:()=>{i(),this.connectNow(),t(this)},fail:()=>{i();let e=this.fatalError();this.emitter.emit(`connectionError`,e),n(e)}}})}failNow(){let e=this.fatalError();return this.emitter.emit(`connectionError`,e),Promise.reject(e)}fatalError(){return new r(`Connection failed with status: 401. Error: the test client failed this initialization. This is an unrecoverable error, will not attempt to reconnect.`,401)}deliverIfConnected(e){this.connected&&this.deliver(e)}deliver(e){if(this.pendingDeliveries.push(e),!this.delivering){this.delivering=!0;try{let e=this.pendingDeliveries.shift();for(;e;)this.emitCaught(e),e=this.pendingDeliveries.shift()}finally{this.delivering=!1}}}emitCaught(e){try{this.emitter.emit(`configBundleReceived`,e)}catch(e){this.logger.error(`[InMemoryConnection] Error dispatching a config update from the test client: `,e)}}fullUpdate(){return{...m,kind:`full`,configs:Object.fromEntries(this.configs)}}encodeAll(e){let t=new Map;for(let[n,r]of Object.entries(e))t.set(n,p(n,r));return t}};const g={start:()=>{},evaluatedConfig:()=>{},close:async()=>{}};var _=class{constructor(e,t){this.client=e,this.connection=t}setValue(e,t){this.connection.setValue(e,t)}removeValue(e){this.connection.removeValue(e)}replaceValues(e){this.connection.replaceValues(e)}holdInitialization(){this.connection.hold()}completeInitialization(){this.connection.complete()}failInitialization(){this.connection.fail()}};const v=(n,r)=>{let i=r?.logger??e(),a=new h(i,r?.values??{});return new _(new t(`test-client`,n,{logger:i,connection:{timeout:r?.timeout}},{transport:a,telemetry:g}),a)},y=e=>v({sdkName:`nextjs-sdk`,sdkVersion:`1.8.0`},e),b=e=>{let t=globalThis.__configDirectorServerClient;return globalThis.__configDirectorServerClient=e.client,()=>{globalThis.__configDirectorServerClient=t}};export{r as ConfigDirectorConnectionError,n as ConfigDirectorValidationError,y as createTestClient,b as installServerTestClient};
+//# sourceMappingURL=testing.mjs.map

package/dist/server/testing.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.mjs","names":["encodeTestValue","encodeShared","createTestClient"],"sources":["../../../shared/src/testing/values.ts","../../../js-server-sdk/src/testing/values.ts","../../../js-server-sdk/src/testing/InMemoryConnection.ts","../../../js-server-sdk/src/testing/TestClient.ts","../../src/server/testing.ts"],"sourcesContent":["import type { ConfigType } from \"../types\";\nimport { ConfigDirectorValidationError } from \"../errors\";\n\nexport type TestJsonValue = boolean | number | string | null | TestJsonValue[] | { [key: string]: TestJsonValue };\n\nexport type TestValue = boolean | number | string | TestJsonValue[] | { [key: string]: TestJsonValue };\n\nexport type TestValues = Record<string, TestValue>;\n\nexport type EncodedTestValue = { type: ConfigType; value: string };\n\nexport const encodeTestValue = (key: string, value: TestValue): EncodedTestValue => {\n  if (key.trim().length == 0) {\n    throw new ConfigDirectorValidationError(\"Invalid config key. The key of a test value cannot be empty.\");\n  }\n  return encode(key, value);\n};\n\nconst encode = (key: string, value: TestValue): EncodedTestValue => {\n  switch (typeof value) {\n    case \"boolean\":\n      return { type: \"boolean\", value: value ? \"true\" : \"false\" };\n    case \"number\":\n      return encodeNumber(key, value);\n    case \"string\":\n      return { type: \"string\", value };\n    case \"object\":\n      if (value !== null) {\n        assertJsonContents(key, value, \"\");\n        return { type: \"json\", value: JSON.stringify(value) };\n      }\n  }\n  throw new ConfigDirectorValidationError(\n    `Invalid test value for '${key}': ${describe(value)}. Use a boolean, a number, a string, a plain object, or an array.`,\n  );\n};\n\nconst encodeNumber = (key: string, value: number): EncodedTestValue => {\n  if (!Number.isFinite(value)) {\n    throw new ConfigDirectorValidationError(`Invalid test value for '${key}': ${describe(value)} is not a finite number.`);\n  }\n  if (Number.isInteger(value)) {\n    if (!Number.isSafeInteger(value)) {\n      throw new ConfigDirectorValidationError(\n        `Invalid test value for '${key}': ${value} is not a safe integer, so the SDK could not read it back exactly.`,\n      );\n    }\n    return { type: \"integer\", value: String(value) };\n  }\n  return { type: \"float\", value: toPlainDecimal(value) };\n};\n\nconst toPlainDecimal = (value: number): string => {\n  const text = String(value);\n  const exponentIndex = text.indexOf(\"e-\");\n  if (exponentIndex < 0) {\n    return text;\n  }\n  const sign = text.startsWith(\"-\") ? \"-\" : \"\";\n  const [integerDigits = \"\", fractionDigits = \"\"] = text.slice(sign.length, exponentIndex).split(\".\");\n  const leadingZeros = Number(text.slice(exponentIndex + 2)) - integerDigits.length;\n  return `${sign}0.${\"0\".repeat(leadingZeros)}${integerDigits}${fractionDigits}`;\n};\n\nconst assertJsonContents = (key: string, value: unknown, path: string): void => {\n  if (value === null || typeof value === \"boolean\" || typeof value === \"string\") {\n    return;\n  }\n  if (typeof value === \"number\") {\n    if (!Number.isFinite(value)) {\n      throw invalidJsonContents(key, path, `${describe(value)} is not a finite number`);\n    }\n    return;\n  }\n  if (Array.isArray(value)) {\n    value.forEach((item, index) => assertJsonContents(key, item, `${path}[${index}]`));\n    return;\n  }\n  if (isPlainObject(value)) {\n    for (const [property, item] of Object.entries(value)) {\n      assertJsonContents(key, item, path ? `${path}.${property}` : property);\n    }\n    return;\n  }\n  throw invalidJsonContents(key, path, `${describe(value)} cannot be encoded as JSON`);\n};\n\nconst invalidJsonContents = (key: string, path: string, problem: string) =>\n  new ConfigDirectorValidationError(\n    `Invalid test value for '${key}'${path ? ` at '${path}'` : \"\"}: ${problem}. JSON contents can hold booleans, finite numbers, strings, null, arrays, and plain objects.`,\n  );\n\nconst isPlainObject = (value: unknown): value is Record<string, unknown> => {\n  if (typeof value !== \"object\" || value === null) {\n    return false;\n  }\n  const prototype = Object.getPrototypeOf(value);\n  return prototype === Object.prototype || prototype === null;\n};\n\nconst describe = (value: unknown): string => {\n  if (value === null) {\n    return \"null\";\n  }\n  if (typeof value === \"function\") {\n    return \"a function\";\n  }\n  if (typeof value === \"object\") {\n    return `a ${value.constructor?.name ?? \"object\"} instance`;\n  }\n  if (typeof value === \"symbol\") {\n    return \"a symbol\";\n  }\n  return String(value);\n};\n","import type { ConfigDefinition } from \"../types\";\nimport { encodeTestValue as encodeShared } from \"@shared/testing/values\";\nimport type { TestValue } from \"@shared/testing/values\";\n\nexport type { TestJsonValue, TestValue, TestValues } from \"@shared/testing/values\";\n\nexport const encodeTestValue = (key: string, value: TestValue): ConfigDefinition => {\n  const encoded = encodeShared(key, value);\n  return {\n    id: `test-config:${key}`,\n    key,\n    type: encoded.type,\n    variations: [{ name: null, value: encoded.value }],\n    target: { defaultValue: encoded.value, rules: [] },\n  };\n};\n","import EventEmitter from \"node:events\";\nimport type { ConfigBundle, ConfigDefinition, ConfigDirectorLogger, Transport, TransportEvents } from \"../types\";\nimport { ConfigDirectorConnectionError } from \"@shared/errors\";\nimport { encodeTestValue, type TestValue, type TestValues } from \"./values\";\n\ntype Armed = \"nothing\" | \"hold\" | \"failure\";\n\ntype PendingHold = {\n  end: () => void;\n  complete: () => void;\n  fail: () => void;\n};\n\nconst TEST_ENVIRONMENT = { environmentId: \"test-environment\", projectId: \"test-project\" };\n\nexport class InMemoryConnection implements Transport {\n  private readonly emitter = new EventEmitter();\n  private readonly configs = new Map<string, ConfigDefinition>();\n  private readonly pendingDeliveries: ConfigBundle[] = [];\n  private armed: Armed = \"nothing\";\n  private pendingHold: PendingHold | undefined;\n  private connected = false;\n  private delivering = false;\n\n  constructor(\n    private readonly logger: ConfigDirectorLogger,\n    values: TestValues,\n  ) {\n    this.encodeAll(values).forEach((definition, key) => this.configs.set(key, definition));\n  }\n\n  public setValue(key: string, value: TestValue) {\n    const definition = encodeTestValue(key, value);\n    this.configs.set(key, definition);\n    this.deliverIfConnected({ ...TEST_ENVIRONMENT, kind: \"delta\", configs: { [key]: definition } });\n  }\n\n  public removeValue(key: string) {\n    this.configs.delete(key);\n    this.deliverIfConnected(this.fullUpdate());\n  }\n\n  public replaceValues(values: TestValues) {\n    const encoded = this.encodeAll(values);\n    this.configs.clear();\n    encoded.forEach((definition, key) => this.configs.set(key, definition));\n    this.armed = \"nothing\";\n    this.deliverIfConnected(this.fullUpdate());\n  }\n\n  public hold() {\n    this.armed = \"hold\";\n  }\n\n  public complete() {\n    if (this.pendingHold) {\n      this.pendingHold.complete();\n    } else if (this.armed === \"hold\") {\n      this.armed = \"nothing\";\n    }\n  }\n\n  public fail() {\n    if (this.pendingHold) {\n      this.pendingHold.fail();\n    } else {\n      this.armed = \"failure\";\n    }\n  }\n\n  public connect(timeout: number): Promise<this> {\n    this.endAttempt();\n    const armed = this.armed;\n    this.armed = \"nothing\";\n    switch (armed) {\n      case \"failure\":\n        return this.failNow();\n      case \"hold\":\n        return this.holdNow(timeout);\n      default:\n        this.connectNow();\n        return Promise.resolve(this);\n    }\n  }\n\n  public get isConnected(): boolean {\n    return this.connected;\n  }\n\n  public on<TName extends keyof TransportEvents>(name: TName, handler: (payload: TransportEvents[TName]) => void) {\n    this.emitter.on(name, handler);\n  }\n\n  public off<TName extends keyof TransportEvents>(name: TName, handler?: (payload: TransportEvents[TName]) => void) {\n    if (handler) {\n      this.emitter.off(name, handler);\n    } else {\n      this.emitter.removeAllListeners(name);\n    }\n  }\n\n  public close() {\n    this.endAttempt();\n  }\n\n  public dispose() {\n    this.close();\n    this.emitter.removeAllListeners();\n  }\n\n  private endAttempt() {\n    this.connected = false;\n    this.pendingHold?.end();\n  }\n\n  private connectNow() {\n    this.connected = true;\n    this.deliver(this.fullUpdate());\n  }\n\n  private holdNow(timeout: number): Promise<this> {\n    return new Promise<this>((resolve, reject) => {\n      const timer = setTimeout(() => this.pendingHold?.end(), timeout);\n      const release = () => {\n        clearTimeout(timer);\n        this.pendingHold = undefined;\n      };\n      this.pendingHold = {\n        end: () => {\n          release();\n          resolve(this);\n        },\n        complete: () => {\n          release();\n          this.connectNow();\n          resolve(this);\n        },\n        fail: () => {\n          release();\n          const error = this.fatalError();\n          this.emitter.emit(\"connectionError\", error);\n          reject(error);\n        },\n      };\n    });\n  }\n\n  private failNow(): Promise<this> {\n    const error = this.fatalError();\n    this.emitter.emit(\"connectionError\", error);\n    return Promise.reject(error);\n  }\n\n  private fatalError() {\n    return new ConfigDirectorConnectionError(\n      \"Connection failed with status: 401. Error: the test client failed this initialization. This is an unrecoverable error, will not attempt to reconnect.\",\n      401,\n    );\n  }\n\n  private deliverIfConnected(configBundle: ConfigBundle) {\n    if (this.connected) {\n      this.deliver(configBundle);\n    }\n  }\n\n  private deliver(configBundle: ConfigBundle) {\n    this.pendingDeliveries.push(configBundle);\n    if (this.delivering) {\n      return;\n    }\n    this.delivering = true;\n    try {\n      let next = this.pendingDeliveries.shift();\n      while (next) {\n        this.emitCaught(next);\n        next = this.pendingDeliveries.shift();\n      }\n    } finally {\n      this.delivering = false;\n    }\n  }\n\n  private emitCaught(configBundle: ConfigBundle) {\n    try {\n      this.emitter.emit(\"configBundleReceived\", configBundle);\n    } catch (error) {\n      this.logger.error(\"[InMemoryConnection] Error dispatching a config update from the test client: \", error);\n    }\n  }\n\n  private fullUpdate(): ConfigBundle {\n    return { ...TEST_ENVIRONMENT, kind: \"full\", configs: Object.fromEntries(this.configs) };\n  }\n\n  private encodeAll(values: TestValues): Map<string, ConfigDefinition> {\n    const encoded = new Map<string, ConfigDefinition>();\n    for (const [key, value] of Object.entries(values)) {\n      encoded.set(key, encodeTestValue(key, value));\n    }\n    return encoded;\n  }\n}\n","import { DefaultConfigDirectorClient } from \"../DefaultConfigDirectorClient\";\nimport { createDefaultLogger } from \"../logger\";\nimport type { ConfigDirectorClient, ConfigDirectorLogger, IdentifyingSdkOptions } from \"../types\";\nimport type { ServerTelemetryClient } from \"../telemetry\";\nimport { InMemoryConnection } from \"./InMemoryConnection\";\nimport type { TestValue, TestValues } from \"./values\";\n\nconst TEST_CLIENT_SDK_KEY = \"test-client\";\n\n/**\n * Options for {@link createTestClient}. Every option is optional.\n */\nexport type TestClientOptions = {\n  /**\n   * The config values the test client serves once its client connects, keyed by config key. The\n   * config type follows from each value: a boolean, an integral number (`integer`), any other\n   * number (`float`), a string, or a plain object or array (`json`). Every context receives the\n   * same value.\n   */\n  values?: TestValues;\n  /**\n   * The connection timeout of the SDK client, in milliseconds. It bounds how long a held\n   * `initialize` waits. Defaults to the SDK's production timeout.\n   */\n  timeout?: number;\n  /**\n   * The logger the SDK client uses. Defaults to the SDK's console logger at `warn` level.\n   */\n  logger?: ConfigDirectorLogger;\n};\n\n/**\n * A real ConfigDirector client connected to an in-memory server that the test controls.\n *\n * The client under {@link TestClient.client} is the SDK's production client: value parsing,\n * targeting evaluation, watchers, events, and readiness behave as they do against ConfigDirector.\n * Only the network connection and telemetry are replaced, so no request is ever made and nothing\n * is left running after the client is disposed.\n */\nexport interface TestClient {\n  /**\n   * The SDK client to hand to the code under test. It starts uninitialized, like a production\n   * client; `initialize` completes at once with the seeded values unless initialization is held.\n   */\n  readonly client: ConfigDirectorClient;\n\n  /**\n   * Stores `value` under `key` and, when the client is connected, delivers it as an update, so\n   * reads, watchers, and `configsUpdated` handlers see it.\n   */\n  setValue(key: string, value: TestValue): void;\n\n  /**\n   * Removes `key` and, when the client is connected, delivers a full update without it, so reads\n   * fall back to the in-code default value and watchers of `key` receive that default.\n   */\n  removeValue(key: string): void;\n\n  /**\n   * Replaces every stored value with `values`, disarms any armed hold or failure, and, when the\n   * client is connected, delivers the new values as a full update.\n   */\n  replaceValues(values: TestValues): void;\n\n  /**\n   * Makes the next `initialize` wait until {@link completeInitialization} or\n   * {@link failInitialization} is called, or until the client's timeout elapses.\n   */\n  holdInitialization(): void;\n\n  /**\n   * Delivers the stored values to a held `initialize`, so it completes with the client ready. When\n   * a hold is armed but no `initialize` has started, it disarms the hold instead.\n   */\n  completeInitialization(): void;\n\n  /**\n   * Fails a held `initialize` with an unrecoverable connection error, or arms the next `initialize`\n   * to fail. `initialize` completes promptly with the client not ready and `connectionError` fires.\n   */\n  failInitialization(): void;\n}\n\nconst noopTelemetryClient: ServerTelemetryClient = {\n  start: () => {},\n  evaluatedConfig: () => {},\n  close: async () => {},\n};\n\nclass InMemoryTestClient implements TestClient {\n  constructor(\n    public readonly client: ConfigDirectorClient,\n    private readonly connection: InMemoryConnection,\n  ) {}\n\n  public setValue(key: string, value: TestValue) {\n    this.connection.setValue(key, value);\n  }\n\n  public removeValue(key: string) {\n    this.connection.removeValue(key);\n  }\n\n  public replaceValues(values: TestValues) {\n    this.connection.replaceValues(values);\n  }\n\n  public holdInitialization() {\n    this.connection.hold();\n  }\n\n  public completeInitialization() {\n    this.connection.complete();\n  }\n\n  public failInitialization() {\n    this.connection.fail();\n  }\n}\n\nexport const createTestClient = (sdkOptions: IdentifyingSdkOptions, options?: TestClientOptions): TestClient => {\n  const logger = options?.logger ?? createDefaultLogger();\n  const connection = new InMemoryConnection(logger, options?.values ?? {});\n  const client = new DefaultConfigDirectorClient(\n    TEST_CLIENT_SDK_KEY,\n    sdkOptions,\n    { logger, connection: { timeout: options?.timeout } },\n    { transport: connection, telemetry: noopTelemetryClient },\n  );\n  return new InMemoryTestClient(client, connection);\n};\n","import { createTestClient as createServerTestClient } from \"@js-server-sdk/testing/TestClient\";\nimport type { TestClient, TestClientOptions } from \"@js-server-sdk/testing/TestClient\";\n\nexport type { TestClient, TestClientOptions } from \"@js-server-sdk/testing/TestClient\";\nexport type { TestValue, TestValues, TestJsonValue } from \"@js-server-sdk/testing/values\";\nexport { ConfigDirectorConnectionError, ConfigDirectorValidationError } from \"@shared/errors\";\n\n/**\n * Creates a {@link TestClient}: a real server `ConfigDirectorClient` connected to an in-memory\n * server that the test controls. No network connection is opened and no telemetry is sent. Put it\n * where `register()` would put the server singleton with {@link installServerTestClient}.\n *\n * @param options {@link TestClientOptions}: the initial values, the client's timeout, and its logger\n * @returns A {@link TestClient} whose `client` is passed to the code under test\n *\n * @example\n * import { createTestClient, installServerTestClient } from \"@configdirector/nextjs-sdk/server/testing\";\n *\n * const testClient = createTestClient({ values: { \"new-checkout\": true } });\n * const uninstall = installServerTestClient(testClient);\n * await testClient.client.initialize();\n */\nexport const createTestClient = (options?: TestClientOptions): TestClient => {\n  return createServerTestClient({ sdkName: \"nextjs-sdk\", sdkVersion: \"__VERSION__\" }, options);\n};\n\n/**\n * Puts `testClient.client` where `register()` puts the server singleton, so `getConfigClient()`,\n * `generateSsrConfigSet()`, and the server `ConfigDirectorProvider` serve its values. It does not\n * initialize the client: call `await testClient.client.initialize()`, as `register()` would.\n *\n * @param testClient The server test client whose `client` to install\n * @returns A function that restores the client installed before\n */\nexport const installServerTestClient = (testClient: TestClient): (() => void) => {\n  const previous = globalThis.__configDirectorServerClient;\n  globalThis.__configDirectorServerClient = testClient.client;\n  return () => {\n    globalThis.__configDirectorServerClient = previous;\n  };\n};\n"],"mappings":"6IAWA,MAAaA,GAAmB,EAAa,IAAuC,CAClF,GAAI,EAAI,MAAM,CAAC,QAAU,EACvB,MAAM,IAAI,EAA8B,+DAA+D,CAEzG,OAAO,EAAO,EAAK,EAAM,EAGrB,GAAU,EAAa,IAAuC,CAClE,OAAQ,OAAO,EAAf,CACE,IAAK,UACH,MAAO,CAAE,KAAM,UAAW,MAAO,EAAQ,OAAS,QAAS,CAC7D,IAAK,SACH,OAAO,EAAa,EAAK,EAAM,CACjC,IAAK,SACH,MAAO,CAAE,KAAM,SAAU,QAAO,CAClC,IAAK,SACH,GAAI,IAAU,KAEZ,OADA,EAAmB,EAAK,EAAO,GAAG,CAC3B,CAAE,KAAM,OAAQ,MAAO,KAAK,UAAU,EAAM,CAAE,CAG3D,MAAM,IAAI,EACR,2BAA2B,EAAI,KAAK,EAAS,EAAM,CAAC,mEACrD,EAGG,GAAgB,EAAa,IAAoC,CACrE,GAAI,CAAC,OAAO,SAAS,EAAM,CACzB,MAAM,IAAI,EAA8B,2BAA2B,EAAI,KAAK,EAAS,EAAM,CAAC,0BAA0B,CAExH,GAAI,OAAO,UAAU,EAAM,CAAE,CAC3B,GAAI,CAAC,OAAO,cAAc,EAAM,CAC9B,MAAM,IAAI,EACR,2BAA2B,EAAI,KAAK,EAAM,oEAC3C,CAEH,MAAO,CAAE,KAAM,UAAW,MAAO,OAAO,EAAM,CAAE,CAElD,MAAO,CAAE,KAAM,QAAS,MAAO,EAAe,EAAM,CAAE,EAGlD,EAAkB,GAA0B,CAChD,IAAM,EAAO,OAAO,EAAM,CACpB,EAAgB,EAAK,QAAQ,KAAK,CACxC,GAAI,EAAgB,EAClB,OAAO,EAET,IAAM,EAAO,EAAK,WAAW,IAAI,CAAG,IAAM,GACpC,CAAC,EAAgB,GAAI,EAAiB,IAAM,EAAK,MAAM,EAAK,OAAQ,EAAc,CAAC,MAAM,IAAI,CAC7F,EAAe,OAAO,EAAK,MAAM,EAAgB,EAAE,CAAC,CAAG,EAAc,OAC3E,MAAO,GAAG,EAAK,IAAI,IAAI,OAAO,EAAa,GAAG,IAAgB,KAG1D,GAAsB,EAAa,EAAgB,IAAuB,CAC1E,SAAU,MAAQ,OAAO,GAAU,WAAa,OAAO,GAAU,UAGrE,IAAI,OAAO,GAAU,SAAU,CAC7B,GAAI,CAAC,OAAO,SAAS,EAAM,CACzB,MAAM,EAAoB,EAAK,EAAM,GAAG,EAAS,EAAM,CAAC,yBAAyB,CAEnF,OAEF,GAAI,MAAM,QAAQ,EAAM,CAAE,CACxB,EAAM,SAAS,EAAM,IAAU,EAAmB,EAAK,EAAM,GAAG,EAAK,GAAG,EAAM,GAAG,CAAC,CAClF,OAEF,GAAI,EAAc,EAAM,CAAE,CACxB,IAAK,GAAM,CAAC,EAAU,KAAS,OAAO,QAAQ,EAAM,CAClD,EAAmB,EAAK,EAAM,EAAO,GAAG,EAAK,GAAG,IAAa,EAAS,CAExE,OAEF,MAAM,EAAoB,EAAK,EAAM,GAAG,EAAS,EAAM,CAAC,4BAA4B,GAGhF,GAAuB,EAAa,EAAc,IACtD,IAAI,EACF,2BAA2B,EAAI,GAAG,EAAO,QAAQ,EAAK,GAAK,GAAG,IAAI,EAAQ,8FAC3E,CAEG,EAAiB,GAAqD,CAC1E,GAAI,OAAO,GAAU,WAAY,EAC/B,MAAO,GAET,IAAM,EAAY,OAAO,eAAe,EAAM,CAC9C,OAAO,IAAc,OAAO,WAAa,IAAc,MAGnD,EAAY,GACZ,IAAU,KACL,OAEL,OAAO,GAAU,WACZ,aAEL,OAAO,GAAU,SACZ,KAAK,EAAM,aAAa,MAAQ,SAAS,WAE9C,OAAO,GAAU,SACZ,WAEF,OAAO,EAAM,CC3GT,GAAmB,EAAa,IAAuC,CAClF,IAAM,EAAUC,EAAa,EAAK,EAAM,CACxC,MAAO,CACL,GAAI,eAAe,IACnB,MACA,KAAM,EAAQ,KACd,WAAY,CAAC,CAAE,KAAM,KAAM,MAAO,EAAQ,MAAO,CAAC,CAClD,OAAQ,CAAE,aAAc,EAAQ,MAAO,MAAO,EAAE,CAAE,CACnD,ECDG,EAAmB,CAAE,cAAe,mBAAoB,UAAW,eAAgB,CAEzF,IAAa,EAAb,KAAqD,CASnD,YACE,EACA,EACA,CAFiB,KAAA,OAAA,EATnB,KAAiB,QAAU,IAAI,EAC/B,KAAiB,QAAU,IAAI,IAC/B,KAAiB,kBAAoC,EAAE,CACvD,KAAQ,MAAe,UAEvB,KAAQ,UAAY,GACpB,KAAQ,WAAa,GAMnB,KAAK,UAAU,EAAO,CAAC,SAAS,EAAY,IAAQ,KAAK,QAAQ,IAAI,EAAK,EAAW,CAAC,CAGxF,SAAgB,EAAa,EAAkB,CAC7C,IAAM,EAAa,EAAgB,EAAK,EAAM,CAC9C,KAAK,QAAQ,IAAI,EAAK,EAAW,CACjC,KAAK,mBAAmB,CAAE,GAAG,EAAkB,KAAM,QAAS,QAAS,EAAG,GAAM,EAAY,CAAE,CAAC,CAGjG,YAAmB,EAAa,CAC9B,KAAK,QAAQ,OAAO,EAAI,CACxB,KAAK,mBAAmB,KAAK,YAAY,CAAC,CAG5C,cAAqB,EAAoB,CACvC,IAAM,EAAU,KAAK,UAAU,EAAO,CACtC,KAAK,QAAQ,OAAO,CACpB,EAAQ,SAAS,EAAY,IAAQ,KAAK,QAAQ,IAAI,EAAK,EAAW,CAAC,CACvE,KAAK,MAAQ,UACb,KAAK,mBAAmB,KAAK,YAAY,CAAC,CAG5C,MAAc,CACZ,KAAK,MAAQ,OAGf,UAAkB,CACZ,KAAK,YACP,KAAK,YAAY,UAAU,CAClB,KAAK,QAAU,SACxB,KAAK,MAAQ,WAIjB,MAAc,CACR,KAAK,YACP,KAAK,YAAY,MAAM,CAEvB,KAAK,MAAQ,UAIjB,QAAe,EAAgC,CAC7C,KAAK,YAAY,CACjB,IAAM,EAAQ,KAAK,MAEnB,OADA,KAAK,MAAQ,UACL,EAAR,CACE,IAAK,UACH,OAAO,KAAK,SAAS,CACvB,IAAK,OACH,OAAO,KAAK,QAAQ,EAAQ,CAC9B,QAEE,OADA,KAAK,YAAY,CACV,QAAQ,QAAQ,KAAK,EAIlC,IAAW,aAAuB,CAChC,OAAO,KAAK,UAGd,GAA+C,EAAa,EAAoD,CAC9G,KAAK,QAAQ,GAAG,EAAM,EAAQ,CAGhC,IAAgD,EAAa,EAAqD,CAC5G,EACF,KAAK,QAAQ,IAAI,EAAM,EAAQ,CAE/B,KAAK,QAAQ,mBAAmB,EAAK,CAIzC,OAAe,CACb,KAAK,YAAY,CAGnB,SAAiB,CACf,KAAK,OAAO,CACZ,KAAK,QAAQ,oBAAoB,CAGnC,YAAqB,CACnB,KAAK,UAAY,GACjB,KAAK,aAAa,KAAK,CAGzB,YAAqB,CACnB,KAAK,UAAY,GACjB,KAAK,QAAQ,KAAK,YAAY,CAAC,CAGjC,QAAgB,EAAgC,CAC9C,OAAO,IAAI,SAAe,EAAS,IAAW,CAC5C,IAAM,EAAQ,eAAiB,KAAK,aAAa,KAAK,CAAE,EAAQ,CAC1D,MAAgB,CACpB,aAAa,EAAM,CACnB,KAAK,YAAc,IAAA,IAErB,KAAK,YAAc,CACjB,QAAW,CACT,GAAS,CACT,EAAQ,KAAK,EAEf,aAAgB,CACd,GAAS,CACT,KAAK,YAAY,CACjB,EAAQ,KAAK,EAEf,SAAY,CACV,GAAS,CACT,IAAM,EAAQ,KAAK,YAAY,CAC/B,KAAK,QAAQ,KAAK,kBAAmB,EAAM,CAC3C,EAAO,EAAM,EAEhB,EACD,CAGJ,SAAiC,CAC/B,IAAM,EAAQ,KAAK,YAAY,CAE/B,OADA,KAAK,QAAQ,KAAK,kBAAmB,EAAM,CACpC,QAAQ,OAAO,EAAM,CAG9B,YAAqB,CACnB,OAAO,IAAI,EACT,wJACA,IACD,CAGH,mBAA2B,EAA4B,CACjD,KAAK,WACP,KAAK,QAAQ,EAAa,CAI9B,QAAgB,EAA4B,CAC1C,QAAK,kBAAkB,KAAK,EAAa,CACrC,MAAK,WAGT,MAAK,WAAa,GAClB,GAAI,CACF,IAAI,EAAO,KAAK,kBAAkB,OAAO,CACzC,KAAO,GACL,KAAK,WAAW,EAAK,CACrB,EAAO,KAAK,kBAAkB,OAAO,QAE/B,CACR,KAAK,WAAa,KAItB,WAAmB,EAA4B,CAC7C,GAAI,CACF,KAAK,QAAQ,KAAK,uBAAwB,EAAa,OAChD,EAAO,CACd,KAAK,OAAO,MAAM,gFAAiF,EAAM,EAI7G,YAAmC,CACjC,MAAO,CAAE,GAAG,EAAkB,KAAM,OAAQ,QAAS,OAAO,YAAY,KAAK,QAAQ,CAAE,CAGzF,UAAkB,EAAmD,CACnE,IAAM,EAAU,IAAI,IACpB,IAAK,GAAM,CAAC,EAAK,KAAU,OAAO,QAAQ,EAAO,CAC/C,EAAQ,IAAI,EAAK,EAAgB,EAAK,EAAM,CAAC,CAE/C,OAAO,ICjMX,MA4EM,EAA6C,CACjD,UAAa,GACb,oBAAuB,GACvB,MAAO,SAAY,GACpB,CAED,IAAM,EAAN,KAA+C,CAC7C,YACE,EACA,EACA,CAFgB,KAAA,OAAA,EACC,KAAA,WAAA,EAGnB,SAAgB,EAAa,EAAkB,CAC7C,KAAK,WAAW,SAAS,EAAK,EAAM,CAGtC,YAAmB,EAAa,CAC9B,KAAK,WAAW,YAAY,EAAI,CAGlC,cAAqB,EAAoB,CACvC,KAAK,WAAW,cAAc,EAAO,CAGvC,oBAA4B,CAC1B,KAAK,WAAW,MAAM,CAGxB,wBAAgC,CAC9B,KAAK,WAAW,UAAU,CAG5B,oBAA4B,CAC1B,KAAK,WAAW,MAAM,GAI1B,MAAaC,GAAoB,EAAmC,IAA4C,CAC9G,IAAM,EAAS,GAAS,QAAU,GAAqB,CACjD,EAAa,IAAI,EAAmB,EAAQ,GAAS,QAAU,EAAE,CAAC,CAOxE,OAAO,IAAI,EANI,IAAI,EACjB,cACA,EACA,CAAE,SAAQ,WAAY,CAAE,QAAS,GAAS,QAAS,CAAE,CACrD,CAAE,UAAW,EAAY,UAAW,EAAqB,CAC1D,CACqC,EAAW,EC3GtC,EAAoB,GACxB,EAAuB,CAAE,QAAS,aAAc,WAAY,QAAe,CAAE,EAAQ,CAWjF,EAA2B,GAAyC,CAC/E,IAAM,EAAW,WAAW,6BAE5B,MADA,YAAW,6BAA+B,EAAW,WACxC,CACX,WAAW,6BAA+B"}

package/dist/server/types-DnzM2ukj.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 ../js-server-sdk/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, ConfigEvaluation as c, ConnectionMode as d, ConfigDirectorLogMessageDecorator as i, ConfigState as l, ConfigDirectorClientOptions as n, ConfigDirectorLoggingLevel as o, ConfigDirectorContext as r, ConfigDirectorMetaContext as s, ConfigDirectorClient as t, ConfigValueType as u };
+//# sourceMappingURL=types-DnzM2ukj.d.cts.map

package/dist/server/types-DnzM2ukj.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-DnzM2ukj.d.cts","names":[],"sources":["../../../shared/src/types.ts","../../../js-server-sdk/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"}