@ethlete/query 5.16.0 → 5.16.1

package/src/lib/query/query.types.ts

@@ -1,532 +0,0 @@
-import { Observable } from 'rxjs';
-import { EntityStore } from '../entity';
-import { AnyQueryCreator, ConstructQuery, QueryDataOf, QueryResponseOf } from '../query-creator';
-import { QueryForm } from '../query-form';
-import { Method, PathParams, QueryParams, RequestError, RequestProgress } from '../request';
-import { Query } from './query';
-
-export interface QueryAutoRefreshConfig {
-  /**
-   * Refresh the query when the query client's headers change.
-   * @default true
-   */
-  queryClientDefaultHeadersChange?: boolean;
-
-  /**
-   * Refresh the query when the window regains focus.
-   *
-   * This can only be disabled if `autoRefreshQueriesOnWindowFocus` is enabled on the query client.
-   * @default true
-   */
-  windowFocus?: boolean;
-}
-
-export interface EntitySetParams<Store, Response, Arguments, Id> {
-  /**
-   * The response data.
-   */
-  response: Response;
-
-  /**
-   * The id(s) returned by the `id` function.
-   */
-  id: Id;
-
-  /**
-   * The arguments passed to the query.
-   */
-  args: Arguments;
-
-  /**
-   * The entity store.
-   */
-  store: Store;
-}
-
-export interface EntityGetParams<Store, Response, Arguments, Id> {
-  /**
-   * The response data.
-   */
-  response: Response;
-
-  /**
-   * The id(s) returned by the `id` function.
-   */
-  id: Id;
-
-  /**
-   * The arguments passed to the query.
-   */
-  args: Arguments;
-
-  /**
-   * The entity store.
-   */
-  store: Store;
-}
-
-export interface EntityIdParams<Response, Arguments> {
-  /**
-   * The response data.
-   */
-  response: Response;
-
-  /**
-   * The arguments passed to the query.
-   */
-  args: Arguments;
-}
-
-export interface QueryEntityConfig<Store, Data, Response, Arguments, Id> {
-  /**
-   * The entity store to use for the query.
-   */
-  store: Store;
-
-  /**
-   * A function that returns the id of the entity. Can also return an array of ids.
-   */
-  id: (data: EntityIdParams<Response, Arguments>) => Id;
-
-  /**
-   * A function that returns the response data (can be a subset of the response).
-   */
-  get?: (data: EntityGetParams<Store, Response, Arguments, Id>) => Observable<Data>;
-
-  /**
-   * A function to update the entity store every time a new response is received.
-   */
-  set?: (data: EntitySetParams<Store, Response, Arguments, Id>) => void;
-}
-
-export type QueryConfigBase<
-  Response,
-  Arguments extends BaseArguments | undefined,
-  Store extends EntityStore<unknown>,
-  Data,
-  Id,
-> = {
-  /**
-   * The http method to use for the query.
-   */
-  method: Method;
-
-  /**
-   * Determines if the auth provider should be used for this query.
-   * The query **will throw** if the query client's auth provider is unset.
-   */
-  secure?: boolean;
-
-  /**
-   * Determines if the query should emit progress events.
-   */
-  reportProgress?: boolean;
-
-  /**
-   * Determines the query's response type.
-   * @default 'json'
-   */
-  responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';
-
-  /**
-   * Whether this request should be sent with outgoing credentials (cookies).
-   * @default false
-   */
-  withCredentials?: boolean;
-
-  /**
-   * Configuration for handling auto refresh triggers.
-   *
-   * **Note:** This is only available for queries that can be refreshed. (`GET`, `HEAD`, `OPTIONS`, `GQL_QUERY`)
-   */
-  autoRefreshOn?: QueryAutoRefreshConfig;
-
-  /**
-   * Whether to automatically stop polling for this query when the window loses focus.
-   * Polling will resume when the window regains focus.
-   *
-   * This can only be disabled if `enableSmartPolling` is enabled on the query client.
-   * @default true
-   */
-  enableSmartPolling?: boolean;
-
-  /**
-   * Object containing the query's type information.
-   */
-  types?: {
-    /**
-     * The type of the successful response.
-     */
-    response?: Response;
-
-    /**
-     * Arguments for executing the query.
-     *
-     * - `pathParams`: The path parameters for the query. (in front of the ? in the url)
-     * - `queryParams`: The query parameters for the query. (after the ? in the url)
-     * - `body`: The body for the query. Unavailable for GET, HEAD and OPTIONS requests.
-     * - `headers`: The headers for the query.
-     * - `variables`: The variables for the query. (graphql only)
-     */
-    args?: Arguments;
-  };
-
-  /**
-   * Object containing the query's entity store information.
-   */
-  entity?: QueryEntityConfig<Store, Data, Response, Arguments, Id>;
-};
-
-export type RestQueryConfig<
-  Route extends RouteType<Arguments>,
-  Response,
-  Arguments extends BaseArguments | undefined,
-  Store extends EntityStore<unknown>,
-  Data,
-  Id,
-> = QueryConfigBase<Response, Arguments, Store, Data, Id> & {
-  /**
-   * The api route to use for the query.
-   */
-  route: Route;
-};
-
-export type GqlTransferOption = 'GET' | 'POST';
-
-export interface GqlQueryConfig<
-  Route extends RouteType<Arguments> | undefined,
-  Response,
-  Arguments extends BaseArguments | undefined,
-  Store extends EntityStore<unknown>,
-  Data,
-  Id,
-> extends QueryConfigBase<Response, Arguments, Store, Data, Id> {
-  /**
-   * The graphql query to use for the query.
-   */
-  query: string;
-
-  /**
-   * Determines if the query should be sent via GET or POST.
-   * - `GET`: The query will be sent via query parameters.
-   * - `POST`: The query will be sent via the body.
-   * @default 'POST'
-   */
-  transferVia?: GqlTransferOption;
-
-  /**
-   * Subroute to use for the query.
-   */
-  route?: Route;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type AnyRestQueryConfig = RestQueryConfig<any, any, any, any, any, any>;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type AnyGqlQueryConfig = GqlQueryConfig<any, any, any, any, any, any>;
-
-export type QueryConfigWithoutMethod<
-  Route extends RouteType<Arguments>,
-  Response,
-  Arguments extends BaseArguments | undefined,
-  Store extends EntityStore<unknown>,
-  Data,
-  Id,
-> = Omit<RestQueryConfig<Route, Response, Arguments, Store, Data, Id>, 'method'>;
-
-export type GqlQueryConfigWithoutMethod<
-  Route extends RouteType<Arguments>,
-  Response,
-  Arguments extends BaseArguments | undefined,
-  Store extends EntityStore<unknown>,
-  Data,
-  Id,
-> = Omit<GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, 'method'>;
-
-export type BaseArguments = WithHeaders &
-  WithVariables &
-  WithBody &
-  WithQueryParams &
-  WithPathParams &
-  WithMock<unknown>;
-
-export interface WithHeaders {
-  /**
-   * The headers to send with the query.
-   */
-  headers?: Record<string, string>;
-}
-
-export interface QueryMockConfig<MockResponse> {
-  /**
-   * The mock response to use for the query.
-   */
-  response?: MockResponse;
-
-  /**
-   * The mock error to use for the query.
-   */
-  error?: RequestError;
-
-  /**
-   * The delay in milliseconds to wait before resolving the mock.
-   * If progress is enabled, the delay will be used for each progress event.
-   * @default 200
-   */
-  delay?: number;
-
-  /**
-   * Whether to report progress for the mock.
-   * For testing e.g. file uploads.
-   */
-  progress?: {
-    /**
-     * The number of progress events to report.
-     * @default 5
-     */
-    eventCount?: number;
-
-    /**
-     * The type of progress event to report.
-     * @default 'upload'
-     */
-    eventType?: 'download' | 'upload';
-
-    /**
-     * The total size of the file to report progress for in bytes.
-     * @default 1_000_000 (1MB)
-     */
-    fileSize?: number;
-
-    /**
-     * If true, the total size of the file will be omitted from the progress event.
-     * Useful for testing e.g. download progress when the server does not provide a total size.
-     */
-    omitTotal?: boolean;
-
-    /**
-     * If true, the partial text will be omitted from the progress event.
-     * Useful for testing e.g. download progress when the server does not provide a partial text.
-     */
-    omitPartialText?: boolean;
-  };
-
-  /**
-   * This will mock the request failing and getting retried 3 times. After, the request will succeed with the provided response.
-   * Can not be used with `progress` enabled.
-   * @default false
-   */
-  retryIntoResponse?: boolean;
-}
-
-export interface WithMock<MockResponse> {
-  mock?: QueryMockConfig<MockResponse>;
-}
-
-export interface QueryConfig {
-  /**
-   * Whether this query should be added to the internal query store.
-   *
-   * Generally this should be left on `false` unless you know what you are doing.
-   * @default false
-   */
-  skipQueryStore?: boolean;
-
-  /**
-   * The cache key to use for this query.
-   * Useful for queries that are equal but should be stored separately.
-   * Will be generated automatically if not provided.
-   *
-   * Generally this should be left on `undefined` unless you know what you are doing.
-   */
-  queryStoreCacheKey?: string;
-}
-
-export interface WithConfig {
-  /**
-   * Additional configuration for this query.
-   */
-  config?: QueryConfig;
-}
-
-export interface WithVariables {
-  /**
-   * The variables for the query. (graphql only)
-   */
-  variables?: Record<string, unknown>;
-}
-
-export interface WithBody {
-  /**
-   * The body for the query. Unavailable for GET, HEAD and OPTIONS requests.
-   */
-  body?: unknown;
-}
-
-export interface WithQueryParams {
-  /**
-   * The query parameters for the query. (after the ? in the url)
-   */
-  queryParams?: QueryParams;
-}
-
-export interface WithPathParams {
-  /**
-   * The path parameters for the query. (in front of the ? in the url)
-   */
-  pathParams?: PathParams;
-}
-
-export type QueryTrigger = 'program' | 'poll' | 'auto';
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type EmptyObject = {};
-
-export interface ExecuteQueryOptions {
-  /**
-   * 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.
-   * @default false
-   */
-  skipCache?: boolean;
-
-  /**
-   * Whether to cancel the previous request if it is still loading.
-   * @default false
-   */
-  cancelPrevious?: boolean;
-
-  /**
-   * The trigger type for this query.
-   * - `program`: The query was triggered by the user.
-   * - `poll`: The query was triggered by polling.
-   * - `auto`: The query was triggered by an auto refresh event.
-   * @default 'program'
-   * @internal
-   */
-  _triggeredVia?: QueryTrigger;
-
-  /**
-   * Whether this is a retry of an unauthorized request.
-   * @internal
-   */
-  _isUnauthorizedRetry?: boolean;
-}
-
-export type RouteType<Arguments extends BaseArguments | undefined> = Arguments extends {
-  pathParams: infer PathParams;
-}
-  ? (p: PathParams) => RouteString
-  : RouteString;
-
-export type RouteString = `/${string}`;
-
-export type AnyRoute = ((p: PathParams) => string) | RouteString;
-
-export interface PollConfig {
-  /**
-   * The interval in milliseconds to poll the query.
-   */
-  interval: number;
-
-  /**
-   * A observable that will stop the polling when it emits.
-   */
-  takeUntil: Observable<unknown>;
-
-  /**
-   * Whether to trigger the query immediately after polling starts.
-   */
-  triggerImmediately?: boolean;
-}
-
-export const enum QueryStateType {
-  Prepared = 'PREPARED',
-  Loading = 'LOADING',
-  Success = 'SUCCESS',
-  Failure = 'FAILURE',
-  Cancelled = 'CANCELLED',
-}
-
-export interface Prepared {
-  type: QueryStateType.Prepared;
-  meta: QueryStateMeta;
-}
-
-export interface Success<Response = unknown> {
-  type: QueryStateType.Success;
-  response: Response;
-  meta: QueryStateSuccessMeta;
-}
-
-export interface Failure {
-  type: QueryStateType.Failure;
-  error: RequestError;
-  meta: QueryStateMeta;
-}
-
-export interface Loading {
-  type: QueryStateType.Loading;
-  meta: QueryStateMeta;
-  partialText?: string;
-  progress?: RequestProgress;
-}
-
-export interface Cancelled {
-  type: QueryStateType.Cancelled;
-  meta: QueryStateMeta;
-}
-
-export interface QueryStateMeta {
-  id: number;
-  triggeredVia: QueryTrigger;
-  isWaitingForRetry?: boolean;
-  retryNumber?: number;
-  retryDelay?: number;
-}
-
-export interface QueryStateSuccessMeta extends QueryStateMeta {
-  expiresAt?: number;
-}
-
-export type QueryState<Response = unknown> = Loading | Success<Response> | Failure | Cancelled | Prepared;
-
-export type QueryStateResponseOf<T extends QueryState = QueryState> =
-  T extends Success<infer Response> ? Response : never;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type AnyQuery = Query<any, any, any, any, any, any>;
-
-export type AnyQueryCreatorCollection = { [name: string]: AnyQueryCreator };
-
-export type QueryCollectionOf<T extends { [name: string]: AnyQueryCreator }> = {
-  [K in keyof T]: { type: K; query: ConstructQuery<T[K]> };
-}[keyof T];
-
-export type AnyQueryCollection = QueryCollectionOf<AnyQueryCreatorCollection>;
-
-export type QueryOf<T extends AnyQueryCollection | AnyQuery | null> = T extends AnyQuery
-  ? T
-  : T extends AnyQueryCollection
-    ? T['query']
-    : never;
-
-export type AnyQueryCollectionResponse<T extends AnyQueryCollection> = QueryResponseOf<T['query']>;
-export type AnyQueryCollectionData<T extends AnyQueryCollection> = QueryDataOf<T['query']>;
-
-export type QueryCollectionKeysOf<T extends AnyQueryCollection | AnyQuery | null> = T extends AnyQueryCollection
-  ? T['type']
-  : never;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export interface ResetPageOnErrorOperatorConfig<J extends QueryForm<any>> {
-  /**
-   * The query form to reset the page of.
-   */
-  queryForm: J;
-
-  /**
-   * The key of the page control in the query form.
-   * @default 'page'
-   */
-  pageControlKey?: string;
-}

package/src/lib/query/query.utils.spec.ts

@@ -1,92 +0,0 @@
-import { Injector, runInInjectionContext } from '@angular/core';
-import { TestBed } from '@angular/core/testing';
-import { of } from 'rxjs';
-import { QueryClient } from '../query-client';
-import { QueryStateType } from './query.types';
-import { createQueryCollectionSubject, switchQueryCollectionState, switchQueryState } from './query.utils';
-const client = new QueryClient({
-  baseRoute: 'https://jsonplaceholder.typicode.com',
-});
-
-const postsQuery = client.get({
-  route: '/posts',
-});
-
-const posts2Query = client.get({
-  route: '/posts',
-});
-
-let injector: Injector;
-
-beforeEach(() => {
-  TestBed.configureTestingModule({});
-
-  injector = TestBed.inject(Injector);
-});
-
-describe('switchQueryCollectionState', () => {
-  it('should switch to the query state observable and return the query state', (done) => {
-    runInInjectionContext(injector, () => {
-      const collection = createQueryCollectionSubject({ mediaWithDetailsQuery: postsQuery, mediaQuery: posts2Query });
-      collection.next({ type: 'mediaQuery', query: posts2Query.prepare() });
-
-      const result$ = switchQueryCollectionState()(collection);
-
-      result$.subscribe((result) => {
-        expect(result).toEqual({ meta: { id: 0, triggeredVia: 'program' }, type: QueryStateType.Prepared });
-
-        done();
-      });
-    });
-  });
-
-  it('should return null if the query state observable is null', (done) => {
-    runInInjectionContext(injector, () => {
-      const collection = createQueryCollectionSubject({ mediaWithDetailsQuery: postsQuery, mediaQuery: posts2Query });
-
-      const result$ = switchQueryCollectionState()(collection);
-
-      result$.subscribe((result) => {
-        expect(result).toBeNull();
-
-        done();
-      });
-    });
-  });
-});
-
-describe('switchQueryState', () => {
-  it('should switch to the query state observable and return the query state', (done) => {
-    const query = posts2Query.prepare();
-
-    const result$ = switchQueryState()(of(query));
-
-    result$.subscribe((result) => {
-      expect(result).toEqual({ meta: { id: 0, triggeredVia: 'program' }, type: QueryStateType.Prepared });
-
-      done();
-    });
-  });
-
-  it('should return null if the query state observable is null', (done) => {
-    const result$ = switchQueryState()(of(null));
-
-    result$.subscribe((result) => {
-      expect(result).toBeNull();
-
-      done();
-    });
-  });
-});
-
-// describe('takeUntilResponse', () => {
-//   it('should complete the observable when a successful response is received', (done) => {
-//     const query = postsQuery.prepare().execute();
-
-//     query.state$.pipe(takeUntilResponse()).subscribe({
-//       complete: () => {
-//         done();
-//       },
-//     });
-//   });
-// });