@payloadcms/drizzle 3.0.0-canary.d894ac7 → 3.0.0-canary.e198dc5

package/dist/postgres/schema/traverseFields.js

@@ -1,7 +1,7 @@
 import { relations } from 'drizzle-orm';
-import { PgNumericBuilder, PgUUIDBuilder, PgVarcharBuilder, boolean, foreignKey, index, integer, jsonb, numeric, text, timestamp, varchar } from 'drizzle-orm/pg-core';
+import { boolean, foreignKey, index, integer, jsonb, numeric, PgNumericBuilder, PgUUIDBuilder, PgVarcharBuilder, text, timestamp, varchar } from 'drizzle-orm/pg-core';
 import { InvalidConfiguration } from 'payload';
-import { fieldAffectsData, optionIsObject } from 'payload/shared';
+import { fieldAffectsData, fieldIsVirtual, optionIsObject } from 'payload/shared';
 import toSnakeCase from 'to-snake-case';
 import { createTableName } from '../../createTableName.js';
 import { hasLocalesTable } from '../../utilities/hasLocalesTable.js';
@@ -11,7 +11,7 @@ import { createIndex } from './createIndex.js';
 import { idToUUID } from './idToUUID.js';
 import { parentIDColumnMap } from './parentIDColumnMap.js';
 import { withDefault } from './withDefault.js';
-export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull, disableUnique = false, fieldPrefix, fields, forceLocalized, indexes, localesColumns, localesIndexes, newTableName, parentTableName, relationsToBuild, relationships, rootRelationsToBuild, rootTableIDColType, rootTableName, versions })=>{
+export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull, disableUnique = false, fieldPrefix, fields, forceLocalized, indexes, joins, localesColumns, localesIndexes, newTableName, parentTableName, relationships, relationsToBuild, rootRelationsToBuild, rootTableIDColType, rootTableName, versions, withinLocalizedArrayOrBlock })=>{
     const throwValidationError = true;
     let hasLocalizedField = false;
     let hasLocalizedRelationshipField = false;
@@ -20,11 +20,22 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
     let hasManyNumberField = false;
     let hasLocalizedManyNumberField = false;
     let parentIDColType = 'integer';
-    if (columns.id instanceof PgUUIDBuilder) parentIDColType = 'uuid';
-    if (columns.id instanceof PgNumericBuilder) parentIDColType = 'numeric';
-    if (columns.id instanceof PgVarcharBuilder) parentIDColType = 'varchar';
+    if (columns.id instanceof PgUUIDBuilder) {
+        parentIDColType = 'uuid';
+    }
+    if (columns.id instanceof PgNumericBuilder) {
+        parentIDColType = 'numeric';
+    }
+    if (columns.id instanceof PgVarcharBuilder) {
+        parentIDColType = 'varchar';
+    }
     fields.forEach((field)=>{
-        if ('name' in field && field.name === 'id') return;
+        if ('name' in field && field.name === 'id') {
+            return;
+        }
+        if (fieldIsVirtual(field)) {
+            return;
+        }
         let columnName;
         let fieldName;
         let targetTable = columns;
@@ -56,7 +67,10 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                     adapter.fieldConstraints[rootTableName][`${columnName}_idx`] = constraintValue;
                 }
                 targetIndexes[`${newTableName}_${field.name}Idx`] = createIndex({
-                    name: fieldName,
+                    name: field.localized ? [
+                        fieldName,
+                        '_locale'
+                    ] : fieldName,
                     columnName,
                     tableName: newTableName,
                     unique
@@ -67,7 +81,8 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
             case 'text':
                 {
                     if (field.hasMany) {
-                        if (field.localized) {
+                        const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                        if (isLocalized) {
                             hasLocalizedManyTextField = true;
                         }
                         if (field.index) {
@@ -93,7 +108,8 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
             case 'number':
                 {
                     if (field.hasMany) {
-                        if (field.localized) {
+                        const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                        if (isLocalized) {
                             hasLocalizedManyNumberField = true;
                         }
                         if (field.index) {
@@ -172,7 +188,8 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                                 }).onDelete('cascade'),
                             parentIdx: (cols)=>index(`${selectTableName}_parent_idx`).on(cols.parent)
                         };
-                        if (field.localized) {
+                        const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                        if (isLocalized) {
                             baseColumns.locale = adapter.enums.enum__locales('locale').notNull();
                             baseExtraConfig.localeIdx = (cols)=>index(`${selectTableName}_locale_idx`).on(cols.locale);
                         }
@@ -208,7 +225,7 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                                 })
                             }));
                     } else {
-                        targetTable[fieldName] = withDefault(adapter.enums[enumName](fieldName), field);
+                        targetTable[fieldName] = withDefault(adapter.enums[enumName](columnName), field);
                     }
                     break;
                 }
@@ -245,29 +262,44 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                             }).onDelete('cascade'),
                         _parentIDIdx: (cols)=>index(`${arrayTableName}_parent_id_idx`).on(cols._parentID)
                     };
