Skip to content

EspoCRM – Open Source CRM Application

foreign-field params helper

Yuri Kuznetsoveae84b9d8f98
diff --git a/client/src/helpers/misc/foreign-field-params.js b/client/src/helpers/misc/foreign-field-params.js
new file mode 100644
index 0000000000..68e4c98f3b
--- /dev/null
+++ b/client/src/helpers/misc/foreign-field-params.js
@@ -0,0 +1,71 @@
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+import {inject} from 'di';
+import Metadata from 'metadata';
+
+/**
+ * @since 9.1.1
+ * @internal For future use.
+ */
+export default class {
+
+ /**
+ * @type {Metadata}
+ * @private
+ */
+ @inject(Metadata)
+ metadata
+
+ /**
+ * Get foreign field params.
+ *
+ * @param {string} entityType
+ * @param {string} field
+ * @return {Record|null}
+ */
+ get(entityType, field) {
+ /** @type {Record|null} */
+ const params = this.metadata.get(`entityDefs.${entityType}.fields.${field}`);
+
+ if (!params) {
+ return null;
+ }
+
+ const foreignField = params.field;
+ const link = params.link;
+
+ const foreignEntityType = this.metadata.get(`entityDefs.${entityType}.links.${link}.entity`);
+
+ if (!foreignEntityType) {
+ return null;
+ }
+
+ return this.metadata.get(`entityDefs.${foreignEntityType}.links.${foreignField}`);
+ }
+}