@ethlete/query 0.1.0-next.1 → 0.1.0-next.10

package/lib/directives/infinity-query.directive.d.ts

@@ -4,6 +4,7 @@ import { BaseArguments } from '../query';
 import { AnyQueryCreator } from '../query-client';
 import { RequestError } from '../request';
 import * as i0 from "@angular/core";
+import * as i1 from "@ethlete/core";
 interface InfinityQueryContext<Q extends InfinityQueryConfig<AnyQueryCreator, BaseArguments, any, unknown[]>> {
     $implicit: Q['response']['arrayType'] | null;
     infinityQuery: Q['response']['arrayType'] | null;
@@ -18,26 +19,31 @@ interface InfinityQueryContext<Q extends InfinityQueryConfig<AnyQueryCreator, Ba
 }
 export declare const INFINITY_QUERY_TOKEN: InjectionToken<InfinityQueryDirective<any>>;
 export declare class InfinityQueryDirective<Q extends InfinityQueryConfig<AnyQueryCreator, BaseArguments, any, unknown[]>> implements OnInit, OnDestroy {
+    private readonly _queryConfigChanged$;
     private readonly _viewContext;
     private _infinityQueryInstance;
-    private _destroy$;
+    private readonly _destroy$;
     private readonly _cdr;
     private readonly _viewContainerRef;
     private readonly _mainTemplateRef;
     private readonly _errorHandler;
+    private readonly _data$;
     private _isMainViewCreated;
     get infinityQuery(): Q;
     set infinityQuery(v: Q);
     private _infinityQuery;
     get context(): InfinityQueryContext<Q>;
     get instance(): InfinityQuery<AnyQueryCreator, import("../query").Query<any, any, any, any, any>, BaseArguments, any, unknown[]> | null;
+    get data$(): import("rxjs").Observable<Q["response"]["arrayType"]>;
+    get data(): Q["response"]["arrayType"];
     static ngTemplateContextGuard<Q extends InfinityQueryConfig<AnyQueryCreator, BaseArguments, any, unknown[]>>(dir: InfinityQueryDirective<Q>, ctx: unknown): ctx is InfinityQueryContext<Q>;
     ngOnInit(): void;
     ngOnDestroy(): void;
     private _setupInfinityQuery;
     _loadNextPage(): void;
     private _renderMainView;
+    private _cleanup;
     static ɵfac: i0.ɵɵFactoryDeclaration<InfinityQueryDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<InfinityQueryDirective<any>, "[infinityQuery]", never, { "infinityQuery": "infinityQuery"; }, {}, never, never, true>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<InfinityQueryDirective<any>, "[infinityQuery]", ["infinityQuery"], { "infinityQuery": "infinityQuery"; }, {}, never, never, true, [{ directive: typeof i1.DestroyDirective; inputs: {}; outputs: {}; }]>;
 }
 export {};

package/lib/directives/query.directive.d.ts

@@ -31,6 +31,6 @@ export declare class QueryDirective<Q extends AnyQuery | null> implements OnInit
     private _updateView;
     private _renderMainView;
     static ɵfac: i0.ɵɵFactoryDeclaration<QueryDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<QueryDirective<any>, "[query]", never, { "query": "query"; "cache": "queryCache"; }, {}, never, never, true>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<QueryDirective<any>, "[query]", never, { "query": "query"; "cache": "queryCache"; }, {}, never, never, true, never>;
 }
 export {};

package/lib/infinite-query/infinity-query.types.d.ts

@@ -1,5 +1,5 @@
-import { BaseArguments } from '../query';
-import { AnyQueryCreator } from '../query-client';
+import { BaseArguments, QueryStateData } from '../query';
+import { AnyQueryCreator, QueryCreatorArgs, QueryCreatorReturnType } from '../query-client';
 export declare type InfinityQueryParamLocation = 'path' | 'query' | 'body' | 'header' | 'variable';
 export declare type AppendItemsLocation = 'start' | 'end';
 export interface PageParamCalculatorOptions {
@@ -89,3 +89,6 @@ export interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator, Argum
         totalPagesExtractor?: (data: TotalPagesExtractorOptions<QueryResponse>) => number;
     };
 }
