yuyeon 0.1.0-rc.13 → 0.1.0-rc.16

package/dist/util/color/hct/hct-solver.d.ts

@@ -0,0 +1,131 @@
+import { Cam16 } from './cam16';
+
+/**
+ * A class that solves the HCT equation.
+ */
+export declare class HctSolver {
+    static SCALED_DISCOUNT_FROM_LINRGB: number[][];
+    static LINRGB_FROM_SCALED_DISCOUNT: number[][];
+    static Y_FROM_LINRGB: number[];
+    static CRITICAL_PLANES: number[];
+    /**
+     * Sanitizes a small enough angle in radians.
+     *
+     * @param angle An angle in radians; must not deviate too much
+     * from 0.
+     * @return A coterminal angle between 0 and 2pi.
+     */
+    private static sanitizeRadians;
+    /**
+     * Delinearizes an RGB component, returning a floating-point
+     * number.
+     *
+     * @param rgbComponent 0.0 <= rgb_component <= 100.0, represents
+     * linear R/G/B channel
+     * @return 0.0 <= output <= 255.0, color channel converted to
+     * regular RGB space
+     */
+    private static trueDelinearized;
+    private static chromaticAdaptation;
+    /**
+     * Returns the hue of a linear RGB color in CAM16.
+     *
+     * @param linrgb The linear RGB coordinates of a color.
+     * @return The hue of the color in CAM16, in radians.
+     */
+    private static hueOf;
+    private static areInCyclicOrder;
+    /**
+     * Solves the lerp equation.
+     *
+     * @param source The starting number.
+     * @param mid The number in the middle.
+     * @param target The ending number.
+     * @return A number t such that lerp(source, target, t) = mid.
+     */
+    private static intercept;
+    private static lerpPoint;
+    /**
+     * Intersects a segment with a plane.
+     *
+     * @param source The coordinates of point A.
+     * @param coordinate The R-, G-, or B-coordinate of the plane.
+     * @param target The coordinates of point B.
+     * @param axis The axis the plane is perpendicular with. (0: R, 1:
+     * G, 2: B)
+     * @return The intersection point of the segment AB with the plane
+     * R=coordinate, G=coordinate, or B=coordinate
+     */
+    private static setCoordinate;
+    private static isBounded;
+    /**
+     * Returns the nth possible vertex of the polygonal intersection.
+     *
+     * @param y The Y value of the plane.
+     * @param n The zero-based index of the point. 0 <= n <= 11.
+     * @return The nth possible vertex of the polygonal intersection
+     * of the y plane and the RGB cube, in linear RGB coordinates, if
+     * it exists. If this possible vertex lies outside of the cube,
+     * [-1.0, -1.0, -1.0] is returned.
+     */
+    private static nthVertex;
+    /**
+     * Finds the segment containing the desired color.
+     *
+     * @param y The Y value of the color.
+     * @param targetHue The hue of the color.
+     * @return A list of two sets of linear RGB coordinates, each
+     * corresponding to an endpoint of the segment containing the
+     * desired color.
+     */
+    private static bisectToSegment;
+    private static midpoint;
+    private static criticalPlaneBelow;
+    private static criticalPlaneAbove;
+    /**
+     * Finds a color with the given Y and hue on the boundary of the
+     * cube.
+     *
+     * @param y The Y value of the color.
+     * @param targetHue The hue of the color.
+     * @return The desired color, in linear RGB coordinates.
+     */
+    private static bisectToLimit;
+    private static inverseChromaticAdaptation;
+    /**
+     * Finds a color with the given hue, chroma, and Y.
+     *
+     * @param hueRadians The desired hue in radians.
+     * @param chroma The desired chroma.
+     * @param y The desired Y.
+     * @return The desired color as a hexadecimal integer, if found; 0
+     * otherwise.
+     */
+    private static findResultByJ;
+    /**
+     * Finds an sRGB color with the given hue, chroma, and L*, if
+     * possible.
+     *
+     * @param hueDegrees The desired hue, in degrees.
+     * @param chroma The desired chroma.
+     * @param lstar The desired L*.
+     * @return A hexadecimal representing the sRGB color. The color
+     * has sufficiently close hue, chroma, and L* to the desired
+     * values, if possible; otherwise, the hue and L* will be
+     * sufficiently close, and chroma will be maximized.
+     */
+    static solveToInt(hueDegrees: number, chroma: number, lstar: number): number;
+    /**
+     * Finds an sRGB color with the given hue, chroma, and L*, if
+     * possible.
+     *
+     * @param hueDegrees The desired hue, in degrees.
+     * @param chroma The desired chroma.
+     * @param lstar The desired L*.
+     * @return An CAM16 object representing the sRGB color. The color
+     * has sufficiently close hue, chroma, and L* to the desired
+     * values, if possible; otherwise, the hue and L* will be
+     * sufficiently close, and chroma will be maximized.
+     */
+    static solveToCam(hueDegrees: number, chroma: number, lstar: number): Cam16;
+}

