@degenerate/endpoints 0.0.1

package/LICENSE.md

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) [2024] [Degenerateiinc.ca]
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @Degenerate/<new-package-name> Package
+
+This package contains the functions for <new-package-name>.  The package <what-the-purpose-of-the-package-is> in the SAFE environment.

package/dist/cors/errors/all-error-handler.d.ts

@@ -0,0 +1,12 @@
+import { NextFunction, Request } from 'express';
+import { BaseError } from '@degenerate/generic';
+/**
+ * This is used to handle all errors. It is the last error handler in the chain.
+ *
+ * @param err the error
+ * @param req the incoming request
+ * @param res the response
+ * @param next the next function
+ */
+export declare function allErrorHandler(err: BaseError, req: Request, res: any, next: NextFunction): void;
+//# sourceMappingURL=all-error-handler.d.ts.map

package/dist/cors/errors/all-error-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"all-error-handler.d.ts","sourceRoot":"","sources":["../../../src/cors/errors/all-error-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,SAAS,EAAoB,MAAM,qBAAqB,CAAC;AAElE;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC3B,GAAG,EAAE,SAAS,EACd,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,YAAY,GACnB,IAAI,CAON"}

package/dist/cors/errors/all-error-handler.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allErrorHandler = allErrorHandler;
+/**
+ * This is used to handle all errors. It is the last error handler in the chain.
+ *
+ * @param err the error
+ * @param req the incoming request
+ * @param res the response
+ * @param next the next function
+ */
+function allErrorHandler(err, req, res, next) {
+    console.error(err);
+    const genericResponse = {
+        successful: false,
+        error: 'An error occurred. That is all we know.',
+    };
+    return res.status(err.errorCode || 500).send(genericResponse);
+}

package/dist/cors/errors/bad-request-handler.d.ts

@@ -0,0 +1,12 @@
+import { NextFunction } from 'express';
+/**
+ * bad request moddleware handler
+ *
+ * @param err the error
+ * @param req the incoming request
+ * @param res the response
+ * @param next next function
+ * @returns
+ */
+export declare function badRequestHandler(err: any, req: any, res: any, next: NextFunction): any;
+//# sourceMappingURL=bad-request-handler.d.ts.map

package/dist/cors/errors/bad-request-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bad-request-handler.d.ts","sourceRoot":"","sources":["../../../src/cors/errors/bad-request-handler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGvC;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,OAWjF"}

package/dist/cors/errors/bad-request-handler.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.badRequestHandler = badRequestHandler;
+const generic_1 = require("@degenerate/generic");
+/**
+ * bad request moddleware handler
+ *
+ * @param err the error
+ * @param req the incoming request
+ * @param res the response
+ * @param next next function
+ * @returns
+ */
+function badRequestHandler(err, req, res, next) {
+    if (err instanceof generic_1.BaseError && err.errorCode === 400) {
+        console.error(err.toJSON());
+        const response = {
+            successful: false,
+            error: 'Bad Request',
+        };
+        return res.status(400).send(response);
+    }
+    next(err);
+    return;
+}

package/dist/cors/errors/unauthorized-handler.d.ts

@@ -0,0 +1,12 @@
+import { NextFunction } from 'express';
+/**
+ * This is used to handle unauthorized requests in the middleware
+ *
+ * @param err the error
+ * @param req the incoming request
+ * @param res the response
+ * @param next the next function
+ * @returns
+ */
+export declare function unauthorizedHandler(err: any, req: any, res: any, next: NextFunction): any;
+//# sourceMappingURL=unauthorized-handler.d.ts.map

package/dist/cors/errors/unauthorized-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unauthorized-handler.d.ts","sourceRoot":"","sources":["../../../src/cors/errors/unauthorized-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,OAWnF"}

package/dist/cors/errors/unauthorized-handler.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unauthorizedHandler = unauthorizedHandler;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const generic_1 = require("@degenerate/generic");
+/**
+ * This is used to handle unauthorized requests in the middleware
+ *
+ * @param err the error
+ * @param req the incoming request
+ * @param res the response
+ * @param next the next function
+ * @returns
+ */
+function unauthorizedHandler(err, req, res, next) {
+    if (err instanceof generic_1.BaseError && err.errorCode === 403) {
+        console.error(err.toJSON());
+        const response = {
+            successful: false,
+            error: 'Unauthorized',
+        };
+        return res.status(403).send(response);
+    }
+    next(err);
+    return;
+}

package/dist/cors/index.d.ts

@@ -0,0 +1,4 @@
+export * from './errors/all-error-handler';
+export * from './errors/bad-request-handler';
+export * from './errors/unauthorized-handler';
+//# sourceMappingURL=index.d.ts.map

package/dist/cors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cors/index.ts"],"names":[],"mappings":"AACA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC"}

package/dist/cors/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//#region cors functions
+__exportStar(require("./errors/all-error-handler"), exports);
+__exportStar(require("./errors/bad-request-handler"), exports);
+__exportStar(require("./errors/unauthorized-handler"), exports);
+//#endregion cors functions

package/dist/index.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";
+// This is the main file for the package

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@degenerate/endpoints",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.9.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "scripts": {
+    "build": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "compile": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "test": "jest --forceExit --detectOpenHandles --verbose --silent=false --env node --config tsconfig.pkg.json",
+    "test:coverage": "jest --forceExit --coverage --detectOpenHandles --verbose --silent=false --env node  --config tsconfig.pkg.json",
+    "test:clearCache": "jest --clearCache"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/syncrude/safe.git"
+  },
+  "keywords": [
+    "ShareData Adaptive Framework Ecosystem",
+    "SAFE",
+    "SAFE Endpoints",
+    "ShareData",
+    "ShareBlock",
+    "SAFE RESTful API",
+    "SAFE Websockets",
+    "SAFE RxJS",
+    "SAFE Observables"
+  ],
+  "bugs": {
+    "url": "https://github.com/syncrude/safe/issues"
+  },
+  "homepage": "https://github.com/syncrude/safe#readme",
+  "author": "Degenerate Inc.",
+  "license": "ISC",
+  "dependencies": {
+    "@degenerate/generic": "^0.1.3"
+  }
+}