@entry-ui/utilities 0.3.0 → 0.4.0

package/dist/chunk-JW4DI4Q2.js

@@ -0,0 +1,2 @@
+import {a as a$1}from'./chunk-O4WYO5SA.js';import {a}from'./chunk-TAV72HQS.js';var s=r=>{let{value:m,min:e,max:i}=r;return a(m)||a$1({prefix:"[Entry UI Utilities]",messages:["Invalid 'value' parameter in 'clamp' utility.",`Expected a finite number, but received: ${m}`]}),a(e)||a$1({prefix:"[Entry UI Utilities]",messages:["Invalid 'min' parameter in 'clamp' utility.",`Expected a finite number, but received: ${e}`]}),a(i)||a$1({prefix:"[Entry UI Utilities]",messages:["Invalid 'max' parameter in 'clamp' utility.",`Expected a finite number, but received: ${i}`]}),e>i&&a$1({prefix:"[Entry UI Utilities]",messages:["Invalid range for 'clamp' utility.",`The 'min' parameter (${e}) must be less than or equal to the 'max' parameter (${i}).`]}),Math.min(i,Math.max(e,m))};export{s as a};//# sourceMappingURL=chunk-JW4DI4Q2.js.map
+//# sourceMappingURL=chunk-JW4DI4Q2.js.map

package/dist/chunk-JW4DI4Q2.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/clamp/clamp.ts"],"names":["clamp","params","value","min","max","isValidNumber","fail"],"mappings":"+EA2BO,IAAMA,EAASC,CAAAA,EAAwB,CAC5C,GAAM,CAAE,KAAA,CAAAC,EAAO,GAAA,CAAAC,CAAAA,CAAK,GAAA,CAAAC,CAAI,EAAIH,CAAAA,CAE5B,OAAKI,EAAcH,CAAK,CAAA,EACtBI,IAAK,CACH,MAAA,CAAQ,sBAAA,CACR,QAAA,CAAU,CAAC,+CAAA,CAAiD,CAAA,wCAAA,EAA2CJ,CAAK,CAAA,CAAE,CAChH,CAAC,CAAA,CAGEG,CAAAA,CAAcF,CAAG,CAAA,EACpBG,GAAAA,CAAK,CACH,MAAA,CAAQ,sBAAA,CACR,SAAU,CAAC,6CAAA,CAA+C,2CAA2CH,CAAG,CAAA,CAAE,CAC5G,CAAC,EAGEE,CAAAA,CAAcD,CAAG,GACpBE,GAAAA,CAAK,CACH,OAAQ,sBAAA,CACR,QAAA,CAAU,CAAC,6CAAA,CAA+C,CAAA,wCAAA,EAA2CF,CAAG,CAAA,CAAE,CAC5G,CAAC,CAAA,CAGCD,CAAAA,CAAMC,GACRE,GAAAA,CAAK,CACH,MAAA,CAAQ,sBAAA,CACR,SAAU,CACR,oCAAA,CACA,wBAAwBH,CAAG,CAAA,qDAAA,EAAwDC,CAAG,CAAA,EAAA,CACxF,CACF,CAAC,CAAA,CAGI,IAAA,CAAK,IAAIA,CAAAA,CAAK,IAAA,CAAK,IAAID,CAAAA,CAAKD,CAAK,CAAC,CAC3C","file":"chunk-JW4DI4Q2.js","sourcesContent":["import type { ClampParams } from './clamp.types';\nimport { isValidNumber } from '../is-valid-number';\nimport { fail } from '../fail';\n\n/**\n * Clamps a number between a minimum and maximum value.\n *\n * This utility ensures that the returned value is restricted to a specified range.\n * If the input value is smaller than the minimum boundary, the minimum value is\n * returned. If it exceeds the maximum boundary, the maximum value is returned.\n *\n * This function will throw an error if:\n * - Any of the input parameters are not finite numbers.\n * - The `min` value is greater than the `max` value.\n *\n * @example\n * ```ts\n * clamp({ value: 150, min: 0, max: 100 });\n * // Returns: 100\n *\n * clamp({ value: -20, min: 0, max: 100 });\n * Returns: 0\n *\n * clamp({ value: 50, min: 0, max: 100 });\n * // Returns: 50\n * ```\n */\nexport const clamp = (params: ClampParams) => {\n  const { value, min, max } = params;\n\n  if (!isValidNumber(value)) {\n    fail({\n      prefix: '[Entry UI Utilities]',\n      messages: [`Invalid 'value' parameter in 'clamp' utility.`, `Expected a finite number, but received: ${value}`],\n    });\n  }\n\n  if (!isValidNumber(min)) {\n    fail({\n      prefix: '[Entry UI Utilities]',\n      messages: [`Invalid 'min' parameter in 'clamp' utility.`, `Expected a finite number, but received: ${min}`],\n    });\n  }\n\n  if (!isValidNumber(max)) {\n    fail({\n      prefix: '[Entry UI Utilities]',\n      messages: [`Invalid 'max' parameter in 'clamp' utility.`, `Expected a finite number, but received: ${max}`],\n    });\n  }\n\n  if (min > max) {\n    fail({\n      prefix: '[Entry UI Utilities]',\n      messages: [\n        `Invalid range for 'clamp' utility.`,\n        `The 'min' parameter (${min}) must be less than or equal to the 'max' parameter (${max}).`,\n      ],\n    });\n  }\n\n  return Math.min(max, Math.max(min, value));\n};\n"]}

