@flink-app/management-actions-plugin 0.12.1-alpha.7 → 0.13.0

package/.flink/generatedHandlers.ts

@@ -0,0 +1,8 @@
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+import { autoRegisteredHandlers, HttpMethod } from "@flink-app/flink";
+import * as Get_0 from "../src/handlers/Get";
+import * as PostById_0 from "../src/handlers/PostById";
+
+export const handlers = [];
+autoRegisteredHandlers.push(...handlers);
+    

package/.flink/generatedJobs.ts

@@ -0,0 +1,5 @@
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+import { autoRegisteredJobs } from "@flink-app/flink";
+export const jobs = [];
+autoRegisteredJobs.push(...jobs);
+    

package/.flink/generatedRepos.ts

@@ -0,0 +1,5 @@
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+  import { autoRegisteredRepos } from "@flink-app/flink";
+  export const repos = [];
+  autoRegisteredRepos.push(...repos);
+      

package/.flink/schemas/schemas.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Schemas",
+  "definitions": {}
+}

package/.flink/schemas/schemas.ts

@@ -0,0 +1 @@
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)

package/.flink/start.ts

@@ -0,0 +1,6 @@
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+import "./generatedHandlers";
+import "./generatedRepos";
+import "./generatedJobs";
+import "../src/index";
+export default {}; // Export an empty object to make it a module

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @flink-app/management-actions-plugin
+
+## 0.13.0
+
+### Minor Changes
+
+-   Migrate to pnpm and streamlines build process.
+
+### Patch Changes
+
+-   Updated dependencies
+    -   @flink-app/management-api-plugin@0.13.0
+    -   @flink-app/flink@0.13.0

package/dist/.flink/generatedHandlers.d.ts

@@ -0,0 +1 @@
+export declare const handlers: never[];

package/dist/.flink/generatedHandlers.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlers = void 0;
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.handlers = [];
+flink_1.autoRegisteredHandlers.push.apply(flink_1.autoRegisteredHandlers, exports.handlers);

package/dist/.flink/generatedJobs.d.ts

@@ -0,0 +1 @@
+export declare const jobs: never[];

package/dist/.flink/generatedJobs.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jobs = void 0;
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.jobs = [];
+flink_1.autoRegisteredJobs.push.apply(flink_1.autoRegisteredJobs, exports.jobs);

package/dist/.flink/generatedRepos.d.ts

@@ -0,0 +1 @@
+export declare const repos: never[];

package/dist/.flink/generatedRepos.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.repos = void 0;
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.repos = [];
+flink_1.autoRegisteredRepos.push.apply(flink_1.autoRegisteredRepos, exports.repos);

package/dist/.flink/schemas/schemas.js

@@ -0,0 +1,2 @@
+"use strict";
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)

package/dist/.flink/schemas/schemas.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/Schemas",
+    "definitions": {}
+}

package/dist/.flink/start.d.ts

@@ -0,0 +1,6 @@
+import "./generatedHandlers";
+import "./generatedRepos";
+import "./generatedJobs";
+import "../src/index";
+declare const _default: {};
+export default _default;

package/dist/.flink/start.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Generated Fri Jan 09 2026 11:18:15 GMT+0100 (Central European Standard Time)
+require("./generatedHandlers");
+require("./generatedRepos");
+require("./generatedJobs");
+require("../src/index");
+exports.default = {}; // Export an empty object to make it a module

package/dist/handlers/Get.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    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.");

package/dist/handlers/PostById.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    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.");

package/dist/src/handlers/Get.d.ts

@@ -0,0 +1,5 @@
+import { FlinkContext, Handler } from "@flink-app/flink";
+import { ActionView } from "../schemas/Action";
+declare const getHandler: Handler<FlinkContext, any, ActionView[]>;
+export default getHandler;
+export declare const __assumedHttpMethod = "get", __file = "Get.ts", __query: never[], __params: never[];

package/dist/src/handlers/Get.js

