@opengeoweb/form-fields 4.13.1 → 4.14.1

package/index.d.ts

@@ -1 +1,2 @@
 export * from './lib/components';
+export * from './lib/hooks/useDraftFormHelpers/useDraftFormHelpers';

package/index.esm.js

@@ -69,9 +69,7 @@ var errorMessages = {
   isLevelLower: 'The lower level has to be below the upper level',
   isNonOrBothCoordinates: 'Please enter both coordinates',
   isInteger: 'Invalid entry, enter a non-decimal number',
-  isNumeric: 'Invalid entry, enter a numeric value',
-  minVisibility: 'The minimum visibility is 0',
-  maxVisibility: 'The maximum visibility is 4900'
+  isNumeric: 'Invalid entry, enter a numeric value'
 };
 var regexMaxTwoDecimals = /^\s*-?\d+(\.\d{1,2})?\s*$/; // validations
 
@@ -123,16 +121,18 @@ var isLatitude = function isLatitude(lat) {
 var isLongitude = function isLongitude(lng) {
   if (!lng) return true;
   return isFinite(lng) && Math.abs(lng) <= 180 && lng >= -180 && regexMaxTwoDecimals.test(lng.toString());
-};
+}; // Pass null if no maxValue
+
 var isValidMax = function isValidMax(value, maxValue) {
-  if (isEmpty(value)) {
+  if (isEmpty(value) || maxValue === null) {
     return true;
   }
 
   return !(value > maxValue);
-};
+}; // Pass null if no minValue
+
 var isValidMin = function isValidMin(value, minValue) {
-  if (isEmpty(value)) {
+  if (isEmpty(value) || minValue === null) {
     return true;
   }
 
@@ -902,4 +902,68 @@ var ReactHookFormHiddenInput = function ReactHookFormHiddenInput(_ref) {
   })) : null;
 };
 
-export { ReactHookKeyboardDateTimePicker as ReactHookFormDateTime, ReactHookFormFormControl, ReactHookFormHiddenInput, ReactHookFormNumberField, ReactHookFormProviderWrapper as ReactHookFormProvider, ReactHookFormRadioGroup, ReactHookFormSelect, ReactHookFormTextField, defaultFormOptions, errorMessages, getDeepProperty, hasIntersectionWithFIR, hasMaxFeaturePoints, hasMulitpleIntersections, isAfter, isBefore, isBetween, isEmpty, isGeometryDirty, isInteger, isLatitude, isLongitude, isMaximumOneDrawing, isNonOrBothCoordinates, isValidDate, isValidGeoJsonCoordinates, isValidMax, isValidMin, isXHoursAfter, isXHoursBefore };
+/* *
+ * 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 2021 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2021 - Finnish Meteorological Institute (FMI)
+ * */
+
+var HIDDEN_INPUT_HELPER_IS_DRAFT = 'IS_DRAFT';
+var useDraftFormHelpers = function useDraftFormHelpers() {
+  var isDefaultDraft = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+
+  var _useFormContext = useFormContext(),
+      getValues = _useFormContext.getValues,
+      setValue = _useFormContext.setValue,
+      register = _useFormContext.register;
+
+  React.useEffect(function () {
+    setValue(HIDDEN_INPUT_HELPER_IS_DRAFT, isDefaultDraft, {
+      shouldDirty: false
+    }); // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  var isDraft = function isDraft() {
+    return getValues(HIDDEN_INPUT_HELPER_IS_DRAFT) === true;
+  };
+
+  var isRequired = function isRequired(value) {
+    if (!isDraft() && isEmpty(value)) {
+      return errorMessages.required;
+    }
+
+    return true;
+  };
+
+  var toggleIsDraft = function toggleIsDraft(isDraft) {
+    return setValue(HIDDEN_INPUT_HELPER_IS_DRAFT, isDraft, {
+      shouldDirty: false
+    });
+  };
+
+  var DraftFieldHelper = function DraftFieldHelper() {
+    return /*#__PURE__*/React.createElement("input", Object.assign({}, register(HIDDEN_INPUT_HELPER_IS_DRAFT), {
+      type: "hidden"
+    }));
+  };
+
+  return {
+    isRequired: isRequired,
+    toggleIsDraft: toggleIsDraft,
+    isDraft: isDraft,
+    DraftFieldHelper: DraftFieldHelper
+  };
+};
+
+export { HIDDEN_INPUT_HELPER_IS_DRAFT, ReactHookKeyboardDateTimePicker as ReactHookFormDateTime, ReactHookFormFormControl, ReactHookFormHiddenInput, ReactHookFormNumberField, ReactHookFormProviderWrapper as ReactHookFormProvider, ReactHookFormRadioGroup, ReactHookFormSelect, ReactHookFormTextField, defaultFormOptions, errorMessages, getDeepProperty, hasIntersectionWithFIR, hasMaxFeaturePoints, hasMulitpleIntersections, isAfter, isBefore, isBetween, isEmpty, isGeometryDirty, isInteger, isLatitude, isLongitude, isMaximumOneDrawing, isNonOrBothCoordinates, isValidDate, isValidGeoJsonCoordinates, isValidMax, isValidMin, isXHoursAfter, isXHoursBefore, useDraftFormHelpers };

package/index.umd.js

@@ -127,9 +127,7 @@
       isLevelLower: 'The lower level has to be below the upper level',
       isNonOrBothCoordinates: 'Please enter both coordinates',
       isInteger: 'Invalid entry, enter a non-decimal number',
-      isNumeric: 'Invalid entry, enter a numeric value',
-      minVisibility: 'The minimum visibility is 0',
-      maxVisibility: 'The maximum visibility is 4900'
+      isNumeric: 'Invalid entry, enter a numeric value'
     };
     var regexMaxTwoDecimals = /^\s*-?\d+(\.\d{1,2})?\s*$/; // validations
 
