@launchdarkly/js-sdk-common 2.10.0 → 2.11.0

package/dist/esm/api/context/LDContext.d.ts

@@ -0,0 +1,8 @@
+import { LDMultiKindContext } from './LDMultiKindContext';
+import { LDSingleKindContext } from './LDSingleKindContext';
+import { LDUser } from './LDUser';
+/**
+ * A LaunchDarkly context object.
+ */
+export type LDContext = LDUser | LDSingleKindContext | LDMultiKindContext;
+//# sourceMappingURL=LDContext.d.ts.map

package/dist/esm/api/context/LDContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDContext.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,mBAAmB,GAAG,kBAAkB,CAAC"}

package/dist/esm/api/context/LDContextCommon.d.ts

@@ -0,0 +1,29 @@
+import { LDContextMeta } from './LDContextMeta';
+export interface LDContextCommon {
+    /**
+     * A unique string identifying a context.
+     */
+    key: string;
+    /**
+     * The context's name.
+     *
+     * You can search for contexts on the Contexts page by name.
+     */
+    name?: string;
+    /**
+     * Meta attributes are used to control behavioral aspects of the Context, such as private
+     * private attributes. See {@link LDContextMeta.privateAttributes} as an example.
+     *
+     * They cannot be addressed in targeting rules.
+     */
+    _meta?: LDContextMeta;
+    /**
+     * If true, the context will _not_ appear on the Contexts page in the LaunchDarkly dashboard.
+     */
+    anonymous?: boolean;
+    /**
+     * Any additional attributes associated with the context.
+     */
+    [attribute: string]: any;
+}
+//# sourceMappingURL=LDContextCommon.d.ts.map

package/dist/esm/api/context/LDContextCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDContextCommon.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDContextCommon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;CAC1B"}

package/dist/esm/api/context/LDContextMeta.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Meta attributes are used to control behavioral aspects of the Context.
+ * They cannot be addressed in targeting rules.
+ */
+export interface LDContextMeta {
+    /**
+     *
+     * Designate any number of Context attributes, or properties within them, as private: that is,
+     * their values will not be sent to LaunchDarkly.
+     *
+     * Each parameter can be a simple attribute name, such as "email". Or, if the first character is
+     * a slash, the parameter is interpreted as a slash-delimited path to a property within a JSON
+     * object, where the first path component is a Context attribute name and each following
+     * component is a nested property name: for example, suppose the attribute "address" had the
+     * following JSON object value:
+     *
+     * ```
+     * {"street": {"line1": "abc", "line2": "def"}}
+     * ```
+     *
+     * Using ["/address/street/line1"] in this case would cause the "line1" property to be marked as
+     * private. This syntax deliberately resembles JSON Pointer, but other JSON Pointer features
+     * such as array indexing are not supported for Private.
+     *
+     * This action only affects analytics events that involve this particular Context. To mark some
+     * (or all) Context attributes as private for all users, use the overall configuration for the
+     * SDK.
+     * See {@link LDOptions.allAttributesPrivate} and {@link LDOptions.privateAttributes}.
+     *
+     * The attributes "kind" and "key", and the "_meta" attributes cannot be made private.
+     *
+     * In this example, firstName is marked as private, but lastName is not:
+     *
+     * ```
+     * const context = {
+     *   kind: 'org',
+     *   key: 'my-key',
+     *   firstName: 'Pierre',
+     *   lastName: 'Menard',
+     *   _meta: {
+     *     privateAttributes: ['firstName'],
+     *   }
+     * };
+     * ```
+     *
+     * This is a metadata property, rather than an attribute that can be addressed in evaluations:
+     * that is, a rule clause that references the attribute name "privateAttributes", will not use
+     * this value, but would use a "privateAttributes" attribute set on the context.
+     */
+    privateAttributes?: string[];
+}
+//# sourceMappingURL=LDContextMeta.d.ts.map

package/dist/esm/api/context/LDContextMeta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDContextMeta.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDContextMeta.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B"}

package/dist/esm/api/context/LDMultiKindContext.d.ts

