@rzl-zone/utils-js 3.12.0 → 3.12.1-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (286) hide show
  1. package/{LICENSE.md → LICENSE} +3 -3
  2. package/README.md +69 -96
  3. package/dist/.references/index.d.cts +25 -0
  4. package/dist/.references/index.d.ts +25 -0
  5. package/dist/assertIsArray-DJXkjHZs.cjs +26 -0
  6. package/dist/assertIsArray-DJXkjHZs.cjs.map +1 -0
  7. package/dist/assertIsArray-bTA3XLjq.js +20 -0
  8. package/dist/assertIsArray-bTA3XLjq.js.map +1 -0
  9. package/dist/assertIsBoolean-C8WEXVr2.cjs +1283 -0
  10. package/dist/assertIsBoolean-C8WEXVr2.cjs.map +1 -0
  11. package/dist/assertIsBoolean-DR1SaXPD.js +1073 -0
  12. package/dist/assertIsBoolean-DR1SaXPD.js.map +1 -0
  13. package/dist/assertIsString-BiHQSrB2.cjs +26 -0
  14. package/dist/assertIsString-BiHQSrB2.cjs.map +1 -0
  15. package/dist/assertIsString-CEB07_83.js +20 -0
  16. package/dist/assertIsString-CEB07_83.js.map +1 -0
  17. package/dist/assertions/index.cjs +37 -40
  18. package/dist/assertions/index.cjs.map +1 -0
  19. package/dist/assertions/index.d.cts +12 -0
  20. package/dist/assertions/index.d.ts +10 -824
  21. package/dist/assertions/index.js +30 -13
  22. package/dist/assertions/index.js.map +1 -0
  23. package/dist/conversions/index.cjs +34 -103
  24. package/dist/conversions/index.d.cts +12 -0
  25. package/dist/conversions/index.d.ts +10 -1791
  26. package/dist/conversions/index.js +14 -24
  27. package/dist/conversions-BNIh_tCH.js +380 -0
  28. package/dist/conversions-BNIh_tCH.js.map +1 -0
  29. package/dist/conversions-D_Kh0a_C.cjs +446 -0
  30. package/dist/conversions-D_Kh0a_C.cjs.map +1 -0
  31. package/dist/events/index.cjs +55 -31
  32. package/dist/events/index.cjs.map +1 -0
  33. package/dist/events/index.d.cts +176 -0
  34. package/dist/events/index.d.ts +164 -166
  35. package/dist/events/index.js +50 -12
  36. package/dist/events/index.js.map +1 -0
  37. package/dist/formatEnvPort-B3OLxQk9.cjs +171 -0
  38. package/dist/formatEnvPort-B3OLxQk9.cjs.map +1 -0
  39. package/dist/formatEnvPort-ByFVLjSV.js +159 -0
  40. package/dist/formatEnvPort-ByFVLjSV.js.map +1 -0
  41. package/dist/formatters/index.cjs +21 -61
  42. package/dist/formatters/index.d.cts +12 -0
  43. package/dist/formatters/index.d.ts +10 -2152
  44. package/dist/formatters/index.js +10 -18
  45. package/dist/formatters--1m_vpE8.js +369 -0
  46. package/dist/formatters--1m_vpE8.js.map +1 -0
  47. package/dist/formatters-Cbij0XLU.cjs +429 -0
  48. package/dist/formatters-Cbij0XLU.cjs.map +1 -0
  49. package/dist/generators/index.cjs +165 -41
  50. package/dist/generators/index.cjs.map +1 -0
  51. package/dist/generators/index.d.cts +12 -0
  52. package/dist/generators/index.d.ts +10 -338
  53. package/dist/generators/index.js +158 -14
  54. package/dist/generators/index.js.map +1 -0
  55. package/dist/index-59zbLcPr.d.ts +340 -0
  56. package/dist/index-B6tawc8L.d.cts +1716 -0
  57. package/dist/index-C267akkJ.d.ts +2158 -0
  58. package/dist/index-CeBC2Vvl.d.cts +2361 -0
  59. package/dist/index-CgRDTI6f.d.ts +822 -0
  60. package/dist/index-CoiUBVmr.d.ts +720 -0
  61. package/dist/index-D4fcasfZ.d.cts +720 -0
  62. package/dist/index-DDrSQKIc.d.ts +1716 -0
  63. package/dist/index-DsGxO31H.d.cts +765 -0
  64. package/dist/index-Hg1qJkjl.d.ts +765 -0
  65. package/dist/index-Qm3iFwd0.d.cts +2158 -0
  66. package/dist/index-UPp94Agr.d.ts +2361 -0
  67. package/dist/index-gBA_8SuF.d.cts +340 -0
  68. package/dist/index-jyDqzicx.d.cts +822 -0
  69. package/dist/isBigInt-C4krUeAw.cjs +20 -0
  70. package/dist/isBigInt-C4krUeAw.cjs.map +1 -0
  71. package/dist/isBigInt-DKe0M6hp.js +14 -0
  72. package/dist/isBigInt-DKe0M6hp.js.map +1 -0
  73. package/dist/isEmptyObject-DCipFwxJ.js +25 -0
  74. package/dist/isEmptyObject-DCipFwxJ.js.map +1 -0
  75. package/dist/isEmptyObject-ZkSwRC_D.cjs +37 -0
  76. package/dist/isEmptyObject-ZkSwRC_D.cjs.map +1 -0
  77. package/dist/isEmptyString-BXzKAC2j.js +15 -0
  78. package/dist/isEmptyString-BXzKAC2j.js.map +1 -0
  79. package/dist/isEmptyString-UiiUsSQj.cjs +21 -0
  80. package/dist/isEmptyString-UiiUsSQj.cjs.map +1 -0
  81. package/dist/isEmptyValue-BQzcjVaL.cjs +30 -0
  82. package/dist/isEmptyValue-BQzcjVaL.cjs.map +1 -0
  83. package/dist/isEmptyValue-jqOr7OHD.js +24 -0
  84. package/dist/isEmptyValue-jqOr7OHD.js.map +1 -0
  85. package/dist/isEqual-BX49cF9m.js +87 -0
  86. package/dist/isEqual-BX49cF9m.js.map +1 -0
  87. package/dist/isEqual-BvumA3RA.cjs +111 -0
  88. package/dist/isEqual-BvumA3RA.cjs.map +1 -0
  89. package/dist/isFinite-BCnaDpod.js +15 -0
  90. package/dist/isFinite-BCnaDpod.js.map +1 -0
  91. package/dist/isFinite-D24ZaE6c.cjs +21 -0
  92. package/dist/isFinite-D24ZaE6c.cjs.map +1 -0
  93. package/dist/isInteger-Caeuz0rB.cjs +20 -0
  94. package/dist/isInteger-Caeuz0rB.cjs.map +1 -0
  95. package/dist/isInteger-naMbJsxJ.js +14 -0
  96. package/dist/isInteger-naMbJsxJ.js.map +1 -0
  97. package/dist/isPlainObject-BF-2-phb.d.cts +339 -0
  98. package/dist/isPlainObject-DxNDL8XU.d.ts +339 -0
  99. package/dist/isServer-BJHVnixd.cjs +20 -0
  100. package/dist/isServer-BJHVnixd.cjs.map +1 -0
  101. package/dist/isServer-Da3o3XSs.js +14 -0
  102. package/dist/isServer-Da3o3XSs.js.map +1 -0
  103. package/dist/isTypedArray-DuNA8tK6.js +31 -0
  104. package/dist/isTypedArray-DuNA8tK6.js.map +1 -0
  105. package/dist/isTypedArray-TJptiw2b.cjs +43 -0
  106. package/dist/isTypedArray-TJptiw2b.cjs.map +1 -0
  107. package/dist/isURL-C-kSk6KJ.js +14 -0
  108. package/dist/isURL-C-kSk6KJ.js.map +1 -0
  109. package/dist/isURL-DeUPO_oR.cjs +20 -0
  110. package/dist/isURL-DeUPO_oR.cjs.map +1 -0
  111. package/dist/isValidDomain-BB9IGhJs.cjs +1845 -0
  112. package/dist/isValidDomain-BB9IGhJs.cjs.map +1 -0
  113. package/dist/isValidDomain-DoE98yhJ.js +1827 -0
  114. package/dist/isValidDomain-DoE98yhJ.js.map +1 -0
  115. package/dist/next/index.cjs +119 -214
  116. package/dist/next/index.cjs.map +1 -0
  117. package/dist/next/index.d.cts +220 -0
  118. package/dist/next/index.d.ts +203 -214
  119. package/dist/next/index.js +117 -212
  120. package/dist/next/index.js.map +1 -0
  121. package/dist/next/server/index.cjs +25 -40
  122. package/dist/next/server/index.cjs.map +1 -0
  123. package/dist/next/server/index.d.cts +39 -0
  124. package/dist/next/server/index.d.ts +34 -35
  125. package/dist/next/server/index.js +23 -38
  126. package/dist/next/server/index.js.map +1 -0
  127. package/dist/noop-B13_ii35.cjs +18 -0
  128. package/dist/noop-B13_ii35.cjs.map +1 -0
  129. package/dist/noop-ubqAIbHD.js +12 -0
  130. package/dist/noop-ubqAIbHD.js.map +1 -0
  131. package/dist/normalizeSpaces-Bg2IZW7W.js +23 -0
  132. package/dist/normalizeSpaces-Bg2IZW7W.js.map +1 -0
  133. package/dist/normalizeSpaces-ZXnR4Qzp.cjs +29 -0
  134. package/dist/normalizeSpaces-ZXnR4Qzp.cjs.map +1 -0
  135. package/dist/normalizeString-BDdkaXui.js +15 -0
  136. package/dist/normalizeString-BDdkaXui.js.map +1 -0
  137. package/dist/normalizeString-BE6ELqEb.cjs +21 -0
  138. package/dist/normalizeString-BE6ELqEb.cjs.map +1 -0
  139. package/dist/operations/index.cjs +65 -32
  140. package/dist/operations/index.cjs.map +1 -0
  141. package/dist/operations/index.d.cts +139 -0
  142. package/dist/operations/index.d.ts +129 -134
  143. package/dist/operations/index.js +61 -17
  144. package/dist/operations/index.js.map +1 -0
  145. package/dist/parsers/index.cjs +12 -19
  146. package/dist/parsers/index.d.cts +239 -0
  147. package/dist/parsers/index.d.ts +234 -235
  148. package/dist/parsers/index.js +10 -12
  149. package/dist/parsers-BSBPgvsq.js +643 -0
  150. package/dist/parsers-BSBPgvsq.js.map +1 -0
  151. package/dist/parsers-OqDeffqc.cjs +649 -0
  152. package/dist/parsers-OqDeffqc.cjs.map +1 -0
  153. package/dist/parsing-Cao8b358.js +50 -0
  154. package/dist/parsing-Cao8b358.js.map +1 -0
  155. package/dist/parsing-DOGSCH6N.cjs +56 -0
  156. package/dist/parsing-DOGSCH6N.cjs.map +1 -0
  157. package/dist/predicates/index.cjs +91 -296
  158. package/dist/predicates/index.d.cts +13 -0
  159. package/dist/predicates/index.d.ts +12 -2482
  160. package/dist/predicates/index.js +23 -25
  161. package/dist/predicates-Bj6meyXV.js +256 -0
  162. package/dist/predicates-Bj6meyXV.js.map +1 -0
  163. package/dist/predicates-D0ubqgqy.cjs +412 -0
  164. package/dist/predicates-D0ubqgqy.cjs.map +1 -0
  165. package/dist/promises/index.cjs +76 -24
  166. package/dist/promises/index.cjs.map +1 -0
  167. package/dist/promises/index.d.cts +123 -0
  168. package/dist/promises/index.d.ts +116 -119
  169. package/dist/promises/index.js +73 -13
  170. package/dist/promises/index.js.map +1 -0
  171. package/dist/punyCode-8SrbMWfM.js +179 -0
  172. package/dist/punyCode-8SrbMWfM.js.map +1 -0
  173. package/dist/punyCode-D-Qu6nj6.cjs +185 -0
  174. package/dist/punyCode-D-Qu6nj6.cjs.map +1 -0
  175. package/dist/removeSpaces-Bmc5DX4F.js +19 -0
  176. package/dist/removeSpaces-Bmc5DX4F.js.map +1 -0
  177. package/dist/removeSpaces-CWIvhZHg.cjs +25 -0
  178. package/dist/removeSpaces-CWIvhZHg.cjs.map +1 -0
  179. package/dist/rzl-utils.global.js +20 -9
  180. package/dist/safeJsonParse-BP38mwlj.js +184 -0
  181. package/dist/safeJsonParse-BP38mwlj.js.map +1 -0
  182. package/dist/safeJsonParse-Sms2CJf4.cjs +208 -0
  183. package/dist/safeJsonParse-Sms2CJf4.cjs.map +1 -0
  184. package/dist/safeStableStringify-CJtP89qn.cjs +106 -0
  185. package/dist/safeStableStringify-CJtP89qn.cjs.map +1 -0
  186. package/dist/safeStableStringify-CXOZ9Ub8.js +88 -0
  187. package/dist/safeStableStringify-CXOZ9Ub8.js.map +1 -0
  188. package/dist/strings/index.cjs +79 -81
  189. package/dist/strings/index.cjs.map +1 -0
  190. package/dist/strings/index.d.cts +12 -0
  191. package/dist/strings/index.d.ts +10 -775
  192. package/dist/strings/index.js +62 -14
  193. package/dist/strings/index.js.map +1 -0
  194. package/dist/tailwind/index.cjs +19 -47
  195. package/dist/tailwind/index.d.cts +12 -0
  196. package/dist/tailwind/index.d.ts +11 -712
  197. package/dist/tailwind/index.js +10 -12
  198. package/dist/tailwind-B2ssevxq.js +199 -0
  199. package/dist/tailwind-B2ssevxq.js.map +1 -0
  200. package/dist/tailwind-CHIx9uxu.cjs +247 -0
  201. package/dist/tailwind-CHIx9uxu.cjs.map +1 -0
  202. package/dist/toStringArrayUnRecursive-C4zYCja7.cjs +51 -0
  203. package/dist/toStringArrayUnRecursive-C4zYCja7.cjs.map +1 -0
  204. package/dist/toStringArrayUnRecursive-DJGtPsFb.js +39 -0
  205. package/dist/toStringArrayUnRecursive-DJGtPsFb.js.map +1 -0
  206. package/dist/urls/index.cjs +130 -57
  207. package/dist/urls/index.cjs.map +1 -0
  208. package/dist/urls/index.d.cts +737 -0
  209. package/dist/urls/index.d.ts +699 -708
  210. package/dist/urls/index.js +122 -26
  211. package/dist/urls/index.js.map +1 -0
  212. package/package.json +203 -194
  213. package/dist/chunk-2AFQ33D3.cjs +0 -64
  214. package/dist/chunk-2CYDJVGM.js +0 -246
  215. package/dist/chunk-2MW4JDQ2.cjs +0 -598
  216. package/dist/chunk-2VTDXC3N.cjs +0 -1825
  217. package/dist/chunk-44XX2P34.js +0 -209
  218. package/dist/chunk-4YLBKLGS.cjs +0 -18
  219. package/dist/chunk-566CXQW7.cjs +0 -560
  220. package/dist/chunk-57EPKYID.cjs +0 -397
  221. package/dist/chunk-5MGEC3YG.js +0 -63
  222. package/dist/chunk-6EF52423.cjs +0 -249
  223. package/dist/chunk-6SCOKU3S.js +0 -109
  224. package/dist/chunk-6VUXD3CF.js +0 -119
  225. package/dist/chunk-7B76BSNK.cjs +0 -118
  226. package/dist/chunk-7Y6I2DSU.cjs +0 -101
  227. package/dist/chunk-A7S7E2EE.cjs +0 -308
  228. package/dist/chunk-AJZ6PMMZ.js +0 -16
  229. package/dist/chunk-AXGBL2IO.cjs +0 -251
  230. package/dist/chunk-B4TC6FBV.cjs +0 -678
  231. package/dist/chunk-BAV5T2E3.cjs +0 -15
  232. package/dist/chunk-BKIJBNIE.js +0 -21
  233. package/dist/chunk-BNIMTFK5.js +0 -59
  234. package/dist/chunk-BXW7YXB7.js +0 -1823
  235. package/dist/chunk-CFYZC4S6.js +0 -53
  236. package/dist/chunk-CSG4SCL3.js +0 -1587
  237. package/dist/chunk-CWQW7AKK.js +0 -676
  238. package/dist/chunk-DVMHRLKP.cjs +0 -16
  239. package/dist/chunk-EN7LVZBZ.js +0 -548
  240. package/dist/chunk-EV4Y7HCY.cjs +0 -26
  241. package/dist/chunk-F66VDYIZ.cjs +0 -18
  242. package/dist/chunk-FLJX37EL.cjs +0 -30
  243. package/dist/chunk-GKC3UDMC.cjs +0 -1623
  244. package/dist/chunk-H65I3GRZ.cjs +0 -106
  245. package/dist/chunk-HHYWB7VZ.js +0 -24
  246. package/dist/chunk-HNGGISFL.cjs +0 -65
  247. package/dist/chunk-HNSQAVSZ.cjs +0 -35
  248. package/dist/chunk-HSP6IWZK.js +0 -17
  249. package/dist/chunk-IDZS7J6T.js +0 -242
  250. package/dist/chunk-JS6R55VL.js +0 -302
  251. package/dist/chunk-JZVT5FK7.js +0 -232
  252. package/dist/chunk-KHO2SBNA.cjs +0 -16
  253. package/dist/chunk-KIDJCMNJ.js +0 -33
  254. package/dist/chunk-KOLEURVT.cjs +0 -38
  255. package/dist/chunk-L4V53MQK.cjs +0 -269
  256. package/dist/chunk-L5RDAVVH.js +0 -14
  257. package/dist/chunk-NODTV4F3.js +0 -16
  258. package/dist/chunk-NYK5K3V2.cjs +0 -211
  259. package/dist/chunk-ODUO3RTL.cjs +0 -113
  260. package/dist/chunk-ONZFBJVW.js +0 -14
  261. package/dist/chunk-PFXCTE37.js +0 -28
  262. package/dist/chunk-PPST7QAQ.js +0 -587
  263. package/dist/chunk-Q5IMYDFL.cjs +0 -33
  264. package/dist/chunk-QFFBIOJ4.js +0 -31
  265. package/dist/chunk-QNKGP5DY.js +0 -14
  266. package/dist/chunk-RRQHMOPE.cjs +0 -19
  267. package/dist/chunk-RU5OSRBU.js +0 -95
  268. package/dist/chunk-SDMPEJ4F.js +0 -35
  269. package/dist/chunk-SYNL5IKP.js +0 -115
  270. package/dist/chunk-TCDOWZQE.js +0 -16
  271. package/dist/chunk-TQPGXGKB.cjs +0 -123
  272. package/dist/chunk-TULOI4GL.js +0 -370
  273. package/dist/chunk-UBHCP4N5.cjs +0 -36
  274. package/dist/chunk-UCHF3M34.cjs +0 -56
  275. package/dist/chunk-UDA26MCU.cjs +0 -16
  276. package/dist/chunk-V3C4FYZL.cjs +0 -18
  277. package/dist/chunk-VAAHZFBF.js +0 -32
  278. package/dist/chunk-VJDDGRIK.cjs +0 -16
  279. package/dist/chunk-WVSPXFTY.js +0 -14
  280. package/dist/chunk-WYP76WXB.js +0 -101
  281. package/dist/chunk-YDE4ZBB7.cjs +0 -237
  282. package/dist/chunk-YKQEOO7C.cjs +0 -23
  283. package/dist/chunk-YSZC56SZ.js +0 -264
  284. package/dist/chunk-YWHHVDT4.js +0 -13
  285. package/dist/index.d.ts +0 -24
  286. package/dist/isPlainObject-DTJVV2Kf.d.ts +0 -536
