web_plsql 1.3.2 → 1.5.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { t as __exportAll } from "./chunk-DQk6qfdC.mjs";
-import { n as setExecuteCallback } from "./oracledb-mock-Dn8aHtd7.mjs";
+import { t as __exportAll } from "./chunk-CfYAbeIz.mjs";
+import { n as setExecuteCallback } from "./oracledb-mock-Cya43xKB.mjs";
 import z$1, { z } from "zod";
 import oracledb from "oracledb";
 import debugModule from "debug";
@@ -20,7 +20,6 @@ import path from "node:path";
 import morgan from "morgan";
 import multer from "multer";
 import readline from "node:readline";
-
 //#region src/common/configStaticSchema.ts
 /**
 * Configuration for serving static files
@@ -30,7 +29,6 @@ const configStaticSchema = z$1.strictObject({
 	directoryPath: z$1.string(),
 	spaFallback: z$1.boolean().optional()
 });
-
 //#endregion
 //#region src/common/procedureTraceEntry.ts
 const procedureTraceEntrySchema = z.strictObject({
@@ -58,7 +56,6 @@ const procedureTraceEntrySchema = z.strictObject({
 	cgi: z.record(z.string(), z.string()).optional(),
 	error: z.string().optional()
 });
-
 //#endregion
 //#region src/common/logEntrySchema.ts
 /**
@@ -86,7 +83,6 @@ const logEntrySchema = z.strictObject({
 		environment: z.record(z.string(), z.string()).optional()
 	}).optional()
 });
-
 //#endregion
 //#region src/backend/types.ts
 /**
@@ -111,11 +107,14 @@ const transactionModeSchema = z$1.union([
 /**
 * Authentication configuration for a PL/SQL route
 */
-const z$authSchema = z$1.strictObject({
+const z$authSchema = z$1.union([z$1.strictObject({
 	type: z$1.literal("basic"),
 	callback: z$1.custom((val) => typeof val === "function", { message: "Invalid auth callback" }),
 	realm: z$1.string().optional()
-});
+}), z$1.strictObject({
+	type: z$1.literal("custom"),
+	callback: z$1.custom((val) => typeof val === "function", { message: "Invalid auth callback" })
+})]);
 /**
 * PL/SQL handler behavior configuration
 */
@@ -156,9 +155,9 @@ const z$configType = z$1.strictObject({
 	adminRoute: z$1.string().optional(),
 	adminUser: z$1.string().optional(),
 	adminPassword: z$1.string().optional(),
-	devMode: z$1.boolean().optional()
+	devMode: z$1.boolean().optional(),
+	setupExtensions: z$1.custom((val) => typeof val === "function", { message: "Invalid setupExtensions callback" }).optional()
 });
-
 //#endregion
 //#region src/backend/util/oracledb-provider.ts
 var oracledb_provider_exports = /* @__PURE__ */ __exportAll({
@@ -186,7 +185,7 @@ const USE_MOCK = process.env.MOCK_ORACLE === "true";
 * @returns The pool.
 */
 async function createPool(config) {
-	if (USE_MOCK) return (await import("./oracledb-mock-Dn8aHtd7.mjs").then((n) => n.t)).createPool(config);
+	if (USE_MOCK) return (await import("./oracledb-mock-Cya43xKB.mjs").then((n) => n.t)).createPool(config);
 	return await oracledb.createPool(config);
 }
 const BIND_IN = oracledb.BIND_IN;
@@ -203,16 +202,14 @@ const DB_TYPE_VARCHAR = oracledb.DB_TYPE_VARCHAR;
 const DB_TYPE_CLOB = oracledb.DB_TYPE_CLOB;
 const DB_TYPE_NUMBER = oracledb.DB_TYPE_NUMBER;
 const DB_TYPE_DATE = oracledb.DB_TYPE_DATE;
-
 //#endregion
 //#region src/backend/version.ts
 globalThis.__VERSION__ ??= "**development**";
 /**
 * Returns the current library version
-* @returns {string} - Version.
+* @returns Version.
 */
-const getVersion = () => "1.3.2";
-
+const getVersion = () => "1.5.0";
 //#endregion
 //#region src/backend/server/config.ts
 const paddedLine = (title, value) => {
@@ -263,7 +260,6 @@ const showConfig = (config) => {
 	}
 	console.log(LINE);
 };
-
 //#endregion
 //#region src/backend/server/server.ts
 const debug$14 = debugModule("webplsql:server");
@@ -337,6 +333,7 @@ const startServer = async (config, ssl) => {
 		});
 	}
 	if (internalConfig.loggerFilename.length > 0) app.use(handlerLogger(internalConfig.loggerFilename));
