@dhis2/ui-forms 8.15.0 → 8.16.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/ui-forms",
-    "version": "8.15.0",
+    "version": "8.16.0-alpha.1",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "sideEffects": [
@@ -8,6 +8,7 @@
         "build/cjs/locales/index.js"
     ],
     "exports": {
+        "types": "./types/index.d.ts",
         "import": "./build/es/index.js",
         "require": "./build/cjs/index.js"
     },
@@ -34,25 +35,27 @@
     },
     "dependencies": {
         "@dhis2/prop-types": "^3.1.2",
-        "@dhis2-ui/button": "8.15.0",
-        "@dhis2-ui/checkbox": "8.15.0",
-        "@dhis2-ui/field": "8.15.0",
-        "@dhis2-ui/file-input": "8.15.0",
-        "@dhis2-ui/input": "8.15.0",
-        "@dhis2-ui/radio": "8.15.0",
-        "@dhis2-ui/select": "8.15.0",
-        "@dhis2-ui/switch": "8.15.0",
-        "@dhis2-ui/text-area": "8.15.0",
+        "@dhis2-ui/button": "8.16.0-alpha.1",
+        "@dhis2-ui/checkbox": "8.16.0-alpha.1",
+        "@dhis2-ui/field": "8.16.0-alpha.1",
+        "@dhis2-ui/file-input": "8.16.0-alpha.1",
+        "@dhis2-ui/input": "8.16.0-alpha.1",
+        "@dhis2-ui/radio": "8.16.0-alpha.1",
+        "@dhis2-ui/select": "8.16.0-alpha.1",
+        "@dhis2-ui/switch": "8.16.0-alpha.1",
+        "@dhis2-ui/text-area": "8.16.0-alpha.1",
         "classnames": "^2.3.1",
         "final-form": "^4.20.2",
         "prop-types": "^15.7.2",
         "react-final-form": "^6.5.3"
     },
     "files": [
-        "build"
+        "build",
+        "types"
     ],
     "devDependencies": {
         "react": "16.13",
         "react-dom": "16.13"
-    }
+    },
+    "types": "types"
 }

package/types/CheckboxFieldFF/CheckboxFieldFF.d.ts

@@ -0,0 +1,16 @@
+import type { FieldRenderProps } from 'react-final-form'
+import type { CheckboxFieldProps } from '@dhis2-ui/checkbox'
+import React from 'react'
+
+type CheckBoxValue = CheckboxFieldProps['value']
+type CheckboxRestProps = Omit<
+    CheckboxFieldProps,
+    'onChange' | 'value' | 'checked' | 'name'
+>
+
+export type CheckboxFieldFFProps = FieldRenderProps<CheckBoxValue> &
+    CheckboxRestProps & {
+        showValidStatus?: boolean
+    }
+
+export const CheckboxFieldFF: React.FC<CheckboxFieldFFProps>

package/types/FieldGroupFF/FieldGroupFF.d.ts

@@ -0,0 +1,9 @@
+import React from 'react'
+import type { FieldGroupProps } from '@dhis2-ui/field'
+
+export type FieldGroupFFProps = Omit<
+    FieldGroupProps,
+    'children' | 'label' | 'name' | 'required'
+>
+
+export const FieldGroupFF: React.FC<FieldGroupFFProps>

package/types/FileInputFieldFF/FileInputFieldFF.d.ts

@@ -0,0 +1,18 @@
+import React from 'react'
+import type { FileInputFieldProps } from '@dhis2-ui/file-input'
+import type { FieldRenderProps } from 'react-final-form'
+
+export type FilesValue = File[] | undefined | null | ''
+
+type FileInputRestProps = Omit<
+    FileInputFieldProps,
+    'onChange' | 'multiple' | 'name'
+>
+
+export type FileInputFieldFFProps = FieldRenderProps<FilesValue> &
+    FileInputRestProps & {
+        showValidStatus?: boolean
+        multifile: FileInputFieldProps['multiple']
+    }
+
+export const FileInputFieldFF: React.FC<FileInputFieldFFProps>

