feat: add provideImmerComponentStore() (#18)

Closes #18

src/component-store/immer-component-store.ts

@@ -0,0 +1,29 @@
+import { Injectable } from '@angular/core';
+import { Observable, Subscription } from 'rxjs';
+import { ComponentStore } from '@ngrx/component-store';
+
+import { immerReducer } from 'ngrx-immer/shared';
+
+/**
+ * Immer wrapper around `ImmerComponentStore` to mutate state
+ * with `updater` and `setState`
+ */
+@Injectable()
+export class ImmerComponentStore<
+	State extends object
+> extends ComponentStore<State> {
+	updater<
+		ProvidedType = void,
+		OriginType = ProvidedType,
+		ValueType = OriginType,
+		ReturnType = OriginType extends void
+			? () => void
+			: (observableOrValue: ValueType | Observable<ValueType>) => Subscription
+	>(updaterFn: (state: State, value: OriginType) => void | State): ReturnType {
+		return super.updater(immerReducer(updaterFn));
+	}
+
+	setState(stateOrUpdaterFn: State | ((state: State) => void | State)): void {
+		super.setState(stateOrUpdaterFn as State | ((state: State) => State));
+	}
+}

src/component-store/index.ts

@@ -1,29 +1,2 @@
-import { Injectable } from '@angular/core';
-import { Observable, Subscription } from 'rxjs';
-import { ComponentStore } from '@ngrx/component-store';
-
-import { immerReducer } from 'ngrx-immer/shared';
-
-/**
- * Immer wrapper around `ImmerComponentStore` to mutate state
- * with `updater` and `setState`
- */
-@Injectable()
-export class ImmerComponentStore<
-	State extends object
-> extends ComponentStore<State> {
-	updater<
-		ProvidedType = void,
-		OriginType = ProvidedType,
-		ValueType = OriginType,
-		ReturnType = OriginType extends void
-			? () => void
-			: (observableOrValue: ValueType | Observable<ValueType>) => Subscription
-	>(updaterFn: (state: State, value: OriginType) => void | State): ReturnType {
-		return super.updater(immerReducer(updaterFn));
-	}
-
-	setState(stateOrUpdaterFn: State | ((state: State) => void | State)): void {
-		super.setState(stateOrUpdaterFn as State | ((state: State) => State));
-	}
-}
+export { ImmerComponentStore } from './immer-component-store';
+export { provideImmerComponentStore } from './provide-immer-component-store';

src/component-store/provide-immer-component-store.ts

@@ -0,0 +1,12 @@
+import { ComponentStore, provideComponentStore } from '@ngrx/component-store';
+import { Provider, Type } from '@angular/core';
+import { ImmerComponentStore } from '.';
+
+/**
+ * @description
+ * Immer wrapper around `provideComponentStore()` in `@ngrx/component-store`.
+ * @returns the ImmerComponentStore class registered as a provider
+ */
+export function provideImmerComponentStore<T extends object>(componentStoreClass: Type<ImmerComponentStore<T>>): Provider[] {
+    return provideComponentStore(componentStoreClass as Type<ComponentStore<T>>);
+}

src/component-store/tests/provide-immer-component-store.test.ts

@@ -0,0 +1,22 @@
+import '@angular/compiler';
+import { test } from 'uvu';
+import * as assert from 'uvu/assert';
+
+import { ImmerComponentStore, provideImmerComponentStore } from 'ngrx-immer/component-store';
+import { provideComponentStore } from '@ngrx/component-store';
+
+
+test('provideImmerComponentStore() should equal provideComponentStore()', () => {
+	const ngrxProviders = provideComponentStore(DummyImmerComponentStore as any);
+
+	const ngrxImmerProviders = provideImmerComponentStore(DummyImmerComponentStore);
+
+	// assert
+	assert.instance(ngrxImmerProviders, Array);
+	assert.is.not(ngrxImmerProviders.length, 0);
+	assert.equal(ngrxImmerProviders.toString(), ngrxProviders.toString());
+});
+
+class DummyImmerComponentStore extends ImmerComponentStore<{}> { }
+
+test.run();