@zengenti/contensis-react-base 2.4.1-beta.7 → 2.5.1-beta.0

package/CHANGELOG.md

@@ -1,3 +1,64 @@
+#### 2.5.0 (2021-09-20)
+
+##### New Features
+
+- Removed useUser hook and created hooks for change password, forgot password (c65d6dd7)
+- add entryMapper to /util utility function to clean up code when mapping route entries with jsonpath-mapper style templates and default arguments (3b6132d9)
+
+##### Bug Fixes
+
+- Error messages not displaying on the various password forms when operations fail (341bc827)
+- issue with a default value set in typescript refactor (822da5c9)
+- added two missing routing selectors (2ddc26e6)
+- server side debugging requires an old version of babel-plugin to define the set globals in the app (09566a99)
+- changes in latest immutable js typings break existing selectors by changing their return value from any to unknown, update search package to fix bug with ToJS component. Use typescript eslint import resolver (9da62533)
+- update search package to set projectId in listings (098ea40f)
+- small issue with SSR and dynamic bundles need to filter out some undefined array items from the loadable modules (c9fa233f)
+
+##### Build System / Dependencies
+
+- install latest search package and uninstall unused packages (81f1c1eb)
+- update search package to add missing types, add rules-of-hooks back to eslintrc, correct staticRoute type in OnRouteLoadArgs (c7d1a9ce)
+- add follow-tags to git push in release script so we caputure the tag created by npm version command (7030a4fd)
+- adding further types to app config (d5da430c)
+- add types to AppConfig keys (2c0d3447)
+- search index.d.ts is not being copied in CI (0f6b7137)
+- copy typescript models for search package as existing d.ts files are ignored by tsc (5f1ce21f)
+- add missing @types packages (0f54a201)
+- update search package to fix build (5223e118)
+- update package-lock to fix build (a2f40c58)
+- fix no default export in /client (9e10dc24)
+- most models not published to npm (1b2eea17)
+- try remove now redundant build stage (87d68755)
+- handle all exports via index file, use ts-patch to be able to use tsconfig plugins to transform alias paths in d.ts files to usable paths for consumers (7fd52af6)
+- update packages (dcc3cbd4)
+- change npm script in CI to clean assets and build models with tsc (32c61de8)
+- further TypeScript work (e91452d8)
+- TypeScript with rollup and babel initial commit (2c737ed9)##### Other Changes
+
+##### Performance Improvements
+
+- remove excess code from bundles (03773ece)
+- update zengenti packages (f654d22a)
+
+##### Refactors
+
+- further typescript conversions (9c88cd52)
+- further typescript conversions (d7010813)
+- typescript conversion progress, all models exported through default package, convert client entrypoint and types for routes and routing events (2a15b4c6)
+- typescript conversion progress, types added for globals and server start config (12e17c53)
+
+##### Documentation Changes
+
+- add TypeScript notes to README (0a8bcabd)
+- tweak package description text (4f713d5a)
+- update CHANGELOG (b8b1b488)
+
+#### Other changes
+
+- zengenti/contensis-react-base into dom-auth-changes-merge (7d6e7ed9)
+- //github.com/zengenti/contensis-react-base into contensis-14-forgot-change-password (c6775cf1)
+
 #### 2.4.0 (2021-08-19)
 
 ##### Build System / Dependencies

package/README.md

@@ -4,6 +4,18 @@ Everything you need to get started with React and Contensis.
 
 Handles web app routing with Contensis Site View and component rendering based on a loaded Content Type entry in Contensis, Redux application store creation and all the major application dependencies to get going, with server side rendering and an Express web server.
 
