feat: add with-connect feature

withConnect() adds a method to connect Signals back to the store.
Everytime these Signals change, the store will be updated accordingly.

Author: manfredsteyer

docs/docs/with-connect.md

@@ -0,0 +1,52 @@
+---
+title: withConnect()
+---
+
+```typescript
+import { withConnect } from '@angular-architects/ngrx-toolkit';
+```
+
+`withConnect()` adds a method to connect Signals back to your store. Everytime these Signals change, the store will be updated accordingly.
+
+Example:
+
+```ts
+const Store = signalStore(
+  { protectedState: false },
+  withState({
+    maxWarpFactor: 8,
+    shipName: 'USS Enterprise',
+    registration: 'NCC-1701',
+    poeple: 430,
+  }),
+  withConnect()
+);
+```
+
+```ts
+@Component({ ... })
+export class MyComponent {
+  private store = inject(OfferListStore);
+
+  readonly maxWarpFactor = signal(8);
+  readonly registration = signal('NCC-1701');
+  readonly people = signal(430);
+
+  constructor() {
+    //
+    // Every change in the local Signals is
+    // refected in the store
+    //
+    this.store.connect(() => ({
+        //
+        // Subset of state in the store
+        //
+        maxWarpFactor: this.maxWarpFactor(),
+        registration: this.registration(),
+        poeple: this.poeple(),
+    }));
+  }
+
+  ...
+}
+```

docs/sidebars.ts

@@ -26,6 +26,7 @@ const sidebars: SidebarsConfig = {
     'with-feature-factory',
     'with-conditional',
     'with-call-state',
+    'with-connect',
   ],
   reduxConnectorSidebar: [
     {

libs/ngrx-toolkit/src/index.ts

@@ -41,3 +41,4 @@ export {
 } from './lib/storage-sync/with-storage-sync';
 export { emptyFeature, withConditional } from './lib/with-conditional';
 export { withFeatureFactory } from './lib/with-feature-factory';
+export * from './lib/with-connect';

libs/ngrx-toolkit/src/lib/with-connect.spec.ts

@@ -0,0 +1,61 @@
+import { getState, patchState, signalStore, withState } from '@ngrx/signals';
+import { fakeAsync, TestBed, tick } from '@angular/core/testing';
+import { signal } from '@angular/core';
+import { withConnect } from './with-connect';
+
+describe('withConnect', () => {
+  const setup = () => {
+    const Store = signalStore(
+      { protectedState: false },
+      withState({
+        maxWarpFactor: 8,
+        shipName: 'USS Enterprise',
+        registration: 'NCC-1701',
+        poeple: 430,
+      }),
+      withConnect()
+    );
+
+    const store = TestBed.configureTestingModule({
+      providers: [Store],
+    }).inject(Store);
+
+    return { store };
+  };
+
+  it('should update store after connected signals are changed', fakeAsync(() => {
+    const { store } = setup();
+
+    TestBed.runInInjectionContext(() => {
+      const maxWarpFactor = signal(9);
+      const registration = signal('NCC-1701-D');
+      const poeple = signal(1100);
+
+      store.connect(() => ({
+        maxWarpFactor: maxWarpFactor(),
+        registration: registration(),
+        poeple: poeple(),
+      }));
+      tick(1);
+      expect(getState(store)).toMatchObject({
+        maxWarpFactor: 9,
+        shipName: 'USS Enterprise',
+        registration: 'NCC-1701-D',
+        poeple: 1100,
+      });
+
+      maxWarpFactor.set(9.6);
+      tick(1);
+      expect(getState(store).maxWarpFactor).toBeCloseTo(9.6);
+      expect(getState(store).shipName).toEqual('USS Enterprise');
+
+      patchState(store, { maxWarpFactor: 9.2 });
+      tick(1);
+      expect(getState(store).maxWarpFactor).toBeCloseTo(9.2);
+      expect(getState(store).shipName).toEqual('USS Enterprise');
+
+      // It's just a one-way-sync
+      expect(maxWarpFactor()).toBeCloseTo(9.6);
+    });
+  }));
+});

libs/ngrx-toolkit/src/lib/with-connect.ts

@@ -0,0 +1,32 @@
+import { computed } from '@angular/core';
+import {
+  EmptyFeatureResult,
+  patchState,
+  signalMethod,
+  SignalStoreFeature,
+  signalStoreFeature,
+  SignalStoreFeatureResult,
+  withMethods,
+} from '@ngrx/signals';
+
+export type WithConnectResultType<T extends SignalStoreFeatureResult> =
+  EmptyFeatureResult & {
+    methods: { connect(stateFn: () => Partial<T['state']>): void };
+  };
+
+export function withConnect<
+  T extends SignalStoreFeatureResult
+>(): SignalStoreFeature<T, WithConnectResultType<T>> {
+  return signalStoreFeature(
+    withMethods((store) => {
+      return {
+        connect(stateFn: () => Partial<T['state']>): void {
+          const stateSignal = computed(stateFn);
+          signalMethod<Partial<T['state']>>((state) => {
+            patchState(store, state);
+          })(stateSignal);
+        },
+      };
+    })
+  );
+}