feat(core/db): allow to extend PrismaClient (#9114)

Co-authored-by: Daniel Cousens <[email protected]>
keystonejs · Apr 25, 2024 · a9d1d22 · a9d1d22
1 parent 2613769
commit a9d1d22
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/.changeset/extend-prisma-client.md b/.changeset/extend-prisma-client.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Add `config.db.extendPrismaClient` to support extending the `PrismaClient`
diff --git a/packages/core/src/lib/createSystem.ts b/packages/core/src/lib/createSystem.ts
@@ -224,7 +224,10 @@ export function createSystem (config_: KeystoneConfig) {
         log: config.db.enableLogging
       })
 
-      const prismaClient = injectNewDefaults(prePrismaClient, lists)
+      const prismaClient = config.db.extendPrismaClient(
+        injectNewDefaults(prePrismaClient, lists)
+      )
+
       const context = createContext({
         config,
         lists,

diff --git a/packages/core/src/lib/defaults.ts b/packages/core/src/lib/defaults.ts
@@ -74,6 +74,7 @@ function defaultIsAccessAllowed ({ session, sessionStrategy }: KeystoneContext)
 }
 
 async function noop () {}
+function identity<T> (x: T) { return x }
 
 export function resolveDefaults <TypeInfo extends BaseKeystoneTypeInfo> (config: KeystoneConfig<TypeInfo>): __ResolvedKeystoneConfig<TypeInfo> {
   if (!['postgresql', 'sqlite', 'mysql'].includes(config.db.provider)) {
@@ -108,7 +109,8 @@ export function resolveDefaults <TypeInfo extends BaseKeystoneTypeInfo> (config:
     db: {
       ...config.db,
       shadowDatabaseUrl: config.db?.shadowDatabaseUrl ?? '',
-      extendPrismaSchema: config.db?.extendPrismaSchema ?? ((schema: string) => schema),
+      extendPrismaSchema: config.db?.extendPrismaSchema ?? identity,
+      extendPrismaClient: config.db?.extendPrismaClient ?? identity,
       onConnect: config.db.onConnect ?? noop,
       prismaClientPath: config.db?.prismaClientPath ?? '@prisma/client',
       prismaSchemaPath: config.db?.prismaSchemaPath ?? 'schema.prisma',

diff --git a/packages/core/src/types/config/index.ts b/packages/core/src/types/config/index.ts
@@ -114,6 +114,7 @@ export type KeystoneConfig<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystoneT
     prismaSchemaPath?: string
 
     extendPrismaSchema?: (schema: string) => string
+    extendPrismaClient?: (client: any) => any
   }
 
   graphql?: {