@dhis2/analytics 26.13.4 → 27.0.0

package/build/cjs/components/FileMenu/FileMenu.js

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

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

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.RenameDialog = void 0;
 var _style = _interopRequireDefault(require("styled-jsx/style"));
-var _appRuntime = require("@dhis2/app-runtime");
 var _ui = require("@dhis2/ui");
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = _interopRequireWildcard(require("react"));
@@ -15,70 +14,21 @@ var _utils = require("./utils.js");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-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: (0, _utils.endpointFromFileType)(type),
-  id: _ref => {
-    let {
-      id
-    } = _ref;
-    return id;
-  },
-  type: 'json-patch',
-  data: _ref2 => {
-    let {
-      name,
-      description
-    } = _ref2;
-    return formatPayload(name, description);
-  }
-});
-const RenameDialog = _ref3 => {
+const RenameDialog = _ref => {
   let {
     type,
     object,
     onClose,
-    onRename,
-    onError
-  } = _ref3;
+    onRename
+  } = _ref;
   const [name, setName] = (0, _react.useState)(object.name);
   const [description, setDescription] = (0, _react.useState)(object.description);
-  const mutation = (0, _react.useMemo)(() => getMutation(type), [type]);
-  const [mutate, {
-    loading
-  }] = (0, _appRuntime.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.default.createElement(_ui.Modal, {
     onClose: onClose,
@@ -91,50 +41,44 @@ const RenameDialog = _ref3 => {
     className: `jsx-${_FileMenuStyles.modalStyles.__hash}` + " " + "modal-content"
   }, /*#__PURE__*/_react.default.createElement(_ui.InputField, {
     label: _index.default.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.default.createElement(_ui.TextAreaField, {
     label: _index.default.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.default.createElement(_ui.ModalActions, null, /*#__PURE__*/_react.default.createElement(_ui.ButtonStrip, null, /*#__PURE__*/_react.default.createElement(_ui.Button, {
     onClick: onClose,
-    disabled: loading,
     secondary: true,
     dataTest: "file-menu-rename-modal-cancel"
   }, _index.default.t('Cancel')), /*#__PURE__*/_react.default.createElement(_ui.Button, {
     onClick: renameObject,
-    disabled: loading,
     primary: true,
     dataTest: "file-menu-rename-modal-rename"
   }, _index.default.t('Rename')))));
 };
 exports.RenameDialog = RenameDialog;
 RenameDialog.propTypes = {
-  id: _propTypes.default.string,
   object: _propTypes.default.shape({
-    id: _propTypes.default.string.isRequired,
     description: _propTypes.default.string,
+    id: _propTypes.default.string,
     name: _propTypes.default.string
   }),
   type: _propTypes.default.oneOf(_utils.supportedFileTypes),
   onClose: _propTypes.default.func,
-  onError: _propTypes.default.func,
   onRename: _propTypes.default.func
 };

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

@@ -1,54 +1,86 @@
 "use strict";
 
-var _ui = require("@dhis2/ui");
-var _enzyme = require("enzyme");
-var _react = _interopRequireDefault(require("react"));
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _react2 = _interopRequireDefault(require("react"));
 var _RenameDialog = require("../RenameDialog.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+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); }
 describe('The FileMenu - RenameDialog component', () => {
-  let shallowRenameDialog;
-  let props;
   const onClose = jest.fn();
-  const getRenameDialogComponent = props => {
-    if (!shallowRenameDialog) {
-      shallowRenameDialog = (0, _enzyme.shallow)(/*#__PURE__*/_react.default.createElement(_RenameDialog.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(_ui.Modal)).toHaveLength(1);
+    jest.resetAllMocks();
+    jest.clearAllMocks();
   });
-  it('renders a ModalTitle containing the type prop', () => {
-    expect(getRenameDialogComponent(props).find(_ui.ModalTitle).childAt(0).text()).toEqual(`Rename ${props.type}`);
+  it('renders a Modal component with the correct heading', () => {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, props));
+    expect(_react.screen.getAllByTestId('file-menu-rename-modal')).toHaveLength(1);
+    expect(_react.screen.getByRole('heading')).toHaveTextContent('Rename visualization');
   });
   it('renders a InputField for name', () => {
-    expect(getRenameDialogComponent(props).findWhere(n => n.prop('label') === 'Name')).toHaveLength(1);
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, props));
+    expect(_react.screen.getByTestId('file-menu-rename-modal-name')).toBeInTheDocument();
+    expect(_react.screen.getByText('Name')).toBeInTheDocument();
+    expect(_react.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);
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, _extends({}, props, {
+      object: {
+        ...props.object,
+        name: 'Vis test'
+      }
+    })));
+    const ancestorElement = _react.screen.getByTestId('file-menu-rename-modal-name');
+    const inputElement = (0, _react.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);
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, props));
+
+    // Locate the label by its text
+    const labelElement = _react.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);
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, _extends({}, props, {
+      object: {
+        ...props.object,
+        description: 'Long explanation of the visualization'
+      }
+    })));
+
+    // Locate the label by its text
+    const labelElement = _react.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 () => {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, props));
+    await _react.fireEvent.click(_react.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(_ui.Button).first().simulate('click');
+  it('calls the onRename callback when the Rename button is clicked', async () => {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(_RenameDialog.RenameDialog, props));
+    await _react.fireEvent.click(_react.screen.getByTestId('file-menu-rename-modal-rename'));
+    expect(onRename).toHaveBeenCalled();
     expect(onClose).toHaveBeenCalled();
   });
 });

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