@@ -1,219 +1,124 @@
1
1
  /*!
2
- * ====================================================
3
- * Rzl Utils-JS.
4
- * ----------------------------------------------------
5
- * Version: 3.12.0.
6
- * Author: Rizalvin Dwiky.
7
- * Repository: https://github.com/rzl-zone/utils-js.
8
- * ====================================================
9
- */
10
- import { normalizePathname, formatEnvPort } from '../chunk-2CYDJVGM.js';
11
- import '../chunk-BXW7YXB7.js';
12
- import '../chunk-44XX2P34.js';
13
- import { removeSpaces } from '../chunk-HHYWB7VZ.js';
14
- import { isEmptyString } from '../chunk-TCDOWZQE.js';
15
- import { assertIsString } from '../chunk-BKIJBNIE.js';
16
- import { safeStableStringify } from '../chunk-6VUXD3CF.js';
17
- import '../chunk-QNKGP5DY.js';
18
- import { isString, getPreciseType, assertIsPlainObject, isNil, isNonEmptyArray, isNonEmptyString, isPlainObject, isUndefined, assertIsBoolean, isError, hasOwnProp } from '../chunk-CSG4SCL3.js';
19
-
2
+ * ========================================================================
3
+ * @rzl-zone/utils-js
4
+ * ------------------------------------------------------------------------
5
+ * Version: `3.12.1-beta.1`
6
+ * Author: `Rizalvin Dwiky <rizalvindwiky@gmail.com>`
7
+ * Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/utils-js`
8
+ * ========================================================================
9
+ */
10
+ import { A as isPlainObject, N as isNil, S as isUndefined, T as assertIsPlainObject, b as hasOwnProp, k as isString, p as isNonEmptyArray, r as getPreciseType, t as assertIsBoolean, v as isError, y as isNonEmptyString } from "../assertIsBoolean-DR1SaXPD.js";
11
+ import { t as assertIsString } from "../assertIsString-CEB07_83.js";
12
+ import { t as safeStableStringify } from "../safeStableStringify-CXOZ9Ub8.js";
13
+ import { t as isEmptyString } from "../isEmptyString-BXzKAC2j.js";
14
+ import { t as removeSpaces } from "../removeSpaces-Bmc5DX4F.js";
15
+ import { n as normalizePathname, t as formatEnvPort } from "../formatEnvPort-ByFVLjSV.js";
20
16
  function generateRoute(route, params) {
21
- if (!isString(route) || isEmptyString(route)) {
22
- throw new TypeError(
23
- `\u274C 'generateRoute' Failed:
24
- - Invalid 'route' value.
25
- - Must be of type \`string\` and non-empty string, but received: "${getPreciseType(
26
- route
27
- )}": \`${safeStableStringify(route, {
28
- keepUndefined: true
29
- })}\`.`
30
- );
31
- }
32
- if (!/[\\[\]]/.test(route)) {
33
- return route;
34
- }
35
- assertIsPlainObject(params, {
36
- message: ({ validType }) => `\u274C 'generateRoute' Failed cause in route "${route}":
37
- - Missing or invalid parameters \`${validType}\` for route: "${route}", must be of type \`${validType}\` mapping parameters.`
38
- });
39
- if (isNil(params)) {
40
- throw new TypeError(
41
- `\u274C 'generateRoute' Failed cause in route "${route}":
42
- - Missing parameters \`plain-object\` for route: "${route}".`
43
- );
44
- }
45
- const invalidChars = [
46
- "?",
47
- "&",
48
- "#",
49
- "=",
50
- "/",
51
- // "`",
52
- // " ",
53
- // ".",
54
- "'",
55
- '"',
56
- "(",
57
- ")",
58
- "+",
59
- ";",
60
- "%",
61
- "@",
62
- ":"
63
- ];
64
- const errors = [];
65
- const requiredKeys = Array.from(route.matchAll(/\[(\w+)\]/g)).map((m) => m[1]);
66
- for (const key of requiredKeys) {
67
- const value = params[key];
68
- if (!isString(value)) {
69
- errors.push(
70
- `- Invalid parameter: "${key}" must be of type \`string\`, but received: \`${getPreciseType(
71
- value
72
- )}\`.`
73
- );
74
- continue;
75
- }
76
- if (isEmptyString(value)) {
77
- errors.push(`- Parameter "${key}" cannot be empty string.`);
78
- continue;
79
- }
80
- const foundInvalidChars = invalidChars.filter((char) => value.includes(char));
81
- if (/\s/.test(value)) {
82
- foundInvalidChars.push("white-space(s)");
83
- }
84
- if (foundInvalidChars.length > 0) {
85
- const formattedChars = foundInvalidChars.map(
86
- (c) => c === "`" ? "backtick - (`)" : `\`${c}\``
87
- );
88
- if (!invalidChars.includes("white-space(s)")) invalidChars.push("white-space(s)");
89
- const formattedInvalidChars = invalidChars.map(
90
- (c) => c === "`" ? "backtick - (`)" : `\`${c}\``
91
- );
92
- errors.push(
93
- `- Parameter "${key}" contains invalid characters (${formattedChars.join(
94
- ", "
95
- )}). These characters are not allowed because they could cause issues in URL structure. The following characters are forbidden in route parameters: (${formattedInvalidChars.join(
96
- ", "
97
- )}).`
98
- );
99
- }
100
- }
101
- if (isNonEmptyArray(errors)) {
102
- throw new Error(
103
- `\u274C 'generateRoute' Failed cause in route "${route}":
104
- ${errors.join("\n")}.`
105
- );
106
- }
107
- return route.replace(/\[(\w+)\]/g, (_, key) => {
108
- const paramKey = isNonEmptyString(params[key]) ? params[key] : "";
109
- return paramKey.trim().replace(/^\/+|\/+$/g, "");
110
- }).replace(/\/+/g, "/");
17
+ if (!isString(route) || isEmptyString(route)) throw new TypeError(`❌ 'generateRoute' Failed:\n- Invalid 'route' value.\n- Must be of type \`string\` and non-empty string, but received: "${getPreciseType(route)}": \`${safeStableStringify(route, { keepUndefined: true })}\`.`);
18
+ if (!/[\\[\]]/.test(route)) return route;
19
+ assertIsPlainObject(params, { message: ({ validType }) => `❌ 'generateRoute' Failed cause in route "${route}":\n- Missing or invalid parameters \`${validType}\` for route: "${route}", must be of type \`${validType}\` mapping parameters.` });
20
+ if (isNil(params)) throw new TypeError(`❌ 'generateRoute' Failed cause in route "${route}":\n- Missing parameters \`plain-object\` for route: "${route}".`);
21
+ const invalidChars = [
22
+ "?",
23
+ "&",
24
+ "#",
25
+ "=",
26
+ "/",
27
+ "'",
28
+ "\"",
29
+ "(",
30
+ ")",
31
+ "+",
32
+ ";",
33
+ "%",
34
+ "@",
35
+ ":"
36
+ ];
37
+ const errors = [];
38
+ const requiredKeys = Array.from(route.matchAll(/\[(\w+)\]/g)).map((m) => m[1] || "");
39
+ for (const key of requiredKeys) {
40
+ const value = params[key];
41
+ if (!isString(value)) {
42
+ errors.push(`- Invalid parameter: "${key}" must be of type \`string\`, but received: \`${getPreciseType(value)}\`.`);
43
+ continue;
44
+ }
45
+ if (isEmptyString(value)) {
46
+ errors.push(`- Parameter "${key}" cannot be empty string.`);
47
+ continue;
48
+ }
49
+ const foundInvalidChars = invalidChars.filter((char) => value.includes(char));
50
+ if (/\s/.test(value)) foundInvalidChars.push("white-space(s)");
51
+ if (foundInvalidChars.length > 0) {
52
+ const formattedChars = foundInvalidChars.map((c) => c === "`" ? "backtick - (`)" : `\`${c}\``);
53
+ if (!invalidChars.includes("white-space(s)")) invalidChars.push("white-space(s)");
54
+ const formattedInvalidChars = invalidChars.map((c) => c === "`" ? "backtick - (`)" : `\`${c}\``);
55
+ errors.push(`- Parameter "${key}" contains invalid characters (${formattedChars.join(", ")}). These characters are not allowed because they could cause issues in URL structure. The following characters are forbidden in route parameters: (${formattedInvalidChars.join(", ")}).`);
56
+ }
57
+ }
58
+ if (isNonEmptyArray(errors)) throw new Error(`❌ 'generateRoute' Failed cause in route "${route}":\n${errors.join("\n")}.`);
59
+ return route.replace(/\[(\w+)\]/g, (_, key) => {
60
+ return (isNonEmptyString(params[key]) ? params[key] : "").trim().replace(/^\/+|\/+$/g, "");
61
+ }).replace(/\/+/g, "/");
111
62
  }