@@ -0,0 +1,69 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = void 0;
+var getHandler = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var modules, module, actions, data;
+    var _c, _d;
+    var ctx = _b.ctx, req = _b.req, origin = _b.origin;
+    return __generator(this, function (_e) {
+        modules = ctx.plugins.managementApi.moduleList.modules;
+        module = modules.find(function (p) { return p.id == origin; });
+        if (((_c = module.data) === null || _c === void 0 ? void 0 : _c.actions) == null) {
+            return [2 /*return*/, {
+                    data: [],
+                    status: 200,
+                }];
+        }
+        actions = (_d = module.data) === null || _d === void 0 ? void 0 : _d.actions;
+        data = actions.map(function (a) {
+            var av = {
+                id: a.id,
+                description: a.description,
+                arguments: a.arguments,
+            };
+            return av;
+        });
+        return [2 /*return*/, {
+                data: data,
+                status: 200,
+            }];
+    });
+}); };
+exports.default = getHandler;
+exports.__assumedHttpMethod = "get", exports.__file = "Get.ts", exports.__query = [], exports.__params = [];

package/dist/src/handlers/PostById.d.ts

@@ -0,0 +1,5 @@
+import { FlinkContext, Handler } from "@flink-app/flink";
+import { ActionArgumentsValues, ActionResponse } from "../schemas/Action";
+declare const postHandler: Handler<FlinkContext, ActionArgumentsValues, ActionResponse>;
+export default postHandler;
+export declare const __assumedHttpMethod = "post", __file = "PostById.ts", __query: never[], __params: never[];

package/dist/src/handlers/PostById.js

