hue.gl 0.0.9 → 0.0.11

package/js/color/ColorPicker.d.ts

@@ -0,0 +1,11 @@
+type ColorEnum = 'RGB' | 'HSL' | 'HCL' | 'HEX';
+export declare class ColorPicker {
+    /**
+     * Retrieves a color value by its enum key.
+     * @param colorEnum The enum type ('RGB' or 'HSL') to pick the color from.
+     * @param colorKey The key of the color in the specified enum.
+     * @returns The color value or null if the key does not exist in the specified enum.
+     */
+    static get(colorEnum: ColorEnum, colorKey: string): string | null;
+}
+export {};

package/js/color/ColorPicker.js

@@ -0,0 +1,53 @@
+"use strict";
+// script/class/class/DirectoryCleaner.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColorPicker = void 0;
+// Copyright 2023 Scape Agency BV
+// 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.
+// ============================================================================
+// Import
+// ============================================================================
+var constants_1 = require("../constants");
+// ============================================================================
+// Classes
+// ============================================================================
+class ColorPicker {
+    /**
+     * Retrieves a color value by its enum key.
+     * @param colorEnum The enum type ('RGB' or 'HSL') to pick the color from.
+     * @param colorKey The key of the color in the specified enum.
+     * @returns The color value or null if the key does not exist in the specified enum.
+     */
+    static get(colorEnum, colorKey) {
+        let color;
+        switch (colorEnum) {
+            case 'RGB':
+                // color = hue_rgb[colorKey as keyof typeof hue_rgb];
+                return constants_1.hue_rgb[colorKey] || null;
+            // break;
+            case 'HCL':
+                // color = hue_hcl[colorKey as keyof typeof hue_hcl];
+                return constants_1.hue_hcl[colorKey] || null;
+            // break;
+            case 'HEX':
+                // color = hue_hex[colorKey as keyof typeof hue_hex];
+                return constants_1.hue_hex[colorKey] || null;
+            // break;
+            default:
+                return null;
+        }
+        // return color || null;
+    }
+}
+exports.ColorPicker = ColorPicker;
+// Usage examples
+// const specificRGBColor = ColorPicker.getColor('RGB', 'N0001'); // Should return "rgb(0, 0, 90)" or similar
+// console.log(specificRGBColor); // Outputs: rgb(0, 0, 90) or similar

package/js/color/ColorScheme.d.ts

@@ -0,0 +1,23 @@
+import { ColorSwatch } from './ColorSwatch.js';
+type ColorSchemeConfig = {
+    prefix?: string;
+    h_step?: number;
+    p_count?: number;
+    l_l_min?: number;
+    l_l_step?: number;
+    d_l_step?: number;
+    l_c_min?: number;
+    l_c_step?: number;
+    d_c_step?: number;
+};
+export declare class ColorScheme {
+    config: ColorSchemeConfig | any;
+    names: any;
+    colorList: ColorSwatch[];
+    colorDict: Record<string, Record<string, ColorSwatch>>;
+    constructor(config: ColorSchemeConfig, names: any);
+    private initializeColors;
+    getColorList(): ColorSwatch[];
+    getColorDict(): Record<string, Record<string, ColorSwatch>>;
+}
+export {};

package/js/color/ColorScheme.js

