rambda 9.4.2 → 10.0.0-beta.1

package/CHANGELOG.md

@@ -1,4 +1,180 @@
-9.4.2 
+10.0.0
+
+CHANGELOG - 10.0.0
+
+This is major revamp of `Rambda` library:
+
+- `R.pipe` is the recommended method for TypeScript chaining.
+
+- All methods should be useful to work inside `R.pipe` chain. If method doesn't have clear use case inside `R.pipe`, it is removed as part of this revamp.
+
+- There will be only one way to use each method. For example, `R.add` can be used only with `R.add(1)(2)`, i.e. it doesn't support `R.add(1, 2)`. This helps with testing and also with TypeScript definitions. This aligns with TypeScript focused approach of this library.
+
+- Confusing methods are removed. For example, `R.cond` and `R.ifElse` are removed as their usage inside `R.piped` makes the whole chain less readable. Such logic should be part of your codebase, not part of external library.
+
+- All methods that expect more than 1 input, will have to be called with `R.methodName(input1)(input2)` or `R.methodName(input1, input2)(input3)`. This is to make TypeScript definitions easier to maintain. 
+
+- Optimize many methods to better work in TypeScript context with `R.pipe`. The focus was passing objects through the `R.pipe` chain.
+
+- Add `R.pipe` supports up to 20 functions, i.e. chain can be 20 functions long.
+
+- `R.chain` is renamed to `R.flatMap`
+- `R.comparator` is renamed to `R.sortingFn`
+
+- Remove following methods:
+
+-- Lenses - `R.lens`, `R.lensProp`, `R.lensPath`, `R.view`, `R.set`, `R.over`
+-- T, F
+-- add
+-- addIndex, addIndexRight
+-- always
+-- ap
+-- applySpec
+-- applyTo
+-- assoc, assocPath, dissoc, dissocPath
+-- binary
+-- bind
+-- call
+-- collectBy
+-- compose
+-- composeWith
+-- cond
+-- converge
+-- curry
+-- difference, differenceWith
+-- divide, multiply, subtract
+-- endsWith/startsWith
+-- flip
+-- forEachObjIndexed
+-- fromPairs
+-- gte, lte, lt, gt
+-- identical
+-- ifElse
+-- insert
+-- juxt
+-- length
+-- mapObjIndexed
+-- mergeAll, mergeLeft, mergeDeepLeft, mergeDeepRight
+-- move
+-- partitionIndexed
+-- pickAll
+-- pickBy
+-- repeat
+-- splitWhen
+-- toLower/toUpper
+-- unapply
+-- unnest
+-- update
+-- without
+
+- Add following methods:
+
+-- R.pipeAsync
+-- R.addProp
+-- R.createObjectFromKeys
+-- R.mapAsync
+-- R.mapParallelAsync
+-- R.ascend/R.descend
+-- R.shuffle
+-- R.permutations
+-- R.compact
+-- R.rejectObject
+-- R.findNth
+-- R.combinations
+-- R.rangeDescending
+
+- Rename following methods:
+
+-- replaceItemAtIndex -> adjust
+-- checkObjectWithSpec -> where 
+-- objectIncludes -> whereEq
+-- modify -> modifyProp
+
+_ Regarding using object as input with TypeScript in methods such as `R.map/filter` - this feature is no longer supported in TypeScript as it has multiple issues when using inside pipes. In JS, it still works as before. Following methods are affected:
+
+-- R.map
+-- R.mapIndexed
+-- R.filter
+-- R.reject
+
+- Regarding using string as path input in `R.omit`, `R.pick` and `R.path` with TypeScript - now it require explicit definition of expected return type.
+
+- Revert adding stopper logic in `R.reduce` - https://github.com/selfrefactor/rambda/pull/630
+
+- Remove use of `Dictionary` custom interface and use more appropriate `Record<PropertyType, ...>`
+
+- Remove use of `Record<string, ...>` in favour of `Record<PropertyType, ...>`
+
+- Add TypeScript definition to handle common case of `R.filter(Boolean)` that will turn `Array<T | undefined>` to `Array<T>`.
+
+- Regarding using object with `R.forEach` in TypeScript - this is no longer supported. Again, JS version still works with objects.
+
+- head/last - empty array as input will return `undefined`, but `never`
+- assocPath - stop supporting curring of type `(x)(y)(z)`
+
+- Stop support string inputs for some methods, since it was hard to correctly type them in TypeScript.
+
+-- append/prepend
+
+- Change `R.range` to work with `endIndex` included instead of `endIndex` excluded, i.e. `R.range(0, 2)` will return `[0, 1, 2]` instead of `[0, 1]`. This is done because `R.rangeDescending` is added and users would wonder if end or start index is excluded.
+
+- Sync with typing of `@types/ramda`:
+
+-- allPass
+-- anyPass
+-- append
+-- both
+-- countBy
+-- drop
+-- dropLast
+-- dropRepeatsBy
+-- either
+-- filter
+-- forEach
+-- keys
+-- map
+-- mergeAll
+-- modify
+-- modifyPath
+-- omit
+-- partition
+-- pluck
+-- prepend
+-- propEq
+-- where
+-- whereAny
+
+- Sync with typing of `remeda`:
+
+-- filter
+-- reject
+-- map
+-- mapObject
+-- toPairs
+-- partition
+
+- Publish to JSR registry - https://jsr.io/@rambda/rambda
+
+- Replace Record<string> with Record<PropertyKey>
+
+- Improve TypeScript definitions of:
+
+-- objOf
+-- pluck
+-- mergeWith
+
+- Change `Jest` with `Vitest`.
+
+- Remove `Babel` dependency in `Rollup` build setup.
+
+- Revert adding stopper logic in `R.reduce` - https://github.com/selfrefactor/rambda/pull/630
+
+- Renamed methods: 
+
+-- `chain` to `flatMap`
+-- `mapObjIndexed` to `mapObject`
+
+9.4.2
 
 - Fix TS issue when `R.take` is used as part of `R.pipe`.