@quenty/valuebaseutils 8.0.0-canary.331.7eefa75.0 → 8.0.0

package/CHANGELOG.md

@@ -3,7 +3,159 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [8.0.0-canary.331.7eefa75.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.6.0...@quenty/valuebaseutils@8.0.0-canary.331.7eefa75.0) (2023-02-27)
+# [8.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.22.0...@quenty/valuebaseutils@8.0.0) (2023-10-11)
+
+
+* fix!: Make RxSignal not automatically skip first input ([6fe7586](https://github.com/Quenty/NevermoreEngine/commit/6fe7586029ea4753b1de7a8633c7d5af15bab420))
+
+
+### BREAKING CHANGES
+
+* RxSignal used to export a different value
+
+
+
+
+
+# [7.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.21.0...@quenty/valuebaseutils@7.22.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.20.0...@quenty/valuebaseutils@7.21.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.19.0...@quenty/valuebaseutils@7.20.0) (2023-08-23)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.18.0...@quenty/valuebaseutils@7.19.0) (2023-08-01)
+
+
+### Features
+
+* Add predicate to ObserveBrio of ValueBaseValue ([146d9da](https://github.com/Quenty/NevermoreEngine/commit/146d9da3d6df06188e08e5768d279b72daffd336))
+
+
+
+
+
+# [7.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.17.0...@quenty/valuebaseutils@7.18.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.16.0...@quenty/valuebaseutils@7.17.0) (2023-07-15)
+
+
+### Features
+
+* Support .Changed event o the ValueBaseValue ([641af67](https://github.com/Quenty/NevermoreEngine/commit/641af67239738f4d71f82f5f8d5e558f1b836b79))
+
+
+
+
+
+# [7.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.15.0...@quenty/valuebaseutils@7.16.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.14.0...@quenty/valuebaseutils@7.15.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.13.0...@quenty/valuebaseutils@7.14.0) (2023-05-26)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.12.0...@quenty/valuebaseutils@7.13.0) (2023-05-08)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.11.1...@quenty/valuebaseutils@7.12.0) (2023-04-10)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+## [7.11.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.11.0...@quenty/valuebaseutils@7.11.1) (2023-04-07)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.10.0...@quenty/valuebaseutils@7.11.0) (2023-04-06)
+
+
+### Features
+
+* Add RxValueBaseUtils.observe(parent, className, name, defaultValue) ([173d598](https://github.com/Quenty/NevermoreEngine/commit/173d59877d82d4d12740937a2aa333b3659ab1d3))
+* Add ValueBaseValue for single-value API interface ([8bfa878](https://github.com/Quenty/NevermoreEngine/commit/8bfa878565611f68f489a528485a459cb1c0339e))
+
+
+
+
+
+# [7.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.9.0...@quenty/valuebaseutils@7.10.0) (2023-04-03)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.8.0...@quenty/valuebaseutils@7.9.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.7.0...@quenty/valuebaseutils@7.8.0) (2023-03-05)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [7.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@7.6.0...@quenty/valuebaseutils@7.7.0) (2023-02-27)
 
 **Note:** Version bump only for package @quenty/valuebaseutils
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 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/valuebaseutils",
-  "version": "8.0.0-canary.331.7eefa75.0",
+  "version": "8.0.0",
   "description": "Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.",
   "keywords": [
     "Roblox",
@@ -25,13 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "9.0.0-canary.331.7eefa75.0",
-    "@quenty/instanceutils": "8.0.0-canary.331.7eefa75.0",
-    "@quenty/loader": "6.1.0",
-    "@quenty/promise": "7.0.0-canary.331.7eefa75.0"
+    "@quenty/brio": "^9.0.0",
+    "@quenty/instanceutils": "^8.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/rxsignal": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7eefa756f8bd892b1210349a8133d6d56992dffb"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/RxValueBaseUtils.lua

@@ -10,43 +10,46 @@ local RxBrioUtils = require("RxBrioUtils")
 local RxValueBaseUtils = {}
 
 --[=[
-	:::warning
-	This caches the last value seen, and may memory leak.
-	:::
+	Observes a value base underneath a parent (last named child).
 
 	@param parent Instance
 	@param className string
 	@param name string
-	@return Observable<any>
-	:::
+	@param predicate callback -- Optional callback
+	@return Observable<Brio<any>>
 ]=]
--- TODO: Handle default value/nothing there, instead of memory leaking!
-function RxValueBaseUtils.observe(parent, className, name)
-	warn("[RxValueBaseUtils.observe] - Deprecated since 4.0.0. Use RxValueBaseUtils.observeBrio")
+function RxValueBaseUtils.observeBrio(parent, className, name, predicate)
+	assert(typeof(parent) == "Instance", "Bad parent")
+	assert(type(className) == "string", "Bad className")
+	assert(type(name) == "string", "Bad naem")
 
 	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name)
 		:Pipe({
-			RxBrioUtils.switchMap(function(valueObject)
+			RxBrioUtils.switchMapBrio(function(valueObject)
 				return RxValueBaseUtils.observeValue(valueObject)
-			end)
+			end),
+			RxBrioUtils.onlyLastBrioSurvives(),
+			predicate and RxBrioUtils.where(predicate) or nil;
 		})
 end
 
 --[=[
-	Observes a value base underneath a parent (last named child).
+	Observes a value base underneath a parent
 
 	@param parent Instance
 	@param className string
 	@param name string
-	@return Observable<Brio<any>>
+	@param defaultValue any
+	@return Observable<any>
 ]=]
-function RxValueBaseUtils.observeBrio(parent, className, name)
-	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name)
+function RxValueBaseUtils.observe(parent, className, name, defaultValue)
+	assert(typeof(parent) == "Instance", "Bad parent")
+	assert(type(className) == "string", "Bad className")
+	assert(type(name) == "string", "Bad name")
+
+	return RxValueBaseUtils.observeBrio(parent, className, name)
 		:Pipe({
-			RxBrioUtils.switchMapBrio(function(valueObject)
-				return RxValueBaseUtils.observeValue(valueObject)
-			end),
-			RxBrioUtils.onlyLastBrioSurvives(),
+			RxBrioUtils.emitOnDeath(defaultValue)
 		})
 end
 

package/src/Shared/ValueBaseValue.lua

@@ -0,0 +1,70 @@
+--[=[
+	For when attributes don't work
+
+	@class ValueBaseValue
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService = game:GetService("RunService")
+
+local ValueBaseUtils = require("ValueBaseUtils")
+local RxValueBaseUtils = require("RxValueBaseUtils")
+local RxSignal = require("RxSignal")
+local Rx = require("Rx")
+
+local ValueBaseValue = {}
+ValueBaseValue.ClassName = "ValueBaseValue"
+ValueBaseValue.__index = ValueBaseValue
+
+function ValueBaseValue.new(parent, className, name, defaultValue)
+	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
+	assert(type(className) == "string", "Bad argument 'className'")
+	assert(type(name) == "string", "Bad argument 'name'")
+
+	local self = {}
+
+	self._parent = parent
+	self._name = name
+	self._className = className
+	self._defaultValue = defaultValue
+
+	-- Initialize on the server
+	if RunService:IsServer() then
+		ValueBaseUtils.getOrCreateValue(parent, self._className, self._name, self._defaultValue)
+	end
+
+	return setmetatable(self, ValueBaseValue)
+end
+
+function ValueBaseValue:ObserveBrio(predicate)
+	return RxValueBaseUtils.observeBrio(self._parent, self._className, self._name, predicate)
+end
+
+function ValueBaseValue:Observe()
+	return RxValueBaseUtils.observe(self._parent, self._className, self._name, self._defaultValue)
+end
+
+function ValueBaseValue:__index(index)
+	if index == "Value" then
+		return ValueBaseUtils.getValue(self._parent, self._className, self._name, self._defaultValue)
+	elseif index == "Changed" then
+		return RxSignal.new(self:Observe():Pipe({
+			Rx.skip(1)
+		}))
+	elseif ValueBaseValue[index] or index == "_defaultValue" then
+		return ValueBaseValue[index]
+	else
+		error(("%q is not a member of ValueBaseValue"):format(tostring(index)))
+	end
+end
+
+function ValueBaseValue:__newindex(index, value)
+	if index == "Value" then
+		ValueBaseUtils.setValue(self._parent, self._className, self._name, value)
+	else
+		error(("%q is not a member of ValueBaseValue"):format(tostring(index)))
+	end
+end
+
+return ValueBaseValue