@rzl-zone/utils-js 3.0.2-beta.2 → 3.1.0

package/dist/next/index.d.ts

@@ -1,184 +1,204 @@
 import{I as IsAny}from'../any-BmdI8UbK.js';import'../if-CvT4R7Kh.js';
-/** Extracts dynamic route parameters from a given route string.
-*
-* This utility type recursively searches for dynamic segments within a route,
-* extracting each parameter and constructing an object where each key represents
-* a dynamic segment and its value is of type `string`.
-*
-* * ⚠️ ***Notes: This Type only support when using `NextJS`***
-*
-* @template T - The route string containing potential dynamic segments.
-*
-* @example
-* ```ts
-* type Params1 = ExtractRouteParams<"/user/[id]">;
-* // Result: { id: string }
-*
-* type Params2 = ExtractRouteParams<"/post/[slug]/comment/[commentId]">;
-* // Result: { slug: string; commentId: string }
-*
-* type Params3 = ExtractRouteParams<"/dashboard">;
-* // Result: {} (no dynamic parameters)
-* ```
-*/
+/** ---------------------------------------------------------
+ * * ***Extracts dynamic route parameters from a given route string.***
+ * ---------------------------------------------------------
+ * **This utility type recursively searches for dynamic segments within a route,
+ * extracting each parameter and constructing an object where each key represents
+ * a dynamic segment and its value is of type `string`.**
+ * - ***⚠️ Warning:***
+ *    - ***This types only support when using ***[`NextJS`](https://nextjs.org/)***.***
+ * @template T - The route string containing potential dynamic segments.
+ * @example
+ * ```ts
+ * type Params1 = ExtractRouteParams<"/user/[id]">;
+ * // ➔ { id: string }
+ * type Params2 = ExtractRouteParams<"/post/[slug]/comment/[commentId]">;
+ * // ➔ { slug: string; commentId: string }
+ * type Params3 = ExtractRouteParams<"/dashboard">;
+ * // ➔ {} (no dynamic parameters)
+ * ```
+ */
 type ExtractRouteParams<T>=T extends string?HasDynamicSegments<T>extends true?T extends`${infer _Start}[${infer Param}]${infer Rest}`?{[K in Param|keyof ExtractRouteParams<Rest>]:string;}:unknown:unknown:unknown;
