@vived/host 3.4.0 → 3.5.0

package/lib/Components/ThemeColors/Entities/HostThemeEntity.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultScheme = exports.makeHostThemeEntity = exports.HostThemeEntity = exports.ThemeColorType = void 0;
+const Entities_1 = require("../../../Entities");
+const HostAppObject_1 = require("../../../HostAppObject");
+const ValueObjects_1 = require("../../../ValueObjects");
+var ThemeColorType;
+(function (ThemeColorType) {
+    ThemeColorType["primary"] = "primary";
+    ThemeColorType["onPrimary"] = "onPrimary";
+    ThemeColorType["primaryContainer"] = "primaryContainer";
+    ThemeColorType["onPrimaryContainer"] = "onPrimaryContainer";
+    ThemeColorType["primaryFixed"] = "primaryFixed";
+    ThemeColorType["onPrimaryFixed"] = "onPrimaryFixed";
+    ThemeColorType["primaryFixedDim"] = "primaryFixedDim";
+    ThemeColorType["onPrimaryFixedVariant"] = "onPrimaryFixedVariant";
+    ThemeColorType["secondary"] = "secondary";
+    ThemeColorType["onSecondary"] = "onSecondary";
+    ThemeColorType["secondaryContainer"] = "secondaryContainer";
+    ThemeColorType["onSecondaryContainer"] = "onSecondaryContainer";
+    ThemeColorType["secondaryFixed"] = "secondaryFixed";
+    ThemeColorType["onSecondaryFixed"] = "onSecondaryFixed";
+    ThemeColorType["secondaryFixedDim"] = "secondaryFixedDim";
+    ThemeColorType["onSecondaryFixedVariant"] = "onSecondaryFixedVariant";
+    ThemeColorType["tertiary"] = "tertiary";
+    ThemeColorType["onTertiary"] = "onTertiary";
+    ThemeColorType["tertiaryContainer"] = "tertiaryContainer";
+    ThemeColorType["onTertiaryContainer"] = "onTertiaryContainer";
+    ThemeColorType["tertiaryFixed"] = "tertiaryFixed";
+    ThemeColorType["onTertiaryFixed"] = "onTertiaryFixed";
+    ThemeColorType["tertiaryFixedDim"] = "tertiaryFixedDim";
+    ThemeColorType["onTertiaryFixedVariant"] = "onTertiaryFixedVariant";
+    ThemeColorType["error"] = "error";
+    ThemeColorType["onError"] = "onError";
+    ThemeColorType["errorContainer"] = "errorContainer";
+    ThemeColorType["onErrorContainer"] = "onErrorContainer";
+    ThemeColorType["outline"] = "outline";
+    ThemeColorType["background"] = "background";
+    ThemeColorType["onBackground"] = "onBackground";
+    ThemeColorType["surface"] = "surface";
+    ThemeColorType["onSurface"] = "onSurface";
+    ThemeColorType["surfaceVariant"] = "surfaceVariant";
+    ThemeColorType["onSurfaceVariant"] = "onSurfaceVariant";
+    ThemeColorType["inverseSurface"] = "inverseSurface";
+    ThemeColorType["inverseOnSurface"] = "inverseOnSurface";
+    ThemeColorType["inversePrimary"] = "inversePrimary";
+    ThemeColorType["shadow"] = "shadow";
+    ThemeColorType["surfaceTint"] = "surfaceTint";
+    ThemeColorType["outlineVariant"] = "outlineVariant";
+    ThemeColorType["scrim"] = "scrim";
+    ThemeColorType["surfaceContainerHighest"] = "surfaceContainerHighest";
+    ThemeColorType["surfaceContainerHigh"] = "surfaceContainerHigh";
+    ThemeColorType["surfaceContainer"] = "surfaceContainer";
+    ThemeColorType["surfaceContainerLow"] = "surfaceContainerLow";
+    ThemeColorType["surfaceContainerLowest"] = "surfaceContainerLowest";
+    ThemeColorType["surfaceBright"] = "surfaceBright";
+    ThemeColorType["surfaceDim"] = "surfaceDim";
+})(ThemeColorType = exports.ThemeColorType || (exports.ThemeColorType = {}));
+class HostThemeEntity extends HostAppObject_1.HostAppObjectEntity {
+}
+exports.HostThemeEntity = HostThemeEntity;
+HostThemeEntity.type = "HostThemeEntity";
+HostThemeEntity.get = (appObjects) => HostAppObject_1.getSingletonComponent(HostThemeEntity.type, appObjects);
+function makeHostThemeEntity(appObject) {
+    return new HostThemeEntityImp(appObject);
+}
+exports.makeHostThemeEntity = makeHostThemeEntity;
+class HostThemeEntityImp extends HostThemeEntity {
+    constructor(appObject) {
+        super(appObject, HostThemeEntity.type);
+        this.schemeLookup = new Map();
+        this.submitScheme = (name, scheme) => {
+            if (this.schemeLookup.has(name)) {
+                this.warn("Duplicate scheme name submitted. Overwriting");
+            }
+            this.schemeLookup.set(name, scheme);
+            if (!this.activeSchemeName) {
+                this.activeSchemeName = name;
+            }
+        };
+        this.memoizedActiveScheme = new Entities_1.MemoizedString("", this.notifyOnChange);
+        this.getColorForType = (type) => {
+            const scheme = this.schemeLookup.get(this.activeSchemeName);
+            if (!scheme) {
+                this.error("No active scheme");
+                return ValueObjects_1.Color.RGB(0, 0, 0);
+            }
+            const colorHex = scheme[type];
+            return ValueObjects_1.Color.Hex(colorHex);
+        };
+        this.appObjects.registerSingleton(this);
+    }
+    get activeScheme() {
+        var _a;
+        return (_a = this.schemeLookup.get(this.activeSchemeName)) !== null && _a !== void 0 ? _a : exports.defaultScheme;
+    }
+    getHexForType(type) {
+        const scheme = this.schemeLookup.get(this.activeSchemeName);
+        if (!scheme) {
+            this.error("No active scheme");
+            return "#000000";
+        }
+        return scheme[type];
+    }
+    get activeSchemeName() {
+        return this.memoizedActiveScheme.val;
+    }
+    set activeSchemeName(val) {
+        if (!this.schemeLookup.has(val)) {
+            this.warn(`Unknown theme schema: ${val}. Ignoring.`);
+            return;
+        }
+        this.memoizedActiveScheme.val = val;
+    }
+}
+exports.defaultScheme = {
+    primary: "#7BD0FF",
+    onPrimary: "#003549",
+    primaryContainer: "#004C69",
+    onPrimaryContainer: "#C4E7FF",
+    primaryFixed: "#C4E7FF",
+    onPrimaryFixed: "#001E2C",
+    primaryFixedDim: "#7BD0FF",
+    onPrimaryFixedVariant: "#004C69",
+    secondary: "#B5C9D7",
+    onSecondary: "#20333E",
+    secondaryContainer: "#374955",
+    onSecondaryContainer: "#D1E5F4",
+    secondaryFixed: "#D1E5F4",
+    onSecondaryFixed: "#0A1E28",
+    secondaryFixedDim: "#B5C9D7",
+    onSecondaryFixedVariant: "#374955",
+    tertiary: "#CAC1E9",
+    onTertiary: "#322C4C",
+    tertiaryContainer: "#484264",
+    onTertiaryContainer: "#E6DEFF",
+    tertiaryFixed: "#E6DEFF",
+    onTertiaryFixed: "#1D1736",
+    tertiaryFixedDim: "#CAC1E9",
+    onTertiaryFixedVariant: "#484264",
+    error: "#FFB4AB",
+    onError: "#690005",
+    errorContainer: "#93000A",
+    onErrorContainer: "#FFDAD6",
+    outline: "#8B9297",
+    background: "#191C1E",
+    onBackground: "#E1E2E5",
+    surface: "#111416",
+    onSurface: "#C5C6C9",
+    surfaceVariant: "#41484D",
+    onSurfaceVariant: "#C0C7CD",
+    inverseSurface: "#E1E2E5",
+    inverseOnSurface: "#191C1E",
+    inversePrimary: "#00668A",
+    shadow: "#000000",
+    surfaceTint: "#7BD0FF",
+    outlineVariant: "#41484D",
+    scrim: "#000000",
+    surfaceContainerHighest: "#333537",
+    surfaceContainerHigh: "#282A2C",
+    surfaceContainer: "#1D2022",
+    surfaceContainerLow: "#191C1E",
+    surfaceContainerLowest: "#0C0F10",
+    surfaceBright: "#37393C",
+    surfaceDim: "#111416"
+};

