Merge pull request #21 from Linkurious/LKE-14938-post-metadata

LKE-14938: Post metadata to the parent process

Author: gmasclet

.nvmrc

@@ -1 +1 @@
-20.12.1
+24.14.1

package-lock.json

@@ -11,7 +11,7 @@
     "url": "git+https://github.com/Linkurious/lke-plugin-webhook-manager.git"
   },
   "engines": {
-    "node": "20.12.1"
+    "node": "24.14.1"
   },
   "author": "Linkurious",
   "scripts": {
@@ -51,7 +51,7 @@
   "devDependencies": {
     "@linkurious/rest-client": "4.3.5",
     "@types/express": "4.17.3",
-    "@types/node": "20.12.1",
+    "@types/node": "24.12.0",
     "@typescript-eslint/eslint-plugin": "7.14.1",
     "acorn": "8.8.1",
     "esbuild": "0.16.17",

package.json

@@ -1,5 +1,20 @@
-import {PluginConfig as PluginConfigBase} from '@linkurious/rest-client';
+import {PluginConfig, PluginRouteOptions as PluginRouteOptionsBase} from '@linkurious/rest-client';
 
-export interface PluginConfig extends PluginConfigBase {
-  //no additional parameters required
+export interface PluginRouteOptions extends PluginRouteOptionsBase<PluginConfig> {
+  parentProcess?: PluginParentProcess;
+}
+
+export interface PluginParentProcess {
+  postMetadata(metadata: PluginMetadata): void;
+}
+
+export interface PluginMetadata {
+  actions: PluginAction[];
+}
+
+export interface PluginAction {
+  name: string;
+  urlTemplate: string;
+  sourceKey?: string;
+  access: 'admin' | '*';
 }

src/@types/plugin.d.ts

@@ -1,15 +1,11 @@
 import express = require('express');
-import {NextFunction, Request, Response} from 'express';
-import {PluginRouteOptions} from '@linkurious/rest-client';
 
-import {PluginConfig} from '../@types/plugin';
+import {PluginRouteOptions} from '../@types/plugin';
 
 import {loggerFormatter, parseLinkuriousAPI} from './shared';
 import {PluginError, UnauthorizedPluginError} from './exceptions';
 
-export = async function configureRoutes(
-  options: PluginRouteOptions<PluginConfig> & {serverRootFolder?: string}
-): Promise<void> {
+export = function configureRoutes(options: PluginRouteOptions): void {
   console.log = loggerFormatter(console.log);
   console.warn = loggerFormatter(console.warn);
   console.info = loggerFormatter(console.info);
@@ -18,26 +14,6 @@ export = async function configureRoutes(
 
   options.router.use(express.json());
 
-  function respond(
-    promiseFunction: (
-      req: express.Request,
-      res: express.Response,
-      next: express.NextFunction
-    ) => Promise<void> | void
-  ): express.RequestHandler {
-    return (req, res, next) => {
-      Promise.resolve(promiseFunction(req, res, next)).catch((e) => {
-        if (e instanceof PluginError) {
-          res.status(e.getHttpResponseCode()).json({error: e.name, message: e.message});
-        } else if (e instanceof Error) {
-          res.status(500).json({error: e.name, message: e.message});
-        } else {
-          res.status(500).json(JSON.stringify(e));
-        }
-      });
-    };
-  }
-
   options.router.use(
     respond(async (req, res, next) => {
       const restClient = options.getRestClient(req);
@@ -63,4 +39,34 @@ export = async function configureRoutes(
       res.sendStatus(204);
     })
   );
+
+  options.parentProcess?.postMetadata({
+    actions: [
+      {
+        name: 'Manage webhooks',
+        urlTemplate: `/`,
+        access: 'admin'
+      }
+    ]
+  });
 };
+
+function respond(
+  promiseFunction: (
+    req: express.Request,
+    res: express.Response,
+    next: express.NextFunction
+  ) => Promise<void> | void
+): express.RequestHandler {
+  return (req, res, next) => {
+    Promise.resolve(promiseFunction(req, res, next)).catch((e) => {
+      if (e instanceof PluginError) {
+        res.status(e.getHttpResponseCode()).json({error: e.name, message: e.message});
+      } else if (e instanceof Error) {
+        res.status(500).json({error: e.name, message: e.message});
+      } else {
+        res.status(500).json(JSON.stringify(e));
+      }
+    });
+  };
+}