@dhis2/analytics 26.13.3 → 27.0.0

package/build/cjs/modules/visTypes.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.visTypeIcons = exports.visTypeDisplayNames = exports.isYearOverYear = exports.isVerticalType = exports.isTwoCategoryChartType = exports.isStacked = exports.isSingleValue = exports.isOutlierTable = exports.isMultiType = exports.isLegendSetType = exports.isDualAxisType = exports.isColumnBasedType = exports.getDisplayNameByVisType = exports.defaultVisType = exports.VIS_TYPE_YEAR_OVER_YEAR_LINE = exports.VIS_TYPE_YEAR_OVER_YEAR_COLUMN = exports.VIS_TYPE_STACKED_COLUMN = exports.VIS_TYPE_STACKED_BAR = exports.VIS_TYPE_STACKED_AREA = exports.VIS_TYPE_SINGLE_VALUE = exports.VIS_TYPE_SCATTER = exports.VIS_TYPE_RADAR = exports.VIS_TYPE_PIVOT_TABLE = exports.VIS_TYPE_PIE = exports.VIS_TYPE_OUTLIER_TABLE = exports.VIS_TYPE_LINE_LIST = exports.VIS_TYPE_LINE = exports.VIS_TYPE_GROUP_CHARTS = exports.VIS_TYPE_GROUP_ALL = exports.VIS_TYPE_GAUGE = exports.VIS_TYPE_COLUMN = exports.VIS_TYPE_BUBBLE = exports.VIS_TYPE_BAR = exports.VIS_TYPE_AREA = void 0;
+exports.visTypeIcons = exports.visTypeDisplayNames = exports.isYearOverYear = exports.isVerticalType = exports.isTwoCategoryChartType = exports.isStacked = exports.isSingleValue = exports.isOutlierTable = exports.isMultiType = exports.isLegendSetType = exports.isDualAxisType = exports.isColumnBasedType = exports.getDisplayNameByVisType = exports.getApiEndpointByVisType = exports.defaultVisType = exports.VIS_TYPE_YEAR_OVER_YEAR_LINE = exports.VIS_TYPE_YEAR_OVER_YEAR_COLUMN = exports.VIS_TYPE_STACKED_COLUMN = exports.VIS_TYPE_STACKED_BAR = exports.VIS_TYPE_STACKED_AREA = exports.VIS_TYPE_SINGLE_VALUE = exports.VIS_TYPE_SCATTER = exports.VIS_TYPE_RADAR = exports.VIS_TYPE_PIVOT_TABLE = exports.VIS_TYPE_PIE = exports.VIS_TYPE_OUTLIER_TABLE = exports.VIS_TYPE_MAP = exports.VIS_TYPE_LINE_LIST = exports.VIS_TYPE_LINE = exports.VIS_TYPE_GROUP_CHARTS = exports.VIS_TYPE_GROUP_ALL = exports.VIS_TYPE_GAUGE = exports.VIS_TYPE_COLUMN = exports.VIS_TYPE_BUBBLE = exports.VIS_TYPE_BAR = exports.VIS_TYPE_AREA = void 0;
 var _ui = require("@dhis2/ui");
 var _index = _interopRequireDefault(require("../locales/index.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -27,6 +27,7 @@ const VIS_TYPE_BUBBLE = exports.VIS_TYPE_BUBBLE = 'BUBBLE';
 const VIS_TYPE_GROUP_ALL = exports.VIS_TYPE_GROUP_ALL = 'ALL';
 const VIS_TYPE_GROUP_CHARTS = exports.VIS_TYPE_GROUP_CHARTS = 'CHARTS';
 const VIS_TYPE_OUTLIER_TABLE = exports.VIS_TYPE_OUTLIER_TABLE = 'OUTLIER_TABLE';
+const VIS_TYPE_MAP = exports.VIS_TYPE_MAP = 'MAP';
 const visTypeDisplayNames = exports.visTypeDisplayNames = {
   [VIS_TYPE_PIVOT_TABLE]: _index.default.t('Pivot table'),
   [VIS_TYPE_AREA]: _index.default.t('Area'),
@@ -46,7 +47,8 @@ const visTypeDisplayNames = exports.visTypeDisplayNames = {
   [VIS_TYPE_SINGLE_VALUE]: _index.default.t('Single value'),
   [VIS_TYPE_OUTLIER_TABLE]: _index.default.t('Outlier table'),
   [VIS_TYPE_GROUP_ALL]: _index.default.t('All types'),
-  [VIS_TYPE_GROUP_CHARTS]: _index.default.t('All charts')
+  [VIS_TYPE_GROUP_CHARTS]: _index.default.t('All charts'),
+  [VIS_TYPE_MAP]: _index.default.t('Map')
 };
 const visTypeIcons = exports.visTypeIcons = {
   [VIS_TYPE_PIVOT_TABLE]: _ui.IconVisualizationPivotTable24,
@@ -67,6 +69,26 @@ const visTypeIcons = exports.visTypeIcons = {
   [VIS_TYPE_SINGLE_VALUE]: _ui.IconVisualizationSingleValue24,
   [VIS_TYPE_OUTLIER_TABLE]: _ui.IconVisualizationOutlierTable24
 };
+const visTypeApiEndpoints = {
+  [VIS_TYPE_PIVOT_TABLE]: 'visualizations',
+  [VIS_TYPE_AREA]: 'visualizations',
+  [VIS_TYPE_STACKED_AREA]: 'visualizations',
+  [VIS_TYPE_BAR]: 'visualizations',
+  [VIS_TYPE_STACKED_BAR]: 'visualizations',
+  [VIS_TYPE_COLUMN]: 'visualizations',
+  [VIS_TYPE_YEAR_OVER_YEAR_COLUMN]: 'visualizations',
+  [VIS_TYPE_STACKED_COLUMN]: 'visualizations',
+  [VIS_TYPE_GAUGE]: 'visualizations',
+  [VIS_TYPE_LINE]: 'visualizations',
+  [VIS_TYPE_YEAR_OVER_YEAR_LINE]: 'visualizations',
+  [VIS_TYPE_PIE]: 'visualizations',
+  [VIS_TYPE_RADAR]: 'visualizations',
+  [VIS_TYPE_SCATTER]: 'visualizations',
+  [VIS_TYPE_SINGLE_VALUE]: 'visualizations',
+  [VIS_TYPE_OUTLIER_TABLE]: 'visualizations',
+  [VIS_TYPE_LINE_LIST]: 'eventVisualizations',
+  [VIS_TYPE_MAP]: 'maps'
+};
 const getDisplayNameByVisType = visType => {
   const displayName = visTypeDisplayNames[visType];
   if (!displayName) {
@@ -75,6 +97,14 @@ const getDisplayNameByVisType = visType => {
   return displayName;
 };
 exports.getDisplayNameByVisType = getDisplayNameByVisType;
+const getApiEndpointByVisType = visType => {
+  const apiEndpoint = visTypeApiEndpoints[visType];
+  if (!apiEndpoint) {
+    throw new Error(`${visType} is not a valid visualization type`);
+  }
+  return apiEndpoint;
+};
+exports.getApiEndpointByVisType = getApiEndpointByVisType;
 const stackedTypes = [VIS_TYPE_STACKED_COLUMN, VIS_TYPE_STACKED_BAR, VIS_TYPE_STACKED_AREA];
 const yearOverYearTypes = [VIS_TYPE_YEAR_OVER_YEAR_LINE, VIS_TYPE_YEAR_OVER_YEAR_COLUMN];
 const dualAxisTypes = [VIS_TYPE_COLUMN, VIS_TYPE_BAR, VIS_TYPE_LINE, VIS_TYPE_AREA];

package/build/cjs/visualizations/util/__tests__/getFilterText.spec.js

@@ -114,24 +114,20 @@ describe('getFilterText', () => {
       filters.push({
         dimension: 'pe',
         items: [{
-          id: '_LAST_2_MONTHS_',
-          name: 'Last 2 months'
+          id: '201801'
+        }, {
+          id: 'LAST_3_MONTHS'
+        }, {
+          id: 'LAST_MONTH'
         }]
       });
-      metaData.dimensions.pe = ['_201801_', '_201802_'];
-      metaData.items._LAST_2_MONTHS_ = {
-        name: 'Last 2 months',
-        uid: '_LAST_2_MONTHS_'
-      };
-      metaData.items._201801_ = {
-        name: '01 of 2018',
-        uid: '_201801_'
+      metaData.dimensions.pe = ['202501', '202502', '202503', '202504', '201801'];
+      metaData.items['201801'] = {
+        name: 'January 2018'
       };
-      metaData.items._201802_ = {
-        name: '02 of 2018',
-        uid: '_201802_'
-      };
-      expect((0, _getFilterText.default)(filters, metaData)).toEqual('Clinics, Hospital - 01 of 2018, 02 of 2018');
+
+      // Relative period names come from relativePeriods.js
+      expect((0, _getFilterText.default)(filters, metaData)).toEqual('Clinics, Hospital - January 2018, Last 3 months, Last month');
     });
   });
 });

package/build/cjs/visualizations/util/getFilterText.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
+var _relativePeriods = require("../../components/PeriodDimension/utils/relativePeriods.js");
 var _getOuLevelAndGroupText = require("../../modules/getOuLevelAndGroupText.js");
+var _dimensionGetItemIds = require("../../modules/layout/dimensionGetItemIds.js");
 var _dimensionGetItems = require("../../modules/layout/dimensionGetItems.js");
 var _dimensionIs = require("../../modules/layout/dimensionIs.js");
 var _index = require("../../modules/ouIdHelper/index.js");
@@ -25,6 +27,12 @@ function _default(filters, metaData) {
       return _index.ouIdHelper.hasGroupPrefix(id) || _index.ouIdHelper.hasLevelPrefix(id);
     })) {
       titleFragments.push((0, _getOuLevelAndGroupText.getOuLevelAndGroupText)(filter, metaData));
+    } else if ((0, _dimensionIs.dimensionIs)(filter, _predefinedDimensions.DIMENSION_ID_PERIOD)) {
+      const relativePeriodNames = (0, _relativePeriods.getRelativePeriodsName)();
+      titleFragments.push((0, _dimensionGetItemIds.dimensionGetItemIds)(filter).map(id => {
+        var _metaData$items$id;
+        return relativePeriodNames[id] || ((_metaData$items$id = metaData.items[id]) === null || _metaData$items$id === void 0 ? void 0 : _metaData$items$id.name) || id;
+      }).join(', '));
     } else {
       const filterItems = metaData.dimensions[filter.dimension];
       if (Array.isArray(filterItems)) {

package/build/es/components/FileMenu/FileMenu.js

@@ -48,8 +48,7 @@ export const FileMenu = _ref => {
           type: fileType,
           object: fileObject,
           onClose: onDialogClose,
-          onRename: onRename,
-          onError: onError
+          onRename: onRename
         });
       case 'translate':
         return /*#__PURE__*/React.createElement(TranslationDialog, {

package/build/es/components/FileMenu/RenameDialog.js

@@ -1,75 +1,25 @@
 import _JSXStyle from "styled-jsx/style";
-import { useDataMutation } from '@dhis2/app-runtime';
 import { Modal, ModalTitle, ModalContent, ModalActions, ButtonStrip, Button, InputField, TextAreaField } from '@dhis2/ui';
 import PropTypes from 'prop-types';
-import React, { useMemo, useState } from 'react';
+import React, { useState } from 'react';
 import i18n from '../../locales/index.js';
 import { modalStyles } from './FileMenu.styles.js';
-import { supportedFileTypes, endpointFromFileType, labelForFileType } from './utils.js';
-const formatPayload = (name, description) => {
-  const payload = [{
-    op: 'add',
-    path: '/name',
-    value: name
-  }];
-  if (description) {
-    payload.push({
-      op: 'add',
-      path: '/description',
-      value: description
-    });
-  }
-  return payload;
-};
-const getMutation = type => ({
-  resource: endpointFromFileType(type),
-  id: _ref => {
-    let {
-      id
-    } = _ref;
-    return id;
-  },
-  type: 'json-patch',
-  data: _ref2 => {
-    let {
-      name,
-      description
-    } = _ref2;
-    return formatPayload(name, description);
-  }
-});
-export const RenameDialog = _ref3 => {
+import { supportedFileTypes, labelForFileType } from './utils.js';
+export const RenameDialog = _ref => {
   let {
     type,
     object,
     onClose,
-    onRename,
-    onError
-  } = _ref3;
+    onRename
+  } = _ref;
   const [name, setName] = useState(object.name);
   const [description, setDescription] = useState(object.description);
-  const mutation = useMemo(() => getMutation(type), [type]);
-  const [mutate, {
-    loading
-  }] = useDataMutation(mutation, {
-    onError: error => {
-      onError(error);
-      onClose();
-    },
-    onComplete: () => {
-      onRename({
-        name,
-        description
-      });
-      onClose();
-    }
-  });
   const renameObject = () => {
-    mutate({
-      id: object.id,
+    onRename({
       name,
       description
     });
+    onClose();
   };
   return /*#__PURE__*/React.createElement(Modal, {
     onClose: onClose,
@@ -82,49 +32,43 @@ export const RenameDialog = _ref3 => {
     className: `jsx-${modalStyles.__hash}` + " " + "modal-content"
   }, /*#__PURE__*/React.createElement(InputField, {
     label: i18n.t('Name'),
-    disabled: loading,
     required: true,
     value: name,
-    onChange: _ref4 => {
+    onChange: _ref2 => {
       let {
         value
-      } = _ref4;
+      } = _ref2;
       return setName(value);
     },
     dataTest: "file-menu-rename-modal-name"
   }), /*#__PURE__*/React.createElement(TextAreaField, {
     label: i18n.t('Description'),
-    disabled: loading,
     value: description,
     rows: 3,
-    onChange: _ref5 => {
+    onChange: _ref3 => {
       let {
         value
-      } = _ref5;
+      } = _ref3;
       return setDescription(value);
     },
     dataTest: "file-menu-rename-modal-description"
   }))), /*#__PURE__*/React.createElement(ModalActions, null, /*#__PURE__*/React.createElement(ButtonStrip, null, /*#__PURE__*/React.createElement(Button, {
     onClick: onClose,
-    disabled: loading,
     secondary: true,
     dataTest: "file-menu-rename-modal-cancel"
   }, i18n.t('Cancel')), /*#__PURE__*/React.createElement(Button, {
     onClick: renameObject,
-    disabled: loading,
     primary: true,
     dataTest: "file-menu-rename-modal-rename"
   }, i18n.t('Rename')))));
 };
 RenameDialog.propTypes = {
-  id: PropTypes.string,
   object: PropTypes.shape({
-    id: PropTypes.string.isRequired,
     description: PropTypes.string,
+    id: PropTypes.string,
     name: PropTypes.string
   }),
   type: PropTypes.oneOf(supportedFileTypes),
   onClose: PropTypes.func,
-  onError: PropTypes.func,
   onRename: PropTypes.func
 };

package/build/es/components/FileMenu/__tests__/RenameDialog.spec.js

@@ -1,51 +1,83 @@
-import { Button, Modal, ModalTitle } from '@dhis2/ui';
-import { shallow } from 'enzyme';
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+import '@testing-library/jest-dom';
+import { render, fireEvent, screen, within } from '@testing-library/react';
 import React from 'react';
 import { RenameDialog } from '../RenameDialog.js';
 describe('The FileMenu - RenameDialog component', () => {
-  let shallowRenameDialog;
-  let props;
   const onClose = jest.fn();
-  const getRenameDialogComponent = props => {
-    if (!shallowRenameDialog) {
-      shallowRenameDialog = shallow(/*#__PURE__*/React.createElement(RenameDialog, props));
-    }
-    return shallowRenameDialog;
+  const onRename = jest.fn();
+  const props = {
+    type: 'visualization',
+    object: {
+      id: 'rename-test'
+    },
+    onClose,
+    onRename
   };
   beforeEach(() => {
-    shallowRenameDialog = undefined;
-    props = {
-      type: 'visualization',
-      object: {
-        id: 'rename-test'
-      },
-      onClose
-    };
-  });
-  it('renders a Modal component', () => {
-    expect(getRenameDialogComponent(props).find(Modal)).toHaveLength(1);
+    jest.resetAllMocks();
+    jest.clearAllMocks();
   });
-  it('renders a ModalTitle containing the type prop', () => {
-    expect(getRenameDialogComponent(props).find(ModalTitle).childAt(0).text()).toEqual(`Rename ${props.type}`);
+  it('renders a Modal component with the correct heading', () => {
+    render(/*#__PURE__*/React.createElement(RenameDialog, props));
+    expect(screen.getAllByTestId('file-menu-rename-modal')).toHaveLength(1);
+    expect(screen.getByRole('heading')).toHaveTextContent('Rename visualization');
   });
   it('renders a InputField for name', () => {
-    expect(getRenameDialogComponent(props).findWhere(n => n.prop('label') === 'Name')).toHaveLength(1);
+    render(/*#__PURE__*/React.createElement(RenameDialog, props));
+    expect(screen.getByTestId('file-menu-rename-modal-name')).toBeInTheDocument();
+    expect(screen.getByText('Name')).toBeInTheDocument();
+    expect(screen.getByText('Name')).toBeVisible();
   });
   it('renders a InputField for name with prefilled value if name is in object prop', () => {
-    props.object.name = 'Name test';
-    const nameInputField = getRenameDialogComponent(props).findWhere(n => n.prop('label') === 'Name');
-    expect(nameInputField.prop('value')).toEqual(props.object.name);
+    render(/*#__PURE__*/React.createElement(RenameDialog, _extends({}, props, {
+      object: {
+        ...props.object,
+        name: 'Vis test'
+      }
+    })));
+    const ancestorElement = screen.getByTestId('file-menu-rename-modal-name');
+    const inputElement = within(ancestorElement).getByRole('textbox');
+    expect(inputElement).toBeInTheDocument();
+    expect(inputElement).toHaveValue('Vis test');
   });
   it('renders a TextAreaField for description', () => {
-    expect(getRenameDialogComponent(props).findWhere(n => n.prop('label') === 'Description')).toHaveLength(1);
+    render(/*#__PURE__*/React.createElement(RenameDialog, props));
+
+    // Locate the label by its text
+    const labelElement = screen.getByText('Description');
+
+    // Find the textarea element within the same container as the label
+    const descriptionField = labelElement.closest('div').querySelector('textarea');
+    expect(descriptionField).toBeInTheDocument();
+    expect(descriptionField).toBeVisible();
   });
   it('renders a TextAreaField for description with prefilled value if description is in object prop', () => {
-    props.object.description = 'Description test';
-    const descriptionInputField = getRenameDialogComponent(props).findWhere(n => n.prop('label') === 'Description');
-    expect(descriptionInputField.prop('value')).toEqual(props.object.description);
+    render(/*#__PURE__*/React.createElement(RenameDialog, _extends({}, props, {
+      object: {
+        ...props.object,
+        description: 'Long explanation of the visualization'
+      }
+    })));
+
+    // Locate the label by its text
+    const labelElement = screen.getByText('Description');
+
+    // Find the textarea element within the same container as the label
+    const descriptionField = labelElement.closest('div').querySelector('textarea');
+    expect(descriptionField).toBeInTheDocument();
+    expect(descriptionField).toHaveValue('Long explanation of the visualization');
+  });
+  it('calls the onClose callback when the Cancel button is clicked', async () => {
+    render(/*#__PURE__*/React.createElement(RenameDialog, props));
+    await fireEvent.click(screen.getByTestId('file-menu-rename-modal-cancel'));
+    expect(onClose).toHaveBeenCalled();
+    expect(onRename).not.toHaveBeenCalled();
   });
-  it('calls the onClose callback when the Cancel button is clicked', () => {
-    getRenameDialogComponent(props).find(Button).first().simulate('click');
+  it('calls the onRename callback when the Rename button is clicked', async () => {
+    render(/*#__PURE__*/React.createElement(RenameDialog, props));
+    await fireEvent.click(screen.getByTestId('file-menu-rename-modal-rename'));
+    expect(onRename).toHaveBeenCalled();
     expect(onClose).toHaveBeenCalled();
   });
 });

package/build/es/components/FileMenu/__tests__/utils.spec.js

@@ -0,0 +1,237 @@
+import { preparePayloadForSaveAs, preparePayloadForSave } from '../utils.js';
+describe('utils', () => {
+  describe('preparePayloadForSaveAs', () => {
+    it('removes unnecessary properties from the visualization object', () => {
+      const visualization = {
+        id: '123',
+        created: '2023-01-01',
+        createdBy: 'user1',
+        user: 'user2',
+        name: 'Existing Name',
+        description: 'Existing Description',
+        type: 'PIVOT_TABLE'
+      };
+      const result = preparePayloadForSaveAs({
+        visualization
+      });
+      expect(result).not.toHaveProperty('id');
+      expect(result).not.toHaveProperty('created');
+      expect(result).not.toHaveProperty('createdBy');
+      expect(result).not.toHaveProperty('user');
+    });
+    it('sets the name to the provided name', () => {
+      const visualization = {
+        type: 'PIVOT_TABLE'
+      };
+      const name = 'New Name';
+      const result = preparePayloadForSaveAs({
+        visualization,
+        name
+      });
+      expect(result.name).toBe(name);
+    });
+    it('sets the name to the existing name if no new name is provided', () => {
+      const visualization = {
+        name: 'Existing Name',
+        type: 'MAP'
+      };
+      const result = preparePayloadForSaveAs({
+        visualization
+      });
+      expect(result.name).toBe('Existing Name');
+    });
+    it('sets the name to a default value if no name is provided', () => {
+      const visualization = {
+        type: 'LINE_LIST'
+      };
+      const result = preparePayloadForSaveAs({
+        visualization
+      });
+      const expectedName = `Untitled Line list, ${new Date().toLocaleDateString(undefined, {
+        year: 'numeric',
+        month: 'short',
+        day: '2-digit'
+      })}`;
+      expect(result.name).toBe(expectedName);
+    });
+    it('sets the description to the provided description', () => {
+      const visualization = {
+        description: 'Existing Description',
+        type: 'PIVOT_TABLE'
+      };
+      const description = 'New Description';
+      const result = preparePayloadForSaveAs({
+        visualization,
+        description
+      });
+      expect(result.description).toBe(description);
+    });
+    it('keeps the existing description if no new description is provided', () => {
+      const visualization = {
+        description: 'Existing Description',
+        type: 'PIVOT_TABLE'
+      };
+      const result = preparePayloadForSaveAs({
+        visualization
+      });
+      expect(result.description).toBe('Existing Description');
+    });
+    it('sets the description to undefined if no description is provided and none exists', () => {
+      const visualization = {
+        type: 'PIVOT_TABLE'
+      };
+      const result = preparePayloadForSaveAs({
+        visualization
+      });
+      expect(result.description).toBeUndefined();
+    });
+  });
+  describe('preparePayloadForSave', () => {
+    const mockEngine = {
+      query: jest.fn()
+    };
+    beforeEach(() => {
+      jest.clearAllMocks();
+    });
+    it('fetches subscribers and adds them to the visualization', async () => {
+      const visualization = {
+        id: '123',
+        type: 'BAR',
+        name: 'Existing Name',
+        description: 'Existing Description'
+      };
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: ['user1', 'user2']
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        engine: mockEngine
+      });
+      expect(mockEngine.query).toHaveBeenCalledWith({
+        ao: {
+          resource: 'visualizations',
+          id: expect.any(Function),
+          params: {
+            fields: 'subscribers'
+          }
+        }
+      }, {
+        variables: {
+          id: '123'
+        }
+      });
+      expect(result.subscribers).toEqual(['user1', 'user2']);
+    });
+    it('sets the name to the provided name', async () => {
+      const visualization = {
+        id: '123',
+        type: 'MAP',
+        name: 'Existing name'
+      };
+      const name = 'New Name';
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: []
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        name,
+        engine: mockEngine
+      });
+      expect(result.name).toBe(name);
+    });
+    it('sets the name to the existing name if no new name is provided', async () => {
+      const visualization = {
+        id: '123',
+        type: 'LINE_LIST',
+        name: 'Existing Name'
+      };
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: []
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        engine: mockEngine
+      });
+      expect(result.name).toBe('Existing Name');
+    });
+    it('sets the name to a default value if no name is provided', async () => {
+      const visualization = {
+        id: '123',
+        type: 'BAR'
+      };
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: []
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        engine: mockEngine
+      });
+      const expectedName = `Untitled Bar, ${new Date().toLocaleDateString(undefined, {
+        year: 'numeric',
+        month: 'short',
+        day: '2-digit'
+      })}`;
+      expect(result.name).toBe(expectedName);
+    });
+    it('sets the description to the provided description', async () => {
+      const visualization = {
+        id: '123',
+        type: 'YEAR_OVER_YEAR_LINE',
+        description: 'Existing Description'
+      };
+      const description = 'New Description';
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: []
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        description,
+        engine: mockEngine
+      });
+      expect(result.description).toBe(description);
+    });
+    it('keeps the existing description if no new description is provided', async () => {
+      const visualization = {
+        id: '123',
+        type: 'COLUMN',
+        description: 'Existing Description'
+      };
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: []
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        engine: mockEngine
+      });
+      expect(result.description).toBe('Existing Description');
+    });
+    it('sets the description to undefined if no description is provided and none exists', async () => {
+      const visualization = {
+        id: '123',
+        type: 'BAR'
+      };
+      mockEngine.query.mockResolvedValue({
+        ao: {
+          subscribers: []
+        }
+      });
+      const result = await preparePayloadForSave({
+        visualization,
+        engine: mockEngine
+      });
+      expect(result.description).toBeUndefined();
+    });
+  });
+});