[schema] Validate file, image schema fields

sanity-io · Nov 30, 2019 · ea6825e · ea6825e
1 parent daae65f
commit ea6825e
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 20 deletions.
diff --git a/packages/@sanity/schema/src/sanity/groupProblems.ts b/packages/@sanity/schema/src/sanity/groupProblems.ts
@@ -35,6 +35,8 @@ function createTypeWithMembersProblemsAccessor(
 const arrify = val => (Array.isArray(val) ? val : (typeof val === 'undefined' && []) || [val])
 
 const getObjectProblems = createTypeWithMembersProblemsAccessor('fields')
+const getImageProblems = createTypeWithMembersProblemsAccessor('fields')
+const getFileProblems = createTypeWithMembersProblemsAccessor('fields')
 const getArrayProblems = createTypeWithMembersProblemsAccessor('of')
 const getReferenceProblems = createTypeWithMembersProblemsAccessor('to', type => arrify(type.to))
 const getBlockAnnotationProblems = createTypeWithMembersProblemsAccessor('marks.annotations')
@@ -70,6 +72,12 @@ export function getTypeProblems(type, path = []): TypeWithProblems[] {
     case 'block': {
       return getBlockProblems(type, path)
     }
+    case 'image': {
+      return getImageProblems(type, path)
+    }
+    case 'file': {
+      return getFileProblems(type, path)
+    }
     default: {
       return getDefaultProblems(type, path)
     }

diff --git a/packages/@sanity/schema/src/sanity/validation/createValidationResult.ts b/packages/@sanity/schema/src/sanity/validation/createValidationResult.ts
@@ -12,6 +12,7 @@ export const HELP_IDS = {
   OBJECT_FIELDS_INVALID: 'schema-object-fields-invalid',
   OBJECT_FIELD_NOT_UNIQUE: 'schema-object-fields-invalid',
   OBJECT_FIELD_NAME_INVALID: 'schema-object-fields-invalid',
+  OBJECT_FIELD_DEFINITION_INVALID_TYPE: 'schema-object-fields-invalid',
   ARRAY_OF_ARRAY: 'schema-array-of-array',
   ARRAY_OF_INVALID: 'schema-array-of-invalid',
   ARRAY_OF_NOT_UNIQUE: 'schema-array-of-invalid',

diff --git a/packages/@sanity/schema/src/sanity/validation/types/file.ts b/packages/@sanity/schema/src/sanity/validation/types/file.ts
@@ -1,7 +1,13 @@
 import {error, HELP_IDS} from '../createValidationResult'
+import {validateFields, validateField} from './object'
 
 export default (typeDef, visitorContext) => {
   const problems = []
+  let fields = typeDef.fields
+
+  if (fields) {
+    problems.push(...validateFields(fields, {allowEmpty: true}))
+  }
 
   if (
     typeDef.options &&
@@ -18,6 +24,15 @@ export default (typeDef, visitorContext) => {
 
   return {
     ...typeDef,
+    fields: (Array.isArray(fields) ? fields : []).map(field => {
+      const {name, ...fieldTypeDef} = field
+      const {_problems, ...fieldType} = visitorContext.visit(fieldTypeDef, visitorContext)
+      return {
+        name,
+        ...fieldType,
+        _problems: validateField(field, visitorContext).concat(_problems || [])
+      }
+    }),
     _problems: problems
   }
 }
diff --git a/packages/@sanity/schema/src/sanity/validation/types/image.ts b/packages/@sanity/schema/src/sanity/validation/types/image.ts
@@ -1,7 +1,13 @@
 import {error, HELP_IDS} from '../createValidationResult'
+import {validateFields, validateField} from './object'
 
 export default (typeDef, visitorContext) => {
   const problems = []
+  let fields = typeDef.fields
+
+  if (fields) {
+    problems.push(...validateFields(fields, {allowEmpty: true}))
+  }
 
   if (
     typeDef.options &&
@@ -18,6 +24,15 @@ export default (typeDef, visitorContext) => {
 
   return {
     ...typeDef,
+    fields: (Array.isArray(fields) ? fields : []).map(field => {
+      const {name, ...fieldTypeDef} = field
+      const {_problems, ...fieldType} = visitorContext.visit(fieldTypeDef, visitorContext)
+      return {
+        name,
+        ...fieldType,
+        _problems: validateField(field, visitorContext).concat(_problems || [])
+      }
+    }),
     _problems: problems
   }
 }
diff --git a/packages/@sanity/schema/src/sanity/validation/types/object.ts b/packages/@sanity/schema/src/sanity/validation/types/object.ts
@@ -1,3 +1,4 @@
+import {isPlainObject} from 'lodash'
 import {error, HELP_IDS, warning} from '../createValidationResult'
 import inspect from '../../inspect'
 
@@ -47,7 +48,16 @@ function validateFieldName(name): Array<any> {
   return []
 }
 
-function validateField(field, visitorContext) {
+export function validateField(field, visitorContext) {
+  if (!isPlainObject(field)) {
+    return [
+      error(
+        `Incorrect type for field definition - should be an object, saw ${inspect(field)}`,
+        HELP_IDS.OBJECT_FIELD_DEFINITION_INVALID_TYPE
+      )
+    ]
+  }
+
   const {name, fieldset, ...fieldType} = field
   return 'name' in field
     ? validateFieldName(name)
@@ -67,32 +77,39 @@ function getDuplicateFields(array: Array<Field>): Array<Array<Field>> {
     .filter(Boolean)
 }
 
-export default (typeDef, visitorContext) => {
+export function validateFields(fields: any, options = {allowEmpty: false}) {
   const problems = []
-  const fieldsIsArray = Array.isArray(typeDef.fields)
-  if (fieldsIsArray) {
-    const fieldsWithNames = typeDef.fields.filter(field => typeof field.name === 'string')
-
-    getDuplicateFields(fieldsWithNames).forEach(dupes => {
-      problems.push(
-        error(
-          `Found ${dupes.length} fields with name "${dupes[0].name}" in object`,
-          HELP_IDS.OBJECT_FIELD_NOT_UNIQUE
-        )
+  const fieldsIsArray = Array.isArray(fields)
+  if (!fieldsIsArray) {
+    return [
+      error(
+        `The "fields" property must be an array of fields. Instead saw "${typeof fields}"`,
+        HELP_IDS.OBJECT_FIELDS_INVALID
       )
-    })
-    if (typeDef.fields.length === 0) {
-      problems.push(error('Object should have at least one field', HELP_IDS.OBJECT_FIELDS_INVALID))
-    }
-  } else {
+    ]
+  }
+
+  const fieldsWithNames = fields.filter(field => typeof field.name === 'string')
+
+  getDuplicateFields(fieldsWithNames).forEach(dupes => {
     problems.push(
       error(
-        `The "fields" property must be an array of fields. Instead saw "${typeof typeDef.fields}"`,
-        HELP_IDS.OBJECT_FIELDS_INVALID
+        `Found ${dupes.length} fields with name "${dupes[0].name}" in object`,
+        HELP_IDS.OBJECT_FIELD_NOT_UNIQUE
       )
     )
+  })
+
+  if (fields.length === 0 && !options.allowEmpty) {
+    problems.push(error('Object should have at least one field', HELP_IDS.OBJECT_FIELDS_INVALID))
   }
 
+  return problems
+}
+
+export default (typeDef, visitorContext) => {
+  const problems = validateFields(typeDef.fields)
+
   if (typeDef.type !== 'document' && typeof typeDef.initialValue !== 'undefined') {
     problems.push(
       error(`The "initialValue" property is currently only supported for document types.`)
@@ -101,7 +118,7 @@ export default (typeDef, visitorContext) => {
 
   return {
     ...typeDef,
-    fields: (fieldsIsArray ? typeDef.fields : []).map(field => {
+    fields: (Array.isArray(typeDef.fields) ? typeDef.fields : []).map(field => {
       const {name, ...fieldTypeDef} = field
       const {_problems, ...fieldType} = visitorContext.visit(fieldTypeDef, visitorContext)
       return {