@directus/api/dist/utils/get-column-path.js

Directus is a real-time API and App dashboard for managing SQL database content

import { InvalidQueryError } from "@directus/errors";
import { getRelationInfo } from "@directus/utils";

//#region src/utils/get-column-path.ts
/**
* Converts a Directus field list path to the correct SQL names based on the constructed alias map.
* For example: ['author', 'role', 'name'] -> 'ljnsv.name'
* Also returns the target collection of the column: 'directus_roles'
* If the last filter path is an alias field, a nested PK is appended to the path
*/
function getColumnPath({ path, collection, aliasMap, relations, schema }) {
	return followRelation(path);
	function followRelation(pathParts, parentCollection = collection, parentFields, addNestedPkField) {
		/**
		* For A2M fields, the path can contain an optional collection scope <field>:<scope>
		*/
		const pathRoot = pathParts[0].split(":")[0];
		const { relation, relationType } = getRelationInfo(relations, parentCollection, pathRoot);
		if (!relation) throw new InvalidQueryError({ reason: `"${parentCollection}.${pathRoot}" is not a relational field` });
		const alias = parentFields ? aliasMap[`${parentFields}.${pathParts[0]}`]?.alias : aliasMap[pathParts[0]]?.alias;
		const remainingParts = pathParts.slice(1);
		let parent;
		if (relationType === "a2o") {
			const pathScope = pathParts[0].split(":")[1];
			if (!pathScope) throw new InvalidQueryError({ reason: `You have to provide a collection scope when sorting on a many-to-any item` });
			parent = pathScope;
		} else if (relationType === "m2o") parent = relation.related_collection;
		else parent = relation.collection;
		if (schema && !((remainingParts[0] ?? parent).includes("(") && (remainingParts[0] ?? parent).includes(")"))) {
			if (remainingParts.length === 0) {
				remainingParts.push(schema.collections[parent].primary);
				addNestedPkField = schema.collections[parent].primary;
			} else if (remainingParts.length === 1 && schema.collections[parent].fields[remainingParts[0]].type === "alias") {
				remainingParts.push(schema.collections[relation.related_collection].primary);
				addNestedPkField = schema.collections[relation.related_collection].primary;
			}
		}
		if (remainingParts.length === 1) return {
			columnPath: `${alias || parent}.${remainingParts[0]}`,
			targetCollection: parent,
			addNestedPkField
		};
		if (remainingParts.length) return followRelation(remainingParts, parent, `${parentFields ? parentFields + "." : ""}${pathParts[0]}`, addNestedPkField);
		return {
			columnPath: "",
			targetCollection: "",
			addNestedPkField
		};
	}
}

//#endregion
export { getColumnPath };