@data-client/core 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-client/core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "High performance reactive framework for async data.",
   "sideEffects": false,
   "main": "dist/index.js",
@@ -89,20 +89,23 @@
     "async",
     "data fetching",
     "data cache",
+    "reactive",
+    "state management",
     "api client",
     "api",
     "normalized cache",
     "swr",
-    "GraphQL",
     "query",
     "ios",
     "android",
     "web",
     "middleware",
     "websocket",
-    "sse",
-    "declarative",
-    "scalable"
+    "SSE",
+    "GraphQL",
+    "REST",
+    "RPC",
+    "declarative"
   ],
   "author": "Nathaniel Tucker <me@ntucker.me> (https://github.com/ntucker)",
   "license": "Apache-2.0",
@@ -117,7 +120,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.17.0",
-    "@data-client/normalizr": "^0.2.0",
+    "@data-client/normalizr": "^0.2.2",
     "flux-standard-action": "^2.1.1"
   },
   "devDependencies": {

package/src/actionTypes.ts

@@ -8,4 +8,5 @@ export const SUBSCRIBE_TYPE = 'rest-hooks/subscribe' as const;
 export const UNSUBSCRIBE_TYPE = 'rest-hook/unsubscribe' as const;
 export const INVALIDATE_TYPE = 'rest-hooks/invalidate' as const;
 export const INVALIDATEALL_TYPE = 'rest-hooks/invalidateall' as const;
+export const EXPIREALL_TYPE = 'rest-hooks/expireall' as const;
 export const GC_TYPE = 'rest-hooks/gc' as const;

package/src/controller/Controller.ts

@@ -19,6 +19,7 @@ import {
 } from '@data-client/normalizr';
 import { inferResults, validateInference } from '@data-client/normalizr';
 
+import createExpireAll from './createExpireAll.js';
 import createFetch from './createFetch.js';
 import createInvalidate from './createInvalidate.js';
 import createInvalidateAll from './createInvalidateAll.js';
@@ -136,10 +137,19 @@ export default class Controller<
   /**
    * Forces refetching and suspense on useSuspense on all matching endpoint result keys.
    * @see https://resthooks.io/docs/api/Controller#invalidateAll
+   * @returns Promise that resolves when invalidation is commited.
    */
   invalidateAll = (options: { testKey: (key: string) => boolean }) =>
     this.dispatch(createInvalidateAll((key: string) => options.testKey(key)));
 
+  /**
+   * Sets all matching endpoint result keys to be STALE.
+   * @see https://dataclient.io/docs/api/Controller#expireAll
+   * @returns Promise that resolves when expiry is commited. *NOT* fetch promise
+   */
+  expireAll = (options: { testKey: (key: string) => boolean }) =>
+    this.dispatch(createExpireAll((key: string) => options.testKey(key)));
+
   /**
    * Resets the entire Rest Hooks cache. All inflight requests will not resolve.
    * @see https://resthooks.io/docs/api/Controller#resetEntireStore

package/src/controller/createExpireAll.ts

@@ -0,0 +1,11 @@
+import { EXPIREALL_TYPE } from '../actionTypes.js';
+import type { ExpireAllAction } from '../types.js';
+
+export default function createExpireAll(
+  testKey: (key: string) => boolean,
+): ExpireAllAction {
+  return {
+    type: EXPIREALL_TYPE,
+    testKey,
+  };
+}

package/src/manager/PollingSubscription.ts

@@ -145,17 +145,20 @@ export default class PollingSubscription implements Subscription {
   protected onlineListener = () => {
     this.connectionListener.removeOnlineListener(this.onlineListener);
     const now = Date.now();
-    this.startId = setTimeout(() => {
-      if (this.startId) {
-        delete this.startId;
-        this.update();
-        this.run();
-      } else if (process.env.NODE_ENV !== 'production') {
-        console.warn(
-          `Poll setTimeout for ${this.key} still running, but timeoutId deleted`,
-        );
-      }
-    }, Math.max(0, this.lastFetchTime() - now + this.frequency));
+    this.startId = setTimeout(
+      () => {
+        if (this.startId) {
+          delete this.startId;
+          this.update();
+          this.run();
+        } else if (process.env.NODE_ENV !== 'production') {
+          console.warn(
+            `Poll setTimeout for ${this.key} still running, but timeoutId deleted`,
+          );
+        }
+      },
+      Math.max(0, this.lastFetchTime() - now + this.frequency),
+    );
     this.connectionListener.addOfflineListener(this.offlineListener);
   };
 

package/src/manager/applyManager.ts

@@ -8,6 +8,7 @@ export default function applyManager(
 ): Middleware[] {
   return managers.map(manager => {
     const middleware = manager.getMiddleware();
+    // TODO(breaking): remove this once controller prop is no longer supported
     return ({ dispatch, getState }) => {
       (controller as any).dispatch = dispatch;
       (controller as any).getState = getState;

package/src/newActions.ts

@@ -14,6 +14,7 @@ import type {
   GC_TYPE,
   OPTIMISTIC_TYPE,
   INVALIDATEALL_TYPE,
+  EXPIREALL_TYPE,
 } from './actionTypes.js';
 import type { EndpointUpdateFunction } from './controller/types.js';
 
@@ -112,6 +113,12 @@ export interface UnsubscribeAction<
   };
 }
 
+/* EXPIRY */
+export interface ExpireAllAction {
+  type: typeof EXPIREALL_TYPE;
+  testKey: (key: string) => boolean;
+}
+
 /* INVALIDATE */
 export interface InvalidateAllAction {
   type: typeof INVALIDATEALL_TYPE;
@@ -146,5 +153,6 @@ export type ActionTypes =
   | UnsubscribeAction
   | InvalidateAction
   | InvalidateAllAction
+  | ExpireAllAction
   | ResetAction
   | GCAction;

package/src/state/reducer/createReducer.ts

@@ -1,3 +1,4 @@
+import { expireReducer } from './expireReducer.js';
 import { fetchReducer } from './fetchReducer.js';
 import { invalidateReducer } from './invalidateReducer.js';
 import { setReducer } from './setReducer.js';
@@ -9,6 +10,7 @@ import {
   GC_TYPE,
   OPTIMISTIC_TYPE,
   INVALIDATEALL_TYPE,
+  EXPIREALL_TYPE,
 } from '../../actionTypes.js';
 import type Controller from '../../controller/Controller.js';
 import type { ActionTypes, State } from '../../types.js';
@@ -43,6 +45,9 @@ export default function createReducer(controller: Controller): ReducerType {
       case INVALIDATE_TYPE:
         return invalidateReducer(state, action);
 
+      case EXPIREALL_TYPE:
+        return expireReducer(state, action);
+
       case RESET_TYPE:
         return { ...initialState, lastReset: action.date };
 

package/src/state/reducer/expireReducer.ts

@@ -0,0 +1,20 @@
+import type { State, ExpireAllAction } from '../../types.js';
+
+export function expireReducer(state: State<unknown>, action: ExpireAllAction) {
+  const meta = { ...state.meta };
+
+  Object.keys(meta).forEach(key => {
+    if (action.testKey(key)) {
+      meta[key] = {
+        ...meta[key],
+        // 1 instead of 0 so we can do 'falsy' checks to see if it is set
+        expiresAt: 1,
+      };
+    }
+  });
+
+  return {
+    ...state,
+    meta,
+  };
+}

package/ts3.4/actionTypes.d.ts

@@ -8,5 +8,6 @@ export declare const SUBSCRIBE_TYPE: "rest-hooks/subscribe";
 export declare const UNSUBSCRIBE_TYPE: "rest-hook/unsubscribe";
 export declare const INVALIDATE_TYPE: "rest-hooks/invalidate";
 export declare const INVALIDATEALL_TYPE: "rest-hooks/invalidateall";
+export declare const EXPIREALL_TYPE: "rest-hooks/expireall";
 export declare const GC_TYPE: "rest-hooks/gc";
 //# sourceMappingURL=actionTypes.d.ts.map

package/ts3.4/controller/Controller.d.ts

@@ -50,10 +50,19 @@ export default class Controller<D extends GenericDispatch = DataClientDispatch>
     /**
      * Forces refetching and suspense on useSuspense on all matching endpoint result keys.
      * @see https://resthooks.io/docs/api/Controller#invalidateAll
+     * @returns Promise that resolves when invalidation is commited.
      */
     invalidateAll: (options: {
         testKey: (key: string) => boolean;
     }) => Promise<void>;
+    /**
+     * Sets all matching endpoint result keys to be STALE.
+     * @see https://dataclient.io/docs/api/Controller#expireAll
+     * @returns Promise that resolves when expiry is commited. *NOT* fetch promise
+     */
+    expireAll: (options: {
+        testKey: (key: string) => boolean;
+    }) => Promise<void>;
     /**
      * Resets the entire Rest Hooks cache. All inflight requests will not resolve.
      * @see https://resthooks.io/docs/api/Controller#resetEntireStore

package/ts3.4/controller/createExpireAll.d.ts

@@ -0,0 +1,3 @@
+import { ExpireAllAction } from '../types.js';
+export default function createExpireAll(testKey: (key: string) => boolean): ExpireAllAction;
+//# sourceMappingURL=createExpireAll.d.ts.map

package/ts3.4/newActions.d.ts

@@ -1,5 +1,5 @@
 import { EndpointInterface, ResolveType, UnknownError } from '@data-client/normalizr';
-import { SET_TYPE, RESET_TYPE, FETCH_TYPE, SUBSCRIBE_TYPE, UNSUBSCRIBE_TYPE, INVALIDATE_TYPE, GC_TYPE, OPTIMISTIC_TYPE, INVALIDATEALL_TYPE } from './actionTypes.js';
+import { SET_TYPE, RESET_TYPE, FETCH_TYPE, SUBSCRIBE_TYPE, UNSUBSCRIBE_TYPE, INVALIDATE_TYPE, GC_TYPE, OPTIMISTIC_TYPE, INVALIDATEALL_TYPE, EXPIREALL_TYPE } from './actionTypes.js';
 import { EndpointUpdateFunction } from './controller/types.js';
 type EndpointAndUpdate<E extends EndpointInterface> = EndpointInterface & {
     update?: EndpointUpdateFunction<E>;
@@ -69,6 +69,10 @@ export interface UnsubscribeAction<E extends EndpointAndUpdate<E> = EndpointDefa
         key: string;
     };
 }
+export interface ExpireAllAction {
+    type: typeof EXPIREALL_TYPE;
+    testKey: (key: string) => boolean;
+}
 export interface InvalidateAllAction {
     type: typeof INVALIDATEALL_TYPE;
     testKey: (key: string) => boolean;
@@ -91,6 +95,6 @@ export interface GCAction {
     ][];
     results: string[];
 }
-export type ActionTypes = FetchAction | OptimisticAction | SetAction | SubscribeAction | UnsubscribeAction | InvalidateAction | InvalidateAllAction | ResetAction | GCAction;
+export type ActionTypes = FetchAction | OptimisticAction | SetAction | SubscribeAction | UnsubscribeAction | InvalidateAction | InvalidateAllAction | ExpireAllAction | ResetAction | GCAction;
 export {};
 //# sourceMappingURL=newActions.d.ts.map

package/ts3.4/state/reducer/expireReducer.d.ts

@@ -0,0 +1,36 @@
+import { State, ExpireAllAction } from '../../types.js';
+export declare function expireReducer(state: State<unknown>, action: ExpireAllAction): {
+    meta: {
+        [x: string]: {
+            readonly date: number;
+            readonly error?: import("packages/normalizr/lib/index.js").ErrorTypes | undefined;
+            readonly expiresAt: number;
+            readonly prevExpiresAt?: number | undefined;
+            readonly invalidated?: boolean | undefined;
+            readonly errorPolicy?: "hard" | "soft" | undefined;
+        };
+    };
+    entities: {
+        readonly [entityKey: string]: {
+            readonly [pk: string]: unknown;
+        } | undefined;
+    };
+    indexes: import("packages/normalizr/lib/interface.js").NormalizedIndex;
+    results: {
+        readonly [key: string]: unknown;
+    };
+    entityMeta: {
+        readonly [entityKey: string]: {
+            readonly [pk: string]: {
+                readonly date: number;
+                readonly expiresAt: number;
+                readonly fetchedAt: number;
+            };
+        };
+    };
+    optimistic: (import("../../newActions.js").SetAction | import("../../newActions.js").OptimisticAction<import("packages/normalizr/lib/index.js").EndpointInterface<import("packages/normalizr/lib/index.js").FetchFunction, import("packages/normalizr/lib/interface.js").Schema | undefined, boolean | undefined> & {
+        update?: import("../../index.js").EndpointUpdateFunction<import("packages/normalizr/lib/index.js").EndpointInterface<import("packages/normalizr/lib/index.js").FetchFunction, import("packages/normalizr/lib/interface.js").Schema | undefined, boolean | undefined>> | undefined;
+    }>)[];
+    lastReset: number;
+};
+//# sourceMappingURL=expireReducer.d.ts.map