@ethlete/query 4.15.0 → 4.16.1

package/lib/query/query.d.ts

@@ -37,7 +37,11 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     /**
      * @internal
      */
-    _arguments: Arguments);
+    _arguments: Arguments, 
+    /**
+     * @internal
+     */
+    _queryStoreKey: string);
     execute(options?: ExecuteQueryOptions): this;
     abort(): this;
     poll(config: PollConfig): this;

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

@@ -174,18 +174,56 @@ export type QueryConfigWithoutMethod<Route extends RouteType<Arguments>, Respons
 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 interface WithHeaders {
+    /**
+     * The headers to send with the query.
+     */
     headers?: Record<string, string>;
 }
+export interface QueryConfig {
+    /**
+     * Whether this query should be added to the internal query store.
+     *
+     * Generally this should be left on `false` unless you know what you are doing.
+     * @default false
+     */
+    skipQueryStore?: boolean;
+    /**
+     * The cache key to use for this query.
+     * Useful for queries that are equal but should be stored separately.
+     * Will be generated automatically if not provided.
+     *
+     * Generally this should be left on `undefined` unless you know what you are doing.
+     */
+    queryStoreCacheKey?: string;
+}
+export interface WithConfig {
+    /**
+     * Additional configuration for this query.
+     */
+    config?: QueryConfig;
+}
 export interface WithVariables {
+    /**
+     * The variables for the query. (graphql only)
+     */
     variables?: Record<string, unknown>;
 }
 export interface WithBody {
+    /**
+     * The body for the query. Unavailable for GET, HEAD and OPTIONS requests.
+     */
     body?: unknown;
 }
 export interface WithQueryParams {
+    /**
+     * The query parameters for the query. (after the ? in the url)
+     */
     queryParams?: QueryParams;
 }
 export interface WithPathParams {
+    /**
+     * The path parameters for the query. (in front of the ? in the url)
+     */
     pathParams?: PathParams;
 }
 export type QueryTrigger = 'program' | 'poll' | 'auto';

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, WithHeaders } from '../query/query.types';
+import { AnyQuery, BaseArguments, EmptyObject, RouteType, WithConfig, WithHeaders } 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) => Query<Response, Arguments, Route, Store, Data, Id> : (args?: (Arguments extends EmptyObject ? Arguments : EmptyObject) & WithHeaders) => 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) => Query<Response, Arguments, Route, Store, Data, Id> : (args?: (Arguments extends EmptyObject ? Arguments : EmptyObject) & WithHeaders & WithConfig) => 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": "4.15.0",
+  "version": "4.16.1",
   "dependencies": {
     "tslib": "^2.5.0"
   },