@quenty/colorpalette 10.21.0 → 10.21.2-canary.547.11ae689.0

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.21.2-canary.547.11ae689.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorpalette@10.21.0...@quenty/colorpalette@10.21.2-canary.547.11ae689.0) (2025-04-07)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+* Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
+
+
+
+
+
+## [10.21.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorpalette@10.21.0...@quenty/colorpalette@10.21.1) (2025-04-07)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [10.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorpalette@10.20.4...@quenty/colorpalette@10.21.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/colorpalette

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2024 James Onnen (Quenty)
+Copyright (c) 2014-2025 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/colorpalette",
-  "version": "10.21.0",
+  "version": "10.21.2-canary.547.11ae689.0",
   "description": "Color palette system for Roblox",
   "keywords": [
     "Roblox",
@@ -28,18 +28,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/blend": "^12.18.0",
-    "@quenty/color3utils": "^11.18.0",
-    "@quenty/colorpicker": "^10.19.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/math": "^2.7.1",
-    "@quenty/observablecollection": "^12.20.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "10.8.2-canary.547.11ae689.0",
+    "@quenty/blend": "12.18.2-canary.547.11ae689.0",
+    "@quenty/color3utils": "11.18.2-canary.547.11ae689.0",
+    "@quenty/colorpicker": "10.19.2-canary.547.11ae689.0",
+    "@quenty/loader": "10.8.2-canary.547.11ae689.0",
+    "@quenty/maid": "3.4.2-canary.547.11ae689.0",
+    "@quenty/math": "2.7.3-canary.547.11ae689.0",
+    "@quenty/observablecollection": "12.20.2-canary.547.11ae689.0",
+    "@quenty/rx": "13.17.2-canary.547.11ae689.0",
+    "@quenty/signal": "7.10.2-canary.547.11ae689.0",
+    "@quenty/table": "3.7.3-canary.547.11ae689.0",
+    "@quenty/valueobject": "13.17.2-canary.547.11ae689.0"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "11ae6894c9c40c596e521dc1d2a71977af63752f"
 }

package/src/Shared/ColorPalette.lua

@@ -134,7 +134,7 @@ function ColorPalette:ObserveColor(color, grade, vividness)
 	end
 end
 
-function ColorPalette:SetDefaultSurfaceName(surfaceName)
+function ColorPalette:SetDefaultSurfaceName(surfaceName: string)
 	assert(type(surfaceName) == "string", "Bad surfaceName")
 
 	self._gradePalette:SetDefaultSurfaceName(surfaceName)
@@ -178,7 +178,7 @@ function ColorPalette:_toGradeObservable(grade, fallbackColorSource)
 			Rx.map(function(value)
 				local luvColor = LuvColor3Utils.fromColor3(value)
 				return luvColor[3]
-			end)
+			end),
 		})
 	else
 		error("Bad fallbackColorSource argument")
@@ -235,7 +235,7 @@ function ColorPalette:_toVividness(vividness, grade, name)
 	end
 end
 
-function ColorPalette:GetColorValue(colorName)
+function ColorPalette:GetColorValue(colorName: string)
 	assert(type(colorName) == "string", "Bad colorName")
 
 	local colorValue = self._colorValues[colorName]
@@ -264,7 +264,6 @@ function ColorPalette:GetVividnessValue(gradeName)
 	return vividnessValue
 end
 
-
 function ColorPalette:ObserveModifiedGrade(gradeName, amount, multiplier)
 	return self._gradePalette:ObserveModified(gradeName, amount, multiplier)
 end
@@ -277,7 +276,7 @@ function ColorPalette:ObserveVividness(name)
 	return self._gradePalette:ObserveVividness(name)
 end
 
-function ColorPalette:GetSwatch(swatchName)
+function ColorPalette:GetSwatch(swatchName: string)
 	assert(type(swatchName) == "string", "Bad swatchName")
 
 	local swatch = self._swatchMap:Get(swatchName)

package/src/Shared/Font/FontPalette.lua

@@ -10,6 +10,7 @@ local BaseObject = require("BaseObject")
 local Rx = require("Rx")
 local ValueObject = require("ValueObject")
 local ObservableSet = require("ObservableSet")
+local _Observable = require("Observable")
 
 local FontPalette = setmetatable({}, BaseObject)
 FontPalette.ClassName = "FontPalette"
@@ -39,7 +40,7 @@ end
 
 	@return { string }
 ]=]
-function FontPalette:GetFontNames()
+function FontPalette:GetFontNames(): { string }
 	return self._fontKeys:GetList()
 end
 
@@ -57,7 +58,7 @@ function FontPalette:ObserveFontNames()
 				warn("[FontPalette.ObserveFontNames] - Calling when FontPalette is already dead")
 				return {}
 			end
-		end)
+		end),
 	})
 end
 
@@ -77,7 +78,7 @@ end
 	@param fontName string
 	@return Enum.Font
 ]=]
-function FontPalette:GetFont(fontName)
+function FontPalette:GetFont(fontName: string): Enum.Font
 	assert(type(fontName) == "string", "Bad fontName")
 
 	return self:GetFontValue(fontName).Value
