@quenty/adorneedata 7.5.0 → 7.6.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneedata@7.5.0...@quenty/adorneedata@7.6.0) (2024-09-12)
+
+
+### Features
+
+* Add AdorneeData:Unset(adornee) ([214b490](https://github.com/Quenty/NevermoreEngine/commit/214b490c3dbc64a6b511167534436376dfc05573))
+* Add AdorneeDataEntry supporting optional attributes ([b840805](https://github.com/Quenty/NevermoreEngine/commit/b8408052efc0dd6f5039d7d9b73ae22b45b201d9))
+
+
+
+
+
 # [7.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneedata@7.4.0...@quenty/adorneedata@7.5.0) (2024-08-09)
 
 **Note:** Version bump only for package @quenty/adorneedata

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/adorneedata",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "description": "Bridges attributes and serialization",
   "keywords": [
     "Roblox",
@@ -25,17 +25,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^14.4.0",
+    "@quenty/attributeutils": "^14.5.0",
     "@quenty/defaultvalueutils": "^1.2.0",
-    "@quenty/ducktype": "^5.3.0",
-    "@quenty/loader": "^10.3.0",
-    "@quenty/rx": "^13.4.0",
-    "@quenty/rxsignal": "^7.4.0",
+    "@quenty/ducktype": "^5.4.0",
+    "@quenty/loader": "^10.4.0",
+    "@quenty/rx": "^13.5.0",
+    "@quenty/rxsignal": "^7.5.0",
     "@quenty/table": "^3.5.0",
     "@quentystudios/t": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ba466bdbc05c42fb607cf5e228c16339201d21d7"
+  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
 }

package/src/Shared/AdorneeData.lua

@@ -22,7 +22,7 @@
 	You can then use the data to retrieve values
 
 	```lua
-	local data = CombatConfiguration:CreateValue(workspace)
+	local data = CombatConfiguration:Create(workspace)
 
 	-- Can ready any data
 	print(data.EnableCombat.Value) --> true
@@ -62,7 +62,7 @@
 	assert(CombatConfiguration:IsData(defaultCombatState))
 
 	-- Or read attributes directly
-	CombatConfiguration:GetAttributes(workspace))
+	CombatConfiguration:Get(workspace))
 
 	-- Note that this is the same as an attribute
 	print(workspace:GetAttribute("EnableCombat")) --> true
@@ -116,17 +116,17 @@ function AdorneeData:__index(index)
 		return AdorneeData[index]
 	elseif type(index) == "string" then
 		local found = self._fullPrototype[index]
-		if not found then
-			error(string.format("[AdorneeData] - Bad index %q is not a known adornee", index))
+		if found == nil then
+			error(string.format("[AdorneeData] - Bad index %q is not a known attribute name", index))
 		end
 
 		if AdorneeDataEntry.isAdorneeDataEntry(found) then
 			return found
 		else
 			-- TODO: Cache this construction
-			return AdorneeDataEntry.new(index, function(adornee)
+			return AdorneeDataEntry.new(typeof(found), function(adornee)
 				return AttributeValue.new(adornee, index, found)
-			end)
+			end, found)
 		end
 	end
 end
@@ -197,17 +197,16 @@ end
 function AdorneeData:Observe(adornee)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
-	return self:CreateAdorneeDataValue(adornee):Observe(adornee)
+	return self:Create(adornee):Observe(adornee)
 end
 
-
 --[=[
 	Gets attribute table for the data
 
 	@param adornee Instance
 	@return AdorneeDataValue
 ]=]
-function AdorneeData:CreateValue(adornee)
+function AdorneeData:Create(adornee)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	local attributeTableValue = AdorneeDataValue.new(adornee, self._fullPrototype)
@@ -215,25 +214,13 @@ function AdorneeData:CreateValue(adornee)
 	return attributeTableValue
 end
 
---[=[
-	Gets attribute table for the data
-
-	@param adornee Instance
-	@return AdorneeDataValue
-]=]
-function AdorneeData:CreateAdorneeDataValue(adornee)
-	assert(typeof(adornee) == "Instance", "Bad adornee")
-
-	return self:CreateValue(adornee)
-end
-
 --[=[
 	Gets the attributes for the adornee
 
 	@param adornee Instance
 	@return TStrict
 ]=]
-function AdorneeData:GetAttributes(adornee)
+function AdorneeData:Get(adornee)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	local data = {}
@@ -253,29 +240,45 @@ function AdorneeData:GetAttributes(adornee)
 	return self:CreateStrictData(data)
 end
 
+
 --[=[
 	Sets the attributes for the adornee
 
 	@param adornee Instance
 	@param data T
 ]=]
-function AdorneeData:SetAttributes(adornee, data)
+function AdorneeData:Set(adornee, data)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 	assert(self:IsData(data))
 
-	local attributeTable = self:CreateAdorneeDataValue(adornee)
+	local attributeTable = self:Create(adornee)
 	for key, value in pairs(data) do
 		attributeTable[key].Value = value
 	end
 end
 
+--[=[
+	Unsets the adornee's attributes (only for baseline attributes)
+
+	@param adornee Instance
+]=]
+function AdorneeData:Unset(adornee)
+	assert(typeof(adornee) == "Instance", "Bad adornee")
+
+	for key, _ in pairs(self._attributePrototype) do
+		adornee:SetAttribute(key, nil)
+	end
+
+	-- TODO: Unset value object values
+end
+
 --[=[
 	Sets the attributes for the adornee
 
 	@param adornee Instance
 	@param data TStrict
 ]=]
-function AdorneeData:SetStrictAttributes(adornee, data)
+function AdorneeData:SetStrict(adornee, data)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 	assert(self:IsStrictData(data))
 
@@ -321,6 +324,12 @@ function AdorneeData:InitAttributes(adornee, data)
 	end
 end
 
+AdorneeData.GetAttributes = AdorneeData.Get
+AdorneeData.SetAttributes = AdorneeData.Set
+AdorneeData.CreateAdorneeDataValue = AdorneeData.Create
+AdorneeData.CreateValue = AdorneeData.CreateValue
+AdorneeData.SetStrictAttributes = AdorneeData.SetStrict
+
 --[=[
 	Gets a strict interface which will return true if the value is a partial interface and
 	false otherwise.

package/src/Shared/AdorneeDataEntry.lua

@@ -9,6 +9,7 @@ local require = require(script.Parent.loader).load(script)
 local DuckTypeUtils = require("DuckTypeUtils")
 local t = require("t")
 local DefaultValueUtils = require("DefaultValueUtils")
+local AttributeValue = require("AttributeValue")
 
 local AdorneeDataEntry = {}
 AdorneeDataEntry.ClassName = "AdorneeDataEntry"
@@ -17,29 +18,46 @@ AdorneeDataEntry.__index = AdorneeDataEntry
 --[=[
 	Creates a new adornee data entry
 
-	@param dataType string
+	@param interface string | (value: any) -> (boolean, string?)
 	@param createValueObject (adornee: Instance) -> ValueObject<T>
+	@param defaultValue T?
 	@return AdorneeDataEntry<T>
 ]=]
-function AdorneeDataEntry.new(dataType, createValueObject)
-	assert(type(dataType) == "string", "Bad dataType")
+function AdorneeDataEntry.new(interface, createValueObject, defaultValue)
+	assert(type(interface) == "string" or type(interface) == "function", "Bad interface")
 	assert(type(createValueObject) == "function", "Bad createValueObject")
 
 	local self = setmetatable({}, AdorneeDataEntry)
 
-	self._dataType = dataType
 	self._createValueObject = createValueObject
-	self._strictInterface = t.typeof(self._dataType)
 
-	if self._dataType == "Instance" then
-		self._defaultValue = nil
+	if type(interface) == "string" then
+		self._interface = t.typeof(interface)
+	elseif type(interface) == "function" then
+		self._interface = interface
 	else
-		self._defaultValue = DefaultValueUtils.getDefaultValueForType(self._dataType)
+		error("Bad interface")
+	end
+
+	if defaultValue ~= nil then
+		self._defaultValue = defaultValue
+	elseif self._dataType == "Instance" then
+		self._defaultValue = nil
+	elseif type(interface) ~= "function" then
+		self._defaultValue = DefaultValueUtils.getDefaultValueForType(interface)
 	end
 
 	return self
 end
 
+function AdorneeDataEntry.optionalAttribute(interface, name)
+	assert(type(interface) == "string" or type(interface) == "function", "Bad interface")
+
+	return AdorneeDataEntry.new(t.optional(interface), function(instance)
+		return AttributeValue.new(instance, name, nil)
+	end, nil)
+end
+
 --[=[
 	Returns true if the implementation is an AdorneeDataEntry
 
@@ -81,7 +99,7 @@ end
 	@param adornee Instance
 	@return T
 ]=]
-function AdorneeDataEntry:GetValue(adornee)
+function AdorneeDataEntry:Get(adornee)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	local valueObject = self:Create(adornee)
@@ -95,18 +113,18 @@ end
 	@param adornee Instance
 	@param value T
 ]=]
-function AdorneeDataEntry:SetValue(adornee, value)
+function AdorneeDataEntry:Set(adornee, value)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
-	assert(self._strictInterface(value))
+	assert(self._interface(value))
 
-	local valueObject = self:CreateValueObject(adornee)
+	local valueObject = self:Create(adornee)
 	valueObject.Value = value
 end
 
 --[=[
 	Gets the default value
 
-	@return T
+	@return T?
 ]=]
 function AdorneeDataEntry:GetDefaultValue()
 	return self._defaultValue
@@ -118,7 +136,7 @@ end
 	@return (value: any) -> (boolean, string)
 ]=]
 function AdorneeDataEntry:GetStrictInterface()
-	return self._strictInterface
+	return self._interface
 end
 
 --[=[
@@ -128,7 +146,7 @@ end
 	@return (boolean, string)
 ]=]
 function AdorneeDataEntry:IsValid(value)
-	return self._strictInterface(value)
+	return self._interface(value)
 end
 
 return AdorneeDataEntry