add example usage, and dont default for SQLite for now

dcousens · dcousens · commit 79f88ccf856a · 2025-07-16T11:38:29.000+10:00
diff --git a/examples/default-values/schema.graphql b/examples/default-values/schema.graphql
@@ -6,6 +6,7 @@ type Task {
   label: String
   priority: TaskPriorityType
   isComplete: Boolean
+  additionalData: JSON
   assignedTo: Person
   finishBy: DateTime
   viewCount: BigInt
@@ -129,6 +130,7 @@ input TaskUpdateInput {
   label: String
   priority: TaskPriorityType
   isComplete: Boolean
+  additionalData: JSON
   assignedTo: PersonRelateToOneForUpdateInput
   finishBy: DateTime
   viewCount: BigInt
@@ -149,6 +151,7 @@ input TaskCreateInput {
   label: String
   priority: TaskPriorityType
   isComplete: Boolean
+  additionalData: JSON
   assignedTo: PersonRelateToOneForCreateInput
   finishBy: DateTime
   viewCount: BigInt
diff --git a/examples/default-values/schema.prisma b/examples/default-values/schema.prisma
@@ -13,14 +13,15 @@ generator client {
 }
 
 model Task {
-  id           String    @id @default(cuid())
-  label        String    @default("")
-  priority     String?
-  isComplete   Boolean   @default(false)
-  assignedTo   Person?   @relation("Task_assignedTo", fields: [assignedToId], references: [id])
-  assignedToId String?   @map("assignedTo")
-  finishBy     DateTime?
-  viewCount    BigInt?   @default(0)
+  id             String    @id @default(cuid())
+  label          String    @default("")
+  priority       String?
+  isComplete     Boolean   @default(false)
+  additionalData Json?
+  assignedTo     Person?   @relation("Task_assignedTo", fields: [assignedToId], references: [id])
+  assignedToId   String?   @map("assignedTo")
+  finishBy       DateTime?
+  viewCount      BigInt?   @default(0)
 
   @@index([assignedToId])
 }
diff --git a/examples/default-values/schema.ts b/examples/default-values/schema.ts
@@ -1,8 +1,15 @@
+import type { Lists } from '.keystone/types'
 import { list } from '@keystone-6/core'
-import { bigInt, checkbox, relationship, text, timestamp } from '@keystone-6/core/fields'
-import { select } from '@keystone-6/core/fields'
 import { allowAll } from '@keystone-6/core/access'
-import type { Lists } from '.keystone/types'
+import {
+  bigInt,
+  checkbox,
+  json,
+  relationship,
+  select,
+  text,
+  timestamp,
+} from '@keystone-6/core/fields'
 
 export const lists = {
   Task: list({
@@ -34,6 +41,15 @@ export const lists = {
       // static default: when a task is first created, it is incomplete
       isComplete: checkbox({ defaultValue: false }),
 
+      // static default: may stringify in Prisma schema
+      additionalData: json({
+        defaultValue: {
+          conditions: [],
+          location: null,
+          notification: 'bongo',
+        },
+      }),
+
       assignedTo: relationship({
         ref: 'Person.tasks',
         many: false,
diff --git a/examples/document-field-customisation/keystone-server/schema.prisma b/examples/document-field-customisation/keystone-server/schema.prisma
@@ -23,7 +23,7 @@ model Post {
   id          String    @id @default(cuid())
   title       String    @default("")
   slug        String    @unique @default("")
-  content     String    @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
+  content     Json
   publishDate DateTime? @default(now())
   author      User?     @relation("Post_author", fields: [authorId], references: [id])
   authorId    String?   @map("author")
diff --git a/examples/document-field/schema.prisma b/examples/document-field/schema.prisma
@@ -17,7 +17,7 @@ model Post {
   title       String    @default("")
   slug        String    @unique @default("")
   status      String?
-  content     String    @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
+  content     Json
   publishDate DateTime?
   author      Author?   @relation("Post_author", fields: [authorId], references: [id])
   authorId    String?   @map("author")
@@ -30,5 +30,5 @@ model Author {
   name  String @default("")
   email String @unique @default("")
   posts Post[] @relation("Post_author")
-  bio   String @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
+  bio   Json
 }
diff --git a/examples/framework-nextjs-app-directory/schema.prisma b/examples/framework-nextjs-app-directory/schema.prisma
@@ -15,6 +15,6 @@ generator client {
 model User {
   id        String    @id @default(cuid())
   name      String    @default("")
-  about     String    @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
+  about     Json
   createdAt DateTime? @default(now())
 }
diff --git a/examples/framework-nextjs-two-servers/keystone-server/schema.prisma b/examples/framework-nextjs-two-servers/keystone-server/schema.prisma
@@ -23,7 +23,7 @@ model Post {
   id          String    @id @default(cuid())
   title       String    @default("")
   slug        String    @unique @default("")
-  content     String    @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
+  content     Json
   publishDate DateTime? @default(now())
   author      User?     @relation("Post_author", fields: [authorId], references: [id])
   authorId    String?   @map("author")
diff --git a/examples/relationships/schema.prisma b/examples/relationships/schema.prisma
@@ -19,8 +19,8 @@ model Post {
   categoryId        String?   @map("category")
   tags              Tag[]     @relation("Post_tags")
   related           Post[]    @relation("Post_related")
-  recommendations   String    @default("[]")
-  bundles           String    @default("[]")
+  recommendations   Json
+  bundles           Json
   from_Post_related Post[]    @relation("Post_related")
 
   @@index([categoryId])
diff --git a/examples/structure-field/schema.prisma b/examples/structure-field/schema.prisma
@@ -13,8 +13,8 @@ generator client {
 }
 
 model Homepage {
-  id       Int    @id
-  metadata String @default("{\"featuredPosts\":[]}")
+  id       Int  @id
+  metadata Json
 }
 
 model Post {
diff --git a/examples/usecase-blog/schema.prisma b/examples/usecase-blog/schema.prisma
@@ -24,7 +24,7 @@ model Author {
 model Post {
   id       String  @id @default(cuid())
   title    String  @default("")
-  content  String  @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")
+  content  Json
   author   Author? @relation("Post_author", fields: [authorId], references: [id])
   authorId String? @map("author")
   tags     Tag[]   @relation("Post_tags")
diff --git a/packages/core/src/fields/types/json/index.ts b/packages/core/src/fields/types/json/index.ts
@@ -30,12 +30,11 @@ export type JsonFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonField
   db?: { map?: string; extendPrismaSchema?: (field: string) => string }
 }
 
-export const json =
-  <ListTypeInfo extends BaseListTypeInfo>({
-    defaultValue = null,
-    ...config
-  }: JsonFieldConfig<ListTypeInfo> = {}): FieldTypeFunc<ListTypeInfo> =>
-  meta => {
+export function json<ListTypeInfo extends BaseListTypeInfo>({
+  defaultValue = null,
+  ...config
+}: JsonFieldConfig<ListTypeInfo> = {}): FieldTypeFunc<ListTypeInfo> {
+  return meta => {
     if ((config as any).isIndexed === 'unique') {
       throw Error("isIndexed: 'unique' is not a supported option for field type json")
     }
@@ -47,7 +46,14 @@ export const json =
       default:
         defaultValue === null
           ? undefined
-          : { kind: 'literal', value: JSON.stringify(defaultValue) },
+          : meta.provider === 'sqlite'
+            ? undefined
+            : {
+                kind: 'literal',
+                // TODO: waiting on https://github.com/prisma/prisma/issues/26571
+                //   input.create manages defaultValues anyway
+                value: JSON.stringify(defaultValue ?? null),
+              },
       map: config.db?.map,
       extendPrismaSchema: config.db?.extendPrismaSchema,
     })({
@@ -57,6 +63,7 @@ export const json =
         create: {
           arg: g.arg({ type: g.JSON }),
           resolve(val) {
+            // TODO: redundant when https://github.com/prisma/prisma/issues/26571 is resolved
             return val === undefined ? defaultValue : val
           },
         },
@@ -67,3 +74,4 @@ export const json =
       getAdminMeta: () => ({ defaultValue }),
     })
   }
+}
diff --git a/packages/core/src/fields/types/multiselect/index.ts b/packages/core/src/fields/types/multiselect/index.ts
@@ -128,10 +128,15 @@ export function multiselect<ListTypeInfo extends BaseListTypeInfo>(
       mode,
       map: config?.db?.map,
       extendPrismaSchema: config.db?.extendPrismaSchema,
-      default: {
-        kind: 'literal',
-        value: JSON.stringify(defaultValue ?? null),
-      },
+      default:
+        meta.provider === 'sqlite'
+          ? undefined
+          : {
+              kind: 'literal',
+              // TODO: waiting on https://github.com/prisma/prisma/issues/26571
+              //   input.create manages defaultValues anyway
+              value: JSON.stringify(defaultValue ?? null),
+            },
     })({
       ...config,
       ui,
diff --git a/packages/fields-document/src/index.ts b/packages/fields-document/src/index.ts
@@ -115,14 +115,20 @@ export function document<ListTypeInfo extends BaseListTypeInfo>({
       }
     }
 
+    const defaultValue = [{ type: 'paragraph', children: [{ text: '' }] }]
     return fieldType({
       kind: 'scalar',
       scalar: 'Json',
       mode: 'required',
-      default: {
-        kind: 'literal',
-        value: JSON.stringify([{ type: 'paragraph', children: [{ text: '' }] }]),
-      },
+      default:
+        meta.provider === 'sqlite'
+          ? undefined
+          : {
+              kind: 'literal',
+              // TODO: waiting on https://github.com/prisma/prisma/issues/26571
+              //   input.create manages defaultValues anyway
+              value: JSON.stringify(defaultValue ?? null),
+            },
       map: config.db?.map,
       extendPrismaSchema: config.db?.extendPrismaSchema,
     })({
@@ -133,7 +139,7 @@ export function document<ListTypeInfo extends BaseListTypeInfo>({
           arg: g.arg({ type: g.JSON }),
           resolve(val) {
             if (val === undefined) {
-              val = [{ type: 'paragraph', children: [{ text: '' }] }]
+              val = defaultValue
             }
             return inputResolver(val)
           },
diff --git a/packages/fields-document/src/structure.ts b/packages/fields-document/src/structure.ts
@@ -52,10 +52,15 @@ export function structure<ListTypeInfo extends BaseListTypeInfo>({
     return fieldType({
       kind: 'scalar',
       scalar: 'Json',
-      default: {
-        kind: 'literal',
-        value: JSON.stringify(defaultValue),
-      },
+      default:
+        meta.provider === 'sqlite'
+          ? undefined
+          : {
+              kind: 'literal',
+              // TODO: waiting on https://github.com/prisma/prisma/issues/26571
+              //   input.create manages defaultValues anyway
+              value: JSON.stringify(defaultValue ?? null),
+            },
       map: config.db?.map,
       mode: 'required',
     })({

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,6 @@ generator client {`
`15`	`15`	`model User {`
`16`	`16`	`id String @id @default(cuid())`
`17`	`17`	`name String @default("")`
`18`		`- about String @default("[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]")`
	`18`	`+ about Json`
`19`	`19`	`createdAt DateTime? @default(now())`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ generator client {`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`model Homepage {`
`16`		`- id Int @id`
`17`		`- metadata String @default("{\"featuredPosts\":[]}")`
	`16`	`+ id Int @id`
	`17`	`+ metadata Json`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`model Post {`