@ethlete/query 2.3.0 → 2.5.0

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

@@ -85,16 +85,26 @@ export type RestQueryConfig<Route extends RouteType<Arguments>, Response, Argume
      */
     route: Route;
 };
+export type GqlTransferOption = 'GET' | 'POST';
 export interface GqlQueryConfig<Route extends RouteType<Arguments> | undefined, Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> extends QueryConfigBase<Response, Arguments, ResponseTransformer> {
     /**
      * The graphql query to use for the query.
      */
     query: string;
+    /**
+     * Determines if the query should be sent via GET or POST.
+     * - `GET`: The query will be sent via query parameters.
+     * - `POST`: The query will be sent via the body.
+     * @default 'POST'
+     */
+    transferVia?: GqlTransferOption;
     /**
      * Subroute to use for the query.
      */
     route?: Route;
 }
+export type AnyRestQueryConfig = RestQueryConfig<any, any, any, any>;
+export type AnyGqlQueryConfig = GqlQueryConfig<any, any, any, any>;
 export type QueryConfigWithoutMethod<Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> = Omit<RestQueryConfig<Route, Response, Arguments, ResponseTransformer>, 'method'>;
 export type GqlQueryConfigWithoutMethod<Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> = Omit<GqlQueryConfig<Route, Response, Arguments, ResponseTransformer>, 'method'>;
 export type BaseArguments = WithHeaders & WithVariables & WithBody & WithQueryParams & WithPathParams;

package/lib/query/query.utils.d.ts

@@ -1,7 +1,7 @@
 import { BehaviorSubject, Observable } from 'rxjs';
-import { AnyQueryCreator, QueryCreator, QueryCreatorArgs, QueryCreatorMethod, QueryCreatorResponse, QueryCreatorResponseTransformer, ResponseTransformerType } from '../query-client';
+import { AnyQueryCreator, QueryClient, QueryClientConfig, QueryCreator, QueryCreatorArgs, QueryCreatorMethod, QueryCreatorResponse, QueryCreatorResponseTransformer, ResponseTransformerType } from '../query-client';
 import { Method, RequestHeaders, RequestHeadersMethodMap } from '../request';
-import { AnyQuery, AnyQueryCreatorCollection, AnyQueryOfCreatorCollection, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryRawResponseType, QueryResponseType, QueryState, QueryStateData, QueryStateRawData, QueryStateType, RouteType, Success } from './query.types';
+import { AnyGqlQueryConfig, AnyQuery, AnyQueryCreatorCollection, AnyQueryOfCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryRawResponseType, QueryResponseType, QueryState, QueryStateData, QueryStateRawData, QueryStateType, RouteType, Success } from './query.types';
 type OmitNull<T> = T extends null ? never : T;
 export declare function filterSuccess(): <T extends QueryState<unknown, unknown> | null, Response_1 extends QueryStateData<OmitNull<T>>, RawResponse extends QueryStateRawData<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response_1, RawResponse>>;
 export declare function ignoreAutoRefresh(): <T extends QueryState<unknown, unknown> | null>(source: Observable<T>) => Observable<T>;
@@ -36,4 +36,27 @@ export declare const castQueryCreatorTypes: <QC extends AnyQueryCreator, Argumen
     args?: OverrideArguments | undefined;
     response?: OverrideResponse | undefined;
 }) => QueryCreator<OverrideArguments, Method_1, OverrideResponse, Route, ResponseTransformer>;
+export declare const computeQueryMethod: (config: {
+    config: AnyRestQueryConfig | AnyGqlQueryConfig;
+}) => "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
+export declare const computeQueryBody: (config: {
+    config: AnyRestQueryConfig | AnyGqlQueryConfig;
+    clientConfig: QueryClientConfig;
+    args?: BaseArguments | undefined;
+    method: Method;
+}) => unknown;
+export declare const computeQueryAuthHeader: (config: {
+    config: AnyRestQueryConfig | AnyGqlQueryConfig;
+    client: QueryClient;
+}) => Record<string, string> | null;
+export declare const computeQueryHeaders: (config: {
+    config: AnyRestQueryConfig | AnyGqlQueryConfig;
+    client: QueryClient;
+    args?: BaseArguments | undefined;
+}) => RequestHeaders | undefined;
+export declare const computeQueryQueryParams: (config: {
+    config: AnyRestQueryConfig | AnyGqlQueryConfig;
+    clientConfig: QueryClientConfig;
+    args?: BaseArguments | undefined;
+}) => import("../request").QueryParams | undefined;
 export {};

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

@@ -1,6 +1,6 @@
 import { BehaviorSubject } from 'rxjs';
 import { Query } from '../query/query';
-import { BaseArguments, EmptyObject, RouteType, WithHeaders, WithUseResultIn } from '../query/query.types';
+import { BaseArguments, EmptyObject, GqlTransferOption, RouteType, WithHeaders, WithUseResultIn } from '../query/query.types';
 import { CacheAdapterFn, Method as MethodType, RequestHeaders, RequestHeadersMethodMap, RequestRetryFn } from '../request';
 import { QueryClient } from './query-client';
 export interface QueryClientConfig {
@@ -54,6 +54,18 @@ export interface QueryClientConfig {
          * @default shouldRetryRequest()
          */
         retryFn?: RequestRetryFn;
+        /**
+         * Configuration options for all graphql queries.
+         */
+        gql?: {
+            /**
+             * Determines if the query should be sent via GET or POST.
+             * - `GET`: The query will be sent via query parameters.
+             * - `POST`: The query will be sent via the body.
+             * @default 'POST'
+             */
+            transferVia?: GqlTransferOption;
+        };
     };
     /**
      * Parent query client.

package/lib/request/request.util.d.ts

@@ -14,7 +14,10 @@ export declare const isParamValid: (primitive: UnfilteredParamPrimitive) => bool
 export declare const extractExpiresInSeconds: (headers: RequestHeaders) => number | null;
 export declare const buildTimestampFromSeconds: (seconds: number | null) => number | null;
 export declare const serializeBody: (body: unknown) => ArrayBuffer | Blob | FormData | string | null;
-export declare const transformMethod: (method: Method) => "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
+export declare const transformMethod: (config: {
+    method: Method;
+    transferVia?: 'GET' | 'POST';
+}) => "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
 export declare const detectContentTypeHeader: (body: unknown) => string | null;
 export declare const hasHeader: (headers: RequestHeaders, header: string) => boolean;
 export declare const forEachHeader: (headers: RequestHeaders, callback: (value: string, key: string) => void) => void;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1",
     "@angular/core": "^15.2.1",
-    "@ethlete/core": "1.4.3"
+    "@ethlete/core": "1.5.1"
   },
   "module": "fesm2015/ethlete-query.mjs",
   "es2020": "fesm2020/ethlete-query.mjs",