Generate specific types for KeystoneContext and List APIs (#6093)

.changeset/orange-buttons-crash.md

@@ -0,0 +1,7 @@
+---
+"@keystone-next/keystone": patch
+---
+
+Added generated types for KeystoneContext, KeystoneListsAPI and KeystoneDbAPI.
+
+You can now import these from `.keystone/types` (instead of `@keystone-next/types`) to get types that are pre-bound to your project's schema.

packages/keystone/src/lib/schema-type-printer.tsx

@@ -85,6 +85,14 @@ export function printGeneratedTypes(
     Float: 'number',
     JSON: 'import("@keystone-next/types").JSONValue',
   };
+
+  let prelude = `import {
+  KeystoneListsAPI as GenericKeystoneListsAPI,
+  KeystoneDbAPI as GenericKeystoneDbAPI,
+  KeystoneContext as GenericKeystoneContext,
+} from '@keystone-next/types';
+`;
+
   let { printedTypes, ast, printTypeNode } = printInputTypesFromSchema(
     printedSchema,
     graphQLSchema,
@@ -154,7 +162,19 @@ export type ${listKey}ListFn = (
 `;
     allListsStr += `\n  readonly ${JSON.stringify(listKey)}: ${listTypeInfoName};`;
   }
-  return prettier.format(printedTypes + allListsStr + '\n};\n', {
+  allListsStr += '\n};';
+
+  const postlude = `
+export type KeystoneListsAPI = GenericKeystoneListsAPI<KeystoneListsTypeInfo>;
+export type KeystoneDbAPI = GenericKeystoneDbAPI<KeystoneListsTypeInfo>;
+
+export type KeystoneContext = Omit<GenericKeystoneContext, 'db' | 'lists' | 'prisma'> & {
+  db: { lists: KeystoneDbAPI };
+  lists: KeystoneListsAPI;
+  prisma: import('.prisma/client').PrismaClient;
+};
+`;
+  return prettier.format(prelude + printedTypes + allListsStr + postlude, {
     parser: 'babel-ts',
     trailingComma: 'es5',
     singleQuote: true,

packages/keystone/src/scripts/tests/__snapshots__/artifacts.test.ts.snap

@@ -2,6 +2,11 @@
 
 exports[`postinstall writes the correct node_modules files 1`] = `
 ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯ node_modules/.keystone/types.d.ts ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
+import {
+  KeystoneListsAPI as GenericKeystoneListsAPI,
+  KeystoneDbAPI as GenericKeystoneDbAPI,
+  KeystoneContext as GenericKeystoneContext,
+} from '@keystone-next/types';
 type Scalars = {
   readonly ID: string;
   readonly Boolean: boolean;
@@ -113,6 +118,17 @@ export type TodoListFn = (
 export type KeystoneListsTypeInfo = {
   readonly Todo: TodoListTypeInfo;
 };
+export type KeystoneListsAPI = GenericKeystoneListsAPI<KeystoneListsTypeInfo>;
+export type KeystoneDbAPI = GenericKeystoneDbAPI<KeystoneListsTypeInfo>;
+
+export type KeystoneContext = Omit<
+  GenericKeystoneContext,
+  'db' | 'lists' | 'prisma'
+> & {
+  db: { lists: KeystoneDbAPI };
+  lists: KeystoneListsAPI;
+  prisma: import('.prisma/client').PrismaClient;
+};
 
 ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯ node_modules/.keystone/types.js ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