ramda-adjunct 4.0.0 → 4.1.0

package/es/index.js

@@ -170,6 +170,7 @@ export { default as findOr } from './findOr';
 export { default as invoke } from './invoke';
 export { default as invokeArgs } from './invokeArgs';
 export { default as paths } from './paths';
+export { default as renameKey } from './renameKey';
 export { default as renameKeys } from './renameKeys';
 export { default as renameKeysWith } from './renameKeysWith';
 export { default as renameKeyWith } from './renameKeyWith';

package/es/pathNotEq.js

@@ -22,7 +22,7 @@ import { pathEq, complement } from 'ramda';
  * const user2 = { address: { zipCode: 55555 } };
  * const user3 = { name: 'Bob' };
  * const users = [ user1, user2, user3 ];
- * const isFamous = R.pathNotEq(90210, ['address', 'zipCode']);
+ * const isFamous = RA.pathNotEq(90210, ['address', 'zipCode']);
  * R.filter(isFamous, users); //=> [ user2, user3 ]
  */
 /* eslint-enable max-len */

package/es/renameKey.js

@@ -0,0 +1,35 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { curry } from 'ramda';
+import renameKeys from './renameKeys';
+
+/**
+ * Creates a new object with the own properties of the provided object, but a
+ * single key is renamed from `oldKey` to `newKey`.
+ *
+ * Keep in mind that in the case of keys conflict is behavior undefined and
+ * the result may vary between various JS engines!
+ *
+ * @func renameKey
+ * @memberOf RA
+ * @since {@link https://char0n.github.io/ramda-adjunct/4.1.0|v4.1.0}
+ * @category Object
+ * @sig (String a, String b) => a -> b ->  {a: *} -> {b: *}
+ * @param {!string} oldKey
+ * @param {!string} newKey
+ * @param {!Object} obj
+ * @return {!Object} New object with renamed key
+ * @see {@link https://github.com/ramda/ramda/wiki/Cookbook#rename-key-of-an-object|Ramda Cookbook}, {@link RA.renameKeyWith|renameKeyWith}
+ * @example
+ *
+ * const input = { firstName: 'Elisia', age: 22, type: 'human' };
+ *
+ * RA.renameKey('firstName', 'name')(input);
+ * //=> { name: 'Elisia', age: 22, type: 'human' }
+ */
+var renameKey = curry(function (oldKey, newKey, obj) {
+  return renameKeys(_defineProperty({}, oldKey, newKey), obj);
+});
+export default renameKey;

package/lib/index.js

@@ -2,8 +2,8 @@
 
 exports.__esModule = true;
 exports.isNotRegExp = exports.isNotPrimitive = exports.isNotPlainObject = exports.isNotPlainObj = exports.isNotPair = exports.isNotObjectLike = exports.isNotObject = exports.isNotObjLike = exports.isNotObj = exports.isNotNumber = exports.isNotNull = exports.isNotNilOrEmpty = exports.isNotNil = exports.isNotNaN = exports.isNotMap = exports.isNotInteger = exports.isNotGeneratorFunction = exports.isNotFunction = exports.isNotFloat = exports.isNotFinite = exports.isNotEmpty = exports.isNotDate = exports.isNotBoolean = exports.isNotAsyncFunction = exports.isNotArrayLike = exports.isNotArray = exports.isNonPositive = exports.isNonNegative = exports.isNonEmptyString = exports.isNonEmptyArray = exports.isNilOrEmpty = exports.isNegativeZero = exports.isNegative = exports.isNaturalNumber = exports.isNaN = exports.isMap = exports.isIterable = exports.isInvalidDate = exports.isInteger32 = exports.isInteger = exports.isInt32 = exports.isIndexed = exports.isGeneratorFunction = exports.isFunction = exports.isFloat = exports.isFinite = exports.isFalsy = exports.isFalse = exports.isEven = exports.isError = exports.isEmptyString = exports.isEmptyArray = exports.isDate = exports.isBoolean = exports.isBlank = exports.isBigInt = exports.isAsyncFunction = exports.isArrayLike = exports.isArray = exports.invokeArgs = exports.invoke = exports.included = exports.inRange = exports.fnull = exports.floor = exports.flattenProp = exports.flattenPath = exports.flattenDepth = exports.firstP = exports.findOr = exports.filterIndexed = exports.escapeRegExp = exports.ensureArray = exports.dropArgs = exports.divideNum = exports.dispatch = exports.delayP = exports.defaultWhen = exports.curryRightN = exports.curryRight = exports.copyKeys = exports.concatRight = exports.concatAll = exports.compact = exports.ceil = exports.catchP = exports.cata = exports.async = exports.argsPass = exports.appendFlipped = exports.anyP = exports.allUnique = exports.allSettledP = exports.allP = exports.allIdenticalTo = exports.allIdentical = exports.allEqualTo = exports.allEqual = exports.Y = exports.Identity = void 0;
