@bigbinary/neeto-commons-frontend 2.1.6 → 2.1.8

package/README.md

@@ -1,19 +1,19 @@
 # neeto-commons-frontend
 
-A library encapsulating common boilerplate frontend code required for all neeto
+A library that packages common boilerplate frontend code necessary for all neeto
 products.
 
 <table>
 <thead>
 <tr>
-<th>
+<th style="text-align: left;">
 
-Name
+Category
 
 </th>
-<th>
+<th style="text-align: left;">
 
-Category
+Name
 
 </th>
 </tr>
@@ -23,17 +23,16 @@ Category
 <tr>
 <td  style="vertical-align: top;">
 
+Initializers [↗](./docs/initializers/README.md)
+
+</td>
+<td  style="vertical-align: top;">
+
 - [Set up axios](./docs/initializers/axios.md)
 - [Set up globalProps](./docs/initializers/globalProps.md)
 - [Set up translations](./docs/initializers/translation.md)
-- [Set up mixpanel](./docs/initializers/mixpanel.md)
 - [Set up logger](./docs/initializers/logger.md)
 - [Disable React Developer Tools in production](./docs/initializers/reactDevTools.md)
-</td>
-<td  style="vertical-align: top;">
-
-[Initializers](./docs/initializers/README.md)
-
 </td>
 </tr>
 <tr></tr>
@@ -41,90 +40,100 @@ Category
 <tr>
 <td  style="vertical-align: top;">
 