package/dist/util/color/hct/hct.d.ts

@@ -0,0 +1,71 @@
+import { ViewingConditions } from './viewing-conditions';
+
+/**
+ * HCT, hue, chroma, and tone. A color system that provides a perceptually
+ * accurate color measurement system that can also accurately render what colors
+ * will appear as in different lighting environments.
+ */
+export declare class Hct {
+    private argb;
+    /**
+     * @param hue 0 <= hue < 360; invalid values are corrected.
+     * @param chroma 0 <= chroma < ?; Informally, colorfulness. The color
+     *     returned may be lower than the requested chroma. Chroma has a different
+     *     maximum for any given hue and tone.
+     * @param tone 0 <= tone <= 100; invalid values are corrected.
+     * @return HCT representation of a color in default viewing conditions.
+     */
+    internalHue: number;
+    internalChroma: number;
+    internalTone: number;
+    static from(hue: number, chroma: number, tone: number): Hct;
+    /**
+     * @param argb ARGB representation of a color.
+     * @return HCT representation of a color in default viewing conditions
+     */
+    static fromInt(argb: number): Hct;
+    toInt(): number;
+    /**
+     * A number, in degrees, representing ex. red, orange, yellow, etc.
+     * Ranges from 0 <= hue < 360.
+     */
+    get hue(): number;
+    /**
+     * @param newHue 0 <= newHue < 360; invalid values are corrected.
+     * Chroma may decrease because chroma has a different maximum for any given
+     * hue and tone.
+     */
+    set hue(newHue: number);
+    get chroma(): number;
+    /**
+     * @param newChroma 0 <= newChroma < ?
+     * Chroma may decrease because chroma has a different maximum for any given
+     * hue and tone.
+     */
+    set chroma(newChroma: number);
+    /** Lightness. Ranges from 0 to 100. */
+    get tone(): number;
+    /**
+     * @param newTone 0 <= newTone <= 100; invalid valids are corrected.
+     * Chroma may decrease because chroma has a different maximum for any given
+     * hue and tone.
+     */
+    set tone(newTone: number);
+    private constructor();
+    private setInternalState;
+    /**
+     * Translates a color into different [ViewingConditions].
+     *
+     * Colors change appearance. They look different with lights on versus off,
+     * the same color, as in hex code, on white looks different when on black.
+     * This is called color relativity, most famously explicated by Josef Albers
+     * in Interaction of Color.
+     *
+     * In color science, color appearance models can account for this and
+     * calculate the appearance of a color in different settings. HCT is based on
+     * CAM16, a color appearance model, and uses it to make these calculations.
+     *
+     * See [ViewingConditions.make] for parameters affecting color appearance.
+     */
+    inViewingConditions(vc: ViewingConditions): Hct;
+}

package/dist/util/color/hct/viewing-conditions.d.ts

