@ethlete/query 3.0.4 → 4.0.1

package/index.d.ts

@@ -10,4 +10,5 @@ export * from './lib/query-creator';
 export * from './lib/query-form';
 export * from './lib/query-store';
 export * from './lib/request';
+export * from './lib/symfony';
 export * from './lib/utils';

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

@@ -1,6 +1,7 @@
 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 {
@@ -287,3 +288,14 @@ 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 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/lib/query/query.utils.d.ts

@@ -3,8 +3,9 @@ import { BehaviorSubject, Observable } from 'rxjs';
 import { EntityStore } from '../entity';
 import { QueryClient } from '../query-client';
 import { AnyQueryCreator, QueryArgsOf, QueryCreator, QueryDataOf, QueryResponseOf, QueryStoreIdOf, QueryStoreOf } from '../query-creator';
+import { QueryForm } from '../query-form';
 import { Method, RequestHeaders, RequestHeadersMethodMap } from '../request';
-import { AnyGqlQueryConfig, AnyQuery, AnyQueryCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryCollectionOf, QueryState, QueryStateResponseOf, QueryStateType, RouteType, Success } from './query.types';
+import { AnyGqlQueryConfig, AnyQuery, AnyQueryCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryCollectionOf, QueryState, QueryStateResponseOf, QueryStateType, ResetPageOnErrorOperatorConfig, RouteType, Success } from './query.types';
 type OmitNull<T> = T extends null ? never : T;
 export declare function filterSuccess(): <T extends QueryState<unknown> | null, Response_1 extends QueryStateResponseOf<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response_1>>;
 export declare function ignoreAutoRefresh(): <T extends QueryState<unknown> | null>(source: Observable<T>) => Observable<T>;
@@ -19,6 +20,7 @@ export declare function switchQueryCollectionState(): <T extends {
     type: string;
     query: import("@ethlete/query").Query<any, any, any, any, any, any>;
 } | null, Data extends QueryDataOf<OmitNull<T>["query"]>>(source: Observable<T>) => Observable<QueryState<Data> | null>;
+export declare const resetPageOnError: <T extends AnyQuery | null | undefined, J extends QueryForm<any>>(config: ResetPageOnErrorOperatorConfig<J>) => (source: Observable<T>) => Observable<T | QueryState<any>>;
 export declare const isQueryStateLoading: (state: QueryState | null | undefined) => state is Loading;
 export declare const isQueryStateSuccess: (state: QueryState | null | undefined) => state is Success<unknown>;
 export declare const isQueryStateFailure: (state: QueryState | null | undefined) => state is Failure;

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

@@ -1,6 +1,6 @@
 import { FormGroup } from '@angular/forms';
 import { Observable } from 'rxjs';
-import { QueryFieldOptions, QueryFormGroup, QueryFormValue } from './query-form.types';
+import { QueryFieldOptions, QueryFormGroup, QueryFormObserveOptions, QueryFormValue } from './query-form.types';
 export declare class QueryField<T> {
     data: QueryFieldOptions<T>;
     changes$: Observable<T | null>;
@@ -19,9 +19,10 @@ export declare class QueryForm<T extends Record<string, QueryField<any>>> {
     private _defaultValues;
     form: FormGroup<QueryFormGroup<T>>;
     constructor(_fields: T);
-    observe(options?: {
-        syncViaUrlQueryParams?: boolean;
-    }): Observable<QueryFormValue<T>>;
+    observe(options?: QueryFormObserveOptions): Observable<{
+        previousValue: QueryFormValue<T>;
+        currentValue: QueryFormValue<T>;
+    }>;
     setFormValueFromUrlQueryParams(options?: {
         skipDebounce?: boolean;
     }): void;

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

@@ -21,6 +21,14 @@ export interface QueryFieldOptions<T = unknown> {
      * @default true
      */
     appendToUrl?: boolean;
+    /**
+     * Reset the field's value to the default value if one or more of the specified fields are changed.
+     *
+     * @example
+     * // Given this field is a `page` field, the field will be reset if the `limit`, `query` or `search` fields are changed.
+     * ['limit', 'query', 'search']
+     */
+    isResetBy?: string | string[];
     /**
      * A function that transforms the the value gotten from the url query params to a value required by the field.
      * E.g. for a number field, the value from the url query params is a string, but the field requires a number.
@@ -51,3 +59,9 @@ export type QueryFormGroup<T extends Record<string, QueryField<any>>> = {
 export type QueryFormValue<T extends Record<string, QueryField<any>>> = {
     [Property in keyof T]: T[Property]['control']['value'];
 };
+export interface QueryFormObserveOptions {
+    /**
+     * Whether the form value should be synced to the url query params.
+     */
+    syncViaUrlQueryParams?: boolean;
+}

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

@@ -8,6 +8,6 @@ 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";
+    direction: "asc" | "desc";
 } | null;
 export declare const transformToSortQueryParam: (value: unknown) => string | null;

package/lib/symfony/index.d.ts

@@ -0,0 +1,2 @@
+export * from './symfony.types';
+export * from './symfony.utils';

package/lib/symfony/symfony.types.d.ts

@@ -0,0 +1,19 @@
+import { HttpStatusCode } from '../request';
+export interface SymfonyErrorTrace {
+    args: string[];
+    class: string;
+    file: string;
+    function: string;
+    line: number;
+    namespace: string;
+    short_class: string;
+    type: string;
+}
+export interface SymfonyError {
+    class: string;
+    detail: string;
+    status: HttpStatusCode;
+    title: string;
+    trace: SymfonyErrorTrace[];
+    type: string;
+}

package/lib/symfony/symfony.utils.d.ts

@@ -0,0 +1,3 @@
+import { SymfonyError } from './symfony.types';
+export declare const isSymfonyError: (error: unknown) => error is SymfonyError;
+export declare const isSymfonyPagerfantaOutOfRangeError: (error: unknown) => error is SymfonyError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query",
-  "version": "3.0.4",
+  "version": "4.0.1",
   "dependencies": {
     "tslib": "^2.5.0"
   },