@opengeoweb/taf 2.5.0 → 2.6.0

package/index.d.ts

@@ -2,3 +2,4 @@ export * from './lib/components/TafForm';
 export * from './lib/components/TafModule';
 export { createApi } from './lib/utils/api';
 export { createApi as createFakeApi } from './lib/utils/fakeApi';
+export * from './lib/components/ComponentsLookUp';

package/index.esm.js

@@ -4,8 +4,8 @@ import { TextField, SvgIcon, Grid, Box, Button, IconButton, Tooltip, Chip, Typog
 import { useFormContext, Controller, useFieldArray } from 'react-hook-form';
 import { ReactSortable, Sortable } from 'react-sortablejs';
 import { getDeepProperty, ReactHookFormHiddenInput, ReactHookFormProvider } from '@opengeoweb/form-fields';
-import { useApiContext, useApi, createApiInstance } from '@opengeoweb/api';
-import { useIsMounted, ToggleMenu, useDraftFormHelpers, ToolContainerDraggable, useConfirmationDialog, usePreventBrowserClose, ToolButton, ToolHeader, getAxiosErrorMessage, AlertBanner, ConfirmationServiceProvider, usePoller } from '@opengeoweb/shared';
+import { useApiContext, useApi, createApiInstance, ApiProvider } from '@opengeoweb/api';
+import { useIsMounted, ToggleMenu, useDraftFormHelpers, ToolContainerDraggable, useConfirmationDialog, usePreventBrowserClose, ToolButton, ToolHeader, getAxiosErrorMessage, AlertBanner, ConfirmationServiceProvider, usePoller, ErrorBoundary } from '@opengeoweb/shared';
 import moment from 'moment';
 import { isEqual } from 'lodash';
 import makeStyles from '@mui/styles/makeStyles';
@@ -1994,6 +1994,22 @@ var validateFourthCloud = function validateFourthCloud(firstCloudValue, secondCl
   return true;
 };
 
+var emptyBaseForecast = {
+  wind: '',
+  visibility: '',
+  weather: {
+    weather1: '',
+    weather2: '',
+    weather3: ''
+  },
+  cloud: {
+    cloud1: '',
+    cloud2: '',
+    cloud3: '',
+    cloud4: ''
+  }
+}; // formatters
+
 var formatIssueTime = function formatIssueTime(issueDate) {
   return issueDate ? "".concat(moment(issueDate).utc().format('DDHHmm'), "Z") : 'Not issued';
 };
@@ -2299,8 +2315,6 @@ var tacHasError = function tacHasError(tac) {
   return tac === TAC_MISSING_DATA || tac === TAC_NOT_AVAILABLE || tac === TAC_RETRIEVING_DATA || tac === TAC_FAILED;
 };
 var useTACGenerator = function useTACGenerator(taf, requestTAC) {
-  var standardTAC = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
-
   var _React$useState = React__default.useState(taf.status === 'NEW' ? TAC_NOT_AVAILABLE : TAC_RETRIEVING_DATA),
       _React$useState2 = _slicedToArray(_React$useState, 2),
       TAC = _React$useState2[0],
@@ -2325,16 +2339,11 @@ var useTACGenerator = function useTACGenerator(taf, requestTAC) {
     }
   }, [isMounted, requestTAC]);
   React__default.useEffect(function () {
-    if (taf.status !== 'NEW' && !standardTAC) {
+    if (taf.status !== 'NEW') {
       retrieveTAC(taf);
     } // eslint-disable-next-line react-hooks/exhaustive-deps
 
   }, []);
-  React__default.useEffect(function () {
-    if (standardTAC !== '') {
-      setTAC(standardTAC);
-    }
-  }, [standardTAC]);
   return [TAC, retrieveTAC];
 };
 var useDragOrder = function useDragOrder(trigger, move, onFormBlur) {
@@ -2526,7 +2535,7 @@ var prepareTafValues = function prepareTafValues(_taf, tafAction) {
   var taf = tafAction === 'AMEND' || tafAction === 'DRAFT_AMEND' || tafAction === 'CORRECT' || tafAction === 'DRAFT_CORRECT' ? getAmendedCorrectedTafTimes(_taf, tafAction) : _taf;
   return Object.assign(Object.assign(Object.assign(Object.assign({}, taf), {
     messageType: getMessageType(taf, tafAction),
-    baseForecast: formatFormValues(taf.baseForecast)
+    baseForecast: Object.assign(Object.assign({}, emptyBaseForecast), formatFormValues(taf.baseForecast))
   }), taf.changeGroups && {
     changeGroups: taf.changeGroups.map(formatFormValues)
   }), addEmptyChangeGroup && {
@@ -2913,7 +2922,7 @@ var TafFormRow = /*#__PURE__*/React__default.forwardRef(function (_a, ref) {
       getValues = _useFormContext.getValues,
       trigger = _useFormContext.trigger;
 
-  var _useDraftFormHelpers = useDraftFormHelpers(),
+  var _useDraftFormHelpers = useDraftFormHelpers(true),
       isNotRequiredForAction = _useDraftFormHelpers.isRequired; // cross-field required validation
 
 
@@ -3742,20 +3751,6 @@ var getPaneTitle = function getPaneTitle(sumOfErrors) {
   }
 };
 
-var getErrorDefaultMessage = function getErrorDefaultMessage(error) {
-  switch (error.type) {
-    case 'required':
-      {
-        return 'this field is required';
-      }
-
-    default:
-      {
-        return error.message;
-      }
-  }
-};
-
 var capitalizeWord = function capitalizeWord(_ref) {
   var _ref2 = _toArray(_ref),
       firstLetter = _ref2[0],
@@ -3793,7 +3788,7 @@ var getErrorMessage = function getErrorMessage(error, index) {
       firstNamePart = _name$split2[0];
 
   var fieldErrorTitle = humanizeErrorMessage(firstNamePart);
-  return "".concat(index + 1, ". ").concat(fieldErrorTitle, ": ").concat(getErrorDefaultMessage(error));
+  return "".concat(index + 1, ". ").concat(fieldErrorTitle, ": ").concat(error.message);
 };
 var MODAL_DIALOG_ELEMENT = 'modal-dialog';
 var useIssuesPane = function useIssuesPane() {
@@ -3878,12 +3873,16 @@ var TafModuleContext = /*#__PURE__*/React.createContext({
   onValidateForm: null,
   registerValidateForm: null,
   tafAction: null,
-  setTafAction: null
+  setTafAction: null,
+  isFormDirty: null,
+  setIsFormDirty: null
 });
 var useTafModuleContext = function useTafModuleContext() {
   return React.useContext(TafModuleContext);
 };
-var useTafModuleState = function useTafModuleState() {
+var useTafModuleState = function useTafModuleState(_ref) {
+  var onPreventCloseView = _ref.onPreventCloseView;
+
   var _React$useState = React.useState(function () {
     return new Promise(function () {
       return true;
@@ -3898,22 +3897,40 @@ var useTafModuleState = function useTafModuleState() {
       tafAction = _React$useState4[0],
       setTafAction = _React$useState4[1];
 
+  var _React$useState5 = React.useState(false),
+      _React$useState6 = _slicedToArray(_React$useState5, 2),
+      isFormDirty = _React$useState6[0],
+      setIsFormDirty = _React$useState6[1];
+
   var onRegisterValidateForm = function onRegisterValidateForm(promiseToRegister) {
     registerValidateForm(function () {
       return promiseToRegister;
     });
   };
 
+  var onChangeFormDirty = function onChangeFormDirty(isDirty) {
+    if (isDirty !== isFormDirty) {
+      setIsFormDirty(isDirty);
+      onPreventCloseView(isDirty);
+    }
+  };
+
   return {
     onValidateForm: onValidateForm,
     registerValidateForm: onRegisterValidateForm,
     tafAction: tafAction,
-    setTafAction: setTafAction
+    setTafAction: setTafAction,
+    isFormDirty: isFormDirty,
+    setIsFormDirty: onChangeFormDirty
   };
 };
-var TafModuleProvider = function TafModuleProvider(_ref) {
-  var children = _ref.children;
-  var contextState = useTafModuleState();
+var TafModuleProvider = function TafModuleProvider(_ref2) {
+  var children = _ref2.children,
+      _ref2$onPreventCloseV = _ref2.onPreventCloseView,
+      onPreventCloseView = _ref2$onPreventCloseV === void 0 ? function () {} : _ref2$onPreventCloseV;
+  var contextState = useTafModuleState({
+    onPreventCloseView: onPreventCloseView
+  });
   return /*#__PURE__*/React.createElement(TafModuleContext.Provider, {
     value: contextState
   }, children);
@@ -3927,10 +3944,6 @@ var TafForm = function TafForm(_ref) {
       onFormAction = _ref$onFormAction === void 0 ? function () {
     return null;
   } : _ref$onFormAction,
-      _ref$onFormDirty = _ref.onFormDirty,
-      onFormDirty = _ref$onFormDirty === void 0 ? function () {
-    return null;
-  } : _ref$onFormDirty,
       _ref$isIssuesPaneOpen = _ref.isIssuesPaneOpen,
       isIssuesPaneOpen = _ref$isIssuesPaneOpen === void 0 ? false : _ref$isIssuesPaneOpen,
       _ref$setIsIssuesPaneO = _ref.setIsIssuesPaneOpen,
@@ -3947,14 +3960,15 @@ var TafForm = function TafForm(_ref) {
   var isDefaultDisabled = getIsFormDefaultDisabled(tafFromBackend.taf.status);
   var confirmDialog = useConfirmationDialog();
 
-  var _useDraftFormHelpers = useDraftFormHelpers(),
+  var _useDraftFormHelpers = useDraftFormHelpers(true),
       toggleIsDraft = _useDraftFormHelpers.toggleIsDraft,
       DraftFieldHelper = _useDraftFormHelpers.DraftFieldHelper;
 
   var _useTafModuleContext = useTafModuleContext(),
       registerValidateForm = _useTafModuleContext.registerValidateForm,
       tafAction = _useTafModuleContext.tafAction,
-      setTafAction = _useTafModuleContext.setTafAction;
+      setTafAction = _useTafModuleContext.setTafAction,
+      setIsFormDirty = _useTafModuleContext.setIsFormDirty;
 
   var _useApiContext = useApiContext(),
       api = _useApiContext.api;
@@ -4008,8 +4022,8 @@ var TafForm = function TafForm(_ref) {
   }, [hasErrors]); // Needed to be able to show a confirmation dialog on switching tabs when form is edited and not saved
 
   React__default.useEffect(function () {
-    onFormDirty(isFormDirty);
-  }, [isFormDirty, onFormDirty]);
+    setIsFormDirty(isFormDirty);
+  }, [isFormDirty, setIsFormDirty]);
 
   var onSubmit = function onSubmit(data) {
     // eslint-disable-next-line no-console
@@ -4238,6 +4252,11 @@ var TafForm = function TafForm(_ref) {
       reset({});
     }; // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
+  React__default.useEffect(function () {
+    var newValues = prepareTafValues(tafFromBackend.taf, undefined, !isDefaultDisabled && !tafFromBackend.taf.changeGroups); // set new form values when tafFromBackend changed
+
+    reset(newValues); // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [tafFromBackend]);
   React__default.useEffect(function () {
     if (shouldValidate && !isDisabled) {
       // trigger validation on all changegroup validity times after initial load since they could be outside the new validity period
@@ -4523,21 +4542,6 @@ var muiTabA11yProps = function muiTabA11yProps(index) {
     'aria-controls': "simple-tabpanel-".concat(index)
   };
 };
-var emptyBaseForecast = {
-  wind: '',
-  visibility: '',
-  weather: {
-    weather1: '',
-    weather2: '',
-    weather3: ''
-  },
-  cloud: {
-    cloud1: '',
-    cloud2: '',
-    cloud3: '',
-    cloud4: ''
-  }
-};
 var prepareTafExportValues = function prepareTafExportValues(tafToCopy, currentTaf) {
   var _a;
 
@@ -5214,47 +5218,48 @@ var usePostTafRequest = function usePostTafRequest(request) {
           switch (_context.prev = _context.next) {
             case 0:
               setLoading(true);
-              _context.prev = 1;
-              _context.next = 4;
+              setError(null);
+              _context.prev = 2;
+              _context.next = 5;
               return request(params);
 
-            case 4:
+            case 5:
               if (isMounted.current) {
-                _context.next = 6;
+                _context.next = 7;
                 break;
               }
 
               return _context.abrupt("return");
 
-            case 6:
+            case 7:
               setLoading(false);
               setError(null);
-              _context.next = 18;
+              _context.next = 19;
               break;
 
-            case 10:
-              _context.prev = 10;
-              _context.t0 = _context["catch"](1);
+            case 11:
+              _context.prev = 11;
+              _context.t0 = _context["catch"](2);
 
               if (isMounted.current) {
-                _context.next = 14;
+                _context.next = 15;
                 break;
               }
 
               return _context.abrupt("return");
 
-            case 14:
+            case 15:
               newErrorr = errorParser ? errorParser(_context.t0, params) : _context.t0;
               setLoading(false);
               setError(newErrorr);
               throw newErrorr;
 
-            case 18:
+            case 19:
             case "end":
               return _context.stop();
           }
         }
-      }, _callee, null, [[1, 10]]);
+      }, _callee, null, [[2, 11]]);
     }));
   };
 
@@ -5276,10 +5281,6 @@ var TafPanel = function TafPanel(_ref) {
       postTaf = _ref$postTaf === void 0 ? function () {
     return null;
   } : _ref$postTaf,
-      _ref$onFormDirty = _ref.onFormDirty,
-      onFormDirty = _ref$onFormDirty === void 0 ? function () {
-    return null;
-  } : _ref$onFormDirty,
       _ref$isIssuesPaneOpen = _ref.isIssuesPaneOpen,
       isIssuesPaneOpen = _ref$isIssuesPaneOpen === void 0 ? false : _ref$isIssuesPaneOpen,
       _ref$setIsIssuesPaneO = _ref.setIsIssuesPaneOpen,
@@ -5353,16 +5354,21 @@ var TafPanel = function TafPanel(_ref) {
     severity: "error",
     title: error.title,
     info: error.message,
-    dataTestId: "taf-error"
-  }), /*#__PURE__*/React__default.createElement(TafForm, {
+    dataTestId: "taf-error",
+    shouldClose: true
+  }), /*#__PURE__*/React__default.createElement(Box, {
+    sx: {
+      marginTop: '10px',
+      padding: 1
+    }
+  }, /*#__PURE__*/React__default.createElement(TafForm, {
     tafFromBackend: tafFromBackend,
     onFormAction: onTafAction,
-    onFormDirty: onFormDirty,
     isIssuesPaneOpen: isIssuesPaneOpen,
     setIsIssuesPaneOpen: setIsIssuesPaneOpen,
     isDisabled: isFormDisabled,
     setIsDisabled: setIsFormDisabled
-  }));
+  })));
 };
 
 /* *
@@ -5423,7 +5429,8 @@ var TafLayout = function TafLayout(_ref) {
 
   var _useTafModuleContext = useTafModuleContext(),
       onValidateForm = _useTafModuleContext.onValidateForm,
-      tafAction = _useTafModuleContext.tafAction;
+      tafAction = _useTafModuleContext.tafAction,
+      isFormDirty = _useTafModuleContext.isFormDirty;
 
   var _React$useState = React__default.useState(sortTafTimeSlots(tafList)),
       _React$useState2 = _slicedToArray(_React$useState, 2),
@@ -5454,13 +5461,8 @@ var TafLayout = function TafLayout(_ref) {
 
   var _React$useState9 = React__default.useState(false),
       _React$useState10 = _slicedToArray(_React$useState9, 2),
-      isFormDirty = _React$useState10[0],
-      setIsFormDirty = _React$useState10[1];
-
-  var _React$useState11 = React__default.useState(false),
-      _React$useState12 = _slicedToArray(_React$useState11, 2),
-      isFormDisabled = _React$useState12[0],
-      setIsFormDisabled = _React$useState12[1];
+      isFormDisabled = _React$useState10[0],
+      setIsFormDisabled = _React$useState10[1];
 
   var postTaf = function postTaf(data) {
     return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
@@ -5518,16 +5520,18 @@ var TafLayout = function TafLayout(_ref) {
               _context2.t0 = _context2["catch"](1);
               confirmDialog(CONFIRM_DIALOG_OPTIONS).then(function () {
                 action(value);
+                setError(null);
               });
 
             case 13:
-              _context2.next = 16;
+              _context2.next = 17;
               break;
 
             case 15:
               action(value);
+              setError(null);
 
-            case 16:
+            case 17:
             case "end":
               return _context2.stop();
           }
@@ -5646,8 +5650,6 @@ var TafLayout = function TafLayout(_ref) {
   }, /*#__PURE__*/React__default.createElement(Card, {
     variant: "outlined",
     sx: {
-      padding: 1,
-      paddingTop: 0,
       marginBottom: '12px',
       position: 'relative'
     }
@@ -5662,7 +5664,6 @@ var TafLayout = function TafLayout(_ref) {
       activeTafIndex: activeTafIndex,
       index: index,
       tafFromBackend: tafFromBackend,
-      onFormDirty: setIsFormDirty,
       isIssuesPaneOpen: isIssuesPaneOpen,
       setIsIssuesPaneOpen: onToggleIssuesPane,
       isFormDisabled: isFormDisabled,
@@ -5673,13 +5674,15 @@ var TafLayout = function TafLayout(_ref) {
     });
   }))), /*#__PURE__*/React__default.createElement(Grid, {
     item: true,
-    xs: 3,
-    sx: {
-      height: '100%'
+    xs: 0,
+    sm: 3,
+    height: {
+      xs: 0,
+      sm: '100%'
     },
-    display: {
-      xs: 'none',
-      sm: 'block'
+    width: {
+      xs: 0,
+      sm: '100%'
     }
   }, /*#__PURE__*/React__default.createElement(TacOverview, {
     upcomingTafs: upcoming,
@@ -5694,26 +5697,11 @@ var TafLayout = function TafLayout(_ref) {
   }));
 };
 
-/* *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * Copyright 2022 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
- * Copyright 2022 - Finnish Meteorological Institute (FMI)
- * */
+var TafWrapper = function TafWrapper(_a) {
+  var children = _a.children,
+      props = __rest(_a, ["children"]);
 
-var TafWrapper = function TafWrapper(_ref) {
-  var children = _ref.children;
-  return /*#__PURE__*/React.createElement(TafModuleProvider, null, /*#__PURE__*/React.createElement(ConfirmationServiceProvider, null, /*#__PURE__*/React.createElement(ReactHookFormProvider, {
+  return /*#__PURE__*/React.createElement(TafModuleProvider, Object.assign({}, props), /*#__PURE__*/React.createElement(ConfirmationServiceProvider, null, /*#__PURE__*/React.createElement(ReactHookFormProvider, {
     options: {
       mode: 'onTouched',
       reValidateMode: 'onChange',
@@ -5795,15 +5783,17 @@ var TafModule = function TafModule() {
   }), hasTafListError && /*#__PURE__*/React.createElement(AlertBanner, {
     severity: "error",
     title: "An error has occurred while retrieving the list",
-    info: getTafListError.message
+    info: getTafListError.message,
+    dataTestId: "taf-list-error",
+    shouldClose: true
   }), /*#__PURE__*/React.createElement(TafLayout, {
     tafList: tafList,
     onPostTaf: reFetchNewTafList
   }));
 };
 
-var Wrapper = function Wrapper() {
-  return /*#__PURE__*/React.createElement(TafWrapper, null, /*#__PURE__*/React.createElement(TafModule, null));
+var Wrapper = function Wrapper(props) {
+  return /*#__PURE__*/React.createElement(TafWrapper, Object.assign({}, props), /*#__PURE__*/React.createElement(TafModule, null));
 };
 
 /* *
@@ -6805,4 +6795,85 @@ var createApi = function createApi() {
   };
 };
 
-export { TafForm, Wrapper as TafModule, createApi$1 as createApi, createApi as createFakeApi };
+/* *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright 2022 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2022 - Finnish Meteorological Institute (FMI)
+ * */
+var tafScreenPreset = {
+  id: 'screenConfigTaf',
+  title: 'TAF',
+  views: {
+    byId: {
+      taf: {
+        title: 'TAF',
+        componentType: 'TafModule',
+        initialProps: {}
+      }
+    },
+    allIds: ['taf']
+  },
+  syncGroups: [],
+  mosaicNode: 'taf'
+};
+var TafApiWrapper = function TafApiWrapper(_ref) {
+  var config = _ref.config,
+      auth = _ref.auth,
+      onSetAuth = _ref.onSetAuth,
+      onPreventCloseView = _ref.onPreventCloseView;
+  return config ? /*#__PURE__*/React.createElement(ApiProvider, {
+    baseURL: config.baseUrl,
+    appURL: config.appUrl,
+    auth: auth,
+    onSetAuth: onSetAuth,
+    createApi: createApi$1,
+    authTokenUrl: config.authTokenUrl,
+    authClientId: config.authClientId
+  }, /*#__PURE__*/React.createElement(ErrorBoundary, null, /*#__PURE__*/React.createElement(Wrapper, {
+    onPreventCloseView: onPreventCloseView
+  }))) : null;
+};
+var componentsLookUp = function componentsLookUp(payload, _ref2) {
+  var config = _ref2.config,
+      auth = _ref2.auth,
+      onSetAuth = _ref2.onSetAuth;
+  var ConnectedModuleWrapper = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  var componentType = payload.componentType;
+
+  switch (componentType) {
+    case 'TafModule':
+      if (ConnectedModuleWrapper) {
+        return /*#__PURE__*/React.createElement(ConnectedModuleWrapper, {
+          component: TafApiWrapper,
+          payload: payload,
+          "data-testid": "tafmodule",
+          config: config,
+          auth: auth,
+          onSetAuth: onSetAuth
+        });
+      }
+
+      return /*#__PURE__*/React.createElement(TafApiWrapper, {
+        "data-testid": "tafmodule",
+        config: config,
+        auth: auth,
+        onSetAuth: onSetAuth
+      });
+
+    default:
+      return null;
+  }
+};
+
+export { TafApiWrapper, TafForm, Wrapper as TafModule, componentsLookUp, createApi$1 as createApi, createApi as createFakeApi, tafScreenPreset };