@quenty/binder 9.0.0-canary.367.e9fdcbc.0 → 9.0.0

package/CHANGELOG.md

@@ -3,7 +3,126 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [9.0.0-canary.367.e9fdcbc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.16.0...@quenty/binder@9.0.0-canary.367.e9fdcbc.0) (2023-06-05)
+# [9.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.27.0...@quenty/binder@9.0.0) (2023-10-11)
+
+
+### Bug Fixes
+
+* Binder has warning about constructing other binders ([3729779](https://github.com/Quenty/NevermoreEngine/commit/37297794d59310a53a3659a406f1e6e266460283))
+
+
+
+
+
+# [8.27.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.26.0...@quenty/binder@8.27.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+# [8.26.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.25.0...@quenty/binder@8.26.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+# [8.25.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.24.0...@quenty/binder@8.25.0) (2023-08-23)
+
+
+### Features
+
+* Add Binder:ObserveAllBrio() ([f68cccc](https://github.com/Quenty/NevermoreEngine/commit/f68cccc8b74acf770ca16888d31c0bb82436d3b0))
+
+
+
+
+
+# [8.24.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.23.0...@quenty/binder@8.24.0) (2023-08-01)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+# [8.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.22.0...@quenty/binder@8.23.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+# [8.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.21.0...@quenty/binder@8.22.0) (2023-07-23)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+# [8.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.20.0...@quenty/binder@8.21.0) (2023-07-15)
+
+
+### Features
+
+* Add Binder:Create() API surface ([0e78a1c](https://github.com/Quenty/NevermoreEngine/commit/0e78a1ce69e2469f61059b641b2000ddd0c7d758))
+
+
+
+
+
+# [8.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.19.1...@quenty/binder@8.20.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+## [8.19.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.19.0...@quenty/binder@8.19.1) (2023-06-24)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+# [8.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.18.1...@quenty/binder@8.19.0) (2023-06-24)
+
+**Note:** Version bump only for package @quenty/binder
+
+
+
+
+
+## [8.18.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.18.0...@quenty/binder@8.18.1) (2023-06-23)
+
+
+### Bug Fixes
+
+* Fix binder args failing in no-arg non-service-provided interface ([36f3417](https://github.com/Quenty/NevermoreEngine/commit/36f3417debd56f478fea591133f78d2a0c521dab))
+
+
+
+
+
+# [8.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.17.0...@quenty/binder@8.18.0) (2023-06-17)
+
+
+### Features
+
+* Binders can be initialized by the ServiceBag directly instead of requireing a BinderProvider ([28ce17f](https://github.com/Quenty/NevermoreEngine/commit/28ce17fe254b7fdce115132244ca1a6e8693d24b))
+
+
+
+
+
+# [8.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.16.0...@quenty/binder@8.17.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/binder
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/binder",
-  "version": "9.0.0-canary.367.e9fdcbc.0",
+  "version": "9.0.0",
   "description": "Utility object to Bind a class to Roblox object, and associated helper methods",
   "keywords": [
     "Roblox",
@@ -25,18 +25,19 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "6.2.1",
-    "@quenty/brio": "8.13.0",
-    "@quenty/instanceutils": "7.14.0",
-    "@quenty/linkutils": "7.14.0",
-    "@quenty/loader": "6.2.1",
-    "@quenty/maid": "2.5.0",
-    "@quenty/promise": "6.5.0",
-    "@quenty/signal": "2.4.0",
-    "@quenty/valueobject": "8.0.0-canary.367.e9fdcbc.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/brio": "^9.0.0",
+    "@quenty/instanceutils": "^8.0.0",
+    "@quenty/linkutils": "^8.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/signal": "^3.0.0",
+    "@quenty/valueobject": "^8.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9fdcbc6ea1d46e068bf42a08b833099e9005259"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/Binder.lua

@@ -31,8 +31,10 @@ local CollectionService = game:GetService("CollectionService")
 
 local Maid = require("Maid")
 local MaidTaskUtils = require("MaidTaskUtils")
-local Signal = require("Signal")
+local Observable = require("Observable")
 local promiseBoundClass = require("promiseBoundClass")
+local Signal = require("Signal")
+local Brio = require("Brio")
 
 local Binder = {}
 Binder.__index = Binder
@@ -65,12 +67,22 @@ Binder.ClassName = "Binder"
 	@return Binder<T>
 ]=]
 function Binder.new(tagName, constructor, ...)
+	assert(type(tagName) == "string", "Bad tagName")
+
 	local self = setmetatable({}, Binder)
 
 	self._tagName = assert(tagName, "Bad argument 'tagName', expected string")
 	self._constructor = assert(constructor, "Bad argument 'constructor', expected table or function")
+	self._defaultClassType = "Folder"
+	self.ServiceName = self._tagName .. "Binder"
 
-	self:Init(...)
+	if Binder.isBinder(self._constructor) then
+		error("Cannot make a binder that constructs another binder")
+	end
+
+	if select("#", ...) > 0 then
+		self._args = { ... }
+	end
 
 	return self
 end
@@ -119,22 +131,50 @@ function Binder:Init(...)
 	self._pendingInstSet = {} -- [inst] = true
 
 	self._listeners = {} -- [inst] = callback
-	self._args = {...}
+
+	if select("#", ...) > 0 then
+		if not self._args then
+			self._args = {...}
+		elseif not self:_argsMatch(...) then
+			warn("[Binder.Init] - Non-matching args from :Init() and .new()")
+		end
+	elseif not self._args then
+		-- Binder.new() would have captured args if we had them
+		self._args = {}
+	end
 
 	self._maid._warning = task.delay(5, function()
 		warn(("Binder %q is not loaded. Call :Start() on it!"):format(self._tagName))
 	end)
 end
 
+function Binder:_argsMatch(...)
+	if #self._args ~= select("#", ...) then
+		return false
+	end
+
+	for index, value in pairs({...}) do
+		if self._args[index] ~= value then
+			return false
+		end
+	end
+
+	return true
+end
+
 --[=[
 	Listens for new instances and connects to the GetInstanceAddedSignal() and removed signal!
 ]=]
 function Binder:Start()
-	if self._loaded then
+	if not self._initialized then
+		self:Init()
+	end
+
+	if self._started then
 		return
 	end
 	self._maid._warning = nil
-	self._loaded = true
+	self._started = true
 
 	for _, inst in pairs(CollectionService:GetTagged(self._tagName)) do
 		task.spawn(self._add, self, inst)
@@ -166,9 +206,95 @@ function Binder:GetConstructor()
 	return self._constructor
 end
 
+--[=[
+	Observes the current value of the instance
+
+	@param instance Instance
+	@return Observable<T | nil>
+]=]
+function Binder:Observe(instance)
+	assert(typeof(instance) == "Instance", "Bad instance")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		maid:GiveTask(self:ObserveInstance(instance, function(...)
+			sub:Fire(...)
+		end))
+		sub:Fire(self:Get(instance))
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes all entries in the binder
+
+	@return Observable<Brio<T>>
+]=]
+function Binder:ObserveAllBrio()
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function handleNewClass(class)
+			local brio = Brio.new(class)
+			maid[class] = brio
+
+			sub:Fire(brio)
+		end
+
+		maid:GiveTask(self:GetClassAddedSignal():Connect(handleNewClass))
+
+		for _, item in pairs(self:GetAll()) do
+			handleNewClass(item)
+		end
+
+		maid:GiveTask(self:GetClassRemovingSignal():Connect(function(class)
+			maid[class] = nil
+		end))
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes a bound class on a given instance.
+
+	@param instance Instance
+	@return Observable<Brio<T>>
+]=]
+function Binder:ObserveBrio(instance)
+	assert(typeof(instance) == "Instance", "Bad instance")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function handleClassChanged(class)
+			if class then
+				local brio = Brio.new(class)
+				maid._lastBrio = brio
+
+				sub:Fire(brio)
+			else
+				maid._lastBrio = nil
+			end
+		end
+
+		maid:GiveTask(self:ObserveInstance(instance, handleClassChanged))
+		handleClassChanged(self:Get(instance))
+
+		return maid
+	end)
+end
+
 --[=[
 	Fired when added, and then after removal, but before destroy!
 
+	:::info
+	This is before [Rx] so it doesn't follow the same Rx pattern. See [Binder.Observe] for
+	an [Rx] compatible interface.
+	:::
+
 	@param inst Instance
 	@param callback function
 	@return function -- Cleanup function
@@ -323,6 +449,28 @@ function Binder:Bind(inst)
 	return self:Get(inst)
 end
 
+--[=[
+	Tags the instance with the tag for the binder
+
+	@param inst Instance
+]=]
+function Binder:Tag(inst)
+	assert(typeof(inst) == "Instance", "Bad inst")
+
+	CollectionService:AddTag(inst, self._tagName)
+end
+
+--[=[
+	Untags the instance with the tag for the binder
+
+	@param inst Instance
+]=]
+function Binder:Untag(inst)
+	assert(typeof(inst) == "Instance", "Bad inst")
+
+	CollectionService:RemoveTag(inst, self._tagName)
+end
+
 --[=[
 	Unbinds the instance by removing the tag.
 
@@ -394,6 +542,24 @@ function Binder:Promise(inst, cancelToken)
 	return promiseBoundClass(self, inst, cancelToken)
 end
 
+--[=[
+	Creates a new class tagged with this binder's instance
+
+	@param className string | nil
+	@return Instance
+]=]
+function Binder:Create(className)
+	assert(type(className) == "string" or className == nil, "Bad className")
+
+	local instance = Instance.new(className or self._defaultClassType)
+	instance.Name = self._tagName
+	instance.Archivable = false
+
+	self:Tag(instance)
+
+	return instance
+end
+
 function Binder:_add(inst)
 	assert(typeof(inst) == "Instance", "Argument 'inst' is not an Instance")