@ethlete/query 4.12.0 → 4.13.0

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

@@ -11,7 +11,7 @@ export declare class QueryCreator<Arguments extends BaseArguments | undefined, R
     constructor(_queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, _client: QueryClient, _store: QueryStore);
     prepare: QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>;
     createSubject: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => QuerySubject<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
-    createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => void;
+    createSignal: (initialValue?: ReturnType<typeof this.prepare> | null, config?: QueryContainerConfig) => import("@angular/core").WritableSignal<ReturnType<QueryPrepareFn<Arguments, Response, Route, Store, Data, Id>> | null>;
     /**
      * @deprecated Use `myQuery.createSubject()` or `myQuery.createSignal()` instead. Will be removed in v5.
      */

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

@@ -1,5 +1,5 @@
 import { FormGroup } from '@angular/forms';
-import { QueryFieldOptions, QueryFormGroupControls, QueryFormObserveOptions, QueryFormValue, QueryFormValueEvent } from './query-form.types';
+import { QueryFieldOptions, QueryFormGroupControls, QueryFormObserveOptions, QueryFormValue, QueryFormValueEvent, QueryFormWriteOptions } from './query-form.types';
 export declare class QueryField<T> {
     data: QueryFieldOptions<T>;
     get control(): import("@angular/forms").FormControl<T | null>;
@@ -16,6 +16,17 @@ export declare class QueryForm<T extends Record<string, QueryField<any>>> {
     private readonly _zone;
     private readonly _didValueChanges$;
     private _isObserving;
+    private _skipNextResets;
+    /**
+     * The angular form group that contains all the fields.
+     *
+     * **Do not** use any of the following methods on this form group:
+     * - `setValue`: Use `QueryForm.setValue` instead.
+     * - `patchValue`: Use `QueryForm.patchValue` instead.
+     * - `valueChanges`: Use `QueryForm.changes$` instead.
+     * - `value`: Use `QueryForm.value` instead.
+     * - `controls`: Use `QueryForm.controls` instead.
+     */
     readonly form: FormGroup<QueryFormGroupControls<T>>;
     private readonly _lastFormValue$;
     private readonly _currentFormValue$;
@@ -33,6 +44,8 @@ export declare class QueryForm<T extends Record<string, QueryField<any>>> {
     setFormValueFromUrlQueryParams(options: {
         queryParams: Record<string, unknown>;
     }): boolean;
+    setValue(value: QueryFormValue<T>, options?: QueryFormWriteOptions): void;
+    patchValue(value: Partial<QueryFormValue<T>>, options?: QueryFormWriteOptions): void;
     private _getDefaultValue;
     private _isDefaultValue;
     private _setupFormGroup;

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

@@ -87,3 +87,22 @@ export interface QueryFormValueEvent<T extends Record<string, QueryField<any>>>
     previousValue: QueryFormValue<T> | null;
     currentValue: QueryFormValue<T>;
 }
+export interface QueryFormWriteOptions {
+    /**
+     * When true, each change only affects this control, and not its parent.
+     * @default false
+     */
+    onlySelf?: boolean;
+    /**
+     * When true or not supplied (the default), both the `statusChanges` and `valueChanges`
+     * observables emit events with the latest status and value when the control value is updated.
+     * When false, no events are emitted.
+     * @default true
+     */
+    emitEvent?: boolean;
+    /**
+     * When true, the `resetBy` conditions will be ignored for this write.
+     * @default false
+     */
+    skipResets?: boolean;
+}

package/lib/utils/data.utils.d.ts

@@ -12,4 +12,4 @@ export declare class QuerySubject<T extends AnyQuery | null> extends BehaviorSub
     constructor(initialValue?: T, _config?: QueryContainerConfig | undefined);
     next(value: T): void;
 }
-export declare const querySignal: <T extends AnyQuery | null>(initialValue?: T, config?: QueryContainerConfig) => void;
+export declare const querySignal: <T extends AnyQuery | null>(initialValue?: T, config?: QueryContainerConfig) => import("@angular/core").WritableSignal<T>;

package/package.json

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