Remove isRequired and defaultValue from some fields (#6513)

keystonejs · Sep 9, 2021 · 4048991 · 4048991
1 parent bf58744
commit 4048991
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 50 deletions.
diff --git a/.changeset/forty-jobs-grow.md b/.changeset/forty-jobs-grow.md
@@ -0,0 +1,5 @@
+---
+'@keystone-next/cloudinary': major
+---
+
+Removed `isRequired` and `defaultValue` from the `cloudinaryImage` field. If you were using these options, the same behaviour can be re-created with the `validateInput` and `resolveInput` hooks respectively.
diff --git a/.changeset/real-jars-buy.md b/.changeset/real-jars-buy.md
@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': major
+---
+
+Removed `isRequired` and `defaultValue` from the `image` and `file` fields. If you were using these options, the same behaviour can be re-created with the `validateInput` and `resolveInput` hooks respectively.
diff --git a/docs/pages/docs/apis/fields.mdx b/docs/pages/docs/apis/fields.mdx
@@ -621,10 +621,6 @@ A `file` field represents a file of any type.
 
 See [`config.files`](./config#files) for details on how to configure your Keystone system with support for the `file` field type.
 
-Options:
-
-- `isRequired` (default: `false`): If `true` then this field can never be set to `null`.
-
 ```typescript
 import { config, createSchema, list } from '@keystone-next/keystone';
 import { file } from '@keystone-next/keystone/fields';
@@ -633,9 +629,7 @@ export default config({
   lists: createSchema({
     ListName: list({
       fields: {
-        repo: file({
-          isRequired: true,
-        }),
+        repo: file(),
         /* ... */
       },
     }),
@@ -651,10 +645,6 @@ An `image` field represents an image file, i.e. `.jpg`, `.png`, `.webp`, or `.gi
 
 See [`config.images`](./config#images) for details on how to configure your Keystone system with support for the `image` field type.
 
-Options:
-
-- `isRequired` (default: `false`): If `true` then this field can never be set to `null`.
-
 ```typescript
 import { config, createSchema, list } from '@keystone-next/keystone';
 import { image } from '@keystone-next/keystone/fields';
@@ -663,9 +653,7 @@ export default config({
   lists: createSchema({
     ListName: list({
       fields: {
-        avatar: image({
-          isRequired: true,
-        }),
+        avatar: image(),
         /* ... */
       },
     }),
@@ -722,7 +710,6 @@ export default config({
 
 (coming soon)
 
-- `isRequired` (default: `false`): If `true` then this field can never be set to `null`.
 - `cloudinary`: Configuration for the connected Cloudinary account.
   - `cloudName`
   - `apiKey`
@@ -738,7 +725,6 @@ export default config({
     ListName: list({
       fields: {
         fieldName: cloudinaryImage({
-          isRequired: true,
           cloudinary: {
             cloudName: process.env.CLOUDINARY_CLOUD_NAME,
             apiKey: process.env.CLOUDINARY_API_KEY,

diff --git a/packages/cloudinary/src/index.ts b/packages/cloudinary/src/index.ts
@@ -5,7 +5,6 @@ import {
   FieldTypeFunc,
   jsonFieldTypePolyfilledForSQLite,
   graphql,
-  FieldDefaultValue,
 } from '@keystone-next/keystone/types';
 import { FileUpload } from 'graphql-upload';
 import cuid from 'cuid';
@@ -23,8 +22,6 @@ type StoredFile = {
 
 type CloudinaryImageFieldConfig<TGeneratedListTypes extends BaseGeneratedListTypes> =
   CommonFieldConfig<TGeneratedListTypes> & {
-    isRequired?: boolean;
-    defaultValue?: FieldDefaultValue<any, TGeneratedListTypes>;
     cloudinary: {
       cloudName: string;
       apiKey: string;
@@ -111,8 +108,6 @@ const outputType = graphql.object<CloudinaryImage_File>()({
 export const cloudinaryImage =
   <TGeneratedListTypes extends BaseGeneratedListTypes>({
     cloudinary,
-    isRequired,
-    defaultValue,
     ...config
   }: CloudinaryImageFieldConfig<TGeneratedListTypes>): FieldTypeFunc =>
   meta => {
@@ -170,6 +165,5 @@ export const cloudinaryImage =
         },
       }),
       views: path.join(path.dirname(__dirname), 'views'),
-      __legacy: { isRequired, defaultValue },
     });
   };
diff --git a/packages/cloudinary/src/test-fixtures.skip.ts b/packages/cloudinary/src/test-fixtures.skip.ts
@@ -30,6 +30,7 @@ const prepareFile = (_filePath: string) => {
 export const name = 'CloudinaryImage';
 export const typeFunction = cloudinaryImage;
 export const supportsUnique = false;
+export const skipRequiredTest = true;
 export const fieldName = 'image';
 export const subfieldName = 'originalFilename';
 

diff --git a/packages/keystone/src/fields/types/file/index.ts b/packages/keystone/src/fields/types/file/index.ts
@@ -7,16 +7,12 @@ import {
   BaseGeneratedListTypes,
   KeystoneContext,
   FileData,
-  FieldDefaultValue,
 } from '../../../types';
 import { resolveView } from '../../resolve-view';
 import { getFileRef } from './utils';
 
 export type FileFieldConfig<TGeneratedListTypes extends BaseGeneratedListTypes> =
-  CommonFieldConfig<TGeneratedListTypes> & {
-    isRequired?: boolean;
-    defaultValue?: FieldDefaultValue<FileFieldInputType, TGeneratedListTypes>;
-  };
+  CommonFieldConfig<TGeneratedListTypes>;
 
 const FileFieldInput = graphql.inputObject({
   name: 'FileFieldInput',
@@ -84,11 +80,9 @@ async function inputResolver(data: FileFieldInputType, context: KeystoneContext)
 }
 
 export const file =
-  <TGeneratedListTypes extends BaseGeneratedListTypes>({
-    isRequired,
-    defaultValue,
-    ...config
-  }: FileFieldConfig<TGeneratedListTypes> = {}): FieldTypeFunc =>
+  <TGeneratedListTypes extends BaseGeneratedListTypes>(
+    config: FileFieldConfig<TGeneratedListTypes> = {}
+  ): FieldTypeFunc =>
   () => {
     if ((config as any).isIndexed === 'unique') {
       throw Error("isIndexed: 'unique' is not a supported option for field type file");
@@ -123,9 +117,5 @@ export const file =
       }),
       unreferencedConcreteInterfaceImplementations: [LocalFileFieldOutput],
       views: resolveView('file/views'),
-      __legacy: {
-        isRequired,
-        defaultValue,
-      },
     });
   };
diff --git a/packages/keystone/src/fields/types/file/tests/test-fixtures.ts b/packages/keystone/src/fields/types/file/tests/test-fixtures.ts
@@ -26,6 +26,7 @@ export const createReturnedValue = 3250;
 export const updateReturnedValue = 5562;
 
 export const supportsUnique = false;
+export const skipRequiredTest = true;
 export const fieldName = 'secretFile';
 export const subfieldName = 'filesize';
 

diff --git a/packages/keystone/src/fields/types/image/index.ts b/packages/keystone/src/fields/types/image/index.ts
@@ -1,7 +1,6 @@
 import { FileUpload } from 'graphql-upload';
 import {
   BaseGeneratedListTypes,
-  FieldDefaultValue,
   fieldType,
   FieldTypeFunc,
   CommonFieldConfig,
@@ -14,10 +13,7 @@ import { resolveView } from '../../resolve-view';
 import { getImageRef, SUPPORTED_IMAGE_EXTENSIONS } from './utils';
 
 export type ImageFieldConfig<TGeneratedListTypes extends BaseGeneratedListTypes> =
-  CommonFieldConfig<TGeneratedListTypes> & {
-    defaultValue?: FieldDefaultValue<ImageFieldInputType, TGeneratedListTypes>;
-    isRequired?: boolean;
-  };
+  CommonFieldConfig<TGeneratedListTypes>;
 
 const ImageExtensionEnum = graphql.enum({
   name: 'ImageExtension',
@@ -96,11 +92,9 @@ function isValidImageExtension(extension: string): extension is ImageExtension {
 }
 
 export const image =
-  <TGeneratedListTypes extends BaseGeneratedListTypes>({
-    isRequired,
-    defaultValue,
-    ...config
-  }: ImageFieldConfig<TGeneratedListTypes> = {}): FieldTypeFunc =>
+  <TGeneratedListTypes extends BaseGeneratedListTypes>(
+    config: ImageFieldConfig<TGeneratedListTypes> = {}
+  ): FieldTypeFunc =>
   () => {
     if ((config as any).isIndexed === 'unique') {
       throw Error("isIndexed: 'unique' is not a supported option for field type image");
@@ -142,9 +136,5 @@ export const image =
       }),
       unreferencedConcreteInterfaceImplementations: [LocalImageFieldOutput],
       views: resolveView('image/views'),
-      __legacy: {
-        isRequired,
-        defaultValue,
-      },
     });
   };
diff --git a/packages/keystone/src/fields/types/image/tests/test-fixtures.ts b/packages/keystone/src/fields/types/image/tests/test-fixtures.ts
@@ -27,6 +27,7 @@ export const createReturnedValue = 'jpg';
 export const updateReturnedValue = createReturnedValue;
 
 export const supportsUnique = false;
+export const skipRequiredTest = true;
 export const fieldName = 'avatar';
 export const subfieldName = 'extension';