@genesislcap/pbc-reporting-ui 15.19.0 → 15.19.1

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-grid.helpers.test.ts

@@ -1,187 +0,0 @@
-import { ICellRendererParams } from '@ag-grid-community/core';
-import { assert, sinon, suite } from '@genesislcap/foundation-testing';
-import { actions, selectors } from '../../../store';
-import { GridColumnNames } from '../shared';
-import { displayNameOnChangeHandler, lookupColumnRename } from './col-rename-alias-grid.helpers';
-import { ColumnRenameAliasRowData } from './col-rename-alias-grid.types';
-
-// When running all tests, the shared helper tests will be executed separately
-// Here we only test the col-rename-alias-specific helpers
-
-const LookupColumnRename = suite('lookupColumnRename()');
-
-LookupColumnRename.before.each(() => {
-  sinon.restore();
-});
-
-LookupColumnRename('should return original data when no rename is found', () => {
-  const mockData: ColumnRenameAliasRowData = {
-    [GridColumnNames.ColumnName]: 'originalColumn',
-    [GridColumnNames.DisplayName]: 'Original Display',
-    [GridColumnNames.Type]: 'STRING',
-    [GridColumnNames.Datasource]: 'Test (Snapshot)',
-  };
-
-  const getDatasourceStub = sinon.stub(selectors.datasourceConfig, 'getDatasource').returns({
-    KEY: 'test',
-    NAME: 'Test Datasource',
-    INPUT_TYPE: 'REQ_REP' as const,
-    OUTPUT_TYPE: 'TABLE' as const,
-    TRANSFORMER_CONFIGURATION: { COLUMN_RENAMES: {} },
-    GROUPING_STRATEGY: 'NONE',
-    GROUP_KEY: null,
-  });
-
-  const result = lookupColumnRename(mockData);
-
-  assert.equal(result, mockData);
-  assert.ok(getDatasourceStub.calledOnce);
-});
-
-LookupColumnRename('should return data with renamed display name when rename exists', () => {
-  const originalColumn = 'originalColumn';
-  const newDisplayName = 'Renamed Display';
-  const mockData: ColumnRenameAliasRowData = {
-    [GridColumnNames.ColumnName]: originalColumn,
-    [GridColumnNames.DisplayName]: 'Original Display',
-    [GridColumnNames.Type]: 'STRING',
-    [GridColumnNames.Datasource]: 'Test (Snapshot)',
-  };
-
-  const getDatasourceStub = sinon.stub(selectors.datasourceConfig, 'getDatasource').returns({
-    KEY: 'test',
-    NAME: 'Test Datasource',
-    INPUT_TYPE: 'REQ_REP' as const,
-    OUTPUT_TYPE: 'TABLE' as const,
-    TRANSFORMER_CONFIGURATION: {
-      COLUMN_RENAMES: {
-        [originalColumn]: newDisplayName,
-      },
-    },
-    GROUPING_STRATEGY: 'NONE',
-    GROUP_KEY: null,
-  });
-
-  const result = lookupColumnRename(mockData);
-
-  assert.equal(result[GridColumnNames.DisplayName], newDisplayName);
-  assert.equal(result[GridColumnNames.ColumnName], mockData[GridColumnNames.ColumnName]);
-  assert.equal(result[GridColumnNames.Type], mockData[GridColumnNames.Type]);
-  assert.equal(result[GridColumnNames.Datasource], mockData[GridColumnNames.Datasource]);
-  assert.ok(getDatasourceStub.calledOnce);
-});
-
-LookupColumnRename('should handle undefined COLUMN_RENAMES', () => {
-  const mockData: ColumnRenameAliasRowData = {
-    [GridColumnNames.ColumnName]: 'originalColumn',
-    [GridColumnNames.DisplayName]: 'Original Display',
-    [GridColumnNames.Type]: 'STRING',
-    [GridColumnNames.Datasource]: 'Test (Snapshot)',
-  };
-
-  const getDatasourceStub = sinon.stub(selectors.datasourceConfig, 'getDatasource').returns({
-    KEY: 'test',
-    NAME: 'Test Datasource',
-    INPUT_TYPE: 'REQ_REP' as const,
-    OUTPUT_TYPE: 'TABLE' as const,
-    TRANSFORMER_CONFIGURATION: {},
-    GROUPING_STRATEGY: 'NONE',
-    GROUP_KEY: null,
-  });
-
-  const result = lookupColumnRename(mockData);
-
-  assert.equal(result, mockData);
-  assert.ok(getDatasourceStub.calledOnce);
-});
-
-LookupColumnRename.run();
-
-const DisplayNameOnChangeHandler = suite('displayNameOnChangeHandler');
-
-DisplayNameOnChangeHandler.before.each(() => {
-  sinon.restore();
-});
-
-DisplayNameOnChangeHandler('calls setColumnRename with correct parameters when valid input', () => {
-  const callback = sinon.spy();
-  const handler = displayNameOnChangeHandler(callback);
-  const mockData = {
-    [GridColumnNames.Datasource]: 'testAlias (Snapshot)',
-    [GridColumnNames.ColumnName]: 'originalColumn',
-    [GridColumnNames.DisplayName]: 'Original Display',
-    [GridColumnNames.Type]: 'STRING',
-  } as ColumnRenameAliasRowData;
-
-  const setColumnRenameStub = sinon.stub(actions.datasourceConfig, 'setColumnRename');
-  sinon.stub(selectors.datasourceConfig, 'getAllConfigSet').returns({
-    REQ_REP_testSource_testAlias: {
-      KEY: 'testAlias',
-      NAME: 'testSource',
-      INPUT_TYPE: 'REQ_REP',
-      OUTPUT_TYPE: 'TABLE',
-      TRANSFORMER_CONFIGURATION: {},
-      GROUPING_STRATEGY: 'NONE',
-      GROUP_KEY: null,
-    },
-  });
-
-  handler('newColumn', { data: mockData } as ICellRendererParams<ColumnRenameAliasRowData>);
-
-  assert.equal(setColumnRenameStub.calledOnce, true);
-
-  // Check each property individually instead of using deepEqual
-  const firstCallArg = setColumnRenameStub.firstCall.args[0];
-  assert.equal(firstCallArg.key, 'REQ_REP_testSource_testAlias');
-  assert.equal(firstCallArg.columnFrom, 'originalColumn');
-  assert.equal(firstCallArg.columnTo, 'newColumn');
-
-  assert.equal(callback.called, false);
-});
-
-DisplayNameOnChangeHandler('removes prohibited characters and calls callback', () => {
-  const callback = sinon.spy();
-  const handler = displayNameOnChangeHandler(callback);
-  const mockData = {
-    [GridColumnNames.Datasource]: 'testAlias (Snapshot)',
-    [GridColumnNames.ColumnName]: 'originalColumn',
-    [GridColumnNames.DisplayName]: 'Original Display',
-    [GridColumnNames.Type]: 'STRING',
-  } as ColumnRenameAliasRowData;
-
-  const setColumnRenameStub = sinon.stub(actions.datasourceConfig, 'setColumnRename');
-  sinon.stub(selectors.datasourceConfig, 'getAllConfigSet').returns({
-    REQ_REP_testSource_testAlias: {
-      KEY: 'testAlias',
-      NAME: 'testSource',
-      INPUT_TYPE: 'REQ_REP',
-      OUTPUT_TYPE: 'TABLE',
-      TRANSFORMER_CONFIGURATION: {},
-      GROUPING_STRATEGY: 'NONE',
-      GROUP_KEY: null,
-    },
-  });
-
-  handler('new@Column-=+test', { data: mockData } as ICellRendererParams<ColumnRenameAliasRowData>);
-
-  assert.equal(setColumnRenameStub.calledOnce, true);
-
-  // Check each property individually instead of using deepEqual
-  const firstCallArg = setColumnRenameStub.firstCall.args[0];
-  assert.equal(firstCallArg.key, 'REQ_REP_testSource_testAlias');
-  assert.equal(firstCallArg.columnFrom, 'originalColumn');
-  assert.equal(firstCallArg.columnTo, 'newColumntest');
-
-  assert.equal(callback.calledOnce, true);
-});
-
-DisplayNameOnChangeHandler('throws error when params.data is undefined', () => {
-  const callback = sinon.spy();
-  const handler = displayNameOnChangeHandler(callback);
-
-  assert.throws(() => {
-    handler('newColumn', { data: undefined } as any);
-  }, 'displayNameOnChangeHandler with invalid data');
-});
-
-DisplayNameOnChangeHandler.run();

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-grid.helpers.ts

