web_plsql 0.3.2 → 0.5.0

package/CHANGELOG.md

@@ -1,106 +1,127 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-
-## [?.?.?] - ????-??-??
-
-### Added
-- ???
-
-### Changed
-- ???
-
-### Fixed
-- ???
-
-
-## [0.3.2] - 2020-03-29
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.3.1] - 2020-02-19
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.3.0] - 2019-09-17
-
-### Added
-- Added a simple oracledb example "examples/oracledb_example.js".
-
-### Changed
-- The credentials for the "examples/sample.js" are stored in "examples/credentials.js" and can also be set using the environment.
-
-### Fixed
-- Updated to oracledb 4 and full binary support for node 12 and later.
-- Updated all minor dependencies.
-
-
-## [0.2.0] - 2019-06-02
-
-### Fixed
-- Fixed a problem with the dependencies when installing the npm package.
-- Fixed link to the official oracledb installation documentation.
-- Updated all dependencies.
-
-
-## [0.1.2] - 2019-03-02
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.1.1] - 2019-02-05
-
-### Changed
-- Migrated from Babel to TypeScript
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.1.0] - 2018-09-03
-
-### Added
-- Added the configuration open "errorStyle" that can be set to "basic" or "debug".
-- The current web_plsql version is now a string property "version" in the middleware object.
-- Added the express status monitor to the sample. (http://localhost:8000/status)
-
-### Fixed
-- When downloading a file, first send any eventual "other headers" like "Content-Disposition".
-- Changed x-db-xontent-length to x-db-content-length.
-- Updated all dependencies.
-
-
-## [0.0.3] - 2018-03-20
-
-### Added
-- Added support for the PlsqlPathAlias and PlsqlPathAliasProcedure DAD settings.
-- Partial support of APEX application.
-- Added example configuration for APEX application.
-- Added unit tests with a code coverage of over 90%.
-
-### Fixed
-- Fixed some edge cases when processing the http headers.
-
-
-## [0.0.2] - 2018-03-19
-
-### Added
-- Allow to add or override CGI environment variables using the "cgi" property in the configuration object.
-- Added unit tests with a code coverage of over 80%.
-
-### Fixed
-- Fixed wrong field name when uploading files using a form.
-
-
-## [0.0.1] - 2018-03-17
-
-- Initial release
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [?.?.?] - 2021-??-??
+
+### Added
+### Changed
+### Fixed
+
+
+## [0.5.0] - 2022-05-09
+
+### Changed
+- Replaced mocha with jest.
+- Added support for node 18.
+
+### Fixed
+- Updated all dependencies.
+
+
+## [0.4.2] - 2022-01-17
+
+### Changed
+- node.js support starting with v16.
+
+### Fixed
+- Updated all dependencies.
+
+
+## [0.4.1] - 2021-08-30
+
+### Fixed
+- Updated all dependencies.
+
+
+## [0.4.0] - 2021-04-09
+
+### Added
+- Added a simple oracledb example "examples/oracledb_example.js".
+
+### Changed
+- The credentials for the "examples/sample.js" are stored in "examples/credentials.js" and can also be set using the environment.
+
+### Fixed
+- Updated to oracledb 5 and full binary support for node 14 and later.
+- Updated all minor dependencies.
+
+
+## [0.3.2] - 2020-03-29
+
+### Fixed
+- Updated all minor dependencies.
+
+
+## [0.3.1] - 2020-02-19
+
+### Fixed
+- Updated all minor dependencies.
+
+
+## [0.2.0] - 2019-06-02
+
+## [0.2.0] - 2019-06-02
+
+### Fixed
+- Fixed a problem with the dependencies when installing the npm package.
+- Fixed link to the official oracledb installation documentation.
+- Updated all dependencies.
+
+
+## [0.1.2] - 2019-03-02
+
+### Fixed
+- Updated all dependencies.
+
+
+## [0.1.1] - 2019-02-05
+
+### Changed
+- Migrated from Babel to TypeScript
+
+### Fixed
+- Updated all dependencies.
+
+
+## [0.1.0] - 2018-09-03
+
+### Added
+- Added the configuration open "errorStyle" that can be set to "basic" or "debug".
+- The current web_plsql version is now a string property "version" in the middleware object.
+- Added the express status monitor to the sample. (http://localhost:8000/status)
+
+### Fixed
+- When downloading a file, first send any eventual "other headers" like "Content-Disposition".
+- Changed x-db-xontent-length to x-db-content-length.
+- Updated all dependencies.
+
+
+## [0.0.3] - 2018-03-20
+
+### Added
+- Added support for the PlsqlPathAlias and PlsqlPathAliasProcedure DAD settings.
+- Partial support of APEX application.
+- Added example configuration for APEX application.
+- Added unit tests with a code coverage of over 90%.
+
+### Fixed
+- Fixed some edge cases when processing the http headers.
+
+
+## [0.0.2] - 2018-03-19
+
+### Added
+- Allow to add or override CGI environment variables using the "cgi" property in the configuration object.
+- Added unit tests with a code coverage of over 80%.
+
+### Fixed
+- Fixed wrong field name when uploading files using a form.
+
+
+## [0.0.1] - 2018-03-17
+
+- Initial release

package/LICENSE

@@ -1,21 +1,21 @@
-(The MIT License)
-
-Copyright (c) 2014-2018 Dieter Oberkofler <dieter.oberkofler@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+(The MIT License)
+
+Copyright (c) 2014-2018 Dieter Oberkofler <dieter.oberkofler@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,164 +1,165 @@
-  [![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]
-  [![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
-This Express Middleware is a bridge between a PL/SQL application running in an Oracle Database and an Express web server for Node.js.
-It is an open-source alternative to mod_plsql, the Embedded PL/SQL Gateway and ORDS,
-allowing you to develop PL/SQL web applications using the PL/SQL Web Toolkit (OWA) and Oracle Application Express (Apex),
-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.
-
-# Release History
-See the [changelog](https://github.com/doberkofler/web_plsql/blob/master/CHANGELOG.md).
-
-# Installation
-
-## Prerequisites
-There are several prerequisites needed to both compile and run the Oracle database driver.
-Please visit the [node-oracledb INSTALL.md](https://oracle.github.io/node-oracledb/INSTALL.html) page for more information.
-
-## Installing
-* Create and move to a new directory
-* Create a new npm project (`npm init`)
-* Install package (`npm install web_plsql`)
-* Install the PL/SQL examples (`sqlplus node_modules/web_plsql/examples/sql/install.sql`)
-* Start the sample server (`node node_modules/web_plsql/examples/sample`)
-* Invoke a browser and open the page `http://localhost:8000/base`
-
-# Configuration
-
-## How does a mod_plsql DAD configuration compare to the web_plsql app
-
-```
-<Location /pls/sample>
-  SetHandler                    pls_handler
-  Order                         deny,allow
-  Allow                         from all
-  PlsqlDatabaseUsername         sample
-  PlsqlDatabasePassword         sample
-  PlsqlDatabaseConnectString    ORCL
-  PlsqlAuthenticationMode       Basic
-  PlsqlDefaultPage              sample.pageindex
-  PlsqlDocumentTablename        doctable
-  PlsqlErrorStyle               DebugStyle
-  PlsqlNlsLanguage              AMERICAN_AMERICA.UTF8
-</Location>
-```
-
-```javascript
-const fs = require('fs');
-const path = require('path');
-const express = require('express');
-const bodyParser = require('body-parser');
-const multipart = require('connect-multiparty');
-const cookieParser = require('cookie-parser');
-const compression = require('compression');
-const morgan = require('morgan');
-
-const oracledb = require('oracledb');
-const webplsql = require('../lib');
-
-/*
-*	Allocate the Oracle database pool
-*/
-
-const databasePool = oracledb.createPool({
-	user: 'sample',
-	password: 'sample',
-	connectString: 'ORCL',
-	poolMin: 10,
-	poolMax: 1000,
-	poolIncrement: 10,
-	queueRequests: false,
-	queueTimeout: 1000
-});
-
-databasePool.catch(e => {
-	console.error(`Unable to create database pool.\n${e.message}`);
-	process.exit(1);
-});
-
-/*
-*	Start the server
-*/
-
-const PORT = 8000;
-const PATH = '/pls/sample';
-const OPTIONS = {
-	defaultPage: 'sample.pageIndex',
-  doctable: 'docTable',
-  errorStyle: 'debug'
-};
-
-// create express app
-const app = express();
-
-// add middleware
-app.use(multipart());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: true}));
-app.use(cookieParser());
-app.use(compression());
-app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
-
-// add the oracle pl/sql express middleware
-app.use(PATH + '/:name?', webplsql(databasePool, OPTIONS));
-
-// serving static files
-app.use('/static', express.static(path.join(process.cwd(), 'examples/static')));
-
-// listen on port
-console.log(`Waiting on http://localhost:${PORT}${PATH}`);
-app.listen(PORT);
-```
-
-# Missing features
-
-## Features in mod_plsql that are not (yet) available in web_plsql:
-- Support for APEX 5.
-- Default exclusion list.
-- Basic and custom authentication methods, based on the OWA_SEC package and custom packages.
-
-## Supported mod_plsql configuration options:
-- PlsqlDatabaseConnectString -> specified when creating the oracledb connection pool
-- PlsqlDatabaseUserName -> specified when creating the oracledb connection pool
-- PlsqlDatabasePassword -> specified when creating the oracledb connection pool
-- PlsqlDefaultPage -> use the "doctable" configuration option
-- PlsqlDocumentTablename -> use the "defaultPage" configuration option
-- PlsqlErrorStyle -> use the "errorStyle" configuration option
-- PlsqlLogEnable -> use a HTTP request logger middleware for node.js like morgan
-- PlsqlLogDirectory -> use a HTTP request logger middleware for node.js like morgan
-- PlsqlPathAlias -> use the "pathAlias.alias" configuration option
-- PlsqlPathAliasProcedure -> use the "pathAlias.procedure" configuration option
-
-## Configuration options that are not (yet) supported:
-- PlsqlIdleSessionCleanupInterval
-- PlsqlAfterProcedure
-- PlsqlAlwaysDescribeProcedure
-- PlsqlBeforeProcedure
-- PlsqlCGIEnvironmentList
-- PlsqlDocumentPath
-- PlsqlDocumentProcedure
-- PlsqlExclusionList
-- PlsqlRequestValidationFunction
-- PlsqlSessionCookieName
-- PlsqlSessionStateManagement
-- PlsqlTransferMode
-
-# License
-
-[MIT](LICENSE)
-
-
-[npm-image]: https://img.shields.io/npm/v/web_plsql.svg
-[npm-url]: https://npmjs.org/package/web_plsql
-
-[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
+  [![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]
+  [![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
+This Express Middleware is a bridge between a PL/SQL application running in an Oracle Database and an Express web server for Node.js.
+It is an open-source alternative to mod_plsql, the Embedded PL/SQL Gateway and ORDS,
+allowing you to develop PL/SQL web applications using the PL/SQL Web Toolkit (OWA) and Oracle Application Express (Apex),
+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.
+
+# Release History
+See the [changelog](https://github.com/doberkofler/web_plsql/blob/master/CHANGELOG.md).
+
+# Installation
+
+## Prerequisites
+There are several prerequisites needed to both compile and run the Oracle database driver.
+Please visit the [node-oracledb INSTALL.md](https://oracle.github.io/node-oracledb/INSTALL.html) page for more information.
+On where Oracle is looking for the client consult: https://oracle.github.io/node-oracledb/doc/api.html#oracleclientloading
+
+## Installing
+* Create and move to a new directory
+* Create a new npm project (`npm init`)
+* Install package (`npm install web_plsql`)
+* Install the PL/SQL examples (`sqlplus node_modules/web_plsql/examples/sql/install.sql`)
+* Start the sample server (`node node_modules/web_plsql/examples/sample`)
+* Invoke a browser and open the page `http://localhost:8000/base`
+
+# Configuration
+
+## How does a mod_plsql DAD configuration compare to the web_plsql app
+
+```
+<Location /pls/sample>
+  SetHandler                    pls_handler
+  Order                         deny,allow
+  Allow                         from all
+  PlsqlDatabaseUsername         sample
+  PlsqlDatabasePassword         sample
+  PlsqlDatabaseConnectString    ORCL
+  PlsqlAuthenticationMode       Basic
+  PlsqlDefaultPage              sample.pageindex
+  PlsqlDocumentTablename        doctable
+  PlsqlErrorStyle               DebugStyle
+  PlsqlNlsLanguage              AMERICAN_AMERICA.UTF8
+</Location>
+```
+
+```javascript
+const fs = require('fs');
+const path = require('path');
+const express = require('express');
+const bodyParser = require('body-parser');
+const multipart = require('connect-multiparty');
+const cookieParser = require('cookie-parser');
+const compression = require('compression');
+const morgan = require('morgan');
+
+const oracledb = require('oracledb');
+const webplsql = require('../lib');
+
+/*
+*	Allocate the Oracle database pool
+*/
+
+const databasePool = oracledb.createPool({
+	user: 'sample',
+	password: 'sample',
+	connectString: 'ORCL',
+	poolMin: 10,
+	poolMax: 1000,
+	poolIncrement: 10,
+	queueRequests: false,
+	queueTimeout: 1000
+});
+
+databasePool.catch(e => {
+	console.error(`Unable to create database pool.\n${e.message}`);
+	process.exit(1);
+});
+
+/*
+*	Start the server
+*/
+
+const PORT = 8000;
+const PATH = '/pls/sample';
+const OPTIONS = {
+	defaultPage: 'sample.pageIndex',
+  doctable: 'docTable',
+  errorStyle: 'debug'
+};
+
+// create express app
+const app = express();
+
+// add middleware
+app.use(multipart());
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({extended: true}));
+app.use(cookieParser());
+app.use(compression());
+app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
+
+// add the oracle pl/sql express middleware
+app.use(PATH + '/:name?', webplsql(databasePool, OPTIONS));
+
+// serving static files
+app.use('/static', express.static(path.join(process.cwd(), 'examples/static')));
+
+// listen on port
+console.log(`Waiting on http://localhost:${PORT}${PATH}`);
+app.listen(PORT);
+```
+
+# Missing features
+
+## Features in mod_plsql that are not (yet) available in web_plsql:
+- Support for APEX 5.
+- Default exclusion list.
+- Basic and custom authentication methods, based on the OWA_SEC package and custom packages.
+
+## Supported mod_plsql configuration options:
+- PlsqlDatabaseConnectString -> specified when creating the oracledb connection pool
+- PlsqlDatabaseUserName -> specified when creating the oracledb connection pool
+- PlsqlDatabasePassword -> specified when creating the oracledb connection pool
+- PlsqlDefaultPage -> use the "doctable" configuration option
+- PlsqlDocumentTablename -> use the "defaultPage" configuration option
+- PlsqlErrorStyle -> use the "errorStyle" configuration option
+- PlsqlLogEnable -> use a HTTP request logger middleware for node.js like morgan
+- PlsqlLogDirectory -> use a HTTP request logger middleware for node.js like morgan
+- PlsqlPathAlias -> use the "pathAlias.alias" configuration option
+- PlsqlPathAliasProcedure -> use the "pathAlias.procedure" configuration option
+
+## Configuration options that are not (yet) supported:
+- PlsqlIdleSessionCleanupInterval
+- PlsqlAfterProcedure
+- PlsqlAlwaysDescribeProcedure
+- PlsqlBeforeProcedure
+- PlsqlCGIEnvironmentList
+- PlsqlDocumentPath
+- PlsqlDocumentProcedure
+- PlsqlExclusionList
+- PlsqlRequestValidationFunction
+- PlsqlSessionCookieName
+- PlsqlSessionStateManagement
+- PlsqlTransferMode
+
+# License
+
+[MIT](LICENSE)
+
+
+[npm-image]: https://img.shields.io/npm/v/web_plsql.svg
+[npm-url]: https://npmjs.org/package/web_plsql
+
+[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