-/** Determines whether a given route contains dynamic segments.
-*
-* This type checks if the route includes at least one `[param]` pattern.
-* If it does, the result is `true`, otherwise `false`.
-*
-* * ⚠️ ***Notes: This Type only support when using `NextJS`***
-*
-* @template T - The route string to be evaluated.
-*
-* @example
-* ```ts
-* type HasParams1 = HasDynamicSegments<"/user/[id]">;
-* // Result: true
-*
-* type HasParams2 = HasDynamicSegments<"/settings/profile">;
-* // Result: false
-*
-* type HasParams3 = HasDynamicSegments<"/blog/[category]/[slug]">;
-* // Result: true
-* ```
-*/
+/** ---------------------------------------------------------
+ * * ***Determines whether a given route contains dynamic segments.***
+ * ---------------------------------------------------------
+ * **This type checks if the route includes at least one `[param]` pattern.
+ * If it does, the result is `true`, otherwise `false`.**
+ * - ***⚠️ Warning:***
+ *    - ***This types only support when using ***[`NextJS`](https://nextjs.org/)***.***
+ * @template T - The route string to be evaluated.
+ * @example
+ * ```ts
+ * type HasParams1 = HasDynamicSegments<"/user/[id]">;
+ * // ➔ true
+ * type HasParams2 = HasDynamicSegments<"/settings/profile">;
+ * // ➔ false
+ * type HasParams3 = HasDynamicSegments<"/blog/[category]/[slug]">;
+ * // ➔ true
+ * ```
+ */
 type HasDynamicSegments<T>=T extends`${string}[${string}]${string}`?true:false;type GenerateRouteResult<T>=true extends IsAny<T>?unknown:T extends string?string:unknown;
 /** ---------------------------------
-* * ***Generates a URL by replacing dynamic route parameters with provided values.***
-* ---------------------------------
-*
-* * ⚠️ ***Notes: This Function only support when using `NextJS`***
-*
-* @template T - The route string containing dynamic segments in the format `[param]`.
-*
-* @param {T} route - The route string containing dynamic segments.
-* @param {ExtractRouteParams<T>} [params] - An object containing key-value pairs that match the dynamic segments in the route.
-*
-* @returns {string} The formatted URL with all dynamic segments replaced.
-*
-* @throws {Error} If the route contains dynamic segments but no parameters object is provided.
-* @throws {Error} If a required parameter is missing from the `params` object.
-* @throws {Error} If a parameter value is an empty string.
-* @throws {Error} If any parameter contains invalid characters like `?`, `&`, `=`, `#`, `/`, spaces, `'`, `"`, `(`, `)`, `+`, `;`, `%`, `@`, or `:`, which can cause URL issues.
-*
-* @example
-* // Basic usage
-* generateRoute("/user/[id]", { id: "123" });
-* // Returns: "/user/123"
-*
-* @example
-* // No dynamic segments, returns as-is
-* generateRoute("/dashboard");
-* // Returns: "/dashboard"
-*
-* @example
-* // Throws an error due to missing parameters object
-* generateRoute("/profile/[username]");
-* // ❌ Error: ❌ Missing parameters object for route: "/profile/[username]"
-*
-* @example
-* // Throws an error due to an empty parameter value
-* generateRoute("/post/[category]/[slug]", { category: "tech", slug: "" });
-* // ❌ Error: ❌ Parameter "slug" cannot be empty in route: "/post/[category]/[slug]"
-*
-* @example
-* // Throws an error due to parameter containing invalid characters
-* generateRoute("/search/[query]", { query: "how to?learn" });
-* // ❌ Error: ❌ Parameter "query" contains invalid character "?" in route: "/search/[query]"
-*
-* @example
-* // Handles leading/trailing slashes correctly
-* generateRoute("/blog/[category]/[slug]", { category: "/news/", slug: "/latest-update/" });
-* // ❌ Error: ❌ Parameter "category" and "slug" contains slashes "/" which is not allowed.
-*/
-declare function generateRoute<T extends string>(route:T extends string?(HasDynamicSegments<T>extends true?T:never):never,params:T extends string?ExtractRouteParams<T>:undefined):GenerateRouteResult<T>;declare function generateRoute<T extends string>(route:T extends string?T:never,params?:Extract<ExtractRouteParams<T>,Record<string,unknown>>):GenerateRouteResult<T>;declare function generateRoute<T=unknown>(route:T extends string?(HasDynamicSegments<T>extends true?T:unknown):unknown,params?:T extends string?ExtractRouteParams<T>:undefined):unknown;
+ * * ***Generates a URL by replacing dynamic route parameters with provided values.***
+ * ---------------------------------
+ * - ***⚠️ Warning:***
+ *    - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***
+ * @template T - The route string containing dynamic segments in the format `[param]`.
+ * @param {T} route - The route string containing dynamic segments.
+ * @param {ExtractRouteParams<T>} [params] - An object containing key-value pairs that match the dynamic segments in the route.
+ * @returns {string} The formatted URL with all dynamic segments replaced.
+ * @throws {Error} If the route contains dynamic segments but no parameters object is provided.
+ * @throws {Error} If a required parameter is missing from the `params` object.
+ * @throws {Error} If a parameter value is an empty string.
+ * @throws {Error} If any parameter contains invalid characters like `?`, `&`, `=`, `#`, `/`, spaces, `'`, `"`, `(`, `)`, `+`, `;`, `%`, `@`, or `:`, which can cause URL issues.
+ * @example
+ * // Basic usage
+ * generateRoute("/user/[id]", { id: "123" });
+ * // ➔ "/user/123"
+ *
+ * // No dynamic segments, returns as-is
+ * generateRoute("/dashboard");
+ * // ➔ "/dashboard"
+ *
+ * // Throws an error due to missing parameters object
+ * generateRoute("/profile/[username]");
+ * // ➔ ❌ Error: ❌ Missing parameters object for route: "/profile/[username]"
+ *
+ * // Throws an error due to an empty parameter value
+ * generateRoute("/post/[category]/[slug]", { category: "tech", slug: "" });
+ * // ➔ ❌ Error: ❌ Parameter "slug" cannot be empty in route: "/post/[category]/[slug]"
+ *
+ * // Throws an error due to parameter containing invalid characters
+ * generateRoute("/search/[query]", { query: "how to?learn" });
+ * // ➔ ❌ Error: ❌ Parameter "query" contains invalid character "?" in route: "/search/[query]"
+ *
+ * // Handles leading/trailing slashes correctly
+ * generateRoute("/blog/[category]/[slug]", { category: "/news/", slug: "/latest-update/" });
+ * // ➔ ❌ Error: ❌ Parameter "category" and "slug" contains slashes "/" which is not allowed.
+ */
+declare function generateRoute<T extends string>(route:T extends string?(HasDynamicSegments<T>extends true?T:never):never,params:T extends string?ExtractRouteParams<T>:undefined):GenerateRouteResult<T>;declare function generateRoute<T extends string>(route:T extends string?T:never,params?:Extract<ExtractRouteParams<T>,Record<string,unknown>>):GenerateRouteResult<T>;declare function generateRoute<T=unknown>(route:T extends string?(HasDynamicSegments<T>extends true?T:unknown):unknown,params?:T extends string?ExtractRouteParams<T>:undefined):unknown;type OptionsCreateBeApiUrl={
+/** * The prefix pathname api url, e.g:`"http://localhost.com/your-target-prefix-entri-point-api-is-here"`, default: `"/api"`.
+ *
+ * @default "/api" */
+prefix?:string;
+/** * Option to getting `prefix` and `pathname` of api url only `(removing origin base api url)`, default: `true`.
+ *
+ * @default true */
+withOrigin?:boolean;};
 /** ---------------------------------
-* * ***Constructs a backend API URL by appending a given pathname to the base API URL.***
-* ---------------------------------
-* This function builds on top of `getBeApiUrl()`, which determines the base API URL from:
-* - `NEXT_PUBLIC_BACKEND_API_URL` environment variable (or defaults to `"http://localhost:8000"`).
-* - Automatically appends `NEXT_PUBLIC_PORT_BE` if the base URL does not already include a port.
-*
-* Features of this function:
-* - Allows customizing the API path with an optional `prefix` (defaults to `"/api"`).
-* - Can include or exclude the origin (protocol + host) via `withOrigin`.
-* - Normalizes paths to avoid duplicate slashes.
-*
-* * ⚠️ ***Notes: This Function only support when using `NextJS`***
-*
-* @param {string} pathname - The API endpoint path (e.g., `/users` or `/v1/posts`).
-* @param {Object} options - Configuration options.
-* @param {string} [options.prefix="/api"] - The prefix for the API path (default is `"/api"`).
-* @param {boolean} [options.withOrigin=true] - Whether to include the full base URL or return only the API path.
-* @returns {string} The formatted API URL.
-*
-* @throws {TypeError} If `withOrigin` is not a boolean.
-* @throws {TypeError} If `prefix` and `pathname` is not a string.
-* @throws {Error} If constructing the API URL fails due to an invalid base URL.
-*
-* @example
-* createBeApiUrl("/users")
-* // -> "http://localhost:8000/api/users"
-*
-* createBeApiUrl("/users", { withOrigin: false })
-* // -> "/api/users"
-*/
+ * * ***Constructs a backend API URL by appending a given pathname to the base API URL.***
+ * ---------------------------------
+ * This function builds on top of `getBeApiUrl()`.
+ * - **Determines the base API URL from:**
+ *    - `NEXT_PUBLIC_BACKEND_API_URL` environment variable (or defaults to `"http://localhost:8000"`).
+ *    - Automatically appends `NEXT_PUBLIC_PORT_BE` if the base URL does not already include a port.
+ * - **Features of this function:**
+ *    - Allows customizing the API path with an optional `prefix` (defaults to `"/api"`).
+ *    - Can include or exclude the origin (protocol + host) via `withOrigin`.
+ *    - Normalizes paths to avoid duplicate slashes.
+ * - ***⚠️ Warning:***
+ *    - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***
+ * @param {string|null|undefined} pathname - The API endpoint path (e.g., `/users` or `/v1/posts`), defaultValue: `""`.
+ * @param {OptionsCreateBeApiUrl} [options] - Configuration options.
+ * @param {OptionsCreateBeApiUrl["prefix"]} [options.prefix="/api"] - The prefix for the API path (default is `"/api"`).
+ * @param {OptionsCreateBeApiUrl["withOrigin"]} [options.withOrigin=true] - Whether to include the full base URL or return only the API path.
+ * @returns {string} The formatted API URL.
+ * @throws {TypeError} If `withOrigin` is not a boolean.
+ * @throws {TypeError} If `prefix` and `pathname` is not a string.
+ * @throws {Error} If constructing the API URL fails due to an invalid base URL.
+ * @example
+ * createBeApiUrl("/users")
+ * // ➔ "http://localhost:8000/api/users"
+ * createBeApiUrl("/api/users")
+ * // ➔ "http://localhost:8000/api/users"
+ * createBeApiUrl("/v1", { prefix: "/v1" })
+ * // ➔ "http://localhost:8000/v1"
+ * createBeApiUrl("/v1/users")
+ * // ➔ "http://localhost:8000/api/v1/users"
+ * createBeApiUrl("/v1/users", { prefix: "/v1" })
+ * // ➔ "http://localhost:8000/v1/users"
+ * createBeApiUrl("/users", { withOrigin: false })
+ * // ➔ "/api/users"
+ * createBeApiUrl(null, { withOrigin: false })
+ * // ➔ "/api"
+ * createBeApiUrl(undefined, { withOrigin: false })
+ * // ➔ "/api"
+ */
 declare const createBeApiUrl:(
 /** * The pathname api url, e.g:`"http://localhost.com/your-target-prefix-entri-point-api-is-here/your-target-pathname-is-here"`.
-*
-* @default "" */
-pathname?:string,options?:{
-/** * The prefix pathname api url, e.g:`"http://localhost.com/your-target-prefix-entri-point-api-is-here"`.
-*
-* @default "/api" */
-prefix?:string;
-/** * Option to getting `prefix` and `pathname` of api url only `(removing origin base api url)`.
-*
-* @default true */
-withOrigin?:boolean;})=>string;
-/** ---------------------------------
-* * ***Retrieves the base API URL of the backend.***
-* ---------------------------------
-*
-* This function determines the backend API base URL from the `NEXT_PUBLIC_BACKEND_API_URL` environment variable.
-* If the variable is not set, it defaults to `"http://localhost:8000"`.
-* It also allows adding an optional suffix to the returned URL.
-*
-* * ⚠️ ***Notes: This Function only support when using `NextJS`***
-*
-* This function determines the backend API base URL from the `NEXT_PUBLIC_BACKEND_API_URL` environment variable.
-* - If `NEXT_PUBLIC_BACKEND_API_URL` is not set, it defaults to `"http://localhost:8000"`.
-* - If `NEXT_PUBLIC_BACKEND_API_URL` does **not** contain a port, it appends one from `NEXT_PUBLIC_PORT_BE` if available.
-* - Supports appending optional suffix (like "/api").
-*
-*
-* @param {Object} options - Configuration options.
-* @param {string} [options.suffix="/"] - The suffix to append to the base API URL.
-* @returns {string} The formatted backend API base URL.
-* @throws {TypeError} If `suffix` is not a `string`.
-* @throws {Error} If `NEXT_PUBLIC_BACKEND_API_URL` is invalid.
-*/
-declare const getBeApiUrl:({suffix}?:{
-/** * The Suffix origin base api url, e.g:`http://localhost.com/api`.
-*
-* @default "/" */
-suffix?:string;})=>string;
-/** ---------------------------------
-* * ***Retrieves the base URL of the application.***
-* ---------------------------------
-*
-* This function is designed to be used within Next.js applications.
-* It determines the base URL from the `NEXT_PUBLIC_BASE_URL` environment variable.
-*
-* * ⚠️ ***Notes: This Function only support when using `NextJS`***
-*
-* - If `NEXT_PUBLIC_BASE_URL` is not set, it defaults to `"http://localhost:3000"`.
-* - If `NEXT_PUBLIC_BASE_URL` does **not** contain a port, it appends one from `NEXT_PUBLIC_PORT_FE` if available.
-* - Ensures the final URL is valid and normalized (no trailing slashes).
-*
-* @returns {string} The resolved base URL of the application.
-* @throws {Error} If the constructed URL is invalid or malformed.
-*
-*/
+ *
+ * @default ""
+ */
+pathname:string|null|undefined,options?:OptionsCreateBeApiUrl)=>string;type OptionsGetBeApiUrl={
+/** * The Suffix origin base api url, e.g:`http://localhost.com/api`, default: `"/"`.
+ *
+ * @default "/" */
+suffix?:string;};
+/** ---------------------------------------------------
+ * * ***Retrieves the base API URL of the backend.***
+ * ---------------------------------------------------
+ * **This function determines the backend API base URL from the `NEXT_PUBLIC_BACKEND_API_URL` environment variable.**
+ * - **Behavior:**
+ *    - If the variable is not set, it defaults to `"http://localhost:8000"`.
+ *    - It also allows adding an optional suffix to the returned URL.
+ * - ***⚠️ Warning:***
+ *    - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***
+ * @description
+ * This function determines the backend API base URL from the `NEXT_PUBLIC_BACKEND_API_URL` environment variable.
+ * - If `NEXT_PUBLIC_BACKEND_API_URL` is not set, it defaults to `"http://localhost:8000"`.
+ * - If `NEXT_PUBLIC_BACKEND_API_URL` does **not** contain a port, it appends one from `NEXT_PUBLIC_PORT_BE` if available.
+ * - Supports appending optional suffix (like "/api").
+ * @param {OptionsGetBeApiUrl|undefined} options - Configuration options.
+ * @param {OptionsGetBeApiUrl["suffix"]} [options.suffix="/"] - The suffix to append to the base API URL.
+ * @returns {string} The formatted backend API base URL.
+ * @throws {TypeError} If `suffix` is not a `string`.
+ * @throws {Error} If `NEXT_PUBLIC_BACKEND_API_URL` is invalid.
+ * @example
+ * // With NEXT_PUBLIC_BACKEND_API_URL set at `*.env` file
+ * NEXT_PUBLIC_BACKEND_API_URL = "https://api.example.com";
+ * getBeApiUrl();
+ * // ➔ "https://api.example.com/"
+ *
+ * // With NEXT_PUBLIC_BACKEND_API_URL but no port, using NEXT_PUBLIC_PORT_BE at `*.env` file
+ * NEXT_PUBLIC_BACKEND_API_URL = "http://localhost";
+ * NEXT_PUBLIC_PORT_BE = "5000";
+ * getBeApiUrl({ suffix: "/api" });
+ * // ➔ "http://localhost:5000/api"
+ *
+ * // Without NEXT_PUBLIC_BACKEND_API_URL at `*.env` file (defaults to localhost:8000)
+ * delete NEXT_PUBLIC_BACKEND_API_URL;
+ * getBeApiUrl({ suffix: "/v1" });
+ * // ➔ "http://localhost:8000/v1"
+ */
+declare const getBeApiUrl:({suffix}?:OptionsGetBeApiUrl)=>string;
+/** ---------------------------------------------------
+ * * ***Retrieves the base URL of the application.***
+ * ---------------------------------------------------
+ * **This function is designed to be used within `Next.js` applications.**
+ * - **Behavior:**
+ *    - It determines the base URL from the `NEXT_PUBLIC_BASE_URL` environment variable.
+ *    - If `NEXT_PUBLIC_BASE_URL` is not set, it defaults to `"http://localhost:3000"`.
+ *    - If `NEXT_PUBLIC_BASE_URL` does **not** contain a port, it appends one from `NEXT_PUBLIC_PORT_FE` if available.
+ *    - Ensures the final URL is valid and normalized (no trailing slashes).
+ * - ***⚠️ Warning:***
+ *    - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***
+ * @returns {string} The resolved base URL of the application.
+ * @throws {Error} If the constructed URL is invalid or malformed.
+ * @example
+ * // With environment variable set at `*.env` file
+ * NEXT_PUBLIC_BASE_URL = "https://example.com";
+ * getBaseUrl();
+ * // ➔ "https://example.com"
+ *
+ * // With custom port via NEXT_PUBLIC_PORT_FE  at `*.env` file
+ * NEXT_PUBLIC_BASE_URL = "http://localhost";
+ * NEXT_PUBLIC_PORT_FE = "4000";
+ * getBaseUrl();
+ * // ➔ "http://localhost:4000"
+ *
+ * // Without environment variable at `*.env` file
+ * delete NEXT_PUBLIC_BASE_URL;
+ * getBaseUrl();
+ * // ➔ "http://localhost:3000"
+ */
 declare const getBaseUrl:()=>string;export{type ExtractRouteParams,type HasDynamicSegments,createBeApiUrl,generateRoute,getBaseUrl,getBeApiUrl};