@@ -185,16 +183,18 @@
     var isLongitude = function isLongitude(lng) {
       if (!lng) return true;
       return isFinite(lng) && Math.abs(lng) <= 180 && lng >= -180 && regexMaxTwoDecimals.test(lng.toString());
-    };
+    }; // Pass null if no maxValue
+
     var isValidMax = function isValidMax(value, maxValue) {
-      if (isEmpty(value)) {
+      if (isEmpty(value) || maxValue === null) {
         return true;
       }
 
       return !(value > maxValue);
-    };
+    }; // Pass null if no minValue
+
     var isValidMin = function isValidMin(value, minValue) {
-      if (isEmpty(value)) {
+      if (isEmpty(value) || minValue === null) {
         return true;
       }
 
@@ -853,6 +853,56 @@
       })) : null;
     };
 
+    var HIDDEN_INPUT_HELPER_IS_DRAFT = 'IS_DRAFT';
+    var useDraftFormHelpers = function useDraftFormHelpers(isDefaultDraft) {
+      if (isDefaultDraft === void 0) {
+        isDefaultDraft = false;
+      }
+
+      var _a = reactHookForm.useFormContext(),
+          getValues = _a.getValues,
+          setValue = _a.setValue,
+          register = _a.register;
+
+      React__namespace.useEffect(function () {
+        setValue(HIDDEN_INPUT_HELPER_IS_DRAFT, isDefaultDraft, {
+          shouldDirty: false
+        }); // eslint-disable-next-line react-hooks/exhaustive-deps
+      }, []);
+
+      var isDraft = function isDraft() {
+        return getValues(HIDDEN_INPUT_HELPER_IS_DRAFT) === true;
+      };
+
+      var isRequired = function isRequired(value) {
+        if (!isDraft() && isEmpty(value)) {
+          return errorMessages.required;
+        }
+
+        return true;
+      };
+
+      var toggleIsDraft = function toggleIsDraft(isDraft) {
+        return setValue(HIDDEN_INPUT_HELPER_IS_DRAFT, isDraft, {
+          shouldDirty: false
+        });
+      };
+
+      var DraftFieldHelper = function DraftFieldHelper() {
+        return /*#__PURE__*/React__namespace.createElement("input", __assign({}, register(HIDDEN_INPUT_HELPER_IS_DRAFT), {
+          type: "hidden"
+        }));
+      };
+
+      return {
+        isRequired: isRequired,
+        toggleIsDraft: toggleIsDraft,
+        isDraft: isDraft,
+        DraftFieldHelper: DraftFieldHelper
+      };
+    };
+
+    exports.HIDDEN_INPUT_HELPER_IS_DRAFT = HIDDEN_INPUT_HELPER_IS_DRAFT;
     exports.ReactHookFormDateTime = ReactHookKeyboardDateTimePicker;
     exports.ReactHookFormFormControl = ReactHookFormFormControl;
     exports.ReactHookFormHiddenInput = ReactHookFormHiddenInput;
