@ethlete/query 2.4.0 → 2.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm2020/lib/query/query.mjs +7 -2
- package/esm2020/lib/query/query.types.mjs +1 -1
- package/esm2020/lib/query/query.utils.mjs +7 -3
- package/esm2020/lib/query-client/query-client.mjs +2 -5
- package/esm2020/lib/query-client/query-client.types.mjs +1 -1
- package/esm2020/lib/query-store/query-store.mjs +1 -1
- package/fesm2015/ethlete-query.mjs +21 -15
- package/fesm2015/ethlete-query.mjs.map +1 -1
- package/fesm2020/ethlete-query.mjs +13 -7
- package/fesm2020/ethlete-query.mjs.map +1 -1
- package/lib/query/query.types.d.ts +2 -1
- package/lib/query/query.utils.d.ts +3 -1
- package/lib/query-client/query-client.types.d.ts +13 -1
- package/lib/query-store/query-store.d.ts +1 -1
- package/package.json +1 -1
|
@@ -85,6 +85,7 @@ export type RestQueryConfig<Route extends RouteType<Arguments>, Response, Argume
|
|
|
85
85
|
*/
|
|
86
86
|
route: Route;
|
|
87
87
|
};
|
|
88
|
+
export type GqlTransferOption = 'GET' | 'POST';
|
|
88
89
|
export interface GqlQueryConfig<Route extends RouteType<Arguments> | undefined, Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> extends QueryConfigBase<Response, Arguments, ResponseTransformer> {
|
|
89
90
|
/**
|
|
90
91
|
* The graphql query to use for the query.
|
|
@@ -96,7 +97,7 @@ export interface GqlQueryConfig<Route extends RouteType<Arguments> | undefined,
|
|
|
96
97
|
* - `POST`: The query will be sent via the body.
|
|
97
98
|
* @default 'POST'
|
|
98
99
|
*/
|
|
99
|
-
transferVia?:
|
|
100
|
+
transferVia?: GqlTransferOption;
|
|
100
101
|
/**
|
|
101
102
|
* Subroute to use for the query.
|
|
102
103
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BehaviorSubject, Observable } from 'rxjs';
|
|
2
|
-
import { AnyQueryCreator, QueryClient, QueryCreator, QueryCreatorArgs, QueryCreatorMethod, QueryCreatorResponse, QueryCreatorResponseTransformer, ResponseTransformerType } from '../query-client';
|
|
2
|
+
import { AnyQueryCreator, QueryClient, QueryClientConfig, QueryCreator, QueryCreatorArgs, QueryCreatorMethod, QueryCreatorResponse, QueryCreatorResponseTransformer, ResponseTransformerType } from '../query-client';
|
|
3
3
|
import { Method, RequestHeaders, RequestHeadersMethodMap } from '../request';
|
|
4
4
|
import { AnyGqlQueryConfig, AnyQuery, AnyQueryCreatorCollection, AnyQueryOfCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryRawResponseType, QueryResponseType, QueryState, QueryStateData, QueryStateRawData, QueryStateType, RouteType, Success } from './query.types';
|
|
5
5
|
type OmitNull<T> = T extends null ? never : T;
|
|
@@ -41,6 +41,7 @@ export declare const computeQueryMethod: (config: {
|
|
|
41
41
|
}) => "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
|
|
42
42
|
export declare const computeQueryBody: (config: {
|
|
43
43
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
44
|
+
clientConfig: QueryClientConfig;
|
|
44
45
|
args?: BaseArguments | undefined;
|
|
45
46
|
method: Method;
|
|
46
47
|
}) => unknown;
|
|
@@ -55,6 +56,7 @@ export declare const computeQueryHeaders: (config: {
|
|
|
55
56
|
}) => RequestHeaders | undefined;
|
|
56
57
|
export declare const computeQueryQueryParams: (config: {
|
|
57
58
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
59
|
+
clientConfig: QueryClientConfig;
|
|
58
60
|
args?: BaseArguments | undefined;
|
|
59
61
|
}) => import("../request").QueryParams | undefined;
|
|
60
62
|
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BehaviorSubject } from 'rxjs';
|
|
2
2
|
import { Query } from '../query/query';
|
|
3
|
-
import { BaseArguments, EmptyObject, RouteType, WithHeaders, WithUseResultIn } from '../query/query.types';
|
|
3
|
+
import { BaseArguments, EmptyObject, GqlTransferOption, RouteType, WithHeaders, WithUseResultIn } from '../query/query.types';
|
|
4
4
|
import { CacheAdapterFn, Method as MethodType, RequestHeaders, RequestHeadersMethodMap, RequestRetryFn } from '../request';
|
|
5
5
|
import { QueryClient } from './query-client';
|
|
6
6
|
export interface QueryClientConfig {
|
|
@@ -54,6 +54,18 @@ export interface QueryClientConfig {
|
|
|
54
54
|
* @default shouldRetryRequest()
|
|
55
55
|
*/
|
|
56
56
|
retryFn?: RequestRetryFn;
|
|
57
|
+
/**
|
|
58
|
+
* Configuration options for all graphql queries.
|
|
59
|
+
*/
|
|
60
|
+
gql?: {
|
|
61
|
+
/**
|
|
62
|
+
* Determines if the query should be sent via GET or POST.
|
|
63
|
+
* - `GET`: The query will be sent via query parameters.
|
|
64
|
+
* - `POST`: The query will be sent via the body.
|
|
65
|
+
* @default 'POST'
|
|
66
|
+
*/
|
|
67
|
+
transferVia?: GqlTransferOption;
|
|
68
|
+
};
|
|
57
69
|
};
|
|
58
70
|
/**
|
|
59
71
|
* Parent query client.
|
|
@@ -12,7 +12,7 @@ export declare class QueryStore {
|
|
|
12
12
|
enableSmartPolling?: boolean | undefined;
|
|
13
13
|
} | undefined);
|
|
14
14
|
add(id: string, query: AnyQuery): void;
|
|
15
|
-
get(id: string):
|
|
15
|
+
get<T extends AnyQuery>(id: string): T | null;
|
|
16
16
|
remove(id: string): void;
|
|
17
17
|
forEach(callback: (value: AnyQuery, key: string) => void): void;
|
|
18
18
|
refreshQueriesInUse(config?: {
|