-                    if (field.localized && adapter.payload.config.localization) {
+                    const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                    if (isLocalized) {
                         baseColumns._locale = adapter.enums.enum__locales('_locale').notNull();
                         baseExtraConfig._localeIdx = (cols)=>index(`${arrayTableName}_locale_idx`).on(cols._locale);
                     }
-                    const { hasManyNumberField: subHasManyNumberField, hasManyTextField: subHasManyTextField, relationsToBuild: subRelationsToBuild } = buildTable({
+                    const { hasLocalizedManyNumberField: subHasLocalizedManyNumberField, hasLocalizedManyTextField: subHasLocalizedManyTextField, hasLocalizedRelationshipField: subHasLocalizedRelationshipField, hasManyNumberField: subHasManyNumberField, hasManyTextField: subHasManyTextField, relationsToBuild: subRelationsToBuild } = buildTable({
                         adapter,
                         baseColumns,
                         baseExtraConfig,
                         disableNotNull: disableNotNullFromHere,
                         disableUnique,
                         fields: disableUnique ? idToUUID(field.fields) : field.fields,
-                        rootRelationsToBuild,
                         rootRelationships: relationships,
+                        rootRelationsToBuild,
                         rootTableIDColType,
                         rootTableName,
                         tableName: arrayTableName,
-                        versions
+                        versions,
+                        withinLocalizedArrayOrBlock: isLocalized
                     });
+                    if (subHasLocalizedManyNumberField) {
+                        hasLocalizedManyNumberField = subHasLocalizedManyNumberField;
+                    }
+                    if (subHasLocalizedRelationshipField) {
+                        hasLocalizedRelationshipField = subHasLocalizedRelationshipField;
+                    }
+                    if (subHasLocalizedManyTextField) {
+                        hasLocalizedManyTextField = subHasLocalizedManyTextField;
+                    }
                     if (subHasManyTextField) {
-                        if (!hasManyTextField || subHasManyTextField === 'index') hasManyTextField = subHasManyTextField;
+                        if (!hasManyTextField || subHasManyTextField === 'index') {
+                            hasManyTextField = subHasManyTextField;
+                        }
                     }
                     if (subHasManyNumberField) {
-                        if (!hasManyNumberField || subHasManyNumberField === 'index') hasManyNumberField = subHasManyNumberField;
+                        if (!hasManyNumberField || subHasManyNumberField === 'index') {
+                            hasManyNumberField = subHasManyNumberField;
+                        }
                     }
                     relationsToBuild.set(fieldName, {
                         type: 'many',
@@ -335,7 +367,6 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                             };
                             const baseExtraConfig = {
                                 _orderIdx: (cols)=>index(`${blockTableName}_order_idx`).on(cols._order),
-                                _parentIDIdx: (cols)=>index(`${blockTableName}_parent_id_idx`).on(cols._parentID),
                                 _parentIdFk: (cols)=>foreignKey({
                                         name: `${blockTableName}_parent_id_fk`,
                                         columns: [
@@ -345,31 +376,47 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                                             adapter.tables[rootTableName].id
                                         ]
                                     }).onDelete('cascade'),
+                                _parentIDIdx: (cols)=>index(`${blockTableName}_parent_id_idx`).on(cols._parentID),
                                 _pathIdx: (cols)=>index(`${blockTableName}_path_idx`).on(cols._path)
                             };
-                            if (field.localized && adapter.payload.config.localization) {
+                            const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                            if (isLocalized) {
                                 baseColumns._locale = adapter.enums.enum__locales('_locale').notNull();
                                 baseExtraConfig._localeIdx = (cols)=>index(`${blockTableName}_locale_idx`).on(cols._locale);
                             }
-                            const { hasManyNumberField: subHasManyNumberField, hasManyTextField: subHasManyTextField, relationsToBuild: subRelationsToBuild } = buildTable({
+                            const { hasLocalizedManyNumberField: subHasLocalizedManyNumberField, hasLocalizedManyTextField: subHasLocalizedManyTextField, hasLocalizedRelationshipField: subHasLocalizedRelationshipField, hasManyNumberField: subHasManyNumberField, hasManyTextField: subHasManyTextField, relationsToBuild: subRelationsToBuild } = buildTable({
                                 adapter,
                                 baseColumns,
                                 baseExtraConfig,
                                 disableNotNull: disableNotNullFromHere,
                                 disableUnique,
                                 fields: disableUnique ? idToUUID(block.fields) : block.fields,
-                                rootRelationsToBuild,
                                 rootRelationships: relationships,
+                                rootRelationsToBuild,
                                 rootTableIDColType,
                                 rootTableName,
                                 tableName: blockTableName,
-                                versions
+                                versions,
+                                withinLocalizedArrayOrBlock: isLocalized
                             });
+                            if (subHasLocalizedManyNumberField) {
+                                hasLocalizedManyNumberField = subHasLocalizedManyNumberField;
+                            }
+                            if (subHasLocalizedRelationshipField) {
+                                hasLocalizedRelationshipField = subHasLocalizedRelationshipField;
+                            }
+                            if (subHasLocalizedManyTextField) {
+                                hasLocalizedManyTextField = subHasLocalizedManyTextField;
+                            }
                             if (subHasManyTextField) {
-                                if (!hasManyTextField || subHasManyTextField === 'index') hasManyTextField = subHasManyTextField;
+                                if (!hasManyTextField || subHasManyTextField === 'index') {
+                                    hasManyTextField = subHasManyTextField;
+                                }
                             }
                             if (subHasManyNumberField) {
-                                if (!hasManyNumberField || subHasManyNumberField === 'index') hasManyNumberField = subHasManyNumberField;
+                                if (!hasManyNumberField || subHasManyNumberField === 'index') {
+                                    hasManyNumberField = subHasManyNumberField;
+                                }
                             }
                             adapter.relations[`relations_${blockTableName}`] = relations(adapter.tables[blockTableName], ({ many, one })=>{
                                 const result = {
@@ -442,23 +489,37 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                             fields: field.fields,
                             forceLocalized,
                             indexes,
+                            joins,
                             localesColumns,
                             localesIndexes,
                             newTableName,
                             parentTableName,
-                            relationsToBuild,
                             relationships,
+                            relationsToBuild,
                             rootRelationsToBuild,
                             rootTableIDColType,
                             rootTableName,
-                            versions
+                            versions,
+                            withinLocalizedArrayOrBlock
                         });
-                        if (groupHasLocalizedField) hasLocalizedField = true;
-                        if (groupHasLocalizedRelationshipField) hasLocalizedRelationshipField = true;
-                        if (groupHasManyTextField) hasManyTextField = true;
-                        if (groupHasLocalizedManyTextField) hasLocalizedManyTextField = true;
-                        if (groupHasManyNumberField) hasManyNumberField = true;
-                        if (groupHasLocalizedManyNumberField) hasLocalizedManyNumberField = true;
+                        if (groupHasLocalizedField) {
+                            hasLocalizedField = true;
+                        }
+                        if (groupHasLocalizedRelationshipField) {
+                            hasLocalizedRelationshipField = true;
+                        }
+                        if (groupHasManyTextField) {
+                            hasManyTextField = true;
+                        }
+                        if (groupHasLocalizedManyTextField) {
+                            hasLocalizedManyTextField = true;
+                        }
+                        if (groupHasManyNumberField) {
+                            hasManyNumberField = true;
+                        }
+                        if (groupHasLocalizedManyNumberField) {
+                            hasLocalizedManyNumberField = true;
+                        }
                         break;
                     }
                     const disableNotNullFromHere = Boolean(field.admin?.condition) || disableNotNull;
@@ -472,23 +533,37 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                         fields: field.fields,
                         forceLocalized: field.localized,
                         indexes,
+                        joins,
                         localesColumns,
                         localesIndexes,
                         newTableName: `${parentTableName}_${columnName}`,
                         parentTableName,
-                        relationsToBuild,
                         relationships,
+                        relationsToBuild,
                         rootRelationsToBuild,
                         rootTableIDColType,
                         rootTableName,
-                        versions
+                        versions,
+                        withinLocalizedArrayOrBlock: withinLocalizedArrayOrBlock || field.localized
                     });
-                    if (groupHasLocalizedField) hasLocalizedField = true;
-                    if (groupHasLocalizedRelationshipField) hasLocalizedRelationshipField = true;
-                    if (groupHasManyTextField) hasManyTextField = true;
-                    if (groupHasLocalizedManyTextField) hasLocalizedManyTextField = true;
-                    if (groupHasManyNumberField) hasManyNumberField = true;
-                    if (groupHasLocalizedManyNumberField) hasLocalizedManyNumberField = true;
+                    if (groupHasLocalizedField) {
+                        hasLocalizedField = true;
+                    }
+                    if (groupHasLocalizedRelationshipField) {
+                        hasLocalizedRelationshipField = true;
+                    }
+                    if (groupHasManyTextField) {
+                        hasManyTextField = true;
+                    }
+                    if (groupHasLocalizedManyTextField) {
+                        hasLocalizedManyTextField = true;
+                    }
+                    if (groupHasManyNumberField) {
+                        hasManyNumberField = true;
+                    }
+                    if (groupHasLocalizedManyNumberField) {
+                        hasLocalizedManyNumberField = true;
+                    }
                     break;
                 }
             case 'tabs':
@@ -507,23 +582,37 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                             })),
                         forceLocalized,
                         indexes,
+                        joins,
                         localesColumns,
                         localesIndexes,
                         newTableName,
                         parentTableName,
-                        relationsToBuild,
                         relationships,
+                        relationsToBuild,
                         rootRelationsToBuild,
                         rootTableIDColType,
                         rootTableName,
-                        versions
+                        versions,
+                        withinLocalizedArrayOrBlock
                     });