@@ -0,0 +1,46 @@
+import { LDContextCommon } from './LDContextCommon';
+/**
+ * A context which represents multiple kinds. Each kind having its own key and attributes.
+ *
+ * A multi-context must contain `kind: 'multi'` at the root.
+ *
+ * ```
+ * const myMultiContext = {
+ *   // Multi-contexts must be of kind 'multi'.
+ *   kind: 'multi',
+ *   // The context is namespaced by its kind. This is an 'org' kind context.
+ *   org: {
+ *     // Each component context has its own key and attributes.
+ *     key: 'my-org-key',
+ *     someAttribute: 'my-attribute-value',
+ *   },
+ *   user: {
+ *     key: 'my-user-key',
+ *     firstName: 'Bob',
+ *     lastName: 'Bobberson',
+ *     _meta: {
+ *       // Each component context has its own _meta attributes. This will only apply the this
+ *       // 'user' context.
+ *       privateAttributes: ['firstName']
+ *     }
+ *   }
+ * };
+ * ```
+ *
+ * The above multi-context contains both an 'org' and a 'user'. Each with their own key,
+ * attributes, and _meta attributes.
+ */
+export interface LDMultiKindContext {
+    /**
+     * The kind of the context.
+     */
+    kind: 'multi';
+    /**
+     * The contexts which compose this multi-kind context.
+     *
+     * These should be of type LDContextCommon. "multi" is to allow
+     * for the top level "kind" attribute.
+     */
+    [kind: string]: 'multi' | LDContextCommon;
+}
+//# sourceMappingURL=LDMultiKindContext.d.ts.map

package/dist/esm/api/context/LDMultiKindContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDMultiKindContext.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDMultiKindContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;OAKG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC;CAC3C"}

package/dist/esm/api/context/LDSingleKindContext.d.ts

@@ -0,0 +1,24 @@
+import { LDContextCommon } from './LDContextCommon';
+/**
+ * A context which represents a single kind.
+ *
+ * For a single kind context the 'kind' may not be 'multi'.
+ *
+ * ```
+ * const myOrgContext = {
+ *   kind: 'org',
+ *   key: 'my-org-key',
+ *   someAttribute: 'my-attribute-value'
+ * };
+ * ```
+ *
+ * The above context would be a single kind context representing an organization. It has a key
+ * for that organization, and a single attribute 'someAttribute'.
+ */
+export interface LDSingleKindContext extends LDContextCommon {
+    /**
+     * The kind of the context.
+     */
+    kind: string;
+}
+//# sourceMappingURL=LDSingleKindContext.d.ts.map

package/dist/esm/api/context/LDSingleKindContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDSingleKindContext.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDSingleKindContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/esm/api/context/LDUser.d.ts

@@ -0,0 +1,66 @@
+/**
+ * A LaunchDarkly user object.
+ *
+ * @deprecated
+ */
+export interface LDUser {
+    /**
+     * A unique string identifying a user.
+     */
+    key: string;
+    /**
+     * The user's name.
+     *
+     * You can search for users on the User page by name.
+     */
+    name?: string;
+    /**
+     * The user's first name.
+     */
+    firstName?: string;
+    /**
+     * The user's last name.
+     */
+    lastName?: string;
+    /**
+     * The user's email address.
+     *
+     * If an `avatar` URL is not provided, LaunchDarkly will use Gravatar
+     * to try to display an avatar for the user on the Users page.
+     */
+    email?: string;
+    /**
+     * An absolute URL to an avatar image for the user.
+     */
+    avatar?: string;
+    /**
+     * The user's IP address.
+     *
+     * If you provide an IP, LaunchDarkly will use a geolocation service to
+     * automatically infer a `country` for the user, unless you've already
+     * specified one.
+     */
+    ip?: string;
+    /**
+     * The country associated with the user.
+     */
+    country?: string;
+    /**
+     * If true, the user will _not_ appear on the Users page in the LaunchDarkly dashboard.
+     */
+    anonymous?: boolean;
+    /**
+     * Any additional attributes associated with the user.
+     */
+    custom?: {
+        [key: string]: string | boolean | number | Array<string | boolean | number>;
+    };
+    /**
+     * Specifies a list of attribute names (either built-in or custom) which should be
+     * marked as private, and not sent to LaunchDarkly in analytics events. This is in
+     * addition to any private attributes designated in the global configuration
+     * with {@link LDOptions.privateAttributes} or {@link LDOptions.allAttributesPrivate}.
+     */
+    privateAttributeNames?: Array<string>;
+}
+//# sourceMappingURL=LDUser.d.ts.map

