nuxeo-development-framework 5.6.4 → 5.6.5

package/src/lib/components/tables/ndf-table/containers/ndf-table/ndf-table.component.ts

@@ -1,575 +0,0 @@
-import { Direction } from '@angular/cdk/bidi';
-import {
-  Component,
-  ContentChild,
-  EventEmitter,
-  Input,
-  OnChanges,
-  Output,
-  SimpleChanges,
-  TemplateRef,
-} from '@angular/core';
-import { MatDialog } from '@angular/material/dialog';
-import { TranslateService } from '@ngx-translate/core';
-
-import {
-  BehaviorSubject,
-  combineLatest,
-  forkJoin,
-  iif,
-  Observable,
-  of,
-} from 'rxjs';
-import {
-  catchError,
-  filter,
-  map,
-  startWith,
-  switchMap,
-  take,
-  takeUntil,
-} from 'rxjs/operators';
-import {
-  ACTIONS_TABLE_TEMPLATE,
-  FILTER_CUSTOM_TEMPLATE,
-  SEARCH_TABLE_TEMPLATE,
-} from '../../directives';
-import {
-  AggregationResponse,
-  COMPARISON_OPERATOR,
-  FormQueryModel,
-  HtmlDialogComponent,
-  HtmlDialogConfig,
-} from '../../../../ndf-filters';
-import {
-  CustomCriteriaModel,
-  ExportType,
-  NdfExportPayload,
-  NdfTableConfig,
-  SortTableItem,
-  TableColumnConfig,
-  TableSortOptions,
-  TableViewMode,
-} from '../../models';
-import { NdfTableConfigurationService, NdfTableService } from '../../services';
-import _ from 'lodash';
-import { PAGE_SIZE } from '../../constants';
-import { PageEvent } from '@angular/material/paginator/paginator';
-import { DestroySubject } from '../../../../../shared/components';
-import { NuxeoPagination } from '../../../../../shared/models';
-import { DynamicTableService } from '../../../dynamic-table';
-import { CustomToastrService } from '../../../../custom-toastr/services/custom-toastr.service';
-
-import { FiltersMapperService } from '../../../../ndf-filters/services';
-import { NDF_EDITOR_TYPE } from '../../../../../shared';
-
-@Component({
-  selector: 'app-ndf-table',
-  templateUrl: './ndf-table.component.html',
-  styleUrls: ['./ndf-table.component.scss'],
-  host: {
-    class: 'ndf-table',
-    '[dir]': 'direction',
-  },
-})
-export class NdfTableComponent extends DestroySubject implements OnChanges {
-  private readonly _aggregationsSub = new BehaviorSubject<
-    Record<string, AggregationResponse>
-  >(null);
-  private readonly _displayedColumnsSub = new BehaviorSubject<
-    TableColumnConfig[]
-  >([]);
-  private readonly _sortOptionSub = new BehaviorSubject<TableSortOptions>(null);
-  private readonly _viewModeSub = new BehaviorSubject<TableViewMode>('list');
-  private readonly _textSearchSub = new BehaviorSubject<string>(null);
-
-  private readonly _activatedCriteriaSub = new BehaviorSubject<{
-    previousValue: Record<string, any>;
-    currentValue: Record<string, any>;
-  }>(null);
-
-  private readonly _customCriteriaSub =
-    new BehaviorSubject<CustomCriteriaModel>({
-      params: {},
-      payload: {
-        predicateList: [],
-      },
-    });
-
-  readonly aggregations$ = this._aggregationsSub.asObservable();
-  readonly displayedColumns$ = this._displayedColumnsSub.asObservable();
-  readonly sortOption$ = this._sortOptionSub.asObservable();
-  readonly viewMode$ = this._viewModeSub.asObservable();
-  readonly customFilters$ = this._customCriteriaSub.asObservable();
-  readonly textSearch$ = this._textSearchSub.asObservable();
-
-  readonly searchAndFilters$ = combineLatest([
-    this.textSearch$,
-    this.customFilters$,
-  ]).pipe(map((res) => this._prepareSearch(res)));
-  @Input() rows: Array<unknown>;
-  @Input() totalRecords: number;
-  @Input() autoCalculateHeight = true;
-  @Input() emptyMessage = 'table_noData';
-  @Input() activeQuery: FormQueryModel;
-  @Input() configPath: string = 'tables';
-  @Input() styleClass: string = '';
-
-  @Input() configTransformer: (
-    config: NdfTableConfig,
-  ) => Observable<NdfTableConfig>;
-  @Input() tableKey: string;
-
-  @Input() jsonEditorEnabled: boolean = false;
-
-  private _config: NdfTableConfig;
-  @Input() set config(config: NdfTableConfig) {
-    this._config = config;
-  }
-
-  get tableConfig() {
-    return this._tableConfigSub.getValue();
-  }
-
-  @Input() set customCriteria(criteria: CustomCriteriaModel) {
-    if (criteria) {
-      this._customCriteriaSub.next(criteria);
-    }
-  }
-
-  @Input() set searchTerm(value: string) {
-    if (value) {
-      this._textSearchSub.next(value);
-    }
-  }
-
-  @Output() onRowSelected = new EventEmitter();
-  @Output() onRowIndexSelected = new EventEmitter();
-  @Output() actionOnRow = new EventEmitter();
-  @Output() onGettingData = new EventEmitter();
-  @Output() onMultiRowSelected = new EventEmitter();
-  @Output() onLoading = new EventEmitter();
-
-  @Output() onPage = new EventEmitter<PageEvent>();
-  @Output() onInitialized = new EventEmitter<NuxeoPagination<any>>();
-  @Output() onLoaded = new EventEmitter<NuxeoPagination<any>>();
-
-  @Output() onQueryChange = new EventEmitter();
-  @Output() onSort = new EventEmitter<TableSortOptions>();
-
-  @ContentChild(ACTIONS_TABLE_TEMPLATE, { read: TemplateRef })
-  actionsTableTemplate: TemplateRef<any>;
-  @ContentChild(SEARCH_TABLE_TEMPLATE, { read: TemplateRef })
-  searchTableTemplate: TemplateRef<any>;
-  @ContentChild(FILTER_CUSTOM_TEMPLATE, { read: TemplateRef })
-  filterCustomTemplate: TemplateRef<any>;
-
-  private _tableConfigSub = new BehaviorSubject<NdfTableConfig>(null);
-
-  get options() {
-    return this.tableConfig?.options;
-  }
-
-  get filtersConfig() {
-    return this.options?.filters;
-  }
-
-  get sortList() {
-    return this.options?.sortList || [];
-  }
-
-  get columnsOptions() {
-    return this.tableConfig?.options?.columns;
-  }
-
-  get columnToggle() {
-    return this.columnsOptions?.toggle ?? true;
-  }
-
-  get tableMode() {
-    return this.options?.tableMode;
-  }
-
-  get panelConfig() {
-    return this.options?.filters?.panel;
-  }
-
-  get isPanelToggleAvailable() {
-    return this.panelConfig?.toggleButton ?? true;
-  }
-
-  get textSearchConfig() {
-    return this.options?.search;
-  }
-
-  get filterReloadConfig() {
-    return this.options?.filters?.reload;
-  }
-
-  get exportTableConfig() {
-    return this.options?.export;
-  }
-
-  readonly defaultSort = [{ prop: 'properties.createdAt', dir: 'desc' }];
-
-  direction: Direction = 'rtl';
-  isPanelOpened = false;
-  readonly defaultPageSizes = PAGE_SIZE;
-
-  private _isConfigChanged = false;
-  private _tableInitialized = false;
-  private _pageChanged = false;
-  private _activePage: PageEvent = {
-    pageIndex: 1,
-    pageSize: 10,
-    length: 0,
-  };
-
-  private _sortValue: TableSortOptions;
-
-  editorType = NDF_EDITOR_TYPE.TABLES;
-  /**
-   *
-   */
-  constructor(
-    private _filtersMapper: FiltersMapperService,
-    private _dynamicTableService: DynamicTableService,
-    private _translateService: TranslateService,
-    private _ngTableService: NdfTableService,
-    private _toastrService: CustomToastrService,
-    private _ndfTableConfigurationService: NdfTableConfigurationService,
-    private _dialog: MatDialog,
-  ) {
-    super();
-    this._translateService.onLangChange
-      .pipe(
-        startWith({ lang: this._translateService.currentLang }),
-        takeUntil(this.destroy$),
-      )
-      .subscribe((res) => {
-        this.direction = res.lang === 'ar' ? 'rtl' : 'ltr';
-      });
-  }
-
-  ngOnChanges(changes: SimpleChanges) {
-    const tableKey = changes.tableKey?.currentValue;
-    const config = changes.config?.currentValue;
-
-    if (tableKey && config) {
-      throw new Error(
-        'You cannot set both tableKey and tableConfig at the same time.',
-      );
-    }
-
-    if (config) {
-      this._applyTableConfig(config);
-    }
-
-    if (tableKey) {
-      this._loadTableConfig(tableKey);
-    }
-  }
-
-  togglePanel() {
-    this.isPanelOpened = !this.isPanelOpened;
-  }
-
-  onLoad(data: NuxeoPagination<any>): void {
-    this.onLoaded.emit(data);
-    if (
-      !this._tableInitialized ||
-      this.filterReloadConfig?.strategy === 'never' ||
-      this._pageChanged
-    ) {
-      this._pageChanged = false;
-      return;
-    }
-
-    if (
-      this._isConfigChanged ||
-      this.filterReloadConfig?.strategy === 'always'
-    ) {
-      this._aggregationsSub.next(data?.aggregations);
-      return;
-    }
-
-    if (this.filterReloadConfig?.strategy === 'onChange') {
-      const activatedQuery = this._activatedCriteriaSub.getValue();
-      const currentValue = activatedQuery?.currentValue || {};
-      const previousValue = activatedQuery?.previousValue || {};
-
-      const updatedKeys = _.union(
-        _.keys(previousValue),
-        _.keys(currentValue),
-      ).filter((key) => !_.isEqual(previousValue[key], currentValue[key]));
-
-      const triggerKeys = this.filterReloadConfig.triggerFields || [];
-      const shouldReload = triggerKeys.some((key) => updatedKeys.includes(key));
-      if (shouldReload) {
-        this._aggregationsSub.next(data?.aggregations);
-      }
-    }
-  }
-
-  onInitialize(data: NuxeoPagination<any>): void {
-    this._aggregationsSub.next(data?.aggregations);
-    this._tableInitialized = true;
-    this._isConfigChanged = false;
-    this.onInitialized.emit(data);
-  }
-
-  columnsChanged(columns: TableColumnConfig[]) {
-    this._displayedColumnsSub.next(columns);
-  }
-
-  sortChanged(sort: SortTableItem) {
-    this._sortValue = { sortBy: sort.value, sortOrder: sort.direction };
-    this._sortOptionSub.next(this._sortValue);
-  }
-
-  modeChanged(mode: TableViewMode) {
-    this._viewModeSub.next(mode);
-  }
-
-  onSortChanged(sort: TableSortOptions) {
-    this._sortValue = sort;
-    this.onSort.emit(sort);
-  }
-
-  exportTable(type: ExportType) {
-    const request = _.cloneDeep(this.exportTableConfig?.request);
-    if (!request) {
-      return;
-    }
-    const columns = this._displayedColumnsSub.getValue();
-    const fields = columns.map((col) => col.headerClass || col?.filedKey);
-    const headers = columns.map(
-      (col) => (this.tableConfig.prefix || '') + col.name,
-    );
-
-    const criteria = this._customCriteriaSub.getValue();
-
-    request.params = Object.assign(
-      {},
-      criteria.params,
-      this._sortValue || {},
-      this.tableConfig?.quickFilters
-        ? { quickFilters: this.tableConfig.quickFilters }
-        : {},
-      request.params,
-    );
-
-    const blobNameKey = this.exportTableConfig?.blobName;
-    const payload: NdfExportPayload = {
-      predicateList: criteria.payload.predicateList || [],
-      reportMetaData: {
-        blobName: '',
-        docTypeName: this.exportTableConfig.docTypeName,
-        fileType: type,
-        locale:
-          this.exportTableConfig?.locale || this._translateService.currentLang,
-        fields: this.exportTableConfig?.fields || fields,
-        headers: [],
-      },
-    };
-
-    forkJoin({
-      ar: this._translateService.getTranslation('ar'),
-      en: this._translateService.getTranslation('en'),
-    })
-      .pipe(
-        switchMap((translations) => {
-          const currentTranslations =
-            translations[this._translateService.currentLang];
-          payload.reportMetaData.headers = headers.map((col) =>
-            _.get(currentTranslations, col),
-          );
-          payload.reportMetaData.blobName = _.get(
-            translations['ar'],
-            blobNameKey,
-          );
-          payload.reportMetaData.blobNameEn = _.get(
-            translations['en'],
-            blobNameKey,
-          );
-          return this._ngTableService.exportTable(request, payload).pipe(
-            catchError((_) => {
-              this._toastrService.error('TABLE.EXPORT.RequestError');
-              return of(false);
-            }),
-          );
-        }),
-
-        filter(Boolean),
-        takeUntil(this.destroy$),
-      )
-      .subscribe((res: boolean) => {
-        if (res) {
-          this._toastrService.success('TABLE.EXPORT.requestSuccess');
-        } else {
-          this._toastrService.error('TABLE.EXPORT.requestError');
-        }
-      });
-  }
-
-  filterChanged(criteria: Record<string, any>) {
-    this._triggerCriteriaChanges(criteria);
-    if (this.filtersConfig?.mode !== 'payload') {
-      const isStringifyParams = this.filtersConfig?.stringifyParams;
-      const value = !isStringifyParams
-        ? criteria
-        : this._stringifyValues(criteria);
-      this._dynamicTableService.refreshData.next(value);
-      return;
-    }
-
-    const payload = this._filtersMapper.preparePayload(
-      this.filtersConfig.fields,
-      criteria,
-    );
-    this._customCriteriaSub.next(payload);
-  }
-
-  onTextSearch(text: string) {
-    if (!this.textSearchConfig?.fieldKey || typeof text !== 'string') {
-      return;
-    }
-
-    if (!text) {
-      this.onClearSearch();
-      return;
-    }
-    this._textSearchSub.next(text);
-  }
-
-  onClearSearch() {
-    this._textSearchSub.next(null);
-  }
-
-  openSearchModal() {
-    const _dialogConfig = this.textSearchConfig?.suffix?.dialog;
-    if (!_dialogConfig) {
-      return;
-    }
-    const { options, ...data } = _dialogConfig;
-    this._dialog.open<HtmlDialogComponent, HtmlDialogConfig>(
-      HtmlDialogComponent,
-      {
-        panelClass: 'p-0',
-        minWidth: 'min(500px,60vw)',
-        direction: this.direction,
-        ...options,
-        data,
-      },
-    );
-  }
-
-  onPageChanged(page: PageEvent) {
-    this._pageChanged =
-      this._activePage.pageIndex !== page.pageIndex ||
-      this._activePage.pageSize !== page.pageSize;
-    if (this._pageChanged) {
-      this.onPage.emit(page);
-      this._activePage = page;
-    }
-  }
-
-  private _filterByVisibility(
-    columns: TableColumnConfig[],
-  ): TableColumnConfig[] {
-    return columns.filter((col) => col.defaultVisible);
-  }
-
-  private _prepareSearch([search, filters]: [
-    string,
-    {
-      params?: Record<string, any>;
-      payload?: { predicateList: any[] } & Record<string, any>;
-    },
-  ]): any {
-    {
-      const { predicateList } = filters?.payload || { predicateList: [] };
-      const _key = this.textSearchConfig?.fieldKey;
-      const searchIndex = predicateList.findIndex((itm) => itm.name === _key);
-      if (search && _key) {
-        if (searchIndex >= 0) {
-          predicateList[searchIndex].value = `'${search}'`;
-        } else {
-          predicateList.push({
-            name: _key,
-            operator:
-              this.textSearchConfig?.operator || COMPARISON_OPERATOR.equals,
-            value: `'${search}'`,
-          });
-        }
-      } else if (searchIndex >= 0) {
-        predicateList.splice(searchIndex);
-      }
-      return _.cloneDeep({ ...filters });
-    }
-  }
-
-  private _stringifyValues(criteria: Record<string, any>) {
-    return Object.entries(criteria).reduce((acc, [key, value]) => {
-      acc[key] = Array.isArray(value) ? JSON.stringify(value) : value;
-      return acc;
-    }, {});
-  }
-
-  private _triggerCriteriaChanges(criteria: Record<string, any>) {
-    if (this._tableInitialized) {
-      this.onQueryChange.emit(criteria);
-    }
-    const activatedQuery = { ...this._activatedCriteriaSub.getValue() };
-    const previousValue = activatedQuery?.currentValue;
-    this._activatedCriteriaSub.next({
-      previousValue: previousValue,
-      currentValue: criteria,
-    });
-  }
-  /**
-   * @description
-   * This method is used to set the table configuration.
-   * @param config NdfTableConfig
-   */
-  private _applyTableConfig(config: NdfTableConfig): void {
-    this._tableConfigSub.next(config);
-    this.isPanelOpened = config?.options?.filters?.panel?.visible ?? true;
-    this._isConfigChanged = !!config;
-    if (config.columns) {
-      this._displayedColumnsSub.next(this._filterByVisibility(config.columns));
-    }
-    if (config.sortingBy) {
-      this._sortValue = config.sortingBy;
-      this._sortOptionSub.next(config.sortingBy);
-    }
-    if (config?.options?.tableMode?.mode) {
-      this._viewModeSub.next(config.options.tableMode.mode);
-    }
-    if (config.pageSize) {
-      this._activePage.pageSize = config.pageSize;
-    }
-  }
-
-  /**
-   * @private
-   * @description Loads the table configuration based on the provided key and applies it.
-   * @param {string} key - The key used to fetch the table configuration.
-   */
-  private _loadTableConfig(key: string) {
-    this._ndfTableConfigurationService
-      .getTableConfiguration(key, this.configPath)
-      .pipe(
-        switchMap((config) => {
-          if (this.configTransformer && _.isFunction(this.configTransformer)) {
-            return this.configTransformer(config);
-          }
-          return of(config);
-        }),
-        takeUntil(this.destroy$),
-      )
-      .subscribe((config) => {
-        this._applyTableConfig(config);
-      });
-  }
-}

