@oscarpalmer/atoms 0.74.1 → 0.76.0

package/types/colour/functions.d.cts

@@ -0,0 +1,173 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type HSLColourValue = {
+	hue: number;
+	lightness: number;
+	saturation: number;
+};
+declare class HSLColour extends Colour<HSLColourValue> {
+	/**
+	 * Get the current hue
+	 */
+	get hue(): number;
+	/**
+	 * Set the current hue
+	 */
+	set hue(value: number);
+	/**
+	 * Get the current lightness
+	 */
+	get lightness(): number;
+	/**
+	 * Set the current lightness
+	 */
+	set lightness(value: number);
+	/**
+	 * Get the current saturation
+	 */
+	get saturation(): number;
+	/**
+	 * Set the current saturation
+	 */
+	set saturation(value: number);
+	constructor(value: HSLColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an RGB-colour
+	 */
+	toRgb(): RGBColour;
+	/**
+	 * @inheritdoc
+	 */
+	toString(): string;
+	/**
+	 * Convert an HSL-colour to an RGB-colour
+	 */
+	static toRgb(value: HSLColourValue): RGBColour;
+}
+declare class HexColour {
+	private readonly $colour;
+	private readonly state;
+	/**
+	 * Get the value of the colour
+	 */
+	get value(): string;
+	/**
+	 * Set 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;
+}
+declare abstract class Colour<Model> {
+	private readonly $colour;
+	protected readonly state: ColourState<Model>;
+	/**
+	 * Get 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;
+};
+declare class RGBColour extends Colour<RGBColourValue> {
+	/**
+	 * Get the current blue value
+	 */
+	get blue(): number;
+	/**
+	 * Set the current blue value
+	 */
+	set blue(value: number);
+	/**
+	 * Get the current green value
+	 */
+	get green(): number;
+	/**
+	 * Set the current green value
+	 */
+	set green(value: number);
+	/**
+	 * Get the current red value
+	 */
+	get red(): number;
+	/**
+	 * Set the current red value
+	 */
+	set red(value: number);
+	constructor(value: RGBColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an HSL-colour
+	 */
+	toHsl(): HSLColour;
+	/**
+	 * @inheritdoc
+	 */
+	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;
+}
+export declare const anyPattern: RegExp;
+export declare function getNormalisedHex(value: string): string;
+/**
+ * Convert a hex-colour to an RGB-colour
+ */
+export declare function hexToRgb(value: string): RGBColour;
+/**
+ * - Convert an HSL-colour to an RGB-colour
+ * - Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L61
+ */
+export declare function hslToRgb(value: HSLColourValue): RGBColour;
+/**
+ * Convert an RGB-colour to a hex-colour
+ */
+export declare function rgbToHex(value: RGBColourValue): HexColour;
+/**
+ * - Convert an RGB-colour to an HSL-colour
+ * - Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26
+ */
+export declare function rgbToHsl(rgb: RGBColourValue): HSLColour;
+
+export {};

package/types/colour/functions.d.ts

@@ -1,6 +1,6 @@
-import { HexColour } from './hex';
-import { HSLColour, type HSLColourValue } from './hsl';
-import { RGBColour, type RGBColourValue } from './rgb';
+import { HexColour } from '~/colour/hex';
+import { HSLColour, type HSLColourValue } from '~/colour/hsl';
+import { RGBColour, type RGBColourValue } from '~/colour/rgb';
 export declare const anyPattern: RegExp;
 export declare function getNormalisedHex(value: string): string;
 /**

package/types/colour/hex.d.cts

@@ -0,0 +1,157 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type HSLColourValue = {
+	hue: number;
+	lightness: number;
+	saturation: number;
+};
+declare class HSLColour extends Colour<HSLColourValue> {
+	/**
+	 * Get the current hue
+	 */
+	get hue(): number;
+	/**
+	 * Set the current hue
+	 */
+	set hue(value: number);
+	/**
+	 * Get the current lightness
+	 */
+	get lightness(): number;
+	/**
+	 * Set the current lightness
+	 */
+	set lightness(value: number);
+	/**
+	 * Get the current saturation
+	 */
+	get saturation(): number;
+	/**
+	 * Set the current saturation
+	 */
+	set saturation(value: number);
+	constructor(value: HSLColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an RGB-colour
+	 */
+	toRgb(): RGBColour;
+	/**
+	 * @inheritdoc
+	 */
+	toString(): string;
+	/**
+	 * Convert an HSL-colour to an RGB-colour
+	 */
+	static toRgb(value: HSLColourValue): RGBColour;
+}
+export declare class HexColour {
+	private readonly $colour;
+	private readonly state;
+	/**
+	 * Get the value of the colour
+	 */
+	get value(): string;
+	/**
+	 * Set 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>;
+	/**
+	 * Get 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;
+};
+declare class RGBColour extends Colour<RGBColourValue> {
+	/**
+	 * Get the current blue value
+	 */
+	get blue(): number;
+	/**
+	 * Set the current blue value
+	 */
+	set blue(value: number);
+	/**
+	 * Get the current green value
+	 */
+	get green(): number;
+	/**
+	 * Set the current green value
+	 */
+	set green(value: number);
+	/**
+	 * Get the current red value
+	 */
+	get red(): number;
+	/**
+	 * Set the current red value
+	 */
+	set red(value: number);
+	constructor(value: RGBColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an HSL-colour
+	 */
+	toHsl(): HSLColour;
+	/**
+	 * @inheritdoc
+	 */
+	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;
+}
+
+export {};

package/types/colour/hex.d.ts

@@ -1,14 +1,14 @@
-import type { HSLColour } from './hsl';
-import type { RGBColour } from './rgb';
+import type { HSLColour } from '~/colour/hsl';
+import type { RGBColour } from '~/colour/rgb';
 export declare class HexColour {
     private readonly $colour;
     private readonly state;
     /**
-     * Gets the value of the colour
+     * Get the value of the colour
      */
     get value(): string;
     /**
-     * Sets the value of the colour
+     * Set the value of the colour
      */
     set value(value: string);
     constructor(value: string);

package/types/colour/hsl.d.cts

@@ -0,0 +1,157 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type HSLColourValue = {
+	hue: number;
+	lightness: number;
+	saturation: number;
+};
+export declare class HSLColour extends Colour<HSLColourValue> {
+	/**
+	 * Get the current hue
+	 */
+	get hue(): number;
+	/**
+	 * Set the current hue
+	 */
+	set hue(value: number);
+	/**
+	 * Get the current lightness
+	 */
+	get lightness(): number;
+	/**
+	 * Set the current lightness
+	 */
+	set lightness(value: number);
+	/**
+	 * Get the current saturation
+	 */
+	get saturation(): number;
+	/**
+	 * Set the current saturation
+	 */
+	set saturation(value: number);
+	constructor(value: HSLColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an RGB-colour
+	 */
+	toRgb(): RGBColour;
+	/**
+	 * @inheritdoc
+	 */
+	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;
+declare class HexColour {
+	private readonly $colour;
+	private readonly state;
+	/**
+	 * Get the value of the colour
+	 */
+	get value(): string;
+	/**
+	 * Set 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;
+}
+declare abstract class Colour<Model> {
+	private readonly $colour;
+	protected readonly state: ColourState<Model>;
+	/**
+	 * Get 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;
+};
+declare class RGBColour extends Colour<RGBColourValue> {
+	/**
+	 * Get the current blue value
+	 */
+	get blue(): number;
+	/**
+	 * Set the current blue value
+	 */
+	set blue(value: number);
+	/**
+	 * Get the current green value
+	 */
+	get green(): number;
+	/**
+	 * Set the current green value
+	 */
+	set green(value: number);
+	/**
+	 * Get the current red value
+	 */
+	get red(): number;
+	/**
+	 * Set the current red value
+	 */
+	set red(value: number);
+	constructor(value: RGBColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an HSL-colour
+	 */
+	toHsl(): HSLColour;
+	/**
+	 * @inheritdoc
+	 */
+	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;
+}
+
+export {};

package/types/colour/hsl.d.ts

@@ -1,6 +1,6 @@
-import { Colour } from './base';
-import type { HexColour } from './hex';
-import type { RGBColour } from './rgb';
+import { Colour } from '~/colour/base';
+import type { HexColour } from '~/colour/hex';
+import type { RGBColour } from '~/colour/rgb';
 export type HSLColourValue = {
     hue: number;
     lightness: number;
@@ -8,35 +8,41 @@ export type HSLColourValue = {
 };
 export declare class HSLColour extends Colour<HSLColourValue> {
     /**
-     * Gets the current hue
+     * Get the current hue
      */
     get hue(): number;
     /**
-     * Sets the current hue
+     * Set the current hue
      */
     set hue(value: number);
     /**
-     * Gets the current lightness
+     * Get the current lightness
      */
     get lightness(): number;
     /**
-     * Sets the current lightness
+     * Set the current lightness
      */
     set lightness(value: number);
     /**
-     * Gets the current saturation
+     * Get the current saturation
      */
     get saturation(): number;
     /**
-     * Sets the current saturation
+     * Set the current saturation
      */
     set saturation(value: number);
     constructor(value: HSLColourValue);
+    /**
+     * @inheritdoc
+     */
     toHex(): HexColour;
     /**
-     * Converts the colour to an RGB-colour
+     * Convert the colour to an RGB-colour
      */
     toRgb(): RGBColour;
+    /**
+     * @inheritdoc
+     */
     toString(): string;
     /**
      * Convert an HSL-colour to an RGB-colour

package/types/colour/index.d.cts

@@ -7,35 +7,41 @@ export type HSLColourValue = {
 };
 export declare class HSLColour extends Colour<HSLColourValue> {
 	/**
-	 * Gets the current hue
+	 * Get the current hue
 	 */
 	get hue(): number;
 	/**
-	 * Sets the current hue
+	 * Set the current hue
 	 */
 	set hue(value: number);
 	/**
-	 * Gets the current lightness
+	 * Get the current lightness
 	 */
 	get lightness(): number;
 	/**
-	 * Sets the current lightness
+	 * Set the current lightness
 	 */
 	set lightness(value: number);
 	/**
-	 * Gets the current saturation
+	 * Get the current saturation
 	 */
 	get saturation(): number;
 	/**
-	 * Sets the current saturation
+	 * Set the current saturation
 	 */
 	set saturation(value: number);
 	constructor(value: HSLColourValue);
+	/**
+	 * @inheritdoc
+	 */
 	toHex(): HexColour;
 	/**
-	 * Converts the colour to an RGB-colour
+	 * Convert the colour to an RGB-colour
 	 */
 	toRgb(): RGBColour;
+	/**
+	 * @inheritdoc
+	 */
 	toString(): string;
 	/**
 	 * Convert an HSL-colour to an RGB-colour
@@ -50,11 +56,11 @@ export declare class HexColour {
 	private readonly $colour;
 	private readonly state;
 	/**
-	 * Gets the value of the colour
+	 * Get the value of the colour
 	 */
 	get value(): string;
 	/**
-	 * Sets the value of the colour
+	 * Set the value of the colour
 	 */
 	set value(value: string);
 	constructor(value: string);
@@ -83,7 +89,7 @@ declare abstract class Colour<Model> {
 	private readonly $colour;
 	protected readonly state: ColourState<Model>;
 	/**
-	 * Gets the current value of the colour
+	 * Get the current value of the colour
 	 */
 	get value(): Model;
 	constructor(type: string, value: Model, defaults: Model, properties: Array<keyof Model>);
@@ -106,35 +112,41 @@ export type RGBColourValue = {
 };
 export declare class RGBColour extends Colour<RGBColourValue> {
 	/**
-	 * Gets the current blue value
+	 * Get the current blue value
 	 */
 	get blue(): number;
 	/**
-	 * Sets the current blue value
+	 * Set the current blue value
 	 */
 	set blue(value: number);
 	/**
-	 * Gets the current green value
+	 * Get the current green value
 	 */
 	get green(): number;
 	/**
-	 * Sets the current green value
+	 * Set the current green value
 	 */
 	set green(value: number);
 	/**
-	 * Gets the current red value
+	 * Get the current red value
 	 */
 	get red(): number;
 	/**
-	 * Sets the current red value
+	 * Set the current red value
 	 */
 	set red(value: number);
 	constructor(value: RGBColourValue);
+	/**
+	 * @inheritdoc
+	 */
 	toHex(): HexColour;
 	/**
 	 * Convert the colour to an HSL-colour
 	 */
 	toHsl(): HSLColour;
+	/**
+	 * @inheritdoc
+	 */
 	toString(): string;
 	/**
 	 * Convert an RGB-colour to a hex-colour

package/types/colour/index.d.ts

@@ -1,4 +1,4 @@
-import type { RGBColourValue } from './rgb';
+import type { RGBColourValue } from '~/colour/rgb';
 /**
  * Get a foreground colour _(usually text)_ based on a background colour's luminance
  */