@@ -0,0 +1,93 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = void 0;
+var flink_1 = require("@flink-app/flink");
+var Action_1 = require("../schemas/Action");
+var postHandler = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var modules, module, actions, action, i, arg, resp, ex_1;
+    var _c;
+    var ctx = _b.ctx, req = _b.req, origin = _b.origin;
+    return __generator(this, function (_d) {
+        switch (_d.label) {
+            case 0:
+                modules = ctx.plugins.managementApi.moduleList.modules;
+                module = modules.find(function (p) { return p.id == origin; });
+                if (((_c = module.data) === null || _c === void 0 ? void 0 : _c.actions) == null) {
+                    return [2 /*return*/, (0, flink_1.notFound)("Action not found")];
+                }
+                actions = module.data.actions;
+                action = actions.find(function (a) { return a.id == req.params.actionId; });
+                if (action == null) {
+                    return [2 /*return*/, (0, flink_1.notFound)("Action not found")];
+                }
+                for (i in action.arguments) {
+                    arg = action.arguments[i];
+                    if (arg.required) {
+                        if (req.body[arg.id] == null) {
+                            return [2 /*return*/, (0, flink_1.badRequest)("".concat(arg.id, " is missing "))];
+                        }
+                    }
+                }
+                _d.label = 1;
+            case 1:
+                _d.trys.push([1, 3, , 4]);
+                return [4 /*yield*/, action.handler(ctx, req.body)];
+            case 2:
+                resp = _d.sent();
+                if (resp.status == Action_1.ActionReturnStatus.success) {
+                    return [2 /*return*/, {
+                            data: resp,
+                            status: 200,
+                        }];
+                }
+                else {
+                    return [2 /*return*/, (0, flink_1.internalServerError)(resp.error)];
+                }
+                return [3 /*break*/, 4];
+            case 3:
+                ex_1 = _d.sent();
+                console.log("EXCEPTIOIN managementActionsPlugin:");
+                console.log(ex_1);
+                return [2 /*return*/, (0, flink_1.internalServerError)()];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+exports.default = postHandler;
+exports.__assumedHttpMethod = "post", exports.__file = "PostById.ts", exports.__query = [], exports.__params = [];

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+import { ManagementApiModule } from "@flink-app/management-api-plugin";
+import { Action } from "./schemas/Action";
+export interface GetManagementModuleConfig {
+    pluginId?: string;
+    ui: boolean;
+    uiSettings?: {
+        title: string;
+    };
+    actions: Action[];
+}
+export declare const GetManagementModule: (config: GetManagementModuleConfig) => ManagementApiModule;

package/dist/src/index.js

@@ -0,0 +1,69 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetManagementModule = void 0;
+var management_api_plugin_1 = require("@flink-app/management-api-plugin");
+var flink_1 = require("@flink-app/flink");
+var postHandler = __importStar(require("./handlers/PostById"));
+var getHandler = __importStar(require("./handlers/Get"));
+var GetManagementModule = function (config) {
+    var _a;
+    if (config.pluginId == null)
+        config.pluginId = "managementActionsApi";
+    var endpoints = [];
+    endpoints.push({
+        routeProps: {
+            path: "/:actionId",
+            method: flink_1.HttpMethod.post,
+            origin: config.pluginId,
+        },
+        handler: postHandler,
+    });
+    endpoints.push({
+        routeProps: {
+            path: "",
+            method: flink_1.HttpMethod.get,
+            origin: config.pluginId,
+        },
+        handler: getHandler,
+    });
+    var features = [];
+    var module = {
+        id: config.pluginId || "action",
+        uiSettings: {
+            title: ((_a = config.uiSettings) === null || _a === void 0 ? void 0 : _a.title) || "Actions",
+            icon: "",
+            features: features,
+        },
+        ui: config.ui,
+        type: management_api_plugin_1.ManagementApiType.action,
+        endpoints: endpoints,
+        data: {
+            actions: config.actions,
+        },
+    };
+    return module;
+};
+exports.GetManagementModule = GetManagementModule;

package/dist/src/schemas/Action.d.ts

@@ -0,0 +1,35 @@
+import { FlinkContext } from "@flink-app/flink";
+export interface Action {
+    id: string;
+    description?: string;
+    arguments: ActionArguments[];
+    handler(ctx: FlinkContext<any>, args: ActionArgumentsValues): Promise<ActionResponse>;
+}
+export interface ActionArgumentsValues {
+    [key: string]: any;
+}
+export interface ActionResponse {
+    status: ActionReturnStatus;
+    error?: string;
+    data?: {
+        [key: string]: any;
+    };
+}
+export declare enum ActionReturnStatus {
+    success = "SUCCESS",
+    error = "ERROR"
+}
+export interface ActionArguments {
+    id: string;
+    required: boolean;
+    type: ActionArugmentType;
+    default?: string;
+}
+export declare enum ActionArugmentType {
+    text = "TEXT"
+}
+export interface ActionView {
+    id: string;
+    description?: string;
+    arguments: ActionArguments[];
+}

package/dist/src/schemas/Action.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionArugmentType = exports.ActionReturnStatus = void 0;
+var ActionReturnStatus;
+(function (ActionReturnStatus) {
+    ActionReturnStatus["success"] = "SUCCESS";
+    ActionReturnStatus["error"] = "ERROR";
+})(ActionReturnStatus || (exports.ActionReturnStatus = ActionReturnStatus = {}));
+var ActionArugmentType;
+(function (ActionArugmentType) {
+    ActionArugmentType["text"] = "TEXT";
+})(ActionArugmentType || (exports.ActionArugmentType = ActionArugmentType = {}));

package/package.json

@@ -1,30 +1,27 @@
 {
-    "name": "@flink-app/management-actions-plugin",
-    "version": "0.12.1-alpha.7",
-    "description": "Flink plugin that makes it possible create actions that can be run trought the management-api",
-    "scripts": {
-        "test": "echo \"Error: no test specified\"",
-        "build": "flink build",
-        "prepublish": "tsc"
-    },
-    "author": "johan@frost.se",
-    "publishConfig": {
-        "access": "public"
-    },
-    "license": "MIT",
-    "types": "dist/src/index.d.ts",
-    "main": "dist/src/index.js",
-    "dependencies": {
-        "@flink-app/management-api-plugin": "^0.12.1-alpha.7",
-        "express": "^4.17.1",
-        "node-color-log": "^5.3.1"
-    },
-    "devDependencies": {
-        "@flink-app/flink": "^0.12.1-alpha.7",
-        "@types/express": "4.17.11",
-        "@types/node": "22.13.10",
-        "ts-node": "^9.1.1",
-        "typescript": "5.4.5"
-    },
-    "gitHead": "cd86dec5f9b3bf23c01374a729bb02d8a48c2869"
-}
+  "name": "@flink-app/management-actions-plugin",
+  "version": "0.13.0",
+  "description": "Flink plugin that makes it possible create actions that can be run trought the management-api",
+  "author": "johan@frost.se",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "types": "dist/src/index.d.ts",
+  "main": "dist/src/index.js",
+  "dependencies": {
+    "node-color-log": "^5.3.1",
+    "@flink-app/flink": "0.13.0",
+    "@flink-app/management-api-plugin": "0.13.0"
+  },
+  "devDependencies": {
+    "@types/node": "22.13.10",
+    "ts-node": "^10.9.2"
+  },
+  "gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
+  "scripts": {
+    "test": "echo \"Error: no test specified\"",
+    "build": "flink build",
+    "clean": "rimraf dist .flink"
+  }
+}

package/readme.md

@@ -1,66 +1,385 @@
-# Flink API Docs
+# @flink-app/management-actions-plugin
 
-A FLINK management-api module that makes it possible to expose actions that can be executed via the management-api, and thereby also via flink-admin.
+A Flink management API module that enables you to create and execute custom actions through the management API. This plugin integrates with `@flink-app/management-api-plugin` to expose server-side actions that can be triggered via HTTP requests.
 
-## Prerequisite 
-Flink management-api-plugin must be installed and configured to your project.
+## Features
 
-## Usage
+- Define custom server-side actions with arguments
+- Execute actions through the management API
+- Type-safe argument handling
+- Built-in UI support for management interfaces
+- Flexible response handling with success/error states
+- List all available actions via API
 
-Install plugin to your flink app project:
+## Prerequisites
 
-```
-npm i -S @flink-app/management-actions-plugin
+This plugin requires `@flink-app/management-api-plugin` to be installed and configured in your Flink application.
+
+```bash
+npm install @flink-app/management-api-plugin
 ```
 
-Add and configure plugin in your app startup (probable the `index.ts` in root project):
+## Installation
 
+```bash
+npm install @flink-app/management-actions-plugin
 ```
-import { GetManagementModule as GetActionsManagmenetModule } from '@flink-app/management-actions-plugin'
 
-const actionsManagementModule = GetActionsManagmenetModule({
-    ui: true,
-    uiSettings: {
-        title: 'Actions',
-    },
-    actions : [
-      {
-        id: 'hello-world',
-        description: 'Greets you',
-        arguments: [
-            {
-                id: 'name',
-                type: ActionArugmentType.text,
-                required: true,
-            },
-        ],
-        async handler(ctx: FlinkContext<any>, args: ActionArgumentsValues): Promise<ActionResponse> {
-            
-            return {
-                data: {
-                    message: 'Hello ' + args.name,
-                },
-                status: ActionReturnStatus.success,
-            }
+## Usage
+
+### Basic Setup
+
+```typescript
+import { FlinkApp } from "@flink-app/flink";
+import { managementApiPlugin } from "@flink-app/management-api-plugin";
+import {
+  GetManagementModule,
+  ActionArugmentType,
+  ActionReturnStatus,
+} from "@flink-app/management-actions-plugin";
+
+const actionsModule = GetManagementModule({
+  ui: true,
+  uiSettings: {
+    title: "Actions",
+  },
+  actions: [
+    {
+      id: "hello-world",
+      description: "Greets you with a personalized message",
+      arguments: [
+        {
+          id: "name",
+          type: ActionArugmentType.text,
+          required: true,
         },
+      ],
+      async handler(ctx, args) {
+        return {
+          data: {
+            message: "Hello " + args.name,
+          },
+          status: ActionReturnStatus.success,
+        };
+      },
     },
-    
-    ]
-})
-
+  ],
+});
 
 function start() {
   new FlinkApp<AppContext>({
     name: "My app",
     plugins: [
-        // Register plugin
-        managementApiPlugin({
-          token : "SECRET_TOKEN_USED_TO_COMMUNICATE_WITH_THE_API",
-          jwtSecret : "JWT_SECRET_USED_TO_GENERATE_LOGGED_IN_TOKENS",
-          modules : [actionsManagementModule] // <-- Add the module
-        })
+      managementApiPlugin({
+        token: "SECRET_TOKEN",
+        jwtSecret: "JWT_SECRET",
+        modules: [actionsModule],
+      }),
     ],
   }).start();
 }
