Create option for isEqualPath

Author: minimal-ui-kit

packages/minimal-shared/CHANGELOG.md

@@ -1,5 +1,13 @@
 # minimal-shared
 
+## 1.0.11
+
+_May 14, 2025_
+
+- Update `src/utils/url`.
+
+---
+
 ## 1.0.10
 
 _May 12, 2025_

packages/minimal-shared/package.json

@@ -1,7 +1,7 @@
 {
   "name": "minimal-shared",
   "author": "Minimals",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "Shared hooks and utils used by Minimal UI and Zone UI.",
   "keywords": [
     "typescript",

packages/minimal-shared/src/utils/url/url.test.ts

@@ -39,10 +39,23 @@ describe('isEqualPath()', () => {
     ['Match with trailing slash', '/dashboard/', '/dashboard', true],
     ['Both paths have trailing slashes', '/dashboard/', '/dashboard/', true],
     ['Different paths', '/dashboard', '/settings', false],
-  ];
+    ['Path with and without trailing slash', '/dashboard/params', '/dashboard/params/', true],
+    [
+      'Same path with query params and trailing slash',
+      '/dashboard/params?id=123&filter=active',
+      '/dashboard/params/?id=123&filter=active',
+      true,
+    ],
+    ['Invalid URLs fallback to false', 'not-a-url', '/valid', false],
+  ] as const;
 
-  test.each(mapWithIndex(cases))('%i. %s', (_i, _desc, a, b, expected) => {
-    expect(isEqualPath(a, b)).toBe(expected);
+  describe.each([true, false])('deep = %s', (deep) => {
+    test.each(cases)('%s | a: "%s", b: "%s" => %s', (description, a, b, expected) => {
+      const result = isEqualPath(a, b, { deep });
+      const mode = deep ? 'including params' : 'ignoring params';
+      console.log(`[${mode}] ${description}: Comparing "${a}" and "${b}" => ${result}`);
+      expect(result).toBe(expected);
+    });
   });
 });
 

packages/minimal-shared/src/utils/url/url.ts

@@ -1,3 +1,7 @@
+import { isEqual } from 'es-toolkit';
+
+// ----------------------------------------------------------------------
+
 /**
  * Checks if a URL has query parameters.
  *
@@ -41,15 +45,36 @@ export function removeLastSlash(pathname: string): string {
  * Checks if two paths are equal after removing trailing slashes.
  *
  * @param targetUrl - The target URL to compare.
- * @param pathname - The pathname to compare.
+ * @param currentUrl - The pathname to compare.
+ * @param options.deep - Options for deep comparison.
  * @returns True if the paths are equal, false otherwise.
  *
  * @example
  * isEqualPath('/dashboard/', '/dashboard'); // true
  * isEqualPath('/home', '/dashboard'); // false
  */
-export function isEqualPath(targetUrl: string, pathname: string): boolean {
-  return removeLastSlash(targetUrl) === removeLastSlash(pathname);
+export type EqualPathOptions = {
+  deep?: boolean;
+};
+
+export function isEqualPath(
+  targetUrl: string,
+  currentUrl: string,
+  options: EqualPathOptions = {
+    deep: true,
+  }
+): boolean {
+  const parseUrl = (url: string) => {
+    try {
+      const { pathname, searchParams } = new URL(url.trim(), 'http://dummy');
+      return options.deep
+        ? { pathname: removeLastSlash(pathname), params: Object.fromEntries(searchParams) }
+        : { pathname: removeLastSlash(pathname) };
+    } catch {
+      return { pathname: '' };
+    }
+  };
+  return isEqual(parseUrl(currentUrl), parseUrl(targetUrl));
 }
 
 // ----------------------------------------------------------------------