package/src/lib/components/tables/ndf-table/directives/actions.directive.ts

@@ -1,16 +0,0 @@
-import { Directive, InjectionToken, TemplateRef } from '@angular/core';
-
-export const ACTIONS_TABLE_TEMPLATE = new InjectionToken<ActionsTableTemplateDirective>('ActionsTableTemplateDirective');
-
-@Directive({
-	selector: '[headerTableTemplate]',
-	providers: [
-		{
-			provide: ACTIONS_TABLE_TEMPLATE,
-			useExisting: ActionsTableTemplateDirective
-		}
-	]
-})
-export class ActionsTableTemplateDirective {
-	constructor(public template: TemplateRef<any>) {}
-}

package/src/lib/components/tables/ndf-table/directives/filter-custom.directive.ts

@@ -1,18 +0,0 @@
-import { Directive, InjectionToken, TemplateRef } from '@angular/core';
-
-export const FILTER_CUSTOM_TEMPLATE = new InjectionToken<FilterCustomTemplateDirective>(
-	'FilterCustomTemplateDirective'
-);
-
-@Directive({
-	selector: '[filterCustomTemplate]',
-	providers: [
-		{
-			provide: FILTER_CUSTOM_TEMPLATE,
-			useExisting: FilterCustomTemplateDirective
-		}
-	]
-})
-export class FilterCustomTemplateDirective {
-	constructor(public template: TemplateRef<any>) {}
-}

