refactor: FileItem typing

app/src/components/globals/formItems/FileItem.vue

@@ -2,46 +2,39 @@
 import type { BFormFile } from 'bootstrap-vue-next'
 import { computed, inject, ref } from 'vue'
 
+import { ValidationTouchSymbol } from '@/composables/form'
 import { getFileContent } from '@/helpers/commons'
-
+import type {
-type CustomFile = {
+  BaseItemComputedProps,
-  file: File | null
+  FileItemProps,
-  content?: string | null
+  FileModelValue,
-  current?: boolean
+} from '@/types/form'
-  removed?: boolean
-}
 
 const props = withDefaults(
-  defineProps<{
+  defineProps<FileItemProps & BaseItemComputedProps<FileModelValue>>(),
-    id?: string
-    modelValue?: CustomFile
-    placeholder?: string
-    dropPlaceholder?: string
-    accept?: string
-    state?: string
-    required?: boolean
-    name?: string
-  }>(),
   {
     id: undefined,
-    modelValue: () => ({ file: null }),
-    placeholder: 'Choose a file or drop it here...',
-    dropPlaceholder: undefined,
-    accept: '',
-    state: undefined,
-    required: false,
     name: undefined,
+    placeholder: 'Choose a file or drop it here...',
+    touchKey: undefined,
+    accept: '',
+    dropPlaceholder: undefined,
+
+    ariaDescribedby: undefined,
+    modelValue: () => ({ file: null }),
+    state: undefined,
+    validation: undefined,
   },
 )
 
 const emit = defineEmits<{
-  'update:modelValue': [value: CustomFile]
+  'update:modelValue': [value: FileModelValue]
 }>()
 
-const touch = inject('touch')
+const touch = inject(ValidationTouchSymbol)
 const inputElem = ref<InstanceType<typeof BFormFile> | null>(null)
 
-const _placeholder = computed(() => {
+const placeholder = computed(() => {
   return props.modelValue.file === null
     ? props.placeholder
     : props.modelValue.file.name
@@ -72,34 +65,34 @@ function clearFiles() {
     removed: true,
   })
 }
+
+const required = computed(() => 'required' in (props.validation ?? {}))
 </script>
 
 <template>
   <BInputGroup class="w-100">
-    <template #append>
+    <template v-if="!required && modelValue.file !== null" #append>
-      <BButton
+      <BButton variant="danger" @click="clearFiles">
-        v-if="!required && modelValue.file !== null"
-        @click="clearFiles"
-        variant="danger"
-      >
         <span class="visually-hidden">{{ $t('delete') }}</span>
         <YIcon iname="trash" />
       </BButton>
     </template>
 
     <BFormFile
-      :modelValue="modelValue.file"
-      ref="inputElem"
       :id="id"
-      :required="required"
+      ref="inputElem"
-      :placeholder="_placeholder"
+      :name="name"
+      :placeholder="placeholder"
       :accept="accept"
       :drop-placeholder="dropPlaceholder"
+      :aria-describedby="ariaDescribedby"
+      :model-value="modelValue.file"
       :state="state"
       :browse-text="$t('words.browse')"
-      @update:modelValue="onInput"
+      :required="required"
-      @blur="touch(name)"
+      @blur="touch?.(touchKey)"
-      @focusout="touch(name)"
+      @focusout="touch?.(touchKey)"
+      @update:model-value="onInput"
     />
   </BInputGroup>
 </template>

app/src/helpers/commons.ts

@@ -117,16 +117,17 @@ export function randint(min, max) {
 /**
  * Returns a File content.
  *
- * @param {File} file
+ * @param file -
- * @param {Object} [extraParams] - Optionnal params
+ * @param base64 - returns a base64 representation of the file.
- * @param {Boolean} [extraParams.base64] - returns a base64 representation of the file.
- * @return {Promise<String>}
  */
-export function getFileContent(file, { base64 = false } = {}) {
+export function getFileContent(
+  file: File,
+  { base64 = false } = {},
+): Promise<string> {
   return new Promise((resolve, reject) => {
     const reader = new FileReader()
     reader.onerror = reject
-    reader.onload = () => resolve(reader.result)
+    reader.onload = () => resolve(reader.result as string)
 
     if (base64) {
       reader.readAsDataURL(file)

app/src/types/form.ts

@@ -33,3 +33,14 @@ export type CheckboxItemProps = BaseWritableItemProps & {
   // FIXME unused?
   // choices: string[]
 }
+
+export type FileItemProps = BaseWritableItemProps & {
+  accept?: string | string[]
+  dropPlaceholder?: string
+}
+export type FileModelValue = {
+  file: File | null
+  content?: string | null
+  current?: boolean
+  removed?: boolean
+}