capacitor-launchdarkly 0.0.0-stage → 0.1.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,520 @@
+import type { PluginsConfig } from '@capacitor/cli';
+import type { PluginListenerHandle } from '@capacitor/core';
+declare module '@capacitor/cli' {
+    interface PluginsConfig {
+        /**
+         * Starts the native LaunchDarkly client as the app launches, before the
+         * web view runs any app code. Leave `mobileKey` out to start it from
+         * JavaScript with `initialize()` instead. iOS and Android only.
+         */
+        LaunchDarkly?: {
+            /**
+             * The mobile key of the LaunchDarkly environment. Without it there is
+             * no native start-up, and `initialize()` starts the client instead.
+             *
+             * @since 0.1.0
+             * @example "mob-00000000-0000-0000-0000-000000000000"
+             */
+            mobileKey?: string;
+            /**
+             * The context the native start-up uses when no context was stored by an
+             * earlier `identify()`.
+             *
+             * @since 0.1.0
+             * @default { kind: 'user', key: 'anonymous_user', anonymous: true }
+             * @example { "kind": "user", "key": "anonymous_user", "anonymous": true }
+             */
+            initialContext?: LDContext;
+            /**
+             * Streams flag updates when `true`, polls when `false`.
+             *
+             * @since 0.1.0
+             * @default true
+             * @example true
+             */
+            streaming?: boolean;
+            /**
+             * Asks LaunchDarkly for the reason behind each evaluation.
+             *
+             * @since 0.1.0
+             * @default false
+             * @example false
+             */
+            evaluationReasons?: boolean;
+            /**
+             * Starts the client offline, until `setOnline({ online: true })`.
+             *
+             * @since 0.1.0
+             * @default false
+             * @example false
+             */
+            offline?: boolean;
+            /**
+             * How long the start waits for the first set of flags, in seconds.
+             *
+             * @since 0.1.0
+             * @default 5
+             * @example 5
+             */
+            startWaitSeconds?: number;
+            /**
+             * Application metadata sent to LaunchDarkly with every request.
+             *
+             * @since 0.1.0
+             * @example { "id": "com.example.plugin", "version": "1.0.0" }
+             */
+            application?: LDApplicationInfo;
+        };
+    }
+}
+/**
+ * The `plugins.LaunchDarkly` block of `capacitor.config`.
+ */
+export type LaunchDarklyConfig = NonNullable<PluginsConfig['LaunchDarkly']>;
+export interface LaunchDarklyPlugin {
+    /**
+     * Starts the client from JavaScript and waits for the first set of flags or
+     * `options.startWaitSeconds` (5 by default), whichever comes first.
+     *
+     * - **iOS, Android**: takes `mobileKey`. Needed only by an app that does not
+     *   put a `mobileKey` in `capacitor.config`; with one there, the client is
+     *   already running when the app's code starts, and this call only answers
+     *   its state.
+     * - **Web**: takes `clientSideId`, and is the only way to start the client.
+     *   Needs `@launchdarkly/js-client-sdk` installed (see the README).
+     *
+     * `context` plays the part of `initialContext`: when an earlier `identify()`
+     * stored a context, the client starts with the stored one instead, so the
+     * app does not flip to an anonymous context for a moment after a restart.
+     *
+     * There is one client per process (per page on the web). A second call with
+     * the same key, or a call after the native start-up already started a
+     * client with that key, changes nothing: the client is not created again,
+     * `context` and `options` are ignored, and the current state is answered.
+     * Use `identify()` to switch the context. A call with a different key closes
+     * the running client and starts a new one.
+     *
+     * @since 0.1.0
+     */
+    initialize(options: InitializeOptions): Promise<LaunchDarklyState>;
+    /**
+     * Answers whether the client has received its first set of flags, waiting
+     * up to `timeoutSeconds` (5 by default) for that when it has not yet.
+     *
+     * Resolves `{ initialized: false }` straight away when no client was
+     * started, neither natively nor with `initialize()`.
+     *
+     * @since 0.1.0
+     */
+    waitForInitialization(options?: WaitForInitializationOptions): Promise<WaitForInitializationResult>;
+    /**
+     * The state of the native client: whether it has its flags, the current
+     * context and the value of every flag, read from the native SDK's own
+     * store. Meant for bootstrapping the web layer at start without a second
+     * network round trip.
+     *
+     * While the native start-up is still running, this waits until it is done:
+     * until the first set of flags is in, or `startWaitSeconds` has passed.
+     * With no client at all it answers `initialized: false` and no flags.
+     *
+     * Reading the flags this way sends no evaluation events.
+     *
+     * @since 0.1.0
+     */
+    getState(): Promise<LaunchDarklyState>;
+    /**
+     * Switches the client to another context and resolves when the flags for
+     * it are loaded, or when `timeoutSeconds` (5 by default) has passed.
+     *
+     * The context the SDK accepted is stored natively, under a key of the
+     * plugin's own, and the next native start-up begins with it instead of
+     * `initialContext`. So an app logs out by identifying its anonymous
+     * context, which then becomes the stored one; `clearStoredContext()`
+     * forgets it altogether.
+     *
+     * An anonymous context keeps the key it is given. The plugin never asks the
+     * SDK to generate one.
+     *
+     * @since 0.1.0
+     */
+    identify(options: IdentifyOptions): Promise<IdentifyResult>;
+    /**
+     * Evaluates one flag for the current context and answers its value, of any
+     * JSON type, or `defaultValue` (`null` when left out) when the flag is
+     * unknown or the client has not started. Goes through the SDK's JSON
+     * variation call, so it records an evaluation event like any SDK call.
+     *
+     * @since 0.1.0
+     */
+    variation(options: VariationOptions): Promise<VariationResult>;
+    /**
+     * The value of every flag for the current context, from the native SDK's
+     * store. Sends no evaluation events. Empty when the client has not started.
+     *
+     * @since 0.1.0
+     */
+    allFlags(): Promise<AllFlagsResult>;
+    /**
+     * Switches between streaming and polling. Neither native SDK can change its
+     * data source while it runs, so the plugin closes the client and starts it
+     * again with the same mobile key, options and current context, then waits as
+     * at start-up. Flag listeners stay registered. The web SDK switches in place
+     * (`setStreaming()`).
+     *
+     * @since 0.1.0
+     */
+    setStreaming(options: SetStreamingOptions): Promise<void>;
+    /**
+     * Takes the client online or offline (`setOnline()` / `setOffline()` on
+     * Android, `setOnline(_:)` on iOS). Offline, the client keeps answering the
+     * values it has.
+     *
+     * The web SDK has no offline mode. There, going offline closes the stream so
+     * no flag updates arrive, and going online opens it again if `streaming` is
+     * on; analytics events are still sent.
+     *
+     * @since 0.1.0
+     */
+    setOnline(options: SetOnlineOptions): Promise<void>;
+    /**
+     * Sends the analytics events the client has queued.
+     *
+     * @since 0.1.0
+     */
+    flush(): Promise<void>;
+    /**
+     * Closes the client. It can be started again with `initialize()`; until
+     * then, `variation()` answers the default value. The stored context is
+     * kept.
+     *
+     * @since 0.1.0
+     */
+    close(): Promise<void>;
+    /**
+     * Forgets the context `identify()` stored, so the next native start-up
+     * begins with `initialContext` again. The running client is not changed.
+     *
+     * @since 0.1.0
+     */
+    clearStoredContext(): Promise<void>;
+    /**
+     * Called for every flag whose value changes: from the stream or a poll, and
+     * after `identify()` for each flag whose value differs for the new context.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'flagChange', listenerFunc: (change: FlagChange) => void): Promise<PluginListenerHandle>;
+    /**
+     * Called when the SDK's connection mode changes, for example from streaming
+     * to offline. iOS and Android only: the web SDK has no connection mode, and
+     * this is never called there.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'connectionModeChange', listenerFunc: (change: ConnectionModeChange) => void): Promise<PluginListenerHandle>;
+    /**
+     * Removes every listener of this plugin.
+     *
+     * @since 0.1.0
+     */
+    removeAllListeners(): Promise<void>;
+}
+export interface LaunchDarklyOptions {
+    /**
+     * Streams flag updates when `true`, polls when `false`.
+     *
+     * @since 0.1.0
+     * @default true
+     */
+    streaming?: boolean;
+    /**
+     * Asks LaunchDarkly for the reason behind each evaluation. The SDKs then
+     * attach it to their evaluation events.
+     *
+     * @since 0.1.0
+     * @default false
+     */
+    evaluationReasons?: boolean;
+    /**
+     * Starts the client offline: it answers cached or default values and does
+     * not connect until `setOnline({ online: true })`.
+     *
+     * The web SDK has no offline mode: there `offline: true` starts without a
+     * stream, and the first flags are still fetched once.
+     *
+     * @since 0.1.0
+     * @default false
+     */
+    offline?: boolean;
+    /**
+     * How long the start waits for the first set of flags, in seconds.
+     *
+     * @since 0.1.0
+     * @default 5
+     */
+    startWaitSeconds?: number;
+    /**
+     * Application metadata sent to LaunchDarkly with every request. It
+     * describes the app; it is not a context, and adds nothing to the contexts
+     * counted for billing.
+     *
+     * @since 0.1.0
+     */
+    application?: LDApplicationInfo;
+    /**
+     * Web only: flags to start with before LaunchDarkly answers. `'localStorage'`
+     * starts from the flags the web SDK cached in `localStorage` for the context
+     * on an earlier visit, which the SDK does on its own; a flag object (for
+     * example rendered by your server) starts from those values. The native
+     * SDKs always start from their own cache and ignore this.
+     *
+     * @since 0.1.0
+     */
+    bootstrap?: 'localStorage' | LDFlagSet;
+}
+export interface LDApplicationInfo {
+    /**
+     * @since 0.1.0
+     */
+    id?: string;
+    /**
+     * @since 0.1.0
+     */
+    name?: string;
+    /**
+     * @since 0.1.0
+     */
+    version?: string;
+    /**
+     * @since 0.1.0
+     */
+    versionName?: string;
+}
+export interface InitializeOptions {
+    /**
+     * The mobile key of the LaunchDarkly environment, used on iOS and Android.
+     *
+     * @since 0.1.0
+     */
+    mobileKey?: string;
+    /**
+     * The client-side ID of the LaunchDarkly environment, used on the web.
+     *
+     * @since 0.1.0
+     */
+    clientSideId?: string;
+    /**
+     * @since 0.1.0
+     */
+    context: LDContext;
+    /**
+     * @since 0.1.0
+     */
+    options?: LaunchDarklyOptions;
+}
+/**
+ * A context in the JSON shape LaunchDarkly's SDKs use: a single-kind context
+ * or a multi-context.
+ */
+export type LDContext = LDSingleKindContext | LDMultiKindContext;
+/**
+ * A context of one kind. Any other property is a custom attribute: a string,
+ * number, boolean, array or object.
+ */
+export interface LDSingleKindContext {
+    /**
+     * The context kind, for example `user` or `organization`.
+     *
+     * @since 0.1.0
+     */
+    kind: string;
+    /**
+     * The key. An anonymous context keeps the key it is given.
+     *
+     * @since 0.1.0
+     */
+    key: string;
+    /**
+     * @since 0.1.0
+     */
+    name?: string;
+    /**
+     * Leaves the context out of the dashboard's context list. It is still
+     * counted for billing by its key.
+     *
+     * @since 0.1.0
+     */
+    anonymous?: boolean;
+    /**
+     * @since 0.1.0
+     */
+    _meta?: LDContextMeta;
+    [attribute: string]: unknown;
+}
+/**
+ * One kind of a multi-context: the attributes of `LDSingleKindContext` without
+ * `kind`, which is the property name in the multi-context.
+ */
+export interface LDContextCommon {
+    /**
+     * @since 0.1.0
+     */
+    key: string;
+    /**
+     * @since 0.1.0
+     */
+    name?: string;
+    /**
+     * @since 0.1.0
+     */
+    anonymous?: boolean;
+    /**
+     * @since 0.1.0
+     */
+    _meta?: LDContextMeta;
+    [attribute: string]: unknown;
+}
+export interface LDContextMeta {
+    /**
+     * Attributes, by name or `/`-separated reference, that are not sent to
+     * LaunchDarkly in analytics events.
+     *
+     * @since 0.1.0
+     */
+    privateAttributes?: string[];
+}
+/**
+ * A context made of several kinds: `{ kind: 'multi', user: {...}, organization: {...} }`.
+ * Each kind's object has no `kind` of its own.
+ */
+export interface LDMultiKindContext {
+    /**
+     * @since 0.1.0
+     */
+    kind: 'multi';
+    [contextKind: string]: 'multi' | LDContextCommon;
+}
+export interface LDFlagSet {
+    [flagKey: string]: unknown;
+}
+export interface LaunchDarklyState {
+    /**
+     * Whether the client has received its first set of flags, from the network
+     * or, when it was started offline, from its cache.
+     *
+     * @since 0.1.0
+     */
+    initialized: boolean;
+    /**
+     * The current context. Absent when no client was started.
+     *
+     * @since 0.1.0
+     */
+    context?: LDContext;
+    /**
+     * The value of every flag for the current context.
+     *
+     * @since 0.1.0
+     */
+    flags: LDFlagSet;
+}
+export interface WaitForInitializationOptions {
+    /**
+     * @since 0.1.0
+     * @default 5
+     */
+    timeoutSeconds?: number;
+}
+export interface WaitForInitializationResult {
+    /**
+     * @since 0.1.0
+     */
+    initialized: boolean;
+}
+export interface IdentifyOptions {
+    /**
+     * @since 0.1.0
+     */
+    context: LDContext;
+    /**
+     * How long to wait for the flags of the new context, in seconds.
+     *
+     * @since 0.1.0
+     * @default 5
+     */
+    timeoutSeconds?: number;
+}
+export interface IdentifyResult {
+    /**
+     * `true` when the flags of the new context did not arrive in time. The
+     * context is switched all the same, and the flags follow when they arrive.
+     *
+     * @since 0.1.0
+     */
+    timedOut: boolean;
+}
+export interface VariationOptions {
+    /**
+     * @since 0.1.0
+     */
+    key: string;
+    /**
+     * @since 0.1.0
+     * @default null
+     */
+    defaultValue?: unknown;
+}
+export interface VariationResult {
+    /**
+     * @since 0.1.0
+     */
+    value: unknown;
+}
+export interface AllFlagsResult {
+    /**
+     * @since 0.1.0
+     */
+    flags: LDFlagSet;
+}
+export interface SetStreamingOptions {
+    /**
+     * @since 0.1.0
+     */
+    enabled: boolean;
+}
+export interface SetOnlineOptions {
+    /**
+     * @since 0.1.0
+     */
+    online: boolean;
+}
+export interface FlagChange {
+    /**
+     * @since 0.1.0
+     */
+    key: string;
+    /**
+     * The new value; `null` when the flag was deleted.
+     *
+     * @since 0.1.0
+     */
+    value: unknown;
+    /**
+     * The value before the change, when the plugin knew one.
+     *
+     * @since 0.1.0
+     */
+    previous?: unknown;
+}
+export interface ConnectionModeChange {
+    /**
+     * The SDK's own name for the mode, which differs between the platforms:
+     * on iOS `streaming`, `polling`, `offline` or
+     * `establishingStreamingConnection`; on Android the name of the SDK's
+     * `ConnectionMode`, such as `STREAMING`, `POLLING`, `OFFLINE`,
+     * `SET_OFFLINE` or `BACKGROUND_POLLING`.
+     *
+     * @since 0.1.0
+     */
+    mode: string;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginsConfig } from '@capacitor/cli';\nimport type { PluginListenerHandle } from '@capacitor/core';\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * Starts the native LaunchDarkly client as the app launches, before the\n     * web view runs any app code. Leave `mobileKey` out to start it from\n     * JavaScript with `initialize()` instead. iOS and Android only.\n     */\n    LaunchDarkly?: {\n      /**\n       * The mobile key of the LaunchDarkly environment. Without it there is\n       * no native start-up, and `initialize()` starts the client instead.\n       *\n       * @since 0.1.0\n       * @example \"mob-00000000-0000-0000-0000-000000000000\"\n       */\n      mobileKey?: string;\n\n      /**\n       * The context the native start-up uses when no context was stored by an\n       * earlier `identify()`.\n       *\n       * @since 0.1.0\n       * @default { kind: 'user', key: 'anonymous_user', anonymous: true }\n       * @example { \"kind\": \"user\", \"key\": \"anonymous_user\", \"anonymous\": true }\n       */\n      initialContext?: LDContext;\n\n      /**\n       * Streams flag updates when `true`, polls when `false`.\n       *\n       * @since 0.1.0\n       * @default true\n       * @example true\n       */\n      streaming?: boolean;\n\n      /**\n       * Asks LaunchDarkly for the reason behind each evaluation.\n       *\n       * @since 0.1.0\n       * @default false\n       * @example false\n       */\n      evaluationReasons?: boolean;\n\n      /**\n       * Starts the client offline, until `setOnline({ online: true })`.\n       *\n       * @since 0.1.0\n       * @default false\n       * @example false\n       */\n      offline?: boolean;\n\n      /**\n       * How long the start waits for the first set of flags, in seconds.\n       *\n       * @since 0.1.0\n       * @default 5\n       * @example 5\n       */\n      startWaitSeconds?: number;\n\n      /**\n       * Application metadata sent to LaunchDarkly with every request.\n       *\n       * @since 0.1.0\n       * @example { \"id\": \"com.example.plugin\", \"version\": \"1.0.0\" }\n       */\n      application?: LDApplicationInfo;\n    };\n  }\n}\n\n/**\n * The `plugins.LaunchDarkly` block of `capacitor.config`.\n */\nexport type LaunchDarklyConfig = NonNullable<PluginsConfig['LaunchDarkly']>;\n\nexport interface LaunchDarklyPlugin {\n  /**\n   * Starts the client from JavaScript and waits for the first set of flags or\n   * `options.startWaitSeconds` (5 by default), whichever comes first.\n   *\n   * - **iOS, Android**: takes `mobileKey`. Needed only by an app that does not\n   *   put a `mobileKey` in `capacitor.config`; with one there, the client is\n   *   already running when the app's code starts, and this call only answers\n   *   its state.\n   * - **Web**: takes `clientSideId`, and is the only way to start the client.\n   *   Needs `@launchdarkly/js-client-sdk` installed (see the README).\n   *\n   * `context` plays the part of `initialContext`: when an earlier `identify()`\n   * stored a context, the client starts with the stored one instead, so the\n   * app does not flip to an anonymous context for a moment after a restart.\n   *\n   * There is one client per process (per page on the web). A second call with\n   * the same key, or a call after the native start-up already started a\n   * client with that key, changes nothing: the client is not created again,\n   * `context` and `options` are ignored, and the current state is answered.\n   * Use `identify()` to switch the context. A call with a different key closes\n   * the running client and starts a new one.\n   *\n   * @since 0.1.0\n   */\n  initialize(options: InitializeOptions): Promise<LaunchDarklyState>;\n\n  /**\n   * Answers whether the client has received its first set of flags, waiting\n   * up to `timeoutSeconds` (5 by default) for that when it has not yet.\n   *\n   * Resolves `{ initialized: false }` straight away when no client was\n   * started, neither natively nor with `initialize()`.\n   *\n   * @since 0.1.0\n   */\n  waitForInitialization(options?: WaitForInitializationOptions): Promise<WaitForInitializationResult>;\n\n  /**\n   * The state of the native client: whether it has its flags, the current\n   * context and the value of every flag, read from the native SDK's own\n   * store. Meant for bootstrapping the web layer at start without a second\n   * network round trip.\n   *\n   * While the native start-up is still running, this waits until it is done:\n   * until the first set of flags is in, or `startWaitSeconds` has passed.\n   * With no client at all it answers `initialized: false` and no flags.\n   *\n   * Reading the flags this way sends no evaluation events.\n   *\n   * @since 0.1.0\n   */\n  getState(): Promise<LaunchDarklyState>;\n\n  /**\n   * Switches the client to another context and resolves when the flags for\n   * it are loaded, or when `timeoutSeconds` (5 by default) has passed.\n   *\n   * The context the SDK accepted is stored natively, under a key of the\n   * plugin's own, and the next native start-up begins with it instead of\n   * `initialContext`. So an app logs out by identifying its anonymous\n   * context, which then becomes the stored one; `clearStoredContext()`\n   * forgets it altogether.\n   *\n   * An anonymous context keeps the key it is given. The plugin never asks the\n   * SDK to generate one.\n   *\n   * @since 0.1.0\n   */\n  identify(options: IdentifyOptions): Promise<IdentifyResult>;\n\n  /**\n   * Evaluates one flag for the current context and answers its value, of any\n   * JSON type, or `defaultValue` (`null` when left out) when the flag is\n   * unknown or the client has not started. Goes through the SDK's JSON\n   * variation call, so it records an evaluation event like any SDK call.\n   *\n   * @since 0.1.0\n   */\n  variation(options: VariationOptions): Promise<VariationResult>;\n\n  /**\n   * The value of every flag for the current context, from the native SDK's\n   * store. Sends no evaluation events. Empty when the client has not started.\n   *\n   * @since 0.1.0\n   */\n  allFlags(): Promise<AllFlagsResult>;\n\n  /**\n   * Switches between streaming and polling. Neither native SDK can change its\n   * data source while it runs, so the plugin closes the client and starts it\n   * again with the same mobile key, options and current context, then waits as\n   * at start-up. Flag listeners stay registered. The web SDK switches in place\n   * (`setStreaming()`).\n   *\n   * @since 0.1.0\n   */\n  setStreaming(options: SetStreamingOptions): Promise<void>;\n\n  /**\n   * Takes the client online or offline (`setOnline()` / `setOffline()` on\n   * Android, `setOnline(_:)` on iOS). Offline, the client keeps answering the\n   * values it has.\n   *\n   * The web SDK has no offline mode. There, going offline closes the stream so\n   * no flag updates arrive, and going online opens it again if `streaming` is\n   * on; analytics events are still sent.\n   *\n   * @since 0.1.0\n   */\n  setOnline(options: SetOnlineOptions): Promise<void>;\n\n  /**\n   * Sends the analytics events the client has queued.\n   *\n   * @since 0.1.0\n   */\n  flush(): Promise<void>;\n\n  /**\n   * Closes the client. It can be started again with `initialize()`; until\n   * then, `variation()` answers the default value. The stored context is\n   * kept.\n   *\n   * @since 0.1.0\n   */\n  close(): Promise<void>;\n\n  /**\n   * Forgets the context `identify()` stored, so the next native start-up\n   * begins with `initialContext` again. The running client is not changed.\n   *\n   * @since 0.1.0\n   */\n  clearStoredContext(): Promise<void>;\n\n  /**\n   * Called for every flag whose value changes: from the stream or a poll, and\n   * after `identify()` for each flag whose value differs for the new context.\n   *\n   * @since 0.1.0\n   */\n  addListener(eventName: 'flagChange', listenerFunc: (change: FlagChange) => void): Promise<PluginListenerHandle>;\n\n  /**\n   * Called when the SDK's connection mode changes, for example from streaming\n   * to offline. iOS and Android only: the web SDK has no connection mode, and\n   * this is never called there.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'connectionModeChange',\n    listenerFunc: (change: ConnectionModeChange) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Removes every listener of this plugin.\n   *\n   * @since 0.1.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\nexport interface LaunchDarklyOptions {\n  /**\n   * Streams flag updates when `true`, polls when `false`.\n   *\n   * @since 0.1.0\n   * @default true\n   */\n  streaming?: boolean;\n\n  /**\n   * Asks LaunchDarkly for the reason behind each evaluation. The SDKs then\n   * attach it to their evaluation events.\n   *\n   * @since 0.1.0\n   * @default false\n   */\n  evaluationReasons?: boolean;\n\n  /**\n   * Starts the client offline: it answers cached or default values and does\n   * not connect until `setOnline({ online: true })`.\n   *\n   * The web SDK has no offline mode: there `offline: true` starts without a\n   * stream, and the first flags are still fetched once.\n   *\n   * @since 0.1.0\n   * @default false\n   */\n  offline?: boolean;\n\n  /**\n   * How long the start waits for the first set of flags, in seconds.\n   *\n   * @since 0.1.0\n   * @default 5\n   */\n  startWaitSeconds?: number;\n\n  /**\n   * Application metadata sent to LaunchDarkly with every request. It\n   * describes the app; it is not a context, and adds nothing to the contexts\n   * counted for billing.\n   *\n   * @since 0.1.0\n   */\n  application?: LDApplicationInfo;\n\n  /**\n   * Web only: flags to start with before LaunchDarkly answers. `'localStorage'`\n   * starts from the flags the web SDK cached in `localStorage` for the context\n   * on an earlier visit, which the SDK does on its own; a flag object (for\n   * example rendered by your server) starts from those values. The native\n   * SDKs always start from their own cache and ignore this.\n   *\n   * @since 0.1.0\n   */\n  bootstrap?: 'localStorage' | LDFlagSet;\n}\n\nexport interface LDApplicationInfo {\n  /**\n   * @since 0.1.0\n   */\n  id?: string;\n\n  /**\n   * @since 0.1.0\n   */\n  name?: string;\n\n  /**\n   * @since 0.1.0\n   */\n  version?: string;\n\n  /**\n   * @since 0.1.0\n   */\n  versionName?: string;\n}\n\nexport interface InitializeOptions {\n  /**\n   * The mobile key of the LaunchDarkly environment, used on iOS and Android.\n   *\n   * @since 0.1.0\n   */\n  mobileKey?: string;\n\n  /**\n   * The client-side ID of the LaunchDarkly environment, used on the web.\n   *\n   * @since 0.1.0\n   */\n  clientSideId?: string;\n\n  /**\n   * @since 0.1.0\n   */\n  context: LDContext;\n\n  /**\n   * @since 0.1.0\n   */\n  options?: LaunchDarklyOptions;\n}\n\n/**\n * A context in the JSON shape LaunchDarkly's SDKs use: a single-kind context\n * or a multi-context.\n */\nexport type LDContext = LDSingleKindContext | LDMultiKindContext;\n\n/**\n * A context of one kind. Any other property is a custom attribute: a string,\n * number, boolean, array or object.\n */\nexport interface LDSingleKindContext {\n  /**\n   * The context kind, for example `user` or `organization`.\n   *\n   * @since 0.1.0\n   */\n  kind: string;\n\n  /**\n   * The key. An anonymous context keeps the key it is given.\n   *\n   * @since 0.1.0\n   */\n  key: string;\n\n  /**\n   * @since 0.1.0\n   */\n  name?: string;\n\n  /**\n   * Leaves the context out of the dashboard's context list. It is still\n   * counted for billing by its key.\n   *\n   * @since 0.1.0\n   */\n  anonymous?: boolean;\n\n  /**\n   * @since 0.1.0\n   */\n  _meta?: LDContextMeta;\n\n  [attribute: string]: unknown;\n}\n\n/**\n * One kind of a multi-context: the attributes of `LDSingleKindContext` without\n * `kind`, which is the property name in the multi-context.\n */\nexport interface LDContextCommon {\n  /**\n   * @since 0.1.0\n   */\n  key: string;\n\n  /**\n   * @since 0.1.0\n   */\n  name?: string;\n\n  /**\n   * @since 0.1.0\n   */\n  anonymous?: boolean;\n\n  /**\n   * @since 0.1.0\n   */\n  _meta?: LDContextMeta;\n\n  [attribute: string]: unknown;\n}\n\nexport interface LDContextMeta {\n  /**\n   * Attributes, by name or `/`-separated reference, that are not sent to\n   * LaunchDarkly in analytics events.\n   *\n   * @since 0.1.0\n   */\n  privateAttributes?: string[];\n}\n\n/**\n * A context made of several kinds: `{ kind: 'multi', user: {...}, organization: {...} }`.\n * Each kind's object has no `kind` of its own.\n */\nexport interface LDMultiKindContext {\n  /**\n   * @since 0.1.0\n   */\n  kind: 'multi';\n\n  [contextKind: string]: 'multi' | LDContextCommon;\n}\n\nexport interface LDFlagSet {\n  [flagKey: string]: unknown;\n}\n\nexport interface LaunchDarklyState {\n  /**\n   * Whether the client has received its first set of flags, from the network\n   * or, when it was started offline, from its cache.\n   *\n   * @since 0.1.0\n   */\n  initialized: boolean;\n\n  /**\n   * The current context. Absent when no client was started.\n   *\n   * @since 0.1.0\n   */\n  context?: LDContext;\n\n  /**\n   * The value of every flag for the current context.\n   *\n   * @since 0.1.0\n   */\n  flags: LDFlagSet;\n}\n\nexport interface WaitForInitializationOptions {\n  /**\n   * @since 0.1.0\n   * @default 5\n   */\n  timeoutSeconds?: number;\n}\n\nexport interface WaitForInitializationResult {\n  /**\n   * @since 0.1.0\n   */\n  initialized: boolean;\n}\n\nexport interface IdentifyOptions {\n  /**\n   * @since 0.1.0\n   */\n  context: LDContext;\n\n  /**\n   * How long to wait for the flags of the new context, in seconds.\n   *\n   * @since 0.1.0\n   * @default 5\n   */\n  timeoutSeconds?: number;\n}\n\nexport interface IdentifyResult {\n  /**\n   * `true` when the flags of the new context did not arrive in time. The\n   * context is switched all the same, and the flags follow when they arrive.\n   *\n   * @since 0.1.0\n   */\n  timedOut: boolean;\n}\n\nexport interface VariationOptions {\n  /**\n   * @since 0.1.0\n   */\n  key: string;\n\n  /**\n   * @since 0.1.0\n   * @default null\n   */\n  defaultValue?: unknown;\n}\n\nexport interface VariationResult {\n  /**\n   * @since 0.1.0\n   */\n  value: unknown;\n}\n\nexport interface AllFlagsResult {\n  /**\n   * @since 0.1.0\n   */\n  flags: LDFlagSet;\n}\n\nexport interface SetStreamingOptions {\n  /**\n   * @since 0.1.0\n   */\n  enabled: boolean;\n}\n\nexport interface SetOnlineOptions {\n  /**\n   * @since 0.1.0\n   */\n  online: boolean;\n}\n\nexport interface FlagChange {\n  /**\n   * @since 0.1.0\n   */\n  key: string;\n\n  /**\n   * The new value; `null` when the flag was deleted.\n   *\n   * @since 0.1.0\n   */\n  value: unknown;\n\n  /**\n   * The value before the change, when the plugin knew one.\n   *\n   * @since 0.1.0\n   */\n  previous?: unknown;\n}\n\nexport interface ConnectionModeChange {\n  /**\n   * The SDK's own name for the mode, which differs between the platforms:\n   * on iOS `streaming`, `polling`, `offline` or\n   * `establishingStreamingConnection`; on Android the name of the SDK's\n   * `ConnectionMode`, such as `STREAMING`, `POLLING`, `OFFLINE`,\n   * `SET_OFFLINE` or `BACKGROUND_POLLING`.\n   *\n   * @since 0.1.0\n   */\n  mode: string;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { LaunchDarklyPlugin } from './definitions';
+declare const LaunchDarkly: LaunchDarklyPlugin;
+export * from './definitions';
+export { LaunchDarkly };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const LaunchDarkly = registerPlugin('LaunchDarkly', {
+    web: () => import('./web').then((m) => new m.LaunchDarklyWeb()),
+});
+export * from './definitions';
+export { LaunchDarkly };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,YAAY,GAAG,cAAc,CAAqB,cAAc,EAAE;IACtE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;CAChE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { LaunchDarklyPlugin } from './definitions';\n\nconst LaunchDarkly = registerPlugin<LaunchDarklyPlugin>('LaunchDarkly', {\n  web: () => import('./web').then((m) => new m.LaunchDarklyWeb()),\n});\n\nexport * from './definitions';\nexport { LaunchDarkly };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,46 @@
+import { WebPlugin } from '@capacitor/core';
+import type { LDClient, LDOptions } from '@launchdarkly/js-client-sdk';
+import type { AllFlagsResult, IdentifyOptions, IdentifyResult, InitializeOptions, LaunchDarklyPlugin, LaunchDarklyState, LDContext, SetOnlineOptions, SetStreamingOptions, VariationOptions, VariationResult, WaitForInitializationOptions, WaitForInitializationResult } from './definitions';
+/** The part of `@launchdarkly/js-client-sdk` the plugin uses. */
+export interface WebSdk {
+    createClient(clientSideId: string, context: LDContext, options?: LDOptions): LDClient;
+}
+/** The key the plugin keeps the context of the last `identify()` under in `localStorage`. */
+export declare const STORED_CONTEXT_KEY = "CapacitorLaunchDarkly.context";
+export declare const MISSING_SDK_MESSAGE = "The LaunchDarkly web SDK is not installed. To use this plugin on the web, run: npm install @launchdarkly/js-client-sdk";
+/**
+ * The web implementation, on LaunchDarkly's browser SDK. It follows the native rules: one client per page, a context the
+ * caller gave with its key (an anonymous context without a key is refused rather than given a generated one), and a context
+ * stored by `identify()` that wins over the one `initialize()` is given.
+ */
+export declare class LaunchDarklyWeb extends WebPlugin implements LaunchDarklyPlugin {
+    private readonly loadSdk;
+    private client?;
+    private clientSideId?;
+    private options;
+    private context?;
+    private initialized;
+    private starting?;
+    private lastValues;
+    constructor(loadSdk?: () => Promise<WebSdk>);
+    initialize(options: InitializeOptions): Promise<LaunchDarklyState>;
+    waitForInitialization(options?: WaitForInitializationOptions): Promise<WaitForInitializationResult>;
+    getState(): Promise<LaunchDarklyState>;
+    identify(options: IdentifyOptions): Promise<IdentifyResult>;
+    variation(options: VariationOptions): Promise<VariationResult>;
+    allFlags(): Promise<AllFlagsResult>;
+    setStreaming(options: SetStreamingOptions): Promise<void>;
+    setOnline(options: SetOnlineOptions): Promise<void>;
+    flush(): Promise<void>;
+    close(): Promise<void>;
+    clearStoredContext(): Promise<void>;
+    private sdk;
+    private started;
+    private state;
+    private flagsChanged;
+}
+/**
+ * Refuses a context whose key (or the key of any kind in a multi-context) is missing or empty. The browser SDK would generate
+ * one for an anonymous context, stored per browser, and every browser would then count as a context of its own.
+ */
+export declare function requireKeys(context: LDContext | undefined): void;