@design-edito/tools 0.4.23 → 0.5.0

package/agnostic/arrays/find-duplicates/index.d.ts

@@ -12,4 +12,4 @@ export declare function findDuplicates<T>(arr: T[], stopAtFirst?: boolean): T[];
  * @param arr - The array to search for duplicates positions.
  * @returns An array of the positions of duplicate elements found in the input array.
  */
-export declare function findDuplicatesPositions(arr: any[]): number[];
+export declare function findDuplicatesPositions(arr: unknown[]): number[];

package/agnostic/arrays/find-duplicates/index.js

@@ -29,8 +29,9 @@ export function findDuplicatesPositions(arr) {
     const duplicatesPos = [];
     arr.forEach((item, pos) => {
         if (seen.has(item))
-            return duplicatesPos.push(pos);
-        seen.add(item);
+            duplicatesPos.push(pos);
+        else
+            seen.add(item);
     });
     return duplicatesPos;
 }

package/agnostic/arrays/is-array-of/index.d.ts

@@ -12,5 +12,5 @@ type TypeOfChecker<C> = C extends ConstructorFunction<infer U> ? U : C extends T
  * Supports constructor functions (e.g., `Number`, `String`, `Boolean`, custom classes)
  * and custom type guard functions.
  */
-export declare function isArrayOf<C extends TypeChecker<any> | Array<TypeChecker<any>>>(input: unknown, _types?: C): input is Array<TypeOfChecker<C extends any[] ? C[number] : C>>;
+export declare function isArrayOf<C extends TypeChecker<unknown> | Array<TypeChecker<unknown>>>(input: unknown, _types?: C): input is Array<TypeOfChecker<C extends unknown[] ? C[number] : C>>;
 export {};

package/agnostic/arrays/is-array-of/index.js

@@ -1,3 +1,4 @@
+import { isNotFalsy } from '../../booleans/is-falsy/index.js';
 import { isConstructorFunction } from '../../misc/is-constructor-function/index.js';
 /**
  * Type guard to check if an input is an array and optionally if all elements match a type.
@@ -18,8 +19,9 @@ export function isArrayOf(input, _types) {
         [Boolean, 'boolean']
     ]);
     return input.every(entry => types.some(typeChecker => {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
         if (!isConstructorFunction(typeChecker))
-            return typeChecker(entry);
+            return isNotFalsy(typeChecker(entry));
         const primitiveType = primitiveTypeMap.get(typeChecker);
         // eslint-disable-next-line valid-typeof
         if (primitiveType !== undefined)

package/agnostic/arrays/make/index.d.ts

@@ -1,5 +1,5 @@
 /** Function that generates a value for each array position. */
