map-anything 1.0.1 → 1.0.5

package/README.md

@@ -1,10 +1,13 @@
 # Map anything 🗺
 
+<a href="https://www.npmjs.com/package/map-anything"><img src="https://img.shields.io/npm/v/map-anything.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/map-anything"><img src="https://img.shields.io/npm/dw/map-anything.svg" alt="Latest Stable Version"></a>
+
 ```
 npm i map-anything
 ```
 
-Array.map but for objects. A small and simple integration.
+Array.map but for objects with good TypeScript support. A small and simple integration.
 
 ## Motivation
 
@@ -14,7 +17,7 @@ I always want to do:
 someObject.map(val => someFunction)
 ```
 
-But this doesn't exist for objects, so you need to do this instead:
+But this doesn't exist for objects, you need to do this instead:
 
 ```js
 Object.entries(someObject).reduce((carry, [key, value], index, array) => {
@@ -25,6 +28,8 @@ Object.entries(someObject).reduce((carry, [key, value], index, array) => {
 
 So I made a wrapper function for that. 😃
 
+`map-anything` has very good [#TypeScript](#typescript) support as well.
+
 ## Meet the family
 
 - [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
@@ -78,6 +83,12 @@ addIds ===
   }
 ```
 
+## TypeScript
+
+Without having to specify the return type in the reducer, I've set `map-anything` up so it automatically detects that type for you!
+
+![typescript support](https://raw.githubusercontent.com/mesqueeb/map-anything/master/.github/typescript-support.png)
+
 ## Source code
 
 The source code is rather simple, it's doing something like the snippet show here below.

package/dist/{index.cjs.js → index.cjs}

@@ -11,8 +11,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @returns {Record<string, any>}
  */
 function mapObject(target, mapFunction) {
-    return Object.entries(target).reduce(function (carry, _a, index, array) {
-        var key = _a[0], value = _a[1];
+    return Object.entries(target).reduce((carry, [key, value], index, array) => {
         carry[key] = mapFunction(value, key, array);
         return carry;
     }, {});

package/dist/{index.esm.js → index.es.js}

@@ -7,8 +7,7 @@
  * @returns {Record<string, any>}
  */
 function mapObject(target, mapFunction) {
-    return Object.entries(target).reduce(function (carry, _a, index, array) {
-        var key = _a[0], value = _a[1];
+    return Object.entries(target).reduce((carry, [key, value], index, array) => {
         carry[key] = mapFunction(value, key, array);
         return carry;
     }, {});

package/package.json

@@ -1,35 +1,58 @@
 {
   "name": "map-anything",
   "sideEffects": false,
-  "version": "1.0.1",
-  "description": "Array.map but for objects. A small and simple integration.",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "typings": "types/index.d.ts",
+  "type": "module",
+  "version": "1.0.5",
+  "description": "Array.map but for objects with good TypeScript support. A small and simple integration.",
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13",
+    "npm": ">=7"
+  },
   "scripts": {
-    "test": "ava",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "rollup": "rollup -c build/rollup.js",
-    "build": "npm run lint && npm run test && npm run rollup"
+    "test": "vitest run",
+    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "build": "rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.6.1",
-    "@typescript-eslint/parser": "^4.6.1",
-    "ava": "^3.13.0",
-    "eslint": "^7.12.1",
-    "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-tree-shaking": "^1.8.0",
-    "rollup": "^2.33.1",
-    "rollup-plugin-typescript2": "^0.29.0",
-    "ts-node": "^9.0.0",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^4.0.5"
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.0",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.1"
   },
   "keywords": [
-    "map-object"
+    "map-object",
+    "object-map",
+    "object-to-object",
+    "mapping",
+    "transform",
+    "object-mapper",
+    "compose",
+    "map-reduce"
   ],
   "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mesqueeb/map-anything/issues"
@@ -39,13 +62,35 @@
     "type": "git",
     "url": "git+https://github.com/mesqueeb/map-anything.git"
   },
-  "ava": {
-    "extensions": [
-      "ts"
+  "np": {
+    "yarn": false,
+    "branch": "production"
+  },
+  "eslintConfig": {
+    "ignorePatterns": [
+      "node_modules",
+      "dist",
+      "scripts",
+      "test"
+    ],
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint",
+      "tree-shaking"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier"
     ],
-    "require": [
-      "tsconfig-paths/register",
-      "ts-node/register"
-    ]
+    "rules": {
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/ban-ts-ignore": "off",
+      "tree-shaking/no-side-effects-in-initialization": "error",
+      "@typescript-eslint/ban-ts-comment": "off"
+    }
   }
 }

package/.eslintignore

@@ -1,9 +0,0 @@
-# don't ever lint node_modules
-node_modules
-# don't lint build output (make sure it's set to your correct build folder name)
-dist
-# don't lint nyc coverage output
-coverage
-
-test
-.eslintrc.js

package/.eslintrc.js

@@ -1,17 +0,0 @@
-// npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-tree-shaking
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'tree-shaking'],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier/@typescript-eslint',
-  ],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-ts-ignore': 'off',
-    'tree-shaking/no-side-effects-in-initialization': 'error',
-  },
-}

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 100,
-  "tabWidth": 2,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "semi": false,
-  "bracketSpacing": true,
-  "quoteProps": "consistent"
-}

package/build/rollup.js

@@ -1,59 +0,0 @@
-/* eslint-disable */
-
-// npm install rollup-plugin-typescript2 typescript --save-dev
-import typescript from 'rollup-plugin-typescript2'
-// import { terser } from 'rollup-plugin-terser'
-// import resolve from 'rollup-plugin-node-resolve'
-
-// ------------------------------------------------------------------------------------------
-// formats
-// ------------------------------------------------------------------------------------------
-// amd – Asynchronous Module Definition, used with module loaders like RequireJS
-// cjs – CommonJS, suitable for Node and Browserify/Webpack
-// esm – Keep the bundle as an ES module file
-// iife – A self-executing function, suitable for inclusion as a <script> tag. (If you want to create a bundle for your application, you probably want to use this, because it leads to smaller file sizes.)
-// umd – Universal Module Definition, works as amd, cjs and iife all in one
-// system – Native format of the SystemJS loader
-
-// ------------------------------------------------------------------------------------------
-// setup
-// ------------------------------------------------------------------------------------------
-const pkg = require('../package.json')
-const name = pkg.name
-const className = name.replace(/(^\w|-\w)/g, c => c.replace('-', '').toUpperCase())
-const external = Object.keys(pkg.dependencies || [])
-const plugins = [
-  typescript({ useTsconfigDeclarationDir: true, tsconfigOverride: { exclude: ['test/**/*'] } }),
-]
-
-// ------------------------------------------------------------------------------------------
-// Builds
-// ------------------------------------------------------------------------------------------
-function defaults (config) {
-  // defaults
-  const defaults = {
-    plugins,
-    external,
-  }
-  // defaults.output
-  config.output = config.output.map(output => {
-    return Object.assign(
-      {
-        sourcemap: false,
-        name: className,
-      },
-      output
-    )
-  })
-  return Object.assign(defaults, config)
-}
-
-export default [
-  defaults({
-    input: 'src/index.ts',
-    output: [
-      { file: 'dist/index.cjs.js', format: 'cjs' },
-      { file: 'dist/index.esm.js', format: 'esm' },
-    ],
-  }),
-]

package/src/index.ts

@@ -1,17 +0,0 @@
-/**
- * Map each value of an object with provided function, just like `Array.map`
- *
- * @template T
- * @param {T} target
- * @param {(value: T, propName: keyof T, array: T[keyof T][]) => any} mapFunction
- * @returns {Record<string, any>}
- */
-export function mapObject<
-  T extends Record<string, any>,
-  MapFunction extends (value: T[keyof T], propName: keyof T, array: T[keyof T][]) => any
->(target: T, mapFunction: MapFunction): { [key in keyof T]: ReturnType<typeof mapFunction> } {
-  return Object.entries(target).reduce((carry, [key, value], index, array) => {
-    carry[key as keyof T] = mapFunction(value, key, array as T[keyof T][])
-    return carry
-  }, {} as { [key in keyof T]: ReturnType<typeof mapFunction> })
-}

package/test/index.ts

@@ -1,84 +0,0 @@
-import test from 'ava'
-import { mapObject } from '../src/index'
-
-test('mapObjectWithObjects', (t) => {
-  const target = {
-    '001': { name: 'Bulbasaur', level: 10 },
-    '004': { name: 'Charmander', level: 8 },
-    '007': { name: 'Squirtle', level: 11 },
-  }
-
-  const res = mapObject(target, (pkmn) => {
-    return { ...pkmn, level: pkmn.level + 1 }
-  })
-  t.deepEqual(res, {
-    '001': { name: 'Bulbasaur', level: 11 },
-    '004': { name: 'Charmander', level: 9 },
-    '007': { name: 'Squirtle', level: 12 },
-  })
-})
-
-test('with types', (t) => {
-  type Pokemon = { name: string, level: number }
-  const target: { [id in string]: Pokemon } = {
-    '001': { name: 'Bulbasaur', level: 10 },
-    '004': { name: 'Charmander', level: 8 },
-    '007': { name: 'Squirtle', level: 11 },
-  }
-  const mapFn = (pkmn: Pokemon): Pokemon => ({ ...pkmn, level: pkmn.level + 1 })
-
-  const res = mapObject(target, mapFn)
-  t.deepEqual(res, {
-    '001': { name: 'Bulbasaur', level: 11 },
-    '004': { name: 'Charmander', level: 9 },
-    '007': { name: 'Squirtle', level: 12 },
-  })
-})
-
-test('mapObjectWithNumbers', (t) => {
-  const target = {
-    '001': 1,
-    '004': 2,
-    '007': 3,
-  }
-
-  const res = mapObject(target, (val, a, b) => val + 1)
-
-  t.deepEqual(res, {
-    '001': 2,
-    '004': 3,
-    '007': 4,
-  })
-})
-
-test('set to propname + test type inside of second arg', (t) => {
-  type Pokemon = { name: string, level: number }
-  const target: { [id in string]: Pokemon } = {
-    '001': { name: 'Bulbasaur', level: 10 },
-    '004': { name: 'Charmander', level: 8 },
-    '007': { name: 'Squirtle', level: 11 },
-  }
-  const res = mapObject(target, (pkmn, propName) => propName)
-  t.deepEqual(res, {
-    '001': '001',
-    '004': '004',
-    '007': '007',
-  })
-})
-
-test('replace objects with numbers', (t) => {
-  type Pokemon = { name: string, level: number }
-  const target: { [id in string]: Pokemon } = {
-    '001': { name: 'Bulbasaur', level: 10 },
-    '004': { name: 'Charmander', level: 8 },
-    '007': { name: 'Squirtle', level: 11 },
-  }
-  const mapFn = (pkmn: Pokemon) => pkmn.name
-
-  const res = mapObject(target, mapFn)
-  t.deepEqual(res, {
-    '001': 'Bulbasaur',
-    '004': 'Charmander',
-    '007': 'Squirtle',
-  })
-})

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "./dist",
-    "declaration": true,
-    "declarationDir": "./types/",
-    "target": "es5",
-    "lib": ["es5", "es2015", "es2016", "es2017", "dom"]
-  },
-  "include": [
-    "src/**/*",
-    "test/**/*"
-  ]
-}