[schema] Fix wrong asset type names and use asset.originalFilename a…

…s default preview title for images (#235) * [schema] Fix wrong asset type names and use asset.originalFilename as default preview title for images * [base] Update schema definitions for assets * [base] Give the asset types better titles
sanity-io · Oct 12, 2017 · 4de8a0c · 4de8a0c
1 parent f7a7021
commit 4de8a0c
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 25 deletions.
diff --git a/packages/@sanity/base/src/schema/types/fileAsset.js b/packages/@sanity/base/src/schema/types/fileAsset.js
@@ -1,32 +1,60 @@
 export default {
-  name: 'fileAsset',
-  title: 'File asset',
+  name: 'sanity.fileAsset',
+  title: 'File',
   type: 'object',
+  fieldsets: [
+    {
+      name: 'system',
+      title: 'System fields',
+      description: 'These are read only'
+    }
+  ],
   fields: [
     {
-      name: 'assetId',
+      name: 'originalFilename',
+      type: 'string',
+      title: 'Original file name'
+    },
+    {
+      name: 'extension',
       type: 'string',
-      title: 'Asset ID'
+      title: 'File extension'
     },
     {
-      name: 'project',
+      name: 'mimeType',
       type: 'string',
-      title: 'Project'
+      title: 'Mime type'
     },
     {
       name: 'label',
       type: 'string',
       title: 'Label'
     },
+    {
+      name: 'assetId',
+      type: 'string',
+      title: 'Asset ID',
+      readOnly: true,
+      fieldset: 'system'
+    },
     {
       name: 'path',
       type: 'string',
-      title: 'Path'
+      title: 'Path',
+      readOnly: true,
+      fieldset: 'system'
     },
     {
       name: 'url',
       type: 'string',
-      title: 'Url'
+      title: 'Url',
+      readOnly: true,
+      fieldset: 'system'
+    }
+  ],
+  preview: {
+    select: {
+      title: 'originalFilename'
     }
-  ]
+  }
 }
diff --git a/packages/@sanity/base/src/schema/types/imageAsset.js b/packages/@sanity/base/src/schema/types/imageAsset.js
@@ -1,38 +1,80 @@
+const PALETTE_FIELDS = [
+  {name: 'background', type: 'string', title: 'Background'},
+  {name: 'foreground', type: 'string', title: 'Foreground'},
+  {name: 'population', type: 'number', title: 'Population'},
+  {name: 'title', type: 'string', title: 'String'},
+]
 export default {
-  name: 'imageAsset',
-  title: 'Image asset',
+  name: 'sanity.imageAsset',
+  title: 'Image',
   type: 'object',
+  fieldsets: [
+    {
+      name: 'system',
+      title: 'System fields',
+      description: 'These are read only'
+    },
+    {
+      name: 'metadata',
+      title: 'Extra metadata…',
+      options: {
+        collapsable: true
+      }
+    }
+  ],
   fields: [
     {
-      name: 'assetId',
+      name: 'originalFilename',
       type: 'string',
-      title: 'Asset ID'
+      title: 'Original file name'
     },
     {
-      name: 'project',
+      name: 'extension',
       type: 'string',
-      title: 'Project'
+      title: 'File extension'
+    },
+    {
+      name: 'mimeType',
+      type: 'string',
+      title: 'Mime type'
     },
     {
       name: 'label',
       type: 'string',
       title: 'Label'
     },
+    {
+      name: 'assetId',
+      type: 'string',
+      title: 'Asset ID',
+      readOnly: true,
+      fieldset: 'system'
+    },
     {
       name: 'path',
       type: 'string',
-      title: 'Path'
+      title: 'Path',
+      readOnly: true,
+      fieldset: 'system'
     },
     {
       name: 'url',
       type: 'string',
-      title: 'Url'
+      title: 'Url',
+      readOnly: true,
+      fieldset: 'system'
     },
     {
       name: 'metadata',
       type: 'object',
       title: 'Metadata',
+      readOnly: true,
+      fieldset: 'metadata',
       fields: [
+        {
+          name: 'location',
+          type: 'geopoint'
+        },
         {
           name: 'dimensions',
           type: 'object',
@@ -44,10 +86,26 @@ export default {
           ]
         },
         {
-          name: 'location',
-          type: 'geopoint'
+          name: 'palette',
+          type: 'object',
+          title: 'Palette',
+          fields: [
+            {name: 'darkMuted', type: 'object', title: 'Dark Muted', fields: PALETTE_FIELDS},
+            {name: 'lightVibrant', type: 'object', title: 'Light Vibrant', fields: PALETTE_FIELDS},
+            {name: 'darkVibrant', type: 'object', title: 'Dark Vibrant', fields: PALETTE_FIELDS},
+            {name: 'vibrant', type: 'object', title: 'Vibrant', fields: PALETTE_FIELDS},
+            {name: 'dominant', type: 'object', title: 'Dominant', fields: PALETTE_FIELDS},
+            {name: 'lightMuted', type: 'object', title: 'Light Muted', fields: PALETTE_FIELDS},
+            {name: 'muted', type: 'object', title: 'Muted', fields: PALETTE_FIELDS}
+          ]
         }
       ]
     }
-  ]
+  ],
+  preview: {
+    select: {
+      title: 'originalFilename',
+      imageUrl: 'url'
+    }
+  }
 }
