@data-client/core 0.1.0 → 0.2.0

package/src/state/__tests__/reducer.ts

@@ -1,32 +1,32 @@
-import { DELETED, schema } from '@data-client/endpoint';
+import { INVALID } from '@data-client/endpoint';
 import {
   ArticleResource,
-  ArticleResourceWithOtherListUrl,
   PaginatedArticleResource,
   Article,
   PaginatedArticle,
-  UrlArticle,
 } from '__tests__/new';
 
 import { Controller } from '../..';
 import {
-  RECEIVE_TYPE,
+  SET_TYPE,
   INVALIDATE_TYPE,
   FETCH_TYPE,
   RESET_TYPE,
   GC_TYPE,
 } from '../../actionTypes';
-import { UpdateFunction, State, ActionTypes, legacyActions } from '../../types';
-import { createReceive } from '../legacy-actions';
+import createSet from '../../controller/createSet';
+import {
+  UpdateFunction,
+  State,
+  ActionTypes,
+  FetchAction,
+  SetAction,
+  ResetAction,
+  InvalidateAction,
+  GCAction,
+} from '../../types';
 import createReducer, { initialState } from '../reducer/createReducer';
 
-type FetchAction = legacyActions.FetchAction;
-type ReceiveAction<T extends string | number | object | null = any> =
-  legacyActions.ReceiveAction<T>;
-type ResetAction = legacyActions.ResetAction;
-type InvalidateAction = legacyActions.InvalidateAction;
-type GCAction = legacyActions.GCAction;
-
 describe('reducer', () => {
   let reducer: (
     state: State<unknown> | undefined,
@@ -40,11 +40,12 @@ describe('reducer', () => {
   describe('singles', () => {
     const id = 20;
     const payload = { id, title: 'hi', content: 'this is the content' };
-    const action: ReceiveAction<typeof payload> = {
-      type: RECEIVE_TYPE,
+    const action: SetAction = {
+      type: SET_TYPE,
       payload,
+      endpoint: ArticleResource.get,
       meta: {
-        schema: Article,
+        args: [{ id }],
         key: ArticleResource.get.url({ id }),
         date: 5000000000,
         expiresAt: 5000500000,
@@ -158,9 +159,11 @@ describe('reducer', () => {
       const spy = jest.spyOn(ExpiresSoon, 'expiresAt');
       const localAction = {
         ...partialResultAction,
+        endpoint: (partialResultAction.endpoint as any).extend({
+          schema: ExpiresSoon,
+        }),
         meta: {
           ...partialResultAction.meta,
-          schema: ExpiresSoon,
           date: partialResultAction.meta.date * 2,
           expiresAt: partialResultAction.meta.expiresAt * 2,
           fetchedAt: partialResultAction.meta.date * 2,
@@ -191,31 +194,35 @@ describe('reducer', () => {
   it('mutate should never change results', () => {
     const id = 20;
     const payload = { id, title: 'hi', content: 'this is the content' };
-    const action: ReceiveAction = {
-      type: RECEIVE_TYPE,
+    const action: SetAction = {
+      type: SET_TYPE,
       payload,
+      endpoint: ArticleResource.get,
       meta: {
-        schema: Article,
-        key: ArticleResource.getList.key(payload),
+        args: [{ id }],
+        key: ArticleResource.get.key(payload),
         date: 0,
+        fetchedAt: 0,
         expiresAt: 1000000000000,
       },
     };
     const iniState = {
       ...initialState,
-      results: { abc: '5', [ArticleResource.getList.key(payload)]: `${id}` },
+      results: { abc: '5', [ArticleResource.get.key(payload)]: `${id}` },
     };
     const newState = reducer(iniState, action);
     expect(newState.results).toStrictEqual(iniState.results);
   });
   it('purge should delete entities', () => {
     const id = 20;
-    const action: ReceiveAction = {
-      type: RECEIVE_TYPE,
+    const action: SetAction = {
+      type: SET_TYPE,
       payload: { id },
+      endpoint: ArticleResource.delete,
       meta: {
-        schema: new schema.Delete(Article),
+        args: [{ id }],
         key: ArticleResource.delete.key({ id }),
+        fetchedAt: 0,
         date: 0,
         expiresAt: 0,
       },
@@ -238,203 +245,11 @@ describe('reducer', () => {
     const newState = reducer(iniState, action);
     expect(newState.results.abc).toBe(iniState.results.abc);
     const expectedEntities = { ...iniState.entities[Article.key] };
-    expectedEntities['20'] = DELETED;
+    expectedEntities['20'] = INVALID;
     expect(newState.entities[Article.key]).toEqual(expectedEntities);
   });
 
-  describe('updaters', () => {
-    describe('Update on get (pagination use case)', () => {
-      const shape = PaginatedArticleResource.getList;
-      function makeOptimisticAction(
-        payload: {
-          results: Partial<PaginatedArticle>[];
-        },
-        updaters: {
-          [key: string]: UpdateFunction<
-            (typeof shape)['schema'],
-            (typeof shape)['schema']
-          >;
-        },
-      ) {
-        return {
-          type: RECEIVE_TYPE,
-          payload,
-          meta: {
-            schema: PaginatedArticleResource.getList.schema,
-            key: PaginatedArticleResource.getList.key({
-              cursor: 2,
-            }),
-            updaters,
-            date: 5000000000,
-            expiresAt: 5000500000,
-          },
-        };
-      }
-
-      const insertAfterUpdater = <T extends { results?: string[] } | undefined>(
-        newPage: { results: string[] },
-        oldResults: T,
-      ) => ({
-        ...oldResults,
-        results: [...(oldResults?.results || []), ...newPage.results],
-      });
-
-      const insertBeforeUpdater = <
-        T extends { results?: string[] } | undefined,
-      >(
-        newPage: { results: string[] },
-        oldResults: T,
-      ) => ({
-        ...oldResults,
-        results: [...newPage.results, ...(oldResults?.results || [])],
-      });
-
-      const iniState: any = {
-        ...initialState,
-        entities: {
-          [PaginatedArticle.key]: {
-            '10': PaginatedArticle.fromJS({ id: 10 }),
-          },
-        },
-        results: {
-          [PaginatedArticleResource.getList.key()]: { results: ['10'] },
-        },
-      };
-
-      it('should insert a new page of resources into a list request', () => {
-        const newState = reducer(
-          iniState,
-          makeOptimisticAction(
-            { results: [{ id: 11 }, { id: 12 }] },
-            {
-              [PaginatedArticleResource.getList.key()]: insertAfterUpdater,
-            },
-          ),
-        );
-        expect(
-          newState.results[PaginatedArticleResource.getList.key()],
-        ).toStrictEqual({ results: ['10', '11', '12'] });
-      });
-
-      it('should insert correctly into the beginning of the list request', () => {
-        const newState = reducer(
-          iniState,
-          makeOptimisticAction(
-            { results: [{ id: 11 }, { id: 12 }] },
-            {
-              [PaginatedArticleResource.getList.key()]: insertBeforeUpdater,
-            },
-          ),
-        );
-        expect(
-          newState.results[PaginatedArticleResource.getList.key()],
-        ).toStrictEqual({ results: ['11', '12', '10'] });
-      });
-    });
-
-    describe('rpc update on create', () => {
-      const createEndpoint = ArticleResource.create;
-      function makeOptimisticAction(
-        payload: Partial<Article>,
-        updaters: {
-          [key: string]: UpdateFunction<
-            (typeof createEndpoint)['schema'],
-            (typeof Article)[]
-          >;
-        },
-      ) {
-        return {
-          type: RECEIVE_TYPE,
-          payload,
-          meta: {
-            schema: Article,
-            key: ArticleResource.create.key({}),
-            updaters,
-            date: 0,
-            expiresAt: 100000000000,
-          },
-        };
-      }
-
-      const insertAfterUpdater = (
-        result: string,
-        oldResults: string[] | undefined,
-      ) => [...(oldResults || []), result];
-
-      const insertBeforeUpdater = (
-        result: string,
-        oldResults: string[] | undefined,
-      ) => [result, ...(oldResults || [])];
-
-      const iniState: any = {
-        ...initialState,
-        entities: {
-          [UrlArticle.key]: {
-            '10': UrlArticle.fromJS({ id: 10 }),
-            '21': UrlArticle.fromJS({ id: 21 }),
-          },
-        },
-        results: {
-          [ArticleResourceWithOtherListUrl.getList.key()]: ['10'],
-          [ArticleResourceWithOtherListUrl.otherList.key()]: ['21'],
-        },
-      };
-
-      it('it should run inserts for a simple resource after the existing list entities', () => {
-        const newState = reducer(
-          iniState,
-          makeOptimisticAction(
-            { id: 11 },
-            {
-              [ArticleResource.getList.key()]: insertAfterUpdater,
-            },
-          ),
-        );
-        expect(newState.results[ArticleResource.getList.key()]).toStrictEqual([
-          '10',
-          '11',
-        ]);
-      });
-
-      it('it should run inserts for a simple resource before the existing list entities', () => {
-        const newState = reducer(
-          iniState,
-          makeOptimisticAction(
-            { id: 11 },
-            {
-              [ArticleResource.getList.key()]: insertBeforeUpdater,
-            },
-          ),
-        );
-        expect(newState.results[ArticleResource.getList.key()]).toStrictEqual([
-          '11',
-          '10',
-        ]);
-      });
-
-      it('it runs inserts for multiple updaters', () => {
-        const newState = reducer(
-          iniState,
-          makeOptimisticAction(
-            { id: 11 },
-            {
-              [ArticleResourceWithOtherListUrl.getList.key()]:
-                insertAfterUpdater,
-              [ArticleResourceWithOtherListUrl.otherList.key()]:
-                insertAfterUpdater,
-            },
-          ),
-        );
-        expect(
-          newState.results[ArticleResourceWithOtherListUrl.getList.key()],
-        ).toStrictEqual(['10', '11']);
-        expect(
-          newState.results[ArticleResourceWithOtherListUrl.otherList.key()],
-        ).toStrictEqual(['21', '11']);
-      });
-    });
-  });
-
+  /* this is probably not needed and will eventually be deprecated
   describe('endpoint.update', () => {
     describe('Update on get (pagination use case)', () => {
       const endpoint = PaginatedArticleResource.getList;
@@ -452,7 +267,7 @@ describe('reducer', () => {
       };
 
       it('should insert a new page of resources into a list request', () => {
-        const action = createReceive(
+        const action = createSet(
           { results: [{ id: 11 }, { id: 12 }] },
           {
             ...endpoint,
@@ -479,7 +294,7 @@ describe('reducer', () => {
       it('should insert correctly into the beginning of the list request', () => {
         const newState = reducer(
           iniState,
-          createReceive(
+          createSet(
             { results: [{ id: 11 }, { id: 12 }] },
             {
               ...endpoint,
@@ -519,7 +334,7 @@ describe('reducer', () => {
         };
         const newState = reducer(
           iniState,
-          createReceive(
+          createSet(
             { results: [{ id: 11 }, { id: 12 }] },
             {
               ...endpoint,
@@ -546,7 +361,7 @@ describe('reducer', () => {
         });
       });
     });
-  });
+  });*/
 
   it('invalidates resources correctly', () => {
     const id = 20;
@@ -589,12 +404,14 @@ describe('reducer', () => {
   it('should set error in meta for "receive"', () => {
     const id = 20;
     const error = new Error('hi');
-    const action: ReceiveAction = {
-      type: RECEIVE_TYPE,
+    const action: SetAction = {
+      type: SET_TYPE,
       payload: error,
+      endpoint: ArticleResource.get,
       meta: {
-        schema: Article,
+        args: [{ id }],
         key: ArticleResource.get.key({ id }),
+        fetchedAt: 5000000000,
         date: 5000000000,
         expiresAt: 5000500000,
       },
@@ -607,12 +424,14 @@ describe('reducer', () => {
   it('should not modify state on error for "rpc"', () => {
     const id = 20;
     const error = new Error('hi');
-    const action: ReceiveAction = {
-      type: RECEIVE_TYPE,
+    const action: SetAction = {
+      type: SET_TYPE,
       payload: error,
+      endpoint: ArticleResource.get,
       meta: {
-        schema: Article,
+        args: [{ id }],
         key: ArticleResource.get.key({ id }),
+        fetchedAt: 0,
         date: 0,
         expiresAt: 10000000000000000000,
       },
@@ -626,12 +445,14 @@ describe('reducer', () => {
   it('should not delete on error for "purge"', () => {
     const id = 20;
     const error = new Error('hi');
-    const action: ReceiveAction = {
-      type: RECEIVE_TYPE,
+    const action: SetAction = {
+      type: SET_TYPE,
       payload: error,
+      endpoint: ArticleResource.delete,
       meta: {
-        schema: new schema.Delete(Article),
+        args: [{ id }],
         key: ArticleResource.delete.key({ id }),
+        fetchedAt: 0,
         date: 0,
         expiresAt: 0,
       },
@@ -652,15 +473,17 @@ describe('reducer', () => {
     expect(newState.entities).toBe(iniState.entities);
   });
   it('rest-hooks/fetch should console.warn()', () => {
-    const warnspy = jest.spyOn(global.console, 'warn');
+    const warnspy = jest
+      .spyOn(global.console, 'warn')
+      .mockImplementation(() => {});
     try {
       const action: FetchAction = {
         type: FETCH_TYPE,
         payload: () => new Promise<any>(() => null),
+        endpoint: ArticleResource.get,
         meta: {
-          schema: Article,
+          args: [{ id: 5 }],
           key: ArticleResource.get.url({ id: 5 }),
-          type: 'read' as const,
           throttle: true,
           reject: (v: any) => null,
           resolve: (v: any) => null,
@@ -693,7 +516,7 @@ describe('reducer', () => {
   describe('RESET', () => {
     let warnspy: jest.SpyInstance;
     beforeEach(() => {
-      warnspy = jest.spyOn(global.console, 'warn');
+      warnspy = jest.spyOn(global.console, 'warn').mockImplementation(() => {});
     });
     afterEach(() => {
       warnspy.mockRestore();
@@ -724,67 +547,6 @@ describe('reducer', () => {
       expect(newState.meta).toEqual({});
       expect(newState.entities).toEqual({});
     });
-
-    // TODO(breaking): Remove once Date support is removed from action
-    it('reset should delete all entries (legacy format)', () => {
-      const action: ResetAction = {
-        type: RESET_TYPE,
-        date: new Date(),
-      };
-      const iniState: any = {
-        ...initialState,
-        entities: {
-          [Article.key]: {
-            '10': Article.fromJS({ id: 10 }),
-            '20': Article.fromJS({ id: 20 }),
-            '25': Article.fromJS({ id: 25 }),
-          },
-          [PaginatedArticle.key]: {
-            hi: PaginatedArticle.fromJS({ id: 5 }),
-          },
-          '5': undefined,
-        },
-        results: { abc: '20' },
-      };
-      const newState = reducer(iniState, action);
-      expect(newState.results).toEqual({});
-      expect(newState.meta).toEqual({});
-      expect(newState.entities).toEqual({});
-    });
-
-    it('reset without date should warn about deprecation', () => {
-      const action: any = {
-        type: RESET_TYPE,
-      };
-      const iniState: any = {
-        ...initialState,
-        entities: {
-          [Article.key]: {
-            '10': Article.fromJS({ id: 10 }),
-            '20': Article.fromJS({ id: 20 }),
-            '25': Article.fromJS({ id: 25 }),
-          },
-          [PaginatedArticle.key]: {
-            hi: PaginatedArticle.fromJS({ id: 5 }),
-          },
-          '5': undefined,
-        },
-        results: { abc: '20' },
-      };
-      const newState = reducer(iniState, action);
-      expect(newState.results).toEqual({});
-      expect(newState.meta).toEqual({});
-      expect(newState.entities).toEqual({});
-      expect(newState.lastReset).toBeDefined();
-      expect(newState.lastReset).toBeGreaterThan(0);
-      expect(warnspy.mock.calls).toMatchInlineSnapshot(`
-        [
-          [
-            "rest-hooks/reset sent without 'date' member. This is deprecated. Please use createReset() action creator to ensure correct action shape.",
-          ],
-        ]
-      `);
-    });
   });
 
   describe('GC action', () => {

package/src/state/reducer/createReducer.ts

@@ -11,12 +11,12 @@ import {
   INVALIDATEALL_TYPE,
 } from '../../actionTypes.js';
 import type Controller from '../../controller/Controller.js';
-import type { OldActionTypes, ActionTypes, State } from '../../types.js';
+import type { ActionTypes, State } from '../../types.js';
 
 export default function createReducer(controller: Controller): ReducerType {
   return function reducer(
     state: State<unknown> | undefined,
-    action: OldActionTypes,
+    action: ActionTypes,
   ): State<unknown> {
     if (!state) state = initialState;
     switch (action.type) {
@@ -44,15 +44,7 @@ export default function createReducer(controller: Controller): ReducerType {
         return invalidateReducer(state, action);
 
       case RESET_TYPE:
-        if (
-          process.env.NODE_ENV !== 'production' &&
-          action.date === undefined
-        ) {
-          console.warn(
-            `${RESET_TYPE} sent without 'date' member. This is deprecated. Please use createReset() action creator to ensure correct action shape.`,
-          );
-        }
-        return { ...initialState, lastReset: action.date ?? Date.now() };
+        return { ...initialState, lastReset: action.date };
 
       default:
         // A reducer must always return a valid state.

package/src/state/reducer/fetchReducer.ts

@@ -1,31 +1,18 @@
 import createOptimistic from '../../controller/createOptimistic.js';
 import type {
+  State,
   ReceiveAction,
   OptimisticAction,
   FetchAction,
-} from '../../previousActions.js';
-import type { State } from '../../types.js';
-import { createReceive as legacyCreateReceive } from '../legacy-actions/index.js';
+} from '../../types.js';
 
 export function fetchReducer(state: State<unknown>, action: FetchAction) {
-  const optimisticResponse = action.meta.optimisticResponse;
-  const getOptimisticResponse = action.endpoint?.getOptimisticResponse;
   let receiveAction: ReceiveAction | OptimisticAction;
 
-  if (getOptimisticResponse && action.endpoint && action.endpoint.sideEffect) {
+  if (action.endpoint.getOptimisticResponse && action.endpoint.sideEffect) {
     receiveAction = createOptimistic(action.endpoint, {
-      args: action.meta.args as readonly any[],
-      fetchedAt:
-        typeof action.meta.createdAt !== 'number'
-          ? action.meta.createdAt.getTime()
-          : action.meta.createdAt,
-    }) as any;
-  } /* istanbul ignore if */ else if (optimisticResponse) {
-    // TODO(breaking): this is no longer used, remove this branch
-    /* istanbul ignore next */
-    receiveAction = legacyCreateReceive(optimisticResponse, {
-      ...action.meta,
-      dataExpiryLength: Infinity,
+      args: action.meta.args,
+      fetchedAt: action.meta.createdAt,
     });
   } else {
     // If 'fetch' action reaches the reducer there are no middlewares installed to handle it

package/src/state/reducer/invalidateReducer.ts

@@ -1,9 +1,9 @@
 import { INVALIDATE_TYPE } from '../../actionTypes.js';
 import type {
+  State,
   InvalidateAllAction,
   InvalidateAction,
-} from '../../previousActions.js';
-import type { State } from '../../types.js';
+} from '../../types.js';
 
 export function invalidateReducer(
   state: State<unknown>,

package/src/state/reducer/setReducer.ts

@@ -2,9 +2,7 @@ import { normalize } from '@data-client/normalizr';
 
 import { OPTIMISTIC_TYPE } from '../../actionTypes.js';
 import type Controller from '../../controller/Controller.js';
-import type { ReceiveAction, OptimisticAction } from '../../previousActions.js';
-import type { State } from '../../types.js';
-import applyUpdatersToResults from '../applyUpdatersToResults.js';
+import type { State, ReceiveAction, OptimisticAction } from '../../types.js';
 
 export function setReducer(
   state: State<unknown>,
@@ -18,14 +16,14 @@ export function setReducer(
     let payload: any;
     // for true receives payload is contained in action
     if (action.type === OPTIMISTIC_TYPE) {
+      // this should never happen
       if (!action.endpoint.getOptimisticResponse) return state;
       try {
         // compute optimistic response based on current state
         payload = action.endpoint.getOptimisticResponse.call(
           action.endpoint,
           controller.snapshot(state, action.meta.fetchedAt),
-          // if endpoint exists, so must args; TODO: fix typing
-          ...(action.meta.args as any[]),
+          ...action.meta.args,
         );
       } catch (e: any) {
         // AbortOptimistic means 'do nothing', otherwise we count the exception as endpoint failure
@@ -39,30 +37,20 @@ export function setReducer(
     }
     const { result, entities, indexes, entityMeta } = normalize(
       payload,
-      action.meta.schema,
+      action.endpoint.schema,
       action.meta.args as any,
       state.entities,
       state.indexes,
       state.entityMeta,
-      { fetchedAt: action.meta.date, ...action.meta },
+      action.meta,
     );
-    let results = {
+    const results = {
       ...state.results,
       [action.meta.key]: result,
     };
     try {
-      if ('updaters' in action.meta && action.meta.updaters) {
-        results = applyUpdatersToResults(
-          results,
-          result,
-          action.meta.updaters as any,
-        );
-      }
-      if (action.meta.update) {
-        const updaters = action.meta.update(
-          result,
-          ...(action.meta.args || []),
-        );
+      if (action.endpoint.update) {
+        const updaters = action.endpoint.update(result, ...action.meta.args);
         Object.keys(updaters).forEach(key => {
           results[key] = updaters[key](results[key]);
         });
@@ -97,7 +85,7 @@ export function setReducer(
       error.message = `Error processing ${
         action.meta.key
       }\n\nFull Schema: ${JSON.stringify(
-        action.meta.schema,
+        action.endpoint.schema,
         undefined,
         2,
       )}\n\nError:\n${error.message}`;
@@ -136,7 +124,7 @@ function reduceError(
         date: action.meta.date,
         error,
         expiresAt: action.meta.expiresAt,
-        errorPolicy: action.meta.errorPolicy?.(error),
+        errorPolicy: action.endpoint.errorPolicy?.(error),
       },
     },
     optimistic: filterOptimistic(state, action),