-                    if (tabHasLocalizedField) hasLocalizedField = true;
-                    if (tabHasLocalizedRelationshipField) hasLocalizedRelationshipField = true;
-                    if (tabHasManyTextField) hasManyTextField = true;
-                    if (tabHasLocalizedManyTextField) hasLocalizedManyTextField = true;
-                    if (tabHasManyNumberField) hasManyNumberField = true;
-                    if (tabHasLocalizedManyNumberField) hasLocalizedManyNumberField = true;
+                    if (tabHasLocalizedField) {
+                        hasLocalizedField = true;
+                    }
+                    if (tabHasLocalizedRelationshipField) {
+                        hasLocalizedRelationshipField = true;
+                    }
+                    if (tabHasManyTextField) {
+                        hasManyTextField = true;
+                    }
+                    if (tabHasLocalizedManyTextField) {
+                        hasLocalizedManyTextField = true;
+                    }
+                    if (tabHasManyNumberField) {
+                        hasManyNumberField = true;
+                    }
+                    if (tabHasLocalizedManyNumberField) {
+                        hasLocalizedManyNumberField = true;
+                    }
                     break;
                 }
             case 'row':
@@ -540,30 +629,44 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                         fields: field.fields,
                         forceLocalized,
                         indexes,
+                        joins,
                         localesColumns,
                         localesIndexes,
                         newTableName,
                         parentTableName,
