@bigbinary/neeto-commons-frontend 2.0.17 → 2.0.19

package/README.md

@@ -1,13 +1,14 @@
 # neeto-commons-frontend
 
-The commons frontend library for Neeto Applications.
+A library encapsulating common boilerplate frontend code required for all neeto
+products.
 
 ## Installation Instructions
 
 Install from npm:
 
 ```bash
-yarn add "@bigbinary/neeto-commons-frontend@2.0.17"
+yarn add "@bigbinary/neeto-commons-frontend@2.0.19"
 ```
 
 This package relies on the host project's tailwind configuration. So add
@@ -76,25 +77,24 @@ When you are migrating from version 1 to version 2, do the following:
    file. You can omit the `--watch` flag if you want to run the build only once.
 5. In a different terminal, run `yalc publish` to publish the
    neeto-commons-frontend to the local yalc store.
-6. Run `yalc install` to install the neeto-commons-frontend to the host
-   application.
-7. After making all changes to `neeto-commons-frontend`, run `yalc push` to push
-   the changes to the host application.
+6. Run `yalc add @bigbinary/neeto-commons-frontend` to install the
+   neeto-commons-frontend to the host application.
+7. After making necessary changes to `neeto-commons-frontend`, run `yalc push`
+   to push the changes to the host application (assuming that you are in watch
+   mode and the changes are bundled automatically).
 8. Video explanation on how to use yalc: https://vimeo.com/722958162/9e931b640c
 
 ## Building and releasing.
 
 This is how releases are managed in this repo.
 
