Merge pull request #162 from launchdarkly/eb/ch32565/typescript

change TS declarations to prefer interfaces over types

Author: eli-darkly

packages/ldclient-js-common/test-types.ts

@@ -1,3 +1,45 @@
 
 // This file exists only so that we can run the TypeScript compiler in the CI build
 // to validate our typings.d.ts file.
+
+import * as ld from 'ldclient-js-common';
+
+var ver: string = ld.version;
+
+var logger: ld.LDLogger = ld.createConsoleLogger("info");
+var userWithKeyOnly: ld.LDUser = { key: 'user' };
+var user: ld.LDUser = {
+  key: 'user',
+  name: 'name',
+  firstName: 'first',
+  lastName: 'last',
+  email: 'test@example.com',
+  avatar: 'http://avatar.url',
+  ip: '1.1.1.1',
+  country: 'us',
+  anonymous: true,
+  custom: {
+    'a': 's',
+    'b': true,
+    'c': 3,
+    'd': [ 'x', 'y' ],
+    'e': [ true, false ],
+    'f': [ 1, 2 ]
+  },
+  privateAttributeNames: [ 'name', 'email' ]
+};
+
+var client: ld.LDClientBase = {} as ld.LDClientBase;  // wouldn't do this in real life, it's just so the following statements will compile
+
+var boolFlagValue: ld.LDFlagValue = client.variation('key', false);
+var numberFlagValue: ld.LDFlagValue = client.variation('key', 2);
+var stringFlagValue: ld.LDFlagValue = client.variation('key', 'default');
+var jsonFlagValue: ld.LDFlagValue = client.variation('key', [ 'a', 'b' ]);
+
+var detail: ld.LDEvaluationDetail = client.variationDetail('key', 'default');
+var detailValue: ld.LDFlagValue = detail.value;
+var detailIndex: number | undefined = detail.variationIndex;
+var detailReason: ld.LDEvaluationReason = detail.reason;
+
+var flagSet: ld.LDFlagSet = client.allFlags();
+var flagSetValue: ld.LDFlagValue = flagSet['key'];

packages/ldclient-js-common/typings.d.ts

@@ -18,19 +18,19 @@ declare module 'ldclient-js-common' {
   /**
    * A map of feature flags from their keys to their values.
    */
-  export type LDFlagSet = {
+  export interface LDFlagSet {
     [key: string]: LDFlagValue;
-  };
+  }
 
   /**
    * A map of feature flag keys to objects holding changes in their values.
    */
-  export type LDFlagChangeset = {
+  export interface LDFlagChangeset {
     [key: string]: {
       current: LDFlagValue;
       previous: LDFlagValue;
     };
-  };
+  }
 
   /**
    * The minimal interface for any object that LDClient can use for logging.
@@ -154,15 +154,16 @@ declare module 'ldclient-js-common' {
 
     /**
      * Whether all user attributes (except the user key) should be marked as private, and
-     * not sent to LaunchDarkly.
+     * not sent to LaunchDarkly in analytics events.
      *
      * By default, this is false.
      */
     allAttributesPrivate?: boolean;
 
     /**
      * The names of user attributes that should be marked as private, and not sent
-     * to LaunchDarkly.
+     * to LaunchDarkly in analytics events. You can also specify this on a per-user basis
+     * with [[LDUser.privateAttributeNames]].
      */
     privateAttributeNames?: Array<string>;
 
@@ -211,7 +212,7 @@ declare module 'ldclient-js-common' {
   /**
    * A LaunchDarkly user object.
    */
-  export type LDUser = {
+  export interface LDUser {
     /**
      * A unique string identifying a user.
      */
@@ -268,13 +269,21 @@ declare module 'ldclient-js-common' {
     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 [[LDOptions.privateAttributeNames]] or [[LDOptions.allAttributesPrivate]].
+     */
+    privateAttributeNames?: Array<string>;
   }
 
   /**
    * Describes the reason that a flag evaluation produced a particular value. This is
    * part of the [[LDEvaluationDetail]] object returned by [[LDClient.variationDetail]].
    */
-  export type LDEvaluationReason = {
+  export interface LDEvaluationReason {
     /**
      * The general category of the reason:
      *
@@ -308,7 +317,7 @@ declare module 'ldclient-js-common' {
      * The key of the failed prerequisite flag, if the kind was `'PREREQUISITE_FAILED'`.
      */
     prerequisiteKey?: string;
-  };
+  }
 
   /**
    * An object that combines the result of a feature flag evaluation with information about
@@ -318,7 +327,7 @@ declare module 'ldclient-js-common' {
    *
    * For more information, see the [SDK reference guide](https://docs.launchdarkly.com/docs/evaluation-reasons).
    */
-  export type LDEvaluationDetail = {
+  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]].
@@ -335,7 +344,7 @@ declare module 'ldclient-js-common' {
      * An object describing the main factor that influenced the flag evaluation value.
      */
     reason: LDEvaluationReason;
-  };
+  }
 
   /**
    * The basic interface for the LaunchDarkly client. The browser SDK and the Electron SDK both

packages/ldclient-js/test-types.ts

@@ -2,11 +2,13 @@
 // This file exists only so that we can run the TypeScript compiler in the CI build
 // to validate our typings.d.ts file.
 
-import { createConsoleLogger, LDClient, LDLogger, LDOptions, LDUser, initialize } from 'ldclient-js';
+import * as ld from 'ldclient-js';
 
-var emptyOptions: LDOptions = {};
-var logger: LDLogger = createConsoleLogger("info");
-var allOptions: LDOptions = {
+var ver: string = ld.version;
+
+var emptyOptions: ld.LDOptions = {};
+var logger: ld.LDLogger = ld.createConsoleLogger("info");
+var allOptions: ld.LDOptions = {
   bootstrap: { },
   hash: '',
   baseUrl: '',
@@ -27,5 +29,37 @@ var allOptions: LDOptions = {
   streamReconnectDelay: 1,
   logger: logger
 };
-var user: LDUser = { key: 'user' };
-var client: LDClient = initialize('env', user, allOptions);
+var userWithKeyOnly: ld.LDUser = { key: 'user' };
+var user: ld.LDUser = {
+  key: 'user',
+  name: 'name',
+  firstName: 'first',
+  lastName: 'last',
+  email: 'test@example.com',
+  avatar: 'http://avatar.url',
+  ip: '1.1.1.1',
+  country: 'us',
+  anonymous: true,
+  custom: {
+    'a': 's',
+    'b': true,
+    'c': 3,
+    'd': [ 'x', 'y' ],
+    'e': [ true, false ],
+    'f': [ 1, 2 ]
+  },
+  privateAttributeNames: [ 'name', 'email' ]
+};
+var client: ld.LDClient = ld.initialize('env', user, allOptions);
+
+var boolFlagValue: ld.LDFlagValue = client.variation('key', false);
+var numberFlagValue: ld.LDFlagValue = client.variation('key', 2);
+var stringFlagValue: ld.LDFlagValue = client.variation('key', 'default');
+
+var detail: ld.LDEvaluationDetail = client.variationDetail('key', 'default');
+var detailValue: ld.LDFlagValue = detail.value;
+var detailIndex: number | undefined = detail.variationIndex;
+var detailReason: ld.LDEvaluationReason = detail.reason;
+
+var flagSet: ld.LDFlagSet = client.allFlags();
+var flagSetValue: ld.LDFlagValue = flagSet['key'];