package/types/InputFieldFF/InputFieldFF.d.ts

@@ -0,0 +1,15 @@
+import React from 'react'
+import type { InputFieldProps } from '@dhis2-ui/input'
+import type { FieldRenderProps } from 'react-final-form'
+
+export type InputValue = InputFieldProps['value']
+
+type InputFieldRestProps = Omit<InputFieldProps, 'onChange' | 'value' | 'name'>
+
+export type InputFieldFFProps = FieldRenderProps<InputValue> &
+    InputFieldRestProps & {
+        showLoadingStatus?: boolean
+        showValidStatus?: boolean
+    }
+
+export const InputFieldFF: React.FC<InputFieldFFProps>

package/types/MultiSelectFieldFF/MutliSelectFieldFF.d.ts

@@ -0,0 +1,24 @@
+import React from 'react'
+import type { FieldRenderProps } from 'react-final-form'
+import type {
+    MultiSelectOptionProps,
+    MultiSelectFieldProps,
+} from '@dhis2-ui/select'
+
+type InputValue = MultiSelectFieldProps['selected'] | ''
+
+type MultiSelectFieldRestProps = Omit<
+    MultiSelectFieldProps,
+    'onChange' | 'value'
+>
+
+type MultiSelectOptions = Array<Pick<MultiSelectOptionProps, 'value' | 'label'>>
+
+export type MultiSelectFieldFFProps = FieldRenderProps<InputValue> &
+    MultiSelectFieldRestProps & {
+        showLoadingStatus?: boolean
+        showValidStatus?: boolean
+        options: MultiSelectOptions
+    }
+
+export const MultiSelectFieldFF: React.FC<MultiSelectFieldFFProps>

package/types/RadioFieldFF/RadioFieldFF.d.ts

@@ -0,0 +1,17 @@
+import React from 'react'
+import type { FieldRenderProps } from 'react-final-form'
+import type { RadioProps } from '@dhis2-ui/radio'
+
+type InputValue = RadioProps['value']
+
+type RadioRestProps = Omit<
+    RadioProps,
+    'onChange' | 'value' | 'checked' | 'name'
+>
+
+export type RadioFieldFFProps = FieldRenderProps<InputValue> &
+    RadioRestProps & {
+        showValidStatus?: boolean
+    }
+
+export const RadioFieldFF: React.FC<RadioFieldFFProps>

package/types/SingleSelectFieldFF/SingleSelectFieldFF.d.ts

@@ -0,0 +1,26 @@
+import React from 'react'
+import type { FieldRenderProps } from 'react-final-form'
+import type {
+    SingleSelectOptionProps,
+    SingleSelectFieldProps,
+} from '@dhis2-ui/select'
+
+type InputValue = SingleSelectFieldProps['selected']
+
+type SingleSelectOptions = Array<
+    Pick<SingleSelectOptionProps, 'value' | 'label'>
+>
+
+type SingleSelectRestProps = Omit<
+    SingleSelectFieldProps,
+    'onChange' | 'value' | 'name'
+>
+
+export type SingleSelectFieldFFProps = FieldRenderProps<InputValue> &
+    SingleSelectRestProps & {
+        showLoadingStatus?: boolean
+        showValidStatus?: boolean
+        options: SingleSelectOptions
+    }
+
+export const SingleSelectFieldFF: React.FC<SingleSelectFieldFFProps>

package/types/SwitchFieldFF/SwitchFieldFF.d.ts

@@ -0,0 +1,15 @@
+import React from 'react'
+import type { FieldRenderProps } from 'react-final-form'
+import type { SwitchFieldProps } from '@dhis2-ui/switch'
+
+type InputValue = SwitchFieldProps['value']
+
+type SwitchFieldRestProps = Omit<
+    SwitchFieldProps,
+    'onChange' | 'checked' | 'value' | 'name'
+>
+
+export type SwitchFieldFFProps = FieldRenderProps<InputValue> &
+    SwitchFieldRestProps
+
+export const SwitchFieldFF: React.FC<SwitchFieldFFProps>

