@genesislcap/grid-pro 14.20.1 → 14.20.2-alpha-97d057d.0

package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js

@@ -11,6 +11,11 @@ import { logger } from '../utils/logger';
 const criteriaDelimiter = ';';
 const criteriaJoin = ' && ';
 const withoutFullInit = null;
+/**
+ * The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.
+ * @remarks Only supports Client-Side Row Model.
+ * @public
+ */
 let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleMixin(FoundationElement) {
     constructor() {
         super(...arguments);
@@ -69,6 +74,11 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         return this.parentElement;
     }
     // Genesis Specific
+    /**
+     * Initializes the datasource.
+     * @public
+     * @remarks This method is called automatically when the element is connected to the DOM.
+     */
     init() {
         if (this.agGrid && this.resourceName && this.connect.isConnected) {
             const gridOptions = Object.assign({ getRowId: (params) => params.data[this.rowId] }, this.deferredGridOptions);
@@ -87,14 +97,16 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         logger.warn(`Application not connected, falling back to local columnDefs/rowData`);
     }
     /**
+     * Deinitialises the datasource, resetting it to its initial state.
      * @public
      */
     deinit() {
         this.reset();
     }
     /**
-     * Use {@link @genesislcap/grid-pro#GridProGenesisDatasource#deinit} instead
-     * @deprecated
+     * Resets the datasource to its initial state.
+     * @public
+     * @deprecated Use `deinit` instead
      */
     reset() {
         if (this.dataSub) {
@@ -119,6 +131,10 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         this.criteriaFromFilters = new Map();
         this.update = new BehaviorSubject(new Map());
     }
+    /**
+     * Restarts the datasource, uses `deinit` and `init` in sequence.
+     * @public
+     */
     restart() {
         this.deinit();
         this.init();

package/dist/esm/grid-pro.js

@@ -21,8 +21,17 @@ GridProGenesisDatasourceNext;
 GridProCell;
 GridColumn;
 ModuleRegistry.registerModules([CsvExportModule, ClientSideRowModelModule]);
-const hypenateAndLowercase = (property) => property.replace('/([a-z])([A-Z])/g', '$1-$2').toLowerCase();
 /**
+ * A function to convert string values from 'camelCase' to 'hypenated-lowercase'.
+ * @param value - The value to hypenate and lowercase.
+ * @returns The hypenated and lowercased result.
+ * @public
+ */
+export const hypenateAndLowercase = (value) => value.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+/**
+ * The Grid Pro element.
+ * @remarks Grid Pro is a Web Component wrapper around the AG Grid Community library.
+ * @public
  * @tagname %%prefix%%-grid-pro
  */
 export class GridPro extends LifecycleMixin(FoundationElement) {
@@ -78,7 +87,7 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         ComponentUtil.ALL_PROPERTIES.forEach((key) => {
             Object.defineProperty(this, key, {
                 set: (v) => {
-                    this.agAttributeChangedCallback(key.toLowerCase(), undefined, v);
+                    this.agAttributeChangedCallback(hypenateAndLowercase(key), undefined, v);
                 },
                 enumerable: true,
                 configurable: true,
@@ -125,16 +134,16 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         }, DEBOUNCED_RESIZE_TIME);
     }
     /**
-     * If {@link @genesislcap/grid-pro#GridPro#gridAutosizingEnabled} is true, will remove the widths from the column states.
+     * If {@link @genesislcap/grid-pro#GridPro.gridAutosizingEnabled} is true, will remove the widths from the column states.
      * @internal
      */
     removeConfigWidthsToAutosize(colState) {
         return colState.map((col) => (Object.assign(Object.assign({}, col), { width: null })));
     }
-    serialiseStoreTableConfig() {
+    saveColumnState() {
         if (this.rehydrationAttempted && this.statePersistanceEnabled()) {
             const existingOptions = JSON.parse(this.session.getLocalStorageItem('gridOptions') || '{}');
-            let colState = this.agGridOptions.columnApi.getColumnState();
+            let colState = this.gridApi.getColumnDefs();
             colState = this.gridAutosizingEnabled
                 ? this.removeConfigWidthsToAutosize(colState)
                 : colState;
@@ -142,25 +151,40 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
             this.session.setLocalStorageItem('gridOptions', JSON.stringify(existingOptions));
         }
     }
-    rehydrateTableConfig() {
-        this.rehydrationAttempted = true;
-        if (this.statePersistanceEnabled() && this.session.getLocalStorageItem('gridOptions')) {
-            const allGridOptions = JSON.parse(this.session.getLocalStorageItem('gridOptions'));
+    /**
+     * Gets the saved grid ColDefs from local storage
+     * @remarks This is used to restore the grid state when the grid is rehydrated
+     * @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
+     * @public
+     */
+    get savedColumnState() {
+        const localStorageGridOptions = this.session.getLocalStorageItem('gridOptions');
+        if (this.statePersistanceEnabled() && localStorageGridOptions) {
+            const allGridOptions = JSON.parse(localStorageGridOptions);
             if (this.persistColumnStateKey in allGridOptions) {
-                this.agGridOptions.columnApi.applyColumnState({
-                    state: JSON.parse(allGridOptions[this.persistColumnStateKey]),
-                    applyOrder: true,
-                });
+                return JSON.parse(allGridOptions[this.persistColumnStateKey]);
             }
         }
+        return [];
+    }
+    restoreColumnState() {
+        this.rehydrationAttempted = true;
+        if (this.savedColumnState.length > 0) {
+            this.gridApi.setColumnDefs(this.savedColumnState);
+        }
+    }
+    /**
+     * @public
+     */
+    get gridOptions() {
+        return this.agGridOptions;
     }
     set gridOptions(options) {
         const globalEventListener = this.globalEventListener.bind(this);
         const gridOnChangeCallback = () => {
-            this.serialiseStoreTableConfig.bind(this)();
+            this.saveColumnState.bind(this)();
             this.debouncedColumnAutosize.bind(this)();
         };
-        const rehydrateTableConfig = this.rehydrateTableConfig.bind(this);
         Array.from(this.attributes).forEach((attribute) => {
             const attrName = this.agPropertiesMap[attribute.name];
             if (!attrName)
@@ -183,10 +207,10 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
                     params,
                     gridId: this.id,
                 });
-                rehydrateTableConfig();
+                this.restoreColumnState.bind(this)();
                 this.debouncedColumnAutosize.bind(this)();
             }, onFirstDataRendered: () => {
-                this.enableFlashingRows.bind(this);
+                this.enableFlashingRows.bind(this)();
             }, onColumnPinned: gridOnChangeCallback, onColumnResized: gridOnChangeCallback, onColumnMoved: gridOnChangeCallback, onDisplayedColumnsChanged: gridOnChangeCallback, onFilterChanged: gridOnChangeCallback, onGridSizeChanged: gridOnChangeCallback, onSortChanged: gridOnChangeCallback }), rest);
         this.agGridOptions = Object.assign(Object.assign({}, this.agGridOptions), ComponentUtil.copyAttributesToGridOptions(derivedOptions, this.agAttributes));
         const gridParams = {
@@ -353,13 +377,22 @@ __decorate([
 __decorate([
     observable
 ], GridPro.prototype, "gridComponents", void 0);
-// explicitly declaring for extensibility
+/**
+ * GridPro shadow root options.
+ * @public
+ * @remarks
+ * For extensibility, this can be used to set the shadow root mode and delegatesFocus
+ */
 export const foundationGridProShadowOptions = undefined;
+/**
+ * Grid Pro default configuration.
+ * @public
+ */
 export const defaultGridProConfig = {
     shadowOptions: undefined,
 };
 /**
- * The Foundation AgGrid
+ * A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks

package/dist/esm/style/colors.js

@@ -2,13 +2,13 @@ import { parseColorHexRGB } from '@microsoft/fast-colors';
 import { SwatchRGB } from '@microsoft/fast-components';
 /**
  * The background color swatch.
- * @deprecated - only used in the deprecated ag-theme-material theme
  * @internal
+ * @deprecated - only used in the deprecated ag-theme-material theme
  */
 export const backgroundSwatch = SwatchRGB.from(parseColorHexRGB('#4c4c4c'));
 /**
  * The foreground color swatch.
- * @deprecated - only used in the deprecated ag-theme-material theme
  * @internal
+ * @deprecated - only used in the deprecated ag-theme-material theme
  */
 export const foregroundSwatch = SwatchRGB.from(parseColorHexRGB('#c01754'));