package/lib/Components/ThemeColors/Entities/index.d.ts

@@ -0,0 +1 @@
+export * from "./HostThemeEntity";

package/lib/Components/ThemeColors/Entities/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./HostThemeEntity"), exports);

package/lib/Components/ThemeColors/Mocks/MockThemeColorPM.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="jest" />
+import { HostAppObject, HostAppObjectRepo } from "../../../HostAppObject";
+import { ThemeColorsPM } from "../PM";
+export declare class MockThemeColorPM extends ThemeColorsPM {
+    vmsAreEqual: jest.Mock<any, any>;
+    constructor(appObject: HostAppObject);
+}
+export declare function makeMockThemeColorPM(appObjects: HostAppObjectRepo): MockThemeColorPM;

package/lib/Components/ThemeColors/Mocks/MockThemeColorPM.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeMockThemeColorPM = exports.MockThemeColorPM = void 0;
+const PM_1 = require("../PM");
+class MockThemeColorPM extends PM_1.ThemeColorsPM {
+    constructor(appObject) {
+        super(appObject, PM_1.ThemeColorsPM.type);
+        this.vmsAreEqual = jest.fn();
+    }
+}
+exports.MockThemeColorPM = MockThemeColorPM;
+function makeMockThemeColorPM(appObjects) {
+    return new MockThemeColorPM(appObjects.getOrCreate("MockThemeColorPM"));
+}
+exports.makeMockThemeColorPM = makeMockThemeColorPM;

