Update dependency immutable to v5

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
immutable (source)	^4.3.1 -> ^5.0.0

---

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.

---

Release Notes

immutable-js/immutable-js (immutable)

v5.1.4

Compare Source

• Migrate some files to TS by @​jdeniau in #​2125
  • Iterator.ts
  • PairSorting.ts
  • toJS.ts
  • Math.ts
  • Hash.ts
• Extract CollectionHelperMethods and convert to TS by @​jdeniau in #​2131
• Use npm trusted publishing only to avoid token stealing.

Documentation

• Fix/a11y issues by @​lyannel in #​2136
• Doc add Map.get signature update by @​borracciaBlu in #​2138
• fix(doc):minor-issues#2132 by @​JayMeDotDot in #​2133
• Fix algolia search by @​jdeniau in #​2135
• Typo in OrderedMap by @​jdeniau in #​2144

Internal

• chore: Sort all imports and activate eslint import rule by @​jdeniau in #​2119

v5.1.3

Compare Source

TypeScript

• fix: allow readonly map entry constructor by @​septs in #​2123

Documentation

There has been a huge amount of changes in the documentation, mainly migrate from an autogenerated documentation from .d.ts file, to a proper documentation in markdown.
The playground has been included on nearly all method examples.
We added a page about browser extensions too: https://immutable-js.com/browser-extension/

Internal

• replace rimraf by a node script by @​jdeniau in #​2113
• remove warning for tseslint config by @​jdeniau in #​2114
• Use default tsconfig for tests by @​jdeniau in #​2055
• add tests for arrCopy by @​jdeniau in #​2120

v5.1.2

Compare Source

• Revert previous assertion as it introduced a regression #​2102 by @​giggo1604
• Merge should work with empty record #​2103 by @​jdeniau

v5.1.1

Compare Source

• Fix type copying

v5.1.0

Compare Source

• Add shuffle to list #​2066 by @​mazerty
• TypeScript: Better getIn RetrievePath #​2070 by @​jdeniau
• Fix #​1915 "Converting a Seq to a list causes RangeError (max call size exceeded)" by @​alexvictoor in #​2038
• TypeScript: Fix proper typings for Seq.concat() #​2040 by @​alexvictoor
• Fix Uncaught "TypeError: keyPath.slice is not a function" for ArrayLike method #​2065 by @​jdeniau

Internal

• Upgrade typescript and typescript-eslint #​2046 by @​jdeniau
• Upgrade to rollup 4 #​2049 by @​jdeniau
• Start migrating codebase to TypeScript without any runtime change nor .d.ts change:
  • allow TS files to be compiled in src dir #​2054 by @​jdeniau
• add exception for code that should not happen in updateIn #​2074 by @​jdeniau
• Reformat Range.toString for readability #​2075 by @​Ustin.Vaskin

v5.0.3

Compare Source

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

v5.0.2

Compare Source

• Fix wrong path for esm module after fix in 5.0.1

v5.0.1

Compare Source

• Fix circular dependency issue with ESM build by @​iambumblehead in #​2035 by @​iambumblehead

v5.0.0

Compare Source

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

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, 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]

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: src/servicebroker-npm/yarn.lock

➤ YN0000: · Yarn 4.5.0
➤ YN0000: ┌ Resolution step
➤ YN0085: │ + immutable@npm:5.1.4
➤ YN0085: │ - immutable@npm:4.3.5
➤ YN0000: └ Completed in 0s 432ms
➤ YN0000: ┌ Post-resolution validation
➤ YN0086: │ Some peer dependencies are incorrectly met by dependencies; run yarn explain peer-requirements for details.
➤ YN0000: └ Completed
➤ YN0000: ┌ Fetch step
➤ YN0041: │ immutable@npm:5.1.4: Invalid authentication (as an anonymous user)
➤ YN0000: └ Completed
➤ YN0000: · Failed with errors in 0s 606ms