@saber-usa/node-common 1.7.7 → 1.7.9-alpha.1

package/README.md

@@ -1,42 +1,13 @@
-# Saber Common node functions
-
-The contains common node functions used across saber applications
-
-## Logger
-
-The logger component is a standard logger based on [winston](https://github.com/winstonjs/winston). The logger factory
-creates a default console logger for errors along with exception/rejection catching. By setting the `CONSOLE_LOG` 
-variable to `true` will turn on the console logger for local development. The log level is configured by the `LOG_LEVEL`
-environment variable to one of the following levels: `emerg`, `alert`, `crit`, `error`, `warning`, `warn`, `notice`, 
-`info`, `debug` (default level is `error`). The reason using an environment variable for the level is useful when 
-deployed to the server. Changing the environment variable is easier than setting a new flag in the script execution.
-
-### Usage
-
-To create a new logger, just pass in options to the factory:
-
-```javascript
-const logger = loggerFactory(opts);
-
-logger.debug("This is a debug message");
-```
-
-For further usage, consult [winston](https://github.com/winstonjs/winston)
-
-### Options
-
-- `nameSpace` help distinguish where the logger message comes from.
-- `additionalData` Data to include with each message 
-- `level` overwrite the `LOG_LEVEL` environment level
-
-## Transformer
-
-A transformer for object keys is provided. This will take an object and transform the keys using a function. 
-
-## Publishing changes
-
-1. Change the version in package.json
-2. Run `npm publish && npm install`
-3. Enable GPG in GIT: `git config --global commit.gpgsign true`
-4. Run `gpg --list-keys` to get your <id> 
-5. Tell the GIT to use your key `git config user.signingkey <id>`
+# Node Common
+
+Common nodejs functions used across a number of saber's applications.
+
+## License
+AGPLv3
+
+## Publishing changes
+
+1. Increment the version in `package.json`
+2. Check you are logged in to npm using `npm whoami`
+3. You may need to login using `npm login` note your npm user must have 2FA enabled (in your profile)
+4. Run `npm install` then `npm publish`

package/package.json

@@ -1,52 +1,51 @@
-{
-  "name": "@saber-usa/node-common",
-  "version": "1.7.7",
-  "description": "Common node functions for Saber",
-  "main": "src/index.js",
-  "type": "module",
-  "scripts": {
-    "lint": "eslint . --ext js",
-    "lint:fix": "eslint . --ext js --fix",
-    "test": "jest --no-coverage --silent",
-    "test:unit": "jest --coverage --runInBand --no-watch",
-    "sonar": "node --experimental-vm-modules sonar-project.js",
-    "prepub:alpha": "npm version prerelease --preid=alpha && npm publish --tag alpha"
-  },
-  "files": [
-    "src/**/*"
-  ],
-  "author": "Saber USA",
-  "license": "ISC",
-  "dependencies": {
-    "@aws-sdk/client-s3": "^3.666.0",
-    "date-fns": "^4.1.0",
-    "lodash": "4.17.21",
-    "mathjs": "^14.7.0",
-    "pious-squid": "^2.3.0",
-    "plotly": "^1.0.6",
-    "satellite.js": "^6.0.1",
-    "solar-calculator": "^0.3.0",
-    "three": "^0.178.0",
-    "winston": "3.3.3"
-  },
-  "devDependencies": {
-    "@babel/core": "7.16.0",
-    "@babel/eslint-parser": "7.16.3",
-    "@babel/plugin-transform-modules-commonjs": "7.16.0",
-    "@jest/globals": "27.4.4",
-    "eslint-config-google": "0.14.0",
-    "eslint-plugin-jest": "25.3.0",
-    "jest": "29.7.0",
-    "jest-diff": "29.7.0",
-    "nodemon": "3.1.4",
-    "sonarqube-scanner": "3.0.1"
-  },
-  "overrides": {
-    "braces": "3.0.3"
-  },
-  "babel": {
-    "plugins": [
-      "@babel/plugin-transform-modules-commonjs"
-    ]
-  }
-}
+{
+  "name": "@saber-usa/node-common",
+  "version": "1.7.9-alpha.1",
+  "description": "Common node functions for Saber",
+  "main": "src/index.js",
+  "type": "module",
+  "scripts": {
+    "lint": "eslint . --ext js",
+    "lint:fix": "eslint . --ext js --fix",
+    "test": "jest --no-coverage --silent",
+    "test:unit": "jest --coverage --runInBand --no-watch",
+    "sonar": "node --experimental-vm-modules sonar-project.js"
+  },
+  "files": [
+    "src/**/*"
+  ],
+  "author": "Saber USA",
+  "license": "ISC",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.666.0",
+    "date-fns": "^4.1.0",
+    "lodash": "4.17.21",
+    "mathjs": "^14.7.0",
+    "pious-squid": "^2.3.0",
+    "plotly": "^1.0.6",
+    "satellite.js": "^6.0.1",
+    "solar-calculator": "^0.3.0",
+    "three": "^0.178.0",
+    "winston": "3.3.3"
+  },
+  "devDependencies": {
+    "@babel/core": "7.16.0",
+    "@babel/eslint-parser": "7.16.3",
+    "@babel/plugin-transform-modules-commonjs": "7.16.0",
+    "@jest/globals": "27.4.4",
+    "eslint-config-google": "0.14.0",
+    "eslint-plugin-jest": "25.3.0",
+    "jest": "29.7.0",
+    "jest-diff": "29.7.0",
+    "nodemon": "3.1.4",
+    "sonarqube-scanner": "3.0.1"
+  },
+  "overrides": {
+    "braces": "3.0.3"
+  },
+  "babel": {
+    "plugins": [
+      "@babel/plugin-transform-modules-commonjs"
+    ]
+  }
+}