@quenty/binder 8.17.0 → 9.0.0-canary.367.903617a.0

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [8.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.16.0...@quenty/binder@8.17.0) (2023-06-05)
+# [9.0.0-canary.367.903617a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.16.0...@quenty/binder@9.0.0-canary.367.903617a.0) (2023-06-09)
 
 **Note:** Version bump only for package @quenty/binder
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/binder",
-  "version": "8.17.0",
+  "version": "9.0.0-canary.367.903617a.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": "^7.15.0"
+    "@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/rx": "7.11.0",
+    "@quenty/signal": "2.4.0",
+    "@quenty/valueobject": "8.0.0-canary.367.903617a.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d8ad8f8567843d3867b6c06c8c57ec4493672335"
+  "gitHead": "903617ace784bce6cc7e0a15093ee50566bd9b54"
 }

package/src/Shared/Binder.lua

@@ -31,8 +31,9 @@ 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 Binder = {}
 Binder.__index = Binder
@@ -67,20 +68,13 @@ Binder.ClassName = "Binder"
 function Binder.new(tagName, constructor, ...)
 	local self = setmetatable({}, Binder)
 
-	self._maid = Maid.new()
-	self._tagName = tagName or error("Bad argument 'tagName', expected string")
-	self._constructor = constructor or error("Bad argument 'constructor', expected table or function")
-
-	self._instToClass = {} -- [inst] = class
-	self._allClassSet = {} -- [class] = true
-	self._pendingInstSet = {} -- [inst] = true
-
-	self._listeners = {} -- [inst] = callback
-	self._args = {...}
+	self._tagName = assert(tagName, "Bad argument 'tagName', expected string")
+	self._constructor = assert(constructor, "Bad argument 'constructor', expected table or function")
+	self.ServiceName = "Binder" .. self._tagName
 
-	self._maid._warning = task.delay(5, function()
-		warn(("Binder %q is not loaded. Call :Start() on it!"):format(self._tagName))
-	end)
+	if select("#", ...) > 0 then
+		self._args = { ... }
+	end
 
 	return self
 end
@@ -111,10 +105,46 @@ function Binder.isBinder(value)
 		and type(value.Destroy) == "function"
 end
 
+--[=[
+	Initializes the Binder. Designed to be done via ServiceBag.
+
+	@param ... any
+]=]
+function Binder:Init(...)
+	if self._initialized then
+		return
+	end
+
+	self._initialized = true
+	self._maid = Maid.new()
+
+	self._instToClass = {} -- [inst] = class
+	self._allClassSet = {} -- [class] = true
+	self._pendingInstSet = {} -- [inst] = true
+
+	self._listeners = {} -- [inst] = callback
+
+	if select("#", ...) > 0 then
+		if not self._args then
+			self._args = {...}
+		else
+			warn("[Binder.Init] - Matching args")
+		end
+	end
+
+	self._maid._warning = task.delay(5, function()
+		warn(("Binder %q is not loaded. Call :Start() on it!"):format(self._tagName))
+	end)
+end
+
 --[=[
 	Listens for new instances and connects to the GetInstanceAddedSignal() and removed signal!
 ]=]
 function Binder:Start()
+	if not self._initialized then
+		self:Init()
+	end
+
 	if self._loaded then
 		return
 	end
@@ -151,9 +181,35 @@ function Binder:GetConstructor()
 	return self._constructor
 end
 
+--[=[
+	Observes the current value of the instance
+
+	@param instance Instance
+	@return Observable<Instance | 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
+
 --[=[
 	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

package/src/Shared/BinderProvider.lua

@@ -117,6 +117,10 @@ function BinderProvider:Init(...)
 
 	self._initMethod(self, ...)
 
+	for _, binder in pairs(self._binders) do
+		binder:Init(...)
+	end
+
 	self._bindersAddedPromise:Resolve()
 end