package/dist/chunk-TAV72HQS.js

@@ -0,0 +1,2 @@
+var m=e=>typeof e=="number"&&Number.isFinite(e);export{m as a};//# sourceMappingURL=chunk-TAV72HQS.js.map
+//# sourceMappingURL=chunk-TAV72HQS.js.map

package/dist/chunk-TAV72HQS.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/is-valid-number/is-valid-number.ts"],"names":["isValidNumber","value"],"mappings":"AAoBO,IAAMA,EAAiBC,CAAAA,EACrB,OAAOA,GAAU,QAAA,EAAY,MAAA,CAAO,SAASA,CAAK","file":"chunk-TAV72HQS.js","sourcesContent":["/**\n * Determines whether the provided value is a valid, finite number.\n *\n * This utility serves as a type guard that goes beyond a simple `typeof` check.\n * While `typeof NaN` or `typeof Infinity` returns `\"number\"`, this function\n * ensures the value is a usable numeric value by excluding these edge cases\n * using `Number.isFinite`.\n *\n * @example\n * ```ts\n * isValidNumber(10);\n * // Returns: true\n *\n * isValidNumber(NaN);\n * // Returns: false\n *\n * isValidNumber(Infinity);\n * // Returns: false\n * ```\n */\nexport const isValidNumber = (value: number): value is number => {\n  return typeof value === 'number' && Number.isFinite(value);\n};\n"]}

package/dist/clamp/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Configuration object for the `clamp` utility.
+ *
+ * This interface defines the numerical boundaries and the target value required
+ * to perform a clamping operation. It ensures that all provided properties are
+ * valid, finite numbers, maintaining strict mathematical constraints where
+ * the minimum bound must not exceed the maximum bound.
+ */
+interface ClampParams {
+    /**
+     * The numerical value to be restricted within the specified range.
+     * Must be a finite number.
+     */
+    value: number;
+    /**
+     * The lower bound of the range.
+     * If `value` is less than `min`, the function returns `min`.
+     * Must be a finite number and less than or equal to `max`.
+     */
+    min: number;
+    /**
+     * The upper bound of the range.
+     * If `value` is greater than `max`, the function returns `max`.
+     * Must be a finite number and greater than or equal to `min`.
+     */
+    max: number;
+}
+
+/**
+ * Clamps a number between a minimum and maximum value.
+ *
+ * This utility ensures that the returned value is restricted to a specified range.
+ * If the input value is smaller than the minimum boundary, the minimum value is
+ * returned. If it exceeds the maximum boundary, the maximum value is returned.
+ *
+ * This function will throw an error if:
+ * - Any of the input parameters are not finite numbers.
+ * - The `min` value is greater than the `max` value.
+ *
+ * @example
+ * ```ts
+ * clamp({ value: 150, min: 0, max: 100 });
+ * // Returns: 100
+ *
+ * clamp({ value: -20, min: 0, max: 100 });
+ * Returns: 0
+ *
+ * clamp({ value: 50, min: 0, max: 100 });
+ * // Returns: 50
+ * ```
+ */
+declare const clamp: (params: ClampParams) => number;
+
+export { type ClampParams, clamp };

