@mtes-mct/monitor-ui 2.10.0 → 2.12.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mtes-mct/monitor-ui",
   "description": "Common React UI components and styles for Monitorfish and Monitorenv.",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "license": "AGPL-3.0",
   "engines": {
     "node": ">=18"
@@ -9,7 +9,7 @@
   "dependencies": {
     "@babel/runtime": "7.20.6",
     "prop-types": "15.8.1",
-    "tslib": "2.4.1"
+    "tslib": "2.5.0"
   },
   "peerDependencies": {
     "formik": "^2.0.0",
@@ -31,7 +31,7 @@
       "bash -c 'npm run test:type'"
     ]
   },
-  "packageManager": "yarn@3.3.0",
+  "packageManager": "yarn@3.4.1",
   "bugs": {
     "url": "https://github.com/MTES-MCT/monitor-ui/issues"
   },

package/src/fields/Checkbox.d.ts

@@ -1,8 +1,9 @@
 import type { CheckboxProps as RsuiteCheckboxProps } from 'rsuite';
 import type { Promisable } from 'type-fest';
 export type CheckboxProps = Omit<RsuiteCheckboxProps, 'as' | 'checked' | 'id' | 'onChange'> & {
+    error?: string | undefined;
     label: string;
     name: string;
     onChange?: ((isCheched: boolean) => Promisable<void>) | undefined;
 };
-export declare function Checkbox({ label, onChange, ...originalProps }: CheckboxProps): JSX.Element;
+export declare function Checkbox({ error, label, onChange, ...originalProps }: CheckboxProps): JSX.Element;

package/src/fields/DatePicker/index.d.ts

@@ -10,6 +10,7 @@ export interface DatePickerProps extends Omit<HTMLAttributes<HTMLFieldSetElement
     baseContainer?: Document | HTMLDivElement | null | undefined;
     defaultValue?: Date | string | undefined;
     disabled?: boolean | undefined;
+    error?: string | undefined;
     isCompact?: boolean | undefined;
     /** Only allow past dates until today. */
     isHistorical?: boolean | undefined;

package/src/fields/DateRangePicker/index.d.ts

@@ -11,6 +11,7 @@ export interface DateRangePickerProps extends Omit<HTMLAttributes<HTMLFieldSetEl
     baseContainer?: Document | HTMLDivElement | null | undefined;
     defaultValue?: DateRange | DateAsStringRange | undefined;
     disabled?: boolean | undefined;
+    error?: string | undefined;
     isCompact?: boolean | undefined;
     /** Only allow past dates until today. */
     isHistorical?: boolean | undefined;

package/src/fields/MultiCheckbox.d.ts

