rambda 10.0.1 → 10.2.0

package/index.d.ts

@@ -206,6 +206,11 @@ export function append<T>(el: T): (list: readonly T[]) => T[];
  */
 export function ascend<T>(fn: (obj: T) => Ord): (a: T, b: T)=> Ordering;
 
+/**
+ * It helps to make sure that input is from specific type. Similar to `R.convertToType`, but it actually checks the type of the input value. If `fn` input returns falsy value, then the function will throw an error.
+ */
+export function assertType<T, U extends T>(fn: (x: T) => x is U) : (x: T) => U;
+
 /**
  * It returns `true` if all each property in `conditions` returns `true` when applied to corresponding property in `input` object.
  */
@@ -235,6 +240,12 @@ export function complement<T extends any[]>(predicate: (...args: T) => unknown):
 export function concat<T>(x: T[]): (y: T[]) => T[];
 export function concat(x: string): (y: string) => string;
 
+/**
+ * It helps to convert a value to a specific type.
+ * It is useful when you have to overcome TypeScript's type inference.
+ */
+export function convertToType<T>(x: unknown) : T;
+
 /**
  * It counts how many times `predicate` function returns `true`, when supplied with iteration of `list`.
  */
@@ -586,6 +597,123 @@ export function minBy<T>(compareFn: (input: T) => Ord, x: T): (y: T) => T;
  */
 export function modifyItemAtIndex<T>(index: number, replaceFn: (x: T) => T): (list: T[]) => T[];
 
