@launchdarkly/js-client-sdk-common 0.1.0-alpha

package/dist/api/LDClient.d.ts

@@ -0,0 +1,285 @@
+import { LDContext, LDEvaluationDetail, LDEvaluationDetailTyped, LDFlagSet, LDFlagValue, LDLogger } from '@launchdarkly/js-sdk-common';
+/**
+ * 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(): 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 hash
+     *   The signed context key if you are using [Secure Mode](https://docs.launchdarkly.com/sdk/features/secure-mode#configuring-secure-mode-in-the-javascript-client-side-sdk).
+     * @returns
+     *   A Promise which resolves when the flag values for the specified context are available.
+     */
+    identify(context: LDContext, hash?: string): 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>;
+    /**
+     * Returns the logger configured as part of LDOptions during construction.
+     *
+     * For more, read {@link LDOptions.logger}.
+     */
+    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.
+     *
+     * 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.
+     *
+     * The following event names (keys) are used by the client:
+     *
+     * - `"identifying"`: The client starts to fetch feature flags.
+     * - `"error"`: General event for any kind of error condition during client operation.
+     *   The callback parameter is an Error object. If you do not listen for "error"
+     *   events, then the errors will be logged with `console.log()`.
+     * - `"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.
+     *
+     * @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.
+     *
+     * 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.
+     *
+     * 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.
+     *
+     * 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 `evaluationExplanations` to true in {@link LDOptions}.
+     * Otherwise, the `reason` property of the result will be null.
+     *
+     * 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;
+}
+//# sourceMappingURL=LDClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LDClient.d.ts","sourceRoot":"","sources":["../../src/api/LDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACvB,SAAS,EACT,WAAW,EACX,QAAQ,EACT,MAAM,6BAA6B,CAAC;AAErC;;;;;;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,IAAI,CAAC;IAEd;;;;;;;;;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;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;;;;;;;;;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;;;;OAIG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;;;;;;;OAUG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;;;;;;;;;;;;;;OAkBG;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;;;;;;;;;;;;;;;;;;;OAmBG;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;;;;;;;;;;;;;;;;;;OAkBG;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;;;;;;;;;;;;;;;OAeG;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;CAC9E"}

package/dist/api/LDClient.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LDClient.js.map

package/dist/api/LDClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDClient.js","sourceRoot":"","sources":["../../src/api/LDClient.ts"],"names":[],"mappings":""}

package/dist/api/LDEmitter.d.ts

@@ -0,0 +1,37 @@
+export type EventName = 'identifying' | 'error' | 'change';
+/**
+ * Native api usage: EventTarget.
+ *
+ * This is an event emitter using the standard built-in EventTarget web api.
+ * https://developer.mozilla.org/en-US/docs/Web/API/EventTarget
+ *
+ * In react-native use event-target-shim to polyfill EventTarget. This is safe
+ * because the react-native repo uses it too.
+ * https://github.com/mysticatea/event-target-shim
+ */
+export default class LDEmitter {
+    private et;
+    private listeners;
+    /**
+     * Cache all listeners in a Map so we can remove them later
+     * @param name string event name
+     * @param originalListener pointer to the original function as specified by
+     * the consumer
+     * @param customListener pointer to the custom function based on original
+     * listener. This is needed to allow for CustomEvents.
+     * @private
+     */
+    private saveListener;
+    on(name: EventName, listener: Function): void;
+    /**
+     * Unsubscribe one or all events.
+     *
+     * @param name
+     * @param listener Optional. If unspecified, all listeners for the event will be removed.
+     */
+    off(name: EventName, listener?: Function): void;
+    emit(name: EventName, ...detail: any[]): void;
+    eventNames(): string[];
+    listenerCount(name: EventName): number;
+}
+//# sourceMappingURL=LDEmitter.d.ts.map

package/dist/api/LDEmitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDEmitter.d.ts","sourceRoot":"","sources":["../../src/api/LDEmitter.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;AAM3D;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,EAAE,CAAkC;IAE5C,OAAO,CAAC,SAAS,CAAqD;IAEtE;;;;;;;;OAQG;IACH,OAAO,CAAC,YAAY;IASpB,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ;IAWtC;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,QAAQ;IA2BxC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE;IAItC,UAAU,IAAI,MAAM,EAAE;IAItB,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;CAGvC"}

package/dist/api/LDEmitter.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Native api usage: EventTarget.
+ *
+ * This is an event emitter using the standard built-in EventTarget web api.
+ * https://developer.mozilla.org/en-US/docs/Web/API/EventTarget
+ *
+ * In react-native use event-target-shim to polyfill EventTarget. This is safe
+ * because the react-native repo uses it too.
+ * https://github.com/mysticatea/event-target-shim
+ */
+class LDEmitter {
+    constructor() {
+        this.et = new EventTarget();
+        this.listeners = new Map();
+    }
+    /**
+     * Cache all listeners in a Map so we can remove them later
+     * @param name string event name
+     * @param originalListener pointer to the original function as specified by
+     * the consumer
+     * @param customListener pointer to the custom function based on original
+     * listener. This is needed to allow for CustomEvents.
+     * @private
+     */
+    saveListener(name, originalListener, customListener) {
+        var _a;
+        const listener = { original: originalListener, custom: customListener };
+        if (!this.listeners.has(name)) {
+            this.listeners.set(name, [listener]);
+        }
+        else {
+            (_a = this.listeners.get(name)) === null || _a === void 0 ? void 0 : _a.push(listener);
+        }
+    }
+    on(name, listener) {
+        const customListener = (e) => {
+            const { detail } = e;
+            // invoke listener with args from CustomEvent
+            listener(...detail);
+        };
+        this.saveListener(name, listener, customListener);
+        this.et.addEventListener(name, customListener);
+    }
+    /**
+     * Unsubscribe one or all events.
+     *
+     * @param name
+     * @param listener Optional. If unspecified, all listeners for the event will be removed.
+     */
+    off(name, listener) {
+        const existingListeners = this.listeners.get(name);
+        if (!existingListeners) {
+            return;
+        }
+        if (listener) {
+            const toBeRemoved = existingListeners.find((c) => c.original === listener);
+            this.et.removeEventListener(name, toBeRemoved === null || toBeRemoved === void 0 ? void 0 : toBeRemoved.custom);
+            // remove from internal cache
+            const updated = existingListeners.filter((l) => l.original !== listener);
+            if (updated.length === 0) {
+                this.listeners.delete(name);
+            }
+            else {
+                this.listeners.set(name, updated);
+            }
+            return;
+        }
+        // remove all listeners
+        existingListeners.forEach((l) => {
+            this.et.removeEventListener(name, l.custom);
+        });
+        this.listeners.delete(name);
+    }
+    emit(name, ...detail) {
+        this.et.dispatchEvent(new CustomEvent(name, { detail }));
+    }
+    eventNames() {
+        return [...this.listeners.keys()];
+    }
+    listenerCount(name) {
+        var _a, _b;
+        return (_b = (_a = this.listeners.get(name)) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
+    }
+}
+exports.default = LDEmitter;
+//# sourceMappingURL=LDEmitter.js.map

package/dist/api/LDEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDEmitter.js","sourceRoot":"","sources":["../../src/api/LDEmitter.ts"],"names":[],"mappings":";;AAMA;;;;;;;;;GASG;AACH,MAAqB,SAAS;IAA9B;QACU,OAAE,GAAgB,IAAI,WAAW,EAAE,CAAC;QAEpC,cAAS,GAA2C,IAAI,GAAG,EAAE,CAAC;IA2ExE,CAAC;IAzEC;;;;;;;;OAQG;IACK,YAAY,CAAC,IAAe,EAAE,gBAA0B,EAAE,cAAwB;;QACxF,MAAM,QAAQ,GAAG,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QACxE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC7B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtC;aAAM;YACL,MAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,0CAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC1C;IACH,CAAC;IAED,EAAE,CAAC,IAAe,EAAE,QAAkB;QACpC,MAAM,cAAc,GAAG,CAAC,CAAQ,EAAE,EAAE;YAClC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAgB,CAAC;YAEpC,6CAA6C;YAC7C,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC;QACtB,CAAC,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;QAClD,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,IAAe,EAAE,QAAmB;QACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,iBAAiB,EAAE;YACtB,OAAO;SACR;QAED,IAAI,QAAQ,EAAE;YACZ,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;YAC3E,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAa,CAAC,CAAC;YAE9D,6BAA6B;YAC7B,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;YACzE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACxB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAC7B;iBAAM;gBACL,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;aACnC;YACD,OAAO;SACR;QAED,uBAAuB;QACvB,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC9B,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,MAAa,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,IAAe,EAAE,GAAG,MAAa;QACpC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,UAAU;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,aAAa,CAAC,IAAe;;QAC3B,OAAO,MAAA,MAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,0CAAE,MAAM,mCAAI,CAAC,CAAC;IAC/C,CAAC;CACF;AA9ED,4BA8EC"}

package/dist/api/LDInspection.d.ts

@@ -0,0 +1,88 @@
+import { LDContext, LDEvaluationDetail } from '@launchdarkly/js-sdk-common';
+/**
+ * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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/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,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAE5E;;;;;;;GAOG;AAEH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;CACvF;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;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;;;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,MAAM,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;CACtC;AAED,MAAM,MAAM,YAAY,GACpB,2BAA2B,GAC3B,qCAAqC,GACrC,oCAAoC,GACpC,2BAA2B,CAAC"}

package/dist/api/LDInspection.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LDInspection.js.map

package/dist/api/LDInspection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDInspection.js","sourceRoot":"","sources":["../../src/api/LDInspection.ts"],"names":[],"mappings":""}