@@ -0,0 +1,239 @@
+"use strict";
+
+var _utils = require("../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 = (0, _utils.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 = (0, _utils.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 = (0, _utils.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 = (0, _utils.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 = (0, _utils.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 = (0, _utils.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 = (0, _utils.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 (0, _utils.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 (0, _utils.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 (0, _utils.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 (0, _utils.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 (0, _utils.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 (0, _utils.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 (0, _utils.preparePayloadForSave)({
+        visualization,
+        engine: mockEngine
+      });
+      expect(result.description).toBeUndefined();
+    });
+  });
+});

package/build/cjs/components/FileMenu/utils.js

@@ -3,8 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.supportedFileTypes = exports.preparePayloadForSaveAs = exports.labelForFileType = exports.endpointFromFileType = exports.appPathFor = exports.FILE_TYPE_VISUALIZATION = exports.FILE_TYPE_MAP = exports.FILE_TYPE_EVENT_VISUALIZATION = exports.FILE_TYPE_EVENT_REPORT = void 0;
+exports.supportedFileTypes = exports.preparePayloadForSaveAs = exports.preparePayloadForSave = exports.labelForFileType = exports.endpointFromFileType = exports.appPathFor = exports.FILE_TYPE_VISUALIZATION = exports.FILE_TYPE_MAP = exports.FILE_TYPE_EVENT_VISUALIZATION = exports.FILE_TYPE_EVENT_REPORT = void 0;
 var _d2I18n = _interopRequireDefault(require("@dhis2/d2-i18n"));
