interfacer - npm Package Compare versions

Comparing version 0.0.9 to 0.1.0

package.json

 {
   "name": "interfacer",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "Module for working with REST API",
@@ -58,2 +58,3 @@ "main": "lib/index.js",
     "fetch-mock": "^5.1.5",
+    "flow-bin": "^0.43.0",
     "jest": "^18.1.0",
@@ -64,2 +65,3 @@ "jsdoc": "^3.4.0",
     "mocha-jsdom": "^1.1.0",
+    "nock": "^9.0.11",
     "react": "^15.4.1",
@@ -75,5 +77,3 @@ "react-addons-test-utils": "^15.4.1",
     "sinon-chai": "^2.8.0",
-    "tmp": "0.0.28",
-    "flow-bin": "^0.43.0",
-    "nock": "^9.0.11"
+    "tmp": "0.0.28"
   },
@@ -83,4 +83,5 @@ "dependencies": {
     "isomorphic-fetch": "^2.2.1",
+    "normalizr": "^3.2.2",
     "request": "^2.81.0"
   }
 }

README.md

@@ -11,3 +11,5 @@ # Interfacer.js
 * Customizable query construction
+* Optional [normalizr](https://github.com/paularmstrong/normalizr) integration
 
+
 ## How to install
@@ -117,4 +119,8 @@
 | `querybuilder` | Function that transform `query` object into a query string | `function`| `querybuilder`
-| `makeBody` | Function that'll be run on body, right before request is made. | `function` | `body => body`
+| `makeBody` | Function that'll be run on body, right before request is made. | `function` | `body => body`|
+| `schema` | If you're using [normalizr](https://github.com/paularmstrong/normalizr) you can specify, response will be normalized using this schema. | `object` | |
 
+##### **Note on normalization:**
+Normalization of the response will take place **after** `flatMethod` is applied. Also `schema` property can be only configured in either `Interface level` or `Request level` config, as it doesn't really make sense to use one schema for all requests.
+
 ## URL Queries
@@ -121,0 +127,0 @@

src/configComposers.js

@@ -25,4 +25,5 @@ // @flow
   makeBody: callConfig.makeBody || localConfig.makeBody || globalConfig.makeBody,
+  schema: callConfig.schema || localConfig.schema
 });
 
 export default composeConfigs;

src/send.js

 // @flow
 import fetch from 'isomorphic-fetch';
+import { normalize } from 'normalizr';
 import { constructTrack, saveTrack, getTrack } from './memoization';
@@ -31,2 +32,4 @@ import { composeUrl } from './helpers';
     .then(res => (request.flatMethod && request.flatMethod(res)) || res.json())
+    // eslint-disable-next-line no-confusing-arrow
+    .then(res => request.schema && normalize ? normalize(res, request.schema) : res)
     .catch(error => {
@@ -33,0 +36,0 @@ request.errorHandler({ message: request.error || request.defaultError, error });

src/types.js

@@ -42,3 +42,4 @@ // @flow
   flatMethod?: Function,
-  makeBody?: Function
+  makeBody?: Function,
+  schema?: Object
 };
@@ -67,2 +68,3 @@
   flatMethod: Function,
+  schema?: Object
 };
@@ -69,0 +71,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

186490

increased by0.23%

Lines of code

400

increased by1.52%

Number of lines in readme file

140

increased by4.48%

Worsened metrics

Dependency count

4

increased by33.33%

Dependency changes

• + Addednormalizr@^3.2.2

• + Addednormalizr@3.6.2(transitive)