web_plsql 0.12.1 → 0.13.2

package/types/{sendResponse.d.ts → handler/plsql/sendResponse.d.ts}

@@ -1,4 +1,6 @@
 export function sendResponse(req: Request, res: Response, page: pageType): void;
 export type Request = import("express").Request;
 export type Response = import("express").Response;
-export type pageType = import("./types.js").pageType;
+export type CookieOptions = import("express").CookieOptions;
+export type pageType = import("../../types.js").pageType;
+export type cookieType = import("../../types.js").cookieType;

package/types/{upload.d.ts → handler/plsql/upload.d.ts}

@@ -2,4 +2,4 @@ export function getFiles(req: Request): fileUploadType[];
 export function uploadFile(file: fileUploadType, doctable: string, databaseConnection: Connection): Promise<void>;
 export type Request = import("express").Request;
 export type Connection = import("oracledb").Connection;
-export type fileUploadType = import("./types.js").fileUploadType;
+export type fileUploadType = import("../../types.js").fileUploadType;

package/types/index.d.ts

@@ -1,9 +1,8 @@
-export * from "./shutdown.js";
-export * from "./oracle.js";
-export * from "./file.js";
-export * from "./tty.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";
+export * from "./util/shutdown.js";
+export * from "./util/oracle.js";
+export * from "./util/file.js";
+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";
+export { createServer, startServer, loadConfig, startServerConfig } from "./server/server.js";

package/types/server/config.d.ts

@@ -0,0 +1,2 @@
+export function showConfig(config: configType): void;
+export type configType = import("../types.js").configType;

package/types/server/server.d.ts

@@ -0,0 +1,52 @@
+export function createServer(app: Express, ssl?: sslConfig): http.Server | https.Server;
+export function startServer(config: configType, ssl?: sslConfig): Promise<webServer>;
+export function loadConfig(filename?: string): configType;
+export function startServerConfig(filename?: string, ssl?: sslConfig): Promise<webServer>;
+export type Socket = import("node:net").Socket;
+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;
+/**
+ * - Web server interface.
+ */
+export type webServer = {
+    /**
+     * - Configuration object.
+     */
+    config: configType;
+    /**
+     * - Oracle connection pools.
+     */
+    connectionPools: Pool[];
+    /**
+     * - Express app.
+     */
+    app: Express;
+    /**
+     * - Native Node http(s) server instance.
+     */
+    server: http.Server | https.Server;
+    /**
+     * - Shutdown function.
+     */
+    shutdown: () => Promise<void>;
+};
+/**
+ * - SSL configuration.
+ */
+export type sslConfig = {
+    /**
+     * - key filename.
+     */
+    keyFilename: string;
+    /**
+     * - cert filename.
+     */
+    certFilename: string;
+};
+import http from 'node:http';
+import https from 'node:https';

package/types/types.d.ts

@@ -1,5 +1,6 @@
 /**
  * @typedef {import('oracledb').BindParameter} BindParameter
+ * @typedef {import('express').CookieOptions} CookieOptions
  */
 /**
  * @typedef {'basic' | 'debug'} errorStyleType
@@ -78,7 +79,6 @@ export const z$configPlSqlType: z.ZodObject<{
  * @property {configStaticType[]} routeStatic - The static routes.
  * @property {configPlSqlType[]} routePlSql - The PL/SQL routes.
  * @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.ZodObject<{
     port: z.ZodNumber;
@@ -103,9 +103,9 @@ export const z$configType: z.ZodObject<{
         }>;
     }, z.core.$strict>>;
     loggerFilename: z.ZodString;
-    monitorConsole: z.ZodBoolean;
 }, z.core.$strict>;
 export type BindParameter = import("oracledb").BindParameter;
+export type CookieOptions = import("express").CookieOptions;
 export type errorStyleType = "basic" | "debug";
 export type configStaticType = {
     /**
@@ -187,10 +187,6 @@ export type configType = {
      * - name of the request logger filename or '' if not required.
      */
     loggerFilename: string;
-    /**
-     * - Enable console status monitor.
-     */
-    monitorConsole: boolean;
 };
 /**
  * Environment variables as string key-value pairs
@@ -247,25 +243,9 @@ export type cookieType = {
      */
     value: string;
     /**
-     * - The path of the cookie.
+     * - The cookie options.
      */
-    path?: string;
-    /**
-     * - The domain of the cookie.
-     */
-    domain?: string;
-    /**
-     * - The secure flag.
-     */
-    secure?: string;
-    /**
-     * - The expiration date.
-     */
-    expires?: Date;
-    /**
-     * - The httpOnly flag.
-     */
-    httpOnly?: boolean;
+    options: CookieOptions;
 };
 /**
  * - The page.
@@ -297,17 +277,4 @@ export type pageType = {
         fileBlob: Buffer | null;
     };
 };
-/**
- * - The metrics.
- */
-export type metricsType = {
-    /**
-     * - The total number of requests.
-     */
-    totalRequests: number;
-    /**
-     * - The number of requests in the last second.
-     */
-    requestsInLastInterval: number;
-};
 import z from 'zod';

package/types/util/type.d.ts

@@ -0,0 +1 @@
+export function isStringOrArrayOfString(value: unknown): value is string | string[];

package/src/handlerMetrics.js

