enhance: Provide args to update method

Author: ntucker

packages/core/src/state/__tests__/reducer.ts

@@ -454,6 +454,45 @@ describe('reducer', () => {
           },
         );
       });
+
+      it('should account for args', () => {
+        const iniState: any = {
+          ...initialState,
+          entities: {
+            [PaginatedArticle.key]: {
+              '10': PaginatedArticle.fromJS({ id: 10 }),
+            },
+          },
+          results: {
+            [PaginatedArticle.list().key({ admin: true })]: { results: ['10'] },
+          },
+        };
+        const newState = reducer(
+          iniState,
+          createReceive(
+            { results: [{ id: 11 }, { id: 12 }] },
+            {
+              ...endpoint,
+              key: endpoint.key({ cursor: 2, admin: true }),
+              args: [{ cursor: 2, admin: true }],
+              update: (nextpage: { results: string[] }, { admin }) => ({
+                [PaginatedArticle.list().key({ admin })]: (
+                  existing: { results: string[] } = { results: [] },
+                ) => ({
+                  ...existing,
+                  results: [...nextpage.results, ...existing.results],
+                }),
+              }),
+              dataExpiryLength: 600000,
+            },
+          ),
+        );
+        expect(
+          newState.results[PaginatedArticle.list().key({ admin: true })],
+        ).toStrictEqual({
+          results: ['11', '12', '10'],
+        });
+      });
     });
   });
 

packages/core/src/state/actions/createReceive.ts

@@ -15,7 +15,7 @@ interface Options<
   S extends Schema | undefined = any,
 > extends Pick<
     FetchAction<Payload, S>['meta'],
-    'schema' | 'key' | 'type' | 'updaters' | 'update'
+    'schema' | 'key' | 'type' | 'updaters' | 'update' | 'args'
   > {
   dataExpiryLength: NonNullable<FetchOptions['dataExpiryLength']>;
 }
@@ -34,7 +34,14 @@ export default function createReceive<
   S extends Schema | undefined = any,
 >(
   data: Payload,
-  { schema, key, updaters, update, dataExpiryLength }: Options<Payload, S>,
+  {
+    schema,
+    key,
+    args,
+    updaters,
+    update,
+    dataExpiryLength,
+  }: Options<Payload, S>,
 ): ReceiveAction<Payload, S> {
   /* istanbul ignore next */
   if (process.env.NODE_ENV === 'development' && dataExpiryLength < 0) {
@@ -44,6 +51,7 @@ export default function createReceive<
   const meta: ReceiveAction['meta'] = {
     schema,
     key,
+    args,
     date: now,
     expiresAt: now + dataExpiryLength,
   };

packages/core/src/state/reducer.ts

@@ -70,7 +70,10 @@ export default function reducer(
         };
         results = applyUpdatersToResults(results, result, action.meta.updaters);
         if (action.meta.update) {
-          const updaters = action.meta.update(result);
+          const updaters = action.meta.update(
+            result,
+            ...(action.meta.args || []),
+          );
           Object.keys(updaters).forEach(key => {
             results[key] = updaters[key](results[key]);
           });

packages/core/src/types.ts

@@ -1,6 +1,13 @@
 import { NormalizedIndex } from '@rest-hooks/normalizr';
 import { Middleware } from '@rest-hooks/use-enhanced-reducer';
 import { FSAWithPayloadAndMeta, FSAWithMeta, FSA } from 'flux-standard-action';
+import type {
+  UpdateFunction,
+  AbstractInstanceType,
+  Schema,
+  FetchFunction,
+  EndpointExtraOptions,
+} from '@rest-hooks/endpoint';
 
 import { ErrorableFSAWithPayloadAndMeta } from './fsa';
 import { FetchShape } from './endpoint';
@@ -13,14 +20,6 @@ import {
   INVALIDATE_TYPE,
 } from './actionTypes';
 
-import type {
-  UpdateFunction,
-  AbstractInstanceType,
-  Schema,
-  FetchFunction,
-  EndpointExtraOptions,
-} from '@rest-hooks/endpoint';
-
 export type { AbstractInstanceType, UpdateFunction };
 
 export type ReceiveTypes = typeof RECEIVE_TYPE;
@@ -66,8 +65,9 @@ export type FetchOptions<F extends FetchFunction = FetchFunction> =
 export interface ReceiveMeta<S extends Schema | undefined> {
   schema: S;
   key: string;
+  args?: readonly any[];
   updaters?: Record<string, UpdateFunction<S, any>>;
-  update?: (result: any) => Record<string, (...args: any) => any>;
+  update?: (result: any, ...args: any) => Record<string, (...args: any) => any>;
   date: number;
   expiresAt: number;
 }
@@ -98,8 +98,9 @@ interface FetchMeta<
   type: FetchShape<any, any>['type'];
   schema: S;
   key: string;
+  args?: readonly any[];
   updaters?: Record<string, UpdateFunction<S, any>>;
-  update?: (result: any) => Record<string, (...args: any) => any>;
+  update?: (result: any, ...args: any) => Record<string, (...args: any) => any>;
   options?: FetchOptions;
   throttle: boolean;
   resolve: (value?: any | PromiseLike<any>) => void;

packages/experimental/README.md

@@ -13,7 +13,13 @@
 
 </div>
 
-## useFetcher()
+## Motivation
+
+Field application of designs help smooth edges of a theoretical design. New designs can be iterated on here, breaking freely without worry of legacy support plans.
+
+## Usage
+
+### useFetcher()
 
 ```tsx
 const fetch = useFetcher();
@@ -25,7 +31,7 @@ return (
 );
 ```
 
-## Endpoint.update
+### Endpoint.update
 
 <details open><summary><b>Simple</b></summary>
 
@@ -65,7 +71,7 @@ const createUser = new Endpoint(postToUserFunction, {
 </details>
 
 
-## Entity, EntityRecord, Resource, BaseResource
+### Entity, EntityRecord, Resource, BaseResource
 
 - Normalizes to pojo
 - Faster

packages/experimental/src/createFetch.ts

@@ -1,10 +1,9 @@
 import { actionTypes } from '@rest-hooks/core';
-
-import { UpdateFunction } from './types';
-
 import type { FetchAction } from '@rest-hooks/core';
 import type { EndpointInterface } from '@rest-hooks/endpoint';
 
+import { UpdateFunction } from './types';
+
 /** Requesting a fetch to begin
  *
  * @param endpoint
@@ -25,6 +24,7 @@ export default function createFetch<
   const meta: FetchAction['meta'] = {
     schema: endpoint.schema,
     type: endpoint.sideEffect ? ('mutate' as const) : ('read' as const),
+    args,
     key,
     throttle,
     options: endpoint,
@@ -51,3 +51,17 @@ export default function createFetch<
     meta,
   };
 }
+
+/** Future action shape
+{
+  type: actionTypes.FETCH_TYPE,
+  endpoint,
+  meta: {
+    args,
+    throttle,
+    createdAt,
+    promise,
+    resolve,
+    reject,
+  }
+} */

website/siteConfig.js

@@ -57,6 +57,7 @@ const siteConfig = {
     {
       href: 'https://github.com/Rest-Hooks/todo-example',
       label: '🎮 Demo',
+      external: true,
     },
     //{ page: 'help', label: 'Help' },
     { search: true },