@tamtamchik/json-deep-sort 0.1.0

package/.idea/GitLink.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="uk.co.ben_gibson.git.link.SettingsState">
+    <option name="host" value="72037fcc-cb9c-4c22-960a-ffe73fd5e229" />
+  </component>
+</project>

package/.idea/json-deep-sort.iml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/json-deep-sort.iml" filepath="$PROJECT_DIR$/.idea/json-deep-sort.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yuri Tkachenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,62 @@
+# JSON Deep Sort
+
+![npm](https://img.shields.io/npm/v/json-deep-sort)
+![license](https://img.shields.io/npm/l/json-deep-sort)
+
+JSON Deep Sort is a comprehensive package that provides flexible sorting of JSON objects by keys. This
+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:
+
+```shell
+npm install json-deep-sort
+```
+
+Using yarn:
+
+```shell
+yarn add json-deep-sort
+```
+
+## Usage
+
+Import JSON Deep Sort in your TypeScript file:
+
+```typescript
+import { sort } from '@tamtamchik/json-deep-sort';
+```
+
+Here is an example of sorting a JSON object:
+
+```typescript
+let data = {
+    b: 'b',
+    a: 'a',
+    c: {
+        d: 'd',
+        c: 'c',
+        a: 'a',
+        b: 'b'
+    }
+};
+let sortedData = sort(data, true);
+console.log(sortedData); // { a: 'a', b: 'b', c: { a: 'a', b: 'b', c: 'c', d: 'd' } }
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+JSON Deep Sort is [MIT licensed](./LICENSE).

package/dist/cjs/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 declare function sort(data: any, asc?: boolean): any;

package/dist/cjs/index.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sort = void 0;
+/**
+ * Enumeration of data types.
+ * @enum {string}
+ */
+var DataType;
+(function (DataType) {
+    DataType["OBJECT"] = "OBJECT";
+    DataType["ARRAY"] = "ARRAY";
+    DataType["STRING"] = "STRING";
+    DataType["OTHER"] = "OTHER";
+})(DataType || (DataType = {}));
+/**
+ * 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) {
+    const objectConstructor = {}.constructor;
+    const arrayConstructor = [].constructor;
+    const stringConstructor = ''.constructor;
+    if (data && data.constructor === objectConstructor) {
+        return DataType.OBJECT;
+    }
+    else if (data && data.constructor === arrayConstructor) {
+        return DataType.ARRAY;
+    }
+    else if (data && data.constructor === stringConstructor) {
+        return DataType.STRING;
+    }
+    else {
+        return DataType.OTHER;
+    }
+}
+/**
+ * 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.
+ */
+function sort(data, asc = true) {
+    switch (getType(data)) {
+        case DataType.ARRAY:
+            return data.map((d) => [DataType.OBJECT, DataType.ARRAY].includes(getType(d)) ? sort(d, asc) : d);
+        case DataType.OBJECT:
+            const keys = Object.keys(data).sort();
+            if (!asc)
+                keys.reverse();
+            return keys.reduce((newData, key) => {
+                if ([DataType.OBJECT, DataType.ARRAY].includes(getType(data[key])))
+                    newData[key] = sort(data[key], asc);
+                else
+                    newData[key] = data[key];
+                return newData;
+            }, {});
+        default:
+            throw new Error('Invalid data type: expected an object or array.');
+    }
+}
+exports.sort = sort;

package/dist/esm/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 declare function sort(data: any, asc?: boolean): any;

package/dist/esm/index.js

@@ -0,0 +1,59 @@
+/**
+ * Enumeration of data types.
+ * @enum {string}
+ */
+var DataType;
+(function (DataType) {
+    DataType["OBJECT"] = "OBJECT";
+    DataType["ARRAY"] = "ARRAY";
+    DataType["STRING"] = "STRING";
+    DataType["OTHER"] = "OTHER";
+})(DataType || (DataType = {}));
+/**
+ * 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) {
+    const objectConstructor = {}.constructor;
+    const arrayConstructor = [].constructor;
+    const stringConstructor = ''.constructor;
+    if (data && data.constructor === objectConstructor) {
+        return DataType.OBJECT;
+    }
+    else if (data && data.constructor === arrayConstructor) {
+        return DataType.ARRAY;
+    }
+    else if (data && data.constructor === stringConstructor) {
+        return DataType.STRING;
+    }
+    else {
+        return DataType.OTHER;
+    }
+}
+/**
+ * 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, asc = true) {
+    switch (getType(data)) {
+        case DataType.ARRAY:
+            return data.map((d) => [DataType.OBJECT, DataType.ARRAY].includes(getType(d)) ? sort(d, asc) : d);
+        case DataType.OBJECT:
+            const keys = Object.keys(data).sort();
+            if (!asc)
+                keys.reverse();
+            return keys.reduce((newData, key) => {
+                if ([DataType.OBJECT, DataType.ARRAY].includes(getType(data[key])))
+                    newData[key] = sort(data[key], asc);
+                else
+                    newData[key] = data[key];
+                return newData;
+            }, {});
+        default:
+            throw new Error('Invalid data type: expected an object or array.');
+    }
+}

package/jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  collectCoverage: true,
+  coverageReporters: ['text', 'lcov'],
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@tamtamchik/json-deep-sort",
+  "version": "0.1.0",
+  "description": "A comprehensive utility for sorting JSON objects by keys.",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "author": "Yuri Tkachenko <yuri.tam.tkachenko@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/tamtamchik/json-deep-sort#readme",
+  "bugs": {
+    "url": "https://github.com/tamtamchik/json-deep-sort/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/tamtamchik/json-deep-sort.git"
+  },
+  "keywords": [
+    "json",
+    "sort",
+    "json-sort",
+    "keysort",
+    "json-keysort",
+    "json-deep-sort",
+    "sorting",
+    "typescript",
+    "async-sort",
+    "synchronous-sort",
+    "json-manipulation",
+    "data-processing",
+    "json-utility",
+    "json-tools"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "directories": {
+    "test": "test"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.1",
+    "@types/node": "20.2.5",
+    "jest": "29.5.0",
+    "ts-jest": "29.1.0",
+    "typescript": "5.0.4"
+  },
+  "scripts": {
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
+    "dev": "tsc --watch",
+    "prepare": "npm run build",
+    "test": "jest"
+  }
+}

package/src/index.ts

@@ -0,0 +1,62 @@
+/**
+ * Enumeration of data types.
+ * @enum {string}
+ */
+enum DataType {
+  OBJECT = 'OBJECT',
+  ARRAY = 'ARRAY',
+  STRING = 'STRING',
+  OTHER = '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 {
+  const objectConstructor = {}.constructor
+  const arrayConstructor = [].constructor
+  const stringConstructor = ''.constructor
+
+  if (data && data.constructor === objectConstructor) {
+    return DataType.OBJECT
+  } else if (data && data.constructor === arrayConstructor) {
+    return DataType.ARRAY
+  } else if (data && data.constructor === stringConstructor) {
+    return DataType.STRING
+  } else {
+    return DataType.OTHER
+  }
+}
+
+/**
+ * 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 = true): any {
+  switch (getType(data)) {
+
+    case DataType.ARRAY:
+      return data.map((d: any) => [DataType.OBJECT, DataType.ARRAY].includes(getType(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) => {
+        if ([DataType.OBJECT, DataType.ARRAY].includes(getType(data[key])))
+          newData[key] = sort(data[key], asc)
+        else
+          newData[key] = data[key]
+        return newData
+      }, {})
+
+    default:
+      throw new Error('Invalid data type: expected an object or array.')
+  }
+}

package/test/sort.test.ts

@@ -0,0 +1,98 @@
+import { sort } from '../src'
+
+describe('sort', () => {
+  it('should sort an object', () => {
+    const input = { b: 'b', a: 'a' }
+    const expected = { a: 'a', b: 'b' }
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should not sort an simple array', () => {
+    const input = ['a', 'b']
+    const expected = ['a', 'b']
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should sort an array of objects', () => {
+    const input = [
+      { b: 'b', a: 'a' },
+      { d: 'd', c: 'c' },
+    ]
+    const expected = [
+      { a: 'a', b: 'b' },
+      { c: 'c', d: 'd' },
+    ]
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should sort an object with array values', () => {
+    const input = {
+      b: ['b', 'a'],
+      a: ['d', 'c', 'b', 'a'],
+    }
+    const expected = {
+      a: ['d', 'c', 'b', 'a'],
+      b: ['b', 'a'],
+    }
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should sort an object with nested objects', () => {
+    const input = {
+      a: 'a',
+      b: {
+        b: 'b',
+        a: 'a',
+      },
+    }
+    const expected = {
+      a: 'a',
+      b: {
+        a: 'a',
+        b: 'b',
+      },
+    }
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should not sort an array of simple arrays', () => {
+    const input = [
+      ['b', 'a'],
+      ['d', 'c', 'b', 'a'],
+    ]
+    const expected = [
+      ['b', 'a'],
+      ['d', 'c', 'b', 'a'],
+    ]
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should sort an array containing objects', () => {
+    const input = [
+      { b: 'b', a: 'a' },
+      { d: 'd', c: 'c', b: 'b', a: 'a' },
+    ]
+    const expected = [
+      { a: 'a', b: 'b' },
+      { a: 'a', b: 'b', c: 'c', d: 'd' },
+    ]
+    expect(sort(input)).toEqual(expected)
+  })
+
+  it('should sort an object in descending order', () => {
+    const input = { b: 'b', a: 'a', c: 'c' }
+    const expected = { c: 'c', b: 'b', a: 'a' }
+    expect(sort(input, false)).toEqual(expected)
+  })
+
+  it('should throw an error for non-object, non-array input', () => {
+    const input = 'string'
+    expect(() => sort(input)).toThrow('Invalid data type: expected an object or array.')
+
+    const inputNumber = 123
+    expect(() => sort(inputNumber)).toThrow('Invalid data type: expected an object or array.')
+
+    const inputNull = null
+    expect(() => sort(inputNull)).toThrow('Invalid data type: expected an object or array.')
+  })
+})

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "./dist/cjs",
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "es2020",
+    "outDir": "./dist/esm",
+  }
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "target": "es6",
+    "moduleResolution": "node"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}