@times-components/user-state 0.4.2 → 0.4.3

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.3](https://github.com/newsuk/times-components/compare/@times-components/user-state@0.4.2...@times-components/user-state@0.4.3) (2022-10-18)
+
+
+### Bug Fixes
+
+* **TDP-2612:** UserState refactor ([#3167](https://github.com/newsuk/times-components/issues/3167)) ([acb908b](https://github.com/newsuk/times-components/commit/acb908ba9827284f9d91b02c1246f4578716c559))
+
+
+
+
+
 ## [0.4.2](https://github.com/newsuk/times-components/compare/@times-components/user-state@0.4.1...@times-components/user-state@0.4.2) (2022-10-14)
 
 **Note:** Version bump only for package @times-components/user-state

package/README.md

@@ -37,17 +37,6 @@ The `state` property is simply a matcher function that gets passed the current u
 state and returns true/false to decide whether to return the children or
 the fallback.
 
-`UserState` also provides a number of preset matchers which you can use.
-
-- `loggedIn`: Is the user logged in at all (subscriber, RA, RA Expired)
-- `meteredExpired`: Is the user RA Expired
-- `metered`: Is the user RA or RA Expired
-- `shared`: Is the user viewing with a shareToken
-- `nonExpiredUser`: Is the user logged in with access (subscriber, RA)
-- `fullArticle`: Does the user have access to the full article (subscriber, RA, share token)
-- `subscriber`: Is the user a subscriber
-- `loggedInOrShared`: Is the user logged in or on a share token (subscriber, RA, RA Expired, share token)
-
 ```js
 // In the test file
 import { mockUserState } from "@times-components/user-state";

package/dist/matchers.js

@@ -3,58 +3,69 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isLoggedInOrShared = exports.shouldShowFullArticle = exports.isNonMeteredExpiredUser = exports.isSubscriber = exports.isMetered = exports.isShared = exports.isMeteredExpired = exports.hasAccess = exports.isLoggedIn = void 0;
+exports.showJoinTheConversationDialog = exports.showCommentingModule = exports.showTokenisedEmailShare = exports.showArticleSaveButton = exports.showTopicTags = exports.showArticleExtras = exports.showSaveAndShareBar = void 0;
 
-var isLoggedIn = function isLoggedIn(userState) {
-  return userState.isLoggedIn;
+/* User states */
+var isMeteredUser = function isMeteredUser(userState) {
+  return userState.isMetered || userState.isLightPackUser;
 };
 
-exports.isLoggedIn = isLoggedIn;
+var isLightPackExpired = function isLightPackExpired(userState) {
+  return userState.isLightPackUser && userState.viewsRemaining === 0;
+};
 
-var hasAccess = function hasAccess(userState) {
-  return userState.hasAccess;
+var isMeteredExpiredUser = function isMeteredExpiredUser(userState) {
+  return userState.isMeteredExpired || isLightPackExpired(userState);
 };
 
-exports.hasAccess = hasAccess;
+var isLoggedInWithAccess = function isLoggedInWithAccess(userState) {
+  return userState.isLoggedIn && !isMeteredExpiredUser(userState);
+};
 
-var isMeteredExpired = function isMeteredExpired(userState) {
-  return isLoggedIn(userState) && userState.isMeteredExpired;
+var isSubscriber = function isSubscriber(userState) {
+  return userState.isLoggedIn && !isMeteredUser(userState);
 };
+/* Entitlements */
 
-exports.isMeteredExpired = isMeteredExpired;
 
-var isShared = function isShared(userState) {
-  return userState.isShared;
+var showSaveAndShareBar = function showSaveAndShareBar(userState) {
+  return userState.isLoggedIn || userState.isShared;
 };
 
-exports.isShared = isShared;
+exports.showSaveAndShareBar = showSaveAndShareBar;
 
-var isMetered = function isMetered(userState) {
-  return isLoggedIn(userState) && userState.isMetered;
+var showArticleExtras = function showArticleExtras(userState) {
+  return isLoggedInWithAccess(userState) || userState.isShared;
 };
 
-exports.isMetered = isMetered;
+exports.showArticleExtras = showArticleExtras;
 
-var isSubscriber = function isSubscriber(userState) {
-  return isLoggedIn(userState) && !userState.isMetered && !userState.isMeteredExpired;
+var showTopicTags = function showTopicTags(userState) {
+  return userState.isLoggedIn || userState.isShared;
+};
+
+exports.showTopicTags = showTopicTags;
+
+var showArticleSaveButton = function showArticleSaveButton(userState) {
+  return userState.isLoggedIn;
 };
 
-exports.isSubscriber = isSubscriber;
+exports.showArticleSaveButton = showArticleSaveButton;
 
-var isNonMeteredExpiredUser = function isNonMeteredExpiredUser(user) {
-  return isLoggedIn(user) && !isMeteredExpired(user);
+var showTokenisedEmailShare = function showTokenisedEmailShare(userState) {
+  return isSubscriber(userState);
 };
 
-exports.isNonMeteredExpiredUser = isNonMeteredExpiredUser;
+exports.showTokenisedEmailShare = showTokenisedEmailShare;
 
-var shouldShowFullArticle = function shouldShowFullArticle(user) {
-  return isShared(user) || isNonMeteredExpiredUser(user) || hasAccess(user);
+var showCommentingModule = function showCommentingModule(userState) {
+  return isSubscriber(userState);
 };
 
-exports.shouldShowFullArticle = shouldShowFullArticle;
+exports.showCommentingModule = showCommentingModule;
 
-var isLoggedInOrShared = function isLoggedInOrShared(user) {
-  return isShared(user) || isLoggedIn(user);
+var showJoinTheConversationDialog = function showJoinTheConversationDialog(userState) {
+  return userState.isLoggedIn && isMeteredUser(userState);
 };
 
-exports.isLoggedInOrShared = isLoggedInOrShared;
+exports.showJoinTheConversationDialog = showJoinTheConversationDialog;

package/dist/mock-user-state.js

@@ -27,7 +27,7 @@ function mockUserState() {
     }, MockUserState);
 
     MockUserState.mockReset = function () {
-      MockUserState.mockStates = [RealUserState.fullArticle, RealUserState.loggedIn, RealUserState.loggedInOrShared, RealUserState.subscriber];
+      MockUserState.mockStates = [RealUserState.showSaveAndShareBar, RealUserState.showArticleExtras, RealUserState.showArticleSaveButton, RealUserState.showCommentingModule];
     };
 
     MockUserState.mockReset();

package/dist/user-state.js

@@ -63,15 +63,13 @@ function UserState(_ref) {
   });
 }
 
-UserState.loggedIn = _matchers.isLoggedIn;
-UserState.meteredExpired = _matchers.isMeteredExpired;
-UserState.metered = _matchers.isMetered;
-UserState.shared = _matchers.isShared;
-UserState.nonMeteredExpiredUser = _matchers.isNonMeteredExpiredUser;
-UserState.fullArticle = _matchers.shouldShowFullArticle;
-UserState.subscriber = _matchers.isSubscriber;
-UserState.loggedInOrShared = _matchers.isLoggedInOrShared;
-UserState.hasAccess = _matchers.hasAccess;
+UserState.showSaveAndShareBar = _matchers.showSaveAndShareBar;
+UserState.showArticleExtras = _matchers.showArticleExtras;
+UserState.showTopicTags = _matchers.showTopicTags;
+UserState.showArticleSaveButton = _matchers.showArticleSaveButton;
+UserState.showTokenisedEmailShare = _matchers.showTokenisedEmailShare;
+UserState.showCommentingModule = _matchers.showCommentingModule;
+UserState.showJoinTheConversationDialog = _matchers.showJoinTheConversationDialog;
 UserState.propTypes = {
   state: _propTypes["default"].func.isRequired,
   children: _propTypes["default"].node,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@times-components/user-state",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Selectively render react components based on current user state",
   "main": "dist/user-state",
   "dev": "src/user-state",
@@ -32,15 +32,15 @@
   "homepage": "https://github.com/newsuk/times-components#readme",
   "dependencies": {
     "@storybook/addon-knobs": "5.3.18",
-    "@times-components/context": "1.10.1",
-    "@times-components/utils": "6.15.1",
+    "@times-components/context": "1.10.2",
+    "@times-components/utils": "6.15.2",
     "prop-types": "15.7.2"
   },
   "devDependencies": {
     "@babel/core": "7.4.4",
     "@times-components/eslint-config-thetimes": "0.8.18",
     "@times-components/jest-configurator-web": "0.8.0",
-    "@times-components/jest-serializer": "3.4.1",
+    "@times-components/jest-serializer": "3.4.2",
     "@times-components/webpack-configurator": "2.1.0",
     "babel-jest": "24.8.0",
     "babel-loader": "8.0.5",
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1da4d8169d316fe83739814ab4ba16ce195709c9"
+  "gitHead": "0d8c91264a62f72c627c89b0953e66f4128c20ed"
 }

package/rnw.js

@@ -1 +1 @@
-module.exports=function(e){var r={};function t(n){if(r[n])return r[n].exports;var o=r[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,t),o.l=!0,o.exports}return t.m=e,t.c=r,t.d=function(e,r,n){t.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:n})},t.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.t=function(e,r){if(1&r&&(e=t(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(t.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var o in e)t.d(n,o,function(r){return e[r]}.bind(null,o));return n},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},t.p="",t(t.s=7)}([function(e,r){e.exports=require("react")},function(e,r){e.exports=require("@storybook/addon-knobs/react")},function(e,r){e.exports=require("prop-types")},function(e,r){e.exports=require("@times-components/context/rnw")},function(e,r){e.exports=require("@times-components/utils/rnw")},function(e,r){function t(e){var r=new Error("Cannot find module '"+e+"'");throw r.code="MODULE_NOT_FOUND",r}t.keys=function(){return[]},t.resolve=t,e.exports=t,t.id=5},function(e,r){e.exports=require("@times-components/user-state/rnw")},function(e,r,t){"use strict";t.r(r);var n=t(0),o=t.n(n),u=(t(2),t(3)),i=t.n(u),c=t(4);function s(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function f(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?s(Object(t),!0).forEach((function(r){a(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):s(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function a(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}var l=function(e){var r=e.children,t=e.serverRender,n=void 0===t||t;return o.a.createElement(i.a.Consumer,null,(function(e){var t=e.user;return o.a.createElement(c.ServerClientRender,{client:function(){var e=window.nuk,n=(void 0===e?{}:e).user||{};return r({user:f(f({},t),n)})},server:n?function(){return r({user:t})}:null})}))},d=function(e){return e.isLoggedIn},b=function(e){return e.hasAccess},p=function(e){return d(e)&&e.isMeteredExpired},O=function(e){return e.isShared},v=function(e){return d(e)&&!p(e)};var g,y=function(){jest.mock("@times-components/user-state",(function(){var e=t(5).requireActual("@times-components/user-state").default;function r(e){var t=e.state,n=e.children,o=void 0===n?null:n,u=e.fallback,i=void 0===u?null:u;return r.mockStates.find((function(e){return e===t}))?o:i}return Object.keys(e).reduce((function(r,t){return r[t]=e[t],r}),r),r.mockReset=function(){r.mockStates=[e.fullArticle,e.loggedIn,e.loggedInOrShared,e.subscriber]},r.mockReset(),r}));var e=t(6);return beforeEach((function(){e.mockReset()})),e},m="Registered Access",j="Registered Access (Expired)",S={SUBSCRIBER:"Subscriber",RA:m,RA_EXPIRED:j,GUEST:"Guest"},w=t(1);function P(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function h(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?P(Object(t),!0).forEach((function(r){E(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):P(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function E(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}var x=(E(g={},"Subscriber",["isLoggedIn"]),E(g,m,["isLoggedIn","isMetered"]),E(g,j,["isLoggedIn","isMetered","isMeteredExpired"]),E(g,"Guest",[]),g),k=["Subscriber",m,j,"Guest"];var R=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"Subscriber";window.nuk=window.nuk||{},Object.defineProperty(window.nuk,"user",{enumerable:!0,configurable:!0,get:function(){var r=Object(w.select)("Current User State",k,e,"User State"),t=Object(w.boolean)("Is Shared",!1,"User State"),n=x[r].reduce((function(e,r){return h(h({},e),{},E({},r,!0))}),{});return h({isLoggedIn:!1,isMetered:!1,isMeteredExpired:!1,isShared:t},n)}})};function M(e){var r=e.state,t=e.children,n=e.fallback,u=e.serverRender;return o.a.createElement(l,{serverRender:u},(function(e){var o=e.user;return r(o)?t:n}))}t.d(r,"mockUserState",(function(){return y})),t.d(r,"USER_STATES",(function(){return S})),t.d(r,"addUserStateKnobs",(function(){return R})),M.loggedIn=d,M.meteredExpired=p,M.metered=function(e){return d(e)&&e.isMetered},M.shared=O,M.nonMeteredExpiredUser=v,M.fullArticle=function(e){return O(e)||v(e)||b(e)},M.subscriber=function(e){return d(e)&&!e.isMetered&&!e.isMeteredExpired},M.loggedInOrShared=function(e){return O(e)||d(e)},M.hasAccess=b,M.defaultProps={children:null,serverRender:!0,fallback:null};r.default=M}]);
+module.exports=function(e){var r={};function t(n){if(r[n])return r[n].exports;var o=r[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,t),o.l=!0,o.exports}return t.m=e,t.c=r,t.d=function(e,r,n){t.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:n})},t.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.t=function(e,r){if(1&r&&(e=t(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(t.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var o in e)t.d(n,o,function(r){return e[r]}.bind(null,o));return n},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},t.p="",t(t.s=7)}([function(e,r){e.exports=require("react")},function(e,r){e.exports=require("@storybook/addon-knobs/react")},function(e,r){e.exports=require("prop-types")},function(e,r){e.exports=require("@times-components/context/rnw")},function(e,r){e.exports=require("@times-components/utils/rnw")},function(e,r){function t(e){var r=new Error("Cannot find module '"+e+"'");throw r.code="MODULE_NOT_FOUND",r}t.keys=function(){return[]},t.resolve=t,e.exports=t,t.id=5},function(e,r){e.exports=require("@times-components/user-state/rnw")},function(e,r,t){"use strict";t.r(r);var n=t(0),o=t.n(n),i=(t(2),t(3)),u=t.n(i),c=t(4);function s(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function a(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?s(Object(t),!0).forEach((function(r){f(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):s(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function f(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}var l=function(e){var r=e.children,t=e.serverRender,n=void 0===t||t;return o.a.createElement(u.a.Consumer,null,(function(e){var t=e.user;return o.a.createElement(c.ServerClientRender,{client:function(){var e=window.nuk,n=(void 0===e?{}:e).user||{};return r({user:a(a({},t),n)})},server:n?function(){return r({user:t})}:null})}))},d=function(e){return e.isMetered||e.isLightPackUser},b=function(e){return e.isLoggedIn&&!d(e)};var p,g=function(){jest.mock("@times-components/user-state",(function(){var e=t(5).requireActual("@times-components/user-state").default;function r(e){var t=e.state,n=e.children,o=void 0===n?null:n,i=e.fallback,u=void 0===i?null:i;return r.mockStates.find((function(e){return e===t}))?o:u}return Object.keys(e).reduce((function(r,t){return r[t]=e[t],r}),r),r.mockReset=function(){r.mockStates=[e.showSaveAndShareBar,e.showArticleExtras,e.showArticleSaveButton,e.showCommentingModule]},r.mockReset(),r}));var e=t(6);return beforeEach((function(){e.mockReset()})),e},v="Registered Access",O="Registered Access (Expired)",m={SUBSCRIBER:"Subscriber",RA:v,RA_EXPIRED:O,GUEST:"Guest"},y=t(1);function w(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function S(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?w(Object(t),!0).forEach((function(r){h(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):w(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function h(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}var j=(h(p={},"Subscriber",["isLoggedIn"]),h(p,v,["isLoggedIn","isMetered"]),h(p,O,["isLoggedIn","isMetered","isMeteredExpired"]),h(p,"Guest",[]),p),P=["Subscriber",v,O,"Guest"];var k=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"Subscriber";window.nuk=window.nuk||{},Object.defineProperty(window.nuk,"user",{enumerable:!0,configurable:!0,get:function(){var r=Object(y.select)("Current User State",P,e,"User State"),t=Object(y.boolean)("Is Shared",!1,"User State"),n=j[r].reduce((function(e,r){return S(S({},e),{},h({},r,!0))}),{});return S({isLoggedIn:!1,isMetered:!1,isMeteredExpired:!1,isShared:t},n)}})};function E(e){var r=e.state,t=e.children,n=e.fallback,i=e.serverRender;return o.a.createElement(l,{serverRender:i},(function(e){var o=e.user;return r(o)?t:n}))}t.d(r,"mockUserState",(function(){return g})),t.d(r,"USER_STATES",(function(){return m})),t.d(r,"addUserStateKnobs",(function(){return k})),E.showSaveAndShareBar=function(e){return e.isLoggedIn||e.isShared},E.showArticleExtras=function(e){return function(e){return e.isLoggedIn&&!function(e){return e.isMeteredExpired||function(e){return e.isLightPackUser&&0===e.viewsRemaining}(e)}(e)}(e)||e.isShared},E.showTopicTags=function(e){return e.isLoggedIn||e.isShared},E.showArticleSaveButton=function(e){return e.isLoggedIn},E.showTokenisedEmailShare=function(e){return b(e)},E.showCommentingModule=function(e){return b(e)},E.showJoinTheConversationDialog=function(e){return e.isLoggedIn&&d(e)},E.defaultProps={children:null,serverRender:!0,fallback:null};r.default=E}]);