package/dist/next/index.js

@@ -1,8 +1 @@
-import {c as c$2,d}from'../chunk-JFRL7NKU.js';import {c as c$3}from'../chunk-GECI2YBP.js';import {a}from'../chunk-NIMNTEGV.js';import {a as a$1}from'../chunk-XVB3ZZEB.js';import'../chunk-ELDDNERR.js';import {c}from'../chunk-MNGGDB2G.js';import'../chunk-5SZUSNGZ.js';import {h,E,m,c as c$1,r,p,f,k,G}from'../chunk-XCFIOTCV.js';function C(e,t){if(!h(e)||a(e))throw new TypeError(`\u274C 'generateRoute' Failed:
-- Invalid 'route' value.
-- Must be of type \`string\` and non-empty string, but received: "${E(e)}": \`${c(e)}\`.`);if(!/[\\[\]]/.test(e))return e;if(m(t,{message:({validType:o})=>`\u274C 'generateRoute' Failed cause in route "${e}":
-- Missing or invalid parameters \`${o}\` for route: "${e}", must be of type \`${o}\` mapping parameters.`}),c$1(t))throw new TypeError(`\u274C 'generateRoute' Failed cause in route "${e}":
-- Missing parameters \`plain-object\` for route: "${e}".`);let n=["?","&","#","=","/","'",'"',"(",")","+",";","%","@",":"],r$1=[],s=Array.from(e.matchAll(/\[(\w+)\]/g)).map(o=>o[1]);for(let o of s){let i=t[o];if(!h(i)){r$1.push(`- Invalid parameter: "${o}" must be of type \`string\`, but received: \`${E(i)}\`.`);continue}if(a(i)){r$1.push(`- Parameter "${o}" cannot be empty string.`);continue}let p=n.filter(g=>i.includes(g));if(/\s/.test(i)&&p.push("white-space(s)"),p.length>0){let g=p.map(a=>a==="`"?"backtick - (`)":`\`${a}\``);n.includes("white-space(s)")||n.push("white-space(s)");let c=n.map(a=>a==="`"?"backtick - (`)":`\`${a}\``);r$1.push(`- Parameter "${o}" contains invalid characters (${g.join(", ")}). These characters are not allowed because they could cause issues in URL structure. The following characters are forbidden in route parameters: (${c.join(", ")}).`);}}if(r(r$1))throw new Error(`\u274C 'generateRoute' Failed cause in route "${e}":
-${r$1.join(`
-`)}.`);return e.replace(/\[(\w+)\]/g,(o,i)=>(p(t[i])?t[i]:"").trim().replace(/^\/+|\/+$/g,"")).replace(/\/+/g,"/")}var M=(e="",t)=>{try{let p=function(c,a){return `${c.replace(/\/+$/,"")}/${a.replace(/^\/+/,"")}`};var n=p;a$1(e,{message({currentType:c,validType:a}){return `First parameter \`pathname\` must be of type \`${a}\`, but received: \`${c}\`.`}}),f(t)||(t={});let{prefix:r="/api",withOrigin:s=!0}=t;if(!k(r)&&!h(r))throw new TypeError(`Parameter \`prefix\` property of the \`options\` (second parameter) must be of type \`string\`, but received: ${E(r)}.`);G(s,{message:({currentType:c,validType:a})=>`Parameter \`withOrigin\` property of the \`options\` (second parameter) must be of type \`${a}\`, but received: \`${c}\`.`}),e=c$2(e),r=c$2(r);let o=r.endsWith("/")?r:r+"/";(e===r||e===r+"/"||e.startsWith(o))&&(e=e.slice(r.length),e=c$2(e));let i=U({suffix:r});return p(s?i:new URL(i).pathname,e).replace(/\/+$/,"")}catch(r){throw new Error("Failed to generate backend API URL in `createBeApiUrl()`, Error:"+r)}};var U=({suffix:e="/"}={})=>{a$1(e,{message({currentType:t,validType:n}){return `Parameter \`suffix\` property of the first parameter must be of type \`${n}\`, but received: \`${t}\`.`}});try{let t=process.env.NEXT_PUBLIC_BACKEND_API_URL?.trim();if(t){t=c$3(t);let s=new URL(t);!!!s.port&&process.env.NEXT_PUBLIC_PORT_BE&&(t=s.origin+d(process.env.NEXT_PUBLIC_PORT_BE,{prefixColon:!0}));}else t="http://localhost"+d(process.env.NEXT_PUBLIC_PORT_BE||"8000",{prefixColon:!0});e=c$3(e).length?c$3(e):"/";let n=new URL(t.replace(/\/+$/,"")).origin,r=e==="/"?"/":`${e.startsWith("/")?"":"/"}${e.replace(/\/+$/,"")}`;return `${n}${r}`}catch(t){throw new Error("Invalid `NEXT_PUBLIC_BACKEND_API_URL`, failed to generate from `getBeApiUrl()`, Error:"+t)}};var Z=()=>{try{let e=process.env.NEXT_PUBLIC_BASE_URL?.trim(),t=process.env.NEXT_PUBLIC_PORT_FE?.trim(),n=e||"http://localhost";n=c$3(n).replace(/\/+$/,"");let r=/:\/\/[^/]+:\d+/.test(n);!r&&t?n+=d(t,{prefixColon:!0}):!r&&!e&&(n+=":3000");let s=new URL(n);return `${s.protocol}//${s.hostname}${s.port?`:${s.port}`:""}`}catch(e){throw new Error("Invalid `NEXT_PUBLIC_BASE_URL`, failed to generate from `getBaseUrl()`, Error:"+e)}};
-export{M as createBeApiUrl,C as generateRoute,Z as getBaseUrl,U as getBeApiUrl};
+import{normalizePathname as e,formatEnvPort as r}from"../chunk-6HQDHIOD.js";import{removeSpaces as t}from"../chunk-Q6NHYWVX.js";import{isEmptyString as o}from"../chunk-TSLYDPBJ.js";import{assertIsString as n}from"../chunk-W2W3L2M5.js";import"../chunk-WVSPXFTY.js";import{safeStableStringify as i}from"../chunk-AJ65QFV2.js";import"../chunk-QNKGP5DY.js";import{isString as a,getPreciseType as s,assertIsPlainObject as p,isNil as c,isNonEmptyArray as u,isNonEmptyString as l,isPlainObject as m,isUndefined as f,assertIsBoolean as h,isError as $}from"../chunk-2UIRWYE3.js";function d(e,r){if(!a(e)||o(e))throw new TypeError(`❌ 'generateRoute' Failed:\n- Invalid 'route' value.\n- Must be of type \`string\` and non-empty string, but received: "${s(e)}": \`${i(e)}\`.`);if(!/[\\[\]]/.test(e))return e;if(p(r,{message:({validType:r})=>`❌ 'generateRoute' Failed cause in route "${e}":\n- Missing or invalid parameters \`${r}\` for route: "${e}", must be of type \`${r}\` mapping parameters.`}),c(r))throw new TypeError(`❌ 'generateRoute' Failed cause in route "${e}":\n- Missing parameters \`plain-object\` for route: "${e}".`);const t=["?","&","#","=","/","'",'"',"(",")","+",";","%","@",":"],n=[],m=Array.from(e.matchAll(/\[(\w+)\]/g)).map(e=>e[1]);for(const e of m){const i=r[e];if(!a(i)){n.push(`- Invalid parameter: "${e}" must be of type \`string\`, but received: \`${s(i)}\`.`);continue}if(o(i)){n.push(`- Parameter "${e}" cannot be empty string.`);continue}const p=t.filter(e=>i.includes(e));if(/\s/.test(i)&&p.push("white-space(s)"),p.length>0){const r=p.map(e=>"`"===e?"backtick - (`)":`\`${e}\``);t.includes("white-space(s)")||t.push("white-space(s)");const o=t.map(e=>"`"===e?"backtick - (`)":`\`${e}\``);n.push(`- Parameter "${e}" contains invalid characters (${r.join(", ")}). These characters are not allowed because they could cause issues in URL structure. The following characters are forbidden in route parameters: (${o.join(", ")}).`)}}if(u(n))throw new Error(`❌ 'generateRoute' Failed cause in route "${e}":\n${n.join("\n")}.`);return e.replace(/\[(\w+)\]/g,(e,t)=>(l(r[t])?r[t]:"").trim().replace(/^\/+|\/+$/g,"")).replace(/\/+/g,"/")}var g=(r,t={})=>{try{let o=function(e,r){return`${e.replace(/\/+$/,"")}/${r.replace(/^\/+/,"")}`};n(c(r)?"":r,{message:({currentType:e,validType:r})=>`First parameter (\`pathname\`) must be of type \`${r}\`, but received: \`${e}\`.`}),m(t)||(t={});let{prefix:i="/api",withOrigin:p=!0}=t;if(!f(i)&&!a(i))throw new TypeError(`Parameter \`prefix\` property of the \`options\` (second parameter) must be of type \`string\`, but received: \`${s(i)}\`.`);h(p,{message:({currentType:e,validType:r})=>`Parameter \`withOrigin\` property of the \`options\` (second parameter) must be of type \`${r}\`, but received: \`${e}\`.`}),r=e(r),i=e(i);const u=i.endsWith("/")?i:i+"/";(r===i||r===i+"/"||r.startsWith(u))&&(r=r.slice(i.length),r=e(r));const l=v({suffix:i});return o(p?l:new URL(l).pathname,r).replace(/\/+$/,"")}catch(e){throw $(e)?e:new Error("Failed to generate backend API URL in `createBeApiUrl()`, Error: "+new Error(String(e)).message.trim())}},v=({suffix:e="/"}={})=>{var o;n(e,{message:({currentType:e,validType:r})=>`Parameter \`suffix\` property of the first parameter must be of type \`${r}\`, but received: \`${e}\`.`});try{let n=null==(o=process.env.NEXT_PUBLIC_BACKEND_API_URL)?void 0:o.trim();if(n){n=t(n);const e=new URL(n);!!!e.port&&process.env.NEXT_PUBLIC_PORT_BE&&(n=e.origin+r(process.env.NEXT_PUBLIC_PORT_BE,{prefixColon:!0}))}else n="http://localhost"+r(process.env.NEXT_PUBLIC_PORT_BE||"8000",{prefixColon:!0});e=t(e).length?t(e):"/";const i=new URL(n.replace(/\/+$/,"")).origin;return`${i}${"/"===e?"/":`${e.startsWith("/")?"":"/"}${e.replace(/\/+$/,"")}`}`}catch(e){throw new Error("Invalid `NEXT_PUBLIC_BACKEND_API_URL`, failed to generate from `getBeApiUrl()`, Error:"+e)}},w=()=>{var e,o;try{const n=null==(e=process.env.NEXT_PUBLIC_BASE_URL)?void 0:e.trim(),i=null==(o=process.env.NEXT_PUBLIC_PORT_FE)?void 0:o.trim();let a=n||"http://localhost";a=t(a).replace(/\/+$/,"");const s=/:\/\/[^/]+:\d+/.test(a);!s&&i?a+=r(i,{prefixColon:!0}):s||n||(a+=":3000");const p=new URL(a);return`${p.protocol}//${p.hostname}${p.port?`:${p.port}`:""}`}catch(e){throw new Error("Invalid `NEXT_PUBLIC_BASE_URL`, failed to generate from `getBaseUrl()`, Error:"+e)}};export{g as createBeApiUrl,d as generateRoute,w as getBaseUrl,v as getBeApiUrl};

