@ethlete/query 5.16.1 → 5.17.0

package/lib/entity/entity.utils.d.ts

@@ -5,7 +5,7 @@ export declare function mapToPaginated<T>(response: Paginated<T>): import("rxjs"
 /**
  * Use an other store to represent a property of the current entity.
  */
-export declare const insertFrom: <OriginStoreType, OriginKeys extends keyof NonNullable<OriginStoreType>, SubStoreType extends NonNullable<OriginStoreType>[OriginKeys] extends (infer U)[] ? U : NonNullable<OriginStoreType>[OriginKeys], IdFn extends (value: NonNullable<OriginStoreType>) => EntityKey | EntityKey[], ComputedEntityType extends ReturnType<IdFn> extends unknown[] ? OriginStoreType : Omit<OriginStoreType, OriginKeys> & { [K in OriginKeys]: SubStoreType | null; }>(store: EntityStore<SubStoreType>, { for: key, id }: InsertFromConfig<OriginStoreType, OriginKeys, IdFn>) => import("rxjs").OperatorFunction<OriginStoreType, ComputedEntityType | null>;
+export declare const insertFrom: <OriginStoreType, OriginKeys extends keyof NonNullable<OriginStoreType>, SubStoreType extends NonNullable<OriginStoreType>[OriginKeys] extends Array<infer U> ? U : NonNullable<OriginStoreType>[OriginKeys], IdFn extends (value: NonNullable<OriginStoreType>) => EntityKey | EntityKey[], ComputedEntityType extends ReturnType<IdFn> extends Array<unknown> ? OriginStoreType : Omit<OriginStoreType, OriginKeys> & { [K in OriginKeys]: SubStoreType | null; }>(store: EntityStore<SubStoreType>, { for: key, id }: InsertFromConfig<OriginStoreType, OriginKeys, IdFn>) => import("rxjs").OperatorFunction<OriginStoreType, ComputedEntityType | null>;
 /**
  * Remove entities from a store based on a where function.
  */

package/lib/gql/gql.d.ts

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

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

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import { EntityStore } from '../entity';
 import { AnyQueryCreator, ConstructQuery, QueryDataOf, QueryResponseOf } from '../query-creator';
 import { QueryForm } from '../query-form';
-import { Method, PathParams, QueryParams, RequestError, RequestProgress } from '../request';
+import { Method, PathParams, QueryParams, RequestError, RequestHeaders, RequestProgress } from '../request';
 import { Query } from './query';
 export interface QueryAutoRefreshConfig {
     /**
@@ -329,6 +329,7 @@ export interface Prepared {
 export interface Success<Response = unknown> {
     type: QueryStateType.Success;
     response: Response;
+    headers: RequestHeaders;
     meta: QueryStateSuccessMeta;
 }
 export interface Failure {

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

@@ -6,7 +6,7 @@ import { AnyQueryCreator, QueryArgsOf, QueryCreator, QueryDataOf, QueryResponseO
 import { QueryForm } from '../query-form';
 import { Method, RequestHeaders, RequestHeadersMethodMap } from '../request';
 import { QueryContainerConfig } from '../utils';
-import { AnyGqlQueryConfig, AnyQuery, AnyQueryCollectionData, AnyQueryCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryCollectionOf, QueryState, QueryStateResponseOf, QueryStateType, ResetPageOnErrorOperatorConfig, RouteType, Success } from './query.types';
+import { AnyGqlQueryConfig, AnyQuery, AnyQueryCollection, AnyQueryCollectionData, AnyQueryCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryCollectionOf, QueryState, QueryStateResponseOf, QueryStateType, ResetPageOnErrorOperatorConfig, RouteType, Success } from './query.types';
 type OmitNull<T> = T extends null ? never : T;
 export declare function filterSuccess(): <T extends QueryState | null, Response extends QueryStateResponseOf<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response>>;
 export declare function ignoreAutoRefresh(): <T extends QueryState | null>(source: Observable<T>) => Observable<T>;
@@ -17,13 +17,10 @@ export declare function takeUntilResponse(config?: {
 }): <T extends QueryState | null>(source: Observable<T>) => Observable<T>;
 export declare function filterNull(): <T>(source: Observable<T>) => Observable<OmitNull<T>>;
 export declare function switchQueryState(): <T extends AnyQuery | null, Data extends QueryDataOf<T>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
-export declare function switchQueryCollectionState(): <T extends {
-    type: string;
-    query: import("@ethlete/query").Query<any, any, any, any, any, any>;
-} | null, Data extends AnyQueryCollectionData<OmitNull<T>>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
+export declare function switchQueryCollectionState(): <T extends AnyQueryCollection | null, Data extends AnyQueryCollectionData<OmitNull<T>>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
 export declare const resetPageOnError: <T extends AnyQuery | null | undefined, J extends QueryForm<any>>(config: ResetPageOnErrorOperatorConfig<J>) => (source: Observable<T>) => Observable<QueryState<any> | T>;
 export declare const isQueryStateLoading: (state: QueryState | null | undefined) => state is Loading;
-export declare const isQueryStateSuccess: (state: QueryState | null | undefined) => state is Success<unknown>;
+export declare const isQueryStateSuccess: (state: QueryState | null | undefined) => state is Success;
 export declare const isQueryStateFailure: (state: QueryState | null | undefined) => state is Failure;
 export declare const isQueryStateCancelled: (state: QueryState | null | undefined) => state is Cancelled;
 export declare const isQueryStatePrepared: (state: QueryState | null | undefined) => state is Prepared;
@@ -31,20 +28,14 @@ export declare const isAutoRefresh: (state: QueryState | null | undefined) => bo
 export declare const mergeHeaders: (...headers: Array<RequestHeaders | null | undefined>) => RequestHeaders | null | undefined;
 export declare const isGqlQueryConfig: <Response, Arguments extends BaseArguments | undefined, Route extends RouteType<Arguments> | undefined, Store extends EntityStore<unknown>, Data, Id>(config: unknown) => config is GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>;
 export declare const isQuery: <T extends AnyQuery>(query: unknown) => query is T;
-export declare const isQueryCollection: <T extends {
-    type: string;
-    query: import("@ethlete/query").Query<any, any, any, any, any, any>;
-}>(query: unknown) => query is T;
+export declare const isQueryCollection: <T extends AnyQueryCollection>(query: unknown) => query is T;
 /**
  * @deprecated Use `createQueryCollectionSubject` instead. Will be removed in v6.
  */
 export declare const createQueryCollection: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T) => BehaviorSubject<R | null>;
 export declare const createQueryCollectionSubject: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T, config?: QueryContainerConfig) => BehaviorSubject<R | null>;
 export declare const createQueryCollectionSignal: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T, config?: QueryContainerConfig) => import("@angular/core").WritableSignal<R | null>;
