@quenty/attributeutils 14.14.0 → 14.15.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [14.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@14.14.0...@quenty/attributeutils@14.15.0) (2024-12-15)
+
+
+### Features
+
+* Add JSONAttributeValue and EncodedAttributeValue ([fbb09eb](https://github.com/Quenty/NevermoreEngine/commit/fbb09ebcbec2e22580918727e5157f0789fafa17))
+
+
+
+
+
 # [14.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@14.13.0...@quenty/attributeutils@14.14.0) (2024-12-03)
 
 **Note:** Version bump only for package @quenty/attributeutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/attributeutils",
-  "version": "14.14.0",
+  "version": "14.15.0",
   "description": "Provides utility functions to work with attributes in Roblox",
   "keywords": [
     "Roblox",
@@ -25,17 +25,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.14.0",
-    "@quenty/canceltoken": "^11.9.0",
+    "@quenty/brio": "^14.15.0",
+    "@quenty/canceltoken": "^11.10.0",
     "@quenty/loader": "^10.7.1",
     "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.8.0",
-    "@quenty/rx": "^13.14.0",
-    "@quenty/rxsignal": "^7.14.0",
+    "@quenty/promise": "^10.9.0",
+    "@quenty/rx": "^13.15.0",
+    "@quenty/rxsignal": "^7.15.0",
     "@quenty/symbol": "^3.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "66190e48c1ca93b07040326e9cfcf97e8eb4b0e1"
+  "gitHead": "0a20ace4dc7d38f8c889bf73b716b33e8a767c54"
 }

package/src/Shared/EncodedAttributeValue.lua

@@ -0,0 +1,112 @@
+--[=[
+	Allows access to an attribute like a ValueObject, but also encoded or decoded
+
+	@class EncodedAttributeValue
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RxAttributeUtils = require("RxAttributeUtils")
+local Rx = require("Rx")
+local RxBrioUtils = require("RxBrioUtils")
+
+local EncodedAttributeValue = {}
+EncodedAttributeValue.ClassName = "EncodedAttributeValue"
+EncodedAttributeValue.__index = EncodedAttributeValue
+
+--[=[
+	Constructs a new EncodedAttributeValue. If a defaultValue that is not nil
+	is defined, then this value will be set on the Roblox object.
+
+	@param object Instance
+	@param attributeName string
+	@param encode (TValue) -> T
+	@param decode (T) -> TValue
+	@param defaultValue T?
+	@return EncodedAttributeValue<T, TValue>
+]=]
+function EncodedAttributeValue.new(object, attributeName, encode, decode, defaultValue)
+	assert(typeof(object) == "Instance", "Bad object")
+	assert(type(attributeName) == "string", "Bad attributeName")
+	assert(type(decode) == "function", "Bad decode")
+	assert(type(encode) == "function", "Bad encode")
+
+	local self = {
+		_object = object;
+		_attributeName = attributeName;
+		_decode = decode;
+		_encode = encode;
+	}
+
+	if defaultValue ~= nil and self._object:GetAttribute(self._attributeName) == nil then
+		self._object:SetAttribute(rawget(self, "_attributeName"), encode(defaultValue))
+	end
+	return setmetatable(self, EncodedAttributeValue)
+end
+
+--[=[
+	Handles observing the value conditionalli
+
+	@param condition function | nil
+	@return Observable<Brio<any>>
+]=]
+function EncodedAttributeValue:ObserveBrio(condition)
+	return RxAttributeUtils.observeAttributeBrio(self._object, self._attributeName, condition):Pipe({
+		RxBrioUtils.map(rawget(self, "_decode"))
+	})
+end
+
+--[=[
+	Observes an attribute on an instance.
+	@return Observable<any>
+]=]
+function EncodedAttributeValue:Observe()
+	return RxAttributeUtils.observeAttribute(self._object, self._attributeName, rawget(self, "_defaultValue")):Pipe({
+		Rx.map(rawget(self, "_decode"))
+	})
+end
+
+--[=[
+	The current property of the Attribute. Can be assigned to to write
+	the attribute.
+	@prop Value T
+	@within EncodedAttributeValue
+]=]
+
+--[=[
+	Signal that fires when the attribute changes
+	@readonly
+	@prop Changed Signal<()>
+	@within EncodedAttributeValue
+]=]
+function EncodedAttributeValue:__index(index)
+	if EncodedAttributeValue[index] then
+		return EncodedAttributeValue[index]
+	elseif index == "Value" then
+		local result = self._object:GetAttribute(rawget(self, "_attributeName"))
+		local default = rawget(self, "_defaultValue")
+		if result == nil then
+			return default
+		else
+			local decode = rawget(self, "_decode")
+			return decode(result)
+		end
+	elseif index == "Changed" then
+		return self._object:GetAttributeChangedSignal(self._attributeName)
+	elseif index == "AttributeName" then
+		return rawget(self, "_attributeName")
+	else
+		error(string.format("%q is not a member of EncodedAttributeValue", tostring(index)))
+	end
+end
+
+function EncodedAttributeValue:__newindex(index, value)
+	if index == "Value" then
+		local encode = rawget(self, "_encode")
+		self._object:SetAttribute(rawget(self, "_attributeName"), encode(value))
+	else
+		error(string.format("%q is not a member of EncodedAttributeValue", tostring(index)))
+	end
+end
+
+return EncodedAttributeValue

package/src/Shared/JSONAttributeValue.lua

@@ -0,0 +1,31 @@
+--[=[
+	@class JSONAttributeValue
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local HttpService = game:GetService("HttpService")
+local BaseObject = require("BaseObject")
+local EncodedAttributeValue = require("EncodedAttributeValue")
+
+local JSONAttributeValue = setmetatable({}, BaseObject)
+JSONAttributeValue.ClassName = "JSONAttributeValue"
+JSONAttributeValue.__index = JSONAttributeValue
+
+function JSONAttributeValue.new(object, attributeName, defaultValue)
+	return EncodedAttributeValue.new(object, attributeName, function(value)
+		if type(value) == "table" or type(value) == "string" then
+			return HttpService:JSONEncode(value)
+		else
+			return nil
+		end
+	end, function(value)
+		if type(value) == "string" then
+			return HttpService:JSONDecode(value)
+		else
+			return nil
+		end
+	end, defaultValue)
+end
+
+return JSONAttributeValue