@ethlete/query 4.14.0 → 4.16.0

package/lib/devtools/components/query-devtools/query-devtools.component.d.ts

@@ -28,6 +28,7 @@ export declare class QueryDevtoolsComponent {
     private readonly _queries$;
     protected readonly queries: import("@angular/core").Signal<AnyQuery[] | undefined>;
     protected readonly selectedQuery: import("@angular/core").Signal<AnyQuery | null>;
+    protected readonly selectedQuery$: import("rxjs").Observable<AnyQuery | null>;
     protected selectedQueryEntityStore: import("@angular/core").Signal<EntityStore<unknown> | null>;
     protected readonly selectedQueryEntityStore$: import("rxjs").Observable<EntityStore<unknown> | null>;
     protected readonly selectedQueryEntityStoreValue$: import("rxjs").Observable<Record<string, unknown> | null>;

package/lib/infinite-query/infinity-query.d.ts

@@ -18,7 +18,7 @@ export declare class InfinityQuery<QueryCreator extends AnyQueryCreator, Query e
     get itemsPerPage$(): import("rxjs").Observable<number>;
     get itemsPerPage(): number;
     get data$(): import("rxjs").Observable<InfinityResponse>;
-    get currentQuery$(): import("rxjs").Observable<Query>;
+    get currentQuery$(): import("rxjs").Observable<Query | null>;
     constructor(_config: InfinityQueryConfig<QueryCreator, Args, QueryResponse, InfinityResponse>);
     nextPage(): void;
     reset(newConfig?: Omit<InfinityQueryConfig<QueryCreator, Args, QueryResponse, InfinityResponse>, 'queryCreator' | 'response'>): void;

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.d.ts

@@ -1,8 +1,9 @@
+import { BehaviorSubject } from 'rxjs';
 import { EntityStore } from '../entity';
 import { QueryClient } from '../query-client';
 import { QueryStore } from '../query-store';
 import { BaseArguments, GqlQueryConfig, RestQueryConfig, RouteType } from '../query/query.types';
-import { QueryContainerConfig, QuerySubject } from '../utils';
+import { QueryContainerConfig } from '../utils';
 import { QueryPrepareFn } from './query-creator.types';
 export declare class QueryCreator<Arguments extends BaseArguments | undefined, Response, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> {
     private _queryConfig;
@@ -10,10 +11,10 @@ export declare class QueryCreator<Arguments extends BaseArguments | undefined, R
     private _store;
     constructor(_queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, _client: QueryClient, _store: QueryStore);
     prepare: QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>;
-    createSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => QuerySubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
+    createSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => BehaviorSubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
     createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => import("@angular/core").WritableSignal<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
     /**
      * @deprecated Use `myQuery.createSubject()` or `myQuery.createSignal()` instead. Will be removed in v5.
      */
-    behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => QuerySubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
+    behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null) => BehaviorSubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
 }

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/lib/utils/data.utils.d.ts

@@ -1,15 +1,29 @@
-import { BehaviorSubject } from 'rxjs';
+import { Signal } from '@angular/core';
+import { ToObservableOptions, ToSignalOptions } from '@angular/core/rxjs-interop';
+import { Observable, Subscribable } from 'rxjs';
 import { AnyQuery } from '../query';
 export interface QueryContainerConfig {
     /**
      * If `true`, the previous query will be aborted when a new query is pushed into the container.
-     * @default false
+     * @default true // Only if the request can be cached (GET, OPTIONS, HEAD and GQL_QUERY). Otherwise false.
      */
     abortPrevious?: boolean;
+    /**
+     * If `true`, the query will be aborted when the container is destroyed.
+     * @default true // Only if the request can be cached (GET, OPTIONS, HEAD and GQL_QUERY). Otherwise false.
+     */
+    abortOnDestroy?: boolean;
 }
-export declare class QuerySubject<T extends AnyQuery | null> extends BehaviorSubject<T> {
-    private _config?;
-    constructor(initialValue?: T, _config?: QueryContainerConfig | undefined);
-    next(value: T): void;
-}
-export declare const querySignal: <T extends AnyQuery | null>(initialValue?: T, config?: QueryContainerConfig) => import("@angular/core").WritableSignal<T>;
+export declare const addQueryContainerHandling: (obs: Observable<AnyQuery | null>, valueFn: () => 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<undefined> & {
+    requireSync?: false;
+} & QueryContainerConfig): Signal<T | undefined>;
+export declare function toQuerySignal<T extends AnyQuery | null, U extends T | null | undefined>(source: Observable<T> | Subscribable<T>, options: ToSignalOptions<U> & {
+    initialValue: U;
+    requireSync?: false;
+} & QueryContainerConfig): Signal<T | U>;
+export declare function toQuerySignal<T extends AnyQuery | null>(source: Observable<T> | Subscribable<T>, options: ToSignalOptions<undefined> & {
+    requireSync: true;
+} & QueryContainerConfig): Signal<T>;
+export declare function toQuerySubject<T extends AnyQuery | null>(source: Signal<T>, options?: ToObservableOptions & QueryContainerConfig): Observable<T>;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "4.14.0",
+  "version": "4.16.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1 || ^16.0.0",
     "@angular/core": "^15.2.1 || ^16.0.0",
-    "@ethlete/core": "3.7.0"
+    "@ethlete/core": "3.8.0"
   },
   "module": "fesm2022/ethlete-query.mjs",
   "typings": "index.d.ts",