@jaypie/testkit 1.0.28 → 1.1.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Finlayson Studio, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -25,6 +25,23 @@ The testkit provides a complete mock for Jaypie including:
 vi.mock("jaypie", async () => vi.importActual("@jaypie/testkit/mock"));
 ```
 
+#### Error Spying
+  
+```javascript
+import { ConfigurationError } from "@jaypie/core";
+
+vi.mock("jaypie", async () => vi.importActual("@jaypie/testkit/mock"));
+
+test("ConfigurationError", () => {
+  try {
+    throw new ConfigurationError("Sorpresa!");
+  } catch (error) {
+    expect(error).toBeJaypieError();
+    expect(ConfigurationError).toHaveBeenCalled();
+  }
+});
+```
+
 #### Log Spying
 
 ```javascript
@@ -333,6 +350,7 @@ const event = sqsTestRecords(
 
 | Date       | Version | Summary        |
 | ---------- | ------- | -------------- |
+|  9/15/2024 |  1.0.29 | All errors exported as mocks |
 |  9/14/2024 |  1.0.28 | Matchers `toThrowBadGatewayError`, `toThrowGatewayTimeoutError`, `toThrowUnavailableError` |
 |  9/13/2024 |  1.0.27 | Matcher `toBeCalledAboveTrace` |
 |  7/16/2024 |  1.0.21 | Export Jaypie mock as default |
@@ -343,4 +361,4 @@ const event = sqsTestRecords(
 
 ## 📜 License
 
-Published by Finlayson Studio. All rights reserved
+[MIT License](./LICENSE.txt). Published by Finlayson Studio

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@jaypie/testkit",
-  "version": "1.0.28",
+  "version": "1.1.0",
+  "license": "MIT",
   "author": "Finlayson Studio",
   "type": "module",
   "exports": {
@@ -12,17 +13,8 @@
     "format": "npm run format:package && npm run format:lint",
     "format:lint": "eslint --fix .",
     "format:package": "sort-package-json ./package.json",
-    "init:commander": "hygen jaypie commander-init",
-    "init:deploy": "hygen jaypie workflow-npm",
     "lint": "eslint .",
-    "new": "hygen jaypie vite",
-    "new:command": "hygen jaypie command",
-    "new:constants": "hygen jaypie constants",
-    "new:hygen": "hygen jaypie hygen",
-    "new:index": "hygen jaypie index",
-    "new:model": "hygen jaypie model",
-    "new:test": "hygen jaypie vitest",
-    "test": "vitest",
+    "test": "vitest run .",
     "test:spec:constants": "vitest run ./src/__tests__/constants.spec.js",
     "test:spec:expressHandler.mock": "vitest run ./src/__tests__/expressHandler-supertest.mock.spec.js",
     "test:spec:index": "vitest run ./src/__tests__/index.spec.js",
@@ -39,21 +31,17 @@
     "test:spec:toThrowJaypieError.matcher": "vitest run ./src/matchers/__tests__/toThrowJaypieError.matcher.spec.js"
   },
   "dependencies": {
-    "@jaypie/core": "^1.0.33",
+    "@jaypie/core": "^1.1.0",
     "jaypie": "^1.0.44",
     "jest-json-schema": "^6.1.0",
     "lodash.isequal": "^4.5.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "eslint": "^8.57.0",
-    "eslint-config-jaypie": "^1.0.7",
-    "express": "^4.19.2",
-    "hygen": "^6.2.11",
-    "jest-extended": "^4.0.2",
-    "prettier": "^3.2.5",
-    "sort-package-json": "^2.8.0",
-    "supertest": "^7.0.0",
-    "vitest": "^1.4.0"
-  }
+    "express": "^4.21.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "26b6847fa8b061594bd899c2e098822dad198e51"
 }

package/src/jaypie.mock.js

@@ -1,12 +1,31 @@
 import { getMessages as originalGetMessages } from "@jaypie/aws";
 import { force, uuid as originalUuid } from "@jaypie/core";
 import {
-  BadRequestError,
+  // Core utilities
   HTTP,
   JAYPIE,
   log,
-  UnavailableError,
-  UnhandledError,
+  // Errors
+  BadGatewayError as BadGatewayErrorOriginal,
+  BadRequestError as BadRequestErrorOriginal,
+  ConfigurationError as ConfigurationErrorOriginal,
+  ForbiddenError as ForbiddenErrorOriginal,
+  GatewayTimeoutError as GatewayTimeoutErrorOriginal,
+  GoneError as GoneErrorOriginal,
+  IllogicalError as IllogicalErrorOriginal,
+  InternalError as InternalErrorOriginal,
+  MethodNotAllowedError as MethodNotAllowedErrorOriginal,
+  MultiError as MultiErrorOriginal,
+  NotFoundError as NotFoundErrorOriginal,
+  NotImplementedError as NotImplementedErrorOriginal,
+  ProjectError as ProjectErrorOriginal,
+  ProjectMultiError as ProjectMultiErrorOriginal,
+  RejectedError as RejectedErrorOriginal,
+  TeapotError as TeapotErrorOriginal,
+  UnauthorizedError as UnauthorizedErrorOriginal,
+  UnavailableError as UnavailableErrorOriginal,
+  UnhandledError as UnhandledErrorOriginal,
+  UnreachableCodeError as UnreachableCodeErrorOriginal,
 } from "@jaypie/core";
 import { beforeAll, vi } from "vitest";
 
@@ -64,6 +83,69 @@ export const sendMessage = vi.fn(() => {
   return { value: `_MOCK_MESSAGE_[${TAG}]` };
 });
 
+// @jaypie/core Errors
+
+export const BadGatewayError = vi.fn((...params) => {
+  return BadGatewayErrorOriginal(...params);
+});
+export const BadRequestError = vi.fn((...params) => {
+  return BadRequestErrorOriginal(...params);
+});
+export const ConfigurationError = vi.fn((...params) => {
+  return ConfigurationErrorOriginal(...params);
+});
+export const ForbiddenError = vi.fn((...params) => {
+  return ForbiddenErrorOriginal(...params);
+});
+export const GatewayTimeoutError = vi.fn((...params) => {
+  return GatewayTimeoutErrorOriginal(...params);
+});
+export const GoneError = vi.fn((...params) => {
+  return GoneErrorOriginal(...params);
+});
+export const IllogicalError = vi.fn((...params) => {
+  return IllogicalErrorOriginal(...params);
+});
+export const InternalError = vi.fn((...params) => {
+  return InternalErrorOriginal(...params);
+});
+export const MethodNotAllowedError = vi.fn((...params) => {
+  return MethodNotAllowedErrorOriginal(...params);
+});
+export const MultiError = vi.fn((...params) => {
+  return MultiErrorOriginal(...params);
+});
+export const NotFoundError = vi.fn((...params) => {
+  return NotFoundErrorOriginal(...params);
+});
+export const NotImplementedError = vi.fn((...params) => {
+  return NotImplementedErrorOriginal(...params);
+});
+export const ProjectError = vi.fn((...params) => {
+  return ProjectErrorOriginal(...params);
+});
+export const ProjectMultiError = vi.fn((...params) => {
+  return ProjectMultiErrorOriginal(...params);
+});
+export const RejectedError = vi.fn((...params) => {
+  return RejectedErrorOriginal(...params);
+});
+export const TeapotError = vi.fn((...params) => {
+  return TeapotErrorOriginal(...params);
+});
+export const UnauthorizedError = vi.fn((...params) => {
+  return UnauthorizedErrorOriginal(...params);
+});
+export const UnavailableError = vi.fn((...params) => {
+  return UnavailableErrorOriginal(...params);
+});
+export const UnhandledError = vi.fn((...params) => {
+  return UnhandledErrorOriginal(...params);
+});
+export const UnreachableCodeError = vi.fn((...params) => {
+  return UnreachableCodeErrorOriginal(...params);
+});
+
 // @jaypie/core Functions
 
 export const envBoolean = vi.fn(() => {
@@ -181,7 +263,6 @@ export const expressHandler = vi.fn((handler, props = {}) => {
         for (let i = 0; i < keys.length; i += 1) {
           const key = keys[i];
           if (typeof props.locals[key] === "function") {
-            // eslint-disable-next-line no-await-in-loop
             localsReq.locals[key] = await props.locals[key](
               localsReq,
               localsRes,
@@ -240,6 +321,7 @@ export const expressHandler = vi.fn((handler, props = {}) => {
         } else if (typeof response === "string") {
           try {
             res.status(status).json(JSON.parse(response));
+            // eslint-disable-next-line no-unused-vars
           } catch (error) {
             if (supertestMode) {
               res.status(status).send(response);
@@ -263,6 +345,12 @@ export const expressHandler = vi.fn((handler, props = {}) => {
 
 // For testing, this is the same as the jaypieHandler
 export const lambdaHandler = vi.fn((handler, props = {}) => {
+  // If handler is an object and options is a function, swap them
+  if (typeof handler === "object" && typeof props === "function") {
+    const temp = handler;
+    handler = props;
+    props = temp;
+  }
   return async (event, context, ...extra) => {
     return jaypieHandler(handler, props)(event, context, ...extra);
   };

package/src/matchers/toBeCalledAboveTrace.matcher.js

@@ -1,13 +1,3 @@
-//
-//
-// Constants
-//
-
-//
-//
-// Helper Functions
-//
-
 //
 //
 // Main
@@ -29,6 +19,7 @@ const calledAboveTrace = (log) => {
         pass: true,
       };
     }
+    // eslint-disable-next-line no-unused-vars
   } catch (error) {
     throw Error(`[calledAboveTrace] log is not a mock object`);
   }

package/src/matchers/toBeClass.matcher.js

@@ -1,13 +1,3 @@
-//
-//
-// Constants
-//
-
-//
-//
-// Helper Functions
-//
-
 //
 //
 // Main
@@ -17,10 +7,10 @@ const toBeClass = (received) => {
   let pass = false;
   if (typeof received === "function") {
     try {
-      // eslint-disable-next-line new-cap, no-new
       new received();
       pass = true;
-    } catch (e) {
+      // eslint-disable-next-line no-unused-vars
+    } catch (error) {
       pass = false;
     }
   }

package/src/sqsTestRecords.function.js

@@ -1,15 +1,5 @@
 import { v4 as uuid } from "uuid";
 
-//
-//
-// Constants
-//
-
-//
-//
-// Helper Functions
-//
-
 //
 //
 // Main
@@ -20,7 +10,6 @@ const sqsTestRecords = (...args) => {
 
   // See if only a single array was passed in and spread it
   if (args.length === 1 && Array.isArray(args[0])) {
-    // eslint-disable-next-line no-param-reassign
     [args] = args;
   }