package/lib/Components/ThemeColors/Mocks/index.d.ts

@@ -0,0 +1 @@
+export * from "./MockThemeColorPM";

package/lib/Components/ThemeColors/Mocks/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./MockThemeColorPM"), exports);

package/lib/Components/ThemeColors/PM/ThemeColorsPM.d.ts

@@ -0,0 +1,12 @@
+import { HostAppObject, HostAppObjectPM, HostAppObjectRepo } from "../../../HostAppObject";
+import { ColorScheme } from "../Entities/HostThemeEntity";
+export interface ThemeColorsVM {
+    themeName: string;
+    scheme: ColorScheme;
+}
+export declare const defaultThemeColorsVM: ThemeColorsVM;
+export declare abstract class ThemeColorsPM extends HostAppObjectPM<ThemeColorsVM> {
+    static readonly type = "ThemeColorsPM";
+    static get(appObjects: HostAppObjectRepo): ThemeColorsPM | undefined;
+}
+export declare function makeThemeColorsPM(appObject: HostAppObject): ThemeColorsPM;

package/lib/Components/ThemeColors/PM/ThemeColorsPM.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeThemeColorsPM = exports.ThemeColorsPM = exports.defaultThemeColorsVM = void 0;
+const HostAppObject_1 = require("../../../HostAppObject");
+const HostThemeEntity_1 = require("../Entities/HostThemeEntity");
+exports.defaultThemeColorsVM = {
+    themeName: "",
+    scheme: HostThemeEntity_1.defaultScheme
+};
+class ThemeColorsPM extends HostAppObject_1.HostAppObjectPM {
+    static get(appObjects) {
+        return HostAppObject_1.getSingletonComponent(ThemeColorsPM.type, appObjects);
+    }
+}
+exports.ThemeColorsPM = ThemeColorsPM;
+ThemeColorsPM.type = "ThemeColorsPM";
+function makeThemeColorsPM(appObject) {
+    return new ThemeColorsPMImp(appObject);
+}
+exports.makeThemeColorsPM = makeThemeColorsPM;
+class ThemeColorsPMImp extends ThemeColorsPM {
+    constructor(appObject) {
+        super(appObject, ThemeColorsPM.type);
+        this.onThemeChange = () => {
+            if (!this.themeColors)
+                return;
+            this.doUpdateView({
+                themeName: this.themeColors.activeSchemeName,
+                scheme: this.themeColors.activeScheme
+            });
+        };
+        this.appObjects.registerSingleton(this);
+        this.themeColors = HostThemeEntity_1.HostThemeEntity.get(appObject.appObjectRepo);
+        if (!this.themeColors) {
+            this.error("Unable to find HostThemeEntity");
+            return;
+        }
+        else {
+            this.themeColors.addChangeObserver(this.onThemeChange);
+            this.onThemeChange();
+        }
+    }
+    vmsAreEqual(a, b) {
+        return a.themeName === b.themeName;
+    }
+}

