@payloadcms/drizzle 3.15.2-canary.ee31a64 → 3.16.0

package/dist/postgres/schema/traverseFields.js

@@ -0,0 +1,599 @@
+import { relations } from 'drizzle-orm';
+import { boolean, foreignKey, index, integer, jsonb, numeric, PgNumericBuilder, PgUUIDBuilder, PgVarcharBuilder, text, timestamp, varchar } from 'drizzle-orm/pg-core';
+import { InvalidConfiguration } from 'payload';
+import { fieldAffectsData, fieldIsVirtual, optionIsObject } from 'payload/shared';
+import toSnakeCase from 'to-snake-case';
+import { createTableName } from '../../createTableName.js';
+import { buildIndexName } from '../../utilities/buildIndexName.js';
+import { hasLocalesTable } from '../../utilities/hasLocalesTable.js';
+import { validateExistingBlockIsIdentical } from '../../utilities/validateExistingBlockIsIdentical.js';
+import { buildTable } from './build.js';
+import { createIndex } from './createIndex.js';
+import { geometryColumn } from './geometryColumn.js';
+import { idToUUID } from './idToUUID.js';
+import { parentIDColumnMap } from './parentIDColumnMap.js';
+import { withDefault } from './withDefault.js';
+export const traverseFields = ({ adapter, columnPrefix, columns, disableNotNull, disableRelsTableUnique, disableUnique = false, fieldPrefix, fields, forceLocalized, indexes, localesColumns, localesIndexes, newTableName, parentTableName, relationships, relationsToBuild, rootRelationsToBuild, rootTableIDColType, rootTableName, uniqueRelationships, versions, withinLocalizedArrayOrBlock })=>{
+    const throwValidationError = true;
+    let hasLocalizedField = false;
+    let hasLocalizedRelationshipField = false;
+    let hasManyTextField = false;
+    let hasLocalizedManyTextField = false;
+    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';
+    }
+    fields.forEach((field)=>{
+        if ('name' in field && field.name === 'id') {
+            return;
+        }
+        if (fieldIsVirtual(field)) {
+            return;
+        }
+        let targetTable = columns;
+        let targetIndexes = indexes;
+        const columnName = `${columnPrefix || ''}${field.name[0] === '_' ? '_' : ''}${toSnakeCase(field.name)}`;
+        const fieldName = `${fieldPrefix?.replace('.', '_') || ''}${field.name}`;
+        // If field is localized,
+        // add the column to the locale table instead of main table
+        if (adapter.payload.config.localization && (field.localized || forceLocalized) && field.type !== 'array' && field.type !== 'blocks' && ('hasMany' in field && field.hasMany !== true || !('hasMany' in field))) {
+            hasLocalizedField = true;
+            targetTable = localesColumns;
+            targetIndexes = localesIndexes;
+        }
+        if ((field.unique || field.index || [
+            'relationship',
+            'upload'
+        ].includes(field.type)) && ![
+            'array',
+            'blocks',
+            'group'
+        ].includes(field.type) && !('hasMany' in field && field.hasMany === true) && !('relationTo' in field && Array.isArray(field.relationTo))) {
+            const unique = disableUnique !== true && field.unique;
+            if (unique) {
+                const constraintValue = `${fieldPrefix || ''}${field.name}`;
+                if (!adapter.fieldConstraints?.[rootTableName]) {
+                    adapter.fieldConstraints[rootTableName] = {};
+                }
+                adapter.fieldConstraints[rootTableName][`${columnName}_idx`] = constraintValue;
+            }
+            const indexName = buildIndexName({
+                name: `${newTableName}_${columnName}`,
+                adapter
+            });
+            targetIndexes[indexName] = createIndex({
+                name: field.localized ? [
+                    fieldName,
+                    '_locale'
+                ] : fieldName,
+                indexName,
+                unique
+            });
+        }
+        switch(field.type){
+            case 'array':
+                {
+                    const disableNotNullFromHere = Boolean(field.admin?.condition) || disableNotNull;
+                    const arrayTableName = createTableName({
+                        adapter,
+                        config: field,
+                        parentTableName: newTableName,
+                        prefix: `${newTableName}_`,
+                        throwValidationError,
+                        versionsCustomName: versions
+                    });
+                    const baseColumns = {
+                        _order: integer('_order').notNull(),
+                        _parentID: parentIDColumnMap[parentIDColType]('_parent_id').notNull()
+                    };
+                    const baseExtraConfig = {
+                        _orderIdx: (cols)=>index(`${arrayTableName}_order_idx`).on(cols._order),
+                        _parentIDFk: (cols)=>foreignKey({
+                                name: `${arrayTableName}_parent_id_fk`,
+                                columns: [
+                                    cols['_parentID']
+                                ],
+                                foreignColumns: [
+                                    adapter.tables[parentTableName].id
+                                ]
+                            }).onDelete('cascade'),
+                        _parentIDIdx: (cols)=>index(`${arrayTableName}_parent_id_idx`).on(cols._parentID)
+                    };
+                    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 { hasLocalizedManyNumberField: subHasLocalizedManyNumberField, hasLocalizedManyTextField: subHasLocalizedManyTextField, hasLocalizedRelationshipField: subHasLocalizedRelationshipField, hasManyNumberField: subHasManyNumberField, hasManyTextField: subHasManyTextField, relationsToBuild: subRelationsToBuild } = buildTable({
+                        adapter,
+                        baseColumns,
+                        baseExtraConfig,
+                        disableNotNull: disableNotNullFromHere,
+                        disableRelsTableUnique: true,
+                        disableUnique,
+                        fields: disableUnique ? idToUUID(field.flattenedFields) : field.flattenedFields,
+                        rootRelationships: relationships,
+                        rootRelationsToBuild,
+                        rootTableIDColType,
+                        rootTableName,
+                        rootUniqueRelationships: uniqueRelationships,
+                        tableName: arrayTableName,
+                        versions,
+                        withinLocalizedArrayOrBlock: isLocalized
+                    });
+                    if (subHasLocalizedManyNumberField) {
+                        hasLocalizedManyNumberField = subHasLocalizedManyNumberField;
+                    }
+                    if (subHasLocalizedRelationshipField) {
+                        hasLocalizedRelationshipField = subHasLocalizedRelationshipField;
+                    }
+                    if (subHasLocalizedManyTextField) {
+                        hasLocalizedManyTextField = subHasLocalizedManyTextField;
+                    }
+                    if (subHasManyTextField) {
+                        if (!hasManyTextField || subHasManyTextField === 'index') {
+                            hasManyTextField = subHasManyTextField;
+                        }
+                    }
+                    if (subHasManyNumberField) {
+                        if (!hasManyNumberField || subHasManyNumberField === 'index') {
+                            hasManyNumberField = subHasManyNumberField;
+                        }
+                    }
+                    relationsToBuild.set(fieldName, {
+                        type: 'many',
+                        // arrays have their own localized table, independent of the base table.
+                        localized: false,
+                        target: arrayTableName
+                    });
+                    adapter.relations[`relations_${arrayTableName}`] = relations(adapter.tables[arrayTableName], ({ many, one })=>{
+                        const result = {
+                            _parentID: one(adapter.tables[parentTableName], {
+                                fields: [
+                                    adapter.tables[arrayTableName]._parentID
+                                ],
+                                references: [
+                                    adapter.tables[parentTableName].id
+                                ],
+                                relationName: fieldName
+                            })
+                        };
+                        if (hasLocalesTable(field.fields)) {
+                            result._locales = many(adapter.tables[`${arrayTableName}${adapter.localesSuffix}`], {
+                                relationName: '_locales'
+                            });
+                        }
+                        subRelationsToBuild.forEach(({ type, localized, target }, key)=>{
+                            if (type === 'one') {
+                                const arrayWithLocalized = localized ? `${arrayTableName}${adapter.localesSuffix}` : arrayTableName;
+                                result[key] = one(adapter.tables[target], {
+                                    fields: [
+                                        adapter.tables[arrayWithLocalized][key]
+                                    ],
+                                    references: [
+                                        adapter.tables[target].id
+                                    ],
+                                    relationName: key
+                                });
+                            }
+                            if (type === 'many') {
+                                result[key] = many(adapter.tables[target], {
+                                    relationName: key
+                                });
+                            }
+                        });
+                        return result;
+                    });
+                    break;
+                }
+            case 'blocks':
+                {
+                    const disableNotNullFromHere = Boolean(field.admin?.condition) || disableNotNull;
+                    field.blocks.forEach((block)=>{
+                        const blockTableName = createTableName({
+                            adapter,
+                            config: block,
+                            parentTableName: rootTableName,
+                            prefix: `${rootTableName}_blocks_`,
+                            throwValidationError,
+                            versionsCustomName: versions
+                        });
+                        if (!adapter.tables[blockTableName]) {
+                            const baseColumns = {
+                                _order: integer('_order').notNull(),
+                                _parentID: parentIDColumnMap[rootTableIDColType]('_parent_id').notNull(),
+                                _path: text('_path').notNull()
+                            };
+                            const baseExtraConfig = {
+                                _orderIdx: (cols)=>index(`${blockTableName}_order_idx`).on(cols._order),
+                                _parentIdFk: (cols)=>foreignKey({
+                                        name: `${blockTableName}_parent_id_fk`,
+                                        columns: [
+                                            cols._parentID
+                                        ],
+                                        foreignColumns: [
+                                            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)
+                            };
+                            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 { hasLocalizedManyNumberField: subHasLocalizedManyNumberField, hasLocalizedManyTextField: subHasLocalizedManyTextField, hasLocalizedRelationshipField: subHasLocalizedRelationshipField, hasManyNumberField: subHasManyNumberField, hasManyTextField: subHasManyTextField, relationsToBuild: subRelationsToBuild } = buildTable({
+                                adapter,
+                                baseColumns,
+                                baseExtraConfig,
+                                disableNotNull: disableNotNullFromHere,
+                                disableRelsTableUnique: true,
+                                disableUnique,
+                                fields: disableUnique ? idToUUID(block.flattenedFields) : block.flattenedFields,
+                                rootRelationships: relationships,
+                                rootRelationsToBuild,
+                                rootTableIDColType,
+                                rootTableName,
+                                rootUniqueRelationships: uniqueRelationships,
+                                tableName: blockTableName,
+                                versions,
+                                withinLocalizedArrayOrBlock: isLocalized
+                            });
+                            if (subHasLocalizedManyNumberField) {
+                                hasLocalizedManyNumberField = subHasLocalizedManyNumberField;
+                            }
+                            if (subHasLocalizedRelationshipField) {
+                                hasLocalizedRelationshipField = subHasLocalizedRelationshipField;
+                            }
+                            if (subHasLocalizedManyTextField) {
+                                hasLocalizedManyTextField = subHasLocalizedManyTextField;
+                            }
+                            if (subHasManyTextField) {
+                                if (!hasManyTextField || subHasManyTextField === 'index') {
+                                    hasManyTextField = subHasManyTextField;
+                                }
+                            }
+                            if (subHasManyNumberField) {
+                                if (!hasManyNumberField || subHasManyNumberField === 'index') {
+                                    hasManyNumberField = subHasManyNumberField;
+                                }
+                            }
+                            adapter.relations[`relations_${blockTableName}`] = relations(adapter.tables[blockTableName], ({ many, one })=>{
+                                const result = {
+                                    _parentID: one(adapter.tables[rootTableName], {
+                                        fields: [
+                                            adapter.tables[blockTableName]._parentID
+                                        ],
+                                        references: [
+                                            adapter.tables[rootTableName].id
+                                        ],
+                                        relationName: `_blocks_${block.slug}`
+                                    })
+                                };
+                                if (hasLocalesTable(block.fields)) {
+                                    result._locales = many(adapter.tables[`${blockTableName}${adapter.localesSuffix}`], {
+                                        relationName: '_locales'
+                                    });
+                                }
+                                subRelationsToBuild.forEach(({ type, localized, target }, key)=>{
+                                    if (type === 'one') {
+                                        const blockWithLocalized = localized ? `${blockTableName}${adapter.localesSuffix}` : blockTableName;
+                                        result[key] = one(adapter.tables[target], {
+                                            fields: [
+                                                adapter.tables[blockWithLocalized][key]
+                                            ],
+                                            references: [
+                                                adapter.tables[target].id
+                                            ],
+                                            relationName: key
+                                        });
+                                    }
+                                    if (type === 'many') {
+                                        result[key] = many(adapter.tables[target], {
+                                            relationName: key
+                                        });
+                                    }
+                                });
+                                return result;
+                            });
+                        } else if (process.env.NODE_ENV !== 'production' && !versions) {
+                            validateExistingBlockIsIdentical({
+                                block,
+                                localized: field.localized,
+                                rootTableName,
+                                table: adapter.tables[blockTableName],
+                                tableLocales: adapter.tables[`${blockTableName}${adapter.localesSuffix}`]
+                            });
+                        }
+                        // blocks relationships are defined from the collection or globals table down to the block, bypassing any subBlocks
+                        rootRelationsToBuild.set(`_blocks_${block.slug}`, {
+                            type: 'many',
+                            // blocks are not localized on the parent table
+                            localized: false,
+                            target: blockTableName
+                        });
+                    });
+                    break;
+                }
+            case 'checkbox':
+                {
+                    targetTable[fieldName] = withDefault(boolean(columnName), field);
+                    break;
+                }
+            case 'code':
+            case 'email':
+            case 'textarea':
+                {
+                    targetTable[fieldName] = withDefault(varchar(columnName), field);
+                    break;
+                }
+            case 'date':
+                {
+                    targetTable[fieldName] = withDefault(timestamp(columnName, {
+                        mode: 'string',
+                        precision: 3,
+                        withTimezone: true
+                    }), field);
+                    break;
+                }
+            case 'group':
+            case 'tab':
+                {
+                    const disableNotNullFromHere = Boolean(field.admin?.condition) || disableNotNull;
+                    const { hasLocalizedField: groupHasLocalizedField, hasLocalizedManyNumberField: groupHasLocalizedManyNumberField, hasLocalizedManyTextField: groupHasLocalizedManyTextField, hasLocalizedRelationshipField: groupHasLocalizedRelationshipField, hasManyNumberField: groupHasManyNumberField, hasManyTextField: groupHasManyTextField } = traverseFields({
+                        adapter,
+                        columnPrefix: `${columnName}_`,
+                        columns,
+                        disableNotNull: disableNotNullFromHere,
+                        disableUnique,
+                        fieldPrefix: `${fieldName}.`,
+                        fields: field.flattenedFields,
+                        forceLocalized: field.localized,
+                        indexes,
+                        localesColumns,
+                        localesIndexes,
+                        newTableName: `${parentTableName}_${columnName}`,
+                        parentTableName,
+                        relationships,
+                        relationsToBuild,
+                        rootRelationsToBuild,
+                        rootTableIDColType,
+                        rootTableName,
+                        uniqueRelationships,
+                        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;
+                    }
+                    break;
+                }
+            case 'json':
+            case 'richText':
+                {
+                    targetTable[fieldName] = withDefault(jsonb(columnName), field);
+                    break;
+                }
+            case 'number':
+                {
+                    if (field.hasMany) {
+                        const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                        if (isLocalized) {
+                            hasLocalizedManyNumberField = true;
+                        }
+                        if (field.index) {
+                            hasManyNumberField = 'index';
+                        } else if (!hasManyNumberField) {
+                            hasManyNumberField = true;
+                        }
+                        if (field.unique) {
+                            throw new InvalidConfiguration('Unique is not supported in Postgres for hasMany number fields.');
+                        }
+                    } else {
+                        targetTable[fieldName] = withDefault(numeric(columnName), field);
+                    }
+                    break;
+                }
+            case 'point':
+                {
+                    targetTable[fieldName] = withDefault(geometryColumn(columnName), field);
+                    if (!adapter.extensions.postgis) {
+                        adapter.extensions.postgis = true;
+                    }
+                    break;
+                }
+            case 'radio':
+            case 'select':
+                {
+                    const enumName = createTableName({
+                        adapter,
+                        config: field,
+                        parentTableName: newTableName,
+                        prefix: `enum_${newTableName}_`,
+                        target: 'enumName',
+                        throwValidationError
+                    });
+                    adapter.enums[enumName] = adapter.pgSchema.enum(enumName, field.options.map((option)=>{
+                        if (optionIsObject(option)) {
+                            return option.value;
+                        }
+                        return option;
+                    }));
+                    if (field.type === 'select' && field.hasMany) {
+                        const selectTableName = createTableName({
+                            adapter,
+                            config: field,
+                            parentTableName: newTableName,
+                            prefix: `${newTableName}_`,
+                            throwValidationError,
+                            versionsCustomName: versions
+                        });
+                        const baseColumns = {
+                            order: integer('order').notNull(),
+                            parent: parentIDColumnMap[parentIDColType]('parent_id').notNull(),
+                            value: adapter.enums[enumName]('value')
+                        };
+                        const baseExtraConfig = {
+                            orderIdx: (cols)=>index(`${selectTableName}_order_idx`).on(cols.order),
+                            parentFk: (cols)=>foreignKey({
+                                    name: `${selectTableName}_parent_fk`,
+                                    columns: [
+                                        cols.parent
+                                    ],
+                                    foreignColumns: [
+                                        adapter.tables[parentTableName].id
+                                    ]
+                                }).onDelete('cascade'),
+                            parentIdx: (cols)=>index(`${selectTableName}_parent_idx`).on(cols.parent)
+                        };
+                        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);
+                        }
+                        if (field.index) {
+                            baseExtraConfig.value = (cols)=>index(`${selectTableName}_value_idx`).on(cols.value);
+                        }
+                        buildTable({
+                            adapter,
+                            baseColumns,
+                            baseExtraConfig,
+                            disableNotNull,
+                            disableUnique,
+                            fields: [],
+                            rootTableName,
+                            tableName: selectTableName,
+                            versions
+                        });
+                        relationsToBuild.set(fieldName, {
+                            type: 'many',
+                            // selects have their own localized table, independent of the base table.
+                            localized: false,
+                            target: selectTableName
+                        });
+                        adapter.relations[`relations_${selectTableName}`] = relations(adapter.tables[selectTableName], ({ one })=>({
+                                parent: one(adapter.tables[parentTableName], {
+                                    fields: [
+                                        adapter.tables[selectTableName].parent
+                                    ],
+                                    references: [
+                                        adapter.tables[parentTableName].id
+                                    ],
+                                    relationName: fieldName
+                                })
+                            }));
+                    } else {
+                        targetTable[fieldName] = withDefault(adapter.enums[enumName](columnName), field);
+                    }
+                    break;
+                }
+            case 'relationship':
+            case 'upload':
+                if (Array.isArray(field.relationTo)) {
+                    field.relationTo.forEach((relation)=>{
+                        relationships.add(relation);
+                        if (field.unique && !disableUnique && !disableRelsTableUnique) {
+                            uniqueRelationships.add(relation);
+                        }
+                    });
+                } else if (field.hasMany) {
+                    relationships.add(field.relationTo);
+                    if (field.unique && !disableUnique && !disableRelsTableUnique) {
+                        uniqueRelationships.add(field.relationTo);
+                    }
+                } else {
+                    // simple relationships get a column on the targetTable with a foreign key to the relationTo table
+                    const relationshipConfig = adapter.payload.collections[field.relationTo].config;
+                    const tableName = adapter.tableNameMap.get(toSnakeCase(field.relationTo));
+                    // 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';
+                    }
+                    // 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'
+                    });
+                    // add relationship to table
+                    relationsToBuild.set(fieldName, {
+                        type: 'one',
+                        localized: adapter.payload.config.localization && (field.localized || forceLocalized),
+                        target: tableName
+                    });
+                    // add notNull when not required
+                    if (!disableNotNull && field.required && !field.admin?.condition) {
+                        targetTable[fieldName].notNull();
+                    }
+                    break;
+                }
+                if (Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock) {
+                    hasLocalizedRelationshipField = true;
+                }
+                break;
+            case 'text':
+                {
+                    if (field.hasMany) {
+                        const isLocalized = Boolean(field.localized && adapter.payload.config.localization) || withinLocalizedArrayOrBlock || forceLocalized;
+                        if (isLocalized) {
+                            hasLocalizedManyTextField = true;
+                        }
+                        if (field.index) {
+                            hasManyTextField = 'index';
+                        } else if (!hasManyTextField) {
+                            hasManyTextField = true;
+                        }
+                        if (field.unique) {
+                            throw new InvalidConfiguration('Unique is not supported in Postgres for hasMany text fields.');
+                        }
+                    } else {
+                        targetTable[fieldName] = withDefault(varchar(columnName), field);
+                    }
+                    break;
+                }
+            default:
+                break;
+        }
+        const condition = field.admin && field.admin.condition;
+        if (!disableNotNull && targetTable[fieldName] && 'required' in field && field.required && !condition) {
+            targetTable[fieldName].notNull();
+        }
+    });
+    return {
+        hasLocalizedField,
+        hasLocalizedManyNumberField,
+        hasLocalizedManyTextField,
+        hasLocalizedRelationshipField,
+        hasManyNumberField,
+        hasManyTextField
+    };
+};
+
+//# sourceMappingURL=traverseFields.js.map