@launchdarkly/js-client-sdk-common 1.9.1-beta.1 → 1.9.1-beta.2

package/dist/esm/api/LDClient.d.ts

@@ -0,0 +1,315 @@
+import { LDContext, LDFlagSet, LDFlagValue, LDLogger } from '@launchdarkly/js-sdk-common';
+import { Hook } from './integrations/Hooks';
+import { LDEvaluationDetail, LDEvaluationDetailTyped } from './LDEvaluationDetail';
+import { LDIdentifyOptions } from './LDIdentifyOptions';
+/**
+ * The basic interface for the LaunchDarkly client. Platform-specific SDKs may add some methods of their own.
+ *
+ * @see https://docs.launchdarkly.com/sdk/client-side/javascript
+ *
+ * @ignore (don't need to show this separately in TypeDoc output; all methods will be shown in LDClient)
+ */
+export interface LDClient {
+    /**
+     * Returns a map of all available flags to the current context's values.
+     *
+     * @returns
+     *   An object in which each key is a feature flag key and each value is the flag value.
+     *   Note that there is no way to specify a default value for each flag as there is with
+     *   {@link variation}, so any flag that cannot be evaluated will be undefined.
+     */
+    allFlags(): LDFlagSet;
+    /**
+     * Determines the boolean variation of a feature flag.
+     *
+     * If the flag variation does not have a boolean value, defaultValue is returned.
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *   The boolean value.
+     */
+    boolVariation(key: string, defaultValue: boolean): boolean;
+    /**
+     * Determines the boolean variation of a feature flag, along with information about
+     * how it was calculated.
+     *
+     * The `reason` property of the result will also be included in analytics events, if you are
+     * capturing detailed event data for this flag.
+     *
+     * If the flag variation does not have a boolean value, defaultValue is returned. The reason will
+     * indicate an error of the type `WRONG_KIND` in this case.
+     *
+     * For more information, see the [SDK reference
+     * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *  The result (as an {@link LDEvaluationDetailTyped<boolean>}).
+     */
+    boolVariationDetail(key: string, defaultValue: boolean): LDEvaluationDetailTyped<boolean>;
+    /**
+     * Shuts down the client and releases its resources, after delivering any pending analytics
+     * events. After the client is closed, all calls to {@link variation} will return default values,
+     * and it will not make any requests to LaunchDarkly.
+     */
+    close(): Promise<void>;
+    /**
+     * Flushes all pending analytics events.
+     *
+     * Normally, batches of events are delivered in the background at intervals determined by the
+     * `flushInterval` property of {@link LDOptions}. Calling `flush()` triggers an immediate delivery.
+     *
+     * @returns
+     *   A Promise which resolves once
+     *   flushing is finished. You can inspect the result of the flush for errors.
+     */
+    flush(): Promise<{
+        error?: Error;
+        result: boolean;
+    }>;
+    /**
+     * Returns the client's current context.
+     *
+     * This is the context that was most recently passed to {@link identify}, or, if {@link identify} has never
+     * been called, this will be undefined.
+     */
+    getContext(): LDContext | undefined;
+    /**
+     * Identifies a context to LaunchDarkly.
+     *
+     * Unlike the server-side SDKs, the client-side JavaScript SDKs maintain a current context state,
+     * which is set when you call `identify()`.
+     *
+     * Changing the current context also causes all feature flag values to be reloaded. Until that has
+     * finished, calls to {@link variation} will still return flag values for the previous context. You can
+     * await the Promise to determine when the new flag values are available.
+     *
+     * @param context
+     *    The LDContext object.
+     * @param identifyOptions
+     *    Optional configuration. Please see {@link LDIdentifyOptions}.
+     * @returns
+     *    A Promise which resolves when the flag values for the specified
+     * context are available. It rejects when:
+     *
+     * 1. The context is unspecified or has no key.
+     *
+     * 2. The identify timeout is exceeded. In client SDKs this defaults to 5s.
+     * You can customize this timeout with {@link LDIdentifyOptions | identifyOptions}.
+     *
+     * 3. A network error is encountered during initialization.
+     */
+    identify(context: LDContext, identifyOptions?: LDIdentifyOptions): Promise<void>;
+    /**
+     * Determines the json variation of a feature flag.
+     *
+     * This version may be favored in TypeScript versus `variation` because it returns
+     * an `unknown` type instead of `any`. `unknown` will require a cast before usage.
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *   The json value.
+     */
+    jsonVariation(key: string, defaultValue: unknown): unknown;
+    /**
+     * Determines the json variation of a feature flag, along with information about how it
+     * was calculated.
+     *
+     * The `reason` property of the result will also be included in analytics events, if you are
+     * capturing detailed event data for this flag.
+     *
+     * This version may be favored in TypeScript versus `variation` because it returns
+     * an `unknown` type instead of `any`. `unknown` will require a cast before usage.
+     *
+     * For more information, see the [SDK reference
+     * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *  The result (as an {@link LDEvaluationDetailTyped<unknown>}).
+     */
+    jsonVariationDetail(key: string, defaultValue: unknown): LDEvaluationDetailTyped<unknown>;
+    /**
+     * The logger configured as part of LDOptions during construction.
+     *
+     * @remarks
+     * For more information, read {@link LDOptions.logger} and {@link LDLogger}.
+     *
+     * @returns The configured {@link LDLogger}.
+     */
+    readonly logger: LDLogger;
+    /**
+     * Determines the numeric variation of a feature flag.
+     *
+     * If the flag variation does not have a numeric value, defaultValue is returned.
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *   The numeric value.
+     */
+    numberVariation(key: string, defaultValue: number): number;
+    /**
+     * Determines the numeric variation of a feature flag for a context, along with information about
+     * how it was calculated.
+     *
+     * @remarks
+     * The `reason` property of the result will also be included in analytics events, if you are
+     * capturing detailed event data for this flag.
+     *
+     * If the flag variation does not have a numeric value, defaultValue is returned. The reason will
+     * indicate an error of the type `WRONG_KIND` in this case.
+     *
+     * For more information, see the [SDK reference
+     * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *   The result (as an {@link LDEvaluationDetailTyped<number>}).
+     */
+    numberVariationDetail(key: string, defaultValue: number): LDEvaluationDetailTyped<number>;
+    /**
+     * Removes an event listener. See {@link on} for the available event types.
+     *
+     * @param key
+     *   The name of the event for which to stop listening.
+     * @param callback
+     *   The function to deregister.
+     */
+    off(key: string, callback: (...args: any[]) => void): void;
+    /**
+     * Registers an event listener.
+     *
+     * @remarks
+     * You can subscribe to one of the supported {@link EventName}:
+     *
+     * - `"change"`: The client has received new feature flag data. This can happen either
+     *   because you have switched contexts with {@link identify}, or because the client has a
+     *   stream connection and has received a live change to a flag value (see below).
+     *   The callback parameters are the context and an array of flag keys that have changed.
+     *
+     * - `"error"`: General event for any kind of error condition during client operation.
+     *   The callback parameters are the context and an Error object. Errors are also output by
+     *   the {@link logger} at the error level.
+     *
+     * - `"dataSourceStatus"`: Event indicating that there has been a change in the status of the
+     *   data source. This will include the state of the data source as well any error information.
+     *
+     * @param key
+     *   The name of the event for which to listen.
+     * @param callback
+     *   The function to execute when the event fires. The callback may or may not
+     *   receive parameters, depending on the type of event.
+     */
+    on(key: string, callback: (...args: any[]) => void): void;
+    /**
+     * Determines the string variation of a feature flag.
+     *
+     * If the flag variation does not have a string value, defaultValue is returned.
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *   The string value.
+     */
+    stringVariation(key: string, defaultValue: string): string;
+    /**
+     * Determines the string variation of a feature flag for a context, along with information about
+     * how it was calculated.
+     *
+     * @remarks
+     * The `reason` property of the result will also be included in analytics events, if you are
+     * capturing detailed event data for this flag.
+     *
+     * If the flag variation does not have a string value, defaultValue is returned. The reason will
+     * indicate an error of the type `WRONG_KIND` in this case.
+     *
+     * For more information, see the [SDK reference
+     * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+     *
+     * @param key The unique key of the feature flag.
+     * @param defaultValue The default value of the flag, to be used if the value is not available
+     *   from LaunchDarkly.
+     * @returns
+     *   The result (as an {@link LDEvaluationDetailTyped<string>}).
+     */
+    stringVariationDetail(key: string, defaultValue: string): LDEvaluationDetailTyped<string>;
+    /**
+     * Track events for experiments.
+     *
+     * @param key
+     *   The name of the event, which may correspond to a goal in an experiment.
+     * @param data
+     *   Additional information to associate with the event.
+     * @param metricValue
+     *   An optional numeric value that can be used by the LaunchDarkly experimentation
+     *   feature in numeric custom metrics. Can be omitted if this event is used by only
+     *   non-numeric metrics. This field will also be returned as part of the custom event
+     *   for Data Export.
+     */
+    track(key: string, data?: any, metricValue?: number): void;
+    /**
+     * We recommend using strongly typed variation methods which perform
+     * type checks and handle type errors.
+     *
+     * @remarks
+     * Determines the variation of a feature flag.
+     *
+     * In the client-side JavaScript SDKs, this is always a fast synchronous operation because all of
+     * the feature flag values for the current context have already been loaded into memory.
+     *
+     * @param key
+     *   The unique key of the feature flag.
+     * @param defaultValue
+     *   The default value of the flag, to be used if the value is not available from LaunchDarkly.
+     * @returns
+     *   The flag's value.
+     */
+    variation(key: string, defaultValue?: LDFlagValue): LDFlagValue;
+    /**
+     * We recommend using strongly typed variation detail methods which perform
+     * type checks and handle type errors.
+     *
+     * @remarks
+     * Determines the variation of a feature flag for a context, along with information about how it was
+     * calculated.
+     *
+     * Note that this will only work if you have set `withReasons` to true in {@link LDOptions}.
+     *
+     * The `reason` property of the result will also be included in analytics events, if you are
+     * capturing detailed event data for this flag.
+     *
+     * For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#javascript).
+     *
+     * @param key
+     *   The unique key of the feature flag.
+     * @param defaultValue
+     *   The default value of the flag, to be used if the value is not available from LaunchDarkly.
+     *
+     * @returns
+     *   An {@link LDEvaluationDetail} object containing the value and explanation.
+     */
+    variationDetail(key: string, defaultValue?: LDFlagValue): LDEvaluationDetail;
+    /**
+     * Add a hook to the client. In order to register a hook before the client
+     * starts, please use the `hooks` property of {@link LDOptions}.
+     *
+     * Hooks provide entrypoints which allow for observation of SDK functions.
+     *
+     * @param Hook The hook to add.
+     */
+    addHook(hook: Hook): void;
+}
+//# sourceMappingURL=LDClient.d.ts.map