@@ -1,89 +0,0 @@
-import {
-  CellClassParams,
-  CellStyle,
-  ICellRendererParams,
-  RowSelectedEvent,
-} from '@ag-grid-community/core';
-import { capitalCase } from 'change-case';
-import { actions, selectors } from '../../../store';
-import {
-  GridColumnNames,
-  GridRowData,
-  datasourceNameFromDisplay,
-  lookupColumnIsRenamed,
-  shouldDisableColumn,
-} from '../shared';
-import { ColumnRenameAliasRowData } from './col-rename-alias-grid.types';
-
-/**
- * Adds display name info from store to the row data
- */
-export function lookupColumnRename(data: ColumnRenameAliasRowData): ColumnRenameAliasRowData {
-  const key = datasourceNameFromDisplay(data[GridColumnNames.Datasource]);
-  const rename =
-    selectors.datasourceConfig.getDatasource(key).TRANSFORMER_CONFIGURATION.COLUMN_RENAMES?.[
-      data[GridColumnNames.ColumnName]
-    ];
-  return {
-    ...data,
-    [GridColumnNames.DisplayName]: rename || capitalCase(data[GridColumnNames.DisplayName]),
-  };
-}
-
-/**
- * Factory for creating cell styles based on filter status for rename grid cells
- */
-export function buildRenameCellStyle<
-  T extends Pick<GridRowData, GridColumnNames.Datasource | GridColumnNames.ColumnName>,
->(rowDeselectedStyle: CellStyle, rowSelectedStyle: CellStyle = {}) {
-  return (params: CellClassParams<T>): CellStyle => {
-    if (params.data && lookupColumnIsRenamed(params.data as any)) {
-      return rowSelectedStyle;
-    }
-    return rowDeselectedStyle;
-  };
-}
-
-/**
- * Handler for display name changes in the grid
- */
-export const displayNameOnChangeHandler = (callback: () => any) => {
-  return (value: string, params: ICellRendererParams<ColumnRenameAliasRowData>) => {
-    if (!params.data) throw new Error('displayNameOnChangeHandler with invalid data');
-    const prohibitedChars = /[-@=+]/g;
-    const columnTo = value.replace(prohibitedChars, '');
-    actions.datasourceConfig.setColumnRename({
-      key: datasourceNameFromDisplay(params.data[GridColumnNames.Datasource]),
-      columnFrom: params.data[GridColumnNames.ColumnName],
-      columnTo,
-      included: true,
-    });
-    if (value !== columnTo) {
-      callback();
-    }
-  };
-};
-
-/**
- * Handler for row selection changes in the grid
- */
-export function renameRowSelectionChangedHandler(
-  event: RowSelectedEvent<ColumnRenameAliasRowData>,
-): void {
-  if (!event.data) return;
-
-  // gate event listener to only trigger if the data is actually changed by the user
-  // (return if setting the same value as in the store, e.g. when first loading
-  // the grid data)
-  if (lookupColumnIsRenamed(event.data) === (event.node.isSelected() ?? true)) return;
-
-  if (shouldDisableColumn(event.data)) return;
-  actions.datasourceConfig.setColumnRename({
-    key: datasourceNameFromDisplay(event.data[GridColumnNames.Datasource]),
-    columnFrom: event.data[GridColumnNames.ColumnName],
-    columnTo: event.data[GridColumnNames.DisplayName],
-    included: event.node.isSelected() ?? true,
-  });
-
-  event.api.redrawRows();
-}

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-grid.styles.ts

