web_plsql 0.3.2 → 0.5.0

package/src/procedureError.ts

@@ -1,27 +1,27 @@
-/*
-*	RequestError
-*/
-
-import {environmentType} from './cgi';
-
-export class ProcedureError extends Error {
-	timestamp: Date;
-	environment: environmentType;
-	sql: string;
-	bind: any;
-
-	constructor(message: string, environment: environmentType, sql: string, bind: any) {
-		super(message);
-
-		// Maintains proper stack trace for where our error was thrown (only available on V8)
-		if (Error.captureStackTrace) {
-			Error.captureStackTrace(this, ProcedureError);
-		}
-
-		// Custom debugging information
-		this.timestamp = new Date();
-		this.environment = environment;
-		this.sql = sql;
-		this.bind = bind;
-	}
-}
+/*
+*	RequestError
+*/
+
+import {environmentType} from './cgi';
+
+export class ProcedureError extends Error {
+	timestamp: Date;
+	environment: environmentType;
+	sql: string;
+	bind: unknown;
+
+	constructor(message: string, environment: environmentType, sql: string, bind: unknown) {
+		super(message);
+
+		// Maintains proper stack trace for where our error was thrown (only available on V8)
+		if (Error.captureStackTrace) {
+			Error.captureStackTrace(this, ProcedureError);
+		}
+
+		// Custom debugging information
+		this.timestamp = new Date();
+		this.environment = environment;
+		this.sql = sql;
+		this.bind = bind;
+	}
+}

package/src/request.ts

