fix(signal-slice): Do not allow optional properties in signalSlice (#177

)
ngxtension · Nov 30, 2023 · 84ccf3c · 84ccf3c
1 parent 96d5de4
commit 84ccf3c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/libs/ngxtension/signal-slice/src/signal-slice.spec.ts b/libs/ngxtension/signal-slice/src/signal-slice.spec.ts
@@ -32,6 +32,13 @@ describe(signalSlice.name, () => {
 		it('should create default selectors', () => {
 			expect(state.age()).toEqual(initialState.age);
 		});
+
+		it('should not accept optional properties in initial state', () => {
+			// @ts-expect-error: Testing that signalSlice should not accept an optional property in its initial state
+			signalSlice<{ optional?: string }, any, any, any>({
+				initialState: { optional: 'test' },
+			});
+		});
 	});
 
 	describe('sources', () => {

diff --git a/libs/ngxtension/signal-slice/src/signal-slice.ts b/libs/ngxtension/signal-slice/src/signal-slice.ts
@@ -11,6 +11,10 @@ import { takeUntilDestroyed, toObservable } from '@angular/core/rxjs-interop';
 import { connect, type PartialOrValue, type Reducer } from 'ngxtension/connect';
 import { Subject, isObservable, take, type Observable } from 'rxjs';
 
+type NoOptionalProperties<T> = {
+	[P in keyof T]-?: T[P];
+};
+
 type NamedActionSources<TSignalValue> = {
 	[actionName: string]:
 		| Subject<any>
@@ -86,7 +90,7 @@ type ActionStreams<
 export type Source<TSignalValue> = Observable<PartialOrValue<TSignalValue>>;
 
 export type SignalSlice<
-	TSignalValue,
+	TSignalValue extends NoOptionalProperties<TSignalValue>,
 	TActionSources extends NamedActionSources<TSignalValue>,
 	TSelectors extends NamedSelectors,
 	TEffects extends NamedEffects
@@ -98,7 +102,7 @@ export type SignalSlice<
 	ActionStreams<TSignalValue, TActionSources>;
 
 export function signalSlice<
-	TSignalValue,
+	TSignalValue extends NoOptionalProperties<TSignalValue>,
 	TActionSources extends NamedActionSources<TSignalValue>,
 	TSelectors extends NamedSelectors,
 	TEffects extends NamedEffects