update tsconfig and add internal flag

Author: CoveMB

.eslintrc.js

@@ -2,7 +2,7 @@ module.exports = {
   "parserOptions": {
     "ecmaVersion": 10,
     "parser": "@typescript-eslint/parser",
-    "project": "./tsconfig.json"
+    "project": "./tsconfig.eslint.json"
   },
   "extends": [
     "airbnb-typescript/base",
@@ -76,13 +76,21 @@ module.exports = {
     "@typescript-eslint/no-magic-numbers": 'off',
     "@typescript-eslint/no-floating-promises": ["error", { "ignoreIIFE": true }],
     "@typescript-eslint/no-duplicate-imports": "error",
+    "@typescript-eslint/restrict-template-expressions": "off",
     "@typescript-eslint/no-shadow": ["error", { "builtinGlobals": false, "hoist": "functions"}],
     // Function 
     "func-style": "off"
   },
+  "overrides":[
+    {
+      "files": ["./__tests__/**/*.ts"],
+      "env": {
+        "node": true,
+        "jest": true
+      }
+    }
+  ],
   "env": {
-    "node": true,
-    "browser": true,
-    "jest": true
+    "node": true
   },
 };

__tests__/.eslintrc.js

@@ -1,82 +1,11 @@
 module.exports = {
-  "parserOptions": {
-    "ecmaVersion": 10,
-    "parser": "@typescript-eslint/parser",
-    "project": "./tsconfig.json"
-  },
   "extends": [
-    "airbnb-typescript/base",
-    "hardcore/ts-for-js",
-    "hardcore", 
-    "hardcore/fp"
-  ],
-  "plugins": [
-    "@typescript-eslint",
-    "unicorn",
-    "functional",
-    "jest"
+    "../.eslintrc.js",
   ],
-  "settings": {
-    "import/resolver": {
-      "node": {
-        "extensions": [
-          ".js",
-          ".ts",
-          ".d.ts"
-        ],
-        "moduleDirectory": [
-          "node_modules",
-          "./src"
-        ]
-      }
-    }
-  },
+  
   "rules": {
-    // Import
-    "import/extensions": [
-      "error",
-      "ignorePackages",
-      {
-        "js": "never",
-        "ts": "never",
-      }
-    ],
-    "import/order": "off",
-    "import/no-cycle": "off",
-    "import/unambiguous": "off",
-    "import/no-namespace": "off",
-    "import/group-exports": "off",
-    "import/exports-last": "off",
-    "import/prefer-default-export": "off",
-    "import/no-unused-modules": "off",
+    "import/no-extraneous-dependencies": "off",
     "no-param-reassign": "off",
-    // Eslint General
-    "max-len": [
-      "warn",
-      {
-        "code": 100,
-        "ignoreStrings": true,
-        "ignoreUrls": true,
-        "ignoreComments": true,
-        "ignoreTemplateLiterals": true,
-        "ignoreRegExpLiterals": true
-      }
-    ],
-    "no-shadow": ["error", { "builtinGlobals": false, "hoist": "functions"}],
-    "no-underscore-dangle": "off",
-    "no-console": "off",
-    "no-magic-numbers": "off",
-    "no-unused-vars": "off",
-    "consistent-return": "off",
-    "require-atomic-updates": "off",
-    "lines-around-comment": "off",
-    // Typescript
-    "@typescript-eslint/ban-ts-comment": "off",
-    "@typescript-eslint/naming-convention": "off",
-    "@typescript-eslint/no-magic-numbers": "off",
-    "@typescript-eslint/no-floating-promises": ["error", { "ignoreIIFE": true }],
-    "@typescript-eslint/no-duplicate-imports": "error",
-    "@typescript-eslint/no-shadow": ["error", { "builtinGlobals": false, "hoist": "functions"}],
     // Function 
     "func-style": "off",
     // FP

__tests__/error.test.ts

@@ -7,7 +7,7 @@ import {
   simpleResponse,
 } from "../src";
 import { lambdaExecutor } from "./fixtures/helpers";
-import createHttpError from "http-errors";
+import * as createHttpError from "http-errors";
 
 it("If an error occur during the flow it is returned in the body", async () => {
   const flow = lambdaFlow((box) => {
@@ -251,7 +251,7 @@ it("If an error is attached to the box the other functions of the flow are not r
       return box;
     },
     (box) => {
-      toMutate = "mutated";
+      toMutate = "mutated2";
 
       return box;
     }
@@ -292,7 +292,7 @@ it("If is compatible with http-error", async () => {
       return box;
     },
     (box) => {
-      toMutate = "mutated";
+      toMutate = "mutated3";
 
       return box;
     }
@@ -312,11 +312,11 @@ it("If is compatible with http-error", async () => {
   let toMutate = "Not mutated";
 
   const flow = lambdaFlow(
-    (box) => {
+    () => {
       throw new createHttpError.NotFound();
     },
     (box) => {
-      toMutate = "mutated";
+      toMutate = "mutated4";
 
       return box;
     }

__tests__/fixtures/data.ts

@@ -1,3 +1,4 @@
+/* eslint-disable unicorn/no-null */
 import { APIGatewayProxyEvent, APIGatewayProxyEventV2 } from "aws-lambda";
 
 const lambdaContext = {

__tests__/flow.test.ts

@@ -20,7 +20,7 @@ it("Does not return the FlowBox", async () => {
   const flow = lambdaFlow(simpleResponse())();
   const response = await lambdaExecutor(flow);
 
-  // @ts-ignore for test
+  // @ts-expect-error
   expect(response.state).toBe(undefined);
 });
 

__tests__/gard.test.ts

@@ -1,7 +1,9 @@
+/* eslint-disable unicorn/consistent-function-scoping */
 import { FlowBox } from "../src/types";
 import { lambdaFlow } from "../src";
 import { lambdaExecutor } from "./fixtures/helpers";
 
+// eslint-disable-next-line max-statements
 it("A middleware has to return a box", async () => {
   const originalLog = console.log;
 
@@ -17,7 +19,7 @@ it("A middleware has to return a box", async () => {
 
       return box;
     },
-    // @ts-ignore
+    // @ts-expect-error
     wrongMiddleware
   )();
 
@@ -49,7 +51,7 @@ it("Only allowed key of box can be mutated", async () => {
   const wrongMiddleware = (box: FlowBox) => {
     box.statusCode = 200;
     box.body = { name: true };
-    // @ts-ignore
+    // @ts-expect-error
     box.mutation = 9;
 
     return box;

package.json

@@ -9,11 +9,15 @@
     "type": "git",
     "url": "https://github.com/BjMrq/LambdaFlow"
   },
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "dist/src/**/*"
+    "dist/**/*"
   ],
+  "volta": {
+    "node": "12.20.0",
+    "yarn": "1.22.10"
+  },
   "scripts": {
     "prepare": "npm run build",
     "prepublishOnly": "npm test",
@@ -22,7 +26,7 @@
     "test": "jest -i --config jestconfig.json"
   },
   "dependencies": {
-    "@bjmrq/utils": "^0.0.19",
+    "@bjmrq/utils": "^0.0.20",
     "aws-lambda": "^1.0.6",
     "fp-ts": "^2.8.4",
     "ramda": "^0.27.1"
@@ -65,4 +69,4 @@
     "serverless",
     "apigateway"
   ]
-}
+}

src/helpers/helpers-error.ts

@@ -13,8 +13,8 @@ const errorBuilder: ErrorBuilder = (expose = false) => (statusCode = 500) => (
 ) => ({
   expose,
   statusCode,
-  message: R.when(R.is(Object), R.prop("message"))(message),
-  error: R.unless(R.is(Object), () => new Error(message as string))(message),
+  message: R.when(R.is(Error), R.prop("message"))(message),
+  error: R.unless(R.is(Error), () => new Error(message as string))(message),
 });
 
 /**

src/lambda-flow.ts

@@ -26,6 +26,7 @@ import {
 } from "./types";
 import enhancedErrors from "./utils/guards-reasons";
 
+// @internal
 const createBox: CreateBox = (event, context, callback) =>
   Object.seal({
     state: {},
@@ -41,6 +42,7 @@ const createBox: CreateBox = (event, context, callback) =>
     multiValueHeaders: undefined,
   });
 
+// @internal
 const errorResponse = flow(
   R.over(
     toBodyErrorResponseLens,
@@ -61,6 +63,7 @@ const errorResponse = flow(
   )
 );
 
+// @internal
 const successResponse = flow(
   R.over(toIsEncodedResponseLens, R.identity),
   R.over(toStatusResponseLens, R.unless(R.is(Number), R.always(200))),
@@ -70,6 +73,7 @@ const successResponse = flow(
   )
 );
 
+// @internal
 const returnResponse: ResponseMiddleware = async (box) =>
   flow(
     R.set(responseLens, {}),
@@ -84,6 +88,7 @@ const returnResponse: ResponseMiddleware = async (box) =>
     R.prop("response")
   )(await box) as Promise<APIGatewayProxyStructuredResultV2>;
 
+// @internal
 const validateBoxState = (middleware: FlowMiddleware) =>
   R.unless(
     R.is(Object),
@@ -97,6 +102,7 @@ const validateBoxState = (middleware: FlowMiddleware) =>
     )
   );
 
+// @internal
 const notCatchedErrors = (middleware: FlowMiddleware) => (
   error: Error,
   errorBox: FlowBoxWithError
@@ -107,30 +113,30 @@ const notCatchedErrors = (middleware: FlowMiddleware) => (
     R.tap(logError)
   );
 
+// @internal
 const errorOut: ErrorOut = (middleware) => async (box) =>
-  // @ts-ignore
+  // @ts-expect-error
   flow(
-    // @ts-ignore
     R.unless(
       flow(R.prop("error"), R.is(Object)),
-      // @ts-ignore
       // TODO have a look at ramda otherwise
       tryCatchAsync(
-        // @ts-ignore
+        // @ts-expect-error
         flow(middleware, validateBoxState(middleware)),
         notCatchedErrors(middleware)
       )
     )
-    // @ts-ignore
+    // @ts-expect-error
   )(await box);
 
+// @internal
 const errorCallbackHandler: ErrorCallbackHandler = (errorCallback) => async (
   box
 ) =>
-  // @ts-ignore
+  // @ts-expect-error
   R.when(
     flow(R.prop("error"), R.is(Object)),
-    // @ts-ignore
+    // @ts-expect-error
     flow(R.clone, errorCallback, R.always(await box))
   )(await box);
 
@@ -142,10 +148,10 @@ const errorCallbackHandler: ErrorCallbackHandler = (errorCallback) => async (
 const lambdaFlow: LambdaFlow = (...middlewares) => (
   errorCallback = R.identity
 ) =>
-  // @ts-ignore
+  // @ts-expect-error
   flow(
     createBox,
-    // @ts-ignore
+    // @ts-expect-error
     ...R.map(errorOut)(middlewares),
     errorCallbackHandler(errorCallback),
     returnResponse

src/types/error.ts

@@ -13,6 +13,7 @@ export type ErrorBuilder = (
 
 export type ErrorCallback = (box: FlowBoxWithError) => void;
 
+// @internal
 export type ErrorCallbackHandler = (
   errorCallback: ErrorCallback
 ) => (box: Promise<FlowBox>) => Promise<FlowBox>;

src/types/helpers.ts

@@ -6,12 +6,14 @@ import {
 } from "./middleware";
 
 // Middleware helpers
+// @internal
 export type HandleAsyncMiddleware = <
   M extends FlowSyncMiddleware<M> | FlowAsyncMiddleware<M>
 >(
   middleware: M
 ) => (box: Promise<FlowBox<M>>) => Promise<FlowBox<M>>;
 
+// @internal
 export type ErrorOut = <M extends FlowMiddleware>(
   middleware: M
 ) => (box: Promise<FlowBox>) => Promise<FlowBox>;

src/types/internals.ts

@@ -6,6 +6,7 @@ import {
 } from "aws-lambda";
 import { FlowBox } from "./box";
 
+// @internal
 export type CreateBox = (
   event: APIGatewayProxyEventV2,
   context: Context,

src/utils/guards-reasons.ts

@@ -7,7 +7,7 @@ import { boxMutated } from "./guards-messages";
 const enhancedErrors = (middleware: FlowMiddleware) =>
   R.ifElse(
     flow(
-      // @ts-ignore
+      // @ts-expect-error
       R.prop("message"),
       R.includes("object is not extensible")
     ),

tsconfig.eslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "./src",
+    "./__tests__"
+  ]
+}