Change to module es6 (#63)

* Initial upgrade to imports

* Refactoring to es6

Author: DaveBathnes

README.md

@@ -1,6 +1,6 @@
 # Library data API
 
-A Node JS API to provide UK public library data for library applications.
+An API to provide UK public library data for easy use in library applications.
 
 ## Getting Started
 
@@ -28,7 +28,7 @@ npm start
 
 ## Authors
 
-- **Dave Rowe** - *Original code and maintenance* - [DaveBathnes](https://github.com/DaveBathnes)
+- **Dave Rowe** - _Original code and maintenance_ - [DaveBathnes](https://github.com/DaveBathnes)
 
 See also the list of [contributors](https://github.com/LibrariesHacked/api-librarydata/contributors) who participated in this project.
 

app.js

@@ -1,24 +1,27 @@
 'use strict'
 
-const express = require('express')
-const app = express()
+import express from 'express'
+
+import authenticate from './routes/authenticate.js'
+import libraries from './routes/libraries.js'
+import schemas from './routes/schemas.js'
+import services from './routes/services.js'
 
-const authenticate = require('./routes/authenticate')
-const libraries = require('./routes/libraries')
-const schemas = require('./routes/schemas')
-const services = require('./routes/services')
+import dotenv from 'dotenv'
+import dotenvDefaults from 'dotenv-defaults'
 
-require('dotenv').config()
-require('dotenv-defaults').config()
+const app = express()
+dotenv.config()
+dotenvDefaults.config()
 
-// Allow cross origin
-app.use(function (req, res, next) {
+// Allow cross origin requests
+app.use((req, res, next) => {
   res.header('Access-Control-Allow-Origin', '*')
+  res.header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
   res.header(
     'Access-Control-Allow-Headers',
     'Origin, X-Requested-With, Content-Type, Accept, Authorization'
   )
-  res.header('Access-Control-Allow-Methods', 'POST, PUT, GET, OPTIONS')
   next()
 })
 

helpers/airtable.js

@@ -1,12 +1,12 @@
-const Airtable = require('airtable')
+import Airtable from 'airtable'
 
 /**
  * Gets all records and fields from a table
  * @param {string} baseName The base name e.g. librarieshacked
  * @param {string} table The table name e.g. Library services
  * @returns {Array} An array of records
  */
-module.exports.getAllRecordsInTable = async (baseName, table) => {
+export async function getAllRecordsInTable (baseName, table) {
   const base = new Airtable({ apiKey: process.env.AIRTABLE_API_KEY }).base(
     baseName
   )
@@ -23,7 +23,7 @@ module.exports.getAllRecordsInTable = async (baseName, table) => {
  * @param {string} filterFieldValue The value to filter the filter field by
  * @returns {Array} An array of records
  */
-module.exports.getSingleFieldArrayAllRecordsInTable = async (
+export const getSingleFieldArrayAllRecordsInTable = async (
   baseName,
   table,
   fieldName,
@@ -56,7 +56,7 @@ module.exports.getSingleFieldArrayAllRecordsInTable = async (
  * @param {string} fieldValue The value to filter the filter field by
  * @returns
  */
-module.exports.getRecordInTable = async (
+export const getRecordInTable = async (
   baseName,
   table,
   fieldName,

helpers/authenticate.js

@@ -1,17 +1,21 @@
-const pool = require('../helpers/database')
-const jwt = require('jsonwebtoken')
-const nodemailer = require('nodemailer')
-const Email = require('email-templates')
+import jsonwebtoken from 'jsonwebtoken'
+import { createTransport } from 'nodemailer'
+
+import Email from 'email-templates'
+
+import pool from '../helpers/database.js'
+
+const { verify, sign } = jsonwebtoken
 
 /**
  * Verifies that a JWT is valid and returns the claims or null if it isn't
  * @param {string} token A JSON web token
  * @returns {object|null} A claims object
  */
-module.exports.verifyToken = async token => {
+export const verifyToken = async token => {
   let domain = null
   try {
-    const decoded = jwt.verify(token, process.env.AUTHSECRET)
+    const decoded = verify(token, process.env.AUTHSECRET)
     domain = decoded.sub
   } catch (e) {
     return null
@@ -25,10 +29,10 @@ module.exports.verifyToken = async token => {
  * @param {string} token
  * @returns {string} Email domain
  */
-module.exports.getTokenDomain = async token => {
+export const getTokenDomain = async token => {
   let domain = null
   try {
-    const decoded = jwt.verify(token, process.env.AUTHSECRET)
+    const decoded = verify(token, process.env.AUTHSECRET)
     domain = decoded.sub
   } catch (e) {
     return null
@@ -41,13 +45,14 @@ module.exports.getTokenDomain = async token => {
  * @param {string} domain A top level domain
  * @returns {object} A claims object
  */
-module.exports.getDomainClaims = async domain => {
+export const getDomainClaims = async domain => {
   let claims = { admin: false, codes: [] }
   try {
     const query = 'select * from authentication where domain = $1 limit 1'
     const { rows } = await pool.query(query, [domain])
-    if (rows.length > 0)
+    if (rows.length > 0) {
       claims = { admin: rows[0].admin, codes: rows[0].authority_codes }
+    }
   } catch (e) {}
   return claims
 }
@@ -58,9 +63,9 @@ module.exports.getDomainClaims = async domain => {
  * @param {object} claims A claims object
  * @param {string} website A web address domain
  */
-module.exports.sendMagicLink = async (email, claims, website) => {
+export const sendMagicLink = async (email, claims, website) => {
   const domain = email.split('@').pop()
-  const token = jwt.sign(claims, process.env.AUTHSECRET, {
+  const token = sign(claims, process.env.AUTHSECRET, {
     audience: [website],
     expiresIn: '30d',
     issuer: 'api.librarydata.uk',
@@ -76,7 +81,7 @@ module.exports.sendMagicLink = async (email, claims, website) => {
     }
   }
 
-  const transporter = nodemailer.createTransport(mailConfig)
+  const transporter = createTransport(mailConfig)
 
   const emailTemplate = new Email({
     message: {
@@ -93,8 +98,8 @@ module.exports.sendMagicLink = async (email, claims, website) => {
         to: email
       },
       locals: {
-        website: website,
-        token: token
+        website,
+        token
       }
     })
   } catch (e) {
@@ -110,6 +115,6 @@ module.exports.sendMagicLink = async (email, claims, website) => {
  * @param {object} claims
  * @returns {boolean} Access
  */
-module.exports.verifyServiceCodeAccess = async (serviceCode, claims) => {
+export const verifyServiceCodeAccess = (serviceCode, claims) => {
   return claims.codes.indexOf(serviceCode) === -1 && claims.admin === false
 }

helpers/database.js

@@ -1,8 +1,12 @@
-const pg = require('pg')
+import pg from 'pg'
+
+const { types, Pool } = pg
 
 // Currently using timestamp without timezone so this ensures the time isn't messed with
-pg.types.setTypeParser(1114, str => str)
+types.setTypeParser(1114, str => str)
 
+// This is the connection to the database
+// It uses the .env file to get the credentials
 const config = {
   user: process.env.PGUSER,
   host: process.env.PGHOST,
@@ -16,6 +20,6 @@ const config = {
   idleTimeoutMillis: 30000
 }
 
-const pool = new pg.Pool(config)
+const pool = new Pool(config)
 
-module.exports = pool
+export default pool

helpers/feed.js

@@ -1,4 +1,4 @@
-const RSSCombiner = require('../lib/feed-combiner')
+import RSSCombiner from '../lib/feed-combiner.js'
 
 /**
  * Gets a combined feed from multiple feed URLs
@@ -7,9 +7,9 @@ const RSSCombiner = require('../lib/feed-combiner')
  * @param {Array} customNamespaces An array of namespaces
  * @returns {Object} A combined feed
  */
-module.exports.getFeedFromUrls = async (urls, title, customNamespaces) => {
+export const getFeedFromUrls = async (urls, title, customNamespaces) => {
   const feedConfig = {
-    title: title,
+    title,
     size: 100,
     feeds: urls,
     pubDate: new Date(),
@@ -24,7 +24,7 @@ module.exports.getFeedFromUrls = async (urls, title, customNamespaces) => {
  * @param {string} id ID of the YouTube channel/playlist/user
  * @returns {string} A feed URL
  */
-module.exports.getYouTubeFeedUrlFromId = id => {
+export const getYouTubeFeedUrlFromId = id => {
   const youTubeUrl = process.env.YOUTUBE_FEED_URL
   const idTypes = {
     UC: 'channel_id',
@@ -38,7 +38,7 @@ module.exports.getYouTubeFeedUrlFromId = id => {
  * @param {string} id ID of the Flickr user
  * @returns {string} A feed URL
  */
-module.exports.getFlickrFeedUrlFromId = id => {
+export const getFlickrFeedUrlFromId = id => {
   return process.env.FLICKR_FEED_URL + id
 }
 
@@ -47,7 +47,7 @@ module.exports.getFlickrFeedUrlFromId = id => {
  * @param {Array} ids An array of YouTube IDs
  * @returns {Array} A set of feed URLs
  */
-module.exports.getYouTubeFeedUrlArrayFromIds = ids => {
+export const getYouTubeFeedUrlArrayFromIds = ids => {
   return ids.map(id => this.getYouTubeFeedUrlFromId(id))
 }
 
@@ -56,7 +56,7 @@ module.exports.getYouTubeFeedUrlArrayFromIds = ids => {
  * @param {Array} ids An array of YouTube IDs
  * @returns {object} A combined feed
  */
-module.exports.getFeedFromYouTubeIds = async ids => {
+export const getFeedFromYouTubeIds = async ids => {
   const urls = this.getYouTubeFeedUrlArrayFromIds(ids)
   const feed = await this.getFeedFromUrls(
     urls,
@@ -74,7 +74,7 @@ module.exports.getFeedFromYouTubeIds = async ids => {
  * @param {*} urls A set of Blog feed URLs
  * @returns {object} A combined feed
  */
-module.exports.getFeedFromBlogUrls = async urls => {
+export const getFeedFromBlogUrls = async urls => {
   const feed = await this.getFeedFromUrls(
     urls,
     'Library blogs | Libraries at home',

helpers/github.js

@@ -1,5 +1,5 @@
-const { Octokit } = require('@octokit/rest')
-const { Base64 } = require('js-base64')
+import { Octokit } from '@octokit/rest'
+import { Base64 } from 'js-base64'
 
 /**
  * Creates or updates a file stored in GitHub
@@ -8,13 +8,13 @@ const { Base64 } = require('js-base64')
  * @param {string} message A commit message that describes the change
  * @returns {boolean} Whether the update was successful.
  */
-module.exports.createOrUpdateFile = async (
+export async function createOrUpdateFile (
   path,
   file,
   message,
   authorName,
   authorEmail
-) => {
+) {
   const content = Base64.encode(file)
 
   const octokit = new Octokit({
@@ -26,18 +26,18 @@ module.exports.createOrUpdateFile = async (
 
   const fileResult = await octokit.repos.getContent({
     owner: organisation,
-    repo: repo,
+    repo,
     path
   })
 
   const sha = fileResult?.data?.sha
 
   const result = await octokit.repos.createOrUpdateFileContents({
     owner: organisation,
-    repo: repo,
+    repo,
     path,
-    message: message,
-    content: content,
+    message,
+    content,
     committer: {
       name: process.env.GITHUB_ORGANISATION_BOT_NAME,
       email: process.env.GITHUB_ORGANISATION_EMAIL

helpers/schema.js

@@ -1,11 +1,11 @@
-const axios = require('axios')
+import axios from 'axios'
 
 /**
  * Gets the contents of a file from the URL provided
  * @param {string} url The file URL
  * @returns {string} The file contents
  */
-module.exports.getFileFromUrl = async url => {
+export const getFileFromUrl = async url => {
   const response = await axios.get(url)
   return response.data
 }

helpers/utils.js

@@ -1,4 +1,8 @@
-module.exports.convertJsonToGeoJson = (json, longitudeField, latitudeField) => {
+export const convertJsonToGeoJson = async (
+  json,
+  longitudeField,
+  latitudeField
+) => {
   const features = []
   json.forEach(item => {
     if (
@@ -7,7 +11,7 @@ module.exports.convertJsonToGeoJson = (json, longitudeField, latitudeField) => {
       item[longitudeField] === '' ||
       item[latitudeField] === ''
     ) {
-      return
+      return null
     } else {
       const feature = {
         type: 'Feature',