package/src/lib/components/tables/ndf-table/directives/search.directive.ts

@@ -1,16 +0,0 @@
-import { Directive, InjectionToken, TemplateRef } from '@angular/core';
-
-export const SEARCH_TABLE_TEMPLATE = new InjectionToken<SearchTableTemplateDirective>('SearchTableTemplateDirective');
-
-@Directive({
-  selector: '[searchTableTemplate]',
-  providers: [
-    {
-      provide: SEARCH_TABLE_TEMPLATE,
-      useExisting: SearchTableTemplateDirective
-    }
-  ]
-})
-export class SearchTableTemplateDirective {
-  constructor(public template: TemplateRef<any>) {}
-}

package/src/lib/components/tables/ndf-table/models/payload-types.ts

@@ -1,21 +0,0 @@
-export type NdfRequestConfig = {
-	method: 'post' | 'get';
-	url: string;
-	payload?: Record<string, any>;
-	params?: Record<string, any>;
-	headers?: Record<string, any>;
-};
-
-export type NdfExportPayload = {
-	predicateList: { name: string; value: string; operator: string }[];
-	reportMetaData: {
-		blobName: string;
-		blobNameEn?: string;
-		docTypeName: string;
-		fileType: string;
-		reportTitle?: string;
-		locale: string;
-		fields: string[];
-		headers?: string[];
-	};
-};

