feat: improve ts notation and upgrade dependencies

Author: themgoncalves

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

.husky/post-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+git update-index --again

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn test

.huskyrc

@@ -1,3 +1,4 @@
 ### @cookbook/mapper-js is authored by: 
 * Marcos <contact@themgoncalves.com>
 * Marcos Gonçalves <contact@themgoncalves.com>
+* semantic-release-bot <semantic-release-bot@martynus.net>

AUTHORS.md

@@ -1,4 +1,5 @@
 # @cookbook/mapper-js
+
 > Fast, reliable and intuitive object mapping.
 
 [![NPM Version][npm-image]][npm-url]
@@ -41,7 +42,7 @@ const source = {
   person: {
     name: {
       firstName: 'John',
-      lastName: 'Doe'
+      lastName: 'Doe',
     },
     age: 32,
     drinks: ['beer', 'whiskey'],
@@ -51,7 +52,7 @@ const source = {
         city: 'Cupertino',
         state: 'CA',
         postalCode: 95014,
-        country: 'United States'
+        country: 'United States',
       },
       {
         street: '1600 Amphitheatre',
@@ -60,12 +61,11 @@ const source = {
         postalCode: 94043,
         country: 'United States',
       },
-    ]
-  }
-}
+    ],
+  },
+};
 ```
 
-
 ### 2) Create your mapping using dot notation
 
 At this step, we need to create our `mapping` against our data `source`.
@@ -81,14 +81,14 @@ For that, `map()` accepts `single dot notation` path or
 `an array of dot notation paths`. E.g.: `map('person.name.firstName')`, `map([person.name.firstName, person.name.lastName]);`'
 
 Those values can be _transformed_ by using the `.transform()` method, which expects a `function` as argument and provides
-the selected values as array in the `parameter`. 
+the selected values as array in the `parameter`.
 
 > For more information about the usage, check the [API Documentation](#api-documentation).
 
-
 Now let's create our `mapping`!
 
 ```js
+// mapping.ts
 import mapper from '@cookbook/mapper-js';
 
 ...
@@ -106,15 +106,14 @@ const mapping = mapper((map) => ({
 }));
 ```
 
-
 ### 3) Create your mapped object
 
 ```js
-import mapper from '@cookbook/mapper-js';
+import mapping from './mapping';
 ...
 
 const result = mapping(source);
-/* outputs 
+/* outputs
 {
   person: {
     name: 'John Doe',
@@ -151,11 +150,10 @@ const result = mapping(source);
 **Return:** `<T>(source: object | object[], options?: Options) => T extends [] ? T[] : T`,
 **Signature:** `(mapping: Mapping) => <T>(source: object | object[], options?: Options) => T extends [] ? T[] : T`
 
-
 **Description:**
 
-  `mapper()` is the main method and responsible for mapping the _values_ from your _data source_ against the _mapping instructions_.
-  It accepts `dot notation` path(s) as `key(s)`.
+`mapper()` is the main method and responsible for mapping the _values_ from your _data source_ against the _mapping instructions_.
+It accepts `dot notation` path(s) as `key(s)`.
 
 Example:
 
@@ -173,9 +171,9 @@ const mapping = mapper((map) => ({
 }));
 ```
 
-  As a result from the above implementation, `mapper()` return a new `function` to map and compile your _source data_ against your _mapping_.
+As a result from the above implementation, `mapper()` return a new `function` to map and compile your _source data_ against your _mapping_.
 
-  It accepts an extra (_optional_) argument defining the [_global mapping options_](#mapper-options).
+It accepts an extra (_optional_) argument defining the [_global mapping options_](#mapper-options).
 
 Example:
 
@@ -184,7 +182,7 @@ Example:
 
 mapping(source, options);
 
-/* outputs 
+/* outputs
 {
   employee: {
     name: 'John',
@@ -203,77 +201,72 @@ mapping(source, options);
 }
 */
 ```
-___
 
+---
 
 ## map
 
 **Type:** `function`
-**Parameter:** `keys: string | string[], options?: Options` 
+**Parameter:** `keys: string | string[], options?: Options`
 **Return:** `MapMethods<T>`,
 **Signature:** `<T = unknown>(keys: string | string[], options?: Options) => MapMethods<T>`
 
-**Description:** 
+**Description:**
 
-  `root` method retrieves values from your _source data_ using `dot notation` path, it accepts a string or array of string.
+`root` method retrieves values from your _source data_ using `dot notation` path, it accepts a string or array of string.
 
-  It accepts an extra (_optional_) argument to define the [_mapping options for current entry_](#mapper-options), _overriding_ the _global mapping options_.
+It accepts an extra (_optional_) argument to define the [_mapping options for current entry_](#mapper-options), _overriding_ the _global mapping options_.
 
 Example:
+
 ```ts
 map('person.name.firstName');
 map(['person.name.firstName', 'person.name.lastName']);
 map(['person.name.firstName', 'person.name.lastName'], options);
 ```
 
-
 #### `transform`
 
 **Type:** `function`
 **Parameter:** `...unknown[]`
 **Return:** `unknown | unknown[]`,
 **Signature:** `(...args: unknown[]) => unknown | unknown[]`
 
-**Description:** 
+**Description:**
 
-  `.transform` method provides you the ability to _transform_ the retrieved value(s) from `map()` according to your needs, and for that, it expects a return value.
+`.transform` method provides you the ability to _transform_ the retrieved value(s) from `map()` according to your needs, and for that, it expects a return value.
 
-  `.transform` provides you as _parameter_, the retrieved value(s) in the **same order** as defined in the `map()` method, otherwise
+`.transform` provides you as _parameter_, the retrieved value(s) in the **same order** as defined in the `map()` method, otherwise
 
 Example:
+
 ```ts
 // single value