@@ -1,46 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:handlerMetrics');
-
-/**
- * @typedef {import('express').RequestHandler} RequestHandler
- * @typedef {import('./types.js').metricsType} metricsType
- */
-
-/**
- * metrics initializer.
- * @returns {metricsType} The metrics.
- */
-export const initMetrics = () => {
-	return {
-		totalRequests: 0,
-		requestsInLastInterval: 0,
-	};
-};
-
-/**
- * The metrics handler.
- * @param {metricsType} metrics - the nmetrics.
- * @returns {RequestHandler} - Request handler.
- */
-export const handlerMetrics = (metrics) => {
-	debug('register');
-
-	metrics.totalRequests = 0;
-	metrics.requestsInLastInterval = 0;
-
-	return (req, res, next) => {
-		metrics.totalRequests++;
-		metrics.requestsInLastInterval++;
-
-		if (debug.enabled) {
-			const start = process.hrtime();
-			res.on('finish', () => {
-				const [seconds, nanoseconds] = process.hrtime(start);
-				const duration = seconds * 1000 + nanoseconds / 1_000_000;
-				debug(`Request to ${req.params?.name} ${req.url} took ${duration.toFixed(3)}ms`);
-			});
-		}
-
-		next();
-	};
-};

package/src/server.js

@@ -1,223 +0,0 @@
-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';
-import compression from 'compression';
-import {z$configType} from './types.js';
-import {installShutdown} from './shutdown.js';
-import {writeAfterEraseLine} from './tty.js';
-import {poolCreate, poolsClose} from '../src/oracle.js';
-import {handlerUpload} from './handlerUpload.js';
-import {handlerLogger} from './handlerLogger.js';
-import {initMetrics, handlerMetrics} from './handlerMetrics.js';
-import {handlerWebPlSql} from './handlerPlSql.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
- * @typedef {import('oracledb').Pool} Pool
- * @typedef {import('./types.js').environmentType} environmentType
- * @typedef {import('./types.js').configType} configType
- */
-
-/**
- * Show configuration.
- * @param {configType} config - The config.
- * @returns {void}
- */
-export const showConfig = (config) => {
-	console.log('-'.repeat(80));
-	console.log('NODE PL/SQL SERVER');
-	console.log('-'.repeat(80));
-
-	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}"`);
-		});
-	}
-
-	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}"`);
-		});
-	}
-
-	console.log('-'.repeat(80));
-};
-
-/**
- * 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);
-		});
-	});
-};
-
-/**
- * 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));
-	}
-
-	// Default middleware
-	app.use(handlerUpload());
-	app.use(bodyParser.json());
-	app.use(bodyParser.urlencoded({extended: true}));
-	app.use(cookieParser());
-	app.use(compression());
-
-	/** @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);
-		connectionPools.push(pool);
-
-		app.use([`${i.route}/:name`, i.route], handlerWebPlSql(pool, i));
-	}
-
-	// Update metrics every second
-	if (config.monitorConsole) {
-		setInterval(() => {
-			// Update requests per second
-			const requestsLastInterval = metrics.requestsInLastInterval;
-			metrics.requestsInLastInterval = 0;
-
-			// Clear console and display metrics
-			writeAfterEraseLine(`Total requests: ${metrics.totalRequests}, requests per second: ${requestsLastInterval}`);
-		}, 1000);
-	}
-
-	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/tty.js

@@ -1,48 +0,0 @@
-/**
- * Write to stdout.
- * @param {string} text - text to write.
- * @returns {void}
- */
-export const write = (text) => {
-	if (process.stdout.isTTY) {
-		process.stdout.write(text);
-	}
-};
-
-/**
- * Write to stdout with new line.
- * @param {string} text - text to write.
- * @returns {void}
- */
-export const writeNewLine = (text = '') => {
-	if (process.stdout.isTTY) {
-		process.stdout.write(`${text}\n`);
-	}
-};
-
-/**
- * Write to stdout after erasing line.
- * @param {string} text - text to write.
- * @returns {void}
- */
-export const writeAfterEraseLine = (text) => {
-	if (process.stdout.isTTY) {
-		process.stdout.clearLine(0);
-		process.stdout.cursorTo(0);
-		process.stdout.write(text);
-	}
-};
-
-/**
- * Write to stdout starting a column.
- * @param {string} text - text to write.
- * @param {number} column - column.
- * @returns {void}
- */
-export const writeStartingOnColumn = (text, column) => {
-	if (process.stdout.isTTY) {
-		process.stdout.cursorTo(column);
-		process.stdout.clearLine(1);
-		process.stdout.write(text);
-	}
-};

package/types/handlerMetrics.d.ts

@@ -1,4 +0,0 @@
-export function initMetrics(): metricsType;
-export function handlerMetrics(metrics: metricsType): RequestHandler;
-export type RequestHandler = import("express").RequestHandler;
-export type metricsType = import("./types.js").metricsType;

package/types/parsePage.d.ts

@@ -1,3 +0,0 @@
-export function parsePage(text: string): pageType;
-export type pageType = import("./types.js").pageType;
-export type cookieType = import("./types.js").cookieType;

package/types/server.d.ts

@@ -1,14 +0,0 @@
-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/tty.d.ts

@@ -1,4 +0,0 @@
-export function write(text: string): void;
-export function writeNewLine(text?: string): void;
-export function writeAfterEraseLine(text: string): void;
-export function writeStartingOnColumn(text: string, column: number): void;