package/lib/Components/ThemeColors/PM/index.d.ts

@@ -0,0 +1 @@
+export * from "./ThemeColorsPM";

package/lib/Components/ThemeColors/PM/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ThemeColorsPM"), exports);

package/lib/Components/ThemeColors/UCs/SetThemeUC.d.ts

@@ -0,0 +1,10 @@
+import { HostAppObject, HostAppObjectRepo, HostAppObjectUC } from "../../../HostAppObject";
+export declare abstract class SetThemeUC extends HostAppObjectUC {
+    static type: string;
+    abstract lightThemeName: string;
+    abstract darkThemeName: string;
+    abstract setThemeByName(name: string): void;
+    abstract tryDetectTheme(): void;
+    static get(appObjects: HostAppObjectRepo): SetThemeUC | undefined;
+}
+export declare function makeSetThemeUC(appObject: HostAppObject): SetThemeUC;

package/lib/Components/ThemeColors/UCs/SetThemeUC.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeSetThemeUC = exports.SetThemeUC = void 0;
+const HostAppObject_1 = require("../../../HostAppObject");
+const Entities_1 = require("../Entities");
+class SetThemeUC extends HostAppObject_1.HostAppObjectUC {
+    static get(appObjects) {
+        return HostAppObject_1.getSingletonComponent(SetThemeUC.type, appObjects);
+    }
+}
+exports.SetThemeUC = SetThemeUC;
+SetThemeUC.type = "SetThemeUC";
+function makeSetThemeUC(appObject) {
+    return new SetThemeUCImp(appObject);
+}
+exports.makeSetThemeUC = makeSetThemeUC;
+class SetThemeUCImp extends SetThemeUC {
+    constructor(appObject) {
+        super(appObject, SetThemeUC.type);
+        this.lightThemeName = "light";
+        this.darkThemeName = "dark";
+        this.appObjects.registerSingleton(this);
+    }
+    get theme() {
+        return this.getCachedSingleton(Entities_1.HostThemeEntity.type);
+    }
+    setThemeByName(name) {
+        if (!this.theme)
+            return;
+        this.theme.activeSchemeName = name;
+    }
+    tryDetectTheme() {
+        if (!this.theme)
+            return;
+        const darkThemeMq = window.matchMedia("(prefers-color-scheme: dark)");
+        if (darkThemeMq.matches) {
+            this.theme.activeSchemeName = this.darkThemeName;
+        }
+        else {
+            this.theme.activeSchemeName = this.darkThemeName;
+        }
+    }
+}

package/lib/Components/ThemeColors/UCs/index.d.ts

@@ -0,0 +1 @@
+export * from "./SetThemeUC";

