Update dependency immutable to v5 #21

renovate · 2024-12-11T03:27:07Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
immutable (source)	`^4.0.0` -> `^5.0.0`

Release Notes

immutable-js/immutable-js (immutable)

`v5.0.3`

Compare Source

Fix List.VNode.removeAfter() / removeBefore() issue on some particular case #2030 by @alexvictoor

`v5.0.2`

Compare Source

Changed

Fix wrong path for esm module after fix in 5.0.1

Full Changelog: immutable-js/immutable-js@v5.0.1...v5.0.2

`v5.0.1`

Compare Source

What's Changed

Breaking changes

To sum up, the big change in 5.0 is a Typescript change related to Map that is typed closer to the JS object. This is a huge change for TS users, but do not impact the runtime behavior. (see Improve TypeScript definition for Map for more details)

Other breaking changes are:

[BREAKING] Remove deprecated methods:

Released in 5.0.0-rc.1

Map.of('k', 'v'): use Map([ [ 'k', 'v' ] ]) or Map({ k: 'v' })
Collection.isIterable: use isIterable directly
Collection.isKeyed: use isKeyed directly
Collection.isIndexed: use isIndexed directly
Collection.isAssociative: use isAssociative directly
Collection.isOrdered: use isOrdered directly

[BREAKING] `OrdererMap` and `OrderedSet` hashCode implementation has been fixed

Released in 5.0.0-rc.1

Fix issue implementation of hashCode for OrdererMap and OrderedSet where equal objects might not return the same hashCode.

Changed in #2005

[BREAKING] Range function needs at least two defined parameters

Released in 5.0.0-beta.5

Range with undefined would end in an infinite loop. Now, you need to define at least the start and end values.

If you need an infinite range, you can use Range(0, Infinity).

Changed in #1967 by @jdeniau

[Minor BC break] Remove default export

Released in 5.0.0-beta.1

Immutable does not export a default object containing all it's API anymore.
As a drawback, you can not immport Immutable directly:

- import Immutable from 'immutable';
+ import { List, Map } from 'immutable';

- const l = Immutable.List([Immutable.Map({ a: 'A' })]);
+ const l = List([Map({ a: 'A' })]);

If you want the non-recommanded, but shorter migration path, you can do this:

- import Immutable from 'immutable';
+ import * as Immutable from 'immutable';

  const l = Immutable.List([Immutable.Map({ a: 'A' })]);

[TypeScript Break] Improve TypeScript definition for `Map`

Released in 5.0.0-beta.1

If you do use TypeScript, then this change does not impact you : no runtime change here.
But if you use Map with TypeScript, this is a HUGE change !
Imagine the following code

const m = Map({ length: 3, 1: 'one' });

This was previously typed as Map<string, string | number>

and return type of m.get('length') or m.get('inexistant') was typed as string | number | undefined.

This made Map really unusable with TypeScript.

Now the Map is typed like this:

MapOf<{
    length: number;
    1: string;
}>

and the return type of m.get('length') is typed as number.

The return of m.get('inexistant') throw the TypeScript error:

Argument of type '"inexistant"' is not assignable to parameter of type '1 | "length"

If you want to keep the old definition

This is a minor BC for TS users, so if you want to keep the old definition, you can declare you Map like this:

const m = Map<string, string | number>({ length: 3, 1: 'one' });

If you need to type the Map with a larger definition

You might want to declare a wider definition, you can type your Map like this:

type MyMapType = {
  length: number;
  1: string | null;
  optionalProperty?: string;
};
const m = Map<MyMapType>({ length: 3, 1: 'one' });

Keep in mind that the MapOf will try to be consistant with the simple TypeScript object, so you can not do this:

Map({ a: 'a' }).set('b', 'b');
Map({ a: 'a' }).delete('a');

Like a simple object, it will only work if the type is forced:

Map<{ a: string; b?: string }>({ a: 'a' }).set('b', 'b'); // b is forced in type and optional
Map<{ a?: string }>({ a: 'a' }).delete('a'); // you can only delete an optional key

Are all `Map` methods implemented ?

For now, only get, getIn, set, update, delete, remove, toJS, toJSON methods are implemented. All other methods will fallback to the basic Map definition. Other method definition will be added later, but as some might be really complex, we prefer the progressive enhancement on the most used functions.

Fixes

Fix type inference for first() and last() #2001 by @butchler
Fix issue with empty list that is a singleton #2004 by @jdeniau
Map and Set sort and sortBy return type #2013 by @jdeniau

Internal

