@opengeoweb/form-fields 19.0.0 → 19.1.1

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+import formFieldsTranslations from '../locales/formFields.json';
+export * from './lib/components';
+export * from './lib/hooks/useDraftFormHelpers/useDraftFormHelpers';
+export { FORM_FIELDS_NAMESPACE } from './lib/utils/i18n';
+export { formFieldsTranslations };

package/dist/src/lib/components/DegreesMinutesField.d.ts

@@ -0,0 +1,15 @@
+import type { TFunction } from 'i18next';
+import React from 'react';
+export declare function decimalToDegreesMinutes(value: number): string;
+export declare function degreesMinutesToDecimal(input: string | number): number;
+interface Props {
+    name: string;
+    label: string;
+    disabled?: boolean;
+    isReadOnly?: boolean;
+    size?: 'small' | 'medium';
+    isLongitude?: boolean;
+    t: TFunction;
+}
+export declare const DegreesMinutesField: React.FC<Props>;
+export {};

package/dist/src/lib/components/Providers.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+import type { UseFormProps } from 'react-hook-form';
+export declare const zeplinLinks: {
+    name: string;
+    link: string;
+}[];
+interface StoryLayoutProps {
+    children?: React.ReactNode;
+}
+export declare const FormFieldsWrapper: React.FC<StoryLayoutProps & {
+    options?: UseFormProps;
+}>;
+export declare const FormFieldsWrappeDecorator: React.FC<StoryLayoutProps & {
+    isDarkTheme?: boolean;
+}>;
+export declare const FormFieldsI18nProvider: React.FC<{
+    children?: React.ReactNode;
+}>;
+export {};

package/dist/src/lib/components/ReactHookFormDateTime.d.ts

@@ -0,0 +1,24 @@
+import type { SxProps, Theme } from '@mui/material';
+import type { DateTimePickerProps, DateTimePickerSlotProps } from '@mui/x-date-pickers';
+import React from 'react';
+import type { ReactHookFormInput } from './types';
+/**
+ * Should return an isostring in the form "YYYY-MM-DDThh:mmZ";
+ * The milli seconds section should not be included, strictly YYYY-MM-DDThh:mm:ssZ is important
+ * @param value input Date
+ * @returns iso string in YYYY-MM-DDThh:mm format.
+ */
+export declare const getFormattedValueForDatePicker: (value: Date) => string | null;
+export declare const getDateValue: (value: string) => Date | null;
+type ReactHookKeyboardDateTimePickerProps = DateTimePickerProps & DateTimePickerSlotProps & ReactHookFormInput<{
+    defaultNullValue?: string | null;
+    value?: string;
+    onChange?: (value: Date | string | null) => void;
+    format?: string;
+    sx?: SxProps<Theme>;
+}> & {
+    'data-testid'?: string;
+    shouldHideUTC?: boolean;
+};
+declare const ReactHookKeyboardDateTimePicker: React.FC<ReactHookKeyboardDateTimePickerProps>;
+export default ReactHookKeyboardDateTimePicker;

package/dist/src/lib/components/ReactHookFormFormControl.d.ts

@@ -0,0 +1,12 @@
+import type { FormControlProps } from '@mui/material';
+import type { TFunction } from 'i18next';
+import React from 'react';
+import type { FieldErrors } from 'react-hook-form';
+interface ReactHookFormFormControlProps extends FormControlProps {
+    children?: React.ReactNode;
+    errors?: FieldErrors;
+    isReadOnly?: boolean;
+}
+export declare const getErrorMessage: (t: TFunction, errors: FieldErrors) => string;
+declare const ReactHookFormFormControl: React.FC<ReactHookFormFormControlProps>;
+export default ReactHookFormFormControl;

package/dist/src/lib/components/ReactHookFormHiddenInput.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import type { ReactHookFormInput } from './types';
+type ReactHookFormHiddenInputProps = ReactHookFormInput<{
+    defaultValue?: unknown;
+}>;
+declare const ReactHookFormHiddenInput: React.FC<ReactHookFormHiddenInputProps>;
+export default ReactHookFormHiddenInput;

package/dist/src/lib/components/ReactHookFormNumberField.d.ts