package/dist/esm/api/LDClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDClient.d.ts","sourceRoot":"","sources":["../../src/api/LDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAE1F,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;OAOG;IACH,QAAQ,IAAI,SAAS,CAAC;IAEtB;;;;;;;;;;OAUG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE1F;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;;;OASG;IACH,KAAK,IAAI,OAAO,CAAC;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAErD;;;;;OAKG;IACH,UAAU,IAAI,SAAS,GAAG,SAAS,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,eAAe,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE1F;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE1F;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAE1D;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE1F;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3D;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,WAAW,GAAG,kBAAkB,CAAC;IAE7E;;;;;;;OAOG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CAC3B"}

package/dist/esm/api/LDEvaluationDetail.d.ts

@@ -0,0 +1,26 @@
+import { LDEvaluationDetail as CommonDetail, LDEvaluationDetailTyped as CommonDetailTyped, LDEvaluationReason } from '@launchdarkly/js-sdk-common';
+/**
+ * An object that combines the result of a feature flag evaluation with information about
+ * how it was calculated.
+ *
+ * This is the result of calling `LDClient.variationDetail`.
+ */
+export type LDEvaluationDetail = Omit<CommonDetail, 'reason'> & {
+    /**
+     * An optional object describing the main factor that influenced the flag evaluation value.
+     */
+    reason: LDEvaluationReason | null;
+};
+/**
+ * An object that combines the result of a feature flag evaluation with information about
+ * how it was calculated.
+ *
+ * This is the result of calling detailed variation methods.
+ */
+export type LDEvaluationDetailTyped<TFlag> = Omit<CommonDetailTyped<TFlag>, 'reason'> & {
+    /**
+     * An optional object describing the main factor that influenced the flag evaluation value.
+     */
+    reason: LDEvaluationReason | null;
+};
+//# sourceMappingURL=LDEvaluationDetail.d.ts.map

