Merge remote-tracking branch 'origin/main' into jd-feat-tsMapObject

Author: jdeniau

CHANGELOG.md

@@ -10,9 +10,6 @@ Dates are formatted as YYYY-MM-DD.
 
 ### Changed
 
-- Accept Symbol as Map key. [#1859](https://github.com/immutable-js/immutable-js/pull/1859) by [jdeniau](https://github.com/jdeniau)
-- Optimize contructors without arguments [#1887](https://github.com/immutable-js/immutable-js/pull/1887) by [marianoguerra](https://github.com/marianoguerra)
-
 ### Improve TypeScript definition for `Map`
 
 Imagine the following code
@@ -82,6 +79,13 @@ Map<{ a?: string }>({ a: 'a' }).delete('a'); // you can only delete an optional
 
 For now, only `get`, `getIn`, `set`, `update`, `delete` and `remove` 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.
 
+## [4.1.0] - 2022-05-23
+
+- Accept Symbol as Map key. [#1859](https://github.com/immutable-js/immutable-js/pull/1859) by [jdeniau](https://github.com/jdeniau)
+- Optimize contructors without arguments [#1887](https://github.com/immutable-js/immutable-js/pull/1887) by [marianoguerra](https://github.com/marianoguerra)
+- Fix Flow removeIn types [#1902](https://github.com/immutable-js/immutable-js/pull/1902) by [nifgraup](https://github.com/nifgraup)
+- Fix bug in Record.equals when comparing against Map [#1903](https://github.com/immutable-js/immutable-js/pull/1903) by [jmtoung](https://github.com/jmtoung)
+
 ## [4.0.0] - 2021-09-30
 
 This release brings new functionality and many fixes.

__tests__/Map.ts

@@ -428,6 +428,12 @@ describe('Map', () => {
     expect(is(m1, m2)).toBe(true);
   });
 
+  it('does not equal Record with same values', () => {
+    const m1 = Map({ A: 1, B: 2, C: 3 });
+    const m2 = Record({ A: 1, B: 2, C: 3 });
+    expect(is(m1, m2)).toBe(false);
+  });
+
   it('deletes all the provided keys', () => {
     const NOT_SET = undefined;
     const m1 = Map({ A: 1, B: 2, C: 3 });

__tests__/Record.ts

@@ -88,6 +88,12 @@ describe('Record', () => {
     expect(t1.equals(null)).toBeFalsy();
   });
 
+  it('if compared against Map should return false', () => {
+    const MyType = Record({ a: 1, b: 2 });
+    const t1 = MyType();
+    expect(t1.equals(Map({ a: 1, b: 2 }))).toBeFalsy();
+  });
+
   it('merges in Objects and other Records', () => {
     const Point2 = Record({ x: 0, y: 0 });
     const Point3 = Record({ x: 0, y: 0, z: 0 });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "immutable",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Immutable Data Collections",
   "license": "MIT",
   "homepage": "https://immutable-js.com",

package.json

@@ -120,7 +120,8 @@ export class Record {
 
   equals(other) {
     return (
-      this === other || (other && recordSeq(this).equals(recordSeq(other)))
+      this === other ||
+      (isRecord(other) && recordSeq(this).equals(recordSeq(other)))
     );
   }
 

src/Record.js

@@ -1999,36 +1999,36 @@ declare function hasIn(collection: Object, keyPath: Iterable<mixed>): boolean;
 
 declare function removeIn<C>(collection: C, keyPath: []): void;
 declare function removeIn<C, K: $KeyOf<C>>(collection: C, keyPath: [K]): C;
-declare function removeIn<C, K: $KeyOf<C>, K2: $KeyOf<$ValOf<C>>>(
+declare function removeIn<C, K: $KeyOf<C>, K2: $KeyOf<$ValOf<C, K>>>(
   collection: C,
   keyPath: [K, K2]
 ): C;
 declare function removeIn<
   C,
   K: $KeyOf<C>,
-  K2: $KeyOf<$ValOf<C>>,
-  K3: $KeyOf<$ValOf<$ValOf<C>, K2>>
+  K2: $KeyOf<$ValOf<C, K>>,
+  K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>
 >(
   collection: C,
   keyPath: [K, K2, K3]
 ): C;
 declare function removeIn<
   C,
   K: $KeyOf<C>,
-  K2: $KeyOf<$ValOf<C>>,
-  K3: $KeyOf<$ValOf<$ValOf<C>, K2>>,
-  K4: $KeyOf<$ValOf<$ValOf<$ValOf<C>, K2>, K3>>
+  K2: $KeyOf<$ValOf<C, K>>,
+  K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
+  K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>
 >(
   collection: C,
   keyPath: [K, K2, K3, K4]
 ): C;
 declare function removeIn<
   C,
   K: $KeyOf<C>,
-  K2: $KeyOf<$ValOf<C>>,
-  K3: $KeyOf<$ValOf<$ValOf<C>, K2>>,
-  K4: $KeyOf<$ValOf<$ValOf<$ValOf<C>, K2>, K3>>,
-  K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C>, K2>, K3>, K4>>
+  K2: $KeyOf<$ValOf<C, K>>,
+  K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
+  K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
+  K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>>
 >(
   collection: C,
   keyPath: [K, K2, K3, K4, K5]

type-definitions/immutable.js.flow

@@ -23,7 +23,7 @@ export const MarkdownContent = memo<Props>(function MarkdownContent({
 
   return (
     <div
-      className={'markdown ' + className}
+      className={'markdown ' + (className || '')}
       onClick={handleClick}
       dangerouslySetInnerHTML={{ __html: contents }}
     />

website/src/MarkdownContent.tsx

@@ -70,7 +70,7 @@ export function MemberDoc({ member }: { member: MemberDefinition }) {
         {member.doc?.description && (
           <section>
             <h4 className="infoHeader">
-              {member.doc.description.substr(0, 5) === '<code'
+              {member.doc.description.slice(0, 5) === '<code'
                 ? 'Example'
                 : 'Discussion'}
             </h4>

website/src/MemberDoc.tsx

@@ -94,7 +94,7 @@ function FunctionDoc({ def }: { def: MemberDefinition }) {
       {def.doc?.description && (
         <section>
           <h4 className="infoHeader">
-            {def.doc.description.substr(0, 5) === '<code'
+            {def.doc.description.slice(0, 5) === '<code'
               ? 'Example'
               : 'Discussion'}
           </h4>
@@ -147,7 +147,7 @@ function TypeDoc({
       {def.doc?.description && (
         <section>
           <h4 className="infoHeader">
-            {def.doc.description.substr(0, 5) === '<code'
+            {def.doc.description.slice(0, 5) === '<code'
               ? 'Example'
               : 'Discussion'}
           </h4>