package/types/TextAreaFieldFF/TextAreaFieldFF.d.ts

@@ -0,0 +1,15 @@
+import React from 'react'
+import type { FieldRenderProps } from 'react-final-form'
+import type { TextAreaFieldProps } from '@dhis2-ui/text-area'
+
+type InputValue = TextAreaFieldProps['value']
+
+type TextAreaFieldRestProps = Omit<
+    TextAreaFieldProps,
+    'onChange' | 'value' | 'name'
+>
+
+export type TextAreaFieldFFProps = FieldRenderProps<InputValue> &
+    TextAreaFieldRestProps
+
+export const TextAreaFieldFF: React.FC<TextAreaFieldFFProps>

package/types/index.d.ts

@@ -0,0 +1,28 @@
+import * as FinalForm from 'final-form'
+import * as ReactFinalForm from 'react-final-form'
+
+export { CheckboxFieldFF } from './CheckboxFieldFF/CheckboxFieldFF'
+export { FileInputFieldFF } from './FileInputFieldFF/FileInputFieldFF'
+export { InputFieldFF } from './InputFieldFF/InputFieldFF'
+export { MultiSelectFieldFF } from './MultiSelectFieldFF/MutliSelectFieldFF'
+export { SingleSelectFieldFF } from './SingleSelectFieldFF/SingleSelectFieldFF'
+export { RadioFieldFF } from './RadioFieldFF/RadioFieldFF'
+export { SwitchFieldFF } from './SwitchFieldFF/SwitchFieldFF'
+export { TextAreaFieldFF } from './TextAreaFieldFF/TextAreaFieldFF'
+export { FieldGroupFF } from './FieldGroupFF/FieldGroupFF'
+
+export * from './transformers'
+export * from './validators'
+
+/**
+ * Allows direct access to the FinalForm library. Please note that this is considered advanced
+ * usage and that you need to stay up to date with breaking changes in the FinalForm library.
+ */
+export { FinalForm }
+
+/**
+ * Allows direct access to the ReactFinalForm library. Please note that this is considered
+ * advanced usage and that you need to stay up to date with breaking changes in the FinalForm
+ * library.
+ */
+export { ReactFinalForm }

package/types/transformers/index.d.ts

@@ -0,0 +1,6 @@
+export type ValuesWithId = Array<{ id: string }> | undefined
+
+export const arrayWithIdObjects: {
+    format: (value: ValuesWithId) => string
+    pars: (value: string) => ValuesWithId
+}

package/types/validators/index.d.ts

@@ -0,0 +1,31 @@
+export type Validator = (value: unknown) => string | undefined
+
+export const alphaNumeric: Validator
+export const boolean: Validator
+export const composeValidators: (...validators: Validator[]) => Validator
+
+export const createCharacterLengthRange: (
+    lowerBound: number,
+    upperBound: number,
+    customMessage?: string
+) => Validator
+export const createEqualTo: (key: string, description?: string) => Validator
+export const createMaxCharacterLength: (upperBound: number) => Validator
+export const createMaxNumber: (upperBound: number) => Validator
+export const createMinCharacterLength: (lowerBound: number) => Validator
+export const createMinNumber: (lowerBound: number) => Validator
+export const createNumberRange: (
+    lowerBound: number,
+    upperBound: number,
+    customMessage?: string
+) => Validator
+export const createPattern: (pattern: RegExp, message?: string) => Validator
+export const dhis2Password: Validator
+export const dhis2Username: Validator
+export const email: Validator
+export const hasValue: Validator
+export const integer: Validator
+export const internationalPhoneNumber: Validator
+export const number: Validator
+export const string: Validator
+export const url: Validator