@equinor/cpl-utils 0.2.2 → 0.3.0

package/dist/index.d.mts

@@ -1,3 +1,35 @@
+/**
+ * Creates a sort function that orders items by a numeric property
+ *
+ * @param key - The property key to sort by (must be a number type)
+ * @param order - Sort order: 'asc' for ascending, 'desc' for descending
+ * @returns A comparator function for use with Array.sort()
+ *
+ * @example
+ * const users = [{ age: 30 }, { age: 25 }, { age: 35 }]
+ * users.sort(buildObjectNumberCompareFn('age', 'asc')) // 25, 30, 35
+ * users.sort(buildObjectNumberCompareFn('age', 'desc')) // 35, 30, 25
+ */
+declare function buildObjectNumberCompareFn<T>(key: {
+    [K in keyof T]: T[K] extends number | undefined | null ? K : never;
+}[keyof T], order?: 'asc' | 'desc'): (a: T, b: T) => number;
+
+/**
+ * Creates a sort function that orders items by a string property
+ *
+ * @param key - The property key to sort by (must be a string type)
+ * @param order - Sort order: 'asc' for ascending, 'desc' for descending
+ * @returns A comparator function for use with Array.sort()
+ *
+ * @example
+ * const users = [{ name: 'John' }, { name: 'Alice' }]
+ * users.sort(buildObjectStringCompareFn('name', 'asc')) // Alice, John
+ * users.sort(buildObjectStringCompareFn('name', 'desc')) // John, Alice
+ */
+declare function buildObjectStringCompareFn<T>(key: {
+    [K in keyof T]: T[K] extends string | undefined | null ? K : never;
+}[keyof T], order?: 'asc' | 'desc'): (a: T, b: T) => number;
+
 type TreeNode<T> = T & {
     children?: TreeNode<T>[];
 };