diff --git a/packages/@sanity/data-aspects/src/DataAspectsResolver.js b/packages/@sanity/data-aspects/src/DataAspectsResolver.js
@@ -1,6 +1,6 @@
 import config from 'config:@sanity/data-aspects'
 import {startCase} from 'lodash'
-const bundledTypeNames = ['geopoint', 'richDate', 'date', 'imageAsset', 'fileAsset']
+const bundledTypeNames = ['geopoint', 'richDate', 'date', 'sanity.imageAsset', 'sanity.fileAsset']
 
 class DataAspectsResolver {
 

diff --git a/packages/@sanity/schema/src/preview/guessPreviewConfig.js b/packages/@sanity/schema/src/preview/guessPreviewConfig.js
@@ -11,7 +11,7 @@ function fieldHasReferenceTo(fieldDef, refType) {
 }
 
 function isImageAssetField(fieldDef) {
-  return fieldHasReferenceTo(fieldDef, 'imageAsset')
+  return fieldHasReferenceTo(fieldDef, 'sanity.imageAsset')
 }
 
 function resolveImageAssetPath(typeDef) {
@@ -26,7 +26,7 @@ function resolveImageAssetPath(typeDef) {
 }
 
 function isFileAssetField(fieldDef) {
-  return fieldHasReferenceTo(fieldDef, 'fileAsset')
+  return fieldHasReferenceTo(fieldDef, 'sanity.fileAsset')
 }
 
 function resolveFileAssetPath(typeDef) {
@@ -67,6 +67,9 @@ export default function guessPreviewFields(rawObjectTypeDef) {
     if (fileAssetPath) {
       titleField = `${fileAssetPath}.originalFilename`
     }
+    if (imageAssetPath) {
+      titleField = `${imageAssetPath}.originalFilename`
+    }
   }
 
   if (!titleField && !imageAssetPath) {

diff --git a/packages/@sanity/schema/src/types/file.js b/packages/@sanity/schema/src/types/file.js
@@ -5,7 +5,7 @@ import createPreviewGetter from '../preview/createPreviewGetter'
 export const ASSET_FIELD = {
   name: 'asset',
   type: 'reference',
-  to: {type: 'fileAsset'}
+  to: {type: 'sanity.fileAsset'}
 }
 
 const OVERRIDABLE_FIELDS = [

diff --git a/packages/@sanity/schema/src/types/image/fieldDefs.js b/packages/@sanity/schema/src/types/image/fieldDefs.js
@@ -1,7 +1,7 @@
 export const ASSET_FIELD = {
   name: 'asset',
   type: 'reference',
-  to: [{type: 'imageAsset'}]
+  to: [{type: 'sanity.imageAsset'}]
 }
 
 export const HOTSPOT_FIELD = {