web_plsql 1.2.0 → 1.3.1

package/types/handler/handlerAdmin.d.ts

@@ -1,79 +0,0 @@
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('express').Response} Response
- * @typedef {import('express').NextFunction} NextFunction
- */
-/**
- * @typedef {import('../util/statsManager.js').Bucket} Bucket
- */
-/**
- * @typedef {object} StatsSummary
- * @property {Date} startTime - Server start time.
- * @property {number} totalRequests - Total requests handled.
- * @property {number} totalErrors - Total errors encountered.
- * @property {number} avgResponseTime - Lifetime average response time.
- * @property {number} minResponseTime - Lifetime minimum response time.
- * @property {number} maxResponseTime - Lifetime maximum response time.
- * @property {number} maxRequestsPerSecond - Lifetime maximum requests per second.
- * @property {object} maxMemory - Lifetime memory extremes.
- * @property {number} maxMemory.heapUsedMax - Maximum heap used.
- * @property {number} maxMemory.heapTotalMax - Maximum heap total.
- * @property {number} maxMemory.rssMax - Maximum RSS.
- * @property {number} maxMemory.externalMax - Maximum external memory.
- * @property {object} cpu - Lifetime CPU extremes.
- * @property {number} cpu.max - Max CPU.
- * @property {number} cpu.userMax - Max user CPU.
- * @property {number} cpu.systemMax - Max system CPU.
- */
-export const handlerAdmin: import("express-serve-static-core").Router;
-export type Request = import("express").Request;
-export type Response = import("express").Response;
-export type NextFunction = import("express").NextFunction;
-export type Bucket = import("../util/statsManager.js").Bucket;
-export type StatsSummary = {
-    /**
-     * - Server start time.
-     */
-    startTime: Date;
-    /**
-     * - Total requests handled.
-     */
-    totalRequests: number;
-    /**
-     * - Total errors encountered.
-     */
-    totalErrors: number;
-    /**
-     * - Lifetime average response time.
-     */
-    avgResponseTime: number;
-    /**
-     * - Lifetime minimum response time.
-     */
-    minResponseTime: number;
-    /**
-     * - Lifetime maximum response time.
-     */
-    maxResponseTime: number;
-    /**
-     * - Lifetime maximum requests per second.
-     */
-    maxRequestsPerSecond: number;
-    /**
-     * - Lifetime memory extremes.
-     */
-    maxMemory: {
-        heapUsedMax: number;
-        heapTotalMax: number;
-        rssMax: number;
-        externalMax: number;
-    };
-    /**
-     * - Lifetime CPU extremes.
-     */
-    cpu: {
-        max: number;
-        userMax: number;
-        systemMax: number;
-    };
-};

package/types/handler/handlerLogger.d.ts

@@ -1,2 +0,0 @@
-export function handlerLogger(filename: string): RequestHandler;
-export type RequestHandler = import("express").RequestHandler;

package/types/handler/handlerUpload.d.ts

@@ -1,7 +0,0 @@
-export function handlerUpload(uploadFileSizeLimit?: number): RequestHandler;
-export type RequestHandler = import("express").RequestHandler;
-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;

package/types/handler/plsql/cgi.d.ts

@@ -1,4 +0,0 @@
-export function getCGI(req: Request, doctable: string, cgi: environmentType): environmentType;
-export type Request = import("express").Request;
-export type environmentType = import("../../types.js").environmentType;
-export type configPlSqlType = import("../../types.js").configPlSqlType;

package/types/handler/plsql/errorPage.d.ts

@@ -1,11 +0,0 @@
-export function errorPage(req: Request, res: Response, options: configPlSqlHandlerType, error: unknown): void;
-export type Request = import("express").Request;
-export type Response = import("express").Response;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;
-export type environmentType = import("../../types.js").environmentType;
-export type configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type outputType = {
-    html: string;
-    text: string;
-};
-export type messageType = import("../../util/trace.js").messageType;

package/types/handler/plsql/handlerPlSql.d.ts

