@technomoron/api-server-base 2.0.0-beta.22 → 2.0.0-beta.24

package/dist/cjs/api-module.cjs

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiModule = void 0;
+/** Base class for feature modules mounted into {@link ApiServer}. */
 class ApiModule {
+    /** The server instance this module is mounted on. */
     get server() {
         if (this._server === undefined) {
             throw new Error('ApiModule.server is not set. Mount the module with ApiServer.api(...) before using it.');
@@ -15,12 +17,18 @@ class ApiModule {
         this.mountpath = '';
         this.namespace = opts.namespace ?? this.constructor.defaultNamespace ?? '';
     }
+    /** Optional pre-mount configuration validation hook. */
     checkConfig() {
         return true;
     }
+    /** Return all routes exposed by this module. */
     defineRoutes() {
         return [];
     }
+    /** Optional mount-time hook for modules that need direct server integration. */
+    onMount() {
+        return;
+    }
 }
 exports.ApiModule = ApiModule;
 ApiModule.defaultNamespace = '';

package/dist/cjs/api-module.d.ts

@@ -17,17 +17,29 @@ export type ApiRoute = {
         type: ApiAuthType;
         req: ApiAuthClass;
     };
+    schema?: {
+        body?: Record<string, unknown>;
+        querystring?: Record<string, unknown>;
+        params?: Record<string, unknown>;
+    };
 };
+/** Base class for feature modules mounted into {@link ApiServer}. */
 export declare class ApiModule<T = unknown> {
     private _server?;
+    /** The server instance this module is mounted on. */
     get server(): T;
     set server(value: T);
+    /** Route namespace under `apiBasePath`. */
     namespace: string;
     mountpath: string;
     static defaultNamespace: string;
     constructor(opts?: {
         namespace?: string;
     });
+    /** Optional pre-mount configuration validation hook. */
     checkConfig(): boolean;
+    /** Return all routes exposed by this module. */
     defineRoutes(): ApiRoute[];
+    /** Optional mount-time hook for modules that need direct server integration. */
+    onMount(): void;
 }