+	if (internalConfig.setupExtensions) await internalConfig.setupExtensions(app, adminContext.pools);
 	for (const i of internalConfig.routeStatic) {
 		app.use(i.route, expressStaticGzip(i.directoryPath, {
 			enableBrotli: true,
@@ -406,7 +403,6 @@ const loadConfig = (filename = "config.json") => z$configType.parse(getJsonFile(
 * @returns Promise resolving to the web server object.
 */
 const startServerConfig = async (filename = "config.json", ssl) => startServer(loadConfig(filename), ssl);
-
 //#endregion
 //#region src/backend/util/shutdown.ts
 const debug$13 = debugModule("webplsql:shutdown");
@@ -453,7 +449,6 @@ const forceShutdown = () => {
 	debug$13("forceShutdown");
 	process.kill(process.pid, "SIGTERM");
 };
-
 //#endregion
 //#region src/common/constants.ts
 /**
@@ -560,27 +555,6 @@ const OWA_STREAM_CHUNK_SIZE = 1e3;
 */
 const OWA_STREAM_BUFFER_SIZE = 16384;
 /**
-* OWA_RESOLVED_NAME_MAX_LEN = 400
-*
-* Purpose: Maximum string length for resolved Oracle procedure canonical names.
-*          Canonical format: SCHEMA.PACKAGE.PROCEDURE or SCHEMA.PROCEDURE.
-*
-* Used By:
-*   - resolveProcedureName() function for dbms_utility.name_resolve output
-*   - Procedure name resolution SQL at procedureSanitize.js:46-76
-*
-* Related Values:
-*   - dbms_utility.name_resolve context = 1 (procedure/function resolution)
-*   - Oracle identifier limits: Schema (128) + Package (128) + Procedure (128) + 2 dots = ~386
-*   - 400 provides comfortable headroom
-*
-* Implications:
-*   - Oracle object names: 30 bytes for most, extended to 128 in some contexts
-*   - Canonical name: schema.package.procedure (max ~128+1+128+1+128 = 386)
-*   - 400 is safe upper bound with margin
-*/
-const OWA_RESOLVED_NAME_MAX_LEN = 400;
-/**
 * STATS_INTERVAL_MS = 5000
 *
 * Purpose: Duration of each statistical bucket in milliseconds.
@@ -645,107 +619,6 @@ const MAX_HISTORY_BUCKETS = 1e3;
 *   - Under heavy load, older samples are discarded (FIFO)
 */
 const MAX_PERCENTILE_SAMPLES = 1e3;
-/**
-* SHUTDOWN_GRACE_DELAY_MS = 100
-*
-* Purpose: Delay between initiating server shutdown and forced termination.
-*
-* Used By: POST /api/server/stop handler only
-*
-* Related Values:
-*   - forceShutdown() at src/util/shutdown.js
-*   - SIGTERM/SIGINT handlers at shutdown.js
-*
-* Implications:
-*   - Allows graceful completion of in-flight requests
-*   - Gives Express middleware time to send final responses
-*   - 100ms is short; may be insufficient under heavy load
-*   - Consider making configurable for high-traffic deployments
-*/
-const SHUTDOWN_GRACE_DELAY_MS = 100;
-/**
-* TRACE_LOG_ROTATION_SIZE = '10M'
-*
-* Purpose: Log file size threshold triggering trace log rotation (10 Megabytes).
-*
-* Used By: rotating-file-stream library for 'trace.log'
-*
-* Related Values:
-*   - TRACE_LOG_ROTATION_INTERVAL ('1d'): Also triggers rotation
-*   - TRACE_LOG_MAX_ROTATED_FILES (10): Maximum retained files
-*
-* Implications:
-*   - When either size OR time threshold is reached, rotation occurs
-*   - Combined with daily rotation: ~10MB/day minimum
-*   - gzip compression reduces rotated file size by ~70-90%
-*/
-const TRACE_LOG_ROTATION_SIZE = "10M";
-/**
-* TRACE_LOG_ROTATION_INTERVAL = '1d'
-*
-* Purpose: Time-based trace log rotation trigger (daily).
-*
-* Used By: rotating-file-stream library for 'trace.log'
-*
-* Implications:
-*   - Guarantees at least one rotation per day
-*   - Midnight-based or 24h from first write
-*/
-const TRACE_LOG_ROTATION_INTERVAL = "1d";
-/**
-* TRACE_LOG_MAX_ROTATED_FILES = 10
-*
-* Purpose: Maximum number of rotated trace log files to retain.
-*
-* Used By: rotating-file-stream library for 'trace.log'
-*
-* Implications:
-*   - When exceeded, oldest rotated file is deleted
-*   - Maximum: ~10 files × 10MB = ~100MB (compressed: ~10-30MB)
-*/
-const TRACE_LOG_MAX_ROTATED_FILES = 10;
-/**
-* JSON_LOG_ROTATION_SIZE = '10M'
-*
-* Purpose: Log file size threshold triggering JSON error log rotation (10 Megabytes).
-*
-* Used By: rotating-file-stream library for 'error.json.log'
-*
-* Related Values:
-*   - JSON_LOG_ROTATION_INTERVAL ('1d'): Also triggers rotation
-*   - JSON_LOG_MAX_ROTATED_FILES (10): Maximum retained files
-*
-* Implications:
-*   - When either size OR time threshold is reached, rotation occurs
-*   - Combined with daily rotation: ~10MB/day minimum
-*   - gzip compression reduces rotated file size by ~70-90%
-*/
-const JSON_LOG_ROTATION_SIZE = "10M";
-/**
-* JSON_LOG_ROTATION_INTERVAL = '1d'
-*
-* Purpose: Time-based JSON error log rotation trigger (daily).
-*
-* Used By: rotating-file-stream library for 'error.json.log'
-*
-* Implications:
-*   - Guarantees at least one rotation per day
-*   - Midnight-based or 24h from first write
-*/
-const JSON_LOG_ROTATION_INTERVAL = "1d";
-/**
-* JSON_LOG_MAX_ROTATED_FILES = 10
-*
-* Purpose: Maximum number of rotated JSON error log files to retain.
-*
-* Used By: rotating-file-stream library for 'error.json.log'
-*
-* Implications:
-*   - When exceeded, oldest rotated file is deleted
-*   - Maximum: ~10 files × 10MB = ~100MB (compressed: ~10-30MB)
-*/
-const JSON_LOG_MAX_ROTATED_FILES = 10;
-
 //#endregion
 //#region src/backend/util/statsManager.ts
 const debug$12 = debugModule("webplsql:statsManager");
@@ -977,7 +850,6 @@ var StatsManager = class {
 		return this.history;
 	}
 };
-
 //#endregion
 //#region src/backend/server/adminContext.ts
 /**
@@ -1020,7 +892,6 @@ var AdminContext = class {
 		this._paused = value;
 	}
 };
-
 //#endregion
 //#region src/backend/util/file.ts
 /**
@@ -1097,7 +968,6 @@ const isFile = async (filePath) => {
 		return false;
 	}
 };
-
 //#endregion
 //#region src/backend/util/html.ts
 /**
@@ -1145,7 +1015,6 @@ ${body}
 </body>
 </html>
 `;
-
 //#endregion
 //#region src/backend/util/trace.ts
 /**
@@ -1219,9 +1088,9 @@ const toTable = (head, body) => {
 */
 const logToFile = (text) => {
 	const fs = rotatingFileStream.createStream("trace.log", {
-		size: TRACE_LOG_ROTATION_SIZE,
-		interval: TRACE_LOG_ROTATION_INTERVAL,
-		maxFiles: TRACE_LOG_MAX_ROTATED_FILES,
+		size: "10M",
+		interval: "1d",
+		maxFiles: 10,
 		compress: "gzip"
 	});
 	fs.write(text);
@@ -1425,7 +1294,6 @@ const warningMessage = (para) => {
 	logToFile(text);
 	console.warn(text);
 };
-
 //#endregion
 //#region src/backend/util/errorToString.ts
 /**
@@ -1443,7 +1311,6 @@ const errorToString = (error) => {
 		return parts.join("\n");
 	} else return inspect(error);
 };
-
 //#endregion
 //#region src/backend/handler/plsql/upload.ts
 const debug$11 = debugModule("webplsql:fileUpload");
@@ -1516,7 +1383,6 @@ const uploadFile = async (file, doctable, databaseConnection) => {
 		throw new Error(`Unable to remove file "${file.filename}".\n${errorToString(err)}`);
 	}
 };
-
 //#endregion
 //#region src/backend/handler/plsql/procedureVariable.ts
 const debug$10 = debugModule("webplsql:procedureVariable");
@@ -1559,7 +1425,6 @@ const getProcedureVariable = (_req, procName, argObj) => {
 		}
 	};
 };
-
 //#endregion
 //#region src/backend/handler/plsql/requestError.ts
 var RequestError = class RequestError extends Error {
@@ -1573,7 +1438,6 @@ var RequestError = class RequestError extends Error {
 		this.timestamp = /* @__PURE__ */ new Date();
 	}
 };
-
 //#endregion
 //#region src/backend/util/util.ts
 /**
@@ -1587,7 +1451,6 @@ const stringToNumber = (value) => {
 	if (typeof value !== "string" || !/^[+-]?(?:\d+(?:\.\d+)?|\.\d+)(?:E[+-]?\d+)?$/i.test(value)) return null;
 	return Number(value);
 };
-
 //#endregion
 //#region src/backend/handler/plsql/procedureNamed.ts
 const debug$9 = debugModule("webplsql:procedureNamed");
@@ -1818,7 +1681,6 @@ const getProcedureNamed = async (req, procName, argObj, databaseConnection, argu
 		bind: bindings
 	};
 };
-
 //#endregion
 //#region src/backend/handler/plsql/parsePage.ts
 const debug$8 = debugModule("webplsql:parsePage");
@@ -1951,7 +1813,6 @@ const tryDecodeDate = (value) => {
 	if (Number.isNaN(result.getTime())) return null;
 	return result;
 };
-
 //#endregion
 //#region src/backend/handler/plsql/sendResponse.ts
 const debug$7 = debugModule("webplsql:sendResponse");
@@ -2057,7 +1918,6 @@ const sendResponse = async (_req, res, page) => {
 	});
 	else res.send(page.body);
 };
-
 //#endregion
 //#region src/backend/handler/plsql/procedureError.ts
 var ProcedureError = class ProcedureError extends Error {
@@ -2080,7 +1940,6 @@ var ProcedureError = class ProcedureError extends Error {
 		this.bind = bind;
 	}
 };
-
 //#endregion
 //#region src/backend/util/cache.ts
 /**
@@ -2179,7 +2038,6 @@ var Cache = class {
 		};
 	}
 };
-
 //#endregion
 //#region src/backend/handler/plsql/procedureSanitize.ts
 const debug$6 = debugModule("webplsql:procedureSanitize");
@@ -2250,7 +2108,7 @@ const resolveProcedureName = async (procName, databaseConnection, procedureNameC
 		resolved: {
 			dir: BIND_OUT,
 			type: STRING,
-			maxSize: OWA_RESOLVED_NAME_MAX_LEN
+			maxSize: 400
 		}
 	};
 	try {
@@ -2388,7 +2246,6 @@ const requestValidationFunction = async (procName, validationFunction, databaseC
 	validationFunctionCache.set(key, { valid });
 	return valid;
 };
-
 //#endregion
 //#region src/backend/handler/plsql/owaPageStream.ts
 const debug$5 = debugModule("webplsql:owaPageStream");
@@ -2458,7 +2315,6 @@ var OWAPageStream = class extends Readable {
 		if (content && content.length > 0) this.push(content);
 	}
 };
-
 //#endregion
 //#region src/backend/util/traceManager.ts
 var TraceManager = class {
@@ -2511,7 +2367,6 @@ var TraceManager = class {
 	}
 };
 const traceManager = new TraceManager();
-
 //#endregion
 //#region src/backend/handler/plsql/procedure.ts
 const debug$4 = debugModule("webplsql:procedure");
@@ -2810,7 +2665,6 @@ const invokeProcedure = async (req, res, argObj, cgiObj, filesToUpload, options,
 	}
 	debug$4("invokeProcedure: end");
 };
-
 //#endregion
 //#region src/backend/handler/plsql/cgi.ts
 const debug$3 = debugModule("webplsql:cgi");
@@ -2915,7 +2769,6 @@ const getCGI = (req, doctable, cgi, authenticatedUser = null) => {
 	};
 	return Object.assign({}, DEFAULT_CGI, CGI, cgi);
 };
-
 //#endregion
 //#region src/backend/util/type.ts
 /**
@@ -2924,7 +2777,6 @@ const getCGI = (req, doctable, cgi, authenticatedUser = null) => {
 *	@returns True if the value is a string or an array of strings
 */
 const isStringOrArrayOfString = (value) => typeof value === "string" || Array.isArray(value) && value.every((element) => typeof element === "string");
-
 //#endregion
 //#region src/backend/handler/plsql/request.ts
 const debug$2 = debugModule("webplsql:request");
@@ -3001,16 +2853,15 @@ const processRequest = async (req, res, options, connectionPool, procedureNameCa
 	}
 	debug$2("processRequest: EXIT");
 };
-
 //#endregion
 //#region src/backend/util/jsonLogger.ts
 var JsonLogger = class {
 	stream;
 	constructor(filename = "error.json.log") {
 		this.stream = rotatingFileStream.createStream(filename, {
-			size: JSON_LOG_ROTATION_SIZE,
-			interval: JSON_LOG_ROTATION_INTERVAL,
-			maxFiles: JSON_LOG_MAX_ROTATED_FILES,
+			size: "10M",
+			interval: "1d",
+			maxFiles: 10,
 			compress: "gzip"
 		});
 	}
@@ -3035,7 +2886,6 @@ var JsonLogger = class {
 	}
 };
 const jsonLogger = new JsonLogger();
-
 //#endregion
 //#region src/backend/handler/plsql/errorPage.ts
 /**
@@ -3102,10 +2952,13 @@ const errorPage = (req, res, options, error) => {
 		}
 	});
 	console.error(text);
+	if (res.headersSent) {
+		console.warn("errorPage: Response headers already sent. Cannot show error page.");
+		return;
+	}
 	if (options.errorStyle === "basic") res.status(404).send("Page not found");
 	else res.status(404).send(getHtmlPage(html));
 };
-
 //#endregion
 //#region src/backend/handler/plsql/handlerPlSql.ts
 const debug$1 = debugModule("webplsql:handlerPlSql");
@@ -3125,16 +2978,22 @@ const requestHandler = async (req, res, _next, connectionPool, options, procedur
 		if (options.auth?.type === "basic") {
 			const b64auth = (req.headers.authorization ?? "").split(" ")[1] ?? "";
 			const [login, password] = Buffer.from(b64auth, "base64").toString().split(":");
-			if (login) authenticatedUser = await options.auth.callback(connectionPool, {
+			if (login) authenticatedUser = await options.auth.callback({
 				username: login,
 				password
-			});
+			}, connectionPool);
 			if (authenticatedUser === null) {
 				const realm = options.auth.realm ?? "PL/SQL Gateway";
 				res.set("WWW-Authenticate", `Basic realm="${realm}"`);
 				res.status(401).send("Authentication required.");
 				return;
 			}
+		} else if (options.auth?.type === "custom") {
+			authenticatedUser = await options.auth.callback(req, connectionPool);
+			if (authenticatedUser === null) {
+				res.status(401).send("Authentication required.");
+				return;
+			}
 		}
 		if (typeof req.params.name !== "string" || req.params.name.length === 0) if (typeof options.defaultPage === "string" && options.defaultPage.length > 0) {
 			const newUrl = url.resolve(`${req.originalUrl}/${options.defaultPage}`, "");
@@ -3171,7 +3030,6 @@ const handlerWebPlSql = (connectionPool, config, adminContext) => {
 	handler.argumentCache = argumentCache;
 	return handler;
 };
-
 //#endregion
 //#region src/backend/handler/handlerLogger.ts
 const debug = debugModule("webplsql:handlerLogger");
@@ -3184,7 +3042,6 @@ const handlerLogger = (filename) => {
 	debug("register");
 	return morgan("combined", { stream: fs.createWriteStream(path.join(process.cwd(), filename), { flags: "a" }) });
 };
-
 //#endregion
 //#region src/backend/handler/handlerUpload.ts
 /**
@@ -3198,7 +3055,6 @@ const handlerUpload = (uploadFileSizeLimit) => {
 		limits: { fileSize: uploadFileSizeLimit }
 	}).any();
 };
-
 //#endregion
 //#region src/backend/handler/handlerAdmin.ts
 const version = () => getVersion();
@@ -3382,7 +3238,7 @@ const createAdminRouter = (adminContext) => {
 				res.json({ message: "Server shutting down..." });
 				setTimeout(() => {
 					forceShutdown();
-				}, SHUTDOWN_GRACE_DELAY_MS);
+				}, 100);
 				break;
 			case "pause":
 				adminContext.setPaused(true);
@@ -3434,7 +3290,6 @@ const createAdminRouter = (adminContext) => {
 	});
 	return router;
 };
-
 //#endregion
 //#region src/backend/handler/handlerAdminConsole.ts
 /**
@@ -3534,7 +3389,6 @@ const handlerAdminConsole = (config, adminContext) => {
 	}));
 	return router;
 };
-
 //#endregion
 //#region src/backend/handler/handlerSpaFallback.ts
 /**
@@ -3569,7 +3423,7 @@ const createSpaFallback = (directoryPath, _route) => {
 		});
 	};
 };
-
 //#endregion
 export { AdminContext, createAdminRouter, createServer, createSpaFallback, forceShutdown, getJsonFile, getVersion, handlerAdminConsole, handlerLogger, handlerUpload, handlerWebPlSql, installShutdown, isDirectory, isFile, loadConfig, oracledb_provider_exports as oracledb, readFile, readFileSyncUtf8, removeFile, showConfig, startServer, startServerConfig, z$configType };
+
 //# sourceMappingURL=index.mjs.map