@@ -883,6 +933,7 @@
     exports.isValidMin = isValidMin;
     exports.isXHoursAfter = isXHoursAfter;
     exports.isXHoursBefore = isXHoursBefore;
+    exports.useDraftFormHelpers = useDraftFormHelpers;
 
     Object.defineProperty(exports, '__esModule', { value: true });
 

package/lib/components/utils.d.ts

@@ -17,8 +17,6 @@ export declare const errorMessages: {
     isNonOrBothCoordinates: string;
     isInteger: string;
     isNumeric: string;
-    minVisibility: string;
-    maxVisibility: string;
 };
 export declare const isEmpty: (value?: string | number | null | undefined) => boolean;
 export declare const isValidDate: (value?: string | moment.Moment | null | undefined) => boolean;
@@ -29,8 +27,8 @@ export declare const isXHoursBefore: (ownDate: string, otherDate: string, hours?
 export declare const isXHoursAfter: (ownDate: string, otherDate: string, hours?: number) => boolean;
 export declare const isLatitude: (lat?: number | null | undefined) => boolean;
 export declare const isLongitude: (lng?: number | null | undefined) => boolean;
-export declare const isValidMax: (value: number, maxValue: number) => boolean;
-export declare const isValidMin: (value: number, minValue: number) => boolean;
+export declare const isValidMax: (value: number, maxValue: number | null) => boolean;
+export declare const isValidMin: (value: number, minValue: number | null) => boolean;
 export declare const hasValidGeometry: (geojson?: import("geojson").FeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | null | undefined) => boolean;
 export declare const isValidGeoJsonCoordinates: (geojson: GeoJSON.FeatureCollection) => boolean;
 export declare const isMaximumOneDrawing: (geojson: GeoJSON.FeatureCollection) => boolean;

package/lib/hooks/useDraftFormHelpers/useDraftFormHelpers.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+export declare const HIDDEN_INPUT_HELPER_IS_DRAFT = "IS_DRAFT";
+export declare const useDraftFormHelpers: (isDefaultDraft?: boolean) => {
+    isRequired: (value: string) => boolean | string;
+    toggleIsDraft: (isDraft: boolean) => void;
+    isDraft: () => boolean;
+    DraftFieldHelper: () => React.ReactElement;
+};

package/lib/hooks/useDraftFormHelpers/useDraftFormHelpers.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/form-fields",
-  "version": "4.13.1",
+  "version": "4.14.1",
   "description": "GeoWeb form-fields library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -15,7 +15,7 @@
     "react-hook-form": "^7.41.5",
     "react": "^18.2.0",
     "@mui/material": "^5.10.8",
-    "@opengeoweb/theme": "4.13.1",
+    "@opengeoweb/theme": "4.14.1",
     "moment": "^2.29.0",
     "moment-timezone": "^0.5.31",
     "@mui/x-date-pickers": "^5.0.4",