Merge pull request #17 from hull/release/v2.0.0

Release/v2.0.0

Author: michaloo

.babelrc

@@ -1,3 +1,3 @@
 {
-  "plugins": ["transform-flow-comments", "transform-object-rest-spread"]
+  "plugins": ["transform-flow-comments", ["transform-object-rest-spread", { "useBuiltIns": true }]]
 }

.eslintrc

@@ -19,7 +19,9 @@
     "eqeqeq": [1],
     "prefer-destructuring": [0],
     "class-methods-use-this": [0],
-    "flowtype-errors/show-errors": 2
+    "flowtype-errors/show-errors": 2,
+    "spaced-comment": ["error", "always", { "markers": [":", "::"] }],
+    "no-use-before-define": ["error", { "classes": false }]
   },
   "extends": [
     "airbnb-base",

.flowconfig

@@ -6,6 +6,7 @@
 [include]
 
 [libs]
+flow-typed
 
 [lints]
 all=warn

.gitignore

@@ -5,3 +5,4 @@ node_modules
 *tgz
 npm-debug.log
 yarn.lock
+yarn-error.log

API.md

@@ -1,31 +1,59 @@
-# 1.2.2
-* Allow anonymous_id in Account claims
+# CHANGELOG
 
-# 1.2.1
+## 2.0.0-beta.3
+* fix missing flow types
+* documentation adjustments
+
+## 2.0.0-beta.2
+* adds experimental `logsArray` and `firehoseEventsArray` to additionally capture log lines and firehose events to separate arrays.
+  CAUTION: this does not disable normal behaviour of the libary
+* fix retry callback errors
+
+## 2.0.0-beta.1
+* **BREAKING** HullClient is a set of ES6 classes now, not a Function anymore - this means you cannot do `const hullClient = HullClient()` anymore, you always need `new` keyword
+* **BREAKING** `as` method is not available anymore, use `asUser`
+* **BREAKING** `utils.groupTraits` method is not available anymore, use `utils.traits.group`
+* **BREAKING** `traits` method second parameter accepting `source` and `sync` option is not available anymore. Sync calls are not available at all, and if you need to apply `source` to your traits you need to do it before passing payload to `traits` method
+* **BREAKING** `hullClient.api.get` methods are not available anymore, use `hullClient.get` or `hullClient.api(path, "get")`, the same applies for all HTTP verbs
+* the client now comes with full set of Flow types in src/types.js file
+  ```js
+  import type { HullUserClaims } from "hull-client";
+
+  const userClaims: HullUserClaims = {
+    wrong_claim: "bar"
+  };
+  // this will throw flow check error since `wrong_claim` is not correct
+  ```
+* underlying HTTP library restler was replaced with superagent
+
+## 1.2.2
+* allow anonymous_id in Account claims
+
+## 1.2.1
 * render docs without a TOC so the Website can display them properly.
 
-# 1.2.0
+## 1.2.0
 * documentation split into API reference in API.md and getting started and "how-tos" guides in README.md
 * cleanup babeljs configuration and use native NodeJS v6 with single babeljs plugin (transform-object-rest-spread) to allow object spread syntax (remove import/export syntax)
 * run circleci jobs on all supported nodejs versions
 * upgrade of dependencies
 
-# 1.1.5
+## 1.1.5
 * retry all 5xx errors
 
-# 1.1.4
+## 1.1.4
 * add requestId in logger context
 
-# 1.1.3
+## 1.1.3
 * fixes building and publishing process
 
-# 1.1.2
+## 1.1.2
 * fixes how API rest client rejects after errors
 
-# 1.1.1
+## 1.1.1
 * Add support for custom `scopes` claim in auth tokens
 
-# 1.1.0
+## 1.1.0
 * logging api timeouts and failures
 * filter out logged claims for users and accounts so one can pass `hull.asUser(user)`
 * add `client.as` alias and deprecation notice
@@ -35,9 +63,9 @@
 * adds `Hull-Organization` header to firehose calls
 * adds `ip` and `time` context param to traits call
 
-# 1.0.6
+## 1.0.6
 * fix `client.utils.traits.group` and deprecates `client.utils.groupTraits`
 * improves code structure
 
-# 1.0.0
+## 1.0.0
 * extract from `hull-node 0.11.4` - Initial Commit

CHANGELOG.md

@@ -0,0 +1,7 @@
+toc:
+  - HullClient
+  - EntityScopedHullClient
+  - UserScopedHullClient
+  - AccountScopedHullClient
+  - Api
+  - Utils