@orchestrator-ui/orchestrator-ui-components 7.4.1 → 7.5.1

package/src/utils/cacheTag.spec.ts

@@ -3,12 +3,12 @@ import { CacheTagType } from '@/types';
 import { getCacheTag } from './cacheTag';
 
 describe('getCacheTag', () => {
-    it('returns cacheTag with type only when no id is passed', () => {
-        const result = getCacheTag(CacheTagType.processes);
-        expect(result).toEqual([{ type: CacheTagType.processes }]);
-    });
-    it('returns cacheTag with type and id if id is passed', () => {
-        const result = getCacheTag(CacheTagType.processes, '123');
-        expect(result).toEqual([{ type: CacheTagType.processes, id: '123' }]);
-    });
+  it('returns cacheTag with type only when no id is passed', () => {
+    const result = getCacheTag(CacheTagType.processes);
+    expect(result).toEqual([{ type: CacheTagType.processes }]);
+  });
+  it('returns cacheTag with type and id if id is passed', () => {
+    const result = getCacheTag(CacheTagType.processes, '123');
+    expect(result).toEqual([{ type: CacheTagType.processes, id: '123' }]);
+  });
 });

package/src/utils/cacheTag.ts

@@ -1,11 +1,11 @@
 import { CacheTag, CacheTagType } from '@/types';
 
 export const getCacheTag = (type: CacheTagType, id?: string): CacheTag[] => {
-    const cacheTag: CacheTag = {
-        type,
-    };
-    if (id) {
-        cacheTag.id = id;
-    }
-    return [cacheTag];
+  const cacheTag: CacheTag = {
+    type,
+  };
+  if (id) {
+    cacheTag.id = id;
+  }
+  return [cacheTag];
 };

package/src/utils/compareVersions.spec.ts

@@ -3,127 +3,49 @@ import { MappedVersion } from '@/types';
 import { getOrchestratorCoreVersionIfNotCompatible } from './compareVersions';
 
 const TEST_VERSIONS: MappedVersion[] = [
-    {
-        orchestratorUiVersion: '3.4.0',
-        minimumOrchestratorCoreVersion: '2.10.0',
-        changes: 'Endpoints in BE to modify description on metadata pages',
-    },
-    {
-        orchestratorUiVersion: '3.8.1',
-        minimumOrchestratorCoreVersion: '3.0.0',
-        changes: 'Endpoints in BE to modify description on metadata pages',
-    },
-    {
-        orchestratorUiVersion: '3.10.0',
-        minimumOrchestratorCoreVersion: '3.1.1',
-        changes: 'Endpoints in BE to modify description on metadata pages',
-    },
+  {
+    orchestratorUiVersion: '3.4.0',
+    minimumOrchestratorCoreVersion: '2.10.0',
+    changes: 'Endpoints in BE to modify description on metadata pages',
+  },
+  {
+    orchestratorUiVersion: '3.8.1',
+    minimumOrchestratorCoreVersion: '3.0.0',
+    changes: 'Endpoints in BE to modify description on metadata pages',
+  },
+  {
+    orchestratorUiVersion: '3.10.0',
+    minimumOrchestratorCoreVersion: '3.1.1',
+    changes: 'Endpoints in BE to modify description on metadata pages',
+  },
 ];
 
 describe('isOrchestratorUiVersionCompatible', () => {
-    test('returns true if orchestratorCoreVersion matches exactly the minimum required orchestratorCoreVersion', () => {
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.4.0',
-                '2.10.0',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null);
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.8.1',
-                '3.0.0',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null);
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.10.0',
-                '3.1.1',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null);
-    });
+  test('returns true if orchestratorCoreVersion matches exactly the minimum required orchestratorCoreVersion', () => {
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.4.0', '2.10.0', TEST_VERSIONS)).toBe(null);
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.8.1', '3.0.0', TEST_VERSIONS)).toBe(null);
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.10.0', '3.1.1', TEST_VERSIONS)).toBe(null);
+  });
 
-    test('returns true if orchestratorCoreVersion is newer than the minimum required orchestratorCoreVersion', () => {
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.4.0',
-                '2.11.0',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null);
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.8.1',
-                '3.0.1',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null);
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.10.0',
-                '4.2.0',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null);
-    });
+  test('returns true if orchestratorCoreVersion is newer than the minimum required orchestratorCoreVersion', () => {
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.4.0', '2.11.0', TEST_VERSIONS)).toBe(null);
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.8.1', '3.0.1', TEST_VERSIONS)).toBe(null);
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.10.0', '4.2.0', TEST_VERSIONS)).toBe(null);
+  });
 
