Change the type for ui.getAdditionalFiles to be flattened (#9681)

Co-authored-by: Daniel Cousens <[email protected]>

Author: dcousens

.changeset/less-arrays-ui.md

@@ -0,0 +1,5 @@
+---
+"@keystone-6/core": major
+---
+
+Changes the type for `ui.getAdditionalFiles` to be flattened, prefer function composition when wrapping

examples/document-field/keystone.ts

@@ -6,7 +6,7 @@ export default config({
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
 
-    // WARNING: this is only needed for our monorepo examples, dont do this
+    // WARNING: this is needed for our monorepo, you may not want this
     prismaClientPath: 'node_modules/myprisma',
   },
   lists,

examples/document-field/next.config.js

@@ -1,5 +1,4 @@
-// you don't need this if you're building something outside of the Keystone repo
-
+// WARNING: this is needed for our monorepo, you may not want this
 const withPreconstruct = require('@preconstruct/next')
 
 module.exports = withPreconstruct()

examples/logging/keystone.ts

@@ -68,5 +68,23 @@ export default config<TypeInfo>({
       ],
     },
   },
+  ui: {
+    getAdditionalFiles: async () => [
+      {
+        mode: 'write',
+        src: `export default ${JSON.stringify({
+          // stop the default Next logging
+          logging: false, // we use pino
+
+          // defaults from packages/core/src/templates/next-config.ts
+          bundlePagesRouterDependencies: true,
+          eslint: { ignoreDuringBuilds: true },
+          typescript: { ignoreBuildErrors: true },
+          transpilePackages: ['../../admin'],
+        })}`,
+        outputPath: 'next.config.js',
+      },
+    ],
+  },
   lists,
 })

packages/auth/src/index.ts

@@ -215,7 +215,7 @@ export function createAuth<ListTypeInfo extends BaseListTypeInfo>({
     let { ui } = config
     if (!ui?.isDisabled) {
       const {
-        getAdditionalFiles = [],
+        getAdditionalFiles = () => [],
         isAccessAllowed = defaultIsAccessAllowed,
         pageMiddleware,
         publicPages = [],
@@ -224,7 +224,10 @@ export function createAuth<ListTypeInfo extends BaseListTypeInfo>({
       ui = {
         ...ui,
         publicPages: [...publicPages, ...authPublicPages],
-        getAdditionalFiles: [...getAdditionalFiles, () => authGetAdditionalFiles(config)],
+        getAdditionalFiles: async () => [
+          ...(await getAdditionalFiles()),
+          ...authGetAdditionalFiles(config),
+        ],
 
         isAccessAllowed: async (context: KeystoneContext) => {
           if (await hasInitFirstItemConditions(context)) return true

packages/core/src/admin-ui/system/generateAdminUI.ts

@@ -68,8 +68,7 @@ export async function generateAdminUI(
   }
 
   // Write out the files configured by the user
-  const userFiles = config.ui?.getAdditionalFiles?.map(x => x()) ?? []
-  const userFilesToWrite = (await Promise.all(userFiles)).flat()
+  const userFilesToWrite = await config.ui.getAdditionalFiles()
   const savedFiles = await Promise.all(
     userFilesToWrite.map(file => writeAdminFile(file, projectAdminPath))
   )

packages/core/src/schema.ts

@@ -139,7 +139,7 @@ export function config<TypeInfo extends BaseKeystoneTypeInfo>(
       basePath: config.ui?.basePath ?? '',
       isAccessAllowed: config.ui?.isAccessAllowed ?? defaultIsAccessAllowed,
       isDisabled: config.ui?.isDisabled ?? false,
-      getAdditionalFiles: config.ui?.getAdditionalFiles ?? [],
+      getAdditionalFiles: config.ui?.getAdditionalFiles ?? (() => []),
       pageMiddleware: config.ui?.pageMiddleware ?? noop,
       publicPages: config.ui?.publicPages ?? [],
     },

packages/core/src/scripts/start.ts

@@ -1,11 +1,11 @@
 import next from 'next'
 
-import { createSystem } from '../lib/createSystem'
-import { createExpressServer } from '../lib/createExpressServer'
 import { createAdminUIMiddlewareWithNextApp } from '../lib/createAdminUIMiddleware'
+import { createExpressServer } from '../lib/createExpressServer'
+import { createSystem } from '../lib/createSystem'
 import { withMigrate } from '../lib/migrations'
+import type { Flags } from './cli'
 import { importBuiltKeystoneConfiguration } from './utils'
-import { type Flags } from './cli'
 
 export async function start(
   cwd: string,

packages/core/src/types/config/index.ts

@@ -162,7 +162,7 @@ export type KeystoneConfigPre<TypeInfo extends BaseKeystoneTypeInfo = BaseKeysto
     /** The Base Path for Keystones Admin UI */
     basePath?: string
 
-    getAdditionalFiles?: readonly (() => MaybePromise<readonly AdminFileToWrite[]>)[]
+    getAdditionalFiles?: () => MaybePromise<readonly AdminFileToWrite[]>
 
     /** An async middleware function that can optionally return a redirect */
     pageMiddleware?: (args: {

tests/test-projects/live-reloading/keystone.ts

@@ -15,14 +15,12 @@ export default config({
     extendGraphqlSchema,
   },
   ui: {
-    getAdditionalFiles: [
-      () => [
-        {
-          mode: 'write',
-          src: "export default function(req,res) {res.send('something')}",
-          outputPath: 'pages/api/blah/[...rest].js',
-        },
-      ],
+    getAdditionalFiles: () => [
+      {
+        mode: 'write',
+        src: "export default function(req,res) {res.send('something')}",
+        outputPath: 'pages/api/blah/[...rest].js',
+      },
     ],
   },
 })