[Fix] [GRAFX-4154] Adjust output settings interface by replacing outp…

…utType with dataSourceEnabled (#270)
chili-publish · Jan 31, 2025 · a5fe48a · a5fe48a
1 parent 9b9ba63
commit a5fe48a
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 27 deletions.
diff --git a/__mocks__/mockOutputSetting.ts b/__mocks__/mockOutputSetting.ts
@@ -1,5 +1,4 @@
 import { DownloadFormats } from '@chili-publish/studio-sdk';
-import { OutputType } from '../src/utils/ApiTypes';
 
 export const mockOutputSetting = {
     id: '1',
@@ -10,7 +9,7 @@ export const mockOutputSetting = {
     maxFileSizeInKiloBytes: 120,
     scaling: 1.5,
     watermark: true,
-    outputType: OutputType.Single,
+    dataSourceEnabled: false,
 };
 
 export const mockOutputSetting2 = {
@@ -22,5 +21,5 @@ export const mockOutputSetting2 = {
     maxFileSizeInKiloBytes: 120,
     scaling: 1.5,
     watermark: true,
-    outputType: OutputType.Single,
+    dataSourceEnabled: false,
 };
diff --git a/src/contexts/UiConfigContext.tsx b/src/contexts/UiConfigContext.tsx
@@ -7,7 +7,6 @@ import {
     defaultOutputSettings,
     defaultUiOptions,
 } from '../types/types';
-import { OutputType } from '../utils/ApiTypes';
 import { useAppContext } from './AppProvider';
 import { IUiConfigContext } from './UiConfigContext.types';
 
@@ -61,7 +60,7 @@ export function UiConfigContextProvider({
                             val.layoutIntents.includes(layoutIntent ?? ''),
                         );
 
-                        settings = dataSource ? settings : settings?.filter((s) => s.outputType !== OutputType.Batch);
+                        settings = dataSource ? settings : settings?.filter((s) => !s.dataSourceEnabled);
                         setUserInterfaceOutputSettings(settings ?? null);
                         setSelectedUserInterfaceId(res?.userInterface?.id || null);
                     });

diff --git a/src/tests/navbar/Navbar.test.tsx b/src/tests/navbar/Navbar.test.tsx
@@ -7,7 +7,6 @@ import Navbar from '../../components/navbar/Navbar';
 import AppProvider from '../../contexts/AppProvider';
 import * as UiConfigContext from '../../contexts/UiConfigContext';
 import { ProjectConfig, defaultOutputSettings, defaultPlatformUiOptions } from '../../types/types';
-import { OutputType } from '../../utils/ApiTypes';
 import { APP_WRAPPER_ID } from '../../utils/constants';
 import { getDataTestIdForSUI } from '../../utils/dataIds';
 
@@ -181,15 +180,15 @@ describe('Navbar', () => {
                             description: 'some decs',
                             type: DownloadFormats.MP4,
                             layoutIntents: ['digitalAnimated'],
-                            outputType: OutputType.Single,
+                            dataSourceEnabled: false,
                         },
                         {
                             name: 'user interface GIF',
                             id: '2',
                             description: 'some decs',
                             type: DownloadFormats.MP4,
                             layoutIntents: ['digitalAnimated'],
-                            outputType: OutputType.Single,
+                            dataSourceEnabled: false,
                         },
                     ],
                 }),
@@ -243,15 +242,15 @@ describe('Navbar', () => {
                             description: 'some decs',
                             type: DownloadFormats.PDF,
                             layoutIntents: ['print'],
-                            outputType: OutputType.Batch,
+                            dataSourceEnabled: true,
                         },
                         {
                             name: 'Single for PDF',
                             id: '1',
                             description: 'some decs',
                             type: DownloadFormats.PDF,
                             layoutIntents: ['print'],
-                            outputType: OutputType.Single,
+                            dataSourceEnabled: false,
                         },
                     ],
                 }),
@@ -302,15 +301,15 @@ describe('Navbar', () => {
                             description: 'some decs',
                             type: DownloadFormats.PDF,
                             layoutIntents: ['print'],
-                            outputType: OutputType.Batch,
+                            dataSourceEnabled: true,
                         },
                         {
                             name: 'Single for PDF',
                             id: '1',
                             description: 'some decs',
                             type: DownloadFormats.PDF,
                             layoutIntents: ['print'],
-                            outputType: OutputType.Single,
+                            dataSourceEnabled: false,
                         },
                     ],
                 }),