-export declare const extractQuery: <T extends AnyQuery | {
-    type: string;
-    query: import("@ethlete/query").Query<any, any, any, any, any, any>;
-} | null>(v: T) => import("@ethlete/query").Query<any, any, any, any, any, any> | null;
+export declare const extractQuery: <T extends AnyQuery | AnyQueryCollection | null>(v: T) => import("@ethlete/query").Query<any, any, any, any, any, any> | null;
 export declare const getDefaultHeaders: (headers: RequestHeaders | RequestHeadersMethodMap | null | undefined, method: Method) => RequestHeaders;
 export declare const castQueryCreatorTypes: <QC extends AnyQueryCreator, Arguments extends QueryArgsOf<QC>, Response extends QueryResponseOf<QC>, Store extends QueryStoreOf<QC>, Data extends QueryDataOf<QC>, Route extends RouteType<Arguments>, Id extends QueryStoreIdOf<QC>, OverrideArguments extends BaseArguments | undefined, OverrideResponse extends Response | undefined>(config: {
     creator: QC;

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

@@ -1,4 +1,4 @@
 import { BaseArguments } from '../query/query.types';
 import { Method } from '../request';
-export declare const shouldCacheQuery: (method: Method) => boolean;
+export declare const shouldCacheQuery: (method: Method) => method is "GET" | "HEAD" | "OPTIONS" | "GQL_QUERY";
 export declare const buildQueryCacheKey: (route: string, args: BaseArguments | undefined) => string;

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

@@ -20,11 +20,12 @@ export declare class QueryForm<T extends Record<string, QueryField<any>>> {
     private readonly _router;
     private readonly _activatedRoute;
     private readonly _defaultValues;
-    private readonly _routerStateService;
     private readonly _zone;
     private readonly _didValueChanges$;
     private _isObserving;
     private _skipNextResets;
+    private _queryParamChanges$;
+    private _queryParams;
     /**
      * The angular form group that contains all the fields.
      *
@@ -88,4 +89,5 @@ export declare class QueryForm<T extends Record<string, QueryField<any>>> {
     private _extractDefaultValues;
     private _syncViaUrlQueryParams;
     private _handleFormChange;
+    private _cleanup;
 }

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

@@ -9,10 +9,10 @@ export declare class QueryStore {
     readonly storeChange$: import("rxjs").Observable<string>;
     readonly queryCreated$: import("rxjs").Observable<AnyQuery>;
     constructor(_config?: {
-        enableChangeLogging?: boolean | undefined;
-        enableGarbageCollectorLogging?: boolean | undefined;
-        autoRefreshQueriesOnWindowFocus?: boolean | undefined;
-        enableSmartPolling?: boolean | undefined;
+        enableChangeLogging?: boolean;
+        enableGarbageCollectorLogging?: boolean;
+        autoRefreshQueriesOnWindowFocus?: boolean;
+        enableSmartPolling?: boolean;
     } | undefined);
     add(id: string, query: AnyQuery): void;
     get<T extends AnyQuery>(id: string): T | null;

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

@@ -16,7 +16,7 @@ export declare const buildTimestampFromSeconds: (seconds: number | null) => numb
 export declare const serializeBody: (body: unknown) => ArrayBuffer | URLSearchParams | Blob | FormData | string | null;
 export declare const transformMethod: (config: {
     method: Method;
-    transferVia?: 'GET' | 'POST';
+    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;

package/lib/utils/data.utils.d.ts

@@ -29,19 +29,19 @@ export interface QueryFilterConfig {
 }
 export declare const addQueryContainerHandling: (obs: Observable<AnyQuery | AnyQuery[] | null>, valueFn: () => AnyQuery | AnyQuery[] | null | undefined, config?: QueryContainerConfig) => void;
 export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>): Signal<T | undefined>;
-export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: ToSignalOptions & {
+export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | undefined>> & {
     initialValue?: undefined;
     requireSync?: false;
 } & QueryContainerConfig): Signal<T | undefined>;
-export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: ToSignalOptions & {
+export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | null>> & {
     initialValue?: null;
     requireSync?: false;
 } & QueryContainerConfig): Signal<T | null>;
-export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: ToSignalOptions & {
+export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T>> & {
     initialValue?: undefined;
     requireSync: true;
 } & QueryContainerConfig): Signal<T>;
-export declare function toQuerySignal<T extends AnyQuery | null, const U extends T>(source: Observable<T> | Subscribable<T>, options: ToSignalOptions & {
+export declare function toQuerySignal<T extends AnyQuery | null, const U extends T>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | U>> & {
     initialValue: U;
     requireSync?: false;
 } & QueryContainerConfig): Signal<T | U>;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ethlete/query",
-  "version": "5.16.1",
+  "version": "5.17.0",
   "peerDependencies": {
-    "@angular/common": "18.0.6",
-    "@angular/core": "18.0.6",
-    "@angular/forms": "18.0.6",
-    "@angular/router": "18.0.6",
+    "@angular/common": "^18.1.0",
+    "@angular/core": "^18.1.0",
+    "@angular/forms": "^18.1.0",
+    "@angular/router": "^18.1.0",
     "@ethlete/core": "^4.0.3",
     "@ethlete/types": "^1.6.2",
     "rxjs": "^7.8.1"