@run-crank/utilities - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

dist/src/utils/assert.d.ts

@@ -5,2 +5,2 @@ export interface AssertionResult {
 }
-export declare function assert(operator: string, actualValue: any, expectedValue: any, field: string): AssertionResult;
+export declare function assert(operator: string, actualValue: any, expectedValue: any, field: string, piiLevel?: string): AssertionResult;

dist/src/utils/assert.js

@@ -81,31 +81,32 @@ "use strict";
 };
+const piiRedactedMessage = 'PII REDACTED';
 const FAIL_MESSAGES = {
-    'be': (actual, expected, field) => `Expected ${field} field to be "${expected}", but it was actually "${actual}"`,
-    'not be': (actual, expected, field) => `Expected ${field} field not to be "${expected}", but it was also "${actual}"`,
-    'contain': (actual, expected, field) => `Expected ${field} field to contain "${expected}", but it is not contained in "${actual}"`,
-    'not contain': (actual, expected, field) => `Expected ${field} field not to contain "${expected}", but it is contained in "${actual}"`,
-    'be greater than': (actual, expected, field) => `${field} field is expected to be greater than "${expected}", but its value was "${actual}"`,
-    'be less than': (actual, expected, field) => `${field} field is expected to be less than "${expected}", but its value was "${actual}"`,
-    'be set': (actual, expected, field) => `Expected ${field} field to be set, but it was not`,
-    'not be set': (actual, expected, field) => `Expected ${field} field not to be set, but it was actually set to "${actual}"`,
-    'be one of': (actual, expected, field) => `Expected ${field} field to be one of these values ("${expected}"), but it was actually "${actual}"`,
-    'not be one of': (actual, expected, field) => `Expected ${field} field to not be one of these values ("${expected}"), but it was actually "${actual}"`,
-    'match': (actual, expected, field) => `Expected ${field} field to match the pattern "${expected}", but it does not. The actual value is "${actual}"`,
-    'not match': (actual, expected, field) => `Expected ${field} field not to match the pattern "${expected}", but it does. The actual value is "${actual}"`,
+    'be': (actual, expected, field, piiLevel = null) => `Expected ${field} field to be "${expected}", but it was actually "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not be': (actual, expected, field, piiLevel = null) => `Expected ${field} field not to be "${expected}", but it was also "${piiLevel ? piiRedactedMessage : actual}"`,
+    'contain': (actual, expected, field, piiLevel = null) => `Expected ${field} field to contain "${expected}", but it is not contained in "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not contain': (actual, expected, field, piiLevel = null) => `Expected ${field} field not to contain "${expected}", but it is contained in "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be greater than': (actual, expected, field, piiLevel = null) => `${field} field is expected to be greater than "${expected}", but its value was "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be less than': (actual, expected, field, piiLevel = null) => `${field} field is expected to be less than "${expected}", but its value was "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be set': (actual, expected, field, piiLevel = null) => `Expected ${field} field to be set, but it was not`,
+    'not be set': (actual, expected, field, piiLevel = null) => `Expected ${field} field not to be set, but it was actually set to "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be one of': (actual, expected, field, piiLevel = null) => `Expected ${field} field to be one of these values ("${expected}"), but it was actually "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not be one of': (actual, expected, field, piiLevel = null) => `Expected ${field} field to not be one of these values ("${expected}"), but it was actually "${piiLevel ? piiRedactedMessage : actual}"`,
+    'match': (actual, expected, field, piiLevel = null) => `Expected ${field} field to match the pattern "${expected}", but it does not. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not match': (actual, expected, field, piiLevel = null) => `Expected ${field} field not to match the pattern "${expected}", but it does. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
 };
 const SUCCESS_MESSAGES = {
-    'be': (expected, field, actual) => `The ${field} field was set to "${expected}", as expected`,
-    'not be': (expected, field, actual) => `The ${field} field was not set to "${expected}", as expected. The actual value is "${actual}"`,
-    'contain': (expected, field, actual) => `The ${field} field contains "${expected}", as expected. The actual value is "${actual}"`,
-    'not contain': (expected, field, actual) => `The ${field} field does not contain "${expected}", as expected. The actual value is "${actual}"`,
-    'be greater than': (expected, field, actual) => `The ${field} field was greater than "${expected}", as expected. The actual value is "${actual}"`,
-    'be less than': (expected, field, actual) => `The ${field} field was less than "${expected}", as expected. The actual value is "${actual}"`,
-    'be set': (expected, field, actual) => `${field} field was set, as expected. The actual value is "${actual}"`,
-    'not be set': (expected, field, actual) => `${field} field was not set, as expected`,
-    'be one of': (expected, field, actual) => `${field} field was set to one of these values ("${expected}"), as expected. The actual value is "${actual}"`,
-    'not be one of': (expected, field, actual) => `${field} field was not set to one of these values ("${expected}"), as expected. The actual value is "${actual}"`,
-    'match': (expected, field, actual) => `The ${field} field matches the pattern "${expected}", as expected. The actual value is "${actual}"`,
-    'not match': (expected, field, actual) => `The ${field} field does not match the pattern "${expected}", as expected. The actual value is "${actual}"`,
+    'be': (expected, field, actual, piiLevel = null) => `The ${field} field was set to "${expected}", as expected`,
+    'not be': (expected, field, actual, piiLevel = null) => `The ${field} field was not set to "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'contain': (expected, field, actual, piiLevel = null) => `The ${field} field contains "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not contain': (expected, field, actual, piiLevel = null) => `The ${field} field does not contain "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be greater than': (expected, field, actual, piiLevel = null) => `The ${field} field was greater than "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be less than': (expected, field, actual, piiLevel = null) => `The ${field} field was less than "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'be set': (expected, field, actual, piiLevel = null) => `${field} field was set, as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not be set': (expected, field, actual, piiLevel = null) => `${field} field was not set, as expected`,
+    'be one of': (expected, field, actual, piiLevel = null) => `${field} field was set to one of these values ("${expected}"), as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not be one of': (expected, field, actual, piiLevel = null) => `${field} field was not set to one of these values ("${expected}"), as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'match': (expected, field, actual, piiLevel = null) => `The ${field} field matches the pattern "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
+    'not match': (expected, field, actual, piiLevel = null) => `The ${field} field does not match the pattern "${expected}", as expected. The actual value is "${piiLevel ? piiRedactedMessage : actual}"`,
 };
-function assert(operator, actualValue, expectedValue, field) {
+function assert(operator, actualValue, expectedValue, field, piiLevel = null) {
     operator = operator ? operator.toLowerCase().trim() : '';
@@ -122,3 +123,3 @@ actualValue = stringifyValue(actualValue);
     result.valid = COMPARERS[operator](actualValue, expectedValue);
-    result.message = result.valid ? SUCCESS_MESSAGES[operator](expectedValue, field, actualValue) : FAIL_MESSAGES[operator](actualValue, expectedValue, field);
+    result.message = result.valid ? SUCCESS_MESSAGES[operator](expectedValue, field, actualValue, piiLevel) : FAIL_MESSAGES[operator](actualValue, expectedValue, field, piiLevel);
     return result;
@@ -125,0 +126,0 @@ }

package.json

 {
   "name": "@run-crank/utilities",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Utility methods and functionality to be shared across all Cogs written in Typescript.",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/run-crank/typescript-cog-utilities#readme",

No alert changes

Improved metrics

Total package byte prevSize

21439

increased by5.82%

Lines of code

316

increased by0.32%

No dependency changes