@rbxts/covenant 1.0.2 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rbxts/covenant",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "main": "src/init.lua",
     "scripts": {
         "build": "rbxtsc",

package/src/covenant.d.ts

@@ -16,7 +16,7 @@ export declare class Covenant {
     private systems;
     private worldChangesForReplication;
     private worldChangesForPrediction;
-    private underivedStringifiedComponents;
+    private undefinedStringifiedComponents;
     private replicatedStringifiedComponents;
     private predictedStringifiedComponents;
     private started;
@@ -41,16 +41,16 @@ export declare class Covenant {
     subscribeComponent<T>(component: Entity<T>, subscriber: (entity: Entity, state: T | undefined, previousState: T | undefined) => void): () => void;
     private worldDelete;
     worldComponent<T extends defined>(): Entity<T>;
-    private checkComponentDerived;
+    private checkComponentDefined;
     private defineComponentNetworkBehavior;
-    deriveComponent<T extends defined>({ component, queriedComponents, recipe, replicated, predictionValidator, }: {
+    defineComputedComponent<T extends defined>({ component, queriedComponents, recipe, replicated, predictionValidator, }: {
         replicated: boolean;
         predictionValidator: ComponentPredictionValidator | false;
         component: Entity<T>;
         queriedComponents: Entity[][];
         recipe: (entity: Entity, lastState: T | undefined, updateId: number, hooks: CovenantHooks) => T | undefined;
     }): void;
-    deriveChildren<T extends defined>({ parentComponent, parentEntityTrackerComponent, childIdentityComponent, getIdentifier, queriedComponents, recipe, replicated, predictionValidator, }: {
+    defineManagedChildren<T extends defined>({ parentComponent, parentEntityTrackerComponent, childIdentityComponent, getIdentifier, queriedComponents, recipe, replicated, predictionValidator, }: {
         replicated: boolean;
         predictionValidator: ComponentPredictionValidator | false;
         parentComponent: Entity<ReadonlyArray<T>>;
@@ -60,12 +60,12 @@ export declare class Covenant {
         queriedComponents: Entity[][];
         recipe: (entity: Entity, lastChildrenStates: ReadonlyArray<T>, updateId: number, hooks: CovenantHooks) => ReadonlyArray<T>;
     }): void;
-    deriveRootEntity<T extends defined>({ identityComponent, recipe, replicated, }: {
+    defineEntitySource<T extends defined>({ identityComponent, recipe, replicated, }: {
         replicated: boolean;
         identityComponent: Entity<T>;
         recipe: (updateId: number, hooks: CovenantHooks) => {
-            statesToCreate: ReadonlyArray<T>;
-            entitiesToDelete: ReadonlyArray<Entity>;
+            statesToCreate?: ReadonlyArray<T>;
+            entitiesToDelete?: ReadonlyArray<Entity>;
         };
     }): void;
     private worldEntity;

package/src/covenant.luau

@@ -48,7 +48,7 @@ do
 		self.systems = {}
 		self.worldChangesForReplication = {}
 		self.worldChangesForPrediction = {}
-		self.underivedStringifiedComponents = {}
+		self.undefinedStringifiedComponents = {}
 		self.replicatedStringifiedComponents = {}
 		self.predictedStringifiedComponents = {}
 		self.started = false
@@ -235,14 +235,14 @@ do
 	function Covenant:start()
 		local _arg0 = not self.started
 		assert(_arg0, "Already started")
-		local _exp = next(self.underivedStringifiedComponents) == nil
+		local _exp = next(self.undefinedStringifiedComponents) == nil
 		-- ▼ ReadonlySet.size ▼
 		local _size = 0
-		for _ in self.underivedStringifiedComponents do
+		for _ in self.undefinedStringifiedComponents do
 			_size += 1
 		end
 		-- ▲ ReadonlySet.size ▲
-		local _arg1 = `There are {_size} components that are not derived`
+		local _arg1 = `There are {_size} components that are not defined`
 		assert(_exp, _arg1)
 		self.started = true
 		local _exp_1 = self.systems
@@ -439,15 +439,15 @@ do
 		local c = self._world:component()
 		return c
 	end
-	function Covenant:checkComponentDerived(component)
-		local _underivedStringifiedComponents = self.underivedStringifiedComponents
+	function Covenant:checkComponentDefined(component)
+		local _undefinedStringifiedComponents = self.undefinedStringifiedComponents
 		local _arg0 = tostring(component)
-		local _arg0_1 = _underivedStringifiedComponents[_arg0] ~= nil
-		local _arg1 = `Component {component} is already derived`
+		local _arg0_1 = _undefinedStringifiedComponents[_arg0] ~= nil
+		local _arg1 = `Component {component} is already defined`
 		assert(_arg0_1, _arg1)
-		local _underivedStringifiedComponents_1 = self.underivedStringifiedComponents
+		local _undefinedStringifiedComponents_1 = self.undefinedStringifiedComponents
 		local _arg0_2 = tostring(component)
-		_underivedStringifiedComponents_1[_arg0_2] = nil
+		_undefinedStringifiedComponents_1[_arg0_2] = nil
 	end
 	function Covenant:defineComponentNetworkBehavior(component, replicated, predictionValidator)
 		if replicated then
@@ -465,13 +465,13 @@ do
 			_stringifiedComponentValidators[_arg0_1] = _predictionValidator
 		end
 	end
-	function Covenant:deriveComponent(_param)
+	function Covenant:defineComputedComponent(_param)
 		local component = _param.component
 		local queriedComponents = _param.queriedComponents
 		local recipe = _param.recipe
 		local replicated = _param.replicated
 		local predictionValidator = _param.predictionValidator
-		self:checkComponentDerived(component)
+		self:checkComponentDefined(component)
 		self:defineComponentNetworkBehavior(component, replicated, predictionValidator)
 		local queryThisComponent = self:worldQuery(component):cached()
 		local willUpdate = true
@@ -581,7 +581,7 @@ do
 			updater()
 		end)
 	end
-	function Covenant:deriveChildren(_param)
+	function Covenant:defineManagedChildren(_param)
 		local parentComponent = _param.parentComponent
 		local parentEntityTrackerComponent = _param.parentEntityTrackerComponent
 		local childIdentityComponent = _param.childIdentityComponent
@@ -590,9 +590,9 @@ do
 		local recipe = _param.recipe
 		local replicated = _param.replicated
 		local predictionValidator = _param.predictionValidator
-		self:checkComponentDerived(parentComponent)
-		self:checkComponentDerived(parentEntityTrackerComponent)
-		self:checkComponentDerived(childIdentityComponent)
+		self:checkComponentDefined(parentComponent)
+		self:checkComponentDefined(parentEntityTrackerComponent)
+		self:checkComponentDefined(childIdentityComponent)
 		self:defineComponentNetworkBehavior(parentComponent, replicated, predictionValidator)
 		local queryParentComponent = self:worldQuery(parentComponent):cached()
 		local willUpdate = true
@@ -769,11 +769,11 @@ do
 			updater()
 		end)
 	end
-	function Covenant:deriveRootEntity(_param)
+	function Covenant:defineEntitySource(_param)
 		local identityComponent = _param.identityComponent
 		local recipe = _param.recipe
 		local replicated = _param.replicated
-		self:checkComponentDerived(identityComponent)
+		self:checkComponentDefined(identityComponent)
 		self:defineComponentNetworkBehavior(identityComponent, replicated, false)
 		local willUpdate = true
 		local function indicateUpdate()
@@ -791,23 +791,29 @@ do
 			local _binding = recipe(lastUpdateId, hooks)
 			local statesToCreate = _binding.statesToCreate
 			local entitiesToDelete = _binding.entitiesToDelete
-			-- ▼ ReadonlyArray.forEach ▼
-			local _callback = function(state)
-				local entity = self:worldEntity()
-				self:worldSet(entity, identityComponent, state)
-			end
-			for _k, _v in statesToCreate do
-				_callback(_v, _k - 1, statesToCreate)
-			end
-			-- ▲ ReadonlyArray.forEach ▲
-			-- ▼ ReadonlyArray.forEach ▼
-			local _callback_1 = function(entity)
-				self:worldDelete(entity)
+			local _result = statesToCreate
+			if _result ~= nil then
+				-- ▼ ReadonlyArray.forEach ▼
+				local _callback = function(state)
+					local entity = self:worldEntity()
+					self:worldSet(entity, identityComponent, state)
+				end
+				for _k, _v in _result do
+					_callback(_v, _k - 1, _result)
+				end
+				-- ▲ ReadonlyArray.forEach ▲
 			end
-			for _k, _v in entitiesToDelete do
-				_callback_1(_v, _k - 1, entitiesToDelete)
+			local _result_1 = entitiesToDelete
+			if _result_1 ~= nil then
+				-- ▼ ReadonlyArray.forEach ▼
+				local _callback = function(entity)
+					self:worldDelete(entity)
+				end
+				for _k, _v in _result_1 do
+					_callback(_v, _k - 1, _result_1)
+				end
+				-- ▲ ReadonlyArray.forEach ▲
 			end
-			-- ▲ ReadonlyArray.forEach ▲
 		end
 		self:schedule(RunService.Heartbeat, function()
 			if not willUpdate then

package/src/hooks.luau

@@ -1,89 +1,112 @@
 -- Compiled with roblox-ts v3.0.0
 -- eslint-disable-next-line @typescript-eslint/no-explicit-any
-local function withUpdateId(fn)
-	local cache = nil
-	local lastUpdateId = -1
-	return function(id, ...)
-		local args = { ... }
-		if lastUpdateId ~= id then
-			cache = nil
-			lastUpdateId = id
-		end
-		if cache == nil then
-			cache = fn(unpack(args))
-		end
-		return cache
-	end
-end
 local function createUseEvent(_param)
 	local indicateUpdate = _param.indicateUpdate
 	local queues = {}
 	local watchedEvents = {}
-	local hook = function(event)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, event)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local _event = event
-		if not (watchedEvents[_event] ~= nil) then
-			local _event_1 = event
-			watchedEvents[_event_1] = true
+		local cache = caches[_event]
+		if cache ~= nil then
+			return cache
+		end
+		local _event_1 = event
+		if not (watchedEvents[_event_1] ~= nil) then
 			local _event_2 = event
-			queues[_event_2] = {}
+			watchedEvents[_event_2] = true
+			local _event_3 = event
+			queues[_event_3] = {}
 			event:Connect(function(...)
 				local args = { ... }
-				local _event_3 = event
-				local _exp = queues[_event_3]
+				local _event_4 = event
+				local _exp = queues[_event_4]
 				local _args = args
 				table.insert(_exp, _args)
 				indicateUpdate()
 			end)
+			local _event_4 = event
+			caches[_event_4] = {}
 			return {}
 		end
-		local _event_1 = event
-		local queue = queues[_event_1]
+		local _event_2 = event
+		local queue = queues[_event_2]
 		if not (#queue == 0) then
-			local _event_2 = event
-			queues[_event_2] = {}
+			local _event_3 = event
+			queues[_event_3] = {}
 		end
+		local _event_3 = event
+		caches[_event_3] = queue
 		return queue
 	end
-	return withUpdateId(hook)
 end
 local function createUseEventImmediately(_param)
 	local indicateUpdate = _param.indicateUpdate
 	local queues = {}
 	local watchedEvents = {}
-	local hook = function(event, callback)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, event, callback)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local _event = event
-		if not (watchedEvents[_event] ~= nil) then
-			local _event_1 = event
-			watchedEvents[_event_1] = true
+		local cache = caches[_event]
+		if cache ~= nil then
+			return cache
+		end
+		local _event_1 = event
+		if not (watchedEvents[_event_1] ~= nil) then
 			local _event_2 = event
-			queues[_event_2] = {}
+			watchedEvents[_event_2] = true
+			local _event_3 = event
+			queues[_event_3] = {}
 			event:Connect(function(...)
 				local args = { ... }
-				local _event_3 = event
-				local _exp = queues[_event_3]
+				local _event_4 = event
+				local _exp = queues[_event_4]
 				local _arg0 = callback(unpack(args))
 				table.insert(_exp, _arg0)
 				indicateUpdate()
 			end)
+			local _event_4 = event
+			caches[_event_4] = {}
 			return {}
 		end
-		local _event_1 = event
-		local queue = queues[_event_1]
+		local _event_2 = event
+		local queue = queues[_event_2]
 		if not (#queue == 0) then
-			local _event_2 = event
-			queues[_event_2] = {}
+			local _event_3 = event
+			queues[_event_3] = {}
 		end
+		local _event_3 = event
+		caches[_event_3] = queue
 		return queue
 	end
-	return withUpdateId(hook)
 end
 local function createUseComponentChange(_param)
 	local subscribeComponent = _param.subscribeComponent
 	local update = _param.indicateUpdate
 	local queues = {}
 	local watchedStringifiedComponents = {}
-	local hook = function(component)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, component)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local stringifiedComponent = tostring(component)
+		local cache = caches[stringifiedComponent]
+		if cache ~= nil then
+			return cache
+		end
 		if not (watchedStringifiedComponents[stringifiedComponent] ~= nil) then
 			watchedStringifiedComponents[stringifiedComponent] = true
 			queues[stringifiedComponent] = {}
@@ -97,15 +120,16 @@ local function createUseComponentChange(_param)
 				table.insert(_exp, _arg0)
 				update()
 			end)
+			caches[stringifiedComponent] = {}
 			return {}
 		end
 		local queue = queues[stringifiedComponent]
 		if not (#queue == 0) then
 			queues[stringifiedComponent] = {}
 		end
+		caches[stringifiedComponent] = queue
 		return queue
 	end
-	return withUpdateId(hook)
 end
 local function equalsDependencies(a, b)
 	if a == b then
@@ -135,27 +159,43 @@ end
 local function createUseAsync(_param)
 	local indicateUpdate = _param.indicateUpdate
 	local storage = {}
-	local hook = function(asnycFactory, dependencies, discriminator)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, asnycFactory, dependencies, discriminator)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local _discriminator = discriminator
-		if not (storage[_discriminator] ~= nil) then
+		local cache = caches[_discriminator]
+		if cache ~= nil then
+			return cache
+		end
+		local _discriminator_1 = discriminator
+		if not (storage[_discriminator_1] ~= nil) then
 			local newResult = {
 				completed = false,
 				value = nil,
 			}
 			local thread = coroutine.create(executeThread)
 			coroutine.resume(thread, newResult, asnycFactory, indicateUpdate)
-			local _discriminator_1 = discriminator
+			local _discriminator_2 = discriminator
 			local _arg1 = {
 				lastDependencies = dependencies,
 				thread = thread,
 				result = newResult,
 			}
-			storage[_discriminator_1] = _arg1
+			storage[_discriminator_2] = _arg1
+			local _discriminator_3 = discriminator
+			caches[_discriminator_3] = newResult
 			return newResult
 		end
-		local _discriminator_1 = discriminator
-		local state = storage[_discriminator_1]
+		local _discriminator_2 = discriminator
+		local state = storage[_discriminator_2]
 		if equalsDependencies(state.lastDependencies, dependencies) then
+			local _discriminator_3 = discriminator
+			local _result = state.result
+			caches[_discriminator_3] = _result
 			return state.result
 		else
 			coroutine.yield(state.thread)
@@ -166,39 +206,56 @@ local function createUseAsync(_param)
 			}
 			local newThread = coroutine.create(executeThread)
 			coroutine.resume(newThread, newResult, asnycFactory, indicateUpdate)
-			local _discriminator_2 = discriminator
+			local _discriminator_3 = discriminator
 			local _arg1 = {
 				lastDependencies = dependencies,
 				thread = newThread,
 				result = newResult,
 			}
-			storage[_discriminator_2] = _arg1
+			storage[_discriminator_3] = _arg1
+			local _discriminator_4 = discriminator
+			caches[_discriminator_4] = newResult
 			return newResult
 		end
 	end
-	return withUpdateId(hook)
 end
 local function createUseImperative(_param)
 	local indicateUpdate = _param.indicateUpdate
 	local storage = {}
-	local hook = function(dirtyFactory, dependencies, discriminator)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, dirtyFactory, dependencies, discriminator)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local _discriminator = discriminator
-		if not (storage[_discriminator] ~= nil) then
+		local cache = caches[_discriminator]
+		if cache ~= nil then
+			return cache
+		end
+		local _discriminator_1 = discriminator
+		if not (storage[_discriminator_1] ~= nil) then
 			local _binding = dirtyFactory(indicateUpdate)
 			local value = _binding.value
 			local cleanup = _binding.cleanup
-			local _discriminator_1 = discriminator
+			local _discriminator_2 = discriminator
 			local _arg1 = {
 				cache = value,
 				cleanup = cleanup,
 				lastDependencies = dependencies,
 			}
-			storage[_discriminator_1] = _arg1
+			storage[_discriminator_2] = _arg1
+			local _discriminator_3 = discriminator
+			caches[_discriminator_3] = value
 			return value
 		end
-		local _discriminator_1 = discriminator
-		local state = storage[_discriminator_1]
+		local _discriminator_2 = discriminator
+		local state = storage[_discriminator_2]
 		if equalsDependencies(state.lastDependencies, dependencies) then
+			local _discriminator_3 = discriminator
+			local _cache = state.cache
+			caches[_discriminator_3] = _cache
 			return state.cache
 		else
 			if state.cleanup ~= nil then
@@ -207,66 +264,100 @@ local function createUseImperative(_param)
 			local _binding = dirtyFactory(indicateUpdate)
 			local value = _binding.value
 			local cleanup = _binding.cleanup
-			local _discriminator_2 = discriminator
+			local _discriminator_3 = discriminator
 			local _arg1 = {
 				cache = value,
 				cleanup = cleanup,
 				lastDependencies = dependencies,
 			}
-			storage[_discriminator_2] = _arg1
+			storage[_discriminator_3] = _arg1
+			local _discriminator_4 = discriminator
+			caches[_discriminator_4] = value
 			return value
 		end
 	end
-	return withUpdateId(hook)
 end
 local function createUseChange()
 	local dependenciesStorage = {}
-	local hook = function(dependencies, discriminator)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, dependencies, discriminator)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local _discriminator = discriminator
-		if not (dependenciesStorage[_discriminator] ~= nil) then
-			local _discriminator_1 = discriminator
+		local cache = caches[_discriminator]
+		if cache ~= nil then
+			return cache
+		end
+		local _discriminator_1 = discriminator
+		if not (dependenciesStorage[_discriminator_1] ~= nil) then
+			local _discriminator_2 = discriminator
 			local _dependencies = dependencies
-			dependenciesStorage[_discriminator_1] = _dependencies
+			dependenciesStorage[_discriminator_2] = _dependencies
+			local _discriminator_3 = discriminator
+			caches[_discriminator_3] = true
 			return true
 		end
-		local _discriminator_1 = discriminator
-		local lastDependencies = dependenciesStorage[_discriminator_1]
+		local _discriminator_2 = discriminator
+		local lastDependencies = dependenciesStorage[_discriminator_2]
 		if equalsDependencies(lastDependencies, dependencies) then
+			local _discriminator_3 = discriminator
+			caches[_discriminator_3] = false
 			return false
 		else
-			local _discriminator_2 = discriminator
+			local _discriminator_3 = discriminator
 			local _dependencies = dependencies
-			dependenciesStorage[_discriminator_2] = _dependencies
+			dependenciesStorage[_discriminator_3] = _dependencies
+			local _discriminator_4 = discriminator
+			caches[_discriminator_4] = true
 			return true
 		end
 	end
-	return withUpdateId(hook)
 end
 local function createUseInterval(_param)
 	local indicateUpdate = _param.indicateUpdate
 	local nextClocks = {}
-	local hook = function(seconds, trueOnInit, discriminator)
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, seconds, trueOnInit, discriminator)
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
 		local _discriminator = discriminator
-		if not (nextClocks[_discriminator] ~= nil) then
-			local _discriminator_1 = discriminator
+		local cache = caches[_discriminator]
+		if cache ~= nil then
+			return cache
+		end
+		local _discriminator_1 = discriminator
+		if not (nextClocks[_discriminator_1] ~= nil) then
+			local _discriminator_2 = discriminator
 			local _arg1 = os.clock() + seconds
-			nextClocks[_discriminator_1] = _arg1
+			nextClocks[_discriminator_2] = _arg1
 			task.delay(seconds, indicateUpdate)
+			local _discriminator_3 = discriminator
+			local _trueOnInit = trueOnInit
+			caches[_discriminator_3] = _trueOnInit
 			return trueOnInit
 		end
-		local _discriminator_1 = discriminator
-		local nextClock = nextClocks[_discriminator_1]
+		local _discriminator_2 = discriminator
+		local nextClock = nextClocks[_discriminator_2]
 		if nextClock < os.clock() then
+			local _discriminator_3 = discriminator
+			caches[_discriminator_3] = false
 			return false
 		else
-			local _discriminator_2 = discriminator
+			local _discriminator_3 = discriminator
 			local _arg1 = os.clock() + seconds
-			nextClocks[_discriminator_2] = _arg1
+			nextClocks[_discriminator_3] = _arg1
 			task.delay(seconds, indicateUpdate)
+			local _discriminator_4 = discriminator
+			caches[_discriminator_4] = true
 			return true
 		end
 	end
-	return withUpdateId(hook)
 end
 local function createHooks(props)
 	return {