@@ -0,0 +1,58 @@
+/**
+ * In traditional color spaces, a color can be identified solely by the
+ * observer's measurement of the color. Color appearance models such as CAM16
+ * also use information about the environment where the color was
+ * observed, known as the viewing conditions.
+ *
+ * For example, white under the traditional assumption of a midday sun white
+ * point is accurately measured as a slightly chromatic blue by CAM16. (roughly,
+ * hue 203, chroma 3, lightness 100)
+ *
+ * This class caches intermediate values of the CAM16 conversion process that
+ * depend only on viewing conditions, enabling speed ups.
+ */
+export declare class ViewingConditions {
+    n: number;
+    aw: number;
+    nbb: number;
+    ncb: number;
+    c: number;
+    nc: number;
+    rgbD: number[];
+    fl: number;
+    fLRoot: number;
+    z: number;
+    /** sRGB-like viewing conditions.  */
+    static DEFAULT: ViewingConditions;
+    /**
+     * Create ViewingConditions from a simple, physically relevant, set of
+     * parameters.
+     *
+     * @param whitePoint White point, measured in the XYZ color space.
+     *     default = D65, or sunny day afternoon
+     * @param adaptingLuminance The luminance of the adapting field. Informally,
+     *     how bright it is in the room where the color is viewed. Can be
+     *     calculated from lux by multiplying lux by 0.0586. default = 11.72,
+     *     or 200 lux.
+     * @param backgroundLstar The lightness of the area surrounding the color.
+     *     measured by L* in L*a*b*. default = 50.0
+     * @param surround A general description of the lighting surrounding the
+     *     color. 0 is pitch dark, like watching a movie in a theater. 1.0 is a
+     *     dimly light room, like watching TV at home at night. 2.0 means there
+     *     is no difference between the lighting on the color and around it.
+     *     default = 2.0
+     * @param discountingIlluminant Whether the eye accounts for the tint of the
+     *     ambient lighting, such as knowing an apple is still red in green light.
+     *     default = false, the eye does not perform this process on
+     *       self-luminous objects like displays.
+     */
+    static make(whitePoint?: number[], adaptingLuminance?: number, backgroundLstar?: number, surround?: number, discountingIlluminant?: boolean): ViewingConditions;
+    /**
+     * Parameters are intermediate values of the CAM16 conversion process. Their
+     * names are shorthand for technical color science terminology, this class
+     * would not benefit from documenting them individually. A brief overview
+     * is available in the CAM16 specification, and a complete overview requires
+     * a color science textbook, such as Fairchild's Color Appearance Models.
+     */
+    private constructor();
+}

package/dist/util/color/index.d.ts

@@ -0,0 +1,4 @@
+export declare function isColorValue(value: string): boolean;
+export declare function isTextColorIsLight(r: number, g: number, b: number): boolean;
+export * from './const';
+export * from './conversion';

package/dist/util/color/palettes/core-palette.d.ts

@@ -0,0 +1,44 @@
+import { TonalPalette } from './tonal-palette';
+
+/**
+ * Set of colors to generate a [CorePalette] from
+ */
+export interface CorePaletteColors {
+    primary: number;
+    secondary?: number;
+    tertiary?: number;
+    neutral?: number;
+    neutralVariant?: number;
+    error?: number;
+}
+/**
+ * An intermediate concept between the key color for a UI theme, and a full
+ * color scheme. 5 sets of tones are generated, all except one use the same hue
+ * as the key color, and all vary in chroma.
+ */
+export declare class CorePalette {
+    a1: TonalPalette;
+    a2: TonalPalette;
+    a3: TonalPalette;
+    n1: TonalPalette;
+    n2: TonalPalette;
+    error: TonalPalette;
+    /**
+     * @param argb ARGB representation of a color
+     */
+    static of(argb: number): CorePalette;
+    /**
+     * @param argb ARGB representation of a color
+     */
+    static contentOf(argb: number): CorePalette;
+    /**
+     * Create a [CorePalette] from a set of colors
+     */
+    static fromColors(colors: CorePaletteColors): CorePalette;
+    /**
+     * Create a content [CorePalette] from a set of colors
+     */
+    static contentFromColors(colors: CorePaletteColors): CorePalette;
+    private static createPaletteFromColors;
+    private constructor();
+}

package/dist/util/color/palettes/tonal-palette.d.ts

@@ -0,0 +1,40 @@
+import { Hct } from '../hct/hct';
+
+/**
+ *  A convenience class for retrieving colors that are constant in hue and
+ *  chroma, but vary in tone.
+ */
+export declare class TonalPalette {
+    readonly hue: number;
+    readonly chroma: number;
+    readonly keyColor: Hct;
+    private readonly cache;
+    /**
+     * @param argb ARGB representation of a color
+     * @return Tones matching that color's hue and chroma.
+     */
+    static fromInt(argb: number): TonalPalette;
+    /**
+     * @param hct Hct
+     * @return Tones matching that color's hue and chroma.
+     */
+    static fromHct(hct: Hct): TonalPalette;
+    /**
+     * @param hue HCT hue
+     * @param chroma HCT chroma
+     * @return Tones matching hue and chroma.
+     */
+    static fromHueAndChroma(hue: number, chroma: number): TonalPalette;
+    private constructor();
+    private static createKeyColor;
+    /**
+     * @param tone HCT tone, measured from 0 to 100.
+     * @return ARGB representation of a color with that tone.
+     */
+    tone(tone: number): number;
+    /**
+     * @param tone HCT tone.
+     * @return HCT representation of a color with that tone.
+     */
+    getHct(tone: number): Hct;
+}

