@oscarpalmer/atoms 0.73.0 → 0.74.0

package/package.json

@@ -14,10 +14,11 @@
 		"@types/bun": "^1.1.10",
 		"bun": "^1.1.29",
 		"dts-bundle-generator": "^9.5.1",
-		"sass": "^1.79.3",
+		"sass": "^1.79.4",
 		"typescript": "^5.6.2"
 	},
 	"exports": {
+		"./package.json": "./package.json",
 		".": {
 			"bun": "./src/js/index.ts",
 			"import": {
@@ -30,16 +31,26 @@
 			}
 		},
 		"./array": {
-			"types": "./types/array/index.d.ts",
 			"bun": "./src/js/array/index.ts",
-			"import": "./dist/js/array/index.mjs",
-			"require": "./dist/js/array/index.js"
+			"import": {
+				"types": "./types/array/index.d.ts",
+				"default": "./dist/js/array/index.mjs"
+			},
+			"require": {
+				"types": "./types/array/index.d.cts",
+				"default": "./dist/js/array/index.js"
+			}
 		},
 		"./colour": {
-			"types": "./types/colour/index.d.ts",
 			"bun": "./src/js/colour/index.ts",
-			"import": "./dist/js/colour/index.mjs",
-			"require": "./dist/js/colour/index.js"
+			"import": {
+				"types": "./types/colour/index.d.ts",
+				"default": "./dist/js/colour/index.mjs"
+			},
+			"require": {
+				"types": "./types/colour/index.d.cts",
+				"default": "./dist/js/colour/index.js"
+			}
 		},
 		"./css/a11y": {
 			"sass": "./src/css/a11y.scss",
@@ -54,93 +65,149 @@
 			"style": "./dist/css/reset.css"
 		},
 		"./emitter": {
-			"types": "./types/emitter.d.ts",
 			"bun": "./src/js/emitter.ts",
-			"import": "./dist/js/emitter.mjs",
-			"require": "./dist/js/emitter.js"
+			"import": {
+				"types": "./types/emitter.d.ts",
+				"default": "./dist/js/emitter.mjs"
+			},
+			"require": {
+				"types": "./types/emitter.d.cts",
+				"default": "./dist/js/emitter.js"
+			}
 		},
 		"./function": {
-			"types": "./types/function.d.ts",
 			"bun": "./src/js/function.ts",
-			"import": "./dist/js/function.mjs",
-			"require": "./dist/js/function.js"
+			"import": {
+				"types": "./types/function.d.ts",
+				"default": "./dist/js/function.mjs"
+			},
+			"require": {
+				"types": "./types/function.d.cts",
+				"default": "./dist/js/function.js"
+			}
 		},
 		"./is": {
-			"types": "./types/is.d.ts",
 			"bun": "./src/js/is.ts",
-			"import": "./dist/js/is.mjs",
-			"require": "./dist/js/is.js"
+			"import": {
+				"types": "./types/is.d.ts",
+				"default": "./dist/js/is.mjs"
+			},
+			"require": {
+				"types": "./types/is.d.cts",
+				"default": "./dist/js/is.js"
+			}
 		},
 		"./logger": {
-			"types": "./types/logger.d.ts",
 			"bun": "./src/js/logger.ts",
-			"import": "./dist/js/logger.mjs",
-			"require": "./dist/js/logger.js"
+			"import": {
+				"types": "./types/logger.d.ts",
+				"default": "./dist/js/logger.mjs"
+			},
+			"require": {
+				"types": "./types/logger.d.cts",
+				"default": "./dist/js/logger.js"
+			}
 		},
 		"./math": {
-			"types": "./types/math.d.ts",
 			"bun": "./src/js/math.ts",
-			"import": "./dist/js/math.mjs",
-			"require": "./dist/js/math.js"
+			"import": {
+				"types": "./types/math.d.ts",
+				"default": "./dist/js/math.mjs"
+			},
+			"require": {
+				"types": "./types/math.d.cts",
+				"default": "./dist/js/math.js"
+			}
 		},
 		"./models": {
-			"types": "./types/models.d.ts",
-			"bun": "./src/js/models.ts"
+			"bun": "./src/js/models.ts",
+			"import": {
+				"types": "./types/models.d.ts"
+			},
+			"require": {
+				"types": "./types/models.d.cts"
+			}
 		},
 		"./number": {
-			"types": "./types/number.d.ts",
 			"bun": "./src/js/number.ts",
-			"import": "./dist/js/number.mjs",
-			"require": "./dist/js/number.js"
+			"import": {
+				"types": "./types/number.d.ts",
+				"default": "./dist/js/number.mjs"
+			},
+			"require": {
+				"types": "./types/number.d.cts",
+				"default": "./dist/js/number.js"
+			}
 		},
 		"./query": {
-			"types": "./types/query.d.ts",
 			"bun": "./src/js/query.ts",
-			"import": "./dist/js/query.mjs",
-			"require": "./dist/js/query.js"
+			"import": {
+				"types": "./types/query.d.ts",
+				"default": "./dist/js/query.mjs"
+			},
+			"require": {
+				"types": "./types/query.d.cts",
+				"default": "./dist/js/query.js"
+			}
 		},
 		"./queue": {
-			"types": "./types/queue.d.ts",
 			"bun": "./src/js/queue.ts",
-			"import": "./dist/js/queue.mjs",
-			"require": "./dist/js/queue.js"
+			"import": {
+				"types": "./types/queue.d.ts",
+				"default": "./dist/js/queue.mjs"
+			},
+			"require": {
+				"types": "./types/queue.d.cts",
+				"default": "./dist/js/queue.js"
+			}
 		},
 		"./random": {
-			"types": "./types/random.d.ts",
 			"bun": "./src/js/random.ts",
-			"import": "./dist/js/random.mjs",
-			"require": "./dist/js/random.js"
+			"import": {
+				"types": "./types/random.d.ts",
+				"default": "./dist/js/random.mjs"
+			},
+			"require": {
+				"types": "./types/random.d.cts",
+				"default": "./dist/js/random.js"
+			}
 		},
 		"./string": {
-			"types": "./types/string/index.d.ts",
 			"bun": "./src/js/string/index.ts",
-			"import": "./dist/js/string/index.mjs",
-			"require": "./dist/js/string/index.js"
+			"import": {
+				"types": "./types/string/index.d.ts",
+				"default": "./dist/js/string/index.mjs"
+			},
+			"require": {
+				"types": "./types/string/index.d.cts",
+				"default": "./dist/js/string/index.js"
+			}
 		},
 		"./supports-touch": {
-			"types": "./types/touch.d.ts",
 			"bun": "./src/js/touch.ts",
-			"import": "./dist/js/touch.mjs",
-			"require": "./dist/js/touch.js"
+			"import": {
+				"types": "./types/touch.d.ts",
+				"default": "./dist/js/touch.mjs"
+			},
+			"require": {
+				"types": "./types/touch.d.cts",
+				"default": "./dist/js/touch.js"
+			}
 		},
 		"./value": {
-			"types": "./types/value/index.d.ts",
 			"bun": "./src/js/value/index.ts",
-			"import": "./dist/js/value/index.mjs",
-			"require": "./dist/js/value/index.js"
-		},
-		"./package.json": "./package.json"
+			"import": {
+				"types": "./types/value/index.d.ts",
+				"default": "./dist/js/value/index.mjs"
+			},
+			"require": {
+				"types": "./types/value/index.d.cts",
+				"default": "./dist/js/value/index.js"
+			}
+		}
 	},
