Add examples/reuse example, showing how to add fields to Lists in a re-usable way

.changeset/add-field-hooks.md

@@ -0,0 +1,5 @@
+---
+"@keystone-6/core": minor
+---
+
+Add type `FieldHooks` to `@keystone-6/core/types` exports

.changeset/fix-id-filters.md

@@ -2,4 +2,4 @@
 "@keystone-6/core": patch
 ---
 
-Fixes `Input error: only a int can be passed to id filters` for AdminUI
+Fix `Input error: only a int can be passed to id filters` for AdminUI

.changeset/odd-lemons-hide.md

@@ -2,4 +2,4 @@
 '@keystone-6/core': patch
 ---
 
-Fixes `hooks.validateInput` argument types for update operations
+Fix `hooks.validateInput` argument types for update operations

.changeset/strong-swans-destroy.md

@@ -2,4 +2,4 @@
 '@keystone-6/core': patch
 ---
 
-Removed deprecated `experimental.appDir` flag from generated next.config
+Remove deprecated `experimental.appDir` flag from generated next.config

examples/default-values/README.md

@@ -1,7 +1,8 @@
 ## Feature Example - Default Values
 
-This project demonstrates how to use default values for fields.
-It builds on the [Task Manager](../task-manager) starter project.
+This example demonstrates how to use default values for fields.
+
+This example builds on the [TODO](../usecase-todo) starter project.
 
 ## Instructions
 
@@ -11,10 +12,9 @@ To run this project, clone the Keystone repository locally, run `pnpm` at the ro
 pnpm dev
 ```
 
-This will start the Admin UI at [localhost:3000](http://localhost:3000).
-You can use the Admin UI to create items in your database.
+This will start Keystone’s Admin UI at [localhost:3000](http://localhost:3000), where you can add items to an empty database.
 
-You can also access a GraphQL Playground at [localhost:3000/api/graphql](http://localhost:3000/api/graphql), which allows you to directly run GraphQL queries and mutations.
+When `NODE_ENV` is not equal to `production`, by default you can play with the GraphQL Playground at [localhost:3000/api/graphql](http://localhost:3000/api/graphql).
 
 ## Features
 

examples/default-values/schema.graphql

@@ -168,6 +168,7 @@ type Person {
 
 input PersonWhereUniqueInput {
   id: ID
+  name: String
 }
 
 input PersonWhereInput {

examples/default-values/schema.prisma

@@ -27,6 +27,6 @@ model Task {
 
 model Person {
   id    String @id @default(cuid())
-  name  String @default("")
+  name  String @unique @default("")
   tasks Task[] @relation("Task_assignedTo")
 }

examples/default-values/schema.ts

@@ -78,7 +78,7 @@ export const lists: Lists = {
   Person: list({
     access: allowAll,
     fields: {
-      name: text({ validation: { isRequired: true } }),
+      name: text({ validation: { isRequired: true }, isIndexed: 'unique' }),
       tasks: relationship({ ref: 'Task.assignedTo', many: true }),
     },
   }),

examples/hooks/schema.ts

@@ -21,13 +21,13 @@ const readOnly = {
   },
   ui: {
     createView: {
-      fieldMode: (args: unknown) => 'hidden' as const,
+      fieldMode: () => 'hidden' as const,
     },
     itemView: {
-      fieldMode: (args: unknown) => 'read' as const,
+      fieldMode: () => 'read' as const,
     },
     listView: {
-      fieldMode: (args: unknown) => 'read' as const,
+      fieldMode: () => 'read' as const,
     },
   },
 };

examples/reuse/README.md

@@ -0,0 +1,22 @@
+## Base Project - Reuse
+
+This example demonstrates how to reuse lists, fields, hooks and other functions.
+Navigatingn the types of these primitives can be difficult without experience, so hopefully this project helps you understand how you can apply this to your project.
+
+Reuse is not encouraged typically, but it can be helpful in projects that have grown beyond having everything inline.
+
+## Instructions
+
+To run this project, clone the Keystone repository locally, run `pnpm` at the root of the repository then navigate to this directory and run:
+
+```shell
+pnpm dev
+```
+
+This will start Keystone’s Admin UI at [localhost:3000](http://localhost:3000), where you can add items to an empty database.
+
+When `NODE_ENV` is not equal to `production`, by default you can play with the GraphQL Playground at [localhost:3000/api/graphql](http://localhost:3000/api/graphql).
+
+## Try it out in CodeSandbox 🧪
+
+You can play with this example online in a web browser using the free [codesandbox.io](https://codesandbox.io/) service. To launch this example, open the URL <https://githubbox.com/keystonejs/keystone/tree/main/examples/reuse>. You can also fork this sandbox to make your own changes.

examples/reuse/keystone.ts

@@ -0,0 +1,14 @@
+import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
+import { lists } from './schema';
+
+export default config({
+  db: {
+    provider: 'sqlite',
+    url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, don't do this
+    ...fixPrismaPath,
+  },
+  lists,
+});

examples/reuse/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@keystone-6/example-reuse",
+  "version": "0.0.1",
+  "private": true,
+  "license": "MIT",
+  "scripts": {
+    "dev": "keystone dev",
+    "start": "keystone start",
+    "build": "keystone build",
+    "postinstall": "keystone postinstall"
+  },
+  "dependencies": {
+    "@keystone-6/core": "^5.0.0",
+    "@prisma/client": "^4.16.2"
+  },
+  "devDependencies": {
+    "prisma": "^4.16.2",
+    "typescript": "~5.0.0"
+  }
+}

examples/reuse/sandbox.config.json

@@ -0,0 +1,7 @@
+{
+  "template": "node",
+  "container": {
+    "startScript": "keystone dev",
+    "node": "18"
+  }
+}