ramda-adjunct 3.3.0 → 3.4.0

package/package.json

@@ -14,7 +14,7 @@
     "cookbook",
     "functional"
   ],
-  "version": "3.3.0",
+  "version": "3.4.0",
   "homepage": "https://github.com/char0n/ramda-adjunct",
   "license": "BSD-3-Clause",
   "repository": {
@@ -70,7 +70,7 @@
     "test": "better-npm-run test",
     "test:web": "better-npm-run test:web",
     "test:ramda": "bnr test:ramda",
-    "test:types": "dtslint ./types",
+    "test:types": "eslint --no-eslintrc --no-ignore -c ./types/dtslint.eslint.js ./types/test/*.ts",
     "test:bundle-create": "better-npm-run test:bundle-create",
     "test:bundle-clean": "better-npm-run test:bundle-clean",
     "coverage": "better-npm-run coverage",
@@ -83,8 +83,8 @@
   },
   "betterScripts": {
     "docs": "jsdoc -c jsdoc.json && node ./scripts/jsdoc-inject-dist.js",
-    "lint": "eslint ./ && tslint --project types/tsconfig.json -c types/tslint.json types/**/*.ts",
-    "lint:fix": "eslint ./ --fix && tslint --fix --project types/tsconfig.json -c types/tslint.json types/**/*.ts",
+    "lint": "eslint ./ && eslint --no-ignore --no-eslintrc -c ./types/.eslintrc.js ./types/test/**/*.ts",
+    "lint:fix": "eslint --fix ./ && eslint --no-ignore --no-eslintrc --fix -c ./types/.eslintrc.js ./types/test/**/*.ts",
     "changelog": "conventional-changelog -p angular -i ./CHANGELOG.md -s",
     "test": {
       "command": "mocha",
@@ -124,27 +124,29 @@
     "ramda": ">= 0.28.0 <= 0.28.0"
   },
   "devDependencies": {
-    "@babel/cli": "7.18.10",
-    "@babel/core": "=7.19.1",
-    "@babel/plugin-transform-modules-commonjs": "=7.18.6",
-    "@babel/preset-env": "=7.19.1",
+    "@babel/cli": "7.19.3",
+    "@babel/core": "=7.20.5",
+    "@babel/plugin-transform-modules-commonjs": "=7.19.6",
+    "@babel/preset-env": "=7.20.2",
     "@babel/register": "7.18.9",
-    "@commitlint/cli": "=17.1.2",
-    "@commitlint/config-conventional": "=17.1.0",
+    "@commitlint/cli": "=17.3.0",
+    "@commitlint/config-conventional": "=17.3.0",
+    "@typescript-eslint/eslint-plugin": "=5.45.0",
+    "@typescript-eslint/parser": "=5.45.0",
     "assert": "=2.0.0",
-    "babel-loader": "=8.2.5",
+    "babel-loader": "=9.1.0",
     "babel-plugin-annotate-pure-calls": "0.4.0",
     "babel-plugin-istanbul": "6.1.1",
     "better-npm-run": "0.1.1",
-    "chai": "4.3.6",
+    "chai": "4.3.7",
     "codecov": "3.8.3",
     "conventional-changelog-cli": "2.2.2",
-    "core-js": "=3.25.1",
+    "core-js": "=3.26.1",
     "docdash": "git+https://github.com/char0n/docdash.git#534b44382138a55dd8d93642c979e51e46471185",
-    "dtslint": "=4.2.1",
-    "eslint": "=8.23.1",
+    "eslint": "=8.29.0",
     "eslint-config-airbnb-base": "=15.0.0",
     "eslint-config-prettier": "=8.5.0",
+    "eslint-plugin-dtslint": "=3.0.1",
     "eslint-plugin-import": "=2.26.0",
     "eslint-plugin-mocha": "=10.1.0",
     "eslint-plugin-prettier": "4.2.1",
@@ -153,31 +155,31 @@
     "fantasy-laws": "=2.0.1",
     "folktale": "=2.3.2",
     "glob": "=8.0.3",
-    "husky": "8.0.1",
+    "husky": "8.0.2",
     "istanbul": "=0.4.5",
-    "jsdoc": "=3.6.11",
+    "jsdoc": "=4.0.0",
     "jsverify": "0.8.4",
     "license-cli": "1.1.6",
-    "lint-staged": "13.0.3",
-    "mocha": "=10.0.0",
-    "mocha-junit-reporter": "2.0.2",
+    "lint-staged": "13.0.4",
+    "mocha": "=10.1.0",
+    "mocha-junit-reporter": "2.2.0",
     "mocha-multi-reporters": "1.5.1",
     "monet": "0.9.3",
     "nyc": "15.1.0",
-    "prettier": "=2.7.1",
+    "prettier": "=2.8.0",
     "process": "=0.11.10",
     "ramda": "=0.28.0",
     "ramda-fantasy": "=0.8.0",
-    "regenerator-runtime": "=0.13.9",
+    "regenerator-runtime": "=0.13.11",
     "rimraf": "3.0.2",
     "sanctuary-show": "3.0.0",
-    "sinon": "=14.0.0",
+    "sinon": "=15.0.0",
     "terser-webpack-plugin": "5.3.6",
-    "testem": "=3.9.0",
-    "tslint": "=6.1.3",
-    "typescript": "=4.8.3",
-    "webpack": "=5.74.0",
-    "webpack-cli": "4.10.0"
+    "testem": "=3.10.0",
+    "typescript": "=4.9.3",
+    "webpack": "=5.75.0",
+    "webpack-cli": "5.0.0",
+    "taffydb": "npm:@jsdoc/salty@0.2.1"
   },
   "browserslist": "> 0.25%, ie 10, ie 11, not op_mini all",
   "tonicExampleFilename": "tonicExample.js",

package/src/index.js

@@ -161,6 +161,7 @@ export { default as toArray } from './toArray';
 export { default as allUnique } from './allUnique';
 export { default as notAllUnique } from './notAllUnique';
 export { default as sortByProps } from './sortByProps';
+export { default as sortByProp } from './sortByProp';
 export { default as sortByPaths } from './sortByPaths';
 export { default as skipTake } from './skipTake';
 export { default as rangeStep } from './rangeStep';

package/src/isGeneratorFunction.js

@@ -1,21 +1,4 @@
-import {
-  type,
-  is,
-  F as stubFalse,
-  either,
-  identical,
-  pipe,
-  curryN,
-} from 'ramda';
-
-let GeneratorFunction = null;
-let legacyCheck = null;
-try {
-  GeneratorFunction = new Function('return function* () {}')().constructor; // eslint-disable-line no-new-func
-  legacyCheck = is(GeneratorFunction);
-} catch (e) {
-  legacyCheck = stubFalse;
-}
+import { type, identical, pipe, curryN } from 'ramda';
 
 /**
  * Checks if input value is `Generator Function`.
@@ -37,7 +20,7 @@ try {
  */
 const isGeneratorFunction = curryN(
   1,
-  either(pipe(type, identical('GeneratorFunction')), legacyCheck)
+  pipe(type, identical('GeneratorFunction'))
 );
 
 export default isGeneratorFunction;

package/src/sortByProp.js

@@ -0,0 +1,45 @@
+import { __, append, identity, useWith } from 'ramda';
+
+import sortByProps from './sortByProps';
+
+/**
+ * Sort a list of objects by a property.
+ *
+ * @func sortByProp
+ * @memberOf RA
+ * @since {@link https://char0n.github.io/ramda-adjunct/3.4.0|v3.4.0}
+ * @category List
+ * @sig k -> [{k: v}] -> [{k: v}]
+ * @param {Array.<string>} prop The property in the list param to sort by
+ * @param {Array.<object>} list A list of objects to be sorted
+ * @return {Array.<object>} A new list sorted by the property in the prop param
+ * @example
+ *
+ * // sorting list of tuples
+ * const sortByFirstItem = sortByProp(0);
+ * const listOfTuples = [[-1, 1], [-2, 2], [-3, 3]];
+ * sortByFirstItem(listOfTuples); // => [[-3, 3], [-2, 2], [-1, 1]]
+ *
+ * // sorting list of objects
+ * const sortByName = sortByProp('name');
+ * const alice = {
+ *   name: 'ALICE',
+ *   age: 101,
+ * };
+ * const bob = {
+ *   name: 'Bob',
+ *   age: -10,
+ * };
+ * const clara = {
+ *   name: 'clara',
+ *   age: 314.159,
+ * };
+ * const people = [clara, bob, alice];
+ * sortByName(people); // => [alice, bob, clara]
+ */
+
+const addValueInAnArray = append(__, []);
+
+const sortByProp = useWith(sortByProps, [addValueInAnArray, identity]);
+
+export default sortByProp;

package/src/sortByProps.js

@@ -1,4 +1,4 @@
-import { reduce, either, curry, prop, sort, comparator, map, lt } from 'ramda';
+import { comparator, curry, either, lt, map, prop, reduce, sort } from 'ramda';
 
 /**
  * Sort a list of objects by a list of props (if first prop value is equivalent, sort by second, etc).

package/types/.eslintrc.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const { join } = require('path');
+
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2019,
+    project: join(__dirname, './tsconfig.json'),
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  extends: ['plugin:prettier/recommended', 'plugin:@typescript-eslint/recommended'],
+  rules: {
+    '@typescript-eslint/ban-ts-comment': 0,
+    'import/no-unresolved': 0,
+    'import/extensions': 0,
+    '@typescript-eslint/no-empty-function': 0,
+    '@typescript-eslint/no-unused-vars': 0,
+    '@typescript-eslint/ban-types': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+  }
+};

package/types/dtslint.eslint.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const { join } = require('path');
+
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2019,
+    project: join(__dirname, './tsconfig.json'),
+    sourceType: 'module',
+  },
+  extends: ['plugin:dtslint/recommended'],
+};

package/types/index.d.ts

@@ -1,4 +1,4 @@
-// TypeScript Version: 2.4
+// Minimum TypeScript Version: 2.4
 
 interface Functor<T> {
   map<U>(fn: (t: T) => U): Functor<U>;
@@ -606,10 +606,21 @@ export function cata<V1, V2, T1, T2>(
  * keys renamed according to the keysMap object as `{oldKey: newKey}`.
  * When some key is not found in the keysMap, then it's passed as-is.
  */
-export function renameKeys(keysMap: Dictionary<string>, obj: object): object;
-export function renameKeys(
-  keysMap: Dictionary<string>
-): (obj: object) => object;
+type PickRenameMulti<
+  R extends { [K: string]: string },
+  T extends { [s in keyof R]: any }
+> = {
+  [P in keyof T as P extends keyof R ? R[P] : P]: T[P];
+};
+export function renameKeys<
+  MAP extends Dictionary<string>,
+  OBJ extends { readonly [s in keyof MAP]: any }
+>(keysMap: MAP, obj: OBJ): PickRenameMulti<MAP, OBJ>;
+export function renameKeys<MAP extends Dictionary<string>>(
+  keysMap: MAP
+): <OBJ extends { readonly [s in keyof MAP]: any }>(
+  obj: OBJ
+) => PickRenameMulti<MAP, OBJ>;
 
 /**
  * Creates a new object with the own properties of the provided object, and the
@@ -1692,6 +1703,14 @@ export function padCharsStart(
 export function padStart(targetLength: number, value: string): string;
 export function padStart(targetLength: number): (value: string) => string;
 
+/**
+ * Sort a list of objects by a property.
+ */
+export function sortByProp<T>(prop: string | number, list: readonly T[]): T[];
+export function sortByProp(
+  prop: string | number
+): <T>(list: readonly T[]) => T[];
+
 /**
  * Sort a list of objects by a list of props (if first prop value is equivalent, sort by second, etc).
  */