package/dist/util/color/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * RGBA component
+ *
+ * @param r Red value should be between 0-255
+ * @param g Green value should be between 0-255
+ * @param b Blue value should be between 0-255
+ * @param a Alpha value should be between 0-255
+ */
+export interface Rgba {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}

package/dist/util/color/utils/math-utils.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Utility methods for mathematical operations.
+ */
+/**
+ * The signum function.
+ *
+ * @return 1 if num > 0, -1 if num < 0, and 0 if num = 0
+ */
+export declare function signum(num: number): number;
+/**
+ * The linear interpolation function.
+ *
+ * @return start if amount = 0 and stop if amount = 1
+ */
+export declare function lerp(start: number, stop: number, amount: number): number;
+/**
+ * Clamps an integer between two integers.
+ *
+ * @return input when min <= input <= max, and either min or max
+ * otherwise.
+ */
+export declare function clampInt(min: number, max: number, input: number): number;
+/**
+ * Clamps an integer between two floating-point numbers.
+ *
+ * @return input when min <= input <= max, and either min or max
+ * otherwise.
+ */
+export declare function clampDouble(min: number, max: number, input: number): number;
+/**
+ * Sanitizes a degree measure as an integer.
+ *
+ * @return a degree measure between 0 (inclusive) and 360
+ * (exclusive).
+ */
+export declare function sanitizeDegreesInt(degrees: number): number;
+/**
+ * Sanitizes a degree measure as a floating-point number.
+ *
+ * @return a degree measure between 0.0 (inclusive) and 360.0
+ * (exclusive).
+ */
+export declare function sanitizeDegreesDouble(degrees: number): number;
+/**
+ * Sign of direction change needed to travel from one angle to
+ * another.
+ *
+ * For angles that are 180 degrees apart from each other, both
+ * directions have the same travel distance, so either direction is
+ * shortest. The value 1.0 is returned in this case.
+ *
+ * @param from The angle travel starts from, in degrees.
+ * @param to The angle travel ends at, in degrees.
+ * @return -1 if decreasing from leads to the shortest travel
+ * distance, 1 if increasing from leads to the shortest travel
+ * distance.
+ */
+export declare function rotationDirection(from: number, to: number): number;
+/**
+ * Distance of two points on a circle, represented using degrees.
+ */
+export declare function differenceDegrees(a: number, b: number): number;
+/**
+ * Multiplies a 1x3 row vector with a 3x3 matrix.
+ */
+export declare function matrixMultiply(row: number[], matrix: number[][]): number[];

package/dist/util/common.d.ts

@@ -0,0 +1,13 @@
+export declare function hasOwnProperty(object: any, property: string): boolean;
+export declare function getNestedValue(obj: any, path: (string | number)[], fallback?: any): any;
+export declare function mergeDeep(source?: Record<string, any>, overwrite?: Record<string, any>, arrayFn?: (source: unknown[], overwrite: unknown[]) => unknown[]): {
+    [x: string]: any;
+};
+export declare function getObjectValueByPath(obj: any, path: string, fallback?: any): any;
+export type SelectItemKey = boolean | string | (string | number)[] | ((item: Record<string, any>, fallback?: any) => any);
+export declare function getPropertyFromItem(item: any, property: SelectItemKey, fallback?: any): any;
+export declare function clamp(value: number, min?: number, max?: number): number;
+export declare function getRangeArr(length: number, start?: number): number[];
+export declare function deepEqual(a: any, b: any): boolean;
+export declare function isObject(obj: unknown): boolean;
+export declare function omit<T extends object, U extends Extract<keyof T, string>>(obj: T, excludes: U[]): Omit<T, U>;

package/dist/util/date/adapters/yuyeon-date-adapter.d.ts

