Merge pull request #25 from bci-oss/feature/extract-rql-extension

Extract RQL Extension interfaces from table generation

Author: sha4be

libs/schematic/generators/ng-generate/components/card/generators/components/card/files/__name@dasherize__.component.ts.template

@@ -46,7 +46,6 @@ import {MatTableDataSource} from "@angular/material/table";
 
 <% if (options.enableRemoteDataHandling) { %>
     <%= options.include('/remote-handling/imports.ts.template') %>
-    <%= options.include('/remote-handling/custom-rql-filter-extensions.ts.template') %>
 <% } else { %>
     import {<%= classify(name) %>Service} from './<%= dasherize(name) %>.service';
 <% } %>

libs/schematic/generators/ng-generate/components/shared/generators/components/command-bar/files/__name@dasherize__-command-bar.component.ts.template

@@ -32,6 +32,7 @@ import {MatTooltip} from '@angular/material/tooltip';
 import {MatMenuModule} from '@angular/material/menu';
 import {MatIconButton} from '@angular/material/button';
 import {MatInput} from '@angular/material/input';
+import {TranslocoPipe} from '@jsverse/transloco';
 
 @Component({
     selector: '<%= dasherize(name) %>-command-bar',
@@ -50,7 +51,8 @@ import {MatInput} from '@angular/material/input';
       MatTooltip,
       MatMenuModule,
       MatIconButton,
-      MatInput
+      MatInput,
+      TranslocoPipe
     ],
     templateUrl: './<%= dasherize(name) %>-command-bar.component.html',
     styleUrls: ['./<%= dasherize(name) %>-command-bar.component.scss'],

libs/schematic/generators/ng-generate/components/shared/methods/remote-handling/imports.ts.template

@@ -6,4 +6,5 @@
 <% } %>
 
 import {AbstractArrayNode, AbstractNode, And, Eq, Limit, Query, QueryStringifier, Sort} from 'rollun-ts-rql';
+import {CustomRQLFilterExtension, CustomRQLOptionExtension, ExtendedCsvExporter} from '@esmf/semantic-ui-schematic';
 import {SortOptions} from "rollun-ts-rql/dist/nodes/Sort";

libs/schematic/generators/ng-generate/components/table/generators/components/table/files/__name@dasherize__.component.ts.template

@@ -29,6 +29,7 @@ import {
 import { MatPaginator } from '@angular/material/paginator';
 import { MatSort, MatSortModule, SortDirection } from '@angular/material/sort';
 import { MatTable, MatTableModule } from '@angular/material/table';
+import {TranslocoPipe} from '@jsverse/transloco';
 
 <% if (options.hasFilters || options.hasSearchBar) { %>
     import {<%= options.filterServiceName %>} from './<%= cmpFileName %>-filter.service';
@@ -75,7 +76,6 @@ import {<% if (options.enableRemoteDataHandling) { %>catchError, finalize, tap,
 
 <% if (options.enableRemoteDataHandling) { %>
     <%= options.include('/remote-handling/imports.ts.template') %>
-    <%= options.include('/remote-handling/custom-rql-filter-extensions.ts.template') %>
 <% } else { %>
     import {EsmfStaticTableService} from '@esmf/semantic-ui-schematic';
 <% } %>
@@ -127,6 +127,7 @@ type Entity = <%= classify(options.selectedModelTypeName) %>;
       MatIcon,
       MatTooltip,
       EsmfTableCellComponent,
+      TranslocoPipe,
       <%= classify(name) %>CommandBarComponent
     ],
     templateUrl: './<%= cmpFileName %>.component.html',

libs/schematic/src/index.ts

@@ -18,5 +18,6 @@ export * from './lib/services/remote-table-data-source.service';
 export * from './lib/services/static-table-data-source.service';
 
 export * from './lib/models/filter.definition';
+export * from './lib/models/rql-extension.definition';
 
 export * from './lib/pipes/show-description.pipe';

libs/schematic/src/lib/components/chip-list/chip-list.component.ts

@@ -5,11 +5,12 @@ import {FilterEnums, FilterType} from '../../models/filter.definition';
 import {MatMiniFabButton} from '@angular/material/button';
 import {MatChipListbox, MatChipOption} from '@angular/material/chips';
 import {EsmfHorizontalOverflowDirective} from '../../directives/horizontal-overflow.directive';
+import {TranslocoDirective} from '@jsverse/transloco';
 
 @Component({
   selector: 'esmf-chip-list',
   templateUrl: './chip-list.component.html',
-  imports: [MatIcon, MatTooltip, MatMiniFabButton, MatChipListbox, MatChipOption, EsmfHorizontalOverflowDirective],
+  imports: [MatIcon, MatTooltip, MatMiniFabButton, MatChipListbox, MatChipOption, EsmfHorizontalOverflowDirective, TranslocoDirective],
   styleUrls: ['./chip-list.component.scss'],
   encapsulation: ViewEncapsulation.None,
   host: {class: 'esmf-chip-list'},

libs/schematic/src/lib/components/column-menu/column-menu.component.ts

@@ -1,11 +1,11 @@
 import {CdkDragDrop, moveItemInArray} from '@angular/cdk/drag-drop';
-import {ChangeDetectionStrategy, Component, computed, input, linkedSignal, output, ViewEncapsulation} from '@angular/core';
+import {ChangeDetectionStrategy, Component, input, linkedSignal, output, ViewEncapsulation} from '@angular/core';
 import {MatDivider, MatListOption, MatSelectionList} from '@angular/material/list';
 import {MatButton} from '@angular/material/button';
 import {MatIcon} from '@angular/material/icon';
 import {MatTooltip} from '@angular/material/tooltip';
 import {DragDropModule} from '@angular/cdk/drag-drop';
-import {TranslocoPipe} from '@jsverse/transloco';
+import {TranslocoDirective} from '@jsverse/transloco';
 
 export interface Column {
   name: string;
@@ -22,7 +22,7 @@ function makeAllColumnsSelected(columns: string[]): Column[] {
   selector: 'esmf-column-menu',
   templateUrl: './column-menu.component.html',
   styleUrls: ['./column-menu.component.scss'],
-  imports: [MatSelectionList, MatDivider, MatListOption, MatButton, MatIcon, MatTooltip, DragDropModule, TranslocoPipe],
+  imports: [MatSelectionList, MatDivider, MatListOption, MatButton, MatIcon, MatTooltip, DragDropModule, TranslocoDirective],
   changeDetection: ChangeDetectionStrategy.OnPush,
   encapsulation: ViewEncapsulation.None,
   host: {class: 'esmf-column-menu'},

libs/schematic/src/lib/models/rql-extension.definition.ts

@@ -0,0 +1,36 @@
+import {And, Query} from 'rollun-ts-rql';
+
+/**
+ * Interface of a CustomRQLFilterExtension which will be used to
+ * modify the RQL query before the API service will be called to query
+ * the backend.
+ */
+export interface CustomRQLFilterExtension {
+  /**
+   * Apply modification to the given RQL query
+   */
+  apply(query: And): void;
+}
+
+/**
+ * Interface of a CustomRQLOptionExtension which will be used to
+ * modify the RQL query before the API service will be called to query
+ * the backend.
+ */
+export interface CustomRQLOptionExtension {
+  /**
+   * Apply modification to the given RQL query
+   */
+  apply(query: Query): void;
+}
+
+/**
+ * Interface of ExtendedCsvExporter which will used to export data
+ * from a remote backend.
+ */
+export interface ExtendedCsvExporter {
+  /**
+   * Exports the all data
+   */
+  export(displayedColumns: string[], rqlQuery: string): void;
+}