web_plsql 0.18.0 → 1.2.0

package/README.md

@@ -1,7 +1,6 @@
   [![NPM Version][npm-image]][npm-url]
   [![NPM Downloads][downloads-image]][downloads-url]
-  [![Linux Build](https://travis-ci.org/doberkofler/web_plsql.svg?branch=master)](https://travis-ci.org/doberkofler/web_plsql)
-  [![Build status][appveyor-image]][appveyor-url]
+  [![Node.js CI](https://github.com/doberkofler/web_plsql/actions/workflows/node.js.yml/badge.svg)](https://github.com/doberkofler/web_plsql/actions/workflows/node.js.yml)
   [![Coverage Status](https://coveralls.io/repos/github/doberkofler/web_plsql/badge.svg?branch=master)](https://coveralls.io/github/doberkofler/web_plsql?branch=master)
 
 # Oracle PL/SQL Gateway Middleware for the Express web framework for Node.js
@@ -12,6 +11,8 @@ and serve the content using the Express web framework for Node.js.
 
 Please feel free to try and suggest any improvements. Your thoughts and ideas are most welcome.
 
+![Dashboard](docs/images/admin_console.png)
+
 # Release History
 See the [changelog](https://github.com/doberkofler/web_plsql/blob/master/CHANGELOG.md).
 
@@ -31,10 +32,29 @@ Please visit the [node-oracledb](https://node-oracledb.readthedocs.io/en/latest/
 * Start server using `node examples/config-native.js` after having set the WEB_PLSQL_ORACLE_SERVER environment variable to the database where you just installed the sample schema.
 * Invoke a browser and open the page `http://localhost/sample`.
 
-## Container
-* Build the image using `npm run image-build`.
-* Adapt the `examples/config-docker.json` configuration file. Typically only the `connectString` property must be changed.
-* Start the container using `docker compose up -d`.
+# Admin Console
+
+`web_plsql` includes a built-in Admin Console for real-time monitoring and management of your gateway.
+
+## Features
+- **Dashboard**: Real-time charts showing requests per second and error rates.
+- **Pool Monitoring**: Visual representation of database connection pool usage.
+- **Cache Management**: View and manage the metadata cache.
+- **Access & Error Logs**: Interactive viewers for the server logs.
+- **System Info**: Overview of the server environment and configuration.
+
+## Configuration
+The admin console is enabled by default in the `startServer` API. You can configure it via the `admin` property in the main configuration object.
+
+```typescript
+/**
+ * @typedef {object} configAdminType
+ * @property {boolean} [enabled=true] - Whether the admin console is enabled.
+ * @property {string} [route='/admin'] - The route path for the admin console.
+ */
+```
+
+Access the console at `http://localhost:<port>/admin` (e.g., `http://localhost:8080/admin`).
 
 # Configuration
 
@@ -93,6 +113,7 @@ The `startServer` api uses the following configuration object:
 /**
  * @typedef {object} configType
  * @property {number} port - The server port number.
+ * @property {configAdminType} [admin] - The admin console configuration.
  * @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.
@@ -180,6 +201,8 @@ The following mod_plsql DAD configuration translates to the configuration option
 - PlsqlRequestValidationFunction -> routePlSql[].pathAliasProcedure
 - PlsqlExclusionList
 - Basic and custom authentication methods, based on the OWA_SEC package and custom packages.
+- Caching of procedure metadata and validation results for high performance.
+- Real-time monitoring and management via a built-in Admin Console.
 
 ## Features that are only available in web_plsql
 - The option `transactionModeType` specifies an optional transaction mode.
@@ -213,6 +236,3 @@ The following mod_plsql DAD configuration translates to the configuration option
 
 [downloads-image]: https://img.shields.io/npm/dm/web_plsql.svg
 [downloads-url]: https://npmjs.org/package/web_plsql
-
-[appveyor-image]: https://ci.appveyor.com/api/projects/status/github/doberkofler/web_plsql?branch=master&svg=true
-[appveyor-url]: https://ci.appveyor.com/project/doberkofler/web-plsql

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.18.0",
+	"version": "1.2.0",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -43,14 +43,18 @@
 	"types": "./types/index.d.ts",
 	"type": "module",
 	"scripts": {
-		"lint": "prettier --check --experimental-cli . && eslint . && tsc --noEmit",
+		"build": "npm run build:admin",
+		"build:admin": "vite build",
+		"lint": "prettier --check --experimental-cli . && eslint . && tsc --noEmit && eslint src/admin --config src/admin/js/eslint.config.js",
 		"test": "vitest run",
+		"test:perf": "vitest run tests/performance.test.js",
 		"test:coverage": "vitest run --coverage",
+		"stylelint": "stylelint \"src/admin/**/*.css\"",
 		"types": "rm -rf types && tsc  --noEmit false --declaration true --declarationDir types --emitDeclarationOnly true --allowJs true --target es2020 --module es2020 --moduleResolution node --allowSyntheticDefaultImports true src/*.js",
 		"clean": "shx rm -f *.tgz && shx rm -f *.log",
-		"ci": "npm run clean && npm run version && npm run types && npm run lint && npm run test:coverage",
 		"version": "node update-version.js",
-		"create-package": "shx rm -f *.tgz && npm pack",
+		"ci": "npm run clean && npm run version && npm run types && npm run build && npm run lint && npm run stylelint && npm run test:coverage",
+		"create-package": "npm run ci && shx rm -f *.tgz && npm pack",
 		"image-build": "docker build --no-cache --progress=plain --tag=web_plsql .",
 		"image-save": "docker save web_plsql | gzip > web_plsql.tar.gz"
 	},
@@ -58,6 +62,7 @@
 		"oracledb": "6.10.0"
 	},
 	"dependencies": {
+		"chart.js": "^4.5.1",
 		"compression": "1.8.1",
 		"cookie-parser": "1.4.7",
 		"debug": "4.4.3",
@@ -66,26 +71,31 @@
 		"morgan": "1.10.1",
 		"multer": "2.0.2",
 		"rotating-file-stream": "3.2.8",
-		"zod": "4.3.6"
+		"zod": "^4.3.6"
 	},
 	"devDependencies": {
+		"@tailwindcss/vite": "^4.1.18",
 		"@types/compression": "1.8.1",
 		"@types/cookie-parser": "1.4.10",
 		"@types/debug": "4.1.12",
 		"@types/morgan": "1.9.10",
 		"@types/multer": "2.0.0",
-		"@types/node": "25.2.1",
+		"@types/node": "25.2.2",
 		"@types/oracledb": "6.10.1",
 		"@types/supertest": "6.0.3",
 		"@vitest/coverage-v8": "^4.0.18",
 		"eslint": "9.39.2",
-		"eslint-plugin-jsdoc": "62.5.2",
+		"eslint-plugin-jsdoc": "62.5.4",
 		"oracledb": "6.10.0",
 		"prettier": "3.8.1",
 		"shx": "0.4.0",
+		"stylelint": "^17.1.1",
+		"stylelint-config-standard": "^40.0.0",
 		"supertest": "7.2.2",
+		"tailwindcss": "^4.1.18",
 		"typescript": "5.9.3",
 		"typescript-eslint": "8.54.0",
+		"vite": "^7.3.1",
 		"vitest": "^4.0.18"
 	}
 }