@@ -0,0 +1,12 @@
+import type { TextFieldProps } from '@mui/material';
+import React from 'react';
+import type { ReactHookFormInput } from './types';
+type InputMode = 'numeric' | 'decimal';
+export declare const convertNumericInputValue: (value: string, inputMode: InputMode) => number | null;
+export declare const getAllowedKeys: (inputMode?: InputMode) => string[];
+type ReactHookFormNumberFieldProps = Partial<TextFieldProps> & ReactHookFormInput<{
+    inputMode?: InputMode;
+    onBeforeChange?: () => void;
+}>;
+declare const ReactHookFormNumberField: React.FC<ReactHookFormNumberFieldProps>;
+export default ReactHookFormNumberField;

package/dist/src/lib/components/ReactHookFormProvider.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { UseFormProps } from 'react-hook-form';
+interface WrapperProps {
+    children: React.ReactNode;
+    options?: UseFormProps;
+}
+export declare const defaultFormOptions: UseFormProps;
+declare const ReactHookFormProviderWrapper: React.FC<WrapperProps>;
+export default ReactHookFormProviderWrapper;

package/dist/src/lib/components/ReactHookFormRadioGroup.d.ts

@@ -0,0 +1,9 @@
+import type { RadioGroupProps } from '@mui/material';
+import React from 'react';
+import type { ReactHookFormInput } from './types';
+type ReactHookFormRadioGroupProps = Partial<RadioGroupProps> & ReactHookFormInput<{
+    disabled?: boolean;
+    children?: React.ReactNode;
+}>;
+declare const ReactHookFormRadioGroup: React.FC<ReactHookFormRadioGroupProps>;
+export default ReactHookFormRadioGroup;

package/dist/src/lib/components/ReactHookFormSelect.d.ts

@@ -0,0 +1,8 @@
+import type { SelectProps } from '@mui/material';
+import React from 'react';
+import type { ReactHookFormInput } from './types';
+type ReactHookFormSelectProps = Partial<SelectProps> & ReactHookFormInput<{
+    onBeforeChange?: () => void;
+}>;
+declare const ReactHookFormSelect: React.FC<ReactHookFormSelectProps>;
+export default ReactHookFormSelect;

package/dist/src/lib/components/ReactHookFormTextField.d.ts

@@ -0,0 +1,10 @@
+import type { BaseTextFieldProps, FilledInputProps, SlotCommonProps, SlotProps, TextFieldProps } from '@mui/material';
+import React from 'react';
+import type { ReactHookFormInput } from './types';
+export declare const convertTextInputValue: (value: string, inCapitals: boolean) => number | string;
+type ReactHookFormTextFieldProps = Partial<TextFieldProps> & ReactHookFormInput<{
+    upperCase?: boolean;
+    inputSlotProps?: SlotProps<React.ElementType<FilledInputProps, keyof React.JSX.IntrinsicElements>, SlotCommonProps, BaseTextFieldProps> | undefined;
+}>;
+declare const ReactHookFormTextField: React.FC<ReactHookFormTextFieldProps>;
+export default ReactHookFormTextField;

package/dist/src/lib/components/formUtils.d.ts

@@ -0,0 +1,3 @@
+import type { FieldErrors } from 'react-hook-form';
+export declare function getDeepProperty<I>(property: string[], state: I): I | null;
+export declare const getErrors: (name: string, errors: FieldErrors) => FieldErrors | undefined;

package/dist/src/lib/components/index.d.ts

