@jaypie/express 1.1.0 → 1.1.2

package/dist/module.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+var errors = require('@jaypie/errors');
+var expressCors = require('cors');
 var core = require('@jaypie/core');
 var serverlessExpress = require('@codegenie/serverless-express');
 
@@ -16,6 +18,83 @@ const EXPRESS = {
   },
 };
 
+//
+//
+// 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 errors.CorsError());
+      }
+    },
+    methods: [...DEFAULT_METHODS, ...(methods || [])],
+    allowedHeaders: [...DEFAULT_HEADERS, ...(headers || [])],
+    ...overrides,
+  };
+
+  return expressCors(options);
+};
+
 //
 //
 // Helper Functions
@@ -548,6 +627,7 @@ const {
 
 exports.EXPRESS = EXPRESS;
 exports.badRequestRoute = badRequestRoute;
+exports.cors = corsHelper;
 exports.echoRoute = echoRoute;
 exports.expressHandler = expressHandler;
 exports.expressHttpCodeHandler = httpHandler;

package/dist/module.esm.js

@@ -1,3 +1,5 @@
+import { CorsError } from '@jaypie/errors';
+import expressCors from 'cors';
 import { log, JAYPIE, HTTP, validate, force, jaypieHandler, UnhandledError, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, MethodNotAllowedError, GoneError, TeapotError, InternalError, BadGatewayError, UnavailableError, GatewayTimeoutError, NotImplementedError } from '@jaypie/core';
 import { getCurrentInvoke } from '@codegenie/serverless-express';
 
@@ -14,6 +16,83 @@ const EXPRESS = {
   },
 };
 
+//
+//
+// 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);
+};
+
 //
 //
 // Helper Functions
@@ -544,4 +623,4 @@ const {
   notImplementedRoute,
 } = routes;
 
-export { EXPRESS, badRequestRoute, echoRoute, expressHandler, httpHandler as expressHttpCodeHandler, forbiddenRoute, goneRoute, methodNotAllowedRoute, noContentRoute, notFoundRoute, notImplementedRoute };
+export { EXPRESS, badRequestRoute, corsHelper as cors, echoRoute, expressHandler, httpHandler as expressHttpCodeHandler, forbiddenRoute, goneRoute, methodNotAllowedRoute, noContentRoute, notFoundRoute, notImplementedRoute };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/express",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "license": "MIT",
   "author": "Finlayson Studio",
   "type": "module",
@@ -22,6 +22,7 @@
     "prepublish": "npm run build",
     "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",
@@ -35,10 +36,12 @@
   },
   "dependencies": {
     "@codegenie/serverless-express": "^4.15.0",
-    "@jaypie/core": "^1.1.0"
+    "@jaypie/core": "^1.1.0",
+    "@jaypie/errors": "^1.1.2",
+    "cors": "^2.8.5"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b6847fa8b061594bd899c2e098822dad198e51"
+  "gitHead": "ec672a9713d9e81e70e93988933e97b853cc1432"
 }

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/index.js

@@ -1,4 +1,5 @@
 export { EXPRESS } from "./constants.js";
+export { default as cors } from "./cors.helper.js";
 export { default as expressHandler } from "./expressHandler.js";
 export { default as expressHttpCodeHandler } from "./http.handler.js";
 export * from "./routes.js";