Only complete assigners are allowed

.changeset/thick-paws-invite.md

@@ -0,0 +1,5 @@
+---
+'@xstate/store': major
+---
+
+Only complete assigners can now be used

packages/xstate-store/src/store.ts

@@ -9,11 +9,8 @@ import {
   Recipe,
   Store,
   StoreAssigner,
-  StoreCompleteAssigner,
   StoreContext,
   StoreInspectionEvent,
-  StorePartialAssigner,
-  StorePropertyAssigner,
   StoreSnapshot
 } from './types';
 
@@ -57,17 +54,11 @@ function createStoreCore<
 >(
   initialContext: TContext,
   transitions: {
-    [K in keyof TEventPayloadMap & string]:
-      | StoreAssigner<
-          NoInfer<TContext>,
-          { type: K } & TEventPayloadMap[K],
-          TEmitted
-        >
-      | StorePropertyAssigner<
-          NoInfer<TContext>,
-          { type: K } & TEventPayloadMap[K],
-          TEmitted
-        >;
+    [K in keyof TEventPayloadMap & string]: StoreAssigner<
+      NoInfer<TContext>,
+      { type: K } & TEventPayloadMap[K],
+      TEmitted
+    >;
   },
   updater?: (
     context: NoInfer<TContext>,
@@ -207,21 +198,13 @@ export type TransitionsFromEventPayloadMap<
   TContext extends StoreContext,
   TEmitted extends EventObject
 > = {
-  [K in keyof TEventPayloadMap & string]:
-    | StoreAssigner<
-        TContext,
-        {
-          type: K;
-        } & TEventPayloadMap[K],
-        TEmitted
-      >
-    | StorePropertyAssigner<
-        TContext,
-        {
-          type: K;
-        } & TEventPayloadMap[K],
-        TEmitted
-      >;
+  [K in keyof TEventPayloadMap & string]: StoreAssigner<
+    TContext,
+    {
+      type: K;
+    } & TEventPayloadMap[K],
+    TEmitted
+  >;
 };
 
 /**
@@ -264,17 +247,11 @@ export function createStore<
 }: {
   context: TContext;
   on: {
-    [K in keyof TEventPayloadMap & string]:
-      | StoreAssigner<
-          NoInfer<TContext>,
-          { type: K } & TEventPayloadMap[K],
-          Cast<TTypes['emitted'], EventObject>
-        >
-      | StorePropertyAssigner<
-          NoInfer<TContext>,
-          { type: K } & TEventPayloadMap[K],
-          Cast<TTypes['emitted'], EventObject>
-        >;
+    [K in keyof TEventPayloadMap & string]: StoreAssigner<
+      NoInfer<TContext>,
+      { type: K } & TEventPayloadMap[K],
+      Cast<TTypes['emitted'], EventObject>
+    >;
   };
 } & { types?: TTypes }): Store<
   TContext,
@@ -445,13 +422,11 @@ export function createStoreTransition<
   TEmitted extends EventObject
 >(
   transitions: {
-    [K in keyof TEventPayloadMap & string]:
-      | StoreAssigner<TContext, { type: K } & TEventPayloadMap[K], TEmitted>
-      | StorePropertyAssigner<
-          TContext,
-          { type: K } & TEventPayloadMap[K],
-          TEmitted
-        >;
+    [K in keyof TEventPayloadMap & string]: StoreAssigner<
+      TContext,
+      { type: K } & TEventPayloadMap[K],
+      TEmitted
+    >;
   },
   updater?: (
     context: TContext,
@@ -480,9 +455,11 @@ export function createStoreTransition<
     if (typeof assigner === 'function') {
       currentContext = updater
         ? updater(currentContext, (draftContext) =>
-            (
-              assigner as StoreCompleteAssigner<TContext, StoreEvent, TEmitted>
-            )?.(draftContext, event, enqueue)
+            (assigner as StoreAssigner<TContext, StoreEvent, TEmitted>)?.(
+              draftContext,
+              event,
+              enqueue
+            )
           )
         : setter(currentContext, (draftContext) =>
             Object.assign(
@@ -501,14 +478,11 @@ export function createStoreTransition<
         const propAssignment = assigner[key];
         partialUpdate[key] =
           typeof propAssignment === 'function'
-            ? (
-                propAssignment as StorePartialAssigner<
-                  TContext,
-                  StoreEvent,
-                  typeof key,
-                  TEmitted
-                >
-              )(currentContext, event, enqueue)
+            ? (propAssignment as StoreAssigner<TContext, StoreEvent, TEmitted>)(
+                currentContext,
+                event,
+                enqueue
+              )
             : propAssignment;
       }
       currentContext = Object.assign({}, currentContext, partialUpdate);

packages/xstate-store/src/types.ts

@@ -18,7 +18,7 @@ export type StoreAssigner<
   context: TContext,
   event: TEvent,
   enq: EnqueueObject<TEmitted>
-) => Partial<TContext>;
+) => TContext;
 export type StoreCompleteAssigner<
   TContext,
   TEvent extends EventObject,

packages/xstate-store/test/fromStore.test.ts

@@ -4,11 +4,10 @@ import { fromStore } from '../src/index.ts';
 describe('fromStore', () => {
   it('creates an actor from store logic with input (2 args)', () => {
     const storeLogic = fromStore((count: number) => ({ count }), {
-      inc: {
-        count: (ctx, ev: { by: number }) => {
-          return ctx.count + ev.by;
-        }
-      }
+      inc: (ctx, ev: { by: number }) => ({
+        ...ctx,
+        count: ctx.count + ev.by
+      })
     });
 
     const actor = createActor(storeLogic, {

packages/xstate-store/test/react.test.tsx

@@ -14,9 +14,10 @@ it('useSelector should work', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      })
     }
   );
 
@@ -52,12 +53,14 @@ it('useSelector can take in a custom comparator', () => {
       items: [1, 2]
     },
     {
-      same: {
-        items: () => [1, 2] // different array, same items
-      },
-      different: {
-        items: () => [3, 4]
-      }
+      same: (ctx) => ({
+        ...ctx,
+        items: [1, 2] // different array, same items
+      }),
+      different: (ctx) => ({
+        ...ctx,
+        items: [3, 4]
+      })
     }
   );
 
@@ -117,9 +120,10 @@ it('can batch updates', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      })
     }
   );
 
@@ -158,9 +162,10 @@ it('useSelector (@xstate/react) should work', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      })
     }
   );
 
@@ -196,9 +201,10 @@ it('useActor (@xstate/react) should work', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      })
     }
   );
 
@@ -234,9 +240,10 @@ it('useActorRef (@xstate/react) should work', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      })
     }
   );
 

packages/xstate-store/test/solid.test.tsx

@@ -22,8 +22,14 @@ const createCounterStore = () =>
   createStore(
     { count: 0, other: 0 },
     {
-      increment: { count: ({ count }) => count + 1 },
-      other: { other: ({ other }) => other + 1 }
+      increment: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      }),
+      other: (ctx) => ({
+        ...ctx,
+        other: ctx.other + 1
+      })
     }
   );
 
@@ -75,8 +81,14 @@ describe('Solid.js integration', () => {
       const store = createStore(
         { items: INITIAL_ITEMS },
         {
-          same: { items: () => [...INITIAL_ITEMS] },
-          different: { items: () => DIFFERENT_ITEMS }
+          same: (ctx) => ({
+            ...ctx,
+            items: [...INITIAL_ITEMS]
+          }),
+          different: (ctx) => ({
+            ...ctx,
+            items: DIFFERENT_ITEMS
+          })
         }
       );
 

packages/xstate-store/test/store.test.ts

@@ -27,13 +27,14 @@ it('can update context with a property assigner', () => {
   const store = createStore(
     { count: 0, greeting: 'hello' },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      },
-      updateBoth: {
-        count: () => 42,
+      inc: (ctx) => ({
+        ...ctx,
+        count: ctx.count + 1
+      }),
+      updateBoth: (ctx) => ({
+        count: 42,
         greeting: 'hi'
-      }
+      })
     }
   );
 
@@ -52,9 +53,9 @@ it('handles unknown events (does not do anything)', () => {
   const store = createStore(
     { count: 0 },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        count: ctx.count + 1
+      })
     }
   );
 
@@ -165,7 +166,7 @@ it('createStoreWithProducer(…) infers the context type properly with a produce
       count: 0
     },
     on: {
-      inc: (ctx, ev: { by: number }, enq) => {
+      inc: (ctx, ev: { by: number }) => {
         ctx.count += ev.by;
       }
     }
@@ -180,9 +181,9 @@ it('can be observed', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        count: ctx.count + 1
+      })
     }
   );
 
@@ -211,9 +212,9 @@ it('can be inspected', () => {
       count: 0
     },
     {
-      inc: {
-        count: (ctx) => ctx.count + 1
-      }
+      inc: (ctx) => ({
+        count: ctx.count + 1
+      })
     }
   );