feat: add FileField definition

deno.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://deno.land/x/deno/cli/schemas/config-file.v1.json",
   "name": "@byzanteam/taihaku-schemas",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "exports": "./types/mod.ts",
   "license": "UNLICENSED",
   "compilerOptions": {

types/ui_schema/field.ts

@@ -5,6 +5,7 @@ export enum FieldType {
   Checkbox = 'Checkbox',
   Date = 'Date',
   DateTime = 'DateTime',
+  File = 'File',
   HasMany = 'HasMany',
   HasOne = 'HasOne',
   Numeric = 'Numeric',
@@ -26,9 +27,30 @@ interface AssocitaionSettings {
   associationResource: string
 }
 
+interface FileSettings {
+  /**
+   * Defines the max size of a file upload in megabytes (MB) (inclusive)
+   * that can be selected for uploading
+   * @default Infinity
+   */
+  maxFileItemSizeLimitInMB?: number
+  /**
+   * Count limit
+   * @default Infinity
+   */
+  maxCount?: number
+  /**
+   * Allowed mimetype pattern
+   * @default '*'
+   * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept
+   */
+  accept?: string
+}
+
 type SettingsRequiredFieldType =
   | FieldType.BelongsTo
   | FieldType.Checkbox
+  | FieldType.File
   | FieldType.HasMany
   | FieldType.HasOne
   | FieldType.RadioButton
@@ -37,6 +59,7 @@ type SettingsRequiredFieldType =
 interface FieldSettingsMap {
   [FieldType.BelongsTo]: AssocitaionSettings
   [FieldType.Checkbox]: EnumSettings
+  [FieldType.File]: FileSettings
   [FieldType.HasMany]: AssocitaionSettings
   [FieldType.HasOne]: AssocitaionSettings
   [FieldType.RadioButton]: EnumSettings

types/ui_schema/form/example/association.ts

@@ -7,6 +7,7 @@ const MovieFormUISchema: FormUISchema<
       id: string // format: 'uuid'
       name?: string
     }
+    score: number
     poster?: {
       id?: string // format: 'uuid'
       name: string
@@ -15,9 +16,8 @@ const MovieFormUISchema: FormUISchema<
   },
   /** Custom Widget UIOption Map */
   {
-    FileWidget: {
-      'ui:x-multiple': boolean
-      'ui:x-accept': string
+    RatingWidget: {
+      'ui:x-count'?: number
     }
   }
 > = {
@@ -33,8 +33,14 @@ const MovieFormUISchema: FormUISchema<
   },
   poster: {
     'ui:widget': 'FileWidget',
-    'ui:x-multiple': false,
+    'ui:x-max-file-item-size-limit-in-mb': 20,
+    'ui:x-capture': 'user',
     'ui:x-accept': 'image/*',
+    'ui:x-max-count': 1,
+  },
+  score: {
+    'ui:widget': 'RatingWidget',
+    'ui:x-count': 5,
   },
   actors: {
     'ui:widget': 'HasManyWidget',

types/ui_schema/form/ui_options.ts

@@ -76,12 +76,21 @@ type BooleanFieldUIOptions = {
   'ui:x-falsy-label'?: string
 } & CommonCustomFieldUIOptions
 
+type FileFieldUIOptions = {
+  'ui:x-max-file-item-size-limit-in-mb'?: number
+  'ui:x-accept'?: string
+  /** @link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/capture */
+  'ui:x-capture'?: 'user' | 'environment'
+  'ui:x-max-count'?: number
+} & CommonCustomFieldUIOptions
+
 export type CustomFieldUIOptionsMap = {
   [FieldType.BelongsTo]: AssociationFieldUIOptions
   [FieldType.Boolean]: BooleanFieldUIOptions
   [FieldType.Checkbox]: CheckBoxFieldUIOptions
   [FieldType.Date]: DateFieldUIOptions
   [FieldType.DateTime]: DateTimeFieldUIOptions
+  [FieldType.File]: FileFieldUIOptions
   [FieldType.HasMany]: AssociationFieldUIOptions
   [FieldType.HasOne]: AssociationFieldUIOptions
   [FieldType.Numeric]: NumericFieldUIOptions

types/ui_schema/table/example/simple.ts

@@ -21,9 +21,8 @@ const moviesTableSchema: TableSchema<
   },
   /** Custom Widget UIOption Map */
   {
-    FileWidget: {
-      'ui:x-multiple': boolean
-      'ui:x-accept': string
+    RatingWidget: {
+      'ui:x-count'?: number
     }
   }
 > = {
@@ -93,10 +92,12 @@ const moviesTableSchema: TableSchema<
     },
     poster: {
       name: 'poster',
-      fieldType: 'HasOneField',
+      fieldType: 'FileField',
       label: '海报',
       settings: {
-        associationResource: 'object',
+        accept: 'image/*',
+        maxCount: 1,
+        maxFileItemSizeLimitInMB: 20,
       },
     },
     actors: {
@@ -143,13 +144,15 @@ const moviesTableSchema: TableSchema<
     },
     poster: {
       'ui:widget': 'FileWidget',
-      'ui:x-multiple': false,
-      'ui:x-accept': 'image/*',
     },
     actors: {
       'ui:widget': 'HasManyWidget',
       'ui:x-display-property': 'name',
     },
+    score: {
+      'ui:widget': 'RatingWidget',
+      'ui:x-count': 5,
+    },
   },
 }
 

types/ui_schema/table/ui_options.ts

@@ -13,9 +13,7 @@ type DateTimeFieldUIOptions = CommonCustomFieldUIOptions & {
   'ui:x-format'?: string
 }
 
-type DateFieldUIOptions = CommonCustomFieldUIOptions & {
-  'ui:x-format'?: string
-}
+type DateFieldUIOptions = DateTimeFieldUIOptions
 
 type RadioButtonUIOptions = CommonCustomFieldUIOptions & {
   'ui:x-option-fallback-style'?: /** className */ string
@@ -25,31 +23,29 @@ type RadioButtonUIOptions = CommonCustomFieldUIOptions & {
   >
 }
 
-type CheckboxUIOptions = CommonCustomFieldUIOptions & {
-  'ui:x-option-fallback-style'?: /** className */ string
-  'ui:x-options-style'?: Record<
-    /** option-value */ string,
-    /** className */ string
-  >
-}
+type CheckboxUIOptions = RadioButtonUIOptions
 
 type AssociationUIOptions = CommonCustomFieldUIOptions & {
   /** which property should be shown as current assoication row value */
   'ui:x-display-property': string
 }
 
+type FileUIOptions = CommonCustomFieldUIOptions & {
+  'ui:x-capture'?: 'user' | 'environment'
+}
+
 type BooleanUIOptions = CommonCustomFieldUIOptions & {
   'ui:x-truthy-label'?: string
   'ui:x-falsy-label'?: string
 }
 
 export type CustomColumnUIOptionsMap = {
-  // TODO: define Checkbox to Signature's UIOptions
   [FieldType.BelongsTo]: AssociationUIOptions
   [FieldType.Boolean]: BooleanUIOptions
   [FieldType.Checkbox]: CheckboxUIOptions
   [FieldType.Date]: DateFieldUIOptions
   [FieldType.DateTime]: DateTimeFieldUIOptions
+  [FieldType.File]: FileUIOptions
   [FieldType.HasMany]: AssociationUIOptions
   [FieldType.HasOne]: AssociationUIOptions
   [FieldType.Numeric]: CommonCustomFieldUIOptions