@ethlete/query 5.20.1 → 5.21.1

package/lib/experimental/http-request.d.ts

@@ -91,7 +91,9 @@ export type HttpRequestLoadingProgressState = {
 };
 export type HttpRequest<TArgs extends QueryArgs> = {
     /** Executes the request */
-    execute: () => boolean;
+    execute: (options?: {
+        skipCache?: boolean;
+    }) => boolean;
     /** Destroys the request (cancels it if in progress) */
     destroy: () => boolean;
     /** The loading state of the request */

package/lib/experimental/index.d.ts

@@ -1,6 +1,7 @@
 export * from './bearer-auth-provider';
 export * from './bearer-auth-provider-config';
 export * from './http-request';
+export * from './paged-query';
 export * from './query';
 export * from './query-client';
 export * from './query-client-config';

package/lib/experimental/paged-query.d.ts

@@ -0,0 +1,35 @@
+import { ContentfulGqlLikePaginated, DynLikePaginated, GgLikePaginated, NormalizedPagination, Paginated } from '@ethlete/types';
+import { Query, QueryArgs, RequestArgs, ResponseType } from './query';
+import { QueryCreator } from './query-creator';
+export declare const ethletePaginationAdapter: <T>(response: Paginated<T>) => NormalizedPagination<T>;
+export declare const ggLikePaginationAdapter: <T>(response: GgLikePaginated<T>) => NormalizedPagination<T>;
+export declare const dynLikePaginationAdapter: <T>(response: DynLikePaginated<T>) => NormalizedPagination<T>;
+export declare const contentfulGqlLikePaginationAdapter: <T>(response: ContentfulGqlLikePaginated<T>) => NormalizedPagination<T>;
+export type CreatePagedQueryOptions<TArgs extends QueryArgs> = {
+    responseNormalizer: (response: ResponseType<TArgs>) => NormalizedPagination<ResponseType<TArgs>>;
+    queryCreator: QueryCreator<TArgs>;
+    args: (page: number) => RequestArgs<TArgs>;
+    initialPage?: number;
+};
+export type PagedQueryResetOptions = {
+    initialPage?: number;
+};
+export declare const createPagedQuery: <TArgs extends QueryArgs>(options: CreatePagedQueryOptions<TArgs>) => {
+    pagination: import("@angular/core").Signal<NormalizedPagination<ResponseType<TArgs>> | null>;
+    fetchPreviousPage: () => void;
+    fetchNextPage: () => void;
+    canFetchPreviousPage: import("@angular/core").Signal<boolean>;
+    canFetchNextPage: import("@angular/core").Signal<boolean>;
+    items: import("@angular/core").Signal<ResponseType<TArgs>[]>;
+    direction: import("@angular/core").Signal<"next" | "previous">;
+    loading: import("@angular/core").Signal<boolean>;
+    error: import("@angular/core").Signal<import("@angular/common/http").HttpErrorResponse | null>;
+    lastQuery: import("@angular/core").Signal<Query<TArgs> | null>;
+    isFirstLoad: import("@angular/core").Signal<boolean>;
+    queries: Query<TArgs>[];
+    reset: (resetOptions?: PagedQueryResetOptions) => void;
+    execute: (options?: {
+        where?: (items: ResponseType<TArgs>) => boolean;
+        skipCache?: boolean;
+    }) => void;
+};

package/lib/experimental/query-errors.d.ts

@@ -20,7 +20,10 @@ export declare const enum RuntimeErrorCode {
     UNABLE_TO_DECRYPT_BEARER_TOKEN = 210,
     BEARER_EXPIRES_IN_PROPERTY_NOT_NUMBER = 211,
     UNCACHEABLE_REQUEST_HAS_CACHE_KEY_PARAM = 300,
-    UNCACHEABLE_REQUEST_HAS_SKIP_CACHE_PARAM = 301
+    UNCACHEABLE_REQUEST_HAS_SKIP_CACHE_PARAM = 301,
+    PAGED_QUERY_PAGE_BIGGER_THAN_TOTAL_PAGES = 400,
+    PAGED_QUERY_NEXT_PAGE_CALLED_WITHOUT_PREVIOUS_PAGE = 401,
+    PAGED_QUERY_PREVIOUS_PAGE_CALLED_BUT_ALREADY_AT_FIRST_PAGE = 402
 }
 export declare const queryFeatureUsedMultipleTimes: (type: QueryFeatureType) => RuntimeError<RuntimeErrorCode.QUERY_FEATURE_USED_MULTIPLE_TIMES>;
 export declare const withArgsQueryFeatureMissingButRouteIsFunction: () => RuntimeError<RuntimeErrorCode.WITH_ARGS_QUERY_FEATURE_MISSING_BUT_ROUTE_IS_FUNCTION>;
@@ -41,3 +44,6 @@ export declare const unableToDecryptBearerToken: (token: string) => RuntimeError
 export declare const bearerExpiresInPropertyNotNumber: (expiresIn: unknown) => RuntimeError<RuntimeErrorCode.BEARER_EXPIRES_IN_PROPERTY_NOT_NUMBER>;
 export declare const uncacheableRequestHasCacheKeyParam: (key: string) => RuntimeError<RuntimeErrorCode.UNCACHEABLE_REQUEST_HAS_CACHE_KEY_PARAM>;
 export declare const uncacheableRequestHasSkipCacheParam: () => RuntimeError<RuntimeErrorCode.UNCACHEABLE_REQUEST_HAS_SKIP_CACHE_PARAM>;
+export declare const pagedQueryPageBiggerThanTotalPages: (page: number, totalPages: number) => RuntimeError<RuntimeErrorCode.PAGED_QUERY_PAGE_BIGGER_THAN_TOTAL_PAGES>;
+export declare const pagedQueryNextPageCalledWithoutPreviousPage: () => RuntimeError<RuntimeErrorCode.PAGED_QUERY_NEXT_PAGE_CALLED_WITHOUT_PREVIOUS_PAGE>;
+export declare const pagedQueryPreviousPageCalledButAlreadyAtFirstPage: () => RuntimeError<RuntimeErrorCode.PAGED_QUERY_PREVIOUS_PAGE_CALLED_BUT_ALREADY_AT_FIRST_PAGE>;

package/lib/experimental/query-stack.d.ts

@@ -13,7 +13,9 @@ export type QueryStack<T extends AnyQuery, J = ReturnType<T['response']>[]> = {
     /** Contains the responses of all queries in the stack. Will be `null` for queries that are loading or errored. */
     response: Signal<J>;
     /** Executes all queries in the stack. */
-    execute: () => void;
+    execute: (options?: {
+        skipCache?: boolean;
+    }) => void;
     /** Destroys all queries in the stack and empties it. This should only be used if `append` is true. */
     clear: () => void;
 };
@@ -43,4 +45,4 @@ export declare const transformArrayResponse: <T extends (unknown | null)[]>(resp
 export declare const transformPaginatedResponse: <T extends ({
     items: unknown[];
 } | null)[]>(responses: T) => NonNullable<NonNullable<T[0]>["items"]>;
-export declare const createQueryStack: <T extends AnyQuery, J = ReturnType<T["response"]>[]>(computation: () => T | T[], options?: CreateQueryStackOptions<T, J>) => QueryStack<T, J>;
+export declare const createQueryStack: <T extends AnyQuery, J = ReturnType<T["response"]>[]>(computation: () => T | T[] | null, options?: CreateQueryStackOptions<T, J>) => QueryStack<T, J>;

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

@@ -4,8 +4,9 @@ export interface QueryFieldOptions<T = unknown> {
     /**
      * The default value of the field.
      * Will be set to the initial value of the form control if not specified.
+     * If a function is provided, it will be called to get the default value.
      */
-    defaultValue?: T | null;
+    defaultValue?: T | (() => T) | null;
     /**
      * Debounce time in milliseconds.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query",
-  "version": "5.20.1",
+  "version": "5.21.1",
   "peerDependencies": {
     "@angular/common": "^18.1.0",
     "@angular/core": "^18.1.0",