@configdirector/openfeature-server-provider 1.10.0 → 1.11.0

package/dist/configdirector-openfeature-server-provider.d.cts

@@ -89,9 +89,90 @@ type ConfigDirectorMetaContext = {
   appVersion?: string;
   appName?: string;
 };
-type ConnectionMode = "streaming" | "polling";
+type ConnectionMode = "streaming" | "polling" | "offline";
+//#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-server-sdk/src/types.d.ts
+/**
+ * One value an offline client serves for a config key. The config type follows from the value: a
+ * boolean, an integral number (`integer`), any other number (`float`), a string, or a plain object
+ * or array (`json`).
+ */
+type OfflineValue = NativeValue;
+/**
+ * The values an offline client serves, keyed by config key. See {@link OfflineValue} for how each
+ * value's config type is decided. Every context receives the same value.
+ */
+type OfflineValues = NativeValues;
+/**
+ * Connection options of the {@link ConfigDirectorClient}
+ */
+type ConnectionOptions = {
+  /**
+   * The connection mode to be used, one of `streaming` (default), `polling` or `offline`.
+   * 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`.
+   * When set to `offline`, the client never connects to ConfigDirector and sends nothing: it serves
+   * the values read from {@link file} or given in {@link values} to every context, or the in-code
+   * default values when neither is given. No SDK key is needed.
+   *
+   * Defaults to `streaming`
+   */
+  mode?: ConnectionMode;
+  /**
+   * The path of a JSON file holding the values to serve in `offline` mode, resolved against the
+   * process working directory. The file holds one object with a value per config key, such as
+   * `{ "new-checkout": true, "max-items": 20 }`; see {@link OfflineValue} for how the config type
+   * of each value is decided. A file that is missing, unreadable, not a JSON object, or holding a
+   * value such as `null` makes `initialize` reject with a `ConfigDirectorInitializationError`.
+   *
+   * Only one of `file` and `values` can be given, and only in `offline` mode; otherwise
+   * `initialize` rejects.
+   */
+  file?: string;
+  /**
+   * The values to serve in `offline` mode, keyed by config key. A value such as `null` makes
+   * `initialize` reject with a `ConfigDirectorInitializationError`.
+   *
+   * Only one of `file` and `values` can be given, and only in `offline` mode; otherwise
+   * `initialize` rejects.
+   */
+  values?: OfflineValues;
+  /**
+   * The polling interval in _seconds_ when the `mode` is set to `polling`. This option has no
+   * effect in the other modes.
+   *
+   * 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. This option has
+   * no effect in `offline` mode.
+   *
+   * 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. This option has no effect in `offline` mode.
+   */
+  url?: string;
+};
 /**
  * Configuration options for the {@link ConfigDirectorClient}
  */
@@ -103,41 +184,7 @@ type ConfigDirectorClientOptions = {
   /**
    * 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;
-  };
+  connection?: ConnectionOptions;
   /**
    * A logger that implements {@link ConfigDirectorLogger}. It defaults to the ConfigDirector console
    * logger set to 'warn' level.
@@ -197,6 +244,14 @@ type ConfigDirectorClientOptions = {
    */
   hooks?: ClientHooks;
 };