-- We will create a branch with the next release version as its name (`1.0.x`)
+- We will create a branch with the next release version as its name (`2.0.x`)
   from main branch.
 - Version in
   [README.md](https://github.com/bigbinary/neeto-commons-frontend/blob/main/README.md#L10)
   and
   [package.json](https://github.com/bigbinary/neeto-commons-frontend/blob/main/package.json#L3)
   will be updated to the current branch name.
-- From now on, we can install the package to neeto-applications using the
-  version `2.X.Y`.
 - We will create a draft PR of this branch targeting main. This keeps the branch
   in sync with main branch (bot-bigbinary will auto-merge the changes).
 - When all features have been built, we will deploy it to all neeto-applications
@@ -103,20 +103,17 @@ This is how releases are managed in this repo.
   usage of yalc is explained in this video:
   https://vimeo.com/722958162/9e931b640c
 - In case if we notice any problem during verification, like any missed edge
-  cases, we will fix the problem in this repo and re-run `yalc push` to install
-  the latest changes.
-- Once everything is fine and the verification is complete, we will create a
+  cases, we will fix the problem in neeto-commons-frontend locally and re-run
+  `yalc push` to update the local host projects.
+- Once everything is working fine and the verification is complete, create a PR
+  with those bug fixes and get it merged.
+- We will now merge the PR `2.X.Y` to main.
+- We can now create a
   [new github release](https://github.com/bigbinary/neeto-commons-frontend/releases/new)
-  from `2.X.Y` branch with the exact same name for the tag (`2.X.Y`). The target
-  branch will be kept as `2.X.Y`. This will create a tag from the latest `2.X.Y`
-  branch and this ensures that the latest commit on that branch will remain
-  intact even if that branch gets deleted.
+  from main branch with the current version as the tag name (`2.X.Y`).
 - Whenever a new release is created with a new version number, the github
   actions will automatically publish the built package to npm.
-- Now we will squash and merge the PR `2.X.Y` to main and delete its source
-  branch. This will delete all commits except the top one (since we have created
-  a tag with it).
-- Immediately, we will open another branch with the next version (`2.X.Y`) and
+- Immediately, we will open another branch with the next version (`2.X.Z`) and
   the cycle will continue.
 - Now we can run `yalc remove neeto-commons-frontend` to remove yalc based
   package and run `yarn add neeto-commons-frontend@2.X.Y` to fetch the latest

package/initializers.cjs.js

@@ -217,7 +217,9 @@ nullSafe(filterNonNull);
 var HEADERS_KEYS = {
   xAuthEmail: "X-Auth-Email",
   xAuthToken: "X-Auth-Token",
-  xCsrfToken: "X-CSRF-TOKEN"
+  xCsrfToken: "X-CSRF-TOKEN",
+  contentType: "Content-Type",
+  accept: "Accept"
 };
 
 var resetAuthTokens = function resetAuthTokens() {
@@ -231,12 +233,9 @@ var shouldNot = function shouldNot(skip) {
 };
 
 var setAuthHeaders = function setAuthHeaders() {
-  var _globalProps$user, _globalProps$user2;
+  var _document$querySelect, _axios$defaults$heade, _globalProps$user, _globalProps$user2;
 
-  axios__default["default"].defaults.headers = _defineProperty({
-    Accept: "application/json",
-    "Content-Type": "application/json"
-  }, HEADERS_KEYS.xCsrfToken, document.querySelector('[name="csrf-token"]').getAttribute("content"));
+  axios__default["default"].defaults.headers = (_axios$defaults$heade = {}, _defineProperty(_axios$defaults$heade, HEADERS_KEYS.accept, "application/json"), _defineProperty(_axios$defaults$heade, HEADERS_KEYS.contentType, "application/json"), _defineProperty(_axios$defaults$heade, HEADERS_KEYS.xCsrfToken, (_document$querySelect = document.querySelector('[name="csrf-token"]')) === null || _document$querySelect === void 0 ? void 0 : _document$querySelect.getAttribute("content")), _axios$defaults$heade);
   var token = (_globalProps$user = globalProps.user) === null || _globalProps$user === void 0 ? void 0 : _globalProps$user.authenticationToken;
   var email = (_globalProps$user2 = globalProps.user) === null || _globalProps$user2 === void 0 ? void 0 : _globalProps$user2.email;
 
@@ -573,25 +572,15 @@ function initializeLogger() {
 }
 
 function initializeMixPanel() {
-  var isProduction = process.env.NODE_ENV === "production";
-  var isTokenPresent = !!process.env.MIXPANEL_TOKEN;
   var isUserLoggedIn = !ramda.either(ramda.isEmpty, ramda.isNil)(globalProps.user);
-
-  if (isProduction && isTokenPresent && isUserLoggedIn) {
-    mixpanel__default["default"].init(process.env.MIXPANEL_TOKEN || "");
-    mixpanel__default["default"].people.set({
-      $email: globalProps.user.email,
-      $fist_name: globalProps.user.firstName,
-      $last_name: globalProps.user.lastName
-    });
-    mixpanel__default["default"].identify(globalProps.user.email);
-  } else {
-    /*
-    We need to initialize mixpanel with a bogus token in development and test environment to
-    prevent mixpanel library from throwing an error when we use mixpanel.track() method in react components.
-    */
-    mixpanel__default["default"].init("TEST_TOKEN");
-  }
+  mixpanel__default["default"].init(process.env.MIXPANEL_TOKEN || "TEST_TOKEN");
+  if (!isUserLoggedIn) return;
+  mixpanel__default["default"].people.set({
+    $email: globalProps.user.email,
+    $fist_name: globalProps.user.firstName,
+    $last_name: globalProps.user.lastName
+  });
+  mixpanel__default["default"].identify(globalProps.user.email);
 }
 
 exports.globalProps = {};

package/initializers.js

@@ -206,7 +206,9 @@ nullSafe(filterNonNull);
 var HEADERS_KEYS = {
   xAuthEmail: "X-Auth-Email",
   xAuthToken: "X-Auth-Token",
-  xCsrfToken: "X-CSRF-TOKEN"
+  xCsrfToken: "X-CSRF-TOKEN",
+  contentType: "Content-Type",
+  accept: "Accept"
 };
 
 var resetAuthTokens = function resetAuthTokens() {
@@ -220,12 +222,9 @@ var shouldNot = function shouldNot(skip) {
 };
 
 var setAuthHeaders = function setAuthHeaders() {
-  var _globalProps$user, _globalProps$user2;
+  var _document$querySelect, _axios$defaults$heade, _globalProps$user, _globalProps$user2;
 
-  axios.defaults.headers = _defineProperty({
-    Accept: "application/json",
-    "Content-Type": "application/json"
-  }, HEADERS_KEYS.xCsrfToken, document.querySelector('[name="csrf-token"]').getAttribute("content"));
+  axios.defaults.headers = (_axios$defaults$heade = {}, _defineProperty(_axios$defaults$heade, HEADERS_KEYS.accept, "application/json"), _defineProperty(_axios$defaults$heade, HEADERS_KEYS.contentType, "application/json"), _defineProperty(_axios$defaults$heade, HEADERS_KEYS.xCsrfToken, (_document$querySelect = document.querySelector('[name="csrf-token"]')) === null || _document$querySelect === void 0 ? void 0 : _document$querySelect.getAttribute("content")), _axios$defaults$heade);
   var token = (_globalProps$user = globalProps.user) === null || _globalProps$user === void 0 ? void 0 : _globalProps$user.authenticationToken;
   var email = (_globalProps$user2 = globalProps.user) === null || _globalProps$user2 === void 0 ? void 0 : _globalProps$user2.email;
 
@@ -562,25 +561,15 @@ function initializeLogger() {
 }
 
 function initializeMixPanel() {
-  var isProduction = process.env.NODE_ENV === "production";
-  var isTokenPresent = !!process.env.MIXPANEL_TOKEN;
   var isUserLoggedIn = !either(isEmpty, isNil)(globalProps.user);
-
-  if (isProduction && isTokenPresent && isUserLoggedIn) {
-    mixpanel.init(process.env.MIXPANEL_TOKEN || "");
-    mixpanel.people.set({
-      $email: globalProps.user.email,
-      $fist_name: globalProps.user.firstName,
-      $last_name: globalProps.user.lastName
-    });
-    mixpanel.identify(globalProps.user.email);
-  } else {
-    /*
-    We need to initialize mixpanel with a bogus token in development and test environment to
-    prevent mixpanel library from throwing an error when we use mixpanel.track() method in react components.
-    */
-    mixpanel.init("TEST_TOKEN");
-  }
+  mixpanel.init(process.env.MIXPANEL_TOKEN || "TEST_TOKEN");
+  if (!isUserLoggedIn) return;
+  mixpanel.people.set({
+    $email: globalProps.user.email,
+    $fist_name: globalProps.user.firstName,
+    $last_name: globalProps.user.lastName
+  });
+  mixpanel.identify(globalProps.user.email);
 }
 
 var globalProps$1 = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "2.0.17",
+  "version": "2.0.19",
   "description": "A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.",
   "repository": "git@github.com:bigbinary/neeto-commons-frontend.git",
   "author": "Amaljith K <amaljith.k@bigbinary.com>",
@@ -87,6 +87,7 @@
     "ramda": "^0.28.0",
     "react": "^17.0.2",
     "react-dom": "17.0.2",
+    "react-helmet": "^6.1.0",
     "react-i18next": "11.16.8",
     "react-query": "^3.39.2",
     "react-router-dom": "^5.2.0",