@@ -0,0 +1,90 @@
+"use strict";
+// script/class/class/DirectoryCleaner.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColorScheme = void 0;
+// Copyright 2023 Scape Agency BV
+// 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.
+// ============================================================================
+// Import
+// ============================================================================
+var ColorSwatch_js_1 = require("./ColorSwatch.js");
+var util_js_1 = require("../util.js");
+// ============================================================================
+// Classes
+// ============================================================================
+class ColorScheme {
+    constructor(config, names) {
+        // Initialize colorList and other properties based on config
+        this.config = config;
+        this.names = names;
+        this.colorList = [];
+        this.colorDict = {};
+        this.initializeColors();
+    }
+    initializeColors() {
+        // Logic to initialize colorList based on the provided configuration
+        const l_count = Math.ceil(this.config.p_count / 2);
+        const d_count = Math.floor(this.config.p_count / 2);
+        const d_l_min = this.config.l_l_min + (this.config.l_l_step * (l_count - 1));
+        const d_c_min = this.config.l_c_min + (this.config.l_c_step * (l_count - 1));
+        // Create LC lists
+        // --------------------------------------------------------------------
+        // const l_list  = [0];
+        // const c_list  = [0];
+        const l_list = [];
+        const c_list = [];
+        for (let i = 0; i < this.config.p_count; i++) {
+            let l_cur = this.config.l_l_min + this.config.l_l_step + i * this.config.l_l_step - 2 * i;
+            l_list.push(l_cur);
+        }
+        ;
+        for (let i = 0; i < l_count; i++) {
+            let c_cur = this.config.l_c_min + i * this.config.l_c_step;
+            c_list.push(c_cur);
+        }
+        ;
+        for (let i = 0; i < d_count; i++) {
+            let c_cur = d_c_min + this.config.d_c_step + i * this.config.d_c_step;
+            c_list.push(c_cur);
+        }
+        ;
+        // Create hue.gl
+        // --------------------------------------------------------------------
+        // for (let h = this.config.h_step; h <= 360; h += this.config.h_step) {
+        for (let h = 0; h <= 360; h += this.config.h_step) {
+            let h_group = {};
+            // let h_group_name = h.toString();
+            let h_group_name = this.names[h];
+            ;
+            for (let i = 0; i < this.config.p_count; i++) {
+                let l_cur = l_list[i];
+                let c_cur = c_list[i];
+                if (h == 0) {
+                    c_cur = 0;
+                }
+                ;
+                let name = this.config.prefix + (0, util_js_1.pad)(h.toString(), 3, "0") + (i + 1).toString();
+                let color = new ColorSwatch_js_1.ColorSwatch(h, c_cur, l_cur, name);
+                this.colorList.push(color);
+                h_group[name] = color;
+            }
+            ;
+            this.colorDict[h_group_name] = h_group;
+        }
+    }
+    getColorList() {
+        return this.colorList;
+    }
+    getColorDict() {
+        return this.colorDict;
+    }
+}
+exports.ColorScheme = ColorScheme;

package/js/color/ColorSwatch.d.ts

@@ -0,0 +1,54 @@
+import Color from 'colorjs.io';
+export declare class ColorSwatch {
+    name?: string;
+    h: number;
+    c: number;
+    l: number;
+    model: Color;
+    constructor(h: number, c: number, l: number, name?: string);
+    setHCL(h: number, c: number, l: number): void;
+    checkGamut(color_constant: Color): boolean;
+    getName(): string | undefined;
+    getRGB(): [number, number, number];
+    a98rgb(): import("colorjs.io/types/src/color.js").Coords;
+    a98rgb_linear(): import("colorjs.io/types/src/color.js").Coords;
+    acescg(): import("colorjs.io/types/src/color.js").Coords;
+    hsl(): import("colorjs.io/types/src/color.js").Coords;
+    hsv(): import("colorjs.io/types/src/color.js").Coords;
+    hwb(): import("colorjs.io/types/src/color.js").Coords;
+    ictcp(): import("colorjs.io/types/src/color.js").Coords;
+    jzczhz(): import("colorjs.io/types/src/color.js").Coords;
+    jzazbz(): import("colorjs.io/types/src/color.js").Coords;
+    lab(): import("colorjs.io/types/src/color.js").Coords;
+    lab_d65(): import("colorjs.io/types/src/color.js").Coords;
+    lch(): import("colorjs.io/types/src/color.js").Coords;
+    oklch(): import("colorjs.io/types/src/color.js").Coords;
+    oklab(): import("colorjs.io/types/src/color.js").Coords;
+    p3(): import("colorjs.io/types/src/color.js").Coords;
+    p3_linear(): import("colorjs.io/types/src/color.js").Coords;
+    prophoto(): import("colorjs.io/types/src/color.js").Coords;
+    prophoto_linear(): import("colorjs.io/types/src/color.js").Coords;
+    rec2020(): import("colorjs.io/types/src/color.js").Coords;
+    rec2020_linear(): import("colorjs.io/types/src/color.js").Coords;
+    rec2100hlg(): import("colorjs.io/types/src/color.js").Coords;
+    rec2100pq(): import("colorjs.io/types/src/color.js").Coords;
+    xyz_abs_d65(): import("colorjs.io/types/src/color.js").Coords;
+    xyz_d50(): import("colorjs.io/types/src/color.js").Coords;
+    xyz_d65(): import("colorjs.io/types/src/color.js").Coords;
+    xyz(): import("colorjs.io/types/src/color.js").Coords;
+    srgb(): Color;
+    srgb_linear(): import("colorjs.io/types/src/color.js").Coords;
+    hex(): string;
+    hcl(): {
+        h: number;
+        c: number;
+        l: number;
+    };
+    rgb(): {
+        r: number;
+        g: number;
+        b: number;
+    };
+    toString(): string;
+    toDict(): Record<string, any>;
+}