package/lib/Components/ThemeColors/UCs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./SetThemeUC"), exports);

package/lib/Components/ThemeColors/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./Adapter";
+export * from "./Controllers";
+export * from "./Data";
+export * from "./Entities";
+export * from "./Mocks";
+export * from "./PM";
+export * from "./UCs";

package/lib/Components/ThemeColors/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Adapter"), exports);
+__exportStar(require("./Controllers"), exports);
+__exportStar(require("./Data"), exports);
+__exportStar(require("./Entities"), exports);
+__exportStar(require("./Mocks"), exports);
+__exportStar(require("./PM"), exports);
+__exportStar(require("./UCs"), exports);

package/lib/Components/index.d.ts

@@ -6,5 +6,6 @@ export * from "./Dispatcher";
 export * from "./Handler";
 export * from "./Logger";
 export * from "./StateMachine";
+export * from "./ThemeColors";
 export * from "./VivedAPI";
 export * from "./ZSpaceHost";

package/lib/Components/index.js

@@ -18,5 +18,6 @@ __exportStar(require("./Dispatcher"), exports);
 __exportStar(require("./Handler"), exports);
 __exportStar(require("./Logger"), exports);
 __exportStar(require("./StateMachine"), exports);
+__exportStar(require("./ThemeColors"), exports);
 __exportStar(require("./VivedAPI"), exports);
 __exportStar(require("./ZSpaceHost"), exports);

package/lib/Entities/MemoizedColor.d.ts

@@ -0,0 +1,9 @@
+import { Color } from "../ValueObjects";
+export declare class MemoizedColor {
+    private _val;
+    get val(): Color;
+    set val(v: Color);
+    setValQuietly(val: Color): void;
+    private onChangeCallback;
+    constructor(initialValue: Color, onChangeCallback: () => void);
+}

package/lib/Entities/MemoizedColor.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoizedColor = void 0;
+const ValueObjects_1 = require("../ValueObjects");
+class MemoizedColor {
+    constructor(initialValue, onChangeCallback) {
+        this._val = initialValue;
+        this.onChangeCallback = onChangeCallback;
+    }
+    get val() {
+        return this._val;
+    }
+    set val(v) {
+        if (ValueObjects_1.Color.Equal(v, this._val))
+            return;
+        this._val = v;
+        this.onChangeCallback();
+    }
+    setValQuietly(val) {
+        this._val = val;
+    }
+}
+exports.MemoizedColor = MemoizedColor;

package/lib/Entities/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./Auth";
 export * from "./ChallengeResults";
 export * from "./MemoizedBoolean";
+export * from "./MemoizedColor";
 export * from "./MemoizedNumber";
 export * from "./MemoizedString";
 export * from "./ObservableEntity";

package/lib/Entities/index.js

@@ -13,6 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Auth"), exports);
 __exportStar(require("./ChallengeResults"), exports);
 __exportStar(require("./MemoizedBoolean"), exports);
+__exportStar(require("./MemoizedColor"), exports);
 __exportStar(require("./MemoizedNumber"), exports);
 __exportStar(require("./MemoizedString"), exports);
 __exportStar(require("./ObservableEntity"), exports);

package/lib/Utilities/addAlphaToHex.d.ts

@@ -0,0 +1 @@
+export declare function addAlphaToHex(hex: string, alpha: number): string;

package/lib/Utilities/addAlphaToHex.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addAlphaToHex = void 0;
+const alphaToHex_1 = require("./alphaToHex");
+function addAlphaToHex(hex, alpha) {
+    if (!/^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$/.test(hex)) {
+        console.warn("[addAlphaToHex] Hex value is not valid.");
+        return "#000";
+    }
+    if (hex.length === 4) {
+        hex = "#" + hex[1] + hex[1] + hex[2] + hex[2] + hex[3] + hex[3];
+    }
+    const alphaHex = alphaToHex_1.alphaToHex(alpha);
+    return `${hex}${alphaHex}`;
+}
+exports.addAlphaToHex = addAlphaToHex;

