@ethlete/query 5.23.0 → 5.25.0

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

@@ -1,39 +0,0 @@
-import { PathParamsType, Query, QueryArgs } from './query';
-import { QueryClientConfig } from './query-client-config';
-import { QueryFeature } from './query-features';
-export type RouteType<TArgs extends QueryArgs> = PathParamsType<TArgs> extends {
-    [key: string]: string;
-} ? (args: TArgs['pathParams']) => RouteString : RouteString;
-export type RouteString = `/${string}`;
-export type CreateQueryCreatorOptions<TArgs extends QueryArgs> = {
-    route: RouteType<TArgs>;
-    reportProgress?: boolean;
-    responseType?: 'json';
-    withCredentials?: boolean;
-    transferCache?: {
-        includeHeaders?: string[];
-    } | boolean;
-};
-export type QueryCreator<TArgs extends QueryArgs> = {
-    (...features: QueryFeature<TArgs>[]): Query<TArgs>;
-    (queryConfig: QueryConfig, ...features: QueryFeature<TArgs>[]): Query<TArgs>;
-};
-export type QueryMethod = 'GET' | 'OPTIONS' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'CONNECT';
-export type InternalCreateQueryCreatorOptions = {
-    method: QueryMethod;
-    client: QueryClientConfig;
-};
-export type QueryConfig = {
-    /** A custom id to use for this query. Only affects queries that can be cached. */
-    key?: string;
-    /**
-     * If true, the query will not be executed automatically.
-     * Does not affect mutations such as POST, PUT etc. since those are never executed automatically.
-     */
-    onlyManualExecution?: boolean;
-};
-export declare const splitQueryConfig: <TArgs extends QueryArgs>(args: (QueryFeature<TArgs> | QueryConfig)[]) => {
-    features: QueryFeature<TArgs>[];
-    queryConfig: QueryConfig;
-};
-export declare const createQueryCreator: <TArgs extends QueryArgs>(options: CreateQueryCreatorOptions<TArgs>, internals: InternalCreateQueryCreatorOptions) => QueryCreator<TArgs>;

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

