@3plus/redux-api 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [0.12.0](https://github.com/lexich/redux-api/compare/v0.11.2...v0.12.0) (2020-02-25)
+
+
+### Bug Fixes
+
+* potential security vulnerabilities in dependencies ([5a37929](https://github.com/lexich/redux-api/commit/5a379290d78798ca39b4eb7792f9a0cd0d6ab0b8))
+
+<a name="0.11.2"></a>
+## [0.11.2](https://github.com/lexich/redux-api/compare/v0.11.1...v0.11.2) (2017-12-29)
+
+
+
+<a name="0.11.1"></a>
+## [0.11.1](https://github.com/lexich/redux-api/compare/v0.11.0...v0.11.1) (2017-10-02)
+
+
+
+<a name="0.11.0"></a>
+# [0.11.0](https://github.com/lexich/redux-api/compare/v0.10.8...v0.11.0) (2017-07-31)
+
+
+
+<a name="0.10.8"></a>
+## [0.10.8](https://github.com/lexich/redux-api/compare/v0.10.7...v0.10.8) (2017-07-14)
+
+
+
+<a name="0.10.7"></a>
+## [0.10.7](https://github.com/lexich/redux-api/compare/v0.10.6...v0.10.7) (2017-07-10)
+
+
+
+<a name="0.10.6"></a>
+## [0.10.6](https://github.com/lexich/redux-api/compare/v0.10.5...v0.10.6) (2017-06-12)
+
+
+
+<a name="0.10.5"></a>
+## [0.10.5](https://github.com/lexich/redux-api/compare/v0.10.4...v0.10.5) (2017-05-18)
+
+
+
+<a name="0.10.4"></a>
+## [0.10.4](https://github.com/lexich/redux-api/compare/v0.10.3...v0.10.4) (2017-04-28)
+
+
+
+<a name="0.10.3"></a>
+## [0.10.3](https://github.com/lexich/redux-api/compare/v0.10.2...v0.10.3) (2017-03-30)
+
+
+
+<a name="0.10.2"></a>
+## [0.10.2](https://github.com/lexich/redux-api/compare/v0.9.18...v0.10.2) (2017-03-29)
+Add support cache [option](https://github.com/lexich/redux-api/blob/master/docs/DOCS.md#cache)
+
+<a name="0.9.18"></a>
+## [0.9.18](https://github.com/lexich/redux-api/compare/v0.9.17...v0.9.18) (2017-03-06)
+
+
+
+<a name="0.9.17"></a>
+## [0.9.17](https://github.com/lexich/redux-api/compare/0.9.16...v0.9.17) (2017-01-19)
+
+
+
+<a name="0.9.15"></a>
+## [0.9.15](https://github.com/lexich/redux-api/compare/v0.9.13...v0.9.15) (2016-11-16)
+
+
+
+<a name="0.9.13"></a>
+## [0.9.13](https://github.com/lexich/redux-api/compare/v0.9.12...v0.9.13) (2016-10-24)
+
+
+
+<a name="0.9.12"></a>
+## [0.9.12](https://github.com/lexich/redux-api/compare/0.9.11...v0.9.12) (2016-10-24)

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Efremov Alex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,132 @@
+### Redux-api
+Flux REST API for redux infrastructure
+
+## Introduction
+`redux-api` solves the problem of writing clients to communicate with backends. It generates [actions](http://redux.js.org/docs/basics/Actions.html) and [reducers](http://redux.js.org/docs/basics/Reducers.html) for making AJAX calls to API endpoints. You don't need to write a lot of [boilerplate code](http://redux.js.org/docs/advanced/ExampleRedditAPI.html) if you use `redux` and want to exchange data with server.
+
+Inspired by [Redux-rest](https://github.com/Kvoti/redux-rest) and is intended to be used with [Redux](https://github.com/gaearon/redux).
+
+
+## Documentation
+See [DOCS.md](docs/DOCS.md) for API documentation.
+## Use cases
+* [AuthorizationJWT.md](docs/AuthorizationJWT.md) - example of JWT Authorization  
+* [Scoping.md](docs/Scoping.md) - use scoping or using multiple redux-api instance without naming intersections.
+
+## Install
+With npm:
+```sh
+npm install @3plus/redux-api --save
+```
+
+=======
+## Remote calls
+
+`redux-api` doesn't bind you to a technology to make AJAX calls. It uses configurable `adapters` - a pretty simple function which receives 2 arguments: `endpoint` and `options`, and returns a Promise as result. The default adapter uses [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch), and has an implementation like this:
+```js
+function adapterFetch(url, options) {
+  return fetch(url, options);
+}
+```
+
+However, you are not tied to using isomorphic-fetch. For instance, if you prefer to use jQuery, you can use the following adapter:
+```js
+function adapterJquery(url, options) {
+  return new Promise((success, error)=> {
+    $.ajax({ ...options, url, success, error });
+  });
+}
+```
+This implementation allows you to make any request and process any response.
+
+And of course you have to set up adapter to your `redux-api` instance before using.
+```
+  reduxApi(....).use("fetch", adapterFetch)
+```
+
+=======
+
+### Example
+rest.js
+```js
+import "isomorphic-fetch";
+import reduxApi, {transformers} from "@3plus/redux-api";
+import adapterFetch from "@3plus/redux-api/lib/adapters/fetch";
+export default reduxApi({
+  // simple endpoint description
+  entry: `/api/v1/entry/:id`,
+  // complex endpoint description
+  regions: {
+    url: `/api/v1/regions`,
+    // reimplement default `transformers.object`
+    transformer: transformers.array,
+    // base endpoint options `fetch(url, options)`
+    options: {
+      headers: {
+        "Accept": "application/json"
+      }
+    }
+  }
+}).use("fetch", adapterFetch(fetch));
+```
+
+index.jsx
+```js
+import React, {PropTypes} from "react";
+import { createStore, applyMiddleware, combineReducers } from "redux";
+import thunk from "redux-thunk";
+import { Provider, connect } from "react-redux";
+import rest from "./rest"; //our redux-rest object
+
+const createStoreWithMiddleware = applyMiddleware(thunk)(createStore);
+const reducer = combineReducers(rest.reducers);
+const store = createStoreWithMiddleware(reducer);
+
+function select(state) {
+  return { entry: state.entry, regions: state.regions };
+}
+
+class Application {
+  static propTypes = {
+    entry: PropTypes.shape({
+      loading: PropTypes.bool.isRequired,
+      data: PropTypes.shape({
+        text: PropTypes.string
+      }).isRequired
+    }).isRequired,
+    regions: PropTypes.shape({
+      loading: PropTypes.bool.isRequired,
+      data: PropTypes.array.isRequired
+    }).isRequired,
+    dispatch: PropTypes.func.isRequired
+  };
+  componentDidMount() {
+    const {dispatch} = this.props;
+    // fetch `/api/v1/regions
+    dispatch(rest.actions.regions.sync());
+    //specify id for GET: /api/v1/entry/1
+    dispatch(rest.actions.entry({id: 1}));
+  }
+  render() {
+    const {entry, regions} = this.props;
+    const Regions = regions.data.map((item)=> <p>{ item.name }</p>)
+    return (
+      <div>
+        Loading regions: { regions.loading }
+        <Regions/>
+        Loading entry: {entry.loading}
+        <div>{{ entry.data.text }}</div>
+      </div>
+    );
+  }
+}
+
+const SmartComponent = connect(select)(Application);
+
+React.render(
+  <Provider store={store}>
+    <SmartComponent />
+  </Provider>,
+  document.getElementById("content")
+);
+```

package/lib/PubSub.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+var PubSub = exports["default"] = /*#__PURE__*/function () {
+  function PubSub() {
+    _classCallCheck(this, PubSub);
+    this.container = [];
+  }
+  return _createClass(PubSub, [{
+    key: "push",
+    value: function push(cb) {
+      cb instanceof Function && this.container.push(cb);
+    }
+  }, {
+    key: "resolve",
+    value: function resolve(data) {
+      var container = this.container;
+      this.container = [];
+      container.forEach(function (cb) {
+        return cb(null, data);
+      });
+    }
+  }, {
+    key: "reject",
+    value: function reject(err) {
+      var container = this.container;
+      this.container = [];
+      container.forEach(function (cb) {
+        return cb(err);
+      });
+    }
+  }]);
+}();
+module.exports = exports.default;
+//# sourceMappingURL=PubSub.js.map

package/lib/PubSub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PubSub.js","names":["Object","defineProperty","exports","value","_typeof","o","Symbol","iterator","constructor","prototype","_classCallCheck","a","n","TypeError","_defineProperties","e","r","t","length","enumerable","configurable","writable","_toPropertyKey","key","_createClass","i","_toPrimitive","toPrimitive","call","String","Number","PubSub","container","push","cb","Function","resolve","data","forEach","reject","err","module","default"],"sources":["../src/PubSub.js"],"sourcesContent":["\"use strict\";\n\nexport default class PubSub {\n  constructor() {\n    this.container = [];\n  }\n\n  push(cb) {\n    cb instanceof Function && this.container.push(cb);\n  }\n\n  resolve(data) {\n    const container = this.container;\n    this.container = [];\n    container.forEach(cb => cb(null, data));\n  }\n\n  reject(err) {\n    const container = this.container;\n    this.container = [];\n    container.forEach(cb => cb(err));\n  }\n}\n"],"mappings":"AAAA,YAAY;;AAACA,MAAA,CAAAC,cAAA,CAAAC,OAAA;EAAAC,KAAA;AAAA;AAAAD,OAAA;AAAA,SAAAE,QAAAC,CAAA,sCAAAD,OAAA,wBAAAE,MAAA,uBAAAA,MAAA,CAAAC,QAAA,aAAAF,CAAA,kBAAAA,CAAA,gBAAAA,CAAA,WAAAA,CAAA,yBAAAC,MAAA,IAAAD,CAAA,CAAAG,WAAA,KAAAF,MAAA,IAAAD,CAAA,KAAAC,MAAA,CAAAG,SAAA,qBAAAJ,CAAA,KAAAD,OAAA,CAAAC,CAAA;AAAA,SAAAK,gBAAAC,CAAA,EAAAC,CAAA,UAAAD,CAAA,YAAAC,CAAA,aAAAC,SAAA;AAAA,SAAAC,kBAAAC,CAAA,EAAAC,CAAA,aAAAC,CAAA,MAAAA,CAAA,GAAAD,CAAA,CAAAE,MAAA,EAAAD,CAAA,UAAAZ,CAAA,GAAAW,CAAA,CAAAC,CAAA,GAAAZ,CAAA,CAAAc,UAAA,GAAAd,CAAA,CAAAc,UAAA,QAAAd,CAAA,CAAAe,YAAA,kBAAAf,CAAA,KAAAA,CAAA,CAAAgB,QAAA,QAAArB,MAAA,CAAAC,cAAA,CAAAc,CAAA,EAAAO,cAAA,CAAAjB,CAAA,CAAAkB,GAAA,GAAAlB,CAAA;AAAA,SAAAmB,aAAAT,CAAA,EAAAC,CAAA,EAAAC,CAAA,WAAAD,CAAA,IAAAF,iBAAA,CAAAC,CAAA,CAAAN,SAAA,EAAAO,CAAA,GAAAC,CAAA,IAAAH,iBAAA,CAAAC,CAAA,EAAAE,CAAA,GAAAjB,MAAA,CAAAC,cAAA,CAAAc,CAAA,iBAAAM,QAAA,SAAAN,CAAA;AAAA,SAAAO,eAAAL,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,gCAAAb,OAAA,CAAAqB,CAAA,IAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,oBAAAZ,OAAA,CAAAa,CAAA,MAAAA,CAAA,SAAAA,CAAA,MAAAF,CAAA,GAAAE,CAAA,CAAAX,MAAA,CAAAqB,WAAA,kBAAAZ,CAAA,QAAAU,CAAA,GAAAV,CAAA,CAAAa,IAAA,CAAAX,CAAA,EAAAD,CAAA,gCAAAZ,OAAA,CAAAqB,CAAA,UAAAA,CAAA,YAAAZ,SAAA,yEAAAG,CAAA,GAAAa,MAAA,GAAAC,MAAA,EAAAb,CAAA;AAAA,IAEQc,MAAM,GAAA7B,OAAA;EACzB,SAAA6B,OAAA,EAAc;IAAArB,eAAA,OAAAqB,MAAA;IACZ,IAAI,CAACC,SAAS,GAAG,EAAE;EACrB;EAAC,OAAAR,YAAA,CAAAO,MAAA;IAAAR,GAAA;IAAApB,KAAA,EAED,SAAA8B,KAAKC,EAAE,EAAE;MACPA,EAAE,YAAYC,QAAQ,IAAI,IAAI,CAACH,SAAS,CAACC,IAAI,CAACC,EAAE,CAAC;IACnD;EAAC;IAAAX,GAAA;IAAApB,KAAA,EAED,SAAAiC,QAAQC,IAAI,EAAE;MACZ,IAAML,SAAS,GAAG,IAAI,CAACA,SAAS;MAChC,IAAI,CAACA,SAAS,GAAG,EAAE;MACnBA,SAAS,CAACM,OAAO,CAAC,UAAAJ,EAAE;QAAA,OAAIA,EAAE,CAAC,IAAI,EAAEG,IAAI,CAAC;MAAA,EAAC;IACzC;EAAC;IAAAd,GAAA;IAAApB,KAAA,EAED,SAAAoC,OAAOC,GAAG,EAAE;MACV,IAAMR,SAAS,GAAG,IAAI,CAACA,SAAS;MAChC,IAAI,CAACA,SAAS,GAAG,EAAE;MACnBA,SAAS,CAACM,OAAO,CAAC,UAAAJ,EAAE;QAAA,OAAIA,EAAE,CAACM,GAAG,CAAC;MAAA,EAAC;IAClC;EAAC;AAAA;AAAAC,MAAA,CAAAvC,OAAA,GAAAA,OAAA,CAAAwC,OAAA","ignoreList":[]}