@rbxts/covenant 3.6.0 → 3.7.0

package/package.json

@@ -1,48 +1,48 @@
-{
-    "name": "@rbxts/covenant",
-    "version": "3.6.0",
-    "main": "src/init.luau",
-    "scripts": {
-        "build": "rbxtsc",
-        "watch": "rbxtsc -w",
-        "prepublishOnly": "npm run build"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/cuberootmctoasted/covenant.git"
-    },
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/cuberootmctoasted/covenant/issues"
-    },
-    "homepage": "https://github.com/cuberootmctoasted/covenant#readme",
-    "description": "",
-    "types": "src/covenant.d.ts",
-    "files": [
-        "src",
-        "!**/*.tsbuildinfo"
-    ],
-    "publishConfig": {
-        "access": "public"
-    },
-    "devDependencies": {
-        "@rbxts/compiler-types": "^3.0.0-types.0",
-        "@rbxts/covenant": "^2.1.1",
-        "@rbxts/types": "^1.0.891",
-        "@typescript-eslint/eslint-plugin": "^8.47.0",
-        "@typescript-eslint/parser": "^8.47.0",
-        "eslint": "^9.39.1",
-        "eslint-config-prettier": "^10.1.8",
-        "eslint-plugin-prettier": "^5.5.4",
-        "eslint-plugin-roblox-ts": "^1.3.0",
-        "prettier": "^3.6.2",
-        "roblox-ts": "^3.0.0",
-        "typescript": "^5.9.3"
-    },
-    "dependencies": {
-        "@rbxts/jecs": "^0.9.0",
-        "@rbxts/services": "^1.6.0"
-    }
-}
+{
+    "name": "@rbxts/covenant",
+    "version": "3.7.0",
+    "main": "src/init.luau",
+    "scripts": {
+        "build": "rbxtsc",
+        "watch": "rbxtsc -w",
+        "prepublishOnly": "npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/cuberootmctoasted/covenant.git"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/cuberootmctoasted/covenant/issues"
+    },
+    "homepage": "https://github.com/cuberootmctoasted/covenant#readme",
+    "description": "",
+    "types": "src/covenant.d.ts",
+    "files": [
+        "src",
+        "!**/*.tsbuildinfo"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "devDependencies": {
+        "@rbxts/compiler-types": "^3.0.0-types.0",
+        "@rbxts/covenant": "^2.1.1",
+        "@rbxts/types": "^1.0.891",
+        "@typescript-eslint/eslint-plugin": "^8.47.0",
+        "@typescript-eslint/parser": "^8.47.0",
+        "eslint": "^9.39.1",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-prettier": "^5.5.4",
+        "eslint-plugin-roblox-ts": "^1.3.0",
+        "prettier": "^3.6.2",
+        "roblox-ts": "^3.0.0",
+        "typescript": "^5.9.3"
+    },
+    "dependencies": {
+        "@rbxts/jecs": "^0.9.0",
+        "@rbxts/services": "^1.6.0"
+    }
+}

package/src/covenant.luau

@@ -578,21 +578,7 @@ do
 		end
 		local hooks = createHooks({
 			indicateUpdate = indicateUpdate,
-			subscribeComponent = function(component, subscriber)
-				self:subscribeComponent(component, subscriber)
-			end,
-			getPayloadQueue = function(component)
-				local queue = {}
-				for entity, state in self:worldQuery(component) do
-					local _arg0 = {
-						entity = entity,
-						state = state,
-						previousState = nil,
-					}
-					table.insert(queue, _arg0)
-				end
-				return queue
-			end,
+			covenant = self,
 		})
 		-- ▼ ReadonlyArray.map ▼
 		local _newValue = table.create(#queriedComponents)

package/src/hooks.d.ts

@@ -1,4 +1,5 @@
 import { Entity } from "@rbxts/jecs";
+import { Covenant } from "./covenant";
 type AsyncResult<T = unknown> = {
     completed: boolean;
     value: T | undefined;
@@ -13,6 +14,10 @@ export interface CovenantHooks {
         state: T | undefined;
         previousState: T | undefined;
     }[];
+    useComponentChangeOfEntity: <T extends defined>(updateId: number, entity: Entity, component: Entity<T>, payload: boolean) => {
+        state: T | undefined;
+        previousState: T | undefined;
+    } | undefined;
     useAsync: <T>(updateId: number, asnycFactory: () => T, dependencies: unknown[], discriminator: Discriminator) => AsyncResult<T>;
     useImperative: <T extends defined>(updateId: number, dirtyFactory: (indicateUpdate: () => void) => {
         value: T;
@@ -23,12 +28,7 @@ export interface CovenantHooks {
 }
 interface CovenantHooksProps {
     indicateUpdate: () => void;
-    subscribeComponent: <T extends defined>(component: Entity<T>, subscriber: (entity: Entity, state: T | undefined, previousState: T | undefined) => void) => void;
-    getPayloadQueue: <T extends defined>(component: Entity<T>) => {
-        entity: Entity;
-        state: T | undefined;
-        previousState: T | undefined;
-    }[];
+    covenant: Covenant;
 }
 export declare function createHooks(props: CovenantHooksProps): CovenantHooks;
 export {};

package/src/hooks.luau

@@ -77,9 +77,8 @@ local function createUseEventImmediately(_param)
 	end
 end
 local function createUseComponentChange(_param)
-	local subscribeComponent = _param.subscribeComponent
+	local covenant = _param.covenant
 	local indicateUpdate = _param.indicateUpdate
-	local getPayloadQueue = _param.getPayloadQueue
 	local queues = {}
 	local watchedStringifiedComponents = {}
 	local caches = {}
@@ -100,7 +99,7 @@ local function createUseComponentChange(_param)
 		if not (watchedStringifiedComponents[stringifiedComponent] ~= nil) then
 			watchedStringifiedComponents[stringifiedComponent] = true
 			queues[stringifiedComponent] = {}
-			subscribeComponent(component, function(entity, state, previousState)
+			covenant:subscribeComponent(component, function(entity, state, previousState)
 				local _exp = queues[stringifiedComponent]
 				local _arg0 = {
 					entity = entity,
@@ -114,7 +113,16 @@ local function createUseComponentChange(_param)
 			if not payload then
 				return {}
 			else
-				return getPayloadQueue(component)
+				local payloadQueue = {}
+				for entity, state in covenant:worldQuery(component) do
+					local _arg0 = {
+						entity = entity,
+						state = state,
+						previousState = nil,
+					}
+					table.insert(payloadQueue, _arg0)
+				end
+				return payloadQueue
 			end
 		end
 		local queue = queues[stringifiedComponent]
@@ -125,6 +133,64 @@ local function createUseComponentChange(_param)
 		return queue
 	end
 end
+local function createUseComponentChangeOfEntity(_param)
+	local covenant = _param.covenant
+	local indicateUpdate = _param.indicateUpdate
+	local changes = {}
+	local watchedStringifiedComponents = {}
+	local caches = {}
+	local lastUpdateId = -1
+	return function(updateId, entity, component, payload)
+		if payload == nil then
+			payload = false
+		end
+		if lastUpdateId ~= updateId then
+			table.clear(caches)
+			lastUpdateId = updateId
+		end
+		local stringifiedComponent = tostring(component)
+		local cache = caches[stringifiedComponent]
+		if cache ~= nil then
+			return if cache == false then nil else cache
+		end
+		if not (watchedStringifiedComponents[stringifiedComponent] ~= nil) then
+			watchedStringifiedComponents[stringifiedComponent] = true
+			covenant:subscribeComponent(component, function(anEntity, state, previousState)
+				if entity ~= anEntity then
+					return nil
+				end
+				local _arg1 = {
+					state = state,
+					previousState = previousState,
+				}
+				changes[stringifiedComponent] = _arg1
+				indicateUpdate()
+			end)
+			caches[stringifiedComponent] = false
+			if not payload then
+				return nil
+			else
+				if not covenant:worldContains(entity) then
+					return nil
+				end
+				local state = covenant:worldGet(entity, component)
+				if state == nil then
+					return nil
+				end
+				return {
+					state = state,
+					previousState = nil,
+				}
+			end
+		end
+		local change = changes[stringifiedComponent]
+		if change ~= nil then
+			changes[stringifiedComponent] = nil
+		end
+		caches[stringifiedComponent] = change
+		return change
+	end
+end
 local function equalsDependencies(a, b)
 	if a == b then
 		return true
@@ -357,6 +423,7 @@ local function createHooks(props)
 		useEvent = createUseEvent(props),
 		useEventImmediately = createUseEventImmediately(props),
 		useComponentChange = createUseComponentChange(props),
+		useComponentChangeOfEntity = createUseComponentChangeOfEntity(props),
 		useAsync = createUseAsync(props),
 		useImperative = createUseImperative(props),
 		useChange = createUseChange(),