launchdarkly-js-sdk-common 3.2.12 → 3.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "launchdarkly-js-sdk-common",
-  "version": "3.2.12",
+  "version": "3.3.2",
   "description": "LaunchDarkly SDK for JavaScript - common code",
   "author": "LaunchDarkly <team@launchdarkly.com>",
   "license": "Apache-2.0",
@@ -33,7 +33,8 @@
     "test:junit": "cross-env NODE_ENV=test jest --testResultsProcessor jest-junit",
     "check-typescript": "node_modules/typescript/bin/tsc",
     "clean": "rimraf dist/**",
-    "prepublishOnly": "npm run build:min"
+    "prepublishOnly": "npm run build:min",
+    "prepare": "npm run build"
   },
   "devDependencies": {
     "@babel/cli": "^7.8.4",

package/typings.d.ts

@@ -169,6 +169,14 @@ declare module 'launchdarkly-js-sdk-common' {
      */
     privateAttributeNames?: Array<string>;
 
+    /**
+     * Whether to include full user details in every analytics event.
+     *
+     * The default is `false`: events will only include the user key, except for one "index" event
+     * that provides the full details for the user.
+     */
+    inlineUsersInEvents?: boolean;
+
     /**
      * Whether or not to send an analytics event for a flag evaluation even if the same flag was
      * evaluated with the same value within the last five minutes.
@@ -259,6 +267,14 @@ declare module 'launchdarkly-js-sdk-common' {
      * If `wrapperName` is unset, this field will be ignored.
      */
     wrapperVersion?: string;
+
+    /**
+     * Whether to disable the automatic sending of an alias event when [[identify]] is
+     * called with a non-anonymous user when the previous user is anonymous.
+     * 
+     * The default value is `false`.
+     */
+    autoAliasingOptOut?: boolean;
   }
 
   /**
@@ -603,7 +619,7 @@ declare module 'launchdarkly-js-sdk-common' {
     /**
      * Registers an event listener.
      *
-     * The following event names (keys) are used by the cliet:
+     * The following event names (keys) are used by the client:
      *
      * - `"ready"`: The client has finished starting up. This event will be sent regardless
      *   of whether it successfully connected to LaunchDarkly, or encountered an error
@@ -671,6 +687,21 @@ declare module 'launchdarkly-js-sdk-common' {
      */
     track(key: string, data?: any, metricValue?: number): void;
 
+    /**
+     * Associates two users for analytics purposes. 
+     * 
+     * This can be helpful in the situation where a person is represented by multiple 
+     * LaunchDarkly users. This may happen, for example, when a person initially logs into 
+     * an application-- the person might be represented by an anonymous user prior to logging
+     * in and a different user after logging in, as denoted by a different user key.
+     * 
+     * @param user 
+     *   The newly identified user.
+     * @param previousUser 
+     *   The previously identified user.
+     */
+    alias(user: LDUser, previousUser: LDUser): void;
+
     /**
      * Returns a map of all available flags to the current user's values.
      *