package/dist/clamp/index.js

@@ -0,0 +1,2 @@
+export{a as clamp}from'../chunk-JW4DI4Q2.js';import'../chunk-O4WYO5SA.js';import'../chunk-TAV72HQS.js';//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/clamp/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export { AddEventListenerOnceParams, AllEventMaps, addEventListenerOnce } from './add-event-listener-once/index.js';
+export { ClampParams, clamp } from './clamp/index.js';
 export { ErrorParams, error } from './error/index.js';
 export { FailParams, fail } from './fail/index.js';
+export { isValidNumber } from './is-valid-number/index.js';
 export { PossibleStyle, mergeStyles } from './merge-styles/index.js';
 export { visuallyHiddenInputStyle } from './visually-hidden-input-style/index.js';
 export { visuallyHiddenStyle } from './visually-hidden-style/index.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-export{a as warn}from'./chunk-6L6DIP5N.js';export{a as addEventListenerOnce}from'./chunk-GLPQ4KOF.js';export{a as error}from'./chunk-GG6DRWSS.js';export{a as fail}from'./chunk-O4WYO5SA.js';export{a as visuallyHiddenInputStyle}from'./chunk-AYHMR4G2.js';export{a as mergeStyles}from'./chunk-NBN5PUZ6.js';export{a as visuallyHiddenStyle}from'./chunk-YRBGPPKC.js';export{a as wait}from'./chunk-OUZ54COH.js';//# sourceMappingURL=index.js.map
+export{a as visuallyHiddenStyle}from'./chunk-YRBGPPKC.js';export{a as wait}from'./chunk-OUZ54COH.js';export{a as warn}from'./chunk-6L6DIP5N.js';export{a as addEventListenerOnce}from'./chunk-GLPQ4KOF.js';export{a as clamp}from'./chunk-JW4DI4Q2.js';export{a as error}from'./chunk-GG6DRWSS.js';export{a as fail}from'./chunk-O4WYO5SA.js';export{a as isValidNumber}from'./chunk-TAV72HQS.js';export{a as mergeStyles}from'./chunk-NBN5PUZ6.js';export{a as visuallyHiddenInputStyle}from'./chunk-AYHMR4G2.js';//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/is-valid-number/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Determines whether the provided value is a valid, finite number.
+ *
+ * This utility serves as a type guard that goes beyond a simple `typeof` check.
+ * While `typeof NaN` or `typeof Infinity` returns `"number"`, this function
+ * ensures the value is a usable numeric value by excluding these edge cases
+ * using `Number.isFinite`.
+ *
+ * @example
+ * ```ts
+ * isValidNumber(10);
+ * // Returns: true
+ *
+ * isValidNumber(NaN);
+ * // Returns: false
+ *
+ * isValidNumber(Infinity);
+ * // Returns: false
+ * ```
+ */
+declare const isValidNumber: (value: number) => value is number;
+
+export { isValidNumber };

package/dist/is-valid-number/index.js

@@ -0,0 +1,2 @@
+export{a as isValidNumber}from'../chunk-TAV72HQS.js';//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/is-valid-number/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entry-ui/utilities",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "",
   "keywords": [],
   "homepage": "https://github.com/ZAHON/entry-ui/tree/main/packages/utilities#readme",