[Internal] Migrating TS type tests from dtslint to TSTyche #1988 and #1991 by @mrazauskas.
Special thanks to @arnfaldur that migrated every type tests to tsd just before that.
[internal] Upgrade to rollup 3.x #1965 by @jdeniau
[internal] upgrade tooling (TS, eslint) and documentation packages: #1971, #1972, #1973, #1974, #1975, #1976, #1977, #1978, #1979, #1980, #1981

`v4.3.7`

Compare Source

Fix issue with slice negative of filtered sequence #2006 by @jdeniau

`v4.3.6`

Compare Source

Fix Repeat(<value>).equals(undefined) incorrectly returning true #1994 by @butchler

`v4.3.5`

Compare Source

What's Changed

Fix Set.fromKeys types with Map constructor in TS 5.0 by @jdeniau in https://github.com/immutable-js/immutable-js/pull/1971
upgrade to TS 5.1 by @jdeniau in https://github.com/immutable-js/immutable-js/pull/1972
fix dist-stats command by @jdeniau in https://github.com/immutable-js/immutable-js/pull/1964
fix Read the Docs link on readme by @joshding in https://github.com/immutable-js/immutable-js/pull/1970

New Contributors

@joshding made their first contribution in https://github.com/immutable-js/immutable-js/pull/1970

Full Changelog: immutable-js/immutable-js@v4.3.4...v4.3.5

`v4.3.4`

Compare Source

Rollback toJS type due to circular reference error #1958 by @jdeniau

`v4.3.3`

Compare Source

[typescript] manage to handle toJS circular reference. #1932 by @jdeniau
[doc] Add install instructions for pnpm and Bun #1952 by @colinhacks and #1953 by @menglingyu659

`v4.3.2`

Compare Source

[TypeScript] Fix isOrderedSet type #1948

`v4.3.1`

Compare Source

Faster and implementation of some #1944
[internal] remove unused exports #1928

`v4.3.0`

Compare Source

Introduce Comparator and PairSorting #1937 by @https://github.com/giancosta86
[TypeScript] Fix fromJS declaration for greater compatibility #1936

`v4.2.4`

Compare Source

[TypeScript] Improve type infererence for from JS by KSXGitHub #1927

`v4.2.3`

Compare Source

[TypeScript] groupBy return either a Map or an OrderedMap: make the type more precise than base Collection #1924

`v4.2.2`

Compare Source

[Flow] Add type for partition method #1920 by Dagur

`v4.2.1`

Compare Source

[Typescript] rollback some of the change on toJS to avoir circular reference

`v4.2.0`

Compare Source

[TypeScript] Better type for toJS #1917 by jdeniau
- [TS Minor Break] tests are ran with TS > 4.5 only. It was tested with TS > 2.1 previously, but we want to level up TS types with recent features. TS 4.5 has been released more than one year before this release. If it does break your implementation (it might not), you should probably consider upgrading to the latest TS version.
Added a partition method to all containers #1916 by johnw42

`v4.1.0`

Compare Source

Accept Symbol as Map key. #1859 by jdeniau
Optimize contructors without arguments #1887 by marianoguerra
Fix Flow removeIn types #1902 by nifgraup
Fix bug in Record.equals when comparing against Map #1903 by jmtoung

Configuration

📅 Schedule: Branch creation - "before 7am every weekday" in timezone Europe/Brussels, Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

renovate · 2024-12-11T03:27:08Z

Branch automerge failure

This PR was configured for branch automerge. However, this is not possible, so it has been raised as a PR instead.

Branch has one or more failed status checks

Update dependency immutable to v5

8d728b5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency immutable to v5 #21

Update dependency immutable to v5 #21

renovate bot commented Dec 11, 2024

renovate bot commented Dec 11, 2024

Update dependency immutable to v5 #21

Are you sure you want to change the base?

Update dependency immutable to v5 #21

Conversation

renovate bot commented Dec 11, 2024

Release Notes

Changed

What's Changed

Fixes

Internal

Breaking changes

[BREAKING] Remove deprecated methods:

[BREAKING] OrdererMap and OrderedSet hashCode implementation has been fixed

[BREAKING] Range function needs at least two defined parameters

[Minor BC break] Remove default export

[TypeScript Break] Improve TypeScript definition for Map

If you want to keep the old definition

If you need to type the Map with a larger definition

Are all Map methods implemented ?

Fixes

Internal

What's Changed

New Contributors

Configuration

renovate bot commented Dec 11, 2024

Branch automerge failure

[BREAKING] `OrdererMap` and `OrderedSet` hashCode implementation has been fixed

[TypeScript Break] Improve TypeScript definition for `Map`

Are all `Map` methods implemented ?