-exports.sortByProps = exports.sortByProp = exports.sortByPaths = exports.sliceTo = exports.sliceFrom = exports.skipTake = exports.sign = exports.sequencing = exports.seq = exports.round = exports.resolveP = exports.replaceAll = exports.repeatStr = exports.renameKeysWith = exports.renameKeys = exports.renameKeyWith = exports.rejectP = exports.reduceRightP = exports.reduceP = exports.reduceIndexed = exports.rangeStep = exports.propNotEq = exports.pickIndexes = exports.paths = exports.pathOrLazy = exports.pathNotEq = exports.padStart = exports.padEnd = exports.padCharsStart = exports.padCharsEnd = exports.overlaps = exports.omitIndexes = exports.omitBy = exports.notEqual = exports.notBoth = exports.notAllUnique = exports.notAllPass = exports.nor = exports.noop = exports.nonePass = exports.noneP = exports.neither = exports.nand = exports.move = exports.mergeProps = exports.mergeProp = exports.mergePaths = exports.mergePath = exports.mapIndexed = exports.list = exports.liftFN = exports.liftF = exports.lensTraverse = exports.lensSatisfies = exports.lensNotSatisfy = exports.lensNotEq = exports.lensIso = exports.lensEq = exports.lengthNotEq = exports.lengthLte = exports.lengthLt = exports.lengthGte = exports.lengthGt = exports.lengthEq = exports.lastP = exports.isValidNumber = exports.isValidDate = exports.isUndefined = exports.isUinteger32 = exports.isUint32 = exports.isTruthy = exports.isTrue = exports.isThenable = exports.isSymbol = exports.isString = exports.isSparseArray = exports.isSet = exports.isSentinelValue = exports.isSafeInteger = exports.isRegExp = exports.isPrototypeOf = exports.isPromise = exports.isPrimitive = exports.isPositiveZero = exports.isPositive = exports.isPlainObject = exports.isPlainObj = exports.isPair = exports.isOdd = exports.isObjectLike = exports.isObject = exports.isObjLike = exports.isObj = exports.isNumber = exports.isNull = exports.isNotValidNumber = exports.isNotValidDate = exports.isNotUndefined = exports.isNotString = exports.isNotSet = void 0;
-exports.zipObjWith = exports.weaveLazy = exports.weave = exports.viewOr = exports.unzipObjWith = exports.trunc = exports.trimStart = exports.trimRight = exports.trimLeft = exports.trimEnd = exports.trimCharsStart = exports.trimCharsEnd = exports.toUinteger32 = exports.toUint32 = exports.toNumber = exports.toInteger32 = exports.toInt32 = exports.toArray = exports.thenCatchP = exports.subtractNum = exports.stubUndefined = exports.stubString = exports.stubObject = exports.stubObj = exports.stubNull = exports.stubArray = exports.spreadProp = exports.spreadPath = void 0;
+exports.sortByProp = exports.sortByPaths = exports.sliceTo = exports.sliceFrom = exports.skipTake = exports.sign = exports.sequencing = exports.seq = exports.round = exports.resolveP = exports.replaceAll = exports.repeatStr = exports.renameKeysWith = exports.renameKeys = exports.renameKeyWith = exports.renameKey = exports.rejectP = exports.reduceRightP = exports.reduceP = exports.reduceIndexed = exports.rangeStep = exports.propNotEq = exports.pickIndexes = exports.paths = exports.pathOrLazy = exports.pathNotEq = exports.padStart = exports.padEnd = exports.padCharsStart = exports.padCharsEnd = exports.overlaps = exports.omitIndexes = exports.omitBy = exports.notEqual = exports.notBoth = exports.notAllUnique = exports.notAllPass = exports.nor = exports.noop = exports.nonePass = exports.noneP = exports.neither = exports.nand = exports.move = exports.mergeProps = exports.mergeProp = exports.mergePaths = exports.mergePath = exports.mapIndexed = exports.list = exports.liftFN = exports.liftF = exports.lensTraverse = exports.lensSatisfies = exports.lensNotSatisfy = exports.lensNotEq = exports.lensIso = exports.lensEq = exports.lengthNotEq = exports.lengthLte = exports.lengthLt = exports.lengthGte = exports.lengthGt = exports.lengthEq = exports.lastP = exports.isValidNumber = exports.isValidDate = exports.isUndefined = exports.isUinteger32 = exports.isUint32 = exports.isTruthy = exports.isTrue = exports.isThenable = exports.isSymbol = exports.isString = exports.isSparseArray = exports.isSet = exports.isSentinelValue = exports.isSafeInteger = exports.isRegExp = exports.isPrototypeOf = exports.isPromise = exports.isPrimitive = exports.isPositiveZero = exports.isPositive = exports.isPlainObject = exports.isPlainObj = exports.isPair = exports.isOdd = exports.isObjectLike = exports.isObject = exports.isObjLike = exports.isObj = exports.isNumber = exports.isNull = exports.isNotValidNumber = exports.isNotValidDate = exports.isNotUndefined = exports.isNotString = exports.isNotSet = void 0;
+exports.zipObjWith = exports.weaveLazy = exports.weave = exports.viewOr = exports.unzipObjWith = exports.trunc = exports.trimStart = exports.trimRight = exports.trimLeft = exports.trimEnd = exports.trimCharsStart = exports.trimCharsEnd = exports.toUinteger32 = exports.toUint32 = exports.toNumber = exports.toInteger32 = exports.toInt32 = exports.toArray = exports.thenCatchP = exports.subtractNum = exports.stubUndefined = exports.stubString = exports.stubObject = exports.stubObj = exports.stubNull = exports.stubArray = exports.spreadProp = exports.spreadPath = exports.sortByProps = void 0;
 var _isNotUndefined = _interopRequireDefault(require("./isNotUndefined"));
 exports.isNotUndefined = _isNotUndefined["default"];
 var _isUndefined = _interopRequireDefault(require("./isUndefined"));
