@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/Core/Utilities/path.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Pull the directory portion out of a path string. Adapted from Node.js's path.dirname()
+ */
+export declare function getDirectoryName(path: string): string;
+/**
+ * Joins all given path segments together using the "/" as a delimiter, then normalizes the resulting path.
+ * Adapted from Node.js's path.join()
+ */
+export declare function combine(...args: string[]): string;
+/**
+ * Normalizes the given path, resolving '..' and '.' segments. When multiple, sequential "/"
+ * characters are found, they are replaced by a single instance of "/";
+ */
+export declare function normalize(path: string): string;
+/**
+ * Returns the extension of the path, from the last occurrence of the . character to end of string in the last portion
+ * of the path. If there is no . in the last portion of the path, or if there are no . characters other than the first
+ * character of the basename of path, an empty string is returned.
+ *
+ * Adapted from Node.js's path.extname
+ */
+export declare function getExtension(path: string): string;
+/**
+ * Returns the last portion of a path, similar to the Unix basename command. Trailing directory separators are ignored.
+ * Unlike the C# equivalent, if there is a trailing slash, this will still return the last part that comes before the trailing
+ * slash, whereas C# will treat it as a folder and will return an empty string. Also, unlike the C# version, this function
+ * allows you to specify an suffix to strip off the end of the result.
+ *
+ * Adapted from Node.js's path.basename()
+ */
+export declare function getFileName(path: string, suffix?: string): string;
+/**
+ * Returns the same thing as `getFileName`, but doesn't require you to know the extension and pass it in in order to
+ * exclude the extension.
+ */
+export declare function getFileNameWithoutExtension(path: string): string;

package/types/Core/Utilities/rockColor.d.ts

