web_plsql 0.17.0 → 0.17.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.17.0",
+	"version": "0.17.1",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -47,7 +47,8 @@
 		"test": "node --test --test-concurrency=1 \"./tests/**/*.test.js\"",
 		"types": "rm -rf types && tsc  --noEmit false --declaration true --declarationDir types --emitDeclarationOnly true --allowJs true --target es2020 --module es2020 --moduleResolution node --allowSyntheticDefaultImports true src/*.js",
 		"clean": "shx rm -f *.tgz && shx rm -f *.log",
-		"ci": "npm run clean && npm run lint && npm run test && npm run types",
+		"ci": "npm run clean && npm run version && npm run lint && npm run test && npm run types",
+		"version": "node update-version.js",
 		"create-package": "shx rm -f *.tgz && npm pack",
 		"image-build": "docker build --no-cache --progress=plain --tag=web_plsql .",
 		"image-save": "docker save web_plsql | gzip > web_plsql.tar.gz"
@@ -56,7 +57,6 @@
 		"oracledb": "6.10.0"
 	},
 	"dependencies": {
-		"basic-auth": "2.0.1",
 		"compression": "1.8.1",
 		"cookie-parser": "1.4.7",
 		"debug": "4.4.3",
@@ -64,25 +64,25 @@
 		"http-parser-js": "0.5.10",
 		"morgan": "1.10.1",
 		"multer": "2.0.2",
-		"rotating-file-stream": "3.2.7",
+		"rotating-file-stream": "3.2.8",
 		"zod": "4.3.6"
 	},
 	"devDependencies": {
-		"@types/basic-auth": "1.1.8",
 		"@types/compression": "1.8.1",
 		"@types/cookie-parser": "1.4.10",
 		"@types/debug": "4.1.12",
 		"@types/morgan": "1.9.10",
 		"@types/multer": "2.0.0",
-		"@types/node": "25.0.10",
+		"@types/node": "25.2.0",
 		"@types/oracledb": "6.10.1",
 		"@types/supertest": "6.0.3",
 		"eslint": "9.39.2",
-		"eslint-plugin-jsdoc": "62.4.1",
+		"eslint-plugin-jsdoc": "62.5.1",
+		"oracledb": "6.10.0",
 		"prettier": "3.8.1",
 		"shx": "0.4.0",
 		"supertest": "7.2.2",
 		"typescript": "5.9.3",
-		"typescript-eslint": "8.53.1"
+		"typescript-eslint": "8.54.0"
 	}
 }

package/src/handler/plsql/cgi.js