@@ -1,22 +0,0 @@
-import { css } from '@genesislcap/web-core';
-
-export const styles = css`
-  div.grid-container {
-    width: 100%;
-    height: calc(var(--constrained-height) - 160px);
-  }
-
-  div.grid-container.error {
-    cursor: not-allowed;
-  }
-
-  div.error rapid-grid-pro {
-    pointer-events: none;
-    opacity: 80%;
-  }
-
-  rapid-grid-pro::part(grid) {
-    --base-height-multiplier: 9;
-    --ag-selected-row-background-color: transparent !important;
-  }
-`;

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-grid.template.ts

@@ -1,14 +0,0 @@
-import { classNames, html } from '@genesislcap/web-core';
-import type { ColRenamesAliases } from './col-rename-alias-grid';
-
-export const template = html<ColRenamesAliases>`
-  <div class="grid-container ${(x) => classNames(['error', x.dataError])}">
-    <rapid-grid-pro
-      class="${(x) => classNames(['error', x.dataError])}"
-      data-test-id="datasource-config-col-rename-grid"
-      :gridOptions=${(x) => x.getGridOptions()}
-      :rowData=${(x) => x.fieldData}
-      grid-autosizing
-    ></rapid-grid-pro>
-  </div>
-`;

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-grid.ts

