@genesislcap/pbc-reporting-ui 14.396.4 → 14.397.0

package/src/new/utils/alias-generator.test.ts

@@ -0,0 +1,44 @@
+import { assert, suite } from '@genesislcap/foundation-testing';
+import { generateUniqueAlias } from './alias-generator';
+
+const GenerateUniqueAlias = suite('generateUniqueAlias');
+
+GenerateUniqueAlias('returns the base alias if it does not exist', () => {
+  const existingAliases = new Set(['other']);
+  const alias = generateUniqueAlias('test', existingAliases);
+  assert.equal(alias, 'test');
+});
+
+GenerateUniqueAlias('increments the alias if it already exists', () => {
+  const existingAliases = new Set(['test']);
+  const alias = generateUniqueAlias('test', existingAliases);
+  assert.equal(alias, 'test_1');
+});
+
+GenerateUniqueAlias('increments the alias until it is unique', () => {
+  const existingAliases = new Set(['test', 'test_1']);
+  const alias = generateUniqueAlias('test', existingAliases);
+  assert.equal(alias, 'test_2');
+});
+
+GenerateUniqueAlias('handles case-insensitivity when checking for existing aliases', () => {
+  const existingAliases = new Set(['Test']);
+  const alias = generateUniqueAlias('test', existingAliases);
+  assert.equal(alias, 'test_1');
+});
+
+GenerateUniqueAlias('handles case-insensitivity for new alias generation', () => {
+  const existingAliases = new Set(['test']);
+  const alias = generateUniqueAlias('Test', existingAliases);
+  // Since input baseAlias is 'Test', it tries 'Test'. 'Test' matches 'test' case-insensitively.
+  // Next attempt 'Test_1'.
+  assert.equal(alias, 'Test_1');
+});
+
+GenerateUniqueAlias('handles mixed case existing aliases', () => {
+  const existingAliases = new Set(['TeSt', 'tEsT_1']);
+  const alias = generateUniqueAlias('test', existingAliases);
+  assert.equal(alias, 'test_2');
+});
+
+GenerateUniqueAlias.run();

package/src/new/utils/alias-generator.ts

@@ -0,0 +1,18 @@
+/**
+ * Generates a unique alias by appending a counter if the base alias already exists in the set.
+ * @param baseAlias The desired alias name (usually the resource name).
+ * @param existingAliases A Set of currently used aliases to check against.
+ * @returns A unique alias string.
+ */
+export function generateUniqueAlias(baseAlias: string, existingAliases: Set<string>): string {
+  const existingAliasesLower = new Set(
+    Array.from(existingAliases).map((alias) => alias.toLowerCase()),
+  );
+  let uniqueAlias = baseAlias;
+  let counter = 1;
+  while (existingAliasesLower.has(uniqueAlias.toLowerCase())) {
+    uniqueAlias = `${baseAlias}_${counter}`;
+    counter += 1;
+  }
+  return uniqueAlias;
+}

package/src/new/utils/index.ts

@@ -1,3 +1,4 @@
+export * from './alias-generator';
 export * from './endpoint';
 export * from './formatters';
 export * from './notifications';

package/src/new/utils/tooltip.ts