package/js/color/ColorSwatch.js

@@ -0,0 +1,258 @@
+"use strict";
+// Copyright 2023 Scape Agency BV
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColorSwatch = void 0;
+// 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.
+// ============================================================================
+// Import
+// ============================================================================
+var colorjs_io_1 = __importDefault(require("colorjs.io"));
+var util_js_1 = require("../util.js");
+// ============================================================================
+// Classes
+// ============================================================================
+class ColorSwatch {
+    constructor(h, c, l, name) {
+        this.h = 0; // Hue (0-360)
+        this.c = 0; // Chroma (0-100)
+        this.l = 0; // Luminance (0-100)
+        if (h < 0 || h > 360 || c < 0 || c > 100 || l < 0 || l > 100) {
+            throw new Error("Invalid HCL values");
+        }
+        this.h = h;
+        this.c = c;
+        this.l = l;
+        // this.setHCL(h, c, l);
+        this.name = name;
+        this.model = new colorjs_io_1.default("lch", [l, c, h]);
+        ;
+    }
+    setHCL(h, c, l) {
+        if (h < 0 || h > 360 || c < 0 || c > 100 || l < 0 || l > 100) {
+            throw new Error("Invalid HCL values");
+        }
+        this.h = h;
+        this.c = c;
+        this.l = l;
+    }
+    /// Color Gamut Checks
+    checkGamut(color_constant) {
+        let lch_in_gamut = (color_constant.to("lch")).inGamut();
+        let srgb_in_gamut = (color_constant.to("srgb")).inGamut();
+        let argb_in_gamut = (color_constant.to("a98rgb")).inGamut();
+        // console.log(argb_in_gamut);
+        let in_gamut;
+        if (lch_in_gamut == false ||
+            srgb_in_gamut == false ||
+            argb_in_gamut == false) {
+            in_gamut = false;
+            // color_object = new Color("white");
+        }
+        else {
+            in_gamut = true;
+        }
+        return in_gamut;
+    }
+    getName() {
+        return this.name;
+    }
+    // HCL(): [number, number, number] {
+    //     return [this.h, this.c, this.l];
+    // }
+    getRGB() {
+        // const color_constant = new Color("lch", [l, c, h]);
+        // let color_object = color_constant
+        // Convert HCL to RGB here
+        // This is a non-trivial conversion and may require a detailed algorithm or library
+        // Placeholder for conversion logic
+        return [0, 0, 0]; // Replace with actual conversion logic
+    }
+    // Color Space Conversions
+    // ========================================================================
+    a98rgb() {
+        let color = this.model.to("a98rgb");
+        return color.coords;
+    }
+    a98rgb_linear() {
+        let color = this.model.to("a98rgb-linear");
+        return color.coords;
+    }
+    acescg() {
+        let color = this.model.to("acescg");
+        return color.coords;
+    }
+    hsl() {
+        let color = this.model.to("hsl");
+        return color.coords;
+    }
+    hsv() {
+        let color = this.model.to("hsv");
+        return color.coords;
+    }
+    hwb() {
+        let color = this.model.to("hwb");
+        return color.coords;
+    }
+    ictcp() {
+        let color = this.model.to("ictcp");
+        return color.coords;
+    }
+    jzczhz() {
+        let color = this.model.to("jzczhz");
+        return color.coords;
+    }
+    jzazbz() {
+        let color = this.model.to("jzazbz");
+        return color.coords;
+    }
+    lab() {
+        let color = this.model.to("lab");
+        return color.coords;
+    }
+    lab_d65() {
+        let color = this.model.to("lab-d65");
+        return color.coords;
+    }
+    lch() {
+        let color = this.model.to("lch");
+        return color.coords;
+    }
+    oklch() {
+        let color = this.model.to("oklch");
+        return color.coords;
+    }
+    oklab() {
+        let color = this.model.to("oklab");
+        return color.coords;
+    }
+    p3() {
+        let color = this.model.to("p3");
+        return color.coords;
+    }
+    p3_linear() {
+        let color = this.model.to("p3-linear");
+        return color.coords;
+    }
+    prophoto() {
+        let color = this.model.to("prophoto");
+        return color.coords;
+    }
+    prophoto_linear() {
+        let color = this.model.to("prophoto-linear");
+        return color.coords;
+    }
+    rec2020() {
+        let color = this.model.to("rec2020");
+        return color.coords;
+    }
+    rec2020_linear() {
+        let color = this.model.to("rec2020-linear");
+        return color.coords;
+    }
+    rec2100hlg() {
+        let color = this.model.to("rec2100hlg");
+        return color.coords;
+    }
+    rec2100pq() {
+        let color = this.model.to("rec2100pq");
+        return color.coords;
+    }
+    xyz_abs_d65() {
+        let color = this.model.to("xyz-abs-d65");
+        return color.coords;
+    }
+    xyz_d50() {
+        let color = this.model.to("xyz-d50");
+        return color.coords;
+    }
+    xyz_d65() {
+        let color = this.model.to("xyz-d65");
+        return color.coords;
+    }
+    xyz() {
+        let color = this.model.to("xyz");
+        return color.coords;
+    }
+    srgb() {
+        let color = this.model.to("srgb");
+        return color;
+    }
+    srgb_linear() {
+        let color = this.model.to("srgb-linear");
+        return color.coords;
+    }
+    hex() {
+        let color = this.srgb();
+        let hex = (0, util_js_1.convertRGBtoHex)(Math.round(color.coords[0] * 255), Math.round(color.coords[1] * 255), Math.round(color.coords[2] * 255));
+        // console.log(color.coords[0]);
+        return hex;
+    }
+    hcl() {
+        let hcl = {
+            "h": this.h,
+            "c": this.c,
+            "l": this.l
+        };
+        return hcl;
+    }
+    // rgb() {
+    //     let color = this.srgb();
+    //     let rgb = (
+    //         Math.round(color.coords[0]*255),
+    //         Math.round(color.coords[1]*255),
+    //         Math.round(color.coords[2]*255)
+    //     );
+    //     return rgb;
+    // }
+    rgb() {
+        let color = this.srgb();
+        let rgb = {
+            "r": Math.round(color.coords[0] * 255),
+            "g": Math.round(color.coords[1] * 255),
+            "b": Math.round(color.coords[2] * 255)
+        };
+        return rgb;
+    }
+    // cmyk() {
+    //     let color_srgb = this.srgb;
+    //     let cmyk = rgb2cmyk(
+    //         color_srgb[0],
+    //         color_srgb[1],
+    //         color_srgb[2],
+    //         false
+    //     );
+    //     let color = this.model.to("srgb-linear");
+    //     return color.coords;
+    // }
+    // // Color Strings
+    // // --------------------------------------------------------
+    // let color_css = color_object
+    // let color_string_rgb = color_srgb.toString({precision: 3, format: "rgb"});
+    // let color_string_rgba = color_srgb.toString({precision: 3, format: "rgba"});
+    // let color_string_hex = color_srgb.toString({precision: 3, format: "hex"});
+    // let color_string_color = color_srgb.toString({precision: 3, format: "color"});
+    toString() {
+        const [r, g, b] = this.getRGB();
+        return `rgb(${r}, ${g}, ${b})`;
+    }
+    toDict() {
+        return {
+            name: this.name,
+            hcl_h: this.h,
+            hcl_c: this.c,
+            hcl_l: this.l
+        };
+    }
+}
+exports.ColorSwatch = ColorSwatch;

