feat(plugins): move Row Detail View plugin to universal

packages/common/src/controls/slickGridMenu.ts

@@ -11,7 +11,7 @@ import {
   SlickEventHandler,
   SlickNamespace,
 } from '../interfaces/index';
-import { DelimiterType, FileType } from '../enums';
+import { DelimiterType, FileType } from '../enums/index';
 import { ExtensionUtility } from '../extensions/extensionUtility';
 import { emptyElement, findWidthOrDefault, getHtmlElementOffset, getTranslationPrefix, } from '../services/index';
 import { ExcelExportService } from '../services/excelExport.service';

packages/common/src/enums/slickPluginList.enum.ts

@@ -1,7 +1,4 @@
-import {
-  SlickEditorLock,
-  SlickRowDetailView,
-} from '../interfaces/index';
+import { SlickEditorLock } from '../interfaces/index';
 import {
   SlickAutoTooltip,
   SlickCellExternalCopyManager,
@@ -15,6 +12,7 @@ import {
   SlickGroupItemMetadataProvider,
   SlickHeaderButtons,
   SlickHeaderMenu,
+  SlickRowDetailView,
   SlickRowMoveManager,
   SlickRowSelectionModel,
 } from '../plugins/index';

packages/common/src/extensions/extensionUtility.ts

@@ -1,5 +1,5 @@
 import { Constants } from '../constants';
-import { Column, GridOption, Locale, MenuCommandItem, MenuOptionItem, } from '../interfaces';
+import { Column, GridOption, Locale, MenuCommandItem, MenuOptionItem, } from '../interfaces/index';
 import { BackendUtilityService } from '../services/backendUtility.service';
 import { SharedService } from '../services/shared.service';
 import { TranslaterService } from '../services/translater.service';

packages/common/src/extensions/index.ts

@@ -1,2 +1 @@
 export * from './extensionUtility';
-export * from './rowDetailViewExtension';

packages/common/src/formatters/bsDropdownFormatter.ts

@@ -1,6 +1,9 @@
 import { Formatter } from '../interfaces/formatter.interface';
 
-/** A simple Bootstrap Dropdown Formatter which requires a Formatter Label */
+/**
+ * @deprecated @use `CellMenu`, which is a lot more generic instead of `bsDropdownFormatter`.
+ * A simple Bootstrap Dropdown Formatter which requires a Formatter Label.
+ */
 export const bsDropdownFormatter: Formatter = (row, cell, _val, columnDef) => {
   const columnParams = columnDef && columnDef.params || {};
   const label = columnParams.label || columnParams.formatterLabel;

packages/common/src/formatters/formatters.index.ts

@@ -62,6 +62,7 @@ export const Formatters = {
   bold: boldFormatter,
 
   /**
+   * @deprecated @use `CellMenu`, which is a lot more generic instead of `bsDropdownFormatter`.
    * a simple Bootstrap Dropdown Formatter which requires a Formatter Label
    * example:: { formatter: Formatters.bsDropdown, params: { formatterLabel: 'Label' }}
    */

packages/common/src/interfaces/column.interface.ts

@@ -28,6 +28,9 @@ type Join<T extends any[], D extends string> =
 /* eslint-enable @typescript-eslint/indent */
 
 export interface Column<T = any> {
+  /** do we want to always render the column? */
+  alwaysRenderColumn?: boolean;
+
   /** async background post-rendering formatter */
   asyncPostRender?: (domCellNode: any, row: number, dataContext: T, columnDef: Column) => void;
 

packages/common/src/interfaces/index.ts

@@ -145,7 +145,6 @@ export * from './slickNamespace.interface';
 export * from './slickRange.interface';
 export * from './slickRemoteModel.interface';
 export * from './slickResizer.interface';
-export * from './slickRowDetailView.interface';
 export * from './sorter.interface';
 export * from './textExportOption.interface';
 export * from './treeDataOption.interface';

packages/common/src/interfaces/rowDetailView.interface.ts

@@ -1,7 +1,5 @@
-import { RowDetailViewOption } from './rowDetailViewOption.interface';
-import { SlickGrid } from './slickGrid.interface';
-import { SlickEventData } from './slickEventData.interface';
-import { SlickRowDetailView } from './slickRowDetailView.interface';
+import { RowDetailViewOption, SlickEventData, SlickGrid } from './index';
+import { SlickRowDetailView } from '../plugins/slickRowDetailView';
 
 export interface RowDetailView extends RowDetailViewOption {
   // --

packages/common/src/interfaces/rowDetailViewOption.interface.ts

@@ -63,7 +63,7 @@ export interface RowDetailViewOption {
    * It's preferable to use the "preloadView" property to use a framework View instead of plain HTML.
    * If you still wish to use these methods, we strongly suggest you to sanitize your HTML, e.g. "DOMPurify.sanitize()"
    */
-  preTemplate?: () => string;
+  preTemplate?: (item?: any) => string;
 
   /**
    * HTML Post Template (when Row Detail data is available) that will be loaded once the async function finishes

packages/common/src/interfaces/slickNamespace.interface.ts

@@ -27,7 +27,6 @@ import {
   SlickRange,
   SlickRemoteModel,
   SlickResizer,
-  SlickRowDetailView,
 } from './index';
 import { SlickGridMenu, } from '../controls/index';
 import {
@@ -43,6 +42,7 @@ import {
   SlickGroupItemMetadataProvider,
   SlickHeaderButtons,
   SlickHeaderMenu,
+  SlickRowDetailView,
   SlickRowMoveManager,
   SlickRowSelectionModel,
 } from '../plugins/index';

packages/common/src/plugins/__tests__/slickContextMenu.spec.ts

@@ -1,10 +1,10 @@
+import { DelimiterType, FileType } from '../../enums/index';
 import { ContextMenu, Column, ElementPosition, GridOption, MenuCommandItem, MenuOptionItem, SlickDataView, SlickGrid, SlickNamespace, } from '../../interfaces/index';
-import { SlickContextMenu } from '../slickContextMenu';
-import { BackendUtilityService, deepCopy, ExcelExportService, PubSubService, SharedService, TextExportService, TreeDataService, } from '../../services';
+import { BackendUtilityService, deepCopy, ExcelExportService, PubSubService, SharedService, TextExportService, TreeDataService, } from '../../services/index';
 import { ExtensionUtility } from '../../extensions/extensionUtility';
-import { TranslateServiceStub } from '../../../../../test/translateServiceStub';
 import { Formatters } from '../../formatters';
-import { DelimiterType, FileType } from '../../enums';
+import { TranslateServiceStub } from '../../../../../test/translateServiceStub';
+import { SlickContextMenu } from '../slickContextMenu';
 
 declare const Slick: SlickNamespace;
 

packages/common/src/plugins/__tests__/slickRowDetail.spec.ts

@@ -0,0 +1,69 @@
+import { SlickRowDetailView } from '../slickRowDetailView';
+
+describe('SlickRowDetailView plugin', () => {
+  let plugin: SlickRowDetailView;
+
+  beforeEach(() => {
+    plugin = new SlickRowDetailView();
+  });
+
+  it('should throw a not implemented error when calling "init" method', () => {
+    expect(() => plugin.init({} as any)).toThrow('SlickRowDetailView the "init" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "create" method', () => {
+    expect(() => plugin.create([], {} as any)).toThrow('SlickRowDetailView the "create" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "destroy" method', () => {
+    expect(() => plugin.destroy()).toThrow('SlickRowDetailView the "destroy" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "dispose" method', () => {
+    expect(() => plugin.dispose()).toThrow('SlickRowDetailView the "dispose" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "collapseAll" method', () => {
+    expect(() => plugin.collapseAll()).toThrow('SlickRowDetailView the "collapseAll" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "collapseDetailView" method', () => {
+    expect(() => plugin.collapseDetailView({} as any, true)).toThrow('SlickRowDetailView the "collapseDetailView" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "expandDetailView" method', () => {
+    expect(() => plugin.expandDetailView({} as any)).toThrow('SlickRowDetailView the "expandDetailView" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "expandableOverride" method', () => {
+    expect(() => plugin.expandableOverride({} as any)).toThrow('SlickRowDetailView the "expandableOverride" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "getColumnDefinition" method', () => {
+    expect(() => plugin.getColumnDefinition()).toThrow('SlickRowDetailView the "getColumnDefinition" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "getExpandedRows" method', () => {
+    expect(() => plugin.getExpandedRows()).toThrow('SlickRowDetailView the "getExpandedRows" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "getFilterItem" method', () => {
+    expect(() => plugin.getFilterItem({} as any)).toThrow('SlickRowDetailView the "getFilterItem" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "getOptions" method', () => {
+    expect(() => plugin.getOptions()).toThrow('SlickRowDetailView the "getOptions" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "resizeDetailView" method', () => {
+    expect(() => plugin.resizeDetailView({} as any)).toThrow('SlickRowDetailView the "resizeDetailView" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "saveDetailView" method', () => {
+    expect(() => plugin.saveDetailView({} as any)).toThrow('SlickRowDetailView the "saveDetailView" method must be implemented');
+  });
+
+  it('should throw a not implemented error when calling "setOptions" method', () => {
+    expect(() => plugin.setOptions({} as any)).toThrow('SlickRowDetailView the "setOptions" method must be implemented');
+  });
+});

packages/common/src/plugins/index.ts

@@ -11,5 +11,6 @@ export * from './slickDraggableGrouping';
 export * from './slickGroupItemMetadataProvider';
 export * from './slickHeaderButtons';
 export * from './slickHeaderMenu';
+export * from './slickRowDetailView';
 export * from './slickRowMoveManager';
 export * from './slickRowSelectionModel';

packages/common/src/plugins/slickContextMenu.ts

@@ -10,14 +10,13 @@ import {
   MenuOptionItem,
   SlickEventHandler,
 } from '../interfaces/index';
-import { getCellValueFromQueryFieldGetter, getTranslationPrefix, } from '../services/index';
+import { DelimiterType, FileType } from '../enums/index';
+import { ExcelExportService, getCellValueFromQueryFieldGetter, getTranslationPrefix, TextExportService } from '../services/index';
 import { exportWithFormatterWhenDefined } from '../formatters/formatterUtilities';
 import { ExtensionUtility } from '../extensions/extensionUtility';
 import { PubSubService } from '../services/pubSub.service';
 import { SharedService } from '../services/shared.service';
 import { TreeDataService } from '../services/treeData.service';
-import { ExcelExportService, TextExportService } from '../services';
-import { DelimiterType, FileType } from '../enums';
 import { MenuFromCellBaseClass } from './menuFromCellBaseClass';