-    test('returns false if orchestratorCoreVersion is older than minimum required orchestratorCoreVersion', () => {
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.4.0',
-                '2.9.9',
-                TEST_VERSIONS,
-            ),
-        ).toBe('2.10.0');
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.8.1',
-                '2.10.9',
-                TEST_VERSIONS,
-            ),
-        ).toBe('3.0.0');
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.10.0',
-                '3.0.5',
-                TEST_VERSIONS,
-            ),
-        ).toBe('3.1.1');
-    });
+  test('returns false if orchestratorCoreVersion is older than minimum required orchestratorCoreVersion', () => {
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.4.0', '2.9.9', TEST_VERSIONS)).toBe('2.10.0');
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.8.1', '2.10.9', TEST_VERSIONS)).toBe('3.0.0');
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.10.0', '3.0.5', TEST_VERSIONS)).toBe('3.1.1');
+  });
 
-    test('handles orchestratorUiVersions not exactly in MAPPED_VERSIONS by selecting previous compatible minimum version', () => {
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.9.0',
-                '3.0.0',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null); // nearest lower mapped version is 3.8.1
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '3.11.0',
-                '3.1.1',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null); // nearest lower mapped is 3.10.0
-    });
+  test('handles orchestratorUiVersions not exactly in MAPPED_VERSIONS by selecting previous compatible minimum version', () => {
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.9.0', '3.0.0', TEST_VERSIONS)).toBe(null); // nearest lower mapped version is 3.8.1
+    expect(getOrchestratorCoreVersionIfNotCompatible('3.11.0', '3.1.1', TEST_VERSIONS)).toBe(null); // nearest lower mapped is 3.10.0
+  });
 
-    test('handles orchestratorUiVersions lower than lowest mapped version', () => {
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '1.0.0',
-                '2.10.0',
-                TEST_VERSIONS,
-            ),
-        ).toBe(null); // falls back to first MAPPED_VERSION
-        expect(
-            getOrchestratorCoreVersionIfNotCompatible(
-                '1.0.0',
-                '2.9.9',
-                TEST_VERSIONS,
-            ),
-        ).toBe('2.10.0');
-    });
+  test('handles orchestratorUiVersions lower than lowest mapped version', () => {
+    expect(getOrchestratorCoreVersionIfNotCompatible('1.0.0', '2.10.0', TEST_VERSIONS)).toBe(null); // falls back to first MAPPED_VERSION
+    expect(getOrchestratorCoreVersionIfNotCompatible('1.0.0', '2.9.9', TEST_VERSIONS)).toBe('2.10.0');
+  });
 });

package/src/utils/compareVersions.ts

@@ -1,64 +1,44 @@
 import { MappedVersion } from '@/types';
 
