Remove deprecated @keystone-6/core/system exports

Author: dcousens

.changeset/no-system-export.md

@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': major
+---
+
+Removes `@keystone-6/core/system` from exports

examples/custom-output-paths/my-types.ts

@@ -138,7 +138,6 @@ type ResolvedPostCreateInput = {
   content?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['content']
   publishDate?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['publishDate']
 }
-
 type ResolvedPostUpdateInput = {
   id?: undefined
   title?: import('./node_modules/.myprisma/client').Prisma.PostUpdateInput['title']

examples/extend-graphql-schema-nexus/keystone-types.ts

@@ -220,7 +220,6 @@ type ResolvedPostCreateInput = {
   publishDate?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['publishDate']
   author?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['author']
 }
-
 type ResolvedPostUpdateInput = {
   id?: undefined
   title?: import('./node_modules/.myprisma/client').Prisma.PostUpdateInput['title']
@@ -229,13 +228,11 @@ type ResolvedPostUpdateInput = {
   publishDate?: import('./node_modules/.myprisma/client').Prisma.PostUpdateInput['publishDate']
   author?: import('./node_modules/.myprisma/client').Prisma.PostUpdateInput['author']
 }
-
 type ResolvedAuthorCreateInput = {
   id?: import('./node_modules/.myprisma/client').Prisma.AuthorCreateInput['id']
   name?: import('./node_modules/.myprisma/client').Prisma.AuthorCreateInput['name']
   posts?: import('./node_modules/.myprisma/client').Prisma.AuthorCreateInput['posts']
 }
-
 type ResolvedAuthorUpdateInput = {
   id?: undefined
   name?: import('./node_modules/.myprisma/client').Prisma.AuthorUpdateInput['name']

packages/core/package.json

@@ -14,10 +14,6 @@
       "module": "./access/dist/keystone-6-core-access.esm.js",
       "default": "./access/dist/keystone-6-core-access.cjs.js"
     },
-    "./system": {
-      "module": "./system/dist/keystone-6-core-system.esm.js",
-      "default": "./system/dist/keystone-6-core-system.cjs.js"
-    },
     "./context": {
       "module": "./context/dist/keystone-6-core-context.esm.js",
       "default": "./context/dist/keystone-6-core-context.cjs.js"
@@ -265,7 +261,6 @@
     "entrypoints": [
       "index.ts",
       "access.ts",
-      "system.ts",
       "___internal-do-not-use-will-break-in-patch/artifacts.ts",
       "___internal-do-not-use-will-break-in-patch/admin-ui/pages/*/index.tsx",
       "___internal-do-not-use-will-break-in-patch/admin-ui/id-field-view.tsx",

packages/core/src/___internal-do-not-use-will-break-in-patch/artifacts.ts

@@ -1,6 +1,13 @@
 export {
-  validatePrismaAndGraphQLSchemas,
-  generateTypescriptTypesAndPrisma,
-  generatePrismaAndGraphQLSchemas,
+  createExpressServer,
+} from '../lib/createExpressServer'
+export {
+  createSystem,
+} from '../lib/createSystem'
+export {
+  pushPrismaSchemaToDatabase,
+} from '../lib/migrations'
+export {
   getCommittedArtifacts,
+  validatePrismaAndGraphQLSchemas,
 } from '../artifacts'

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

@@ -7,7 +7,7 @@ import { type GraphQLSchema } from 'graphql'
 import { type Entry, walk as _walk } from '@nodelib/fs.walk'
 import {
   type AdminFileToWrite,
-  type KeystoneConfig
+  type __ResolvedKeystoneConfig
 } from '../../types'
 import { writeAdminFiles } from '../templates'
 import { type AdminMetaRootVal } from '../../lib/create-admin-meta'
@@ -66,7 +66,7 @@ export async function writeAdminFile (file: AdminFileToWrite, projectAdminPath:
 const pageExtensions = new Set(['.js', '.jsx', '.ts', '.tsx'])
 
 export async function generateAdminUI (
-  config: KeystoneConfig,
+  config: __ResolvedKeystoneConfig,
   graphQLSchema: GraphQLSchema,
   adminMeta: AdminMetaRootVal,
   projectAdminPath: string,

packages/core/src/admin-ui/templates/index.ts

@@ -1,6 +1,9 @@
 import * as Path from 'path'
 import type { GraphQLSchema } from 'graphql'
-import type { KeystoneConfig, AdminFileToWrite } from '../../types'
+import {
+  type AdminFileToWrite,
+  type __ResolvedKeystoneConfig
+} from '../../types'
 import type { AdminMetaRootVal } from '../../lib/create-admin-meta'
 import { appTemplate } from './app'
 import { homeTemplate } from './home'
@@ -13,7 +16,7 @@ import { nextConfigTemplate } from './next-config'
 const pkgDir = Path.dirname(require.resolve('@keystone-6/core/package.json'))
 
 export const writeAdminFiles = (
-  config: KeystoneConfig,
+  config: __ResolvedKeystoneConfig,
   graphQLSchema: GraphQLSchema,
   adminMeta: AdminMetaRootVal,
   configFileExists: boolean

packages/core/src/artifacts.ts

@@ -3,12 +3,13 @@ import path from 'node:path'
 import { createRequire } from 'node:module'
 import { printSchema, GraphQLSchema } from 'graphql'
 import { getGenerators, formatSchema } from '@prisma/internals'
-import type { KeystoneConfig } from './types'
-import { printGeneratedTypes } from './lib/typescript-schema-printer'
 import { ExitError } from './scripts/utils'
+import {
+  type KeystoneConfig,
+  type __ResolvedKeystoneConfig
+} from './types'
 import { initialiseLists } from './lib/core/initialise-lists'
 import { printPrismaSchema } from './lib/core/prisma-schema-printer'
-import { initConfig } from './system'
 
 export function getFormattedGraphQLSchema (schema: string) {
   return (
@@ -19,7 +20,7 @@ export function getFormattedGraphQLSchema (schema: string) {
   )
 }
 
-export async function getCommittedArtifacts (config: KeystoneConfig, graphQLSchema: GraphQLSchema) {
+export async function getCommittedArtifacts (config: __ResolvedKeystoneConfig, graphQLSchema: GraphQLSchema) {
   const lists = initialiseLists(config)
   const prismaSchema = printPrismaSchema(config, lists)
   return {
@@ -71,14 +72,14 @@ export function getBuiltKeystoneConfigurationPath (cwd: string) {
 }
 
 export function getBuiltKeystoneConfiguration (cwd: string) {
-  return initConfig(require(getBuiltKeystoneConfigurationPath(cwd)).default)
+  return require(getBuiltKeystoneConfigurationPath(cwd)).default
 }
 
 function posixify (s: string) {
   return s.split(path.sep).join('/')
 }
 
-export function getSystemPaths (cwd: string, config: KeystoneConfig) {
+export function getSystemPaths (cwd: string, config: KeystoneConfig | __ResolvedKeystoneConfig) {
   const prismaClientPath = config.db.prismaClientPath === '@prisma/client'
     ? null
     : config.db.prismaClientPath
@@ -118,7 +119,7 @@ export function getSystemPaths (cwd: string, config: KeystoneConfig) {
 
 export async function validatePrismaAndGraphQLSchemas (
   cwd: string,
-  config: KeystoneConfig,
+  config: __ResolvedKeystoneConfig,
   graphQLSchema: GraphQLSchema
 ) {
   const paths = getSystemPaths(cwd, config)
@@ -150,49 +151,7 @@ export async function validatePrismaAndGraphQLSchemas (
   throw new ExitError(1)
 }
 
-export async function generatePrismaAndGraphQLSchemas (
-  cwd: string,
-  config: KeystoneConfig,
-  graphQLSchema: GraphQLSchema
-) {
-  const paths = getSystemPaths(cwd, config)
-  const artifacts = await getCommittedArtifacts(config, graphQLSchema)
-
-  await fs.writeFile(paths.schema.graphql, artifacts.graphql)
-  await fs.writeFile(paths.schema.prisma, artifacts.prisma)
-  return artifacts
-}
-
-export async function generateTypescriptTypes (
-  cwd: string,
-  config: KeystoneConfig,
-  graphQLSchema: GraphQLSchema
-) {
-  const lists = initialiseLists(config)
-  const paths = getSystemPaths(cwd, config)
-  const schema = printGeneratedTypes(paths.types.relativePrismaPath, graphQLSchema, lists)
-
-  await fs.mkdir(path.dirname(paths.schema.types), { recursive: true })
-  await fs.writeFile(paths.schema.types, schema)
-}
-
-export async function generateTypescriptTypesAndPrisma (
-  cwd: string,
-  config: KeystoneConfig,
-  graphQLSchema: GraphQLSchema
-) {
-  const paths = getSystemPaths(cwd, config)
-  const dataProxy = config.db.url.startsWith('prisma:')
-  if (dataProxy === true) {
-    console.log('✨ Generating Prisma Client (data proxy)')
-  }
-  await Promise.all([
-    generatePrismaClient(paths.schema.prisma, dataProxy),
-    generateTypescriptTypes(cwd, config, graphQLSchema),
-  ])
-}
-
-async function generatePrismaClient (prismaSchemaPath: string, dataProxy: boolean) {
+export async function generatePrismaClient (prismaSchemaPath: string, dataProxy: boolean) {
   const generators = await getGenerators({
     schemaPath: prismaSchemaPath,
     dataProxy,

packages/core/src/context.ts

@@ -3,14 +3,13 @@ import {
   type KeystoneConfig,
   type KeystoneContext
 } from './types'
-import { initConfig } from './system'
 import { createSystem } from './lib/createSystem'
 
 export function getContext<TypeInfo extends BaseKeystoneTypeInfo> (
   config: KeystoneConfig<TypeInfo>,
   PrismaModule: unknown
 ): KeystoneContext<TypeInfo> {
-  const system = createSystem(initConfig(config))
+  const system = createSystem(config)
   const { context } = system.getKeystone(PrismaModule)
   return context
 }

packages/core/src/lib/assets/createFilesContext.ts

@@ -1,6 +1,9 @@
 import { randomBytes } from 'node:crypto'
 
-import type { KeystoneConfig, FilesContext } from '../../types'
+import {
+  type FilesContext,
+  type __ResolvedKeystoneConfig,
+} from '../../types'
 import { localFileAssetsAPI } from './local'
 import { s3FileAssetsAPI } from './s3'
 import type { FileAdapter } from './types'
@@ -18,7 +21,7 @@ function defaultTransformName (path: string) {
   return `${urlSafeName}-${id}`
 }
 
-export function createFilesContext (config: KeystoneConfig): FilesContext {
+export function createFilesContext (config: __ResolvedKeystoneConfig): FilesContext {
   const adaptersMap = new Map<string, FileAdapter>()
 
   for (const [storageKey, storageConfig] of Object.entries(config.storage || {})) {