web_plsql 1.0.0 → 1.3.0

package/types/server/server.d.ts

@@ -1,74 +0,0 @@
-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;
-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: Cache<string>;
-    argumentCache: 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 { Cache } from '../util/cache.js';
-import http from 'node:http';
-import https from 'node:https';

package/types/types.d.ts

@@ -1,328 +0,0 @@
-/**
- * @typedef {import('oracledb').BindParameter} BindParameter
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('express').CookieOptions} CookieOptions
- * @typedef {import('express').Request} Request
- */
-/**
- * @typedef {'basic' | 'debug'} errorStyleType
- */
-export const z$errorStyleType: z.ZodEnum<{
-    basic: "basic";
-    debug: "debug";
-}>;
-/**
- * @typedef {object} configStaticType
- * @property {string} route - The Static route path.
- * @property {string} directoryPath - The Static directory.
- */
-export const z$configStaticType: z.ZodObject<{
-    route: z.ZodString;
-    directoryPath: z.ZodString;
-}, z.core.$strict>;
-/**
- * @typedef {(connection: Connection, procedure: string) => void | Promise<void>} transactionCallbackType
- * @typedef {'commit' | 'rollback' | transactionCallbackType | undefined | null} transactionModeType
- */
-/**
- * @typedef {object} configPlSqlHandlerType
- * @property {string} defaultPage - The default page.
- * @property {string} [pathAlias] - The path alias.
- * @property {string} [pathAliasProcedure] - The path alias.
- * @property {string} documentTable - The document table.
- * @property {string[]} [exclusionList] - The exclusion list.
- * @property {string} [requestValidationFunction] - The request validation function.
- * @property {Record<string, string>} [cgi] - The additional CGI.
- * @property {transactionModeType} [transactionMode] - Specifies an optional transaction mode.
- * "commit" this automatically commits any open transaction after each request. This is the defaults because this is what mod_plsql and ohs are doing.
- * "rollback" this automatically rolles back any open transaction after each request.
- * "transactionCallbackType" this allows to defined a custom handler as a JavaScript function.
- * @property {errorStyleType} errorStyle - The error style.
- */
-export const z$configPlSqlHandlerType: z.ZodObject<{
-    defaultPage: z.ZodString;
-    pathAlias: z.ZodOptional<z.ZodString>;
-    pathAliasProcedure: z.ZodOptional<z.ZodString>;
-    documentTable: z.ZodString;
-    exclusionList: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    requestValidationFunction: z.ZodOptional<z.ZodString>;
-    transactionMode: z.ZodOptional<z.ZodUnknown>;
-    errorStyle: z.ZodEnum<{
-        basic: "basic";
-        debug: "debug";
-    }>;
-}, z.core.$strict>;
-/**
- * @typedef {object} configPlSqlConfigType
- * @property {string} route - The PL/SQL route path.
- * @property {string} user - The Oracle username.
- * @property {string} password - The Oracle password.
- * @property {string} connectString - The Oracle connect string.
- */
-export const z$configPlSqlConfigType: z.ZodObject<{
-    route: z.ZodString;
-    user: z.ZodString;
-    password: z.ZodString;
-    connectString: z.ZodString;
-}, z.core.$strict>;
-/**
- * @typedef {configPlSqlHandlerType & configPlSqlConfigType} configPlSqlType
- */
-export const z$configPlSqlType: z.ZodObject<{
-    route: z.ZodString;
-    user: z.ZodString;
-    password: z.ZodString;
-    connectString: z.ZodString;
-    defaultPage: z.ZodString;
-    pathAlias: z.ZodOptional<z.ZodString>;
-    pathAliasProcedure: z.ZodOptional<z.ZodString>;
-    documentTable: z.ZodString;
-    exclusionList: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    requestValidationFunction: z.ZodOptional<z.ZodString>;
-    transactionMode: z.ZodOptional<z.ZodUnknown>;
-    errorStyle: z.ZodEnum<{
-        basic: "basic";
-        debug: "debug";
-    }>;
-}, z.core.$strict>;
-/**
- * @typedef {object} configType
- * @property {number} port - The server port number.
- * @property {configStaticType[]} routeStatic - The static routes.
- * @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;
-    routeStatic: z.ZodArray<z.ZodObject<{
-        route: z.ZodString;
-        directoryPath: z.ZodString;
-    }, z.core.$strict>>;
-    routePlSql: z.ZodArray<z.ZodObject<{
-        route: z.ZodString;
-        user: z.ZodString;
-        password: z.ZodString;
-        connectString: z.ZodString;
-        defaultPage: z.ZodString;
-        pathAlias: z.ZodOptional<z.ZodString>;
-        pathAliasProcedure: z.ZodOptional<z.ZodString>;
-        documentTable: z.ZodString;
-        exclusionList: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        requestValidationFunction: z.ZodOptional<z.ZodString>;
-        transactionMode: z.ZodOptional<z.ZodUnknown>;
-        errorStyle: z.ZodEnum<{
-            basic: "basic";
-            debug: "debug";
-        }>;
-    }, 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;
-export type CookieOptions = import("express").CookieOptions;
-export type Request = import("express").Request;
-export type errorStyleType = "basic" | "debug";
-export type configStaticType = {
-    /**
-     * - The Static route path.
-     */
-    route: string;
-    /**
-     * - The Static directory.
-     */
-    directoryPath: string;
-};
-export type transactionCallbackType = (connection: Connection, procedure: string) => void | Promise<void>;
-export type transactionModeType = "commit" | "rollback" | transactionCallbackType | undefined | null;
-export type configPlSqlHandlerType = {
-    /**
-     * - The default page.
-     */
-    defaultPage: string;
-    /**
-     * - The path alias.
-     */
-    pathAlias?: string;
-    /**
-     * - The path alias.
-     */
-    pathAliasProcedure?: string;
-    /**
-     * - The document table.
-     */
-    documentTable: string;
-    /**
-     * - The exclusion list.
-     */
-    exclusionList?: string[];
-    /**
-     * - The request validation function.
-     */
-    requestValidationFunction?: string;
-    /**
-     * - The additional CGI.
-     */
-    cgi?: Record<string, string>;
-    /**
-     * - Specifies an optional transaction mode.
-     * "commit" this automatically commits any open transaction after each request. This is the defaults because this is what mod_plsql and ohs are doing.
-     * "rollback" this automatically rolles back any open transaction after each request.
-     * "transactionCallbackType" this allows to defined a custom handler as a JavaScript function.
-     */
-    transactionMode?: transactionModeType;
-    /**
-     * - The error style.
-     */
-    errorStyle: errorStyleType;
-};
-export type configPlSqlConfigType = {
-    /**
-     * - The PL/SQL route path.
-     */
-    route: string;
-    /**
-     * - The Oracle username.
-     */
-    user: string;
-    /**
-     * - The Oracle password.
-     */
-    password: string;
-    /**
-     * - The Oracle connect string.
-     */
-    connectString: string;
-};
-export type configPlSqlType = configPlSqlHandlerType & configPlSqlConfigType;
-export type configType = {
-    /**
-     * - The server port number.
-     */
-    port: number;
-    /**
-     * - The static routes.
-     */
-    routeStatic: configStaticType[];
-    /**
-     * - The PL/SQL routes.
-     */
-    routePlSql: configPlSqlType[];
-    /**
-     * - Maximum size of each uploaded file in bytes or no limit if omitted.
-     */
-    uploadFileSizeLimit?: number;
-    /**
-     * - 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
- */
-export type environmentType = Record<string, string>;
-/**
- * Oracle database bind parameter configuration
- */
-export type BindParameterConfig = Record<string, BindParameter>;
-/**
- * Arguments object with string or string array values
- */
-export type argObjType = Record<string, string | string[]>;
-/**
- * File upload metadata
- */
-export type fileUploadType = {
-    /**
-     * - The field value.
-     */
-    fieldname: string;
-    /**
-     * - The filename.
-     */
-    originalname: string;
-    /**
-     * - The encoding.
-     */
-    encoding: string;
-    /**
-     * - The mimetype.
-     */
-    mimetype: string;
-    /**
-     * - The filename.
-     */
-    filename: string;
-    /**
-     * - The path.
-     */
-    path: string;
-    /**
-     * - The size.
-     */
-    size: number;
-};
-export type cookieType = {
-    /**
-     * - The name of the cookie.
-     */
-    name: string;
-    /**
-     * - The value of the cookie.
-     */
-    value: string;
-    /**
-     * - The cookie options.
-     */
-    options: CookieOptions;
-};
-/**
- * - The page.
- */
-export type pageType = {
-    /**
-     * - The body of the page.
-     */
-    body: string;
-    /**
-     * - The head of the page.
-     */
-    head: {
-        cookies: cookieType[];
-        contentType?: string;
-        contentLength?: number;
-        statusCode?: number;
-        statusDescription?: string;
-        redirectLocation?: string;
-        otherHeaders: Record<string, string>;
-        server?: string;
-    };
-    /**
-     * - The file.
-     */
-    file: {
-        fileType: string | null;
-        fileSize: number | null;
-        fileBlob: import("node:stream").Readable | Buffer | null;
-    };
-};
-import z from 'zod';

package/types/util/cache.d.ts

@@ -1,69 +0,0 @@
-/**
- * @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/errorToString.d.ts

@@ -1 +0,0 @@
-export function errorToString(error: unknown): string;

package/types/util/file.d.ts

@@ -1,6 +0,0 @@
-export function readFileSyncUtf8(filePath: string): string;
-export function readFile(filePath: string): Promise<Buffer>;
-export function removeFile(filePath: string): Promise<void>;
-export function getJsonFile(filePath: string): unknown;
-export function isDirectory(directoryPath: unknown): Promise<boolean>;
-export function isFile(filePath: unknown): Promise<boolean>;

package/types/util/html.d.ts

@@ -1,3 +0,0 @@
-export function escapeHtml(value: string): string;
-export function convertAsciiToHtml(text: string): string;
-export function getHtmlPage(body: string): string;

package/types/util/jsonLogger.d.ts

@@ -1,45 +0,0 @@
-/**
- * @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/util/oracle.d.ts

@@ -1,5 +0,0 @@
-export function connectionValid(connectionPool: Pool): Promise<boolean>;
-export function poolCreate(user: string, password: string, connectString: string, poolMin?: number, poolMax?: number): Promise<Pool>;
-export function poolClose(pool: Pool): Promise<void>;
-export function poolsClose(pools: Pool[]): Promise<void>;
-export type Pool = import("oracledb").Pool;

package/types/util/shutdown.d.ts

@@ -1,2 +0,0 @@
-export function installShutdown(handler: () => Promise<void>): void;
-export function forceShutdown(): void;

package/types/util/trace.d.ts

@@ -1,22 +0,0 @@
-export function inspect(value: unknown, depth?: number | null): string;
-export function toTable(head: string[], body: string[][]): outputType;
-export function logToFile(text: string): void;
-export function getBlock(title: string, body: string): string;
-export function getFormattedMessage(para: messageType): outputType;
-export function warningMessage(para: messageType): void;
-export type Request = import("express").Request;
-export type BindParameterConfig = import("../types.js").BindParameterConfig;
-export type environmentType = import("../types.js").environmentType;
-export type outputType = {
-    html: string;
-    text: string;
-};
-export type messageType = {
-    type: "error" | "warning" | "trace";
-    message: string;
-    timestamp?: Date | null;
-    req?: Request | null;
-    environment?: environmentType | null;
-    sql?: string | null;
-    bind?: BindParameterConfig | null;
-};

package/types/util/type.d.ts

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

package/types/util/util.d.ts

@@ -1,3 +0,0 @@
-export function humanDuration(duration: number): string;
-export function stringToNumber(value: unknown): number | null;
-export function stringToInteger(value: unknown): number | null;

package/types/version.d.ts

@@ -1 +0,0 @@
-export function getVersion(): string;