Make FP comatible with Lodash and fp-ts (closes #3641)

kossnocorp · kossnocorp · commit 25f1bd6b7b3d · 2024-01-09T17:57:14.000+08:00
Fixed types compatability with Lodash's `flow` and fp-ts's `pipe`.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -24,7 +24,10 @@ module.exports = {
   plugins: ["@typescript-eslint"],
   ignorePatterns: ["lib", "tmp", "examples"],
   rules: {
-    "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+    ],
     "@typescript-eslint/consistent-type-imports": "error",
     // The following rules are deprecated: https://eslint.org/blog/2023/10/deprecating-formatting-rules
     "array-bracket-newline": "off",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6025,6 +6025,7 @@
     "@octokit/core": "^3.2.5",
     "@size-limit/esbuild": "^11.0.1",
     "@size-limit/file": "^11.0.1",
+    "@types/lodash": "^4.14.202",
     "@types/node": "^20.10.2",
     "@types/sinon": "^9.0.6",
     "@typescript-eslint/eslint-plugin": "^6.13.1",
@@ -6036,7 +6037,9 @@
     "coveralls": "^3.1.1",
     "eslint": "^8.55.0",
     "firebase": "^3.7.1",
+    "fp-ts": "^2.16.2",
     "js-fns": "^2.5.1",
+    "lodash": "^4.17.21",
     "playwright": "^1.40.1",
     "prettier": "^3.1.0",
     "simple-git": "^2.35.2",
diff --git a/src/fp/_lib/convertToFP/test.ts b/src/fp/_lib/convertToFP/test.ts
@@ -1,7 +1,11 @@
 /* eslint-env mocha */
 
 import assert from "assert";
+import { pipe } from "fp-ts/function";
+import { flow as jsFnsFlow } from "js-fns";
+import lodashFlow from "lodash/flow";
 import { describe, it } from "vitest";
+import { addDays, addHours, isEqual } from "../../index.js";
 import { convertToFP } from "./index.js";
 
 describe("convertToFP", () => {
@@ -77,4 +81,42 @@ describe("convertToFP", () => {
       assert(result === "undefined undefined undefined");
     });
   });
+
+  describe("types", () => {
+    it("resolves proper types", () => {
+      const fn1 = addDays();
+      const fn2 = fn1(1);
+      const result = fn2(new Date(1987, 1));
+      assert(result.getFullYear() === 1987);
+    });
+  });
+
+  describe("Lodash", () => {
+    it("works with flow", () => {
+      const fn = lodashFlow(addDays(1), addHours(1));
+      const result = fn(new Date(1987, 1, 11));
+      assert(result.getFullYear() === 1987);
+      assert.deepStrictEqual(result, new Date(1987, 1, 12, 1));
+    });
+  });
+
+  describe("fp-ts", () => {
+    it("works with pipe", () => {
+      const result = pipe(
+        new Date(1987, 1, 11),
+        isEqual(new Date(1987, 1, 11)),
+      );
+      const _assign: boolean = result;
+      assert(result);
+    });
+  });
+
+  describe("js-fns", () => {
+    it("works with flow", () => {
+      const fn = jsFnsFlow(addDays(1), addHours(1));
+      const result = fn(new Date(1987, 1, 11));
+      assert(result.getFullYear() === 1987);
+      assert.deepStrictEqual(result, new Date(1987, 1, 12, 1));
+    });
+  });
 });
diff --git a/src/fp/types.ts b/src/fp/types.ts
@@ -39,24 +39,24 @@ export type FPFn<Fn extends FPFnInput, Arity extends FPArity> = Arity extends 4
  */
 export interface FPFn1<Result, Arg> {
   /**
-   * Returns the result of the function call.
+   * Curried version of the function. Returns itself.
    */
-  (arg: Arg): Result;
+  (): FPFn1<Result, Arg>;
 
   /**
-   * Curried version of the function. Returns itself.
+   * Returns the result of the function call.
    */
-  (): FPFn1<Result, Arg>;
+  (arg: Arg): Result;
 }
 
 /**
  * FP function interface with 2 arguments.
  */
 export interface FPFn2<Result, Arg2, Arg1> {
   /**
-   * Returns the result of the function call.
+   * Curried version of the function. Returns itself.
    */
-  (arg2: Arg2, arg1: Arg1): Result;
+  (): FPFn2<Result, Arg2, Arg1>;
 
   /**
    * Curried version of the function. Returns a function that accepts the rest
@@ -65,52 +65,52 @@ export interface FPFn2<Result, Arg2, Arg1> {
   (arg2: Arg2): FPFn1<Result, Arg1>;
 
   /**
-   * Curried version of the function. Returns itself.
+   * Returns the result of the function call.
    */
-  (): FPFn2<Result, Arg2, Arg1>;
+  (arg2: Arg2, arg1: Arg1): Result;
 }
 
 /**
  * FP function interface with 3 arguments.
  */
 export interface FPFn3<Result, Arg3, Arg2, Arg1> {
   /**
-   * Returns the result of the function call.
+   * Curried version of the function. Returns itself.
    */
-  (arg3: Arg3, arg2: Arg2, arg1: Arg1): Result;
+  (): FPFn3<Result, Arg3, Arg2, Arg1>;
 
   /**
    * Curried version of the function. Returns a function that accepts the rest
    * arguments.
    */
-  (arg3: Arg3, arg2: Arg2): FPFn1<Result, Arg1>;
+  (arg3: Arg3): FPFn2<Result, Arg2, Arg1>;
 
   /**
    * Curried version of the function. Returns a function that accepts the rest
    * arguments.
    */
-  (arg3: Arg3): FPFn2<Result, Arg2, Arg1>;
+  (arg3: Arg3, arg2: Arg2): FPFn1<Result, Arg1>;
 
   /**
-   * Curried version of the function. Returns itself.
+   * Returns the result of the function call.
    */
-  (): FPFn3<Result, Arg3, Arg2, Arg1>;
+  (arg3: Arg3, arg2: Arg2, arg1: Arg1): Result;
 }
 
 /**
  * FP function interface with 4 arguments.
  */
 export interface FPFn4<Result, Arg4, Arg3, Arg2, Arg1> {
   /**
-   * Returns the result of the function call.
+   * Curried version of the function. Returns itself.
    */
-  (arg4: Arg4, arg3: Arg3, arg2: Arg2, arg1: Arg1): Result;
+  (): FPFn4<Result, Arg4, Arg3, Arg2, Arg1>;
 
   /**
    * Curried version of the function. Returns a function that accepts the rest
    * arguments.
    */
-  (arg4: Arg4, arg3: Arg3, arg2: Arg2): FPFn1<Result, Arg1>;
+  (arg4: Arg4): FPFn3<Result, Arg3, Arg2, Arg1>;
 
   /**
    * Curried version of the function. Returns a function that accepts the rest
@@ -122,10 +122,10 @@ export interface FPFn4<Result, Arg4, Arg3, Arg2, Arg1> {
    * Curried version of the function. Returns a function that accepts the rest
    * arguments.
    */
-  (arg4: Arg4): FPFn3<Result, Arg3, Arg2, Arg1>;
+  (arg4: Arg4, arg3: Arg3, arg2: Arg2): FPFn1<Result, Arg1>;
 
   /**
-   * Curried version of the function. Returns itself.
+   * Returns the result of the function call.
    */
-  (): FPFn4<Result, Arg4, Arg3, Arg2, Arg1>;
+  (arg4: Arg4, arg3: Arg3, arg2: Arg2, arg1: Arg1): Result;
 }
