@ethlete/query 5.42.0 → 5.43.0
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/CHANGELOG.md +14 -0
- package/fesm2022/ethlete-query.mjs +40 -42
- package/fesm2022/ethlete-query.mjs.map +1 -1
- package/generators/migrate-to-query-v3/migration.js +1210 -4
- package/index.d.ts +23 -15
- package/package.json +6 -6
package/index.d.ts
CHANGED
|
@@ -1638,7 +1638,7 @@ type CreateLegacyQueryCreatorOptions<TArgs extends QueryArgs, Response, Store ex
|
|
|
1638
1638
|
*/
|
|
1639
1639
|
entity?: QueryEntityConfig<Store, Data, Response, LegacyArgumentsOfQueryArgs<TArgs>, Id>;
|
|
1640
1640
|
};
|
|
1641
|
-
|
|
1641
|
+
type WithLegacyConfig = {
|
|
1642
1642
|
/**
|
|
1643
1643
|
* Additional configuration for this query.
|
|
1644
1644
|
*/
|
|
@@ -1648,8 +1648,8 @@ interface WithLegacyConfig {
|
|
|
1648
1648
|
*/
|
|
1649
1649
|
destroyOnResponse?: boolean;
|
|
1650
1650
|
};
|
|
1651
|
-
}
|
|
1652
|
-
type LegacyQueryPrepareFn<Arguments extends BaseArguments | undefined, Response, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id, TNewQuery extends AnyNewQuery> =
|
|
1651
|
+
};
|
|
1652
|
+
type LegacyQueryPrepareFn<Arguments extends BaseArguments | undefined, Response, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id, TNewQuery extends AnyNewQuery> = (args: Arguments & WithHeaders & WithLegacyConfig & WithInjector) => LegacyQuery<Response, Arguments, Route, Store, Data, Id, TNewQuery>;
|
|
1653
1653
|
type AnyLegacyQueryCreator = LegacyQueryCreator<any, any, any, any, any>;
|
|
1654
1654
|
/**
|
|
1655
1655
|
* Creates a legacy query creator.
|
|
@@ -1658,10 +1658,10 @@ type AnyLegacyQueryCreator = LegacyQueryCreator<any, any, any, any, any>;
|
|
|
1658
1658
|
declare class LegacyQueryCreator<TArgs extends QueryArgs, Response extends ResponseType<TArgs>, Store extends EntityStore<unknown>, Id, Data = Response> {
|
|
1659
1659
|
options: CreateLegacyQueryCreatorOptions<TArgs, Response, Store, Data, Id>;
|
|
1660
1660
|
constructor(options: CreateLegacyQueryCreatorOptions<TArgs, Response, Store, Data, Id>);
|
|
1661
|
-
prepare: LegacyQueryPrepareFn<
|
|
1662
|
-
createSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => BehaviorSubject<LegacyQuery<Response,
|
|
1663
|
-
createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => _angular_core.WritableSignal<LegacyQuery<Response,
|
|
1664
|
-
behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => BehaviorSubject<LegacyQuery<Response,
|
|
1661
|
+
prepare: LegacyQueryPrepareFn<LegacyArgumentsOfQueryArgs<TArgs>, Response, RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query$1<TArgs>>;
|
|
1662
|
+
createSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => BehaviorSubject<LegacyQuery<Response, LegacyArgumentsOfQueryArgs<TArgs>, RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query$1<TArgs>> | null>;
|
|
1663
|
+
createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => _angular_core.WritableSignal<LegacyQuery<Response, LegacyArgumentsOfQueryArgs<TArgs>, RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query$1<TArgs>> | null>;
|
|
1664
|
+
behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => BehaviorSubject<LegacyQuery<Response, LegacyArgumentsOfQueryArgs<TArgs>, RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query$1<TArgs>> | null>;
|
|
1665
1665
|
}
|
|
1666
1666
|
declare const createLegacyQueryCreator: <TArgs extends QueryArgs, Response extends ResponseType<TArgs>, Store extends EntityStore<unknown>, Id, Data = Response>(options: CreateLegacyQueryCreatorOptions<TArgs, Response, Store, Data, Id>) => LegacyQueryCreator<TArgs, Response, Store, Id, Data>;
|
|
1667
1667
|
|
|
@@ -2755,9 +2755,9 @@ declare function takeUntilResponse(config?: {
|
|
|
2755
2755
|
excludeNull?: boolean;
|
|
2756
2756
|
}): <T extends QueryState | null>(source: Observable<T>) => Observable<T>;
|
|
2757
2757
|
declare function filterNull(): <T>(source: Observable<T>) => Observable<OmitNull<T>>;
|
|
2758
|
-
declare function switchQueryState(): <T extends AnyQuery | null, Data extends QueryDataOf<T>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
|
|
2758
|
+
declare function switchQueryState(): <T extends AnyQuery | AnyLegacyQuery | null, Data extends QueryDataOf<T>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
|
|
2759
2759
|
declare function switchQueryCollectionState(): <T extends AnyQueryCollection | null, Data extends AnyQueryCollectionData<OmitNull<T>>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
|
|
2760
|
-
declare const resetPageOnError: <T extends AnyQuery | null | undefined, J extends QueryForm<any>>(config: ResetPageOnErrorOperatorConfig<J>) => (source: Observable<T>) => Observable<QueryState<any> | T>;
|
|
2760
|
+
declare const resetPageOnError: <T extends AnyQuery | AnyLegacyQuery | null | undefined, J extends QueryForm<any>>(config: ResetPageOnErrorOperatorConfig<J>) => (source: Observable<T>) => Observable<QueryState<any> | T>;
|
|
2761
2761
|
declare const isQueryStateLoading: (state: QueryState | null | undefined) => state is Loading;
|
|
2762
2762
|
declare const isQueryStateSuccess: (state: QueryState | null | undefined) => state is Success;
|
|
2763
2763
|
declare const isQueryStateFailure: (state: QueryState | null | undefined) => state is Failure;
|
|
@@ -2766,7 +2766,7 @@ declare const isQueryStatePrepared: (state: QueryState | null | undefined) => st
|
|
|
2766
2766
|
declare const isAutoRefresh: (state: QueryState | null | undefined) => boolean;
|
|
2767
2767
|
declare const mergeHeaders: (...headers: Array<RequestHeaders | null | undefined>) => RequestHeaders | null | undefined;
|
|
2768
2768
|
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>;
|
|
2769
|
-
declare const isQuery: <T extends AnyQuery>(query: unknown) => query is T;
|
|
2769
|
+
declare const isQuery: <T extends AnyQuery | AnyLegacyQuery>(query: unknown) => query is T;
|
|
2770
2770
|
declare const isQueryCollection: <T extends AnyQueryCollection>(query: unknown) => query is T;
|
|
2771
2771
|
/**
|
|
2772
2772
|
* @deprecated Use `createQueryCollectionSubject` instead. Will be removed in v6.
|
|
@@ -2774,7 +2774,7 @@ declare const isQueryCollection: <T extends AnyQueryCollection>(query: unknown)
|
|
|
2774
2774
|
declare const createQueryCollection: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T) => BehaviorSubject<R | null>;
|
|
2775
2775
|
declare const createQueryCollectionSubject: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T, config?: QueryContainerConfig) => BehaviorSubject<R | null>;
|
|
2776
2776
|
declare const createQueryCollectionSignal: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T, config?: QueryContainerConfig) => _angular_core.WritableSignal<R | null>;
|
|
2777
|
-
declare const extractQuery: <T extends AnyQuery | AnyLegacyQuery | AnyQueryCollection | null>(v: T) =>
|
|
2777
|
+
declare const extractQuery: <T extends AnyQuery | AnyLegacyQuery | AnyQueryCollection | null>(v: T) => Query<any, any, any, any, any, any> | (T & AnyLegacyQuery) | LegacyQuery<any, LegacyArgumentsOfQueryArgs<any>, `/${string}`, any, any, any, Query$1<any>> | null;
|
|
2778
2778
|
declare const getDefaultHeaders: (headers: RequestHeaders | RequestHeadersMethodMap | null | undefined, method: Method) => RequestHeaders;
|
|
2779
2779
|
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: {
|
|
2780
2780
|
creator: QC;
|
|
@@ -3403,6 +3403,11 @@ interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator | AnyLegacyQu
|
|
|
3403
3403
|
* The args that will be merged with the page arg.
|
|
3404
3404
|
*/
|
|
3405
3405
|
defaultArgs?: Arguments & WithHeaders;
|
|
3406
|
+
/**
|
|
3407
|
+
* Enables or disables the infinite query functionality.
|
|
3408
|
+
* @default true
|
|
3409
|
+
*/
|
|
3410
|
+
enabled?: boolean;
|
|
3406
3411
|
pageParam?: {
|
|
3407
3412
|
/**
|
|
3408
3413
|
* The location where the page param is in request.
|
|
@@ -3508,7 +3513,7 @@ declare class InfinityQuery<QueryCreator extends AnyQueryCreator | AnyLegacyQuer
|
|
|
3508
3513
|
declare const createInfinityQueryConfig: <QueryCreator extends AnyQueryCreator | AnyLegacyQueryCreator, Args extends QueryArgsOf<QueryCreator>, QueryResponse extends QueryDataOf<QueryCreator>, InfinityResponse extends unknown[]>(config: InfinityQueryConfig<QueryCreator, Args, QueryResponse, InfinityResponse>) => InfinityQueryConfig<QueryCreator, Args, QueryResponse, InfinityResponse>;
|
|
3509
3514
|
declare const skipPaginationPageParamCalculator: ({ page, itemsPerPage }: PageParamCalculatorOptions) => number;
|
|
3510
3515
|
|
|
3511
|
-
interface InfinityQueryContext<Q extends InfinityQueryConfig<
|
|
3516
|
+
interface InfinityQueryContext<Q extends InfinityQueryConfig<DirectiveQueryCreator, BaseArguments | undefined, any, unknown[]>> {
|
|
3512
3517
|
$implicit: Q['response']['arrayType'] | null;
|
|
3513
3518
|
etInfinityQuery: Q['response']['arrayType'] | null;
|
|
3514
3519
|
loading: boolean;
|
|
@@ -3522,7 +3527,8 @@ interface InfinityQueryContext<Q extends InfinityQueryConfig<AnyQueryCreator, Ba
|
|
|
3522
3527
|
currentQuery: ConstructQuery<Q['queryCreator']> | null;
|
|
3523
3528
|
}
|
|
3524
3529
|
declare const INFINITY_QUERY_TOKEN: InjectionToken<InfinityQueryDirective<any>>;
|
|
3525
|
-
|
|
3530
|
+
type DirectiveQueryCreator = AnyQueryCreator | AnyLegacyQueryCreator;
|
|
3531
|
+
declare class InfinityQueryDirective<Q extends InfinityQueryConfig<DirectiveQueryCreator, BaseArguments | undefined, any, unknown[]>> {
|
|
3526
3532
|
private readonly _queryConfigChanged$;
|
|
3527
3533
|
private readonly _viewContext;
|
|
3528
3534
|
private _infinityQueryInstance;
|
|
@@ -3540,7 +3546,7 @@ declare class InfinityQueryDirective<Q extends InfinityQueryConfig<AnyQueryCreat
|
|
|
3540
3546
|
get instance(): InfinityQueryOf<Q> | null;
|
|
3541
3547
|
get data$(): rxjs.Observable<Q["response"]["arrayType"]>;
|
|
3542
3548
|
data: _angular_core.Signal<Q["response"]["arrayType"]>;
|
|
3543
|
-
static ngTemplateContextGuard<Q extends InfinityQueryConfig<
|
|
3549
|
+
static ngTemplateContextGuard<Q extends InfinityQueryConfig<DirectiveQueryCreator, BaseArguments | undefined, any, unknown[]>>(dir: InfinityQueryDirective<Q>, ctx: unknown): ctx is InfinityQueryContext<Q>;
|
|
3544
3550
|
constructor();
|
|
3545
3551
|
private _setupInfinityQuery;
|
|
3546
3552
|
loadNextPage(): void;
|
|
@@ -3557,11 +3563,13 @@ declare class InfinityQueryTriggerDirective implements OnInit, OnDestroy {
|
|
|
3557
3563
|
private _observer;
|
|
3558
3564
|
click$: rxjs.Observable<unknown>;
|
|
3559
3565
|
scrollContainerSelector: string | null;
|
|
3566
|
+
infinityQueryOverride: _angular_core.InputSignal<InfinityQueryDirective<any> | null>;
|
|
3567
|
+
infinityQuery: _angular_core.Signal<InfinityQueryDirective<any>>;
|
|
3560
3568
|
ngOnInit(): void;
|
|
3561
3569
|
ngOnDestroy(): void;
|
|
3562
3570
|
private _setupIntersectionObserver;
|
|
3563
3571
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<InfinityQueryTriggerDirective, never>;
|
|
3564
|
-
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<InfinityQueryTriggerDirective, "[etInfinityQueryTrigger], et-infinity-query-trigger", never, { "scrollContainerSelector": { "alias": "scrollContainerSelector"; "required": false; }; }, {}, never, never, true, never>;
|
|
3572
|
+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<InfinityQueryTriggerDirective, "[etInfinityQueryTrigger], et-infinity-query-trigger", never, { "scrollContainerSelector": { "alias": "scrollContainerSelector"; "required": false; }; "infinityQueryOverride": { "alias": "infinityQueryOverride"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
3565
3573
|
}
|
|
3566
3574
|
|
|
3567
3575
|
declare const buildErrorMessage: (code: string, message: string) => string;
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ethlete/query",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.43.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"peerDependencies": {
|
|
7
|
-
"@angular/common": "20.3.
|
|
8
|
-
"@angular/core": "20.3.
|
|
9
|
-
"@angular/forms": "20.3.
|
|
10
|
-
"@angular/router": "20.3.
|
|
7
|
+
"@angular/common": "20.3.6",
|
|
8
|
+
"@angular/core": "20.3.6",
|
|
9
|
+
"@angular/forms": "20.3.6",
|
|
10
|
+
"@angular/router": "20.3.6",
|
|
11
11
|
"@ethlete/core": "^4.0.3",
|
|
12
12
|
"@ethlete/types": "^1.6.2",
|
|
13
|
-
"@nx/devkit": "21.6.
|
|
13
|
+
"@nx/devkit": "21.6.5",
|
|
14
14
|
"rxjs": "7.8.2",
|
|
15
15
|
"socket.io-client": "4.8.1",
|
|
16
16
|
"typescript": "5.9.3"
|