package/dist/esm/api/LDEvaluationDetail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDEvaluationDetail.d.ts","sourceRoot":"","sources":["../../src/api/LDEvaluationDetail.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,IAAI,YAAY,EAClC,uBAAuB,IAAI,iBAAiB,EAC5C,kBAAkB,EACnB,MAAM,6BAA6B,CAAC;AAQrC;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAC9D;;OAEG;IACH,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,CAAC,KAAK,IAAI,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,GAAG;IACtF;;OAEG;IACH,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC,CAAC"}

package/dist/esm/api/LDIdentifyOptions.d.ts

@@ -0,0 +1,23 @@
+export interface LDIdentifyOptions {
+    /**
+     * In seconds. Determines when the identify promise resolves if no flags have been
+     * returned from the network. If you use a large timeout and await it, then
+     * any network delays will cause your application to wait a long time before
+     * continuing execution.
+     *
+     * Defaults to 5 seconds.
+     */
+    timeout?: number;
+    /**
+     * When true indicates that the SDK will attempt to wait for values from
+     * LaunchDarkly instead of depending on cached values. The cached values will
+     * still be loaded, but the promise returned by the identify function will not
+     * resolve as a result of those cached values being loaded. Generally this
+     * option should NOT be used and instead flag changes should be listened to.
+     * If the client is set to offline mode, then this option is ignored.
+     *
+     * Defaults to false.
+     */
+    waitForNetworkResults?: boolean;
+}
+//# sourceMappingURL=LDIdentifyOptions.d.ts.map