-                        relationsToBuild,
                         relationships,
+                        relationsToBuild,
                         rootRelationsToBuild,
                         rootTableIDColType,
                         rootTableName,
-                        versions
+                        versions,
+                        withinLocalizedArrayOrBlock
                     });
-                    if (rowHasLocalizedField) hasLocalizedField = true;
-                    if (rowHasLocalizedRelationshipField) hasLocalizedRelationshipField = true;
-                    if (rowHasManyTextField) hasManyTextField = true;
-                    if (rowHasLocalizedManyTextField) hasLocalizedManyTextField = true;
-                    if (rowHasManyNumberField) hasManyNumberField = true;
-                    if (rowHasLocalizedManyNumberField) hasLocalizedManyNumberField = true;
+                    if (rowHasLocalizedField) {
+                        hasLocalizedField = true;
+                    }
+                    if (rowHasLocalizedRelationshipField) {
+                        hasLocalizedRelationshipField = true;
+                    }
+                    if (rowHasManyTextField) {
+                        hasManyTextField = true;
+                    }
+                    if (rowHasLocalizedManyTextField) {
+                        hasLocalizedManyTextField = true;
+                    }
+                    if (rowHasManyNumberField) {
+                        hasManyNumberField = true;
+                    }
+                    if (rowHasLocalizedManyNumberField) {
+                        hasLocalizedManyNumberField = true;
+                    }
                     break;
                 }
             case 'relationship':
             case 'upload':
                 if (Array.isArray(field.relationTo)) {
                     field.relationTo.forEach((relation)=>relationships.add(relation));
-                } else if (field.type === 'relationship' && field.hasMany) {
+                } else if (field.hasMany) {
                     relationships.add(field.relationTo);
                 } else {
                     // simple relationships get a column on the targetTable with a foreign key to the relationTo table
@@ -572,8 +675,12 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                     // get the id type of the related collection
                     let colType = adapter.idType === 'uuid' ? 'uuid' : 'integer';
                     const relatedCollectionCustomID = relationshipConfig.fields.find((field)=>fieldAffectsData(field) && field.name === 'id');
-                    if (relatedCollectionCustomID?.type === 'number') colType = 'numeric';
-                    if (relatedCollectionCustomID?.type === 'text') colType = 'varchar';
+                    if (relatedCollectionCustomID?.type === 'number') {
+                        colType = 'numeric';
+                    }
+                    if (relatedCollectionCustomID?.type === 'text') {
+                        colType = 'varchar';
+                    }
                     // make the foreign key column for relationship using the correct id column type
                     targetTable[fieldName] = parentIDColumnMap[colType](`${columnName}_id`).references(()=>adapter.tables[tableName].id, {
                         onDelete: 'set null'
@@ -581,7 +688,7 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                     // add relationship to table
                     relationsToBuild.set(fieldName, {
                         type: 'one',
-                        localized: adapter.payload.config.localization && field.localized,
+                        localized: adapter.payload.config.localization && (field.localized || forceLocalized),
                         target: tableName
                     });
                     // add notNull when not required
@@ -590,10 +697,32 @@ export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull,
                     }
                     break;
                 }
-                if (adapter.payload.config.localization && field.localized) {
+                if (Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock) {
                     hasLocalizedRelationshipField = true;
                 }
                 break;
+            case 'join':
+                {
+                    // fieldName could be 'posts' or 'group_posts'
+                    // using `on` as the key for the relation
+                    const localized = adapter.payload.config.localization && field.localized;
+                    const fieldSchemaPath = `${fieldPrefix || ''}${field.name}`;
+                    let target;
+                    const joinConfig = joins[field.collection].find(({ schemaPath })=>fieldSchemaPath === schemaPath);
+                    if (joinConfig.targetField.hasMany) {
+                        target = `${adapter.tableNameMap.get(toSnakeCase(field.collection))}${adapter.relationshipsSuffix}`;
+                    } else {
+                        target = `${adapter.tableNameMap.get(toSnakeCase(field.collection))}${localized ? adapter.localesSuffix : ''}`;
+                    }
+                    relationsToBuild.set(fieldName, {
+                        type: 'many',
+                        // joins are not localized on the parent table
+                        localized: false,
+                        relationName: field.on.replaceAll('.', '_'),
+                        target
+                    });
+                    break;
+                }
             default:
                 break;
         }