+## v2.6 Installation Notes
+
+This version introduces React v17. React is very sensitive to having multiple versions installed at the same time.
+
+Many projects upgrading to v2.6 of `contensis-react-base` are likely to be using an older version of Storybook which when installed along with React 17 results in multiple versions of React being installed and resulting in the app not rendering giving a react console error.
+
+You will need to upgrade your version of Storybook to be >= 6.1 which has support for React 17. [Further reading](https://storybook.js.org/blog/storybook-6-1/)
+
+TLDR: Storybook have provided a simple way to upgrade. Run `npx sb upgrade` when upgrading to v2.6 of `contensis-react-base`. You should also ensure you are running the latest version of webpack or webpack@4 to prevent futher errors when loading Storybook.
+
+If you are still getting react errors after this, check your project for other dependencies to remove/update that rely on older versions of react
+
 # What's goin' on under the hood? 🔧
 
 The core of your Contensis React application is in package `@zengenti/contensis-react-base` this must be installed as a 'production' dependency, i.e. lives in the `dependencies` section of your `package.json`
@@ -46,6 +58,8 @@ Default export `ZengentiAppServer` which has a `.start()` function attached for
 
 Named export `{ ReactApp }` provides a ready-made instance of a root `<App>` component to provide as the first argument to `ZengentiAppServer.start()`
 
+All TypeScript models are exported from here and should be imported in your app from the default package `@zengenti/contensis-react-base`
+
 ### /client
 
 Default export `ClientApp` which is a class when instantiated with `new ClientApp` accepts two constructor arguments similar to `ZengentiAppServer.start()` except for use when loading the application via the client-side entrypoint
@@ -79,6 +93,20 @@ Some simple utility functions to save repetion of common functions in our app co
 - mapping functions when working with certain Contensis api results or data types
 - a copy of `ZenInfo` page to show certain build and expose configuration parameters. Something we usually include with every deployed site and served at `/zenInfo` route.
 
+### Using imports in your app
+
+You should not import files from any other place than the packages / subpackages mentioned in this README. e.g. using imports like `@zengenti/contensis-react-base/cjs/client` or `@zengenti/contensis-react-base/models/*` is not recommended as it will not provide you with the best build output and they could change in future and would not be reflected in the semantic versioning having the potential to cause problems in future.
+
+Sometimes VSCode may import the reference automatically from an unsupported place. You should check when committing your code that all imports are referenced correctly.
+
+## TypeScript support
+
+As of v2.5.0 TypeScript declarations are available to use, and will also benefit applications written in JavaScript
+
+All models are exported with the default package `@zengenti/contensis-react-base`
+
+When importing Types to use in your own TypeScript project, try to always use the root import path e.g. `import { ModelName } from '@zengenti/contensis-react-base';`
+
 ## Key scripts to build from source 🚦 📃
 
 - `npm install` - install dependencies so we can get started
@@ -92,6 +120,67 @@ https://www.conventionalcommits.org/en/v1.0.0/#summary
 
 # Changelog
 
+#### 2.5.0 (2021-09-20)
+
+##### New Features
+
+- Removed useUser hook and created hooks for change password, forgot password (c65d6dd7)
+- add entryMapper to /util utility function to clean up code when mapping route entries with jsonpath-mapper style templates and default arguments (3b6132d9)
+
+##### Bug Fixes
+
+- Error messages not displaying on the various password forms when operations fail (341bc827)
+- issue with a default value set in typescript refactor (822da5c9)
+- added two missing routing selectors (2ddc26e6)
+- server side debugging requires an old version of babel-plugin to define the set globals in the app (09566a99)
+- changes in latest immutable js typings break existing selectors by changing their return value from any to unknown, update search package to fix bug with ToJS component. Use typescript eslint import resolver (9da62533)
+- update search package to set projectId in listings (098ea40f)
+- small issue with SSR and dynamic bundles need to filter out some undefined array items from the loadable modules (c9fa233f)
+
+##### Build System / Dependencies
+
+- install latest search package and uninstall unused packages (81f1c1eb)
+- update search package to add missing types, add rules-of-hooks back to eslintrc, correct staticRoute type in OnRouteLoadArgs (c7d1a9ce)
+- add follow-tags to git push in release script so we caputure the tag created by npm version command (7030a4fd)
+- adding further types to app config (d5da430c)
+- add types to AppConfig keys (2c0d3447)
+- search index.d.ts is not being copied in CI (0f6b7137)
+- copy typescript models for search package as existing d.ts files are ignored by tsc (5f1ce21f)
+- add missing @types packages (0f54a201)
+- update search package to fix build (5223e118)
+- update package-lock to fix build (a2f40c58)
+- fix no default export in /client (9e10dc24)
+- most models not published to npm (1b2eea17)
+- try remove now redundant build stage (87d68755)
+- handle all exports via index file, use ts-patch to be able to use tsconfig plugins to transform alias paths in d.ts files to usable paths for consumers (7fd52af6)
+- update packages (dcc3cbd4)
+- change npm script in CI to clean assets and build models with tsc (32c61de8)
+- further TypeScript work (e91452d8)
+- TypeScript with rollup and babel initial commit (2c737ed9)##### Other Changes
+
+##### Performance Improvements
+
+- remove excess code from bundles (03773ece)
+- update zengenti packages (f654d22a)
+
+##### Refactors
+
+- further typescript conversions (9c88cd52)
+- further typescript conversions (d7010813)
+- typescript conversion progress, all models exported through default package, convert client entrypoint and types for routes and routing events (2a15b4c6)
+- typescript conversion progress, types added for globals and server start config (12e17c53)
+
+##### Documentation Changes
+
+- add TypeScript notes to README (0a8bcabd)
+- tweak package description text (4f713d5a)
+- update CHANGELOG (b8b1b488)
+
+#### Other changes
+
+- zengenti/contensis-react-base into dom-auth-changes-merge (7d6e7ed9)
+- //github.com/zengenti/contensis-react-base into contensis-14-forgot-change-password (c6775cf1)
+
 #### 2.4.0 (2021-08-19)
 
 ##### Build System / Dependencies

package/cjs/{App-f3164dab.js → App-8f560cc5.js}

@@ -7,20 +7,21 @@ require('redux-immutable');
 require('redux-thunk');
 require('redux-saga');
 require('redux-injectors');
-var injectors = require('./injectors-72d5b989.js');
-var actions = require('./actions-e22726ed.js');
-var reducers = require('./reducers-91e3e239.js');
+var version = require('./version-3a808c12.js');
+var actions = require('./actions-e9f69947.js');
+var reducers = require('./reducers-cb531715.js');
 var history$1 = require('history');
 var effects = require('@redux-saga/core/effects');
 var contensisDeliveryApi = require('contensis-delivery-api');
-var version = require('./version-2193b4a2.js');
+var version$1 = require('./version-2193b4a2.js');
 require('query-string');
-var selectors = require('./selectors-69c3d37c.js');
+var selectors = require('./selectors-1295124a.js');
 var log = require('loglevel');
-var login = require('./login-6c0ef139.js');
+var ToJs = require('./ToJs-d72e5b10.js');
+var login = require('./login-4f274c6a.js');
 var awaitToJs = require('await-to-js');
 require('react-hot-loader');
-var RouteLoader = require('./RouteLoader-5c44f039.js');
+var RouteLoader = require('./RouteLoader-f99cd734.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -32,7 +33,7 @@ const browserHistory = selectedHistory();
 
 const storeSurrogateKeys = response => {
   const keys = response.headers.get ? response.headers.get('surrogate-key') : response.headers.map['surrogate-key'];
-  if (keys) injectors.reduxStore.dispatch(actions.setSurrogateKeys(keys));
+  if (keys) version.reduxStore.dispatch(actions.setSurrogateKeys(keys));
 };
 
 const getClientConfig = project => {
@@ -303,13 +304,13 @@ class CachedSearch {
 
 const cachedSearch = new CachedSearch();
 
-const navigationSagas = [effects.takeEvery(injectors.GET_NODE_TREE, ensureNodeTreeSaga)];
+const navigationSagas = [effects.takeEvery(version.GET_NODE_TREE, ensureNodeTreeSaga)];
 function* ensureNodeTreeSaga(action) {
   const state = yield effects.select();
 
   try {
-    if (!injectors.hasNavigationTree(state)) {
-      const deliveryApiVersionStatus = yield effects.select(version.selectVersionStatus);
+    if (!version.hasNavigationTree(state)) {
+      const deliveryApiVersionStatus = yield effects.select(version$1.selectVersionStatus);
       const project = yield effects.select(selectors.selectCurrentProject);
       const nodes = yield deliveryApi.getClient(deliveryApiVersionStatus, project).nodes.getRoot({
         depth: action.treeDepth || 0
@@ -317,18 +318,18 @@ function* ensureNodeTreeSaga(action) {
 
       if (nodes) {
         yield effects.put({
-          type: injectors.SET_NODE_TREE,
+          type: version.SET_NODE_TREE,
           nodes
         });
       } else {
         yield effects.put({
-          type: injectors.GET_NODE_TREE_ERROR
+          type: version.GET_NODE_TREE_ERROR
         });
       }
     }
   } catch (ex) {
     yield effects.put({
-      type: injectors.GET_NODE_TREE_ERROR,
+      type: version.GET_NODE_TREE_ERROR,
       error: ex.toString()
     });
   }
@@ -424,7 +425,7 @@ function* getRouteSaga(action) {
     const routeNode = selectors.selectCurrentNode(state);
     const currentPath = action.path; //selectCurrentPath(state);
 
-    const deliveryApiStatus = version.selectVersionStatus(state);
+    const deliveryApiStatus = version$1.selectVersionStatus(state);
     const project = selectors.selectCurrentProject(state);
     const isHome = currentPath === '/';
     const isPreview = currentPath && currentPath.startsWith('/preview/');
@@ -611,9 +612,9 @@ function* getRouteSaga(action) {
       }
     }
 
-    if (!injectors.hasNavigationTree(state) && (doNavigation === true || doNavigation.tree)) if (typeof window !== 'undefined') {
+    if (!version.hasNavigationTree(state) && (doNavigation === true || doNavigation.tree)) if (typeof window !== 'undefined') {
       yield effects.put({
-        type: injectors.GET_NODE_TREE,
+        type: version.GET_NODE_TREE,
         treeDepth: doNavigation === true || !doNavigation.tree || doNavigation.tree === true ? 2 : doNavigation.tree
       });
     } else {
@@ -703,7 +704,7 @@ function* reduxInjectorSaga(injectorFn) {
       reducer,
       saga
     } = yield injectorFn();
-    injectors.injectRedux({
+    version.injectRedux({
       key,
       reducer,
       saga
@@ -786,6 +787,220 @@ function* redirectSaga() {
   if (redirectUri) yield effects.put(actions.setRoute(redirectUri));
 }
 
+const PAP_URL = 'https://pap.zengenti.com';
+const USER_ENVS_URI = 'my-environments';
+const USER_RESEND_VERIFICATION_URI = 'account/verify/resend';
+const USER_REQUEST_PASSWORD_RESET_URI = 'account/reset';
+const USER_RESET_PASSWORD_URI = 'account/reset/password';
+const USER_ENVS_URL = `${PAP_URL}/${USER_ENVS_URI}`;
+const BASE_OPTIONS = {
+  method: 'GET',
+  headers: {
+    'Content-Type': 'application/json'
+  }
+};
+class UserHelper {
+  static async GetUsersEnvironments(securityToken) {
+    const options = { ...BASE_OPTIONS,
+      headers: {
+        'x-security-token': securityToken
+      }
+    };
+    return await UserHelper.get(USER_ENVS_URL, options);
+  }
+
+  static async ResendUserVerification(userEmail) {
+    const options = { ...BASE_OPTIONS
+    };
+    return await UserHelper.get(`/${USER_RESEND_VERIFICATION_URI}?user=${userEmail}`, options);
+  }
+
+  static async RequestPasswordReset(userEmailObject) {
+    const options = { ...BASE_OPTIONS,
+      body: JSON.stringify(userEmailObject)
+    };
+    options.method = 'POST';
+    return await UserHelper.get(`/${USER_REQUEST_PASSWORD_RESET_URI}`, options);
+  }
+
+  static async ResetPassword(resetPasswordObject) {
+    const options = { ...BASE_OPTIONS,
+      body: JSON.stringify(resetPasswordObject)
+    };
+    options.method = 'POST';
+    return await UserHelper.get(`/${USER_RESET_PASSWORD_URI}`, options);
+  }
+
+  static async get(url, options = BASE_OPTIONS) {
+    try {
+      const responseBody = await api(url, options);
+      return responseBody;
+    } catch (err) {
+      return {
+        error: {
+          message: err.message
+        }
+      };
+    }
+  }
+
+}
+
+async function api(url, options) {
+  return fetch(url, options).then(async response => {
+    return response.json().then(data => data);
+  }).catch(error => {
+    throw error;
+  });
+}
+
+const resetPasswordSagas = [effects.takeEvery(reducers.REQUEST_USER_PASSWORD_RESET, requestPasswordResetSaga), effects.takeEvery(reducers.RESET_USER_PASSWORD, resetPasswordSaga), effects.takeEvery(reducers.CHANGE_USER_PASSWORD, changePasswordSaga)];
+
+function* requestPasswordResetSaga(action) {
+  const userEmailObject = action.userEmailObject;
+  yield effects.put({
+    type: reducers.REQUEST_USER_PASSWORD_RESET_SENDING
+  });
+
+  if (userEmailObject && userEmailObject.userEmail) {
+    try {
+      const passwordResetRequestResponse = yield UserHelper.RequestPasswordReset(userEmailObject);
+
+      if (passwordResetRequestResponse) {
+        if (!passwordResetRequestResponse.error) {
+          yield effects.put({
+            type: reducers.REQUEST_USER_PASSWORD_RESET_SUCCESS
+          });
+        } else {
+          yield effects.put({
+            type: reducers.REQUEST_USER_PASSWORD_RESET_ERROR,
+            error: passwordResetRequestResponse.error.message
+          });
+        }
+      } else {
+        yield effects.put({
+          type: reducers.REQUEST_USER_PASSWORD_RESET_ERROR,
+          error: 'No response from server'
+        });
+      }
+    } catch (error) {
+      yield effects.put({
+        type: reducers.REQUEST_USER_PASSWORD_RESET_ERROR,
+        error: error && error.toString()
+      });
+    }
+  } else {
+    yield effects.put({
+      type: reducers.REQUEST_USER_PASSWORD_RESET_ERROR,
+      error: 'Invalid object'
+    });
+  }
+}
+
+function* resetPasswordSaga(action) {
+  const resetPasswordObject = action.resetPasswordObject;
+  yield effects.put({
+    type: reducers.RESET_USER_PASSWORD_SENDING
+  });
+
+  if (resetPasswordObject.token && resetPasswordObject.password) {
+    try {
+      const resetPasswordResponse = yield UserHelper.ResetPassword(resetPasswordObject);
+
+      if (resetPasswordResponse) {
+        if (!resetPasswordResponse.error) {
+          yield effects.put({
+            type: reducers.RESET_USER_PASSWORD_SUCCESS
+          });
+        } else {
+          const error = resetPasswordResponse.error.data && resetPasswordResponse.error.data.length > 0 && resetPasswordResponse.error.data[0].message || resetPasswordResponse.error.message;
+          yield effects.put({
+            type: reducers.RESET_USER_PASSWORD_ERROR,
+            error
+          });
+        }
+      } else {
+        yield effects.put({
+          type: reducers.RESET_USER_PASSWORD_ERROR,
+          error: 'No response from server'
+        });
+      }
+    } catch (error) {
+      yield effects.put({
+        type: reducers.RESET_USER_PASSWORD_ERROR,
+        error: error && error.toString()
+      });
+    }
+  } else {
+    yield effects.put({
+      type: reducers.RESET_USER_PASSWORD_ERROR,
+      error: 'Invalid object'
+    });
+  }
+} // userId
+// existingPassword
+// newPassword
+
+
+function* changePasswordSaga(action) {
+  if (!action || !action.userId || !action.currentPassword || !action.newPassword) {
+    yield effects.put({
+      type: reducers.CHANGE_USER_PASSWORD_ERROR,
+      error: 'Invalid action object sent to changePassword saga'
+    });
+    return;
+  }
+
+  try {
+    const changePasswordObject = {
+      userId: action.userId,
+      existing: action.currentPassword,
+      new: action.newPassword
+    };
+    yield effects.put({
+      type: reducers.CHANGE_USER_PASSWORD_SENDING
+    });
+    const clientCredentials = (yield effects.select(ToJs.selectClientCredentials)).toJS();
+    const client = yield login.getManagementApiClient({ ...clientCredentials
+    });
+    const [err, res] = yield awaitToJs.to(client.security.users.updatePassword(changePasswordObject));
+
+    if (err) {
+      var _err$data, _err$data$data, _err$data2;
+
+      const error = (err === null || err === void 0 ? void 0 : (_err$data = err.data) === null || _err$data === void 0 ? void 0 : (_err$data$data = _err$data.data) === null || _err$data$data === void 0 ? void 0 : _err$data$data.length) > 0 && err.data.data[0].message || (err === null || err === void 0 ? void 0 : (_err$data2 = err.data) === null || _err$data2 === void 0 ? void 0 : _err$data2.message);
+      yield effects.put({
+        type: reducers.CHANGE_USER_PASSWORD_ERROR,
+        error
+      });
+      return;
+    } // // eslint-disable-next-line no-console
+    // console.log(changePasswordObject);
+    // // eslint-disable-next-line no-console
+    // console.log(userCredentialsObject);
+
+
+    yield effects.put({
+      type: reducers.CHANGE_USER_PASSWORD_SUCCESS
+    });
+  } catch (error) {
+    yield effects.put({
+      type: reducers.CHANGE_USER_PASSWORD_ERROR,
+      error: error && error.toString()
+    });
+  }
+}
+
+const userSagas = [...login.loginSagas, ...registerSagas, ...resetPasswordSagas];
+
+// index.js
+function rootSaga (featureSagas = []) {
+  return function* rootSaga() {
+    const subSagas = [...routingSagas, ...navigationSagas, ...userSagas];
+    yield effects.all([...subSagas, ...featureSagas]);
+  };
+}
+
 const servers = SERVERS;
 /* global SERVERS */
 
@@ -834,10 +1049,9 @@ const AppRoot = props => {
 };
 
 exports.AppRoot = AppRoot;
+exports.browserHistory = browserHistory;
 exports.deliveryApi = deliveryApi;
 exports.history = history;
-exports.navigationSagas = navigationSagas;
 exports.pickProject = pickProject;
-exports.registerSagas = registerSagas;
-exports.routingSagas = routingSagas;
-//# sourceMappingURL=App-f3164dab.js.map
+exports.rootSaga = rootSaga;
+//# sourceMappingURL=App-8f560cc5.js.map