+/**
+ * The options of a client created without an SDK key: the connection mode is `offline`.
+ */
+type OfflineClientOptions = ConfigDirectorClientOptions & {
+  connection: ConnectionOptions & {
+    mode: "offline";
+  };
+};
 type ClientEvents = {
   configsUpdated: {
     keys: string[];
@@ -303,6 +358,12 @@ interface ConfigDirectorClient {
   dispose(): void;
 }
 //#endregion
+//#region ../shared/src/errors.d.ts
+declare class ConfigDirectorInitializationError extends Error {
+  readonly name: string;
+  constructor(message: string);
+}
+//#endregion
 //#region src/ConfigDirectorProvider.d.ts
 declare class ConfigDirectorProvider implements Provider {
   private readonly client;
@@ -310,7 +371,15 @@ declare class ConfigDirectorProvider implements Provider {
   readonly metadata: ProviderMetadata;
   readonly runsOn: Paradigm;
   readonly events: OpenFeatureEventEmitter;
-  constructor(clientSdkKey: string, clientOptions?: ConfigDirectorClientOptions);
+  /**
+   * Creates a provider connected to ConfigDirector with the given server SDK key.
+   */
+  constructor(serverSdkKey: string, clientOptions?: ConfigDirectorClientOptions);
+  /**
+   * Creates a provider in `offline` mode, which needs no server SDK key: it never connects to
+   * ConfigDirector and serves `connection.file` or `connection.values` to every evaluation.
+   */
+  constructor(clientOptions: OfflineClientOptions);
   initialize(): Promise<void>;
   resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext): Promise<ResolutionDetails<boolean>>;
   resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext): Promise<ResolutionDetails<string>>;
@@ -321,5 +390,5 @@ declare class ConfigDirectorProvider implements Provider {
   private mapContext;
 }
 //#endregion
-export { type ConfigDirectorClient, type ConfigDirectorClientOptions, type ConfigDirectorContext, type ConfigDirectorLogMessageDecorator, type ConfigDirectorLogger, type ConfigDirectorLoggingLevel, ConfigDirectorProvider, type ConfigValueType };
+export { type ConfigDirectorClient, type ConfigDirectorClientOptions, type ConfigDirectorContext, ConfigDirectorInitializationError, type ConfigDirectorLogMessageDecorator, type ConfigDirectorLogger, type ConfigDirectorLoggingLevel, ConfigDirectorProvider, type ConfigValueType, type OfflineClientOptions, type OfflineValue, type OfflineValues };
 //# sourceMappingURL=configdirector-openfeature-server-provider.d.cts.map

package/dist/configdirector-openfeature-server-provider.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"configdirector-openfeature-server-provider.d.cts","names":[],"sources":["../../shared/src/types.ts","../../js-server-sdk/src/types.ts","../src/ConfigDirectorProvider.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;KAqCY,qBAAA;;;;;;;;;EASV,EAAA;EAzCK;;;;;;;AAKP;;;;EAiDE,IAAA;EA7CU;;;;EAmDV,IAAA;EAzCU;;;;EA+CV,MAAA;IAAA,CAAY,GAAA;EAAA;EAzCmB;;;;;;;EAkD/B,SAAA;AAAA;;;;AA3CF;KAkDY,yBAAA;EACV,UAAA;EACA,OAAA;AAAA;AAAA,KAGU,cAAA;;;;;;KC/FA,2BAAA;EDlBA;;;ECsBV,QAAA,GAAW,yBAAA;EDtBkC;AAE/C;;ECwBE,UAAA;IDxB6C;;AAE/C;;;;;AAEA;;IC8BI,IAAA,GAAO,cAAA;ID3BO;;;;;;;ICmCd,eAAA;IDjCK;AAQT;;;;;AAEA;;ICgCI,OAAA;IDhCiC;;;;;ICsCjC,GAAA;EAAA;EDjCF;;;;;;;;AAKF;;;;;EC2CE,MAAA,GAAS,oBAAA;EDvCiB;;;;AAU5B;;;ECsCE,SAAA;IDjCQ;;;;;;;;;IC2CN,eAAA;ID3CM;;;;;AAQV;;;IC6CI,aAAA;EAAA;EDvBF;;;;;;;AA4BF;;;;;AAKA;;;ECQE,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;;;;;;;UAQ/C,oBAAA;EA3BI;AAGrB;;;;;;;;;;EAoCE,UAAA,IAAc,OAAA;EAhCd;;;;;AAGF;EAHE,IAwCI,OAAA;;;;;;;;;;;EAYJ,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,OAAA,GAAU,qBAAA,GAAwB,CAAA;EAhD1G;;;;;;;;;;;;EA8DA,KAAA,WAAgB,eAAA,EACd,SAAA,UACA,YAAA,EAAc,CAAA,EACd,QAAA,EAAU,YAAA,CAAa,CAAA,GACvB,OAAA,GAAU,qBAAA;EA/DkD;AAGhE;;;;;;;EAuEE,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAvExD;;;EA4EtB,UAAA;EA5E4D;;;AAE9D;;;;EAmFE,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;EAlF/D;;;;;;EA0Ff,OAAA;AAAA;;;cC3OW,sBAAA,YAAkC,QAAA;EAAA,iBAC5B,MAAA;EAAA,iBACA,YAAA;EAAA,SAER,QAAA,EAAU,gBAAA;EAAA,SAGV,MAAA,EAAQ,QAAA;EAAA,SACR,MAAA,EAAM,uBAAA;cAEI,YAAA,UAAsB,aAAA,GAAgB,2BAAA;EAiBnD,UAAA,CAAA,GAAU,OAAA;EAMhB,wBAAA,CACE,OAAA,UACA,YAAA,WACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,WAAkC,SAAA,CAAA,CAChC,OAAA,UACA,YAAA,EAAc,CAAA,EACd,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA,CAAkB,CAAA;EAM7B,OAAA,CAAA,CAAA,GAAY,OAAA;EAAA,QAKJ,QAAA;EAAA,QAWA,UAAA;AAAA"}
+{"version":3,"file":"configdirector-openfeature-server-provider.d.cts","names":[],"sources":["../../shared/src/types.ts","../../shared/src/native-values.ts","../../js-server-sdk/src/types.ts","../../shared/src/errors.ts","../src/ConfigDirectorProvider.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;KAqCY,qBAAA;;;;;;;;;EASV,EAAA;EAzCK;;;;;;;AAKP;;;;EAiDE,IAAA;EA7CU;;;;EAmDV,IAAA;EAzCU;;;;EA+CV,MAAA;IAAA,CAAY,GAAA;EAAA;EAzCmB;;;;;;;EAkD/B,SAAA;AAAA;;;;AA3CF;KAkDY,yBAAA;EACV,UAAA;EACA,OAAA;AAAA;AAAA,KAGU,cAAA;;;KCxHA,eAAA,sCAAqD,eAAA;EAAA,CAAuB,GAAA,WAAc,eAAA;AAAA;AAAA,KAE1F,WAAA,+BAA0C,eAAA;EAAA,CAAuB,GAAA,WAAc,eAAA;AAAA;AAAA,KAE/E,YAAA,GAAe,MAAA,SAAe,WAAA;;;;;;ADG1C;;KEqBY,YAAA,GAAe,WAAA;;;AFnB3B;;KEyBY,aAAA,GAAgB,YAAA;;;AFvB5B;KE4BY,iBAAA;;;;AF1BZ;;;;;;;;;EEuCE,IAAA,GAAO,cAAA;EFlCA;;AAQT;;;;;AAEA;;;EEmCE,IAAA;EFlCA;;;;;;;EE0CA,MAAA,GAAS,aAAA;EFtCgB;;;;;;AAK3B;EEyCE,eAAA;;;;AFrCF;;;;;AAUA;EEqCE,OAAA;;;;;;EAMA,GAAA;AAAA;;;;KAMU,2BAAA;EF5CV;;;EEgDA,QAAA,GAAW,yBAAA;EF/CoB;;AAOjC;EE4CE,UAAA,GAAa,iBAAA;;;;;;;;;;;AFMf;;;EEQE,MAAA,GAAS,oBAAA;EFNF;AAGT;;;;;;EEYE,SAAA;;ADpIF;;;;;;;;IC8II,eAAA;ID5IQ;;;;;;;;ICsJR,aAAA;EAAA;EDpJoB;;;;;;;ACwBxB;;;;;AAMA;;;EAwIE,KAAA,GAAQ,WAAA;AAAA;AAnIV;;;AAAA,KAyIY,oBAAA,GAAuB,2BAAA;EACjC,UAAA,EAAY,iBAAA;IAAsB,IAAA;EAAA;AAAA;AAAA,KAGxB,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;;;;;;;UAQ/C,oBAAA;EA5BL;;;;;;;;;;AAIZ;EAoCE,UAAA,IAAc,OAAA;;;;;;;MAQV,OAAA;EAzCe;;;;;;;AAIrB;;;EAiDE,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,OAAA,GAAU,qBAAA,GAAwB,CAAA;EAhD/D;;;;;;;;;;;;EA8D3C,KAAA,WAAgB,eAAA,EACd,SAAA,UACA,YAAA,EAAc,CAAA,EACd,QAAA,EAAU,YAAA,CAAa,CAAA,GACvB,OAAA,GAAU,qBAAA;EAjEK;;;;;;;;EA4EjB,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EA1EhB;AAGhE;;EA4EE,UAAA;EA5E2C;;;;;;;EAqF3C,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;EA1FxD;;;;;;EAkGtB,OAAA;AAAA;;;cCnRW,iCAAA,SAA0C,KAAA;EAAA,SAC5B,IAAA;cAEb,OAAA;AAAA;;;cCVD,sBAAA,YAAkC,QAAA;EAAA,iBAC5B,MAAA;EAAA,iBACA,YAAA;EAAA,SAER,QAAA,EAAU,gBAAA;EAAA,SAGV,MAAA,EAAQ,QAAA;EAAA,SACR,MAAA,EAAM,uBAAA;EJbK;;;cIkBD,YAAA,UAAsB,aAAA,GAAgB,2BAAA;EJhB/C;;;;cIqBS,aAAA,EAAe,oBAAA;EAc5B,UAAA,CAAA,GAAU,OAAA;EAMhB,wBAAA,CACE,OAAA,UACA,YAAA,WACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,WAAkC,SAAA,CAAA,CAChC,OAAA,UACA,YAAA,EAAc,CAAA,EACd,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA,CAAkB,CAAA;EAM7B,OAAA,CAAA,CAAA,GAAY,OAAA;EAAA,QAKJ,QAAA;EAAA,QAWA,UAAA;AAAA"}

package/dist/configdirector-openfeature-server-provider.d.mts

@@ -89,9 +89,90 @@ type ConfigDirectorMetaContext = {
   appVersion?: string;
   appName?: string;
 };
-type ConnectionMode = "streaming" | "polling";
+type ConnectionMode = "streaming" | "polling" | "offline";
+//#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-server-sdk/src/types.d.ts
+/**
+ * One value an offline client serves for a config key. The config type follows from the value: a
+ * boolean, an integral number (`integer`), any other number (`float`), a string, or a plain object
+ * or array (`json`).
+ */
+type OfflineValue = NativeValue;
+/**
+ * The values an offline client serves, keyed by config key. See {@link OfflineValue} for how each
+ * value's config type is decided. Every context receives the same value.
+ */
+type OfflineValues = NativeValues;
+/**
+ * Connection options of the {@link ConfigDirectorClient}
+ */
+type ConnectionOptions = {
+  /**
+   * The connection mode to be used, one of `streaming` (default), `polling` or `offline`.
+   * 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`.
+   * When set to `offline`, the client never connects to ConfigDirector and sends nothing: it serves
+   * the values read from {@link file} or given in {@link values} to every context, or the in-code
+   * default values when neither is given. No SDK key is needed.
+   *
+   * Defaults to `streaming`
+   */
+  mode?: ConnectionMode;
+  /**
+   * The path of a JSON file holding the values to serve in `offline` mode, resolved against the
+   * process working directory. The file holds one object with a value per config key, such as
+   * `{ "new-checkout": true, "max-items": 20 }`; see {@link OfflineValue} for how the config type
+   * of each value is decided. A file that is missing, unreadable, not a JSON object, or holding a
+   * value such as `null` makes `initialize` reject with a `ConfigDirectorInitializationError`.
+   *
+   * Only one of `file` and `values` can be given, and only in `offline` mode; otherwise
+   * `initialize` rejects.
+   */
+  file?: string;
+  /**
+   * The values to serve in `offline` mode, keyed by config key. A value such as `null` makes
+   * `initialize` reject with a `ConfigDirectorInitializationError`.
+   *
+   * Only one of `file` and `values` can be given, and only in `offline` mode; otherwise
+   * `initialize` rejects.
+   */
+  values?: OfflineValues;
+  /**
+   * The polling interval in _seconds_ when the `mode` is set to `polling`. This option has no
+   * effect in the other modes.
+   *
+   * 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. This option has
+   * no effect in `offline` mode.
+   *
+   * 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. This option has no effect in `offline` mode.
+   */
+  url?: string;
+};
 /**
  * Configuration options for the {@link ConfigDirectorClient}
  */
@@ -103,41 +184,7 @@ type ConfigDirectorClientOptions = {
   /**
    * 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;
-  };
+  connection?: ConnectionOptions;
   /**
    * A logger that implements {@link ConfigDirectorLogger}. It defaults to the ConfigDirector console
    * logger set to 'warn' level.
@@ -197,6 +244,14 @@ type ConfigDirectorClientOptions = {
    */
   hooks?: ClientHooks;
 };
+/**
+ * The options of a client created without an SDK key: the connection mode is `offline`.
+ */
+type OfflineClientOptions = ConfigDirectorClientOptions & {
+  connection: ConnectionOptions & {
+    mode: "offline";
+  };
+};
 type ClientEvents = {
   configsUpdated: {
     keys: string[];
@@ -303,6 +358,12 @@ interface ConfigDirectorClient {
   dispose(): void;
 }
 //#endregion
+//#region ../shared/src/errors.d.ts
+declare class ConfigDirectorInitializationError extends Error {
+  readonly name: string;
+  constructor(message: string);
+}
+//#endregion
 //#region src/ConfigDirectorProvider.d.ts
 declare class ConfigDirectorProvider implements Provider {
   private readonly client;
@@ -310,7 +371,15 @@ declare class ConfigDirectorProvider implements Provider {
   readonly metadata: ProviderMetadata;
   readonly runsOn: Paradigm;
   readonly events: OpenFeatureEventEmitter;
-  constructor(clientSdkKey: string, clientOptions?: ConfigDirectorClientOptions);
+  /**
+   * Creates a provider connected to ConfigDirector with the given server SDK key.
+   */
+  constructor(serverSdkKey: string, clientOptions?: ConfigDirectorClientOptions);
+  /**
+   * Creates a provider in `offline` mode, which needs no server SDK key: it never connects to
+   * ConfigDirector and serves `connection.file` or `connection.values` to every evaluation.
+   */
+  constructor(clientOptions: OfflineClientOptions);
   initialize(): Promise<void>;
   resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext): Promise<ResolutionDetails<boolean>>;
   resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext): Promise<ResolutionDetails<string>>;
@@ -321,5 +390,5 @@ declare class ConfigDirectorProvider implements Provider {
   private mapContext;
 }
 //#endregion
-export { type ConfigDirectorClient, type ConfigDirectorClientOptions, type ConfigDirectorContext, type ConfigDirectorLogMessageDecorator, type ConfigDirectorLogger, type ConfigDirectorLoggingLevel, ConfigDirectorProvider, type ConfigValueType };
+export { type ConfigDirectorClient, type ConfigDirectorClientOptions, type ConfigDirectorContext, ConfigDirectorInitializationError, type ConfigDirectorLogMessageDecorator, type ConfigDirectorLogger, type ConfigDirectorLoggingLevel, ConfigDirectorProvider, type ConfigValueType, type OfflineClientOptions, type OfflineValue, type OfflineValues };
 //# sourceMappingURL=configdirector-openfeature-server-provider.d.mts.map

package/dist/configdirector-openfeature-server-provider.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"configdirector-openfeature-server-provider.d.mts","names":[],"sources":["../../shared/src/types.ts","../../js-server-sdk/src/types.ts","../src/ConfigDirectorProvider.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;KAqCY,qBAAA;;;;;;;;;EASV,EAAA;EAzCK;;;;;;;AAKP;;;;EAiDE,IAAA;EA7CU;;;;EAmDV,IAAA;EAzCU;;;;EA+CV,MAAA;IAAA,CAAY,GAAA;EAAA;EAzCmB;;;;;;;EAkD/B,SAAA;AAAA;;;;AA3CF;KAkDY,yBAAA;EACV,UAAA;EACA,OAAA;AAAA;AAAA,KAGU,cAAA;;;;;;KC/FA,2BAAA;EDlBA;;;ECsBV,QAAA,GAAW,yBAAA;EDtBkC;AAE/C;;ECwBE,UAAA;IDxB6C;;AAE/C;;;;;AAEA;;IC8BI,IAAA,GAAO,cAAA;ID3BO;;;;;;;ICmCd,eAAA;IDjCK;AAQT;;;;;AAEA;;ICgCI,OAAA;IDhCiC;;;;;ICsCjC,GAAA;EAAA;EDjCF;;;;;;;;AAKF;;;;;EC2CE,MAAA,GAAS,oBAAA;EDvCiB;;;;AAU5B;;;ECsCE,SAAA;IDjCQ;;;;;;;;;IC2CN,eAAA;ID3CM;;;;;AAQV;;;IC6CI,aAAA;EAAA;EDvBF;;;;;;;AA4BF;;;;;AAKA;;;ECQE,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;;;;;;;UAQ/C,oBAAA;EA3BI;AAGrB;;;;;;;;;;EAoCE,UAAA,IAAc,OAAA;EAhCd;;;;;AAGF;EAHE,IAwCI,OAAA;;;;;;;;;;;EAYJ,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,OAAA,GAAU,qBAAA,GAAwB,CAAA;EAhD1G;;;;;;;;;;;;EA8DA,KAAA,WAAgB,eAAA,EACd,SAAA,UACA,YAAA,EAAc,CAAA,EACd,QAAA,EAAU,YAAA,CAAa,CAAA,GACvB,OAAA,GAAU,qBAAA;EA/DkD;AAGhE;;;;;;;EAuEE,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAvExD;;;EA4EtB,UAAA;EA5E4D;;;AAE9D;;;;EAmFE,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;EAlF/D;;;;;;EA0Ff,OAAA;AAAA;;;cC3OW,sBAAA,YAAkC,QAAA;EAAA,iBAC5B,MAAA;EAAA,iBACA,YAAA;EAAA,SAER,QAAA,EAAU,gBAAA;EAAA,SAGV,MAAA,EAAQ,QAAA;EAAA,SACR,MAAA,EAAM,uBAAA;cAEI,YAAA,UAAsB,aAAA,GAAgB,2BAAA;EAiBnD,UAAA,CAAA,GAAU,OAAA;EAMhB,wBAAA,CACE,OAAA,UACA,YAAA,WACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,WAAkC,SAAA,CAAA,CAChC,OAAA,UACA,YAAA,EAAc,CAAA,EACd,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA,CAAkB,CAAA;EAM7B,OAAA,CAAA,CAAA,GAAY,OAAA;EAAA,QAKJ,QAAA;EAAA,QAWA,UAAA;AAAA"}
+{"version":3,"file":"configdirector-openfeature-server-provider.d.mts","names":[],"sources":["../../shared/src/types.ts","../../shared/src/native-values.ts","../../js-server-sdk/src/types.ts","../../shared/src/errors.ts","../src/ConfigDirectorProvider.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;KAqCY,qBAAA;;;;;;;;;EASV,EAAA;EAzCK;;;;;;;AAKP;;;;EAiDE,IAAA;EA7CU;;;;EAmDV,IAAA;EAzCU;;;;EA+CV,MAAA;IAAA,CAAY,GAAA;EAAA;EAzCmB;;;;;;;EAkD/B,SAAA;AAAA;;;;AA3CF;KAkDY,yBAAA;EACV,UAAA;EACA,OAAA;AAAA;AAAA,KAGU,cAAA;;;KCxHA,eAAA,sCAAqD,eAAA;EAAA,CAAuB,GAAA,WAAc,eAAA;AAAA;AAAA,KAE1F,WAAA,+BAA0C,eAAA;EAAA,CAAuB,GAAA,WAAc,eAAA;AAAA;AAAA,KAE/E,YAAA,GAAe,MAAA,SAAe,WAAA;;;;;;ADG1C;;KEqBY,YAAA,GAAe,WAAA;;;AFnB3B;;KEyBY,aAAA,GAAgB,YAAA;;;AFvB5B;KE4BY,iBAAA;;;;AF1BZ;;;;;;;;;EEuCE,IAAA,GAAO,cAAA;EFlCA;;AAQT;;;;;AAEA;;;EEmCE,IAAA;EFlCA;;;;;;;EE0CA,MAAA,GAAS,aAAA;EFtCgB;;;;;;AAK3B;EEyCE,eAAA;;;;AFrCF;;;;;AAUA;EEqCE,OAAA;;;;;;EAMA,GAAA;AAAA;;;;KAMU,2BAAA;EF5CV;;;EEgDA,QAAA,GAAW,yBAAA;EF/CoB;;AAOjC;EE4CE,UAAA,GAAa,iBAAA;;;;;;;;;;;AFMf;;;EEQE,MAAA,GAAS,oBAAA;EFNF;AAGT;;;;;;EEYE,SAAA;;ADpIF;;;;;;;;IC8II,eAAA;ID5IQ;;;;;;;;ICsJR,aAAA;EAAA;EDpJoB;;;;;;;ACwBxB;;;;;AAMA;;;EAwIE,KAAA,GAAQ,WAAA;AAAA;AAnIV;;;AAAA,KAyIY,oBAAA,GAAuB,2BAAA;EACjC,UAAA,EAAY,iBAAA;IAAsB,IAAA;EAAA;AAAA;AAAA,KAGxB,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;;;;;;;UAQ/C,oBAAA;EA5BL;;;;;;;;;;AAIZ;EAoCE,UAAA,IAAc,OAAA;;;;;;;MAQV,OAAA;EAzCe;;;;;;;AAIrB;;;EAiDE,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,OAAA,GAAU,qBAAA,GAAwB,CAAA;EAhD/D;;;;;;;;;;;;EA8D3C,KAAA,WAAgB,eAAA,EACd,SAAA,UACA,YAAA,EAAc,CAAA,EACd,QAAA,EAAU,YAAA,CAAa,CAAA,GACvB,OAAA,GAAU,qBAAA;EAjEK;;;;;;;;EA4EjB,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EA1EhB;AAGhE;;EA4EE,UAAA;EA5E2C;;;;;;;EAqF3C,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;EA1FxD;;;;;;EAkGtB,OAAA;AAAA;;;cCnRW,iCAAA,SAA0C,KAAA;EAAA,SAC5B,IAAA;cAEb,OAAA;AAAA;;;cCVD,sBAAA,YAAkC,QAAA;EAAA,iBAC5B,MAAA;EAAA,iBACA,YAAA;EAAA,SAER,QAAA,EAAU,gBAAA;EAAA,SAGV,MAAA,EAAQ,QAAA;EAAA,SACR,MAAA,EAAM,uBAAA;EJbK;;;cIkBD,YAAA,UAAsB,aAAA,GAAgB,2BAAA;EJhB/C;;;;cIqBS,aAAA,EAAe,oBAAA;EAc5B,UAAA,CAAA,GAAU,OAAA;EAMhB,wBAAA,CACE,OAAA,UACA,YAAA,WACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,CACE,OAAA,UACA,YAAA,UACA,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA;EAIX,uBAAA,WAAkC,SAAA,CAAA,CAChC,OAAA,UACA,YAAA,EAAc,CAAA,EACd,OAAA,EAAS,iBAAA,GACR,OAAA,CAAQ,iBAAA,CAAkB,CAAA;EAM7B,OAAA,CAAA,CAAA,GAAY,OAAA;EAAA,QAKJ,QAAA;EAAA,QAWA,UAAA;AAAA"}