@@ -1,119 +0,0 @@
-import { ColDef, IRowNode, RowDataUpdatedEvent, ValueGetterParams } from '@ag-grid-community/core';
-import { GridOptionsConfig, RapidAgTextRenderer } from '@genesislcap/rapid-grid-pro';
-import { customElement } from '@genesislcap/web-core';
-import { RowSelectRenderer } from '../../../../old/components/renderers/row-select.renderer';
-import { selectors } from '../../../store';
-import {
-  datasourceNameFromDisplay,
-  DatasourceDataBaseComponent,
-  GridColumnNames,
-  pathParameters,
-  lookupColumnIsRenamed,
-  lookupColumnIsIncluded,
-  orderRowsByIncludeColumns,
-} from '../shared';
-import {
-  buildRenameCellStyle,
-  displayNameOnChangeHandler,
-  lookupColumnRename,
-  renameRowSelectionChangedHandler,
-} from './col-rename-alias-grid.helpers';
-import { styles } from './col-rename-alias-grid.styles';
-import { template } from './col-rename-alias-grid.template';
-import { ColumnRenameAliasRowData } from './col-rename-alias-grid.types';
-
-@customElement({
-  name: 'col-rename-alias',
-  template,
-  styles,
-})
-export class ColRenamesAliases extends DatasourceDataBaseComponent {
-  /**
-   * Override updateGridData to include column rename information
-   */
-  protected async updateDataFields() {
-    try {
-      const rows = this.datasourceSpec
-        .flatMap(pathParameters)
-        .filter(lookupColumnIsIncluded)
-        .map(lookupColumnRename);
-      const currentDisplay = this.datasourceSpec[0]?.name;
-      const include = currentDisplay
-        ? selectors.datasourceConfig.getDatasource(datasourceNameFromDisplay(currentDisplay))
-            ?.TRANSFORMER_CONFIGURATION?.INCLUDE_COLUMNS
-        : undefined;
-      this.fieldData = orderRowsByIncludeColumns(rows as any, include) as any;
-      this.dataError = false;
-    } catch (e) {
-      this.handleError(e as Error, 'There were errors when loading the datasource fields');
-    }
-  }
-
-  getGridOptions(): GridOptionsConfig {
-    const disableCellStyle = {
-      opacity: '0.5',
-      pointerEvents: 'none',
-    };
-    const hideCellStyle = {
-      display: 'none',
-    };
-
-    const columnDefs: ColDef[] = [
-      {
-        field: '',
-        headerTooltip: 'Controls whether this column is added to the renamed columns.',
-        headerCheckboxSelection: true,
-        cellRenderer: 'row-select',
-        valueGetter: (params: ValueGetterParams<ColumnRenameAliasRowData>) =>
-          lookupColumnIsRenamed(params.data!),
-        maxWidth: 60,
-      },
-      {
-        field: GridColumnNames.ColumnName,
-        headerTooltip: 'The name of the field as defined on the selected datasource.',
-        cellStyle: buildRenameCellStyle<ColumnRenameAliasRowData>(disableCellStyle),
-      },
-      {
-        field: GridColumnNames.DisplayName,
-        headerTooltip: 'Configurable name for the associated column name.',
-        cellStyle: buildRenameCellStyle<ColumnRenameAliasRowData>(hideCellStyle),
-        cellRenderer: RapidAgTextRenderer,
-        cellRendererParams: {
-          accessor: GridColumnNames.DisplayName,
-          onChange: displayNameOnChangeHandler(this.updateDataFields.bind(this)),
-        },
-      },
-      {
-        field: GridColumnNames.Type,
-        headerTooltip: 'The type of the field on the underlying datasource.',
-        cellStyle: buildRenameCellStyle<ColumnRenameAliasRowData>(disableCellStyle),
-      },
-    ];
-
-    return {
-      components: {
-        'row-select': RowSelectRenderer,
-      },
-      suppressRowTransform: true,
-      columnDefs,
-      rowData: [],
-      headerHeight: 30,
-      rowHeight: 38,
-      tooltipShowDelay: 0,
-      rowSelection: 'multiple',
-      onGridReady: () => {
-        this.handleUpdatedDatasources();
-      },
-      context: {
-        ariaLabelField: GridColumnNames.ColumnName,
-      },
-      suppressRowClickSelection: true,
-      onRowSelected: renameRowSelectionChangedHandler,
-      onRowDataUpdated(params: RowDataUpdatedEvent) {
-        params.api.forEachNode((node: IRowNode<ColumnRenameAliasRowData>) => {
-          node.setSelected(lookupColumnIsRenamed(node.data!));
-        });
-      },
-    };
-  }
-}

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-grid.types.ts