@@ -109,7 +109,7 @@ export const getCGI = (req, doctable, cgi) => {
 	const CGI = {
 		SERVER_PORT: typeof req.socket.localPort === 'number' ? req.socket.localPort.toString() : '',
 		REQUEST_METHOD: req.method,
-		PATH_INFO: req.params.name,
+		PATH_INFO: Array.isArray(req.params.name) ? req.params.name[0] : req.params.name,
 		SCRIPT_NAME: PATH.script,
 		REMOTE_ADDR: (req.ip ?? '').replace('::ffff:', ''),
 		SERVER_PROTOCOL: `${PROTOCOL}/${req.httpVersion}`,

package/src/handler/plsql/procedure.js

@@ -82,7 +82,7 @@ const procedurePrepare = async (cgiObj, databaseConnection) => {
 	try {
 		await databaseConnection.execute(sqlStatement);
 	} catch (err) {
-		throw new ProcedureError(`Error when preparing procedure\n${errorToString(err)}`, cgiObj, sqlStatement, {});
+		throw new ProcedureError(`procedurePrepare: error when preparing procedure\n${errorToString(err)}`, cgiObj, sqlStatement, {});
 	}
 
 	// htbuf_len: reduce this limit based on your worst-case character size.
@@ -99,7 +99,7 @@ const procedurePrepare = async (cgiObj, databaseConnection) => {
 	try {
 		await databaseConnection.execute(sqlStatement, bindParameter);
 	} catch (err) {
-		throw new ProcedureError(`Error when preparing procedure\n${errorToString(err)}`, cgiObj, sqlStatement, bindParameter);
+		throw new ProcedureError(`procedurePrepare: error when preparing procedure\n${errorToString(err)}`, cgiObj, sqlStatement, bindParameter);
 	}
 };
 
@@ -116,7 +116,7 @@ const procedureExecute = async (para, databaseConnection) => {
 	try {
 		await databaseConnection.execute(sqlStatement, para.bind);
 	} catch (err) {
-		throw new ProcedureError(`Error when executing procedure:\n${sqlStatement}\n${errorToString(err)}`, {}, para.sql, para.bind);
+		throw new ProcedureError(`procedureExecute: error when executing procedure:\n${sqlStatement}\n${errorToString(err)}`, {}, para.sql, para.bind);
 	}
 };
 
@@ -144,10 +144,10 @@ const procedureGetPage = async (test, databaseConnection) => {
 		result = await databaseConnection.execute(sqlStatement, bindParameter);
 	} catch (err) {
 		if (debug.enabled) {
-			debug(getBlock('results', inspect(result)));
+			debug(getBlock('procedureGetPage: results', inspect(result)));
 		}
 
-		throw new ProcedureError(`Error when getting page returned by procedure\n${errorToString(err)}`, {}, sqlStatement, bindParameter);
+		throw new ProcedureError(`procedureGetPage: error when getting page returned by procedure\n${errorToString(err)}`, {}, sqlStatement, bindParameter);
 	}
 
 	const {lines, irows} = z.object({irows: z.number(), lines: z.array(z.string())}).parse(result.outBinds);
@@ -155,7 +155,7 @@ const procedureGetPage = async (test, databaseConnection) => {
 	// Make sure that we have retrieved all the rows
 	if (irows > MAX_IROWS) {
 		/* istanbul ignore next */
-		throw new ProcedureError(`Error when retrieving rows. irows="${irows}"`, {}, sqlStatement, bindParameter);
+		throw new ProcedureError(`procedureGetPage: error when retrieving rows. irows="${irows}"`, {}, sqlStatement, bindParameter);
 	}
 
 	return lines.join('');
@@ -199,10 +199,10 @@ END;
 		result = await databaseConnection.execute(sqlStatement, bindParameter);
 	} catch (err) {
 		if (debug.enabled) {
-			debug(getBlock('results', inspect(result)));
+			debug(getBlock('procedureDownloadFiles: results', inspect(result)));
 		}
 
-		throw new ProcedureError(`Error when downloading files of procedure\n${errorToString(err)}`, {}, sqlStatement, bindParameter);
+		throw new ProcedureError(`procedureDownloadFiles: error when downloading files\n${errorToString(err)}`, {}, sqlStatement, bindParameter);
 	}
 
 	return z
@@ -233,12 +233,9 @@ END;
  * @returns {Promise<void>} Promise resolving to the page content generated by the executed procedure
  */
 export const invokeProcedure = async (req, res, argObj, cgiObj, filesToUpload, options, databaseConnection) => {
-	debug('invokeProcedure: ENTER');
-
-	//
-	// UPLOAD FILES
-	//
+	debug('invokeProcedure: begin');
 
+	// 1) upload files
 	debug(`invokeProcedure: upload "${filesToUpload.length}" files`);
 	if (filesToUpload.length > 0) {
 		if (typeof options.documentTable === 'string' && options.documentTable.length > 0) {
@@ -250,48 +247,41 @@ export const invokeProcedure = async (req, res, argObj, cgiObj, filesToUpload, o
 		}
 	}
 
-	//
-	// GET SQL STATEMENT AND ARGUMENTS
-	//
+	// 2) get procedure to execute and the arguments
 
-	const para = await getProcedure(req, req.params.name, argObj, options, databaseConnection);
+	debug('invokeProcedure: get procedure to execute and the arguments');
+	const para = await getProcedure(req, Array.isArray(req.params.name) ? req.params.name[0] : req.params.name, argObj, options, databaseConnection);
 
-	//
-	//	PROCEDURE PREPARE
-	//
+	// 3) prepare the session
 
+	debug('invokeProcedure: prepare the session');
 	await procedurePrepare(cgiObj, databaseConnection);
 
-	//
-	//	PROCEDURE EXECUTE
-	//
+	// 4) execute the procedure
 
+	debug('invokeProcedure: execute the session');
 	await procedureExecute(para, databaseConnection);
 
-	//
-	//	PROCEDURE GET PAGE
-	//
+	// 5) get the page returned from the procedure
 
+	debug('invokeProcedure: get the page returned from the procedure');
 	const lines = await procedureGetPage(true, databaseConnection);
 	if (debug.enabled) {
 		debug(getBlock('data', lines));
 	}
 
-	//
-	//	PROCEDURE DOWNLOAD FILE
-	//
+	// 6) download files
 
+	debug('invokeProcedure: download files');
 	const fileBlob = await databaseConnection.createLob(oracledb.BLOB);
 	const fileDownload = await procedureDownloadFiles(fileBlob, databaseConnection);
 	if (debug.enabled) {
-		debug(getBlock('data', inspect(fileDownload)));
+		debug(getBlock('fileDownload', inspect({fileType: fileDownload.fileType, fileSize: fileDownload.fileSize})));
 	}
 
-	//
-	//	PARSE PAGE
-	//
+	// 7) parse the page
 
-	// parse what we received from PL/SQL
+	debug('invokeProcedure: parse the page');
 	const pageComponents = parsePage(lines);
 
 	// add "Server" header
@@ -304,17 +294,15 @@ export const invokeProcedure = async (req, res, argObj, cgiObj, filesToUpload, o
 		pageComponents.file.fileBlob = await streamToBuffer(fileDownload.fileBlob);
 	}
 
-	//
-	//	SEND THE RESPONSE
-	//
+	// 8) send the page to browser
 
+	debug('invokeProcedure: send the page to browser');
 	sendResponse(req, res, pageComponents);
 
-	//
-	//	CLEANUP
-	//
+	// 9) cleanup
 
+	debug('invokeProcedure: cleanup');
 	fileBlob.destroy();
 
-	debug('invokeProcedure: EXIT');
+	debug('invokeProcedure: end');
 };

package/src/handler/plsql/request.js

@@ -33,6 +33,11 @@ import {isStringOrArrayOfString} from '../../util/type.js';
 export const processRequest = async (req, res, options, connectionPool) => {
 	debug('processRequest: ENTER');
 
+	//
+	if (Array.isArray(req.params.name)) {
+		console.warn(`processRequest: WARNING: the req.params.name is not a string but an array of string: ${req.params.name.join(',')}`);
+	}
+
 	// open database connection
 	const connection = await connectionPool.getConnection();
 
@@ -68,7 +73,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(connection, req.params.name);
+		const result = options.transactionMode(connection, Array.isArray(req.params.name) ? req.params.name[0] : req.params.name);
 		debug('transactionMode: callback restult', result);
 		if (result && typeof result.then === 'function') {
 			await result;

package/src/index.js

@@ -1,5 +1,9 @@
+// libraries
+import oracledb from 'oracledb';
+export {oracledb};
+
 // server
-export {getVersion} from './server/version.js';
+export {getVersion} from './version.js';
 export {createServer, startServer, loadConfig, startServerConfig} from './server/server.js';
 export * from './util/shutdown.js';
 

package/src/server/config.js

@@ -1,4 +1,4 @@
-import {getVersion} from './version.js';
+import {getVersion} from '../version.js';
 
 /**
  * @typedef {import('../types.js').configType} configType

package/src/{server/version.js → version.js}

@@ -2,4 +2,4 @@
  * Returns the current library version
  * @returns {string} - Version.
  */
-export const getVersion = () => '0.17.0';
+export const getVersion = () => '0.17.1';

package/types/index.d.ts

@@ -1,4 +1,5 @@
-export { getVersion } from "./server/version.js";
+export { oracledb };
+export { getVersion } from "./version.js";
 export * from "./util/shutdown.js";
 export * from "./util/oracle.js";
 export * from "./util/file.js";
@@ -6,4 +7,5 @@ export { handlerWebPlSql } from "./handler/plsql/handlerPlSql.js";
 export { handlerLogger } from "./handler/handlerLogger.js";
 export { handlerUpload } from "./handler/handlerUpload.js";
 export { handlerMetrics } from "./handler/handlerMetrics.js";
+import oracledb from 'oracledb';
 export { createServer, startServer, loadConfig, startServerConfig } from "./server/server.js";