package/js/color/index.d.ts

@@ -0,0 +1,3 @@
+export { ColorScheme } from './ColorScheme';
+export { ColorSwatch } from './ColorSwatch';
+export { ColorPicker } from './ColorPicker';

package/js/color/index.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright 2024 Scape Agency BV
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColorPicker = exports.ColorSwatch = exports.ColorScheme = void 0;
+// 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.
+var ColorScheme_1 = require("./ColorScheme");
+Object.defineProperty(exports, "ColorScheme", { enumerable: true, get: function () { return ColorScheme_1.ColorScheme; } });
+var ColorSwatch_1 = require("./ColorSwatch");
+Object.defineProperty(exports, "ColorSwatch", { enumerable: true, get: function () { return ColorSwatch_1.ColorSwatch; } });
+var ColorPicker_1 = require("./ColorPicker");
+Object.defineProperty(exports, "ColorPicker", { enumerable: true, get: function () { return ColorPicker_1.ColorPicker; } });

package/js/config/hue.config.d.ts

@@ -0,0 +1,11 @@
+export declare const hueConfig: {
+    prefix: string;
+    h_step: number;
+    p_count: number;
+    l_l_min: number;
+    l_l_step: number;
+    d_l_step: number;
+    l_c_min: number;
+    l_c_step: number;
+    d_c_step: number;
+};

