@apigames/json 22.1.0-dev.3 → 22.1.0-dev.7

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 API Games Limited
+Copyright (c) 2022 API Games Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,5 +1,10 @@
-API Games JSON Utilities
-========================
+# API Games JSON Utilities
+
+![](https://img.shields.io/badge/build-passing-brightgreen)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6aba1020060a467899666e3f1884d37f)](https://www.codacy.com/gh/apigames-public/json/dashboard?utm_source=github.com&utm_medium=referral&utm_content=apigames-public/json&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/6aba1020060a467899666e3f1884d37f)](https://www.codacy.com/gh/apigames-public/json/dashboard?utm_source=github.com&utm_medium=referral&utm_content=apigames-public/json&utm_campaign=Badge_Coverage)
+![](https://img.shields.io/npm/v/@apigames/json)
+![](https://img.shields.io/badge/license-MIT-blue)
 
 JSON Utilities Library for the API Games Platform and SDKs.
 
@@ -7,7 +12,7 @@ JSON Utilities Library for the API Games Platform and SDKs.
 
 This package includes a set of utility functions that provide efficient and consistent JSON object manipulation capabilities.
 
-### List of features
+## List of features
 
 *   Provides the ability to append a JSON object with another sub document
 *   Provides the ability to compare JSON objects
@@ -15,16 +20,16 @@ This package includes a set of utility functions that provide efficient and cons
 *   Provides the ability to extract and redact elements from a JSON obejct
 *   Provides the ability to evaluate JSON element types
 
-### Download & Installation
+## Download & Installation
 
 ```shell 
 $ npm i @apigames/json 
 ```
 
-### Authors or Acknowledgments
+## Authors or Acknowledgments
 
 *   API Games Limited
 
-### License
+## License
 
 This project is licensed under the MIT License

package/lib/index.d.ts

@@ -1 +1 @@
-export { append, areEqual, clone, extractAndRedact, hasProperty, isArray, isBoolean, isDate, isDefined, isDefinedAndNotNull, isEmpty, isError, isFalse, isInteger, isNumber, isObject, isRegExp, isString, isTrue, isUndefined, isUndefinedOrNull, redactUndefinedValues, stringify, } from './utils';
+export { append, areEqual, clone, extractAndRedact, hasProperty, isArray, isArrayOfBooleans, isArrayOfDates, isArrayOfIntegers, isArrayOfNumbers, isArrayOfObjects, isArrayOfStrings, isBoolean, isDate, isDefined, isDefinedAndNotNull, isEmpty, isError, isFalse, isInteger, isNumber, isObject, isRegExp, isString, isTrue, isUndefined, isUndefinedOrNull, redactUndefinedValues, stringify, } from './utils';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = exports.redactUndefinedValues = exports.isUndefinedOrNull = exports.isUndefined = exports.isTrue = exports.isString = exports.isRegExp = exports.isObject = exports.isNumber = exports.isInteger = exports.isFalse = exports.isError = exports.isEmpty = exports.isDefinedAndNotNull = exports.isDefined = exports.isDate = exports.isBoolean = exports.isArray = exports.hasProperty = exports.extractAndRedact = exports.clone = exports.areEqual = exports.append = void 0;
+exports.stringify = exports.redactUndefinedValues = exports.isUndefinedOrNull = exports.isUndefined = exports.isTrue = exports.isString = exports.isRegExp = exports.isObject = exports.isNumber = exports.isInteger = exports.isFalse = exports.isError = exports.isEmpty = exports.isDefinedAndNotNull = exports.isDefined = exports.isDate = exports.isBoolean = exports.isArrayOfStrings = exports.isArrayOfObjects = exports.isArrayOfNumbers = exports.isArrayOfIntegers = exports.isArrayOfDates = exports.isArrayOfBooleans = exports.isArray = exports.hasProperty = exports.extractAndRedact = exports.clone = exports.areEqual = exports.append = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "append", { enumerable: true, get: function () { return utils_1.append; } });
 Object.defineProperty(exports, "areEqual", { enumerable: true, get: function () { return utils_1.areEqual; } });
@@ -8,6 +8,12 @@ Object.defineProperty(exports, "clone", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "extractAndRedact", { enumerable: true, get: function () { return utils_1.extractAndRedact; } });
 Object.defineProperty(exports, "hasProperty", { enumerable: true, get: function () { return utils_1.hasProperty; } });
 Object.defineProperty(exports, "isArray", { enumerable: true, get: function () { return utils_1.isArray; } });
+Object.defineProperty(exports, "isArrayOfBooleans", { enumerable: true, get: function () { return utils_1.isArrayOfBooleans; } });
+Object.defineProperty(exports, "isArrayOfDates", { enumerable: true, get: function () { return utils_1.isArrayOfDates; } });
+Object.defineProperty(exports, "isArrayOfIntegers", { enumerable: true, get: function () { return utils_1.isArrayOfIntegers; } });
+Object.defineProperty(exports, "isArrayOfNumbers", { enumerable: true, get: function () { return utils_1.isArrayOfNumbers; } });
+Object.defineProperty(exports, "isArrayOfObjects", { enumerable: true, get: function () { return utils_1.isArrayOfObjects; } });
+Object.defineProperty(exports, "isArrayOfStrings", { enumerable: true, get: function () { return utils_1.isArrayOfStrings; } });
 Object.defineProperty(exports, "isBoolean", { enumerable: true, get: function () { return utils_1.isBoolean; } });
 Object.defineProperty(exports, "isDate", { enumerable: true, get: function () { return utils_1.isDate; } });
 Object.defineProperty(exports, "isDefined", { enumerable: true, get: function () { return utils_1.isDefined; } });

package/lib/utils.d.ts

@@ -1,8 +1,10 @@
+export declare function isDefined(value: any): boolean;
+export declare function isDefinedAndNotNull(value: any): boolean;
+export declare function isUndefined(value: any): boolean;
+export declare function isUndefinedOrNull(value: any): boolean;
 export declare function isArray(value: any): value is Array<any>;
 export declare function isBoolean(value: any): value is boolean;
 export declare function isDate(value: any): value is Date;
-export declare function isDefined(value: any): boolean;
-export declare function isDefinedAndNotNull(value: any): boolean;
 export declare function isError(value: any): value is Error;
 export declare function isFalse(value: any): boolean;
 export declare function isNumber(value: any): value is number;
@@ -11,9 +13,13 @@ export declare function isObject(value: any): value is Object;
 export declare function isEmpty(document: any): boolean;
 export declare function isRegExp(value: any): value is RegExp;
 export declare function isString(value: any): value is string;
+export declare function isArrayOfBooleans(values: any): values is boolean[];
+export declare function isArrayOfDates(values: any): values is Date[];
+export declare function isArrayOfIntegers(values: any): values is number[];
+export declare function isArrayOfNumbers(values: any): values is number[];
+export declare function isArrayOfStrings(values: any): values is string[];
+export declare function isArrayOfObjects(values: any): values is object[];
 export declare function isTrue(value: any): boolean;
-export declare function isUndefined(value: any): boolean;
-export declare function isUndefinedOrNull(value: any): boolean;
 export declare function hasProperty(obj: any, property: string): boolean;
 export declare function append(document: any, extensionDocument: any): any;
 export declare function areEqual(firstObject: any, secondObject: any): boolean;

package/lib/utils.js

@@ -1,31 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractAndRedact = exports.stringify = exports.clone = exports.redactUndefinedValues = exports.areEqual = exports.append = exports.hasProperty = exports.isUndefinedOrNull = exports.isUndefined = exports.isTrue = exports.isString = exports.isRegExp = exports.isEmpty = exports.isObject = exports.isInteger = exports.isNumber = exports.isFalse = exports.isError = exports.isDefinedAndNotNull = exports.isDefined = exports.isDate = exports.isBoolean = exports.isArray = void 0;
+exports.extractAndRedact = exports.stringify = exports.clone = exports.redactUndefinedValues = exports.areEqual = exports.append = exports.hasProperty = exports.isTrue = exports.isArrayOfObjects = exports.isArrayOfStrings = exports.isArrayOfNumbers = exports.isArrayOfIntegers = exports.isArrayOfDates = exports.isArrayOfBooleans = exports.isString = exports.isRegExp = exports.isEmpty = exports.isObject = exports.isInteger = exports.isNumber = exports.isFalse = exports.isError = exports.isDate = exports.isBoolean = exports.isArray = exports.isUndefinedOrNull = exports.isUndefined = exports.isDefinedAndNotNull = exports.isDefined = void 0;
 const deepEqual = require('deep-equal');
 const clonedeep = require('lodash.clonedeep');
+function isDefined(value) {
+    return (value !== undefined);
+}
+exports.isDefined = isDefined;
+function isDefinedAndNotNull(value) {
+    return (value !== undefined) && (value !== null);
+}
+exports.isDefinedAndNotNull = isDefinedAndNotNull;
+function isUndefined(value) {
+    return (value === undefined);
+}
+exports.isUndefined = isUndefined;
+function isUndefinedOrNull(value) {
+    return (value === undefined) || (value === null);
+}
+exports.isUndefinedOrNull = isUndefinedOrNull;
 function isArray(value) {
-    return ((value !== null) && ((value !== undefined))) && (typeof value === 'object')
+    return isDefinedAndNotNull(value) && (typeof value === 'object')
         && (value.constructor === Array);
 }
 exports.isArray = isArray;
 function isBoolean(value) {
-    return ((value !== null) && ((value !== undefined))) && (typeof value === 'boolean');
+    return isDefinedAndNotNull(value) && (typeof value === 'boolean');
 }
 exports.isBoolean = isBoolean;
 function isDate(value) {
-    return ((value !== null) && ((value !== undefined))) && (value instanceof Date);
+    return isDefinedAndNotNull(value) && (value instanceof Date);
 }
 exports.isDate = isDate;
-function isDefined(value) {
-    return (value !== undefined);
-}
-exports.isDefined = isDefined;
-function isDefinedAndNotNull(value) {
-    return (value !== undefined) && (value !== null);
-}
-exports.isDefinedAndNotNull = isDefinedAndNotNull;
 function isError(value) {
-    return ((value !== null) && ((value !== undefined))) && (value instanceof Error) && (typeof value.message !== 'undefined');
+    return isDefinedAndNotNull(value) && (value instanceof Error) && (typeof value.message !== 'undefined');
 }
 exports.isError = isError;
 function isFalse(value) {
@@ -33,7 +41,7 @@ function isFalse(value) {
 }
 exports.isFalse = isFalse;
 function isNumber(value) {
-    return ((value !== null) && ((value !== undefined))) && (typeof value === 'number') && isFinite(value);
+    return isDefinedAndNotNull(value) && (typeof value === 'number') && isFinite(value);
 }
 exports.isNumber = isNumber;
 function isInteger(value) {
@@ -41,34 +49,86 @@ function isInteger(value) {
 }
 exports.isInteger = isInteger;
 function isObject(value) {
-    return ((value !== null) && ((value !== undefined))) && (typeof value === 'object')
+    return isDefinedAndNotNull(value) && (typeof value === 'object')
         && ((value.constructor === Object) || ((value instanceof Object) && (!isArray(value))));
 }
 exports.isObject = isObject;
 function isEmpty(document) {
-    return (!document) || (isObject(document) && (Object.keys(document).length === 0));
+    return (isUndefined(document)) || (isObject(document) && (Object.keys(document).length === 0));
 }
 exports.isEmpty = isEmpty;
 function isRegExp(value) {
-    return ((value !== null) && ((value !== undefined))) && (typeof value === 'object') && (value.constructor === RegExp);
+    return isDefinedAndNotNull(value) && (typeof value === 'object') && (value.constructor === RegExp);
 }
 exports.isRegExp = isRegExp;
 function isString(value) {
-    return ((value !== null) && ((value !== undefined))) && ((typeof value === 'string') || (value instanceof String));
+    return isDefinedAndNotNull(value) && ((typeof value === 'string') || (value instanceof String));
 }
 exports.isString = isString;
+function isArrayOfBooleans(values) {
+    if (isArray(values)) {
+        for (const value of values)
+            if (!isBoolean(value))
+                return false;
+        return true;
+    }
+    return false;
+}
+exports.isArrayOfBooleans = isArrayOfBooleans;
+function isArrayOfDates(values) {
+    if (isArray(values)) {
+        for (const value of values)
+            if (!isDate(value))
+                return false;
+        return true;
+    }
+    return false;
+}
+exports.isArrayOfDates = isArrayOfDates;
+function isArrayOfIntegers(values) {
+    if (isArray(values)) {
+        for (const value of values)
+            if (!isInteger(value))
+                return false;
+        return true;
+    }
+    return false;
+}
+exports.isArrayOfIntegers = isArrayOfIntegers;
+function isArrayOfNumbers(values) {
+    if (isArray(values)) {
+        for (const value of values)
+            if (!isNumber(value))
+                return false;
+        return true;
+    }
+    return false;
+}
+exports.isArrayOfNumbers = isArrayOfNumbers;
+function isArrayOfStrings(values) {
+    if (isArray(values)) {
+        for (const value of values)
+            if (!isString(value))
+                return false;
+        return true;
+    }
+    return false;
+}
+exports.isArrayOfStrings = isArrayOfStrings;
+function isArrayOfObjects(values) {
+    if (isArray(values)) {
+        for (const value of values)
+            if (!isObject(value))
+                return false;
+        return true;
+    }
+    return false;
+}
+exports.isArrayOfObjects = isArrayOfObjects;
 function isTrue(value) {
     return isBoolean(value) && (value === true);
 }
 exports.isTrue = isTrue;
-function isUndefined(value) {
-    return (value === undefined);
-}
-exports.isUndefined = isUndefined;
-function isUndefinedOrNull(value) {
-    return (value === undefined) || (value === null);
-}
-exports.isUndefinedOrNull = isUndefinedOrNull;
 function hasProperty(obj, property) {
     return isDefined(obj) && isObject(obj) && Object.prototype.hasOwnProperty.call(obj, property);
 }

package/package.json

@@ -3,7 +3,7 @@
   "author": "API Games Limited",
   "description": "API Games JSON Utilities",
   "license": "MIT",
-  "version": "22.1.0-dev.3",
+  "version": "22.1.0-dev.7",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
@@ -28,17 +28,17 @@
     "lodash.clonedeep": "4.5.0"
   },
   "devDependencies": {
-    "@types/jest": "27.0.3",
-    "@types/node": "14.18.0",
-    "@typescript-eslint/eslint-plugin": "5.7.0",
-    "@typescript-eslint/parser": "5.7.0",
-    "eslint": "8.4.1",
-    "eslint-config-airbnb": "19.0.2",
-    "eslint-plugin-import": "2.25.3",
+    "@types/jest": "27.4.0",
+    "@types/node": "14.18.5",
+    "@typescript-eslint/eslint-plugin": "5.9.1",
+    "@typescript-eslint/parser": "5.9.1",
+    "eslint": "8.6.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jsx-a11y": "6.5.1",
-    "eslint-plugin-react": "7.27.1",
+    "eslint-plugin-react": "7.28.0",
     "eslint-plugin-react-hooks": "4.3.0",
-    "jest": "27.4.5",
+    "jest": "27.4.7",
     "ts-jest": "27.1.2",
     "typescript": "4.5.4"
   },

package/publishCodeCoverage.sh

@@ -0,0 +1,7 @@
+export CODACY_API_TOKEN=zLmkgxu0V5R3qEbGrbbm
+export CODACY_ORGANIZATION_PROVIDER=gh
+export CODACY_USERNAME=apigames-public
+export CODACY_PROJECT_NAME=json
+
+bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r coverage/clover.xml
+