web_plsql 0.14.1 → 0.15.0

package/README.md

@@ -46,7 +46,7 @@ There are 2 options on how to use the web_plsql express middleware:
 
 The `startServer` api uses the following configuration object:
 
-```
+```typescript
 /**
  * @typedef {'basic' | 'debug'} errorStyleType
  */
@@ -58,13 +58,7 @@ The `startServer` api uses the following configuration object:
  */
 
 /**
- * @callback transactionCallbackType
- * @param {Request} req - Incoming request object.
- * @param {import('oracledb').Connection} connection - Active database connection pool.
- * @returns {void | Promise<void>}
- */
-
-/**
+ * @typedef {(connection: Connection, procedure: string) => void | Promise<void>} transactionCallbackType
  * @typedef {'commit' | 'rollback' | transactionCallbackType | undefined | null} transactionModeType
  */
 
@@ -101,6 +95,7 @@ The `startServer` api uses the following configuration object:
  * @property {number} port - The server port number.
  * @property {configStaticType[]} routeStatic - The static routes.
  * @property {configPlSqlType[]} routePlSql - The PL/SQL routes.
+ * @property {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
  * @property {string} loggerFilename - name of the request logger filename or '' if not required.
  */
 ```
@@ -134,7 +129,7 @@ The following mod_plsql DAD configuration translates to the configuration option
 ```
 
 **mod_plsql**
-```
+```typescript
 {
 	port: 80,
 	routeStatic: [
@@ -155,9 +150,11 @@ The following mod_plsql DAD configuration translates to the configuration option
 			requestValidationFunction: 'sample_pkg.request_validation_function', // PlsqlRequestValidationFunction
 			pathAlias: 'myalias', // PlsqlPathAlias
 			pathAliasProcedure: 'sample_pkg.page_path_alias', // PlsqlPathAliasProcedure
+			transactionMode: 'commit',
 			errorStyle: 'debug', // PlsqlErrorStyle
 		},
 	],
+	uploadFileSizeLimit: 50 * 1024 * 1024, // 50MB
 	loggerFilename: 'access.log', // PlsqlLogEnable and PlsqlLogDirectory
 }
 ```

package/examples/config-native.js

@@ -55,14 +55,12 @@ void startServer({
 			requestValidationFunction: 'sample_pkg.request_validation_function', // PlsqlRequestValidationFunction
 			pathAlias: 'myalias', // PlsqlPathAlias
 			pathAliasProcedure: 'sample_pkg.page_path_alias', // PlsqlPathAliasProcedure
-			transactionMode: 'commit',
-			/*
-			transactionMode: async (req, connection) => {
+			//transactionMode: 'commit',
+			transactionMode: async (connection, procedure) => {
 				if (await hasOpenTransaction(connection)) {
-					console.log(`We detected an open transaction in "${req.originalUrl}"`);
+					console.log(`We detected an open transaction in "${procedure}"`);
 				}
 			},
-			*/
 			errorStyle: 'debug', // PlsqlErrorStyle
 		},
 	],

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.14.1",
+	"version": "0.15.0",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -67,7 +67,7 @@
 		"morgan": "1.10.1",
 		"multer": "2.0.2",
 		"rotating-file-stream": "3.2.7",
-		"zod": "4.1.12"
+		"zod": "4.1.13"
 	},
 	"devDependencies": {
 		"@types/basic-auth": "1.1.8",
@@ -78,16 +78,15 @@
 		"@types/fs-extra": "11.0.4",
 		"@types/morgan": "1.9.10",
 		"@types/multer": "2.0.0",
-		"@types/node": "24.9.2",
+		"@types/node": "24.10.1",
 		"@types/oracledb": "6.10.0",
 		"@types/supertest": "6.0.3",
-		"eslint": "9.39.0",
-		"eslint-plugin-jsdoc": "61.1.11",
-		"prettier": "3.6.2",
-		"rimraf": "6.1.0",
+		"eslint": "9.39.1",
+		"eslint-plugin-jsdoc": "61.4.1",
+		"prettier": "3.7.1",
 		"shx": "0.4.0",
 		"supertest": "7.1.4",
 		"typescript": "5.9.3",
-		"typescript-eslint": "8.46.2"
+		"typescript-eslint": "8.48.0"
 	}
 }

package/src/handler/handlerUpload.js

@@ -1,4 +1,3 @@
-//import path from 'node:path';
 import multer from 'multer';
 
 /**
@@ -12,21 +11,14 @@ import multer from 'multer';
 
 /**
  * Create the upload middleware.
+ * @param {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
  * @returns {RequestHandler} - Request handler.
  */
-export const handlerUpload = () => {
+export const handlerUpload = (uploadFileSizeLimit = Infinity) => {
 	const upload = multer({
-		storage: multer.diskStorage({
-			/*
-			destination: '/tmp/webplsql',
-			filename: (req, file, cb) => {
-				const uniqueSuffix = `${Date.now()}-${Math.round(Math.random() * 1e9)}`;
-				cb(null, `${file.fieldname}-${uniqueSuffix}${path.extname(file.originalname)}`);
-			},
-			*/
-		}),
+		storage: multer.diskStorage({}),
 		limits: {
-			fileSize: 50 * 1024 * 1024, // 50MB limit
+			fileSize: uploadFileSizeLimit,
 		},
 	});
 

package/src/handler/plsql/request.js

@@ -31,18 +31,18 @@ import {isStringOrArrayOfString} from '../../util/type.js';
  * @returns {Promise<void>} - Promise resolving to th page
  */
 export const processRequest = async (req, res, options, connectionPool) => {
-	debug('executeRequest: ENTER');
+	debug('processRequest: ENTER');
 
 	// open database connection
 	const connection = await connectionPool.getConnection();
 
 	// Get the CGI
 	const cgiObj = getCGI(req, options.documentTable ?? '', options.cgi ?? {});
-	debug('executeRequest: cgiObj=', cgiObj);
+	debug('processRequest: cgiObj=', cgiObj);
 
 	// Does the request contain any files
 	const filesToUpload = getFiles(req);
-	debug('executeRequest: filesToUpload=', filesToUpload);
+	debug('processRequest: filesToUpload=', filesToUpload);
 
 	// Add the query properties
 	/** @type {argObjType} */
@@ -57,7 +57,7 @@ export const processRequest = async (req, res, options, connectionPool) => {
 
 	// Does the request contain a body
 	Object.assign(argObj, normalizeBody(req));
-	debug('executeRequest: argObj=', argObj);
+	debug('processRequest: argObj=', argObj);
 
 	// invoke the Oracle procedure and get the page contenst
 	await invokeProcedure(req, res, argObj, cgiObj, filesToUpload, options, connection);
@@ -68,7 +68,7 @@ export const processRequest = async (req, res, options, connectionPool) => {
 		await connection.rollback();
 	} else if (typeof options.transactionMode === 'function') {
 		debug('transactionMode: callback');
-		const result = options.transactionMode(req, connection);
+		const result = options.transactionMode(connection, req.params.name);
 		debug('transactionMode: callback restult', result);
 		if (result && typeof result.then === 'function') {
 			await result;
@@ -81,7 +81,7 @@ export const processRequest = async (req, res, options, connectionPool) => {
 	// close database connection
 	await connection.release();
 
-	debug('executeRequest: EXIT');
+	debug('processRequest: EXIT');
 };
 
 /**

package/src/server/config.js

@@ -16,6 +16,7 @@ export const showConfig = (config) => {
 
 	console.log(`Server port:            ${config.port}`);
 	console.log(`Access log:             ${config.loggerFilename.length > 0 ? config.loggerFilename : ''}`);
+	console.log(`Upload file size limit: ${typeof config.uploadFileSizeLimit === 'number' ? `${config.uploadFileSizeLimit} bytes` : 'any'}`);
 
 	if (config.routeStatic.length > 0) {
 		console.log(LINE);

package/src/server/server.js

@@ -85,9 +85,9 @@ export const startServer = async (config, ssl) => {
 	}
 
 	// Default middleware
-	app.use(handlerUpload());
-	app.use(express.json());
-	app.use(express.urlencoded({extended: true}));
+	app.use(handlerUpload(internalConfig.uploadFileSizeLimit));
+	app.use(express.json({limit: '50mb'}));
+	app.use(express.urlencoded({limit: '50mb', extended: true}));
 	app.use(cookieParser());
 	app.use(compression());
 

package/src/types.js

@@ -23,7 +23,7 @@ export const z$configStaticType = z.strictObject({
 });
 
 /**
- * @typedef {(req: Request, connection: Connection) => void | Promise<void>} transactionCallbackType
+ * @typedef {(connection: Connection, procedure: string) => void | Promise<void>} transactionCallbackType
  * @typedef {'commit' | 'rollback' | transactionCallbackType | undefined | null} transactionModeType
  */
 
@@ -36,7 +36,7 @@ export const z$configStaticType = z.strictObject({
  * @property {string[]} [exclusionList] - The exclusion list.
  * @property {string} [requestValidationFunction] - The request validation function.
  * @property {Record<string, string>} [cgi] - The additional CGI.
- * @property {transactionModeType} [transactionMode='commit'] - Specifies an optional transaction mode.
+ * @property {transactionModeType} [transactionMode] - Specifies an optional transaction mode.
  * "commit" this automatically commits any open transaction after each request. This is the defaults because this is what mod_plsql and ohs are doing.
  * "rollback" this automatically rolles back any open transaction after each request.
  * "transactionCallbackType" this allows to defined a custom handler as a JavaScript function.
@@ -80,12 +80,14 @@ export const z$configPlSqlType = z.strictObject({
  * @property {number} port - The server port number.
  * @property {configStaticType[]} routeStatic - The static routes.
  * @property {configPlSqlType[]} routePlSql - The PL/SQL routes.
+ * @property {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
  * @property {string} loggerFilename - name of the request logger filename or '' if not required.
  */
 export const z$configType = z.strictObject({
 	port: z.number(),
 	routeStatic: z.array(z$configStaticType),
 	routePlSql: z.array(z$configPlSqlType),
+	uploadFileSizeLimit: z.number().optional(),
 	loggerFilename: z.string(),
 });
 

package/src/util/type.js

@@ -1,5 +1,3 @@
-/* eslint-disable jsdoc/no-undefined-types */
-
 /**
  *	Is the given value a string or an array of strings
  *	@param {unknown} value - The value to check.

package/types/handler/handlerUpload.d.ts

@@ -1,4 +1,4 @@
-export function handlerUpload(): RequestHandler;
+export function handlerUpload(uploadFileSizeLimit?: number): RequestHandler;
 export type RequestHandler = import("express").RequestHandler;
 export type Response = import("express").Response;
 export type NextFunction = import("express").NextFunction;

package/types/types.d.ts

@@ -21,7 +21,7 @@ export const z$configStaticType: z.ZodObject<{
     directoryPath: z.ZodString;
 }, z.core.$strict>;
 /**
- * @typedef {(req: Request, connection: Connection) => void | Promise<void>} transactionCallbackType
+ * @typedef {(connection: Connection, procedure: string) => void | Promise<void>} transactionCallbackType
  * @typedef {'commit' | 'rollback' | transactionCallbackType | undefined | null} transactionModeType
  */
 /**
@@ -33,7 +33,7 @@ export const z$configStaticType: z.ZodObject<{
  * @property {string[]} [exclusionList] - The exclusion list.
  * @property {string} [requestValidationFunction] - The request validation function.
  * @property {Record<string, string>} [cgi] - The additional CGI.
- * @property {transactionModeType} [transactionMode='commit'] - Specifies an optional transaction mode.
+ * @property {transactionModeType} [transactionMode] - Specifies an optional transaction mode.
  * "commit" this automatically commits any open transaction after each request. This is the defaults because this is what mod_plsql and ohs are doing.
  * "rollback" this automatically rolles back any open transaction after each request.
  * "transactionCallbackType" this allows to defined a custom handler as a JavaScript function.
@@ -90,6 +90,7 @@ export const z$configPlSqlType: z.ZodObject<{
  * @property {number} port - The server port number.
  * @property {configStaticType[]} routeStatic - The static routes.
  * @property {configPlSqlType[]} routePlSql - The PL/SQL routes.
+ * @property {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
  * @property {string} loggerFilename - name of the request logger filename or '' if not required.
  */
 export const z$configType: z.ZodObject<{
@@ -115,6 +116,7 @@ export const z$configType: z.ZodObject<{
             debug: "debug";
         }>;
     }, z.core.$strict>>;
+    uploadFileSizeLimit: z.ZodOptional<z.ZodNumber>;
     loggerFilename: z.ZodString;
 }, z.core.$strict>;
 export type BindParameter = import("oracledb").BindParameter;
@@ -132,7 +134,7 @@ export type configStaticType = {
      */
     directoryPath: string;
 };
-export type transactionCallbackType = (req: Request, connection: Connection) => void | Promise<void>;
+export type transactionCallbackType = (connection: Connection, procedure: string) => void | Promise<void>;
 export type transactionModeType = "commit" | "rollback" | transactionCallbackType | undefined | null;
 export type configPlSqlHandlerType = {
     /**
@@ -207,6 +209,10 @@ export type configType = {
      * - The PL/SQL routes.
      */
     routePlSql: configPlSqlType[];
+    /**
+     * - Maximum size of each uploaded file in bytes or no limit if omitted.
+     */
+    uploadFileSizeLimit?: number;
     /**
      * - name of the request logger filename or '' if not required.
      */