-	"files": [
-		"dist/css/*.css",
-		"dist/js/*.js",
-		"dist/js/**/index.js",
-		"dist/js/element/focusable.js",
-		"dist/js/**/*.mjs",
-		"src",
-		"types"
-	],
-	"keywords": [],
+	"files": ["dist", "src", "types"],
+	"keywords": ["helper", "utility"],
 	"license": "MIT",
 	"main": "./dist/js/index.js",
 	"module": "./dist/js/index.mjs",
@@ -150,18 +217,15 @@
 		"url": "git+https://github.com/oscarpalmer/atoms.git"
 	},
 	"scripts": {
-		"build": "bun run clean && bun run build:css && bun run build:js && bun run types",
+		"build": "bun run clean && bun run build:css && bun run build:js",
 		"build:css": "bunx sass ./src/css:./dist/css --no-source-map",
-		"build:js": "bunx bun ./.bun.ts && bunx bun ./.bun.ts --mjs",
+		"build:js": "bunx bun ./.bun.ts && bunx bun ./.bun.ts --esm",
 		"clean": "rm -rf ./dist && rm -rf ./types && rm -f ./tsconfig.tsbuildinfo",
 		"test": "bun test",
-		"types": "bun run types:cjs && bun run types:esm",
-		"types:cjs": "bunx dts-bundle-generator --out-file ./types/index.d.cts --external-inlines 'type-fest' --no-check --silent ./src/js/index.ts",
-		"types:esm": "bunx tsc -p ./tsconfig.json",
 		"watch:css": "bunx sass ./src/css:./dist/css --no-source-map --watch",
 		"watch:js": "bun build ./src/js/index.ts --outfile ./dist/js/index.js --watch"
 	},
 	"type": "module",
 	"types": "./types/index.d.cts",
