Merge branch 'main' into fix/db-postgres-numbers-texts-trigger-delete

Author: akhrarovsaid

package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload-monorepo",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "private": true,
   "type": "module",
   "scripts": {

packages/admin-bar/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/admin-bar",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "description": "An admin bar for React apps using Payload",
   "homepage": "https://payloadcms.com",
   "repository": {

packages/create-payload-app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-payload-app",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "homepage": "https://payloadcms.com",
   "repository": {
     "type": "git",

packages/db-mongodb/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/db-mongodb",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "description": "The officially supported MongoDB database adapter for Payload",
   "homepage": "https://payloadcms.com",
   "repository": {

packages/db-mongodb/src/find.ts

@@ -1,4 +1,4 @@
-import type { PaginateOptions } from 'mongoose'
+import type { PaginateOptions, PipelineStage } from 'mongoose'
 import type { Find } from 'payload'
 
 import { flattenWhereToOperators } from 'payload'
@@ -41,13 +41,17 @@ export const find: Find = async function find(
     hasNearConstraint = constraints.some((prop) => Object.keys(prop).some((key) => key === 'near'))
   }
 
+  const sortAggregation: PipelineStage[] = []
+
   let sort
   if (!hasNearConstraint) {
     sort = buildSortParam({
+      adapter: this,
       config: this.payload.config,
       fields: collectionConfig.flattenedFields,
       locale,
       sort: sortArg || collectionConfig.defaultSort,
+      sortAggregation,
       timestamps: true,
     })
   }
@@ -128,8 +132,8 @@ export const find: Find = async function find(
     locale,
     query,
   })
-  // build join aggregation
-  if (aggregate) {
+
+  if (aggregate || sortAggregation.length > 0) {
     result = await aggregatePaginate({
       adapter: this,
       collation: paginationOptions.collation,
@@ -142,6 +146,7 @@ export const find: Find = async function find(
       query,
       session: paginationOptions.options?.session ?? undefined,
       sort: paginationOptions.sort as object,
+      sortAggregation,
       useEstimatedCount: paginationOptions.useEstimatedCount,
     })
   } else {

packages/db-mongodb/src/findGlobalVersions.ts

@@ -48,6 +48,7 @@ export const findGlobalVersions: FindGlobalVersions = async function findGlobalV
   let sort
   if (!hasNearConstraint) {
     sort = buildSortParam({
+      adapter: this,
       config: this.payload.config,
       fields: versionFields,
       locale,
@@ -103,7 +104,7 @@ export const findGlobalVersions: FindGlobalVersions = async function findGlobalV
   if (limit && limit >= 0) {
     paginationOptions.limit = limit
     // limit must also be set here, it's ignored when pagination is false
-     
+
     paginationOptions.options!.limit = limit
 
     // Disable pagination if limit is 0

packages/db-mongodb/src/findVersions.ts

@@ -50,6 +50,7 @@ export const findVersions: FindVersions = async function findVersions(
   let sort
   if (!hasNearConstraint) {
     sort = buildSortParam({
+      adapter: this,
       config: this.payload.config,
       fields: collectionConfig.flattenedFields,
       locale,
@@ -111,7 +112,7 @@ export const findVersions: FindVersions = async function findVersions(
   if (limit && limit >= 0) {
     paginationOptions.limit = limit
     // limit must also be set here, it's ignored when pagination is false
-     
+
     paginationOptions.options!.limit = limit
 
     // Disable pagination if limit is 0

packages/db-mongodb/src/queries/buildSortParam.ts

@@ -1,14 +1,28 @@
-import type { FlattenedField, SanitizedConfig, Sort } from 'payload'
+import type { PipelineStage } from 'mongoose'
 
+import {
+  APIError,
+  type FlattenedField,
+  getFieldByPath,
+  type SanitizedConfig,
+  type Sort,
+} from 'payload'
+
+import type { MongooseAdapter } from '../index.js'
+
+import { getCollection } from '../utilities/getEntity.js'
 import { getLocalizedSortProperty } from './getLocalizedSortProperty.js'
 
 type Args = {
+  adapter: MongooseAdapter
   config: SanitizedConfig
   fields: FlattenedField[]
   locale?: string
   parentIsLocalized?: boolean
   sort: Sort
+  sortAggregation?: PipelineStage[]
   timestamps: boolean
+  versions?: boolean
 }
 
 export type SortArgs = {
@@ -18,13 +32,111 @@ export type SortArgs = {
 
 export type SortDirection = 'asc' | 'desc'
 
+const relationshipSort = ({
+  adapter,
+  fields,
+  locale,
+  path,
+  sort,
+  sortAggregation,
+  sortDirection,
+  versions,
+}: {
+  adapter: MongooseAdapter
+  fields: FlattenedField[]
+  locale?: string
+  path: string
+  sort: Record<string, string>
+  sortAggregation: PipelineStage[]
+  sortDirection: SortDirection
+  versions?: boolean
+}) => {
+  let currentFields = fields
+  const segments = path.split('.')
+  if (segments.length < 2) {
+    return false
+  }
+
+  for (const [i, segment] of segments.entries()) {
+    if (versions && i === 0 && segment === 'version') {
+      segments.shift()
+      continue
+    }
+
+    const field = currentFields.find((each) => each.name === segment)
+
+    if (!field) {
+      return false
+    }
+
+    if ('fields' in field) {
+      currentFields = field.flattenedFields
+    } else if (
+      (field.type === 'relationship' || field.type === 'upload') &&
+      i !== segments.length - 1
+    ) {
+      const relationshipPath = segments.slice(0, i + 1).join('.')
+      let sortFieldPath = segments.slice(i + 1, segments.length).join('.')
+      if (Array.isArray(field.relationTo)) {
+        throw new APIError('Not supported')
+      }
+
+      const foreignCollection = getCollection({ adapter, collectionSlug: field.relationTo })
+
+      const foreignFieldPath = getFieldByPath({
+        fields: foreignCollection.collectionConfig.flattenedFields,
+        path: sortFieldPath,
+      })
+
+      if (!foreignFieldPath) {
+        return false
+      }
+
+      if (foreignFieldPath.pathHasLocalized && locale) {
+        sortFieldPath = foreignFieldPath.localizedPath.replace('<locale>', locale)
+      }
+
+      if (
+        !sortAggregation.some((each) => {
+          return '$lookup' in each && each.$lookup.as === `__${path}`
+        })
+      ) {
+        sortAggregation.push({
+          $lookup: {
+            as: `__${path}`,
+            foreignField: '_id',
+            from: foreignCollection.Model.collection.name,
+            localField: relationshipPath,
+            pipeline: [
+              {
+                $project: {
+                  [sortFieldPath]: true,
+                },
+              },
+            ],
+          },
+        })
+
+        sort[`__${path}.${sortFieldPath}`] = sortDirection
+
+        return true
+      }
+    }
+  }
+
+  return false
+}
+
 export const buildSortParam = ({
+  adapter,
   config,
   fields,
   locale,
   parentIsLocalized = false,
   sort,
+  sortAggregation,
   timestamps,
+  versions,
 }: Args): Record<string, string> => {
   if (!sort) {
     if (timestamps) {
@@ -52,6 +164,23 @@ export const buildSortParam = ({
       acc['_id'] = sortDirection
       return acc
     }
+
+    if (
+      sortAggregation &&
+      relationshipSort({
+        adapter,
+        fields,
+        locale,
+        path: sortProperty,
+        sort: acc,
+        sortAggregation,
+        sortDirection,
+        versions,
+      })
+    ) {
+      return acc
+    }
+
     const localizedProperty = getLocalizedSortProperty({
       config,
       fields,
@@ -60,6 +189,7 @@ export const buildSortParam = ({
       segments: sortProperty.split('.'),
     })
     acc[localizedProperty] = sortDirection
+
     return acc
   }, {})
 

packages/db-mongodb/src/queryDrafts.ts

@@ -1,4 +1,4 @@
-import type { PaginateOptions, QueryOptions } from 'mongoose'
+import type { PaginateOptions, PipelineStage, QueryOptions } from 'mongoose'
 import type { QueryDrafts } from 'payload'
 
 import { buildVersionCollectionFields, combineQueries, flattenWhereToOperators } from 'payload'
@@ -47,19 +47,24 @@ export const queryDrafts: QueryDrafts = async function queryDrafts(
     hasNearConstraint = constraints.some((prop) => Object.keys(prop).some((key) => key === 'near'))
   }
 
+  const fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
+
+  const sortAggregation: PipelineStage[] = []
   if (!hasNearConstraint) {
     sort = buildSortParam({
+      adapter: this,
       config: this.payload.config,
-      fields: collectionConfig.flattenedFields,
+      fields,
       locale,
       sort: sortArg || collectionConfig.defaultSort,
+      sortAggregation,
       timestamps: true,
+      versions: true,
     })
   }
 
   const combinedWhere = combineQueries({ latest: { equals: true } }, where)
 
-  const fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
   const versionQuery = await buildQuery({
     adapter: this,
     fields,
@@ -133,7 +138,7 @@ export const queryDrafts: QueryDrafts = async function queryDrafts(
   })
 
   // build join aggregation
-  if (aggregate) {
+  if (aggregate || sortAggregation.length > 0) {
     result = await aggregatePaginate({
       adapter: this,
       collation: paginationOptions.collation,

packages/db-mongodb/src/updateMany.ts

@@ -39,6 +39,7 @@ export const updateMany: UpdateMany = async function updateMany(
   let sort: Record<string, unknown> | undefined
   if (!hasNearConstraint) {
     sort = buildSortParam({
+      adapter: this,
       config: this.payload.config,
       fields: collectionConfig.flattenedFields,
       locale,

packages/db-mongodb/src/utilities/aggregatePaginate.ts

@@ -16,6 +16,7 @@ export const aggregatePaginate = async ({
   query,
   session,
   sort,
+  sortAggregation,
   useEstimatedCount,
 }: {
   adapter: MongooseAdapter
@@ -29,10 +30,17 @@ export const aggregatePaginate = async ({
   query: Record<string, unknown>
   session?: ClientSession
   sort?: object
+  sortAggregation?: PipelineStage[]
   useEstimatedCount?: boolean
 }): Promise<PaginatedDocs<any>> => {
   const aggregation: PipelineStage[] = [{ $match: query }]
 
+  if (sortAggregation && sortAggregation.length > 0) {
+    for (const stage of sortAggregation) {
+      aggregation.push(stage)
+    }
+  }
+
   if (sort) {
     const $sort: Record<string, -1 | 1> = {}
 

packages/db-mongodb/src/utilities/buildJoinAggregation.ts

@@ -87,6 +87,7 @@ export const buildJoinAggregation = async ({
     }
 
     const sort = buildSortParam({
+      adapter,
       config: adapter.payload.config,
       fields: aggregatedFields,
       locale,
@@ -279,6 +280,7 @@ export const buildJoinAggregation = async ({
       }
 
       const sort = buildSortParam({
+        adapter,
         config: adapter.payload.config,
         fields: collectionConfig.flattenedFields,
         locale,

packages/db-postgres/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/db-postgres",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "description": "The officially supported Postgres database adapter for Payload",
   "homepage": "https://payloadcms.com",
   "repository": {

packages/db-sqlite/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/db-sqlite",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "description": "The officially supported SQLite database adapter for Payload",
   "homepage": "https://payloadcms.com",
   "repository": {

packages/db-vercel-postgres/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/db-vercel-postgres",
-  "version": "3.28.1",
+  "version": "3.29.0",
   "description": "Vercel Postgres adapter for Payload",
   "homepage": "https://payloadcms.com",
   "repository": {