@@ -1,13 +0,0 @@
-export function handlerWebPlSql(connectionPool: Pool, config: configPlSqlHandlerType): WebPlSqlRequestHandler;
-export type RequestHandler = import("express").RequestHandler;
-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 configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type WebPlSqlRequestHandler = import("express").RequestHandler & {
-    procedureNameCache: Cache<string>;
-    argumentCache: Cache<import("./procedureNamed.js").argsType>;
-};
-import { Cache } from '../../util/cache.js';

package/types/handler/plsql/owaPageStream.d.ts

@@ -1,28 +0,0 @@
-/**
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('../../types.js').BindParameterConfig} BindParameterConfig
- */
-export class OWAPageStream extends Readable {
-    /**
-     * @param {Connection} databaseConnection - The database connection.
-     */
-    constructor(databaseConnection: Connection);
-    databaseConnection: oracledb.Connection;
-    chunkSize: number;
-    isDone: boolean;
-    /**
-     * Fetch a chunk of the page from the database.
-     * @returns {Promise<string[]>} The array of lines fetched.
-     */
-    fetchChunk(): Promise<string[]>;
-    /**
-     * Add initial body content to the stream.
-     * @param {string} content - The initial content to prepend.
-     * @returns {void}
-     */
-    addBody(content: string): void;
-}
-export type Connection = import("oracledb").Connection;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;
-import { Readable } from 'node:stream';
-import oracledb from 'oracledb';

package/types/handler/plsql/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/handler/plsql/procedure.d.ts

@@ -1,13 +0,0 @@
-export function invokeProcedure(req: Request, res: Response, argObj: argObjType, cgiObj: environmentType, filesToUpload: fileUploadType[], options: configPlSqlHandlerType, databaseConnection: Connection, procedureNameCache: ProcedureNameCache, argumentCache: ArgumentCache): Promise<void>;
-export type TraceEntry = import("../../admin/js/types.js").TraceEntry;
-export type Request = import("express").Request;
-export type Response = import("express").Response;
-export type Connection = import("oracledb").Connection;
-export type Result = import("oracledb").Result<unknown>;
-export type argObjType = import("../../types.js").argObjType;
-export type fileUploadType = import("../../types.js").fileUploadType;
-export type environmentType = import("../../types.js").environmentType;
-export type configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;
-export type ProcedureNameCache = import("../../util/cache.js").Cache<string>;
-export type ArgumentCache = import("../../util/cache.js").Cache<import("./procedureNamed.js").argsType>;

package/types/handler/plsql/procedureError.d.ts

@@ -1,23 +0,0 @@
-/**
- * @typedef {import('../../types.js').environmentType} environmentType
- * @typedef {import('../../types.js').BindParameterConfig} BindParameterConfig
- */
-export class ProcedureError extends Error {
-    /**
-     * @param {string} message - The error message.
-     * @param {environmentType} environment - The environment.
-     * @param {string} sql - The SQL to execute.
-     * @param {BindParameterConfig} bind - The bind parameters.
-     */
-    constructor(message: string, environment: environmentType, sql: string, bind: BindParameterConfig);
-    /** @type {Date} */
-    timestamp: Date;
-    /** @type {environmentType} */
-    environment: environmentType;
-    /** @type {string} */
-    sql: string;
-    /** @type {BindParameterConfig} */
-    bind: BindParameterConfig;
-}
-export type environmentType = import("../../types.js").environmentType;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;

package/types/handler/plsql/procedureNamed.d.ts

@@ -1,14 +0,0 @@
-export function getBinding(argName: string, argValue: unknown, argType: string): BindParameter;
-export function getProcedureNamed(req: Request, procName: string, argObj: argObjType, databaseConnection: Connection, argumentCache: ArgumentCache): Promise<{
-    sql: string;
-    bind: BindParameterConfig;
-}>;
-export type Request = import("express").Request;
-export type Connection = import("oracledb").Connection;
-export type Result = import("oracledb").Result<unknown>;
-export type configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type argObjType = import("../../types.js").argObjType;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;
-export type BindParameter = import("../../types.js").BindParameter;
-export type argsType = Record<string, string>;
-export type ArgumentCache = import("../../util/cache.js").Cache<argsType>;

