@tamtamchik/json-deep-sort 1.1.1 → 1.1.3

package/README.md

@@ -2,7 +2,9 @@
 
 [![Buy Me A Coffee][ico-coffee]][link-coffee]
 [![Latest Version on NPM][ico-version]][link-npm]
-[![CircleCI][ico-circleci]][link-circleci]
+[![Scrutinizer build][ico-scrutinizer-build]][link-scrutinizer]
+[![Scrutinizer quality][ico-scrutinizer-quality]][link-scrutinizer]
+[![Scrutinizer coverage][ico-scrutinizer-coverage]][link-scrutinizer]
 [![Software License][ico-license]](LICENSE)
 [![Total Downloads][ico-downloads]][link-downloads]
 
@@ -10,13 +12,6 @@ JSON Deep Sort is a comprehensive package that provides flexible sorting of JSON
 TypeScript-written package can handle deeply nested objects and arrays, and offers both synchronous and asynchronous
 operations.
 
-## Features
-
-- Efficiently sorts keys in JSON objects and arrays.
-- Handles deeply nested JSON objects and arrays.
-- Provides both synchronous and asynchronous sorting operations.
-- Written in TypeScript for robust typing and error checking.
-
 ## Installation
 
 Using npm:
@@ -69,9 +64,11 @@ JSON Deep Sort is [MIT licensed](./LICENSE).
 [ico-version]: https://img.shields.io/npm/v/@tamtamchik/json-deep-sort.svg?style=flat-square
 [ico-license]: https://img.shields.io/npm/l/@tamtamchik/json-deep-sort.svg?style=flat-square
 [ico-downloads]: https://img.shields.io/npm/dt/@tamtamchik/json-deep-sort.svg?style=flat-square
-[ico-circleci]: https://img.shields.io/circleci/build/github/tamtamchik/json-deep-sort.svg?style=flat-square
+[ico-scrutinizer-build]: https://img.shields.io/scrutinizer/build/g/tamtamchik/json-deep-sort/main.svg?style=flat-square
+[ico-scrutinizer-quality]: https://img.shields.io/scrutinizer/quality/g/tamtamchik/json-deep-sort/main.svg?style=flat-square
+[ico-scrutinizer-coverage]: https://img.shields.io/scrutinizer/coverage/g/tamtamchik/json-deep-sort/main.svg?style=flat-square
 
 [link-coffee]: https://www.buymeacoffee.com/tamtamchik
 [link-npm]: https://www.npmjs.com/package/@tamtamchik/json-deep-sort
 [link-downloads]: https://www.npmjs.com/package/@tamtamchik/json-deep-sort
-[link-circleci]: https://app.circleci.com/pipelines/github/tamtamchik/json-deep-sort?branch=main
+[link-scrutinizer]: https://scrutinizer-ci.com/g/tamtamchik/json-deep-sort/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamtamchik/json-deep-sort",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "A comprehensive utility for sorting JSON objects by keys.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -32,12 +32,12 @@
     "json-tools"
   ],
   "devDependencies": {
-    "@types/jest": "29.5.3",
-    "@types/node": "20.5.1",
-    "jest": "29.6.2",
-    "ts-jest": "29.1.1",
-    "tsup": "7.2.0",
-    "typescript": "5.1.6"
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.8",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5"
   },
   "exports": {
     ".": {

package/src/index.ts

@@ -0,0 +1,64 @@
+/**
+ * Enumeration of data types.
+ * @enum {string}
+ */
+enum DataType {
+  OBJECT,
+  ARRAY,
+  STRING,
+  OTHER,
+}
+
+/**
+ * Function to determine the data type of the provided data.
+ * @param {any} data - The data to be checked.
+ * @returns {DataType} The DataType value corresponding to the data's type.
+ */
+function getType (data: any): DataType {
+  if (Array.isArray(data)) {
+    return DataType.ARRAY
+  } else if (typeof data === 'object' && data !== null) {
+    return DataType.OBJECT
+  } else if (typeof data === 'string') {
+    return DataType.STRING
+  } else {
+    return DataType.OTHER
+  }
+}
+
+/**
+ * Function to determine whether the provided data is a recursive type.
+ * @param {any} data - The data to be checked.
+ * @returns {boolean} Whether the data is a recursive type.
+ */
+function isRecursiveType (data: any): boolean {
+  return [DataType.OBJECT, DataType.ARRAY].includes(getType(data))
+}
+
+/**
+ * Function to sort JSON data.
+ * @param {any} data - The data to be sorted.
+ * @param {boolean} [asc=true] - Whether to sort in ascending order.
+ * @returns {any} The sorted data.
+ * @throws {Error} If the data is not an object or array.
+ */
+export function sort (data: any, asc: boolean = true): any {
+  switch (getType(data)) {
+
+    case DataType.ARRAY:
+      return data.map((d: any) => isRecursiveType(d) ? sort(d, asc) : d)
+
+    case DataType.OBJECT:
+      const keys = Object.keys(data).sort()
+
+      if (!asc) keys.reverse()
+
+      return keys.reduce((newData: any, key: string) => {
+        newData[key] = isRecursiveType(data[key]) ? sort(data[key], asc) : data[key]
+        return newData
+      }, {})
+
+    default:
+      throw new Error('Invalid data type: expected an object or array of objects.')
+  }
+}