@wemake4u/form-player 2.0.0 → 2.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wemake4u/form-player",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "license": "MIT",
   "peerDependencies": {
     "@angular/cdk": "^22.2.0",
@@ -16,7 +16,7 @@
     "ag-charts-community": "^11.3.2",
     "util": "^0.12.5",
     "@wemake4u/interact": "^1.0.6",
-    "@wemake4u/form-controls": "^2.0.0"
+    "@wemake4u/form-controls": "^2.0.2"
   },
   "dependencies": {
     "tslib": "^2.3.0",

package/types/wemake4u-form-player.d.ts

@@ -322,6 +322,7 @@ export declare class FormService implements IEvaluatorProvider {
   remove(control: AbstractControl, path: Path, index: number): boolean;
   moveUp(control: AbstractControl, path: Path, index: number): boolean;
   moveDown(control: AbstractControl, path: Path, index: number): boolean;
+  resize(control: AbstractControl, path: Path, newSize: number): boolean;
   status(control: AbstractControl, path: Path, pathOptions?: PathOptions): FormControlStatus | undefined;
   updateAllValueAndValidity(control: AbstractControl, emitEvent?: boolean): void;
   getInvalidControls(control: AbstractControl): {
@@ -692,6 +693,14 @@ declare class FormBuilderService {
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
 export type BrowserNavigation = 'none' | 'fragment' | 'queryParam';
+/**
+ * Where the view scrolls when the active form changes:
+ * - `content`: start of the form content (title and fields);
+ * - `form`: start of the whole form player (progress stepper included);
+ * - `page`: top of the page (the document; nested scroll containers are not moved);
+ * - `none`: no scroll.
+ */
+export type ScrollOnNavigate = 'content' | 'form' | 'page' | 'none';
 export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestroy, IEvaluatorProvider {
   private cdr;
   private destroyRef;
@@ -724,12 +733,16 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
   browserNavigation: BrowserNavigation;
   queryParamName: string;
   navSize: 'normal' | 'small';
+  /** Scroll applied when the active form changes (next/previous, side menu, stepper, goTo, browser history). */
+  scrollOnNavigate: ScrollOnNavigate;
   groupMode: FormGroupMode;
   updateMode: 'changes' | 'submit';
   valueChange: EventEmitter<any>;
   initialized: EventEmitter<FormGroup<any>>;
   activeNavChange: EventEmitter<any>;
   formDiv: ElementRef<HTMLDivElement>;
+  rootDiv?: ElementRef<HTMLDivElement>;
+  private readonly document;
   constructor(cdr: ChangeDetectorRef, destroyRef: DestroyRef, programmability: ProgrammabilityService, formBuilder: FormBuilderService, validationService: ValidationService, statusService: StatusService, eventService: EventService, registerService: RegisterService, languageService: LanguageService, subscribeService: SubscribeService, metadata: MetadataService, formService: FormService, dialog: DialogService, injector: Injector, router: Router, route: ActivatedRoute, scope: ScopeService);
   Texts: {
     i18n: {
@@ -771,6 +784,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         InformationAbout: string;
         OpenMenu: string;
         CloseMenu: string;
+        Loading: string;
         LoadingFailed: string;
         ConfirmDelete: string;
         MoveUp: string;
@@ -794,6 +808,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ItemPosition: string;
+        ItemAdded: string;
+        ItemRemoved: string;
+        ItemMoved: string;
       };
       en: {
         TypeToSearch: string;
@@ -833,6 +851,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         InformationAbout: string;
         OpenMenu: string;
         CloseMenu: string;
+        Loading: string;
         LoadingFailed: string;
         ConfirmDelete: string;
         MoveUp: string;
@@ -856,6 +875,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ItemPosition: string;
+        ItemAdded: string;
+        ItemRemoved: string;
+        ItemMoved: string;
       };
       de: {
         TypeToSearch: string;
@@ -895,6 +918,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         InformationAbout: string;
         OpenMenu: string;
         CloseMenu: string;
+        Loading: string;
         LoadingFailed: string;
         ConfirmDelete: string;
         MoveUp: string;
@@ -918,6 +942,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ItemPosition: string;
+        ItemAdded: string;
+        ItemRemoved: string;
+        ItemMoved: string;
       };
       fr: {
         TypeToSearch: string;
@@ -957,6 +985,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         InformationAbout: string;
         OpenMenu: string;
         CloseMenu: string;
+        Loading: string;
         LoadingFailed: string;
         ConfirmDelete: string;
         MoveUp: string;
@@ -980,6 +1009,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ItemPosition: string;
+        ItemAdded: string;
+        ItemRemoved: string;
+        ItemMoved: string;
       };
       es: {
         TypeToSearch: string;
@@ -1019,6 +1052,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         InformationAbout: string;
         OpenMenu: string;
         CloseMenu: string;
+        Loading: string;
         LoadingFailed: string;
         ConfirmDelete: string;
         MoveUp: string;
@@ -1042,6 +1076,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ItemPosition: string;
+        ItemAdded: string;
+        ItemRemoved: string;
+        ItemMoved: string;
       };
       pt: {
         TypeToSearch: string;
@@ -1081,6 +1119,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         InformationAbout: string;
         OpenMenu: string;
         CloseMenu: string;
+        Loading: string;
         LoadingFailed: string;
         ConfirmDelete: string;
         MoveUp: string;
@@ -1104,6 +1143,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ItemPosition: string;
+        ItemAdded: string;
+        ItemRemoved: string;
+        ItemMoved: string;
       };
     };
     TypeToSearch: string;
@@ -1143,6 +1186,7 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
     InformationAbout: string;
     OpenMenu: string;
     CloseMenu: string;
+    Loading: string;
     LoadingFailed: string;
     ConfirmDelete: string;
     MoveUp: string;
@@ -1166,6 +1210,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
     SomethingWentWrong: string;
     TimeoutOccurred: string;
     GenericError: string;
+    ItemPosition: string;
+    ItemAdded: string;
+    ItemRemoved: string;
+    ItemMoved: string;
   };
   ngOnInit(): void;
   ngOnDestroy(): void;
@@ -1256,7 +1304,14 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
   private clearFormArrays;
   private getCurrentForm;
   private disableAutoFocus;
+  /**
+   * Focuses the first field of the active form, once it is rendered. With `scroll` (form change) the view first scrolls
+   * as set by `scrollOnNavigate`; the focus then does not scroll again (a first field lower in the form would hide its
+   * start).
+   */
   private autoFocus;
+  /** Scrolls as set by `scrollOnNavigate`; false when no scroll is configured. */
+  private scrollToActiveForm;
   private canRevealErrors;
   private hasPotentialNextForm;
   hasSilentErrors(): boolean;
@@ -1327,6 +1382,10 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
       "alias": "navSize";
       "required": false;
     };
+    "scrollOnNavigate": {
+      "alias": "scrollOnNavigate";
+      "required": false;
+    };
     "groupMode": {
       "alias": "groupMode";
       "required": false;
@@ -1618,6 +1677,36 @@ export interface OrderModelItem {
   sort: 'asc' | 'desc';
 }
 export interface OrderModel extends Array<OrderModelItem> {}
+/**
+ * Control of a `table` component rendered by the Sirio data grid (`DynamicFieldsComponent.useDataGrid`).
+ * Same API as `TableControl` (ag-grid), so the form expressions work with both grids: filters and
+ * sort use the ag-grid models, converted to the data grid ones (`ag-grid-model.ts`).
+ *
+ * It extends `TableControl` (overriding every method, nothing of ag-grid is used) so the code that
+ * looks for the control by type (`getControlAs(name, TableControl)`) keeps working with both grids.
+ *
+ * When ag-grid is removed this content moves to `TableControl` (without the conversion, once the
+ * forms use the data grid models) and `DataGridControl` is deleted.
+ */
+export declare class DataGridControl extends TableControl {
+  setFilter(filter: FilterModel): void;
+  getFilter(): FilterModel;
+  clearFilter(): void;
+  getOrder(): OrderModel;
+  setOrder(order: OrderModel): void;
+  /** Evaluates the data source expression again (as `TableControl`) and reloads a server source. */
+  refresh(): void;
+  /** The data grid renders its rows from the data: nothing to redraw. */
+  redraw(): void;
+  private gridState;
+  onLoadState(): void;
+  onSaveState(): void;
+  /** Restores the saved state; a state saved by ag-grid (`TableControl`) is ignored. */
+  private restoreState;
+  private get dataGrid();
+  /** Filter keys and types of the grid columns, for the ag-grid model conversion. */
+  private modelColumns;
+}
 export declare class ButtonControl extends Control {
   /** The registered element is the native button (wmSirioButton of @wemake4u/form-controls). */
   focus(): void;