diff --git a/src/tests/navbar/useDownload.test.tsx b/src/tests/navbar/useDownload.test.tsx
@@ -2,7 +2,6 @@ import { DownloadFormats } from '@chili-publish/studio-sdk';
 import { renderHook } from '@testing-library/react';
 import useDownload from '../../components/navbar/downloadPanel/useDownload';
 import * as UiConfigContext from '../../contexts/UiConfigContext';
-import { OutputType } from '../../utils/ApiTypes';
 
 describe('useDownload', () => {
     test('default download options show all download options', () => {
@@ -60,15 +59,15 @@ describe('useDownload', () => {
                         description: 'some decs',
                         type: DownloadFormats.MP4,
                         layoutIntents: ['digitalAnimated'],
-                        outputType: OutputType.Single,
+                        dataSourceEnabled: false,
                     },
                     {
                         name: 'GIF',
                         id: '2',
                         description: 'some decs',
                         type: DownloadFormats.MP4,
                         layoutIntents: ['digitalAnimated'],
-                        outputType: OutputType.Single,
+                        dataSourceEnabled: false,
                     },
                 ],
             };

diff --git a/src/tests/utils/documentExportHelper.test.tsx b/src/tests/utils/documentExportHelper.test.tsx
@@ -1,6 +1,5 @@
 import { DownloadFormats } from '@chili-publish/studio-sdk';
 import axios from 'axios';
-import { OutputType } from '../../utils/ApiTypes';
 import { addTrailingSlash, getDownloadLink } from '../../utils/documentExportHelper';
 
 jest.mock('axios');
@@ -155,7 +154,7 @@ describe('"getDownloadLink', () => {
         it('should send data source', async () => {
             (axios.get as jest.Mock).mockResolvedValue({
                 data: {
-                    outputType: OutputType.Batch,
+                    dataSourceEnabled: true,
                 },
             });
             await getDownloadLink(DownloadFormats.PDF, '', 'Token', '1', 'projectId', 'outputId', false);

diff --git a/src/types/types.ts b/src/types/types.ts
@@ -1,7 +1,6 @@
 import { ITheme, UiThemeConfig } from '@chili-publish/grafx-shared-components';
 import { DownloadFormats } from '@chili-publish/studio-sdk';
 import { AxiosError, AxiosResponse } from 'axios';
-import { OutputType } from '../utils/ApiTypes';
 import { ConnectorAuthenticationResult } from './ConnectorAuthenticationResult';
 
 export type FeatureFlagsType = Record<string, boolean>;
@@ -106,7 +105,7 @@ export type UserInterfaceOutputSettings = {
     id: string;
     description: string;
     type: DownloadFormats;
-    outputType: OutputType;
+    dataSourceEnabled: boolean;
     layoutIntents: string[];
 };
 

diff --git a/src/utils/ApiTypes.ts b/src/utils/ApiTypes.ts
@@ -16,11 +16,6 @@ export enum AssetTypeToString {
     FOLDER = 'Folder',
 }
 
-export enum OutputType {
-    Single = 'single',
-    Batch = 'batch',
-}
-
 // It partially describe the API Connector Entity
 // https://main.cpstaging.online/grafx/swagger/index.html?urls.primaryName=experimental#/Connectors/get_api_experimental_environment__environment__connectors__connectorId_
 export type RemoteConnector = {

diff --git a/src/utils/documentExportHelper.ts b/src/utils/documentExportHelper.ts
@@ -2,7 +2,6 @@ import { DownloadFormats, Id } from '@chili-publish/studio-sdk';
 import axios from 'axios';
 import { DataConnectorConfiguration } from '../types/OutputGenerationTypes';
 import { DownloadLinkResult } from '../types/types';
-import { OutputType } from './ApiTypes';
 import { getConnectorConfigurationOptions, getEnvId } from './connectors';
 
 type HttpHeaders = { method: string; body: string | null; headers: { 'Content-Type': string; Authorization?: string } };
@@ -156,7 +155,7 @@ const getDataSourceConfig = async (
         return undefined;
     }
 
-    const { data: setting } = await axios.get<{ outputType: OutputType }>(
+    const { data: setting } = await axios.get<{ dataSourceEnabled: boolean }>(
         `${baseUrl}/output/settings/${outputSettingsId}`,
         {
             headers: {
@@ -165,7 +164,7 @@ const getDataSourceConfig = async (
             },
         },
     );
-    if (setting.outputType !== OutputType.Batch) {
+    if (!setting.dataSourceEnabled) {
         return undefined;
     }
     return {