Add config.experimental.contextInitialisedLists (#6403)

.changeset/afraid-ladybugs-perform.md

@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': minor
+---
+
+Added the experimental config option `config.experimental.contextInitialisedLists`, which adds the internal data structure `experimental.initialisedLists` to the `context` object. This is a temporary addition to the API which will be removed in a future release once a more controlled API is available. It should be used with caution, as it will contain breaking change in `patch` level releases.

packages/keystone/src/lib/context/createContext.ts

@@ -9,6 +9,7 @@ import {
 } from '../../types';
 
 import { PrismaClient } from '../core/utils';
+import { InitialisedList } from '../core/types-for-lists';
 import { getDbAPIFactory, itemAPIForList } from './itemAPI';
 import { createImagesContext } from './createImagesContext';
 import { createFilesContext } from './createFilesContext';
@@ -19,12 +20,14 @@ export function makeCreateContext({
   prismaClient,
   gqlNamesByList,
   config,
+  lists,
 }: {
   graphQLSchema: GraphQLSchema;
   internalSchema: GraphQLSchema;
   config: KeystoneConfig;
   prismaClient: PrismaClient;
   gqlNamesByList: Record<string, GqlNames>;
+  lists: Record<string, InitialisedList>;
 }) {
   const images = createImagesContext(config);
   const files = createFilesContext(config);
@@ -99,6 +102,10 @@ export function makeCreateContext({
       images,
       files,
     };
+    if (config.experimental?.contextInitialisedLists) {
+      contextToReturn.experimental = { initialisedLists: lists };
+    }
+
     const dbAPIFactories = schemaName === 'public' ? publicDbApiFactories : internalDbApiFactories;
     for (const listKey of Object.keys(gqlNamesByList)) {
       dbAPI[listKey] = dbAPIFactories[listKey](contextToReturn);

packages/keystone/src/lib/createSystem.ts

@@ -81,6 +81,7 @@ export function createSystem(config: KeystoneConfig) {
         gqlNamesByList: Object.fromEntries(
           Object.entries(lists).map(([listKey, list]) => [listKey, getGqlNames(list)])
         ),
+        lists,
       });
 
       return {

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

@@ -37,6 +37,10 @@ export type KeystoneConfig = {
     generateNextGraphqlAPI?: boolean;
     /** Config options for Keystone Cloud */
     keystoneCloud?: KeystoneCloudConfig;
+    /** Adds the internal data structure `experimental.initialisedLists` to the context object.
+     * This is not a stable API and may contain breaking changes in `patch` level releases.
+     */
+    contextInitialisedLists?: boolean;
   };
 };
 

packages/keystone/src/types/context.ts

@@ -1,6 +1,7 @@
 import { IncomingMessage } from 'http';
 import { Readable } from 'stream';
 import { GraphQLSchema, ExecutionResult, DocumentNode } from 'graphql';
+import { InitialisedList } from '../lib/core/types-for-lists';
 import type { BaseGeneratedListTypes, GqlNames } from './utils';
 
 export type KeystoneContext = {
@@ -20,6 +21,12 @@ export type KeystoneContext = {
   schemaName: 'public' | 'internal';
   /** @deprecated */
   gqlNames: (listKey: string) => GqlNames;
+  experimental?: {
+    /** @deprecated This value is only available if you have config.experimental.contextInitialisedLists = true.
+     * This is not a stable API and may contain breaking changes in `patch` level releases.
+     */
+    initialisedLists: Record<string, InitialisedList>;
+  };
 } & Partial<SessionContext<any>>;
 
 // List item API