+```
+
+## Action Definition
+
+Each action requires the following properties:
+
+### Action Interface
+
+```typescript
+interface Action {
+  id: string; // Unique identifier for the action
+  description?: string; // Human-readable description
+  arguments: ActionArguments[]; // Array of input arguments
+  handler: (ctx: FlinkContext<any>, args: ActionArgumentsValues) => Promise<ActionResponse>;
+}
+```
+
+### Action Arguments
+
+```typescript
+interface ActionArguments {
+  id: string; // Argument identifier
+  required: boolean; // Whether the argument is required
+  type: ActionArugmentType; // Argument type
+  default?: string; // Optional default value
+}
+
+enum ActionArugmentType {
+  text = "TEXT",
+}
+```
+
+### Action Response
+
+```typescript
+interface ActionResponse {
+  status: ActionReturnStatus; // SUCCESS or ERROR
+  error?: string; // Error message (if status is ERROR)
+  data?: {
+    [key: string]: any; // Response data (if status is SUCCESS)
+  };
+}
+
+enum ActionReturnStatus {
+  success = "SUCCESS",
+  error = "ERROR",
+}
+```
+
+## API Endpoints
+
+The plugin exposes two endpoints for each actions module:
+
+### List Actions
+
+```
+GET /managementapi/{pluginId}
+```
+
+Returns a list of all available actions with their configurations.
+
+**Response:**
+```json
+[
+  {
+    "id": "hello-world",
+    "description": "Greets you with a personalized message",
+    "arguments": [
+      {
+        "id": "name",
+        "type": "TEXT",
+        "required": true
+      }
+    ]
+  }
+]
+```
+
+### Execute Action
+
+```
+POST /managementapi/{pluginId}/{actionId}
+```
+
+Executes a specific action with provided arguments.
+
+**Headers:**
+```
+management-token: YOUR_TOKEN_OR_JWT
+```
+
+**Request Body:**
+```json
+{
+  "name": "World"
+}
+```
+
+**Response:**
+```json
+{
+  "status": "SUCCESS",
+  "data": {
+    "message": "Hello World"
+  }
+}
+```
+
+## Advanced Examples
+
+### Action with Multiple Arguments
+
+```typescript
+{
+  id: "create-user",
+  description: "Creates a new user in the system",
+  arguments: [
+    {
+      id: "username",
+      type: ActionArugmentType.text,
+      required: true,
+    },
+    {
+      id: "email",
+      type: ActionArugmentType.text,
+      required: true,
+    },
+    {
+      id: "role",
+      type: ActionArugmentType.text,
+      required: false,
+      default: "user",
+    },
+  ],
+  async handler(ctx, args) {
+    try {
+      const user = await ctx.repos.userRepo.create({
+        username: args.username,
+        email: args.email,
+        role: args.role,
+      });
+
+      return {
+        status: ActionReturnStatus.success,
+        data: { userId: user._id },
+      };
+    } catch (error) {
+      return {
+        status: ActionReturnStatus.error,
+        error: error.message,
+      };
+    }
+  },
+}
+```
 
+### Action with Database Access
+
+```typescript
+{
+  id: "cleanup-old-records",
+  description: "Removes records older than 30 days",
+  arguments: [],
+  async handler(ctx, args) {
+    try {
+      const cutoffDate = new Date();
+      cutoffDate.setDate(cutoffDate.getDate() - 30);
+
+      const result = await ctx.repos.recordRepo.deleteMany({
+        createdAt: { $lt: cutoffDate },
+      });
+
+      return {
+        status: ActionReturnStatus.success,
+        data: {
+          deletedCount: result.deletedCount,
+          message: `Removed ${result.deletedCount} old records`,
+        },
+      };
+    } catch (error) {
+      return {
+        status: ActionReturnStatus.error,
+        error: `Failed to cleanup records: ${error.message}`,
+      };
+    }
+  },
+}
+```
+
+### Action with External API Call
+
+```typescript
+{
+  id: "sync-data",
+  description: "Syncs data from external service",
+  arguments: [
+    {
+      id: "service",
+      type: ActionArugmentType.text,
+      required: true,
+    },
+  ],
+  async handler(ctx, args) {
+    try {
+      const response = await fetch(`https://api.example.com/${args.service}`);
+      const data = await response.json();
+
+      // Process and store data
+      await ctx.repos.dataRepo.create(data);
+
+      return {
+        status: ActionReturnStatus.success,
+        data: {
+          recordsImported: data.length,
+          service: args.service,
+        },
+      };
+    } catch (error) {
+      return {
+        status: ActionReturnStatus.error,
+        error: `Sync failed: ${error.message}`,
+      };
+    }
+  },
+}
 ```
+
+## Configuration Options
+
+### GetManagementModule Options
+
+```typescript
+interface GetManagementModuleConfig {
+  pluginId?: string; // Custom plugin ID (defaults to "managementActionsApi")
+  ui: boolean; // Enable UI features
+  uiSettings?: {
+    title: string; // Display title in management UI
+  };
+  actions: Action[]; // Array of actions to register
+}
+```
+
+## Context Access
+
+Action handlers receive the full Flink context, providing access to:
+
+- `ctx.repos` - All registered repositories
+- `ctx.db` - MongoDB database connection
+- `ctx.plugins` - All plugin contexts
+- Any other context properties from your application
+
+## Security
+
+All action endpoints are protected by the management API authentication system. Ensure you:
+
+- Use the management token header for all requests
+- Validate and sanitize action arguments
+- Implement proper error handling
+- Avoid exposing sensitive data in responses
+- Log action executions for audit purposes
+
+## Testing Actions
+
+You can test your actions using curl or any HTTP client:
+
+```bash
+# Get list of actions
+curl 'https://your-api.com/managementapi/managementActionsApi' \
+  -H 'management-token: YOUR_TOKEN'
+
+# Execute an action
+curl -X POST 'https://your-api.com/managementapi/managementActionsApi/hello-world' \
+  -H 'management-token: YOUR_TOKEN' \
+  -H 'Content-Type: application/json' \
+  -d '{"name":"World"}'
+```
+
+## TypeScript Support
+
+The plugin is written in TypeScript and provides full type definitions for all interfaces and enums.
+
+## Error Handling
+
+Always return proper error responses from action handlers:
+
+```typescript
+async handler(ctx, args) {
+  try {
+    // Your action logic
+    return {
+      status: ActionReturnStatus.success,
+      data: { /* your data */ },
+    };
+  } catch (error) {
+    return {
+      status: ActionReturnStatus.error,
+      error: error instanceof Error ? error.message : "Unknown error",
+    };
+  }
+}
+```
+
+## License
+
+MIT

package/tsconfig.json

@@ -15,7 +15,7 @@
     "noEmit": false,
     "declaration": true,
     "experimentalDecorators": true,
-    "checkJs": true,
+    "checkJs": false,
     "outDir": "dist"
   },
   "include": ["./src/*"],