@@ -0,0 +1,13 @@
+export { default as ReactHookFormSelect } from './ReactHookFormSelect';
+export { default as ReactHookFormRadioGroup } from './ReactHookFormRadioGroup';
+export { default as ReactHookFormTextField } from './ReactHookFormTextField';
+export { default as ReactHookFormNumberField } from './ReactHookFormNumberField';
+export { default as ReactHookFormFormControl } from './ReactHookFormFormControl';
+export { default as ReactHookFormDateTime } from './ReactHookFormDateTime';
+export * from './ReactHookFormDateTime';
+export { default as ReactHookFormProvider } from './ReactHookFormProvider';
+export { default as ReactHookFormHiddenInput } from './ReactHookFormHiddenInput';
+export { DegreesMinutesField } from './DegreesMinutesField';
+export { defaultFormOptions } from './ReactHookFormProvider';
+export { errorMessages, isMaximumOneDrawing, hasValidGeometry, isGeometryDirty, isValidGeoJsonCoordinates, hasIntersectionWithFIR, countIntersectionPoints, isValidMax, isValidMin, isInteger, hasMulitpleIntersections, isLatitude, isLongitude, isNonOrBothCoordinates, isEmpty, isXHoursAfter, isXHoursBefore, } from './utils';
+export { getDeepProperty } from './formUtils';

package/dist/src/lib/components/types.d.ts

@@ -0,0 +1,8 @@
+import type { RegisterOptions } from 'react-hook-form';
+export type ReactHookFormInput<T> = T & {
+    name: string;
+    label?: string;
+    rules?: RegisterOptions;
+    helperText?: string;
+    isReadOnly?: boolean;
+};

package/dist/src/lib/components/utils.d.ts

@@ -0,0 +1,37 @@
+import type { Polygon } from 'geojson';
+export declare const defaultProps: {
+    shouldUnregister: boolean;
+};
+export declare const errorMessages: {
+    required: string;
+    isValidDate: string;
+    isAfter: string;
+    isXHoursBefore: string;
+    isXHoursAfter: string;
+    isBefore: string;
+    minLevel: string;
+    isLatitude: string;
+    isLongitude: string;
+    isValidMax: string;
+    isLevelLower: string;
+    isNonOrBothCoordinates: string;
+    isInteger: string;
+    isNumeric: string;
+};
+export declare const isEmpty: (value?: number | string | null) => boolean;
+export declare const isXHoursBefore: (ownDate: string, otherDate: string, hours?: number) => boolean;
+export declare const isXHoursAfter: (ownDate: string, otherDate: string, hours?: number) => boolean;
+export declare const isLatitude: (lat?: number | null) => boolean;
+export declare const isLongitude: (lng?: number | null) => 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?: GeoJSON.FeatureCollection | null) => boolean;
+export declare const isValidGeoJsonCoordinates: (geojson: GeoJSON.FeatureCollection) => boolean;
+export declare const isMaximumOneDrawing: (geojson: GeoJSON.FeatureCollection) => boolean;
+export declare const hasIntersectionWithFIR: (geojson: GeoJSON.FeatureCollection, intersection: GeoJSON.FeatureCollection) => boolean;
+export declare const hasMulitpleIntersections: (geojson: GeoJSON.FeatureCollection) => boolean;
+export declare const countIntersectionPoints: (geojson: GeoJSON.FeatureCollection<Polygon>, intersection: GeoJSON.FeatureCollection<Polygon>) => number;
+export declare const isGeometryDirty: (geoJSON?: GeoJSON.FeatureCollection | null, formGeoJSON?: GeoJSON.FeatureCollection | null) => boolean;
+export declare const isInteger: (value: number) => boolean;
+export declare const isNumeric: (value: any) => boolean;
+export declare const isNonOrBothCoordinates: (coordinate?: number | null, otherCoordinate?: number | null) => boolean;

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

@@ -0,0 +1,8 @@
+import 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/dist/src/lib/utils/i18n.d.ts

@@ -0,0 +1,7 @@
+import i18n from 'i18next';
+import type { UseTranslationResponse } from 'react-i18next';
+export declare const FORM_FIELDS_NAMESPACE = "form-fields";
+export declare const initFormFieldsI18n: () => void;
+export declare const translateInTestsAndStories: (key: string, params?: Record<string, string | number> | undefined) => string;
+export declare const useFormFieldsTranslation: () => UseTranslationResponse<typeof FORM_FIELDS_NAMESPACE, typeof i18n>;
+export { i18n };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/form-fields",
-  "version": "19.0.0",
+  "version": "19.1.1",
   "description": "GeoWeb form-fields library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -40,6 +40,7 @@
   },
   "files": [
     "dist",
+    "!dist/package.json",
     "README.md",
     "package.json"
   ]