@data-client/core 0.12.3 → 0.13.0

package/ts3.4/actions.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, EXPIREALL_TYPE } from './actionTypes.js';
+import { Denormalize, EndpointInterface, Queryable, 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, EXPIREALL_TYPE, SET_RESPONSE_TYPE } from './actionTypes.js';
 import { EndpointUpdateFunction } from './controller/types.js';
 type EndpointAndUpdate<E extends EndpointInterface> = EndpointInterface & {
     update?: EndpointUpdateFunction<E>;
@@ -9,26 +9,38 @@ type EndpointDefault = EndpointInterface & {
 };
 export interface SetMeta {
     args: readonly any[];
-    key: string;
     fetchedAt: number;
     date: number;
     expiresAt: number;
 }
-export interface SetActionSuccess<E extends EndpointAndUpdate<E> = EndpointDefault> {
+export interface SetAction<S extends Queryable = any> {
     type: typeof SET_TYPE;
-    endpoint: E;
+    schema: S;
     meta: SetMeta;
+    value: Denormalize<S>;
+}
+export interface SetResponseMeta {
+    args: readonly any[];
+    key: string;
+    fetchedAt: number;
+    date: number;
+    expiresAt: number;
+}
+export interface SetResponseActionSuccess<E extends EndpointAndUpdate<E> = EndpointDefault> {
+    type: typeof SET_RESPONSE_TYPE;
+    endpoint: E;
+    meta: SetResponseMeta;
     payload: ResolveType<E>;
     error?: false;
 }
-export interface SetActionError<E extends EndpointAndUpdate<E> = EndpointDefault> {
-    type: typeof SET_TYPE;
+export interface SetResponseActionError<E extends EndpointAndUpdate<E> = EndpointDefault> {
+    type: typeof SET_RESPONSE_TYPE;
     endpoint: E;
-    meta: SetMeta;
+    meta: SetResponseMeta;
     payload: UnknownError;
     error: true;
 }
-export type SetAction<E extends EndpointAndUpdate<E> = EndpointDefault> = SetActionSuccess<E> | SetActionError<E>;
+export type SetResponseAction<E extends EndpointAndUpdate<E> = EndpointDefault> = SetResponseActionSuccess<E> | SetResponseActionError<E>;
 export interface FetchMeta<A extends readonly any[] = readonly any[]> {
     args: A;
     key: string;
@@ -50,7 +62,7 @@ export interface FetchAction<E extends EndpointAndUpdate<E> = EndpointDefault> {
 export interface OptimisticAction<E extends EndpointAndUpdate<E> = EndpointDefault> {
     type: typeof OPTIMISTIC_TYPE;
     endpoint: E;
-    meta: SetMeta;
+    meta: SetResponseMeta;
     error?: false;
 }
 export interface SubscribeAction<E extends EndpointAndUpdate<E> = EndpointDefault> {
@@ -95,6 +107,6 @@ export interface GCAction {
     ][];
     endpoints: string[];
 }
-export type ActionTypes = FetchAction | OptimisticAction | SetAction | SubscribeAction | UnsubscribeAction | InvalidateAction | InvalidateAllAction | ExpireAllAction | ResetAction | GCAction;
+export type ActionTypes = FetchAction | OptimisticAction | SetAction | SetResponseAction | SubscribeAction | UnsubscribeAction | InvalidateAction | InvalidateAllAction | ExpireAllAction | ResetAction | GCAction;
 export {};
 //# sourceMappingURL=actions.d.ts.map

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

@@ -79,9 +79,17 @@ export default class Controller<D extends GenericDispatch = DataClientDispatch>
      */
     resetEntireStore: () => Promise<void>;
     /**
-     * Stores response in cache for given Endpoint and args.
+     * Sets value for the Queryable and args.
      * @see https://dataclient.io/docs/api/Controller#set
      */
+    set: <S extends Queryable>(schema: S, ...rest: readonly [
+        ...SchemaArgs<S>,
+        any
+    ]) => Promise<void>;
+    /**
+     * Sets response for the Endpoint and args.
+     * @see https://dataclient.io/docs/api/Controller#setResponse
+     */
     setResponse: <E extends EndpointInterface<FetchFunction, Schema | undefined, boolean | undefined> & {
         update?: EndpointUpdateFunction<E> | undefined;
     }>(endpoint: E, ...rest: readonly [
@@ -89,7 +97,7 @@ export default class Controller<D extends GenericDispatch = DataClientDispatch>
         any
     ]) => Promise<void>;
     /**
-     * Stores the result of Endpoint and args as the error provided.
+     * Sets an error response for the Endpoint and args.
      * @see https://dataclient.io/docs/api/Controller#setError
      */
     setError: <E extends EndpointInterface<FetchFunction, Schema | undefined, boolean | undefined> & {

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

@@ -1,24 +1,10 @@
-import { EndpointInterface, ResolveType } from '@data-client/normalizr';
-import { EndpointUpdateFunction } from './types.js';
+import { Queryable, SchemaArgs } from '@data-client/normalizr';
 import { SetAction } from '../types.js';
-export default function createSet<E extends EndpointInterface & {
-    update?: EndpointUpdateFunction<E>;
-}>(endpoint: E, options: {
+export default function createSet<S extends Queryable>(schema: S, { args, fetchedAt, value, }: {
     args: readonly [
-        ...Parameters<E>
+        ...SchemaArgs<S>
     ];
-    response: Error;
+    value: any;
     fetchedAt?: number;
-    error: true;
-}): SetAction<E>;
-export default function createSet<E extends EndpointInterface & {
-    update?: EndpointUpdateFunction<E>;
-}>(endpoint: E, options: {
-    args: readonly [
-        ...Parameters<E>
-    ];
-    response: ResolveType<E>;
-    fetchedAt?: number;
-    error?: false;
-}): SetAction<E>;
+}): SetAction<S>;
 //# sourceMappingURL=createSet.d.ts.map

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

@@ -0,0 +1,24 @@
+import { EndpointInterface, ResolveType } from '@data-client/normalizr';
+import { EndpointUpdateFunction } from './types.js';
+import { SetResponseAction } from '../types.js';
+export default function createSetResponse<E extends EndpointInterface & {
+    update?: EndpointUpdateFunction<E>;
+}>(endpoint: E, options: {
+    args: readonly [
+        ...Parameters<E>
+    ];
+    response: Error;
+    fetchedAt?: number;
+    error: true;
+}): SetResponseAction<E>;
+export default function createSetResponse<E extends EndpointInterface & {
+    update?: EndpointUpdateFunction<E>;
+}>(endpoint: E, options: {
+    args: readonly [
+        ...Parameters<E>
+    ];
+    response: ResolveType<E>;
+    fetchedAt?: number;
+    error?: false;
+}): SetResponseAction<E>;
+//# sourceMappingURL=createSetResponse.d.ts.map

package/ts3.4/index.d.ts

@@ -9,6 +9,7 @@ export { default as Controller } from './controller/Controller.js';
 export { DataClientDispatch, GenericDispatch, } from './controller/Controller.js';
 export { default as createFetch } from './controller/createFetch.js';
 export { default as createSet } from './controller/createSet.js';
+export { default as createSetResponse } from './controller/createSetResponse.js';
 export * from './controller/types.js';
 import * as actionTypes_1 from './actionTypes.js';
 export { actionTypes_1 as actionTypes };

package/ts3.4/manager/NetworkManager.d.ts

@@ -1,5 +1,5 @@
 import Controller from '../controller/Controller.js';
-import { FetchAction, Manager, ActionTypes, Middleware, SetAction } from '../types.js';
+import { FetchAction, Manager, ActionTypes, Middleware, SetResponseAction } from '../types.js';
 export declare class ResetError extends Error {
     name: string;
     constructor();
@@ -57,7 +57,7 @@ export default class NetworkManager implements Manager {
      *
      * Will resolve the promise associated with set key.
      */
-    protected handleSet(action: SetAction): void;
+    protected handleSet(action: SetResponseAction): void;
     /** Attaches NetworkManager to store
      *
      * Intercepts 'rdc/fetch' actions to start requests.

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

@@ -28,7 +28,7 @@ export declare function expireReducer(state: State<unknown>, action: ExpireAllAc
             };
         };
     };
-    optimistic: (import("../../actions.js").SetAction | import("../../actions.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> & {
+    optimistic: (import("../../actions.js").SetResponseAction | import("../../actions.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;

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

@@ -28,7 +28,7 @@ export declare function invalidateReducer(state: State<unknown>, action: Invalid
             };
         };
     };
-    optimistic: (import("../../actions.js").SetAction | import("../../actions.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> & {
+    optimistic: (import("../../actions.js").SetResponseAction | import("../../actions.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;

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

@@ -1,4 +1,3 @@
-import Controller from '../../controller/Controller.js';
-import { State, SetAction, OptimisticAction } from '../../types.js';
-export declare function setReducer(state: State<unknown>, action: OptimisticAction | SetAction, controller: Controller): State<unknown>;
+import { State, SetAction } from '../../types.js';
+export declare function setReducer(state: State<unknown>, action: SetAction): State<unknown>;
 //# sourceMappingURL=setReducer.d.ts.map

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

@@ -0,0 +1,4 @@
+import Controller from '../../controller/Controller.js';
+import { State, SetResponseAction, OptimisticAction } from '../../types.js';
+export declare function setResponseReducer(state: State<unknown>, action: OptimisticAction | SetResponseAction, controller: Controller): State<unknown>;
+//# sourceMappingURL=setResponseReducer.d.ts.map

package/ts3.4/types.d.ts

@@ -1,11 +1,9 @@
 import { NormalizedIndex } from '@data-client/normalizr';
 import { UpdateFunction, AbstractInstanceType } from '@data-client/normalizr';
 import { ErrorTypes } from '@data-client/normalizr';
-import { ActionTypes, SetAction, OptimisticAction } from './actions.js';
-import { SET_TYPE } from './actionTypes.js';
+import { ActionTypes, SetResponseAction, OptimisticAction } from './actions.js';
 import { Dispatch, Middleware, MiddlewareAPI } from './middlewareTypes.js';
 export { AbstractInstanceType, UpdateFunction };
-export type SetTypes = typeof SET_TYPE;
 export type PK = string;
 export interface State<T> {
     readonly entities: {
@@ -36,7 +34,7 @@ export interface State<T> {
             };
         };
     };
-    readonly optimistic: (SetAction | OptimisticAction)[];
+    readonly optimistic: (SetResponseAction | OptimisticAction)[];
     readonly lastReset: number;
 }
 export * from './actions.js';