+declare type OmitUndefined<T> = T extends undefined ? never : T;
+export declare type InfinityQueryConfigType<QueryCreator extends AnyQueryCreator, InfinityResponse extends unknown[]> = InfinityQueryConfig<QueryCreator, OmitUndefined<QueryCreatorArgs<QueryCreator>>, QueryStateData<QueryCreatorReturnType<QueryCreator>['state']>, InfinityResponse>;
+export {};

package/lib/query/query.utils.d.ts

@@ -1,10 +1,14 @@
 import { Observable } from 'rxjs';
 import { ResponseTransformerType } from '../query-client';
 import { RequestHeaders } from '../request';
-import { BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryState, QueryStateData, QueryStateRawData, RouteType, Success } from './query.types';
-export declare function filterSuccess(): <T extends QueryState<unknown, unknown>, Response_1 extends QueryStateData<T>, RawResponse extends QueryStateRawData<T>>(source: Observable<T>) => Observable<Success<Response_1, RawResponse>>;
-export declare function filterFailure(): <T extends QueryState<unknown, unknown>>(source: Observable<T>) => Observable<Failure>;
+import { AnyQuery, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryRawResponseType, QueryResponseType, QueryState, QueryStateData, QueryStateRawData, QueryStateType, RouteType, Success } from './query.types';
+declare type OmitNull<T> = T extends null ? never : T;
+export declare function filterSuccess(): <T extends QueryState<unknown, unknown> | null, Response_1 extends QueryStateData<OmitNull<T>>, RawResponse extends QueryStateRawData<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response_1, RawResponse>>;
+export declare function filterFailure(): <T extends QueryState<unknown, unknown> | null>(source: Observable<T>) => Observable<Failure>;
+export declare function filterQueryStates(allowedStates: QueryStateType[]): <T extends QueryState<unknown, unknown> | null>(source: Observable<T>) => Observable<T>;
 export declare function takeUntilResponse(): <T extends QueryState<unknown, unknown>>(source: Observable<T>) => Observable<T>;
+export declare function filterNull(): <T>(source: Observable<T>) => Observable<OmitNull<T>>;
+export declare function switchQueryState(): <T extends AnyQuery | null, Response_1 extends QueryResponseType<OmitNull<T>>, RawResponse extends QueryRawResponseType<OmitNull<T>>>(source: Observable<T>) => Observable<QueryState<OmitNull<Response_1>, OmitNull<RawResponse>> | null>;
 export declare const isQueryStateLoading: (state: QueryState | null | undefined) => state is Loading;
 export declare const isQueryStateSuccess: (state: QueryState | null | undefined) => state is Success<unknown, unknown>;
 export declare const isQueryStateFailure: (state: QueryState | null | undefined) => state is Failure;
