@ethlete/query 6.0.0-next.23 → 6.0.0-next.24
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 +45 -0
- package/fesm2022/ethlete-query.mjs +1333 -117
- package/fesm2022/ethlete-query.mjs.map +1 -1
- package/generators/deprecate-legacy-queries/migration.js +77 -0
- package/generators/deprecate-legacy-queries/schema.json +26 -0
- package/generators/generators.json +5 -0
- package/generators/migrate-to-query-v3/legacy-prepare-migration.js +111 -18
- package/generators/migrate-to-query-v3/legacy-query-creator-migration.js +2 -2
- package/generators/migrate-to-query-v3/shared.js +43 -0
- package/package.json +1 -1
- package/types/ethlete-query.d.ts +1187 -15
package/types/ethlete-query.d.ts
CHANGED
|
@@ -13,6 +13,33 @@ import * as _angular_forms from '@angular/forms';
|
|
|
13
13
|
import { FormControl, FormGroup } from '@angular/forms';
|
|
14
14
|
import { ToObservableOptions, ToSignalOptions } from '@angular/core/rxjs-interop';
|
|
15
15
|
|
|
16
|
+
/**
|
|
17
|
+
* One configured option of a feature, as the devtools render it (`interval · 5s`). Values are
|
|
18
|
+
* pre-rendered strings so the panel never has to know a feature's option shape.
|
|
19
|
+
*/
|
|
20
|
+
type QueryDevtoolsFeatureDetail = {
|
|
21
|
+
label: string;
|
|
22
|
+
value: string;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* A feature applied to a query, stack or auth provider, together with how it was configured. `type`
|
|
26
|
+
* is the feature's `*_FEATURE_TYPE` constant (`WITH_POLLING`, `PERSISTENT_AUTH`, …).
|
|
27
|
+
*/
|
|
28
|
+
type QueryDevtoolsFeature = {
|
|
29
|
+
type: string;
|
|
30
|
+
details: QueryDevtoolsFeatureDetail[];
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Describes how a feature was configured. Only ever called while building a devtools entry, so a
|
|
34
|
+
* feature may render whatever it needs to here without paying for it when devtools are off.
|
|
35
|
+
*/
|
|
36
|
+
type QueryDevtoolsFeatureDescriber = () => QueryDevtoolsFeatureDetail[];
|
|
37
|
+
/** A feature as the devtools read it: its type plus its optional self-description. */
|
|
38
|
+
type DescribableFeature = {
|
|
39
|
+
type: string;
|
|
40
|
+
devtools?: QueryDevtoolsFeatureDescriber;
|
|
41
|
+
};
|
|
42
|
+
|
|
16
43
|
/**
|
|
17
44
|
* Route building, query-string serialization and the token clock - shared by the current generation and
|
|
18
45
|
* the legacy V2 client, which re-exports them under their original names.
|
|
@@ -199,6 +226,22 @@ declare const circularQueryDependencyChecker: () => {
|
|
|
199
226
|
check: () => void;
|
|
200
227
|
};
|
|
201
228
|
|
|
229
|
+
/**
|
|
230
|
+
* Why a batch of in-use entries was refreshed. The answer to "why did this refetch?", which the query
|
|
231
|
+
* devtools spell out per query - the entries themselves only ever see a forced execution.
|
|
232
|
+
*/
|
|
233
|
+
type QueryRefreshCause = {
|
|
234
|
+
/**
|
|
235
|
+
* - `refresh` - {@link QueryClient.refreshQueriesInUse}, which narrows nothing.
|
|
236
|
+
* - `invalidation` - {@link QueryClient.invalidateQueries}.
|
|
237
|
+
* - `mutation` - the multi-tab sync engine reacting to a mutation another tab made.
|
|
238
|
+
*/
|
|
239
|
+
type: 'refresh' | 'invalidation' | 'mutation';
|
|
240
|
+
/** The URL the refresh was narrowed to (an invalidation's scope, a mutation's URL), or `null`. */
|
|
241
|
+
url: string | null;
|
|
242
|
+
/** Whether another tab asked for it rather than this one. */
|
|
243
|
+
otherTab: boolean;
|
|
244
|
+
};
|
|
202
245
|
type QueryRepositoryEvent = {
|
|
203
246
|
type: 'request-error';
|
|
204
247
|
error: HttpErrorResponse;
|
|
@@ -241,6 +284,16 @@ type QueryRepositoryEvent = {
|
|
|
241
284
|
isCached: boolean;
|
|
242
285
|
/** @see QueryRepositoryEvent.isPersistEnabled */
|
|
243
286
|
isPersistEnabled: boolean;
|
|
287
|
+
} | {
|
|
288
|
+
/**
|
|
289
|
+
* A batch of in-use entries was re-executed at once. Emitted for every
|
|
290
|
+
* {@link QueryRepository.refreshInUse} call, including one that matched nothing - "the
|
|
291
|
+
* invalidation ran and hit no query" is an answer too.
|
|
292
|
+
*/
|
|
293
|
+
type: 'queries-refreshed';
|
|
294
|
+
cause: QueryRefreshCause;
|
|
295
|
+
/** The requests that were re-executed, in cache order. */
|
|
296
|
+
requests: HttpRequest<QueryArgs>[];
|
|
244
297
|
} | {
|
|
245
298
|
/**
|
|
246
299
|
* Every secure entry was torn down at once - a logout. Emitted after the cache is cleared so
|
|
@@ -282,6 +335,12 @@ type QueryRepositoryItem<TArgs extends QueryArgs> = {
|
|
|
282
335
|
key: QueryKey;
|
|
283
336
|
/** The request object */
|
|
284
337
|
request: HttpRequest<TArgs>;
|
|
338
|
+
/**
|
|
339
|
+
* Whether this call started a network request. `false` when a fresh cache entry answered it, or when
|
|
340
|
+
* an identical request was already in flight - the consumer is bound to that request either way and
|
|
341
|
+
* still gets its response.
|
|
342
|
+
*/
|
|
343
|
+
executed: boolean;
|
|
285
344
|
};
|
|
286
345
|
/**
|
|
287
346
|
* A read-only snapshot of a single cache entry, exposed via {@link QueryRepositorySubtle.cacheEntries}
|
|
@@ -362,11 +421,12 @@ type QueryRepository = {
|
|
|
362
421
|
* in-flight requests. Entries kept only for their `keepUnusedFor` window are skipped - nobody is
|
|
363
422
|
* looking at them, and they revalidate on their own when a consumer binds again.
|
|
364
423
|
*
|
|
365
|
-
* Pass a filter to narrow it down to a subset of those entries
|
|
424
|
+
* Pass a filter to narrow it down to a subset of those entries, and a cause to describe what asked
|
|
425
|
+
* for it - which is what the devtools report as the reason a query refetched.
|
|
366
426
|
*
|
|
367
427
|
* @see QueryClient.refreshQueriesInUse
|
|
368
428
|
*/
|
|
369
|
-
refreshInUse: (filter?: QueryRepositoryRefreshFilterFn) => void;
|
|
429
|
+
refreshInUse: (filter?: QueryRepositoryRefreshFilterFn, cause?: QueryRefreshCause) => void;
|
|
370
430
|
/**
|
|
371
431
|
* Writes a response that another tab received onto the matching cache entry, so the same query
|
|
372
432
|
* shows the same data everywhere without a second network request.
|
|
@@ -435,8 +495,168 @@ declare const DEFAULT_KEEP_UNUSED_FOR = 300000;
|
|
|
435
495
|
declare const MAX_UNUSED_ENTRIES = 50;
|
|
436
496
|
declare const createQueryRepository: (config: CreateQueryRepositoryConfig) => QueryRepository;
|
|
437
497
|
|
|
498
|
+
/** Which query forms a query reads while it builds its args. */
|
|
499
|
+
type QueryDevtoolsFormLinksHandle = {
|
|
500
|
+
/**
|
|
501
|
+
* The devtools ids of the query forms this query's args have read. Empty for a query whose args read
|
|
502
|
+
* none.
|
|
503
|
+
*
|
|
504
|
+
* Accumulates rather than being rebuilt per evaluation: a form's `value` is a memoized signal, so an
|
|
505
|
+
* args build that re-runs for an unrelated reason reads the cached value without going through the
|
|
506
|
+
* form again. Dropping the id there would make the link flicker; a form that a conditional branch
|
|
507
|
+
* stops reading keeps its link until the query is recreated instead.
|
|
508
|
+
*/
|
|
509
|
+
ids: Signal<readonly string[]>;
|
|
510
|
+
};
|
|
511
|
+
/** The write side, used by the code that evaluates a query's args. */
|
|
512
|
+
type QueryDevtoolsFormLinksRecorder = QueryDevtoolsFormLinksHandle & {
|
|
513
|
+
/** Runs `build`, recording every query form whose value it reads. */
|
|
514
|
+
track: <T>(build: () => T) => T;
|
|
515
|
+
};
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* What a query did over its lifetime, as the devtools panel accounts for it: how often it ran, how many
|
|
519
|
+
* of those runs reached the network, and how much payload they moved.
|
|
520
|
+
*/
|
|
521
|
+
type QueryDevtoolsStats = {
|
|
522
|
+
/** How often the query executed, whether or not that reached the network. */
|
|
523
|
+
executions: number;
|
|
524
|
+
/**
|
|
525
|
+
* How many of those executions started a request. The remainder were answered by a fresh cache entry
|
|
526
|
+
* or joined a request that was already in flight.
|
|
527
|
+
*/
|
|
528
|
+
requests: number;
|
|
529
|
+
/** How many responses arrived over the network. */
|
|
530
|
+
responses: number;
|
|
531
|
+
/** How many requests failed. */
|
|
532
|
+
errors: number;
|
|
533
|
+
/**
|
|
534
|
+
* How many attempts the retry policy added on top of the first one. A request that succeeded on its
|
|
535
|
+
* third attempt counts two.
|
|
536
|
+
*/
|
|
537
|
+
retries: number;
|
|
538
|
+
/** The total size of every response body received. */
|
|
539
|
+
receivedBytes: number;
|
|
540
|
+
/** The total size of every request body sent. */
|
|
541
|
+
sentBytes: number;
|
|
542
|
+
/**
|
|
543
|
+
* Whether any byte count had to be measured from a body instead of read from a `content-length`
|
|
544
|
+
* header. A serialized body is the decoded payload, so it does not account for transport compression -
|
|
545
|
+
* the real transfer was probably smaller.
|
|
546
|
+
*/
|
|
547
|
+
hasEstimatedBytes: boolean;
|
|
548
|
+
/** When the query executed for the first time. */
|
|
549
|
+
firstExecutedAt: number | null;
|
|
550
|
+
/** When its last response arrived. */
|
|
551
|
+
lastResponseAt: number | null;
|
|
552
|
+
/**
|
|
553
|
+
* How long the last response took, measured from the execution that preceded it - so it includes the
|
|
554
|
+
* retry delays and the queueing wall clock time, not just the round trip.
|
|
555
|
+
*/
|
|
556
|
+
lastDurationMs: number | null;
|
|
557
|
+
/** The sum of every response's duration, which together with {@link responses} gives the average. */
|
|
558
|
+
totalDurationMs: number;
|
|
559
|
+
};
|
|
560
|
+
/** A payload whose transferred size is to be measured, plus the headers it came with (if any). */
|
|
561
|
+
type QueryDevtoolsPayload = {
|
|
562
|
+
headers?: HttpHeaders | null;
|
|
563
|
+
body: unknown;
|
|
564
|
+
};
|
|
565
|
+
/**
|
|
566
|
+
* How one run of a query ended. `aborted` is a run whose query started another request before the
|
|
567
|
+
* response arrived - the previous request's events are unbound at that point, so the response it was
|
|
568
|
+
* waiting for can no longer reach it.
|
|
569
|
+
*/
|
|
570
|
+
type QueryDevtoolsRunStatus = 'pending' | 'success' | 'error' | 'aborted';
|
|
571
|
+
/**
|
|
572
|
+
* A single run of a query, kept alongside the running totals so overlapping runs stay tellable apart -
|
|
573
|
+
* which is what turns "ran 40 times" into "ran 40 times in two seconds".
|
|
574
|
+
*/
|
|
575
|
+
type QueryDevtoolsRun = {
|
|
576
|
+
/**
|
|
577
|
+
* Position in the query's lifetime, 1-based. Keeps climbing past the runs the buffer has dropped, so
|
|
578
|
+
* it is a stable identity as well as a run number.
|
|
579
|
+
*/
|
|
580
|
+
index: number;
|
|
581
|
+
startedAt: number;
|
|
582
|
+
/** When the run ended, or `null` while it is still in flight. */
|
|
583
|
+
endedAt: number | null;
|
|
584
|
+
status: QueryDevtoolsRunStatus;
|
|
585
|
+
/**
|
|
586
|
+
* Whether this run is a request of the query's own. A response that arrives without one was produced
|
|
587
|
+
* by something else - a poll, another consumer of the same cache entry, another tab - and is recorded
|
|
588
|
+
* as an instant, since only its arrival time is knowable.
|
|
589
|
+
*/
|
|
590
|
+
didRequest: boolean;
|
|
591
|
+
/**
|
|
592
|
+
* The URL this run went to. Kept per run rather than read off the query: a query whose args changed
|
|
593
|
+
* between runs would otherwise label every older run with the URL it happens to hold now.
|
|
594
|
+
*/
|
|
595
|
+
url: string | null;
|
|
596
|
+
/**
|
|
597
|
+
* How many HTTP attempts this run took - 1 unless the retry policy fired, and 0 for a run that made no
|
|
598
|
+
* request of its own. Which is what tells a slow response apart from one that was retried into place.
|
|
599
|
+
*/
|
|
600
|
+
attempts: number;
|
|
601
|
+
/** The size of the request body this run sent. */
|
|
602
|
+
sentBytes: number;
|
|
603
|
+
/** The size of the response body it received, or 0 until one has. */
|
|
604
|
+
receivedBytes: number;
|
|
605
|
+
/**
|
|
606
|
+
* The response body, so one run can be diffed against another. Only the newest few runs keep theirs -
|
|
607
|
+
* a polling query would otherwise retain every response it ever received.
|
|
608
|
+
*/
|
|
609
|
+
response: unknown;
|
|
610
|
+
/** Whether {@link response} still holds this run's body; a dropped and an empty body both read `null`. */
|
|
611
|
+
hasResponse: boolean;
|
|
612
|
+
};
|
|
613
|
+
/** The read side of a stats recorder, as a {@link QueryDevtoolsEntry} exposes it to the panel. */
|
|
614
|
+
type QueryDevtoolsStatsHandle = {
|
|
615
|
+
/** The live stats. */
|
|
616
|
+
current: Signal<QueryDevtoolsStats>;
|
|
617
|
+
/** The query's most recent runs, oldest first. Bounded - older runs are dropped as new ones arrive. */
|
|
618
|
+
runs: Signal<readonly QueryDevtoolsRun[]>;
|
|
619
|
+
/** Clears every counter, so a measurement can be scoped to a single interaction. */
|
|
620
|
+
reset: () => void;
|
|
621
|
+
};
|
|
622
|
+
/** The write side, used by the instrumentation inside the query itself. */
|
|
623
|
+
type QueryDevtoolsStatsRecorder = QueryDevtoolsStatsHandle & {
|
|
624
|
+
recordExecution: (options: {
|
|
625
|
+
/** Whether the execution started a request, as reported by the repository. */
|
|
626
|
+
didRequest: boolean;
|
|
627
|
+
/** The request body it sent, for the outgoing byte count. */
|
|
628
|
+
body?: unknown;
|
|
629
|
+
/** The URL it went to. @see QueryDevtoolsRun.url */
|
|
630
|
+
url?: string;
|
|
631
|
+
}) => void;
|
|
632
|
+
recordResponse: (payload: QueryDevtoolsPayload) => void;
|
|
633
|
+
recordError: () => void;
|
|
634
|
+
/**
|
|
635
|
+
* Raises the attempt count of the run in flight. Idempotent per attempt, so a caller driven off a
|
|
636
|
+
* signal may report the same attempt more than once without inflating {@link QueryDevtoolsStats.retries}.
|
|
637
|
+
*/
|
|
638
|
+
recordRetry: (options: {
|
|
639
|
+
attempt: number;
|
|
640
|
+
}) => void;
|
|
641
|
+
};
|
|
642
|
+
/**
|
|
643
|
+
* Adds up the stats of several entries, for a stack's or a client's total. `lastDurationMs` is taken from
|
|
644
|
+
* whichever entry responded most recently rather than summed.
|
|
645
|
+
*/
|
|
646
|
+
declare const sumQueryDevtoolsStats: (handles: readonly (QueryDevtoolsStatsHandle | undefined)[]) => QueryDevtoolsStats;
|
|
647
|
+
|
|
438
648
|
type SetupQueryStateOptions<TArgs extends QueryArgs> = {
|
|
439
649
|
transformResponse?: (rawResponse: RawResponseType<TArgs>) => ResponseType<TArgs>;
|
|
650
|
+
/**
|
|
651
|
+
* The devtools stats recorder to feed from this state's executions, or nothing when the devtools are
|
|
652
|
+
* not installed.
|
|
653
|
+
*/
|
|
654
|
+
devtoolsStats?: QueryDevtoolsStatsRecorder | null;
|
|
655
|
+
/**
|
|
656
|
+
* The recorder that notes which query forms the args source reads, or nothing when the devtools are
|
|
657
|
+
* not installed.
|
|
658
|
+
*/
|
|
659
|
+
devtoolsFormLinks?: QueryDevtoolsFormLinksRecorder | null;
|
|
440
660
|
};
|
|
441
661
|
type QueryStateSubtle<TArgs extends QueryArgs> = {
|
|
442
662
|
request: WritableSignal<HttpRequest<TArgs> | null>;
|
|
@@ -453,6 +673,10 @@ type QueryStateSubtle<TArgs extends QueryArgs> = {
|
|
|
453
673
|
* default source returns `null`.
|
|
454
674
|
*/
|
|
455
675
|
setArgsSource: (source: () => RequestArgs<TArgs> | null) => void;
|
|
676
|
+
/** @see SetupQueryStateOptions.devtoolsStats */
|
|
677
|
+
devtoolsStats: QueryDevtoolsStatsRecorder | null;
|
|
678
|
+
/** @see SetupQueryStateOptions.devtoolsFormLinks */
|
|
679
|
+
devtoolsFormLinks: QueryDevtoolsFormLinksRecorder | null;
|
|
456
680
|
};
|
|
457
681
|
type QueryState<TArgs extends QueryArgs> = {
|
|
458
682
|
rawResponse: WritableSignal<RawResponseType<TArgs> | null>;
|
|
@@ -556,10 +780,13 @@ type QueryFeatureFn<TArgs extends QueryArgs> = (context: QueryFeatureContext<TAr
|
|
|
556
780
|
type QueryFeature<TArgs extends QueryArgs> = {
|
|
557
781
|
type: QueryFeatureType;
|
|
558
782
|
fn: (context: QueryFeatureContext<TArgs>) => void;
|
|
783
|
+
/** How the feature was configured, for the devtools. Only called while devtools are enabled. */
|
|
784
|
+
devtools?: QueryDevtoolsFeatureDescriber;
|
|
559
785
|
};
|
|
560
786
|
declare const createQueryFeature: <TArgs extends QueryArgs>(config: {
|
|
561
787
|
type: QueryFeatureType;
|
|
562
788
|
fn: QueryFeatureFn<TArgs>;
|
|
789
|
+
devtools?: QueryDevtoolsFeatureDescriber;
|
|
563
790
|
}) => QueryFeature<TArgs>;
|
|
564
791
|
/**
|
|
565
792
|
* A query feature that allows you to set the arguments of the query.
|
|
@@ -851,6 +1078,17 @@ type QueryCreator<TArgs extends QueryArgs> = {
|
|
|
851
1078
|
* ```
|
|
852
1079
|
*/
|
|
853
1080
|
clone: (additionalOptions: Partial<BaseQueryCreatorOptions<TArgs>>) => QueryCreator<TArgs>;
|
|
1081
|
+
/**
|
|
1082
|
+
* What the creator was built with - `route`, `method` and the client for an HTTP creator, the
|
|
1083
|
+
* GraphQL document for a GraphQL one.
|
|
1084
|
+
*
|
|
1085
|
+
* Advanced: for tooling that has to describe a query (the devtools' Insomnia export builds an auth
|
|
1086
|
+
* provider's token-refresh request from it) without instantiating one.
|
|
1087
|
+
*/
|
|
1088
|
+
subtle: {
|
|
1089
|
+
creatorInternals: Record<string, unknown>;
|
|
1090
|
+
creatorOptions: Record<string, unknown> | undefined;
|
|
1091
|
+
};
|
|
854
1092
|
};
|
|
855
1093
|
type AnyQueryCreator = QueryCreator<any>;
|
|
856
1094
|
type QueryArgsOf<T extends AnyQueryCreator | AnyNewQuery> = T extends QueryCreator<infer TArgs> ? TArgs : T extends Query<infer TArgs> ? TArgs : never;
|
|
@@ -1425,10 +1663,14 @@ type QueryClientFeatureContext = {
|
|
|
1425
1663
|
type QueryClientMultiTabSyncFeature = {
|
|
1426
1664
|
type: typeof QueryClientFeatureType.MULTI_TAB_SYNC;
|
|
1427
1665
|
instance: QuerySyncEngine | null;
|
|
1666
|
+
/** How the feature was configured, for the devtools. Only called while devtools are enabled. */
|
|
1667
|
+
devtools?: QueryDevtoolsFeatureDescriber;
|
|
1428
1668
|
};
|
|
1429
1669
|
type QueryClientPersistenceFeature = {
|
|
1430
1670
|
type: typeof QueryClientFeatureType.PERSISTENCE;
|
|
1431
1671
|
instance: QueryPersistenceEngine | null;
|
|
1672
|
+
/** How the feature was configured, for the devtools. Only called while devtools are enabled. */
|
|
1673
|
+
devtools?: QueryDevtoolsFeatureDescriber;
|
|
1432
1674
|
};
|
|
1433
1675
|
/**
|
|
1434
1676
|
* A feature that only installs error-pipeline behavior. It has no per-client instance: how an error
|
|
@@ -1664,6 +1906,11 @@ type QueryClientSubtle = {
|
|
|
1664
1906
|
* feature (or runs on the server).
|
|
1665
1907
|
*/
|
|
1666
1908
|
persistence: QueryPersistenceEngine | null;
|
|
1909
|
+
/**
|
|
1910
|
+
* The client's features and the options each was configured with, for the devtools panel. Empty
|
|
1911
|
+
* unless `provideQueryDevtools()` is used.
|
|
1912
|
+
*/
|
|
1913
|
+
devtoolsFeatures: QueryDevtoolsFeature[];
|
|
1667
1914
|
};
|
|
1668
1915
|
type QueryClient = {
|
|
1669
1916
|
repository: QueryRepository;
|
|
@@ -1761,6 +2008,8 @@ type CreateHttpRequestOptions<TArgs extends QueryArgs> = {
|
|
|
1761
2008
|
dependencies: QueryRepositoryDependencies;
|
|
1762
2009
|
/** The client options of the request */
|
|
1763
2010
|
clientOptions?: CreateQueryCreatorOptions;
|
|
2011
|
+
/** Display name of the owning query client. Scopes devtools fault injection, which is armed per client. */
|
|
2012
|
+
clientName?: string;
|
|
1764
2013
|
/**
|
|
1765
2014
|
* Headers configured on the query client, applied to every request it makes. Per-request
|
|
1766
2015
|
* `args.headers` are merged on top and win per header name.
|
|
@@ -1797,6 +2046,21 @@ type HttpRequestLoadingProgressState = {
|
|
|
1797
2046
|
/** The estimated remaining time in milliseconds */
|
|
1798
2047
|
remainingTime: number | null;
|
|
1799
2048
|
};
|
|
2049
|
+
/**
|
|
2050
|
+
* A retry the request has scheduled and is waiting out. Present only during the backoff itself - the
|
|
2051
|
+
* attempt that follows clears it - which is what lets a slow request be told apart from one that is
|
|
2052
|
+
* sitting out a delay.
|
|
2053
|
+
*/
|
|
2054
|
+
type HttpRequestRetryState = {
|
|
2055
|
+
/** The attempt the backoff leads up to, 1-based: the first retry is attempt 2. */
|
|
2056
|
+
attempt: number;
|
|
2057
|
+
/** The delay the retry policy asked for, in ms. */
|
|
2058
|
+
delayMs: number;
|
|
2059
|
+
/** When the attempt starts, as a timestamp. */
|
|
2060
|
+
startsAt: number;
|
|
2061
|
+
/** The status of the response that caused the retry, or 0 when the request never reached the server. */
|
|
2062
|
+
status: number;
|
|
2063
|
+
};
|
|
1800
2064
|
/**
|
|
1801
2065
|
* Advanced request internals. **Not part of the general public contract** - do not build
|
|
1802
2066
|
* application logic on top of these.
|
|
@@ -1847,12 +2111,35 @@ type HttpRequestSubtle<TArgs extends QueryArgs> = {
|
|
|
1847
2111
|
* the query devtools to show which entries are showing data from a previous session.
|
|
1848
2112
|
*/
|
|
1849
2113
|
lastPersistedResponseAt: Signal<number | null>;
|
|
2114
|
+
/**
|
|
2115
|
+
* The headers this request sends, resolved the way an execution resolves them: the client's headers
|
|
2116
|
+
* with the per-request ones merged on top. Read by the query devtools to export a request that can be
|
|
2117
|
+
* replayed outside the app.
|
|
2118
|
+
*
|
|
2119
|
+
* Throws whatever a header provider function throws - a secure query's provider, for one, requires an
|
|
2120
|
+
* access token to be available.
|
|
2121
|
+
*/
|
|
2122
|
+
resolveHeaders: () => HttpHeaders | undefined;
|
|
2123
|
+
/**
|
|
2124
|
+
* How many HTTP attempts the current execution has made, counting from 1. Anything above that is the
|
|
2125
|
+
* retry policy having fired. Reset by the next execution, so it keeps reading `3` after a request
|
|
2126
|
+
* that took three attempts to succeed.
|
|
2127
|
+
*/
|
|
2128
|
+
attempts: Signal<number>;
|
|
2129
|
+
/** The retry currently being waited out, or `null` when none is. @see HttpRequestRetryState */
|
|
2130
|
+
retryState: Signal<HttpRequestRetryState | null>;
|
|
1850
2131
|
};
|
|
1851
2132
|
type HttpRequest<TArgs extends QueryArgs> = {
|
|
1852
2133
|
/** The HTTP method of the request. */
|
|
1853
2134
|
method: QueryMethod;
|
|
1854
2135
|
/** The full URL of the request (base + path + query params). */
|
|
1855
2136
|
url: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* The args this request was built from - the resolved path params, query params, body and headers
|
|
2139
|
+
* behind {@link HttpRequest.url}. Read by the query devtools to show what a query actually sent,
|
|
2140
|
+
* which a query executed imperatively (`execute({ args })`) does not keep on its own `args` signal.
|
|
2141
|
+
*/
|
|
2142
|
+
args: RequestArgs<TArgs> | null;
|
|
1856
2143
|
/**
|
|
1857
2144
|
* Executes the request.
|
|
1858
2145
|
*
|
|
@@ -2483,7 +2770,7 @@ declare const gqlDataPropertyMissingInResponse: () => RuntimeError<600>;
|
|
|
2483
2770
|
declare const tokensNotAvailableInsideAuthAndExec: () => RuntimeError<700>;
|
|
2484
2771
|
declare const invalidStateInsideSecureExecuteFactory: () => RuntimeError<701>;
|
|
2485
2772
|
declare const circularQueryDependency: () => RuntimeError<800>;
|
|
2486
|
-
declare const legacyPrepareWithoutInjectionContext: (creatorName: string | undefined) => RuntimeError<950>;
|
|
2773
|
+
declare const legacyPrepareWithoutInjectionContext: (creatorName: string | undefined, method?: "prepare" | "createSubject" | "createSignal") => RuntimeError<950>;
|
|
2487
2774
|
declare const querySequenceAlreadyRunning: () => RuntimeError<900>;
|
|
2488
2775
|
|
|
2489
2776
|
/** The last element of a tuple type - the response of the step a `.then()` callback follows. */
|
|
@@ -3041,6 +3328,10 @@ type InactivityLogoutFeature = {
|
|
|
3041
3328
|
declare const withInactivityLogout: <TBuilders extends readonly AnyQueryBuilder[]>(config?: InactivityLogoutConfig) => (context: BearerAuthProviderFeatureContext<unknown, TBuilders>) => {
|
|
3042
3329
|
type: "INACTIVITY_LOGOUT";
|
|
3043
3330
|
instance: InactivityLogoutFeature;
|
|
3331
|
+
devtools: () => {
|
|
3332
|
+
label: string;
|
|
3333
|
+
value: string;
|
|
3334
|
+
}[];
|
|
3044
3335
|
};
|
|
3045
3336
|
|
|
3046
3337
|
type BearerAuthMultiTabSyncConfig = {
|
|
@@ -3096,6 +3387,10 @@ type BearerAuthMultiTabSyncFeature = {
|
|
|
3096
3387
|
declare const withBearerAuthMultiTabSync: <TBuilders extends readonly AnyQueryBuilder[]>(config?: BearerAuthMultiTabSyncConfig) => ((_context: BearerAuthProviderFeatureContext<unknown, TBuilders>) => {
|
|
3097
3388
|
type: "MULTI_TAB_SYNC";
|
|
3098
3389
|
instance: BearerAuthMultiTabSyncFeature;
|
|
3390
|
+
devtools: () => {
|
|
3391
|
+
label: string;
|
|
3392
|
+
value: string;
|
|
3393
|
+
}[];
|
|
3099
3394
|
}) & {
|
|
3100
3395
|
earlySetup: (context: BearerAuthProviderEarlySetupContext) => _ethlete_query.BearerAuthProviderEarlySetupResult;
|
|
3101
3396
|
};
|
|
@@ -3177,6 +3472,10 @@ type PersistentAuthFeature = {
|
|
|
3177
3472
|
declare const withPersistentAuth: <TBuilders extends readonly AnyQueryBuilder[], TKey extends ExtractQueryKey<TBuilders[number]> = ExtractQueryKey<TBuilders[number]>>(config: PersistentAuthConfig<TBuilders, TKey>) => (context: BearerAuthProviderFeatureContext<unknown, TBuilders>) => {
|
|
3178
3473
|
type: "PERSISTENT_AUTH";
|
|
3179
3474
|
instance: PersistentAuthFeature;
|
|
3475
|
+
devtools: () => {
|
|
3476
|
+
label: string;
|
|
3477
|
+
value: string;
|
|
3478
|
+
}[];
|
|
3180
3479
|
};
|
|
3181
3480
|
declare const createPersistentAuthFeature: <TBuilders extends readonly AnyQueryBuilder[], TKey extends ExtractQueryKey<TBuilders[number]> = ExtractQueryKey<TBuilders[number]>>(config: PersistentAuthConfig<TBuilders, TKey>, context: BearerAuthProviderFeatureContext<unknown, TBuilders>) => PersistentAuthFeature;
|
|
3182
3481
|
|
|
@@ -3209,6 +3508,10 @@ type TokenExpirationWarningFeature = {
|
|
|
3209
3508
|
declare const withTokenExpirationWarning: <TBuilders extends readonly AnyQueryBuilder[]>(config?: NoInfer<TokenExpirationWarningConfig>) => (context: BearerAuthProviderFeatureContext<unknown, TBuilders>) => {
|
|
3210
3509
|
type: "TOKEN_EXPIRATION_WARNING";
|
|
3211
3510
|
instance: TokenExpirationWarningFeature;
|
|
3511
|
+
devtools: () => {
|
|
3512
|
+
label: string;
|
|
3513
|
+
value: string;
|
|
3514
|
+
}[];
|
|
3212
3515
|
};
|
|
3213
3516
|
|
|
3214
3517
|
type TokenRevocationConfig<TBuilders extends readonly AnyQueryBuilder[], TKey extends ExtractQueryKey<TBuilders[number]> = ExtractQueryKey<TBuilders[number]>> = {
|
|
@@ -3256,6 +3559,10 @@ declare const withTokenRevocation: <TBuilders extends readonly AnyQueryBuilder[]
|
|
|
3256
3559
|
instance: TokenRevocationFeature<QuerySnapshot<ExtractQueryArgs<Extract<TBuilders[number], {
|
|
3257
3560
|
key: TKey;
|
|
3258
3561
|
}>>>>;
|
|
3562
|
+
devtools: () => {
|
|
3563
|
+
label: string;
|
|
3564
|
+
value: string;
|
|
3565
|
+
}[];
|
|
3259
3566
|
};
|
|
3260
3567
|
|
|
3261
3568
|
type TrackingEventName<TBuilders extends readonly AnyQueryBuilder[]> = `${ExtractQueryKey<TBuilders[number]>}Execute` | `${ExtractQueryKey<TBuilders[number]>}Success` | `${ExtractQueryKey<TBuilders[number]>}Failure` | 'tokenRefreshSuccess' | 'logout' | 'leaderStatusChange' | 'leaderInstanceCountChange';
|
|
@@ -3313,6 +3620,10 @@ type TrackingFeature<TBuilders extends readonly AnyQueryBuilder[]> = {
|
|
|
3313
3620
|
declare const withTracking: <TBuilders extends readonly AnyQueryBuilder[]>(config?: TrackingConfig<TBuilders>) => (context: BearerAuthProviderFeatureContext<unknown, TBuilders>) => {
|
|
3314
3621
|
type: "TRACKING";
|
|
3315
3622
|
instance: TrackingFeature<TBuilders>;
|
|
3623
|
+
devtools: () => {
|
|
3624
|
+
label: string;
|
|
3625
|
+
value: string;
|
|
3626
|
+
}[];
|
|
3316
3627
|
};
|
|
3317
3628
|
declare const createTrackingFeature: <TBuilders extends readonly AnyQueryBuilder[]>(context: BearerAuthProviderFeatureContext<unknown, TBuilders>, config?: TrackingConfig<TBuilders>) => TrackingFeature<TBuilders>;
|
|
3318
3629
|
|
|
@@ -3347,6 +3658,8 @@ type BearerAuthFeatureType = (typeof BearerAuthFeatureType)[keyof typeof BearerA
|
|
|
3347
3658
|
type BearerAuthFeature<TBuilders extends readonly AnyQueryBuilder[], TBearerData> = {
|
|
3348
3659
|
type: BearerAuthFeatureType;
|
|
3349
3660
|
setup: (context: BearerAuthProviderFeatureContext<TBearerData, TBuilders>) => unknown;
|
|
3661
|
+
/** How the feature was configured, for the devtools. Only called while devtools are enabled. */
|
|
3662
|
+
devtools?: QueryDevtoolsFeatureDescriber;
|
|
3350
3663
|
};
|
|
3351
3664
|
/**
|
|
3352
3665
|
* What a feature gets before the provider's queries are wired up. Only the tokens and the client
|
|
@@ -3559,11 +3872,138 @@ type AnyBearerAuthProvider = Omit<NonNullable<ReturnType<AnyCreateBearerAuthProv
|
|
|
3559
3872
|
queries: any;
|
|
3560
3873
|
};
|
|
3561
3874
|
|
|
3875
|
+
/**
|
|
3876
|
+
* A fault armed on one query client from the devtools panel. Unlike the panel's forced states - which
|
|
3877
|
+
* write a query's signals directly - an armed fault is applied inside the request pipeline, so retries,
|
|
3878
|
+
* error handling features and the cache all see it exactly as they would see a real one.
|
|
3879
|
+
*/
|
|
3880
|
+
type QueryDevtoolsFault = {
|
|
3881
|
+
/** Extra latency in ms added before every attempt starts. `0` disables it. */
|
|
3882
|
+
latencyMs: number;
|
|
3883
|
+
/**
|
|
3884
|
+
* How many upcoming attempts fail before the client is let through again, counted down as they are
|
|
3885
|
+
* consumed. `0` disables it.
|
|
3886
|
+
*/
|
|
3887
|
+
failNext: number;
|
|
3888
|
+
/** The percentage of attempts that fail, rolled per attempt. `0` disables it, `100` fails everything. */
|
|
3889
|
+
failRate: number;
|
|
3890
|
+
/** The status an injected failure responds with. */
|
|
3891
|
+
status: number;
|
|
3892
|
+
};
|
|
3893
|
+
/** The neutral fault: nothing armed. */
|
|
3894
|
+
declare const EMPTY_QUERY_DEVTOOLS_FAULT: QueryDevtoolsFault;
|
|
3895
|
+
/**
|
|
3896
|
+
* Statuses worth injecting, and whether the SDK's default retry policy retries them. A picker built from
|
|
3897
|
+
* this cannot arm a 500 and then leave you wondering why no retry fired.
|
|
3898
|
+
* @see runDefaultQueryRetry
|
|
3899
|
+
*/
|
|
3900
|
+
declare const QUERY_DEVTOOLS_FAULT_STATUSES: {
|
|
3901
|
+
status: number;
|
|
3902
|
+
label: string;
|
|
3903
|
+
retryable: boolean;
|
|
3904
|
+
}[];
|
|
3905
|
+
/**
|
|
3906
|
+
* The faults armed per client name, consumed by the `<et-query-devtools>` UI. Clients with nothing armed
|
|
3907
|
+
* are absent rather than present with an {@link EMPTY_QUERY_DEVTOOLS_FAULT}.
|
|
3908
|
+
*/
|
|
3909
|
+
declare const queryDevtoolsFaults: Signal<Record<string, QueryDevtoolsFault>>;
|
|
3910
|
+
/** Whether anything at all is armed on a fault. */
|
|
3911
|
+
declare const isQueryDevtoolsFaultArmed: (fault: QueryDevtoolsFault) => boolean;
|
|
3912
|
+
/**
|
|
3913
|
+
* Arms (or updates) the fault of one client. Only the given fields change; the rest keep their current
|
|
3914
|
+
* value. A client whose resulting fault has nothing armed is dropped from {@link queryDevtoolsFaults}.
|
|
3915
|
+
*
|
|
3916
|
+
* Part of the devtools contract consumed by `<et-query-devtools>`; a fault is a debugging tool, not
|
|
3917
|
+
* something an application should arm on itself.
|
|
3918
|
+
*/
|
|
3919
|
+
declare const setQueryDevtoolsFault: (options: {
|
|
3920
|
+
clientName: string;
|
|
3921
|
+
patch: Partial<QueryDevtoolsFault>;
|
|
3922
|
+
}) => void;
|
|
3923
|
+
/**
|
|
3924
|
+
* Disarms every fault of one client, or of all clients when no name is given.
|
|
3925
|
+
*
|
|
3926
|
+
* @see setQueryDevtoolsFault
|
|
3927
|
+
*/
|
|
3928
|
+
declare const clearQueryDevtoolsFaults: (clientName?: string) => void;
|
|
3929
|
+
|
|
3930
|
+
/**
|
|
3931
|
+
* One field of a query form, as the devtools panel reads it: what it holds, what it puts in the URL,
|
|
3932
|
+
* and the rules that decide when either changes.
|
|
3933
|
+
*/
|
|
3934
|
+
type QueryDevtoolsFormField = {
|
|
3935
|
+
key: string;
|
|
3936
|
+
/** The query-param key the field serializes to, with the form's prefix applied. */
|
|
3937
|
+
paramKey: string;
|
|
3938
|
+
/** The committed value - what the query args are built from. */
|
|
3939
|
+
value: unknown;
|
|
3940
|
+
/** The live value of the bound control, which differs from {@link value} while a debounce is pending. */
|
|
3941
|
+
liveValue: unknown;
|
|
3942
|
+
defaultValue: unknown;
|
|
3943
|
+
/** Whether the committed value is the default one. */
|
|
3944
|
+
isDefault: boolean;
|
|
3945
|
+
/** What the field writes to the URL, or `undefined` when it writes nothing. */
|
|
3946
|
+
queryParam: unknown;
|
|
3947
|
+
/** How long a change waits before it is committed, or `null` when it commits immediately. */
|
|
3948
|
+
debounceMs: number | null;
|
|
3949
|
+
/** The sibling fields whose change resets this one back to its default. */
|
|
3950
|
+
isResetBy: readonly string[];
|
|
3951
|
+
/** Whether the field counts towards {@link QueryDevtoolsFormHandle.activeFilterCount}. */
|
|
3952
|
+
countsAsFilter: boolean;
|
|
3953
|
+
};
|
|
3954
|
+
/**
|
|
3955
|
+
* The live state of a query form, as `<et-query-devtools>` renders it. Part of the devtools contract -
|
|
3956
|
+
* not a general-purpose query-form API.
|
|
3957
|
+
*/
|
|
3958
|
+
type QueryDevtoolsFormHandle = {
|
|
3959
|
+
fields: Signal<QueryDevtoolsFormField[]>;
|
|
3960
|
+
/** The committed value of the whole form. */
|
|
3961
|
+
value: Signal<Record<string, unknown>>;
|
|
3962
|
+
/** The value of every field before the most recent commit, or `null` before the first one. */
|
|
3963
|
+
previousValue: Signal<Record<string, unknown> | null>;
|
|
3964
|
+
defaultValue: Record<string, unknown>;
|
|
3965
|
+
/** @see QueryFormSignals.activeFilterCount */
|
|
3966
|
+
activeFilterCount: Signal<number>;
|
|
3967
|
+
/** Whether every field sits at its default. */
|
|
3968
|
+
isAtDefaults: Signal<boolean>;
|
|
3969
|
+
/** Whether a change is waiting out its debounce, so the committed value is one edit behind. */
|
|
3970
|
+
isCommitPending: Signal<boolean>;
|
|
3971
|
+
/** Whether the form is syncing with the URL, i.e. whether `observe()` has been called. */
|
|
3972
|
+
isObserving: Signal<boolean>;
|
|
3973
|
+
resetField: (key: string) => void;
|
|
3974
|
+
resetAll: () => void;
|
|
3975
|
+
};
|
|
3976
|
+
|
|
3562
3977
|
/**
|
|
3563
3978
|
* The kind of object a {@link QueryDevtoolsEntry} describes. Part of the devtools contract consumed
|
|
3564
3979
|
* by `<et-query-devtools>` - not a general-purpose query API.
|
|
3565
3980
|
*/
|
|
3566
|
-
type QueryDevtoolsEntryKind = 'query' | 'query-stack' | 'paged-query-stack' | 'query-sequence' | 'auth-provider' | 'ws-client';
|
|
3981
|
+
type QueryDevtoolsEntryKind = 'query' | 'query-stack' | 'paged-query-stack' | 'query-sequence' | 'auth-provider' | 'ws-client' | 'query-form';
|
|
3982
|
+
/**
|
|
3983
|
+
* One chunk of a parsed query route: either literal text (`param: null`) or a path param, whose name
|
|
3984
|
+
* is in {@link QueryDevtoolsRoutePart.text}. Lets the devtools tell a route's static parts from its
|
|
3985
|
+
* dynamic ones and fill the latter in with the values a query actually used.
|
|
3986
|
+
*/
|
|
3987
|
+
type QueryDevtoolsRoutePart = {
|
|
3988
|
+
text: string;
|
|
3989
|
+
param: string | null;
|
|
3990
|
+
};
|
|
3991
|
+
/**
|
|
3992
|
+
* One of a bearer auth provider's queries, described without instantiating it - which is what lets
|
|
3993
|
+
* tooling build the token-refresh request of a provider whose refresh query has not run yet.
|
|
3994
|
+
*/
|
|
3995
|
+
type QueryDevtoolsAuthQuery = {
|
|
3996
|
+
key: string;
|
|
3997
|
+
/** `token-refresh` for the query registered via `withRefreshQuery`, `auth` for the rest. */
|
|
3998
|
+
kind: 'auth' | 'token-refresh';
|
|
3999
|
+
method: string;
|
|
4000
|
+
/** Stringified route with path params rendered as `:name`. */
|
|
4001
|
+
route: string;
|
|
4002
|
+
/** The args a token refresh sends for a given refresh token. Only set on the refresh query. */
|
|
4003
|
+
buildArgs?: (refreshToken: string) => {
|
|
4004
|
+
body?: unknown;
|
|
4005
|
+
};
|
|
4006
|
+
};
|
|
3567
4007
|
/**
|
|
3568
4008
|
* Descriptive, mostly-static metadata about a registered devtools entry. The live, reactive state
|
|
3569
4009
|
* is read from the entry's {@link QueryDevtoolsEntry.handle} instead.
|
|
@@ -3579,12 +4019,20 @@ type QueryDevtoolsEntryMeta = {
|
|
|
3579
4019
|
url?: string;
|
|
3580
4020
|
/** The GraphQL document string, for GraphQL queries. */
|
|
3581
4021
|
gqlQuery?: string;
|
|
3582
|
-
/** Stringified route with path params rendered as `:
|
|
4022
|
+
/** Stringified route with path params rendered as `:name`, for queries. */
|
|
3583
4023
|
route?: string;
|
|
4024
|
+
/** The same route, split into its literal and path-param parts. */
|
|
4025
|
+
routeParts?: QueryDevtoolsRoutePart[];
|
|
3584
4026
|
/** Human readable HTTP/GQL method, for queries (e.g. `GET`, `GQL QUERY`). */
|
|
3585
4027
|
method?: string;
|
|
3586
|
-
/** The
|
|
3587
|
-
|
|
4028
|
+
/** The features applied at creation, with the options each was configured with. */
|
|
4029
|
+
features?: QueryDevtoolsFeature[];
|
|
4030
|
+
/** Whether the query authenticates through a bearer auth provider, for queries. */
|
|
4031
|
+
isSecure?: boolean;
|
|
4032
|
+
/** Name of the bearer auth provider a secure query authenticates with. */
|
|
4033
|
+
authProviderName?: string;
|
|
4034
|
+
/** The provider's own queries, for auth providers. */
|
|
4035
|
+
authQueries?: QueryDevtoolsAuthQuery[];
|
|
3588
4036
|
/** The query config passed at creation, for queries. */
|
|
3589
4037
|
queryConfig?: QueryConfig;
|
|
3590
4038
|
/** The creator options passed at creation, for queries. */
|
|
@@ -3612,6 +4060,13 @@ type QueryDevtoolsEntry = {
|
|
|
3612
4060
|
meta: QueryDevtoolsEntryMeta;
|
|
3613
4061
|
handle: unknown;
|
|
3614
4062
|
createdAt: number;
|
|
4063
|
+
/**
|
|
4064
|
+
* What the entry has done since it was created - executions, requests, payload sizes. Present for
|
|
4065
|
+
* queries; stacks, sequences and auth providers aggregate the stats of the queries they own instead.
|
|
4066
|
+
*/
|
|
4067
|
+
stats?: QueryDevtoolsStatsHandle;
|
|
4068
|
+
/** The query forms this entry's args read, for queries created with a `withArgs` feature. */
|
|
4069
|
+
formLinks?: QueryDevtoolsFormLinksHandle;
|
|
3615
4070
|
};
|
|
3616
4071
|
/**
|
|
3617
4072
|
* What an instrumentation site hands to the registry. Raw values (`route`, `clientRef`) are rendered
|
|
@@ -3627,14 +4082,45 @@ type QueryDevtoolsRegistration = {
|
|
|
3627
4082
|
route?: unknown;
|
|
3628
4083
|
/** The owning client, whose display name is derived by the registry. */
|
|
3629
4084
|
clientRef?: AnyCreateQueryClientResult;
|
|
4085
|
+
/**
|
|
4086
|
+
* The bearer auth provider a secure query authenticates with, whose display name is derived by the
|
|
4087
|
+
* registry. Typed structurally so the registry does not have to import the auth layer it registers.
|
|
4088
|
+
*/
|
|
4089
|
+
authProviderRef?: {
|
|
4090
|
+
token?: unknown;
|
|
4091
|
+
};
|
|
4092
|
+
/** The auth provider's queries, whose routes are stringified by the registry. */
|
|
4093
|
+
authQueries?: (Omit<QueryDevtoolsAuthQuery, 'route'> & {
|
|
4094
|
+
route?: unknown;
|
|
4095
|
+
})[];
|
|
4096
|
+
/** @see QueryDevtoolsEntry.stats */
|
|
4097
|
+
stats?: QueryDevtoolsStatsHandle;
|
|
4098
|
+
/** @see QueryDevtoolsEntry.formLinks */
|
|
4099
|
+
formLinks?: QueryDevtoolsFormLinksHandle;
|
|
3630
4100
|
};
|
|
3631
4101
|
/** The registry {@link provideQueryDevtools} installs. */
|
|
3632
4102
|
type QueryDevtoolsRegistrar = (entry: QueryDevtoolsRegistration) => () => void;
|
|
4103
|
+
/** The request an upcoming attempt belongs to, for the fault resolver to match against. */
|
|
4104
|
+
type QueryDevtoolsFaultTarget = {
|
|
4105
|
+
/** Display name of the owning query client. Faults are armed per client. */
|
|
4106
|
+
clientName: string;
|
|
4107
|
+
method: string;
|
|
4108
|
+
url: string;
|
|
4109
|
+
};
|
|
4110
|
+
/** What the devtools want done with one upcoming attempt. */
|
|
4111
|
+
type QueryDevtoolsResolvedFault = {
|
|
4112
|
+
/** Extra latency in ms to wait out before the attempt starts. */
|
|
4113
|
+
latencyMs: number;
|
|
4114
|
+
/** The status to fail the attempt with instead of sending it, or `null` to let it through. */
|
|
4115
|
+
status: number | null;
|
|
4116
|
+
};
|
|
3633
4117
|
|
|
3634
4118
|
/**
|
|
3635
4119
|
* The reactive list of every registered devtools entry, consumed by the `<et-query-devtools>` UI.
|
|
3636
4120
|
*/
|
|
3637
4121
|
declare const queryDevtoolsEntries: Signal<QueryDevtoolsEntry[]>;
|
|
4122
|
+
/** Renders parsed route parts as a template, e.g. `/team/:teamId/players`. */
|
|
4123
|
+
declare const stringifyQueryRouteParts: (parts: QueryDevtoolsRoutePart[]) => string;
|
|
3638
4124
|
/**
|
|
3639
4125
|
* Enables the `@ethlete/query` devtools. Add this to your application providers (e.g. in
|
|
3640
4126
|
* `bootstrapApplication`) to make query clients, queries, stacks, sequences and auth providers
|
|
@@ -3713,11 +4199,20 @@ type CreateSecureGqlQueryExecuteOptions<TArgs extends GqlQueryArgs> = {
|
|
|
3713
4199
|
};
|
|
3714
4200
|
declare const createSecureGqlExecuteFn: <TArgs extends GqlQueryArgs>(executeOptions: CreateSecureGqlQueryExecuteOptions<TArgs>) => InternalQueryExecute<TArgs>;
|
|
3715
4201
|
|
|
4202
|
+
/**
|
|
4203
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4204
|
+
*/
|
|
3716
4205
|
type EntityKey = string | number;
|
|
4206
|
+
/**
|
|
4207
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4208
|
+
*/
|
|
3717
4209
|
type EntityStoreConfig = {
|
|
3718
4210
|
name: string;
|
|
3719
4211
|
logActions?: boolean;
|
|
3720
4212
|
};
|
|
4213
|
+
/**
|
|
4214
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4215
|
+
*/
|
|
3721
4216
|
type InsertFromConfig<OriginStoreType, OriginKeys extends keyof NonNullable<OriginStoreType>, IdFn extends (value: NonNullable<OriginStoreType>) => EntityKey | EntityKey[]> = {
|
|
3722
4217
|
/**
|
|
3723
4218
|
* The property key of which the value should be replaced.
|
|
@@ -3728,6 +4223,9 @@ type InsertFromConfig<OriginStoreType, OriginKeys extends keyof NonNullable<Orig
|
|
|
3728
4223
|
*/
|
|
3729
4224
|
id: IdFn;
|
|
3730
4225
|
};
|
|
4226
|
+
/**
|
|
4227
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4228
|
+
*/
|
|
3731
4229
|
type RemoveFromConfig<T> = {
|
|
3732
4230
|
/**
|
|
3733
4231
|
* The where function to select the entities to remove.
|
|
@@ -3739,6 +4237,9 @@ type RemoveFromConfig<T> = {
|
|
|
3739
4237
|
id: (entity: T) => EntityKey;
|
|
3740
4238
|
};
|
|
3741
4239
|
|
|
4240
|
+
/**
|
|
4241
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4242
|
+
*/
|
|
3742
4243
|
declare class EntityStore<T> {
|
|
3743
4244
|
private readonly _config;
|
|
3744
4245
|
constructor(_config: EntityStoreConfig);
|
|
@@ -3763,17 +4264,30 @@ declare class EntityStore<T> {
|
|
|
3763
4264
|
private normalizeKeys;
|
|
3764
4265
|
}
|
|
3765
4266
|
|
|
4267
|
+
/**
|
|
4268
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4269
|
+
*/
|
|
3766
4270
|
declare function mapToPaginated<T>(response: Paginated<T>): rxjs.OperatorFunction<unknown, Paginated<T>>;
|
|
3767
4271
|
/**
|
|
3768
4272
|
* Use an other store to represent a property of the current entity.
|
|
4273
|
+
*
|
|
4274
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
3769
4275
|
*/
|
|
3770
4276
|
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>) => rxjs.OperatorFunction<OriginStoreType, ComputedEntityType | null>;
|
|
3771
4277
|
/**
|
|
3772
4278
|
* Remove entities from a store based on a where function.
|
|
4279
|
+
*
|
|
4280
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
3773
4281
|
*/
|
|
3774
4282
|
declare const removeFrom: <T>(store: EntityStore<T>, { where, id }: RemoveFromConfig<T>) => void;
|
|
3775
4283
|
|
|
4284
|
+
/**
|
|
4285
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4286
|
+
*/
|
|
3776
4287
|
type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT' | 'PURGE' | 'LINK' | 'UNLINK' | 'GQL_QUERY' | 'GQL_MUTATE' | 'CUSTOM';
|
|
4288
|
+
/**
|
|
4289
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4290
|
+
*/
|
|
3777
4291
|
type RequestError<Detail = unknown> = {
|
|
3778
4292
|
url: string;
|
|
3779
4293
|
status: number;
|
|
@@ -3781,28 +4295,52 @@ type RequestError<Detail = unknown> = {
|
|
|
3781
4295
|
detail: Detail;
|
|
3782
4296
|
httpErrorResponse: HttpErrorResponse;
|
|
3783
4297
|
};
|
|
4298
|
+
/**
|
|
4299
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4300
|
+
*/
|
|
3784
4301
|
type RequestHeaders = Record<string, string>;
|
|
3785
4302
|
|
|
4303
|
+
/**
|
|
4304
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4305
|
+
*/
|
|
3786
4306
|
type V2CacheAdapterFn = (headers: RequestHeaders) => number | null;
|
|
4307
|
+
/**
|
|
4308
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4309
|
+
*/
|
|
3787
4310
|
type RequestHeadersMethodMap = {
|
|
3788
4311
|
[M in Method]?: RequestHeaders;
|
|
3789
4312
|
};
|
|
4313
|
+
/**
|
|
4314
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4315
|
+
*/
|
|
3790
4316
|
type PartialXhrState = {
|
|
3791
4317
|
headers: RequestHeaders;
|
|
3792
4318
|
status: number;
|
|
3793
4319
|
statusText: string;
|
|
3794
4320
|
url: string;
|
|
3795
4321
|
};
|
|
4322
|
+
/**
|
|
4323
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4324
|
+
*/
|
|
3796
4325
|
type RequestRetryFnConfig = {
|
|
3797
4326
|
error: RequestError;
|
|
3798
4327
|
headers: RequestHeaders;
|
|
3799
4328
|
currentRetryCount: number;
|
|
3800
4329
|
};
|
|
4330
|
+
/**
|
|
4331
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4332
|
+
*/
|
|
3801
4333
|
type RequestRetryFnResult = {
|
|
3802
4334
|
retry: boolean;
|
|
3803
4335
|
delay?: number;
|
|
3804
4336
|
};
|
|
4337
|
+
/**
|
|
4338
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4339
|
+
*/
|
|
3805
4340
|
type RequestRetryFn = (config: RequestRetryFnConfig) => RequestRetryFnResult;
|
|
4341
|
+
/**
|
|
4342
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4343
|
+
*/
|
|
3806
4344
|
type RequestConfig = {
|
|
3807
4345
|
method: Method;
|
|
3808
4346
|
urlWithParams: string;
|
|
@@ -3814,11 +4352,17 @@ type RequestConfig = {
|
|
|
3814
4352
|
cacheAdapter?: V2CacheAdapterFn;
|
|
3815
4353
|
retryFn?: RequestRetryFn;
|
|
3816
4354
|
};
|
|
4355
|
+
/**
|
|
4356
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4357
|
+
*/
|
|
3817
4358
|
type RequestProgress = {
|
|
3818
4359
|
current: number;
|
|
3819
4360
|
percentage?: number;
|
|
3820
4361
|
total?: number;
|
|
3821
4362
|
};
|
|
4363
|
+
/**
|
|
4364
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4365
|
+
*/
|
|
3822
4366
|
type RequestEvent<Response = unknown> = {
|
|
3823
4367
|
type: 'start';
|
|
3824
4368
|
headers: RequestHeaders;
|
|
@@ -3853,20 +4397,53 @@ type RequestEvent<Response = unknown> = {
|
|
|
3853
4397
|
headers: RequestHeaders;
|
|
3854
4398
|
};
|
|
3855
4399
|
|
|
4400
|
+
/**
|
|
4401
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4402
|
+
*/
|
|
3856
4403
|
declare const request: <Response = unknown>(config: RequestConfig) => Observable<RequestEvent<Response>>;
|
|
3857
4404
|
|
|
4405
|
+
/**
|
|
4406
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4407
|
+
*/
|
|
3858
4408
|
declare const isRequestError: <T = unknown>(error: unknown) => error is RequestError<T>;
|
|
4409
|
+
/**
|
|
4410
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4411
|
+
*/
|
|
3859
4412
|
declare const v2ExtractExpiresInSeconds: (headers: RequestHeaders) => number | null;
|
|
4413
|
+
/**
|
|
4414
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4415
|
+
*/
|
|
3860
4416
|
declare const serializeBody: (body: unknown) => ArrayBuffer | URLSearchParams | Blob | FormData | string | null;
|
|
4417
|
+
/**
|
|
4418
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4419
|
+
*/
|
|
3861
4420
|
declare const transformMethod: (config: {
|
|
3862
4421
|
method: Method;
|
|
3863
4422
|
transferVia?: "GET" | "POST";
|
|
3864
4423
|
}) => "GET" | "OPTIONS" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
|
|
4424
|
+
/**
|
|
4425
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4426
|
+
*/
|
|
3865
4427
|
declare const detectContentTypeHeader: (body: unknown) => string | null;
|
|
4428
|
+
/**
|
|
4429
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4430
|
+
*/
|
|
3866
4431
|
declare const hasHeader: (headers: RequestHeaders, header: string) => boolean;
|
|
4432
|
+
/**
|
|
4433
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4434
|
+
*/
|
|
3867
4435
|
declare const forEachHeader: (headers: RequestHeaders, callback: (value: string, key: string) => void) => void;
|
|
4436
|
+
/**
|
|
4437
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4438
|
+
*/
|
|
3868
4439
|
declare const parseAllXhrResponseHeaders: (xhr: XMLHttpRequest) => RequestHeaders;
|
|
4440
|
+
/**
|
|
4441
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4442
|
+
*/
|
|
3869
4443
|
declare const getResponseUrl: (xhr: XMLHttpRequest) => string | null;
|
|
4444
|
+
/**
|
|
4445
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4446
|
+
*/
|
|
3870
4447
|
declare const v2ShouldRetryRequest: RequestRetryFn;
|
|
3871
4448
|
|
|
3872
4449
|
type QueryFieldOptions<T = unknown> = {
|
|
@@ -4173,12 +4750,57 @@ declare class QueryForm<T extends Record<string, QueryField<any>>> {
|
|
|
4173
4750
|
private cleanup;
|
|
4174
4751
|
}
|
|
4175
4752
|
|
|
4753
|
+
/**
|
|
4754
|
+
* Lets `prepare()` fall back to the application's root injector when it is called outside any injection
|
|
4755
|
+
* context, instead of throwing `ET950`.
|
|
4756
|
+
*
|
|
4757
|
+
* Opt-in, and **browser only**. Two things degrade when the fallback is used, both matching v2, which had
|
|
4758
|
+
* no injector to scope to at all:
|
|
4759
|
+
*
|
|
4760
|
+
* - **The query's lifetime becomes the application's.** Nothing tears it down when a component dies, so
|
|
4761
|
+
* cleanup rests entirely on a query container or `config: { destroyOnResponse: true }`.
|
|
4762
|
+
* - **The devtools lose the host element**, so "inspect" cannot jump to the component. Already the case
|
|
4763
|
+
* for any query created from a root or environment injector.
|
|
4764
|
+
*
|
|
4765
|
+
* It refuses to stash anything on the server: a module-global injector would be shared across concurrent
|
|
4766
|
+
* requests, which is data bleed rather than a leak. Server-side renders keep throwing `ET950`, so a call
|
|
4767
|
+
* site that only works in the browser fails loudly where it matters.
|
|
4768
|
+
*
|
|
4769
|
+
* Prefer passing `injector` at the call site - it keeps the query scoped to whatever created it. Reach for
|
|
4770
|
+
* this when a migration has too many call sites to thread by hand.
|
|
4771
|
+
*
|
|
4772
|
+
* @example
|
|
4773
|
+
* ```ts
|
|
4774
|
+
* bootstrapApplication(AppComponent, {
|
|
4775
|
+
* providers: [provideLegacyPrepareFallback()],
|
|
4776
|
+
* });
|
|
4777
|
+
* ```
|
|
4778
|
+
*
|
|
4779
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4780
|
+
*/
|
|
4781
|
+
declare const provideLegacyPrepareFallback: () => EnvironmentProviders;
|
|
4782
|
+
|
|
4783
|
+
/**
|
|
4784
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4785
|
+
*/
|
|
4176
4786
|
type CreateLegacyQueryOptions<TArgs extends QueryArgs> = {
|
|
4177
4787
|
query: Query<TArgs>;
|
|
4178
4788
|
};
|
|
4789
|
+
/**
|
|
4790
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4791
|
+
*/
|
|
4179
4792
|
declare const transformExecStateToQueryState: <TArgs extends QueryArgs>(execState: QueryExecutionState<TArgs> | null) => V2QueryState<ResponseType<TArgs>>;
|
|
4793
|
+
/**
|
|
4794
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4795
|
+
*/
|
|
4180
4796
|
declare const isLegacyQuery: <T extends AnyLegacyQuery>(query: unknown) => query is T;
|
|
4797
|
+
/**
|
|
4798
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4799
|
+
*/
|
|
4181
4800
|
type AnyLegacyQuery = LegacyQuery<any, any, any, any, any, any, any>;
|
|
4801
|
+
/**
|
|
4802
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4803
|
+
*/
|
|
4182
4804
|
declare class LegacyQuery<Response, Arguments extends BaseArguments | undefined, Route extends V2RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id, TNewQuery extends AnyNewQuery> {
|
|
4183
4805
|
newQuery: TNewQuery;
|
|
4184
4806
|
_arguments: RequestArgs<QueryArgsOf<TNewQuery>>;
|
|
@@ -4192,7 +4814,14 @@ declare class LegacyQuery<Response, Arguments extends BaseArguments | undefined,
|
|
|
4192
4814
|
*
|
|
4193
4815
|
* @internal
|
|
4194
4816
|
*/
|
|
4195
|
-
_isInert?: boolean
|
|
4817
|
+
_isInert?: boolean,
|
|
4818
|
+
/**
|
|
4819
|
+
* Whether the underlying request is cacheable. Resolved by the creator, which is the only place that
|
|
4820
|
+
* knows the method before the first execution.
|
|
4821
|
+
*
|
|
4822
|
+
* @internal
|
|
4823
|
+
*/
|
|
4824
|
+
_canBeCached?: boolean);
|
|
4196
4825
|
get rawState(): V2QueryState<any>;
|
|
4197
4826
|
get isExpired(): boolean | undefined;
|
|
4198
4827
|
get isInUse(): boolean;
|
|
@@ -4213,6 +4842,9 @@ declare class LegacyQuery<Response, Arguments extends BaseArguments | undefined,
|
|
|
4213
4842
|
private teardown;
|
|
4214
4843
|
}
|
|
4215
4844
|
|
|
4845
|
+
/**
|
|
4846
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4847
|
+
*/
|
|
4216
4848
|
type QueryContainerConfig = {
|
|
4217
4849
|
/**
|
|
4218
4850
|
* If `true`, the previous query will be aborted when a new query is pushed into the container.
|
|
@@ -4229,7 +4861,15 @@ type QueryContainerConfig = {
|
|
|
4229
4861
|
* @default true // Only if the query has no other dependents and the request can be cached (GET, OPTIONS, HEAD and GQL_QUERY). Otherwise false.
|
|
4230
4862
|
*/
|
|
4231
4863
|
stopPreviousPolling?: boolean;
|
|
4864
|
+
/**
|
|
4865
|
+
* The injector owning the container. Defaults to the current injection context; pass one to build a
|
|
4866
|
+
* container outside of it - the container's lifecycle then follows that injector.
|
|
4867
|
+
*/
|
|
4868
|
+
injector?: Injector;
|
|
4232
4869
|
};
|
|
4870
|
+
/**
|
|
4871
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4872
|
+
*/
|
|
4233
4873
|
type QueryFilterConfig = {
|
|
4234
4874
|
/**
|
|
4235
4875
|
* If `true`, the response will be cached until the next response is received or the query fails.
|
|
@@ -4237,56 +4877,117 @@ type QueryFilterConfig = {
|
|
|
4237
4877
|
*/
|
|
4238
4878
|
cacheResponse?: boolean;
|
|
4239
4879
|
};
|
|
4880
|
+
/**
|
|
4881
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4882
|
+
*/
|
|
4240
4883
|
declare const addQueryContainerHandling: (obs: Observable<AnyV2Query | AnyV2Query[] | AnyLegacyQuery | AnyLegacyQuery[] | null>, valueFn: () => AnyV2Query | AnyV2Query[] | AnyLegacyQuery | AnyLegacyQuery[] | null | undefined, config?: QueryContainerConfig) => void;
|
|
4884
|
+
/**
|
|
4885
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4886
|
+
*/
|
|
4241
4887
|
declare function toQuerySignal<T extends AnyV2Query | AnyLegacyQuery | null>(source: Observable<T> | Subscribable<T>): Signal<T | undefined>;
|
|
4888
|
+
/**
|
|
4889
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4890
|
+
*/
|
|
4242
4891
|
declare function toQuerySignal<T extends AnyV2Query | AnyLegacyQuery | null>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | undefined>> & {
|
|
4243
4892
|
initialValue?: undefined;
|
|
4244
4893
|
requireSync?: false;
|
|
4245
4894
|
} & QueryContainerConfig): Signal<T | undefined>;
|
|
4895
|
+
/**
|
|
4896
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4897
|
+
*/
|
|
4246
4898
|
declare function toQuerySignal<T extends AnyV2Query | AnyLegacyQuery | null>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | null>> & {
|
|
4247
4899
|
initialValue?: null;
|
|
4248
4900
|
requireSync?: false;
|
|
4249
4901
|
} & QueryContainerConfig): Signal<T | null>;
|
|
4902
|
+
/**
|
|
4903
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4904
|
+
*/
|
|
4250
4905
|
declare function toQuerySignal<T extends AnyV2Query | AnyLegacyQuery | null>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T>> & {
|
|
4251
4906
|
initialValue?: undefined;
|
|
4252
4907
|
requireSync: true;
|
|
4253
4908
|
} & QueryContainerConfig): Signal<T>;
|
|
4909
|
+
/**
|
|
4910
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4911
|
+
*/
|
|
4254
4912
|
declare function toQuerySignal<T extends AnyV2Query | AnyLegacyQuery | null, const U extends T>(source: Observable<T> | Subscribable<T>, options: NoInfer<ToSignalOptions<T | U>> & {
|
|
4255
4913
|
initialValue: U;
|
|
4256
4914
|
requireSync?: false;
|
|
4257
4915
|
} & QueryContainerConfig): Signal<T | U>;
|
|
4916
|
+
/**
|
|
4917
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4918
|
+
*/
|
|
4258
4919
|
declare function effectComputed<T extends AnyV2Query | AnyLegacyQuery | AnyV2Query[] | AnyLegacyQuery[] | null>(computation: () => T, injector: Injector): Signal<T>;
|
|
4920
|
+
/**
|
|
4921
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4922
|
+
*/
|
|
4259
4923
|
declare function queryComputed<T extends AnyV2Query | AnyLegacyQuery | null>(computation: () => T, options?: CreateComputedOptions<T> & QueryContainerConfig & ToObservableOptions): Signal<T>;
|
|
4260
4924
|
/**
|
|
4261
4925
|
* Creates a signal that will only be reactive until the first query is created.
|
|
4262
4926
|
* All subsequent changes inside the computation will be ignored.
|
|
4927
|
+
*
|
|
4928
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4263
4929
|
*/
|
|
4264
4930
|
declare function queryComputedTillTruthy<T extends AnyV2Query | AnyLegacyQuery | null>(computation: () => T, options?: CreateComputedOptions<T> & QueryContainerConfig & ToObservableOptions): Signal<T | null>;
|
|
4931
|
+
/**
|
|
4932
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4933
|
+
*/
|
|
4265
4934
|
declare function queryArrayComputed<T extends AnyV2Query[] | AnyLegacyQuery[] | null>(computation: () => T, options?: CreateComputedOptions<T> & QueryContainerConfig & ToObservableOptions): Signal<T>;
|
|
4935
|
+
/**
|
|
4936
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4937
|
+
*/
|
|
4266
4938
|
declare function toQuerySubject<T extends AnyV2Query | AnyLegacyQuery | null>(source: Signal<T>, options?: ToObservableOptions & QueryContainerConfig): Observable<T>;
|
|
4939
|
+
/**
|
|
4940
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4941
|
+
*/
|
|
4267
4942
|
declare function queryStateSignal<T extends Signal<AnyV2Query | AnyLegacyQuery | AnyQueryCollection | null>>(source: T, options?: QueryFilterConfig): _angular_core.WritableSignal<V2QueryState<QueryDataOf<QueryOf<ReturnType<T>>>> | null>;
|
|
4943
|
+
/**
|
|
4944
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4945
|
+
*/
|
|
4268
4946
|
type QueryStateSignal<T extends Signal<AnyV2Query | AnyLegacyQuery | AnyQueryCollection | null>> = Signal<QueryDataOf<QueryOf<ReturnType<T>>> | null> & {
|
|
4269
4947
|
reset: () => void;
|
|
4270
4948
|
};
|
|
4949
|
+
/**
|
|
4950
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4951
|
+
*/
|
|
4271
4952
|
declare function queryStateResponseSignal<T extends Signal<AnyV2Query | AnyLegacyQuery | AnyQueryCollection | null>>(source: T, options?: QueryFilterConfig): QueryStateSignal<T>;
|
|
4953
|
+
/**
|
|
4954
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4955
|
+
*/
|
|
4272
4956
|
declare function queryStateErrorSignal<T extends Signal<AnyV2Query | AnyLegacyQuery | AnyQueryCollection | null>>(source: T): Signal<_ethlete_query.RequestError | null>;
|
|
4957
|
+
/**
|
|
4958
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4959
|
+
*/
|
|
4273
4960
|
declare function queryStateLoadingSignal<T extends Signal<AnyV2Query | AnyLegacyQuery | AnyQueryCollection | null>>(source: T): Signal<_ethlete_query.Loading | null>;
|
|
4274
4961
|
|
|
4275
|
-
|
|
4962
|
+
/**
|
|
4963
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4964
|
+
*/
|
|
4965
|
+
declare const deepFreeze: <T extends Record<string, unknown>>(object: T) => T;
|
|
4276
4966
|
|
|
4277
4967
|
/**
|
|
4278
4968
|
* Dummy function for providing types while not breaking inference.
|
|
4279
4969
|
* **This function always returns null.**
|
|
4280
4970
|
* @see https://github.com/microsoft/TypeScript/issues/26242
|
|
4281
4971
|
* @returns null
|
|
4972
|
+
*
|
|
4973
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4282
4974
|
*/
|
|
4283
4975
|
declare const def: <Data>() => Data;
|
|
4284
4976
|
|
|
4977
|
+
/**
|
|
4978
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4979
|
+
*/
|
|
4285
4980
|
type LegacyArgumentsOfQueryArgs<T extends QueryArgs> = Omit<T, 'response' | 'headers'> & WithHeaders;
|
|
4981
|
+
/**
|
|
4982
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4983
|
+
*/
|
|
4286
4984
|
type QueryArgsOfLegacyArguments<T extends BaseArguments | undefined, J> = Omit<T, 'mock' | 'headers'> & {
|
|
4287
4985
|
headers?: HttpHeaders;
|
|
4288
4986
|
response?: J;
|
|
4289
4987
|
};
|
|
4988
|
+
/**
|
|
4989
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4990
|
+
*/
|
|
4290
4991
|
type CreateLegacyQueryCreatorOptions<TArgs extends QueryArgs, Response, Store extends EntityStore<unknown>, Data, Id> = {
|
|
4291
4992
|
creator: QueryCreator<TArgs>;
|
|
4292
4993
|
/**
|
|
@@ -4300,6 +5001,9 @@ type CreateLegacyQueryCreatorOptions<TArgs extends QueryArgs, Response, Store ex
|
|
|
4300
5001
|
*/
|
|
4301
5002
|
name?: string;
|
|
4302
5003
|
};
|
|
5004
|
+
/**
|
|
5005
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5006
|
+
*/
|
|
4303
5007
|
type WithLegacyConfig = {
|
|
4304
5008
|
/**
|
|
4305
5009
|
* Additional configuration for this query.
|
|
@@ -4311,8 +5015,17 @@ type WithLegacyConfig = {
|
|
|
4311
5015
|
destroyOnResponse?: boolean;
|
|
4312
5016
|
};
|
|
4313
5017
|
};
|
|
5018
|
+
/**
|
|
5019
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5020
|
+
*/
|
|
4314
5021
|
type LegacyQueryPrepareFn<Arguments extends BaseArguments | undefined, Response, Route extends V2RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id, TNewQuery extends AnyNewQuery> = (args: Arguments & WithHeaders & WithLegacyConfig & WithInjector) => LegacyQuery<Response, Arguments, Route, Store, Data, Id, TNewQuery>;
|
|
5022
|
+
/**
|
|
5023
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5024
|
+
*/
|
|
4315
5025
|
type AnyLegacyQueryCreator = LegacyQueryCreator<any, any, any, any, any>;
|
|
5026
|
+
/**
|
|
5027
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5028
|
+
*/
|
|
4316
5029
|
declare class LegacyQueryCreator<TArgs extends QueryArgs, Response extends ResponseType<TArgs>, Store extends EntityStore<unknown>, Id, Data = Response> {
|
|
4317
5030
|
options: CreateLegacyQueryCreatorOptions<TArgs, Response, Store, Data, Id>;
|
|
4318
5031
|
prepare: LegacyQueryPrepareFn<LegacyArgumentsOfQueryArgs<TArgs>, Response, V2RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query<TArgs>>;
|
|
@@ -4320,6 +5033,19 @@ declare class LegacyQueryCreator<TArgs extends QueryArgs, Response extends Respo
|
|
|
4320
5033
|
createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => _angular_core.WritableSignal<LegacyQuery<Response, LegacyArgumentsOfQueryArgs<TArgs>, V2RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query<TArgs>> | null>;
|
|
4321
5034
|
behaviorSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => BehaviorSubject<LegacyQuery<Response, LegacyArgumentsOfQueryArgs<TArgs>, V2RouteType<LegacyArgumentsOfQueryArgs<TArgs>>, Store, Data, Id, Query<TArgs>> | null>;
|
|
4322
5035
|
constructor(options: CreateLegacyQueryCreatorOptions<TArgs, Response, Store, Data, Id>);
|
|
5036
|
+
/**
|
|
5037
|
+
* Whether the underlying request is cacheable, which is what the legacy container helpers use to decide
|
|
5038
|
+
* their default cleanup. Resolved from the creator, so it answers before the first execution.
|
|
5039
|
+
*/
|
|
5040
|
+
get canBeCached(): boolean;
|
|
5041
|
+
private get label();
|
|
5042
|
+
/**
|
|
5043
|
+
* v2 needed no injection context, so plenty of call sites are plain callbacks. Angular's raw NG0203
|
|
5044
|
+
* names neither the query nor the call site, which makes those a bisection exercise - replace it with
|
|
5045
|
+
* an error that does, and let every other DI failure (NG0205 from an injector mid-teardown, a missing
|
|
5046
|
+
* provider) through untouched.
|
|
5047
|
+
*/
|
|
5048
|
+
private resolveAmbientInjector;
|
|
4323
5049
|
}
|
|
4324
5050
|
/**
|
|
4325
5051
|
* Creates a legacy query creator.
|
|
@@ -4327,9 +5053,14 @@ declare class LegacyQueryCreator<TArgs extends QueryArgs, Response extends Respo
|
|
|
4327
5053
|
* **NOTE**: This is a temporary solution to support legacy queries. It will be removed in the future.
|
|
4328
5054
|
*
|
|
4329
5055
|
* **DO NOT TURN NEW QUERY CREATORS INTO LEGACY ONES MANUALLY. THIS IS ONLY NEEDED FOR MIGRATION PURPOSES.**
|
|
5056
|
+
*
|
|
5057
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
4330
5058
|
*/
|
|
4331
5059
|
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>;
|
|
4332
5060
|
|
|
5061
|
+
/**
|
|
5062
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5063
|
+
*/
|
|
4333
5064
|
type QueryAutoRefreshConfig = {
|
|
4334
5065
|
/**
|
|
4335
5066
|
* Refresh the query when the query client's headers change.
|
|
@@ -4344,6 +5075,9 @@ type QueryAutoRefreshConfig = {
|
|
|
4344
5075
|
*/
|
|
4345
5076
|
windowFocus?: boolean;
|
|
4346
5077
|
};
|
|
5078
|
+
/**
|
|
5079
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5080
|
+
*/
|
|
4347
5081
|
type EntitySetParams<Store, Response, Arguments, Id> = {
|
|
4348
5082
|
/**
|
|
4349
5083
|
* The response data.
|
|
@@ -4362,6 +5096,9 @@ type EntitySetParams<Store, Response, Arguments, Id> = {
|
|
|
4362
5096
|
*/
|
|
4363
5097
|
store: Store;
|
|
4364
5098
|
};
|
|
5099
|
+
/**
|
|
5100
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5101
|
+
*/
|
|
4365
5102
|
type EntityGetParams<Store, Response, Arguments, Id> = {
|
|
4366
5103
|
/**
|
|
4367
5104
|
* The response data.
|
|
@@ -4380,6 +5117,9 @@ type EntityGetParams<Store, Response, Arguments, Id> = {
|
|
|
4380
5117
|
*/
|
|
4381
5118
|
store: Store;
|
|
4382
5119
|
};
|
|
5120
|
+
/**
|
|
5121
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5122
|
+
*/
|
|
4383
5123
|
type EntityIdParams<Response, Arguments> = {
|
|
4384
5124
|
/**
|
|
4385
5125
|
* The response data.
|
|
@@ -4390,6 +5130,9 @@ type EntityIdParams<Response, Arguments> = {
|
|
|
4390
5130
|
*/
|
|
4391
5131
|
args: Arguments;
|
|
4392
5132
|
};
|
|
5133
|
+
/**
|
|
5134
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5135
|
+
*/
|
|
4393
5136
|
type QueryEntityConfig<Store, Data, Response, Arguments, Id> = {
|
|
4394
5137
|
/**
|
|
4395
5138
|
* The entity store to use for the query.
|
|
@@ -4408,6 +5151,9 @@ type QueryEntityConfig<Store, Data, Response, Arguments, Id> = {
|
|
|
4408
5151
|
*/
|
|
4409
5152
|
set?: (data: EntitySetParams<Store, Response, Arguments, Id>) => void;
|
|
4410
5153
|
};
|
|
5154
|
+
/**
|
|
5155
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5156
|
+
*/
|
|
4411
5157
|
type QueryConfigBase<Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = {
|
|
4412
5158
|
/**
|
|
4413
5159
|
* The http method to use for the query.
|
|
@@ -4470,13 +5216,22 @@ type QueryConfigBase<Response, Arguments extends BaseArguments | undefined, Stor
|
|
|
4470
5216
|
*/
|
|
4471
5217
|
entity?: QueryEntityConfig<Store, Data, Response, Arguments, Id>;
|
|
4472
5218
|
};
|
|
5219
|
+
/**
|
|
5220
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5221
|
+
*/
|
|
4473
5222
|
type RestQueryConfig<Route extends V2RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = QueryConfigBase<Response, Arguments, Store, Data, Id> & {
|
|
4474
5223
|
/**
|
|
4475
5224
|
* The api route to use for the query.
|
|
4476
5225
|
*/
|
|
4477
5226
|
route: Route;
|
|
4478
5227
|
};
|
|
5228
|
+
/**
|
|
5229
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5230
|
+
*/
|
|
4479
5231
|
type GqlTransferOption = 'GET' | 'POST';
|
|
5232
|
+
/**
|
|
5233
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5234
|
+
*/
|
|
4480
5235
|
type GqlQueryConfig<Route extends V2RouteType<Arguments> | undefined, Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = QueryConfigBase<Response, Arguments, Store, Data, Id> & {
|
|
4481
5236
|
/**
|
|
4482
5237
|
* The graphql query to use for the query.
|
|
@@ -4494,17 +5249,38 @@ type GqlQueryConfig<Route extends V2RouteType<Arguments> | undefined, Response,
|
|
|
4494
5249
|
*/
|
|
4495
5250
|
route?: Route;
|
|
4496
5251
|
};
|
|
5252
|
+
/**
|
|
5253
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5254
|
+
*/
|
|
4497
5255
|
type AnyRestQueryConfig = RestQueryConfig<any, any, any, any, any, any>;
|
|
5256
|
+
/**
|
|
5257
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5258
|
+
*/
|
|
4498
5259
|
type AnyGqlQueryConfig = GqlQueryConfig<any, any, any, any, any, any>;
|
|
5260
|
+
/**
|
|
5261
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5262
|
+
*/
|
|
4499
5263
|
type QueryConfigWithoutMethod<Route extends V2RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = Omit<RestQueryConfig<Route, Response, Arguments, Store, Data, Id>, 'method'>;
|
|
5264
|
+
/**
|
|
5265
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5266
|
+
*/
|
|
4500
5267
|
type GqlQueryConfigWithoutMethod<Route extends V2RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, Store extends EntityStore<unknown>, Data, Id> = Omit<GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, 'method'>;
|
|
5268
|
+
/**
|
|
5269
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5270
|
+
*/
|
|
4501
5271
|
type BaseArguments = WithHeaders & WithVariables & WithBody & WithQueryParams & WithPathParams & WithMock<unknown>;
|
|
5272
|
+
/**
|
|
5273
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5274
|
+
*/
|
|
4502
5275
|
type WithHeaders = {
|
|
4503
5276
|
/**
|
|
4504
5277
|
* The headers to send with the query.
|
|
4505
5278
|
*/
|
|
4506
5279
|
headers?: Record<string, string>;
|
|
4507
5280
|
};
|
|
5281
|
+
/**
|
|
5282
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5283
|
+
*/
|
|
4508
5284
|
type QueryMockConfig<MockResponse> = {
|
|
4509
5285
|
/**
|
|
4510
5286
|
* The mock response to use for the query.
|
|
@@ -4558,9 +5334,15 @@ type QueryMockConfig<MockResponse> = {
|
|
|
4558
5334
|
*/
|
|
4559
5335
|
retryIntoResponse?: boolean;
|
|
4560
5336
|
};
|
|
5337
|
+
/**
|
|
5338
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5339
|
+
*/
|
|
4561
5340
|
type WithMock<MockResponse> = {
|
|
4562
5341
|
mock?: QueryMockConfig<MockResponse>;
|
|
4563
5342
|
};
|
|
5343
|
+
/**
|
|
5344
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5345
|
+
*/
|
|
4564
5346
|
type V2QueryConfig = {
|
|
4565
5347
|
/**
|
|
4566
5348
|
* Whether this query should be added to the internal query store.
|
|
@@ -4578,41 +5360,68 @@ type V2QueryConfig = {
|
|
|
4578
5360
|
*/
|
|
4579
5361
|
queryStoreCacheKey?: string;
|
|
4580
5362
|
};
|
|
5363
|
+
/**
|
|
5364
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5365
|
+
*/
|
|
4581
5366
|
type WithConfig = {
|
|
4582
5367
|
/**
|
|
4583
5368
|
* Additional configuration for this query.
|
|
4584
5369
|
*/
|
|
4585
5370
|
config?: V2QueryConfig;
|
|
4586
5371
|
};
|
|
5372
|
+
/**
|
|
5373
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5374
|
+
*/
|
|
4587
5375
|
type WithInjector = {
|
|
4588
5376
|
injector?: Injector;
|
|
4589
5377
|
};
|
|
5378
|
+
/**
|
|
5379
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5380
|
+
*/
|
|
4590
5381
|
type WithVariables = {
|
|
4591
5382
|
/**
|
|
4592
5383
|
* The variables for the query. (graphql only)
|
|
4593
5384
|
*/
|
|
4594
5385
|
variables?: Record<string, unknown>;
|
|
4595
5386
|
};
|
|
5387
|
+
/**
|
|
5388
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5389
|
+
*/
|
|
4596
5390
|
type WithBody = {
|
|
4597
5391
|
/**
|
|
4598
5392
|
* The body for the query. Unavailable for GET, HEAD and OPTIONS requests.
|
|
4599
5393
|
*/
|
|
4600
5394
|
body?: unknown;
|
|
4601
5395
|
};
|
|
5396
|
+
/**
|
|
5397
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5398
|
+
*/
|
|
4602
5399
|
type WithQueryParams = {
|
|
4603
5400
|
/**
|
|
4604
5401
|
* The query parameters for the query. (after the ? in the url)
|
|
4605
5402
|
*/
|
|
4606
5403
|
queryParams?: QueryParams;
|
|
4607
5404
|
};
|
|
5405
|
+
/**
|
|
5406
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5407
|
+
*/
|
|
4608
5408
|
type WithPathParams = {
|
|
4609
5409
|
/**
|
|
4610
5410
|
* The path parameters for the query. (in front of the ? in the url)
|
|
4611
5411
|
*/
|
|
4612
5412
|
pathParams?: PathParams;
|
|
4613
5413
|
};
|
|
5414
|
+
/**
|
|
5415
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5416
|
+
*/
|
|
4614
5417
|
type QueryTrigger = 'program' | 'poll' | 'auto';
|
|
5418
|
+
/**
|
|
5419
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5420
|
+
*/
|
|
4615
5421
|
type EmptyObject = {};
|
|
5422
|
+
/**
|
|
5423
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5424
|
+
*/
|
|
4616
5425
|
type ExecuteQueryOptions = {
|
|
4617
5426
|
/**
|
|
4618
5427
|
* Whether to skip the cache for this query. This will force the query to be executed. It might still be caught by the native browser cache.
|
|
@@ -4625,11 +5434,23 @@ type ExecuteQueryOptions = {
|
|
|
4625
5434
|
*/
|
|
4626
5435
|
cancelPrevious?: boolean;
|
|
4627
5436
|
};
|
|
5437
|
+
/**
|
|
5438
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5439
|
+
*/
|
|
4628
5440
|
type V2RouteType<Arguments extends BaseArguments | undefined> = Arguments extends {
|
|
4629
5441
|
pathParams: infer PathParams;
|
|
4630
5442
|
} ? (p: PathParams) => V2RouteString : V2RouteString;
|
|
5443
|
+
/**
|
|
5444
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5445
|
+
*/
|
|
4631
5446
|
type V2RouteString = `/${string}`;
|
|
5447
|
+
/**
|
|
5448
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5449
|
+
*/
|
|
4632
5450
|
type AnyRoute = ((p: PathParams) => string) | V2RouteString;
|
|
5451
|
+
/**
|
|
5452
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5453
|
+
*/
|
|
4633
5454
|
type PollConfig = {
|
|
4634
5455
|
/**
|
|
4635
5456
|
* The interval in milliseconds to poll the query.
|
|
@@ -4644,6 +5465,9 @@ type PollConfig = {
|
|
|
4644
5465
|
*/
|
|
4645
5466
|
triggerImmediately?: boolean;
|
|
4646
5467
|
};
|
|
5468
|
+
/**
|
|
5469
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5470
|
+
*/
|
|
4647
5471
|
declare const enum QueryStateType {
|
|
4648
5472
|
Prepared = "PREPARED",
|
|
4649
5473
|
Loading = "LOADING",
|
|
@@ -4651,31 +5475,49 @@ declare const enum QueryStateType {
|
|
|
4651
5475
|
Failure = "FAILURE",
|
|
4652
5476
|
Cancelled = "CANCELLED"
|
|
4653
5477
|
}
|
|
5478
|
+
/**
|
|
5479
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5480
|
+
*/
|
|
4654
5481
|
type Prepared = {
|
|
4655
5482
|
type: QueryStateType.Prepared;
|
|
4656
5483
|
meta: QueryStateMeta;
|
|
4657
5484
|
};
|
|
5485
|
+
/**
|
|
5486
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5487
|
+
*/
|
|
4658
5488
|
type Success<Response = unknown> = {
|
|
4659
5489
|
type: QueryStateType.Success;
|
|
4660
5490
|
response: Response;
|
|
4661
5491
|
headers: RequestHeaders;
|
|
4662
5492
|
meta: QueryStateSuccessMeta;
|
|
4663
5493
|
};
|
|
5494
|
+
/**
|
|
5495
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5496
|
+
*/
|
|
4664
5497
|
type Failure = {
|
|
4665
5498
|
type: QueryStateType.Failure;
|
|
4666
5499
|
error: RequestError;
|
|
4667
5500
|
meta: QueryStateMeta;
|
|
4668
5501
|
};
|
|
5502
|
+
/**
|
|
5503
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5504
|
+
*/
|
|
4669
5505
|
type Loading = {
|
|
4670
5506
|
type: QueryStateType.Loading;
|
|
4671
5507
|
meta: QueryStateMeta;
|
|
4672
5508
|
partialText?: string;
|
|
4673
5509
|
progress?: RequestProgress;
|
|
4674
5510
|
};
|
|
5511
|
+
/**
|
|
5512
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5513
|
+
*/
|
|
4675
5514
|
type Cancelled = {
|
|
4676
5515
|
type: QueryStateType.Cancelled;
|
|
4677
5516
|
meta: QueryStateMeta;
|
|
4678
5517
|
};
|
|
5518
|
+
/**
|
|
5519
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5520
|
+
*/
|
|
4679
5521
|
type QueryStateMeta = {
|
|
4680
5522
|
id: number;
|
|
4681
5523
|
triggeredVia: QueryTrigger;
|
|
@@ -4683,15 +5525,33 @@ type QueryStateMeta = {
|
|
|
4683
5525
|
retryNumber?: number;
|
|
4684
5526
|
retryDelay?: number;
|
|
4685
5527
|
};
|
|
5528
|
+
/**
|
|
5529
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5530
|
+
*/
|
|
4686
5531
|
type QueryStateSuccessMeta = QueryStateMeta & {
|
|
4687
5532
|
expiresAt?: number;
|
|
4688
5533
|
};
|
|
5534
|
+
/**
|
|
5535
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5536
|
+
*/
|
|
4689
5537
|
type V2QueryState<Response = unknown> = Loading | Success<Response> | Failure | Cancelled | Prepared;
|
|
5538
|
+
/**
|
|
5539
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5540
|
+
*/
|
|
4690
5541
|
type QueryStateResponseOf<T extends V2QueryState = V2QueryState> = T extends Success<infer Response> ? Response : never;
|
|
5542
|
+
/**
|
|
5543
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5544
|
+
*/
|
|
4691
5545
|
type AnyV2Query = V2Query<any, any, any, any, any, any>;
|
|
5546
|
+
/**
|
|
5547
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5548
|
+
*/
|
|
4692
5549
|
type AnyQueryCreatorCollection = {
|
|
4693
5550
|
[name: string]: AnyV2QueryCreator | AnyLegacyQueryCreator;
|
|
4694
5551
|
};
|
|
5552
|
+
/**
|
|
5553
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5554
|
+
*/
|
|
4695
5555
|
type QueryCollectionOf<T extends {
|
|
4696
5556
|
[name: string]: AnyV2QueryCreator | AnyLegacyQueryCreator;
|
|
4697
5557
|
}> = {
|
|
@@ -4700,17 +5560,38 @@ type QueryCollectionOf<T extends {
|
|
|
4700
5560
|
query: ConstructQuery<T[K]>;
|
|
4701
5561
|
};
|
|
4702
5562
|
}[keyof T];
|
|
5563
|
+
/**
|
|
5564
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5565
|
+
*/
|
|
4703
5566
|
type AnyQueryCollection = {
|
|
4704
5567
|
type: string;
|
|
4705
5568
|
query: AnyV2Query | AnyLegacyQuery;
|
|
4706
5569
|
};
|
|
5570
|
+
/**
|
|
5571
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5572
|
+
*/
|
|
4707
5573
|
type QueryOf<T extends AnyQueryCollection | AnyLegacyQuery | AnyV2Query | null> = T extends AnyV2Query ? T : T extends AnyLegacyQuery ? T : T extends AnyQueryCollection ? T['query'] : never;
|
|
5574
|
+
/**
|
|
5575
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5576
|
+
*/
|
|
4708
5577
|
type AnyQueryCollectionResponse<T extends AnyQueryCollection> = QueryResponseOf<T['query']>;
|
|
5578
|
+
/**
|
|
5579
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5580
|
+
*/
|
|
4709
5581
|
type AnyQueryCollectionData<T extends AnyQueryCollection> = QueryDataOf<T['query']>;
|
|
5582
|
+
/**
|
|
5583
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5584
|
+
*/
|
|
4710
5585
|
type QueryCollectionKeysOf<T extends AnyQueryCollection | AnyLegacyQuery | AnyV2Query | null> = T extends AnyQueryCollection ? T['type'] : never;
|
|
5586
|
+
/**
|
|
5587
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5588
|
+
*/
|
|
4711
5589
|
type QueryCollectionWithNullableQuery<T extends AnyQueryCollection | null> = T extends null ? never : {
|
|
4712
5590
|
[K in keyof T]: T[K] extends string ? T[K] : T[K] | null;
|
|
4713
5591
|
};
|
|
5592
|
+
/**
|
|
5593
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5594
|
+
*/
|
|
4714
5595
|
type ResetPageOnErrorOperatorConfig<J extends QueryForm<any>> = {
|
|
4715
5596
|
/**
|
|
4716
5597
|
* The query form to reset the page of.
|
|
@@ -4723,6 +5604,9 @@ type ResetPageOnErrorOperatorConfig<J extends QueryForm<any>> = {
|
|
|
4723
5604
|
pageControlKey?: string;
|
|
4724
5605
|
};
|
|
4725
5606
|
|
|
5607
|
+
/**
|
|
5608
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5609
|
+
*/
|
|
4726
5610
|
declare class V2Query<Response, Arguments extends BaseArguments | undefined, Route extends V2RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> {
|
|
4727
5611
|
private readonly _client;
|
|
4728
5612
|
readonly _id: number;
|
|
@@ -4781,61 +5665,154 @@ declare class V2Query<Response, Arguments extends BaseArguments | undefined, Rou
|
|
|
4781
5665
|
}
|
|
4782
5666
|
|
|
4783
5667
|
type OmitNull<T> = T extends null ? never : T;
|
|
5668
|
+
/**
|
|
5669
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5670
|
+
*/
|
|
4784
5671
|
declare function filterSuccess(): <T extends V2QueryState | null, Response extends QueryStateResponseOf<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response>>;
|
|
5672
|
+
/**
|
|
5673
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5674
|
+
*/
|
|
4785
5675
|
declare function ignoreAutoRefresh(): <T extends V2QueryState | null>(source: Observable<T>) => Observable<T>;
|
|
5676
|
+
/**
|
|
5677
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5678
|
+
*/
|
|
4786
5679
|
declare function filterFailure(): <T extends V2QueryState | null>(source: Observable<T>) => Observable<Failure>;
|
|
5680
|
+
/**
|
|
5681
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5682
|
+
*/
|
|
4787
5683
|
declare function filterQueryStates(allowedStates: QueryStateType[]): <T extends V2QueryState | null>(source: Observable<T>) => Observable<T>;
|
|
5684
|
+
/**
|
|
5685
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5686
|
+
*/
|
|
4788
5687
|
declare function takeUntilResponse(config?: {
|
|
4789
5688
|
excludeNull?: boolean;
|
|
4790
5689
|
}): <T extends V2QueryState | null>(source: Observable<T>) => Observable<T>;
|
|
5690
|
+
/**
|
|
5691
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5692
|
+
*/
|
|
4791
5693
|
declare function filterNull(): <T>(source: Observable<T>) => Observable<OmitNull<T>>;
|
|
5694
|
+
/**
|
|
5695
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5696
|
+
*/
|
|
4792
5697
|
declare function switchQueryState(): <T extends AnyV2Query | AnyLegacyQuery | null, Data extends QueryDataOf<T>>(source: Observable<T>) => Observable<V2QueryState<Data> | null>;
|
|
5698
|
+
/**
|
|
5699
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5700
|
+
*/
|
|
4793
5701
|
declare function switchQueryCollectionState(): <T extends AnyQueryCollection | null, Data extends AnyQueryCollectionData<OmitNull<T>>>(source: Observable<T>) => Observable<V2QueryState<Data> | null>;
|
|
5702
|
+
/**
|
|
5703
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5704
|
+
*/
|
|
4794
5705
|
declare const resetPageOnError: <T extends AnyV2Query | AnyLegacyQuery | null | undefined, J extends QueryForm<any>>(config: ResetPageOnErrorOperatorConfig<J>) => (source: Observable<T>) => Observable<V2QueryState<any> | T>;
|
|
5706
|
+
/**
|
|
5707
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5708
|
+
*/
|
|
4795
5709
|
declare const isQueryStateLoading: (state: V2QueryState | null | undefined) => state is Loading;
|
|
5710
|
+
/**
|
|
5711
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5712
|
+
*/
|
|
4796
5713
|
declare const isQueryStateSuccess: (state: V2QueryState | null | undefined) => state is Success;
|
|
5714
|
+
/**
|
|
5715
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5716
|
+
*/
|
|
4797
5717
|
declare const isQueryStateFailure: (state: V2QueryState | null | undefined) => state is Failure;
|
|
5718
|
+
/**
|
|
5719
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5720
|
+
*/
|
|
4798
5721
|
declare const isQueryStateCancelled: (state: V2QueryState | null | undefined) => state is Cancelled;
|
|
5722
|
+
/**
|
|
5723
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5724
|
+
*/
|
|
4799
5725
|
declare const isQueryStatePrepared: (state: V2QueryState | null | undefined) => state is Prepared;
|
|
5726
|
+
/**
|
|
5727
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5728
|
+
*/
|
|
4800
5729
|
declare const isAutoRefresh: (state: V2QueryState | null | undefined) => boolean;
|
|
5730
|
+
/**
|
|
5731
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5732
|
+
*/
|
|
4801
5733
|
declare const mergeHeaders: (...headers: Array<RequestHeaders | null | undefined>) => RequestHeaders | null | undefined;
|
|
5734
|
+
/**
|
|
5735
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5736
|
+
*/
|
|
4802
5737
|
declare const isGqlQueryConfig: <Response, Arguments extends BaseArguments | undefined, Route extends V2RouteType<Arguments> | undefined, Store extends EntityStore<unknown>, Data, Id>(config: unknown) => config is GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>;
|
|
5738
|
+
/**
|
|
5739
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5740
|
+
*/
|
|
4803
5741
|
declare const isQuery: <T extends AnyV2Query | AnyLegacyQuery>(query: unknown) => query is T;
|
|
5742
|
+
/**
|
|
5743
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5744
|
+
*/
|
|
4804
5745
|
declare const isQueryCollection: <T extends AnyQueryCollection>(query: unknown) => query is T;
|
|
5746
|
+
/**
|
|
5747
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5748
|
+
*/
|
|
4805
5749
|
declare const createQueryCollection: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T) => BehaviorSubject<R | null>;
|
|
5750
|
+
/**
|
|
5751
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5752
|
+
*/
|
|
4806
5753
|
declare const createQueryCollectionSubject: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T, config?: QueryContainerConfig) => BehaviorSubject<R | null>;
|
|
5754
|
+
/**
|
|
5755
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5756
|
+
*/
|
|
4807
5757
|
declare const createQueryCollectionSignal: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T, config?: QueryContainerConfig) => _angular_core.WritableSignal<R | null>;
|
|
5758
|
+
/**
|
|
5759
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5760
|
+
*/
|
|
4808
5761
|
declare const extractQuery: <T extends AnyV2Query | AnyLegacyQuery | AnyQueryCollection | null>(v: T) => AnyV2Query | AnyLegacyQuery | null;
|
|
5762
|
+
/**
|
|
5763
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5764
|
+
*/
|
|
4809
5765
|
declare const getDefaultHeaders: (headers: RequestHeaders | RequestHeadersMethodMap | null | undefined, method: Method) => RequestHeaders;
|
|
5766
|
+
/**
|
|
5767
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5768
|
+
*/
|
|
4810
5769
|
declare const castQueryCreatorTypes: <QC extends AnyV2QueryCreator, Arguments extends V2QueryArgsOf<QC>, Response extends QueryResponseOf<QC>, Store extends QueryStoreOf<QC>, Data extends QueryDataOf<QC>, Route extends V2RouteType<Arguments>, Id extends QueryStoreIdOf<QC>, OverrideArguments extends BaseArguments | undefined, OverrideResponse extends Response | undefined>(config: {
|
|
4811
5770
|
creator: QC;
|
|
4812
5771
|
args?: OverrideArguments;
|
|
4813
5772
|
response?: OverrideResponse;
|
|
4814
5773
|
}) => V2QueryCreator<OverrideArguments, OverrideResponse, Route, Store, Data, Id>;
|
|
5774
|
+
/**
|
|
5775
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5776
|
+
*/
|
|
4815
5777
|
declare const computeQueryMethod: (config: {
|
|
4816
5778
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
4817
5779
|
client: V2QueryClient;
|
|
4818
5780
|
}) => "GET" | "OPTIONS" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
|
|
5781
|
+
/**
|
|
5782
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5783
|
+
*/
|
|
4819
5784
|
declare const computeQueryBody: (config: {
|
|
4820
5785
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
4821
5786
|
client: V2QueryClient;
|
|
4822
5787
|
method: Method;
|
|
4823
5788
|
args?: BaseArguments;
|
|
4824
5789
|
}) => unknown;
|
|
5790
|
+
/**
|
|
5791
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5792
|
+
*/
|
|
4825
5793
|
declare const computeQueryAuthHeader: (config: {
|
|
4826
5794
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
4827
5795
|
client: V2QueryClient;
|
|
4828
5796
|
}) => Record<string, string> | null;
|
|
5797
|
+
/**
|
|
5798
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5799
|
+
*/
|
|
4829
5800
|
declare const computeQueryHeaders: (config: {
|
|
4830
5801
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
4831
5802
|
client: V2QueryClient;
|
|
4832
5803
|
args?: BaseArguments;
|
|
4833
5804
|
}) => RequestHeaders | undefined;
|
|
5805
|
+
/**
|
|
5806
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5807
|
+
*/
|
|
4834
5808
|
declare const computeQueryQueryParams: (config: {
|
|
4835
5809
|
config: AnyRestQueryConfig | AnyGqlQueryConfig;
|
|
4836
5810
|
client: V2QueryClient;
|
|
4837
5811
|
args?: BaseArguments;
|
|
4838
5812
|
}) => object | undefined;
|
|
5813
|
+
/**
|
|
5814
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5815
|
+
*/
|
|
4839
5816
|
declare const paginatedEntityValueUpdater: <T extends Paginated<unknown>, Args extends BaseArguments, Entity, J extends (T extends Paginated<infer X> ? X : never)>(findFn: (val: J, entity: Entity) => boolean) => ({ response, rawResponse, entity }: {
|
|
4840
5817
|
rawResponse: T;
|
|
4841
5818
|
response: T;
|
|
@@ -4850,6 +5827,9 @@ declare const paginatedEntityValueUpdater: <T extends Paginated<unknown>, Args e
|
|
|
4850
5827
|
};
|
|
4851
5828
|
} | null;
|
|
4852
5829
|
|
|
5830
|
+
/**
|
|
5831
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5832
|
+
*/
|
|
4853
5833
|
type V2QueryClientConfig = {
|
|
4854
5834
|
/**
|
|
4855
5835
|
* The api base route. Should **not** end with a trailing slash.
|
|
@@ -4930,6 +5910,9 @@ type V2QueryClientConfig = {
|
|
|
4930
5910
|
parent?: V2QueryClient;
|
|
4931
5911
|
};
|
|
4932
5912
|
|
|
5913
|
+
/**
|
|
5914
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5915
|
+
*/
|
|
4933
5916
|
declare class V2QueryClient {
|
|
4934
5917
|
private _clientConfig;
|
|
4935
5918
|
private readonly _authProvider$;
|
|
@@ -4954,9 +5937,18 @@ declare class V2QueryClient {
|
|
|
4954
5937
|
get authProvider$(): rxjs.Observable<AuthProvider | null>;
|
|
4955
5938
|
}
|
|
4956
5939
|
|
|
5940
|
+
/**
|
|
5941
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5942
|
+
*/
|
|
4957
5943
|
declare const v2ShouldCacheQuery: (method: Method) => method is "GET" | "OPTIONS" | "HEAD" | "GQL_QUERY";
|
|
5944
|
+
/**
|
|
5945
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5946
|
+
*/
|
|
4958
5947
|
declare const v2BuildQueryCacheKey: (route: string, args: BaseArguments | undefined) => string;
|
|
4959
5948
|
|
|
5949
|
+
/**
|
|
5950
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5951
|
+
*/
|
|
4960
5952
|
declare class QueryStore {
|
|
4961
5953
|
private _config?;
|
|
4962
5954
|
private garbageCollector;
|
|
@@ -4988,16 +5980,46 @@ declare class QueryStore {
|
|
|
4988
5980
|
private logGarbageCollector;
|
|
4989
5981
|
}
|
|
4990
5982
|
|
|
5983
|
+
/**
|
|
5984
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5985
|
+
*/
|
|
4991
5986
|
type QueryPrepareFn<Arguments extends BaseArguments | undefined, Response, Route extends V2RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> = Arguments extends BaseArguments ? (args: Arguments & WithHeaders & WithConfig & WithMock<Response>) => V2Query<Response, Arguments, Route, Store, Data, Id> : (args?: (Arguments extends EmptyObject ? Arguments : EmptyObject) & WithHeaders & WithConfig & WithMock<Response>) => V2Query<Response, Arguments, Route, Store, Data, Id>;
|
|
5987
|
+
/**
|
|
5988
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5989
|
+
*/
|
|
4992
5990
|
type AnyV2QueryCreator = V2QueryCreator<any, any, any, any, any, any>;
|
|
5991
|
+
/**
|
|
5992
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5993
|
+
*/
|
|
4993
5994
|
type V2QueryArgsOf<T extends AnyV2QueryCreator | AnyV2Query | AnyLegacyQuery | AnyLegacyQueryCreator | null> = T extends V2QueryCreator<infer Args, any, any, any, any, any> ? Args : T extends V2Query<any, infer Args, any, any, any, any> ? Args : T extends LegacyQuery<any, infer Args, any, any, any, any, any> ? Args : T extends LegacyQueryCreator<infer Args, any, any, any, any> ? LegacyArgumentsOfQueryArgs<Args> : never;
|
|
5995
|
+
/**
|
|
5996
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5997
|
+
*/
|
|
4994
5998
|
type QueryResponseOf<T extends AnyV2QueryCreator | AnyV2Query | AnyLegacyQuery | AnyLegacyQueryCreator | null> = T extends V2QueryCreator<any, infer Response, any, any, any, any> ? Response : T extends V2Query<infer Response, any, any, any, any, any> ? Response : T extends LegacyQuery<infer Response, any, any, any, any, any, any> ? Response : T extends LegacyQueryCreator<any, infer Response, any, any, any> ? Response : never;
|
|
5999
|
+
/**
|
|
6000
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6001
|
+
*/
|
|
4995
6002
|
type QueryRouteOf<T extends AnyV2QueryCreator | AnyV2Query | AnyLegacyQuery | AnyLegacyQueryCreator | null> = T extends V2QueryCreator<any, any, infer Route, any, any, any> ? Route : T extends V2Query<any, any, infer Route, any, any, any> ? Route : T extends LegacyQuery<any, any, infer Route, any, any, any, any> ? Route : T extends LegacyQueryCreator<infer Args, any, any, any, any> ? V2RouteType<LegacyArgumentsOfQueryArgs<Args>> : never;
|
|
6003
|
+
/**
|
|
6004
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6005
|
+
*/
|
|
4996
6006
|
type QueryStoreOf<T extends AnyV2QueryCreator | AnyV2Query | AnyLegacyQuery | AnyLegacyQueryCreator | null> = T extends V2QueryCreator<any, any, any, infer Store, any, any> ? Store : T extends V2Query<any, any, any, infer Store, any, any> ? Store : T extends LegacyQuery<any, any, any, infer Store, any, any, any> ? Store : T extends LegacyQueryCreator<any, any, infer Store, any, any> ? Store : never;
|
|
6007
|
+
/**
|
|
6008
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6009
|
+
*/
|
|
4997
6010
|
type QueryDataOf<T extends AnyV2QueryCreator | AnyLegacyQuery | AnyLegacyQueryCreator | AnyV2Query | null> = T extends V2QueryCreator<any, any, any, any, infer Data, any> ? Data : T extends V2Query<any, any, any, any, infer Data, any> ? Data : T extends LegacyQuery<any, any, any, any, infer Data, any, any> ? Data : T extends LegacyQueryCreator<any, any, any, any, infer Data> ? Data : never;
|
|
6011
|
+
/**
|
|
6012
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6013
|
+
*/
|
|
4998
6014
|
type QueryStoreIdOf<T extends AnyV2QueryCreator | AnyV2Query | AnyLegacyQuery | AnyLegacyQueryCreator | null> = T extends V2QueryCreator<any, any, any, any, any, infer StoreId> ? StoreId : T extends V2Query<any, any, any, any, any, infer StoreId> ? StoreId : T extends LegacyQuery<any, any, any, any, any, infer StoreId, any> ? StoreId : T extends LegacyQueryCreator<any, any, any, infer StoreId, any> ? StoreId : never;
|
|
6015
|
+
/**
|
|
6016
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6017
|
+
*/
|
|
4999
6018
|
type ConstructQuery<T extends AnyV2QueryCreator | AnyLegacyQueryCreator> = ReturnType<T['prepare']>;
|
|
5000
6019
|
|
|
6020
|
+
/**
|
|
6021
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6022
|
+
*/
|
|
5001
6023
|
declare class V2QueryCreator<Arguments extends BaseArguments | undefined, Response, Route extends V2RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> {
|
|
5002
6024
|
private _queryConfig;
|
|
5003
6025
|
private _client;
|
|
@@ -5009,6 +6031,9 @@ declare class V2QueryCreator<Arguments extends BaseArguments | undefined, Respon
|
|
|
5009
6031
|
constructor(_queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, _client: V2QueryClient, _store: QueryStore);
|
|
5010
6032
|
}
|
|
5011
6033
|
|
|
6034
|
+
/**
|
|
6035
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6036
|
+
*/
|
|
5012
6037
|
type AuthProvider = {
|
|
5013
6038
|
/**
|
|
5014
6039
|
* The up to date auth header.
|
|
@@ -5016,6 +6041,9 @@ type AuthProvider = {
|
|
|
5016
6041
|
*/
|
|
5017
6042
|
header: Record<string, string>;
|
|
5018
6043
|
};
|
|
6044
|
+
/**
|
|
6045
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6046
|
+
*/
|
|
5019
6047
|
type AuthProviderBasicConfig = {
|
|
5020
6048
|
/**
|
|
5021
6049
|
* Basic auth username
|
|
@@ -5026,6 +6054,9 @@ type AuthProviderBasicConfig = {
|
|
|
5026
6054
|
*/
|
|
5027
6055
|
password: string;
|
|
5028
6056
|
};
|
|
6057
|
+
/**
|
|
6058
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6059
|
+
*/
|
|
5029
6060
|
type AuthProviderCustomHeaderConfig = {
|
|
5030
6061
|
/**
|
|
5031
6062
|
* The custom header name
|
|
@@ -5038,6 +6069,9 @@ type AuthProviderCustomHeaderConfig = {
|
|
|
5038
6069
|
*/
|
|
5039
6070
|
value: string;
|
|
5040
6071
|
};
|
|
6072
|
+
/**
|
|
6073
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6074
|
+
*/
|
|
5041
6075
|
type AuthProviderBearerConfig<T extends AnyV2QueryCreator> = {
|
|
5042
6076
|
/**
|
|
5043
6077
|
* The initial jwt
|
|
@@ -5048,6 +6082,9 @@ type AuthProviderBearerConfig<T extends AnyV2QueryCreator> = {
|
|
|
5048
6082
|
*/
|
|
5049
6083
|
refreshConfig?: BearerRefreshConfig<T>;
|
|
5050
6084
|
};
|
|
6085
|
+
/**
|
|
6086
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6087
|
+
*/
|
|
5051
6088
|
type BearerRefreshConfig<T extends AnyV2QueryCreator> = {
|
|
5052
6089
|
/**
|
|
5053
6090
|
* The query used to trade the refresh token for a new token response.
|
|
@@ -5123,6 +6160,9 @@ type BearerRefreshConfig<T extends AnyV2QueryCreator> = {
|
|
|
5123
6160
|
*/
|
|
5124
6161
|
responseAdapter?: (response: NonNullable<QueryResponseOf<T>>) => TokenResponse;
|
|
5125
6162
|
};
|
|
6163
|
+
/**
|
|
6164
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6165
|
+
*/
|
|
5126
6166
|
declare const enum AuthBearerRefreshStrategy {
|
|
5127
6167
|
/**
|
|
5128
6168
|
* Automatically refresh the token 5 minutes before expiration.
|
|
@@ -5130,6 +6170,9 @@ declare const enum AuthBearerRefreshStrategy {
|
|
|
5130
6170
|
*/
|
|
5131
6171
|
BeforeExpiration = "beforeExpiration"
|
|
5132
6172
|
}
|
|
6173
|
+
/**
|
|
6174
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6175
|
+
*/
|
|
5133
6176
|
type TokenResponse = {
|
|
5134
6177
|
/**
|
|
5135
6178
|
* The access token used inside the authorization http header.
|
|
@@ -5142,6 +6185,9 @@ type TokenResponse = {
|
|
|
5142
6185
|
refreshToken: string | null;
|
|
5143
6186
|
};
|
|
5144
6187
|
|
|
6188
|
+
/**
|
|
6189
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6190
|
+
*/
|
|
5145
6191
|
declare class CustomHeaderAuthProvider implements AuthProvider {
|
|
5146
6192
|
_config: AuthProviderCustomHeaderConfig;
|
|
5147
6193
|
constructor(_config: AuthProviderCustomHeaderConfig);
|
|
@@ -5151,6 +6197,9 @@ declare class CustomHeaderAuthProvider implements AuthProvider {
|
|
|
5151
6197
|
cleanUp(): void;
|
|
5152
6198
|
}
|
|
5153
6199
|
|
|
6200
|
+
/**
|
|
6201
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6202
|
+
*/
|
|
5154
6203
|
declare class BasicAuthProvider implements AuthProvider {
|
|
5155
6204
|
_config: AuthProviderBasicConfig;
|
|
5156
6205
|
constructor(_config: AuthProviderBasicConfig);
|
|
@@ -5161,6 +6210,9 @@ declare class BasicAuthProvider implements AuthProvider {
|
|
|
5161
6210
|
private get basicAuthString();
|
|
5162
6211
|
}
|
|
5163
6212
|
|
|
6213
|
+
/**
|
|
6214
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6215
|
+
*/
|
|
5164
6216
|
declare class V2BearerAuthProvider<T extends AnyV2QueryCreator> implements AuthProvider {
|
|
5165
6217
|
_config: AuthProviderBearerConfig<T>;
|
|
5166
6218
|
private readonly destroy$;
|
|
@@ -5184,15 +6236,33 @@ declare class V2BearerAuthProvider<T extends AnyV2QueryCreator> implements AuthP
|
|
|
5184
6236
|
private prepareForRefresh;
|
|
5185
6237
|
}
|
|
5186
6238
|
|
|
6239
|
+
/**
|
|
6240
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6241
|
+
*/
|
|
5187
6242
|
declare const isBasicAuthProvider: (authProvider: AuthProvider) => authProvider is BasicAuthProvider;
|
|
6243
|
+
/**
|
|
6244
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6245
|
+
*/
|
|
5188
6246
|
declare const isBearerAuthProvider: <T extends AnyV2QueryCreator>(authProvider: AuthProvider) => authProvider is V2BearerAuthProvider<T>;
|
|
6247
|
+
/**
|
|
6248
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6249
|
+
*/
|
|
5189
6250
|
declare const isCustomHeaderAuthProvider: (authProvider: AuthProvider) => authProvider is CustomHeaderAuthProvider;
|
|
5190
6251
|
|
|
6252
|
+
/**
|
|
6253
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6254
|
+
*/
|
|
5191
6255
|
type QueryClientDevtoolsOptions = {
|
|
5192
6256
|
displayName?: string;
|
|
5193
6257
|
client: V2QueryClient;
|
|
5194
6258
|
};
|
|
6259
|
+
/**
|
|
6260
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6261
|
+
*/
|
|
5195
6262
|
declare const QUERY_CLIENT_DEVTOOLS_TOKEN: InjectionToken<QueryClientDevtoolsOptions[]>;
|
|
6263
|
+
/**
|
|
6264
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6265
|
+
*/
|
|
5196
6266
|
declare const provideQueryClientForDevtools: (queryClient: QueryClientDevtoolsOptions) => {
|
|
5197
6267
|
provide: InjectionToken<QueryClientDevtoolsOptions[]>;
|
|
5198
6268
|
useValue: QueryClientDevtoolsOptions;
|
|
@@ -5202,6 +6272,9 @@ declare const provideQueryClientForDevtools: (queryClient: QueryClientDevtoolsOp
|
|
|
5202
6272
|
type QueryDevtoolsSnapLayout = 'full' | 'left' | 'right' | 'bottom' | 'top';
|
|
5203
6273
|
type QueryListMode = 'live' | 'history';
|
|
5204
6274
|
type QueryViewMode = 'query' | 'authProvider';
|
|
6275
|
+
/**
|
|
6276
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6277
|
+
*/
|
|
5205
6278
|
declare class QueryDevtoolsComponent {
|
|
5206
6279
|
private cdr;
|
|
5207
6280
|
protected queryClientConfigs: QueryClientDevtoolsOptions[];
|
|
@@ -5342,30 +6415,54 @@ declare class QueryDevtoolsComponent {
|
|
|
5342
6415
|
static ɵcmp: _angular_core.ɵɵComponentDeclaration<QueryDevtoolsComponent, "et-query-devtools", never, {}, {}, never, never, true, never>;
|
|
5343
6416
|
}
|
|
5344
6417
|
|
|
6418
|
+
/**
|
|
6419
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6420
|
+
*/
|
|
5345
6421
|
declare class QueryShortNamePipe implements PipeTransform {
|
|
5346
6422
|
transform(value: AnyV2Query): string;
|
|
5347
6423
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<QueryShortNamePipe, never>;
|
|
5348
6424
|
static ɵpipe: _angular_core.ɵɵPipeDeclaration<QueryShortNamePipe, "queryShortName", true>;
|
|
5349
6425
|
}
|
|
5350
6426
|
|
|
6427
|
+
/**
|
|
6428
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6429
|
+
*/
|
|
5351
6430
|
declare const provideInfinityQueryResponseDelay: () => _angular_core.Provider[];
|
|
6431
|
+
/**
|
|
6432
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6433
|
+
*/
|
|
5352
6434
|
declare const injectInfinityQueryResponseDelay: _ethlete_core.InjectFn<{
|
|
5353
6435
|
enabled: _angular_core.WritableSignal<boolean>;
|
|
5354
6436
|
enabled$: rxjs.Observable<boolean>;
|
|
5355
6437
|
}>;
|
|
5356
6438
|
|
|
6439
|
+
/**
|
|
6440
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6441
|
+
*/
|
|
5357
6442
|
type InfinityQueryParamLocation = 'path' | 'query' | 'body' | 'header' | 'variable';
|
|
6443
|
+
/**
|
|
6444
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6445
|
+
*/
|
|
5358
6446
|
type AppendItemsLocation = 'start' | 'end';
|
|
6447
|
+
/**
|
|
6448
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6449
|
+
*/
|
|
5359
6450
|
type PageParamCalculatorOptions = {
|
|
5360
6451
|
page: number;
|
|
5361
6452
|
totalPages: number | null;
|
|
5362
6453
|
itemsPerPage: number;
|
|
5363
6454
|
};
|
|
6455
|
+
/**
|
|
6456
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6457
|
+
*/
|
|
5364
6458
|
type TotalPagesExtractorOptions<Arguments extends BaseArguments | undefined, QueryResponse> = {
|
|
5365
6459
|
response: QueryResponse;
|
|
5366
6460
|
itemsPerPage: number;
|
|
5367
6461
|
args: Arguments;
|
|
5368
6462
|
};
|
|
6463
|
+
/**
|
|
6464
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6465
|
+
*/
|
|
5369
6466
|
type InfinityQueryConfig<QueryCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator, Arguments extends BaseArguments | undefined, QueryResponse, InfinityResponse extends unknown[]> = {
|
|
5370
6467
|
/**
|
|
5371
6468
|
* The query creator to use for fetching pages.
|
|
@@ -5455,11 +6552,26 @@ type InfinityQueryConfig<QueryCreator extends AnyV2QueryCreator | AnyLegacyQuery
|
|
|
5455
6552
|
};
|
|
5456
6553
|
};
|
|
5457
6554
|
type OmitUndefined<T> = T extends undefined ? never : T;
|
|
6555
|
+
/**
|
|
6556
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6557
|
+
*/
|
|
5458
6558
|
type AnyInfinityQueryConfig = InfinityQueryConfig<any, any, any, any>;
|
|
6559
|
+
/**
|
|
6560
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6561
|
+
*/
|
|
5459
6562
|
type AnyInfinityQuery = InfinityQuery<any, any, any, any, any>;
|
|
6563
|
+
/**
|
|
6564
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6565
|
+
*/
|
|
5460
6566
|
type InfinityQueryConfigType<QueryCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator, InfinityResponse extends unknown[]> = InfinityQueryConfig<QueryCreator, OmitUndefined<V2QueryArgsOf<QueryCreator>>, QueryDataOf<QueryCreator>, InfinityResponse>;
|
|
6567
|
+
/**
|
|
6568
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6569
|
+
*/
|
|
5461
6570
|
type InfinityQueryOf<Cfg extends AnyInfinityQueryConfig | null> = InfinityQuery<NonNullable<Cfg>['queryCreator'], ConstructQuery<NonNullable<Cfg>['queryCreator']>, V2QueryArgsOf<NonNullable<Cfg>['queryCreator']>, QueryDataOf<NonNullable<Cfg>['queryCreator']>, NonNullable<Cfg>['response']['arrayType']>;
|
|
5462
6571
|
|
|
6572
|
+
/**
|
|
6573
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6574
|
+
*/
|
|
5463
6575
|
declare class InfinityQuery<QueryCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator, Query extends ConstructQuery<QueryCreator>, Args extends V2QueryArgsOf<QueryCreator>, QueryResponse extends QueryDataOf<QueryCreator>, InfinityResponse extends unknown[]> {
|
|
5464
6576
|
private _config;
|
|
5465
6577
|
private _destroy$;
|
|
@@ -5487,7 +6599,13 @@ declare class InfinityQuery<QueryCreator extends AnyV2QueryCreator | AnyLegacyQu
|
|
|
5487
6599
|
private getPageParamLocation;
|
|
5488
6600
|
}
|
|
5489
6601
|
|
|
6602
|
+
/**
|
|
6603
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6604
|
+
*/
|
|
5490
6605
|
declare const createInfinityQueryConfig: <QueryCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator, Args extends V2QueryArgsOf<QueryCreator>, QueryResponse extends QueryDataOf<QueryCreator>, InfinityResponse extends unknown[]>(config: InfinityQueryConfig<QueryCreator, Args, QueryResponse, InfinityResponse>) => InfinityQueryConfig<QueryCreator, Args, QueryResponse, InfinityResponse>;
|
|
6606
|
+
/**
|
|
6607
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6608
|
+
*/
|
|
5491
6609
|
declare const skipPaginationPageParamCalculator: ({ page, itemsPerPage }: PageParamCalculatorOptions) => number;
|
|
5492
6610
|
|
|
5493
6611
|
type InfinityQueryContext<Q extends InfinityQueryConfig<DirectiveQueryCreator, BaseArguments | undefined, any, unknown[]>> = {
|
|
@@ -5503,8 +6621,14 @@ type InfinityQueryContext<Q extends InfinityQueryConfig<DirectiveQueryCreator, B
|
|
|
5503
6621
|
itemsPerPage: number | null;
|
|
5504
6622
|
currentQuery: ConstructQuery<Q['queryCreator']> | null;
|
|
5505
6623
|
};
|
|
6624
|
+
/**
|
|
6625
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6626
|
+
*/
|
|
5506
6627
|
declare const INFINITY_QUERY_TOKEN: InjectionToken<InfinityQueryDirective<any>>;
|
|
5507
6628
|
type DirectiveQueryCreator = AnyV2QueryCreator | AnyLegacyQueryCreator;
|
|
6629
|
+
/**
|
|
6630
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6631
|
+
*/
|
|
5508
6632
|
declare class InfinityQueryDirective<Q extends InfinityQueryConfig<DirectiveQueryCreator, BaseArguments | undefined, any, unknown[]>> {
|
|
5509
6633
|
private readonly queryConfigChanged$;
|
|
5510
6634
|
private readonly viewContext;
|
|
@@ -5533,6 +6657,9 @@ declare class InfinityQueryDirective<Q extends InfinityQueryConfig<DirectiveQuer
|
|
|
5533
6657
|
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<InfinityQueryDirective<any>, "[etInfinityQuery]", ["etInfinityQuery"], { "infinityQuery": { "alias": "etInfinityQuery"; "required": false; }; }, {}, never, never, true, never>;
|
|
5534
6658
|
}
|
|
5535
6659
|
|
|
6660
|
+
/**
|
|
6661
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6662
|
+
*/
|
|
5536
6663
|
declare class InfinityQueryTriggerDirective implements OnInit, OnDestroy {
|
|
5537
6664
|
private elementRef;
|
|
5538
6665
|
private _infinityQuery;
|
|
@@ -5549,6 +6676,9 @@ declare class InfinityQueryTriggerDirective implements OnInit, OnDestroy {
|
|
|
5549
6676
|
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<InfinityQueryTriggerDirective, "[etInfinityQueryTrigger], et-infinity-query-trigger", never, { "scrollContainerSelector": { "alias": "scrollContainerSelector"; "required": false; "isSignal": true; }; "infinityQueryOverride": { "alias": "infinityQueryOverride"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
5550
6677
|
}
|
|
5551
6678
|
|
|
6679
|
+
/**
|
|
6680
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6681
|
+
*/
|
|
5552
6682
|
type QueryDirectiveContext<Q extends QueryDirectiveType | null> = {
|
|
5553
6683
|
/**
|
|
5554
6684
|
* The queries's response data.
|
|
@@ -5583,7 +6713,13 @@ type QueryDirectiveContext<Q extends QueryDirectiveType | null> = {
|
|
|
5583
6713
|
*/
|
|
5584
6714
|
scope: QueryCollectionKeysOf<Q> | null;
|
|
5585
6715
|
};
|
|
6716
|
+
/**
|
|
6717
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6718
|
+
*/
|
|
5586
6719
|
type QueryDirectiveType = AnyV2Query | AnyLegacyQuery | AnyQueryCollection;
|
|
6720
|
+
/**
|
|
6721
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6722
|
+
*/
|
|
5587
6723
|
declare class QueryDirective<Q extends QueryDirectiveType | null> {
|
|
5588
6724
|
private errorHandler;
|
|
5589
6725
|
private cdr;
|
|
@@ -5597,14 +6733,34 @@ declare class QueryDirective<Q extends QueryDirectiveType | null> {
|
|
|
5597
6733
|
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<QueryDirective<any>, "[etQuery]", never, { "query": { "alias": "etQuery"; "required": true; "isSignal": true; }; "cache": { "alias": "etQueryCache"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
5598
6734
|
}
|
|
5599
6735
|
|
|
6736
|
+
/**
|
|
6737
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6738
|
+
*/
|
|
5600
6739
|
declare const queryStateAlreadyHasKeyError: (data: unknown) => QueryError;
|
|
6740
|
+
/**
|
|
6741
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6742
|
+
*/
|
|
5601
6743
|
declare const queryStateDoesNotContainKeyError: (data: unknown) => QueryError;
|
|
6744
|
+
/**
|
|
6745
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6746
|
+
*/
|
|
5602
6747
|
declare const queryStateCannotTransformError: (data: unknown) => QueryError;
|
|
6748
|
+
/**
|
|
6749
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6750
|
+
*/
|
|
5603
6751
|
declare const invalidBodyError: (data: unknown) => QueryError;
|
|
5604
6752
|
|
|
5605
|
-
/**
|
|
6753
|
+
/**
|
|
6754
|
+
* The args accepted by the creator's `prepare()` - includes `mock`/`config` extras.
|
|
6755
|
+
*
|
|
6756
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6757
|
+
*/
|
|
5606
6758
|
type V2PrepareArgsOf<TCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator> = Parameters<TCreator['prepare']>[0];
|
|
5607
|
-
/**
|
|
6759
|
+
/**
|
|
6760
|
+
* Config for {@link validateWithV2Query}.
|
|
6761
|
+
*
|
|
6762
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
6763
|
+
*/
|
|
5608
6764
|
type ValidateWithV2QueryConfig<TCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator, TValue, TPathKind extends PathKind> = {
|
|
5609
6765
|
/**
|
|
5610
6766
|
* The legacy query creator to run (from `V2QueryClient`'s `post`/`get`, or a
|
|
@@ -5653,6 +6809,8 @@ type ValidateWithV2QueryConfig<TCreator extends AnyV2QueryCreator | AnyLegacyQue
|
|
|
5653
6809
|
* });
|
|
5654
6810
|
* });
|
|
5655
6811
|
* ```
|
|
6812
|
+
*
|
|
6813
|
+
* @deprecated Part of the legacy (v2) query system. Migrate to the current query API - see https://ethlete-sdk-docs.web.app/query/migrating-from-v2, and run `nx g @ethlete/query:migrate-to-query-v3` to rewrite the mechanical parts. Intent to remove in v7.
|
|
5656
6814
|
*/
|
|
5657
6815
|
declare const validateWithV2Query: <TCreator extends AnyV2QueryCreator | AnyLegacyQueryCreator, TValue, TPathKind extends PathKind = PathKind.Root>(path: SchemaPath<TValue, SchemaPathRules.Supported, TPathKind>, config: ValidateWithV2QueryConfig<TCreator, TValue, TPathKind>) => void;
|
|
5658
6816
|
|
|
@@ -5670,11 +6828,11 @@ declare class ParseHttpErrorCodeToMessageDePipe implements PipeTransform {
|
|
|
5670
6828
|
static ɵpipe: _angular_core.ɵɵPipeDeclaration<ParseHttpErrorCodeToMessageDePipe, "parseHttpErrorCodeToMessageDe", true>;
|
|
5671
6829
|
}
|
|
5672
6830
|
|
|
5673
|
-
declare const parseHttpErrorCodeToTitleEn: (statusCode: HttpStatusCode) => "
|
|
6831
|
+
declare const parseHttpErrorCodeToTitleEn: (statusCode: HttpStatusCode) => "Unauthorized" | "Forbidden" | "Bad request" | "Payment required" | "Not found" | "Method not allowed" | "Not acceptable" | "Proxy authentication required" | "Request timeout" | "Conflict" | "Gone" | "Length required" | "Precondition failed" | "Payload too large" | "URI too long" | "Unsupported media type" | "Range not satisfiable" | "Expectation failed" | "I am a teapot" | "Misdirected request" | "Unprocessable entity" | "Locked" | "Failed dependency" | "Too early" | "Upgrade required" | "Precondition required" | "Too many requests" | "Request header fields too large" | "Unavailable for legal reasons" | "Internal server error" | "Not implemented" | "Bad gateway" | "Service unavailable" | "Gateway timeout" | "HTTP version not supported" | "Variant also negotiates" | "Insufficient storage" | "Loop detected" | "Not extended" | "Network authentication required" | "Something went wrong";
|
|
5674
6832
|
declare const parseHttpErrorCodeToMessageEn: (statusCode: HttpStatusCode) => "Sorry, we could not process your request. Please try again later." | "You are not authorized to perform this action. Please log in to continue." | "Payment is required to complete this action." | "You do not have permission to perform this action." | "The requested resource was not found." | "The requested method is not allowed for this resource." | "The requested resource is not capable of generating a response matching the list of acceptable values." | "Proxy authentication is required to complete this action." | "The server timed out waiting for the request." | "The request conflicts with the current state of the resource." | "The requested resource is no longer available and will not be available again." | "The request did not specify the length of its content, which is required by the requested resource." | "The server does not meet one of the preconditions that the requester put on the request." | "The request is larger than the server is willing or able to process." | "The URL provided was too long for the server to process." | "The request entity has a media type which the server or resource does not support." | "The client has asked for a portion of the file, but the server cannot supply that portion." | "The server cannot meet the requirements of the Expect request-header field." | "I am a teapot." | "The request was directed at a server that is not able to produce a response." | "The request was well-formed but was unable to be followed due to semantic errors." | "The resource that is being accessed is locked." | "The request failed due to failure of a previous request." | "The server is unwilling to process the request because the user has not been authenticated." | "The client should switch to a different protocol such as TLS/1.0, given in the Upgrade header field." | "The origin server requires the request to be conditional." | "You have sent too many requests in a given amount of time. Please try again later." | "The server is unwilling to process the request because its header fields are too large." | "The resource is unavailable due to a legal demand." | "Something went wrong on our end. Please try again later." | "The server does not support the functionality required to fulfill the request." | "The server is currently unable to handle the request due to a temporary overload or maintenance of the server." | "The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URL or some other auxiliary server it needed to access in attempting to complete the request." | "The server does not support the HTTP protocol version used in the request." | "The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process." | "The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request." | "The server detected an infinite loop while processing the request." | "Further extensions to the request are required for the server to fulfill it." | "You need to authenticate to gain network access." | "Something went wrong. Check your internet connection and try again later.";
|
|
5675
6833
|
|
|
5676
6834
|
declare class ParseHttpErrorCodeToTitleEnPipe implements PipeTransform {
|
|
5677
|
-
transform: (statusCode: _angular_common_http.HttpStatusCode) => "
|
|
6835
|
+
transform: (statusCode: _angular_common_http.HttpStatusCode) => "Unauthorized" | "Forbidden" | "Bad request" | "Payment required" | "Not found" | "Method not allowed" | "Not acceptable" | "Proxy authentication required" | "Request timeout" | "Conflict" | "Gone" | "Length required" | "Precondition failed" | "Payload too large" | "URI too long" | "Unsupported media type" | "Range not satisfiable" | "Expectation failed" | "I am a teapot" | "Misdirected request" | "Unprocessable entity" | "Locked" | "Failed dependency" | "Too early" | "Upgrade required" | "Precondition required" | "Too many requests" | "Request header fields too large" | "Unavailable for legal reasons" | "Internal server error" | "Not implemented" | "Bad gateway" | "Service unavailable" | "Gateway timeout" | "HTTP version not supported" | "Variant also negotiates" | "Insufficient storage" | "Loop detected" | "Not extended" | "Network authentication required" | "Something went wrong";
|
|
5678
6836
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ParseHttpErrorCodeToTitleEnPipe, never>;
|
|
5679
6837
|
static ɵpipe: _angular_core.ɵɵPipeDeclaration<ParseHttpErrorCodeToTitleEnPipe, "parseHttpErrorCodeToTitleEn", true>;
|
|
5680
6838
|
}
|
|
@@ -5842,6 +7000,12 @@ type CreateQueryFormConfig<TFields extends QueryFormFields> = {
|
|
|
5842
7000
|
* A function is evaluated every time a key is built.
|
|
5843
7001
|
*/
|
|
5844
7002
|
readonly queryParamPrefix?: string | (() => string);
|
|
7003
|
+
/**
|
|
7004
|
+
* What the form is called in the devtools Forms tab. Defaults to the
|
|
7005
|
+
* `queryParamPrefix` where it is a plain string, and to `form` otherwise.
|
|
7006
|
+
* Ignored unless `provideQueryDevtools()` is installed.
|
|
7007
|
+
*/
|
|
7008
|
+
readonly name?: string;
|
|
5845
7009
|
};
|
|
5846
7010
|
/**
|
|
5847
7011
|
* A signals-first query form: binds on-screen controls to typed fields, keeps a
|
|
@@ -5874,6 +7038,7 @@ declare class QueryFormSignals<TFields extends QueryFormFields> {
|
|
|
5874
7038
|
private observing;
|
|
5875
7039
|
private observeOptions;
|
|
5876
7040
|
private pendingTimer;
|
|
7041
|
+
private commitPending;
|
|
5877
7042
|
private skipNextResets;
|
|
5878
7043
|
/**
|
|
5879
7044
|
* The bindable signal-forms field tree - bind a field with `[formField]`, e.g.
|
|
@@ -5905,6 +7070,11 @@ declare class QueryFormSignals<TFields extends QueryFormFields> {
|
|
|
5905
7070
|
}): void;
|
|
5906
7071
|
/** Create a detached editor over the same fields, seeded from the current committed value. */
|
|
5907
7072
|
branch(): QueryFormBranch<TFields>;
|
|
7073
|
+
/**
|
|
7074
|
+
* The live view `<et-query-devtools>` renders. Only built while the devtools are installed - it walks
|
|
7075
|
+
* every field on every change, which an app without them should not pay for.
|
|
7076
|
+
*/
|
|
7077
|
+
private devtoolsHandle;
|
|
5908
7078
|
private onLiveChange;
|
|
5909
7079
|
/** Shortest-debounce-wins; `null` means commit immediately. */
|
|
5910
7080
|
private resolveDebounce;
|
|
@@ -5913,6 +7083,8 @@ declare class QueryFormSignals<TFields extends QueryFormFields> {
|
|
|
5913
7083
|
private applyFromUrl;
|
|
5914
7084
|
private commitFromUrl;
|
|
5915
7085
|
private deserialize;
|
|
7086
|
+
/** What a field puts in the URL for a given value, or `undefined` when it writes nothing. */
|
|
7087
|
+
private queryParamFor;
|
|
5916
7088
|
private writeToUrl;
|
|
5917
7089
|
private paramKey;
|
|
5918
7090
|
private clearTimer;
|
|
@@ -6013,5 +7185,5 @@ type WebSocketClientResult<TMessageData extends SocketMessageView = SocketMessag
|
|
|
6013
7185
|
type AnyWebSocketClient<TMessageData extends SocketMessageView = SocketMessageView> = WebSocketClientResult<TMessageData>;
|
|
6014
7186
|
declare const createWebSocketClient: <TMessageData extends SocketMessageView = SocketMessageView>(options: CreateWebSocketClientConfigOptions) => WebSocketClientResult<TMessageData>;
|
|
6015
7187
|
|
|
6016
|
-
export { AuthBearerRefreshStrategy, BasicAuthProvider, BearerAuthFeatureType, BooleanArrayQueryField, CLEAR_QUERY_ARGS, CustomHeaderAuthProvider, DEFAULT_KEEP_UNUSED_FOR, DEFAULT_QUERY_PERSISTENCE_MAX_AGE, DEFAULT_QUERY_PERSISTENCE_MAX_ENTRIES, DEFAULT_QUERY_PERSISTENCE_VERSION, DEFAULT_QUERY_PERSISTENCE_WRITE_DELAY, DateArrayQueryField, DateQueryField, EntityStore, IGNORED_FILTER_COUNT_FIELDS, INFINITY_QUERY_TOKEN, InfinityQuery, InfinityQueryDirective, InfinityQueryTriggerDirective, LegacyQuery, LegacyQueryCreator, MAX_UNUSED_ENTRIES, NumberArrayQueryField, ParseHttpErrorCodeToMessageDePipe, ParseHttpErrorCodeToMessageEnPipe, ParseHttpErrorCodeToTitleDePipe, ParseHttpErrorCodeToTitleEnPipe, QUERY_CLIENT_DEVTOOLS_TOKEN, QUERY_PERSISTENCE_STORE_VERSION, QUERY_SYNC_PROTOCOL_VERSION, QueryClientFeatureType, QueryDevtoolsComponent, QueryDirective, QueryError, QueryFeatureType, QueryField, QueryForm, QueryFormSignals, QueryRuntimeErrorCode, QueryShortNamePipe, QueryStateType, QueryStore, SERVER_ERROR_KIND, SERVER_VIOLATION_ERROR_KIND, SPEED_BUFFER_TIME_IN_MS, SearchQueryField, SortQueryField, StringArrayQueryField, V2BearerAuthProvider, V2Query, V2QueryClient, V2QueryCreator, addQueryContainerHandling, applyQueryFeatures, authExtractTokensResponseMissingAccessToken, authExtractTokensResponseMissingRefreshToken, authExtractTokensResponseNotObject, authProviderFeatureUsedMultipleTimes, booleanArrayQueryField, buildErrorMessage, buildQueryCacheKey, buildQueryString, buildRoute, buildTimestampFromSeconds, castQueryCreatorTypes, circularQueryDependency, circularQueryDependencyChecker, computeQueryAuthHeader, computeQueryBody, computeQueryHeaders, computeQueryMethod, computeQueryQueryParams, contentfulGqlLikePaginationAdapter, createBaseQuery, createBaseQueryCreator, createBearerAuthProvider, createDeleteQuery, createExecuteFn, createGetQuery, createGqlExecuteFn, createGqlMutationViaGet, createGqlMutationViaPost, createGqlQuery, createGqlQueryCreator, createGqlQueryViaGet, createGqlQueryViaPost, createHttpRequest, createIndexedDbQueryPersistenceAdapter, createInfinityQueryConfig, createLegacyQueryCreator, createNoopQueryPersistenceAdapter, createPagedQueryStack, createPatchQuery, createPersistentAuthFeature, createPostQuery, createPutQuery, createQuery, createQueryClient, createQueryCollection, createQueryCollectionSignal, createQueryCollectionSubject, createQueryContext, createQueryCreator, createQueryErrorResponse, createQueryFeature, createQueryForm, createQueryInvalidationFilter, createQueryKeyLockManager, createQueryObject, createQueryPersistenceEngine, createQueryRepository, createQuerySnapshotFn, createQueryStack, createQuerySyncEngine, createQuerySyncTransport, createSecureDeleteQuery, createSecureExecuteFactory, createSecureExecuteFn, createSecureGetQuery, createSecureGqlExecuteFn, createSecureGqlMutationViaGet, createSecureGqlMutationViaPost, createSecureGqlQuery, createSecureGqlQueryCreator, createSecureGqlQueryViaGet, createSecureGqlQueryViaPost, createSecurePatchQuery, createSecurePostQuery, createSecurePutQuery, createSecureQuery, createSecureQueryCreator, createTrackingFeature, createWebSocketClient, dateArrayQueryField, dateQueryField, decryptBearer, deepFreeze, def, detectContentTypeHeader, dynLikePaginationAdapter, effectComputed, emptyQueryArgs, ethletePaginationAdapter, executeUntilSettled, extractExpiresInSeconds, extractFormViolations, extractHtmlErrorMessage, extractQuery, fakePaginationAdapter, filterFailure, filterNull, filterQueryStates, filterSuccess, forEachHeader, getDefaultHeaders, getQueryFeatureUsage, getResponseUrl, ggLikePaginationAdapter, gql, gqlDataPropertyMissingInResponse, hasHeader, htmlErrorPayload, htmlQueryErrorParser, ignoreAutoRefresh, injectInfinityQueryResponseDelay, injectQueryContext, insertFrom, invalidBaseRouteError, invalidBodyError, invalidRouteError, invalidStateInsideSecureExecuteFactory, isAutoRefresh, isBasicAuthProvider, isBearerAuthProvider, isClassValidatorError, isCreateGqlQueryOptions, isCustomHeaderAuthProvider, isEmptyString, isGqlQueryConfig, isHtmlErrorPayload, isLegacyQuery, isNaN, isPageOutOfRangeError, isQuery, isQueryCollection, isQueryErrorResponse, isQueryStateCancelled, isQueryStateFailure, isQueryStateLoading, isQueryStatePrepared, isQueryStateSuccess, isRequestError, isSymfonyError, isSymfonyFormViolationListError, isSymfonyListError, isSymfonyPagerfantaOutOfRangeError, isUnderInvalidatedUrl, legacyPrepareWithoutInjectionContext, mapToPaginated, mapViolationsToFormErrors, maybeExecute, mergeHeaders, nestedEffect, numberArrayQueryField, pagedQueryStackNextPageCalledWithoutPreviousPage, pagedQueryStackPageBiggerThanTotalPages, pagedQueryStackPreviousPageCalledButAlreadyAtFirstPage, paginatedEntityValueUpdater, parseAllXhrResponseHeaders, parseHttpErrorCodeToMessageDe, parseHttpErrorCodeToMessageEn, parseHttpErrorCodeToTitleDe, parseHttpErrorCodeToTitleEn, pathParamsMissingInRouteFunctionError, provideInfinityQueryResponseDelay, provideQueryClientForDevtools, provideQueryDevtools, queryArrayComputed, queryClientFeatureUsedMultipleTimes, queryComputed, queryComputedTillTruthy, queryDevtoolsEntries, queryErrorMessage, queryErrorMessages, queryExecute, queryFeatureUsedMultipleTimes, queryField, querySequence, querySequenceAlreadyRunning, queryStackTotalQueriesAndExpectedQueriesMismatch, queryStackWithArgsUsed, queryStackWithResponseUpdateUsed, queryStateAlreadyHasKeyError, queryStateCannotTransformError, queryStateDoesNotContainKeyError, queryStateErrorSignal, queryStateLoadingSignal, queryStateResponseSignal, queryStateSignal, registerQueryErrorParser, removeFrom, request, resetExecuteState, resetPageOnError, resolveInvalidationUrl, searchQueryField, serializeBody, setDefaultQueryRetryFn, setupQueryDependencies, setupQueryExecuteState, setupQueryState, shouldAutoExecuteGqlQuery, shouldAutoExecuteQuery, shouldCacheQuery, shouldRetryRequest, silenceMissingWithArgsFeatureErrorUsedButWithArgsPresent, skipPaginationPageParamCalculator, sortQueryField, splitQueryConfig, stringArrayQueryField, switchQueryCollectionState, switchQueryState, symfonyQueryErrorParser, takeUntilResponse, toQuerySignal, toQuerySubject, tokensNotAvailableInsideAuthAndExec, transformArrayResponse, transformExecStateToQueryState, transformGql, transformMethod, transformPaginatedResponse, transformToBoolean, transformToBooleanArray, transformToDate, transformToDateArray, transformToNumber, transformToNumberArray, transformToSort, transformToSortQueryParam, transformToString, transformToStringArray, uncacheableRequestHasAllowCacheParam, uncacheableRequestHasCacheKeyParam, unwrapQuerySyncMessage, v2BuildQueryCacheKey, v2ExtractExpiresInSeconds, v2ShouldCacheQuery, v2ShouldRetryRequest, validateWithQuery, validateWithV2Query, withArgs, withArgsQueryFeatureMissingButRouteIsFunction, withAuthenticationQuery, withAutoRefresh, withAutoRefreshUsedInManualQuery, withAutoRefreshUsedOnUnsupportedHttpMethod, withBearerAuthMultiTabSync, withDefaultRetry, withErrorHandling, withEthleteApiErrors, withHtmlErrorParsing, withInactivityLogout, withLogging, withMultiTabSync, withPageResetOnError, withPersistentAuth, withPolling, withPollingUsedOnUnsupportedHttpMethod, withQueryPersistence, withRefreshQuery, withResponseUpdate, withSuccessHandling, withSymfonyErrors, withTokenExpirationWarning, withTokenRevocation, withTracking, wrapAsObservableSignal, wrapQuerySyncMessage };
|
|
6017
|
-
export type { AnyBearerAuthProvider, AnyCreateBearerAuthProviderResult, AnyCreateGqlQueryCreatorOptions, AnyCreateQueryClientResult, AnyGqlQueryConfig, AnyInfinityQuery, AnyInfinityQueryConfig, AnyLegacyQuery, AnyLegacyQueryCreator, AnyNewQuery, AnyPagedQueryStack, AnyQueryBuilder, AnyQueryClient, AnyQueryCollection, AnyQueryCollectionData, AnyQueryCollectionResponse, AnyQueryCreator, AnyQueryCreatorCollection, AnyQueryForm, AnyQuerySnapshot, AnyQueryStack, AnyRestQueryConfig, AnyRoute, AnyV2Query, AnyV2QueryCreator, AnyWebSocketClient, AppendItemsLocation, ApplyExternalResponseOptions, ApplyPersistedResponseOptions, AuthProvider, AuthProviderBasicConfig, AuthProviderBearerConfig, AuthProviderCustomHeaderConfig, AuthQueryBuilder, AuthQueryConfig, BaseArguments, BaseQueryCreatorFactoryOptions, BaseQueryCreatorOptions, BaseQueryCreatorOptionsSubtle, BearerAuthExecutionState, BearerAuthExecutionStateError, BearerAuthExecutionStateLoading, BearerAuthExecutionStateLogout, BearerAuthExecutionStateSuccess, BearerAuthFeature, BearerAuthMultiTabSyncConfig, BearerAuthMultiTabSyncFeature, BearerAuthProvider, BearerAuthProviderEarlySetup, BearerAuthProviderEarlySetupContext, BearerAuthProviderEarlySetupResult, BearerAuthProviderFeatureContext, BearerAuthProviderOf, BearerAuthProviderQueryContext, BearerAuthProviderRef, BearerAuthProviderTokens, BearerRefreshConfig, BodyType, BuildQueryStringConfig, CacheAdapterFn, Cancelled, ClassValidatorError, ClearQueryArgs, ConstructQuery, CreateBaseQueryOptions, CreateBearerAuthProviderConfig, CreateGqlQueryCreatorOptions, CreateGqlQueryExecuteOptions, CreateGqlQueryOptions, CreateHttpRequestDependencies, CreateHttpRequestOptions, CreateIndexedDbQueryPersistenceAdapterOptions, CreateLegacyQueryCreatorOptions, CreateLegacyQueryOptions, CreatePagedQueryStackOptions, CreateQueryClientConfigOptions, CreateQueryCreatorOptions, CreateQueryExecuteOptions, CreateQueryFormConfig, CreateQueryObjectOptions, CreateQueryOptions, CreateQueryPersistenceEngineOptions, CreateQueryRepositoryConfig, CreateQuerySnapshotOptions, CreateQueryStackOptions, CreateQuerySyncEngineOptions, CreateSecureGqlQueryExecuteOptions, CreateSecureGqlQueryOptions, CreateSecureQueryExecuteOptions, CreateSecureQueryOptions, CreateWebSocketClientConfigOptions, CreateWebSocketClientTransport, DestroyCleanupCallback, EmptyObject, EntityGetParams, EntityIdParams, EntityKey, EntitySetParams, EntityStoreConfig, ExecuteFactory, ExecuteQueryOptions, ExtractQueryArgs, ExtractQueryKey, Failure, FeatureRegistry, GQL, GqlQueryArgs, GqlQueryConfig, GqlQueryConfigWithoutMethod, GqlQueryMethod, GqlQueryTransport, GqlTransferOption, GqlTransformer, GqlVariablesType, HttpErrorEvent, HttpRequest, HttpRequestLoadingProgressState, HttpRequestLoadingState, HttpRequestResponseType, HttpRequestSubtle, HttpRequestTransferCacheConfig, InactivityLogoutConfig, InactivityLogoutFeature, InfinityQueryConfig, InfinityQueryConfigType, InfinityQueryOf, InfinityQueryParamLocation, InsertFromConfig, InternalCreateGqlQueryCreatorOptions, InternalCreateQueryCreatorOptions, InternalQueryExecute, InternalSecureCreateGqlQueryCreatorOptions, InternalSecureCreateQueryCreatorOptions, InternalWebSocketRoom, LeaderInstanceCountChangeEventData, LeaderStatusChangeEventData, LegacyArgumentsOfQueryArgs, LegacyQueryPrepareFn, Loading, MapViolationsToFormErrorsOptions, Method, ObservableSignal, OptionalQueryFieldOptions, PageParamCalculatorOptions, PagedQueryStack, PagedQueryStackDirection, PagedQueryStackExecuteOptions, PagedQueryStackResetOptions, PartialXhrState, PathParams, PathParamsType, PersistedQueryBody, PersistedQueryEntry, PersistedQueryEntryMeta, PersistentAuthConfig, PersistentAuthFeature, PollConfig, Prepared, Query, QueryArgs, QueryArgsOf, QueryArgsOfLegacyArguments, QueryAutoRefreshConfig, QueryBase, QueryClient, QueryClientDevtoolsOptions, QueryClientErrorPipelineFeature, QueryClientFeature, QueryClientFeatureContext, QueryClientFeatureFn, QueryClientMultiTabSyncFeature, QueryClientPersistenceFeature, QueryClientRef, QueryClientSubtle, QueryCollectionKeysOf, QueryCollectionOf, QueryCollectionWithNullableQuery, QueryConfig, QueryConfigBase, QueryConfigWithoutMethod, QueryContainerConfig, QueryContext, QueryCreator, QueryDataOf, QueryDependencies, QueryDevtoolsEntry, QueryDevtoolsEntryKind, QueryDevtoolsEntryMeta, QueryDevtoolsRegistrar, QueryDevtoolsRegistration, QueryDirectiveContext, QueryDirectiveType, QueryEntityConfig, QueryErrorParser, QueryErrorResponse, QueryErrorResponseItem, QueryErrorResponseList, QueryErrorResponseSingle, QueryExecute, QueryExecuteArgs, QueryExecuteEventData, QueryExecuteOptions, QueryExecuteState, QueryExecutionState, QueryExecutionStateFailure, QueryExecutionStateLoading, QueryExecutionStateLoadingWithCachedResponse, QueryExecutionStateLoadingWithNoResponse, QueryExecutionStateSuccess, QueryFailureEventData, QueryFeature, QueryFeatureContext, QueryFeatureFlags, QueryFeatureFn, QueryFieldConfig, QueryFieldDef, QueryFieldOptions, QueryFieldValue, QueryFilterConfig, QueryFormBranch, QueryFormChange, QueryFormFields, QueryFormGroup, QueryFormGroupControls, QueryFormModel, QueryFormObserveOptions, QueryFormOf, QueryFormOptions, QueryFormSignalsObserveOptions, QueryFormSignalsWriteOptions, QueryFormValue, QueryFormValueEvent, QueryFormWriteOptions, QueryInvalidationCandidate, QueryInvalidationFilterFn, QueryInvalidationOptions, QueryKey, QueryKeyLockHold, QueryKeyLockManager, QueryKeyLockState, QueryMethod, QueryMockConfig, QueryMultiTabSyncConfig, QueryOf, QueryParams, QueryParamsType, QueryPersistenceAdapter, QueryPersistenceCandidate, QueryPersistenceConfig, QueryPersistenceEngine, QueryPrepareFn, QueryRegistry, QueryRegistryEntry, QueryRepository, QueryRepositoryCacheEntry, QueryRepositoryDependencies, QueryRepositoryEvent, QueryRepositoryItem, QueryRepositoryRefreshFilterFn, QueryRepositoryRequestOptions, QueryRepositorySubtle, QueryResponseOf, QueryRouteOf, QuerySequence, QuerySequenceResult, QuerySequenceStatus, QuerySequenceStepArgs, QuerySnapshot, QueryStack, QueryStackSubtle, QueryState, QueryStateMeta, QueryStateResponseOf, QueryStateSignal, QueryStateSubtle, QueryStateSuccessMeta, QueryStoreIdOf, QueryStoreOf, QuerySubtle, QuerySuccessEventData, QuerySyncEngine, QuerySyncEnvelope, QuerySyncInvalidateMessage, QuerySyncMessage, QuerySyncMessageListener, QuerySyncMutation, QuerySyncMutationFilterFn, QuerySyncMutationMessage, QuerySyncRefreshCandidate, QuerySyncRefreshOnMutationConfig, QuerySyncResponseMessage, QuerySyncTransport, QueryTrigger, RawResponseType, ReadonlyQuery, RemoveFromConfig, RequestArgs, RequestConfig, RequestError, RequestEvent, RequestHeaders, RequestHeadersMethodMap, RequestHttpEvent, RequestProgress, RequestRetryFn, RequestRetryFnConfig, RequestRetryFnResult, RequiresTransform, ResetExecuteStateOptions, ResetPageOnErrorOperatorConfig, ResponseType, RestQueryConfig, RouteString, RouteType, RunQueryCreator, RunQueryExecuteOptions, SecureExecuteFactoryOptions, ServerValidationError, ServerViolationValidationError, SetupQueryDependenciesOptions, SetupQueryStateOptions, ShouldRetryRequestFn, ShouldRetryRequestOptions, ShouldRetryRequestResult, SocketMessageView, Sort, SortDirection, Success, SymfonyError, SymfonyErrorTrace, TokenExpirationWarningConfig, TokenExpirationWarningFeature, TokenRefreshEventData, TokenRefreshQueryBuilder, TokenRefreshQueryConfig, TokenResponse, TokenRevocationConfig, TokenRevocationFeature, TotalPagesExtractorOptions, TrackingConfig, TrackingEventDataMap, TrackingEventHandler, TrackingEventName, TrackingFeature, TransformedGqlQuery, V2CacheAdapterFn, V2PrepareArgsOf, V2QueryArgsOf, V2QueryClientConfig, V2QueryConfig, V2QueryState, V2RouteString, V2RouteType, ValidateWithQueryConfig, ValidateWithV2QueryConfig, WebSocketClient, WebSocketClientResult, WebSocketClientSubtle, WebSocketDevtoolsHandle, WebSocketDevtoolsMessage, WebSocketRoom, WithAutoRefreshFeatureOptions, WithBody, WithConfig, WithErrorHandlingFeatureOptions, WithHeaders, WithInjector, WithLegacyConfig, WithLoggingFeatureOptions, WithMock, WithPageResetOnErrorFeatureOptions, WithPathParams, WithPollingFeatureOptions, WithQueryParams, WithResponseUpdateFeatureFnData, WithResponseUpdateFeatureOptions, WithSuccessHandlingFeatureOptions, WithVariables };
|
|
7188
|
+
export { AuthBearerRefreshStrategy, BasicAuthProvider, BearerAuthFeatureType, BooleanArrayQueryField, CLEAR_QUERY_ARGS, CustomHeaderAuthProvider, DEFAULT_KEEP_UNUSED_FOR, DEFAULT_QUERY_PERSISTENCE_MAX_AGE, DEFAULT_QUERY_PERSISTENCE_MAX_ENTRIES, DEFAULT_QUERY_PERSISTENCE_VERSION, DEFAULT_QUERY_PERSISTENCE_WRITE_DELAY, DateArrayQueryField, DateQueryField, EMPTY_QUERY_DEVTOOLS_FAULT, EntityStore, IGNORED_FILTER_COUNT_FIELDS, INFINITY_QUERY_TOKEN, InfinityQuery, InfinityQueryDirective, InfinityQueryTriggerDirective, LegacyQuery, LegacyQueryCreator, MAX_UNUSED_ENTRIES, NumberArrayQueryField, ParseHttpErrorCodeToMessageDePipe, ParseHttpErrorCodeToMessageEnPipe, ParseHttpErrorCodeToTitleDePipe, ParseHttpErrorCodeToTitleEnPipe, QUERY_CLIENT_DEVTOOLS_TOKEN, QUERY_DEVTOOLS_FAULT_STATUSES, QUERY_PERSISTENCE_STORE_VERSION, QUERY_SYNC_PROTOCOL_VERSION, QueryClientFeatureType, QueryDevtoolsComponent, QueryDirective, QueryError, QueryFeatureType, QueryField, QueryForm, QueryFormSignals, QueryRuntimeErrorCode, QueryShortNamePipe, QueryStateType, QueryStore, SERVER_ERROR_KIND, SERVER_VIOLATION_ERROR_KIND, SPEED_BUFFER_TIME_IN_MS, SearchQueryField, SortQueryField, StringArrayQueryField, V2BearerAuthProvider, V2Query, V2QueryClient, V2QueryCreator, addQueryContainerHandling, applyQueryFeatures, authExtractTokensResponseMissingAccessToken, authExtractTokensResponseMissingRefreshToken, authExtractTokensResponseNotObject, authProviderFeatureUsedMultipleTimes, booleanArrayQueryField, buildErrorMessage, buildQueryCacheKey, buildQueryString, buildRoute, buildTimestampFromSeconds, castQueryCreatorTypes, circularQueryDependency, circularQueryDependencyChecker, clearQueryDevtoolsFaults, computeQueryAuthHeader, computeQueryBody, computeQueryHeaders, computeQueryMethod, computeQueryQueryParams, contentfulGqlLikePaginationAdapter, createBaseQuery, createBaseQueryCreator, createBearerAuthProvider, createDeleteQuery, createExecuteFn, createGetQuery, createGqlExecuteFn, createGqlMutationViaGet, createGqlMutationViaPost, createGqlQuery, createGqlQueryCreator, createGqlQueryViaGet, createGqlQueryViaPost, createHttpRequest, createIndexedDbQueryPersistenceAdapter, createInfinityQueryConfig, createLegacyQueryCreator, createNoopQueryPersistenceAdapter, createPagedQueryStack, createPatchQuery, createPersistentAuthFeature, createPostQuery, createPutQuery, createQuery, createQueryClient, createQueryCollection, createQueryCollectionSignal, createQueryCollectionSubject, createQueryContext, createQueryCreator, createQueryErrorResponse, createQueryFeature, createQueryForm, createQueryInvalidationFilter, createQueryKeyLockManager, createQueryObject, createQueryPersistenceEngine, createQueryRepository, createQuerySnapshotFn, createQueryStack, createQuerySyncEngine, createQuerySyncTransport, createSecureDeleteQuery, createSecureExecuteFactory, createSecureExecuteFn, createSecureGetQuery, createSecureGqlExecuteFn, createSecureGqlMutationViaGet, createSecureGqlMutationViaPost, createSecureGqlQuery, createSecureGqlQueryCreator, createSecureGqlQueryViaGet, createSecureGqlQueryViaPost, createSecurePatchQuery, createSecurePostQuery, createSecurePutQuery, createSecureQuery, createSecureQueryCreator, createTrackingFeature, createWebSocketClient, dateArrayQueryField, dateQueryField, decryptBearer, deepFreeze, def, detectContentTypeHeader, dynLikePaginationAdapter, effectComputed, emptyQueryArgs, ethletePaginationAdapter, executeUntilSettled, extractExpiresInSeconds, extractFormViolations, extractHtmlErrorMessage, extractQuery, fakePaginationAdapter, filterFailure, filterNull, filterQueryStates, filterSuccess, forEachHeader, getDefaultHeaders, getQueryFeatureUsage, getResponseUrl, ggLikePaginationAdapter, gql, gqlDataPropertyMissingInResponse, hasHeader, htmlErrorPayload, htmlQueryErrorParser, ignoreAutoRefresh, injectInfinityQueryResponseDelay, injectQueryContext, insertFrom, invalidBaseRouteError, invalidBodyError, invalidRouteError, invalidStateInsideSecureExecuteFactory, isAutoRefresh, isBasicAuthProvider, isBearerAuthProvider, isClassValidatorError, isCreateGqlQueryOptions, isCustomHeaderAuthProvider, isEmptyString, isGqlQueryConfig, isHtmlErrorPayload, isLegacyQuery, isNaN, isPageOutOfRangeError, isQuery, isQueryCollection, isQueryDevtoolsFaultArmed, isQueryErrorResponse, isQueryStateCancelled, isQueryStateFailure, isQueryStateLoading, isQueryStatePrepared, isQueryStateSuccess, isRequestError, isSymfonyError, isSymfonyFormViolationListError, isSymfonyListError, isSymfonyPagerfantaOutOfRangeError, isUnderInvalidatedUrl, legacyPrepareWithoutInjectionContext, mapToPaginated, mapViolationsToFormErrors, maybeExecute, mergeHeaders, nestedEffect, numberArrayQueryField, pagedQueryStackNextPageCalledWithoutPreviousPage, pagedQueryStackPageBiggerThanTotalPages, pagedQueryStackPreviousPageCalledButAlreadyAtFirstPage, paginatedEntityValueUpdater, parseAllXhrResponseHeaders, parseHttpErrorCodeToMessageDe, parseHttpErrorCodeToMessageEn, parseHttpErrorCodeToTitleDe, parseHttpErrorCodeToTitleEn, pathParamsMissingInRouteFunctionError, provideInfinityQueryResponseDelay, provideLegacyPrepareFallback, provideQueryClientForDevtools, provideQueryDevtools, queryArrayComputed, queryClientFeatureUsedMultipleTimes, queryComputed, queryComputedTillTruthy, queryDevtoolsEntries, queryDevtoolsFaults, queryErrorMessage, queryErrorMessages, queryExecute, queryFeatureUsedMultipleTimes, queryField, querySequence, querySequenceAlreadyRunning, queryStackTotalQueriesAndExpectedQueriesMismatch, queryStackWithArgsUsed, queryStackWithResponseUpdateUsed, queryStateAlreadyHasKeyError, queryStateCannotTransformError, queryStateDoesNotContainKeyError, queryStateErrorSignal, queryStateLoadingSignal, queryStateResponseSignal, queryStateSignal, registerQueryErrorParser, removeFrom, request, resetExecuteState, resetPageOnError, resolveInvalidationUrl, searchQueryField, serializeBody, setDefaultQueryRetryFn, setQueryDevtoolsFault, setupQueryDependencies, setupQueryExecuteState, setupQueryState, shouldAutoExecuteGqlQuery, shouldAutoExecuteQuery, shouldCacheQuery, shouldRetryRequest, silenceMissingWithArgsFeatureErrorUsedButWithArgsPresent, skipPaginationPageParamCalculator, sortQueryField, splitQueryConfig, stringArrayQueryField, stringifyQueryRouteParts, sumQueryDevtoolsStats, switchQueryCollectionState, switchQueryState, symfonyQueryErrorParser, takeUntilResponse, toQuerySignal, toQuerySubject, tokensNotAvailableInsideAuthAndExec, transformArrayResponse, transformExecStateToQueryState, transformGql, transformMethod, transformPaginatedResponse, transformToBoolean, transformToBooleanArray, transformToDate, transformToDateArray, transformToNumber, transformToNumberArray, transformToSort, transformToSortQueryParam, transformToString, transformToStringArray, uncacheableRequestHasAllowCacheParam, uncacheableRequestHasCacheKeyParam, unwrapQuerySyncMessage, v2BuildQueryCacheKey, v2ExtractExpiresInSeconds, v2ShouldCacheQuery, v2ShouldRetryRequest, validateWithQuery, validateWithV2Query, withArgs, withArgsQueryFeatureMissingButRouteIsFunction, withAuthenticationQuery, withAutoRefresh, withAutoRefreshUsedInManualQuery, withAutoRefreshUsedOnUnsupportedHttpMethod, withBearerAuthMultiTabSync, withDefaultRetry, withErrorHandling, withEthleteApiErrors, withHtmlErrorParsing, withInactivityLogout, withLogging, withMultiTabSync, withPageResetOnError, withPersistentAuth, withPolling, withPollingUsedOnUnsupportedHttpMethod, withQueryPersistence, withRefreshQuery, withResponseUpdate, withSuccessHandling, withSymfonyErrors, withTokenExpirationWarning, withTokenRevocation, withTracking, wrapAsObservableSignal, wrapQuerySyncMessage };
|
|
7189
|
+
export type { AnyBearerAuthProvider, AnyCreateBearerAuthProviderResult, AnyCreateGqlQueryCreatorOptions, AnyCreateQueryClientResult, AnyGqlQueryConfig, AnyInfinityQuery, AnyInfinityQueryConfig, AnyLegacyQuery, AnyLegacyQueryCreator, AnyNewQuery, AnyPagedQueryStack, AnyQueryBuilder, AnyQueryClient, AnyQueryCollection, AnyQueryCollectionData, AnyQueryCollectionResponse, AnyQueryCreator, AnyQueryCreatorCollection, AnyQueryForm, AnyQuerySnapshot, AnyQueryStack, AnyRestQueryConfig, AnyRoute, AnyV2Query, AnyV2QueryCreator, AnyWebSocketClient, AppendItemsLocation, ApplyExternalResponseOptions, ApplyPersistedResponseOptions, AuthProvider, AuthProviderBasicConfig, AuthProviderBearerConfig, AuthProviderCustomHeaderConfig, AuthQueryBuilder, AuthQueryConfig, BaseArguments, BaseQueryCreatorFactoryOptions, BaseQueryCreatorOptions, BaseQueryCreatorOptionsSubtle, BearerAuthExecutionState, BearerAuthExecutionStateError, BearerAuthExecutionStateLoading, BearerAuthExecutionStateLogout, BearerAuthExecutionStateSuccess, BearerAuthFeature, BearerAuthMultiTabSyncConfig, BearerAuthMultiTabSyncFeature, BearerAuthProvider, BearerAuthProviderEarlySetup, BearerAuthProviderEarlySetupContext, BearerAuthProviderEarlySetupResult, BearerAuthProviderFeatureContext, BearerAuthProviderOf, BearerAuthProviderQueryContext, BearerAuthProviderRef, BearerAuthProviderTokens, BearerRefreshConfig, BodyType, BuildQueryStringConfig, CacheAdapterFn, Cancelled, ClassValidatorError, ClearQueryArgs, ConstructQuery, CreateBaseQueryOptions, CreateBearerAuthProviderConfig, CreateGqlQueryCreatorOptions, CreateGqlQueryExecuteOptions, CreateGqlQueryOptions, CreateHttpRequestDependencies, CreateHttpRequestOptions, CreateIndexedDbQueryPersistenceAdapterOptions, CreateLegacyQueryCreatorOptions, CreateLegacyQueryOptions, CreatePagedQueryStackOptions, CreateQueryClientConfigOptions, CreateQueryCreatorOptions, CreateQueryExecuteOptions, CreateQueryFormConfig, CreateQueryObjectOptions, CreateQueryOptions, CreateQueryPersistenceEngineOptions, CreateQueryRepositoryConfig, CreateQuerySnapshotOptions, CreateQueryStackOptions, CreateQuerySyncEngineOptions, CreateSecureGqlQueryExecuteOptions, CreateSecureGqlQueryOptions, CreateSecureQueryExecuteOptions, CreateSecureQueryOptions, CreateWebSocketClientConfigOptions, CreateWebSocketClientTransport, DescribableFeature, DestroyCleanupCallback, EmptyObject, EntityGetParams, EntityIdParams, EntityKey, EntitySetParams, EntityStoreConfig, ExecuteFactory, ExecuteQueryOptions, ExtractQueryArgs, ExtractQueryKey, Failure, FeatureRegistry, GQL, GqlQueryArgs, GqlQueryConfig, GqlQueryConfigWithoutMethod, GqlQueryMethod, GqlQueryTransport, GqlTransferOption, GqlTransformer, GqlVariablesType, HttpErrorEvent, HttpRequest, HttpRequestLoadingProgressState, HttpRequestLoadingState, HttpRequestResponseType, HttpRequestRetryState, HttpRequestSubtle, HttpRequestTransferCacheConfig, InactivityLogoutConfig, InactivityLogoutFeature, InfinityQueryConfig, InfinityQueryConfigType, InfinityQueryOf, InfinityQueryParamLocation, InsertFromConfig, InternalCreateGqlQueryCreatorOptions, InternalCreateQueryCreatorOptions, InternalQueryExecute, InternalSecureCreateGqlQueryCreatorOptions, InternalSecureCreateQueryCreatorOptions, InternalWebSocketRoom, LeaderInstanceCountChangeEventData, LeaderStatusChangeEventData, LegacyArgumentsOfQueryArgs, LegacyQueryPrepareFn, Loading, MapViolationsToFormErrorsOptions, Method, ObservableSignal, OptionalQueryFieldOptions, PageParamCalculatorOptions, PagedQueryStack, PagedQueryStackDirection, PagedQueryStackExecuteOptions, PagedQueryStackResetOptions, PartialXhrState, PathParams, PathParamsType, PersistedQueryBody, PersistedQueryEntry, PersistedQueryEntryMeta, PersistentAuthConfig, PersistentAuthFeature, PollConfig, Prepared, Query, QueryArgs, QueryArgsOf, QueryArgsOfLegacyArguments, QueryAutoRefreshConfig, QueryBase, QueryClient, QueryClientDevtoolsOptions, QueryClientErrorPipelineFeature, QueryClientFeature, QueryClientFeatureContext, QueryClientFeatureFn, QueryClientMultiTabSyncFeature, QueryClientPersistenceFeature, QueryClientRef, QueryClientSubtle, QueryCollectionKeysOf, QueryCollectionOf, QueryCollectionWithNullableQuery, QueryConfig, QueryConfigBase, QueryConfigWithoutMethod, QueryContainerConfig, QueryContext, QueryCreator, QueryDataOf, QueryDependencies, QueryDevtoolsAuthQuery, QueryDevtoolsEntry, QueryDevtoolsEntryKind, QueryDevtoolsEntryMeta, QueryDevtoolsFault, QueryDevtoolsFaultTarget, QueryDevtoolsFeature, QueryDevtoolsFeatureDescriber, QueryDevtoolsFeatureDetail, QueryDevtoolsFormField, QueryDevtoolsFormHandle, QueryDevtoolsFormLinksHandle, QueryDevtoolsFormLinksRecorder, QueryDevtoolsPayload, QueryDevtoolsRegistrar, QueryDevtoolsRegistration, QueryDevtoolsResolvedFault, QueryDevtoolsRoutePart, QueryDevtoolsRun, QueryDevtoolsRunStatus, QueryDevtoolsStats, QueryDevtoolsStatsHandle, QueryDevtoolsStatsRecorder, QueryDirectiveContext, QueryDirectiveType, QueryEntityConfig, QueryErrorParser, QueryErrorResponse, QueryErrorResponseItem, QueryErrorResponseList, QueryErrorResponseSingle, QueryExecute, QueryExecuteArgs, QueryExecuteEventData, QueryExecuteOptions, QueryExecuteState, QueryExecutionState, QueryExecutionStateFailure, QueryExecutionStateLoading, QueryExecutionStateLoadingWithCachedResponse, QueryExecutionStateLoadingWithNoResponse, QueryExecutionStateSuccess, QueryFailureEventData, QueryFeature, QueryFeatureContext, QueryFeatureFlags, QueryFeatureFn, QueryFieldConfig, QueryFieldDef, QueryFieldOptions, QueryFieldValue, QueryFilterConfig, QueryFormBranch, QueryFormChange, QueryFormFields, QueryFormGroup, QueryFormGroupControls, QueryFormModel, QueryFormObserveOptions, QueryFormOf, QueryFormOptions, QueryFormSignalsObserveOptions, QueryFormSignalsWriteOptions, QueryFormValue, QueryFormValueEvent, QueryFormWriteOptions, QueryInvalidationCandidate, QueryInvalidationFilterFn, QueryInvalidationOptions, QueryKey, QueryKeyLockHold, QueryKeyLockManager, QueryKeyLockState, QueryMethod, QueryMockConfig, QueryMultiTabSyncConfig, QueryOf, QueryParams, QueryParamsType, QueryPersistenceAdapter, QueryPersistenceCandidate, QueryPersistenceConfig, QueryPersistenceEngine, QueryPrepareFn, QueryRefreshCause, QueryRegistry, QueryRegistryEntry, QueryRepository, QueryRepositoryCacheEntry, QueryRepositoryDependencies, QueryRepositoryEvent, QueryRepositoryItem, QueryRepositoryRefreshFilterFn, QueryRepositoryRequestOptions, QueryRepositorySubtle, QueryResponseOf, QueryRouteOf, QuerySequence, QuerySequenceResult, QuerySequenceStatus, QuerySequenceStepArgs, QuerySnapshot, QueryStack, QueryStackSubtle, QueryState, QueryStateMeta, QueryStateResponseOf, QueryStateSignal, QueryStateSubtle, QueryStateSuccessMeta, QueryStoreIdOf, QueryStoreOf, QuerySubtle, QuerySuccessEventData, QuerySyncEngine, QuerySyncEnvelope, QuerySyncInvalidateMessage, QuerySyncMessage, QuerySyncMessageListener, QuerySyncMutation, QuerySyncMutationFilterFn, QuerySyncMutationMessage, QuerySyncRefreshCandidate, QuerySyncRefreshOnMutationConfig, QuerySyncResponseMessage, QuerySyncTransport, QueryTrigger, RawResponseType, ReadonlyQuery, RemoveFromConfig, RequestArgs, RequestConfig, RequestError, RequestEvent, RequestHeaders, RequestHeadersMethodMap, RequestHttpEvent, RequestProgress, RequestRetryFn, RequestRetryFnConfig, RequestRetryFnResult, RequiresTransform, ResetExecuteStateOptions, ResetPageOnErrorOperatorConfig, ResponseType, RestQueryConfig, RouteString, RouteType, RunQueryCreator, RunQueryExecuteOptions, SecureExecuteFactoryOptions, ServerValidationError, ServerViolationValidationError, SetupQueryDependenciesOptions, SetupQueryStateOptions, ShouldRetryRequestFn, ShouldRetryRequestOptions, ShouldRetryRequestResult, SocketMessageView, Sort, SortDirection, Success, SymfonyError, SymfonyErrorTrace, TokenExpirationWarningConfig, TokenExpirationWarningFeature, TokenRefreshEventData, TokenRefreshQueryBuilder, TokenRefreshQueryConfig, TokenResponse, TokenRevocationConfig, TokenRevocationFeature, TotalPagesExtractorOptions, TrackingConfig, TrackingEventDataMap, TrackingEventHandler, TrackingEventName, TrackingFeature, TransformedGqlQuery, V2CacheAdapterFn, V2PrepareArgsOf, V2QueryArgsOf, V2QueryClientConfig, V2QueryConfig, V2QueryState, V2RouteString, V2RouteType, ValidateWithQueryConfig, ValidateWithV2QueryConfig, WebSocketClient, WebSocketClientResult, WebSocketClientSubtle, WebSocketDevtoolsHandle, WebSocketDevtoolsMessage, WebSocketRoom, WithAutoRefreshFeatureOptions, WithBody, WithConfig, WithErrorHandlingFeatureOptions, WithHeaders, WithInjector, WithLegacyConfig, WithLoggingFeatureOptions, WithMock, WithPageResetOnErrorFeatureOptions, WithPathParams, WithPollingFeatureOptions, WithQueryParams, WithResponseUpdateFeatureFnData, WithResponseUpdateFeatureOptions, WithSuccessHandlingFeatureOptions, WithVariables };
|