package/js/config/hue.config.js

@@ -0,0 +1,28 @@
+"use strict";
+// hue/config/hue.config.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hueConfig = void 0;
+// Copyright 2023 Scape Agency BV
+// 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.
+// ============================================================================
+// Constants
+// ============================================================================
+exports.hueConfig = {
+    prefix: "N",
+    h_step: 15,
+    p_count: 9,
+    l_l_min: 96,
+    l_l_step: -6,
+    d_l_step: -6,
+    l_c_min: 12,
+    l_c_step: 6,
+    d_c_step: -6
+};

package/js/config/hue.names.d.ts

@@ -0,0 +1,27 @@
+export declare const hueNames: {
+    0: string;
+    15: string;
+    30: string;
+    45: string;
+    60: string;
+    75: string;
+    90: string;
+    105: string;
+    120: string;
+    135: string;
+    150: string;
+    165: string;
+    180: string;
+    195: string;
+    210: string;
+    225: string;
+    240: string;
+    255: string;
+    270: string;
+    285: string;
+    300: string;
+    315: string;
+    330: string;
+    345: string;
+    360: string;
+};

package/js/config/hue.names.js

@@ -0,0 +1,44 @@
+"use strict";
+// hue/config/hue.names.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hueNames = void 0;
+// Copyright 2023 Scape Agency BV
+// 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.
+// ============================================================================
+// Constants
+// ============================================================================
+exports.hueNames = {
+    0: "Grey",
+    15: "Salmon",
+    30: "Orange",
+    45: "Amber",
+    60: "Yellow", // Fixed
+    75: "Lime",
+    90: "Ecru",
+    105: "Olive",
+    120: "Green", // Fixed
+    135: "Forest",
+    150: "Jade",
+    165: "Mint",
+    180: "Cyan", // Fixed
+    195: "Teal",
+    210: "Capri",
+    225: "Sky",
+    240: "Blue", // Fixed
+    255: "Azure",
+    270: "Indigo",
+    285: "Violet",
+    300: "Magenta", // Fixed
+    315: "Purple",
+    330: "Rose",
+    345: "Pink",
+    360: "Red"
+};

package/js/config/index.d.ts

@@ -0,0 +1,2 @@
+export { hueConfig } from './hue.config';
+export { hueNames } from './hue.names';

package/js/config/index.js

@@ -0,0 +1,17 @@
+"use strict";
+// Copyright 2024 Scape Agency BV
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hueNames = exports.hueConfig = void 0;
+// 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.
+var hue_config_1 = require("./hue.config");
+Object.defineProperty(exports, "hueConfig", { enumerable: true, get: function () { return hue_config_1.hueConfig; } });
+var hue_names_1 = require("./hue.names");
+Object.defineProperty(exports, "hueNames", { enumerable: true, get: function () { return hue_names_1.hueNames; } });