@ethlete/query 1.0.0 → 2.0.0

package/lib/gql/gql.d.ts

@@ -1,2 +1,6 @@
-export declare const transformGql: (str: string) => (variables: Record<string, unknown> | null | undefined) => string;
+export declare const transformGql: (str: string) => (variables: Record<string, unknown> | null | undefined) => {
+    query: string;
+    variables?: string | undefined;
+    operationName?: string | undefined;
+};
 export declare const gql: (strings: TemplateStringsArray, ...values: string[]) => string;

package/lib/query/query.d.ts

@@ -14,6 +14,8 @@ export declare class Query<Response, Arguments extends (BaseArguments & WithUseR
     get state$(): import("rxjs").Observable<QueryState<ReturnType<ResponseTransformer>, Response>>;
     get state(): QueryState<ReturnType<ResponseTransformer>, Response>;
     get isExpired(): boolean;
+    get isInUse(): boolean;
+    get _config(): RestQueryConfig<Route, Response, Arguments, ResponseTransformer> | GqlQueryConfig<Route, Response, Arguments, ResponseTransformer>;
     constructor(_client: QueryClient, _queryConfig: RestQueryConfig<Route, Response, Arguments, ResponseTransformer> | GqlQueryConfig<Route, Response, Arguments, ResponseTransformer>, _routeWithParams: Route, _args: Arguments | undefined);
     clone(): import("../query-client").QueryCreator<Arguments, Method, Response, Route, ResponseTransformer>;
     execute<ComputedResponse extends ReturnType<ResponseTransformer>>(options?: RunQueryOptions): this;

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

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import { AnyQueryCreator, QueryCreatorReturnType, ResponseTransformerType } from '../query-client';
 import { Method, PathParams, QueryParams, RequestError, RequestProgress } from '../request';
 import { Query } from './query';
-export interface QueryConfigBase<Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> {
+export type QueryConfigBase<Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> = {
     /**
      * The http method to use for the query.
      */
@@ -31,6 +31,18 @@ export interface QueryConfigBase<Response, Arguments extends BaseArguments | und
      * @default false
      */
     withCredentials?: boolean;
+    /**
+     * Configuration for handling auto refresh triggers.
+     *
+     * **Note:** This is only available for queries that can be refreshed. (`GET`, `HEAD`, `OPTIONS`, `GQL_QUERY`)
+     */
+    autoRefreshOn?: {
+        /**
+         * Refresh the query when the query client's headers change.
+         * @default true
+         */
+        queryClientDefaultHeadersChange?: boolean;
+    };
     /**
      * Object containing the query's type information.
      */
@@ -50,13 +62,13 @@ export interface QueryConfigBase<Response, Arguments extends BaseArguments | und
          */
         args?: Arguments;
     };
-}
-export interface RestQueryConfig<Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> extends QueryConfigBase<Response, Arguments, ResponseTransformer> {
+};
+export type RestQueryConfig<Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, ResponseTransformer extends ResponseTransformerType<Response> | undefined> = QueryConfigBase<Response, Arguments, ResponseTransformer> & {
     /**
      * The api route to use for the query.
      */
     route: Route;
-}
+};
 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.

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

@@ -19,6 +19,9 @@ export declare class QueryClient {
     gqlMutate: <Route extends RouteType<Arguments>, Response_1, Arguments extends BaseArguments | undefined = undefined, ResponseTransformer extends ResponseTransformerType<Response_1> = DefaultResponseTransformer<Response_1>>(queryConfig: GqlQueryConfigWithoutMethod<Route, Response_1, Arguments, ResponseTransformer>) => QueryCreator<Arguments, "GQL_MUTATE", Response_1, Route, ResponseTransformer>;
     fetch: <Route extends RouteType<Arguments>, Response_1, Arguments extends BaseArguments | undefined, Method extends MethodType, ResponseTransformer extends ResponseTransformerType<Response_1> = DefaultResponseTransformer<Response_1>>(queryConfig: RestQueryConfig<Route, Response_1, Arguments, ResponseTransformer> | GqlQueryConfig<Route, Response_1, Arguments, ResponseTransformer>) => QueryCreator<Arguments, Method, Response_1, Route, ResponseTransformer>;
     setAuthProvider: (authProvider: AuthProvider) => void;
-    setDefaultHeaders: (headers: RequestHeaders | RequestHeadersMethodMap | null) => void;
+    setDefaultHeaders: (config: {
+        headers: RequestHeaders | RequestHeadersMethodMap | null;
+        refreshQueriesInUse?: boolean;
+    }) => void;
     clearAuthProvider: () => void;
 }

package/lib/query-store/query-store.d.ts

@@ -10,6 +10,11 @@ export declare class QueryStore {
     add(id: string, query: AnyQuery): void;
     get(id: string): AnyQuery | null;
     remove(id: string): void;
+    forEach(callback: (value: AnyQuery, key: string) => void): void;
+    refreshQueriesInUse(config?: {
+        ignoreCacheValidity?: boolean;
+        purgeUnused?: boolean;
+    }): void;
     private _logState;
     private _initGarbageCollector;
     private _stopGarbageCollector;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
     "@angular/common": "^14.2.0 || ^15.0.0",
     "@angular/core": "^14.2.0 || ^15.0.0",
-    "@ethlete/core": "1.0.0"
+    "@ethlete/core": "1.4.0"
   },
   "module": "fesm2015/ethlete-query.mjs",
   "es2020": "fesm2020/ethlete-query.mjs",