package/dist/next/server/index.cjs

@@ -1,2 +1 @@
-'use strict';var chunkCN53M4QZ_cjs=require('../../chunk-CN53M4QZ.cjs');require('server-only');var server=require('next/server');var g=(t,r=true)=>{if(!chunkCN53M4QZ_cjs.b(server.NextRequest))throw new Error("Function `getClientIpOrUrl` is designed to be used in a `Next.js` environment.");if(!(t instanceof server.NextRequest))throw new TypeError("First parameter `request` must be an instance of NextRequest.");chunkCN53M4QZ_cjs.G(r,{message:({currentType:a,validType:d})=>`Second parameter \`includeFullUrl\` must be of type \`${d}\`, but received: \`${a}\`.`});let e=(t.headers.get("x-forwarded-for")??"127.0.0.1").trim().split(",");(e[0]==="::ffff:127.0.0.1"||e[0]==="::1")&&(e[0]="127.0.0.1");let o=e.length>1?e[e.length-1].trim():e[0];if(!r)return o;let p=t.headers.get("x-forwarded-proto")||"http",f=t.headers.get("x-forwarded-port")||"3000";return `${process.env.NODE_ENV==="production"?p:"http"}://${o}:${f}`};
-exports.getClientIpOrUrl=g;
+"use strict";var e=require("../../chunk-INUFZJLX.cjs");require("server-only");var r=require("next/server");exports.getClientIpOrUrl=(t,n=!0)=>{if(!e.isFunction(r.NextRequest))throw new Error("Function `getClientIpOrUrl` is designed to be used in a `NextJS` environment.");if(!(t instanceof r.NextRequest))throw new TypeError("First parameter (`request`) must be an `instance of NextRequest` from `NextJS`.");e.assertIsBoolean(n,{message:({currentType:e,validType:r})=>`Second parameter (\`includeFullUrl\`) must be of type \`${r}\`, but received: \`${e}\`.`});const s=(t.headers.get("x-forwarded-for")??"127.0.0.1").trim().split(",");"::ffff:127.0.0.1"!==s[0]&&"::1"!==s[0]||(s[0]="127.0.0.1");const o=s.length>1?s[s.length-1].trim():s[0];if(!n)return o;const i=t.headers.get("x-forwarded-proto")||"http",u=t.headers.get("x-forwarded-port")||"3000";return`${"production"===process.env.NODE_ENV?i:"http"}://${o}:${u}`};

