@flink-app/generic-request-plugin 0.12.1-alpha.9 → 0.13.1

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @flink-app/generic-request-plugin
+
+## 0.13.0
+
+### Minor Changes
+
+-   Migrate to pnpm and streamlines build process.
+
+### Patch Changes
+
+-   Updated dependencies
+    -   @flink-app/flink@0.13.0

package/dist/index.d.ts

@@ -18,5 +18,11 @@ export type GenericRequestOptions = {
      * Http method for this request
      */
     method: HttpMethod;
+    /**
+     * Optional permission(s) required to access this route.
+     * If set, the auth plugin will validate the request before calling the handler.
+     * Requires an auth plugin (e.g., jwt-auth-plugin) to be configured in FlinkApp.
+     */
+    permissions?: string | string[];
 };
 export declare const genericRequestPlugin: (options: GenericRequestOptions) => FlinkPlugin;

package/dist/index.js

@@ -1,4 +1,40 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -20,12 +56,39 @@ var genericRequestPlugin = function (options) {
 };
 exports.genericRequestPlugin = genericRequestPlugin;
 function init(app, options) {
+    var _this = this;
     var expressApp = app.expressApp;
     if (!expressApp) {
         throw new Error("Express app not initialized");
     }
-    expressApp[options.method](options.path, function (req, res) {
-        options.handler(req, res, app);
-    });
+    expressApp[options.method](options.path, function (req, res) { return __awaiter(_this, void 0, void 0, function () {
+        var authenticated;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!options.permissions) return [3 /*break*/, 2];
+                    if (!app.auth) {
+                        throw new Error("Route ".concat(options.method.toUpperCase(), " ").concat(options.path, " requires permissions but no auth plugin is configured"));
+                    }
+                    return [4 /*yield*/, app.auth.authenticateRequest(req, options.permissions)];
+                case 1:
+                    authenticated = _a.sent();
+                    if (!authenticated) {
+                        return [2 /*return*/, res.status(401).json({
+                                status: 401,
+                                error: {
+                                    title: "Unauthorized",
+                                    detail: "Authentication required or insufficient permissions",
+                                },
+                            })];
+                    }
+                    _a.label = 2;
+                case 2:
+                    // Call the handler
+                    options.handler(req, res, app);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
     node_color_log_1.default.info("Registered genericRequest route ".concat(options.method, " ").concat(options.path));
 }

package/package.json

@@ -1,28 +1,26 @@
 {
-    "name": "@flink-app/generic-request-plugin",
-    "version": "0.12.1-alpha.9",
-    "description": "Flink plugin that makes it possible to override default request handlers and handle specific requests manually",
-    "scripts": {
-        "test": "echo \"Error: no test specified\"",
-        "prepare": "tsc"
-    },
-    "author": "johan@frost.se",
-    "publishConfig": {
-        "access": "public"
-    },
-    "license": "MIT",
-    "types": "dist/index.d.ts",
-    "main": "dist/index.js",
-    "dependencies": {
-        "express": "^4.17.1",
-        "node-color-log": "^5.3.1"
-    },
-    "devDependencies": {
-        "@flink-app/flink": "^0.12.1-alpha.9",
-        "@types/express": "4.17.11",
-        "@types/node": "22.13.10",
-        "ts-node": "^9.1.1",
-        "typescript": "5.4.5"
-    },
-    "gitHead": "3007ad036607014176930446fde56203bde8d6f5"
-}
+  "name": "@flink-app/generic-request-plugin",
+  "version": "0.13.1",
+  "description": "Flink plugin that makes it possible to override default request handlers and handle specific requests manually",
+  "author": "johan@frost.se",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "dependencies": {
+    "node-color-log": "^5.3.1",
+    "@flink-app/flink": "0.13.0"
+  },
+  "devDependencies": {
+    "@types/jasmine": "^3.7.1",
+    "@types/node": "22.13.10"
+  },
+  "gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
+  "scripts": {
+    "test": "jasmine-ts --config=./spec/support/jasmine.json",
+    "build": "tsc --project tsconfig.dist.json",
+    "clean": "rimraf dist .flink"
+  }
+}