package/dist/esm/api/context/LDUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDUser.d.ts","sourceRoot":"","sources":["../../../src/api/context/LDUser.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,CAAC;KAC7E,CAAC;IAEF;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvC"}

package/dist/esm/api/context/index.d.ts

@@ -0,0 +1,7 @@
+export * from './LDContextCommon';
+export * from './LDContextMeta';
+export * from './LDMultiKindContext';
+export * from './LDSingleKindContext';
+export * from './LDUser';
+export * from './LDContext';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/api/context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

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

@@ -0,0 +1,43 @@
+import { LDEvaluationReason } from './LDEvaluationReason';
+import { LDFlagValue } from './LDFlagValue';
+/**
+ * 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`.
+ *
+ * For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#nodejs-server-side).
+ */
+export interface LDEvaluationDetail {
+    /**
+     * The result of the flag evaluation. This will be either one of the flag's variations or
+     * the default value that was passed to `LDClient.variationDetail`.
+     */
+    value: LDFlagValue;
+    /**
+     * The index of the returned value within the flag's list of variations, e.g. 0 for the
+     * first variation-- or `null` if the default value was returned.
+     */
+    variationIndex?: number | null;
+    /**
+     * An object describing the main factor that influenced the flag evaluation value.
+     */
+    reason: LDEvaluationReason;
+}
+export interface LDEvaluationDetailTyped<TFlag> {
+    /**
+     * The result of the flag evaluation. This will be either one of the flag's variations or
+     * the default value that was passed to `LDClient.variationDetail`.
+     */
+    value: TFlag;
+    /**
+     * The index of the returned value within the flag's list of variations, e.g. 0 for the
+     * first variation-- or `null` if the default value was returned.
+     */
+    variationIndex?: number | null;
+    /**
+     * An object describing the main factor that influenced the flag evaluation value.
+     */
+    reason: LDEvaluationReason;
+}
+//# sourceMappingURL=LDEvaluationDetail.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LDEvaluationDetail.d.ts","sourceRoot":"","sources":["../../../src/api/data/LDEvaluationDetail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,EAAE,WAAW,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB,CAAC,KAAK;IAC5C;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B"}

package/dist/esm/api/data/LDEvaluationReason.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Describes the reason that a flag evaluation produced a particular value. This is
+ * part of the {@link LDEvaluationDetail} object returned by `LDClient.variationDetail`.
+ */
+export interface LDEvaluationReason {
+    /**
+     * The general category of the reason:
+     *
+     * - `'OFF'`: The flag was off and therefore returned its configured off value.
+     * - `'FALLTHROUGH'`: The flag was on but the context did not match any targets or rules.
+     * - `'TARGET_MATCH'`: The context key was specifically targeted for this flag.
+     * - `'RULE_MATCH'`: the context matched one of the flag's rules.
+     * - `'PREREQUISITE_FAILED'`: The flag was considered off because it had at least one
+     *   prerequisite flag that either was off or did not return the desired variation.
+     * - `'ERROR'`: The flag could not be evaluated, e.g. because it does not exist or due
+     *   to an unexpected error.
+     */
+    kind: string;
+    /**
+     * A further description of the error condition, if the kind was `'ERROR'`.
+     */
+    errorKind?: string;
+    /**
+     * The index of the matched rule (0 for the first), if the kind was `'RULE_MATCH'`.
+     */
+    ruleIndex?: number;
+    /**
+     * The unique identifier of the matched rule, if the kind was `'RULE_MATCH'`.
+     */
+    ruleId?: string;
+    /**
+     * The key of the failed prerequisite flag, if the kind was `'PREREQUISITE_FAILED'`.
+     */
+    prerequisiteKey?: string;
+    /**
+     * Whether the evaluation was part of an experiment.
+     *
+     * This is true if the evaluation resulted in an experiment rollout and served one of
+     * the variations in the experiment. Otherwise it is false or undefined.
+     */
+    inExperiment?: boolean;
+    /**
+     * Describes the validity of Big Segment information, if and only if the flag evaluation
+     * required querying at least one Big Segment.
+     *
+     * - `'HEALTHY'`: The Big Segment query involved in the flag evaluation was successful, and
+     *   the segment state is considered up to date.
+     * - `'STALE'`: The Big Segment query involved in the flag evaluation was successful, but
+     *   the segment state may not be up to date
+     * - `'NOT_CONFIGURED'`: Big Segments could not be queried for the flag evaluation because
+     *   the SDK configuration did not include a Big Segment store.
+     * - `'STORE_ERROR'`: The Big Segment query involved in the flag evaluation failed, for
+     *   instance due to a database error.
+     */
+    bigSegmentsStatus?: 'HEALTHY' | 'STALE' | 'NOT_CONFIGURED' | 'STORE_ERROR';
+}
+//# sourceMappingURL=LDEvaluationReason.d.ts.map

