Make Patch[] arrays readonly on the outer bounds

immerjs · Feb 27, 2024 · a125a1e · a125a1e
1 parent f6736a4
commit a125a1e
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/src/core/immerClass.ts b/src/core/immerClass.ts
@@ -120,11 +120,15 @@ export class Immer implements ProducersFns {
 				this.produceWithPatches(state, (draft: any) => base(draft, ...args))
 		}
 
-		let patches: Patch[], inversePatches: Patch[]
-		const result = this.produce(base, recipe, (p: Patch[], ip: Patch[]) => {
-			patches = p
-			inversePatches = ip
-		})
+		let patches: readonly Patch[], inversePatches: readonly Patch[]
+		const result = this.produce(
+			base,
+			recipe,
+			(p: readonly Patch[], ip: readonly Patch[]) => {
+				patches = p
+				inversePatches = ip
+			}
+		)
 		return [result, patches!, inversePatches!]
 	}
 

diff --git a/src/plugins/patches.ts b/src/plugins/patches.ts
@@ -211,7 +211,7 @@ export function enablePatches() {
 		})
 	}
 
-	function applyPatches_<T>(draft: T, patches: Patch[]): T {
+	function applyPatches_<T>(draft: T, patches: readonly Patch[]): T {
 		patches.forEach(patch => {
 			const {path, op} = patch
 

diff --git a/src/types/types-external.ts b/src/types/types-external.ts
@@ -68,7 +68,10 @@ export interface Patch {
 	value?: any
 }
 
-export type PatchListener = (patches: Patch[], inversePatches: Patch[]) => void
+export type PatchListener = (
+	patches: readonly Patch[],
+	inversePatches: readonly Patch[]
+) => void
 
 /** Converts `nothing` into `undefined` */
 type FromNothing<T> = T extends typeof NOTHING ? undefined : T
@@ -81,7 +84,7 @@ export type Produced<Base, Return> = Return extends void
 /**
  * Utility types
  */
-type PatchesTuple<T> = readonly [T, Patch[], Patch[]]
+type PatchesTuple<T> = readonly [T, readonly Patch[], readonly Patch[]]
 
 type ValidRecipeReturnType<State> =
 	| State

diff --git a/src/utils/plugins.ts b/src/utils/plugins.ts
@@ -24,7 +24,7 @@ const plugins: {
 			patches: Patch[],
 			inversePatches: Patch[]
 		): void
-		applyPatches_<T>(draft: T, patches: Patch[]): T
+		applyPatches_<T>(draft: T, patches: readonly Patch[]): T
 	}
 	MapSet?: {
 		proxyMap_<T extends AnyMap>(target: T, parent?: ImmerState): T