@tamtamchik/json-deep-sort 0.1.0 → 1.0.0

package/.circleci/config.yml

@@ -0,0 +1,23 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: cimg/node:20.2.0
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "package-lock.json" }}
+            - v1-dependencies-
+      - run: npm ci
+      - run: npm test
+      - run: npm run coverage
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package-lock.json" }}
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - build

package/README.md

@@ -1,7 +1,10 @@
 # JSON Deep Sort
 
-![npm](https://img.shields.io/npm/v/json-deep-sort)
-![license](https://img.shields.io/npm/l/json-deep-sort)
+[![Buy Me A Coffee][ico-coffee]][link-coffee]
+[![Latest Version on NPM][ico-version]][link-npm]
+[![CircleCI][ico-circleci]][link-circleci]
+[![Software License][ico-license]](LICENSE)
+[![Total Downloads][ico-downloads]][link-downloads]
 
 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
@@ -19,13 +22,13 @@ operations.
 Using npm:
 
 ```shell
-npm install json-deep-sort
+npm install @tamtamchik/json-deep-sort
 ```
 
 Using yarn:
 
 ```shell
-yarn add json-deep-sort
+yarn add @tamtamchik/json-deep-sort
 ```
 
 ## Usage
@@ -49,8 +52,9 @@ let data = {
         b: 'b'
     }
 };
+
 let sortedData = sort(data, true);
-console.log(sortedData); // { a: 'a', b: 'b', c: { a: 'a', b: 'b', c: 'c', d: 'd' } }
+// { a: 'a', b: 'b', c: { a: 'a', b: 'b', c: 'c', d: 'd' } }
 ```
 
 ## Contributing
@@ -60,3 +64,14 @@ Pull requests are welcome. For major changes, please open an issue first to disc
 ## License
 
 JSON Deep Sort is [MIT licensed](./LICENSE).
+
+[ico-coffee]: https://img.shields.io/badge/Buy%20Me%20A-Coffee-%236F4E37.svg?style=flat-square
+[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
+
+[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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamtamchik/json-deep-sort",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "A comprehensive utility for sorting JSON objects by keys.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -53,6 +53,7 @@
     "build": "npm run build:cjs && npm run build:esm",
     "dev": "tsc --watch",
     "prepare": "npm run build",
-    "test": "jest"
+    "test": "jest",
+    "coverage": "jest --coverage"
   }
 }

package/.idea/GitLink.xml

@@ -1,6 +0,0 @@
-<?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

@@ -1,13 +0,0 @@
-<?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

@@ -1,8 +0,0 @@
-<?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

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

package/dist/cjs/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/jest.config.js

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

package/src/index.ts

@@ -1,62 +0,0 @@
-/**
- * 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

@@ -1,98 +0,0 @@
-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.')
-  })
-})