@@ -205,4 +237,4 @@ declare function objectHasOwnNestedProperty<K extends readonly string[]>(object:
  */
 declare function objectHasOwnProperty<Key extends PropertyKey>(object: object, key: Key): object is Record<Key, unknown>;
 
-export { type TreeNode, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnNestedProperty, objectHasOwnProperty };
+export { type TreeNode, buildObjectNumberCompareFn, buildObjectStringCompareFn, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnNestedProperty, objectHasOwnProperty };

package/dist/index.d.ts

@@ -1,3 +1,35 @@
+/**
+ * Creates a sort function that orders items by a numeric property
+ *
+ * @param key - The property key to sort by (must be a number type)
+ * @param order - Sort order: 'asc' for ascending, 'desc' for descending
+ * @returns A comparator function for use with Array.sort()
+ *
+ * @example
+ * const users = [{ age: 30 }, { age: 25 }, { age: 35 }]
+ * users.sort(buildObjectNumberCompareFn('age', 'asc')) // 25, 30, 35
+ * users.sort(buildObjectNumberCompareFn('age', 'desc')) // 35, 30, 25
+ */
+declare function buildObjectNumberCompareFn<T>(key: {
+    [K in keyof T]: T[K] extends number | undefined | null ? K : never;
+}[keyof T], order?: 'asc' | 'desc'): (a: T, b: T) => number;
+
+/**
+ * Creates a sort function that orders items by a string property
+ *
+ * @param key - The property key to sort by (must be a string type)
+ * @param order - Sort order: 'asc' for ascending, 'desc' for descending
+ * @returns A comparator function for use with Array.sort()
+ *
+ * @example
+ * const users = [{ name: 'John' }, { name: 'Alice' }]
+ * users.sort(buildObjectStringCompareFn('name', 'asc')) // Alice, John
+ * users.sort(buildObjectStringCompareFn('name', 'desc')) // John, Alice
+ */
+declare function buildObjectStringCompareFn<T>(key: {
+    [K in keyof T]: T[K] extends string | undefined | null ? K : never;
+}[keyof T], order?: 'asc' | 'desc'): (a: T, b: T) => number;
+
 type TreeNode<T> = T & {
     children?: TreeNode<T>[];
 };
@@ -205,4 +237,4 @@ declare function objectHasOwnNestedProperty<K extends readonly string[]>(object:
  */
 declare function objectHasOwnProperty<Key extends PropertyKey>(object: object, key: Key): object is Record<Key, unknown>;
 
-export { type TreeNode, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnNestedProperty, objectHasOwnProperty };
+export { type TreeNode, buildObjectNumberCompareFn, buildObjectStringCompareFn, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnNestedProperty, objectHasOwnProperty };

package/dist/index.js

@@ -34,6 +34,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  buildObjectNumberCompareFn: () => buildObjectNumberCompareFn,
+  buildObjectStringCompareFn: () => buildObjectStringCompareFn,
   buildTreeNodes: () => buildTreeNodes,
   hasCircularDependency: () => hasCircularDependency,
   itemIsDefined: () => itemIsDefined,
@@ -42,6 +44,38 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/build-object-number-compare-fn.ts
+function buildObjectNumberCompareFn(key, order = "asc") {
+  return (a, b) => {
+    const aValue = Number(a[key] || 0);
+    const bValue = Number(b[key] || 0);
+    const aNum = isNaN(aValue) ? 0 : aValue;
+    const bNum = isNaN(bValue) ? 0 : bValue;
+    if (aNum < bNum) {
+      return order === "asc" ? -1 : 1;
+    }
+    if (aNum > bNum) {
+      return order === "asc" ? 1 : -1;
+    }
+    return 0;
+  };
+}
+
+// src/build-object-string-compare-fn.ts
+function buildObjectStringCompareFn(key, order = "asc") {
+  return (a, b) => {
+    const aValue = String(a[key] || "").toLowerCase();
+    const bValue = String(b[key] || "").toLowerCase();
+    if (aValue < bValue) {
+      return order === "asc" ? -1 : 1;
+    }
+    if (aValue > bValue) {
+      return order === "asc" ? 1 : -1;
+    }
+    return 0;
+  };
+}
+
 // src/has-circular-dependency.ts
 function hasCircularDependency(items, idKey, parentIdKey) {
   const parentMap = /* @__PURE__ */ new Map();
@@ -140,6 +174,8 @@ function objectHasOwnNestedProperty(object, ...keys) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  buildObjectNumberCompareFn,
+  buildObjectStringCompareFn,
   buildTreeNodes,
   hasCircularDependency,
   itemIsDefined,

package/dist/index.mjs

@@ -15,6 +15,38 @@ var __spreadValues = (a, b) => {
   return a;
 };
 
+// src/build-object-number-compare-fn.ts
+function buildObjectNumberCompareFn(key, order = "asc") {
+  return (a, b) => {
+    const aValue = Number(a[key] || 0);
+    const bValue = Number(b[key] || 0);
+    const aNum = isNaN(aValue) ? 0 : aValue;
+    const bNum = isNaN(bValue) ? 0 : bValue;
+    if (aNum < bNum) {
+      return order === "asc" ? -1 : 1;
+    }
+    if (aNum > bNum) {
+      return order === "asc" ? 1 : -1;
+    }
+    return 0;
+  };
+}
+
+// src/build-object-string-compare-fn.ts
+function buildObjectStringCompareFn(key, order = "asc") {
+  return (a, b) => {
+    const aValue = String(a[key] || "").toLowerCase();
+    const bValue = String(b[key] || "").toLowerCase();
+    if (aValue < bValue) {
+      return order === "asc" ? -1 : 1;
+    }
+    if (aValue > bValue) {
+      return order === "asc" ? 1 : -1;
+    }
+    return 0;
+  };
+}
+
 // src/has-circular-dependency.ts
 function hasCircularDependency(items, idKey, parentIdKey) {
   const parentMap = /* @__PURE__ */ new Map();
@@ -112,6 +144,8 @@ function objectHasOwnNestedProperty(object, ...keys) {
   return true;
 }
 export {
+  buildObjectNumberCompareFn,
+  buildObjectStringCompareFn,
   buildTreeNodes,
   hasCircularDependency,
   itemIsDefined,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/cpl-utils",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",