-map('person.name.firstName')
-   .transform((firstName) => firstName.toLoweCase());
+map('person.name.firstName').transform((firstName) => firstName.toLoweCase());
 
 // multiple values
-map(['person.name.firstName', 'person.name.lastName'])
-   .transform((firstName, lastName) => `${firstName} ${lastName}`);
+map(['person.name.firstName', 'person.name.lastName']).transform((firstName, lastName) => `${firstName} ${lastName}`);
 ```
 
-
 #### `value`
 
 **Type:** `readonly`
 **Return:** `T`
-**Description:** 
+**Description:**
 
-  `.value` returns the value of your `dot notation` query. If transformed, returns the transformed value.
+`.value` returns the value of your `dot notation` query. If transformed, returns the transformed value.
 
 Example:
+
 ```ts
 // single value
-map('person.name.firstName')
-   .transform((firstName) => firstName.toLoweCase())
-   .value;
+map('person.name.firstName').transform((firstName) => firstName.toLoweCase()).value;
 
 // multiple values
-map(['person.name.firstName', 'person.name.lastName'])
-   .transform((firstName, lastName) => `${firstName} ${lastName}`)
-   .value;
+map(['person.name.firstName', 'person.name.lastName']).transform((firstName, lastName) => `${firstName} ${lastName}`)
+  .value;
 ```
 
-
 ## Mapper Options
 
 ### defaults
@@ -292,9 +285,9 @@ map(['person.name.firstName', 'person.name.lastName'])
 **Type:** `boolean`
 **default value:** `false`
 
-**Description:** 
+**Description:**
 
-  Removes `null` or `undefined` entries from the _mapped_ object.
+Removes `null` or `undefined` entries from the _mapped_ object.
 
 Example:
 
@@ -309,11 +302,11 @@ Example:
 }
 */
 const mapping = mapper((map) => ({
-  'name': map('person.name').value,
-  'age': map('person.age').value,
-   // source doesn't have property 'address',
-   // therefore will return "undefined"
-  'address': map('person.address').value,
+  name: map('person.name').value,
+  age: map('person.age').value,
+  // source doesn't have property 'address',
+  // therefore will return "undefined"
+  address: map('person.address').value,
 }));
 
 mapping(source, { omitNullUndefined: true });
@@ -323,7 +316,6 @@ mapping(source, { omitNullUndefined: true });
   age: 32,
 }
 */
-
 ```
 
 **`omitStrategy`**
