@znemz/sort-object 3.0.7 → 3.0.9

package/README.md

@@ -1,117 +1,143 @@
-# sort-object [![NPM version](https://img.shields.io/npm/v/sort-object.svg)](https://www.npmjs.com/package/sort-object) [![Build Status](https://img.shields.io/travis/nmccready/sort-object.svg)](https://app.travis-ci.com/github//nmccready/sort-object)
+# @znemz/sort-object
 
-> Sort the keys in an object.
+[![npm version](https://img.shields.io/npm/v/@znemz/sort-object.svg)](https://www.npmjs.com/package/@znemz/sort-object)
 
-## Install
+> Sort the keys in an object. TypeScript-first, ESM, maintained fork of [sort-object](https://github.com/doowb/sort-object).
+
+## Why this fork?
 
-Install with [npm](https://www.npmjs.com/):
+- ✅ **TypeScript** — Full type definitions included
+- ✅ **ESM** — Native ES modules with `type: "module"`
+- ✅ **Maintained** — Active maintenance, modern tooling (vitest, eslint 9)
+- ✅ **New features** — Deep/recursive sort, input validation
+- ✅ **Node 20+** — Modern engine target
+
+## Install
 
 ```sh
-$ npm i sort-object --save
+npm i @znemz/sort-object
 ```
 
 ## Usage
 
-```js
-var sortObj = require("sort-object");
-```
+### TypeScript / ESM
 
-By default, the keys on an object will be sorted in ascending order:
+```ts
+import sortObj from "@znemz/sort-object";
+// or: import { sort } from "@znemz/sort-object";
 
-```js
-sortObj({ a: 1, c: 2, b: 3 });
-//=> {a: 1, b: 3, c: 2}
+const sorted = sortObj({ a: 1, c: 2, b: 3 });
+// => { a: 1, b: 3, c: 2 }
 ```
 
-The second param can be an object of `options` OR an array of `keys`:
+### With options
 
-**object**
+```ts
+import sortObj, { type SortOptions } from "@znemz/sort-object";
 
-```js
-sortObj({ a: 1, c: 2, b: 3 }, { keys: ["a", "b"] });
-//=> {a: 1, b: 3}
+const options: SortOptions = {
+  sortOrder: "desc",
+};
+
+sortObj({ a: 1, c: 2, b: 3 }, options);
+// => { c: 2, b: 3, a: 1 }
 ```
 
-**array**
+## API
 
-```js
-sortObj({ a: 1, c: 2, b: 3 }, ["a", "c"]);
-//=> {a: 1, c: 2}
-```
+### `sort(obj, options?)`
 
-## Options
+Returns a **new object** with sorted keys (does not mutate the original).
 
-- `keys` {Array} The returned object will contain only the specified keys, in the same order.
-- `sort` {Function} Sort function to sort the keys using JavaScript's `.sort()` method.
-- `sortOrder` {String} Valid values are `desc` or `asc`, case insensitive.
-- `sortBy` {String} Sort function that is passed the entire object, rather than just the keys - as with the `.sort()` method.
+#### Options
 
-### options.keys
+| Option | Type | Description |
+|---|---|---|
+| `keys` | `string[]` | Only include these keys, in this order |
+| `sort` | `(a, b) => number` | Custom sort function for keys |
+| `sortOrder` | `'asc' \| 'desc'` | Sort direction (case insensitive) |
+| `sortBy` | `(obj) => string[]` | Function returning array of keys to sort by |
+| `prop` | `string` | Property path to sort by (for nested values) |
+| `get` | `(val, prop?) => unknown` | Custom getter for sort values |
+| `deep` | `boolean` | Recursively sort nested objects |
 
-Create a new object with only the given keys.
+The second parameter can also be an **array of keys** (shorthand for `{ keys: [...] }`):
 
-```js
-var o = { a: 1, c: 2, e: 5, d: 4, b: 3 };
-sortObj(o, { keys: ["a", "b"] });
+```ts
+sortObj({ a: 1, c: 2, b: 3 }, ["c", "a", "b"]);
+// => { c: 2, a: 1, b: 3 }
+```
 
-//=> {a: 1, b: 3}
+### options.keys
+
+Create a new object with only the given keys:
+
+```ts
+sortObj({ a: 1, c: 2, e: 5, d: 4, b: 3 }, { keys: ["a", "b"] });
+// => { a: 1, b: 3 }
 ```
 
 ### options.sort
 
-Function to be passed to javascript's `.sort()` method:
+Custom sort function passed to JavaScript's `.sort()`:
 
-```js
-var o = { a: 1, c: 2, e: 5, d: 4, b: 3 };
-var obj = sortObj(o, {
-  sort: function (a, b) {
-    return a < b ? -1 : 1;
-  },
+```ts
+sortObj({ a: 1, c: 2, e: 5, d: 4, b: 3 }, {
+  sort: (a, b) => (a < b ? -1 : 1),
 });
-obj;
-//=> {a: 1, b: 3, c: 2, d: 4, e: 5}
+// => { a: 1, b: 3, c: 2, d: 4, e: 5 }
 ```
 
 ### options.sortOrder
 
-Valid values are `desc` or `asc`, case insensitive:
+Sort ascending or descending:
 
-```js
-var o = { a: 1, c: 2, e: 5, d: 4, b: 3 };
-sortObj(o, { sortOrder: "ASC" });
-//=> {e: 5, d: 4, c: 3, b: 2, a: 1}
+```ts
+sortObj({ a: 1, c: 2, b: 3 }, { sortOrder: "desc" });
+// => { c: 2, b: 3, a: 1 }
 ```
 
 ### options.sortBy
 
 Function that returns an array of keys to sort by:
 
-```js
-var old = { one: "aa", two: "bc", three: "ab" };
-var o = sortObj(old, {
-  sortBy: function (obj) {
-    var arr = [];
-    Object.keys(obj).filter(function (key) {
-      if (/^a/.test(obj[key])) arr.push(key);
-    });
-    return arr.reverse();
-  },
+```ts
+const old = { one: "aa", two: "bc", three: "ab" };
+sortObj(old, {
+  sortBy: (obj) =>
+    Object.keys(obj)
+      .filter((key) => /^a/.test(obj[key] as string))
+      .reverse(),
 });
-//=> {three: 'ab', one: 'aa'}
+// => { three: 'ab', one: 'aa' }
 ```
 
-## Author
+### options.deep
 
-**Brian Woodward**
+Recursively sort nested objects:
 
-- [github/nmccready](https://github.com/nmccready)
-- [twitter/nmccready](http://twitter.com/nmccready)
+```ts
+sortObj(
+  { c: { z: 1, a: 2 }, a: { y: 3, b: 4 } },
+  { deep: true },
+);
+// => { a: { b: 4, y: 3 }, c: { a: 2, z: 1 } }
+```
 
-## License
+## Notes
+
+- **Immutable**: Always returns a new object; the input is never mutated.
+- **Input validation**: Throws `TypeError` for non-object inputs (null, arrays, primitives).
+- **Prototype-safe**: Only own properties are sorted; inherited properties are ignored.
 
-Copyright © 2014-2016 [Brian Woodward](https://github.com/nmccready)
-Released under the MIT license.
+## Original Author
 
----
+**Brian Woodward** — [github/doowb](https://github.com/doowb)
+
+## Maintainer
+
+**Nick McCready** — [github/nmccready](https://github.com/nmccready)
+
+## License
 
-_This file was generated by [verb](https://github.com/verbose/verb) on February 03, 2016._
+MIT © [Brian Woodward](https://github.com/doowb), [Nick McCready](https://github.com/nmccready)

package/lib/index.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * sort-object <https://github.com/helpers/sort-object>
+ *
+ * Copyright (c) 2014-2015, Brian Woodward.
+ * Licensed under the MIT License
+ */
+/**
+ * Sort function type - compares two values for ordering.
+ */
+export type SortFunction = (a: string, b: string) => number;
+/**
+ * Options for the sort function.
+ */
+export interface SortOptions<T extends Record<string, unknown> = Record<string, unknown>> {
+    /** Array of keys to include in the result (in order). */
+    keys?: string[];
+    /** Custom sort function for keys. */
+    sort?: SortFunction;
+    /** Sort order: 'asc' or 'desc' (case insensitive). */
+    sortOrder?: "asc" | "desc" | "ASC" | "DESC" | string;
+    /** Function that returns an array of keys to sort by. */
+    sortBy?: (obj: T) => string[];
+    /** Property path to sort by (for objects with nested values). */
+    prop?: string;
+    /** Custom getter function for extracting sort values. */
+    get?: (val: unknown, prop?: string) => unknown;
+    /** If true, recursively sort nested objects. */
+    deep?: boolean;
+}
+/**
+ * Sort the keys in an object.
+ *
+ * @param obj - The object to sort.
+ * @param options - Sort options, or an array of keys.
+ * @returns A new object with sorted keys.
+ */
+export declare function sort<T extends Record<string, unknown>>(obj: T, options?: SortOptions<T> | string[]): Partial<T>;
+export default sort;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtF,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,qCAAqC;IACrC,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,sDAAsD;IACtD,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IACrD,yDAAyD;IACzD,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,EAAE,CAAC;IAC9B,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/C,gDAAgD;IAChD,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,GAAG,EAAE,CAAC,EACN,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,GAClC,OAAO,CAAC,CAAC,CAAC,CAwEZ;AAwCD,eAAe,IAAI,CAAC"}

package/lib/index.js

@@ -0,0 +1,108 @@
+/*!
+ * sort-object <https://github.com/helpers/sort-object>
+ *
+ * Copyright (c) 2014-2015, Brian Woodward.
+ * Licensed under the MIT License
+ */
+import isObject from "is-extendable";
+import sortDesc from "sort-desc";
+import bytewise from "bytewise";
+import union from "@znemz/union-value";
+import sortAsc from "sort-asc";
+import get from "get-value";
+const sortFns = { desc: sortDesc, asc: sortAsc };
+/**
+ * Sort the keys in an object.
+ *
+ * @param obj - The object to sort.
+ * @param options - Sort options, or an array of keys.
+ * @returns A new object with sorted keys.
+ */
+export function sort(obj, options) {
+    if (obj == null || typeof obj !== "object" || Array.isArray(obj)) {
+        throw new TypeError(`sort-object expects a plain object, got ${obj === null ? "null" : typeof obj}`);
+    }
+    if (Array.isArray(options)) {
+        options = { keys: options };
+    }
+    const opts = options || {};
+    const prop = opts.prop;
+    const getFn = opts.get ||
+        function (val) {
+            if (prop)
+                return get(val, prop);
+        };
+    let fn = opts.sort || sortAsc;
+    if (opts.sortOrder) {
+        fn = sortFns[opts.sortOrder.toLowerCase()] || null;
+    }
+    let keys = opts.keys || [];
+    if (opts.sortBy) {
+        keys = opts.sortBy(obj);
+        fn = null;
+    }
+    if (opts.keys) {
+        if (!opts.sort && !opts.sortOrder && !opts.sortBy) {
+            fn = null;
+        }
+    }
+    const tmp = {};
+    const sortBy = {};
+    const build = keys.length === 0 ? fromObj : fromKeys;
+    build(obj, keys, tmp, sortBy, function (val) {
+        return getFn(val, prop);
+    });
+    if (fn) {
+        keys.sort(fn);
+    }
+    let len = keys.length;
+    let i = 0;
+    let j = 0;
+    const res = {};
+    let prev;
+    while (len--) {
+        const key = keys[i++];
+        if (prev !== key)
+            j = 0;
+        const k = get(sortBy, key)[j++];
+        res[k] = tmp[k];
+        prev = key;
+    }
+    // Deep sort nested objects if requested
+    if (opts.deep) {
+        for (const key of Object.keys(res)) {
+            if (isObject(res[key]) && !Array.isArray(res[key])) {
+                res[key] = sort(res[key], { deep: true });
+            }
+        }
+    }
+    return res;
+}
+/** Build sorting information from the object itself. */
+function fromObj(obj, keys, tmp, sortBy, fn) {
+    for (const key in obj) {
+        if (!Object.prototype.hasOwnProperty.call(obj, key))
+            continue;
+        const val = obj[key];
+        let item = isObject(val) ? fn(val) || key : key;
+        item = isObject(item)
+            ? bytewise.encode(JSON.stringify(item)).toString()
+            : item;
+        union(sortBy, item, [key]);
+        keys.push(item);
+        tmp[key] = val;
+    }
+}
+/** Build sorting information from the supplied keys. */
+function fromKeys(obj, keys, tmp, sortBy) {
+    let len = keys.length;
+    let i = 0;
+    while (len--) {
+        const key = keys[i++];
+        const val = obj[key];
+        union(sortBy, key, [key]);
+        tmp[key] = val;
+    }
+}
+export default sort;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,KAAK,MAAM,oBAAoB,CAAC;AACvC,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,GAAG,MAAM,WAAW,CAAC;AAE5B,MAAM,OAAO,GAAiC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AA2B/E;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAClB,GAAM,EACN,OAAmC;IAEnC,IAAI,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,SAAS,CACjB,2CAA2C,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,GAAG,EAAE,CAChF,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAoB,CAAC;IAChD,CAAC;IAED,MAAM,IAAI,GAAmB,OAAO,IAAI,EAAE,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,KAAK,GACT,IAAI,CAAC,GAAG;QACR,UAAU,GAAY;YACpB,IAAI,IAAI;gBAAE,OAAO,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC,CAAC;IACJ,IAAI,EAAE,GAAwB,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC;IAEnD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,GAAa,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;IAErC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACxB,EAAE,GAAG,IAAI,CAAC;IACZ,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAClD,EAAE,GAAG,IAAI,CAAC;QACZ,CAAC;IACH,CAAC;IAED,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,MAAM,MAAM,GAA6B,EAAE,CAAC;IAE5C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrD,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,GAAY;QAClD,OAAO,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,EAAE,CAAC;QACP,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;IACtB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,IAAI,IAAwB,CAAC;IAC7B,OAAO,GAAG,EAAE,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;QACtB,IAAI,IAAI,KAAK,GAAG;YAAE,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,CAAC,GAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAc,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9C,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,IAAI,GAAG,GAAG,CAAC;IACb,CAAC;IAED,wCAAwC;IACxC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACnD,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAA4B,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAiB,CAAC;AAC3B,CAAC;AAED,wDAAwD;AACxD,SAAS,OAAO,CACd,GAA4B,EAC5B,IAAc,EACd,GAA4B,EAC5B,MAAgC,EAChC,EAA6B;IAE7B,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC;YAAE,SAAS;QAC9D,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,IAAI,GAAY,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACzD,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YAClD,CAAC,CAAC,IAAI,CAAC;QACT,KAAK,CAAC,MAAM,EAAE,IAAc,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,IAAc,CAAC,CAAC;QAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACjB,CAAC;AACH,CAAC;AAED,wDAAwD;AACxD,SAAS,QAAQ,CACf,GAA4B,EAC5B,IAAc,EACd,GAA4B,EAC5B,MAAgC;IAEhC,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;IACtB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,GAAG,EAAE,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;QACtB,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACjB,CAAC;AACH,CAAC;AAED,eAAe,IAAI,CAAC"}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@znemz/sort-object",
   "description": "Sort the keys in an object.",
-  "version": "3.0.7",
-  "homepage": "https://github.com/brickhouse/sort-object",
+  "version": "3.0.9",
+  "type": "module",
+  "homepage": "https://github.com/brickhouse-tech/sort-object",
   "originalAuthor": "Brian Woodward (https://github.com/doowb)",
   "maintainers": [
     "Nick McCready (https://github.com/nmccready)"
@@ -12,37 +13,53 @@
     "url": "git+https://github.com/brickhouse-tech/sort-object.git"
   },
   "bugs": {
-    "url": "https://github.com/brickhouse/sort-object/issues"
+    "url": "https://github.com/brickhouse-tech/sort-object/issues"
   },
   "license": "MIT",
   "files": [
-    "index.js"
+    "lib"
   ],
-  "main": "index.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "default": "./lib/index.js"
+    }
+  },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
-    "test": "nyc --reporter=html --reporter=text mocha",
-    "lint": "eslint *.js",
+    "build": "tsc",
+    "prebuild": "rm -rf lib",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src/**/*.ts",
+    "prepublishOnly": "npm run build",
     "better-audit": "better-npm-audit audit"
   },
   "dependencies": {
+    "@znemz/union-value": "^2.0.2",
     "bytewise": "^1.1.0",
     "get-value": "^2.0.2",
     "is-extendable": "^0.1.1",
     "sort-asc": "^0.2.0",
-    "sort-desc": "^0.2.0",
-    "@znemz/union-value": "^2.0.2"
+    "sort-desc": "^0.2.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^20",
-    "@commitlint/config-conventional": "^20",
-    "better-npm-audit": "^3.3.0",
-    "eslint": "9",
-    "mocha": "11",
-    "nyc": "^15.1.0",
-    "should": "^13.1.3"
+    "@commitlint/cli": "^19",
+    "@commitlint/config-conventional": "^19",
+    "@typescript-eslint/eslint-plugin": "^8.55.0",
+    "@typescript-eslint/parser": "^8.55.0",
+    "better-npm-audit": "^3.11.0",
+    "eslint": "^9",
+    "globals": "^16.0.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.55.0",
+    "vitest": "^3"
   },
   "keywords": [
     "arr",
@@ -58,11 +75,7 @@
     "re-order",
     "sort",
     "util",
-    "utils"
-  ],
-  "verb": {
-    "related": {
-      "list": []
-    }
-  }
+    "utils",
+    "typescript"
+  ]
 }

package/index.js

@@ -1,107 +0,0 @@
-/*!
- * sort-object <https://github.com/helpers/sort-object>
- *
- * Copyright (c) 2014-2015, Brian Woodward.
- * Licensed under the MIT License
- */
-
-"use strict";
-
-var isObject = require("is-extendable");
-var sortDesc = require("sort-desc");
-var bytewise = require("bytewise");
-var union = require("@znemz/union-value");
-var sortAsc = require("sort-asc");
-var get = require("get-value");
-
-var sortFns = { desc: sortDesc, asc: sortAsc };
-
-/**
- * Expose `sort`
- */
-
-module.exports = sort;
-
-function sort(obj, options) {
-  if (Array.isArray(options)) {
-    options = { keys: options };
-  }
-
-  var opts = options || {};
-  var prop = opts.prop;
-  var getFn =
-    opts.get ||
-    function (val) {
-      if (prop) return get(val, prop);
-    };
-  var fn = opts.sort || sortAsc;
-
-  if (Boolean(opts.sortOrder)) {
-    fn = sortFns[opts.sortOrder.toLowerCase()];
-  }
-
-  var keys = opts.keys || [];
-
-  if (Boolean(opts.sortBy)) {
-    keys = opts.sortBy(obj);
-    fn = null;
-  }
-
-  if (Boolean(opts.keys)) {
-    if (!opts.sort && !opts.sortOrder && !opts.sortBy) {
-      fn = null;
-    }
-  }
-
-  var tmp = {};
-  var sortBy = {};
-
-  var build = keys.length === 0 ? fromObj : fromKeys;
-  build(obj, keys, tmp, sortBy, function (val) {
-    return getFn(val, prop);
-  });
-
-  if (fn) {
-    keys.sort(fn);
-  }
-
-  var len = keys.length,
-    i = 0,
-    j = 0;
-  var res = {},
-    prev;
-  while (len--) {
-    var key = keys[i++];
-    if (prev !== key) j = 0;
-    var k = get(sortBy, key)[j++];
-    res[k] = tmp[k];
-    prev = key;
-  }
-  return res;
-}
-
-// build up the sorting information from the `obj`
-function fromObj(obj, keys, tmp, sortBy, fn) {
-  for (var key in obj) {
-    var val = obj[key];
-    var item = isObject(val) ? fn(val) || key : key;
-    item = isObject(item)
-      ? bytewise.encode(JSON.stringify(item)).toString()
-      : item;
-    union(sortBy, item, [key]);
-    keys.push(item);
-    tmp[key] = val;
-  }
-}
-
-// build up the sorting information from the supplied keys
-function fromKeys(obj, keys, tmp, sortBy) {
-  var len = keys.length,
-    i = 0;
-  while (len--) {
-    var key = keys[i++];
-    var val = obj[key];
-    union(sortBy, key, [key]);
-    tmp[key] = val;
-  }
-}