-- [useDebounce](./docs/react/hooks.md#usedebounce)
-- [useFuncDebounce](./docs/react/hooks.md#usefuncdebounce)
-- [usePrevious](./docs/react/hooks.md#useprevious)
-- [useUpdateEffect](./docs/react/hooks.md#useupdateeffect)
-- [useLocalStorage](./docs/react/hooks.md#uselocalstorage)
-- [useOnClickOutside](./docs/react/hooks.md#useonclickoutside)
-- [useFieldSubmit](./docs/react/hooks.md#usefieldsubmit)
-- [useDisplayErrorPage](./docs/react/hooks.md#usedisplayerrorpage)
-- [useErrorDisplayStore](./docs/react/hooks.md#useerrordisplaystore)
-- [useHotKeys](./docs/react/hooks.md#usehotkeys)
-- [useTimer](./docs/react/hooks.md#usetimer)
-- [useRegisterNavigationCheckpoint](./docs/react/hooks.md#useregisternavigationcheckpoint)
-- [useNavigationCheckpoints](./docs/react/hooks.md#usenavigationcheckpoints)
-- [useStateWithDependency](./docs/react/hooks.md#usestatewithdependency)
-- [useMutationWithInvalidation](./docs/react/hooks.md#usemutationwithinvalidation)
-- [withImmutableActions](./docs/react/utils.md#withimmutableactions)
-- [withTitle](./docs/react/utils.md#withtitle)
-- [withT](./docs/react/utils.md#witht)
-- [registerBrowserNotifications](./docs/react/utils.md#registerbrowsernotifications)
-- [destroyBrowserSubscription](./docs/react/utils.md#destroybrowsersubscription)
-- [handleMetaClick](./docs/react/utils.md#handlemetaclick)
-- [isMetaKeyPressed](./docs/react/utils.md#ismetakeypressed)
-- [PrivateRoute](./docs/react/components.md#privateroute)
-- [HoneybadgerErrorBoundary](./docs/react/components.md#honeybadgererrorboundary)
+React utilities [↗](./docs/react/README.md)
 
 </td>
 <td  style="vertical-align: top;">
 
-[React utilities](./docs/react/README.md)
+- [useDebounce](./docs/react/hooks/useDebounce.md)
+- [useFuncDebounce](./docs/react/hooks/useFuncDebounce.md)
+- [usePrevious](./docs/react/hooks/usePrevious.md)
+- [useUpdateEffect](./docs/react/hooks/useUpdateEffect.md)
+- [useLocalStorage](./docs/react/hooks/useLocalStorage.md)
+- [useOnClickOutside](./docs/react/hooks/useOnClickOutside.md)
+- [useFieldSubmit](./docs/react/hooks/useFieldSubmit.md)
+- [useHotKeys](./docs/react/hooks/useHotKeys.md)
+- [useKeyboardShortcutsPaneState](./docs/react/hooks/useKeyboardShortcutsPaneState.md)
+- [useDisplayErrorPage](./docs/react/hooks/useDisplayErrorPage.md)
+- [useErrorDisplayStore](./docs/react/hooks/useErrorDisplayStore.md)
+- [useTimer](./docs/react/hooks/useTimer.md)
+- [useRegisterNavigationCheckpoint](./docs/react/hooks/useRegisterNavigationCheckpoint.md)
+- [useNavigationCheckpoints](./docs/react/hooks/useNavigationCheckpoints.md)
+- [useMutationWithInvalidation](./docs/react/hooks/useMutationWithInvalidation.md)
+- [useFetchNeetoApps](./docs/react/hooks/useFetchNeetoApps.md)
+- [usePersistedQuery](./docs/react/hooks/usePersistedQuery.md)
+- [useIsElementVisibleInDom](./docs/react/hooks/useIsElementVisibleInDom.md)
+- [useStateWithDependency](./docs/react/hooks/useStateWithDependency.md)
+- [PrivateRoute](./docs/react/components/PrivateRoute.md)
+- [HoneybadgerErrorBoundary](./docs/react/components/HoneybadgerErrorBoundary.md)
+- [withImmutableActions](./docs/react/utils/withImmutableActions.md)
+- [withTitle](./docs/react/utils/withTitle.md)
+- [registerBrowserNotifications](./docs/react/utils/registerBrowserNotifications.md)
+- [destroyBrowserSubscription](./docs/react/utils/destroyBrowserSubscription.md)
+- [handleMetaClick](./docs/react/utils/handleMetaClick.md)
+- [isMetaKeyPressed](./docs/react/utils/isMetaKeyPressed.md)
+- [withT](./docs/react/utils/withT.md)
 
 </td>
+  </tr>
+</td>
+
 </tr>
 <tr></tr>
 <tr>
 <td style="vertical-align: top;">
 
-- [findById](./docs/pure/arrays.md#findbyid)
-- [findIndexById](./docs/pure/arrays.md#findindexbyid)
-- [removeById](./docs/pure/arrays.md#removebyid)
-- [replaceById](./docs/pure/arrays.md#replacebyid)
-- [modifyById](./docs/pure/arrays.md#modifybyid)
-- [existsById](./docs/pure/arrays.md#existsbyid)
-- [findBy](./docs/pure/arrays.md#findby)
-- [findIndexBy](./docs/pure/arrays.md#findindexby)
-- [removeBy](./docs/pure/arrays.md#removeby)
-- [replaceBy](./docs/pure/arrays.md#replaceby)
-- [modifyBy](./docs/pure/arrays.md#modifyby)
-- [existsBy](./docs/pure/arrays.md#existsby)
-- [findLastBy](./docs/pure/arrays.md#findlastby)
-- [findLastIndexBy](./docs/pure/arrays.md#findlastindexby)
-- [filterBy](./docs/pure/arrays.md#filterby)
-- [countBy](./docs/pure/arrays.md#countby)
-- [renameKeys](./docs/pure/arrays.md#renamekeys)
-- [copyKeys](./docs/pure/arrays.md#copykeys)
-- [copyKeysDeep](./docs/pure/arrays.md#copykeysdeep)
-- [transformObjectDeep](./docs/pure/objects.md#transformobjectdeep)
-- [preprocessForSerialization](./docs/pure/objects.md#preprocessforserialization)
-- [keysToCamelCase](./docs/pure/objects.md#keystocamelcase)
-- [keysToSnakeCase](./docs/pure/objects.md#keystosnakecase)
-- [serializeKeysToSnakeCase](./docs/pure/objects.md#serializekeystosnakecase)
-- [deepFreezeObject](./docs/pure/objects.md#deepfreezeobject)
-- [matches](./docs/pure/objects.md#matches)
-- [filterNonNull](./docs/pure/objects.md#filternonnull)
-- [slugify](./docs/pure/strings.md#slugify)
-- [humanize](./docs/pure/strings.md#humanize)
-- [snakeToCamelCase](./docs/pure/strings.md#snaketocamelcase)
-- [camelToSnakeCase](./docs/pure/strings.md#cameltosnakecase)
-- [capitalize](./docs/pure/strings.md#capitalize)
-- [truncate](./docs/pure/strings.md#truncate)
-- [noop](./docs/pure/general.md#noop)
-- [toLabelAndValue](./docs/pure/general.md#tolabelandvalue)
-- [getRandomInt](./docs/pure/general.md#getrandomint)
-- [randomPick](./docs/pure/general.md#randompick)
-- [dynamicArray](./docs/pure/general.md#dynamicarray)
-- [isNotEmpty](./docs/pure/general.md#isnotempty)
-- [isNot (alias notEquals)](./docs/pure/general.md#isnot_alias_notequals)
-- [isNotEqualDeep (alias notEqualsDeep)](./docs/pure/general.md#isnotequaldeep_alias_notequalsdeep)
+Pure utility functions [↗](./docs/pure/README.md)
 
 </td>
 <td style="vertical-align: top;">
 
-[Pure utility functions](./docs/pure/README.md)
+- [findById](./docs/pure/arrays/findById.md)
+- [findIndexById](./docs/pure/arrays/findIndexById.md)
+- [removeById](./docs/pure/arrays/removeById.md)
+- [replaceById](./docs/pure/arrays/replaceById.md)
+- [modifyById](./docs/pure/arrays/modifyById.md)
+- [existsById](./docs/pure/arrays/existsById.md)
+- [findBy](./docs/pure/arrays/findBy.md)
+- [findIndexBy](./docs/pure/arrays/findIndexBy.md)
+- [removeBy](./docs/pure/arrays/removeBy.md)
+- [replaceBy](./docs/pure/arrays/replaceBy.md)
+- [modifyBy](./docs/pure/arrays/modifyBy.md)
+- [existsBy](./docs/pure/arrays/existsBy.md)
+- [findLastBy](./docs/pure/arrays/findLastBy.md)
+- [findLastIndexBy](./docs/pure/arrays/findLastIndexBy.md)
+- [filterBy](./docs/pure/arrays/filterBy.md)
+- [countBy](./docs/pure/arrays/countBy.md)
+- [renameKeys](./docs/pure/arrays/renameKeys.md)
+- [copyKeys](./docs/pure/arrays/copyKeys.md)
+- [copyKeysDeep](./docs/pure/arrays/copyKeysDeep.md)
+- [transformObjectDeep](./docs/pure/objects/transformObjectDeep.md)
+- [preprocessForSerialization](./docs/pure/objects/preprocessForSerialization.md)
+- [keysToCamelCase](./docs/pure/objects/keysToCamelCase.md)
+- [keysToSnakeCase](./docs/pure/objects/keysToSnakeCase.md)
+- [serializeKeysToSnakeCase](./docs/pure/objects/serializeKeysToSnakeCase.md)
+- [deepFreezeObject](./docs/pure/objects/deepFreezeObject.md)
+- [matches](./docs/pure/objects/matches.md)
+- [filterNonNull](./docs/pure/objects/filterNonNull.md)
+- [slugify](./docs/pure/strings/slugify.md)
+- [humanize](./docs/pure/strings/humanize.md)
+- [snakeToCamelCase](./docs/pure/strings/snakeToCamelCase.md)
+- [camelToSnakeCase](./docs/pure/strings/camelToSnakeCase.md)
+- [capitalize](./docs/pure/strings/capitalize.md)
+- [truncate](./docs/pure/strings/truncate.md)
+- [noop](./docs/pure/general/noop.md)
+- [toLabelAndValue](./docs/pure/general/toLabelAndValue.md)
+- [getRandomInt](./docs/pure/general/getRandomInt.md)
+- [randomPick](./docs/pure/general/randomPick.md)
+- [dynamicArray](./docs/pure/general/dynamicArray.md)
+- [isNotEmpty](./docs/pure/general/isNotEmpty.md)
+- [isNot](./docs/pure/general/isNot.md)
+- [isNotEqualDeep](./docs/pure/general/isNotEqualDeep.md)
+- [isNotPresent](./docs/pure/general/isNotPresent.md)
+- [modifyWithImmer](./docs/pure/general/modifyWithImmer.md)
 
 </td>
+
 </tr>
 
 <tr></tr>
@@ -132,28 +141,29 @@ Category
 <tr>
 <td style="vertical-align: top;">
 
-- [withEventTargetValue](./docs/utils/README.md#witheventtargetvalue)
-- [getSubdomain](./docs/utils/README.md#getsubdomain)
-- [simulateApiCall](./docs/utils/README.md#simulateapicall)
-- [copyToClipboard](./docs/utils/README.md#copytoclipboard)
-- [buildUrl](./docs/utils/README.md#buildurl)
-- [dateFormat/timeFormat](./docs/utils/README.md#dateformattimeformat)
-- [toLocale](./docs/utils/README.md#tolocale)
-- [getQueryParams](./docs/utils/README.md#getqueryparams)
-- [joinHyphenCase](./docs/utils/README.md#joinhyphencase)
-- [debounce](./docs/utils/README.md#debounce)
-- [hasPermission](./docs/utils/README.md#haspermission)
-- [hasAnyPermission](./docs/utils/README.md#hasanypermission)
-- [hasAllPermissions](./docs/utils/README.md#hasallpermission)
-- [createSubscription](./docs/utils/README.md#createsubscription)
-- [getFromLocalStorage](./docs/utils/README.md#getfromlocalstorage)
+Web utility functions [↗](./docs/utils/README.md)
 
 </td>
 <td style="vertical-align: top;">
 
-[Web utility functions](./docs/utils/README.md)
+- [withEventTargetValue](./docs/utils/withEventTargetValue.md)
+- [getSubdomain](./docs/utils/getSubdomain.md)
+- [simulateApiCall](./docs/utils/simulateApiCall.md)
+- [copyToClipboard](./docs/utils/copyToClipboard.md)
+- [buildUrl](./docs/utils/buildUrl.md)
+- [dateFormat](./docs/utils/dateFormat.md)
+- [toLocale](./docs/utils/toLocale.md)
+- [getQueryParams](./docs/utils/getQueryParams.md)
+- [joinHyphenCase](./docs/utils/joinHyphenCase.md)
+- [debounce](./docs/utils/debounce.md)
+- [hasPermission](./docs/utils/hasPermission.md)
+- [hasAnyPermission](./docs/utils/hasAnyPermission.md)
+- [hasAllPermissions](./docs/utils/hasAllPermissions.md)
+- [createSubscription](./docs/utils/createSubscription.md)
+- [getFromLocalStorage](./docs/utils/getFromLocalStorage.md)
 
 </td>
+
 </tr>
 
 </tbody>

package/configs/scripts/jsdoc-builder/constants.mjs

@@ -39,4 +39,4 @@ export const JSDOC_EXAMPLE_TAG = "@example ";
 export const JSDOC_END_EXAMPLE_TAG = "@endexample";
 export const ASTERISK = "*";
 export const ASTERISK_WITH_SPACES = " * ";
-export const WHITESPACE_REGEX = /\s/g;
+export const WHITESPACE_PARENTHESIS_REGEX = /[\s()]/g;

package/configs/scripts/jsdoc-builder/utils.mjs

@@ -22,7 +22,7 @@ import {
   PARAGRAPH_PATTERN,
   SUBHEADING_PATTERN,
   TYPES_FOLDER_NAME,
-  WHITESPACE_REGEX,
+  WHITESPACE_PARENTHESIS_REGEX,
 } from "./constants.mjs";
 import * as babelTypes from "@babel/types";
 import _traverse from "@babel/traverse";
@@ -33,7 +33,8 @@ import { matches } from "../../../pure.cjs.js";
 const traverse = _traverse.default;
 const generate = _generate.default;
 
-const removeSpaces = string => string.replace(WHITESPACE_REGEX, "");
+const removeWhiteSpaceAndParentheses = string =>
+  string.replace(WHITESPACE_PARENTHESIS_REGEX, "");
 
 const addLeadingCommentForTextWithLineBreaks = ({
   text,
@@ -145,7 +146,7 @@ export const buildEntityTitleToEntityDescMap = (nodes, map) => {
   nodes.forEach((node, idx) => {
     if (!matches(SUBHEADING_PATTERN, node)) return;
 
-    const entityName = removeSpaces(node.children[0].value);
+    const entityName = removeWhiteSpaceAndParentheses(node.children[0].value);
     const entityRightSiblings = [];
 
     for (let i = idx + 1; i < nodes.length; i++) {

package/cypress-utils.d.ts

@@ -243,9 +243,9 @@ export function initializeCredentials(props: {
 }): string;
 /**
  *
- * Curried: false
+ * The joinHyphenCase function joins an array of strings using hyphens as the
  *
- * This function joins the given strings with hyphen.
+ * delimiter and returns the resulting string.
  *
  * Any number of string arguments.
  *

package/initializers.cjs.js

@@ -2430,7 +2430,6 @@ var initializeI18n = function initializeI18n(resources) {
         translation: de
       }
     }),
-    supportedLngs: ["en", "de"],
     fallbackLng: "en",
     interpolation: {
       escapeValue: false,