@twreporter/redux 7.5.2-rc.0 → 7.6.0-rc.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.6.0-rc.0](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/redux@7.5.2-rc.1...@twreporter/redux@7.6.0-rc.0) (2023-06-12)
+
+
+### Features
+
+* add firstName and lastName and role for user store ([ea21518](https://github.com/twreporter/twreporter-npm-packages/commit/ea21518b60ccd1d7ae098895af1a01c94d35e846))
+* add user action test ([c8d5fc8](https://github.com/twreporter/twreporter-npm-packages/commit/c8d5fc8d25eac02a245653383ddf0c72935617d8))
+* add user reducer test ([28cc793](https://github.com/twreporter/twreporter-npm-packages/commit/28cc793bdf68559a4f81e44ab62e6ee62b58a1b7))
+* get and set user data ([17668f3](https://github.com/twreporter/twreporter-npm-packages/commit/17668f34eee9e305fd9c27278b986c1c2d251b99))
+
+
+
+
+
+## [7.5.2-rc.1](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/redux@7.5.2-rc.0...@twreporter/redux@7.5.2-rc.1) (2023-05-23)
+
+**Note:** Version bump only for package @twreporter/redux
+
+
+
+
+
 ## [7.5.2-rc.0](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/redux@7.5.1...@twreporter/redux@7.5.2-rc.0) (2023-05-22)
 
 **Note:** Version bump only for package @twreporter/redux

package/lib/actions/index.js

@@ -23,6 +23,8 @@ var _bookmarks = require("./bookmarks");
 
 var _latest = require("./latest");
 
+var _user = require("./user");
+
 var _default = {
   createSingleBookmark: _bookmarks.createSingleBookmark,
   deleteSingleBookmark: _bookmarks.deleteSingleBookmark,
@@ -42,6 +44,8 @@ var _default = {
   getAccessToken: _auth.getAccessToken,
   getMultipleBookmarks: _bookmarks.getMultipleBookmarks,
   getSingleBookmark: _bookmarks.getSingleBookmark,
-  searchAuthorsIfNeeded: _authors.searchAuthorsIfNeeded
+  searchAuthorsIfNeeded: _authors.searchAuthorsIfNeeded,
+  getUserData: _user.getUserData,
+  setUserData: _user.setUserData
 };
 exports["default"] = _default;

package/lib/actions/user.js

@@ -0,0 +1,183 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getUserData = getUserData;
+exports.setUserData = setUserData;
+
+var _url = require("../utils/url");
+
+var _apiConfig = _interopRequireDefault(require("../constants/api-config"));
+
+var _apiEndpoints = _interopRequireDefault(require("../constants/api-endpoints"));
+
+var _errorActionCreators = _interopRequireDefault(require("./error-action-creators"));
+
+var _reduxStateFieldNames = _interopRequireDefault(require("../constants/redux-state-field-names"));
+
+var _actionTypes = _interopRequireDefault(require("../constants/action-types"));
+
+var _axios = _interopRequireDefault(require("axios"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+// lodash
+var _ = {
+  get: _get["default"]
+};
+var apiTimeout = _apiConfig["default"].timeout;
+/**
+ * @typedef {Object} userData
+ * @property {string} email - email of user
+ * @property {string} id - id of user
+ * @property {string} jwt - json web token issued by backend for this certain user
+ */
+
+/**
+ * @typedef {Object} RequestAction
+ * @property {string} type - The type of action
+ * @property {string} payload.method - The HTTP request method
+ * @property {string} payload.url - The target to send request
+ * @property {Object} payload.body - The request body with POST, PUT, DELETE, or PATCH request
+ * @property {Object} payload.headers - The request header
+ */
+
+/**
+ * @typedef {Object} SuccessAction
+ * @property {string} type - The type of action
+ * @property {string} payload
+ * @property {Object} payload.data - Response data
+ * @property {string} payload.statusCode - Response status code
+ */
+
+/**
+ * @param {Object} axiosResponse
+ * @param {string} actionType
+ * @returns {SuccessAction}
+ */
+
+function buildSuccessActionFromRes(axiosResponse, actionType) {
+  return {
+    type: actionType,
+    payload: {
+      data: _.get(axiosResponse, 'data'),
+      statusCode: _.get(axiosResponse, 'status')
+    }
+  };
+}
+/**
+ *  @typedef {Object} FailAction
+ *  @property {string} type - Action error type
+ *  @property {string} payload
+ *  @property {string} payload.statusCode - Response status code
+ *  @property {string} payload.message - Error message
+ *  @property {object} payload.error - Error object
+ */
+
+/**
+ *
+ *
+ * @export
+ * @param {string} jwt - access_token granted for the user
+ * @param {number} userID - id of user
+ * @return {Function} - function will be executed in Redux Thunk middleware
+ */
+// TODO: wait till api ready
+
+
+function getUserData(jwt, userID) {
+  /**
+   * @param {Function} dispatch - Redux store dispatch function
+   * @param {Function} getState - Redux store getState function
+   * @return {Promise} resolve with success action or reject with fail action
+   */
+  // return function(dispatch, getState) {
+  //   const state = getState()
+  //   const apiOrigin = _.get(state, [stateFieldNames.origins, 'api'])
+  //   const url = formURL(
+  //     apiOrigin,
+  //     `/v2/${apiEndpoints.users}/${userID}`,
+  //   )
+  //   dispatch({
+  //     type: types.user.read.request,
+  //     url
+  //   })
+  //   const axiosConfig = {
+  //     timeout: apiTimeout,
+  //     headers: {
+  //       Authorization: `Bearer ${jwt}`,
+  //     },
+  //   }
+  //   return axios
+  //     .get(url, axiosConfig)
+  //     .then(res => {
+  //       const successAction = buildSuccessActionFromRes(
+  //         res,
+  //         types.user.read.success
+  //       )
+  //       dispatch(successAction)
+  //       return successAction
+  //     })
+  //     .catch(error => {
+  //       const failAction = failActionCreators.axios(
+  //         error,
+  //         types.user.read.failure
+  //       )
+  //       dispatch(failAction)
+  //       return Promise.reject(failAction)
+  //     })
+  // }
+}
+/**
+ *
+ *
+ * @export
+ * @param {string} jwt - access_token granted for the user
+ * @param {number} userID - id of user
+ * @param {string[]} readPreference - subscribed topics
+ * @param {string[]} maillist - subscribed mail list
+ * @return {Function} - function will be executed in Redux Thunk middleware
+ */
+
+
+function setUserData(jwt, userID, readPreference, maillist) {
+  /**
+   * @param {Function} dispatch - Redux store dispatch function
+   * @param {Function} getState - Redux store getState function
+   * @return {Promise} resolve with success action or reject with fail action
+   */
+  return function (dispatch, getState) {
+    var state = getState();
+
+    var apiOrigin = _.get(state, [_reduxStateFieldNames["default"].origins, 'api']);
+
+    var url = (0, _url.formURL)(apiOrigin, "/v2/".concat(_apiEndpoints["default"].users, "/").concat(userID));
+    dispatch({
+      type: _actionTypes["default"].user.update.request,
+      url: url
+    });
+    var axiosConfig = {
+      timeout: apiTimeout,
+      headers: {
+        Authorization: "Bearer ".concat(jwt)
+      }
+    };
+    var body = {
+      read_preference: readPreference,
+      maillist: maillist
+    };
+    return _axios["default"].post(url, body, axiosConfig).then(function (res) {
+      var successAction = buildSuccessActionFromRes(res, _actionTypes["default"].user.update.success);
+      dispatch(successAction);
+      return successAction;
+    })["catch"](function (error) {
+      var failAction = _errorActionCreators["default"].axios(error, _actionTypes["default"].user.update.failure);
+
+      dispatch(failAction);
+      return Promise.reject(failAction);
+    });
+  };
+}

package/lib/constants/action-types.js

@@ -131,6 +131,18 @@ var _default = {
   },
   dataAlreadyExists: 'data already exists',
   noMoreItemsToFetch: 'no more items to fetch',
-  lastActionIsStillProcessing: 'last action is still processing'
+  lastActionIsStillProcessing: 'last action is still processing',
+  user: {
+    read: {
+      request: 'request to fetch single user data',
+      success: 'succes to fetch single user data',
+      failure: 'fail to fetch single user data'
+    },
+    update: {
+      request: 'request to update user data',
+      success: 'succes to update user data',
+      failure: 'fail to update user data'
+    }
+  }
 };
 exports["default"] = _default;

package/lib/constants/redux-state-field-names.js

@@ -22,7 +22,8 @@ var authorsList = 'authorsList';
 var bookmarks = 'bookmarks';
 var bookmarkWidget = 'bookmarkWidget';
 var entitiesForAuthors = 'entitiesForAuthors';
-var searchedAuthorsList = 'searchedAuthorsList'; // sections in index_page
+var searchedAuthorsList = 'searchedAuthorsList';
+var user = 'user'; // sections in index_page
 
 var editorPicksSection = 'editor_picks_section';
 var infographicsSection = 'infographics_section';
@@ -100,6 +101,7 @@ var _default = {
   searchedAuthorsList: searchedAuthorsList,
   settings: settings,
   relatedPostsOf: 'relatedPostsOf',
-  featureTopic: 'featureTopic'
+  featureTopic: 'featureTopic',
+  user: user
 };
 exports["default"] = _default;

package/lib/index.js

@@ -41,6 +41,8 @@ var _posts = require("./reducers/posts");
 
 var _topics = require("./reducers/topics");
 
+var _user = _interopRequireDefault(require("./reducers/user"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
 // actions
@@ -59,7 +61,8 @@ var _default = {
     posts: _posts.posts,
     relatedPostsOf: _relatedPostsOf["default"],
     topic: _topics.topic,
-    topics: _topics.topics
+    topics: _topics.topics,
+    user: _user["default"]
   },
   reduxStateFields: _reduxStateFieldNames["default"],
   ReduxStoreContext: _reduxStore["default"],

package/lib/reducers/index.js

@@ -39,12 +39,14 @@ var _settings = _interopRequireDefault(require("./settings"));
 
 var _latest = _interopRequireDefault(require("./latest"));
 
+var _user = _interopRequireDefault(require("./user"));
+
 var _combineReducers;
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var rootReducer = (0, _redux.combineReducers)((_combineReducers = {}, _defineProperty(_combineReducers, _reduxStateFieldNames["default"].articlesByAuthor, _authorArticles.articlesByAuthor), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].auth, _auth["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].authorsList, _authors.authorsList), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].bookmarks, _bookmarks["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].bookmarkWidget, _bookmarkWidget["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].entities, _entities["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].indexPage, _indexPage["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].lists, _posts.posts), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].searchedAuthorsList, _authors.searchedAuthorsList), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].selectedPost, _posts.post), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].selectedTopic, _topics.topic), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].topicList, _topics.topics), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].relatedPostsOf, _relatedPostsOf["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].featureTopic, _featureTopic["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].entitiesForAuthors, _entitiesForAuthors["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].origins, _origins["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].settings, _settings["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].latest, _latest["default"]), _combineReducers));
+var rootReducer = (0, _redux.combineReducers)((_combineReducers = {}, _defineProperty(_combineReducers, _reduxStateFieldNames["default"].articlesByAuthor, _authorArticles.articlesByAuthor), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].auth, _auth["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].authorsList, _authors.authorsList), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].bookmarks, _bookmarks["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].bookmarkWidget, _bookmarkWidget["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].entities, _entities["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].indexPage, _indexPage["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].lists, _posts.posts), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].searchedAuthorsList, _authors.searchedAuthorsList), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].selectedPost, _posts.post), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].selectedTopic, _topics.topic), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].topicList, _topics.topics), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].relatedPostsOf, _relatedPostsOf["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].featureTopic, _featureTopic["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].entitiesForAuthors, _entitiesForAuthors["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].origins, _origins["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].settings, _settings["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].latest, _latest["default"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].user, _user["default"]), _combineReducers));
 var _default = rootReducer;
 exports["default"] = _default;

package/lib/reducers/user.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = user;
+
+var _actionTypes = _interopRequireDefault(require("../constants/action-types"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _merge = _interopRequireDefault(require("lodash/merge"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var _ = {
+  get: _get["default"],
+  merge: _merge["default"]
+};
+var initState = {
+  error: null,
+  isFetching: false,
+  isReady: false,
+  // TODO: need add other user state after connect to getUser api
+  // userID: -1,
+  // firstName: '',
+  // lastName: '',
+  // role: MEMBER_ROLE.explorer,
+  // email: '',
+  // activated: false,
+  readPreference: [],
+  maillist: []
+};
+
+function user() {
+  var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : initState;
+  var action = arguments.length > 1 ? arguments[1] : undefined;
+  var payload = action.payload;
+
+  switch (action.type) {
+    case _actionTypes["default"].user.update.request:
+      {
+        return _.merge({}, state, {
+          isFetching: true,
+          isReady: false
+        });
+      }
+
+    case _actionTypes["default"].user.update.success:
+      {
+        var readPreference = _.get(payload, 'data.record.read_preference', []);
+
+        var maillist = _.get(payload, 'data.record.maillist', []);
+
+        state.readPreference = readPreference;
+        state.maillist = maillist;
+        return _objectSpread(_objectSpread({}, state), {}, {
+          error: null,
+          isFetching: false,
+          isReady: true,
+          maillist: maillist,
+          readPreference: readPreference
+        });
+      }
+
+    case _actionTypes["default"].user.update.failure:
+      {
+        return _objectSpread(_objectSpread({}, state), {}, {
+          error: payload.error,
+          isFetching: false,
+          isReady: false
+        });
+      }
+
+    default:
+      return state;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twreporter/redux",
-  "version": "7.5.2-rc.0",
+  "version": "7.6.0-rc.0",
   "description": "redux actions and reducers for twreporter website",
   "repository": "https://github.com/twreporter/twreporter-npm-packages.git",
   "author": "twreporter <developer@twreporter.org>",
@@ -25,7 +25,7 @@
   },
   "homepage": "https://github.com/twreporter/twreporter-redux/#readme",
   "dependencies": {
-    "@twreporter/core": "^1.10.0-rc.0",
+    "@twreporter/core": "^1.10.0-rc.2",
     "axios": "^0.19.0",
     "es6-error": "^4.0.2",
     "humps": "^0.6.0",
@@ -44,5 +44,5 @@
   "files": [
     "lib"
   ],
-  "gitHead": "9302a1179e3e640d73d8ee73cb5596944824ba23"
+  "gitHead": "7f423041f31558196c12a2cb438b506619bc5f68"
 }