@@ -1,10 +0,0 @@
-import { GridColumnNames, GridRowData } from '../shared';
-
-// Define the specific subset of fields needed for this component
-export type ColumnRenameAliasRowData = Pick<
-  GridRowData,
-  | GridColumnNames.ColumnName
-  | GridColumnNames.DisplayName
-  | GridColumnNames.Type
-  | GridColumnNames.Datasource
->;

package/src/new/main/edit-config/col-rename-alias/col-rename-alias-tutorial.ts

@@ -1,33 +0,0 @@
-import { customElement, GenesisElement, html, whenElse } from '@genesislcap/web-core';
-import { selectors } from '../../../store';
-
-@customElement({
-  name: 'col-renames-aliases-tutorial',
-  template: html`
-    <template>
-      ${whenElse(
-        (_) => Boolean(selectors.baseConfig.getConfig().DOCUMENT_TEMPLATE_ID),
-        html`
-          <h1>Column Aliases</h1>
-          <p>
-            In this step, configure the aliases that will be used to reference the datasource column
-            (field) in your template. Where the checkbox is checked, the value in "Display Name"
-            will be used as the alias. Where the checkbox is unchecked, the "Column Name" value will
-            be used as the alias.
-          </p>
-        `,
-        html`
-          <h1>Column Renames</h1>
-          <p>
-            In this step, configure the column headers you wish to see in the generated report.
-            Where the checkbox is checked, the value in "Display Name" will be used as the column
-            header. Where the checkbox is unchecked, the "Column Name" value will be used as the
-            column header.
-          </p>
-        `,
-      )}
-      <p>Any columns you've previously set as not-visible will not be configured here.</p>
-    </template>
-  `,
-})
-export class ColRenamesAliasesTutorial extends GenesisElement {}

