0e5bda9a74
### What?
Previously, the `req` argument:
In database operations (e.g `payload.db`) was required and you needed to
pass the whole `req` with all the properties. This is confusing because
in database operations we never use its properties outside of
`req.transactionID` and `req.t`, both of which should be optional as
well.
Now, you don't have to do that cast:
```ts
payload.db.findOne({
collection: 'posts',
req: {} as PayloadRequest,
where: {
id: {
equals: 1,
},
},
})
```
Becomes:
```ts
payload.db.findOne({
collection: 'posts',
where: {
id: {
equals: 1,
},
},
})
```
If you need to use transactions, you're not required to do the `as` cast
as well now, as the `req` not only optional but also partial -
`Partial<PayloadRequest>`.
`initTransaction`, `commitTransaction`, `killTransaction` utilities are
typed better now as well. They do not require to you pass all the
properties of `req`, but only `payload` -
`MarkRequired<Partial<PayloadRequest>, 'payload'>`
```ts
const req = { payload }
await initTransaction(req)
await payload.db.create({
collection: "posts",
data: {},
req
})
await commitTransaction(req)
```
The same for the Local API. Internal operations (for example
`packages/payload/src/collections/operations/find.ts`) still accept the
whole `req`, but local ones
(`packages/payload/src/collections/operations/local/find.ts`) which are
used through `payload.` now accept `Partial<PayloadRequest>`, as they
pass it through to internal operations with `createLocalReq`.
So now, this is also valid, while previously you had to do `as` cast for
`req`.
```ts
const req = { payload }
await initTransaction(req)
await payload.create({
collection: "posts",
data: {},
req
})
await commitTransaction(req)
```
Marked as deprecated `PayloadRequest['transactionIDPromise']` to remove
in the next major version. It was never used anywhere.
Refactored `withSession` that returns an object to `getSession` that
returns just `ClientSession`. Better type safety for arguments
Deduplicated in all drizzle operations to `getTransaction(this, req)`
utility:
```ts
const db = this.sessions[await req?.transactionID]?.db || this.drizzle
```
Added fallback for throwing unique validation errors in database
operations when `req.t` is not available.
In migration `up` and `down` functions our `req` is not partial, while
we used to passed `req` with only 2 properties - `payload` and
`transactionID`. This is misleading and you can't access for example
`req.t`.
Now, to achieve "real" full `req` - we generate it with `createLocalReq`
in all migration functions.
This all is backwards compatible. In all public API places where you
expect the full `req` (like hooks) you still have it.
### Why?
Better DX, more expected types, less errors because of types casting.
54 lines
1.3 KiB
TypeScript
54 lines
1.3 KiB
TypeScript
import type {
|
|
SanitizedCollectionConfig,
|
|
TypeWithID,
|
|
TypeWithVersion,
|
|
UpdateVersionArgs,
|
|
} from 'payload'
|
|
|
|
import { buildVersionCollectionFields } from 'payload'
|
|
import toSnakeCase from 'to-snake-case'
|
|
|
|
import type { DrizzleAdapter } from './types.js'
|
|
|
|
import buildQuery from './queries/buildQuery.js'
|
|
import { upsertRow } from './upsertRow/index.js'
|
|
import { getTransaction } from './utilities/getTransaction.js'
|
|
|
|
export async function updateVersion<T extends TypeWithID>(
|
|
this: DrizzleAdapter,
|
|
{ id, collection, locale, req, select, versionData, where: whereArg }: UpdateVersionArgs<T>,
|
|
) {
|
|
const db = await getTransaction(this, req)
|
|
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
|
|
const whereToUse = whereArg || { id: { equals: id } }
|
|
const tableName = this.tableNameMap.get(
|
|
`_${toSnakeCase(collectionConfig.slug)}${this.versionsSuffix}`,
|
|
)
|
|
|
|
const fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
|
|
|
|
const { where } = buildQuery({
|
|
adapter: this,
|
|
fields,
|
|
locale,
|
|
tableName,
|
|
where: whereToUse,
|
|
})
|
|
|
|
const result = await upsertRow<TypeWithVersion<T>>({
|
|
id,
|
|
adapter: this,
|
|
data: versionData,
|
|
db,
|
|
fields,
|
|
joinQuery: false,
|
|
operation: 'update',
|
|
req,
|
|
select,
|
|
tableName,
|
|
where,
|
|
})
|
|
|
|
return result
|
|
}
|