-type Filler<T = any> = (pos: number) => T;
+type Filler<T = unknown> = (pos: number) => T;
 /**
  * Creates an array of a specified length using a filler function.
  *

package/agnostic/arrays/random-pick/index.js

@@ -12,6 +12,7 @@ export function randomPick(arr, exclude = []) {
     if (length === 0)
         throw new Error('Array length must be at least 1 after exclusion');
     const pos = Math.floor(Math.random() * length);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
     const found = filteredArr[pos];
     return found;
 }
@@ -30,7 +31,7 @@ export function randomPick(arr, exclude = []) {
 export function randomPickMany(howMuch, arr, exclude = []) {
     const grindedArr = [...arr];
     const pickedSelection = [];
-    for (let i = 0; i < howMuch; i++) {
+    for (let i = 0; i < howMuch; i = i + 1) {
         const picked = randomPick(grindedArr, exclude);
         const indexOfPicked = grindedArr.indexOf(picked);
         grindedArr.splice(indexOfPicked, 1);

package/agnostic/arrays/shuffle/index.js

@@ -8,7 +8,7 @@
  */
 export function shuffle(array) {
     const shuffled = [...array];
-    for (let i = shuffled.length - 1; i > 0; i--) {
+    for (let i = shuffled.length - 1; i > 0; i = i - 1) {
         const j = Math.floor(Math.random() * (i + 1));
         [shuffled[i], shuffled[j]] = [shuffled[j], shuffled[i]];
     }

package/agnostic/booleans/is-falsy/index.d.ts

@@ -1,10 +1,10 @@
 import { type Nullish } from '../../misc/is-nullish/index.js';
 /** Union type representing all falsy values in JavaScript. */
-export type Falsy = Nullish | false | '' | 0 | -0 | typeof NaN | 0n;
+export type Falsy = Nullish | false | '' | 0 | 0n;
 /** Type that excludes falsy values from T (except numbers, which may be 0). */
 export type NotFalsy<T> = Exclude<T, Exclude<Falsy, number>>;
 /** Array containing all falsy values for comparison. */
-declare const falsyValues: Falsy[];
+declare const falsyValues: readonly [...(null | undefined)[], false, "", 0, 0, number, 0n];
 export { falsyValues };
 /**
  * Type guard to check if a value is falsy.
@@ -14,7 +14,7 @@ export { falsyValues };
  * @param val - The value to check.
  * @returns `true` if the value is falsy, `false` otherwise.
  */
-export declare function isFalsy<T>(val: T | Falsy): val is Falsy;
+export declare function isFalsy(val: unknown): val is Falsy;
 /**
  * Type guard to check if a value is not falsy.
  *

package/agnostic/booleans/is-falsy/index.js

@@ -1,8 +1,6 @@
 import { nullishValues } from '../../misc/is-nullish/index.js';
 /** Array containing all falsy values for comparison. */
-const falsyValues = [...nullishValues, false, '', 0, -0, NaN];
-if (typeof BigInt === 'function')
-    falsyValues.push(BigInt(0));
+const falsyValues = [...nullishValues, false, '', 0, -0, NaN, 0n];
 export { falsyValues };
 /**
  * Type guard to check if a value is falsy.
@@ -13,6 +11,7 @@ export { falsyValues };
  * @returns `true` if the value is falsy, `false` otherwise.
  */
 export function isFalsy(val) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
     return falsyValues.includes(val);
 }
 /**

package/agnostic/colors/channels/index.d.ts

@@ -1,39 +1,39 @@
-import { type Color, type TransformedColor, type Channel } from '../types.js';
+import type { Color, TransformedColor, Channel } from '../types.js';
 /**
  * Sets a specific color channel to an absolute value.
  *
  * @template C - The input color type.
- * @param {C} color - The color to modify.
- * @param {Channel} channel - The channel to set.
- * @param {number} value - The new value for the channel.
- * @returns {TransformedColor<C>} The color with the updated channel, in the original format.
+ * @param color - The color to modify.
+ * @param channel - The channel to set.
+ * @param value - The new value for the channel.
+ * @returns The color with the updated channel, in the original format.
  */
 export declare function setChannel<C extends Color>(color: C, channel: Channel, value: number): TransformedColor<C>;
 /**
  * Gets the value of a specific color channel.
  *
- * @param {Color} color - The color to read from.
- * @param {Channel} channel - The channel to retrieve.
- * @returns {number} The value of the specified channel.
+ * @param color - The color to read from.
+ * @param channel - The channel to retrieve.
+ * @returns The value of the specified channel.
  */
 export declare function getChannel(color: Color, channel: Channel): number;
 /**
  * Adds a value to a specific color channel.
  *
  * @template C - The input color type.
- * @param {C} color - The color to modify.
- * @param {Channel} channel - The channel to modify.
- * @param {number} amount - The amount to add to the channel.
- * @returns {TransformedColor<C>} The color with the updated channel, in the original format.
+ * @param color - The color to modify.
+ * @param channel - The channel to modify.
+ * @param amount - The amount to add to the channel.
+ * @returns The color with the updated channel, in the original format.
  */
 export declare function addChannel<C extends Color>(color: C, channel: Channel, amount: number): TransformedColor<C>;
 /**
  * Multiplies a specific color channel by a factor.
  *
  * @template C - The input color type.
- * @param {C} color - The color to modify.
- * @param {Channel} channel - The channel to modify.
- * @param {number} factor - The multiplication factor.
- * @returns {TransformedColor<C>} The color with the updated channel, in the original format.
+ * @param color - The color to modify.
+ * @param channel - The channel to modify.
+ * @param factor - The multiplication factor.
+ * @returns The color with the updated channel, in the original format.
  */
 export declare function multChannel<C extends Color>(color: C, channel: Channel, factor: number): TransformedColor<C>;

package/agnostic/colors/channels/index.js

@@ -8,10 +8,10 @@ import { toRgb, toHsl, toHsb, toCmyk, toXyz, toLab, toLch, viaRgb, viaHsl, viaHs
  * Sets a specific color channel to an absolute value.
  *
  * @template C - The input color type.
- * @param {C} color - The color to modify.
- * @param {Channel} channel - The channel to set.
- * @param {number} value - The new value for the channel.
- * @returns {TransformedColor<C>} The color with the updated channel, in the original format.
+ * @param color - The color to modify.
+ * @param channel - The channel to set.
+ * @param value - The new value for the channel.
+ * @returns The color with the updated channel, in the original format.
  */
 export function setChannel(color, channel, value) {
     switch (channel) {
@@ -43,9 +43,9 @@ export function setChannel(color, channel, value) {
 /**
  * Gets the value of a specific color channel.
  *
- * @param {Color} color - The color to read from.
- * @param {Channel} channel - The channel to retrieve.
- * @returns {number} The value of the specified channel.
+ * @param color - The color to read from.
+ * @param channel - The channel to retrieve.
+ * @returns The value of the specified channel.
  */
 export function getChannel(color, channel) {
     switch (channel) {
@@ -78,10 +78,10 @@ export function getChannel(color, channel) {
  * Adds a value to a specific color channel.
  *
  * @template C - The input color type.
- * @param {C} color - The color to modify.
- * @param {Channel} channel - The channel to modify.
- * @param {number} amount - The amount to add to the channel.
- * @returns {TransformedColor<C>} The color with the updated channel, in the original format.
+ * @param color - The color to modify.
+ * @param channel - The channel to modify.
+ * @param amount - The amount to add to the channel.
+ * @returns The color with the updated channel, in the original format.
  */
 export function addChannel(color, channel, amount) {
     switch (channel) {
@@ -114,10 +114,10 @@ export function addChannel(color, channel, amount) {
  * Multiplies a specific color channel by a factor.
  *
  * @template C - The input color type.
- * @param {C} color - The color to modify.
- * @param {Channel} channel - The channel to modify.
- * @param {number} factor - The multiplication factor.
- * @returns {TransformedColor<C>} The color with the updated channel, in the original format.
+ * @param color - The color to modify.
+ * @param channel - The channel to modify.
+ * @param factor - The multiplication factor.
+ * @returns The color with the updated channel, in the original format.
  */
 export function multChannel(color, channel, factor) {
     switch (channel) {

package/agnostic/colors/contrast/index.d.ts

@@ -1,10 +1,10 @@
-import type { Color, ContrastMethod } from '../types.js';
+import type { Color } from '../types.js';
 /**
  * Calculates the contrast ratio between two colors using the specified method.
  *
- * @param {Color} c1 - The first color.
- * @param {Color} c2 - The second color.
- * @param {ContrastMethod} [method='wcag'] - The calculation method to use.
- * @returns {number} The contrast ratio. For WCAG, values range from 1 (no contrast) to 21 (maximum contrast).
+ * @param c1 - The first color.
+ * @param c2 - The second color.
+ * @param [method='wcag'] - The calculation method to use.
+ * @returns The contrast ratio. For WCAG, values range from 1 (no contrast) to 21 (maximum contrast).
  */
-export declare function contrast(c1: Color, c2: Color, method?: ContrastMethod): number;
+export declare function contrast(c1: Color, c2: Color): number;

package/agnostic/colors/contrast/index.js

@@ -14,13 +14,11 @@ function contrastWcag(c1, c2) {
 /**
  * Calculates the contrast ratio between two colors using the specified method.
  *
- * @param {Color} c1 - The first color.
- * @param {Color} c2 - The second color.
- * @param {ContrastMethod} [method='wcag'] - The calculation method to use.
- * @returns {number} The contrast ratio. For WCAG, values range from 1 (no contrast) to 21 (maximum contrast).
+ * @param c1 - The first color.
+ * @param c2 - The second color.
+ * @param [method='wcag'] - The calculation method to use.
+ * @returns The contrast ratio. For WCAG, values range from 1 (no contrast) to 21 (maximum contrast).
  */
-export function contrast(c1, c2, method = 'wcag') {
-    switch (method) {
-        case 'wcag': return contrastWcag(toRgb(c1), toRgb(c2));
-    }
+export function contrast(c1, c2) {
+    return contrastWcag(toRgb(c1), toRgb(c2));
 }

package/agnostic/colors/contrast/index.test.js

@@ -11,7 +11,7 @@ describe('contrast', () => {
     });
     it('uses wcag method by default', () => {
         const result1 = contrast({ r: 255, g: 0, b: 0 }, { r: 0, g: 255, b: 0 });
-        const result2 = contrast({ r: 255, g: 0, b: 0 }, { r: 0, g: 255, b: 0 }, 'wcag');
+        const result2 = contrast({ r: 255, g: 0, b: 0 }, { r: 0, g: 255, b: 0 });
         expect(result1).toBe(result2);
     });
     it('returns value greater than 1 for any two colors', () => {

package/agnostic/colors/convert/index.d.ts

@@ -2,72 +2,72 @@ import type { Color, Hex, Rgba, Hsla, Hsba, Laba, Lcha, Cmyka, Xyza, CssColor, T
 /**
  * Converts any supported color format to RGBA.
  *
- * @param {Color} color - The color to convert.
- * @returns {Rgba} The color in RGBA format.
+ * @param color - The color to convert.
+ * @returns The color in RGBA format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toRgb(color: Color): Rgba;
 /**
  * Converts any supported color format to CIE XYZ.
  *
- * @param {Color} color - The color to convert.
- * @returns {Xyza} The color in CIE XYZ format.
+ * @param color - The color to convert.
+ * @returns The color in CIE XYZ format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toXyz(color: Color): Xyza;
 /**
  * Converts any supported color format to CIELAB.
  *
- * @param {Color} color - The color to convert.
- * @returns {Laba} The color in CIELAB format.
+ * @param color - The color to convert.
+ * @returns The color in CIELAB format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toLab(color: Color): Laba;
 /**
  * Converts any supported color format to CIELCh.
  *
- * @param {Color} color - The color to convert.
- * @returns {Lcha} The color in CIELCh format.
+ * @param color - The color to convert.
+ * @returns The color in CIELCh format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toLch(color: Color): Lcha;
 /**
  * Converts any supported color format to HSLA.
  *
- * @param {Color} color - The color to convert.
- * @returns {Hsla} The color in HSLA format.
+ * @param color - The color to convert.
+ * @returns The color in HSLA format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toHsl(color: Color): Hsla;
 /**
  * Converts any supported color format to HSBA (HSB/HSV).
  *
- * @param {Color} color - The color to convert.
- * @returns {Hsba} The color in HSBA format.
+ * @param color - The color to convert.
+ * @returns The color in HSBA format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toHsb(color: Color): Hsba;
 /**
  * Converts any supported color format to CMYK.
  *
- * @param {Color} color - The color to convert.
- * @returns {Cmyka} The color in CMYK format.
+ * @param color - The color to convert.
+ * @returns The color in CMYK format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toCmyk(color: Color): Cmyka;
 /**
  * Converts any supported color format to a CSS named color.
  *
- * @param {Color} color - The color to convert.
- * @returns {CssColor | undefined} The CSS named color if an exact match exists, otherwise undefined.
+ * @param color - The color to convert.
+ * @returns The CSS named color if an exact match exists, otherwise undefined.
  */
 export declare function toCss(color: CssColor): CssColor;
 export declare function toCss(color: Color): CssColor | undefined;
 /**
  * Converts any supported color format to hexadecimal.
  *
- * @param {Color} color - The color to convert.
- * @returns {Hex} The color in hexadecimal format.
+ * @param color - The color to convert.
+ * @returns The color in hexadecimal format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function toHex(color: Color): Hex;
@@ -76,9 +76,9 @@ export declare function toHex(color: Color): Hex;
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(rgb: Rgba) => Rgba} transformer - Function that transforms the RGBA representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the RGBA representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaRgb<C extends Color>(color: C, transformer: (rgb: Rgba) => Rgba): TransformedColor<C>;
@@ -87,9 +87,9 @@ export declare function viaRgb<C extends Color>(color: C, transformer: (rgb: Rgb
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(hsl: Hsla) => Hsla} transformer - Function that transforms the HSLA representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the HSLA representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaHsl<C extends Color>(color: C, transformer: (hsl: Hsla) => Hsla): TransformedColor<C>;
@@ -98,9 +98,9 @@ export declare function viaHsl<C extends Color>(color: C, transformer: (hsl: Hsl
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(hsb: Hsba) => Hsba} transformer - Function that transforms the HSBA representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the HSBA representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaHsb<C extends Color>(color: C, transformer: (hsb: Hsba) => Hsba): TransformedColor<C>;
@@ -109,9 +109,9 @@ export declare function viaHsb<C extends Color>(color: C, transformer: (hsb: Hsb
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(cmyk: Cmyka) => Cmyka} transformer - Function that transforms the CMYK representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the CMYK representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaCmyk<C extends Color>(color: C, transformer: (cmyk: Cmyka) => Cmyka): TransformedColor<C>;
@@ -120,9 +120,9 @@ export declare function viaCmyk<C extends Color>(color: C, transformer: (cmyk: C
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(xyz: Xyza) => Xyza} transformer - Function that transforms the XYZ representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the XYZ representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaXyz<C extends Color>(color: C, transformer: (xyz: Xyza) => Xyza): TransformedColor<C>;
@@ -131,9 +131,9 @@ export declare function viaXyz<C extends Color>(color: C, transformer: (xyz: Xyz
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(lab: Laba) => Laba} transformer - Function that transforms the CIELAB representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the CIELAB representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaLab<C extends Color>(color: C, transformer: (lab: Laba) => Laba): TransformedColor<C>;
@@ -142,23 +142,23 @@ export declare function viaLab<C extends Color>(color: C, transformer: (lab: Lab
  * then converting back to the original color format.
  *
  * @template C - The input color type.
- * @param {C} color - The color to transform.
- * @param {(lch: Lcha) => Lcha} transformer - Function that transforms the CIELCh representation.
- * @returns {TransformedColor<C>} The transformed color in the original format.
+ * @param color - The color to transform.
+ * @param transformer - Function that transforms the CIELCh representation.
+ * @returns The transformed color in the original format.
  * @throws {Error} If the color format is invalid or unsupported.
  */
 export declare function viaLch<C extends Color>(color: C, transformer: (lch: Lcha) => Lcha): TransformedColor<C>;
 /**
  * Converts an RGBA color to linear sRGB color space by applying inverse gamma correction.
  *
- * @param {Rgba} rgb - The RGBA color to linearize.
- * @returns {Srgba} The linearized color in sRGB color space.
+ * @param rgb - The RGBA color to linearize.
+ * @returns The linearized color in sRGB color space.
  */
 export declare function linearizeToSRgb(rgb: Rgba): Srgba;
 /**
  * Converts a linear sRGB color to RGBA by applying gamma correction.
  *
- * @param {Srgba} srgb - The linear sRGB color to delinearize.
- * @returns {Rgba} The delinearized color in RGBA format.
+ * @param srgb - The linear sRGB color to delinearize.
+ * @returns The delinearized color in RGBA format.
  */
 export declare function delinearizeToRgb(srgb: Srgba): Rgba;