@ethlete/cdk 4.37.1 → 4.38.0

package/lib/components/forms/utils/form-changes-tracker.util.d.ts

@@ -0,0 +1,47 @@
+import { Signal } from '@angular/core';
+import { AbstractControl } from '@angular/forms';
+export interface FormChangesTrackerRef<T> {
+    /**
+     * Set the default form value to the current form value.
+     * Useful when the form value changes.
+     *
+     * (e.g. when a http request was needed to fill the remaining form fields to their default values)
+     */
+    refreshDefaultFormValue: () => void;
+    /**
+     * Restore the default form value to the form.
+     */
+    restoreDefaultFormValue: () => void;
+    /**
+     * Checks if the form has changes compared to the default form value.
+     * @returns `true` if the form has changes.
+     */
+    hasChanges: Signal<boolean>;
+    /**
+     * The default form value to compare the current form value to
+     */
+    defaultFormValue: Signal<T>;
+}
+export type CreateFormChangesTrackerConfig<T extends AbstractControl> = {
+    /**
+     * The form to check for changes
+     */
+    form: T;
+    /**
+     * The default value to compare the current form value to
+     *
+     * @default form.getRawValue()
+     */
+    defaultValue?: ReturnType<T['getRawValue']>;
+    /**
+     * A custom compare function to compare the current form value to the default value.
+     * By default, a deep comparison will be used.
+     *
+     * @default (currentValue, defaultValue) => equal(currentValue, defaultValue)
+     */
+    compareFn?: (currentValue: ReturnType<T['getRawValue']>, defaultValue: ReturnType<T['getRawValue']>) => boolean;
+};
+/**
+ * A utility function to enhance form usage by providing methods to manage form state and detect changes.
+ */
+export declare const createFormChangesTracker: <T extends AbstractControl>(config: CreateFormChangesTrackerConfig<T>) => FormChangesTrackerRef<ReturnType<T["getRawValue"]>>;

package/lib/components/forms/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './decorated-form-field.base';
 export * from './decorated-input.base';
+export * from './form-changes-tracker.util';
 export * from './input.base';

package/lib/components/sort/partials/sort/sort.directive.d.ts

@@ -6,6 +6,7 @@ import { Sort, SortDefaultOptions, Sortable } from './sort.types';
 import * as i0 from "@angular/core";
 export declare const SORT_DEFAULT_OPTIONS: InjectionToken<SortDefaultOptions>;
 export declare class SortDirective implements OnChanges, OnDestroy, OnInit {
+    destroy$: Observable<boolean>;
     private readonly _defaultOptions;
     sortables: Map<string, Sortable>;
     readonly _stateChanges: Subject<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/cdk",
-  "version": "4.37.1",
+  "version": "4.38.0",
   "exports": {
     ".": {
       "css": "./src/lib/styles/index.css",