@@ -2,6 +2,8 @@ import type { Option } from '../types';
 import type { Promisable } from 'type-fest';
 export type MultiCheckboxProps = {
     defaultValue?: string[] | undefined;
+    disabled?: boolean | undefined;
+    error?: string | undefined;
     isInline?: boolean | undefined;
     isLabelHidden?: boolean | undefined;
     isLight?: boolean | undefined;
@@ -10,4 +12,4 @@ export type MultiCheckboxProps = {
     onChange?: ((nextValue: string[] | undefined) => Promisable<void>) | undefined;
     options: Option[];
 };
-export declare function MultiCheckbox({ defaultValue, isInline, isLabelHidden, isLight, label, name, onChange, options }: MultiCheckboxProps): JSX.Element;
+export declare function MultiCheckbox({ defaultValue, disabled, error, isInline, isLabelHidden, isLight, label, name, onChange, options }: MultiCheckboxProps): JSX.Element;

package/src/fields/MultiRadio.d.ts

@@ -2,6 +2,8 @@ import type { Option } from '../types';
 import type { Promisable } from 'type-fest';
 export type MultiRadioProps = {
     defaultValue?: string | undefined;
+    disabled?: boolean | undefined;
+    error?: string | undefined;
     isInline?: boolean | undefined;
     isLabelHidden?: boolean | undefined;
     isLight?: boolean | undefined;
@@ -10,4 +12,4 @@ export type MultiRadioProps = {
     onChange?: ((nextValue: string | undefined) => Promisable<void>) | undefined;
     options: Option[];
 };
-export declare function MultiRadio({ defaultValue, isInline, isLabelHidden, isLight, label, name, onChange, options }: MultiRadioProps): JSX.Element;
+export declare function MultiRadio({ defaultValue, disabled, error, isInline, isLabelHidden, isLight, label, name, onChange, options }: MultiRadioProps): JSX.Element;

package/src/fields/MultiZoneEditor/index.d.ts

@@ -2,6 +2,7 @@ import type { Promisable } from 'type-fest';
 export type MultiZoneEditorProps = {
     addButtonLabel: string;
     defaultValue?: Record<string, any>[] | undefined;
+    error?: string | undefined;
     initialZone: Record<string, any>;
     isLabelHidden?: boolean;
     isLight?: boolean | undefined;
@@ -12,4 +13,4 @@ export type MultiZoneEditorProps = {
     onDelete?: ((nextZones: Record<string, any>[]) => Promisable<void>) | undefined;
     onEdit?: ((zone: Record<string, any>, index: number) => Promisable<void>) | undefined;
 };
-export declare function MultiZoneEditor({ addButtonLabel, defaultValue, initialZone, isLabelHidden, isLight, label, labelPropName, onAdd, onCenter, onDelete, onEdit }: MultiZoneEditorProps): JSX.Element;
+export declare function MultiZoneEditor({ addButtonLabel, defaultValue, error, initialZone, isLabelHidden, isLight, label, labelPropName, onAdd, onCenter, onDelete, onEdit }: MultiZoneEditorProps): JSX.Element;

package/src/fields/NumberInput.d.ts

@@ -2,10 +2,11 @@ import type { InputProps } from 'rsuite';
 import type { Promisable } from 'type-fest';
 export type NumberInputProps = Omit<InputProps, 'as' | 'defaultValue' | 'id' | 'onChange' | 'type' | 'value'> & {
     defaultValue?: number | undefined;
+    error?: string | undefined;
     isLabelHidden?: boolean | undefined;
     isLight?: boolean | undefined;
     label: string;
     name: string;
     onChange?: ((nextValue: number | undefined) => Promisable<void>) | undefined;
 };
-export declare function NumberInput({ isLabelHidden, isLight, label, onChange, ...originalProps }: NumberInputProps): JSX.Element;
+export declare function NumberInput({ error, isLabelHidden, isLight, label, onChange, ...originalProps }: NumberInputProps): JSX.Element;

package/src/fields/TextInput.d.ts

@@ -2,10 +2,11 @@ import type { InputProps } from 'rsuite';
 import type { Promisable } from 'type-fest';
 export type TextInputProps = Omit<InputProps, 'as' | 'defaultValue' | 'id' | 'onChange' | 'type' | 'value'> & {
     defaultValue?: string | undefined;
+    error?: string | undefined;
     isLabelHidden?: boolean | undefined;
     isLight?: boolean | undefined;
     label: string;
     name: string;
     onChange?: ((nextValue: string | undefined) => Promisable<void>) | undefined;
 };
-export declare function TextInput({ isLabelHidden, isLight, label, onChange, ...originalProps }: TextInputProps): JSX.Element;
+export declare function TextInput({ error, isLabelHidden, isLight, label, onChange, ...originalProps }: TextInputProps): JSX.Element;

package/src/fields/Textarea.d.ts

@@ -2,10 +2,11 @@ import type { TextareaHTMLAttributes } from 'react';
 import type { Promisable } from 'type-fest';
 export type TextareaProps = Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, 'defaultValue' | 'id' | 'onChange' | 'value'> & {
     defaultValue?: string | undefined;
+    error?: string | undefined;
     isLabelHidden?: boolean | undefined;
     isLight?: boolean | undefined;
     label: string;
     name: string;
     onChange?: ((nextValue: string | undefined) => Promisable<void>) | undefined;
 };
-export declare function Textarea({ isLabelHidden, isLight, label, onChange, rows, ...originalProps }: TextareaProps): JSX.Element;
+export declare function Textarea({ error, isLabelHidden, isLight, label, onChange, rows, ...originalProps }: TextareaProps): JSX.Element;

package/src/formiks/FormikAutoComplete.d.ts

@@ -1,3 +1,3 @@
 import type { AutoCompleteProps } from '../fields/AutoComplete';
-export type FormikAutoCompleteProps = Omit<AutoCompleteProps, 'defaultValue' | 'onChange'>;
+export type FormikAutoCompleteProps = Omit<AutoCompleteProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikAutoComplete({ name, ...originalProps }: FormikAutoCompleteProps): JSX.Element;

package/src/formiks/FormikCheckbox.d.ts

@@ -1,3 +1,3 @@
 import type { CheckboxProps } from '../fields/Checkbox';
-export type FormikCheckboxProps = Omit<CheckboxProps, 'checked' | 'defaultChecked' | 'onChange'>;
+export type FormikCheckboxProps = Omit<CheckboxProps, 'checked' | 'defaultChecked' | 'error' | 'onChange'>;
 export declare function FormikCheckbox({ name, ...originalProps }: FormikCheckboxProps): JSX.Element;

package/src/formiks/FormikDatePicker.d.ts

@@ -1,8 +1,8 @@
 import type { DatePickerWithDateDateProps, DatePickerWithStringDateProps } from '../fields/DatePicker';
-export interface FormikDatePickerWithDateDateProps extends Omit<DatePickerWithDateDateProps, 'onChange'> {
+export interface FormikDatePickerWithDateDateProps extends Omit<DatePickerWithDateDateProps, 'defaultValue' | 'error' | 'onChange'> {
     name: string;
 }
-export interface FormikDatePickerWithStringDateProps extends Omit<DatePickerWithStringDateProps, 'onChange'> {
+export interface FormikDatePickerWithStringDateProps extends Omit<DatePickerWithStringDateProps, 'defaultValue' | 'error' | 'onChange'> {
     name: string;
 }
 export declare function FormikDatePicker(props: FormikDatePickerWithDateDateProps): JSX.Element;

package/src/formiks/FormikDateRangePicker.d.ts

@@ -1,8 +1,8 @@
 import type { DateRangePickerWithDateDateProps, DateRangePickerWithStringDateProps } from '../fields/DateRangePicker';
-export interface FormikDateRangePickerWithDateDateProps extends Omit<DateRangePickerWithDateDateProps, 'onChange'> {
+export interface FormikDateRangePickerWithDateDateProps extends Omit<DateRangePickerWithDateDateProps, 'defaultValue' | 'error' | 'onChange'> {
     name: string;
 }
-export interface FormikDateRangePickerWithStringDateProps extends Omit<DateRangePickerWithStringDateProps, 'onChange'> {
+export interface FormikDateRangePickerWithStringDateProps extends Omit<DateRangePickerWithStringDateProps, 'defaultValue' | 'error' | 'onChange'> {
     name: string;
 }
 export declare function FormikDateRangePicker(props: FormikDateRangePickerWithDateDateProps): JSX.Element;

package/src/formiks/FormikMultiCheckbox.d.ts

@@ -1,3 +1,3 @@
 import type { MultiCheckboxProps } from '../fields/MultiCheckbox';
-export type FormikMultiCheckboxProps = Omit<MultiCheckboxProps, 'defaultValue' | 'onChange'>;
+export type FormikMultiCheckboxProps = Omit<MultiCheckboxProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikMultiCheckbox({ name, ...originalProps }: FormikMultiCheckboxProps): JSX.Element;

package/src/formiks/FormikMultiRadio.d.ts

@@ -1,3 +1,3 @@
 import type { MultiRadioProps } from '../fields/MultiRadio';
-export type FormikMultiRadioProps = Omit<MultiRadioProps, 'defaultValue' | 'onChange'>;
+export type FormikMultiRadioProps = Omit<MultiRadioProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikMultiRadio({ name, ...originalProps }: FormikMultiRadioProps): JSX.Element;

package/src/formiks/FormikMultiSelect.d.ts

@@ -1,3 +1,3 @@
 import type { MultiSelectProps } from '../fields/MultiSelect';
-export type FormikMultiSelectProps = Omit<MultiSelectProps, 'defaultValue' | 'onChange'>;
+export type FormikMultiSelectProps = Omit<MultiSelectProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikMultiSelect({ name, ...originalProps }: FormikMultiSelectProps): JSX.Element;

package/src/formiks/FormikNumberInput.d.ts

@@ -1,3 +1,3 @@
 import type { NumberInputProps } from '../fields/NumberInput';
-export type FormikNumberInputProps = Omit<NumberInputProps, 'defaultValue' | 'onChange'>;
+export type FormikNumberInputProps = Omit<NumberInputProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikNumberInput({ name, ...originalProps }: FormikNumberInputProps): JSX.Element;

package/src/formiks/FormikSelect.d.ts

@@ -1,3 +1,3 @@
 import type { SelectProps } from '../fields/Select';
-export type FormikSelectProps = Omit<SelectProps, 'defaultValue' | 'onChange'>;
+export type FormikSelectProps = Omit<SelectProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikSelect({ name, ...originalProps }: FormikSelectProps): JSX.Element;

package/src/formiks/FormikTextInput.d.ts

@@ -1,3 +1,3 @@
 import type { TextInputProps } from '../fields/TextInput';
-export type FormikTextInputProps = Omit<TextInputProps, 'defaultValue' | 'onChange'>;
+export type FormikTextInputProps = Omit<TextInputProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikTextInput({ name, ...originalProps }: FormikTextInputProps): JSX.Element;

package/src/formiks/FormikTextarea.d.ts

@@ -1,3 +1,3 @@
 import type { TextareaProps } from '../fields/Textarea';
-export type FormikTextareaProps = Omit<TextareaProps, 'defaultValue' | 'onChange'>;
+export type FormikTextareaProps = Omit<TextareaProps, 'defaultValue' | 'error' | 'onChange'>;
 export declare function FormikTextarea({ name, ...originalProps }: FormikTextareaProps): JSX.Element;

package/src/hooks/useClickOutsideEffect.d.ts

@@ -0,0 +1,3 @@
+import type { MutableRefObject } from 'react';
+import type { Promisable } from 'type-fest';
+export declare const useClickOutsideEffect: (zoneRefOrzoneRefs: MutableRefObject<any> | MutableRefObject<any>[], action: () => Promisable<void>, baseContainer?: Document | HTMLDivElement | null) => void;

package/src/hooks/useFieldUndefineEffect.d.ts

@@ -0,0 +1,2 @@
+import type { Promisable } from 'type-fest';
+export declare function useFieldUndefineEffect(disabled: boolean | undefined, onChange: ((nextValue: any) => Promisable<void>) | undefined): void;

package/src/index.d.ts

@@ -37,7 +37,7 @@ export { FormikSelect } from './formiks/FormikSelect';
 export { FormikTextarea } from './formiks/FormikTextarea';
 export { FormikTextInput } from './formiks/FormikTextInput';
 export * as Icon from './icons';
-export { useClickOutside } from './hooks/useClickOutside';
+export { useClickOutsideEffect } from './hooks/useClickOutsideEffect';
 export { useForceUpdate } from './hooks/useForceUpdate';
 export { dayjs } from './utils/dayjs';
 export { getLocalizedDayjs } from './utils/getLocalizedDayjs';
@@ -45,7 +45,7 @@ export { getUtcizedDayjs } from './utils/getUtcizedDayjs';
 export { noop } from './utils/noop';
 export { stopMouseEventPropagation } from './utils/stopMouseEventPropagation';
 export type { PartialTheme, Theme } from './theme';
-export type { DateAsStringRange, DateRange, IconProps, Option } from './types';
+export type { DateAsStringRange, DateRange, IconProps, Option, Undefine } from './types';
 export type { DropdownProps, DropdownItemProps } from './components/Dropdown';
 export type { ButtonProps } from './elements/Button';
 export type { FieldProps } from './elements/Field';

package/src/types.d.ts

@@ -10,3 +10,13 @@ export type Option<V = string> = {
     label: string;
     value: V;
 };
+/**
+ * Mark all the props type of an interface/type as `| undefined`
+ *
+ * @description
+ * When `exactOptionalPropertyTypes` is enabled in tsconfig.json,
+ * this is useful to create "partial" objects while keeping their props mandatory.
+ */
+export type Undefine<T> = {
+    [K in keyof T]: T[K] | undefined;
+};

package/src/hooks/useClickOutside.d.ts

@@ -1,3 +0,0 @@
-import type { MutableRefObject } from 'react';
-import type { Promisable } from 'type-fest';
-export declare const useClickOutside: (zoneRefOrzoneRefs: MutableRefObject<any> | MutableRefObject<any>[], action: () => Promisable<void>, baseContainer?: Document | HTMLDivElement | null) => void;