ffc-database 1.0.1

package/README.md

@@ -0,0 +1,82 @@
+# ffc-database
+
+Database utility npm module for FFC services
+
+## Usage
+
+### Installation
+
+```
+npm install --save ffc-database
+```
+
+### Configuration
+
+`dialect` - Database dialect, e.g. `postgres`, `mssql`, `sqlite`, etc.
+
+`host` - Database server hostname, e.g. `localhost` or `mydb.postgres.database.azure.com`
+
+`port` - Database server port, e.g. `5432` for PostgreSQL
+
+`database` - Name of the database to connect to
+
+`username` - Database user name
+
+`password` - Database user password
+
+`ssl` - Boolean or object for SSL configuration (optional, recommended for production)
+
+`logging` - Enable or disable SQL query logging (default: `false`)
+
+#### Example
+```
+const config = { dialect: 'postgres', host: 'localhost', port: 5432, database: 'ffc_pay', username: 'ffc_user', password: 'ffc_password', ssl: true, logging: false }
+```
+
+### Connecting to the database
+
+```
+const { createDatabaseConnection } = require('ffc-database') const db = createDatabaseConnection(config)
+```
+
+### Running migrations
+
+```
+const { runMigrations } = require('ffc-database') await runMigrations(db)
+
+```
+
+### Executing queries
+
+```
+const [results, metadata] = await db.query('SELECT * FROM payments WHERE status = $1', { replacements: ['pending'] })
+```
+
+### Closing the connection
+
+```
+await db.close()
+```
+
+## Licence
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT
+LICENCE found at:
+
+<http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3>
+
+The following attribution statement MUST be cited in your products and
+applications when using this information.
+
+> Contains public sector information licensed under the Open Government license
+> v3
+
+### About the licence
+
+The Open Government Licence (OGL) was developed by the Controller of Her
+Majesty's Stationery Office (HMSO) to enable information providers in the
+public sector to license the use and re-use of their information under a common
+open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly,
+with only a few conditions.

package/app/database/base.js

@@ -0,0 +1,39 @@
+const fs = require('fs')
+const path = require('path')
+const { Sequelize, DataTypes } = require('sequelize')
+const db = {}
+
+class Base {
+  constructor (config) {
+    this.database = config.database
+    this.username = config.username
+    this.password = config.password
+    this.modelPath = config.modelPath
+    this.dbConfig = config
+  }
+
+  connect () {
+    const sequelize = new Sequelize(this.database, this.username, this.password, this.dbConfig)
+    fs.readdirSync(this.modelPath)
+      .filter(file => {
+        return (file.indexOf('.') !== 0) && (file !== 'index.js') && (file.slice(-3) === '.js')
+      })
+      .forEach(file => {
+        const model = require(path.join(this.modelPath, file))(sequelize, DataTypes)
+        db[model.name] = model
+      })
+
+    Object.keys(db).forEach(modelName => {
+      if (db[modelName].associate) {
+        db[modelName].associate(db)
+      }
+    })
+
+    db.sequelize = sequelize
+    db.Sequelize = Sequelize
+
+    return db
+  }
+}
+
+module.exports = Base

package/app/database/database.js

@@ -0,0 +1,5 @@
+const Base = require('./base')
+
+class Database extends Base {}
+
+module.exports = Database

package/app/database/index.js

@@ -0,0 +1,5 @@
+const Database = require('./database')
+
+module.exports = {
+  Database
+}

package/index.js

@@ -0,0 +1,5 @@
+const { Database } = require('./app/database')
+
+module.exports = {
+  Database
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "ffc-database",
+  "version": "1.0.1",
+  "description": "Databas npm module for FCP services",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DEFRA/ffc-database.git"
+  },
+  "author": "Defra",
+  "contributors": [
+    "John Barnard john.barnard.external@atos.net"
+  ],
+  "license": "OGL-UK-3.0",
+  "bugs": {
+    "url": "https://github.com/DEFRA/ffc-database/issues"
+  },
+  "homepage": "https://github.com/DEFRA/ffc-database#readme",
+  "dependencies": {
+    "pg": "8.7.3",
+    "pg-hstore": "2.3.4",
+    "sequelize": "6.31.1"
+  },
+  "devDependencies": {
+    "standard": "17.1.2"
+  }
+}