@@ -89,7 +90,7 @@ end
 	@param fontName string
 	@return Observe<Enum.Font>
 ]=]
-function FontPalette:ObserveFont(fontName)
+function FontPalette:ObserveFont(fontName: string): _Observable.Observable<Enum.Font>
 	assert(type(fontName) == "string", "Bad fontName")
 
 	return self:GetFontValue(fontName):Observe()
@@ -99,11 +100,15 @@ end
 	Observes the curent font face defined for the font name
 
 	@param fontName string
-	@param weight FontWeight | Observable<FontWeight> | nil
-	@param style FontStyle | Observable<FontStyle> | nil
+	@param weight (FontWeight | Observable<FontWeight>)?
+	@param style (FontStyle | Observable<FontStyle>)?
 	@return Observable<Font>
 ]=]
-function FontPalette:ObserveFontFace(fontName, weight, style)
+function FontPalette:ObserveFontFace(
+	fontName: string,
+	weight: (Enum.FontWeight | _Observable.Observable<Enum.FontWeight>)?,
+	style: (Enum.FontStyle | _Observable.Observable<Enum.FontWeight>)?
+)
 	assert(type(fontName) == "string", "Bad fontName")
 
 	if weight == nil and style == nil then
@@ -111,13 +116,13 @@ function FontPalette:ObserveFontFace(fontName, weight, style)
 	end
 
 	return Rx.combineLatest({
-		font = self:GetFontFaceValue(fontName):Observe();
-		weight = weight;
-		style = style;
+		font = self:GetFontFaceValue(fontName):Observe(),
+		weight = weight,
+		style = style,
 	}):Pipe({
 		Rx.map(function(state)
 			return Font.new(state.font.Family, state.weight or state.font.Weight, state.style or state.font.Style)
-		end);
+		end),
 	})
 end
 
@@ -125,9 +130,9 @@ end
 	Gets a font value object for a given font.
 
 	@param fontName string
-	@return ValueObject<Enum.Font>
+	@return ValueObject<Font>
 ]=]
-function FontPalette:GetFontFaceValue(fontName)
+function FontPalette:GetFontFaceValue(fontName: string): Font
 	assert(type(fontName) == "string", "Bad fontName")
 
 	local fontValue = self._fontFaces[fontName]
@@ -142,9 +147,9 @@ end
 	Gets a font value object for a given font.
 
 	@param fontName string
-	@return ValueObject<Enum.Font>
+	@return ValueObject<Font>
 ]=]
-function FontPalette:GetFontValue(fontName)
+function FontPalette:GetFontValue(fontName: string): ValueObject.ValueObject<Enum.Font>
 	assert(type(fontName) == "string", "Bad fontName")
 
 	local fontValue = self._fonts[fontName]
@@ -159,7 +164,7 @@ end
 	Gets the default font map
 	@return { string: Font }
 ]=]
-function FontPalette:GetDefaultFontMap()
+function FontPalette:GetDefaultFontMap(): { string: Font }
 	return self._defaultFontMap
 end
 
@@ -170,13 +175,13 @@ end
 	@param defaultFont Enum.Font | Font
 	@return ValueObject<Enum.Font | Font>
 ]=]
-function FontPalette:DefineFont(fontName, defaultFont)
+function FontPalette:DefineFont(fontName: string, defaultFont: Enum.Font | Font): ValueObject.ValueObject<Enum.Font | Font>?
 	assert(type(fontName) == "string", "Bad fontName")
 	assert(typeof(defaultFont) == "EnumItem" or typeof(defaultFont) == "Font", "Bad defaultFont")
 
 	if self._fonts[fontName] then
 		warn(string.format("Already defined defaultFont of name %q", fontName))
-		return
+		return nil
 	end
 
 	local defaultFontEnum
@@ -216,7 +221,7 @@ function FontPalette:DefineFont(fontName, defaultFont)
 	return fontValue
 end
 
-function FontPalette:_tryToGetFontFace(fontFace)
+function FontPalette:_tryToGetFontFace(fontFace: Font)
 	local assetName = string.gmatch(fontFace.Family, "rbxasset://fonts/families/([%w]+).json$")()
 
 	local fontEnum

package/src/Shared/Grade/ColorGradePalette.lua

@@ -27,7 +27,7 @@ function ColorGradePalette.new()
 	return self
 end
 
-function ColorGradePalette:SetDefaultSurfaceName(gradeName)
+function ColorGradePalette:SetDefaultSurfaceName(gradeName: string)
 	assert(type(gradeName) == "string", "Bad gradeName")
 
 	self._defaultSurfaceName.Value = gradeName
@@ -41,7 +41,7 @@ function ColorGradePalette:HasGrade(gradeName)
 	end
 end
 
-function ColorGradePalette:GetGrade(gradeName)
+function ColorGradePalette:GetGrade(gradeName: string)
 	assert(type(gradeName) == "string", "Bad gradeName")
 
 	local observable = self._grades[gradeName]