@@ -1,270 +1,270 @@
-import { ColorPair } from "./colorPair";
-import { ColorScheme } from "@Obsidian/Enums/Core/colorScheme";
-import { ColorRecipe } from "@Obsidian/Enums/Core/colorRecipe";
-/**
- * Utility class for color manipulation.
- */
-export declare class RockColor {
-    private readonly rgbInternal;
-    private alphaInternal;
-    private hueInternal;
-    private saturationInternal;
-    private luminosityInternal;
-    private textInternal?;
-    /**
-     * Gets or sets the Alpha level. This will be between 0 and 1.
-     */
-    get alpha(): number;
-    set alpha(value: number);
-    /**
-     * Gets or sets the Red value of the color. This will be between 0 and 255.
-     */
-    get r(): number;
-    set r(value: number);
-    /**
-     * Gets or sets the Green value of the color. This will be between 0 and 255.
-     */
-    get g(): number;
-    set g(value: number);
-    /**
-     * Gets or sets the Blue value of the color. This will be between 0 and 255.
-     */
-    get b(): number;
-    set b(value: number);
-    /**
-     * Calculates the luma value based on the W3 Standard.
-     */
-    get luma(): number;
-    /**
-     * Gets or sets the hue of the color.
-     */
-    get hue(): number;
-    set hue(value: number);
-    /**
-     * Gets or sets the saturation of the color.
-     */
-    get saturation(): number;
-    set saturation(value: number);
-    /**
-     * Gets or sets the luminosity of the color.
-     */
-    get luminosity(): number;
-    set luminosity(value: number);
-    /**
-     * Gets the color as a hexadecimal string, including the leading `#`.
-     */
-    get hex(): string;
-    /**
-     * Determines if the color is a light color.
-     */
-    get isLight(): boolean;
-    /**
-     * Determines if the color is a dark color.
-     */
-    get isDark(): boolean;
-    constructor(color: string);
-    constructor(rgb: number[]);
-    constructor(rgb: number[], alpha: number);
-    constructor(rgb: number[], alpha: number, text: string);
-    constructor(color: number);
-    constructor(red: number, green: number, blue: number);
-    constructor(red: number, green: number, blue: number, alpha: number);
-    constructor(red: number, green: number, blue: number, alpha?: number, text?: string);
-    /**
-     * Creates this instance from the specified number value. This is a numeric
-     * representation such as 0x112233.
-     *
-     * @param color The color has a number value.
-     */
-    private constructFromSingleNumber;
-    /**
-     * Creates this instance from the specified text value. This can be either
-     * a `#` hex value, an `rgba` value, an `rgb` value or a named HTML color.
-     *
-     * @param color The string that represents the color.
-     */
-    private constructFromString;
-    /**
-     * Creates this instance from the specified RGB and alpha values.
-     *
-     * @param rgb The RGB components, this must always have 3 components.
-     * @param alpha The alpha value to assign.
-     */
-    private constructFromRgb;
-    /**
-     * Updates the HSL values of the color from the RGB values.
-     */
-    private updateHslFromRgb;
-    /**
-     * Updates the RGB values of the color from the HSL values.
-     */
-    private updateRgbFromHsl;
-    /**
-     * Gets the {@link RockColor} that corresponds to the HTML color keyword.
-     *
-     * @param keyword The HTML color keyword.
-     *
-     * @returns An instance of {@link RockColor} that represents the color or `null` if not found.
-     */
-    static getColorFromKeyword(keyword: string): RockColor | null;
-    /**
-     * Calculates the contrast ratio between two colors.
-     *
-     * @param color1 The first color.
-     * @param color2 The second color.
-     *
-     * @returns A number that represents the contrast ratio between the two colors.
-     */
-    static calculateContrastRatio(color1: RockColor, color2: RockColor): number;
-    /**
-     * Creates a color pair from a single color with logic for light and
-     * dark modes.
-     *
-     * @param color The base color to use when creating the color pair.
-     * @param colorScheme The color scheme the color will be used in.
-     *
-     * @returns A new instance of {@link ColorPair}.
-     */
-    static calculateColorPair(color: RockColor, colorScheme?: ColorScheme): ColorPair;
-    /**
-     * Creates a recipe color from the provided color.
-     *
-     * @param color The base color to calculate the new color from.
-     * @param recipe The recipe to use when calculating the new color.
-     *
-     * @returns A new instance of {@link RockColor}.
-     */
-    static calculateColorRecipe(color: RockColor, recipe: ColorRecipe): RockColor;
-    /**
-     * Lightens the color by the provided percentage.
-     *
-     * @param percentage The percentage amount to lighten the color as a number between 0 and 100.
-     */
-    lighten(percentage: number): void;
-    /**
-     * Darkens the color by the provided percentage.
-     *
-     * @param percentage The percentage amount to darken the color as a number between 0 and 100.
-     */
-    darken(percentage: number): void;
-    /**
-     * Saturates the color by the provided percentage.
-     *
-     * @param percentage The percentage amount to saturate the color as a number between 0 and 100.
-     */
-    saturate(percentage: number): void;
-    /**
-     * Desaturates the color by the provided percentage.
-     *
-     * @param percentage The percentage amount to desaturate the color as a number between 0 and 100.
-     */
-    desaturate(percentage: number): void;
-    /**
-     * Increases the opacity level by the given percentage. This makes the
-     * color less transparent and more opaque.
-     *
-     * @param percentage The percentage amount to adjust the alpha as a number between 0 and 100.
-     */
-    fadeIn(percentage: number): void;
-    /**
-     * Decreases the opacity level by the given percentage. This makes the
-     * color more transparent and less opaque.
-     *
-     * @param percentage The percentage amount to adjust the alpha as a number between 0 and 100.
-     */
-    fadeOut(percentage: number): void;
-    /**
-     * Adjusts the hue by the specified percentage.
-     *
-     * @param percentage The percentage to adjust the hue by as a value between -100 and 100.
-     */
-    adjustHueByPercent(percentage: number): void;
-    /**
-     * Adjusts the hue by the specified number of degrees.
-     *
-     * @param degrees The number of degrees to adjust the hue by as a value between -360 and 360.
-     */
-    adjustHueByDegrees(degrees: number): void;
-    /**
-     * Tints the specified percentage amount. This mixes this color with white
-     * by the percentage.
-     *
-     * @param percentage The percentage amount as a value between 0 and 100.
-     */
-    tint(percentage: number): void;
-    /**
-     * Shades the specified percentage amount. This mixes this color with black
-     * by the percentage.
-     *
-     * @param percentage The percentage amount as a value between 0 and 100.
-     */
-    shade(percentage: number): void;
-    /**
-     * Mixes the specified color into the current color with an optional
-     * percentage amount.
-     *
-     * @param mixColor The color to be mixed into this color.
-     * @param percentage The percentage amount to be mixed as a value between 0 and 100. Defaults to 50.
-     */
-    mix(mixColor: RockColor, percentage?: number): void;
-    /**
-     * Turns the color to it's grayscale value.
-     */
-    grayscale(): void;
-    /**
-     * Creates a clone of this color.
-     *
-     * @returns A new instance that has the same color values as this instance.
-     */
-    clone(): RockColor;
-    /**
-     * Converts the current color to a CSS `rgba` string format.
-     *
-     * @returns A string representation of the color.
-     */
-    toRgba(): string;
-    /**
-     * Converts the current color to an HTML hexadecimal `#rrggbbaa` string
-     * format. If the alpha value is 1 then the "aa" component will not be
-     * included.
-     *
-     * @returns Hexadecimal version of the color.
-     */
-    toHex(): string;
-    /**
-     * Gets a numeric value representing this color. If two colors have the
-     * same RGB and Alpha values then they will return the same value here.
-     *
-     * @returns A numeric value that represents this unique color.
-     */
-    valueOf(): number;
-    /**
-     * Compares this color against another color to see which one has a higher
-     * value.
-     *
-     * @param otherColor The other color to compare this color to.
-     *
-     * @returns `0` if both colors are the same, `-1` if this color is less than the other color and `1` if this color is greater than the other color.
-     */
-    compareTo(otherColor: RockColor | undefined | null): number;
-    /**
-     * Determines if two colors are similar.
-     *
-     * @param otherColor The other color to compare this color to.
-     * @param similarityPercent The minimum percentage to consider the colors similar. This will be between 0 and 1 (defaults to 0.95).
-     * @returns `true` if the colors are N percent similar, where N is the `similarityPercentage`; otherwise, returns `false`.
-     * @example
-     * // this = new RockColor("#FFF")
-     * this.isSimilarTo(new RockColor("#FFE"), 0.95) // `true`, color similarity >= 95%
-     * this.isSimilarTo(new RockColor("#FFE"), 0.99) // `false`, color similarity < 99%
-     * this.isSimilarTo(new RockColor("#FFE"), 1) // `false`, color similarity != 100%
-     * this.isSimilarTo(new RockColor("#FFF"), 1) // `true`, color similarity = 100%
-     */
-    isSimilarTo(otherColor: RockColor, similarityPercent?: number): boolean;
-    /**
-     * Gets the sRGB value of this color.
-     *
-     * @returns This color in the standard RGB color space.
-     */
-    private toStandardRgb;
-}
+import { ColorPair } from "./colorPair";
+import { ColorScheme } from "@Obsidian/Enums/Core/colorScheme";
+import { ColorRecipe } from "@Obsidian/Enums/Core/colorRecipe";
+/**
+ * Utility class for color manipulation.
+ */
+export declare class RockColor {
+    private readonly rgbInternal;
+    private alphaInternal;
+    private hueInternal;
+    private saturationInternal;
+    private luminosityInternal;
+    private textInternal?;
+    /**
+     * Gets or sets the Alpha level. This will be between 0 and 1.
+     */
+    get alpha(): number;
+    set alpha(value: number);
+    /**
+     * Gets or sets the Red value of the color. This will be between 0 and 255.
+     */
+    get r(): number;
+    set r(value: number);
+    /**
+     * Gets or sets the Green value of the color. This will be between 0 and 255.
+     */
+    get g(): number;
+    set g(value: number);
+    /**
+     * Gets or sets the Blue value of the color. This will be between 0 and 255.
+     */
+    get b(): number;
+    set b(value: number);
+    /**
+     * Calculates the luma value based on the W3 Standard.
+     */
+    get luma(): number;
+    /**
+     * Gets or sets the hue of the color.
+     */
+    get hue(): number;
+    set hue(value: number);
+    /**
+     * Gets or sets the saturation of the color.
+     */
+    get saturation(): number;
+    set saturation(value: number);
+    /**
+     * Gets or sets the luminosity of the color.
+     */
+    get luminosity(): number;
+    set luminosity(value: number);
+    /**
+     * Gets the color as a hexadecimal string, including the leading `#`.
+     */
+    get hex(): string;
+    /**
+     * Determines if the color is a light color.
+     */
+    get isLight(): boolean;
+    /**
+     * Determines if the color is a dark color.
+     */
+    get isDark(): boolean;
+    constructor(color: string);
+    constructor(rgb: number[]);
+    constructor(rgb: number[], alpha: number);
+    constructor(rgb: number[], alpha: number, text: string);
+    constructor(color: number);
+    constructor(red: number, green: number, blue: number);
+    constructor(red: number, green: number, blue: number, alpha: number);
+    constructor(red: number, green: number, blue: number, alpha?: number, text?: string);
+    /**
+     * Creates this instance from the specified number value. This is a numeric
+     * representation such as 0x112233.
+     *
+     * @param color The color has a number value.
+     */
+    private constructFromSingleNumber;
+    /**
+     * Creates this instance from the specified text value. This can be either
+     * a `#` hex value, an `rgba` value, an `rgb` value or a named HTML color.
+     *
+     * @param color The string that represents the color.
+     */
+    private constructFromString;
+    /**
+     * Creates this instance from the specified RGB and alpha values.
+     *
+     * @param rgb The RGB components, this must always have 3 components.
+     * @param alpha The alpha value to assign.
+     */
+    private constructFromRgb;
+    /**
+     * Updates the HSL values of the color from the RGB values.
+     */
+    private updateHslFromRgb;
+    /**
+     * Updates the RGB values of the color from the HSL values.
+     */
+    private updateRgbFromHsl;
+    /**
+     * Gets the {@link RockColor} that corresponds to the HTML color keyword.
+     *
+     * @param keyword The HTML color keyword.
+     *
+     * @returns An instance of {@link RockColor} that represents the color or `null` if not found.
+     */
+    static getColorFromKeyword(keyword: string): RockColor | null;
+    /**
+     * Calculates the contrast ratio between two colors.
+     *
+     * @param color1 The first color.
+     * @param color2 The second color.
+     *
+     * @returns A number that represents the contrast ratio between the two colors.
+     */
+    static calculateContrastRatio(color1: RockColor, color2: RockColor): number;
+    /**
+     * Creates a color pair from a single color with logic for light and
+     * dark modes.
+     *
+     * @param color The base color to use when creating the color pair.
+     * @param colorScheme The color scheme the color will be used in.
+     *
+     * @returns A new instance of {@link ColorPair}.
+     */
+    static calculateColorPair(color: RockColor, colorScheme?: ColorScheme): ColorPair;
+    /**
+     * Creates a recipe color from the provided color.
+     *
+     * @param color The base color to calculate the new color from.
+     * @param recipe The recipe to use when calculating the new color.
+     *
+     * @returns A new instance of {@link RockColor}.
+     */
+    static calculateColorRecipe(color: RockColor, recipe: ColorRecipe): RockColor;
+    /**
+     * Lightens the color by the provided percentage.
+     *
+     * @param percentage The percentage amount to lighten the color as a number between 0 and 100.
+     */
+    lighten(percentage: number): void;
+    /**
+     * Darkens the color by the provided percentage.
+     *
+     * @param percentage The percentage amount to darken the color as a number between 0 and 100.
+     */
+    darken(percentage: number): void;
+    /**
+     * Saturates the color by the provided percentage.
+     *
+     * @param percentage The percentage amount to saturate the color as a number between 0 and 100.
+     */
+    saturate(percentage: number): void;
+    /**
+     * Desaturates the color by the provided percentage.
+     *
+     * @param percentage The percentage amount to desaturate the color as a number between 0 and 100.
+     */
+    desaturate(percentage: number): void;
+    /**
+     * Increases the opacity level by the given percentage. This makes the
+     * color less transparent and more opaque.
+     *
+     * @param percentage The percentage amount to adjust the alpha as a number between 0 and 100.
+     */
+    fadeIn(percentage: number): void;
+    /**
+     * Decreases the opacity level by the given percentage. This makes the
+     * color more transparent and less opaque.
+     *
+     * @param percentage The percentage amount to adjust the alpha as a number between 0 and 100.
+     */
+    fadeOut(percentage: number): void;
+    /**
+     * Adjusts the hue by the specified percentage.
+     *
+     * @param percentage The percentage to adjust the hue by as a value between -100 and 100.
+     */
+    adjustHueByPercent(percentage: number): void;
+    /**
+     * Adjusts the hue by the specified number of degrees.
+     *
+     * @param degrees The number of degrees to adjust the hue by as a value between -360 and 360.
+     */
+    adjustHueByDegrees(degrees: number): void;
+    /**
+     * Tints the specified percentage amount. This mixes this color with white
+     * by the percentage.
+     *
+     * @param percentage The percentage amount as a value between 0 and 100.
+     */
+    tint(percentage: number): void;
+    /**
+     * Shades the specified percentage amount. This mixes this color with black
+     * by the percentage.
+     *
+     * @param percentage The percentage amount as a value between 0 and 100.
+     */
+    shade(percentage: number): void;
+    /**
+     * Mixes the specified color into the current color with an optional
+     * percentage amount.
+     *
+     * @param mixColor The color to be mixed into this color.
+     * @param percentage The percentage amount to be mixed as a value between 0 and 100. Defaults to 50.
+     */
+    mix(mixColor: RockColor, percentage?: number): void;
+    /**
+     * Turns the color to it's grayscale value.
+     */
+    grayscale(): void;
+    /**
+     * Creates a clone of this color.
+     *
+     * @returns A new instance that has the same color values as this instance.
+     */
+    clone(): RockColor;
+    /**
+     * Converts the current color to a CSS `rgba` string format.
+     *
+     * @returns A string representation of the color.
+     */
+    toRgba(): string;
+    /**
+     * Converts the current color to an HTML hexadecimal `#rrggbbaa` string
+     * format. If the alpha value is 1 then the "aa" component will not be
+     * included.
+     *
+     * @returns Hexadecimal version of the color.
+     */
+    toHex(): string;
+    /**
+     * Gets a numeric value representing this color. If two colors have the
+     * same RGB and Alpha values then they will return the same value here.
+     *
+     * @returns A numeric value that represents this unique color.
+     */
+    valueOf(): number;
+    /**
+     * Compares this color against another color to see which one has a higher
+     * value.
+     *
+     * @param otherColor The other color to compare this color to.
+     *
+     * @returns `0` if both colors are the same, `-1` if this color is less than the other color and `1` if this color is greater than the other color.
+     */
+    compareTo(otherColor: RockColor | undefined | null): number;
+    /**
+     * Determines if two colors are similar.
+     *
+     * @param otherColor The other color to compare this color to.
+     * @param similarityPercent The minimum percentage to consider the colors similar. This will be between 0 and 1 (defaults to 0.95).
+     * @returns `true` if the colors are N percent similar, where N is the `similarityPercentage`; otherwise, returns `false`.
+     * @example
+     * // this = new RockColor("#FFF")
+     * this.isSimilarTo(new RockColor("#FFE"), 0.95) // `true`, color similarity >= 95%
+     * this.isSimilarTo(new RockColor("#FFE"), 0.99) // `false`, color similarity < 99%
+     * this.isSimilarTo(new RockColor("#FFE"), 1) // `false`, color similarity != 100%
+     * this.isSimilarTo(new RockColor("#FFF"), 1) // `true`, color similarity = 100%
+     */
+    isSimilarTo(otherColor: RockColor, similarityPercent?: number): boolean;
+    /**
+     * Gets the sRGB value of this color.
+     *
+     * @returns This color in the standard RGB color space.
+     */
+    private toStandardRgb;
+}