-	"version": "0.73.0"
+	"version": "0.74.0"
 }

package/types/array/index.d.cts

@@ -0,0 +1,194 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type NestedArrayType<Value> = Value extends Array<infer NestedValue> ? NestedArrayType<NestedValue> : Value;
+export type Key = number | string;
+/**
+ * Chunks an array into smaller arrays of a specified size
+ */
+export declare function chunk<Value>(array: Value[], size?: number): Value[][];
+/**
+ * Compacts and returns an array with all falsey values removed
+ */
+export declare function compact<Value>(array: Value[], strict: true): Exclude<Value, 0 | "" | false | null | undefined>[];
+/**
+ * Compacts and returns an array with all `null` and `undefined` values removed
+ */
+export declare function compact<Value>(array: Value[]): Exclude<Value, null | undefined>[];
+export type ArrayCallback<Value, Returned> = (value: Value, index: number, array: Value[]) => Returned;
+export type BooleanCallback<Value> = ArrayCallback<Value, boolean>;
+export type KeyCallback<Value> = ArrayCallback<Value, Key>;
+export type SortKey<Value> = {
+	direction: "asc" | "desc";
+	value: Key | SortKeyCallback<Value>;
+};
+export type SortKeyCallback<Value> = (value: Value) => Key;
+/**
+ * Returns the number of items _(count)_ that match the given value
+ */
+export declare function count<Model, Value>(array: Model[], value: Value | BooleanCallback<Model>): number;
+/**
+ * - Returns the number of items _(count)_ that match the given value
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function count<Model, Value = Model>(array: Model[], value: Value, key: Key | KeyCallback<Model>): number;
+/**
+ * Does the value exist in array?
+ */
+export declare function exists<Model, Value>(array: Model[], value: Value | BooleanCallback<Model>): boolean;
+/**
+ * - Does the value exist in array?
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function exists<Model, Value = Model>(array: Model[], value: Value, key: Key | KeyCallback<Model>): boolean;
+/**
+ * Returns a filtered array of items matching `value`
+ */
+export declare function filter<Model, Value>(array: Model[], value: Value | BooleanCallback<Model>): Model[];
+/**
+ * - Returns a filtered array of items
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function filter<Model, Value = Model>(array: Model[], value: Value, key: Key | KeyCallback<Model>): Model[];
+/**
+ * Returns the first item matching `value`, or `undefined` if no match is found
+ */
+export declare function find<Model, Value>(array: Model[], value: Value | BooleanCallback<Model>): Model | undefined;
+/**
+ * - Returns the first matching item, or `undefined` if no match is found
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function find<Model, Value = Model>(array: Model[], value: Value, key: Key | KeyCallback<Model>): Model | undefined;
+/**
+ * Groups an array of items using a key or callback
+ */
+export declare function groupBy<Value>(array: Value[], key: Key | KeyCallback<Value>): Record<Key, Value[]>;
+/**
+ * Returns the index for the first item matching `value`, or `-1` if no match is found
+ */
+export declare function indexOf<Model, Value>(array: Model[], value: Value | BooleanCallback<Model>): number;
+/**
+ * - Returns the index for the first matching item, or `-1` if no match is found
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function indexOf<Model, Value = Model>(array: Model[], value: Value, key: Key | KeyCallback<Model>): number;
+/**
+ * - Inserts values into an array at a specified index
+ * - Uses chunking to avoid stack overflow
+ */
+export declare function insert<Value>(array: Value[], index: number, values: Value[]): void;
+/**
+ * Shuffles an array
+ */
+export declare function shuffle<Value>(array: Value[]): Value[];
+/**
+ * Sorts an array of items _(ascending by default)_
+ */
+export declare function sort<Value>(array: Value[], descending?: boolean): Value[];
+/**
+ * - Sorts an array of items, using a `key` to sort by a specific value
+ * - Ascending by default, but can be changed by setting `descending` to `true`, or using a `SortKey`
+ */
+export declare function sort<Value>(array: Value[], key: Key | SortKey<Value> | SortKeyCallback<Value>, descending?: boolean): Value[];
+/**
+ * - Sorts an array of items, using multiple `keys` to sort by specific values
+ * - Ascending by default, but can be changed by setting `descending` to `true`, or using `SortKey`
+ */
+export declare function sort<Value>(array: Value[], keys: Array<Key | SortKey<Value> | SortKeyCallback<Value>>, descending?: boolean): Value[];
+/**
+ * Removes and returns all items from an array starting from a specific index
+ */
+export declare function splice<Value>(array: Value[], start: number): Value[];
+/**
+ * Removes and returns _(up to)_ a specific amount of items from an array, starting from a specific index
+ */
+export declare function splice<Value>(array: Value[], start: number, amount: number): Value[];
+/**
+ * - Splices values into an array and returns any removed values
+ * - Uses chunking to avoid stack overflow
+ */
+export declare function splice<Value>(array: Value[], start: number, values: Value[]): Value[];
+/**
+ * - Splices values into an array and returns any removed values
+ * - Uses chunking to avoid stack overflow
+ */
+export declare function splice<Value>(array: Value[], start: number, amount: number, values: Value[]): Value[];
+/**
+ * Converts an array into a map, using indices as keys
+ */
+export declare function toMap<Value>(array: Value[]): Map<number, Value>;
+/**
+ * Converts an array into a map, using indices as keys and grouping values into arrays
+ */
+export declare function toMap<Value>(array: Value[], arrays: true): Map<number, Value[]>;
+/**
+ * - Converts an array into a map
+ * - Uses `key` to find an identifcation value to use as keys
+ */
+export declare function toMap<Value>(array: Value[], key: Key): Map<Key, Value>;
+/**
+ * - Converts an array into a map
+ * - Uses `key` to find an identifcation value to use as keys
+ * - Groups values into arrays
+ */
+export declare function toMap<Value>(array: Value[], key: Key, arrays: true): Map<Key, Value[]>;
+/**
+ * - Converts an array into a map
+ * - Uses `key` to find an identifcation value to use as keys
+ */
+export declare function toMap<Value>(array: Value[], key: KeyCallback<Value>): Map<Key, Value>;
+/**
+ * - Converts an array into a map
+ * - Uses `key` to find an identifcation value to use as keys
+ * - Groups values into arrays
+ */
+export declare function toMap<Value>(array: Value[], key: KeyCallback<Value>, arrays: true): Map<Key, Value[]>;
+/**
+ * Converts an array into a record, using indices as keys
+ */
+export declare function toRecord<Value>(array: Value[]): Record<number, Value>;
+/**
+ * Converts an array into a record, using indices as keys and grouping values into arrays
+ */
+export declare function toRecord<Value>(array: Value[], arrays: true): Record<number, Value[]>;
+/**
+ * - Converts an array into a record
+ * - Uses `key` to find an identifcation value to use as keys
+ */
+export declare function toRecord<Value>(array: Value[], key: Key): Record<Key, Value>;
+/**
+ * - Converts an array into a record
+ * - Uses `key` to find an identifcation value to use as keys
+ * - Groups values into arrays
+ */
+export declare function toRecord<Value>(array: Value[], key: Key, arrays: true): Record<Key, Value[]>;
+/**
+ * - Converts an array into a record
+ * - Uses `key` to find an identifcation value to use as keys
+ */
+export declare function toRecord<Value>(array: Value[], key: KeyCallback<Value>): Record<Key, Value>;
+/**
+ * - Converts an array into a record
+ * - Uses `key` to find an identifcation value to use as keys
+ * - Groups values into arrays
+ */
+export declare function toRecord<Value>(array: Value[], key: KeyCallback<Value>, arrays: true): Record<Key, Value[]>;
+/**
+ * Returns an array of unique items
+ */
+export declare function unique<Value>(array: Value[]): Value[];
+/**
+ * - Returns an array of unique items
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function unique<Value>(array: Value[], key: Key | KeyCallback<Value>): Value[];
+/**
+ * Flattens an array _(using native `flat` and maximum depth)_
+ */
+export declare function flatten<Value>(array: Value[]): NestedArrayType<Value>[];
+/**
+ * - Pushes values to the end of an array, returning the new length
+ * - Uses chunking to avoid stack overflow
+ */
+export declare function push<Value>(array: Value[], values: Value[]): number;
+
+export {};