+/**
+ * It changes a property of object on the base of provided path and transformer function.
+ */
+export function modifyPath<U, T>(path: [], fn: (value: U) => T): (obj: U) => T;
+export function modifyPath<
+  K0 extends keyof U,
+  U,
+  T
+>(path: [K0], fn: (value: U[K0]) => T): (obj: U) => DeepModify<[K0], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  U,
+  T
+>(path: `${K0}`, fn: (value: U[K0]) => T): (obj: U) => DeepModify<[K0], U, T>;
+export function modifyPath<
+  K0 extends keyof U,
+  K1 extends keyof U[K0],
+  U,
+  T
+>(path: [K0, K1], fn: (value: U[K0][K1]) => T): (obj: U) => DeepModify<[K0, K1], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  K1 extends string & keyof U[K0],
+  U,
+  T
+>(path: `${K0}.${K1}`, fn: (value: U[K0][K1]) => T): (obj: U) => DeepModify<[K0, K1], U, T>;
+export function modifyPath<
+  K0 extends keyof U,
+  K1 extends keyof U[K0],
+  K2 extends keyof U[K0][K1],
+  U,
+  T
+>(path: [K0, K1, K2], fn: (value: U[K0][K1][K2]) => T): (obj: U) => DeepModify<[K0, K1, K2], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  K1 extends string & keyof U[K0],
+  K2 extends string & keyof U[K0][K1],
+  U,
+  T
+>(path: `${K0}.${K1}.${K2}`, fn: (value: U[K0][K1][K2]) => T): (obj: U) => DeepModify<[K0, K1, K2], U, T>;
+export function modifyPath<
+  K0 extends keyof U,
+  K1 extends keyof U[K0],
+  K2 extends keyof U[K0][K1],
+  K3 extends keyof U[K0][K1][K2],
+  U,
+  T
+>(path: [K0, K1, K2, K3], fn: (value: U[K0][K1][K2][K3]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  K1 extends string & keyof U[K0],
+  K2 extends string & keyof U[K0][K1],
+  K3 extends string & keyof U[K0][K1][K2],
+  U,
+  T
+>(path: `${K0}.${K1}.${K2}.${K3}`, fn: (value: U[K0][K1][K2][K3]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3], U, T>;
+export function modifyPath<
+  K0 extends keyof U,
+  K1 extends keyof U[K0],
+  K2 extends keyof U[K0][K1],
+  K3 extends keyof U[K0][K1][K2],
+  K4 extends keyof U[K0][K1][K2][K3],
+  U,
+  T
+>(path: [K0, K1, K2, K3, K4], fn: (value: U[K0][K1][K2][K3][K4]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3, K4], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  K1 extends string & keyof U[K0],
+  K2 extends string & keyof U[K0][K1],
+  K3 extends string & keyof U[K0][K1][K2],
+  K4 extends string & keyof U[K0][K1][K2][K3],
+  U,
+  T
+>(path: `${K0}.${K1}.${K2}.${K3}.${K4}`, fn: (value: U[K0][K1][K2][K3][K4]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3, K4], U, T>;
+export function modifyPath<
+  K0 extends keyof U,
+  K1 extends keyof U[K0],
+  K2 extends keyof U[K0][K1],
+  K3 extends keyof U[K0][K1][K2],
+  K4 extends keyof U[K0][K1][K2][K3],
+  K5 extends keyof U[K0][K1][K2][K3][K4],
+  U,
+  T
+>(path: [K0, K1, K2, K3, K4, K5], fn: (value: U[K0][K1][K2][K3][K4][K5]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3, K4, K5], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  K1 extends string & keyof U[K0],
+  K2 extends string & keyof U[K0][K1],
+  K3 extends string & keyof U[K0][K1][K2],
+  K4 extends string & keyof U[K0][K1][K2][K3],
+  K5 extends string & keyof U[K0][K1][K2][K3][K4],
+  U,
+  T
+>(path: `${K0}.${K1}.${K2}.${K3}.${K4}.${K5}`, fn: (value: U[K0][K1][K2][K3][K4][K5]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3, K4, K5], U, T>;
+export function modifyPath<
+  K0 extends keyof U,
+  K1 extends keyof U[K0],
+  K2 extends keyof U[K0][K1],
+  K3 extends keyof U[K0][K1][K2],
+  K4 extends keyof U[K0][K1][K2][K3],
+  K5 extends keyof U[K0][K1][K2][K3][K4],
+  K6 extends keyof U[K0][K1][K2][K3][K4][K5],
+  U,
+  T
+>(path: [K0, K1, K2, K3, K4, K5, K6], fn: (value: U[K0][K1][K2][K3][K4][K5][K6]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3, K4, K5, K6], U, T>;
+export function modifyPath<
+  K0 extends string & keyof U,
+  K1 extends string & keyof U[K0],
+  K2 extends string & keyof U[K0][K1],
+  K3 extends string & keyof U[K0][K1][K2],
+  K4 extends string & keyof U[K0][K1][K2][K3],
+  K5 extends string & keyof U[K0][K1][K2][K3][K4],
+  K6 extends string & keyof U[K0][K1][K2][K3][K4][K5],
+  U,
+  T
+>(path: `${K0}.${K1}.${K2}.${K3}.${K4}.${K5}.${K6}`, fn: (value: U[K0][K1][K2][K3][K4][K5][K6]) => T): (obj: U) => DeepModify<[K0, K1, K2, K3, K4, K5, K6], U, T>;
+
 /**
  * It changes a property with the result of transformer function.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rambda",
-  "version": "10.0.1",
+  "version": "10.2.0",
   "scripts": {
     "out": "yarn populatedocs && yarn populatereadme && yarn build && yarn create-docsify",
     "build": "yarn build:main && yarn build:web && yarn build:esm",
@@ -28,7 +28,7 @@
   "type": "module",
   "exports": {
     "require": {
-      "types": "./index.d.ts",
+      "types": "./index.d.cts",
       "default": "./dist/rambda.cjs"
     },
     "types": "./index.d.ts",
@@ -95,9 +95,10 @@
     "src",
     "CHANGELOG.md",
     "index.d.ts",
+    "index.d.cts",
     "rambda.js"
   ],
   "sideEffects": false,
   "umd": "./dist/rambda.umd.js",
-  "types": "./index.d.ts"
+  "types": "./index.d.cts"
 }

package/rambda.js

@@ -7,10 +7,12 @@ export * from './src/any.js'
 export * from './src/anyPass.js'
 export * from './src/append.js'
 export * from './src/ascend.js'
+export * from './src/assertType.js'
 export * from './src/checkObjectWithSpec.js'
 export * from './src/compact.js'
 export * from './src/complement.js'
 export * from './src/concat.js'
+export * from './src/convertToType.js'
 export * from './src/count.js'
 export * from './src/countBy.js'
 export * from './src/createObjectFromKeys.js'
@@ -59,6 +61,7 @@ export * from './src/merge.js'
 export * from './src/mergeTypes.js'
 export * from './src/minBy.js'
 export * from './src/modifyItemAtIndex.js'
+export * from './src/modifyPath.js'
 export * from './src/modifyProp.js'
 export * from './src/none.js'
 export * from './src/objOf.js'

package/src/assertType.js

@@ -0,0 +1,8 @@
+export function assertType(fn) {
+  return (x) => {
+    if (fn(x)) {
+      return x
+    }
+    throw new Error('type assertion failed in R.assertType')
+  }
+}

package/src/convertToType.js

@@ -0,0 +1,3 @@
+export function convertToType(x) {
+  return x
+}

package/src/modifyPath.js

@@ -0,0 +1,30 @@
+import { createPath } from './_internals/createPath.js'
+import { path as pathModule } from './path.js'
+
+function assoc(prop, newValue) {
+  return obj => Object.assign({}, obj, { [prop]: newValue })
+}
+
+function modifyPathFn(pathInput, fn, obj) {
+  const path = createPath(pathInput)
+  if (path.length === 1) {
+    return {
+      ...obj,
+      [path[0]]: fn(obj[path[0]]),
+    }
+  }
+  if (pathModule(path)(obj) === undefined) {
+    return obj
+  }
+
+  const val = modifyPathFn(Array.prototype.slice.call(path, 1), fn, obj[path[0]])
+  if (val === obj[path[0]]) {
+    return obj
+  }
+
+  return assoc(path[0], val)(obj)
+}
+
+export function modifyPath(pathInput, fn) {
+  return obj => modifyPathFn(pathInput, fn, obj)
+}