@@ -333,11 +325,12 @@ mapping(source, { omitNullUndefined: true });
 **Return:** `boolean`
 **Signature:** `(value: unknown | unknown[]) => boolean`
 
-**Description:** 
+**Description:**
 
-  Defines a _custom strategy_ to omit (_suppress_) entries from the _mapped object_.
+Defines a _custom strategy_ to omit (_suppress_) entries from the _mapped object_.
 
 Example:
+
 ```tsx
 /* source object
 {
@@ -359,9 +352,9 @@ Example:
 const customOmitStrategy = (address: Record<string, string>): boolean => address && address.city === 'Cupertino';
 
 const mapping = mapper((map) => ({
-  'name': map('person.name').value,
-  'age': map('person.age').value,
-  'address': map('person.address').value,
+  name: map('person.name').value,
+  age: map('person.age').value,
+  address: map('person.address').value,
 }));
 
 mapping(source, { omitStrategy: customOmitStrategy });
@@ -371,10 +364,10 @@ mapping(source, { omitStrategy: customOmitStrategy });
   age: 32,
 }
 */
-
 ```
 
 <!-- Markdown link & img dfn's -->
+
 [npm-image]: https://img.shields.io/npm/v/@cookbook/mapper-js.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/@cookbook/mapper-js
 [npm-downloads]: https://img.shields.io/npm/dm/@cookbook/mapper-js.svg?style=flat-square

README.md