-const compareVersions = (
-    versionString1: string,
-    versionString2: string,
-): number => {
-    const splittedVersion1 = versionString1.split('.');
-    const splittedVersion2 = versionString2.split('.');
+const compareVersions = (versionString1: string, versionString2: string): number => {
+  const splittedVersion1 = versionString1.split('.');
+  const splittedVersion2 = versionString2.split('.');
 
-    for (let i = 0; i < splittedVersion1.length; i++) {
-        if (parseInt(splittedVersion1[i]) > parseInt(splittedVersion2[i])) {
-            return 1;
-        } else if (
-            parseInt(splittedVersion1[i]) < parseInt(splittedVersion2[i])
-        ) {
-            return -1;
-        }
+  for (let i = 0; i < splittedVersion1.length; i++) {
+    if (parseInt(splittedVersion1[i]) > parseInt(splittedVersion2[i])) {
+      return 1;
+    } else if (parseInt(splittedVersion1[i]) < parseInt(splittedVersion2[i])) {
+      return -1;
     }
-    return 0;
+  }
+  return 0;
 };
 
 const findMinimumOrchestratorCoreVersion = (
-    orchestratorUiVersion: string,
-    versionMappings: MappedVersion[],
+  orchestratorUiVersion: string,
+  versionMappings: MappedVersion[],
 ): string => {
-    const orchestratorUiVersions = versionMappings.map(
-        (version) => version.orchestratorUiVersion,
-    );
-    let mappedVersion = versionMappings[0];
+  const orchestratorUiVersions = versionMappings.map((version) => version.orchestratorUiVersion);
+  let mappedVersion = versionMappings[0];
 
-    for (let i = 0; i < orchestratorUiVersions.length; i++) {
-        if (
-            [0, 1].includes(
-                compareVersions(
-                    orchestratorUiVersion,
-                    orchestratorUiVersions[i],
-                ),
-            )
-        ) {
-            mappedVersion = versionMappings[i];
-        }
+  for (let i = 0; i < orchestratorUiVersions.length; i++) {
+    if ([0, 1].includes(compareVersions(orchestratorUiVersion, orchestratorUiVersions[i]))) {
+      mappedVersion = versionMappings[i];
     }
+  }
 
-    return mappedVersion.minimumOrchestratorCoreVersion;
+  return mappedVersion.minimumOrchestratorCoreVersion;
 };
 
 export const getOrchestratorCoreVersionIfNotCompatible = (
-    orchestratorUiVersion: string,
-    orchestratorCoreVersion: string,
-    versionMappings: MappedVersion[],
+  orchestratorUiVersion: string,
+  orchestratorCoreVersion: string,
+  versionMappings: MappedVersion[],
 ): string | null => {
-    const minimumOrchestratorCoreVersion = findMinimumOrchestratorCoreVersion(
-        orchestratorUiVersion,
-        versionMappings,
-    );
-    const comparison = compareVersions(
-        orchestratorCoreVersion,
-        minimumOrchestratorCoreVersion,
-    );
-    if (comparison === -1) {
-        return minimumOrchestratorCoreVersion;
-    }
-    return null;
+  const minimumOrchestratorCoreVersion = findMinimumOrchestratorCoreVersion(orchestratorUiVersion, versionMappings);
+  const comparison = compareVersions(orchestratorCoreVersion, minimumOrchestratorCoreVersion);
+  if (comparison === -1) {
+    return minimumOrchestratorCoreVersion;
+  }
+  return null;
 };

package/src/utils/csvDownload.ts

@@ -5,112 +5,97 @@ import { GraphQLPageInfo, ToastTypes } from '@/types';
 import { toObjectWithSerializedValues, toObjectWithSortedKeys } from '@/utils';
 
 function toCsvFileContent<T extends object>(data: T[]): string {
-    const headers = Object.keys(data[0]).join(';');
-    const rows = data.map((row) =>
-        Object.values(row)
-            .map((value) => (value === null ? '' : `"${value}"`))
-            .join(';')
-            .split('\n')
-            .join(' '),
-    );
-    return [headers, ...rows].join('\n');
+  const headers = Object.keys(data[0]).join(';');
+  const rows = data.map((row) =>
+    Object.values(row)
+      .map((value) => (value === null ? '' : `"${value}"`))
+      .join(';')
+      .split('\n')
+      .join(' '),
+  );
+  return [headers, ...rows].join('\n');
 }
 
 function startCsvDownload(csvFileContent: string, fileName: string) {
-    const blob = new Blob([csvFileContent], { type: 'text/csv' });
-    const url = URL.createObjectURL(blob);
-    const link = document.createElement('a');
-    link.href = url;
-    link.download = fileName.endsWith('.csv') ? fileName : `${fileName}.csv`;
-    link.click();
-    URL.revokeObjectURL(url);
+  const blob = new Blob([csvFileContent], { type: 'text/csv' });
+  const url = URL.createObjectURL(blob);
+  const link = document.createElement('a');
+  link.href = url;
+  link.download = fileName.endsWith('.csv') ? fileName : `${fileName}.csv`;
+  link.click();
+  URL.revokeObjectURL(url);
 }
 
-function totalItemsExceedMaximumItemsForBulkFetching(
-    totalItems?: number | null,
-) {
-    return (totalItems ?? 0) > MAXIMUM_ITEMS_FOR_BULK_FETCHING;
+function totalItemsExceedMaximumItemsForBulkFetching(totalItems?: number | null) {
+  return (totalItems ?? 0) > MAXIMUM_ITEMS_FOR_BULK_FETCHING;
 }
 
 // This function should be used when the data is mapped and ready to be exported
-export function initiateCsvFileDownload<T extends object>(
-    data: T[],
-    keyOrder: string[],
-    fileName: string,
-) {
-    const dataForExport = data.map((dataRow) =>
-        toObjectWithSortedKeys(toObjectWithSerializedValues(dataRow), keyOrder),
-    );
+export function initiateCsvFileDownload<T extends object>(data: T[], keyOrder: string[], fileName: string) {
+  const dataForExport = data.map((dataRow) => toObjectWithSortedKeys(toObjectWithSerializedValues(dataRow), keyOrder));
 
-    const csvFileContent = toCsvFileContent(dataForExport);
-    startCsvDownload(csvFileContent, fileName);
+  const csvFileContent = toCsvFileContent(dataForExport);
+  startCsvDownload(csvFileContent, fileName);
 }
 
 export const getCsvFileNameWithDate = (fileNameWithoutExtension: string) => {
-    const date = new Date();
-    const year = date.getFullYear();
-    const month = (date.getMonth() + 1).toString().padStart(2, '0');
-    const day = date.getDate();
+  const date = new Date();
+  const year = date.getFullYear();
+  const month = (date.getMonth() + 1).toString().padStart(2, '0');
+  const day = date.getDate();
 
-    const hour = date.getHours();
-    const minute = date.getMinutes();
-    const second = date.getSeconds();
+  const hour = date.getHours();
+  const minute = date.getMinutes();
+  const second = date.getSeconds();
 
-    return `${fileNameWithoutExtension}_${year}-${month}-${day}-${hour}${minute}${second}.csv`;
+  return `${fileNameWithoutExtension}_${year}-${month}-${day}-${hour}${minute}${second}.csv`;
 };
 
 // This async function should be used when the exported data needs to be fetched from somewhere else
 export const csvDownloadHandler =
-    <T extends object, U extends object>(
-        dataFetchFunction: () => Promise<T | undefined>,
-        dataMapper: (data: T) => U[],
-        pageInfoMapper: (data: T) => GraphQLPageInfo,
-        keyOrder: string[],
-        filename: string,
-        addToastFunction: (
-            type: ToastTypes,
-            text: string,
-            title: string,
-        ) => void,
-        translationFunction: (
-            translationKey: string,
-            variables?: TranslationValues,
-        ) => string,
-    ) =>
-    async () => {
-        const fetchResult: T | undefined = await dataFetchFunction();
+  <T extends object, U extends object>(
+    dataFetchFunction: () => Promise<T | undefined>,
+    dataMapper: (data: T) => U[],
+    pageInfoMapper: (data: T) => GraphQLPageInfo,
+    keyOrder: string[],
+    filename: string,
+    addToastFunction: (type: ToastTypes, text: string, title: string) => void,
+    translationFunction: (translationKey: string, variables?: TranslationValues) => string,
+  ) =>
+  async () => {
+    const fetchResult: T | undefined = await dataFetchFunction();
 
-        if (!fetchResult) {
-            return;
-        }
+    if (!fetchResult) {
+      return;
+    }
 
-        const data = dataMapper(fetchResult);
-        const pageInfo = pageInfoMapper(fetchResult);
+    const data = dataMapper(fetchResult);
+    const pageInfo = pageInfoMapper(fetchResult);
 
-        if (totalItemsExceedMaximumItemsForBulkFetching(pageInfo.totalItems)) {
-            addToastFunction(
-                ToastTypes.ERROR,
-                translationFunction('notAllResultsExported', {
-                    totalResults: pageInfo.totalItems,
-                    maximumExportedResults: MAXIMUM_ITEMS_FOR_BULK_FETCHING,
-                }),
-                translationFunction('notAllResultsExportedTitle'),
-            );
-        }
+    if (totalItemsExceedMaximumItemsForBulkFetching(pageInfo.totalItems)) {
+      addToastFunction(
+        ToastTypes.ERROR,
+        translationFunction('notAllResultsExported', {
+          totalResults: pageInfo.totalItems,
+          maximumExportedResults: MAXIMUM_ITEMS_FOR_BULK_FETCHING,
+        }),
+        translationFunction('notAllResultsExportedTitle'),
+      );
+    }
 
-        initiateCsvFileDownload(data, keyOrder, filename);
-    };
+    initiateCsvFileDownload(data, keyOrder, filename);
+  };
 
 export const getPageInfoForSyncExport = (
-    dataLength: number,
-    sortFields?: string[],
-    filterFields?: string[],
+  dataLength: number,
+  sortFields?: string[],
+  filterFields?: string[],
 ): GraphQLPageInfo => ({
-    startCursor: 0,
-    endCursor: Math.max(0, dataLength - 1),
-    hasNextPage: false,
-    totalItems: dataLength,
-    hasPreviousPage: false,
-    sortFields: sortFields ?? [],
-    filterFields: filterFields ?? [],
+  startCursor: 0,
+  endCursor: Math.max(0, dataLength - 1),
+  hasNextPage: false,
+  totalItems: dataLength,
+  hasPreviousPage: false,
+  sortFields: sortFields ?? [],
+  filterFields: filterFields ?? [],
 });