@data-client/core 0.14.10 → 0.14.16

package/src/controller/actions/createInvalidateAll.ts

@@ -1,11 +1,11 @@
-import { INVALIDATEALL_TYPE } from '../../actionTypes.js';
+import { INVALIDATEALL } from '../../actionTypes.js';
 import type { InvalidateAllAction } from '../../types.js';
 
 export function createInvalidateAll(
   testKey: (key: string) => boolean,
 ): InvalidateAllAction {
   return {
-    type: INVALIDATEALL_TYPE,
+    type: INVALIDATEALL,
     testKey,
   };
 }

package/src/controller/actions/createOptimistic.ts

@@ -1,7 +1,7 @@
 import type { EndpointInterface } from '@data-client/normalizr';
 
 import { createMeta } from './createMeta.js';
-import { OPTIMISTIC_TYPE } from '../../actionTypes.js';
+import { OPTIMISTIC } from '../../actionTypes.js';
 import type { OptimisticAction } from '../../types.js';
 import type { EndpointUpdateFunction } from '../types.js';
 
@@ -23,7 +23,7 @@ export function createOptimistic<
   }
 
   return {
-    type: OPTIMISTIC_TYPE,
+    type: OPTIMISTIC,
     key: endpoint.key(...args),
     args,
     endpoint,

package/src/controller/actions/createReset.ts

@@ -1,9 +1,9 @@
-import { RESET_TYPE } from '../../actionTypes.js';
+import { RESET } from '../../actionTypes.js';
 import type { ResetAction } from '../../types.js';
 
 export function createReset(): ResetAction {
   return {
-    type: RESET_TYPE,
+    type: RESET,
     date: Date.now(),
   };
 }

package/src/controller/actions/createSet.ts

@@ -5,7 +5,7 @@ import type {
 } from '@data-client/normalizr';
 
 import { createMeta } from './createMeta.js';
-import { SET_TYPE } from '../../actionTypes.js';
+import { SET } from '../../actionTypes.js';
 import type { SetAction } from '../../types.js';
 import ensurePojo from '../ensurePojo.js';
 
@@ -22,7 +22,7 @@ export function createSet<S extends Queryable>(
   },
 ): SetAction<S> {
   return {
-    type: SET_TYPE,
+    type: SET,
     value,
     args: args.map(ensurePojo) as SchemaArgs<S>,
     schema,

package/src/controller/actions/createSetResponse.ts

@@ -1,7 +1,7 @@
 import type { EndpointInterface, ResolveType } from '@data-client/normalizr';
 
 import { createMeta } from './createMeta.js';
-import { SET_RESPONSE_TYPE } from '../../actionTypes.js';
+import { SET_RESPONSE } from '../../actionTypes.js';
 import type { SetResponseAction } from '../../types.js';
 import ensurePojo from '../ensurePojo.js';
 import { EndpointUpdateFunction } from '../types.js';
@@ -62,7 +62,7 @@ export function createSetResponse<
   }
 
   return {
-    type: SET_RESPONSE_TYPE,
+    type: SET_RESPONSE,
     key: endpoint.key(...args),
     response,
     args: args.map(ensurePojo),

package/src/controller/actions/createSubscription.ts

@@ -1,6 +1,6 @@
 import type { EndpointInterface } from '@data-client/normalizr';
 
-import { SUBSCRIBE_TYPE, UNSUBSCRIBE_TYPE } from '../../actionTypes.js';
+import { SUBSCRIBE, UNSUBSCRIBE } from '../../actionTypes.js';
 import type { SubscribeAction, UnsubscribeAction } from '../../types.js';
 
 export function createSubscription<E extends EndpointInterface>(
@@ -8,7 +8,7 @@ export function createSubscription<E extends EndpointInterface>(
   { args }: { args: readonly [...Parameters<E>] },
 ): SubscribeAction<E> {
   return {
-    type: SUBSCRIBE_TYPE,
+    type: SUBSCRIBE,
     endpoint,
     args,
     key: endpoint.key(...args),
@@ -20,7 +20,7 @@ export function createUnsubscription<E extends EndpointInterface>(
   { args }: { args: readonly [...Parameters<E>] },
 ): UnsubscribeAction<E> {
   return {
-    type: UNSUBSCRIBE_TYPE,
+    type: UNSUBSCRIBE,
     key: endpoint.key(...args),
     args,
     endpoint,

package/src/index.ts

@@ -43,6 +43,7 @@ export type {
 export * as actions from './controller/actions/index.js';
 
 export * from './controller/types.js';
+/** @see https://dataclient.io/docs/api/Actions */
 export * as actionTypes from './actionTypes.js';
 /* istanbul ignore next */
 export * from './types.js';

package/src/manager/LogoutManager.ts

@@ -1,4 +1,4 @@
-import { SET_RESPONSE_TYPE } from '../actionTypes.js';
+import { SET_RESPONSE } from '../actionTypes.js';
 import type Controller from '../controller/Controller.js';
 import { UnknownError } from '../index.js';
 import type { Manager, Middleware } from '../types.js';
@@ -16,7 +16,7 @@ export default class LogoutManager implements Manager {
   middleware: Middleware = controller => next => async action => {
     await next(action);
     if (
-      action.type === SET_RESPONSE_TYPE &&
+      action.type === SET_RESPONSE &&
       action.error &&
       this.shouldLogout(action.response)
     ) {

package/src/manager/NetworkManager.ts

@@ -1,4 +1,4 @@
-import { SET_RESPONSE_TYPE, FETCH_TYPE, RESET_TYPE } from '../actionTypes.js';
+import { SET_RESPONSE, FETCH, RESET } from '../actionTypes.js';
 import { createSetResponse } from '../controller/actions/index.js';
 import Controller from '../controller/Controller.js';
 import type {
@@ -46,7 +46,7 @@ export default class NetworkManager implements Manager {
     this.controller = controller;
     return next => action => {
       switch (action.type) {
-        case FETCH_TYPE:
+        case FETCH:
           this.handleFetch(action);
           // This is the only case that causes any state change
           // It's important to intercept other fetches as we don't want to trigger reducers during
@@ -58,7 +58,7 @@ export default class NetworkManager implements Manager {
             return next(action);
           }
           return Promise.resolve();
-        case SET_RESPONSE_TYPE:
+        case SET_RESPONSE:
           // only set after new state is computed
           return next(action).then(() => {
             if (action.key in this.fetched) {
@@ -79,7 +79,7 @@ export default class NetworkManager implements Manager {
               }
             }
           });
-        case RESET_TYPE: {
+        case RESET: {
           const rejectors = { ...this.rejectors };
 
           this.clearAll();
@@ -112,7 +112,7 @@ export default class NetworkManager implements Manager {
   /** Used by DevtoolsManager to determine whether to log an action */
   skipLogging(action: ActionTypes) {
     /* istanbul ignore next */
-    return action.type === FETCH_TYPE && action.key in this.fetched;
+    return action.type === FETCH && action.key in this.fetched;
   }
 
   allSettled() {

package/src/manager/SubscriptionManager.ts

@@ -1,4 +1,4 @@
-import { SUBSCRIBE_TYPE, UNSUBSCRIBE_TYPE } from '../actionTypes.js';
+import { SUBSCRIBE, UNSUBSCRIBE } from '../actionTypes.js';
 import Controller from '../controller/Controller.js';
 import type {
   Manager,
@@ -51,14 +51,14 @@ export default class SubscriptionManager<
     this.controller = controller;
     return next => action => {
       switch (action.type) {
-        case SUBSCRIBE_TYPE:
+        case SUBSCRIBE:
           try {
             this.handleSubscribe(action);
           } catch (e) {
             console.error(e);
           }
           return Promise.resolve();
-        case UNSUBSCRIBE_TYPE:
+        case UNSUBSCRIBE:
           this.handleUnsubscribe(action);
           return Promise.resolve();
         default:

package/src/manager/__tests__/logoutManager.ts

@@ -1,7 +1,7 @@
 import { CoolerArticleResource } from '__tests__/new';
 
 import { Controller, initialState } from '../..';
-import { FETCH_TYPE, RESET_TYPE } from '../../actionTypes';
+import { FETCH, RESET } from '../../actionTypes';
 import { createSetResponse } from '../../controller/actions';
 import LogoutManager from '../LogoutManager.js';
 
@@ -73,7 +73,7 @@ describe('LogoutManager', () => {
       await manager.middleware(API)(next)(action);
 
       expect(dispatch.mock.calls.length).toBe(1);
-      expect(dispatch.mock.calls[0][0]?.type).toBe(RESET_TYPE);
+      expect(dispatch.mock.calls[0][0]?.type).toBe(RESET);
     });
 
     it('should call custom handleLogout', async () => {
@@ -97,7 +97,7 @@ describe('LogoutManager', () => {
     });
 
     it('should let other actions pass through', async () => {
-      const action = { type: FETCH_TYPE };
+      const action = { type: FETCH };
       next.mockReset();
 
       await manager.middleware(API)(next)(action as any);

package/src/manager/__tests__/networkManager.ts

@@ -1,7 +1,7 @@
 import { Endpoint } from '@data-client/endpoint';
 import { Article, ArticleResource } from '__tests__/new';
 
-import { SET_RESPONSE_TYPE } from '../../actionTypes';
+import { SET_RESPONSE } from '../../actionTypes';
 import { createFetch } from '../../controller/actions';
 import Controller from '../../controller/Controller';
 import NetworkManager from '../../manager/NetworkManager';
@@ -159,7 +159,7 @@ describe('NetworkManager', () => {
       await new Promise(resolve => setTimeout(resolve, 0));
 
       const action: SetResponseAction = {
-        type: SET_RESPONSE_TYPE,
+        type: SET_RESPONSE,
         endpoint: fetchResolveAction.endpoint,
         response,
         args: fetchResolveAction.args,
@@ -195,7 +195,7 @@ describe('NetworkManager', () => {
       await new Promise(resolve => setTimeout(resolve, 0));
 
       const action: SetResponseAction = {
-        type: SET_RESPONSE_TYPE,
+        type: SET_RESPONSE,
         endpoint: fetchSetWithUpdatersAction.endpoint,
         response,
         args: fetchSetWithUpdatersAction.args,
@@ -231,7 +231,7 @@ describe('NetworkManager', () => {
       await new Promise(resolve => setTimeout(resolve, 0));
 
       const action: SetResponseAction = {
-        type: SET_RESPONSE_TYPE,
+        type: SET_RESPONSE,
         endpoint: fetchRpcWithUpdatersAction.endpoint,
         response,
         args: fetchRpcWithUpdatersAction.args,
@@ -267,7 +267,7 @@ describe('NetworkManager', () => {
       // mutations resolve before dispatch, so we must wait for next tick to see set
       await new Promise(resolve => setTimeout(resolve, 0));
       expect(dispatch).toHaveBeenCalledWith({
-        type: SET_RESPONSE_TYPE,
+        type: SET_RESPONSE,
         endpoint: fetchRpcWithUpdatersAndOptimisticAction.endpoint,
         response,
         args: fetchRpcWithUpdatersAndOptimisticAction.args,
@@ -338,7 +338,7 @@ describe('NetworkManager', () => {
       } catch (error) {
         expect(next).not.toHaveBeenCalled();
         expect(dispatch).toHaveBeenCalledWith({
-          type: SET_RESPONSE_TYPE,
+          type: SET_RESPONSE,
           response: error,
           key: fetchRejectAction.key,
           meta: {

package/src/manager/__tests__/subscriptionManager.ts

@@ -4,7 +4,7 @@ import { actionTypes, Controller, initialState } from '../..';
 import { SubscribeAction, UnsubscribeAction } from '../../types';
 import SubscriptionManager, { Subscription } from '../SubscriptionManager.js';
 
-const { UNSUBSCRIBE_TYPE, SUBSCRIBE_TYPE, SET_RESPONSE_TYPE } = actionTypes;
+const { UNSUBSCRIBE, SUBSCRIBE, SET_RESPONSE } = actionTypes;
 
 function onError(e: any) {
   e.preventDefault();
@@ -55,7 +55,7 @@ describe('SubscriptionManager', () => {
           () => Promise.reject(new Error('Failed'))
         : () => Promise.resolve(response);
       return {
-        type: SUBSCRIBE_TYPE,
+        type: SUBSCRIBE,
         endpoint: PollingArticleResource.get.extend({ fetch }),
         args: [{ id: response.id }],
         key: PollingArticleResource.get.key({ id: response.id }),
@@ -65,7 +65,7 @@ describe('SubscriptionManager', () => {
       response: Record<string, any>,
     ): UnsubscribeAction {
       return {
-        type: UNSUBSCRIBE_TYPE,
+        type: UNSUBSCRIBE,
         endpoint: PollingArticleResource.get,
         key: PollingArticleResource.get.key({ id: response.id }),
         args: [{ id: response.id }],
@@ -185,7 +185,7 @@ describe('SubscriptionManager', () => {
     });
 
     it('should let other actions pass through', () => {
-      const action = { type: SET_RESPONSE_TYPE };
+      const action = { type: SET_RESPONSE };
       next.mockReset();
 
       manager.middleware(API)(next)(action as any);

package/src/state/__tests__/reducer.ts

@@ -3,12 +3,12 @@ import { ArticleResource, Article, PaginatedArticle } from '__tests__/new';
 
 import { Controller } from '../..';
 import {
-  INVALIDATE_TYPE,
-  FETCH_TYPE,
-  RESET_TYPE,
-  GC_TYPE,
-  SET_RESPONSE_TYPE,
-  SET_TYPE,
+  INVALIDATE,
+  FETCH,
+  RESET,
+  GC,
+  SET_RESPONSE,
+  SET,
 } from '../../actionTypes';
 import {
   State,
@@ -36,7 +36,7 @@ describe('reducer', () => {
     const id = 20;
     const response = { id, title: 'hi', content: 'this is the content' };
     const action: SetResponseAction = {
-      type: SET_RESPONSE_TYPE,
+      type: SET_RESPONSE,
       response,
       endpoint: ArticleResource.get,
       args: [{ id }],
@@ -215,7 +215,7 @@ describe('reducer', () => {
       static key = 'Counter';
     }
     const action: SetAction = {
-      type: SET_TYPE,
+      type: SET,
       value,
       schema: Counter,
       args: [{ id }],
@@ -242,7 +242,7 @@ describe('reducer', () => {
       static key = 'Counter';
     }
     const action: SetAction = {
-      type: SET_TYPE,
+      type: SET,
       value,
       schema: Counter,
       args: [{ id }],
@@ -270,7 +270,7 @@ describe('reducer', () => {
     const id = 20;
     const value = { id, title: 'hi', content: 'this is the content' };
     const action: SetAction = {
-      type: SET_TYPE,
+      type: SET,
       value,
       schema: Article,
       args: [{ id }],
@@ -292,7 +292,7 @@ describe('reducer', () => {
     const id = 20;
     const value = { id, title: 'hi', content: 'this is the content' };
     const action: SetAction = {
-      type: SET_TYPE,
+      type: SET,
       value,
       schema: Article,
       args: [{ id }],
@@ -314,7 +314,7 @@ describe('reducer', () => {
     const id = 20;
     const response = { id, title: 'hi', content: 'this is the content' };
     const action: SetResponseAction = {
-      type: SET_RESPONSE_TYPE,
+      type: SET_RESPONSE,
       response,
       endpoint: ArticleResource.get,
       args: [{ id }],
@@ -335,7 +335,7 @@ describe('reducer', () => {
   it('purge should delete entities', () => {
     const id = 20;
     const action: SetResponseAction = {
-      type: SET_RESPONSE_TYPE,
+      type: SET_RESPONSE,
       response: { id },
       endpoint: ArticleResource.delete,
       args: [{ id }],
@@ -485,7 +485,7 @@ describe('reducer', () => {
   it('invalidates resources correctly', () => {
     const id = 20;
     const action: InvalidateAction = {
-      type: INVALIDATE_TYPE,
+      type: INVALIDATE,
       key: id.toString(),
     };
     const iniState: any = {
@@ -522,7 +522,7 @@ describe('reducer', () => {
     const id = 20;
     const error = new Error('hi');
     const action: SetResponseAction = {
-      type: SET_RESPONSE_TYPE,
+      type: SET_RESPONSE,
       response: error,
       endpoint: ArticleResource.get,
       args: [{ id }],
@@ -542,7 +542,7 @@ describe('reducer', () => {
     const id = 20;
     const error = new Error('hi');
     const action: SetResponseAction = {
-      type: SET_RESPONSE_TYPE,
+      type: SET_RESPONSE,
       response: error,
       endpoint: ArticleResource.get,
       args: [{ id }],
@@ -563,7 +563,7 @@ describe('reducer', () => {
     const id = 20;
     const error = new Error('hi');
     const action: SetResponseAction = {
-      type: SET_RESPONSE_TYPE,
+      type: SET_RESPONSE,
       response: error,
       endpoint: ArticleResource.delete,
       args: [{ id }],
@@ -595,7 +595,7 @@ describe('reducer', () => {
       .mockImplementation(() => {});
     try {
       const action: FetchAction = {
-        type: FETCH_TYPE,
+        type: FETCH,
         endpoint: ArticleResource.get,
         args: [{ id: 5 }],
         key: ArticleResource.get.url({ id: 5 }),
@@ -640,7 +640,7 @@ describe('reducer', () => {
 
     it('reset should delete all entries', () => {
       const action: ResetAction = {
-        type: RESET_TYPE,
+        type: RESET,
         date: Date.now(),
       };
       const iniState: any = {
@@ -697,7 +697,7 @@ describe('reducer', () => {
 
     it('empty targets should do nothing', () => {
       const action: GCAction = {
-        type: GC_TYPE,
+        type: GC,
         entities: [],
         endpoints: [],
       };
@@ -710,7 +710,7 @@ describe('reducer', () => {
 
     it('empty deleting entities should work', () => {
       const action: GCAction = {
-        type: GC_TYPE,
+        type: GC,
         entities: [
           [Article.key, '10'],
           [Article.key, '250'],
@@ -729,7 +729,7 @@ describe('reducer', () => {
 
     it('empty deleting nonexistant things should passthrough', () => {
       const action: GCAction = {
-        type: GC_TYPE,
+        type: GC,
         entities: [
           [Article.key, '100000000'],
           ['sillythings', '10'],

package/src/state/reducer/createReducer.ts

@@ -4,15 +4,15 @@ import { invalidateReducer } from './invalidateReducer.js';
 import { setReducer } from './setReducer.js';
 import { setResponseReducer } from './setResponseReducer.js';
 import {
-  SET_TYPE,
-  INVALIDATE_TYPE,
-  RESET_TYPE,
-  FETCH_TYPE,
-  GC_TYPE,
-  OPTIMISTIC_TYPE,
-  INVALIDATEALL_TYPE,
-  EXPIREALL_TYPE,
-  SET_RESPONSE_TYPE,
+  SET,
+  INVALIDATE,
+  RESET,
+  FETCH,
+  GC,
+  OPTIMISTIC,
+  INVALIDATEALL,
+  EXPIREALL,
+  SET_RESPONSE,
 } from '../../actionTypes.js';
 import type Controller from '../../controller/Controller.js';
 import type { ActionTypes, State } from '../../types.js';
@@ -24,7 +24,7 @@ export default function createReducer(controller: Controller): ReducerType {
   ): State<unknown> {
     if (!state) state = initialState;
     switch (action.type) {
-      case GC_TYPE:
+      case GC:
         // inline deletes are fine as these should have 0 refcounts
         action.entities.forEach(([key, pk]) => {
           delete (state as any).entities[key]?.[pk];
@@ -35,25 +35,25 @@ export default function createReducer(controller: Controller): ReducerType {
           delete (state as any).meta[fetchKey];
         });
         return state;
-      case FETCH_TYPE:
+      case FETCH:
         return fetchReducer(state, action);
 
-      case OPTIMISTIC_TYPE:
+      case OPTIMISTIC:
       // eslint-disable-next-line no-fallthrough
-      case SET_RESPONSE_TYPE:
+      case SET_RESPONSE:
         return setResponseReducer(state, action, controller);
 
-      case SET_TYPE:
+      case SET:
         return setReducer(state, action, controller);
 
-      case INVALIDATEALL_TYPE:
-      case INVALIDATE_TYPE:
+      case INVALIDATEALL:
+      case INVALIDATE:
         return invalidateReducer(state, action);
 
-      case EXPIREALL_TYPE:
+      case EXPIREALL:
         return expireReducer(state, action);
 
-      case RESET_TYPE:
+      case RESET:
         return { ...initialState, lastReset: action.date };
 
       default:

package/src/state/reducer/invalidateReducer.ts

@@ -1,4 +1,4 @@
-import { INVALIDATE_TYPE } from '../../actionTypes.js';
+import { INVALIDATE } from '../../actionTypes.js';
 import type {
   State,
   InvalidateAllAction,
@@ -21,7 +21,7 @@ export function invalidateReducer(
     delete itemMeta.error;
     meta[key] = itemMeta;
   };
-  if (action.type === INVALIDATE_TYPE) {
+  if (action.type === INVALIDATE) {
     invalidateKey(action.key);
   } else {
     Object.keys(endpoints).forEach(key => {

package/src/state/reducer/setResponseReducer.ts

@@ -1,6 +1,6 @@
 import { normalize } from '@data-client/normalizr';
 
-import { OPTIMISTIC_TYPE } from '../../actionTypes.js';
+import { OPTIMISTIC } from '../../actionTypes.js';
 import AbortOptimistic from '../../controller/AbortOptimistic.js';
 import type Controller from '../../controller/Controller.js';
 import type {
@@ -20,7 +20,7 @@ export function setResponseReducer(
   try {
     let response: any;
     // for true set's response is contained in action
-    if (action.type === OPTIMISTIC_TYPE) {
+    if (action.type === OPTIMISTIC) {
       // this should never happen
       /* istanbul ignore if */
       if (!action.endpoint.getOptimisticResponse) return state;
@@ -142,7 +142,7 @@ function filterOptimistic(
   return state.optimistic.filter(
     optimisticAction =>
       optimisticAction.key !== resolvingAction.key ||
-      (optimisticAction.type === OPTIMISTIC_TYPE ?
+      (optimisticAction.type === OPTIMISTIC ?
         optimisticAction.meta.fetchedAt !== resolvingAction.meta.fetchedAt
       : optimisticAction.meta.date > resolvingAction.meta.date),
   );

package/ts3.4/actionTypes.d.ts

@@ -1,3 +1,14 @@
+export declare const FETCH: "rdc/fetch";
+export declare const SET: "rdc/set";
+export declare const SET_RESPONSE: "rdc/setresponse";
+export declare const OPTIMISTIC: "rdc/optimistic";
+export declare const RESET: "rdc/reset";
+export declare const SUBSCRIBE: "rdc/subscribe";
+export declare const UNSUBSCRIBE: "rdc/unsubscribe";
+export declare const INVALIDATE: "rdc/invalidate";
+export declare const INVALIDATEALL: "rdc/invalidateall";
+export declare const EXPIREALL: "rdc/expireall";
+export declare const GC: "rdc/gc";
 export declare const FETCH_TYPE: "rdc/fetch";
 export declare const SET_TYPE: "rdc/set";
 export declare const SET_RESPONSE_TYPE: "rdc/setresponse";