@ruiapp/rapid-core 0.9.6 → 0.9.7

package/dist/core/routes/healthz.d.ts

@@ -0,0 +1,12 @@
+import { ActionHandlerContext } from "../actionHandler";
+declare const _default: {
+    namespace: string;
+    name: string;
+    code: string;
+    type: "RESTful";
+    method: "GET";
+    endpoint: string;
+    handler: typeof handler;
+};
+export default _default;
+export declare function handler(ctx: ActionHandlerContext): Promise<void>;

package/dist/core/routes/index.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    namespace: string;
+    name: string;
+    code: string;
+    type: "RESTful";
+    method: "GET";
+    endpoint: string;
+    handler: typeof import("./healthz").handler;
+}[];
+export default _default;

package/dist/index.js

@@ -1032,18 +1032,38 @@ async function buildRoutes(server, applicationConfig) {
                 input,
             };
             await server.beforeRunRouteActions(handlerContext);
-            for (const actionConfig of routeConfig.actions) {
-                const actionCode = actionConfig.code;
-                const handler = server.getActionHandlerByCode(actionCode);
-                if (!handler) {
-                    throw new Error("Unknown handler: " + actionCode);
+            let handler = routeConfig.handler;
+            if (handler) {
+                if (lodash.isString(handler)) {
+                    handler = new Function(`return (${routeConfig.handler})`);
                 }
-                await server.beforeRunActionHandler(handlerContext, actionConfig);
-                const result = handler(handlerContext, actionConfig.config);
-                if (result instanceof Promise) {
-                    await result;
+                if (lodash.isFunction(handler)) {
+                    const result = handler(handlerContext);
+                    if (result instanceof Promise) {
+                        await result;
+                    }
+                }
+                else {
+                    throw new Error(`Invalid handler for route ${routeConfig.code}: ${routeConfig.handler}`);
                 }
             }
+            else if (routeConfig.actions) {
+                for (const actionConfig of routeConfig.actions) {
+                    const actionCode = actionConfig.code;
+                    const handler = server.getActionHandlerByCode(actionCode);
+                    if (!handler) {
+                        throw new Error("Unknown handler: " + actionCode);
+                    }
+                    await server.beforeRunActionHandler(handlerContext, actionConfig);
+                    const result = handler(handlerContext, actionConfig.config);
+                    if (result instanceof Promise) {
+                        await result;
+                    }
+                }
+            }
+            else {
+                throw new Error(`No handler or actions defined for route ${routeConfig.code}`);
+            }
             if (!isNullOrUndefined(handlerContext.output)) {
                 routerContext.json(handlerContext.output, handlerContext.status);
             }
@@ -3963,6 +3983,21 @@ class EntityManager {
     }
 }
 
+var healthz = {
+    namespace: "sys",
+    name: "sys.healthz",
+    code: "sys.healthz",
+    type: "RESTful",
+    method: "GET",
+    endpoint: "/healthz",
+    handler: handler$x,
+};
+async function handler$x(ctx) {
+    ctx.output = {};
+}
+
+var coreRoutes = [healthz];
+
 class RapidServer {
     #logger;
     #facilityFactories;
@@ -4237,7 +4272,12 @@ class RapidServer {
                 this.#entityBeforeResponseEventEmitters.on(entityWatcher.modelSingularCode, entityWatcher.handler);
             }
         }
+        this.#applicationConfig = lodash.cloneDeep(this.#bootstrapApplicationConfig);
+        this.appendApplicationConfig({
+            routes: coreRoutes,
+        });
         await this.configureApplication();
+        this.#buildedRoutes = await buildRoutes(this, this.#applicationConfig);
         if (!this.#disableCronJobs) {
             await pluginManager.registerCronJobs();
         }
@@ -4245,7 +4285,6 @@ class RapidServer {
         await pluginManager.onApplicationReady(this.#applicationConfig);
     }
     async configureApplication() {
-        this.#applicationConfig = lodash.cloneDeep(this.#bootstrapApplicationConfig);
         const pluginManager = this.#pluginManager;
         await pluginManager.onLoadingApplication(this.#applicationConfig);
         await pluginManager.configureModels(this.#applicationConfig);
@@ -4254,7 +4293,6 @@ class RapidServer {
         await pluginManager.configureRoutes(this.#applicationConfig);
         // TODO: check application configuration.
         await pluginManager.onApplicationLoaded(this.#applicationConfig);
-        this.#buildedRoutes = await buildRoutes(this, this.#applicationConfig);
     }
     registerFacilityFactory(factory) {
         this.#facilityFactories.set(factory.name, factory);

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { ActionHandlerContext } from "./core/actionHandler";
 import { RouteContext } from "./core/routeContext";
 import { IRpdServer, RapidPlugin } from "./core/server";
 import { ColumnSelectOptions, CountRowOptions, FindRowOptions, RowFilterOptions } from "./dataAccess/dataAccessTypes";
@@ -483,6 +484,7 @@ export interface RpdRoute {
     method: RpdHttpMethod;
     endpoint: string;
     actions?: RpdRouteActionConfig[];
+    handler?: string | ((ctx: ActionHandlerContext) => Promise<void>);
 }
 export type RpdHttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
 export interface RpdRouteActionConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.9.6",
+  "version": "0.9.7",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/core/routes/healthz.ts

@@ -0,0 +1,20 @@
+import { RpdRoute } from "~/types";
+import { ActionHandlerContext } from "../actionHandler";
+
+export default {
+  namespace: "sys",
+  name: "sys.healthz",
+  code: "sys.healthz",
+  type: "RESTful",
+  method: "GET",
+  endpoint: "/healthz",
+  handler,
+} satisfies RpdRoute;
+
+export async function handler(ctx: ActionHandlerContext) {
+  const { server, input, routerContext: routeContext, logger } = ctx;
+  const { response } = routeContext;
+  const {} = input;
+
+  ctx.output = {};
+}

package/src/core/routes/index.ts

@@ -0,0 +1,3 @@
+import healthz from "./healthz";
+
+export default [healthz];

package/src/core/routesBuilder.ts

@@ -5,7 +5,7 @@ import { IRpdServer } from "~/core/server";
 import { RpdApplicationConfig } from "~/types";
 import { isNullOrUndefined } from "~/utilities/typeUtility";
 import { Next, RouteContext } from "./routeContext";
-import { cloneDeep } from "lodash";
+import { cloneDeep, isFunction, isString } from "lodash";
 
 export async function buildRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig) {
   const logger = server.getLogger();
@@ -67,19 +67,37 @@ export async function buildRoutes(server: IRpdServer, applicationConfig: RpdAppl
 
       await server.beforeRunRouteActions(handlerContext);
 
-      for (const actionConfig of routeConfig.actions) {
-        const actionCode = actionConfig.code;
-        const handler = server.getActionHandlerByCode(actionCode);
-        if (!handler) {
-          throw new Error("Unknown handler: " + actionCode);
+      let handler = routeConfig.handler as any;
+      if (handler) {
+        if (isString(handler)) {
+          handler = new Function(`return (${routeConfig.handler})`) as any;
         }
 
-        await server.beforeRunActionHandler(handlerContext, actionConfig);
-
-        const result = handler(handlerContext, actionConfig.config);
-        if (result instanceof Promise) {
-          await result;
+        if (isFunction(handler)) {
+          const result = handler(handlerContext);
+          if (result instanceof Promise) {
+            await result;
+          }
+        } else {
+          throw new Error(`Invalid handler for route ${routeConfig.code}: ${routeConfig.handler}`);
+        }
+      } else if (routeConfig.actions) {
+        for (const actionConfig of routeConfig.actions) {
+          const actionCode = actionConfig.code;
+          const handler = server.getActionHandlerByCode(actionCode);
+          if (!handler) {
+            throw new Error("Unknown handler: " + actionCode);
+          }
+
+          await server.beforeRunActionHandler(handlerContext, actionConfig);
+
+          const result = handler(handlerContext, actionConfig.config);
+          if (result instanceof Promise) {
+            await result;
+          }
         }
+      } else {
+        throw new Error(`No handler or actions defined for route ${routeConfig.code}`);
       }
 
       if (!isNullOrUndefined(handlerContext.output)) {

package/src/server.ts

@@ -35,6 +35,7 @@ import { bind, cloneDeep, find, forEach, isString, merge, omit } from "lodash";
 import { Logger } from "./facilities/log/LogFacility";
 import { FacilityFactory } from "./core/facility";
 import { CronJobConfiguration } from "./types/cron-job-types";
+import coreRoutes from "./core/routes";
 
 export interface InitServerOptions {
   logger: Logger;
@@ -367,7 +368,12 @@ export class RapidServer implements IRpdServer {
       }
     }
 
+    this.#applicationConfig = cloneDeep(this.#bootstrapApplicationConfig) as RpdApplicationConfig;
+    this.appendApplicationConfig({
+      routes: coreRoutes,
+    });
     await this.configureApplication();
+    this.#buildedRoutes = await buildRoutes(this, this.#applicationConfig);
 
     if (!this.#disableCronJobs) {
       await pluginManager.registerCronJobs();
@@ -378,8 +384,6 @@ export class RapidServer implements IRpdServer {
   }
 
   async configureApplication() {
-    this.#applicationConfig = cloneDeep(this.#bootstrapApplicationConfig) as RpdApplicationConfig;
-
     const pluginManager = this.#pluginManager;
     await pluginManager.onLoadingApplication(this.#applicationConfig);
     await pluginManager.configureModels(this.#applicationConfig);
@@ -390,8 +394,6 @@ export class RapidServer implements IRpdServer {
     // TODO: check application configuration.
 
     await pluginManager.onApplicationLoaded(this.#applicationConfig);
-
-    this.#buildedRoutes = await buildRoutes(this, this.#applicationConfig);
   }
 
   registerFacilityFactory(factory: FacilityFactory) {

package/src/types.ts

@@ -1,3 +1,4 @@
+import { ActionHandlerContext } from "./core/actionHandler";
 import { RouteContext } from "./core/routeContext";
 import { IRpdServer, RapidPlugin } from "./core/server";
 import { ColumnSelectOptions, CountRowOptions, FindRowOptions, RowFilterOptions } from "./dataAccess/dataAccessTypes";
@@ -586,6 +587,7 @@ export interface RpdRoute {
   method: RpdHttpMethod;
   endpoint: string;
   actions?: RpdRouteActionConfig[];
+  handler?: string | ((ctx: ActionHandlerContext) => Promise<void>);
 }
 
 export type RpdHttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";