@jaypie/express 1.0.15 → 1.1.1

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

@@ -2,15 +2,7 @@
 
 Express Jaypie handler for AWS Lambda
 
-## 📋 Usage
-
-### Installation
-
-```bash
-npm install @jaypie/express
-```
-
-See [Jaypie documentation](https://github.com/finlaysonstudio/jaypie) for usage.
+See [Jaypie](https://github.com/finlaysonstudio/jaypie) for usage.
 
 ## 📝 Changelog
 
@@ -22,4 +14,4 @@ See [Jaypie documentation](https://github.com/finlaysonstudio/jaypie) for usage.
 
 ## 📜 License
 
-Published by Finlayson Studio. All rights reserved
+[MIT License](./LICENSE.txt). Published by Finlayson Studio

package/dist/module.cjs

@@ -60,7 +60,7 @@ const decorateResponse = (
   //
   if (typeof res !== "object" || res === null) {
     log.warn("decorateResponse called but response is not an object");
-    return; // eslint-disable-line no-useless-return
+    return;
   }
 
   try {
@@ -79,28 +79,28 @@ const decorateResponse = (
 
     // X-Project-Environment
     if (process.env.PROJECT_ENV) {
-      res.setHeader(core.HTTP.HEADER.PROJECT.ENVIRONMENT, process.env.PROJECT_ENV);
+      res.set(core.HTTP.HEADER.PROJECT.ENVIRONMENT, process.env.PROJECT_ENV);
     }
 
     // X-Project-Handler
     if (handler) {
-      res.setHeader(core.HTTP.HEADER.PROJECT.HANDLER, handler);
+      res.set(core.HTTP.HEADER.PROJECT.HANDLER, handler);
     }
 
     // X-Project-Invocation
     const currentInvoke = getCurrentInvokeUuid();
     if (currentInvoke) {
-      res.setHeader(core.HTTP.HEADER.PROJECT.INVOCATION, currentInvoke);
+      res.set(core.HTTP.HEADER.PROJECT.INVOCATION, currentInvoke);
     }
 
     // X-Project-Key
     if (process.env.PROJECT_KEY) {
-      res.setHeader(core.HTTP.HEADER.PROJECT.KEY, process.env.PROJECT_KEY);
+      res.set(core.HTTP.HEADER.PROJECT.KEY, process.env.PROJECT_KEY);
     }
 
     // X-Project-Version
     if (version) {
-      res.setHeader(core.HTTP.HEADER.PROJECT.VERSION, version);
+      res.set(core.HTTP.HEADER.PROJECT.VERSION, version);
     }
 
     //
@@ -180,7 +180,6 @@ const expressHandler = (handler, options = {}) => {
   //
   // Validate
   //
-  /* eslint-disable no-autofix/prefer-const */
   let {
     locals,
     name,
@@ -189,7 +188,6 @@ const expressHandler = (handler, options = {}) => {
     unavailable,
     validate,
   } = options;
-  /* eslint-enable no-autofix/prefer-const */
   core.validate.function(handler);
   core.validate.optional.object(locals);
   setup = core.force.array(setup); // allows a single item
@@ -305,7 +303,6 @@ const expressHandler = (handler, options = {}) => {
             const key = keys[i];
             libLogger.trace(`[jaypie] Locals: ${key}`);
             if (typeof locals[key] === "function") {
-              // eslint-disable-next-line no-await-in-loop
               localsReq.locals[key] = await locals[key](localsReq, localsRes);
             } else {
               localsReq.locals[key] = locals[key];
@@ -392,6 +389,7 @@ const expressHandler = (handler, options = {}) => {
           } else if (typeof response === "string") {
             try {
               res.status(status).json(JSON.parse(response));
+              // eslint-disable-next-line no-unused-vars
             } catch (error) {
               res.status(status).send(response);
             }

package/dist/module.esm.js

@@ -58,7 +58,7 @@ const decorateResponse = (
   //
   if (typeof res !== "object" || res === null) {
     log$1.warn("decorateResponse called but response is not an object");
-    return; // eslint-disable-line no-useless-return
+    return;
   }
 
   try {
@@ -77,28 +77,28 @@ const decorateResponse = (
 
     // X-Project-Environment
     if (process.env.PROJECT_ENV) {
-      res.setHeader(HTTP.HEADER.PROJECT.ENVIRONMENT, process.env.PROJECT_ENV);
+      res.set(HTTP.HEADER.PROJECT.ENVIRONMENT, process.env.PROJECT_ENV);
     }
 
     // X-Project-Handler
     if (handler) {
-      res.setHeader(HTTP.HEADER.PROJECT.HANDLER, handler);
+      res.set(HTTP.HEADER.PROJECT.HANDLER, handler);
     }
 
     // X-Project-Invocation
     const currentInvoke = getCurrentInvokeUuid();
     if (currentInvoke) {
-      res.setHeader(HTTP.HEADER.PROJECT.INVOCATION, currentInvoke);
+      res.set(HTTP.HEADER.PROJECT.INVOCATION, currentInvoke);
     }
 
     // X-Project-Key
     if (process.env.PROJECT_KEY) {
-      res.setHeader(HTTP.HEADER.PROJECT.KEY, process.env.PROJECT_KEY);
+      res.set(HTTP.HEADER.PROJECT.KEY, process.env.PROJECT_KEY);
     }
 
     // X-Project-Version
     if (version) {
-      res.setHeader(HTTP.HEADER.PROJECT.VERSION, version);
+      res.set(HTTP.HEADER.PROJECT.VERSION, version);
     }
 
     //
@@ -178,7 +178,6 @@ const expressHandler = (handler, options = {}) => {
   //
   // Validate
   //
-  /* eslint-disable no-autofix/prefer-const */
   let {
     locals,
     name,
@@ -187,7 +186,6 @@ const expressHandler = (handler, options = {}) => {
     unavailable,
     validate: validate$1,
   } = options;
-  /* eslint-enable no-autofix/prefer-const */
   validate.function(handler);
   validate.optional.object(locals);
   setup = force.array(setup); // allows a single item
@@ -303,7 +301,6 @@ const expressHandler = (handler, options = {}) => {
             const key = keys[i];
             libLogger.trace(`[jaypie] Locals: ${key}`);
             if (typeof locals[key] === "function") {
-              // eslint-disable-next-line no-await-in-loop
               localsReq.locals[key] = await locals[key](localsReq, localsRes);
             } else {
               localsReq.locals[key] = locals[key];
@@ -390,6 +387,7 @@ const expressHandler = (handler, options = {}) => {
           } else if (typeof response === "string") {
             try {
               res.status(status).json(JSON.parse(response));
+              // eslint-disable-next-line no-unused-vars
             } catch (error) {
               res.status(status).send(response);
             }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@jaypie/express",
-  "version": "1.0.15",
+  "version": "1.1.1",
+  "license": "MIT",
   "author": "Finlayson Studio",
   "type": "module",
   "exports": {
@@ -17,18 +18,11 @@
     "format": "npm run format:package && npm run format:lint",
     "format:lint": "eslint --fix .",
     "format:package": "sort-package-json ./package.json",
-    "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",
     "prepublish": "npm run build",
-    "test": "vitest",
+    "test": "vitest run .",
     "test:spec:constants": "vitest run ./src/__tests__/constants.spec.js",
+    "test:spec:cors.helper": "vitest run ./src/__tests__/cors.helper.spec.js",
     "test:spec:decorateResponse.helper": "vitest run ./src/__tests__/decorateResponse.helper.spec.js",
     "test:spec:echo.handler": "vitest run ./src/__tests__/echo.handler.spec.js",
     "test:spec:expressHandler": "vitest run ./src/__tests__/expressHandler.spec.js",
@@ -42,23 +36,12 @@
   },
   "dependencies": {
     "@codegenie/serverless-express": "^4.15.0",
-    "@jaypie/core": "^1.0.44"
+    "@jaypie/core": "^1.1.0",
+    "@jaypie/errors": "^1.1.2",
+    "cors": "^2.8.5"
   },
-  "devDependencies": {
-    "@jaypie/testkit": "^1.0.29",
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "eslint": "^8.57.0",
-    "eslint-config-jaypie": "^1.0.7",
-    "express": "^4.19.2",
-    "hygen": "^6.2.11",
-    "jest-extended": "^4.0.2",
-    "mock-express-response": "^0.3.0",
-    "prettier": "^3.2.5",
-    "rollup": "^4.17.2",
-    "rollup-plugin-auto-external": "^2.0.0",
-    "sort-package-json": "^2.10.0",
-    "supertest": "^7.0.0",
-    "vitest": "^2.1.3"
-  }
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "878517b1552208902adeef5f6658c0a5c580c3fc"
 }

package/src/cors.helper.js

@@ -0,0 +1,86 @@
+import { CorsError } from "@jaypie/errors";
+import expressCors from "cors";
+
+//
+//
+// Constants
+//
+
+const DEFAULT_HEADERS = ["Authorization", "X-Session-Id"];
+const DEFAULT_METHODS = ["DELETE", "HEAD", "GET", "POST", "PUT"];
+const HTTP_PROTOCOL = "http://";
+const HTTPS_PROTOCOL = "https://";
+const SANDBOX_ENV = "sandbox";
+
+//
+//
+// Helper Functions
+//
+
+const ensureProtocol = (url) => {
+  if (!url) return url;
+  if (url.startsWith(HTTP_PROTOCOL) || url.startsWith(HTTPS_PROTOCOL))
+    return url;
+  return HTTPS_PROTOCOL + url;
+};
+
+//
+//
+// Main
+//
+
+const corsHelper = (config = {}) => {
+  const { origins, methods, headers, overrides = {} } = config;
+
+  const options = {
+    origin(origin, callback) {
+      // Handle wildcard origin
+      if (origins === "*") {
+        callback(null, true);
+        return;
+      }
+
+      // Allow requests with no origin (like mobile apps, curl, etc)
+      if (!origin) {
+        callback(null, true);
+        return;
+      }
+
+      const allowedOrigins = origins || [
+        ensureProtocol(process.env.BASE_URL),
+        ensureProtocol(process.env.PROJECT_BASE_URL),
+      ];
+
+      // Add localhost origins in sandbox
+      if (!origins && process.env.PROJECT_ENV === SANDBOX_ENV) {
+        allowedOrigins.push("http://localhost");
+        allowedOrigins.push(/^http:\/\/localhost:\d+$/);
+      }
+
+      const isAllowed = allowedOrigins.some((allowed) => {
+        if (allowed instanceof RegExp) {
+          return allowed.test(origin);
+        }
+        return origin.includes(allowed);
+      });
+
+      if (isAllowed) {
+        callback(null, true);
+      } else {
+        callback(new CorsError());
+      }
+    },
+    methods: [...DEFAULT_METHODS, ...(methods || [])],
+    allowedHeaders: [...DEFAULT_HEADERS, ...(headers || [])],
+    ...overrides,
+  };
+
+  return expressCors(options);
+};
+
+//
+//
+// Export
+//
+
+export default corsHelper;

package/src/decorateResponse.helper.js

@@ -20,7 +20,7 @@ const decorateResponse = (
   //
   if (typeof res !== "object" || res === null) {
     log.warn("decorateResponse called but response is not an object");
-    return; // eslint-disable-line no-useless-return
+    return;
   }
 
   try {
@@ -39,28 +39,28 @@ const decorateResponse = (
 
     // X-Project-Environment
     if (process.env.PROJECT_ENV) {
-      res.setHeader(HTTP.HEADER.PROJECT.ENVIRONMENT, process.env.PROJECT_ENV);
+      res.set(HTTP.HEADER.PROJECT.ENVIRONMENT, process.env.PROJECT_ENV);
     }
 
     // X-Project-Handler
     if (handler) {
-      res.setHeader(HTTP.HEADER.PROJECT.HANDLER, handler);
+      res.set(HTTP.HEADER.PROJECT.HANDLER, handler);
     }
 
     // X-Project-Invocation
     const currentInvoke = getCurrentInvokeUuid();
     if (currentInvoke) {
-      res.setHeader(HTTP.HEADER.PROJECT.INVOCATION, currentInvoke);
+      res.set(HTTP.HEADER.PROJECT.INVOCATION, currentInvoke);
     }
 
     // X-Project-Key
     if (process.env.PROJECT_KEY) {
-      res.setHeader(HTTP.HEADER.PROJECT.KEY, process.env.PROJECT_KEY);
+      res.set(HTTP.HEADER.PROJECT.KEY, process.env.PROJECT_KEY);
     }
 
     // X-Project-Version
     if (version) {
-      res.setHeader(HTTP.HEADER.PROJECT.VERSION, version);
+      res.set(HTTP.HEADER.PROJECT.VERSION, version);
     }
 
     //

package/src/expressHandler.js

@@ -30,7 +30,6 @@ const expressHandler = (handler, options = {}) => {
   //
   // Validate
   //
-  /* eslint-disable no-autofix/prefer-const */
   let {
     locals,
     name,
@@ -39,7 +38,6 @@ const expressHandler = (handler, options = {}) => {
     unavailable,
     validate,
   } = options;
-  /* eslint-enable no-autofix/prefer-const */
   validateIs.function(handler);
   validateIs.optional.object(locals);
   setup = force.array(setup); // allows a single item
@@ -155,7 +153,6 @@ const expressHandler = (handler, options = {}) => {
             const key = keys[i];
             libLogger.trace(`[jaypie] Locals: ${key}`);
             if (typeof locals[key] === "function") {
-              // eslint-disable-next-line no-await-in-loop
               localsReq.locals[key] = await locals[key](localsReq, localsRes);
             } else {
               localsReq.locals[key] = locals[key];
@@ -242,6 +239,7 @@ const expressHandler = (handler, options = {}) => {
           } else if (typeof response === "string") {
             try {
               res.status(status).json(JSON.parse(response));
+              // eslint-disable-next-line no-unused-vars
             } catch (error) {
               res.status(status).send(response);
             }

package/.eslintignore

@@ -1 +0,0 @@
-dist/