web_plsql 0.17.1 → 1.0.0

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

@@ -1,7 +1,9 @@
-export function processRequest(req: Request, res: Response, options: configPlSqlHandlerType, connectionPool: Pool): Promise<void>;
+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/sendResponse.d.ts

@@ -1,4 +1,4 @@
-export function sendResponse(req: Request, res: Response, page: pageType): void;
+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;

package/types/server/server.d.ts

@@ -1,3 +1,19 @@
+export namespace AdminContext {
+    let startTime: Date;
+    let config: configType | null;
+    let pools: Pool[];
+    let caches: Array<{
+        poolName: string;
+        procedureNameCache: Cache<string>;
+        argumentCache: Cache<argsType>;
+    }>;
+    let paused: boolean;
+    namespace metrics {
+        let requestCount: number;
+        let errorCount: number;
+        let totalDuration: number;
+    }
+}
 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;
@@ -10,6 +26,11 @@ 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: Cache<string>;
+    argumentCache: Cache<argsType>;
+};
 /**
  * - Web server interface.
  */
@@ -48,5 +69,6 @@ export type sslConfig = {
      */
     certFilename: string;
 };
+import { Cache } from '../util/cache.js';
 import http from 'node:http';
 import https from 'node:https';

package/types/types.d.ts

@@ -92,6 +92,9 @@ export const z$configPlSqlType: z.ZodObject<{
  * @property {configPlSqlType[]} routePlSql - The PL/SQL routes.
  * @property {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
  * @property {string} loggerFilename - name of the request logger filename or '' if not required.
+ * @property {string} [adminRoute] - Optional route for the admin console (defaults to /admin).
+ * @property {string} [adminUser] - Optional username for admin console basic auth.
+ * @property {string} [adminPassword] - Optional password for admin console basic auth.
  */
 export const z$configType: z.ZodObject<{
     port: z.ZodNumber;
@@ -118,6 +121,9 @@ export const z$configType: z.ZodObject<{
     }, z.core.$strict>>;
     uploadFileSizeLimit: z.ZodOptional<z.ZodNumber>;
     loggerFilename: z.ZodString;
+    adminRoute: z.ZodOptional<z.ZodString>;
+    adminUser: z.ZodOptional<z.ZodString>;
+    adminPassword: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 export type BindParameter = import("oracledb").BindParameter;
 export type Connection = import("oracledb").Connection;
@@ -217,6 +223,18 @@ export type configType = {
      * - name of the request logger filename or '' if not required.
      */
     loggerFilename: string;
+    /**
+     * - Optional route for the admin console (defaults to /admin).
+     */
+    adminRoute?: string;
+    /**
+     * - Optional username for admin console basic auth.
+     */
+    adminUser?: string;
+    /**
+     * - Optional password for admin console basic auth.
+     */
+    adminPassword?: string;
 };
 /**
  * Environment variables as string key-value pairs
@@ -304,7 +322,7 @@ export type pageType = {
     file: {
         fileType: string | null;
         fileSize: number | null;
-        fileBlob: Buffer | null;
+        fileBlob: import("node:stream").Readable | Buffer | null;
     };
 };
 import z from 'zod';

package/types/util/cache.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @template T
+ * @typedef {{hitCount: number, value: T}} cacheEntryType
+ */
+/**
+ * Generic Cache class with LFU (Least Frequently Used) eviction policy.
+ * @template T
+ */
+export class Cache<T> {
+    /**
+     * @param {number} maxSize - Maximum number of entries in the cache.
+     */
+    constructor(maxSize?: number);
+    /** @type {Map<string, cacheEntryType<T>>} */
+    cache: Map<string, cacheEntryType<T>>;
+    maxSize: number;
+    hits: number;
+    misses: number;
+    /**
+     * Get an entry from the cache.
+     * @param {string} key - The key.
+     * @returns {T | undefined} - The value or undefined if not found.
+     */
+    get(key: string): T | undefined;
+    /**
+     * Set an entry in the cache.
+     * @param {string} key - The key.
+     * @param {T} value - The value.
+     */
+    set(key: string, value: T): void;
+    /**
+     * Delete an entry from the cache.
+     * @param {string} key - The key.
+     */
+    delete(key: string): void;
+    /**
+     * Clear the cache.
+     */
+    clear(): void;
+    /**
+     * Prune the cache by removing the least frequently used entries.
+     * Removes 10% of the cache size.
+     */
+    prune(): void;
+    /**
+     * Get the size of the cache.
+     * @returns {number} - The size.
+     */
+    get size(): number;
+    /**
+     * Get all keys in the cache.
+     * @returns {string[]} - The keys.
+     */
+    keys(): string[];
+    /**
+     * Get cache statistics.
+     * @returns {{size: number, maxSize: number, hits: number, misses: number}} - The statistics.
+     */
+    getStats(): {
+        size: number;
+        maxSize: number;
+        hits: number;
+        misses: number;
+    };
+}
+export type cacheEntryType<T> = {
+    hitCount: number;
+    value: T;
+};

package/types/util/jsonLogger.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @typedef {object} LogEntry
+ * @property {string} timestamp - ISO string
+ * @property {'error'|'info'|'warning'} type - Log level
+ * @property {string} message - Error message
+ * @property {object} [req] - Request details
+ * @property {object} [details] - Additional details (stack, sql, etc)
+ */
+export class JsonLogger {
+    constructor(filename?: string);
+    stream: rotatingFileStream.RotatingFileStream;
+    /**
+     * Log an entry as NDJSON.
+     * @param {LogEntry} entry - The entry to log.
+     */
+    log(entry: LogEntry): void;
+    /**
+     * Close the stream.
+     */
+    close(): void;
+}
+export const jsonLogger: JsonLogger;
+export type LogEntry = {
+    /**
+     * - ISO string
+     */
+    timestamp: string;
+    /**
+     * - Log level
+     */
+    type: "error" | "info" | "warning";
+    /**
+     * - Error message
+     */
+    message: string;
+    /**
+     * - Request details
+     */
+    req?: object;
+    /**
+     * - Additional details (stack, sql, etc)
+     */
+    details?: object;
+};
+import * as rotatingFileStream from 'rotating-file-stream';

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

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