package/lib/Utilities/alphaToHex.d.ts

@@ -0,0 +1,2 @@
+export declare function roundHalfToEven(number: number): number;
+export declare function alphaToHex(alpha: number): string;

package/lib/Utilities/alphaToHex.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alphaToHex = exports.roundHalfToEven = void 0;
+function roundHalfToEven(number) {
+    const roundedNumber = Math.round(number);
+    if (Math.abs(roundedNumber - number) === 0.5 && roundedNumber % 2 !== 0) {
+        return roundedNumber > number ? roundedNumber - 1 : roundedNumber + 1;
+    }
+    return roundedNumber;
+}
+exports.roundHalfToEven = roundHalfToEven;
+function alphaToHex(alpha) {
+    if (alpha < 0 || alpha > 1) {
+        console.warn("[alphaToHex] Alpha value must be between 0 and 1.");
+        return "00";
+    }
+    const alpha255 = roundHalfToEven(alpha * 255);
+    const alphaHex = alpha255.toString(16).padStart(2, "0");
+    return alphaHex;
+}
+exports.alphaToHex = alphaToHex;

package/lib/Utilities/index.d.ts

@@ -1,2 +1,4 @@
+export * from "./addAlphaToHex";
+export * from "./alphaToHex";
 export * from "./downloadFile";
 export * from "./generateUniqueID";

package/lib/Utilities/index.js

@@ -10,5 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./addAlphaToHex"), exports);
+__exportStar(require("./alphaToHex"), exports);
 __exportStar(require("./downloadFile"), exports);
 __exportStar(require("./generateUniqueID"), exports);

package/lib/ValueObjects/Color.d.ts

@@ -0,0 +1,82 @@
+export declare type BasicColor = "";
+export interface ColorDTO {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export declare class Color {
+    /**
+     * Creates a Color from RGBA values
+     * @param r Red value, between 0-255
+     * @param g Green value, between 0-255
+     * @param b Blue value, between 0-255
+     * @param a Alpha value, between 0-255
+     * @returns The Color
+     */
+    static RGBA(r: number, g: number, b: number, a: number): Color;
+    /**
+     * Creates a Color from RGB values. Alpha is set to 255
+     * @param r Red value, between 0-255
+     * @param g Green value, between 0-255
+     * @param b Blue value, between 0-255
+     * @returns The Color
+     */
+    static RGB(r: number, g: number, b: number): Color;
+    /**
+     *
+     * @returns Creates a Color from a DTO
+     * @param data Data Transfer Object
+     */
+    static FromDTO(data: ColorDTO): Color;
+    /**
+     * Creates a color from a Hex value
+     * @param hex The Hex string. Example '808080'
+     * @returns The Color
+     */
+    static Hex(hex: string): Color;
+    /**
+     * Creates a color from the X11 standard.
+     * @param name X11 name
+     * @returns The Color. If the color name is not found, it will return Black.
+     */
+    static X11(name: string): Color;
+    /**
+     * Checks to see if Color A equals Color B
+     * @param a Color A
+     * @param b Color B
+     * @returns True if Color A === Color B
+     */
+    static Equal(a: Color, b: Color): boolean;
+    readonly r: number;
+    readonly g: number;
+    readonly b: number;
+    readonly a: number;
+    /**
+     * Return the r value as a percent
+     */
+    get rPercent(): number;
+    /**
+     * Return the g value as a percent
+     */
+    get gPercent(): number;
+    /**
+     * Return the b value as a percent
+     */
+    get bPercent(): number;
+    /**
+     * Return the a value as a percent
+     */
+    get aPercent(): number;
+    /**
+     * Returns the Color values as an array [r,g,b,a]
+     */
+    get array(): [number, number, number, number];
+    /**
+     * Returns the Color values as a hex
+     */
+    get hex(): string;
+    get dto(): ColorDTO;
+    private clampVal;
+    private constructor();
+}