@technomoron/api-server-base 2.0.0-beta.16 → 2.0.0-beta.17

package/README.txt

@@ -102,6 +102,7 @@ apiBasePath (string, default '/api') Prefix applied to every module namespace.
 origins (string array, default empty array) CORS allowlist; empty allows all origins.
 uploadPath (string, default empty string) Enables multer.any() when provided.
 uploadMax (number, default 30 * 1024 * 1024) Maximum upload size in bytes.
+staticDirs (record, default empty object) Map of mount path => disk path for serving static files as-is (ex: { '/assets': './public' }).
 accessSecret (string, default empty string) Required for JWT signing and verification.
 refreshSecret (string, default empty string) Used for refresh tokens if you implement them.
 cookieDomain (string, default '.somewhere-over-the-rainbow.com') Domain applied to auth cookies.

package/dist/cjs/api-server-base.cjs

@@ -343,6 +343,7 @@ function fillConfig(config) {
         apiHost: config.apiHost ?? 'localhost',
         uploadPath: config.uploadPath ?? '',
         uploadMax: config.uploadMax ?? 30 * 1024 * 1024,
+        staticDirs: config.staticDirs,
         origins: config.origins ?? [],
         debug: config.debug ?? false,
         apiBasePath: config.apiBasePath ?? '/api',
@@ -399,6 +400,7 @@ class ApiServer {
             this.app.use(upload.any());
         }
         this.middlewares();
+        this.installStaticDirs();
         this.installPingHandler();
         this.installSwaggerHandler();
         // addSwaggerUi(this.app);
@@ -656,6 +658,21 @@ class ApiServer {
         };
         this.app.use((0, cors_1.default)(corsOptions));
     }
+    installStaticDirs() {
+        const staticDirs = this.config.staticDirs;
+        if (!staticDirs || !isPlainObject(staticDirs)) {
+            return;
+        }
+        for (const [mountRaw, dirRaw] of Object.entries(staticDirs)) {
+            const mount = typeof mountRaw === 'string' ? mountRaw.trim() : '';
+            const dir = typeof dirRaw === 'string' ? dirRaw.trim() : '';
+            if (!mount || !dir) {
+                continue;
+            }
+            const resolvedMount = mount.startsWith('/') ? mount : `/${mount}`;
+            this.app.use(resolvedMount, express_1.default.static(dir));
+        }
+    }
     installPingHandler() {
         const path = `${this.apiBasePath}/v1/ping`;
         this.app.get(path, (_req, res) => {

package/dist/cjs/api-server-base.d.ts

@@ -92,6 +92,7 @@ export interface ApiServerConf {
     apiHost: string;
     uploadPath: string;
     uploadMax: number;
+    staticDirs?: Record<string, string>;
     origins: string[];
     debug: boolean;
     apiBasePath: string;
@@ -193,6 +194,7 @@ export declare class ApiServer {
     guessExceptionText(error: unknown, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
+    private installStaticDirs;
     private installPingHandler;
     private loadSwaggerSpec;
     private installSwaggerHandler;

package/dist/esm/api-server-base.d.ts

@@ -92,6 +92,7 @@ export interface ApiServerConf {
     apiHost: string;
     uploadPath: string;
     uploadMax: number;
+    staticDirs?: Record<string, string>;
     origins: string[];
     debug: boolean;
     apiBasePath: string;
@@ -193,6 +194,7 @@ export declare class ApiServer {
     guessExceptionText(error: unknown, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
+    private installStaticDirs;
     private installPingHandler;
     private loadSwaggerSpec;
     private installSwaggerHandler;

package/dist/esm/api-server-base.js

@@ -335,6 +335,7 @@ function fillConfig(config) {
         apiHost: config.apiHost ?? 'localhost',
         uploadPath: config.uploadPath ?? '',
         uploadMax: config.uploadMax ?? 30 * 1024 * 1024,
+        staticDirs: config.staticDirs,
         origins: config.origins ?? [],
         debug: config.debug ?? false,
         apiBasePath: config.apiBasePath ?? '/api',
@@ -391,6 +392,7 @@ export class ApiServer {
             this.app.use(upload.any());
         }
         this.middlewares();
+        this.installStaticDirs();
         this.installPingHandler();
         this.installSwaggerHandler();
         // addSwaggerUi(this.app);
@@ -648,6 +650,21 @@ export class ApiServer {
         };
         this.app.use(cors(corsOptions));
     }
+    installStaticDirs() {
+        const staticDirs = this.config.staticDirs;
+        if (!staticDirs || !isPlainObject(staticDirs)) {
+            return;
+        }
+        for (const [mountRaw, dirRaw] of Object.entries(staticDirs)) {
+            const mount = typeof mountRaw === 'string' ? mountRaw.trim() : '';
+            const dir = typeof dirRaw === 'string' ? dirRaw.trim() : '';
+            if (!mount || !dir) {
+                continue;
+            }
+            const resolvedMount = mount.startsWith('/') ? mount : `/${mount}`;
+            this.app.use(resolvedMount, express.static(dir));
+        }
+    }
     installPingHandler() {
         const path = `${this.apiBasePath}/v1/ping`;
         this.app.get(path, (_req, res) => {

package/docs/swagger/openapi.json

@@ -2,7 +2,7 @@
 	"openapi": "3.1.0",
 	"info": {
 		"title": "API Server Base",
-		"version": "2.0.0-beta.16",
+		"version": "2.0.0-beta.17",
 		"description": "OpenAPI reference for ApiServer base endpoints and optional modules. Auth, passkey, and oauth modules are optional and require the corresponding module to be enabled in the ApiServer config. Base endpoints are always available."
 	},
 	"servers": [

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@technomoron/api-server-base",
-	"version": "2.0.0-beta.16",
+	"version": "2.0.0-beta.17",
 	"description": "Api Server Skeleton / Base Class",
 	"type": "module",
 	"main": "./dist/cjs/index.cjs",
@@ -84,15 +84,15 @@
 		"@types/bcryptjs": "^2.4.6",
 		"@types/express-serve-static-core": "^5.1.0",
 		"@types/supertest": "^6.0.3",
-		"@typescript-eslint/eslint-plugin": "^8.50.1",
-		"@typescript-eslint/parser": "^8.50.1",
+		"@typescript-eslint/eslint-plugin": "^8.54.0",
+		"@typescript-eslint/parser": "^8.54.0",
 		"eslint": "^9.39.2",
 		"eslint-config-prettier": "^10.1.8",
 		"eslint-plugin-import": "^2.32.0",
-		"jsonc-eslint-parser": "^2.4.1",
+		"jsonc-eslint-parser": "^2.4.2",
 		"mysql2": "^3.16.0",
 		"pg": "^8.16.3",
-		"prettier": "^3.7.4",
+		"prettier": "^3.8.1",
 		"sequelize": "^6.37.7",
 		"sqlite3": "^5.1.7",
 		"supertest": "^7.1.4",
@@ -130,5 +130,5 @@
 		"docs/swagger/openapi.json",
 		"package.json"
 	],
-	"packageManager": "pnpm@10.27.0+sha512.72d699da16b1179c14ba9e64dc71c9a40988cbdc65c264cb0e489db7de917f20dcf4d64d8723625f2969ba52d4b7e2a1170682d9ac2a5dcaeaab732b7e16f04a"
+	"packageManager": "pnpm@10.28.2"
 }