package/dist/esm/api/data/LDEvaluationReason.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDEvaluationReason.d.ts","sourceRoot":"","sources":["../../../src/api/data/LDEvaluationReason.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;OAWG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,gBAAgB,GAAG,aAAa,CAAC;CAC5E"}

package/dist/esm/api/data/LDFlagSet.d.ts

@@ -0,0 +1,8 @@
+import { LDFlagValue } from './LDFlagValue';
+/**
+ * A map of feature flags from their keys to their values.
+ */
+export interface LDFlagSet {
+    [key: string]: LDFlagValue;
+}
+//# sourceMappingURL=LDFlagSet.d.ts.map

package/dist/esm/api/data/LDFlagSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDFlagSet.d.ts","sourceRoot":"","sources":["../../../src/api/data/LDFlagSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;CAC5B"}

package/dist/esm/api/data/LDFlagValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The types of values a feature flag can have.
+ *
+ * Flags can have any JSON-serializable value.
+ */
+export type LDFlagValue = any;
+//# sourceMappingURL=LDFlagValue.d.ts.map

package/dist/esm/api/data/LDFlagValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDFlagValue.d.ts","sourceRoot":"","sources":["../../../src/api/data/LDFlagValue.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC"}

package/dist/esm/api/data/index.d.ts

@@ -0,0 +1,5 @@
+export * from './LDEvaluationDetail';
+export * from './LDEvaluationReason';
+export * from './LDFlagSet';
+export * from './LDFlagValue';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/api/data/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/data/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}

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

@@ -0,0 +1,7 @@
+export * from './context';
+export * from './logging';
+export * from './data';
+export * from './options';
+export * from './platform';
+export * as subsystem from './subsystem';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC"}

package/dist/esm/api/logging/BasicLoggerOptions.d.ts

@@ -0,0 +1,43 @@
+import { LDLogLevel } from './LDLogLevel';
+/**
+ * Configuration for {@link basicLogger}.
+ */
+export interface BasicLoggerOptions {
+    /**
+     * The lowest level of log message to enable.
+     *
+     * See {@link LDLogLevel} for a list of possible levels. Setting a level here causes
+     * all lower-importance levels to be disabled: for instance, if you specify
+     * `'warn'`, then `'debug'` and `'info'` are disabled.
+     *
+     * If not specified, the default is `'info'` (meaning that `'debug'` is disabled).
+     */
+    level?: LDLogLevel;
+    /**
+     * Name to use for the log entires. The default name is `LaunchDarkly`.
+     */
+    name?: string;
+    /**
+     * An optional function to use to print each log line.
+     *
+     * If this is specified, `basicLogger` calls it to write each line of output. The
+     * argument is a fully formatted log line, not including a linefeed. The function
+     * is only called for log levels that are enabled.
+     *
+     * If not specified, the default is `console.error`.
+     *
+     * Setting this property to anything other than a function will cause SDK
+     * initialization to fail.
+     */
+    destination?: (line: string) => void;
+    /**
+     * An optional formatter to use. The formatter should be compatible
+     * with node-style format strings like those used with `util.format`.
+     *
+     * If not specified, then a default implementation will be used.
+     * But using a node-specific implementation, for instance, would
+     * have performance and quality benefits.
+     */
+    formatter?: (...args: any[]) => string;
+}
+//# sourceMappingURL=BasicLoggerOptions.d.ts.map

package/dist/esm/api/logging/BasicLoggerOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasicLoggerOptions.d.ts","sourceRoot":"","sources":["../../../src/api/logging/BasicLoggerOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAErC;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC;CACxC"}