@@ -0,0 +1,43 @@
+import { DateAdapter, DateFormatOptions } from '../types';
+
+export declare class YuyeonDateAdapter implements DateAdapter<Date> {
+    locale: string;
+    formats?: Record<string, DateFormatOptions>;
+    constructor(options: {
+        locale: string;
+        formats?: Record<string, DateFormatOptions>;
+    });
+    getWeekArray(date: Date): Date[][];
+    startOfMonth(date: Date): Date;
+    endOfMonth(date: Date): Date;
+    addDays(date: Date, amount: number): Date;
+    addMonths(date: Date, amount: number): Date;
+    date(value?: any): Date | null;
+    endOfDay(date: Date): Date;
+    endOfYear(date: Date): Date;
+    format(date: Date, formatString: string): string;
+    getDiff(date: Date, comparing: string | Date, unit?: string): number;
+    getYear(date: Date): number;
+    getMonth(date: Date): number;
+    getDay(date: Date): number;
+    getNextMonth(date: Date): Date;
+    getWeekdays(): string[];
+    isAfter(date: Date, comparing: Date): boolean;
+    isBefore(date: Date, comparing: Date): boolean;
+    isEqual(date: Date, comparing: Date): boolean;
+    isSameDay(date: Date, comparing: Date): boolean;
+    isSameMonth(date: Date, comparing: Date): boolean;
+    isValid(date: any): boolean;
+    isWithinRange(date: Date, range: [Date, Date]): boolean;
+    parseISO(date: string): Date;
+    setMonth(date: Date, month: number): Date;
+    setYear(date: Date, year: number): Date;
+    startOfDay(date: Date): Date;
+    startOfYear(date: Date): Date;
+    toISO(date: Date): string;
+    toJsDate(date: Date): Date;
+    getHour(date: Date): number;
+    getMinute(date: Date): number;
+    setHour(date: Date, hour: number): Date;
+    setMinute(date: Date, minute: number): Date;
+}

package/dist/util/date/built-in.d.ts

@@ -0,0 +1,41 @@
+import { DateAdapter, DateFormatOptions } from './types';
+
+export declare const ONE_DAY: number;
+export declare const YYYY_MM_DD_REGEX: RegExp;
+export declare const FIRST_SUNDAY: Date;
+export declare class DateUtil {
+    static date(value?: any): Date | null;
+    static format(value: Date, formatString: string, locale: string, formats?: Record<string, DateFormatOptions>): string;
+    static parseLocalDate(value: string): Date;
+    static parseISO(value: string): Date;
+    static toISO(adapter: DateAdapter<any>, value: Date): string;
+    static getWeekArray(date: Date, locale: string): Date[][];
+    static startOfMonth(date: Date): Date;
+    static endOfMonth(date: Date): Date;
+    static startOfDay(date: Date): Date;
+    static startOfYear(date: Date): Date;
+    static endOfDay(date: Date): Date;
+    static endOfYear(date: Date): Date;
+    static getYear(date: Date): number;
+    static getMonth(date: Date): number;
+    static getDay(date: Date): number;
+    static getNextMonth(date: Date): Date;
+    static getWeekdays(locale: string): string[];
+    static getMeridians(locale: string): string[];
+    static isAfter(date: Date, comparing: Date): boolean;
+    static isBefore(date: Date, comparing: Date): boolean;
+    static isEqual(date: Date, comparing: Date): boolean;
+    static isSameDay(date: Date, comparing: Date): boolean;
+    static isSameMonth(date: Date, comparing: Date): boolean;
+    static isValid(date: any): boolean;
+    static isWithinRange(date: Date, range: [Date, Date]): boolean;
+    static addDays(date: Date, amount: number): Date;
+    static addMonths(date: Date, amount: number): Date;
+    static getDiff(date: Date, comparing: string | Date, unit?: 'month' | string): number;
+    static setMonth(date: Date, month: number): Date;
+    static setYear(date: Date, year: number): Date;
+    static getHour(date: Date): number;
+    static setHour(date: Date, hour: number): Date;
+    static getMinute(date: Date): number;
+    static setMinute(date: Date, minute: number): Date;
+}

package/dist/util/date/index.d.ts

@@ -0,0 +1,3 @@
+export * from './built-in';
+export { YuyeonDateAdapter } from './adapters/yuyeon-date-adapter';
+export declare function createDateAdapter(): void;