⚡ i18n feedback refactorings (#2597)

* ⚡ Create endpoint for node credential translation

* ⚡ Add API helper method in FE

* 🔨 Add creds JSON files to tsconfig

* ⚡ Refactor credentials loading

* ⚡ Refactor calls in CredentialConfig

* ✏️ Add dummy translations

* ⚡ Split translations per node

* 🔥 Remove deprecated method

* ⚡ Refactor nesting in collections

* 🚚 Rename topParameter methods for accuracy

* ✏️ Fill out GitHub dummy cred

* 🚚 Clarify naming for collection utils

* ✏️ Fill out dummy translation

* 🔥 Remove surplus colons

* 🔥 Remove logging

* ⚡ Restore missing space

* 🔥 Remove lingering colon

* ⚡ Add path to InputLabel calls

* ✏️ Fill out dummy translations

* 🐛 Fix multipleValuesButtonText logic

* ⚡ Add sample properties to be deleted

* ⚡ Render deeply nested params

* 📦 Update package-lock.json

* 🔥 remove logging

* ✏️ Add dummy value to Slack translation

* ✏️ Add placeholder to dummy translation

* ⚡ Fix placeholder rendering for button text

* 👕 Fix lint

* 🔥 Remove outdated comment

* 🐛 Pass in missing arg for placeholder

* ✏️ Fill out Slack translation

* ⚡ Add explanatory comment

* ✏️ Fill out dummy translation

* ✏️ Update documentation

* 🔥 Remove broken link

* ✏️ Add pending functionality

* ✏️ Fix indentation

* 🐛 Fix method call in CredentialEdit

* ⚡ Implement eventTriggerDescription

* 🐛 Fix table-json-binary radio buttons

* ✏️ Clarify usage of eventTriggerDescription

* 🔥 Remove unneeded arg

* 🐛 Fix display in CodeEdit and TextEdit

* 🔥 Remove logging

* ✏️ Add translation for test cred options

* ✏️ Add test for separate file in same dir

* ✏️ Add test for versioned node

* ✏️ Add test for node in grouped dir

* ✏️ Add minor clarifications

* ✏️ Add nested collection test

* ✏️ Add pending functionality

* ⚡ Generalize collections handling

* 🚚 Rename helper to remove redundancy

* 🚚 Improve naming in helpers

* ✏️ Improve helpers documentation

* ✏️ Improve i18n methods documentation

* 🚚 Make endpoint naming consistent

* ✏️ Add final newlines

* ✏️ Clean up JSON examples

* ⚡ Reuse i18n method

* ⚡ Improve utils readability

* ⚡ Return early if cred translation exists

* 🔥 Remove dummy translations

packages/cli/src/Server.ts

@@ -150,7 +150,7 @@ import { InternalHooksManager } from './InternalHooksManager';
 import { TagEntity } from './databases/entities/TagEntity';
 import { WorkflowEntity } from './databases/entities/WorkflowEntity';
 import { NameRequest } from './WorkflowHelpers';
-import { getNodeTranslationPath } from './TranslationHelpers';
+import { getCredentialTranslationPath, getNodeTranslationPath } from './TranslationHelpers';
 
 require('body-parser-xml')(bodyParser);
 
@@ -1178,6 +1178,27 @@ class App {
 			),
 		);
 
+		this.app.get(
+			`/${this.restEndpoint}/credential-translation`,
+			ResponseHelper.send(
+				async (
+					req: express.Request & { query: { credentialType: string } },
+					res: express.Response,
+				): Promise<object | null> => {
+					const translationPath = getCredentialTranslationPath({
+						locale: this.frontendSettings.defaultLocale,
+						credentialType: req.query.credentialType,
+					});
+
+					try {
+						return require(translationPath);
+					} catch (error) {
+						return null;
+					}
+				},
+			),
+		);
+
 		// Returns node information based on node names and versions
 		this.app.post(
 			`/${this.restEndpoint}/node-types`,
@@ -1201,13 +1222,17 @@ class App {
 						nodeTypes: INodeTypeDescription[],
 					) {
 						const { description, sourcePath } = NodeTypes().getWithSourcePath(name, version);
-						const translationPath = await getNodeTranslationPath(sourcePath, defaultLocale);
+						const translationPath = await getNodeTranslationPath({
+							nodeSourcePath: sourcePath,
+							longNodeType: description.name,
+							locale: defaultLocale,
+						});
 
 						try {
 							const translation = await readFile(translationPath, 'utf8');
 							description.translation = JSON.parse(translation);
 						} catch (error) {
-							// ignore - no translation at expected translation path
+							// ignore - no translation exists at path
 						}
 
 						nodeTypes.push(description);

packages/cli/src/TranslationHelpers.ts

@@ -2,7 +2,7 @@ import { join, dirname } from 'path';
 import { readdir } from 'fs/promises';
 import { Dirent } from 'fs';
 
-const ALLOWED_VERSIONED_DIRNAME_LENGTH = [2, 3]; // v1, v10
+const ALLOWED_VERSIONED_DIRNAME_LENGTH = [2, 3]; // e.g. v1, v10
 
 function isVersionedDirname(dirent: Dirent) {
 	if (!dirent.isDirectory()) return false;
@@ -26,14 +26,39 @@ async function getMaxVersion(from: string) {
 	return Math.max(...dirnames.map((d) => parseInt(d.charAt(1), 10)));
 }
 
-export async function getNodeTranslationPath(
-	nodeSourcePath: string,
-	language: string,
-): Promise<string> {
+/**
+ * Get the full path to a node translation file in `/dist`.
+ */
+export async function getNodeTranslationPath({
+	nodeSourcePath,
+	longNodeType,
+	locale,
+}: {
+	nodeSourcePath: string;
+	longNodeType: string;
+	locale: string;
+}): Promise<string> {
 	const nodeDir = dirname(nodeSourcePath);
 	const maxVersion = await getMaxVersion(nodeDir);
+	const nodeType = longNodeType.replace('n8n-nodes-base.', '');
 
 	return maxVersion
-		? join(nodeDir, `v${maxVersion}`, 'translations', `${language}.json`)
-		: join(nodeDir, 'translations', `${language}.json`);
+		? join(nodeDir, `v${maxVersion}`, 'translations', locale, `${nodeType}.json`)
+		: join(nodeDir, 'translations', locale, `${nodeType}.json`);
+}
+
+/**
+ * Get the full path to a credential translation file in `/dist`.
+ */
+export function getCredentialTranslationPath({
+	locale,
+	credentialType,
+}: {
+	locale: string;
+	credentialType: string;
+}): string {
+	const packagesPath = join(__dirname, '..', '..', '..');
+	const credsPath = join(packagesPath, 'nodes-base', 'dist', 'credentials');
+
+	return join(credsPath, 'translations', locale, `${credentialType}.json`);
 }