@flink-app/management-actions-plugin 0.12.1-alpha.9 → 0.13.1

package/.flink/generatedHandlers.ts

@@ -0,0 +1,8 @@
+// Generated Sat Jan 10 2026 11:13:33 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 Sat Jan 10 2026 11:13:33 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 Sat Jan 10 2026 11:13:33 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 Sat Jan 10 2026 11:13:33 GMT+0100 (Central European Standard Time)

package/.flink/start.ts

@@ -0,0 +1,6 @@
+// Generated Sat Jan 10 2026 11:13:33 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/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/package.json

@@ -1,30 +1,27 @@
 {
-    "name": "@flink-app/management-actions-plugin",
-    "version": "0.12.1-alpha.9",
-    "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",
-        "prepare": "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.9",
-        "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/management-actions-plugin",
+  "version": "0.13.1",
+  "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/index.d.ts",
+  "main": "dist/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/*"],