@ethlete/query 5.7.0 → 5.8.0

package/lib/query/query.d.ts

@@ -26,6 +26,7 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     get autoRefreshOnConfig(): Readonly<QueryAutoRefreshConfig>;
     get store(): Store | null;
     get canBeCached(): boolean;
+    get _isInMockMode(): boolean;
     constructor(_client: QueryClient, 
     /**
      * @internal
@@ -55,4 +56,5 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     private _updateEntityState;
     private _transformState;
     private _updateState;
+    private _mockRequest;
 }

package/lib/query/query.types.d.ts

@@ -172,13 +172,69 @@ export type AnyRestQueryConfig = RestQueryConfig<any, any, any, any, any, any>;
 export type AnyGqlQueryConfig = GqlQueryConfig<any, any, any, any, any, any>;
 export type QueryConfigWithoutMethod<Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = Omit<RestQueryConfig<Route, Response, Arguments, Store, Data, Id>, 'method'>;
 export type GqlQueryConfigWithoutMethod<Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = Omit<GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, 'method'>;
-export type BaseArguments = WithHeaders & WithVariables & WithBody & WithQueryParams & WithPathParams;
+export type BaseArguments = WithHeaders & WithVariables & WithBody & WithQueryParams & WithPathParams & WithMock<unknown>;
 export interface WithHeaders {
     /**
      * The headers to send with the query.
      */
     headers?: Record<string, string>;
 }
+export interface QueryMockConfig<MockResponse> {
+    /**
+     * The mock response to use for the query.
+     */
+    response?: MockResponse;
+    /**
+     * The mock error to use for the query.
+     */
+    error?: RequestError;
+    /**
+     * The delay in milliseconds to wait before resolving the mock.
+     * If progress is enabled, the delay will be used for each progress event.
+     * @default 200
+     */
+    delay?: number;
+    /**
+     * Whether to report progress for the mock.
+     * For testing e.g. file uploads.
+     */
+    progress?: {
+        /**
+         * The number of progress events to report.
+         * @default 5
+         */
+        eventCount?: number;
+        /**
+         * The type of progress event to report.
+         * @default 'upload'
+         */
+        eventType?: 'download' | 'upload';
+        /**
+         * The total size of the file to report progress for in bytes.
+         * @default 1_000_000 (1MB)
+         */
+        fileSize?: number;
+        /**
+         * If true, the total size of the file will be omitted from the progress event.
+         * Useful for testing e.g. download progress when the server does not provide a total size.
+         */
+        omitTotal?: boolean;
+        /**
+         * If true, the partial text will be omitted from the progress event.
+         * Useful for testing e.g. download progress when the server does not provide a partial text.
+         */
+        omitPartialText?: boolean;
+    };
+    /**
+     * This will mock the request failing and getting retried 3 times. After, the request will succeed with the provided response.
+     * Can not be used with `progress` enabled.
+     * @default false
+     */
+    retryIntoResponse?: boolean;
+}
+export interface WithMock<MockResponse> {
+    mock?: QueryMockConfig<MockResponse>;
+}
 export interface QueryConfig {
     /**
      * Whether this query should be added to the internal query store.

package/lib/query-creator/query-creator.types.d.ts

@@ -1,8 +1,8 @@
 import { EntityStore } from '../entity';
 import { Query } from '../query/query';
-import { AnyQuery, BaseArguments, EmptyObject, RouteType, WithConfig, WithHeaders } from '../query/query.types';
+import { AnyQuery, BaseArguments, EmptyObject, RouteType, WithConfig, WithHeaders, WithMock } from '../query/query.types';
 import { QueryCreator } from './query-creator';
-export type QueryPrepareFn<Arguments extends BaseArguments | undefined, Response, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> = Arguments extends BaseArguments ? (args: Arguments & WithHeaders & WithConfig) => Query<Response, Arguments, Route, Store, Data, Id> : (args?: (Arguments extends EmptyObject ? Arguments : EmptyObject) & WithHeaders & WithConfig) => Query<Response, Arguments, Route, Store, Data, Id>;
+export type QueryPrepareFn<Arguments extends BaseArguments | undefined, Response, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> = Arguments extends BaseArguments ? (args: Arguments & WithHeaders & WithConfig & WithMock<Response>) => Query<Response, Arguments, Route, Store, Data, Id> : (args?: (Arguments extends EmptyObject ? Arguments : EmptyObject) & WithHeaders & WithConfig & WithMock<Response>) => Query<Response, Arguments, Route, Store, Data, Id>;
 export type AnyQueryCreator = QueryCreator<any, any, any, any, any, any>;
 export type QueryArgsOf<T extends AnyQueryCreator | AnyQuery | null> = T extends QueryCreator<infer Args, any, any, any, any, any> ? Args : T extends Query<any, infer Args, any, any, any, any> ? Args : never;
 export type QueryResponseOf<T extends AnyQueryCreator | AnyQuery | null> = T extends QueryCreator<any, infer Response, any, any, any, any> ? Response : T extends Query<infer Response, any, any, any, any, any> ? Response : never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "peerDependencies": {
     "@angular/common": "17.2.4",
     "@angular/core": "17.2.4",