package/types/handler/plsql/procedureSanitize.d.ts

@@ -1,11 +0,0 @@
-export function sanitizeProcName(procName: string, databaseConnection: Connection, options: configPlSqlHandlerType, procedureNameCache: ProcedureNameCache): Promise<string>;
-export type Request = import("express").Request;
-export type Response = import("express").Response;
-export type Connection = import("oracledb").Connection;
-export type Result = import("oracledb").Result<unknown>;
-export type argObjType = import("../../types.js").argObjType;
-export type fileUploadType = import("../../types.js").fileUploadType;
-export type environmentType = import("../../types.js").environmentType;
-export type configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;
-export type ProcedureNameCache = import("../../util/cache.js").Cache<string>;

package/types/handler/plsql/procedureVariable.d.ts

@@ -1,10 +0,0 @@
-export function getProcedureVariable(_req: Request, procName: string, argObj: argObjType): {
-    sql: string;
-    bind: BindParameterConfig;
-};
-export type Request = import("express").Request;
-export type Connection = import("oracledb").Connection;
-export type Result = import("oracledb").Result<unknown>;
-export type configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type argObjType = import("../../types.js").argObjType;
-export type BindParameterConfig = import("../../types.js").BindParameterConfig;

package/types/handler/plsql/request.d.ts

@@ -1,9 +0,0 @@
-export function processRequest(req: Request, res: Response, options: configPlSqlHandlerType, connectionPool: Pool, procedureNameCache: ProcedureNameCache, argumentCache: ArgumentCache): Promise<void>;
-export type Request = import("express").Request;
-export type Response = import("express").Response;
-export type Pool = import("oracledb").Pool;
-export type Connection = import("oracledb").Connection;
-export type argObjType = import("../../types.js").argObjType;
-export type configPlSqlHandlerType = import("../../types.js").configPlSqlHandlerType;
-export type ProcedureNameCache = import("../../util/cache.js").Cache<string>;
-export type ArgumentCache = import("../../util/cache.js").Cache<import("./procedureNamed.js").argsType>;

package/types/handler/plsql/requestError.d.ts

@@ -1,8 +0,0 @@
-export class RequestError extends Error {
-    /**
-     * @param {string} message - The error message.
-     */
-    constructor(message: string);
-    /** @type {Date} */
-    timestamp: Date;
-}

package/types/handler/plsql/sendResponse.d.ts

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

package/types/handler/plsql/upload.d.ts

@@ -1,5 +0,0 @@
-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;

package/types/index.d.ts

@@ -1,10 +0,0 @@
-export { oracledb };
-export { getVersion } from "./version.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";
-import oracledb from 'oracledb';
-export { createServer, startServer, loadConfig, startServerConfig } from "./server/server.js";

package/types/server/adminContext.d.ts

@@ -1,17 +0,0 @@
-export namespace AdminContext {
-    let startTime: Date;
-    let config: configType | null;
-    let pools: Pool[];
-    let caches: Array<{
-        poolName: string;
-        procedureNameCache: Cache;
-        argumentCache: Cache;
-    }>;
-    let paused: boolean;
-    let statsManager: StatsManager;
-}
-export type Pool = import("oracledb").Pool;
-export type configType = import("../types.js").configType;
-export type argsType = import("../handler/plsql/procedureNamed.js").argsType;
-export type Cache = import("../util/cache.js").Cache<unknown>;
-import { StatsManager } from '../util/statsManager.js';

package/types/server/config.d.ts

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

package/types/server/server.d.ts

@@ -1,57 +0,0 @@
-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;
-export type argsType = import("../handler/plsql/procedureNamed.js").argsType;
-export type ExtendedRequestHandler = import("express").RequestHandler & {
-    procedureNameCache: import("../util/cache.js").Cache<string>;
-    argumentCache: import("../util/cache.js").Cache<argsType>;
-};
-/**
- * - 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';