feat(db-postgres, db-sqlite): drizzle schema generation (#9953)

This PR allows to have full type safety on `payload.drizzle` with a
single command
```sh
pnpm payload generate:db-schema
```
Which generates TypeScript code with Drizzle declarations based on the
current database schema.

Example of generated file with the website template: 
https://gist.github.com/r1tsuu/b8687f211b51d9a3a7e78ba41e8fbf03

Video that shows the power:


https://github.com/user-attachments/assets/3ced958b-ec1d-49f5-9f51-d859d5fae236


We also now proxy drizzle package the same way we do for Lexical so you
don't have to install it (and you shouldn't because you may have version
mismatch).
Instead, you can import from Drizzle like this:
```ts
import {
  pgTable,
  index,
  foreignKey,
  integer,
  text,
  varchar,
  jsonb,
  boolean,
  numeric,
  serial,
  timestamp,
  uniqueIndex,
  pgEnum,
} from '@payloadcms/db-postgres/drizzle/pg-core'
import { sql } from '@payloadcms/db-postgres/drizzle'
import { relations } from '@payloadcms/db-postgres/drizzle/relations'
```


Fixes https://github.com/payloadcms/payload/discussions/4318

In the future we can also support types generation for mongoose / raw
mongodb results.
This commit is contained in:
Sasha
2024-12-19 18:08:17 +02:00
committed by GitHub
parent ba0e7aeee5
commit 23f1ed4a48
39 changed files with 4519 additions and 32 deletions

View File

@@ -0,0 +1,48 @@
import path from 'path'
import { getPayload, type SanitizedConfig } from 'payload'
import { fileURLToPath } from 'url'
import { generateDatabaseAdapter } from './generateDatabaseAdapter.js'
import { setTestEnvPaths } from './helpers/setTestEnvPaths.js'
const [testConfigDir] = process.argv.slice(2)
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
const writeDBAdapter = process.env.WRITE_DB_ADAPTER !== 'false'
process.env.PAYLOAD_DROP_DATABASE = process.env.PAYLOAD_DROP_DATABASE || 'true'
if (process.env.PAYLOAD_DATABASE === 'mongodb') {
throw new Error('Not supported')
}
if (writeDBAdapter) {
generateDatabaseAdapter(process.env.PAYLOAD_DATABASE || 'postgres')
process.env.WRITE_DB_ADAPTER = 'false'
}
const loadConfig = async (configPath: string): Promise<SanitizedConfig> => {
return await (
await import(configPath)
).default
}
if (!testConfigDir) {
throw new Error('Yo must Specify testConfigDir')
}
const testDir = path.resolve(dirname, testConfigDir)
const config = await loadConfig(path.resolve(testDir, 'config.ts'))
setTestEnvPaths(testDir)
const payload = await getPayload({ config })
// await payload.db.dropDatabase({ adapter: payload.db })
await payload.db.generateSchema({
outputFile: path.resolve(testDir, 'payload-generated-schema.ts'),
})
process.exit(0)