@@ -1,49 +0,0 @@
-import { RuntimeError } from '@ethlete/core';
-import { QueryMethod } from './query-creator';
-import { QueryFeatureType } from './query-features';
-export declare const enum RuntimeErrorCode {
-    QUERY_FEATURE_USED_MULTIPLE_TIMES = 0,
-    WITH_ARGS_QUERY_FEATURE_MISSING_BUT_ROUTE_IS_FUNCTION = 100,
-    WITH_POLLING_USED_ON_UNSUPPORTED_HTTP_METHOD = 101,
-    WITH_AUTO_REFRESH_USED_ON_UNSUPPORTED_HTTP_METHOD = 102,
-    WITH_AUTO_REFRESH_USED_IN_MANUAL_QUERY = 103,
-    COOKIE_LOGIN_TRIED_BUT_COOKIE_DISABLED = 200,
-    ENABLE_COOKIE_CALLED_WITHOUT_COOKIE_CONFIG = 201,
-    DISABLE_COOKIE_CALLED_WITHOUT_COOKIE_CONFIG = 202,
-    LOGIN_CALLED_WITHOUT_CONFIG = 203,
-    LOGIN_WITH_TOKEN_CALLED_WITHOUT_CONFIG = 204,
-    REFRESH_TOKEN_CALLED_WITHOUT_CONFIG = 205,
-    SELECT_ROLE_CALLED_WITHOUT_CONFIG = 206,
-    DEFAULT_RESPONSE_TRANSFORMER_RESPONSE_NOT_OBJECT = 207,
-    DEFAULT_RESPONSE_TRANSFORMER_RESPONSE_NOT_CONTAINING_ACCESS_TOKEN = 208,
-    DEFAULT_RESPONSE_TRANSFORMER_RESPONSE_NOT_CONTAINING_REFRESH_TOKEN = 209,
-    UNABLE_TO_DECRYPT_BEARER_TOKEN = 210,
-    BEARER_EXPIRES_IN_PROPERTY_NOT_NUMBER = 211,
-    UNCACHEABLE_REQUEST_HAS_CACHE_KEY_PARAM = 300,
-    UNCACHEABLE_REQUEST_HAS_ALLOW_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>;
-export declare const withPollingUsedOnUnsupportedHttpMethod: (method: QueryMethod) => RuntimeError<RuntimeErrorCode.WITH_POLLING_USED_ON_UNSUPPORTED_HTTP_METHOD>;
-export declare const withAutoRefreshUsedOnUnsupportedHttpMethod: (method: QueryMethod) => RuntimeError<RuntimeErrorCode.WITH_AUTO_REFRESH_USED_ON_UNSUPPORTED_HTTP_METHOD>;
-export declare const withAutoRefreshUsedInManualQuery: () => RuntimeError<RuntimeErrorCode.WITH_AUTO_REFRESH_USED_IN_MANUAL_QUERY>;
-export declare const cookieLoginTriedButCookieDisabled: () => RuntimeError<RuntimeErrorCode.COOKIE_LOGIN_TRIED_BUT_COOKIE_DISABLED>;
-export declare const enableCookieCalledWithoutCookieConfig: () => RuntimeError<RuntimeErrorCode.ENABLE_COOKIE_CALLED_WITHOUT_COOKIE_CONFIG>;
-export declare const disableCookieCalledWithoutCookieConfig: () => RuntimeError<RuntimeErrorCode.DISABLE_COOKIE_CALLED_WITHOUT_COOKIE_CONFIG>;
-export declare const loginCalledWithoutConfig: () => RuntimeError<RuntimeErrorCode.LOGIN_CALLED_WITHOUT_CONFIG>;
-export declare const loginWithTokenCalledWithoutConfig: () => RuntimeError<RuntimeErrorCode.LOGIN_WITH_TOKEN_CALLED_WITHOUT_CONFIG>;
-export declare const refreshTokenCalledWithoutConfig: () => RuntimeError<RuntimeErrorCode.REFRESH_TOKEN_CALLED_WITHOUT_CONFIG>;
-export declare const selectRoleCalledWithoutConfig: () => RuntimeError<RuntimeErrorCode.SELECT_ROLE_CALLED_WITHOUT_CONFIG>;
-export declare const defaultResponseTransformerResponseNotObject: (currentType: string) => RuntimeError<RuntimeErrorCode.DEFAULT_RESPONSE_TRANSFORMER_RESPONSE_NOT_OBJECT>;
-export declare const defaultResponseTransformerResponseNotContainingAccessToken: () => RuntimeError<RuntimeErrorCode.DEFAULT_RESPONSE_TRANSFORMER_RESPONSE_NOT_CONTAINING_ACCESS_TOKEN>;
-export declare const defaultResponseTransformerResponseNotContainingRefreshToken: () => RuntimeError<RuntimeErrorCode.DEFAULT_RESPONSE_TRANSFORMER_RESPONSE_NOT_CONTAINING_REFRESH_TOKEN>;
-export declare const unableToDecryptBearerToken: (token: string) => RuntimeError<RuntimeErrorCode.UNABLE_TO_DECRYPT_BEARER_TOKEN>;
-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 uncacheableRequestHasAllowCacheParam: () => RuntimeError<RuntimeErrorCode.UNCACHEABLE_REQUEST_HAS_ALLOW_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-features.d.ts

@@ -1,48 +0,0 @@
-import { HttpErrorResponse, HttpEvent } from '@angular/common/http';
-import { Signal } from '@angular/core';
-import { QueryArgs, RequestArgs, ResponseType } from './query';
-import { CreateQueryCreatorOptions, InternalCreateQueryCreatorOptions, QueryConfig } from './query-creator';
-import { QueryDependencies } from './query-dependencies';
-import { QueryExecute } from './query-execute';
-import { QueryState } from './query-state';
-import { QueryArgsReset, QueryFeatureFlags } from './query-utils';
-export declare const enum QueryFeatureType {
-    WithArgs = "withArgs",
-    WithLogging = "withLogging",
-    WithErrorHandling = "withErrorHandling",
-    WithSuccessHandling = "withSuccessHandling",
-    WithPolling = "withPolling",
-    WithAutoRefresh = "withAutoRefresh"
-}
-export type QueryFeatureContext<TArgs extends QueryArgs> = {
-    state: QueryState<TArgs>;
-    queryConfig: QueryConfig;
-    creatorConfig: CreateQueryCreatorOptions<TArgs>;
-    creatorInternals: InternalCreateQueryCreatorOptions;
-    execute: QueryExecute<TArgs>;
-    deps: QueryDependencies;
-    flags: QueryFeatureFlags;
-};
-export type QueryFeatureFn<TArgs extends QueryArgs> = (context: QueryFeatureContext<TArgs>) => void;
-export type QueryFeature<TArgs extends QueryArgs> = {
-    type: QueryFeatureType;
-    fn: (context: QueryFeatureContext<TArgs>) => void;
-};
-export declare const withArgs: <TArgs extends QueryArgs>(args: () => NoInfer<RequestArgs<TArgs>> | QueryArgsReset | null) => QueryFeature<TArgs>;
-export declare const withPolling: <TArgs extends QueryArgs>(options: {
-    interval: number;
-    executeInitially?: boolean;
-}) => QueryFeature<TArgs>;
-export declare const withLogging: <TArgs extends QueryArgs>(options: {
-    logFn: (v: HttpEvent<ResponseType<TArgs>> | null) => void;
-}) => QueryFeature<TArgs>;
-export declare const withErrorHandling: <TArgs extends QueryArgs>(options: {
-    handler: (e: HttpErrorResponse) => void;
-}) => QueryFeature<TArgs>;
-export declare const withSuccessHandling: <TArgs extends QueryArgs>(options: {
-    handler: (data: NonNullable<ResponseType<TArgs>>) => void;
-}) => QueryFeature<TArgs>;
-export declare const withAutoRefresh: <TArgs extends QueryArgs>(options: {
-    signalChanges: Signal<unknown>[];
-    ignoreOnlyManualExecution?: boolean;
-}) => QueryFeature<TArgs>;

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

@@ -1,48 +0,0 @@
-import { HttpErrorResponse } from '@angular/common/http';
-import { Signal } from '@angular/core';
-import { AnyQuery } from './query';
-export type QueryStack<T extends AnyQuery, J = ReturnType<T['response']>[]> = {
-    /** Contains all queries in the stack. */
-    queries: Signal<T[]>;
-    /** Contains the last query in the stack. Useful for getting current pagination values. */
-    lastQuery: Signal<T | null>;
-    /** True if any query in the stack is loading. */
-    loading: Signal<boolean>;
-    /** Contains the first error that occurred in the stack. */
-    error: Signal<HttpErrorResponse | null>;
-    /** 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: (options?: {
-        allowCache?: boolean;
-    }) => void;
-    /** Destroys all queries in the stack and empties it. This should only be used if `append` is true. */
-    clear: () => void;
-};
-export type AnyQueryStack = QueryStack<AnyQuery>;
-export type CreateQueryStackOptions<T extends AnyQuery, J = ReturnType<T['response']>[]> = {
-    /**
-     * If true, new queries will be appended to the existing ones. Otherwise, existing queries will be destroyed.
-     * This should be used for things like infinite scrolling where already fetched queries should not be destroyed.
-     */
-    append?: boolean;
-    /**
-     * If append is true, this function will be called to merge the old and new queries.
-     * Useful if you want to append the new queries in a specific order (e.g. at the beginning).
-     */
-    appendFn?: (oldQueries: T[], newQueries: T[]) => {
-        /** The new queries merged with the old ones. */
-        queries: T[];
-        /** The last query in the new queries. */
-        lastQuery: T | null;
-    };
-    /**
-     * Transforms the responses of all queries in the stack. Useful for merging or filtering responses.
-     */
-    transform?: (responses: ReturnType<T['response']>[]) => J;
-};
-export declare const transformArrayResponse: <T extends (unknown | null)[]>(responses: T) => NonNullable<T[0]>[];
-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[] | null, options?: CreateQueryStackOptions<T, J>) => QueryStack<T, J>;