@soleil-se/app-util 5.12.3 → 5.14.0

package/CHANGELOG.md

@@ -7,6 +7,18 @@ 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 
+by a specific property using localized string comparison since String.localeCompare does not
+work properly with nordic characters in Rhino.
+
 ## [5.12.3] - 2025-12-03
 
 - Even better type definitions for Svelte render functions.

package/common/index.d.ts

@@ -79,3 +79,6 @@ export const isOffline: boolean;
  * @constant {boolean}
  */
 export const isOnline: boolean;
+import { localizedCompare } from "./localized-compare";
+import { localizedCompareBy } from "./localized-compare";
+export { localizedCompare, localizedCompareBy };

package/common/index.js

@@ -3,6 +3,7 @@ import app from '@sitevision/api/common/app';
 
 import { nativeRequire } from '../server';
 import getLegacyRouteUri from './legacy/getRouteUri';
+import { localizedCompare, localizedCompareBy } from './localized-compare';
 
 /**
  * Regex for selecting leading slashes
@@ -150,7 +151,7 @@ export function getRouteUri(route = '', params = undefined) {
  */
 export function getViewUri(route = '', params = undefined) {
   if (!router?.getUrl) {
-    console.warn('[@soleil-api/webapp-util] getViewUri requires router.getUrl support.');
+    console.warn('[@soleil-se/app-util] getViewUri requires router.getUrl support.');
     return undefined;
   }
 
@@ -183,3 +184,5 @@ export function setAppProps(data) {
 export function getAppProps(key) {
   return key ? appProps[key] : appProps;
 }
+
+export { localizedCompare, localizedCompareBy };

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

@@ -0,0 +1,29 @@
+/**
+ * Compares two strings in a localized manner, taking into account special characters.
+ * The order is defined as: a-z å ä æ ö ø (case-insensitive, with lowercase before uppercase).
+ * Characters not in this set are compared based on their Unicode code points after removing accents.
+ * @param {string} a - The first string to compare.
+ * @param {string} b - The second string to compare.
+ * @returns {number} Negative if a < b, positive if a > b, zero if equal.
+ */
+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.
+ * 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 | {
+    key: string;
+    order?: 'asc' | 'desc';
+} | Array<string | {
+    key: string;
+    order?: 'asc' | 'desc';
+}>): (a: any, b: any) => number;

package/common/localized-compare/index.js

@@ -0,0 +1,111 @@
+const charOrder = 'abcdefghijklmnopqrstuvwxyzåäæöø';
+
+function normalizeChar(char) {
+  // Remove accents from unknown characters (é → e, ñ → n)
+  return char.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
+}
+
+function getCharInfo(char) {
+  const lowerChar = char.toLowerCase();
+  let index = charOrder.indexOf(lowerChar);
+  let isAccented = false;
+
+  // If not found, try normalized version
+  if (index === -1) {
+    const normalized = normalizeChar(lowerChar);
+    index = charOrder.indexOf(normalized);
+
+    if (index !== -1) {
+      isAccented = true;
+    } else {
+      // Completely unknown character
+      index = charOrder.length + char.charCodeAt(0);
+    }
+  }
+
+  return {
+    baseIndex: index,
+    isAccented,
+    isLower: char === char.toLowerCase() && char !== char.toUpperCase(),
+    accentCode: isAccented ? char.normalize('NFD').charCodeAt(1) || 0 : 0,
+  };
+}
+
+/**
+ * Compares two strings in a localized manner, taking into account special characters.
+ * The order is defined as: a-z å ä æ ö ø (case-insensitive, with lowercase before uppercase).
+ * Characters not in this set are compared based on their Unicode code points after removing accents.
+ * @param {string} a - The first string to compare.
+ * @param {string} b - The second string to compare.
+ * @returns {number} Negative if a < b, positive if a > b, zero if equal.
+ */
+export function localizedCompare(a, b) {
+  // Handle null/undefined
+  if (a == null) return b == null ? 0 : -1;
+  if (b == null) return 1;
+
+  // Ensure strings
+  const strA = String(a);
+  const strB = String(b);
+
+  const minLength = Math.min(strA.length, strB.length);
+
+  for (let i = 0; i < minLength; i += 1) {
+    const infoA = getCharInfo(strA[i]);
+    const infoB = getCharInfo(strB[i]);
+
+    // 1. Compare base character (case and accent insensitive)
+    if (infoA.baseIndex !== infoB.baseIndex) {
+      return infoA.baseIndex - infoB.baseIndex;
+    }
+
+    // 2. Non-accented before accented (e.g., 'e' < 'é')
+    if (infoA.isAccented !== infoB.isAccented) {
+      return infoA.isAccented ? 1 : -1;
+    }
+
+    // 3. If both accented, compare accent types (é vs è)
+    if (infoA.isAccented && infoA.accentCode !== infoB.accentCode) {
+      return infoA.accentCode - infoB.accentCode;
+    }
+
+    // 4. Lowercase before uppercase (e.g., 'e' < 'E')
+    if (infoA.isLower !== infoB.isLower) {
+      return infoA.isLower ? -1 : 1;
+    }
+  }
+
+  return strA.length - strB.length;
+}
+
+/**
+ * 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.
+ * 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])
+    .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 { key, order } = props[i];
+      const result = localizedCompare(a[key], b[key]);
+      if (result !== 0) {
+        return order === 'desc' ? -result : result;
+      }
+    }
+    return 0;
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "5.12.3",
+  "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": "9b1f44728b2ba84db68acdad31699822067ced13"
+  "gitHead": "1685a5874b85ff0d0b005c815b7207cde49b3e72"
 }

package/common/server/index.d.ts

@@ -1,6 +0,0 @@
-/**
- * Require a module natively.
- * @param {string} module
- * @returns any
- */
-export function nativeRequire(module: string): any;