@ethlete/query 4.2.2 → 4.3.1

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

@@ -1,5 +1,17 @@
-import { FormGroup } from '@angular/forms';
-import { QueryFieldOptions, QueryFormGroup, QueryFormObserveOptions, QueryFormValue, QueryFormValueEvent } from './query-form.types';
+import { AbstractControl, FormGroup, ɵValue } from '@angular/forms';
+import { QueryFieldOptions, QueryFormGroupControls, QueryFormObserveOptions, QueryFormValue } from './query-form.types';
+export declare class QueryFormGroup<T extends {
+    [K in keyof T]: AbstractControl<any, any>;
+} = any> extends FormGroup<T> {
+    patchValue(value: 0 extends 1 & T ? {
+        [key: string]: any;
+    } : Partial<{
+        [K in keyof T]: ɵValue<T[K]>;
+    }>, options?: {
+        onlySelf?: boolean | undefined;
+        emitEvent?: boolean | undefined;
+    } | undefined): void;
+}
 export declare class QueryField<T> {
     data: QueryFieldOptions<T>;
     changes$: import("rxjs").Observable<T | null>;
@@ -13,23 +25,35 @@ export declare class QueryField<T> {
 }
 export declare class QueryForm<T extends Record<string, QueryField<any>>> {
     private _fields;
-    private _router;
-    private _activatedRoute;
-    private _defaultValues;
-    form: FormGroup<QueryFormGroup<T>>;
+    private readonly _destroy$;
+    private readonly _unobserveTrigger$;
+    private readonly _router;
+    private readonly _activatedRoute;
+    private readonly _defaultValues;
+    private readonly _routerStateService;
+    private readonly _zone;
+    private _isObserving;
+    readonly form: QueryFormGroup<QueryFormGroupControls<T>>;
+    private readonly _lastFormValue$;
+    private readonly _currentFormValue$;
     private get _formValue();
     private readonly _changes$;
-    readonly changes$: import("rxjs").Observable<QueryFormValueEvent<T>>;
-    get controls(): 0 extends 1 & QueryFormGroup<T> ? {
-        [key: string]: import("@angular/forms").AbstractControl<any, any>;
-    } : QueryFormGroup<T>;
+    readonly changes$: import("rxjs").Observable<{
+        previousValue: QueryFormValue<T> | null;
+        currentValue: QueryFormValue<T>;
+    }>;
+    get controls(): 0 extends 1 & QueryFormGroupControls<T> ? {
+        [key: string]: AbstractControl<any, any>;
+    } : QueryFormGroupControls<T>;
     get value(): QueryFormValue<T>;
     constructor(_fields: T);
-    observe(options?: QueryFormObserveOptions): import("rxjs").Observable<null>;
-    setFormValueFromUrlQueryParams(options?: {
+    observe(options?: QueryFormObserveOptions): void;
+    private _handleQueryFormResets;
+    unobserve(): void;
+    setFormValueFromUrlQueryParams(options: {
+        queryParams: Record<string, unknown>;
         skipDebounce?: boolean;
     }): void;
-    updateFormOnUrlQueryParamsChange(): import("rxjs").Observable<import("@angular/router").Params>;
     private _getDefaultValue;
     private _isDefaultValue;
     private _setupFormGroup;

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

@@ -53,7 +53,7 @@ export interface QueryFieldOptions<T = unknown> {
      */
     valueToQueryParamTransformFn?: (val: T | null) => unknown;
 }
-export type QueryFormGroup<T extends Record<string, QueryField<any>>> = {
+export type QueryFormGroupControls<T extends Record<string, QueryField<any>>> = {
     [Property in keyof T]: T[Property]['control'];
 };
 export type QueryFormValue<T extends Record<string, QueryField<any>>> = {
@@ -62,8 +62,19 @@ export type QueryFormValue<T extends Record<string, QueryField<any>>> = {
 export interface QueryFormObserveOptions {
     /**
      * Whether the form value should be synced to the url query params.
+     * @default true
+     */
+    writeToQueryParams?: boolean;
+    /**
+     * Whether the form value should be updated when the url query params change.
+     * @default true
+     */
+    syncOnNavigation?: boolean;
+    /**
+     * If true, the navigation will not create a new entry in the browser's history.
+     * @default false
      */
-    syncViaUrlQueryParams?: boolean;
+    replaceUrl?: boolean;
 }
 export interface QueryFormValueEvent<T extends Record<string, QueryField<any>>> {
     previousValue: QueryFormValue<T> | null;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "4.2.2",
+  "version": "4.3.1",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1 || ^16.0.0",
     "@angular/core": "^15.2.1 || ^16.0.0",
-    "@ethlete/core": "2.0.0"
+    "@ethlete/core": "2.2.0"
   },
   "module": "fesm2022/ethlete-query.mjs",
   "typings": "index.d.ts",