112
-
113
- var createBeApiUrl = (pathname, options = {}) => {
114
- try {
115
- let joinPath2 = function(a, b) {
116
- return `${a.replace(/\/+$/, "")}/${b.replace(/^\/+/, "")}`;
117
- };
118
- var joinPath = joinPath2;
119
- assertIsString(isNil(pathname) ? "" : pathname, {
120
- message({ currentType, validType }) {
121
- return `First parameter (\`pathname\`) must be of type \`${validType}\`, but received: \`${currentType}\`.`;
122
- }
123
- });
124
- if (!isPlainObject(options)) {
125
- options = {};
126
- }
127
- let {
128
- prefix = "/api",
129
- withOrigin = true
130
- } = options;
131
- if (!isUndefined(prefix) && !isString(prefix)) {
132
- throw new TypeError(
133
- `Parameter \`prefix\` property of the \`options\` (second parameter) must be of type \`string\`, but received: \`${getPreciseType(
134
- prefix
135
- )}\`.`
136
- );
137
- }
138
- assertIsBoolean(withOrigin, {
139
- message: ({ currentType, validType }) => `Parameter \`withOrigin\` property of the \`options\` (second parameter) must be of type \`${validType}\`, but received: \`${currentType}\`.`
140
- });
141
- pathname = normalizePathname(pathname);
142
- prefix = normalizePathname(prefix);
143
- const normalizedPrefix = prefix.endsWith("/") ? prefix : prefix + "/";
144
- if (pathname === prefix || pathname === prefix + "/" || pathname.startsWith(normalizedPrefix)) {
145
- pathname = pathname.slice(prefix.length);
146
- pathname = normalizePathname(pathname);
147
- }
148
- const baseApiUrl = getBeApiUrl({ suffix: prefix });
149
- const fullPath = withOrigin ? joinPath2(baseApiUrl, pathname) : joinPath2(new URL(baseApiUrl).pathname, pathname);
150
- return fullPath.replace(/\/+$/, "");
151
- } catch (err) {
152
- if (isError(err)) {
153
- throw err;
154
- } else {
155
- throw new Error(
156
- "Failed to generate backend API URL in `createBeApiUrl()`, Error: " + String(err).trim(),
157
- { cause: err }
158
- );
159
- }
160
- }
63
+ const createBeApiUrl = (pathname, options = {}) => {
64
+ try {
65
+ assertIsString(isNil(pathname) ? "" : pathname, { message({ currentType, validType }) {
66
+ return `First parameter (\`pathname\`) must be of type \`${validType}\`, but received: \`${currentType}\`.`;
67
+ } });
68
+ if (!isPlainObject(options)) options = {};
69
+ let { prefix = "/api", withOrigin = true } = options;
70
+ if (!isUndefined(prefix) && !isString(prefix)) throw new TypeError(`Parameter \`prefix\` property of the \`options\` (second parameter) must be of type \`string\`, but received: \`${getPreciseType(prefix)}\`.`);
71
+ assertIsBoolean(withOrigin, { message: ({ currentType, validType }) => `Parameter \`withOrigin\` property of the \`options\` (second parameter) must be of type \`${validType}\`, but received: \`${currentType}\`.` });
72
+ pathname = normalizePathname(pathname);
73
+ prefix = normalizePathname(prefix);
74
+ const normalizedPrefix = prefix.endsWith("/") ? prefix : prefix + "/";
75
+ if (pathname === prefix || pathname === prefix + "/" || pathname.startsWith(normalizedPrefix)) {
76
+ pathname = pathname.slice(prefix.length);
77
+ pathname = normalizePathname(pathname);
78
+ }
79
+ const baseApiUrl = getBeApiUrl({ suffix: prefix });
80
+ function joinPath(a, b) {
81
+ return `${a.replace(/\/+$/, "")}/${b.replace(/^\/+/, "")}`;
82
+ }
83
+ return (withOrigin ? joinPath(baseApiUrl, pathname) : joinPath(new URL(baseApiUrl).pathname, pathname)).replace(/\/+$/, "");
84
+ } catch (err) {
85
+ if (isError(err)) throw err;
86
+ else throw new Error("Failed to generate backend API URL in `createBeApiUrl()`, Error: " + String(err).trim(), { cause: err });
87
+ }
161
88
  };
162
-
163
- var getBeApiUrl = (options = {}) => {
164
- if (!isPlainObject(options)) options = {};
165
- let suffix = hasOwnProp(options, "suffix") ? options.suffix : "/";
166
- assertIsString(suffix, {
167
- message({ currentType, validType }) {
168
- return `Parameter \`suffix\` property of the first parameter must be of type \`${validType}\`, but received: \`${currentType}\`.`;
169
- }
170
- });
171
- try {
172
- let rawBaseUrl = process.env.NEXT_PUBLIC_BACKEND_API_URL?.trim();
173
- if (rawBaseUrl) {
174
- rawBaseUrl = removeSpaces(rawBaseUrl);
175
- const urlObj = new URL(rawBaseUrl);
176
- const hasPort = !!urlObj.port;
177
- if (!hasPort && process.env.NEXT_PUBLIC_PORT_BE) {
178
- rawBaseUrl = urlObj.origin + formatEnvPort(process.env.NEXT_PUBLIC_PORT_BE, {
179
- prefixColon: true
180
- });
181
- }
182
- } else {
183
- rawBaseUrl = "http://localhost" + formatEnvPort(process.env.NEXT_PUBLIC_PORT_BE || "8000", {
184
- prefixColon: true
185
- });
186
- }
187
- suffix = removeSpaces(suffix).length ? removeSpaces(suffix) : "/";
188
- const baseApiUrl = new URL(rawBaseUrl.replace(/\/+$/, "")).origin;
189
- const finalSuffix = suffix === "/" ? "/" : `${suffix.startsWith("/") ? "" : "/"}${suffix.replace(/\/+$/, "")}`;
190
- return `${baseApiUrl}${finalSuffix}`;
191
- } catch (error) {
192
- throw new Error(
193
- "Invalid `NEXT_PUBLIC_BACKEND_API_URL`, failed to generate from `getBeApiUrl()`, Error:" + error
194
- );
195
- }
89
+ const getBeApiUrl = (options = {}) => {
90
+ if (!isPlainObject(options)) options = {};
91
+ let suffix = hasOwnProp(options, "suffix") ? options.suffix : "/";
92
+ assertIsString(suffix, { message({ currentType, validType }) {
93
+ return `Parameter \`suffix\` property of the first parameter must be of type \`${validType}\`, but received: \`${currentType}\`.`;
94
+ } });
95
+ try {
96
+ let rawBaseUrl = process.env.NEXT_PUBLIC_BACKEND_API_URL?.trim();
97
+ if (rawBaseUrl) {
98
+ rawBaseUrl = removeSpaces(rawBaseUrl);
99
+ const urlObj = new URL(rawBaseUrl);
100
+ if (!!!urlObj.port && process.env.NEXT_PUBLIC_PORT_BE) rawBaseUrl = urlObj.origin + formatEnvPort(process.env.NEXT_PUBLIC_PORT_BE, { prefixColon: true });
101
+ } else rawBaseUrl = "http://localhost" + formatEnvPort(process.env.NEXT_PUBLIC_PORT_BE || "8000", { prefixColon: true });
102
+ suffix = removeSpaces(suffix).length ? removeSpaces(suffix) : "/";
103
+ return `${new URL(rawBaseUrl.replace(/\/+$/, "")).origin}${suffix === "/" ? "/" : `${suffix.startsWith("/") ? "" : "/"}${suffix.replace(/\/+$/, "")}`}`;
104
+ } catch (error) {
105
+ throw new Error("Invalid `NEXT_PUBLIC_BACKEND_API_URL`, failed to generate from `getBeApiUrl()`, Error:" + error, { cause: error });
106
+ }
196
107
  };
197
-
198
- var getBaseUrl = () => {
199
- try {
200
- const baseEnv = process.env.NEXT_PUBLIC_BASE_URL?.trim();
201
- const portEnv = process.env.NEXT_PUBLIC_PORT_FE?.trim();
202
- let baseUrl = baseEnv || "http://localhost";
203
- baseUrl = removeSpaces(baseUrl).replace(/\/+$/, "");
204
- const hasPort = /:\/\/[^/]+:\d+/.test(baseUrl);
205
- if (!hasPort && portEnv) {
206
- baseUrl += formatEnvPort(portEnv, { prefixColon: true });
207
- } else if (!hasPort && !baseEnv) {
208
- baseUrl += ":3000";
209
- }
210
- const url = new URL(baseUrl);
211
- return `${url.protocol}//${url.hostname}${url.port ? `:${url.port}` : ""}`;
212
- } catch (error) {
213
- throw new Error(
214
- "Invalid `NEXT_PUBLIC_BASE_URL`, failed to generate from `getBaseUrl()`, Error:" + error
215
- );
216
- }
108
+ const getBaseUrl = () => {
109
+ try {
110
+ const baseEnv = process.env.NEXT_PUBLIC_BASE_URL?.trim();
111
+ const portEnv = process.env.NEXT_PUBLIC_PORT_FE?.trim();
112
+ let baseUrl = baseEnv || "http://localhost";
113
+ baseUrl = removeSpaces(baseUrl).replace(/\/+$/, "");
114
+ const hasPort = /:\/\/[^/]+:\d+/.test(baseUrl);
115
+ if (!hasPort && portEnv) baseUrl += formatEnvPort(portEnv, { prefixColon: true });
116
+ else if (!hasPort && !baseEnv) baseUrl += ":3000";
117
+ const url = new URL(baseUrl);
118
+ return `${url.protocol}//${url.hostname}${url.port ? `:${url.port}` : ""}`;
119
+ } catch (error) {
120
+ throw new Error("Invalid `NEXT_PUBLIC_BASE_URL`, failed to generate from `getBaseUrl()`, Error:" + error, { cause: error });
121
+ }
217
122
  };
218
-
219
123
  export { createBeApiUrl, generateRoute, getBaseUrl, getBeApiUrl };
124
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","names":[],"sources":["../../src/next/generateRoute.ts","../../src/next/createBeApiUrl.ts","../../src/next/getBeApiUrl.ts","../../src/next/getBaseUrl.ts"],"sourcesContent":["import type { IsAny } from \"@rzl-zone/ts-types-plus\";\n\nimport { isNil } from \"@/predicates/is/isNil\";\nimport { isString } from \"@/predicates/is/isString\";\nimport { isEmptyString } from \"@/predicates/is/isEmptyString\";\nimport { isNonEmptyArray } from \"@/predicates/is/isNonEmptyArray\";\nimport { getPreciseType } from \"@/predicates/type/getPreciseType\";\nimport { isNonEmptyString } from \"@/predicates/is/isNonEmptyString\";\nimport { assertIsPlainObject } from \"@/assertions/objects/assertIsPlainObject\";\nimport { safeStableStringify } from \"@/conversions/stringify/safeStableStringify\";\n\n/** ---------------------------------------------------------\n * * ***Extracts dynamic route parameters from a given route string.***\n * ---------------------------------------------------------\n * **This utility type recursively searches for dynamic segments within a route,\n * extracting each parameter and constructing an object where each key represents\n * a dynamic segment and its value is of type `string`.**\n * - ***⚠️ Warning:***\n * - ***This types only support when using ***[`NextJS`](https://nextjs.org/)***.***\n * @template T - The route string containing potential dynamic segments.\n * @example\n * ```ts\n * type Params1 = ExtractRouteParams<\"/user/[id]\">;\n * // ➔ { id: string }\n * type Params2 = ExtractRouteParams<\"/post/[slug]/comment/[commentId]\">;\n * // ➔ { slug: string; commentId: string }\n * type Params3 = ExtractRouteParams<\"/dashboard\">;\n * // ➔ {} (no dynamic parameters)\n * ```\n */\nexport type ExtractRouteParams<T> = T extends string\n ? HasDynamicSegments<T> extends true\n ? T extends `${infer _Start}[${infer Param}]${infer Rest}`\n ? { [K in Param | keyof ExtractRouteParams<Rest>]: string }\n : unknown\n : unknown\n : unknown; // Ensures an empty object if no dynamic segments are found.\n\n/** ---------------------------------------------------------\n * * ***Determines whether a given route contains dynamic segments.***\n * ---------------------------------------------------------\n * **This type checks if the route includes at least one `[param]` pattern.\n * If it does, the result is `true`, otherwise `false`.**\n * - ***⚠️ Warning:***\n * - ***This types only support when using ***[`NextJS`](https://nextjs.org/)***.***\n * @template T - The route string to be evaluated.\n * @example\n * ```ts\n * type HasParams1 = HasDynamicSegments<\"/user/[id]\">;\n * // ➔ true\n * type HasParams2 = HasDynamicSegments<\"/settings/profile\">;\n * // ➔ false\n * type HasParams3 = HasDynamicSegments<\"/blog/[category]/[slug]\">;\n * // ➔ true\n * ```\n */\nexport type HasDynamicSegments<T> = T extends `${string}[${string}]${string}`\n ? true\n : false;\n\ntype GenerateRouteResult<T> =\n true extends IsAny<T> ? unknown : T extends string ? string : unknown;\n\n/** ---------------------------------\n * * ***Utility for NextJS: `generateRoute`.***\n * ---------------------------------\n * **Generates a URL by replacing dynamic route parameters with provided values.**\n * - ***⚠️ Warning:***\n * - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***\n * @template T - The route string containing dynamic segments in the format `[param]`.\n * @param {T} route - The route string containing dynamic segments.\n * @param {ExtractRouteParams<T>} [params] - An object containing key-value pairs that match the dynamic segments in the route.\n * @returns {string} The formatted URL with all dynamic segments replaced.\n * @throws **{@link Error | `Error`}** if the route contains dynamic segments but no parameters object is provided.\n * @throws **{@link Error | `Error`}** if a required parameter is missing from the `params` object.\n * @throws **{@link Error | `Error`}** if a parameter value is an empty string.\n * @throws **{@link Error | `Error`}** if any parameter contains invalid characters like `?`, `&`, `=`, `#`, `/`, spaces, `'`, `\"`, `(`, `)`, `+`, `;`, `%`, `@`, or `:`, which can cause URL issues.\n * @example\n * // Basic usage\n * generateRoute(\"/user/[id]\", { id: \"123\" });\n * // ➔ \"/user/123\"\n *\n * // No dynamic segments, returns as-is\n * generateRoute(\"/dashboard\");\n * // ➔ \"/dashboard\"\n *\n * // Throws an error due to missing parameters object\n * generateRoute(\"/profile/[username]\");\n * // ➔ ❌ Error: ❌ Missing parameters object for route: \"/profile/[username]\"\n *\n * // Throws an error due to an empty parameter value\n * generateRoute(\"/post/[category]/[slug]\", { category: \"tech\", slug: \"\" });\n * // ➔ ❌ Error: ❌ Parameter \"slug\" cannot be empty in route: \"/post/[category]/[slug]\"\n *\n * // Throws an error due to parameter containing invalid characters\n * generateRoute(\"/search/[query]\", { query: \"how to?learn\" });\n * // ➔ ❌ Error: ❌ Parameter \"query\" contains invalid character \"?\" in route: \"/search/[query]\"\n *\n * // Handles leading/trailing slashes correctly\n * generateRoute(\"/blog/[category]/[slug]\", { category: \"/news/\", slug: \"/latest-update/\" });\n * // ➔ ❌ Error: ❌ Parameter \"category\" and \"slug\" contains slashes \"/\" which is not allowed.\n */\nexport function generateRoute<T extends string>(\n route: T extends string\n ? HasDynamicSegments<T> extends true\n ? T\n : never\n : never,\n params: T extends string ? ExtractRouteParams<T> : undefined\n): GenerateRouteResult<T>;\nexport function generateRoute<T extends string>(\n route: T extends string ? T : never,\n params?: Extract<ExtractRouteParams<T>, Record<string, unknown>>\n): GenerateRouteResult<T>;\nexport function generateRoute<T = unknown>(\n route: T extends string\n ? HasDynamicSegments<T> extends true\n ? T\n : unknown\n : unknown,\n params?: T extends string ? ExtractRouteParams<T> : undefined\n): unknown;\nexport function generateRoute<T>(\n route: T,\n params?: ExtractRouteParams<T>\n): string | unknown {\n //todo: Validate the route string\n if (!isString(route) || isEmptyString(route)) {\n throw new TypeError(\n `❌ 'generateRoute' Failed:\\n- Invalid 'route' value.\\n- Must be of type \\`string\\` and non-empty string, but received: \"${getPreciseType(\n route\n )}\": \\`${safeStableStringify(route, {\n keepUndefined: true\n })}\\`.`\n );\n }\n\n //todo: If no dynamic segments exist, return the route as-is immediately\n if (!/[\\\\[\\]]/.test(route)) {\n return route;\n }\n\n //todo: Validate that params is a plain object\n assertIsPlainObject(params, {\n message: ({ validType }) =>\n `❌ 'generateRoute' Failed cause in route \"${route}\":\\n- Missing or invalid parameters \\`${validType}\\` for route: \"${route}\", must be of type \\`${validType}\\` mapping parameters.`\n });\n\n //todo: Ensure parameters are provided for dynamic routes.\n if (isNil(params)) {\n throw new TypeError(\n `❌ 'generateRoute' Failed cause in route \"${route}\":\\n- Missing parameters \\`plain-object\\` for route: \"${route}\".`\n );\n }\n\n //todo: Check for invalid characters that can break the URL format\n const invalidChars = [\n \"?\",\n \"&\",\n \"#\",\n \"=\",\n \"/\",\n \"'\",\n // eslint-disable-next-line quotes\n '\"',\n \"(\",\n \")\",\n \"+\",\n \";\",\n \"%\",\n \"@\",\n \":\"\n ];\n\n const errors: string[] = [];\n\n const requiredKeys = Array.from(route.matchAll(/\\[(\\w+)\\]/g)).map(\n (m) => m[1] || \"\"\n );\n\n for (const key of requiredKeys) {\n const value = params[key];\n\n if (!isString(value)) {\n errors.push(\n `- Invalid parameter: \"${key}\" must be of type \\`string\\`, but received: \\`${getPreciseType(\n value\n )}\\`.`\n );\n continue;\n }\n\n if (isEmptyString(value)) {\n errors.push(`- Parameter \"${key}\" cannot be empty string.`);\n continue;\n }\n\n const foundInvalidChars = invalidChars.filter((char) =>\n value.includes(char)\n );\n\n if (/\\s/.test(value)) {\n foundInvalidChars.push(\"white-space(s)\");\n }\n\n if (foundInvalidChars.length > 0) {\n const formattedChars = foundInvalidChars.map((c) =>\n c === \"`\" ? \"backtick - (`)\" : `\\`${c}\\``\n );\n\n if (!invalidChars.includes(\"white-space(s)\"))\n invalidChars.push(\"white-space(s)\");\n\n const formattedInvalidChars = invalidChars.map((c) =>\n c === \"`\" ? \"backtick - (`)\" : `\\`${c}\\``\n );\n\n errors.push(\n `- Parameter \"${key}\" contains invalid characters (${formattedChars.join(\n \", \"\n )}). These characters are not allowed because they could cause issues in URL structure. The following characters are forbidden in route parameters: (${formattedInvalidChars.join(\n \", \"\n )}).`\n );\n }\n }\n\n if (isNonEmptyArray(errors)) {\n throw new Error(\n `❌ 'generateRoute' Failed cause in route \"${route}\":\\n${errors.join(\"\\n\")}.`\n );\n }\n\n return route\n .replace(/\\[(\\w+)\\]/g, (_, key) => {\n const paramKey = isNonEmptyString(params[key]) ? params[key] : \"\";\n\n return paramKey.trim().replace(/^\\/+|\\/+$/g, \"\");\n })\n .replace(/\\/+/g, \"/\");\n}\n","import { getBeApiUrl } from \"@/next\";\nimport { normalizePathname } from \"@/urls/pathname/normalizePathname\";\n\nimport { isNil } from \"@/predicates/is/isNil\";\nimport { isError } from \"@/predicates/is/isError\";\nimport { isString } from \"@/predicates/is/isString\";\nimport { isUndefined } from \"@/predicates/is/isUndefined\";\nimport { isPlainObject } from \"@/predicates/is/isPlainObject\";\nimport { getPreciseType } from \"@/predicates/type/getPreciseType\";\nimport { assertIsString } from \"@/assertions/strings/assertIsString\";\nimport { assertIsBoolean } from \"@/assertions/booleans/assertIsBoolean\";\n\ntype OptionsCreateBeApiUrl = {\n /** * The prefix pathname api url, e.g:`\"http://localhost.com/your-target-prefix-entri-point-api-is-here\"`, default: `\"/api\"`.\n *\n * @default \"/api\" */\n prefix?: string;\n /** * Option to getting `prefix` and `pathname` of api url only `(removing origin base api url)`, default: `true`.\n *\n * @default true */\n withOrigin?: boolean;\n};\n\n/** ---------------------------------\n * * ***Utility for NextJS: `createBeApiUrl`.***\n * ---------------------------------\n * **Constructs a backend API URL by appending a given pathname to the base API URL.**\n * - **ℹ️ Note:**\n * - This function builds on top of `getBeApiUrl()`.\n * - **Determines the base API URL from:**\n * - `NEXT_PUBLIC_BACKEND_API_URL` environment variable (or defaults to `\"http://localhost:8000\"`).\n * - Automatically appends `NEXT_PUBLIC_PORT_BE` if the base URL does not already include a port.\n * - **Features of this function:**\n * - Allows customizing the API path with an optional `prefix` (defaults to `\"/api\"`).\n * - Can include or exclude the origin (protocol + host) via `withOrigin`.\n * - Normalizes paths to avoid duplicate slashes.\n * - ***⚠️ Warning:***\n * - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***\n * @param {string|null|undefined} pathname - The API endpoint path (e.g., `/users` or `/v1/posts`), defaultValue: `\"\"`.\n * @param {OptionsCreateBeApiUrl} [options] - Configuration options.\n * @param {OptionsCreateBeApiUrl[\"prefix\"]} [options.prefix=\"/api\"] - The prefix for the API path (default is `\"/api\"`).\n * @param {OptionsCreateBeApiUrl[\"withOrigin\"]} [options.withOrigin=true] - Whether to include the full base URL or return only the API path.\n * @returns {string} The formatted API URL.\n * @throws **{@link TypeError | `TypeError`}** if `withOrigin` is not a boolean.\n * @throws **{@link TypeError | `TypeError`}** if `prefix` and `pathname` is not a string.\n * @throws **{@link Error | `Error`}** if constructing the API URL fails due to an invalid base URL.\n * @example\n * createBeApiUrl(\"/users\")\n * // ➔ \"http://localhost:8000/api/users\"\n * createBeApiUrl(\"/api/users\")\n * // ➔ \"http://localhost:8000/api/users\"\n * createBeApiUrl(\"/v1\", { prefix: \"/v1\" })\n * // ➔ \"http://localhost:8000/v1\"\n * createBeApiUrl(\"/v1/users\")\n * // ➔ \"http://localhost:8000/api/v1/users\"\n * createBeApiUrl(\"/v1/users\", { prefix: \"/v1\" })\n * // ➔ \"http://localhost:8000/v1/users\"\n * createBeApiUrl(\"/users\", { withOrigin: false })\n * // ➔ \"/api/users\"\n * createBeApiUrl(null, { withOrigin: false })\n * // ➔ \"/api\"\n * createBeApiUrl(undefined, { withOrigin: false })\n * // ➔ \"/api\"\n */\nexport const createBeApiUrl = (\n /** * The pathname api url, e.g:`\"http://localhost.com/your-target-prefix-entri-point-api-is-here/your-target-pathname-is-here\"`.\n *\n * @default \"\"\n */\n pathname: string | null | undefined,\n options: OptionsCreateBeApiUrl = {}\n): string => {\n try {\n // ✅ Type checks\n assertIsString(isNil(pathname) ? \"\" : pathname, {\n message({ currentType, validType }) {\n return `First parameter (\\`pathname\\`) must be of type \\`${validType}\\`, but received: \\`${currentType}\\`.`;\n }\n });\n\n if (!isPlainObject(options)) {\n options = {};\n }\n\n let { prefix = \"/api\", withOrigin = true } = options;\n\n if (!isUndefined(prefix) && !isString(prefix)) {\n throw new TypeError(\n `Parameter \\`prefix\\` property of the \\`options\\` (second parameter) must be of type \\`string\\`, but received: \\`${getPreciseType(\n prefix\n )}\\`.`\n );\n }\n\n assertIsBoolean(withOrigin, {\n message: ({ currentType, validType }) =>\n `Parameter \\`withOrigin\\` property of the \\`options\\` (second parameter) must be of type \\`${validType}\\`, but received: \\`${currentType}\\`.`\n });\n\n // Normalize pathname\n pathname = normalizePathname(pathname);\n // Normalize prefix\n prefix = normalizePathname(prefix);\n\n const normalizedPrefix = prefix.endsWith(\"/\") ? prefix : prefix + \"/\";\n\n // Remove duplicate prefix in pathname\n if (\n pathname === prefix ||\n pathname === prefix + \"/\" ||\n pathname.startsWith(normalizedPrefix)\n ) {\n pathname = pathname.slice(prefix.length);\n pathname = normalizePathname(pathname);\n }\n\n // Get the base API URL\n const baseApiUrl = getBeApiUrl({ suffix: prefix });\n\n function joinPath(a: string, b: string) {\n return `${a.replace(/\\/+$/, \"\")}/${b.replace(/^\\/+/, \"\")}`;\n }\n\n const fullPath = withOrigin\n ? joinPath(baseApiUrl, pathname)\n : joinPath(new URL(baseApiUrl).pathname, pathname);\n\n return fullPath.replace(/\\/+$/, \"\");\n } catch (err) {\n if (isError(err)) {\n throw err;\n } else {\n throw new Error(\n \"Failed to generate backend API URL in `createBeApiUrl()`, Error: \" +\n String(err).trim(),\n { cause: err }\n );\n }\n }\n};\n","import { formatEnvPort } from \"@/urls/utils/formatEnvPort\";\nimport { hasOwnProp } from \"@/predicates/has/hasOwnProp\";\nimport { isPlainObject } from \"@/predicates/is/isPlainObject\";\nimport { removeSpaces } from \"@/strings/sanitizations/removeSpaces\";\nimport { assertIsString } from \"@/assertions/strings/assertIsString\";\n\ntype OptionsGetBeApiUrl = {\n /** * ***The Suffix origin base api url, e.g:`http://localhost.com/api`, default: `\"/\"`.***\n *\n * @default \"/\" */\n suffix?: string;\n};\n\n/** ---------------------------------------------------\n * * ***Utility for NextJS: `getBeApiUrl`.***\n * ---------------------------------------------------\n * **This function determines the backend API base URL from the `NEXT_PUBLIC_BACKEND_API_URL` environment variable (retrieves the base API URL of the backend).**\n * - **Behavior:**\n * - If the variable is not set, it defaults to `\"http://localhost:8000\"`.\n * - It also allows adding an optional suffix to the returned URL.\n * - ***⚠️ Warning:***\n * - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***\n * @description\n * This function determines the backend API base URL from the `NEXT_PUBLIC_BACKEND_API_URL` environment variable.\n * - If `NEXT_PUBLIC_BACKEND_API_URL` is not set, it defaults to `\"http://localhost:8000\"`.\n * - If `NEXT_PUBLIC_BACKEND_API_URL` does **not** contain a port, it appends one from `NEXT_PUBLIC_PORT_BE` if available.\n * - Supports appending optional suffix (like `\"/api\"`).\n * @param {OptionsGetBeApiUrl|undefined} options - Configuration options.\n * @param {OptionsGetBeApiUrl[\"suffix\"]} [options.suffix=\"/\"] - The suffix to append to the base API URL.\n * @returns {string} The formatted backend API base URL.\n * @throws **{@link TypeError | `TypeError`}** if `suffix` is not a `string`.\n * @throws **{@link Error | `Error`}** if `NEXT_PUBLIC_BACKEND_API_URL` is invalid.\n * @example\n * // With NEXT_PUBLIC_BACKEND_API_URL set at `*.env` file\n * NEXT_PUBLIC_BACKEND_API_URL = \"https://api.example.com\";\n * getBeApiUrl();\n * // ➔ \"https://api.example.com/\"\n *\n * // With NEXT_PUBLIC_BACKEND_API_URL but no port, using NEXT_PUBLIC_PORT_BE at `*.env` file\n * NEXT_PUBLIC_BACKEND_API_URL = \"http://localhost\";\n * NEXT_PUBLIC_PORT_BE = \"5000\";\n * getBeApiUrl({ suffix: \"/api\" });\n * // ➔ \"http://localhost:5000/api\"\n *\n * // Without NEXT_PUBLIC_BACKEND_API_URL at `*.env` file (defaults to localhost:8000)\n * delete NEXT_PUBLIC_BACKEND_API_URL;\n * getBeApiUrl({ suffix: \"/v1\" });\n * // ➔ \"http://localhost:8000/v1\"\n */\nexport const getBeApiUrl = (options: OptionsGetBeApiUrl = {}): string => {\n if (!isPlainObject(options)) options = {};\n\n let suffix = hasOwnProp(options, \"suffix\") ? options.suffix : \"/\";\n\n // Ensure suffix is a string\n assertIsString(suffix, {\n message({ currentType, validType }) {\n return `Parameter \\`suffix\\` property of the first parameter must be of type \\`${validType}\\`, but received: \\`${currentType}\\`.`;\n }\n });\n\n try {\n let rawBaseUrl = process.env.NEXT_PUBLIC_BACKEND_API_URL?.trim();\n\n if (rawBaseUrl) {\n rawBaseUrl = removeSpaces(rawBaseUrl);\n\n const urlObj = new URL(rawBaseUrl);\n const hasPort = !!urlObj.port;\n\n if (!hasPort && process.env.NEXT_PUBLIC_PORT_BE) {\n rawBaseUrl =\n urlObj.origin +\n formatEnvPort(process.env.NEXT_PUBLIC_PORT_BE, {\n prefixColon: true\n });\n }\n } else {\n // fallback\n rawBaseUrl =\n \"http://localhost\" +\n formatEnvPort(process.env.NEXT_PUBLIC_PORT_BE || \"8000\", {\n prefixColon: true\n });\n }\n\n suffix = removeSpaces(suffix).length ? removeSpaces(suffix) : \"/\";\n const baseApiUrl = new URL(rawBaseUrl.replace(/\\/+$/, \"\")).origin;\n\n const finalSuffix =\n suffix === \"/\"\n ? \"/\"\n : `${suffix.startsWith(\"/\") ? \"\" : \"/\"}${suffix.replace(/\\/+$/, \"\")}`;\n\n return `${baseApiUrl}${finalSuffix}`;\n } catch (error) {\n throw new Error(\n \"Invalid `NEXT_PUBLIC_BACKEND_API_URL`, failed to generate from `getBeApiUrl()`, Error:\" +\n error,\n { cause: error }\n );\n }\n};\n","import { formatEnvPort } from \"@/urls/utils/formatEnvPort\";\nimport { removeSpaces } from \"@/strings/sanitizations/removeSpaces\";\n\n/** ---------------------------------------------------\n * * ***Utility for NextJS: `getBaseUrl`.***\n * ---------------------------------------------------\n * **Retrieves the base URL of the application.**\n * - **Behavior:**\n * - It determines the base URL from the `NEXT_PUBLIC_BASE_URL` environment variable.\n * - If `NEXT_PUBLIC_BASE_URL` is not set, it defaults to `\"http://localhost:3000\"`.\n * - If `NEXT_PUBLIC_BASE_URL` does **not** contain a port, it appends one from `NEXT_PUBLIC_PORT_FE` if available.\n * - Ensures the final URL is valid and normalized (no trailing slashes).\n * - ***⚠️ Warning:***\n * - ***This function only support when using ***[`NextJS`](https://nextjs.org/)***.***\n * @returns {string} The resolved base URL of the application.\n * @throws **{@link Error | `Error`}** if the constructed URL is invalid or malformed.\n * @example\n * // With environment variable set at `*.env` file\n * NEXT_PUBLIC_BASE_URL = \"https://example.com\";\n * getBaseUrl();\n * // ➔ \"https://example.com\"\n *\n * // With custom port via NEXT_PUBLIC_PORT_FE at `*.env` file\n * NEXT_PUBLIC_BASE_URL = \"http://localhost\";\n * NEXT_PUBLIC_PORT_FE = \"4000\";\n * getBaseUrl();\n * // ➔ \"http://localhost:4000\"\n *\n * // Without environment variable at `*.env` file\n * delete NEXT_PUBLIC_BASE_URL;\n * getBaseUrl();\n * // ➔ \"http://localhost:3000\"\n */\nexport const getBaseUrl = (): string => {\n try {\n const baseEnv = process.env.NEXT_PUBLIC_BASE_URL?.trim();\n const portEnv = process.env.NEXT_PUBLIC_PORT_FE?.trim();\n\n let baseUrl = baseEnv || \"http://localhost\";\n\n // Always clean trailing slashes first\n baseUrl = removeSpaces(baseUrl).replace(/\\/+$/, \"\");\n\n // Check if already contains port\n const hasPort = /:\\/\\/[^/]+:\\d+/.test(baseUrl);\n\n if (!hasPort && portEnv) {\n baseUrl += formatEnvPort(portEnv, { prefixColon: true });\n } else if (!hasPort && !baseEnv) {\n baseUrl += \":3000\";\n }\n\n const url = new URL(baseUrl);\n return `${url.protocol}//${url.hostname}${url.port ? `:${url.port}` : \"\"}`;\n } catch (error) {\n throw new Error(\n \"Invalid `NEXT_PUBLIC_BASE_URL`, failed to generate from `getBaseUrl()`, Error:\" +\n error,\n { cause: error }\n );\n }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AA0HA,SAAgB,cACd,OACA,QACkB;CAElB,IAAI,CAAC,SAAS,MAAM,IAAI,cAAc,MAAM,EAC1C,MAAM,IAAI,UACR,0HAA0H,eACxH,MACD,CAAC,OAAO,oBAAoB,OAAO,EAClC,eAAe,MAChB,CAAC,CAAC,KACJ;CAIH,IAAI,CAAC,UAAU,KAAK,MAAM,EACxB,OAAO;CAIT,oBAAoB,QAAQ,EAC1B,UAAU,EAAE,gBACV,4CAA4C,MAAM,wCAAwC,UAAU,iBAAiB,MAAM,uBAAuB,UAAU,yBAC/J,CAAC;CAGF,IAAI,MAAM,OAAO,EACf,MAAM,IAAI,UACR,4CAA4C,MAAM,wDAAwD,MAAM,IACjH;CAIH,MAAM,eAAe;EACnB;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACD;CAED,MAAM,SAAmB,EAAE;CAE3B,MAAM,eAAe,MAAM,KAAK,MAAM,SAAS,aAAa,CAAC,CAAC,KAC3D,MAAM,EAAE,MAAM,GAChB;CAED,KAAK,MAAM,OAAO,cAAc;EAC9B,MAAM,QAAQ,OAAO;EAErB,IAAI,CAAC,SAAS,MAAM,EAAE;GACpB,OAAO,KACL,yBAAyB,IAAI,gDAAgD,eAC3E,MACD,CAAC,KACH;GACD;;EAGF,IAAI,cAAc,MAAM,EAAE;GACxB,OAAO,KAAK,gBAAgB,IAAI,2BAA2B;GAC3D;;EAGF,MAAM,oBAAoB,aAAa,QAAQ,SAC7C,MAAM,SAAS,KAAK,CACrB;EAED,IAAI,KAAK,KAAK,MAAM,EAClB,kBAAkB,KAAK,iBAAiB;EAG1C,IAAI,kBAAkB,SAAS,GAAG;GAChC,MAAM,iBAAiB,kBAAkB,KAAK,MAC5C,MAAM,MAAM,mBAAmB,KAAK,EAAE,IACvC;GAED,IAAI,CAAC,aAAa,SAAS,iBAAiB,EAC1C,aAAa,KAAK,iBAAiB;GAErC,MAAM,wBAAwB,aAAa,KAAK,MAC9C,MAAM,MAAM,mBAAmB,KAAK,EAAE,IACvC;GAED,OAAO,KACL,gBAAgB,IAAI,iCAAiC,eAAe,KAClE,KACD,CAAC,qJAAqJ,sBAAsB,KAC3K,KACD,CAAC,IACH;;;CAIL,IAAI,gBAAgB,OAAO,EACzB,MAAM,IAAI,MACR,4CAA4C,MAAM,MAAM,OAAO,KAAK,KAAK,CAAC,GAC3E;CAGH,OAAO,MACJ,QAAQ,eAAe,GAAG,QAAQ;EAGjC,QAFiB,iBAAiB,OAAO,KAAK,GAAG,OAAO,OAAO,IAE/C,MAAM,CAAC,QAAQ,cAAc,GAAG;GAChD,CACD,QAAQ,QAAQ,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC/KzB,MAAa,kBAKX,UACA,UAAiC,EAAE,KACxB;CACX,IAAI;EAEF,eAAe,MAAM,SAAS,GAAG,KAAK,UAAU,EAC9C,QAAQ,EAAE,aAAa,aAAa;GAClC,OAAO,oDAAoD,UAAU,sBAAsB,YAAY;KAE1G,CAAC;EAEF,IAAI,CAAC,cAAc,QAAQ,EACzB,UAAU,EAAE;EAGd,IAAI,EAAE,SAAS,QAAQ,aAAa,SAAS;EAE7C,IAAI,CAAC,YAAY,OAAO,IAAI,CAAC,SAAS,OAAO,EAC3C,MAAM,IAAI,UACR,mHAAmH,eACjH,OACD,CAAC,KACH;EAGH,gBAAgB,YAAY,EAC1B,UAAU,EAAE,aAAa,gBACvB,6FAA6F,UAAU,sBAAsB,YAAY,MAC5I,CAAC;EAGF,WAAW,kBAAkB,SAAS;EAEtC,SAAS,kBAAkB,OAAO;EAElC,MAAM,mBAAmB,OAAO,SAAS,IAAI,GAAG,SAAS,SAAS;EAGlE,IACE,aAAa,UACb,aAAa,SAAS,OACtB,SAAS,WAAW,iBAAiB,EACrC;GACA,WAAW,SAAS,MAAM,OAAO,OAAO;GACxC,WAAW,kBAAkB,SAAS;;EAIxC,MAAM,aAAa,YAAY,EAAE,QAAQ,QAAQ,CAAC;EAElD,SAAS,SAAS,GAAW,GAAW;GACtC,OAAO,GAAG,EAAE,QAAQ,QAAQ,GAAG,CAAC,GAAG,EAAE,QAAQ,QAAQ,GAAG;;EAO1D,QAJiB,aACb,SAAS,YAAY,SAAS,GAC9B,SAAS,IAAI,IAAI,WAAW,CAAC,UAAU,SAAS,EAEpC,QAAQ,QAAQ,GAAG;UAC5B,KAAK;EACZ,IAAI,QAAQ,IAAI,EACd,MAAM;OAEN,MAAM,IAAI,MACR,sEACE,OAAO,IAAI,CAAC,MAAM,EACpB,EAAE,OAAO,KAAK,CACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACvFP,MAAa,eAAe,UAA8B,EAAE,KAAa;CACvE,IAAI,CAAC,cAAc,QAAQ,EAAE,UAAU,EAAE;CAEzC,IAAI,SAAS,WAAW,SAAS,SAAS,GAAG,QAAQ,SAAS;CAG9D,eAAe,QAAQ,EACrB,QAAQ,EAAE,aAAa,aAAa;EAClC,OAAO,0EAA0E,UAAU,sBAAsB,YAAY;IAEhI,CAAC;CAEF,IAAI;EACF,IAAI,aAAa,QAAQ,IAAI,6BAA6B,MAAM;EAEhE,IAAI,YAAY;GACd,aAAa,aAAa,WAAW;GAErC,MAAM,SAAS,IAAI,IAAI,WAAW;GAGlC,IAAI,CAAC,CAFY,CAAC,OAAO,QAET,QAAQ,IAAI,qBAC1B,aACE,OAAO,SACP,cAAc,QAAQ,IAAI,qBAAqB,EAC7C,aAAa,MACd,CAAC;SAIN,aACE,qBACA,cAAc,QAAQ,IAAI,uBAAuB,QAAQ,EACvD,aAAa,MACd,CAAC;EAGN,SAAS,aAAa,OAAO,CAAC,SAAS,aAAa,OAAO,GAAG;EAQ9D,OAAO,GAPY,IAAI,IAAI,WAAW,QAAQ,QAAQ,GAAG,CAAC,CAAC,SAGzD,WAAW,MACP,MACA,GAAG,OAAO,WAAW,IAAI,GAAG,KAAK,MAAM,OAAO,QAAQ,QAAQ,GAAG;UAGhE,OAAO;EACd,MAAM,IAAI,MACR,2FACE,OACF,EAAE,OAAO,OAAO,CACjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACnEL,MAAa,mBAA2B;CACtC,IAAI;EACF,MAAM,UAAU,QAAQ,IAAI,sBAAsB,MAAM;EACxD,MAAM,UAAU,QAAQ,IAAI,qBAAqB,MAAM;EAEvD,IAAI,UAAU,WAAW;EAGzB,UAAU,aAAa,QAAQ,CAAC,QAAQ,QAAQ,GAAG;EAGnD,MAAM,UAAU,iBAAiB,KAAK,QAAQ;EAE9C,IAAI,CAAC,WAAW,SACd,WAAW,cAAc,SAAS,EAAE,aAAa,MAAM,CAAC;OACnD,IAAI,CAAC,WAAW,CAAC,SACtB,WAAW;EAGb,MAAM,MAAM,IAAI,IAAI,QAAQ;EAC5B,OAAO,GAAG,IAAI,SAAS,IAAI,IAAI,WAAW,IAAI,OAAO,IAAI,IAAI,SAAS;UAC/D,OAAO;EACd,MAAM,IAAI,MACR,mFACE,OACF,EAAE,OAAO,OAAO,CACjB"}
@@ -1,43 +1,28 @@
1
1
  /*!
2
- * ====================================================
3
- * Rzl Utils-JS.
4
- * ----------------------------------------------------
5
- * Version: 3.12.0.
6
- * Author: Rizalvin Dwiky.
7
- * Repository: https://github.com/rzl-zone/utils-js.
8
- * ====================================================
9
- */
10
- 'use strict';
11
-
12
- var chunkGKC3UDMC_cjs = require('../../chunk-GKC3UDMC.cjs');
13
- require('server-only');
14
- var server = require('next/server');
15
-
16
- var getClientIpOrUrl = (request, includeFullUrl = true) => {
17
- if (!chunkGKC3UDMC_cjs.isFunction(server.NextRequest)) {
18
- throw new Error(
19
- "Function `getClientIpOrUrl` is designed to be used in a `NextJS` environment."
20
- );
21
- }
22
- if (!(request instanceof server.NextRequest)) {
23
- throw new TypeError(
24
- "First parameter (`request`) must be an `instance of NextRequest` from `NextJS`."
25
- );
26
- }
27
- chunkGKC3UDMC_cjs.assertIsBoolean(includeFullUrl, {
28
- message: ({ currentType, validType }) => `Second parameter (\`includeFullUrl\`) must be of type \`${validType}\`, but received: \`${currentType}\`.`
29
- });
30
- const forwardedIps = (request.headers.get("x-forwarded-for") ?? "127.0.0.1").trim().split(",");
31
- if (forwardedIps[0] === "::ffff:127.0.0.1" || forwardedIps[0] === "::1") {
32
- forwardedIps[0] = "127.0.0.1";
33
- }
34
- const clientIp = forwardedIps.length > 1 ? forwardedIps[forwardedIps.length - 1].trim() : forwardedIps[0];
35
- if (!includeFullUrl) {
36
- return clientIp;
37
- }
38
- const protocol = request.headers.get("x-forwarded-proto") || "http";
39
- const port = request.headers.get("x-forwarded-port") || "3000";
40
- return `${process.env.NODE_ENV === "production" ? protocol : "http"}://${clientIp}:${port}`;
2
+ * ========================================================================
3
+ * @rzl-zone/utils-js
4
+ * ------------------------------------------------------------------------
5
+ * Version: `3.12.1-beta.1`
6
+ * Author: `Rizalvin Dwiky <rizalvindwiky@gmail.com>`
7
+ * Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/utils-js`
8
+ * ========================================================================
9
+ */
10
+ "use strict";
11
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
12
+ const require_assertIsBoolean = require('../../assertIsBoolean-C8WEXVr2.cjs');
13
+ require("@rzl-zone/node-only");
14
+ let next_server = require("next/server");
15
+ const getClientIpOrUrl = (request, includeFullUrl = true) => {
16
+ if (!require_assertIsBoolean.isFunction(next_server.NextRequest)) throw new Error("Function `getClientIpOrUrl` is designed to be used in a `NextJS` environment.");
17
+ if (!(request instanceof next_server.NextRequest)) throw new TypeError("First parameter (`request`) must be an `instance of NextRequest` from `NextJS`.");
18
+ require_assertIsBoolean.assertIsBoolean(includeFullUrl, { message: ({ currentType, validType }) => `Second parameter (\`includeFullUrl\`) must be of type \`${validType}\`, but received: \`${currentType}\`.` });
19
+ const forwardedIps = (request.headers.get("x-forwarded-for") ?? "127.0.0.1").trim().split(",");
20
+ if (forwardedIps[0] === "::ffff:127.0.0.1" || forwardedIps[0] === "::1") forwardedIps[0] = "127.0.0.1";
21
+ const clientIp = forwardedIps.length > 1 ? forwardedIps[forwardedIps.length - 1]?.trim() || "" : forwardedIps[0] || "";
22
+ if (!includeFullUrl) return clientIp;
23
+ const protocol = request.headers.get("x-forwarded-proto") || "http";
24
+ const port = request.headers.get("x-forwarded-port") || "3000";
25
+ return `${process.env.NODE_ENV === "production" ? protocol : "http"}://${clientIp}:${port}`;
41
26
  };
42
-
43
27
  exports.getClientIpOrUrl = getClientIpOrUrl;
28
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","names":["isFunction","NextRequest"],"sources":["../../../src/next/server/getClientIpOrUrl.ts"],"sourcesContent":["import \"@rzl-zone/node-only\";\n\nimport { NextRequest } from \"next/server\";\n\nimport { isFunction } from \"@/predicates/is/isFunction\";\nimport { assertIsBoolean } from \"@/assertions/booleans/assertIsBoolean\";\n\n/** ---------------------------------\n * * ***Utility for NextJS Server: `getClientIpOrUrl`.***\n * ---------------------------------\n * **Retrieves the real client IP address and constructs the full URL using headers like `x-forwarded-for`, `x-forwarded-proto`, and `x-forwarded-port`.**\n * - **ℹ️ Note:**\n * - Only supported in **Next.js** environments (specifically in `server-only` contexts).\n * - Should be used in **middleware**, **route-handler** or **server actions** that have access to ***[`NextRequest - NextJS`](https://nextjs.org/docs/app/api-reference/functions/next-request)***.\n * @param {NextRequest} request - The incoming ***`NextJS`*** request object, must be instanceof `NextRequest` from `next/server`.\n * @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`.\n * @returns {string} The extracted client IP address or the full constructed URL.\n * @throws **{@link Error | `Error`}** if the function is used outside a Next.js server environment.\n * @throws **{@link TypeError | `TypeError`}** if the arguments do not match the expected types.\n * @example\n * // Basic usage in Next.js middleware\n * import { NextRequest } from \"next/server\";\n * import { getClientIpOrUrl } from \"@rzl-zone/utils-js/next/server\";\n *\n * export function middleware(request: NextRequest) {\n * const clientIp = getClientIpOrUrl(request, false);\n * console.log(\"Client IP:\", clientIp);\n * }\n *\n * // Get full URL\n * const url = getClientIpOrUrl(request);\n * console.log(\"Client full URL:\", url);\n */\nexport const getClientIpOrUrl = (\n request: NextRequest,\n includeFullUrl: boolean = true\n): string => {\n // Ensure we're in a Next.js edge/server environment\n if (!isFunction(NextRequest)) {\n throw new Error(\n \"Function `getClientIpOrUrl` is designed to be used in a `NextJS` environment.\"\n );\n }\n\n if (!(request instanceof NextRequest)) {\n throw new TypeError(\n \"First parameter (`request`) must be an `instance of NextRequest` from `NextJS`.\"\n );\n }\n\n assertIsBoolean(includeFullUrl, {\n message: ({ currentType, validType }) =>\n `Second parameter (\\`includeFullUrl\\`) must be of type \\`${validType}\\`, but received: \\`${currentType}\\`.`\n });\n\n const forwardedIps = (request.headers.get(\"x-forwarded-for\") ?? \"127.0.0.1\")\n .trim()\n .split(\",\");\n\n // Normalize IPv6 loopback addresses\n if (forwardedIps[0] === \"::ffff:127.0.0.1\" || forwardedIps[0] === \"::1\") {\n forwardedIps[0] = \"127.0.0.1\";\n }\n\n // Get the last non-empty IP from the list (more reliable for real client IP)\n const clientIp: string =\n forwardedIps.length > 1\n ? forwardedIps[forwardedIps.length - 1]?.trim() || \"\"\n : forwardedIps[0] || \"\";\n\n if (!includeFullUrl) {\n return clientIp;\n }\n\n // Construct full URL using protocol, IP, and port\n const protocol = request.headers.get(\"x-forwarded-proto\") || \"http\";\n // const protocol = \"http\";\n const port = request.headers.get(\"x-forwarded-port\") || \"3000\";\n\n return `${\n process.env.NODE_ENV === \"production\" ? protocol : \"http\"\n }://${clientIp}:${port}`;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,MAAa,oBACX,SACA,iBAA0B,SACf;CAEX,IAAI,CAACA,mCAAWC,wBAAY,EAC1B,MAAM,IAAI,MACR,gFACD;CAGH,IAAI,EAAE,mBAAmBA,0BACvB,MAAM,IAAI,UACR,kFACD;CAGH,wCAAgB,gBAAgB,EAC9B,UAAU,EAAE,aAAa,gBACvB,2DAA2D,UAAU,sBAAsB,YAAY,MAC1G,CAAC;CAEF,MAAM,gBAAgB,QAAQ,QAAQ,IAAI,kBAAkB,IAAI,aAC7D,MAAM,CACN,MAAM,IAAI;CAGb,IAAI,aAAa,OAAO,sBAAsB,aAAa,OAAO,OAChE,aAAa,KAAK;CAIpB,MAAM,WACJ,aAAa,SAAS,IAClB,aAAa,aAAa,SAAS,IAAI,MAAM,IAAI,KACjD,aAAa,MAAM;CAEzB,IAAI,CAAC,gBACH,OAAO;CAIT,MAAM,WAAW,QAAQ,QAAQ,IAAI,oBAAoB,IAAI;CAE7D,MAAM,OAAO,QAAQ,QAAQ,IAAI,mBAAmB,IAAI;CAExD,OAAO,GACL,QAAQ,IAAI,aAAa,eAAe,WAAW,OACpD,KAAK,SAAS,GAAG"}
@@ -0,0 +1,39 @@
1
+ /*!
2
+ * ========================================================================
3
+ * @rzl-zone/utils-js
4
+ * ------------------------------------------------------------------------
5
+ * Version: `3.12.1-beta.1`
6
+ * Author: `Rizalvin Dwiky <rizalvindwiky@gmail.com>`
7
+ * Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/utils-js`
8
+ * ========================================================================
9
+ */
10
+
11
+ import { NextRequest } from "next/server";
12
+ /** ---------------------------------
13
+ * * ***Utility for NextJS Server: `getClientIpOrUrl`.***
14
+ * ---------------------------------
15
+ * **Retrieves the real client IP address and constructs the full URL using headers like `x-forwarded-for`, `x-forwarded-proto`, and `x-forwarded-port`.**
16
+ * - **ℹ️ Note:**
17
+ * - Only supported in **Next.js** environments (specifically in `server-only` contexts).
18
+ * - Should be used in **middleware**, **route-handler** or **server actions** that have access to ***[`NextRequest - NextJS`](https://nextjs.org/docs/app/api-reference/functions/next-request)***.
19
+ * @param {NextRequest} request - The incoming ***`NextJS`*** request object, must be instanceof `NextRequest` from `next/server`.
20
+ * @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`.
21
+ * @returns {string} The extracted client IP address or the full constructed URL.
22
+ * @throws **{@link Error | `Error`}** if the function is used outside a Next.js server environment.
23
+ * @throws **{@link TypeError | `TypeError`}** if the arguments do not match the expected types.
24
+ * @example
25
+ * // Basic usage in Next.js middleware
26
+ * import { NextRequest } from "next/server";
27
+ * import { getClientIpOrUrl } from "@rzl-zone/utils-js/next/server";
28
+ *
29
+ * export function middleware(request: NextRequest) {
30
+ * const clientIp = getClientIpOrUrl(request, false);
31
+ * console.log("Client IP:", clientIp);
32
+ * }
33
+ *
34
+ * // Get full URL
35
+ * const url = getClientIpOrUrl(request);
36
+ * console.log("Client full URL:", url);
37
+ */
38
+ declare const getClientIpOrUrl: (request: NextRequest, includeFullUrl?: boolean) => string;
39
+ export { getClientIpOrUrl };
@@ -1,40 +1,39 @@
1
1
  /*!
2
- * ====================================================
3
- * Rzl Utils-JS.
4
- * ----------------------------------------------------
5
- * Version: 3.12.0.
6
- * Author: Rizalvin Dwiky.
7
- * Repository: https://github.com/rzl-zone/utils-js.
8
- * ====================================================
9
- */
10
- import { NextRequest } from 'next/server';
2
+ * ========================================================================
3
+ * @rzl-zone/utils-js
4
+ * ------------------------------------------------------------------------
5
+ * Version: `3.12.1-beta.1`
6
+ * Author: `Rizalvin Dwiky <rizalvindwiky@gmail.com>`
7
+ * Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/utils-js`
8
+ * ========================================================================
9
+ */
11
10
 
11
+ import { NextRequest } from "next/server";
12
12
  /** ---------------------------------
13
- * * ***Utility for NextJS Server: `getClientIpOrUrl`.***
14
- * ---------------------------------
15
- * **Retrieves the real client IP address and constructs the full URL using headers like `x-forwarded-for`, `x-forwarded-proto`, and `x-forwarded-port`.**
16
- * - **ℹ️ Note:**
17
- * - Only supported in **Next.js** environments (specifically in `server-only` contexts).
18
- * - Should be used in **middleware**, **route-handler** or **server actions** that have access to ***[`NextRequest - NextJS`](https://nextjs.org/docs/app/api-reference/functions/next-request)***.
19
- * @param {NextRequest} request - The incoming ***`NextJS`*** request object, must be instanceof `NextRequest` from `next/server`.
20
- * @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`.
21
- * @returns {string} The extracted client IP address or the full constructed URL.
22
- * @throws **{@link Error | `Error`}** if the function is used outside a Next.js server environment.
23
- * @throws **{@link TypeError | `TypeError`}** if the arguments do not match the expected types.
24
- * @example
25
- * // Basic usage in Next.js middleware
26
- * import { NextRequest } from "next/server";
27
- * import { getClientIpOrUrl } from "@rzl-zone/utils-js/next/server";
28
- *
29
- * export function middleware(request: NextRequest) {
30
- * const clientIp = getClientIpOrUrl(request, false);
31
- * console.log("Client IP:", clientIp);
32
- * }
33
- *
34
- * // Get full URL
35
- * const url = getClientIpOrUrl(request);
36
- * console.log("Client full URL:", url);
37
- */
13
+ * * ***Utility for NextJS Server: `getClientIpOrUrl`.***
14
+ * ---------------------------------
15
+ * **Retrieves the real client IP address and constructs the full URL using headers like `x-forwarded-for`, `x-forwarded-proto`, and `x-forwarded-port`.**
16
+ * - **ℹ️ Note:**
17
+ * - Only supported in **Next.js** environments (specifically in `server-only` contexts).
18
+ * - Should be used in **middleware**, **route-handler** or **server actions** that have access to ***[`NextRequest - NextJS`](https://nextjs.org/docs/app/api-reference/functions/next-request)***.
19
+ * @param {NextRequest} request - The incoming ***`NextJS`*** request object, must be instanceof `NextRequest` from `next/server`.
20
+ * @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`.
21
+ * @returns {string} The extracted client IP address or the full constructed URL.
22
+ * @throws **{@link Error | `Error`}** if the function is used outside a Next.js server environment.
23
+ * @throws **{@link TypeError | `TypeError`}** if the arguments do not match the expected types.
24
+ * @example
25
+ * // Basic usage in Next.js middleware
26
+ * import { NextRequest } from "next/server";
27
+ * import { getClientIpOrUrl } from "@rzl-zone/utils-js/next/server";
28
+ *
29
+ * export function middleware(request: NextRequest) {
30
+ * const clientIp = getClientIpOrUrl(request, false);
31
+ * console.log("Client IP:", clientIp);
32
+ * }
33
+ *
34
+ * // Get full URL
35
+ * const url = getClientIpOrUrl(request);
36
+ * console.log("Client full URL:", url);
37
+ */
38
38
  declare const getClientIpOrUrl: (request: NextRequest, includeFullUrl?: boolean) => string;
39
-
40
39
  export { getClientIpOrUrl };