@mtes-mct/monitor-ui 8.4.0 → 8.5.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": "8.4.0",
+  "version": "8.5.0",
   "license": "AGPL-3.0",
   "engines": {
     "node": ">=18"

package/src/index.d.ts

@@ -65,13 +65,20 @@ export { CustomSearch } from './libs/CustomSearch';
 export { customDayjs } from './utils/customDayjs';
 export { getCoordinates, coordinatesAreDistinct } from './utils/coordinates';
 export { getLocalizedDayjs } from './utils/getLocalizedDayjs';
+export { getOptionsFromIdAndName } from './utils/getOptionsFromIdAndName';
+export { getOptionsFromLabelledEnum } from './utils/getOptionsFromLabelledEnum';
 export { getPseudoRandomString } from './utils/getPseudoRandomString';
 export { getUtcizedDayjs } from './utils/getUtcizedDayjs';
+export { isArray } from './utils/isArray';
+export { isDefined } from './utils/isDefined';
 export { isNumeric } from './utils/isNumeric';
+export { isObject } from './utils/isObject';
 export { logSoftError } from './utils/logSoftError';
+export { nullify } from './utils/nullify';
 export { stopMouseEventPropagation } from './utils/stopMouseEventPropagation';
+export { undefine } from './utils/undefine';
 export type { PartialTheme, Theme } from './theme';
-export type { Coordinates, DateAsStringRange, DateRange, Defined, IconProps, Option, OptionValueType, Undefine } from './types';
+export type { Coordinates, DateAsStringRange, DateRange, Defined, IconProps, Option, OptionValueType, Undefine, UndefineExceptArrays } from './types';
 export type { DialogProps } from './components/Dialog';
 export type { DropdownProps, DropdownItemProps } from './components/Dropdown';
 export type { NewWindowProps } from './components/NewWindow';

package/src/types.d.ts

@@ -66,6 +66,40 @@ export type Define<T> = {
 export type Undefine<T> = {
     [K in keyof T]: T[K] | undefined;
 };
+/**
+ * Mark all the prop types of an interface/type as `prop: <MyType> | undefined` while preserving array props.
+ *
+ * @description
+ * When `exactOptionalPropertyTypes` is enabled in tsconfig.json,
+ * this is useful to create objects allowing undefined prop values while keeping all their props required.
+ *
+ * Opposite of `Defined`.
+ *
+ * @example
+ * ```
+ * type MyType {
+ *   aRequiredProp: string
+ *   anOptionalProp?: string
+ *   anArrayProp: number[]
+ * }
+ *
+ * // `type MyPartialType = UndefineExceptArrays<MyType>` is the same as typing:
+ * type MyPartialType {
+ *   aRequiredProp: string | undefined
+ *   anOptionalProp?: string | undefined
+ *   anArrayProp: number[]
+ * }
+ * ```
+ */
+export type UndefineExceptArrays<T> = {
+    [K in keyof T]: T[K] extends (infer U)[] ? U[] : T[K] | undefined;
+};
+export type Native = boolean | null | number | string | undefined;
+export type NativeAny = boolean | NativeArray | NativeObject | null | number | string | undefined;
+export type NativeArray = Array<NativeAny>;
+export type NativeObject = {
+    [x: string]: NativeAny;
+} | {};
 /**
  * Since Rsuite restricts `value` to `string | number`, we use this proxy type,
  * allowing us to use conventioned option values that can include objects

package/src/utils/getOptionsFromIdAndName.d.ts

@@ -0,0 +1,5 @@
+import type { Option } from '../types';
+export declare function getOptionsFromIdAndName(collection: Array<{
+    id: number;
+    name: string;
+}> | undefined): Array<Option<number>> | undefined;

package/src/utils/getOptionsFromLabelledEnum.d.ts

@@ -0,0 +1,2 @@
+import type { Option } from '../types';
+export declare function getOptionsFromLabelledEnum(labelledEnum: Record<string, string>): Option[];

package/src/utils/isArray.d.ts

@@ -0,0 +1 @@
+export declare function isArray<T>(value: any): value is T[];

package/src/utils/isDefined.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Is the value defined and non-null?
+ */
+export declare function isDefined<T>(value?: T | null | undefined): value is T;

package/src/utils/isObject.d.ts

@@ -0,0 +1,3 @@
+export declare function isObject<T extends {
+    [key: string]: any;
+}>(value: any): value is T;

package/src/utils/nullify.d.ts

@@ -0,0 +1,14 @@
+import type { NativeAny } from '../types';
+type Nullify<T> = T extends undefined ? null : T extends Array<any> ? {
+    [K in keyof T]: T[K] extends (infer U)[] ? Nullify<U>[] : Nullify<T[K]>;
+} : T extends Record<string, any> ? {
+    [K in keyof T]: T[K] extends (infer U)[] ? Nullify<U>[] : Nullify<T[K]>;
+} : T;
+/**
+ * Transform all `undefined` values into `null` ones in any type of value
+ *
+ * @description
+ * The value must be of native type and only contains native types.
+ */
+export declare function nullify<T extends NativeAny>(value: T): Nullify<T> | null;
+export {};

package/src/utils/undefine.d.ts

@@ -0,0 +1,14 @@
+import type { NativeAny } from '../types';
+type Undefine<T> = T extends null ? undefined : T extends Array<any> ? {
+    [K in keyof T]: T[K] extends (infer U)[] ? Undefine<U>[] : Undefine<T[K]>;
+} : T extends Record<string, any> ? {
+    [K in keyof T]: T[K] extends (infer U)[] ? Undefine<U>[] : Undefine<T[K]>;
+} : T;
+/**
+ * Transform all `null` values into `undefined` ones in any type of value
+ *
+ * @description
+ * The value must be of native type and only contains native types.
+ */
+export declare function undefine<T extends NativeAny>(value: T): Undefine<T> | undefined;
+export {};