package/types/array/models.d.cts

@@ -0,0 +1,23 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type Key = number | string;
+export type ArrayCallback<Value, Returned> = (value: Value, index: number, array: Value[]) => Returned;
+export type BooleanCallback<Value> = ArrayCallback<Value, boolean>;
+export type Callbacks<Value> = {
+	bool?: BooleanCallback<Value>;
+	key?: KeyCallback<Value>;
+};
+export type FindType = "index" | "value";
+export type InsertType = "push" | "splice";
+export type KeyCallback<Value> = ArrayCallback<Value, Key>;
+export type SortKey<Value> = {
+	direction: "asc" | "desc";
+	value: Key | SortKeyCallback<Value>;
+};
+export type SortKeyCallback<Value> = (value: Value) => Key;
+export type SortKeyWithCallback<Value> = {
+	callback: SortKeyCallback<Value>;
+	direction: "asc" | "desc";
+};
+
+export {};

package/types/colour/index.d.cts

@@ -0,0 +1,173 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type HSLColourValue = {
+	hue: number;
+	lightness: number;
+	saturation: number;
+};
+export declare class HSLColour extends Colour<HSLColourValue> {
+	/**
+	 * Gets the current hue
+	 */
+	get hue(): number;
+	/**
+	 * Sets the current hue
+	 */
+	set hue(value: number);
+	/**
+	 * Gets the current lightness
+	 */
+	get lightness(): number;
+	/**
+	 * Sets the current lightness
+	 */
+	set lightness(value: number);
+	/**
+	 * Gets the current saturation
+	 */
+	get saturation(): number;
+	/**
+	 * Sets the current saturation
+	 */
+	set saturation(value: number);
+	constructor(value: HSLColourValue);
+	toHex(): HexColour;
+	/**
+	 * Converts the colour to an RGB-colour
+	 */
+	toRgb(): RGBColour;
+	toString(): string;
+	/**
+	 * Convert an HSL-colour to an RGB-colour
+	 */
+	static toRgb(value: HSLColourValue): RGBColour;
+}
+/**
+ * Get an HSL-colour from a value-object
+ */
+export declare function getHSLColour(value: HSLColourValue): HSLColour;
+export declare class HexColour {
+	private readonly $colour;
+	private readonly state;
+	/**
+	 * Gets the value of the colour
+	 */
+	get value(): string;
+	/**
+	 * Sets the value of the colour
+	 */
+	set value(value: string);
+	constructor(value: string);
+	/**
+	 * Convert the colour to an RGB-colour
+	 */
+	toHsl(): HSLColour;
+	/**
+	 * Convert the colour to an HSL-colour
+	 */
+	toRgb(): RGBColour;
+	/**
+	 * Get the colour as a string _(prefixed with #)_
+	 */
+	toString(): string;
+	/**
+	 * Convert a hex-colour to an RGB-colour
+	 */
+	static toRgb(value: string): RGBColour;
+}
+/**
+ * Get a hex-colour from a string
+ */
+export declare function getHexColour(value: string): HexColour;
+declare abstract class Colour<Model> {
+	private readonly $colour;
+	protected readonly state: ColourState<Model>;
+	/**
+	 * Gets the current value of the colour
+	 */
+	get value(): Model;
+	constructor(type: string, value: Model, defaults: Model, properties: Array<keyof Model>);
+	/**
+	 * Convert the colour to a hex-colour
+	 */
+	abstract toHex(): HexColour;
+	/**
+	 * Get the colour as a _CSS-formatted_ string
+	 */
+	abstract toString(): string;
+}
+export type ColourState<Model> = {
+	value: Model;
+};
+export type RGBColourValue = {
+	blue: number;
+	green: number;
+	red: number;
+};
+export declare class RGBColour extends Colour<RGBColourValue> {
+	/**
+	 * Gets the current blue value
+	 */
+	get blue(): number;
+	/**
+	 * Sets the current blue value
+	 */
+	set blue(value: number);
+	/**
+	 * Gets the current green value
+	 */
+	get green(): number;
+	/**
+	 * Sets the current green value
+	 */
+	set green(value: number);
+	/**
+	 * Gets the current red value
+	 */
+	get red(): number;
+	/**
+	 * Sets the current red value
+	 */
+	set red(value: number);
+	constructor(value: RGBColourValue);
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an HSL-colour
+	 */
+	toHsl(): HSLColour;
+	toString(): string;
+	/**
+	 * Convert an RGB-colour to a hex-colour
+	 */
+	static toHex(value: RGBColourValue): HexColour;
+	/**
+	 * - Convert an RGB-colour to an HSL-colour
+	 */
+	static toHsl(rgb: RGBColourValue): HSLColour;
+}
+/**
+ * Get an RGB-colour from a value-object
+ */
+export declare function getRGBColour(value: RGBColourValue): RGBColour;
+/**
+ * Is the value a colour?
+ */
+export declare function isColour(value: unknown): value is HexColour | HSLColour | RGBColour;
+/**
+ * Is the value a hex-colour?
+ */
+export declare function isHexColour(value: unknown): value is HexColour;
+/**
+ * Is the value an HSL-colour?
+ */
+export declare function isHSLColour(value: unknown): value is HSLColour;
+/**
+ * Is the value an RGB-colour?
+ */
+export declare function isRGBColour(value: unknown): value is RGBColour;
+/**
+ * Get a foreground colour _(usually text)_ based on a background colour's luminance
+ */
+export declare function getForegroundColour(value: RGBColourValue): string;
+
+export {};