@@ -64,7 +64,7 @@ function ColorGradePalette:GetGrade(gradeName)
 	return grade, self:GetVividness(gradeName)
 end
 
-function ColorGradePalette:GetVividness(gradeName)
+function ColorGradePalette:GetVividness(gradeName: string)
 	assert(type(gradeName) == "string", "Bad gradeName")
 
 	local observable = self._vividness[gradeName]
@@ -98,7 +98,7 @@ function ColorGradePalette:ObserveGrade(gradeName)
 	return self:_observeGradeFromName(gradeName)
 end
 
-function ColorGradePalette:ObserveVividness(gradeName)
+function ColorGradePalette:ObserveVividness(gradeName: string)
 	assert(type(gradeName) == "string", "Bad gradeName")
 	assert(self._vividness[gradeName], "No vividness for gradeName")
 

package/src/Shared/Grade/ColorGradeUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Helps with color grades, which is the concept where the darkness of the color
 	goes from 0 to 100, with a grade of 100 being white, and a grade of 0 being
@@ -22,9 +23,9 @@ local ColorGradeUtils = {}
 
 	@param grade number
 	@param difference number
-	@return Color3
+	@return number
 ]=]
-function ColorGradeUtils.addGrade(grade, difference)
+function ColorGradeUtils.addGrade(grade: number, difference: number): number
 	local finalGrade = grade + difference
 
 	if finalGrade > 100 or finalGrade < 0 then
@@ -42,7 +43,7 @@ function ColorGradeUtils.addGrade(grade, difference)
 	return finalGrade
 end
 
-function ColorGradeUtils.addGradeToColor(color, difference)
+function ColorGradeUtils.addGradeToColor(color: Color3, difference: number): Color3
 	local grade = ColorGradeUtils.getGrade(color)
 	return ColorGradeUtils.getGradedColor(color, ColorGradeUtils.addGrade(grade, difference))
 end
@@ -56,7 +57,7 @@ end
 	@param amount number -- Between 0 and 100
 	@return Color3
 ]=]
-function ColorGradeUtils.ensureGradeContrast(color, backing, amount)
+function ColorGradeUtils.ensureGradeContrast(color: Color3, backing: Color3, amount: number): Color3
 	local l, u, v = unpack(LuvColor3Utils.fromColor3(color))
 	local _, _, bv = unpack(LuvColor3Utils.fromColor3(backing))
 
@@ -71,7 +72,7 @@ function ColorGradeUtils.ensureGradeContrast(color, backing, amount)
 	end
 
 	local direction = math.sign(rel) > 0 and 1 or -1
-	local newRel = direction*amount
+	local newRel = direction * amount
 
 	local newGrade = math.clamp(backingGrade + newRel, 0, 100)
 	local otherNewGrade = math.clamp(backingGrade - newRel, 0, 100)
@@ -84,10 +85,10 @@ function ColorGradeUtils.ensureGradeContrast(color, backing, amount)
 	end
 
 	-- The further away from the original color the more we reduce vividness
-	local proportion = math.min(amount, math.abs(finalGrade - grade))/amount
-	u = math.clamp((1 - 0.5*proportion)*u, 0, 100)
+	local proportion = math.min(amount, math.abs(finalGrade - grade)) / amount
+	u = math.clamp((1 - 0.5 * proportion) * u, 0, 100)
 
-	return LuvColor3Utils.toColor3({l, u, 100 - finalGrade})
+	return LuvColor3Utils.toColor3({ l, u, 100 - finalGrade })
 end
 
 --[=[
@@ -96,7 +97,7 @@ end
 	@param color Color3
 	@return number
 ]=]
-function ColorGradeUtils.getGrade(color)
+function ColorGradeUtils.getGrade(color: Color3): number
 	assert(typeof(color) == "Color3", "Bad color")
 	local _, _, v = unpack(LuvColor3Utils.fromColor3(color))
 
@@ -108,10 +109,10 @@ end
 
 	@param baseColor Color3
 	@param colorGrade number -- 0 to 100
-	@param vividness number | nil
+	@param vividness number?
 	@return Color3
 ]=]
-function ColorGradeUtils.getGradedColor(baseColor, colorGrade, vividness)
+function ColorGradeUtils.getGradedColor(baseColor: Color3, colorGrade: number, vividness: number?): Color3
 	assert(typeof(baseColor) == "Color3", "Bad baseColor")
 	assert(type(vividness) == "number" or vividness == nil, "Bad vividness")
 	assert(type(colorGrade) == "number", "Bad colorGrade")

package/src/Shared/Swatch/ColorSwatch.lua

@@ -36,7 +36,7 @@ function ColorSwatch.new(color, vividness)
 	return self
 end
 
-function ColorSwatch:GetGraded(colorGrade)
+function ColorSwatch:GetGraded(colorGrade: number)
 	assert(type(colorGrade) == "number", "Bad colorGrade")
 
 	return ColorGradeUtils.getGradedColor(self._color.Value, colorGrade, self._vividness.Value)