package/dist/next/server/index.d.ts

@@ -1,42 +1,28 @@
 import{NextRequest}from'next/server';
 /** ---------------------------------
-* * ***Retrieves the real client IP address and constructs the full URL using headers like***
-* ***`x-forwarded-for`, `x-forwarded-proto`, and `x-forwarded-port`.***
-* ---------------------------------
-*
-* * ⚠️ **Notes:**
-*   - Only supported in **Next.js** environments (specifically in `server-only` contexts).
-*   - Should be used in **middleware** or **server actions** that have access to `NextRequest`.
-*
-*
-* @param {NextRequest} request - The incoming Next.js request object.
-* @param {boolean} [includeFullUrl=true] - Whether to return the full URL (`protocol://ip:port`) or just the IP address.
-*
-* @returns {string} The extracted client IP address or the full constructed URL.
-*
-* @throws {Error} If the function is used outside a Next.js server environment.
-* @throws {TypeError} If the arguments do not match the expected types.
-*
-* @example
-* // Basic usage in Next.js middleware
-* import { NextRequest } from "next/server";
-* import { getClientIpOrUrl } from "@rzl-zone/utils-js/next/server";
-*
-* export function middleware(request: NextRequest) {
-*   const clientIp = getClientIpOrUrl(request, false);
-*   console.log("Client IP:", clientIp);
-* }
-*
-* @example
-* // Get full URL
-* const url = getClientIpOrUrl(request);
-* console.log("Client full URL:", url);
-*/
-declare const getClientIpOrUrl:(
-/** * The incoming Next.js request object. */
-request:NextRequest,
-/** * Whether to return the full URL (protocol, IP, and port) or just the IP address.
-*
-* @default true
-*/
-includeFullUrl?:boolean)=>string;export{getClientIpOrUrl};
+ * * ***Utility for NextJS Server: `getClientIpOrUrl`.***
+ * ---------------------------------
+ * **Retrieves the real client IP address and constructs the full URL using headers like `x-forwarded-for`, `x-forwarded-proto`, and `x-forwarded-port`.**
+ * - **ℹ️ Note:**
+ *    - Only supported in **Next.js** environments (specifically in `server-only` contexts).
+ *    - Should be used in **middleware** or **server actions** that have access to ***[`NextRequest - NextJS`](https://nextjs.org/docs/app/api-reference/functions/next-request)***.
+ * @param {NextRequest} request - The incoming ***`NextJS`*** request object.
+ * @param {boolean|undefined} [includeFullUrl=true] - Whether to return the full URL (`protocol`, `IP`, and `port` like `protocol://ip:port`) or just the IP address, defaultValue: `true`.
+ * @returns {string} The extracted client IP address or the full constructed URL.
+ * @throws {Error} If the function is used outside a Next.js server environment.
+ * @throws {TypeError} If the arguments do not match the expected types.
+ * @example
+ * // Basic usage in Next.js middleware
+ * import { NextRequest } from "next/server";
+ * import { getClientIpOrUrl } from "@rzl-zone/utils-js/next/server";
+ *
+ * export function middleware(request: NextRequest) {
+ *   const clientIp = getClientIpOrUrl(request, false);
+ *   console.log("Client IP:", clientIp);
+ * }
+ *
+ * // Get full URL
+ * const url = getClientIpOrUrl(request);
+ * console.log("Client full URL:", url);
+ */
+declare const getClientIpOrUrl:(request:NextRequest,includeFullUrl?:boolean)=>string;export{getClientIpOrUrl};

package/dist/next/server/index.js

@@ -1,2 +1 @@
-import {b,G}from'../../chunk-XCFIOTCV.js';import'server-only';import {NextRequest}from'next/server';var g=(t,r=true)=>{if(!b(NextRequest))throw new Error("Function `getClientIpOrUrl` is designed to be used in a `Next.js` environment.");if(!(t instanceof NextRequest))throw new TypeError("First parameter `request` must be an instance of NextRequest.");G(r,{message:({currentType:a,validType:d})=>`Second parameter \`includeFullUrl\` must be of type \`${d}\`, but received: \`${a}\`.`});let e=(t.headers.get("x-forwarded-for")??"127.0.0.1").trim().split(",");(e[0]==="::ffff:127.0.0.1"||e[0]==="::1")&&(e[0]="127.0.0.1");let o=e.length>1?e[e.length-1].trim():e[0];if(!r)return o;let p=t.headers.get("x-forwarded-proto")||"http",f=t.headers.get("x-forwarded-port")||"3000";return `${process.env.NODE_ENV==="production"?p:"http"}://${o}:${f}`};
-export{g as getClientIpOrUrl};
+import{isFunction as e,assertIsBoolean as r}from"../../chunk-2UIRWYE3.js";import"server-only";import{NextRequest as t}from"next/server";var o=(o,n=!0)=>{if(!e(t))throw new Error("Function `getClientIpOrUrl` is designed to be used in a `NextJS` environment.");if(!(o instanceof t))throw new TypeError("First parameter (`request`) must be an `instance of NextRequest` from `NextJS`.");r(n,{message:({currentType:e,validType:r})=>`Second parameter (\`includeFullUrl\`) must be of type \`${r}\`, but received: \`${e}\`.`});const s=(o.headers.get("x-forwarded-for")??"127.0.0.1").trim().split(",");"::ffff:127.0.0.1"!==s[0]&&"::1"!==s[0]||(s[0]="127.0.0.1");const i=s.length>1?s[s.length-1].trim():s[0];if(!n)return i;const p=o.headers.get("x-forwarded-proto")||"http",a=o.headers.get("x-forwarded-port")||"3000";return`${"production"===process.env.NODE_ENV?p:"http"}://${i}:${a}`};export{o as getClientIpOrUrl};