@@ -320,6 +320,8 @@ var _invokeArgs = _interopRequireDefault(require("./invokeArgs"));
 exports.invokeArgs = _invokeArgs["default"];
 var _paths = _interopRequireDefault(require("./paths"));
 exports.paths = _paths["default"];
+var _renameKey = _interopRequireDefault(require("./renameKey"));
+exports.renameKey = _renameKey["default"];
 var _renameKeys = _interopRequireDefault(require("./renameKeys"));
 exports.renameKeys = _renameKeys["default"];
 var _renameKeysWith = _interopRequireDefault(require("./renameKeysWith"));

package/lib/pathNotEq.js

@@ -25,7 +25,7 @@ var _ramda = require("ramda");
  * const user2 = { address: { zipCode: 55555 } };
  * const user3 = { name: 'Bob' };
  * const users = [ user1, user2, user3 ];
- * const isFamous = R.pathNotEq(90210, ['address', 'zipCode']);
+ * const isFamous = RA.pathNotEq(90210, ['address', 'zipCode']);
  * R.filter(isFamous, users); //=> [ user2, user3 ]
  */
 /* eslint-enable max-len */

package/lib/renameKey.js

@@ -0,0 +1,40 @@
+"use strict";
+
+exports.__esModule = true;
+exports["default"] = void 0;
+var _ramda = require("ramda");
+var _renameKeys2 = _interopRequireDefault(require("./renameKeys"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+/**
+ * Creates a new object with the own properties of the provided object, but a
+ * single key is renamed from `oldKey` to `newKey`.
+ *
+ * Keep in mind that in the case of keys conflict is behavior undefined and
+ * the result may vary between various JS engines!
+ *
+ * @func renameKey
+ * @memberOf RA
+ * @since {@link https://char0n.github.io/ramda-adjunct/4.1.0|v4.1.0}
+ * @category Object
+ * @sig (String a, String b) => a -> b ->  {a: *} -> {b: *}
+ * @param {!string} oldKey
+ * @param {!string} newKey
+ * @param {!Object} obj
+ * @return {!Object} New object with renamed key
+ * @see {@link https://github.com/ramda/ramda/wiki/Cookbook#rename-key-of-an-object|Ramda Cookbook}, {@link RA.renameKeyWith|renameKeyWith}
+ * @example
+ *
+ * const input = { firstName: 'Elisia', age: 22, type: 'human' };
+ *
+ * RA.renameKey('firstName', 'name')(input);
+ * //=> { name: 'Elisia', age: 22, type: 'human' }
+ */
+var renameKey = (0, _ramda.curry)(function (oldKey, newKey, obj) {
+  return (0, _renameKeys2["default"])(_defineProperty({}, oldKey, newKey), obj);
+});
+var _default = renameKey;
+exports["default"] = _default;

package/package.json

@@ -14,7 +14,7 @@
     "cookbook",
     "functional"
   ],
-  "version": "4.0.0",
+  "version": "4.1.0",
   "homepage": "https://github.com/char0n/ramda-adjunct",
   "license": "BSD-3-Clause",
   "repository": {
@@ -124,61 +124,60 @@
     "ramda": ">= 0.29.0"
   },
   "devDependencies": {
-    "@babel/cli": "7.21.0",
-    "@babel/core": "=7.21.4",
-    "@babel/plugin-transform-modules-commonjs": "=7.21.2",
-    "@babel/preset-env": "=7.21.4",
-    "@babel/register": "7.21.0",
-    "@commitlint/cli": "=17.5.1",
-    "@commitlint/config-conventional": "=17.4.4",
-    "@typescript-eslint/eslint-plugin": "=5.57.1",
-    "@typescript-eslint/parser": "=5.57.1",
+    "@babel/cli": "7.22.10",
+    "@babel/core": "=7.22.10",
+    "@babel/plugin-transform-modules-commonjs": "=7.22.5",
+    "@babel/preset-env": "=7.22.10",
+    "@babel/register": "7.22.5",
+    "@commitlint/cli": "=17.7.1",
+    "@commitlint/config-conventional": "=17.7.0",
+    "@typescript-eslint/eslint-plugin": "=6.4.0",
+    "@typescript-eslint/parser": "=6.4.0",
     "assert": "=2.0.0",
-    "babel-loader": "=9.1.2",
+    "babel-loader": "=9.1.3",
     "babel-plugin-annotate-pure-calls": "0.4.0",
     "babel-plugin-istanbul": "6.1.1",
     "better-npm-run": "0.1.1",
     "chai": "4.3.7",
     "codecov": "3.8.3",
-    "conventional-changelog-cli": "2.2.2",
-    "core-js": "=3.30.0",
+    "conventional-changelog-cli": "3.0.0",
+    "core-js": "=3.32.0",
     "docdash": "git+https://github.com/char0n/docdash.git#534b44382138a55dd8d93642c979e51e46471185",
-    "eslint": "=8.37.0",
+    "eslint": "=8.47.0",
     "eslint-config-airbnb-base": "=15.0.0",
-    "eslint-config-prettier": "=8.8.0",
-    "eslint-plugin-dtslint": "=3.0.1",
-    "eslint-plugin-import": "=2.27.5",
+    "eslint-config-prettier": "=9.0.0",
+    "eslint-plugin-dtslint": "=3.0.2",
+    "eslint-plugin-import": "=2.28.0",
     "eslint-plugin-mocha": "=10.1.0",
-    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-ramda": "2.5.1",
     "fantasy-land": "5.0.1",
     "fantasy-laws": "=2.0.1",
     "folktale": "=2.3.2",
-    "glob": "=9.3.4",
+    "glob": "=10.3.3",
     "husky": "8.0.3",
     "istanbul": "=0.4.5",
     "jsdoc": "=4.0.2",
     "jsverify": "0.8.4",
-    "license-cli": "1.1.6",
-    "lint-staged": "13.2.0",
+    "lint-staged": "14.0.0",
     "mocha": "=10.2.0",
-    "mocha-junit-reporter": "2.2.0",
+    "mocha-junit-reporter": "2.2.1",
     "mocha-multi-reporters": "1.5.1",
     "monet": "0.9.3",
     "nyc": "15.1.0",
-    "prettier": "=2.8.7",
+    "prettier": "=3.0.2",
     "process": "=0.11.10",
     "ramda": "=0.29.0",
     "ramda-fantasy": "=0.8.0",
-    "regenerator-runtime": "=0.13.11",
-    "rimraf": "4.4.1",
+    "regenerator-runtime": "=0.14.0",
+    "rimraf": "5.0.1",
     "sanctuary-show": "3.0.0",
-    "sinon": "=15.0.3",
-    "terser-webpack-plugin": "5.3.7",
+    "sinon": "=15.2.0",
+    "terser-webpack-plugin": "5.3.9",
     "testem": "=3.10.1",
-    "typescript": "=4.9.5",
-    "webpack": "=5.77.0",
-    "webpack-cli": "5.0.1",
+    "typescript": "=5.1.6",
+    "webpack": "=5.88.2",
+    "webpack-cli": "5.1.4",
     "taffydb": "npm:@jsdoc/salty@0.2.1"
   },
   "browserslist": "> 0.25%, ie 10, ie 11, not op_mini all",

package/src/index.js

@@ -170,6 +170,7 @@ export { default as findOr } from './findOr';
 export { default as invoke } from './invoke';
 export { default as invokeArgs } from './invokeArgs';
 export { default as paths } from './paths';
+export { default as renameKey } from './renameKey';
 export { default as renameKeys } from './renameKeys';
 export { default as renameKeysWith } from './renameKeysWith';
 export { default as renameKeyWith } from './renameKeyWith';

package/src/pathNotEq.js

@@ -22,7 +22,7 @@ import { pathEq, complement } from 'ramda';
  * const user2 = { address: { zipCode: 55555 } };
  * const user3 = { name: 'Bob' };
  * const users = [ user1, user2, user3 ];
- * const isFamous = R.pathNotEq(90210, ['address', 'zipCode']);
+ * const isFamous = RA.pathNotEq(90210, ['address', 'zipCode']);
  * R.filter(isFamous, users); //=> [ user2, user3 ]
  */
 /* eslint-enable max-len */

package/src/renameKey.js

@@ -0,0 +1,33 @@
+import { curry } from 'ramda';
+
+import renameKeys from './renameKeys';
+
+/**
+ * Creates a new object with the own properties of the provided object, but a
+ * single key is renamed from `oldKey` to `newKey`.
+ *
+ * Keep in mind that in the case of keys conflict is behavior undefined and
+ * the result may vary between various JS engines!
+ *
+ * @func renameKey
+ * @memberOf RA
+ * @since {@link https://char0n.github.io/ramda-adjunct/4.1.0|v4.1.0}
+ * @category Object
+ * @sig (String a, String b) => a -> b ->  {a: *} -> {b: *}
+ * @param {!string} oldKey
+ * @param {!string} newKey
+ * @param {!Object} obj
+ * @return {!Object} New object with renamed key
+ * @see {@link https://github.com/ramda/ramda/wiki/Cookbook#rename-key-of-an-object|Ramda Cookbook}, {@link RA.renameKeyWith|renameKeyWith}
+ * @example
+ *
+ * const input = { firstName: 'Elisia', age: 22, type: 'human' };
+ *
+ * RA.renameKey('firstName', 'name')(input);
+ * //=> { name: 'Elisia', age: 22, type: 'human' }
+ */
+const renameKey = curry((oldKey, newKey, obj) =>
+  renameKeys({ [oldKey]: newKey }, obj)
+);
+
+export default renameKey;

package/types/index.d.ts

@@ -622,6 +622,34 @@ export function renameKeys<MAP extends Dictionary<string>>(
   obj: OBJ
 ) => PickRenameMulti<MAP, OBJ>;
 
+
+type Keyable = string | number | symbol
+type RenameObjectKey<
+  OKey extends keyof OBJ,
+  OBJ extends { readonly [s in OKey]: any },
+  NKey extends Keyable,
+> = Omit<OBJ, OKey> & Record<NKey, OBJ[OKey]>
+
+/**
+ * Creates a new object with the own properties of the provided object, but a
+ * single key is renamed from `oldKey` to `newKey`.
+ */
+function renameKey<
+  OKey extends Keyable,
+>(oldKey: OKey):
+  <NKey extends Keyable>(newKey: NKey) =>
+  <OBJ extends { readonly [s in OKey]: any }>(obj: OBJ) => RenameObjectKey<OKey, OBJ, NKey>;
+function renameKey<
+  OKey extends Keyable,
+  NKey extends Keyable,
+>(oldKey: OKey, newKey: NKey):
+  <OBJ extends { readonly [s in OKey]: any }>(obj: OBJ) => RenameObjectKey<OKey, OBJ, NKey>;
+function renameKey<
+  OKey extends keyof OBJ,
+  OBJ extends { readonly [s in OKey]: any },
+  NKey extends Keyable,
+>(oldKey: OKey, newKey: NKey, obj: OBJ): RenameObjectKey<OKey, OBJ, NKey>
+
 /**
  * Creates a new object with the own properties of the provided object, and the
  * keys copied according to the keysMap object as `{oldKey: newKey}`.

package/.nvmrc

@@ -1 +0,0 @@
-18