8000 ui.{createView,itemView}.isRequired function on fields by emmatown · Pull Request #9626 · keystonejs/keystone · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

ui.{createView,itemView}.isRequired function on fields #9626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 18, 2025
Merged

ui.{createView,itemView}.isRequired function on fields #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6996ba5
ui.{createView,itemView}.isRequired function on fields
emmatown Jun 12, 2025
e49ef32
prefer satisfies for non-coercive casts
dcousens Jun 18, 2025
e8b4b1c
update copy
dcousens Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/early-shirts-win.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@keystone-6/core": minor
---

Add `ui.{createView,itemView}.isRequired` for control of `isRequired` UI functionality
2 changes: 2 additions & 0 deletions examples/assets-local/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -213,6 +214,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/assets-s3/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -213,6 +214,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/auth-magic-link/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -199,6 +200,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/auth/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -176,6 +177,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/better-list-search/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -323,6 +324,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/byte-encoding/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -167,6 +168,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/cloudinary/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -231,6 +232,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-admin-ui-logo/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -297,6 +298,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-admin-ui-navigation/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -297,6 +298,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-admin-ui-pages/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -297,6 +298,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-esbuild/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -174,6 +175,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
5 changes: 3 additions & 2 deletions examples/custom-field/1-text-field/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { g } from '@keystone-6/core'
import {
BaseFieldTypeInfo,
type BaseListTypeInfo,
Expand All @@ -6,7 +7,7 @@ import {
fieldType,
orderDirectionEnum,
} from '@keystone-6/core/types'
import { g } from '@keystone-6/core'
import { controller } from './views'

type TextFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
ListTypeInfo,
Expand Down Expand Up @@ -45,7 +46,7 @@ export function text<ListTypeInfo extends BaseListTypeInfo>({
}),
views: './1-text-field/views',
getAdminMeta() {
return {}
return {} satisfies Parameters<typeof controller>[0]['fieldMeta']
},
})
}
5 changes: 3 additions & 2 deletions examples/custom-field/2-stars-field/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
orderDirectionEnum,
} from '@keystone-6/core/types'
import { g } from '@keystone-6/core'
import { controller } from './views'

// this field is based on the integer field
// but with validation to ensure the value is within an expected range
Expand Down Expand Up @@ -79,7 +80,7 @@ export function stars<ListTypeInfo extends BaseListTypeInfo>({
resolve(val, context) {
// if it's null, then the value will be set to null in the database
if (val === null) return null
// if it's undefined(which means that it was omitted in the request)
// if it's undefined (which means that it was omitted in the request)
// returning undefined will mean "don't change the existing value"
// note that this means that this function is called on every update to an item
// including when the field is not updated
Expand All @@ -101,7 +102,7 @@ export function stars<ListTypeInfo extends BaseListTypeInfo>({
}),
views: './2-stars-field/views',
getAdminMeta() {
return { maxStars }
return { maxStars } satisfies Parameters<typeof controller>[0]['fieldMeta']
},
})
}
3 changes: 2 additions & 1 deletion examples/custom-field/3-pair-field-json/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
fieldType,
} from '@keystone-6/core/types'
import { g } from '@keystone-6/core'
import { controller } from './views'

type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
ListTypeInfo,
Expand Down Expand Up @@ -101,7 +102,7 @@ export function pair<ListTypeInfo extends BaseListTypeInfo>(
}),
views: './3-pair-field-json/views',
getAdminMeta() {
return {}
return {} satisfies Parameters<typeof controller>[0]['fieldMeta']
},
})
}
3 changes: 2 additions & 1 deletion examples/custom-field/3-pair-field-nested/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
fieldType,
} from '@keystone-6/core/types'
import { g } from '@keystone-6/core'
import { controller } from './views'

type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
ListTypeInfo,
Expand Down Expand Up @@ -111,7 +112,7 @@ export function pair<ListTypeInfo extends BaseListTypeInfo>(
}),
views: './3-pair-field-nested/views',
getAdminMeta() {
return {}
return {} satisfies Parameters<typeof controller>[0]['fieldMeta']
},
})
}
3 changes: 2 additions & 1 deletion examples/custom-field/3-pair-field/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
fieldType,
} from '@keystone-6/core/types'
import { g } from '@keystone-6/core'
import { controller } from './views'

type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
ListTypeInfo,
Expand Down Expand Up @@ -98,7 +99,7 @@ export function pair<ListTypeInfo extends BaseListTypeInfo>(
}),
views: './3-pair-field/views',
getAdminMeta() {
return {}
return {} as Parameters<typeof controller>[0]['fieldMeta']
},
})
}
3 changes: 2 additions & 1 deletion examples/custom-field/4-conditional-field/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
orderDirectionEnum,
} from '@keystone-6/core/types'
import { g } from '@keystone-6/core'
import { controller } from './views'

type TextFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
ListTypeInfo,
Expand Down Expand Up @@ -52,7 +53,7 @@ export function feedback<ListTypeInfo extends BaseListTypeInfo>({
getAdminMeta() {
return {
dependency,
}
} satisfies Parameters<typeof controller>[0]['fieldMeta']
},
})
}
2 changes: 2 additions & 0 deletions examples/custom-field/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -192,6 +193,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-id/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,6 +576,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -590,6 +591,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-output-paths/my-graphql.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -192,6 +193,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-session-invalidation/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -172,6 +173,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-session-jwt/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -228,6 +229,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
2 changes: 2 additions & 0 deletions examples/custom-session-next-auth/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ enum KeystoneAdminUIFieldMetaIsNonNull {

type KeystoneAdminUIFieldMetaCreateView {
fieldMode: JSON!
isRequired: JSON!
}

type KeystoneAdminUIFieldMetaListView {
Expand All @@ -262,6 +263,7 @@ enum KeystoneAdminUIFieldMetaListViewFieldMode {
type KeystoneAdminUIFieldMetaItemView {
fieldMode: JSON!
fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition!
isRequired: JSON!
}

enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
Expand Down
Loading
0