@launchdarkly/js-client-sdk-common 1.15.2 → 1.17.0

package/dist/cjs/flag-manager/FlagUpdater.d.ts

@@ -1,7 +1,7 @@
 import { Context, LDLogger } from '@launchdarkly/js-sdk-common';
 import FlagStore from './FlagStore';
 import { ItemDescriptor } from './ItemDescriptor';
-export type FlagChangeType = 'init' | 'patch';
+export type FlagChangeType = 'init' | 'patch' | 'override';
 /**
  * This callback indicates that the details associated with one or more flags
  * have changed.
@@ -21,20 +21,48 @@ export type FlagsChangeCallback = (context: Context, flagKeys: Array<string>, ty
  * It handles versions checking to handle out of order flag updates and
  * also handles flag comparisons for change notification.
  */
-export default class FlagUpdater {
-    private _flagStore;
-    private _logger;
-    private _activeContextKey;
-    private _changeCallbacks;
-    constructor(flagStore: FlagStore, logger: LDLogger);
+export interface FlagUpdater {
+    /**
+     * Handles the flag changes by calling the change callbacks.
+     *
+     * @param keys keys of the flags that changed
+     * @param type type of change that occurred see {@link FlagChangeType}
+     */
+    handleFlagChanges(keys: string[], type: FlagChangeType): void;
+    /**
+     * Initializes the flag updater with the given context and flags.
+     * This will be called every time a new context is identified.
+     *
+     * @param context the context to initialize the flag updater with
+     * @param newFlags the flags to initialize the flag updater with
+     */
     init(context: Context, newFlags: {
         [key: string]: ItemDescriptor;
     }): void;
     initCached(context: Context, newFlags: {
         [key: string]: ItemDescriptor;
     }): void;
+    /**
+     * Upserts the flag with the given key and item.
+     *
+     * @param context the context to upsert the flag with
+     * @param key the key of the flag to upsert
+     * @param item the item to upsert the flag with
+     * @returns true if the flag was upserted, false otherwise
+     */
     upsert(context: Context, key: string, item: ItemDescriptor): boolean;
+    /**
+     * Registers a callback to be called when the flags change.
+     *
+     * @param callback the callback to register
+     */
     on(callback: FlagsChangeCallback): void;
+    /**
+     * Unregisters a callback to be called when the flags change.
+     *
+     * @param callback the callback to unregister
+     */
     off(callback: FlagsChangeCallback): void;
 }
+export default function createFlagUpdater(_flagStore: FlagStore, _logger: LDLogger): FlagUpdater;
 //# sourceMappingURL=FlagUpdater.d.ts.map

package/dist/cjs/flag-manager/FlagUpdater.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FlagUpdater.d.ts","sourceRoot":"","sources":["../../src/flag-manager/FlagUpdater.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9C;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,EACvB,IAAI,EAAE,cAAc,KACjB,IAAI,CAAC;AAEV;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,OAAO,CAAW;IAC1B,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,gBAAgB,CAAoC;gBAEhD,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ;IAKlD,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE;IAgBlE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE;IAQxE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO;IAuBpE,EAAE,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI;IAIvC,GAAG,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI;CAMzC"}
+{"version":3,"file":"FlagUpdater.d.ts","sourceRoot":"","sources":["../../src/flag-manager/FlagUpdater.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,EACvB,IAAI,EAAE,cAAc,KACjB,IAAI,CAAC;AAEV;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAE9D;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1E,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,GAAG,IAAI,CAAC;IAEhF;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC;IAErE;;;;OAIG;IACH,EAAE,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,GAAG,WAAW,CAoE/F"}