@@ -1,139 +1,139 @@
-/*
-*	Process the http request
-*/
-
-import util from 'util';
-import oracledb from 'oracledb';
-import {invokeProcedure} from './procedure';
-import {getCGI} from './cgi';
-import {getFiles} from './fileUpload';
-import {RequestError} from './requestError';
-import {Trace} from './trace';
-import express from 'express';
-import {oracleExpressMiddleware$options} from './config';
-
-/**
-* Process the request
-*
-* @param {express.Request} req - The req object represents the HTTP request.
-* @param {express.Response} res - The res object represents the HTTP response that an Express app sends when it gets an HTTP request.
-* @param {oracleExpressMiddleware$options} options - the options for the middleware.
-* @param {Promise<oracledb.Pool>} databasePoolPromise - Promise returning a database pool.
-* @param {Trace} trace - Tracing object.
-* returns {Promise<void>} - Promise that resolves when the request has been fullfilled.
-*/
-export async function processRequest(req: express.Request, res: express.Response, options: oracleExpressMiddleware$options, databasePoolPromise: Promise<oracledb.Pool>, trace: Trace): Promise<void> {
-	trace.write('processRequest: ENTER');
-
-	let databasePool;
-	let databaseConnection;
-
-	// wait until the database pool has been allocated
-	try {
-		databasePool = await databasePoolPromise;
-		trace.write('processRequest: Connection pool has been allocated');
-	} catch (e) {
-		/* istanbul ignore next */
-		throw new RequestError(`Unable to create database pool.\n${e.message}`);
-	}
-
-	// open database connection
-	try {
-		databaseConnection = await databasePool.getConnection();
-		trace.write('processRequest: Connection has been allocated');
-	} catch (e) {
-		/* istanbul ignore next */
-		throw new RequestError(`Unable to open database connection\n${e.message}`);
-	}
-
-	// execute request
-	await executeRequest(req, res, options, databaseConnection, trace);
-
-	// close database connection
-	try {
-		await databaseConnection.release();
-		trace.write('processRequest: Connection has been released');
-	} catch (e) {
-		/* istanbul ignore next */
-		console.error(`Unable to release database connection\n${e.message}`);
-	}
-
-	trace.write('processRequest: EXIT');
-}
-
-/**
-* Execute the request
-*
-* @param {express.Request} req - The req object represents the HTTP request.
-* @param {express.Response} res - The res object represents the HTTP response that an Express app sends when it gets an HTTP request.
-* @param {oracleExpressMiddleware$options} options - the options for the middleware.
-* @param {oracledb.Connection} databaseConnection - Database connection.
-* @param {Trace} trace - Tracing object.
-* @returns {Promise<void>} - Promise resolving to th page
-*/
-async function executeRequest(req: express.Request, res: express.Response, options: oracleExpressMiddleware$options, databaseConnection: oracledb.Connection, trace: Trace): Promise<void> {
-	trace.write('executeRequest: ENTER');
-
-	// Get the CGI
-	const cgiObj = getCGI(req, options);
-
-	// Add the query properties
-	const argObj: any = {};
-	Object.assign(argObj, req.query);
-
-	// Does the request contain any files
-	const filesToUpload = getFiles(req);
-	trace.write(`executeRequest: "${filesToUpload.length}" files to upload:\n${Trace.inspect(filesToUpload)}`);
-	/* istanbul ignore next */
-	if (filesToUpload.length > 0 && (typeof options.doctable !== 'string' || options.doctable.length === 0)) {
-		const error = 'Unable to upload files if no document table "doctable" has been configured';
-		trace.write(error);
-		throw new RequestError(error);
-	}
-
-	// Add the files to the arguments
-	filesToUpload.reduce((aggregator, file) => {
-		aggregator[file.fieldValue] = file.filename;
-		return aggregator;
-	}, argObj);
-
-	// Does the request contain a body
-	Object.assign(argObj, normalizeBody(req));
-
-	// invoke the Oracle procedure and get the page contenst
-	await invokeProcedure(req, res, argObj, cgiObj, filesToUpload, options, databaseConnection, trace);
-
-	trace.write('executeRequest: EXIT');
-
-	return Promise.resolve();
-}
-
-/*
-*	Normalize the body by making sure that only "simple" parameters and no nested objects are submitted
-*/
-function normalizeBody(req: express.Request): {[key: string]: string} {
-	const args: {[key: string]: string} = {};
-	/* istanbul ignore else */
-	if (typeof req.body === 'object') {
-		for (const key in req.body) {
-			const value = req.body[key];
-			/* istanbul ignore else */
-			if (isStringOrArrayOfString(value)) {
-				args[key] = value;
-			} else {
-				/* istanbul ignore next */
-				throw new RequestError(`The element "${key}" in the body is not a string or an array of strings!\n` + util.inspect(req.body, {showHidden: false, depth: null, colors: false}));
-			}
-		}
-	}
-
-	return args;
-}
-
-/*
-*	Is the given value a string or an array of strings
-*/
-function isStringOrArrayOfString(value: any): boolean {
-	/* istanbul ignore next */
-	return typeof value === 'string' || (Array.isArray(value) && value.every(element => typeof element === 'string'));
-}
+/*
+*	Process the http request
+*/
+
+import util from 'util';
+import oracledb from 'oracledb';
+import {invokeProcedure} from './procedure';
+import {getCGI} from './cgi';
+import {getFiles} from './fileUpload';
+import {RequestError} from './requestError';
+import {Trace} from './trace';
+import express from 'express';
+import {oracleExpressMiddleware$options} from './config';
+
+/**
+* Process the request
+*
+* @param {express.Request} req - The req object represents the HTTP request.
+* @param {express.Response} res - The res object represents the HTTP response that an Express app sends when it gets an HTTP request.
+* @param {oracleExpressMiddleware$options} options - the options for the middleware.
+* @param {Promise<oracledb.Pool>} databasePoolPromise - Promise returning a database pool.
+* @param {Trace} trace - Tracing object.
+* returns {Promise<void>} - Promise that resolves when the request has been fullfilled.
+*/
+export async function processRequest(req: express.Request, res: express.Response, options: oracleExpressMiddleware$options, databasePoolPromise: Promise<oracledb.Pool>, trace: Trace): Promise<void> {
+	trace.write('processRequest: ENTER');
+
+	let databasePool;
+	let databaseConnection;
+
+	// wait until the database pool has been allocated
+	try {
+		databasePool = await databasePoolPromise;
+		trace.write('processRequest: Connection pool has been allocated');
+	} catch (err) {
+		/* istanbul ignore next */
+		throw new RequestError(`Unable to create database pool.\n${err instanceof Error ? err.message : ''}`);
+	}
+
+	// open database connection
+	try {
+		databaseConnection = await databasePool.getConnection();
+		trace.write('processRequest: Connection has been allocated');
+	} catch (err) {
+		/* istanbul ignore next */
+		throw new RequestError(`Unable to open database connection\n${err instanceof Error ? err.message: ''}`);
+	}
+
+	// execute request
+	await executeRequest(req, res, options, databaseConnection, trace);
+
+	// close database connection
+	try {
+		await databaseConnection.release();
+		trace.write('processRequest: Connection has been released');
+	} catch (err) {
+		/* istanbul ignore next */
+		console.error(`Unable to release database connection\n${err instanceof Error ? err.message : ''}`);
+	}
+
+	trace.write('processRequest: EXIT');
+}
+
+/**
+* Execute the request
+*
+* @param {express.Request} req - The req object represents the HTTP request.
+* @param {express.Response} res - The res object represents the HTTP response that an Express app sends when it gets an HTTP request.
+* @param {oracleExpressMiddleware$options} options - the options for the middleware.
+* @param {oracledb.Connection} databaseConnection - Database connection.
+* @param {Trace} trace - Tracing object.
+* @returns {Promise<void>} - Promise resolving to th page
+*/
+async function executeRequest(req: express.Request, res: express.Response, options: oracleExpressMiddleware$options, databaseConnection: oracledb.Connection, trace: Trace): Promise<void> {
+	trace.write('executeRequest: ENTER');
+
+	// Get the CGI
+	const cgiObj = getCGI(req, options);
+
+	// Add the query properties
+	const argObj: any = {};
+	Object.assign(argObj, req.query);
+
+	// Does the request contain any files
+	const filesToUpload = getFiles(req);
+	trace.write(`executeRequest: "${filesToUpload.length}" files to upload:\n${Trace.inspect(filesToUpload)}`);
+	/* istanbul ignore next */
+	if (filesToUpload.length > 0 && (typeof options.doctable !== 'string' || options.doctable.length === 0)) {
+		const error = 'Unable to upload files if no document table "doctable" has been configured';
+		trace.write(error);
+		throw new RequestError(error);
+	}
+
+	// Add the files to the arguments
+	filesToUpload.reduce((aggregator, file) => {
+		aggregator[file.fieldValue] = file.filename;
+		return aggregator;
+	}, argObj);
+
+	// Does the request contain a body
+	Object.assign(argObj, normalizeBody(req));
+
+	// invoke the Oracle procedure and get the page contenst
+	await invokeProcedure(req, res, argObj, cgiObj, filesToUpload, options, databaseConnection, trace);
+
+	trace.write('executeRequest: EXIT');
+
+	return Promise.resolve();
+}
+
+/*
+*	Normalize the body by making sure that only "simple" parameters and no nested objects are submitted
+*/
+function normalizeBody(req: express.Request): {[key: string]: string} {
+	const args: {[key: string]: string} = {};
+	/* istanbul ignore else */
+	if (typeof req.body === 'object') {
+		for (const key in req.body) {
+			const value = req.body[key];
+			/* istanbul ignore else */
+			if (isStringOrArrayOfString(value)) {
+				args[key] = value;
+			} else {
+				/* istanbul ignore next */
+				throw new RequestError(`The element "${key}" in the body is not a string or an array of strings!\n` + util.inspect(req.body, {showHidden: false, depth: null, colors: false}));
+			}
+		}
+	}
+
+	return args;
+}
+
+/*
+*	Is the given value a string or an array of strings
+*/
+function isStringOrArrayOfString(value: any): boolean {
+	/* istanbul ignore next */
+	return typeof value === 'string' || (Array.isArray(value) && value.every(element => typeof element === 'string'));
+}

