@wemake4u/form-player 2.0.2 → 2.0.3

package/package.json

@@ -1,33 +1,25 @@
 {
   "name": "@wemake4u/form-player",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "license": "MIT",
   "peerDependencies": {
-    "@angular/cdk": "^22.2.0",
     "@angular/common": "^22.2.0",
     "@angular/core": "^22.2.0",
-    "@angular/material": "22.2.2",
+    "@angular/forms": "^22.2.0",
+    "@angular/platform-browser": "^22.2.0",
+    "@angular/router": "^22.2.0",
     "rxjs": "~7.8.0",
-    "bootstrap": "5.3.3",
-    "ag-grid-angular": "^33.0.4",
-    "@ag-grid-community/angular": "^32.3.7",
-    "@ag-grid-community/locale": "^33.1.0",
     "ag-charts-angular": "^11.3.2",
     "ag-charts-community": "^11.3.2",
-    "util": "^0.12.5",
     "@wemake4u/interact": "^1.0.6",
-    "@wemake4u/form-controls": "^2.0.2"
+    "@wemake4u/form-controls": "^2.0.3"
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@types/mime-db": "1.43.5",
-    "@types/sanitize-html": "2.13.0",
     "feelers": "^1.5.1",
     "feelin": "6.2.0",
     "marked": "15.0.7",
-    "mime-db": "1.53.0",
-    "sanitize-html": "^2.13.0",
-    "date-fns": "4.3.0"
+    "dompurify": "^3.4.0"
   },
   "sideEffects": false,
   "module": "fesm2022/wemake4u-form-player.mjs",

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

@@ -3,11 +3,10 @@ import { ChangeDetectorRef, DestroyRef, ElementRef, EnvironmentInjector, EventEm
 import { ActivatedRoute, Params, Router } from "@angular/router";
 import { AbstractControl, AbstractControlOptions, AsyncValidatorFn, FormControlStatus, FormGroup, ValidationErrors, ValidatorFn } from "@angular/forms";
 import { Observable, Subject } from "rxjs";
-import { SirioButtonVariant, SirioDialogSize, SirioSidenavItem, SirioStep, SirioToastService } from "@wemake4u/form-controls";
+import { SirioButtonVariant, SirioDialogSize, SirioGridFilterType, SirioGridFilters, SirioGridSort, SirioSidenavItem, SirioStep, SirioToastService } from "@wemake4u/form-controls";
 import { ConfirmationController, LanguageService, Message, MessageFactory, NotificationController, NotifyTypes, PromptController } from "@wemake4u/interact";
 import { DomSanitizer, SafeHtml, SafeResourceUrl } from "@angular/platform-browser";
 import { HttpClient } from "@angular/common/http";
-import { FilterModel, IGetRowsParams } from "ag-grid-community";
 declare class FormGroupEx<TControl extends { [K in keyof TControl]: AbstractControl<any>; }> extends FormGroup<TControl> {
   constructor(controls: TControl, mode: FormGroupMode, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null);
   getMode(): FormGroupMode;
@@ -611,6 +610,8 @@ declare class StatusCollection<TKey = any> {
   constructor(key?: any | undefined);
   readonly controls: Set<AbstractControl<any, any, any>>;
   readonly children: Map<TKey, StatusCollection<TKey>>;
+  /** Key of the root collection this collection belongs to (set on child collections). */
+  rootKey?: any;
   add(control: AbstractControl): this;
   remove(control: AbstractControl): this;
   has(control: AbstractControl): boolean;
@@ -808,6 +809,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ServiceUnreachable: string;
+        GridNavigationHint: string;
         ItemPosition: string;
         ItemAdded: string;
         ItemRemoved: string;
@@ -875,6 +878,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ServiceUnreachable: string;
+        GridNavigationHint: string;
         ItemPosition: string;
         ItemAdded: string;
         ItemRemoved: string;
@@ -942,6 +947,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ServiceUnreachable: string;
+        GridNavigationHint: string;
         ItemPosition: string;
         ItemAdded: string;
         ItemRemoved: string;
@@ -1009,6 +1016,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ServiceUnreachable: string;
+        GridNavigationHint: string;
         ItemPosition: string;
         ItemAdded: string;
         ItemRemoved: string;
@@ -1076,6 +1085,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ServiceUnreachable: string;
+        GridNavigationHint: string;
         ItemPosition: string;
         ItemAdded: string;
         ItemRemoved: string;
@@ -1143,6 +1154,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
         SomethingWentWrong: string;
         TimeoutOccurred: string;
         GenericError: string;
+        ServiceUnreachable: string;
+        GridNavigationHint: string;
         ItemPosition: string;
         ItemAdded: string;
         ItemRemoved: string;
@@ -1210,6 +1223,8 @@ export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestro
     SomethingWentWrong: string;
     TimeoutOccurred: string;
     GenericError: string;
+    ServiceUnreachable: string;
+    GridNavigationHint: string;
     ItemPosition: string;
     ItemAdded: string;
     ItemRemoved: string;
@@ -1446,7 +1461,8 @@ export declare class SanitizeService {
   sanitizeSafeHtml(html: string): SafeHtml;
   sanitizeSafeUrl(url: string): SafeResourceUrl;
   toString(safeHtml: SafeHtml): string;
-  private sanitizeOption;
+  private readonly purify;
+  private readonly sanitizeOption;
   static ɵfac: i0.ɵɵFactoryDeclaration<SanitizeService, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
@@ -1472,10 +1488,60 @@ declare class RestDataSource<T, T2 = T> {
   getParams(): Record<string, any>;
   getData(): Observable<T2[]>;
 }
-interface IRowsSource {
-  getRows: (params: IGetRowsParams) => void;
+/**
+ * Filter model by column key, in the ag-grid format: `{ filterType, type, filter, filterTo }`,
+ * `{ filterType: 'date', type, dateFrom, dateTo }` or `{ operator: 'AND' | 'OR', conditions }`.
+ */
+type FilterModel = Record<string, any>;
+/** Sort criterion of a table: column key and direction. */
+interface OrderModelItem {
+  colId: string;
+  sort: 'asc' | 'desc';
 }
-interface IDataSource {
+/** Sort criteria of a table, in priority order. */
+interface OrderModel extends Array<OrderModelItem> {}
+/** A column of the data grid as seen by the conversion: filter key and filter type. */
+interface GridModelColumn {
+  /** Key of the column in the grid filters (unique also for columns on the same field, `data~2`). */
+  key: string;
+  /** Field of the column, the name known by a server source (default: the key). */
+  field?: string;
+  filter: SirioGridFilterType | null;
+}
+/**
+ * ag-grid filter model → data grid filters. Conditions combined with AND / OR cannot be represented
+ * (one condition per column): an OR of "equals" on a select column becomes "is one of", the other
+ * combinations keep only the first condition and are reported in the console.
+ */
+declare function filterModelToSirio(model: FilterModel | null | undefined, columns: readonly GridModelColumn[]): SirioGridFilters;
+/** Data grid filters → ag-grid filter model (the format of `TableControl.getFilter()`). */
+declare function sirioFiltersToModel(filters: SirioGridFilters, columns: readonly GridModelColumn[]): FilterModel;
+/** ag-grid sort model of `TableControl` → data grid sort. */
+declare function orderModelToSirio(order: readonly OrderModelItem[] | null | undefined): SirioGridSort[];
+/** Data grid sort → ag-grid sort model of `TableControl`. */
+declare function sirioSortToOrderModel(sort: readonly SirioGridSort[]): OrderModelItem[];
+/**
+ * Request of a block of rows to an `IRowsSource`. Same shape as the `IGetRowsParams` of the ag-grid
+ * infinite row model, so the sources written for it (e.g. `queryRows` of `@wemake4u/remoting`) keep
+ * working.
+ */
+export interface RowsRequest {
+  /** First row of the block (0-based). */
+  startRow: number;
+  /** Row after the last one of the block. */
+  endRow: number;
+  sortModel: OrderModelItem[];
+  filterModel: FilterModel;
+  context: any;
+  /** Rows of the block and, when known, the total row count. */
+  successCallback(rowsThisBlock: any[], lastRow?: number): void;
+  failCallback(): void;
+}
+/** Server data source of a table, reading the rows by blocks. */
+export interface IRowsSource {
+  getRows: (params: RowsRequest) => void;
+}
+export interface IDataSource {
   getData(params: Record<string, any>): Observable<any>;
 }
 export declare class DataService {
@@ -1521,14 +1587,22 @@ export declare class DefaultPromptController implements PromptController {
   static ɵfac: i0.ɵɵFactoryDeclaration<DefaultPromptController, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
+/**
+ * Global properties (GlobalService) that override the default texts of the error messages,
+ * so that an application can use the same texts of its server (WCAG 3.2.4).
+ */
+export declare const ERROR_TITLE_PROPERTY = "errorTitle";
+export declare const ERROR_DETAIL_PROPERTY = "errorDetail";
 export declare class DefaultMessageFactory implements MessageFactory {
   languageService: LanguageService;
+  private readonly global;
   constructor(languageService: LanguageService);
   createError(err: any): Message;
   private get language();
   private locale;
   private getTitleText;
   private getTimeoutText;
+  private getUnreachableText;
   private getDetailText;
   static ɵfac: i0.ɵɵFactoryDeclaration<DefaultMessageFactory, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
@@ -1653,60 +1727,37 @@ export declare class AccordionControl extends ContainerControl {
 }
 export declare class DynamicListControl extends ContainerControl {}
 export declare class GroupControl extends ContainerControl {}
-export declare class TableControl extends Control {
-  setFilter(filter: FilterModel): void;
-  getFilter(): FilterModel;
-  clearFilter(): void;
-  getOrder(): OrderModel;
-  setOrder(order: OrderModel): void;
-  refresh(): void;
-  redraw(): void;
-  private currentState;
-  onLoadState(): void;
-  onSaveState(): void;
-  private createState;
-  private applyState;
-  private applyPagination;
-  private applyPageSize;
-  private applyPageNumber;
-  private get grid();
-  private paginationEnabled;
-}
-export interface OrderModelItem {
-  colId: string;
-  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.
+ * Control of a `table` component, rendered by the Sirio data grid (`@wemake4u/form-controls`).
+ * Filters and sort use the models of the forms (ag-grid format, `grid-models.ts`), converted to the
+ * data grid ones.
  */
-export declare class DataGridControl extends TableControl {
+export declare class TableControl extends Control {
   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. */
+  /** Evaluates the data source expression again 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. */
+  /** Restores the saved state; a state saved by the former ag-grid table is ignored. */
   private restoreState;
   private get dataGrid();
-  /** Filter keys and types of the grid columns, for the ag-grid model conversion. */
+  /** Filter keys and types of the grid columns, for the model conversion. */
   private modelColumns;
 }
+/**
+ * @deprecated The `table` control is always rendered by the Sirio data grid: use `TableControl`.
+ * Kept as an alias for the code written while ag-grid and the data grid coexisted.
+ */
+export declare const DataGridControl: typeof TableControl;
+/** @deprecated Use `TableControl`. */
+export type DataGridControl = TableControl;
 export declare class ButtonControl extends Control {
   /** The registered element is the native button (wmSirioButton of @wemake4u/form-controls). */
   focus(): void;
@@ -1716,4 +1767,4 @@ export declare class SpacerControl extends Control {}
 export declare class IFrameControl extends Control {}
 export declare class TooltipControl extends Control {}
 export declare class DisplayFieldControl extends Control {}
-export {};
+export type { FilterModel, OrderModel, OrderModelItem };