@@ -12,3 +16,4 @@ export declare const isQueryStateCancelled: (state: QueryState | null | undefine
 export declare const isQueryStatePrepared: (state: QueryState | null | undefined) => state is Prepared;
 export declare const mergeHeaders: (...headers: Array<RequestHeaders | null | undefined>) => RequestHeaders | null | undefined;
 export declare const isGqlQueryConfig: <Response_1, Arguments extends BaseArguments | undefined, Route extends RouteType<Arguments> | undefined, ResponseTransformer extends ResponseTransformerType<Response_1> | undefined>(config: unknown) => config is GqlQueryConfig<Route, Response_1, Arguments, ResponseTransformer>;
+export {};

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

@@ -1,6 +1,6 @@
 import { FormGroup } from '@angular/forms';
 import { Observable } from 'rxjs';
-import { QueryFormGroup, QueryFieldOptions, QueryFormValue } from './query-form.types';
+import { QueryFieldOptions, QueryFormGroup, QueryFormValue } from './query-form.types';
 export declare class QueryField<T> {
     data: QueryFieldOptions<T>;
     changes$: Observable<T | null>;

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

@@ -26,14 +26,24 @@ export interface QueryFieldOptions<T = unknown> {
      * E.g. for a number field, the value from the url query params is a string, but the field requires a number.
      *
      * The following common transformations are already implemented:
+     * - `transformToString`
+     * - `transformToStringArray`
      * - `transformToNumber`
      * - `transformToNumberArray`
      * - `transformToBoolean`
      * - `transformToBooleanArray`
      * - `transformToDate` (expects a string in the default js format)
      * - `transformToDateArray` (expects strings in the default js format)
+     * - `transformToSort` (expects a string in the format `field:direction`)
      */
-    queryParamTransformFn?: (val: unknown) => T | null;
+    queryParamToValueTransformFn?: (val: unknown) => T | null;
+    /**
+     * A function that transforms the value of the field to a value that can be appended to the url query params.
+     *
+     * The following common transformations are already implemented:
+     * - `transformToSortQueryParam` (returns an object containing `field` and `direction` properties)
+     */
+    valueToQueryParamTransformFn?: (val: T | null) => unknown;
 }
 export declare type QueryFormGroup<T extends Record<string, QueryField<any>>> = {
     [Property in keyof T]: T[Property]['control'];

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

@@ -6,3 +6,8 @@ export declare const transformToBoolean: (value: unknown) => boolean | null;
 export declare const transformToBooleanArray: (value: unknown) => boolean[] | null;
 export declare const transformToDate: (value: unknown) => Date | null;
 export declare const transformToDateArray: (value: unknown) => Date[] | null;
+export declare const transformToSort: (value: unknown) => {
+    active: string;
+    direction: "desc" | "asc";
+} | null;
+export declare const transformToSortQueryParam: (value: unknown) => string | null;

package/lib/request/request.types.d.ts

@@ -4,6 +4,8 @@ export interface RequestError<Detail = unknown> {
     message: string;
     detail: Detail;
     raw: unknown;
+    route: string;
+    requestInit?: RequestInit;
 }
 export declare type ParamPrimitive = string | number | boolean | null | undefined;
 export declare type Params = Record<string | number | symbol, ParamPrimitive | ParamArray>;

package/lib/request/request.util.d.ts

@@ -1,4 +1,4 @@
-import { QueryParams, Params, RequestError, ParamArray, UnfilteredParamPrimitive, Method } from './request.types';
+import { Method, ParamArray, Params, QueryParams, RequestError, UnfilteredParamPrimitive } from './request.types';
 export declare const isRequestError: (error: unknown) => error is RequestError<unknown>;
 export declare const isAbortRequestError: (error: unknown) => error is RequestError<unknown>;
 export declare const buildRoute: (options: {
@@ -14,7 +14,7 @@ export declare const filterInvalidParams: (params: QueryParams) => Params;
 export declare const isParamValid: (primitive: UnfilteredParamPrimitive) => boolean;
 export declare const extractExpiresInSeconds: (headers: Headers) => number | null;
 export declare const buildTimestampFromSeconds: (seconds: number | null) => number | null;
-export declare const buildRequestError: <ErrorResponse = unknown>(error: unknown) => Promise<RequestError<null> | RequestError<ErrorResponse>>;
+export declare const buildRequestError: <ErrorResponse = unknown>(error: unknown, route: string, requestInit?: RequestInit) => Promise<RequestError<null> | RequestError<ErrorResponse>>;
 export declare const buildBody: (body: unknown) => string | FormData | null;
 export declare const transformMethod: (method: Method) => "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
 export declare const guessContentType: (body: unknown) => "text/plain" | "multipart/form-data" | "application/json" | null;

package/lib/utils/deep-freeze.util.d.ts

@@ -1 +1 @@
-export declare const deepFreeze: <T extends Record<string, unknown>>(object: T) => Readonly<T>;
+export declare const deepFreeze: <T extends Record<string, unknown>>(object: T) => T;

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@ethlete/query",
-  "version": "0.1.0-next.1",
+  "version": "0.1.0-next.10",
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
-    "@angular/common": "^14.2.0",
-    "@angular/core": "^14.2.0",
+    "@angular/common": "^14.2.0 || ^15.0.0",
+    "@angular/core": "^14.2.0 || ^15.0.0",
     "rxjs": "7.5.7",
-    "@angular/forms": "14.2.9",
-    "@angular/router": "14.2.9"
+    "@ethlete/core": "0.2.0-next.8",
+    "@angular/forms": "15.0.2",
+    "@angular/router": "15.0.2"
   },
   "module": "fesm2015/ethlete-query.mjs",
   "es2020": "fesm2020/ethlete-query.mjs",