@@ -46,8 +46,6 @@ module.exports = {
     'plugin:react/recommended',
     'eslint-config-prettier',
     'prettier',
-    'prettier/react',
-    'prettier/@typescript-eslint',
   ],
   rules: {
     '@typescript-eslint/explicit-function-return-type': [

configurations/eslint/config.js

@@ -8,8 +8,6 @@ module.exports = {
   moduleDirectories: ['node_modules', 'src'],
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'md'],
   moduleNameMapper: {
-    '^.+\\.(jpg|jpeg|png|gif||otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
-      './configurations/jest/__mocks__/file.js',
     '^configurations(.*)$': '<rootDir>/configurations$1',
   },
   collectCoverageFrom: [

configurations/jest/config.js

@@ -5,5 +5,4 @@ module.exports = {
   arrowParens:  'always',
   singleQuote: true,
   tabWidth: 2,
-  jsxBracketSameLine: false,
 };

configurations/prettier/config.js

@@ -20,10 +20,17 @@
   "homepage": "https://github.com/the-cookbook/mapper-js#readme",
   "keywords": [
     "library",
-    "javascript"
+    "javascript",
+    "typescript",
+    "mapper",
+    "mapping",
+    "data-mapping",
+    "object-mapping",
+    "dot-notation"
   ],
   "scripts": {
     "authors": "node ./scripts/authors.js",
+    "postinstall": "husky install",
     "prepare": "npm run build && npm run authors",
     "prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
@@ -46,84 +53,84 @@
     "prettier": "prettier -c --write 'src/**/*'"
   },
   "devDependencies": {
-    "@babel/cli": "7.12.16",
-    "@babel/core": "7.12.16",
-    "@babel/plugin-proposal-class-properties": "7.12.13",
-    "@babel/plugin-proposal-export-default-from": "7.12.13",
+    "@babel/cli": "7.15.7",
+    "@babel/core": "7.15.5",
+    "@babel/plugin-proposal-class-properties": "7.14.5",
+    "@babel/plugin-proposal-export-default-from": "7.14.5",
     "@babel/plugin-syntax-dynamic-import": "7.8.3",
-    "@babel/preset-env": "7.12.16",
-    "@babel/preset-react": "7.12.13",
-    "@babel/preset-typescript": "7.12.16",
-    "@commitlint/cli": "11.0.0",
-    "@commitlint/config-conventional": "11.0.0",
-    "@semantic-release/git": "9.0.0",
-    "@semantic-release/github": "7.2.0",
-    "@types/chai": "4.2.15",
-    "@types/core-js": "2.5.4",
+    "@babel/preset-env": "7.15.6",
+    "@babel/preset-react": "7.14.5",
+    "@babel/preset-typescript": "7.15.0",
+    "@commitlint/cli": "13.2.0",
+    "@commitlint/config-conventional": "13.2.0",
+    "@semantic-release/git": "v9.0.1",
+    "@semantic-release/github": "7.2.3",
+    "@types/chai": "4.2.22",
+    "@types/core-js": "2.5.5",
     "@types/expect": "24.3.0",
-    "@types/jest": "26.0.20",
-    "@types/react": "17.0.1",
-    "@types/react-dom": "17.0.0",
-    "@types/react-test-renderer": "17.0.0",
-    "@types/webpack-env": "1.16.0",
-    "@typescript-eslint/eslint-plugin": "4.15.0",
-    "@typescript-eslint/parser": "4.15.0",
+    "@types/jest": "27.0.2",
+    "@types/react": "17.0.26",
+    "@types/react-dom": "17.0.9",
+    "@types/react-test-renderer": "17.0.1",
+    "@types/webpack-env": "1.16.2",
+    "@typescript-eslint/eslint-plugin": "4.32.0",
+    "@typescript-eslint/parser": "4.32.0",
     "babel-loader": "8.2.2",
     "babel-plugin-dynamic-import-node": "2.3.3",
     "babel-plugin-module-resolver": "4.1.0",
     "babel-plugin-transform-react-remove-prop-types": "0.4.24",
     "babel-plugin-transform-remove-console": "6.9.4",
-    "chai": "4.3.0",
-    "commitizen": "4.2.3",
-    "commitlint": "11.0.0",
-    "copy-webpack-plugin": "7.0.0",
+    "chai": "4.3.4",
+    "commitizen": "4.2.4",
+    "commitlint": "13.2.0",
+    "copy-webpack-plugin": "9.0.1",
     "cz-conventional-changelog": "3.3.0",
     "deepmerge": "4.2.2",
-    "eslint": "7.19.0",
+    "eslint": "7.32.0",
     "eslint-config-airbnb": "18.2.1",
-    "eslint-config-prettier": "7.2.0",
+    "eslint-config-prettier": "8.3.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-filenames": "1.3.2",
-    "eslint-plugin-import": "2.22.1",
-    "eslint-plugin-jest": "24.1.3",
+    "eslint-plugin-import": "2.24.2",
+    "eslint-plugin-jest": "24.5.0",
     "eslint-plugin-jsx-a11y": "6.4.1",
-    "eslint-plugin-no-only-tests": "2.4.0",
-    "eslint-plugin-no-unsanitized": "3.1.4",
-    "eslint-plugin-optimize-regex": "1.2.0",
-    "eslint-plugin-prettier": "3.3.1",
-    "eslint-plugin-react": "7.22.0",
+    "eslint-plugin-no-only-tests": "2.6.0",
+    "eslint-plugin-no-unsanitized": "3.1.5",
+    "eslint-plugin-optimize-regex": "1.2.1",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-react": "7.26.1",
     "eslint-plugin-react-hooks": "4.2.0",
-    "eslint-plugin-testing-library": "3.10.1",
-    "html-webpack-plugin": "5.1.0",
-    "husky": "4.3.8",
-    "jest": "26.6.3",
-    "lint-staged": "10.5.4",
+    "eslint-plugin-testing-library": "4.12.4",
+    "html-webpack-plugin": "5.3.2",
+    "husky": "7.0.2",
+    "jest": "27.2.4",
+    "lint-staged": "11.1.2",
     "npm-run-all": "4.1.5",
-    "prettier": "2.2.1",
+    "prettier": "2.4.1",
     "prop-types": "15.7.2",
-    "react": "17.0.1",
-    "react-docgen": "5.3.1",
-    "react-docgen-typescript": "1.21.0",
-    "react-dom": "17.0.1",
+    "react": "17.0.2",
+    "react-docgen": "5.4.0",
+    "react-docgen-typescript": "2.1.0",
+    "react-dom": "17.0.2",
     "react-hot-loader": "4.13.0",
-    "react-json-view": "1.21.1",
-    "react-test-renderer": "17.0.1",
+    "react-json-view": "1.21.3",
+    "react-test-renderer": "17.0.2",
     "require-all": "3.0.0",
-    "rollup": "2.38.5",
+    "rollup": "2.58.0",
     "rollup-plugin-commonjs": "10.1.0",
     "rollup-plugin-node-resolve": "5.2.0",
     "rollup-plugin-terser": "7.0.2",
-    "source-map-loader": "2.0.1",
-    "standard-version": "9.1.0",
-    "start-server-and-test": "1.12.0",
-    "terser-webpack-plugin": "5.1.1",
-    "ts-jest": "26.5.1",
-    "typescript": "4.1.5",
-    "webpack": "5.21.2",
-    "webpack-bundle-analyzer": "4.4.0",
-    "webpack-cli": "4.5.0",
-    "webpack-dev-server": "3.11.2",
-    "webpack-merge": "5.7.3"
+    "source-map-loader": "3.0.0",
+    "standard-version": "9.3.1",
+    "start-server-and-test": "1.14.0",
+    "terser-webpack-plugin": "5.2.4",
+    "ts-jest": "27.0.5",
+    "typescript": "4.4.3",
+    "webpack": "5.56.0",
+    "webpack-bundle-analyzer": "4.4.2",
+    "webpack-cli": "4.8.0",
+    "webpack-dev-server": "4.3.0",
+    "webpack-merge": "5.8.0"
   },
   "peerDependencies": {},
   "dependencies": {

package.json

@@ -16,7 +16,7 @@ type Map = <T = unknown>(keys: string | string[], options?: Options) => MapMetho
 
 const suppress = Symbol('map-suppress');
 
-const map = (source: Record<string, unknown | unknown[]>, mapperOptions: Options = {}): Map => {
+const map = (source: Record<string, unknown>, mapperOptions: Options = {}): Map => {
   if (!is.object(source)) {
     throw new TypeError(`Instance of "source" must be an object, but instead got "${typeOf(source)}"`);
   }
@@ -37,7 +37,7 @@ const map = (source: Record<string, unknown | unknown[]>, mapperOptions: Options
         const { omitNullUndefined, omitStrategy } = OPTIONS;
 
         if ((is.nullOrUndefined(result) && omitNullUndefined) || (omitStrategy && omitStrategy(result))) {
-          return (suppress as unknown) as T extends [] ? T[] : T;
+          return suppress as unknown as T extends [] ? T[] : T;
         }
 
         return result as T extends [] ? T[] : T;
@@ -46,11 +46,9 @@ const map = (source: Record<string, unknown | unknown[]>, mapperOptions: Options
   };
 };
 
-map.omitEntries = (
-  entries: Record<string, unknown | unknown[]> | Record<string, unknown | unknown[]>[],
-): Record<string, unknown | unknown[]> | Record<string, unknown | unknown[]>[] => {
+map.omitEntries = <T extends Record<string, unknown>>(entries: T | T[]): T => {
   const result = toArray(entries).map((entry) => {
-    const values: Record<string, unknown | unknown[]> = {};
+    const values: Record<string, unknown> = {};
     const keys = Object.keys(entry);
 
     for (let i = 0; i < keys.length; i += 1) {
@@ -64,7 +62,7 @@ map.omitEntries = (
     return values;
   });
 
-  return is.array(entries) ? result : result[0];
+  return (is.array(entries) ? result : result[0]) as T;
 };
 
 map.suppress = suppress;

src/map.ts

@@ -1,6 +1,6 @@
 export default {
   nullOrUndefined: (value: unknown): boolean => value === null || value === undefined,
-  object: <T>(value: unknown): value is Record<string, T> =>
+  object: <T = Record<string, unknown>>(value: unknown): value is T =>
     value !== null && typeof value === 'object' && Object.prototype.toString.call(value) === '[object Object]',
-  array: <T = unknown>(value: unknown): value is Array<T> => Array.isArray(value),
+  array: <T>(value: T | Array<T>): value is Array<T> => Array.isArray(value),
 };

src/utils/is.ts

@@ -2,6 +2,6 @@
  * Ensure that given value is array, if not, convert it.
  * @param value
  */
-const toArray = <T = unknown>(value: T | T[]): Array<T> => (Array.isArray(value) ? value : [value]);
+const toArray = <T>(value: T): Array<T> => (Array.isArray(value) ? value : [value]);
 
 export default toArray;