package/src/requestError.ts

@@ -1,19 +1,19 @@
-/*
-*	RequestError
-*/
-
-export class RequestError extends Error {
-	timestamp: Date;
-
-	constructor(message: string) {
-		super(message);
-
-		// Maintains proper stack trace for where our error was thrown (only available on V8)
-		if (Error.captureStackTrace) {
-			Error.captureStackTrace(this, RequestError);
-		}
-
-		// Custom debugging information
-		this.timestamp = new Date();
-	}
-}
+/*
+*	RequestError
+*/
+
+export class RequestError extends Error {
+	timestamp: Date;
+
+	constructor(message: string) {
+		super(message);
+
+		// Maintains proper stack trace for where our error was thrown (only available on V8)
+		if (Error.captureStackTrace) {
+			Error.captureStackTrace(this, RequestError);
+		}
+
+		// Custom debugging information
+		this.timestamp = new Date();
+	}
+}

package/src/stream.ts

@@ -1,26 +1,26 @@
-import stream from 'stream';
-
-/**
-*	Convert a readable stream to a buffer.
-*
-* @param {stream.Readable} readable - The readable stream.
-* @returns {Promise<Buffer>} - The buffer.
-*/
-export async function streamToBuffer(readable: stream.Readable): Promise<Buffer> {
-	return new Promise((resolve, reject) => {
-		const buffers: Array<Buffer> = [];
-
-		readable.on('data', buffer => {
-			buffers.push(buffer);
-		});
-
-		readable.on('end', () => {
-			resolve(Buffer.concat(buffers));
-		});
-
-		readable.on('error', err => {
-			// istanbul ignore next
-			reject(err);
-		});
-	});
-}
+import stream from 'stream';
+
+/**
+*	Convert a readable stream to a buffer.
+*
+* @param {stream.Readable} readable - The readable stream.
+* @returns {Promise<Buffer>} - The buffer.
+*/
+export async function streamToBuffer(readable: stream.Readable): Promise<Buffer> {
+	return new Promise((resolve, reject) => {
+		const buffers: Array<Buffer> = [];
+
+		readable.on('data', buffer => {
+			buffers.push(buffer);
+		});
+
+		readable.on('end', () => {
+			resolve(Buffer.concat(buffers));
+		});
+
+		readable.on('error', err => {
+			// istanbul ignore next
+			reject(err);
+		});
+	});
+}