@soleil-se/app-util 5.13.0 → 5.14.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.14.0] - 2026-04-24
+
+- `localizedCompareBy` now accepts objects with a `key` and optional `order` (`'asc'` | `'desc'`, 
+  defaults to `'asc'`) in addition to plain strings, enabling per-property sort direction.
+  Existing string-based usage is unchanged.
+
 ## [5.13.0] - 2026-01-16
 
 - Add comparator functions `localizedCompare` and `localizedCompareBy` to sort strings and objects 

package/common/localized-compare/index.d.ts

@@ -11,10 +11,19 @@ export function localizedCompare(a: string, b: string): number;
  * Creates a comparator function for sorting objects by a specific property or properties.
  * The property values are compared using localized string comparison.
  * When given an array of properties, sorts by the first property, then by the second if equal, etc.
- * @param {string|string[]} prop - The property name(s) to compare by.
+ * Each property can be a string or an object with a `key` and optional `order` ('asc' | 'desc', defaults to 'asc').
+ * @param {string|{key: string, order?: 'asc'|'desc'}|Array<string|{key: string, order?: 'asc'|'desc'}>} prop - The property name(s) to compare by.
  * @returns {(a: Object, b: Object) => number} A comparator function that accepts two objects and returns their sort order.
  * @example
  * arr.sort(localizedCompareBy('title'))
  * arr.sort(localizedCompareBy(['lastName', 'firstName']))
+ * arr.sort(localizedCompareBy({ key: 'firstName', order: 'desc' }))
+ * arr.sort(localizedCompareBy([{ key: 'lastName', order: 'asc' }, { key: 'firstName', order: 'desc' }]))
  */
-export function localizedCompareBy(prop: string | string[]): (a: any, b: any) => number;
+export function localizedCompareBy(prop: string | {
+    key: string;
+    order?: 'asc' | 'desc';
+} | Array<string | {
+    key: string;
+    order?: 'asc' | 'desc';
+}>): (a: any, b: any) => number;

package/common/localized-compare/index.js

@@ -82,20 +82,28 @@ export function localizedCompare(a, b) {
  * Creates a comparator function for sorting objects by a specific property or properties.
  * The property values are compared using localized string comparison.
  * When given an array of properties, sorts by the first property, then by the second if equal, etc.
- * @param {string|string[]} prop - The property name(s) to compare by.
+ * Each property can be a string or an object with a `key` and optional `order` ('asc' | 'desc', defaults to 'asc').
+ * @param {string|{key: string, order?: 'asc'|'desc'}|Array<string|{key: string, order?: 'asc'|'desc'}>} prop - The property name(s) to compare by.
  * @returns {(a: Object, b: Object) => number} A comparator function that accepts two objects and returns their sort order.
  * @example
  * arr.sort(localizedCompareBy('title'))
  * arr.sort(localizedCompareBy(['lastName', 'firstName']))
+ * arr.sort(localizedCompareBy({ key: 'firstName', order: 'desc' }))
+ * arr.sort(localizedCompareBy([{ key: 'lastName', order: 'asc' }, { key: 'firstName', order: 'desc' }]))
  */
 export function localizedCompareBy(prop) {
-  const props = Array.isArray(prop) ? prop : [prop];
+  const props = (Array.isArray(prop) ? prop : [prop])
+    .map((p) => (typeof p === 'string'
+      ? { key: p, order: 'asc' }
+      : { key: p.key, order: p.order ?? 'asc' }
+    ));
 
   return (a, b) => {
     for (let i = 0; i < props.length; i += 1) {
-      const result = localizedCompare(a[props[i]], b[props[i]]);
+      const { key, order } = props[i];
+      const result = localizedCompare(a[key], b[key]);
       if (result !== 0) {
-        return result;
+        return order === 'desc' ? -result : result;
       }
     }
     return 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "5.13.0",
+  "version": "5.14.0",
   "description": "Utility functions for WebApps, RESTApps and Widgets in Sitevision.",
   "main": "./common/index.js",
   "author": "Soleil AB",
@@ -23,7 +23,7 @@
     "@sitevision/api": "*"
   },
   "scripts": {
-    "create-type-definitions": "node ../../utils/createTypeDefinitions.js ./common/index.js ./client/index.js ./client/svelte/index.js ./client/svelte/3/index.js ./client/svelte/4/index.js ./client/svelte/5/index.js ./server/index.js ./server/svelte/index.js ./server/svelte/3/index.js ./server/svelte/4/index.js ./server/svelte/5/index.js ./server/app-data/index.js ./server/global-app-data/index.js"
+    "create-type-definitions": "node ../../utils/createTypeDefinitions.js ./common/index.js ./common/localized-compare/index.js ./client/index.js ./client/svelte/index.js ./client/svelte/3/index.js ./client/svelte/4/index.js ./client/svelte/5/index.js ./server/index.js ./server/svelte/index.js ./server/svelte/3/index.js ./server/svelte/4/index.js ./server/svelte/5/index.js ./server/app-data/index.js ./server/global-app-data/index.js"
   },
-  "gitHead": "3c3ef92d604eeed89887a94964edf2146e2a746a"
+  "gitHead": "1685a5874b85ff0d0b005c815b7207cde49b3e72"
 }