Use app router template

[gautamsi]

ref #9183

Blocked by

• Return ResolvedKeystoneConfig instead of KeystoneConfig #9189

This PR updates the template to generate the App router, default to typescript version which can be turned off by setting config.ui.tsx = false

What is completed/Verified:

• generate app routes in app/(admin) folder (creates admin route specific layout page. if src page exist, it generates it in `src/app/(admin)
• Stop generating next.config.js file, this should be generated from create-keystone-app going forward (TODO)
• set default ui.basePath to /admin can set ui.basePath to /admin or any other sub path
• No longer copies admin files or generates pages export copy as they are no longer needed
• Does not clear the admin folder files if exist, only overwrites the special config files which contains up to date admin meta and view cache, this should be removed before GA
• Verified custom pages
• Verified custom fields and field views
• can use relative path or even "paths" from typescript (@fields/text/myView)
• Added --reset-admin flag to dev command to force clean (admin) folder, useful in regenerate the admin template if updated in future. should never be needed except braking upgrade
• fix build and start script
• @keystone-6/auth templates
• page middleware

Pending:

• Documentation
• fixing final set of failing tests

---

@dcousens can you create a v-next branch which should be actual target for these PRs instead of main

---

For anyone interested in testing this out, I have published temporary packages (use at your own risk) I have been using it with very large project of mine.
@k6js-next/[email protected]
@k6js-next/[email protected]

to use this you have to specify resolutions, for yarn I do it like this in (root package.json in monorepo)

"resolutions": {
    "graphql": "16.8.1",
    "next": "14.2.5",
    "react": "^18.3.1",
    "react-dom": "^18.3.1",
    "@keystone-6/core": "npm:@k6js-next/[email protected]",
    "@keystone-6/auth": "npm:@k6js-next/[email protected]"
  }

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3e6d294:

Sandbox	Source
@keystone-6/sandbox	Configuration

[gautamsi]

@dcousens I will need some help in fixing tests,
* smoke tests never finishes
* wired error in package unit tests, it has mismatch on keystone error message in build but unable to trace.
* random test failure with checkForTooManyEngines prisma error

I have disabled some ui tests, they need fixes but we can do that before merging to main

@dcousens I have fixed most test cases, these tests definitely helped me fix a lot of issues.

I see that document-field test can not be fixed due to static generation, I may have missed something.

Test live-reloading.test is not behaving properly, same thing, trying to fix some page router vs app router thing. I am having trouble debugging locally on windows for some reason.

[dcousens]

@gautamsi I'm super busy and can't engage on this this week, but, I'll wrap back around as soon as I can and help move this forward 💛

[gautamsi]

@dcousens I have not generated default files for all the example/test projects, have modified the code as such it will generate all the required nextjs files for dev and build. User would need to commit them in git.

The file generation is one time except the .admin/index file which generates the admin meta has and static keystone props for admin.

[gautamsi]

This part of live reload is not needed, we do not even need to figure out file linking from main dir to isolated dir anymore

[gautamsi]

@dcousens do you plan to check this out soon?

[dcousens]

@gautamsi we should be at a point where we can talk internally about this soon - sorry for the delay, as you know we put priority into the broader changes first 💛

[gautamsi]

any traction on this? @dcousens

[gautamsi]

any plan to look into this @dcousens ?? I will update if you have plan, or move on if this is not in your agenda

[dcousens]

Sorry for the delay @gautamsi, this is not on our immediate agenda - however, we are sparring around the issue more broadly, not this pull request

Please keep the pull request open 💛🩵

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License

View full report

[gautamsi]

@dcousens would you care to provide some details on the direction Keystone is heading? curious to see lot of small things being done but still no major release? are you keeping this in same repo or creating a brand new package name for this?

[dcousens]

@gautamsi at this time we're soaking that new design change and a high number of breaking changes.

We are finding many small bugs that we'd rather have fixed before the public release.
We are keeping the same repository and package names, simply a new major.

I am hoping for the official release soon, but we have one or two breaking changes that still need to make their way out first.