@med_ghoul/forge-shared 1.2.0

package/dist/utils/url/url.d.cts

@@ -0,0 +1,74 @@
+/**
+ * Checks if a URL has query parameters.
+ *
+ * @param url - The URL to check.
+ * @returns True if the URL has query parameters, false otherwise.
+ *
+ * @example
+ * hasParams('https://example.com?page=1'); // true
+ * hasParams('https://example.com'); // false
+ */
+declare function hasParams(url: string): boolean;
+/**
+ * Removes the trailing slash from a pathname if present.
+ *
+ * @param pathname - The pathname to process.
+ * @returns The pathname without the trailing slash.
+ *
+ * @example
+ * removeLastSlash('/dashboard/'); // '/dashboard'
+ * removeLastSlash('/dashboard'); // '/dashboard'
+ */
+declare function removeLastSlash(pathname: string): string;
+/**
+ * Checks if two paths are equal after removing trailing slashes.
+ *
+ * @param targetUrl - The target URL 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
+ */
+type EqualPathOptions = {
+    deep?: boolean;
+};
+declare function isEqualPath(targetUrl: string, currentUrl: string, options?: EqualPathOptions): boolean;
+/**
+ * Removes query parameters from a URL and returns only the cleaned pathname.
+ *
+ * @param url - The URL to process.
+ * @returns The pathname without query parameters.
+ *
+ * @example
+ * removeParams('https://example.com/dashboard/user?id=123'); // '/dashboard/user'
+ * removeParams('/dashboard/user?id=123'); // '/dashboard/user'
+ */
+declare function removeParams(url: string): string;
+/**
+ * Determines whether a given URL is external (i.e., starts with "http").
+ *
+ * @param url - The URL to check.
+ * @returns True if the URL is external, false otherwise.
+ *
+ * @example
+ * isExternalLink('https://example.com'); // true
+ * isExternalLink('/internal'); // false
+ */
+declare function isExternalLink(url: string): boolean;
+/**
+ * Safely returns a URL or a fallback if the URL is invalid or not same-origin.
+ *
+ * @param value - The URL to validate.
+ * @param fallback - The fallback URL to return if the value is invalid.
+ * @returns A safe URL or the fallback.
+ *
+ * @example
+ * safeReturnUrl('/dashboard', '/home'); // '/dashboard'
+ * safeReturnUrl('https://example.com', '/home'); // '/'
+ */
+declare function safeReturnUrl(value: string | null, fallback?: string | null): string;
+
+export { type EqualPathOptions, hasParams, isEqualPath, isExternalLink, removeLastSlash, removeParams, safeReturnUrl };

package/dist/utils/url/url.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Checks if a URL has query parameters.
+ *
+ * @param url - The URL to check.
+ * @returns True if the URL has query parameters, false otherwise.
+ *
+ * @example
+ * hasParams('https://example.com?page=1'); // true
+ * hasParams('https://example.com'); // false
+ */
+declare function hasParams(url: string): boolean;
+/**
+ * Removes the trailing slash from a pathname if present.
+ *
+ * @param pathname - The pathname to process.
+ * @returns The pathname without the trailing slash.
+ *
+ * @example
+ * removeLastSlash('/dashboard/'); // '/dashboard'
+ * removeLastSlash('/dashboard'); // '/dashboard'
+ */
+declare function removeLastSlash(pathname: string): string;
+/**
+ * Checks if two paths are equal after removing trailing slashes.
+ *
+ * @param targetUrl - The target URL 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
+ */
+type EqualPathOptions = {
+    deep?: boolean;
+};
+declare function isEqualPath(targetUrl: string, currentUrl: string, options?: EqualPathOptions): boolean;
+/**
+ * Removes query parameters from a URL and returns only the cleaned pathname.
+ *
+ * @param url - The URL to process.
+ * @returns The pathname without query parameters.
+ *
+ * @example
+ * removeParams('https://example.com/dashboard/user?id=123'); // '/dashboard/user'
+ * removeParams('/dashboard/user?id=123'); // '/dashboard/user'
+ */
+declare function removeParams(url: string): string;
+/**
+ * Determines whether a given URL is external (i.e., starts with "http").
+ *
+ * @param url - The URL to check.
+ * @returns True if the URL is external, false otherwise.
+ *
+ * @example
+ * isExternalLink('https://example.com'); // true
+ * isExternalLink('/internal'); // false
+ */
+declare function isExternalLink(url: string): boolean;
+/**
+ * Safely returns a URL or a fallback if the URL is invalid or not same-origin.
+ *
+ * @param value - The URL to validate.
+ * @param fallback - The fallback URL to return if the value is invalid.
+ * @returns A safe URL or the fallback.
+ *
+ * @example
+ * safeReturnUrl('/dashboard', '/home'); // '/dashboard'
+ * safeReturnUrl('https://example.com', '/home'); // '/'
+ */
+declare function safeReturnUrl(value: string | null, fallback?: string | null): string;
+
+export { type EqualPathOptions, hasParams, isEqualPath, isExternalLink, removeLastSlash, removeParams, safeReturnUrl };

