web_plsql 0.6.0 → 0.10.0

package/README.md

@@ -25,16 +25,27 @@ Please visit the [node-oracledb](https://node-oracledb.readthedocs.io/en/latest/
 * Install package (`npm i --omit=dev web_plsql`)
 
 # Example
+
+## Native
 * Change to the `examples/sql` directory, start SQLPLus, connect to the database as SYS specifying the SYSDBA roleInstall and install the sample schema `@examples/sql/install.sql`.
-* Start the sample server using `node examples/server_sample.js` after having set the ORACLE_SERVER environment variable to the database where you just installed the sample schema.
+* Start server using `node examples/config-native.js` after having set the WEB_PLSQL_ORACLE_SERVER environment variable to the database where you just installed the sample schema.
 * Invoke a browser and open the page `http://localhost/sample`.
 
-# Running
-There are 2 main options on how to use the mod_plsql Express middleware:
+## Container
+* Build the image using `npm run image-build`.
+* Adapt the `examples/config-docker.json` configuration file. Typically only the `connectString` property must be changed.
+* Start the container using `docker compose up -d`.
+
+# Configuration
+
+There are 2 options on how to use the web_plsql express middleware:
+- Use the predefined `startHttpServer` api in `src/server.js` like in the `examples/config-native.js` example
+- Hand craft a new Express server using the `handlerWebPlSql` middleware in `src/handlerPlSql.js`
+
+## Use the predefined `startHttpServer`
 
-## Make a copy of the `server_sample.js` sample script and configure it accordingly to your needs.
+The `startHttpServer` api uses the following configuration object:
 
-The the default server implemented in `src/server.js` and has the following configuration options:
 ```
 /**
  * @typedef {'basic' | 'debug'} errorStyleType
@@ -73,6 +84,12 @@ export const z$errorStyleType = z.enum(['basic', 'debug']);
  */
 ```
 
+## Hand craft a new Express server using the `handlerWebPlSql` middleware
+
+WIP
+
+# Compare with mod_plsql
+
 The following mod_plsql DAD configuration translates to the configuration options as follows:
 
 **DAD**

package/examples/{server_apex.js → config-apex.js}

@@ -1,8 +1,6 @@
-#!/usr/bin/env node
+import {startHttpServer} from '../src/index.js';
 
-import {startServer} from '../src/index.js';
-
-void startServer({
+void startHttpServer({
 	port: 80,
 	routeStatic: [
 		{
@@ -15,7 +13,7 @@ void startServer({
 			route: '/apex',
 			user: 'APEX_PUBLIC_USER',
 			password: 'secret',
-			connectString: process.env.ORACLE_SERVER ?? '',
+			connectString: 'localhost:1521/orcl',
 			defaultPage: 'apex',
 			pathAlias: 'r',
 			pathAliasProcedure: 'wwv_flow.resolve_friendly_url',

package/examples/config-docker.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+
+// @ts-expect-error NOTE: the following import would show an error because the path does not exist
+import {startHttpServer} from './src/index.js';
+
+void startHttpServer({
+	port: 8888,
+	routeStatic: [
+		{
+			route: '/static',
+			directoryPath: 'examples/static',
+		},
+	],
+	routePlSql: [
+		{
+			route: '/sample',
+			user: 'sample', // PlsqlDatabaseUserName
+			password: 'sample', // PlsqlDatabasePassword
+			connectString: 'host.docker.internal:1521/TEST', // PlsqlDatabaseConnectString
+			defaultPage: 'sample_pkg.page_index', // PlsqlDefaultPage
+			documentTable: 'doctable', // PlsqlDocumentTablename
+			exclusionList: ['sample_pkg.page_exclusion_list'], // PlsqlExclusionList
+			requestValidationFunction: 'sample_pkg.request_validation_function', // PlsqlRequestValidationFunction
+			pathAlias: 'myalias', // PlsqlPathAlias
+			pathAliasProcedure: 'sample_pkg.page_path_alias', // PlsqlPathAliasProcedure
+			errorStyle: 'debug', // PlsqlErrorStyle
+		},
+	],
+	loggerFilename: 'access.log', // PlsqlLogEnable and PlsqlLogDirectory
+	monitorConsole: false,
+});

package/examples/config-docker.json

@@ -0,0 +1,26 @@
+{
+	"port": 8888,
+	"routeStatic": [
+		{
+			"route": "/static",
+			"directoryPath": "examples/static"
+		}
+	],
+	"routePlSql": [
+		{
+			"route": "/sample",
+			"user": "sample",
+			"password": "sample",
+			"connectString": "host.docker.internal:1521/TEST",
+			"defaultPage": "sample_pkg.page_index",
+			"documentTable": "doctable",
+			"exclusionList": ["sample_pkg.page_exclusion_list"],
+			"requestValidationFunction": "sample_pkg.request_validation_function",
+			"pathAlias": "myalias",
+			"pathAliasProcedure": "sample_pkg.page_path_alias",
+			"errorStyle": "debug"
+		}
+	],
+	"loggerFilename": "access.log",
+	"monitorConsole": false
+}

package/examples/{server_sample.js → config-native.js}

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import {startServer} from '../src/index.js';
+import {startHttpServer} from '../src/index.js';
 
-void startServer({
-	port: 80,
+void startHttpServer({
+	port: 8888,
 	routeStatic: [
 		{
 			route: '/static',
@@ -15,7 +15,7 @@ void startServer({
 			route: '/sample',
 			user: 'sample', // PlsqlDatabaseUserName
 			password: 'sample', // PlsqlDatabasePassword
-			connectString: process.env.ORACLE_SERVER ?? '', // PlsqlDatabaseConnectString
+			connectString: process.env.WEB_PLSQL_ORACLE_SERVER ?? 'localhost:1521/TEST', // PlsqlDatabaseConnectString
 			defaultPage: 'sample_pkg.page_index', // PlsqlDefaultPage
 			documentTable: 'doctable', // PlsqlDocumentTablename
 			exclusionList: ['sample_pkg.page_exclusion_list'], // PlsqlExclusionList

package/examples/sql/install.sql

@@ -19,10 +19,10 @@ GRANT execute on dbms_lob TO &&SAMPLE_USER;
 ALTER SESSION SET CURRENT_SCHEMA=&&SAMPLE_USER;
 
 -- install document table
-@doctable.sql
+@@doctable.sql
 
 -- install package
-@sample_package.sql
+@@sample_package.sql
 show errors
-@sample_package_body.sql
+@@sample_package_body.sql
 show errors

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.6.0",
+	"version": "0.10.0",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -43,50 +43,53 @@
 	"types": "./types/index.d.ts",
 	"type": "module",
 	"scripts": {
-		"lint": "prettier --check . && eslint . && tsc --noEmit",
+		"lint": "prettier --check --experimental-cli . && eslint . && tsc --noEmit",
 		"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 src/*.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",
-		"create-package": "shx rm -f *.tgz && npm pack"
+		"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"
+	},
+	"peerDependencies": {
+		"oracledb": "6.9.0"
 	},
 	"dependencies": {
 		"basic-auth": "2.0.1",
-		"body-parser": "1.20.3",
-		"compression": "1.7.5",
-		"connect-multiparty": "2.2.0",
+		"body-parser": "2.2.0",
+		"compression": "1.8.1",
 		"cookie-parser": "1.4.7",
-		"debug": "4.4.0",
+		"debug": "4.4.1",
 		"escape-html": "1.0.3",
-		"express": "4.21.2",
-		"fs-extra": "11.3.0",
-		"http-parser-js": "0.5.9",
-		"morgan": "1.10.0",
-		"multer": "^1.4.5-lts.1",
-		"oracledb": "6.7.1",
-		"rotating-file-stream": "3.2.5",
-		"zod": "3.24.1"
+		"express": "5.1.0",
+		"fs-extra": "11.3.1",
+		"http-parser-js": "0.5.10",
+		"morgan": "1.10.1",
+		"multer": "2.0.2",
+		"rotating-file-stream": "3.2.6",
+		"zod": "4.0.17"
 	},
 	"devDependencies": {
 		"@types/basic-auth": "1.1.8",
-		"@types/body-parser": "1.19.5",
-		"@types/compression": "1.7.5",
-		"@types/cookie-parser": "1.4.8",
+		"@types/body-parser": "1.19.6",
+		"@types/compression": "1.8.1",
+		"@types/cookie-parser": "1.4.9",
 		"@types/debug": "4.1.12",
 		"@types/escape-html": "1.0.4",
 		"@types/fs-extra": "11.0.4",
-		"@types/morgan": "1.9.9",
-		"@types/multer": "^1.4.12",
-		"@types/node": "22.13.1",
-		"@types/oracledb": "6.5.3",
-		"@types/supertest": "6.0.2",
-		"eslint": "9.20.0",
-		"eslint-plugin-jsdoc": "50.6.3",
-		"prettier": "3.5.0",
+		"@types/morgan": "1.9.10",
+		"@types/multer": "2.0.0",
+		"@types/node": "24.3.0",
+		"@types/oracledb": "6.9.1",
+		"@types/supertest": "6.0.3",
+		"eslint": "9.33.0",
+		"eslint-plugin-jsdoc": "54.1.0",
+		"prettier": "3.6.2",
 		"rimraf": "6.0.1",
-		"shx": "0.3.4",
-		"supertest": "7.0.0",
-		"typescript": "5.7.3",
-		"typescript-eslint": "8.23.0"
+		"shx": "0.4.0",
+		"supertest": "7.1.4",
+		"typescript": "5.9.2",
+		"typescript-eslint": "8.39.1"
 	}
 }

package/src/file.js

@@ -1,5 +1,20 @@
 import {promises as fs, readFileSync} from 'node:fs';
 
+/**
+ * Read file.
+ *
+ * @param {string} filePath - File name.
+ * @returns {string} The string.
+ */
+export const readFileSyncUtf8 = (filePath) => {
+	try {
+		return readFileSync(filePath, 'utf8');
+	} catch (err) {
+		/* istanbul ignore next */
+		throw new Error(`Unable to read file "${filePath}"`);
+	}
+};
+
 /**
  * Read file.
  *
@@ -71,7 +86,10 @@ export const isFile = async (filePath) => {
 		return false;
 	}
 
-	const stats = await fs.stat(filePath);
-
-	return stats.isFile();
+	try {
+		const stats = await fs.stat(filePath);
+		return stats.isFile();
+	} catch {
+		return false;
+	}
 };

package/src/index.js

@@ -1,5 +1,5 @@
 // server
-export {startServer} from './server.js';
+export {createHttpServer, createHttpsServer, startHttpServer, loadConfig} from './server.js';
 export * from './shutdown.js';
 
 // handler

package/src/procedureSanitize.js

@@ -135,7 +135,7 @@ const loadRequestValid = async (procName, requestValidationFunction, databaseCon
 	}
 
 	try {
-		const data = z.object({valid: z.number()}).strict().parse(result.outBinds);
+		const data = z.strictObject({valid: z.number()}).parse(result.outBinds);
 		return data.valid === 1;
 	} catch (err) {
 		debug('result', result.outBinds);

package/src/server.js

@@ -1,6 +1,8 @@
 import debugModule from 'debug';
 const debug = debugModule('webplsql:server');
 
+import http from 'node:http';
+import https from 'node:https';
 import express from 'express';
 import bodyParser from 'body-parser';
 import cookieParser from 'cookie-parser';
@@ -13,9 +15,11 @@ import {handlerUpload} from './handlerUpload.js';
 import {handlerLogger} from './handlerLogger.js';
 import {initMetrics, handlerMetrics} from './handlerMetrics.js';
 import {handlerWebPlSql} from './handlerPlSql.js';
-import {getPackageVersion} from './version.js';
+import {getPackageVersion, getExpressVersion} from './version.js';
+import {readFileSyncUtf8, getJsonFile} from './file.js';
 
 /**
+ * @typedef {import('express').Express} Express
  * @typedef {import('express').Request} Request
  * @typedef {import('express').Response} Response
  * @typedef {import('express').NextFunction} NextFunction
@@ -25,41 +29,150 @@ import {getPackageVersion} from './version.js';
  */
 
 /**
- * Start generic server.
+ * Show configuration.
  * @param {configType} config - The config.
- * @returns {Promise<void>} - Promise.
+ * @returns {void}
  */
-export const startServer = async (config) => {
-	debug('startServer', config);
-
-	config = z$configType.parse(config);
+export const showConfig = (config) => {
+	const expressVersion = getExpressVersion();
+	const packageVersion = getPackageVersion();
+
+	console.log('-'.repeat(80));
+	console.log('NODE PL/SQL SERVER');
+	console.log('-'.repeat(80));
+
+	console.log(`Application version: ${packageVersion}`);
+	console.log(`Express version:     ${expressVersion}`);
+	console.log(`Server port:         ${config.port}`);
+	console.log(`Access log:          ${config.loggerFilename.length > 0 ? config.loggerFilename : ''}`);
+	console.log(`Monitor console:     ${config.monitorConsole ? 'on' : 'off'}`);
+
+	if (config.routeStatic.length > 0) {
+		console.log('');
+		config.routeStatic.forEach((e, i) => {
+			console.log(`Static route #${i + 1}`);
+			console.log(` Route:            "${e.route}"`);
+			console.log(` Directory path:   "${e.directoryPath}"`);
+		});
+	}
 
-	console.log(`WEB_PL/SQL ${getPackageVersion()}`);
+	if (config.routePlSql.length > 0) {
+		console.log('');
+		config.routePlSql.forEach((e, i) => {
+			console.log(`Application route #${i + 1}`);
+			console.log(` Route:                       "http://localhost:${config.port}${e.route}"`);
+			console.log(` Oracle user:                 "${e.user}"`);
+			console.log(` Oracle server:               "${e.connectString}"`);
+			console.log(` Oracle document table:       "${e.documentTable}"`);
+			console.log(` Default page:                "${e.defaultPage}"`);
+			console.log(` Path alias:                  "${e.pathAlias}"`);
+			console.log(` Path alias procedure:        "${e.pathAliasProcedure}"`);
+			console.log(` Exclution list:              "${e.exclusionList?.join(', ')}"`);
+			console.log(` Request validation function: "${e.requestValidationFunction}"`);
+			console.log(` Error style:                 "${e.errorStyle}"`);
+		});
+	}
 
-	/** @type {Pool[]} */
-	const pools = [];
+	console.log('-'.repeat(80));
+};
 
-	// Install shutdown handler
-	installShutdown(async () => {
-		// Close database pools.
-		await poolsClose(pools);
-		pools.length = 0;
+/**
+ * Create HTTP server.
+ * @param {Express} app - express application
+ * @param {number} port - port number
+ * @param {Pool[]} connectionPools - database connection
+ * @returns {Promise<http.Server>} - server
+ */
+export const createHttpServer = (app, port, connectionPools) => {
+	return new Promise((resolve) => {
+		// Create server
+		const server = http.createServer({}, app);
+
+		// Install shutdown handler
+		installShutdown(async () => {
+			// Close database pool.
+			await poolsClose(connectionPools);
+
+			// Close server
+			return new Promise((resolve) => server.close(() => resolve()));
+		});
+
+		// Listen on HTTP ports
+		server.listen(port, () => {
+			resolve(server);
+		});
+	});
+};
 
-		// Close server
-		return new Promise((resolve) => server.close(() => resolve()));
+/**
+ * Create HTTPS server.
+ * @param {Express} app - express application
+ * @param {string} sslKeyFilename - ssl
+ * @param {string} sslCertFilename - ssl
+ * @param {number} port - port number
+ * @param {Pool[]} connectionPools - database connection
+ * @returns {Promise<https.Server>} - server
+ */
+export const createHttpsServer = (app, sslKeyFilename, sslCertFilename, port, connectionPools) => {
+	return new Promise((resolve) => {
+		// Load certificates
+		const key = readFileSyncUtf8(sslKeyFilename);
+		const cert = readFileSyncUtf8(sslCertFilename);
+
+		// Create server
+		const server = https.createServer({key, cert}, app);
+
+		// Install shutdown handler
+		installShutdown(async () => {
+			// Close database pool.
+			await poolsClose(connectionPools);
+
+			// Close server
+			return new Promise((resolve) => server.close(() => resolve()));
+		});
+
+		// Listen on HTTP ports
+		server.listen(port, () => {
+			resolve(server);
+		});
 	});
+};
+
+/**
+ * Start HTTP server.
+ * @param {configType} config - The config.
+ * @returns {Promise<void>} - Promise.
+ */
+export const startHttpServer = async (config) => {
+	debug('startHttpServer', config);
+
+	config = z$configType.parse(config);
+
+	showConfig(config);
 
 	// Create express app
 	const app = express();
 
+	// Debug requests
+	if (debug.enabled) {
+		app.use((req, res, next) => {
+			console.log(`Request: "${req.method}" "${req.url}"`);
+			next();
+		});
+	}
+
 	// Metrics
 	const metrics = initMetrics();
 	app.use(handlerMetrics(metrics));
 
+	// Access log
+	if (config.loggerFilename.length > 0) {
+		app.use(handlerLogger(config.loggerFilename));
+	}
+
 	// Serving static files
 	for (const i of config.routeStatic) {
 		app.use(i.route, express.static(i.directoryPath));
-		console.log(`Static resources on "${i.route}" from directory ${i.directoryPath}`);
 	}
 
 	// Default middleware
@@ -69,24 +182,16 @@ export const startServer = async (config) => {
 	app.use(cookieParser());
 	app.use(compression());
 
-	// Access log
-	if (config.loggerFilename.length > 0) {
-		console.log(`Access log in "${config.loggerFilename}"`);
-		app.use(handlerLogger(config.loggerFilename));
-	}
+	/** @type {Pool[]} */
+	const connectionPools = [];
 
 	// Oracle pl/sql express middleware
 	for (const i of config.routePlSql) {
 		// Allocate the Oracle database pool
 		const pool = await poolCreate(i.user, i.password, i.connectString);
-		pools.push(pool);
-
-		app.use(`${i.route}/:name?`, handlerWebPlSql(pool, i));
+		connectionPools.push(pool);
 
-		console.log(`Application route "http://localhost:${config.port}${i.route}"`);
-		console.log(`   Oracle user:           ${i.user}`);
-		console.log(`   Oracle server:         ${i.connectString}`);
-		console.log(`   Oracle document table: ${i.documentTable}`);
+		app.use([`${i.route}/:name`, i.route], handlerWebPlSql(pool, i));
 	}
 
 	// Update metrics every second
@@ -101,6 +206,24 @@ export const startServer = async (config) => {
 		}, 1000);
 	}
 
-	// listen on port
-	const server = app.listen(config.port);
+	await createHttpServer(app, config.port, connectionPools);
+};
+
+/**
+ * Load configuration.
+ * @param {string} [filename] - The configuration filename.
+ * @returns {configType} - Promise.
+ */
+export const loadConfig = (filename) => {
+	debug('loadConfig', filename);
+
+	if (typeof filename !== 'string' || filename.length === 0) {
+		filename = 'config.json';
+	}
+
+	const data = getJsonFile(filename);
+
+	const config = z$configType.parse(data);
+
+	return config;
 };

package/src/trace.js

@@ -10,7 +10,7 @@ import util from 'node:util';
  * Return a string representation of the value.
  *
  * @param {unknown} value - Any value.
- * @param {number | null} depth - Specifies the number of times to recurse while formatting object..
+ * @param {number | null} depth - Specifies the number of times to recurse while formatting object.
  * @returns {string} - The string representation.
  */
 export const inspect = (value, depth = null) => util.inspect(value, {showHidden: false, depth, colors: false});

package/src/types.js

@@ -14,12 +14,10 @@ export const z$errorStyleType = z.enum(['basic', 'debug']);
  * @property {string} route - The Static route path.
  * @property {string} directoryPath - The Static directory.
  */
-export const z$configStaticType = z
-	.object({
-		route: z.string(),
-		directoryPath: z.string(),
-	})
-	.strict();
+export const z$configStaticType = z.strictObject({
+	route: z.string(),
+	directoryPath: z.string(),
+});
 
 /**
  * @typedef {object} configPlSqlHandlerType
@@ -32,17 +30,15 @@ export const z$configStaticType = z
  * @property {Record<string, string>} [cgi] - The additional CGI.
  * @property {errorStyleType} errorStyle - The error style.
  */
-export const z$configPlSqlHandlerType = z
-	.object({
-		defaultPage: z.string(),
-		pathAlias: z.string().optional(),
-		pathAliasProcedure: z.string().optional(),
-		documentTable: z.string(),
-		exclusionList: z.array(z.string()).optional(),
-		requestValidationFunction: z.string().optional(),
-		errorStyle: z$errorStyleType,
-	})
-	.strict();
+export const z$configPlSqlHandlerType = z.strictObject({
+	defaultPage: z.string(),
+	pathAlias: z.string().optional(),
+	pathAliasProcedure: z.string().optional(),
+	documentTable: z.string(),
+	exclusionList: z.array(z.string()).optional(),
+	requestValidationFunction: z.string().optional(),
+	errorStyle: z$errorStyleType,
+});
 
 /**
  * @typedef {object} configPlSqlConfigType
@@ -51,19 +47,20 @@ export const z$configPlSqlHandlerType = z
  * @property {string} password - The Oracle password.
  * @property {string} connectString - The Oracle connect string.
  */
-export const z$configPlSqlConfigType = z
-	.object({
-		route: z.string(),
-		user: z.string(),
-		password: z.string(),
-		connectString: z.string(),
-	})
-	.strict();
+export const z$configPlSqlConfigType = z.strictObject({
+	route: z.string(),
+	user: z.string(),
+	password: z.string(),
+	connectString: z.string(),
+});
 
 /**
  * @typedef {configPlSqlHandlerType & configPlSqlConfigType} configPlSqlType
  */
-export const z$configPlSqlType = z$configPlSqlHandlerType.merge(z$configPlSqlConfigType);
+export const z$configPlSqlType = z.strictObject({
+	...z$configPlSqlHandlerType.shape,
+	...z$configPlSqlConfigType.shape,
+});
 
 /**
  * @typedef {object} configType
@@ -73,15 +70,13 @@ export const z$configPlSqlType = z$configPlSqlHandlerType.merge(z$configPlSqlCon
  * @property {string} loggerFilename - name of the request logger filename or '' if not required.
  * @property {boolean} monitorConsole - Enable console status monitor.
  */
-export const z$configType = z
-	.object({
-		port: z.number(),
-		routeStatic: z.array(z$configStaticType),
-		routePlSql: z.array(z$configPlSqlType),
-		loggerFilename: z.string(),
-		monitorConsole: z.boolean(),
-	})
-	.strict();
+export const z$configType = z.strictObject({
+	port: z.number(),
+	routeStatic: z.array(z$configStaticType),
+	routePlSql: z.array(z$configPlSqlType),
+	loggerFilename: z.string(),
+	monitorConsole: z.boolean(),
+});
 
 /**
  * Environment variables as string key-value pairs

package/src/version.js

@@ -21,3 +21,18 @@ export const getPackageVersion = () => {
 
 	return typeof pkg.version === 'string' ? pkg.version : '';
 };
+
+/**
+ * Retrieves the express version from package.json.
+ *
+ * @returns {string} The version number of the package.
+ */
+export const getExpressVersion = () => {
+	const __filename = fileURLToPath(import.meta.url);
+	const __dirname = dirname(__filename);
+	const packageJsonPath = join(__dirname, '../node_modules/express/package.json');
+
+	const pkg = /** @type {PackageJSON} */ (getJsonFile(packageJsonPath));
+
+	return typeof pkg.version === 'string' ? pkg.version : '';
+};

package/types/file.d.ts

@@ -1,3 +1,4 @@
+export function readFileSyncUtf8(filePath: string): string;
 export function readFile(filePath: string): Promise<Buffer>;
 export function removeFile(filePath: string): Promise<void>;
 export function getJsonFile(filePath: string): unknown;

package/types/index.d.ts

@@ -1,4 +1,3 @@
-export { startServer } from "./server.js";
 export * from "./shutdown.js";
 export * from "./oracle.js";
 export * from "./file.js";
@@ -7,4 +6,5 @@ export * from "./version.js";
 export { handlerWebPlSql } from "./handlerPlSql.js";
 export { handlerLogger } from "./handlerLogger.js";
 export { handlerUpload } from "./handlerUpload.js";
+export { createHttpServer, createHttpsServer, startHttpServer, loadConfig } from "./server.js";
 export { initMetrics, handlerMetrics } from "./handlerMetrics.js";

package/types/server.d.ts

@@ -1,7 +1,14 @@
-export function startServer(config: configType): Promise<void>;
+export function showConfig(config: configType): void;
+export function createHttpServer(app: Express, port: number, connectionPools: Pool[]): Promise<http.Server>;
+export function createHttpsServer(app: Express, sslKeyFilename: string, sslCertFilename: string, port: number, connectionPools: Pool[]): Promise<https.Server>;
+export function startHttpServer(config: configType): Promise<void>;
+export function loadConfig(filename?: string): configType;
+export type Express = import("express").Express;
 export type Request = import("express").Request;
 export type Response = import("express").Response;
 export type NextFunction = import("express").NextFunction;
 export type Pool = import("oracledb").Pool;
 export type environmentType = import("./types.js").environmentType;
 export type configType = import("./types.js").configType;
+import http from 'node:http';
+import https from 'node:https';

package/types/stream.d.ts

@@ -1 +1,2 @@
 export function streamToBuffer(readable: stream.Readable): Promise<Buffer>;
+import stream from 'node:stream';

package/types/trace.d.ts

@@ -3,3 +3,4 @@ export function logToFile(text: string): void;
 export function inspectRequest(req: express.Request, simple?: boolean): string;
 export function getBlock(title: string, body: string): string;
 export function getTimestamp(): string;
+import express from 'express';

package/types/types.d.ts

@@ -4,13 +4,19 @@
 /**
  * @typedef {'basic' | 'debug'} errorStyleType
  */
-export const z$errorStyleType: any;
+export const z$errorStyleType: z.ZodEnum<{
+    basic: "basic";
+    debug: "debug";
+}>;
 /**
  * @typedef {object} configStaticType
  * @property {string} route - The Static route path.
  * @property {string} directoryPath - The Static directory.
  */
-export const z$configStaticType: any;
+export const z$configStaticType: z.ZodObject<{
+    route: z.ZodString;
+    directoryPath: z.ZodString;
+}, z.core.$strict>;
 /**
  * @typedef {object} configPlSqlHandlerType
  * @property {string} defaultPage - The default page.
@@ -22,7 +28,18 @@ export const z$configStaticType: any;
  * @property {Record<string, string>} [cgi] - The additional CGI.
  * @property {errorStyleType} errorStyle - The error style.
  */
-export const z$configPlSqlHandlerType: any;
+export const z$configPlSqlHandlerType: z.ZodObject<{
+    defaultPage: z.ZodString;
+    pathAlias: z.ZodOptional<z.ZodString>;
+    pathAliasProcedure: z.ZodOptional<z.ZodString>;
+    documentTable: z.ZodString;
+    exclusionList: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    requestValidationFunction: z.ZodOptional<z.ZodString>;
+    errorStyle: z.ZodEnum<{
+        basic: "basic";
+        debug: "debug";
+    }>;
+}, z.core.$strict>;
 /**
  * @typedef {object} configPlSqlConfigType
  * @property {string} route - The PL/SQL route path.
@@ -30,11 +47,31 @@ export const z$configPlSqlHandlerType: any;
  * @property {string} password - The Oracle password.
  * @property {string} connectString - The Oracle connect string.
  */
-export const z$configPlSqlConfigType: any;
+export const z$configPlSqlConfigType: z.ZodObject<{
+    route: z.ZodString;
+    user: z.ZodString;
+    password: z.ZodString;
+    connectString: z.ZodString;
+}, z.core.$strict>;
 /**
  * @typedef {configPlSqlHandlerType & configPlSqlConfigType} configPlSqlType
  */
-export const z$configPlSqlType: any;
+export const z$configPlSqlType: z.ZodObject<{
+    route: z.ZodString;
+    user: z.ZodString;
+    password: z.ZodString;
+    connectString: z.ZodString;
+    defaultPage: z.ZodString;
+    pathAlias: z.ZodOptional<z.ZodString>;
+    pathAliasProcedure: z.ZodOptional<z.ZodString>;
+    documentTable: z.ZodString;
+    exclusionList: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    requestValidationFunction: z.ZodOptional<z.ZodString>;
+    errorStyle: z.ZodEnum<{
+        basic: "basic";
+        debug: "debug";
+    }>;
+}, z.core.$strict>;
 /**
  * @typedef {object} configType
  * @property {number} port - The server port number.
@@ -43,7 +80,31 @@ export const z$configPlSqlType: any;
  * @property {string} loggerFilename - name of the request logger filename or '' if not required.
  * @property {boolean} monitorConsole - Enable console status monitor.
  */
-export const z$configType: any;
+export const z$configType: z.ZodObject<{
+    port: z.ZodNumber;
+    routeStatic: z.ZodArray<z.ZodObject<{
+        route: z.ZodString;
+        directoryPath: z.ZodString;
+    }, z.core.$strict>>;
+    routePlSql: z.ZodArray<z.ZodObject<{
+        route: z.ZodString;
+        user: z.ZodString;
+        password: z.ZodString;
+        connectString: z.ZodString;
+        defaultPage: z.ZodString;
+        pathAlias: z.ZodOptional<z.ZodString>;
+        pathAliasProcedure: z.ZodOptional<z.ZodString>;
+        documentTable: z.ZodString;
+        exclusionList: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        requestValidationFunction: z.ZodOptional<z.ZodString>;
+        errorStyle: z.ZodEnum<{
+            basic: "basic";
+            debug: "debug";
+        }>;
+    }, z.core.$strict>>;
+    loggerFilename: z.ZodString;
+    monitorConsole: z.ZodBoolean;
+}, z.core.$strict>;
 export type BindParameter = import("oracledb").BindParameter;
 export type errorStyleType = "basic" | "debug";
 export type configStaticType = {
@@ -249,3 +310,4 @@ export type metricsType = {
      */
     requestsInLastInterval: number;
 };
+import z from 'zod';

package/types/version.d.ts

@@ -1,4 +1,5 @@
 export function getPackageVersion(): string;
+export function getExpressVersion(): string;
 export type PackageJSON = {
     /**
      * - The package version.