package/dist/esm/api/logging/LDLogLevel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Logging levels that can be used with {@link basicLogger}.
+ *
+ * Set{@link BasicLoggerOptions.level} to one of these values to control what levels
+ * of log messages are enabled. Going from lowest importance (and most verbose)
+ * to most importance, the levels are `'debug'`, `'info'`, `'warn'`, and `'error'`.
+ * You can also specify `'none'` instead to disable all logging.
+ */
+export type LDLogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
+//# sourceMappingURL=LDLogLevel.d.ts.map

package/dist/esm/api/logging/LDLogLevel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDLogLevel.d.ts","sourceRoot":"","sources":["../../../src/api/logging/LDLogLevel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC"}

package/dist/esm/api/logging/LDLogger.d.ts

@@ -0,0 +1,47 @@
+/**
+ * The LaunchDarkly client logger interface.
+ *
+ * The {@link LDOptions.logger} property accepts any object that conforms to this
+ * interface. The SDK only uses four logging levels: `error`, `warn`, `info`, and
+ * `debug`. It will call the corresponding method of the `LDLogger` either with a
+ * single string argument, or with a format string and variable arguments in the
+ * format used by Node's `util.format()`.
+ *
+ * The [Winston](https://github.com/winstonjs/winston) logging package provides a
+ * logger that conforms to this interface, so if you have created a logger with
+ * Winston, you can simply put it into the {@link LDOptions.logger} property.
+ *
+ * If you do not provide a logger object, the SDK uses the {@link basicLogger}
+ * implementation with a minimum level of `info`.
+ */
+export interface LDLogger {
+    /**
+     * The error logger.
+     *
+     * @param args
+     *   A sequence of any JavaScript values.
+     */
+    error(...args: any[]): void;
+    /**
+     * The warning logger.
+     *
+     * @param args
+     *   A sequence of any JavaScript values.
+     */
+    warn(...args: any[]): void;
+    /**
+     * The info logger.
+     *
+     * @param args
+     *   A sequence of any JavaScript values.
+     */
+    info(...args: any[]): void;
+    /**
+     * The debug logger.
+     *
+     * @param args
+     *   A sequence of any JavaScript values.
+     */
+    debug(...args: any[]): void;
+}
+//# sourceMappingURL=LDLogger.d.ts.map

package/dist/esm/api/logging/LDLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDLogger.d.ts","sourceRoot":"","sources":["../../../src/api/logging/LDLogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;OAKG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE5B;;;;;OAKG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;CAC7B"}

package/dist/esm/api/logging/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BasicLoggerOptions';
+export * from './LDLogger';
+export * from './LDLogLevel';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/api/logging/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/logging/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/dist/esm/api/options/LDClientContext.d.ts

@@ -0,0 +1,46 @@
+import { LDLogger } from '../logging';
+import { Platform } from '../platform';
+/**
+ * Specifies the base service URIs used by SDK components.
+ */
+export interface LDServiceEndpoints {
+}
+/**
+ * The most basic properties of the SDK client that are available to all SDK component factories.
+ */
+export interface LDBasicConfiguration {
+    /**
+     * The configured SDK key.
+     */
+    sdkKey: string;
+    /**
+     * Defines the base service URIs used by SDK components.
+     */
+    serviceEndpoints: LDServiceEndpoints;
+    /**
+     * True if the SDK was configured to be completely offline.
+     */
+    offline?: boolean;
+    logger?: LDLogger;
+    tags?: {
+        value?: string;
+    };
+}
+/**
+ * Factory methods receive this class as a parameter.
+ *
+ * Its public properties provide information about the SDK configuration and environment. The SDK
+ * may also include non-public properties that are relevant only when creating one of the built-in
+ * component types and are not accessible to custom components.
+ */
+export interface LDClientContext {
+    /**
+     * The SDK's basic global properties.
+     */
+    basicConfiguration: LDBasicConfiguration;
+    /**
+     * Interfaces providing platform specific information and functionality.
+     */
+    platform: Platform;
+}
+//# sourceMappingURL=LDClientContext.d.ts.map

package/dist/esm/api/options/LDClientContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDClientContext.d.ts","sourceRoot":"","sources":["../../../src/api/options/LDClientContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,kBAAkB;CAElC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAC;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,QAAQ,CAAC;IAElB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,kBAAkB,EAAE,oBAAoB,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB"}

package/dist/esm/api/options/index.d.ts

@@ -0,0 +1,3 @@
+import { LDClientContext } from './LDClientContext';
+export { LDClientContext };
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/api/options/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/options/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,CAAC"}