@twreporter/redux 7.8.3-rc.2 → 7.9.0-rc.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.9.0-rc.0](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/redux@7.8.3-rc.2...@twreporter/redux@7.9.0-rc.0) (2023-12-26)
+
+
+### Features
+
+* **redux/src/actions/__test__/analytics.test:** add 400 error test case ([0aa8530](https://github.com/twreporter/twreporter-npm-packages/commit/0aa853077bf87edd24e02508ae0b2b15ab7a04bf))
+* analytics action & test ([f303c78](https://github.com/twreporter/twreporter-npm-packages/commit/f303c780d1f65cdbb856560e7481d6238e9675f8))
+* analytics reducer & test ([d63f9b4](https://github.com/twreporter/twreporter-npm-packages/commit/d63f9b4388f113416bd9132cb7001f62441fd3bc))
+* get analytics data from getUser ([45570fc](https://github.com/twreporter/twreporter-npm-packages/commit/45570fc2a8d081cf92bc52cf86230bfb3f752742))
+
+
+
+
+
 ## [7.8.3-rc.2](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/redux@7.8.3-rc.1...@twreporter/redux@7.8.3-rc.2) (2023-12-26)
 
 **Note:** Version bump only for package @twreporter/redux

package/lib/actions/analytics.js

@@ -0,0 +1,146 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setUserAnalyticsData = setUserAnalyticsData;
+
+var _url = require("../utils/url");
+
+var _apiConfig = _interopRequireDefault(require("../constants/api-config"));
+
+var _apiEndpoints = _interopRequireDefault(require("../constants/api-endpoints"));
+
+var _reduxStateFieldNames = _interopRequireDefault(require("../constants/redux-state-field-names"));
+
+var _actionTypes = _interopRequireDefault(require("../constants/action-types"));
+
+var _nodeFetch = _interopRequireDefault(require("node-fetch"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+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); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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"]
+};
+var apiTimeout = _apiConfig["default"].timeout;
+/**
+ * @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} fetchResponse
+ * @param {string} actionType
+ * @returns {SuccessAction}
+ */
+
+function buildSuccessActionFromRes(fetchResponse, actionType) {
+  return {
+    type: actionType,
+    payload: {
+      data: _.get(fetchResponse, 'data'),
+      statusCode: _.get(fetchResponse, '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
+ * @param {string} postID - id of post
+ * @param {object} readPostStatus - read post record
+ * @param {boolean} readPostStatus.readPostCount - read post or not
+ * @param {number} readPostStatus.readPostSec - read post second
+ * @return {Function} - function will be executed in Redux Thunk middleware
+ */
+
+
+function setUserAnalyticsData(jwt, userID, postID, _ref) {
+  var readPostCount = _ref.readPostCount,
+      readPostSec = _ref.readPostSec;
+
+  /**
+   * @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, "/analytics"));
+    dispatch({
+      type: _actionTypes["default"].analytics.update.request,
+      url: url
+    });
+    var fetchConfig = {
+      keepalive: true,
+      method: 'POST',
+      timeout: apiTimeout,
+      headers: {
+        Authorization: "Bearer ".concat(jwt)
+      }
+    };
+    var body = {
+      post_id: postID,
+      read_posts_count: readPostCount,
+      read_posts_sec: readPostSec
+    };
+    return (0, _nodeFetch["default"])(url, _objectSpread(_objectSpread({}, fetchConfig), {}, {
+      body: JSON.stringify(body)
+    })).then(function (response) {
+      return response.json().then(function (data) {
+        return {
+          status: response.status,
+          body: data
+        };
+      });
+    }).then(function (res) {
+      var successAction = buildSuccessActionFromRes({
+        data: res.body,
+        status: res.status
+      }, _actionTypes["default"].analytics.update.success);
+      dispatch(successAction);
+      return successAction;
+    })["catch"](function (error) {
+      var failAction = {
+        type: _actionTypes["default"].analytics.update.failure,
+        payload: {
+          error: error
+        }
+      };
+      dispatch(failAction);
+      return Promise.reject(failAction);
+    });
+  };
+}

package/lib/actions/index.js

@@ -25,6 +25,8 @@ var _latest = require("./latest");
 
 var _user = require("./user");
 
+var _analytics = require("./analytics");
+
 var _default = {
   createSingleBookmark: _bookmarks.createSingleBookmark,
   deleteSingleBookmark: _bookmarks.deleteSingleBookmark,
@@ -47,6 +49,7 @@ var _default = {
   searchAuthorsIfNeeded: _authors.searchAuthorsIfNeeded,
   getUserData: _user.getUserData,
   setUserData: _user.setUserData,
-  onboarding: _user.onboarding
+  onboarding: _user.onboarding,
+  setUserAnalyticsData: _analytics.setUserAnalyticsData
 };
 exports["default"] = _default;

package/lib/constants/action-types.js

@@ -143,6 +143,13 @@ var _default = {
       success: 'succes to update user data',
       failure: 'fail to update user data'
     }
+  },
+  analytics: {
+    update: {
+      request: 'request to update user analytics data',
+      success: 'succes to update user analytics data',
+      failure: 'fail to update user analytics data'
+    }
   }
 };
 exports["default"] = _default;

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

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

package/lib/reducers/analytics.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = analytics;
+
+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); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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,
+  userID: -1,
+  postID: '',
+  readPostsCount: false,
+  readPostsSec: 0
+};
+
+function analytics() {
+  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"].analytics.update.request:
+      {
+        return _.merge({}, state, {
+          isFetching: true,
+          isReady: false
+        });
+      }
+
+    case _actionTypes["default"].analytics.update.success:
+      {
+        var userID = _.get(payload, 'data.user_id');
+
+        var postID = _.get(payload, 'data.post_id');
+
+        var readPostsCount = _.get(payload, 'data.read_posts_count');
+
+        var readPostsSec = _.get(payload, 'data.read_posts_sec');
+
+        return _objectSpread(_objectSpread({}, state), {}, {
+          error: null,
+          isFetching: false,
+          isReady: true,
+          userID: userID,
+          postID: postID,
+          readPostsCount: readPostsCount,
+          readPostsSec: readPostsSec
+        });
+      }
+
+    case _actionTypes["default"].analytics.update.failure:
+      {
+        return _objectSpread(_objectSpread({}, state), {}, {
+          error: payload.error,
+          isFetching: false,
+          isReady: false
+        });
+      }
+
+    default:
+      return state;
+  }
+}

package/lib/reducers/index.js

@@ -41,12 +41,14 @@ var _latest = _interopRequireDefault(require("./latest"));
 
 var _user = _interopRequireDefault(require("./user"));
 
+var _analytics = _interopRequireDefault(require("./analytics"));
+
 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"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].user, _user["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"]), _defineProperty(_combineReducers, _reduxStateFieldNames["default"].analytics, _analytics["default"]), _combineReducers));
 var _default = rootReducer;
 exports["default"] = _default;

package/lib/reducers/user.js

@@ -35,7 +35,10 @@ var initState = {
   registrationDate: '',
   activated: false,
   readPreference: [],
-  maillist: []
+  maillist: [],
+  agreeDataCollection: true,
+  readPostsCount: 0,
+  readPostsSec: 0
 };
 
 function user() {
@@ -72,6 +75,12 @@ function user() {
 
         var maillist = _.get(payload, 'data.data.maillist');
 
+        var agreeDataCollection = _.get(payload, 'data.data.agree_data_collection');
+
+        var readPostsCount = _.get(payload, 'data.data.read_posts_count');
+
+        var readPostsSec = _.get(payload, 'data.data.read_posts_sec');
+
         return _objectSpread(_objectSpread({}, state), {}, {
           error: null,
           isFetching: false,
@@ -84,7 +93,10 @@ function user() {
           registrationDate: registrationDate,
           activated: activated,
           readPreference: readPreference,
-          maillist: maillist
+          maillist: maillist,
+          agreeDataCollection: agreeDataCollection,
+          readPostsCount: readPostsCount,
+          readPostsSec: readPostsSec
         });
       }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twreporter/redux",
-  "version": "7.8.3-rc.2",
+  "version": "7.9.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>",
@@ -38,11 +38,11 @@
     "redux-thunk": "^2.3.0"
   },
   "devDependencies": {
-    "nock": "10.0.6",
+    "nock": "^13.4.0",
     "redux-mock-store": "^1.2.3"
   },
   "files": [
     "lib"
   ],
-  "gitHead": "93053f2487a052dce9e04f4acfdb1aa747a11439"
+  "gitHead": "2790482023d97249c159feeff8afe2e65b26813a"
 }