@beauraines/node-helpers 2.4.4 → 2.5.2

package/CHANGELOG.md

@@ -2,12 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [2.4.4](https://github.com/beauraines/node-helpers/compare/v2.4.3...v2.4.4) (2023-04-15)
+### [2.5.2](https://github.com/beauraines/node-helpers/compare/v2.5.0...v2.5.2) (2023-06-03)
+
+## [2.5.0](https://github.com/beauraines/node-helpers/compare/v2.4.3...v2.5.0) (2023-06-03)
+
+
+### Features
+
+* new config module ([#32](https://github.com/beauraines/node-helpers/issues/32)) ([514df50](https://github.com/beauraines/node-helpers/commit/514df509ca33527a8b18e5efe43d1b772963e879))
+* supports cross OS file paths ([#33](https://github.com/beauraines/node-helpers/issues/33)) ([27f5e27](https://github.com/beauraines/node-helpers/commit/27f5e27d02408bff07220c3e82bd90186023b324)), closes [#24](https://github.com/beauraines/node-helpers/issues/24)
 
 
 ### Bug Fixes
 
+* adds export of new config module ([#34](https://github.com/beauraines/node-helpers/issues/34)) ([81c7a27](https://github.com/beauraines/node-helpers/commit/81c7a27696da3d9a0b6fb3a215418185c9b1d153))
 * **deps:** bump @azure/storage-queue from 12.12.0 to 12.13.0 ([45acd3d](https://github.com/beauraines/node-helpers/commit/45acd3d808ab064c1dbc4b492a013c7b60ebf5b2))
+* **deps:** bump dayjs from 1.11.7 to 1.11.8 ([2208985](https://github.com/beauraines/node-helpers/commit/22089855cd90758273bac28fa1d8669d21f661b5))
+* **deps:** bump node-fetch from 2.6.9 to 2.6.11 ([d9fbed2](https://github.com/beauraines/node-helpers/commit/d9fbed2e6ade418caada9cc68f6ac05ba4d3159d))
+* **deps:** bump sqlite from 4.1.2 to 4.2.0 ([5634e40](https://github.com/beauraines/node-helpers/commit/5634e400a0dea024a40a890da639a167df01cf25))
+* **deps:** bump sqlite from 4.2.0 to 4.2.1 ([61b6533](https://github.com/beauraines/node-helpers/commit/61b6533d95c456114de9d8ca01dd30be204af2f9))
 
 ### [2.4.3](https://github.com/beauraines/node-helpers/compare/v2.4.0...v2.4.3) (2023-03-06)
 

package/index.js

@@ -1,5 +1,6 @@
 
 const AzureStorage = require("./src/azure")
+const config = require('./src/config.js')
 const credentials = require("./src/credentials.js");
 const database = require("./src/database");
 const helpers = require("./src/helpers");
@@ -7,6 +8,7 @@ const jira = require("./src/jira");
 
 module.exports = {
     AzureStorage,
+    config,
     credentials,
     database,
     helpers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.4.4",
+  "version": "2.5.2",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {

package/src/config.js

@@ -0,0 +1,80 @@
+const fs = require('fs');
+const {fileExists} = require('./helpers');
+const {homedir} = require('os');
+const path = require('path');
+
+/**
+ * Reads the specified config file from the users home directory
+ * 
+ * @param {string} configFile file name for the JSON config file, from the users home directory
+ * 
+ * @throws {Config file not found. You must create one using the config command}
+ * @returns {object} the configuration object
+ */
+const readConfig = async (configFile) => {
+    configFile = path.join(homedir(),configFile)
+	let config
+	if ( await fileExists(configFile) ) {
+		config = fs.readFileSync(configFile,
+			{ encoding: 'utf8', flag: 'r' });
+		config = JSON.parse(config);
+	} else {
+        throw new Error(`Config file not found. You must create one using the config command`)
+	}
+	
+	return config
+}
+
+/**
+ * Validates the config file to ensure that it has all of the required properties specified. This 
+ * is only schema validation, it does not check if the properties are valid values or data types.
+ * 
+ * @param {string} configFile file name for the JSON config file, from the users home directory
+ * @param {Array} configProps an array of properties that defines a valid config file
+ * 
+ * @throws {Configuration file not found}
+ * @throws {Invalid configuration file}
+ * @returns {boolean} 
+ */
+const validateConfig = async (configFile, configProps) => {
+    configFile = path.join(homedir(),configFile)
+    if (! fs.existsSync(configFile) ) {
+        throw new Error('Configuration file not found')
+    }
+    let config
+    config = fs.readFileSync(configFile,
+        { encoding: 'utf8', flag: 'r' });
+    config = JSON.parse(config);
+    // Check for properties
+    let validConfig = true
+    for (key of configProps) {
+        validConfig = config[key] ? true : false
+    }
+
+    if (!validConfig) {
+        throw Error('Invalid configuration file')
+    }
+    return validConfig
+}
+
+/**
+ * Creates a boilerplate config file in the user's home directory
+ * 
+ * @param {string} configFile file name for the JSON config file, from the users home directory
+ * @param {Array} configProps an array of properties that defines a valid config file
+ * 
+ */
+const createConfig = async (configFile,configProps) => {
+    configFile = path.join(homedir(),configFile)
+    let config = {}
+    for (key of configProps) {
+        config[key] = ''
+    }
+    fs.writeFileSync(configFile,JSON.stringify(config))
+}
+
+module.exports = {
+    createConfig,
+    readConfig,
+    validateConfig
+}

package/src/database.js

@@ -2,15 +2,15 @@ const {homedir} = require('os');
 const sqlite = require('sqlite');
 const sqlite3 = require('sqlite3');
 const {fileExists} = require('./helpers');
+const path = require('path');
 
 /**
  * Opens the BurnDownStatus SQLite3 Database
- * @param file file name of the SQLite3 DB. If not provided, defaults to ${homedir}/BurnDownStatus.db
+ * @param file file name of the SQLite3 DB. If not provided, defaults to BurnDownStatus.db in the users home
  * @returns SQLite database connection
  */
 async function getDBConnection(file) {
-    const homeDir = homedir();
-    file = file ? file : `${homeDir}/BurnDownStatus.db`;
+    file = file ? file : path.join(homedir(),'BurnDownStatus.db');
     if (! await fileExists(file)){
         console.error(`${file} not found`);
         // ! Separation of concerns - this should probably not be doing the exiting, but it is.

package/src/database.test.js

@@ -3,6 +3,7 @@ const sqlite = require('sqlite');
 const sqlite3 = require('sqlite3');
 const helpers = require('./helpers');
 const { getDBConnection } = require('./database');
+const path = require('path');
 
 jest.mock('sqlite');
 jest.mock('os');
@@ -32,7 +33,7 @@ describe('database module', () => {
         helpers.fileExists.mockReturnValue(true);
 
 
-        const expectedDefaultFile = `${os.homedir()}/BurnDownStatus.db`
+        const expectedDefaultFile = path.join(os.homedir(),'BurnDownStatus.db')
         
         const file = undefined;
         // call function with null file
@@ -56,7 +57,7 @@ describe('database module', () => {
         os.homedir.mockReturnValue(expectedHomeDir);
         helpers.fileExists.mockReturnValue(true);
 
-        const expectedDefaultFile = `${os.homedir()}/my_database.db`
+        const expectedDefaultFile = path.join(os.homedir(),'BurnDownStatus.db')
 
         const db = await getDBConnection(expectedDefaultFile)