@trayio/connector-utils - npm Package Compare versions

Comparing version 0.3.1 to 0.3.3

lib/index.js

 /* eslint-disable no-console */
 const deepMapKeys = require('./deepMapKeys');
 const removeEmptyObjects = require('./removeEmptyObjects');
+const removeAuthKeys = require('./removeAuthKeys');
 const lookup = require('./lookup');
@@ -68,2 +69,3 @@ const validatePaginationRange = require('./validatePaginationRange');
 	removeEmptyObjects,
+	removeAuthKeys,
 	lookup,
@@ -70,0 +72,0 @@ mustachedDDL,

lib/internal/errors.js

@@ -9,2 +9,3 @@ /* eslint-disable max-classes-per-file */
 	PAGINATION: 'The validatePagination operation encountered an issue.',
+	REMOVE_AUTH: 'The removeAuthParams operation encountered an issue.',
 };
@@ -49,2 +50,8 @@
 
+class RemoveAuthError extends GenericInternalError {
+	constructor(message = ERROR_MESSAGES.REMOVE_AUTH, ...errorArgs) {
+		super(message, ...errorArgs);
+	}
+}
+
 module.exports = {
@@ -55,2 +62,3 @@ XMLError,
 	PaginationError,
+	RemoveAuthError,
 };

package.json

 {
-    "name": "@trayio/connector-utils",
-    "version": "0.3.1",
-    "description": "Common utility functions used in connectors.",
-    "main": "lib/index.js",
-    "scripts": {
-        "coverage": "npm run test -- --coverage",
-        "lint": "./node_modules/.bin/eslint . --fix",
-        "test": "jest tests",
-        "test:watch": "jest tests --watch --notify"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/trayio/falafel-utils.git"
-    },
-    "keywords": [
-        "falafel",
-        "connectors"
-    ],
-    "files": [
-        "index.js",
-        "/lib"
-    ],
-    "author": "tray.io",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/trayio/connector-utils/issues"
-    },
-    "homepage": "https://github.com/trayio/connector-utils#readme",
-    "devDependencies": {
-        "@trayio/connector-test-runner": "^0.5.0",
-        "@trayio/falafel": "^1.26.0",
-        "eslint": "^6.8.0",
-        "eslint-config-airbnb-base": "^14.1.0",
-        "eslint-config-prettier": "^6.10.0",
-        "eslint-plugin-import": "^2.20.1",
-        "eslint-plugin-jest": "^23.8.2",
-        "eslint-plugin-jsx-a11y": "^6.2.3",
-        "eslint-plugin-prettier": "^3.1.2",
-        "eslint-plugin-promise": "^4.2.1",
-        "jest": "^25.1.0",
-        "jest-json-schema": "^2.1.0",
-        "jsdoc-to-markdown": "^5.0.3",
-        "prettier": "^1.19.1"
-    },
-    "dependencies": {
-        "lodash": "~4.17.15",
-        "mustache": "^4.0.1"
-    }
-}
+	"name": "@trayio/connector-utils",
+	"version": "0.3.3",
+	"description": "Common utility functions used in connectors.",
+	"main": "lib/index.js",
+	"scripts": {
+		"coverage": "npm run test -- --coverage",
+		"lint": "./node_modules/.bin/eslint . --fix",
+		"test": "jest tests",
+		"test:watch": "jest tests --watch --notify"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trayio/falafel-utils.git"
+	},
+	"keywords": [
+		"falafel",
+		"connectors"
+	],
+	"files": [
+		"index.js",
+		"/lib"
+	],
+	"author": "tray.io",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/trayio/connector-utils/issues"
+	},
+	"homepage": "https://github.com/trayio/connector-utils#readme",
+	"devDependencies": {
+		"eslint": "^6.8.0",
+		"eslint-config-airbnb-base": "^14.1.0",
+		"eslint-config-prettier": "^6.10.0",
+		"eslint-plugin-import": "^2.20.1",
+		"eslint-plugin-jest": "^23.8.2",
+		"eslint-plugin-jsx-a11y": "^6.2.3",
+		"eslint-plugin-prettier": "^3.1.2",
+		"eslint-plugin-promise": "^4.2.1",
+		"jest": "^25.1.0",
+		"jest-json-schema": "^2.1.0",
+		"jsdoc-to-markdown": "^5.0.3",
+		"prettier": "^1.19.1"
+	},
+	"dependencies": {
+		"lodash": "~4.17.15",
+		"mustache": "^4.0.1"
+	}
+}

README.md

@@ -9,3 +9,3 @@ # Connector-utils
 
-When adding the package as part of an existing connector, first ensure you have the appropriate `.npmrc` present, then in your terminal, run:
+When adding the package as part of an existing connector, in your terminal, run:
 
@@ -370,2 +370,15 @@ ```
 
+<a name="removeAuthKeys"></a>
+
+## removeAuthKeys(collection, additionalKeys)
+
+Removes top levels '#' keys and additional top level keys if supplied.
+
+**Kind**: global function
+
+| Param          | Type                | Description                                                       |
+| -------------- | ------------------- | ----------------------------------------------------------------- |
+| collection     | <code>Object</code> | The collection to remove '#' keys and additional given keys from. |
+| additionalKeys | <code>Array</code>  | An array of additional key names (strings) to remove.             |
+
 <a name="validatePaginationRange"></a>
@@ -492,6 +505,5 @@
 ```js
-
 formatArrayToDelimitedList({ arrayToFormat: undefined });
 
 // returns undefined
-```
+```

No alert changes

Improved metrics

Total package byte prevSize

51374

increased by5.66%

Dev dependency count

12

decreased by-14.29%

Number of package files

16

increased by14.29%

Lines of code

779

increased by5.7%

Number of lines in readme file

507

increased by2.63%

No dependency changes