package/dist/utils/url/url.js

@@ -0,0 +1 @@
+import{isEqual as h}from"es-toolkit";function u(t){try{let r=new URL(t,window.location.origin);return Array.from(r.searchParams.keys()).length>0}catch{return!1}}function o(t){return t!=="/"&&t.endsWith("/")?t.slice(0,-1):t}function p(t,r,i={deep:!0}){let n=s=>{try{let{pathname:a,searchParams:e}=new URL(s.trim(),"http://dummy");return i.deep?{pathname:o(a),params:Object.fromEntries(e)}:{pathname:o(a)}}catch{return{pathname:""}}};return h(n(r),n(t))}function m(t){try{let r=new URL(t,window.location.origin);return o(r.pathname)}catch{return t}}function g(t){return/^https?:\/\//i.test(t)}function f(t,r){let i=r??"/";if(!t||typeof window>"u"||!window.location?.origin)return i;try{let n=new URL(t,window.location.origin),s=n.origin===window.location.origin,a=n.pathname.startsWith("/")&&!n.pathname.startsWith("//"),e=/^\/:+$/.test(n.pathname),c=n.pathname==="/"&&!n.search&&n.hash;return s&&a&&!e&&!c?`${n.pathname}${n.search}${n.hash}`:i}catch{return t.startsWith("/")&&!t.startsWith("//")?t:i}}export{u as hasParams,p as isEqualPath,g as isExternalLink,o as removeLastSlash,m as removeParams,f as safeReturnUrl};

package/dist/utils/uuidv4/index.cjs

@@ -0,0 +1 @@
+"use strict";var o=Object.defineProperty;var u=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var i=Object.prototype.hasOwnProperty;var a=(r,x)=>{for(var t in x)o(r,t,{get:x[t],enumerable:!0})},g=(r,x,t,e)=>{if(x&&typeof x=="object"||typeof x=="function")for(let n of c(x))!i.call(r,n)&&n!==t&&o(r,n,{get:()=>x[n],enumerable:!(e=u(x,n))||e.enumerable});return r};var p=r=>g(o({},"__esModule",{value:!0}),r);var v={};a(v,{uuidv4:()=>s});module.exports=p(v);function s(){return"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,r=>{let x=Math.random()*16|0;return(r==="x"?x:x&3|8).toString(16)})}0&&(module.exports={uuidv4});

package/dist/utils/uuidv4/index.d.cts

@@ -0,0 +1 @@
+export { uuidv4 } from './uuidv4.cjs';

package/dist/utils/uuidv4/index.d.ts

@@ -0,0 +1 @@
+export { uuidv4 } from './uuidv4.js';

package/dist/utils/uuidv4/index.js

@@ -0,0 +1 @@
+function n(){return"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,r=>{let x=Math.random()*16|0;return(r==="x"?x:x&3|8).toString(16)})}export{n as uuidv4};

package/dist/utils/uuidv4/uuidv4.cjs

@@ -0,0 +1 @@
+"use strict";var o=Object.defineProperty;var u=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var i=Object.prototype.hasOwnProperty;var a=(r,x)=>{for(var t in x)o(r,t,{get:x[t],enumerable:!0})},g=(r,x,t,e)=>{if(x&&typeof x=="object"||typeof x=="function")for(let n of c(x))!i.call(r,n)&&n!==t&&o(r,n,{get:()=>x[n],enumerable:!(e=u(x,n))||e.enumerable});return r};var s=r=>g(o({},"__esModule",{value:!0}),r);var d={};a(d,{uuidv4:()=>v});module.exports=s(d);function v(){return"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,r=>{let x=Math.random()*16|0;return(r==="x"?x:x&3|8).toString(16)})}0&&(module.exports={uuidv4});

package/dist/utils/uuidv4/uuidv4.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Generates a UUID (version 4).
+ *
+ * @returns {string} - A randomly generated UUID.
+ *
+ * @example
+ * const id = uuidv4();
+ * console.log(id); // '3b12f1df-1c3a-4f3b-8f3d-3f3b1c3a4f3b'
+ */
+declare function uuidv4(): string;
+
+export { uuidv4 };

package/dist/utils/uuidv4/uuidv4.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generates a UUID (version 4).
+ *
+ * @returns {string} - A randomly generated UUID.
+ *
+ * @example
+ * const id = uuidv4();
+ * console.log(id); // '3b12f1df-1c3a-4f3b-8f3d-3f3b1c3a4f3b'
+ */
+declare function uuidv4(): string;
+
+export { uuidv4 };

package/dist/utils/uuidv4/uuidv4.js

@@ -0,0 +1 @@
+function n(){return"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,r=>{let x=Math.random()*16|0;return(r==="x"?x:x&3|8).toString(16)})}export{n as uuidv4};

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@med_ghoul/forge-shared",
+  "author": "MedOx",
+  "version": "1.2.0",
+  "description": "A collection of reusable React hooks and utility functions for modern web development",
+  "keywords": [
+    "typescript",
+    "react",
+    "hooks",
+    "utils",
+    "react-hooks",
+    "utilities",
+    "tree-shakeable"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/medghoul/forge-shared.git"
+  },
+  "homepage": "https://github.com/medghoul/forge-shared#readme",
+  "bugs": {
+    "url": "https://github.com/medghoul/forge-shared/issues"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "packageManager": "bun@1.1.38",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/*/index"
+      ]
+    }
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks/index.d.ts",
+      "default": "./dist/hooks/index.js"
+    },
+    "./hooks/*": {
+      "types": "./dist/hooks/*/index.d.ts",
+      "default": "./dist/hooks/*/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "default": "./dist/utils/index.js"
+    },
+    "./utils/*": {
+      "types": "./dist/utils/*/index.d.ts",
+      "default": "./dist/utils/*/index.js"
+    }
+  },
+  "scripts": {
+    "prepublishOnly": "bun run build",
+    "dev": "NODE_OPTIONS='--max-old-space-size=16384' tsup --watch",
+    "build": "bun run test && NODE_OPTIONS='--max-old-space-size=16384' tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint \"**/*.{js,jsx,ts,tsx}\"",
+    "lint:fix": "eslint --fix \"**/*.{js,jsx,ts,tsx}\"",
+    "lint:print": "bunx eslint --print-config eslint.config.mjs > eslint-show-config.json",
+    "clean": "rm -rf node_modules .next out dist build bun.lockb",
+    "re:dev": "bun run clean && bun install && bun dev",
+    "re:build": "bun run clean && bun install && bun test && bun build",
+    "fm:check": "prettier --check \"**/*.{js,jsx,ts,tsx}\"",
+    "fm:fix": "prettier --write \"**/*.{js,jsx,ts,tsx}\"",
+    "check:update": "bun update --interactive --latest",
+    "tsc:print": "bunx tsc --showConfig",
+    "check-types": "bunx tsc --noEmit"
+  },
+  "dependencies": {
+    "es-toolkit": "^1.43.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/bun": "^1.3.5",
+    "@types/node": "^25.0.1",
+    "@types/react": "19.2.7",
+    "eslint": "^9.39.2",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-perfectionist": "^4.15.1",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "7.0.1",
+    "eslint-plugin-unused-imports": "^4.3.0",
+    "globals": "^16.5.0",
+    "jsdom": "^27.3.0",
+    "prettier": "^3.7.4",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.49.0",
+    "vitest": "^4.0.15"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "typescript": "^5.0.0"
+  }
+}