prepare 2.15.0 release (#183)

Author: LaunchDarklyCI

.circleci/config.yml

@@ -6,25 +6,22 @@ jobs:
     steps:
       - checkout
 
-      - run: npm install # this automatically runs "npm prepare" too
-        # Note that for CI to work properly, our lerna command for "npm prepare" in package.json needs to 
-        # have "--concurrency=2", otherwise we may run out of memory. This is a known issue with Lerna.
+      - run: npm install
       - run: npm run lint
-      - run: npm run build
+      - run: npm run build:min
 
-      # We could do "npm run test" here to run tests for all the packages, but then we would not be
-      # able to produce separate output files.
       - run: mkdir -p reports/junit
       - run:
-          command: cd ~/project/packages/launchdarkly-js-sdk-common && npm run test:junit
+          command: npm run test:junit
           environment:
             JEST_JUNIT_OUTPUT: "./reports/junit/js-common-test-results.xml"
+
+      - run: npm run check-typescript
+
       - run:
-          command: cd ~/project/packages/launchdarkly-js-client-sdk && npm run test:junit
-          environment:
-            JEST_JUNIT_OUTPUT: "./reports/junit/js-test-results.xml"
+          name: dependency audit
+          command: ./scripts/better-audit.sh
 
-      - run: cd ~/project && npm run check-typescript
       - store_test_results:
           path: reports/junit/
       - store_artifacts:

.eslintignore

@@ -2,3 +2,4 @@ node_modules/
 coverage/
 dist/
 eventsource.js
+example/example.js

.releaser/config.yml

@@ -0,0 +1,14 @@
+repo:
+  public: js-client-sdk
+  private: js-client-sdk-private
+
+publications:
+  - url: https://www.npmjs.com/package/launchdarkly-js-client-sdk
+    description: npm
+
+template:
+  name: npm
+
+documentation:
+  githubPages: true
+  title: LaunchDarkly JavaScript SDK

CONTRIBUTING.md

@@ -6,41 +6,34 @@ LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkl
 
 The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/js-client-sdk/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
 
-Submitting pull requests
-------------------
+## Submitting pull requests
 
 We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
 
-Build instructions
-------------------
+## Build instructions
 
-Before building the code, it would be helpful to know a bit about the structure of the code in this repository. This repository is a monorepo containing two projects, each of which is published to npm as a package with the same name:
-
-- `launchdarkly-js-client-sdk`: This is the main SDK package that applications will import. Any logic that specifically relies on being in a browser environment should go here (see `browserPlatform.js`). This automatically imports `launchdarkly-js-sdk-common`.
-- `launchdarkly-js-sdk-common`: Internal implementation code that is not browser-specific.
+### Prerequisites
 
-The reason `launchdarkly-js-sdk-common` exists is that the [Electron SDK](https://github.com/launchdarkly/electron-client) has very similar functionality to the browser SDK. Therefore, all of the code that is used by both has been factored out into the common package.
+Note that much of the basic SDK logic, which is common to all of the LaunchDarkly client-side JavaScript-based SDKs, is in the `launchdarkly-js-sdk-common` package in the [js-sdk-common](https://github.com/launchdarkly/js-sdk-common) repository. This is pulled in automatically by `npm` when you build the SDK, but if you are planning to make changes that affect the common code, you will need to check out that repository as well.
 
-### Prerequisites
+### Setup
 
-Before building the SDK, you need to install [Lerna](https://www.npmjs.com/package/lerna).
+To install project dependencies, from the project root directory:
 
 ```
-npm install lerna
+npm install
 ```
 
-### Building
+### Testing
 
-You can build all three packages by running the following command from the root directory:
+To run all unit tests:
 
 ```
-npm run build
+npm test
 ```
 
-### Testing
-
-You can run all tests by running the following command from the root directory:
+To verify that the TypeScript declarations compile correctly (this involves compiling the file `test-types.ts`, so if you have changed any types or interfaces, you will want to update that code):
 
 ```
-npm test
+npm run check-typescript
 ```

example/README.md

@@ -0,0 +1,24 @@
+# SDK Browser Demo Page
+
+This is a simple front-end-only JavaScript application that exercises much of the functionality of the LaunchDarkly SDK for browser JavaScript. It is not meant to be an example of how to write a LaunchDarkly application, since most of its logic is devoted to implementing a testing UI that a real application would not have. Instead, it is meant to show the SDK in action and to verify that feature flags work as expected in a given environment.
+
+For a more realistic example of a LaunchDarkly-enabled application with both a front end and a back end, see [`hello-bootstrap`](https://github.com/launchdarkly/hello-bootstrap).
+
+## Running the demo
+
+Most of the demo can be used without a real HTTP server; just start your browser and tell it to open the `index.html` file in this directory. The only thing that will not work in that mode is the "Set URL" feature under Navigation/Events.
+
+To access the demo via a basic HTTP server, there are several ways but the simplest-- if you have Python-- is to run `python -m SimpleHTTPServer 8000` from a command line at the SDK root directory, and then browse to this location.
+
+Note that by default, the demo uses the latest release of the JS SDK script that is hosted on `app.launchdarkly.com`. However, if it detects that you have built the SDK locally, it will use the local SDK code instead. Therefore, it can be used for testing changes to the SDK. To build from the SDK root directory, run `npm run build`.
+
+## Selecting an environment
+
+By default, the demo uses a simple environment that LaunchDarkly has created for this purpose, containing a few feature flags as follows-- two that do not change, and two that change in response to a user property:
+
+* `client-side-flag-1-always-true`: Always returns the boolean value `true`.
+* `client-side-flag-2-always-green`: Always returns the string value `"green"`.
+* `client-side-flag-3-does-name-start-with-b`: Returns `true` if the user's `name` property starts with the letter B, otherwise `false`.
+* `client-side-flag-4-has-valid-email`: Returns `true` if the user's `email` property matches a simple regex for validating emails, otherwise `false`.
+
+You can instead use your own environment, by copying the environment ID from [your dashboard](https://app.launchdarkly.com/settings/projects) into the Environment ID field and clicking "Update Configuration, Reconnect". You should now see all feature flags from your environment that have the "Make this flag available to client-side SDKs" option checked. If you also clicked the "Live updates (streaming)" box, you should also see any changes you make to your flags reflected on the page in real time.

example/example.css

@@ -0,0 +1,25 @@
+
+#logPanel {
+  border: 1px solid #888;
+  font-family: monospace;
+  font-size: 9pt;
+  height: 140px;
+  overflow: scroll;
+  white-space: pre;
+}
+
+code {
+  font-size: 9pt;
+}
+
+.error {
+  color: red;
+}
+
+#usingWhichScript, #usingWhichScript .local, #usingWhichScript .hosted {
+  display: none;
+}
+
+#usingWhichScript.local, #usingWhichScript.hosted, #usingWhichScript.local .local, #usingWhichScript.hosted .hosted {
+  display: inline;
+}