@@ -52,6 +52,11 @@ export namespace TOOLTIP {
   </ul>
   `;
 
+  export const DATASOURCES_DATASOURCE = `
+  <h3>Datasource</h3>
+  <p>This is the name of the server resource that data will be pulled from to generate the report.</p>
+`;
+
   export const DATASOURCES_NAME = `
   <h3>Datasource name</h3>
   <p>Allows you to set a name for the datasource which must correspond with your template data references where the report is configured to use a template file.</p>
@@ -63,6 +68,20 @@ export namespace TOOLTIP {
   <p>Configures the method by which the server constructs the report configuration. Currently only TABLE is supported, which means the entire datasource is loaded into memory when generating the report using this report configuration.</p>
 `;
 
+  export const DATASOURCES_GROUPING_STRATEGY = `
+  <h3>Grouping Strategy</h3>
+  <p>Select "None" to disable grouping strategies, or select the strategy you'd like to use.</p>
+  <ul>
+    <li><strong>Multi-sheet</strong>: Group data for <code>JXLS</code> template Multi-sheet functionality, to split different groups across multiple excel worksheets.</li>
+    <li><strong>Lookup-table</strong>: Create a lookup table of key value pairs in the template data, where the group key field is the map key.</li>
+  </ul>
+`;
+
+  export const DATASOURCES_GROUPING_KEY = `
+  <h3>Grouping Key</h3>
+  <p>Select the field for this datasource you want to operate the grouping strategy on.</p>
+`;
+
   export const DELIVERY_TIMEZONE = `
   <h3>Timezone</h3>
   <p>Select the timezone to be used for this schedule.</p>

package/src/new/utils/transformers.test.ts

@@ -1,6 +1,10 @@
 import { assert, sinon, suite } from '@genesislcap/foundation-testing';
 import type { Genesis } from '../types';
-import { buildDatasourceName, transformFromServerPayload } from './transformers';
+import {
+  buildDatasourceName,
+  transformFromServerPayload,
+  transformToServerPayload,
+} from './transformers';
 
 const TransformFromServerPayload = suite('transformFromServerPayload');
 
@@ -39,7 +43,7 @@ TransformFromServerPayload('cleans up orphaned fields from INCLUDE_COLUMNS', asy
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   assert.equal(cleanedConfig.INCLUDE_COLUMNS?.length, 2);
@@ -83,7 +87,7 @@ TransformFromServerPayload('cleans up orphaned fields from COLUMN_RENAMES', asyn
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   assert.equal(Object.keys(cleanedConfig.COLUMN_RENAMES || {}).length, 2);
@@ -127,7 +131,7 @@ TransformFromServerPayload('cleans up orphaned fields from COLUMN_FORMATS', asyn
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   assert.equal(Object.keys(cleanedConfig.COLUMN_FORMATS || {}).length, 2);
@@ -171,7 +175,7 @@ TransformFromServerPayload('cleans up orphaned fields from COLUMN_TRANSFORMS', a
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   assert.equal(Object.keys(cleanedConfig.COLUMN_TRANSFORMS || {}).length, 2);
@@ -209,7 +213,7 @@ TransformFromServerPayload('handles schema fetch failure gracefully', async () =
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   // Should keep original config when schema fetch fails
@@ -266,8 +270,8 @@ TransformFromServerPayload('handles multiple datasources independently', async (
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const counterpartyKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
-  const tradeKey = buildDatasourceName('TRADE', 'REQ_REP');
+  const counterpartyKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
+  const tradeKey = buildDatasourceName('TRADE', 'TRADE', 'REQ_REP');
 
   assert.equal(
     result.datasourceConfig[counterpartyKey].TRANSFORMER_CONFIGURATION.INCLUDE_COLUMNS?.length,
@@ -318,7 +322,7 @@ TransformFromServerPayload('handles empty transformer configuration', async () =
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   assert.equal(JSON.stringify(cleanedConfig), JSON.stringify({}));
@@ -350,7 +354,7 @@ TransformFromServerPayload('handles missing schema properties', async () => {
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   // All fields should be removed when schema has no properties
@@ -460,7 +464,7 @@ TransformFromServerPayload('handles all transformer config types together', asyn
 
   const result = await transformFromServerPayload(payload, mockGetSchema);
 
-  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'REQ_REP');
+  const datasourceKey = buildDatasourceName('COUNTERPARTY', 'COUNTERPARTY', 'REQ_REP');
   const cleanedConfig = result.datasourceConfig[datasourceKey].TRANSFORMER_CONFIGURATION;
 
   // INCLUDE_COLUMNS should only have valid fields
@@ -485,3 +489,61 @@ TransformFromServerPayload('handles all transformer config types together', asyn
 });
 
 TransformFromServerPayload.run();
+
+const TransformToServerPayload = suite('transformToServerPayload');
+
+TransformToServerPayload('omits grouping fields when strategy is NONE', () => {
+  const state: any = {
+    baseConfig: {
+      DESTINATION_IDS: [],
+      OUTPUT_DIRECTORY: '/reports',
+    },
+    datasourceConfig: {
+      REQ_REP_COUNTERPARTY_COUNTERPARTY: {
+        KEY: 'COUNTERPARTY',
+        INPUT_TYPE: 'REQ_REP',
+        NAME: 'COUNTERPARTY',
+        OUTPUT_TYPE: 'TABLE',
+        TRANSFORMER_CONFIGURATION: {},
+        GROUPING_STRATEGY: 'NONE',
+        GROUP_KEY: null,
+      },
+    },
+  };
+
+  const result = transformToServerPayload(state);
+  const ds = result.DATA_SOURCES[0];
+
+  assert.equal(ds.KEY, 'COUNTERPARTY');
+  assert.ok(!('GROUPING_STRATEGY' in ds));
+  assert.ok(!('GROUP_KEY' in ds));
+});
+
+TransformToServerPayload('includes grouping fields when strategy is not NONE', () => {
+  const state: any = {
+    baseConfig: {
+      DESTINATION_IDS: [],
+      OUTPUT_DIRECTORY: '/reports',
+    },
+    datasourceConfig: {
+      REQ_REP_COUNTERPARTY_COUNTERPARTY: {
+        KEY: 'COUNTERPARTY',
+        INPUT_TYPE: 'REQ_REP',
+        NAME: 'COUNTERPARTY',
+        OUTPUT_TYPE: 'TABLE',
+        TRANSFORMER_CONFIGURATION: {},
+        GROUPING_STRATEGY: 'MULTI_SHEET',
+        GROUP_KEY: 'some_key',
+      },
+    },
+  };
+
+  const result = transformToServerPayload(state);
+  const ds = result.DATA_SOURCES[0] as any;
+
+  assert.equal(ds.KEY, 'COUNTERPARTY');
+  assert.equal(ds.GROUPING_STRATEGY, 'MULTI_SHEET');
+  assert.equal(ds.GROUP_KEY, 'some_key');
+});
+
+TransformToServerPayload.run();

package/src/new/utils/transformers.ts

@@ -18,7 +18,14 @@ export function transformToServerPayload(state: ReportingConfig): Genesis.Server
     DOCUMENT_TEMPLATE_ID: restBaseConfig.DOCUMENT_TEMPLATE_ID
       ? restBaseConfig.DOCUMENT_TEMPLATE_ID
       : null,
-    DATA_SOURCES: Object.values(datasourceConfig),
+    DATA_SOURCES: Object.values(datasourceConfig).map((ds) => {
+      // For NONE case we just don't send it to the server to be backwards compatible
+      if (ds.GROUPING_STRATEGY === 'NONE') {
+        const { GROUPING_STRATEGY, GROUP_KEY, ...rest } = ds;
+        return rest;
+      }
+      return ds;
+    }),
   };
 }
 
@@ -85,10 +92,18 @@ export async function transformFromServerPayload(
 
   const cleanedDatasources = await Promise.all(
     DATA_SOURCES.map(
-      async ({ KEY, INPUT_TYPE, NAME: DS_NAME, OUTPUT_TYPE, TRANSFORMER_CONFIGURATION }) => {
+      async ({
+        KEY,
+        INPUT_TYPE,
+        NAME: DS_NAME,
+        OUTPUT_TYPE,
+        TRANSFORMER_CONFIGURATION,
+        ...rest
+      }) => {
         try {
-          const schema = await getSchema(KEY);
+          const schema = await getSchema(DS_NAME);
           const validFields = new Set(Object.keys(schema.properties || {}));
+          const { GROUPING_STRATEGY, GROUP_KEY } = rest as any;
 
           const cleanedConfig = cleanupTransformerConfig(
             TRANSFORMER_CONFIGURATION || {},
@@ -101,16 +116,21 @@ export async function transformFromServerPayload(
             NAME: DS_NAME,
             OUTPUT_TYPE,
             TRANSFORMER_CONFIGURATION: cleanedConfig,
+            GROUPING_STRATEGY: GROUPING_STRATEGY || 'NONE',
+            GROUP_KEY: GROUP_KEY || null,
           };
         } catch (error) {
           // If schema fetch fails, log warning but keep original config
           console.warn(`Failed to fetch schema for ${KEY}, skipping cleanup:`, error);
+          const { GROUPING_STRATEGY, GROUP_KEY } = rest as any;
           return {
             KEY,
             INPUT_TYPE,
             NAME: DS_NAME,
             OUTPUT_TYPE,
             TRANSFORMER_CONFIGURATION: TRANSFORMER_CONFIGURATION || {},
+            GROUPING_STRATEGY: GROUPING_STRATEGY || 'NONE',
+            GROUP_KEY: GROUP_KEY || null,
           };
         }
       },
@@ -122,7 +142,7 @@ export async function transformFromServerPayload(
     datasourceConfig: cleanedDatasources.reduce(
       (acum, ds) => ({
         ...acum,
-        [buildDatasourceName(ds.NAME, ds.INPUT_TYPE)]: ds,
+        [buildDatasourceName(ds.KEY, ds.NAME, ds.INPUT_TYPE)]: ds,
       }),
       {},
     ),
@@ -145,6 +165,10 @@ export function datasourceInputFromDisplay(
   else throw new Error(`datasourceInputFromDisplay - Uncaught case ${display}`);
 }
 
-export function buildDatasourceName(key: string, type: DatasourceInputTypes): DatasourceName {
-  return `${type}_${key}`;
+export function buildDatasourceName(
+  alias: string,
+  resourceName: string,
+  type: DatasourceInputTypes,
+): DatasourceName {
+  return `${type}_${resourceName}_${alias}`;
 }

package/src/new/utils/validators.test.ts

@@ -29,12 +29,14 @@ ValidateDatasourceConfig('returns ok when single datasource configured', () => {
       OUTPUT_FORMAT: 'CSV',
     },
     datasourceConfig: {
-      REQ_REP_test: {
-        KEY: 'test',
-        NAME: 'test',
+      REQ_REP_testSource_testAlias: {
+        KEY: 'testAlias',
+        NAME: 'testSource',
         INPUT_TYPE: 'REQ_REP',
         OUTPUT_TYPE: 'TABLE',
         TRANSFORMER_CONFIGURATION: {},
+        GROUPING_STRATEGY: 'NONE',
+        GROUP_KEY: null,
       },
     },
   };
@@ -53,19 +55,23 @@ ValidateDatasourceConfig('returns ok when multiple datasources and PDF format',
       DOCUMENT_TEMPLATE_ID: 'template1',
     },
     datasourceConfig: {
-      REQ_REP_test1: {
-        KEY: 'test1',
-        NAME: 'test1',
+      REQ_REP_source1_alias1: {
+        KEY: 'alias1',
+        NAME: 'source1',
         INPUT_TYPE: 'REQ_REP',
         OUTPUT_TYPE: 'TABLE',
         TRANSFORMER_CONFIGURATION: {},
+        GROUPING_STRATEGY: 'NONE',
+        GROUP_KEY: null,
       },
-      REQ_REP_test2: {
-        KEY: 'test2',
-        NAME: 'test2',
+      REQ_REP_source2_alias2: {
+        KEY: 'alias2',
+        NAME: 'source2',
         INPUT_TYPE: 'REQ_REP',
         OUTPUT_TYPE: 'TABLE',
         TRANSFORMER_CONFIGURATION: {},
+        GROUPING_STRATEGY: 'NONE',
+        GROUP_KEY: null,
       },
     },
   };
@@ -86,19 +92,23 @@ ValidateDatasourceConfig(
         DOCUMENT_TEMPLATE_ID: 'template1',
       },
       datasourceConfig: {
-        REQ_REP_test1: {
-          KEY: 'test1',
-          NAME: 'test1',
+        REQ_REP_source1_alias1: {
+          KEY: 'alias1',
+          NAME: 'source1',
           INPUT_TYPE: 'REQ_REP',
           OUTPUT_TYPE: 'TABLE',
           TRANSFORMER_CONFIGURATION: {},
+          GROUPING_STRATEGY: 'NONE',
+          GROUP_KEY: null,
         },
-        REQ_REP_test2: {
-          KEY: 'test2',
-          NAME: 'test2',
+        REQ_REP_source2_alias2: {
+          KEY: 'alias2',
+          NAME: 'source2',
           INPUT_TYPE: 'REQ_REP',
           OUTPUT_TYPE: 'TABLE',
           TRANSFORMER_CONFIGURATION: {},
+          GROUPING_STRATEGY: 'NONE',
+          GROUP_KEY: null,
         },
       },
     };
@@ -120,19 +130,23 @@ ValidateDatasourceConfig(
         DOCUMENT_TEMPLATE_ID: undefined,
       },
       datasourceConfig: {
-        REQ_REP_test1: {
-          KEY: 'test1',
-          NAME: 'test1',
+        REQ_REP_source1_alias1: {
+          KEY: 'alias1',
+          NAME: 'source1',
           INPUT_TYPE: 'REQ_REP',
           OUTPUT_TYPE: 'TABLE',
           TRANSFORMER_CONFIGURATION: {},
+          GROUPING_STRATEGY: 'NONE',
+          GROUP_KEY: null,
         },
-        REQ_REP_test2: {
-          KEY: 'test2',
-          NAME: 'test2',
+        REQ_REP_source2_alias2: {
+          KEY: 'alias2',
+          NAME: 'source2',
           INPUT_TYPE: 'REQ_REP',
           OUTPUT_TYPE: 'TABLE',
           TRANSFORMER_CONFIGURATION: {},
+          GROUPING_STRATEGY: 'NONE',
+          GROUP_KEY: null,
         },
       },
     };