package/src/new/main/edit-config/config-journey-orchestrator.styles.ts

@@ -1,120 +0,0 @@
-import { css } from '@genesislcap/web-core';
-import { constrainedDimensions } from '../../styles';
-
-export const styles = css`
-  :host {
-    --stepper-size: 50px;
-    ${constrainedDimensions({ navToContentPx: 300 })}
-  }
-
-  div.pad {
-    padding-top: 50px;
-  }
-
-  .centered {
-    max-width: var(--constrained-width);
-    max-height: calc(100vh - var(--reporting-header-to-content-height));
-    width: 100%;
-    margin: auto;
-  }
-
-  .scheduling-container {
-    display: flex;
-    height: 100%;
-  }
-
-  .scheduling-container-margin {
-    margin: 0 auto;
-  }
-
-  .block {
-    display: block;
-  }
-
-  datasource-config-container,
-  base-config {
-    overflow-y: auto;
-    overflow-x: clip;
-    min-height: var(--constrained-height);
-  }
-
-  div.button-container {
-    z-index: 1 !important;
-    position: absolute;
-    top: calc(var(--stepper-size) + calc(var(--design-unit) * 3px));
-    right: calc(var(--design-unit) * 3px);
-    display: flex;
-    align-content: center;
-    align-items: center;
-    gap: calc(var(--design-unit) * 3px);
-  }
-
-  tabbed-datasource-container,
-  row-filters {
-    max-width: var(--constrained-width);
-    margin: auto;
-    display: block;
-  }
-
-  rapid-stepper::part(action-buttons-container) {
-    border-top: calc(var(--stroke-width) * 1px) solid
-      color-mix(in srgb, var(--neutral-stroke-divider-rest), transparent 50%);
-    padding: calc(var(--design-unit) * 3px) calc(var(--design-unit) * 4px);
-  }
-
-  rapid-stepper::part(stepper-tab-panel) {
-    background: var(--app-bg-color);
-    justify-content: space-between;
-    border-bottom: calc(var(--stroke-width) * 1px) solid
-      color-mix(in srgb, var(--neutral-stroke-divider-rest), transparent 50%);
-  }
-
-  rapid-stepper::part(stepper-tab) {
-    border-bottom: calc(var(--stroke-width) * 1px) solid
-      color-mix(in srgb, var(--neutral-stroke-divider-rest), transparent 50%);
-    height: var(--stepper-size);
-  }
-
-  rapid-stepper::part(stepper-panel-container) {
-    overflow: hidden;
-    contain: size;
-  }
-
-  rapid-stepper.hidden::part(action-buttons-container) {
-    display: none;
-  }
-
-  rapid-stepper::part(stepper-tab-menu) {
-    margin: 0;
-    gap: 0;
-  }
-
-  rapid-stepper::part(stepper-tab-progress) {
-    background: var(--app-bg-color);
-    justify-content: center;
-    padding: 0;
-  }
-
-  /**
-   * Hacky way for now - need to adjust it in foundation
-  */
-  rapid-stepper-tab {
-    --neutral-layer-3: var(--app-bg-color);
-  }
-
-  :host(.readonly) rapid-stepper-tab-panel {
-    pointer-events: none;
-  }
-
-  ::-webkit-scrollbar {
-    width: calc((var(--base-height-multiplier) + var(--design-unit)) * 1px);
-  }
-
-  ::-webkit-scrollbar-track {
-    background: var(--neutral-layer-1);
-  }
-
-  ::-webkit-scrollbar-thumb {
-    background: var(--neutral-fill-rest);
-  }
-`;