package/src/lib/components/tables/ndf-table/models/search.config.ts

@@ -1,14 +0,0 @@
-import { ComparisonOperator, HtmlDialogConfig } from "../../../ndf-filters";
-
-export type GlobalSearchConfig = {
-	fieldKey: string;
-	label?: string;
-	placeholder?: string;
-	operator?: ComparisonOperator;
-	searchMode: 'realTime' | 'triggered';
-	debounceTime?: number;
-	searchButtonLabel?: string;
-	suffix?: {
-		dialog?: HtmlDialogConfig;
-	};
-};

package/src/lib/components/tables/ndf-table/models/table-column.ts

@@ -1,32 +0,0 @@
-export type TableColumnAction = {
-	type?: 'button' | 'icon';
-	class?: string;
-	title?: string;
-	iconClass?: string;
-	permission?: string;
-	icon?: string;
-	tooltip?: string;
-	actionName: string;
-};
-
-export interface TableColumnConfig {
-	name: string;
-	id?: string;
-	prop: string;
-	display: boolean;
-	type: string;
-	size?: number;
-	minWidth?: number;
-	maxWidth?: number;
-	sortable?: boolean;
-	headerClass?: string;
-	vocabularyId?: string;
-	actions?: TableColumnAction[];
-	template?: string;
-	custom1stCellTemplate?: string;
-	translatePrefix?: string;
-	order?: number;
-	defaultVisible?: boolean;
-	options?: Record<string, any>;
-	filedKey?: string;
-}