package/dist/esm/api/LDIdentifyOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDIdentifyOptions.d.ts","sourceRoot":"","sources":["../../src/api/LDIdentifyOptions.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC"}

package/dist/esm/api/LDInspection.d.ts

@@ -0,0 +1,105 @@
+import { LDContext } from '@launchdarkly/js-sdk-common';
+import { LDEvaluationDetail } from './LDEvaluationDetail';
+/**
+ * Callback interface for collecting information about the SDK at runtime.
+ *
+ * This interface is used to collect information about flag usage.
+ *
+ * This interface should not be used by the application to access flags for the purpose of controlling application
+ * flow. It is intended for monitoring, analytics, or debugging purposes.
+ */
+export interface LDInspectionFlagUsedHandler {
+    type: 'flag-used';
+    /**
+     * Name of the inspector. Will be used for logging issues with the inspector.
+     */
+    name: string;
+    /**
+     * @deprecated All inspectors run synchronously. This field will be removed in a future major version.
+     */
+    synchronous?: boolean;
+    /**
+     * This method is called when a flag is accessed via a variation method, or it can be called based on actions in
+     * wrapper SDKs which have different methods of tracking when a flag was accessed. It is not called when a call is made
+     * to allFlags.
+     */
+    method: (flagKey: string, flagDetail: LDEvaluationDetail, context?: LDContext) => void;
+}
+/**
+ * Callback interface for collecting information about the SDK at runtime.
+ *
+ * This interface is used to collect information about flag data. In order to understand the
+ * current flag state it should be combined with {@link LDInspectionFlagValueChangedHandler}.
+ * This interface will get the initial flag information, and
+ * {@link LDInspectionFlagValueChangedHandler} will provide changes to individual flags.
+ *
+ * This interface should not be used by the application to access flags for the purpose of controlling application
+ * flow. It is intended for monitoring, analytics, or debugging purposes.
+ */
+export interface LDInspectionFlagDetailsChangedHandler {
+    type: 'flag-details-changed';
+    /**
+     * Name of the inspector. Will be used for logging issues with the inspector.
+     */
+    name: string;
+    /**
+     * @deprecated All inspectors run synchronously. This field will be removed in a future major version.
+     */
+    synchronous?: boolean;
+    /**
+     * This method is called when the flags in the store are replaced with new flags. It will contain all flags
+     * regardless of if they have been evaluated.
+     */
+    method: (details: Record<string, LDEvaluationDetail>) => void;
+}
+/**
+ * Callback interface for collecting information about the SDK at runtime.
+ *
+ * This interface is used to collect changes to flag data, but does not provide the initial
+ * data. It can be combined with {@link LDInspectionFlagValuesChangedHandler} to track the
+ * entire flag state.
+ *
+ * This interface should not be used by the application to access flags for the purpose of controlling application
+ * flow. It is intended for monitoring, analytics, or debugging purposes.
+ */
+export interface LDInspectionFlagDetailChangedHandler {
+    type: 'flag-detail-changed';
+    /**
+     * Name of the inspector. Will be used for logging issues with the inspector.
+     */
+    name: string;
+    /**
+     * @deprecated All inspectors run synchronously. This field will be removed in a future major version.
+     */
+    synchronous?: boolean;
+    /**
+     * This method is called when a flag is updated. It will not be called
+     * when all flags are updated.
+     */
+    method: (flagKey: string, detail: LDEvaluationDetail) => void;
+}
+/**
+ * Callback interface for collecting information about the SDK at runtime.
+ *
+ * This interface is used to track current identity state of the SDK.
+ *
+ * This interface should not be used by the application to access flags for the purpose of controlling application
+ * flow. It is intended for monitoring, analytics, or debugging purposes.
+ */
+export interface LDInspectionIdentifyHandler {
+    type: 'client-identity-changed';
+    /**
+     * Name of the inspector. Will be used for logging issues with the inspector.
+     */
+    name: string;
+    /**
+     * @deprecated All inspectors run synchronously. This field will be removed in a future major version.
+     */
+    synchronous?: boolean;
+    /**
+     * This method will be called when an identify operation completes.
+     */
+    method: (context: LDContext) => void;
+}
+export type LDInspection = LDInspectionFlagUsedHandler | LDInspectionFlagDetailsChangedHandler | LDInspectionFlagDetailChangedHandler | LDInspectionIdentifyHandler;
+//# sourceMappingURL=LDInspection.d.ts.map

package/dist/esm/api/LDInspection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDInspection.d.ts","sourceRoot":"","sources":["../../src/api/LDInspection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;CACxF;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,KAAK,IAAI,CAAC;CAC/D;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,qBAAqB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAC/D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,yBAAyB,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;CACtC;AAED,MAAM,MAAM,YAAY,GACpB,2BAA2B,GAC3B,qCAAqC,GACrC,oCAAoC,GACpC,2BAA2B,CAAC"}