launchdarkly-js-sdk-common 3.5.1 → 3.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "launchdarkly-js-sdk-common",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "LaunchDarkly SDK for JavaScript - common code",
   "author": "LaunchDarkly <team@launchdarkly.com>",
   "license": "Apache-2.0",

package/typings.d.ts

@@ -133,10 +133,14 @@ declare module 'launchdarkly-js-sdk-common' {
     /**
      * Whether or not to include custom HTTP headers when requesting flags from LaunchDarkly.
      *
-     * Currently these are used to track what version of the SDK is active. This defaults to true
-     * (custom headers will be sent). One reason you might want to set it to false is that the presence
-     * of custom headers causes browsers to make an extra OPTIONS request (a CORS preflight check)
-     * before each flag request, which could affect performance.
+     * These are used to send metadata about the SDK (such as the version). They
+     * are also used to send the application.id and application.version set in
+     * the options.
+     * 
+     * This defaults to true (custom headers will be sent). One reason you might
+     * want to set it to false is that the presence of custom headers causes
+     * browsers to make an extra OPTIONS request (a CORS preflight check) before
+     * each flag request, which could affect performance.
      */
     sendLDHeaders?: boolean;
 
@@ -284,6 +288,31 @@ declare module 'launchdarkly-js-sdk-common' {
      * The default value is `false`.
      */
     autoAliasingOptOut?: boolean;
+
+    /**
+     * Information about the application where the LaunchDarkly SDK is running.
+     */
+    application?: {
+      /**
+       * A unique identifier representing the application where the LaunchDarkly SDK is running.
+       * 
+       * This can be specified as any string value as long as it only uses the following characters: ASCII letters,
+       * ASCII digits, period, hyphen, underscore. A string containing any other characters will be ignored.
+       * 
+       * Example: `authentication-service`
+       */
+      id?: string;
+
+      /**
+       * A unique identifier representing the version of the application where the LaunchDarkly SDK is running.
+       * 
+       * This can be specified as any string value as long as it only uses the following characters: ASCII letters,
+       * ASCII digits, period, hyphen, underscore. A string containing any other characters will be ignored.
+       * 
+       * Example: `1.0.0` (standard version string) or `abcdef` (sha prefix)
+       */
+      version?: string;
+    }
   }
 
   /**