@rbxts/covenant 2.1.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rbxts/covenant",
-    "version": "2.1.0",
+    "version": "3.0.0",
     "main": "src/init.luau",
     "scripts": {
         "build": "rbxtsc",
@@ -29,14 +29,14 @@
     },
     "devDependencies": {
         "@rbxts/compiler-types": "^3.0.0-types.0",
-        "@rbxts/covenant": "^2.1.0",
-        "@rbxts/types": "^1.0.890",
-        "@typescript-eslint/eslint-plugin": "^8.46.4",
-        "@typescript-eslint/parser": "^8.46.4",
+        "@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.2.1",
+        "eslint-plugin-roblox-ts": "^1.3.0",
         "prettier": "^3.6.2",
         "roblox-ts": "^3.0.0",
         "typescript": "^5.9.3"

package/src/covenant.d.ts

@@ -1,5 +1,5 @@
 import { Entity, Id } from "@rbxts/jecs";
-import { CovenantHooks, Discriminator } from "./hooks";
+import { CovenantHooks } from "./hooks";
 import { Remove, Delete } from "./stringEnums";
 export * from "@rbxts/jecs";
 export type WorldChangesForReplication = Map<string, Delete | Map<string, defined | Remove>>;
@@ -36,6 +36,8 @@ export declare class Covenant {
     private predictionSend;
     private predictionConnect;
     constructor({ logging, requestPayloadSend, requestPayloadConnect, replicationSend, replicationConnect, replicationSendAll, predictionSend, predictionConnect, }: CovenantProps);
+    getClientEntity(entity: Entity): Entity | undefined;
+    getServerEntity(entity: Entity): Entity | undefined;
     private logging;
     enableLogging(): void;
     disableLogging(): void;
@@ -64,13 +66,10 @@ export declare class Covenant {
         queriedComponents: Entity[][];
         recipe: (entity: Entity, lastState: T | undefined, updateId: number, hooks: CovenantHooks) => T | undefined;
     }): void;
-    defineIdentity<T extends Discriminator>({ identityComponent, recipe, replicated, }: {
-        replicated: boolean;
+    defineIdentity<T extends defined>({ identityComponent, replicated, factory, }: {
         identityComponent: Entity<T>;
-        recipe: (entities: ReadonlyMap<T, Entity>, updateId: number, hooks: CovenantHooks) => {
-            statesToCreate?: T[];
-            statesToDelete?: T[];
-        } | undefined;
+        replicated: boolean;
+        factory: (spawn: (state: T) => Entity, despawn: (entity: Entity) => void) => void;
     }): void;
     private worldEntity;
     worldQuery<T extends Id[]>(...components: T): import("@rbxts/jecs").Query<T>;

package/src/covenant.luau

@@ -63,6 +63,16 @@ do
 		self:setupReplication()
 		self:setupPrediction()
 	end
+	function Covenant:getClientEntity(entity)
+		local _serverToClientEntityMap = self.serverToClientEntityMap
+		local _arg0 = tostring(entity)
+		return _serverToClientEntityMap[_arg0]
+	end
+	function Covenant:getServerEntity(entity)
+		local _clientToServerEntityMap = self.clientToServerEntityMap
+		local _arg0 = tostring(entity)
+		return _clientToServerEntityMap[_arg0]
+	end
 	function Covenant:enableLogging()
 		self.logging = true
 	end
@@ -660,78 +670,16 @@ do
 	end
 	function Covenant:defineIdentity(_param)
 		local identityComponent = _param.identityComponent
-		local recipe = _param.recipe
 		local replicated = _param.replicated
+		local factory = _param.factory
 		self:checkComponentDefined(identityComponent)
 		self:defineComponentNetworkBehavior(identityComponent, replicated, false)
-		local willUpdate = true
-		local function indicateUpdate()
-			willUpdate = true
-		end
-		local hooks = createHooks({
-			indicateUpdate = indicateUpdate,
-			subscribeComponent = function(component, subscriber)
-				self:subscribeComponent(component, subscriber)
-			end,
-		})
-		local entities = {}
-		self:subscribeComponent(identityComponent, function(entity, state, prevState)
-			if prevState ~= nil then
-				local _prevState = prevState
-				entities[_prevState] = nil
-			end
-			if state ~= nil then
-				local _state = state
-				local _entity = entity
-				entities[_state] = _entity
-			end
-		end)
-		local lastUpdateId = 0
-		local updater = function()
-			lastUpdateId += 1
-			local updateId = lastUpdateId
-			local modifiers = recipe(entities, updateId, hooks)
-			if modifiers == nil then
-				return nil
-			end
-			local _binding = modifiers
-			local statesToCreate = _binding.statesToCreate
-			local statesToDelete = _binding.statesToDelete
-			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
-			local _result_1 = statesToDelete
-			if _result_1 ~= nil then
-				-- ▼ ReadonlyArray.forEach ▼
-				local _callback = function(state)
-					local _state = state
-					local entity = entities[_state]
-					if entity == nil then
-						return nil
-					end
-					self:worldDelete(entity)
-				end
-				for _k, _v in _result_1 do
-					_callback(_v, _k - 1, _result_1)
-				end
-				-- ▲ ReadonlyArray.forEach ▲
-			end
-		end
-		self:schedule(RunService.Heartbeat, function()
-			if not willUpdate then
-				return nil
-			end
-			willUpdate = false
-			updater()
+		factory(function(state)
+			local entity = self:worldEntity()
+			self:worldSet(entity, identityComponent, state)
+			return entity
+		end, function(entity)
+			self:worldDelete(entity)
 		end)
 	end
 	function Covenant:worldEntity()