+var _visTypes = require("../../modules/visTypes.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const FILE_TYPE_EVENT_REPORT = exports.FILE_TYPE_EVENT_REPORT = 'eventReport';
 const FILE_TYPE_VISUALIZATION = exports.FILE_TYPE_VISUALIZATION = 'visualization';
@@ -44,12 +45,67 @@ const appPathFor = (fileType, id, apiVersion) => {
 exports.appPathFor = appPathFor;
 const preparePayloadForSaveAs = _ref => {
   let {
-    ...visualization
+    visualization,
+    name,
+    description
   } = _ref;
   delete visualization.id;
   delete visualization.created;
   delete visualization.createdBy;
   delete visualization.user;
+  visualization.name = name || visualization.name || _d2I18n.default.t('Untitled {{visualizationType}}, {{date}}', {
+    visualizationType: (0, _visTypes.getDisplayNameByVisType)(visualization.type),
+    date: new Date().toLocaleDateString(undefined, {
+      year: 'numeric',
+      month: 'short',
+      day: '2-digit'
+    })
+  });
+  visualization.description = description !== undefined ? description : visualization.description;
   return visualization;
 };
-exports.preparePayloadForSaveAs = preparePayloadForSaveAs;
+exports.preparePayloadForSaveAs = preparePayloadForSaveAs;
+const getSubscriberQuery = type => ({
+  ao: {
+    resource: (0, _visTypes.getApiEndpointByVisType)(type),
+    id: _ref2 => {
+      let {
+        id
+      } = _ref2;
+      return id;
+    },
+    params: {
+      fields: 'subscribers'
+    }
+  }
+});
+const apiFetchAOSubscribers = (dataEngine, id, type) => {
+  return dataEngine.query(getSubscriberQuery(type), {
+    variables: {
+      id
+    }
+  });
+};
+const preparePayloadForSave = async _ref3 => {
+  let {
+    visualization,
+    name,
+    description,
+    engine
+  } = _ref3;
+  const {
+    ao
+  } = await apiFetchAOSubscribers(engine, visualization.id, visualization.type);
+  visualization.subscribers = ao.subscribers;
+  visualization.name = name || visualization.name || _d2I18n.default.t('Untitled {{visualizationType}}, {{date}}', {
+    visualizationType: (0, _visTypes.getDisplayNameByVisType)(visualization.type),
+    date: new Date().toLocaleDateString(undefined, {
+      year: 'numeric',
+      month: 'short',
+      day: '2-digit'
+    })
+  });
+  visualization.description = description !== undefined ? description : visualization.description;
+  return visualization;
+};
+exports.preparePayloadForSave = preparePayloadForSave;

package/build/cjs/index.js

@@ -17,6 +17,7 @@ var _exportNames = {
   PivotTable: true,
   FileMenu: true,
   preparePayloadForSaveAs: true,
+  preparePayloadForSave: true,
   VisTypeIcon: true,
   LegendKey: true,
   AboutAOUnit: true,
@@ -150,6 +151,7 @@ var _exportNames = {
   VIS_TYPE_SCATTER: true,
   VIS_TYPE_LINE_LIST: true,
   VIS_TYPE_OUTLIER_TABLE: true,
+  VIS_TYPE_MAP: true,
   visTypeDisplayNames: true,
   visTypeIcons: true,
   getDisplayNameByVisType: true,
@@ -1149,6 +1151,12 @@ Object.defineProperty(exports, "VIS_TYPE_LINE_LIST", {
     return _visTypes.VIS_TYPE_LINE_LIST;
   }
 });
+Object.defineProperty(exports, "VIS_TYPE_MAP", {
+  enumerable: true,
+  get: function () {
+    return _visTypes.VIS_TYPE_MAP;
+  }
+});
 Object.defineProperty(exports, "VIS_TYPE_OUTLIER_TABLE", {
   enumerable: true,
   get: function () {
@@ -1809,6 +1817,12 @@ Object.defineProperty(exports, "ouIdHelper", {
     return _index7.ouIdHelper;
   }
 });
+Object.defineProperty(exports, "preparePayloadForSave", {
+  enumerable: true,
+  get: function () {
+    return _utils.preparePayloadForSave;
+  }
+});
 Object.defineProperty(exports, "preparePayloadForSaveAs", {
   enumerable: true,
   get: function () {

package/build/cjs/locales/en/translations.json

@@ -162,6 +162,7 @@
     "line list": "line list",
     "map": "map",
     "visualization": "visualization",
+    "Untitled {{visualizationType}}, {{date}}": "Untitled {{visualizationType}}, {{date}}",
     "Edit": "Edit",
     "Write a reply": "Write a reply",
     "Post reply": "Post reply",
@@ -451,6 +452,7 @@
     "Single value": "Single value",
     "Outlier table": "Outlier table",
     "All charts": "All charts",
+    "Map": "Map",
     "{{seriesName}} (trend)": "{{seriesName}} (trend)",
     "Trend": "Trend",
     "No legend for this series": "No legend for this series",