mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(editor): proper typings for node related translations

Browse source
This commit is contained in:
Csaba Tuncsik 2022-11-02 08:14:58 +01:00
parent abaed572ef
commit ca52ee4d07
1 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
packages/editor-ui/src/plugins/i18n/index.ts
View file

@ -14,7 +14,7 @@ import {
} from 'n8n-design-system'; } from 'n8n-design-system';
import englishBaseText from './locales/en.json'; import englishBaseText from './locales/en.json';
import { INodeProperties } from "n8n-workflow"; import {INodeProperties, INodePropertyCollection, INodePropertyOptions} from "n8n-workflow";
Vue.use(VueI18n); Vue.use(VueI18n);
locale.use('en'); locale.use('en');
@ -105,7 +105,7 @@ export class I18nClass {
* Display name for a top-level param. * Display name for a top-level param.
*/ */
inputLabelDisplayName( inputLabelDisplayName(
{ name: parameterName, displayName }: { name: string; displayName: string; }, { name: parameterName, displayName }: Pick<INodeProperties, 'name' | 'displayName'>,
) { ) {
if (['clientId', 'clientSecret'].includes(parameterName)) { if (['clientId', 'clientSecret'].includes(parameterName)) {
return context.dynamicRender({ return context.dynamicRender({
@ -124,11 +124,11 @@ export class I18nClass {
* Hint for a top-level param. * Hint for a top-level param.
*/ */
hint( hint(
{ name: parameterName, hint }: { name: string; hint?: string; }, { name: parameterName, hint }: Pick<INodeProperties, 'name' | 'hint'>,
) { ) {
return context.dynamicRender({ return context.dynamicRender({
key: `${credentialPrefix}.${parameterName}.hint`, key: `${credentialPrefix}.${parameterName}.hint`,
fallback: hint || '', fallback: hint ?? '',
}); });
}, },
@ -136,11 +136,11 @@ export class I18nClass {
* Description (tooltip text) for an input label param. * Description (tooltip text) for an input label param.
*/ */
inputLabelDescription( inputLabelDescription(
{ name: parameterName, description }: { name: string; description: string; }, { name: parameterName, description }: Pick<INodeProperties, 'name' | 'description'>,
) { ) {
return context.dynamicRender({ return context.dynamicRender({
key: `${credentialPrefix}.${parameterName}.description`, key: `${credentialPrefix}.${parameterName}.description`,
fallback: description, fallback: description ?? '',
}); });
}, },
@ -148,8 +148,8 @@ export class I18nClass {
* Display name for an option inside an `options` or `multiOptions` param. * Display name for an option inside an `options` or `multiOptions` param.
*/ */
optionsOptionDisplayName( optionsOptionDisplayName(
{ name: parameterName }: { name: string; }, { name: parameterName }: Pick<INodeProperties, 'name'>,
{ value: optionName, name: displayName }: { value: string; name: string; }, { value: optionName, name: displayName }: Pick<INodePropertyOptions, 'value' | 'name'>,
) { ) {
return context.dynamicRender({ return context.dynamicRender({
key: `${credentialPrefix}.${parameterName}.options.${optionName}.displayName`, key: `${credentialPrefix}.${parameterName}.options.${optionName}.displayName`,
@ -161,12 +161,12 @@ export class I18nClass {
* Description for an option inside an `options` or `multiOptions` param. * Description for an option inside an `options` or `multiOptions` param.
*/ */
optionsOptionDescription( optionsOptionDescription(
{ name: parameterName }: { name: string; }, { name: parameterName }: Pick<INodeProperties, 'name'>,
{ value: optionName, description }: { value: string; description: string; }, { value: optionName, description }: Pick<INodePropertyOptions, 'value' | 'description'>,
) { ) {
return context.dynamicRender({ return context.dynamicRender({
key: `${credentialPrefix}.${parameterName}.options.${optionName}.description`, key: `${credentialPrefix}.${parameterName}.options.${optionName}.description`,
fallback: description, fallback: description ?? '',
}); });
}, },
@ -174,11 +174,11 @@ export class I18nClass {
* Placeholder for a `string` param. * Placeholder for a `string` param.
*/ */
placeholder( placeholder(
{ name: parameterName, placeholder }: { name: string; placeholder?: string; }, { name: parameterName, placeholder }: Pick<INodeProperties, 'name' | 'placeholder'>,
) { ) {
return context.dynamicRender({ return context.dynamicRender({
key: `${credentialPrefix}.${parameterName}.placeholder`, key: `${credentialPrefix}.${parameterName}.placeholder`,
fallback: placeholder || '', fallback: placeholder ?? '',
}); });
}, },
}; };
@ -199,7 +199,7 @@ export class I18nClass {
* Display name for an input label, whether top-level or nested. * Display name for an input label, whether top-level or nested.
*/ */
inputLabelDisplayName( inputLabelDisplayName(
parameter: { name: string; displayName: string; type: string }, parameter: INodeProperties,
path: string, path: string,
) { ) {
const middleKey = deriveMiddleKey(path, parameter); const middleKey = deriveMiddleKey(path, parameter);
@ -214,14 +214,14 @@ export class I18nClass {
* Description (tooltip text) for an input label, whether top-level or nested. * Description (tooltip text) for an input label, whether top-level or nested.
*/ */
inputLabelDescription( inputLabelDescription(
parameter: { name: string; description: string; type: string }, parameter: INodeProperties,
path: string, path: string,
) { ) {
const middleKey = deriveMiddleKey(path, parameter); const middleKey = deriveMiddleKey(path, parameter);
return context.dynamicRender({ return context.dynamicRender({
key: `${initialKey}.${middleKey}.description`, key: `${initialKey}.${middleKey}.description`,
fallback: parameter.description, fallback: parameter.description ?? '',
}); });
}, },
@ -236,7 +236,7 @@ export class I18nClass {
return context.dynamicRender({ return context.dynamicRender({
key: `${initialKey}.${middleKey}.hint`, key: `${initialKey}.${middleKey}.hint`,
fallback: parameter.hint || '', fallback: parameter.hint ?? '',
}); });
}, },
@ -247,7 +247,7 @@ export class I18nClass {
* - For a `collection` or `fixedCollection`, the placeholder is the button text. * - For a `collection` or `fixedCollection`, the placeholder is the button text.
*/ */
placeholder( placeholder(
parameter: { name: string; placeholder?: string; type: string }, parameter: Pick<INodeProperties, 'name' | 'type' | 'placeholder'>,
path: string, path: string,
) { ) {
let middleKey = parameter.name; let middleKey = parameter.name;
@ -259,7 +259,7 @@ export class I18nClass {
return context.dynamicRender({ return context.dynamicRender({
key: `${initialKey}.${middleKey}.placeholder`, key: `${initialKey}.${middleKey}.placeholder`,
fallback: parameter.placeholder || '', fallback: parameter.placeholder ?? '',
}); });
}, },
@ -268,8 +268,8 @@ export class I18nClass {
* whether top-level or nested. * whether top-level or nested.
*/ */
optionsOptionDisplayName( optionsOptionDisplayName(
parameter: { name: string; }, parameter: Pick<INodeProperties, 'name'>,
{ value: optionName, name: displayName }: { value: string; name: string; }, { value: optionName, name: displayName }: Pick<INodePropertyOptions, 'value' | 'name'>,
path: string, path: string,
) { ) {
let middleKey = parameter.name; let middleKey = parameter.name;
@ -290,8 +290,8 @@ export class I18nClass {
* whether top-level or nested. * whether top-level or nested.
*/ */
optionsOptionDescription( optionsOptionDescription(
parameter: { name: string; }, parameter: Pick<INodeProperties, 'name'>,
{ value: optionName, description }: { value: string; description: string; }, { value: optionName, description }: Pick<INodePropertyOptions, 'value' | 'description'>,
path: string, path: string,
) { ) {
let middleKey = parameter.name; let middleKey = parameter.name;
@ -303,7 +303,7 @@ export class I18nClass {
return context.dynamicRender({ return context.dynamicRender({
key: `${initialKey}.${middleKey}.options.${optionName}.description`, key: `${initialKey}.${middleKey}.options.${optionName}.description`,
fallback: description, fallback: description ?? '',
}); });
}, },
@ -313,8 +313,8 @@ export class I18nClass {
* be nested in a `collection` or in a `fixedCollection`. * be nested in a `collection` or in a `fixedCollection`.
*/ */
collectionOptionDisplayName( collectionOptionDisplayName(
parameter: { name: string; }, parameter: Pick<INodeProperties, 'name'>,
{ name: optionName, displayName }: { name: string; displayName: string; }, { name: optionName, displayName }: Pick<INodePropertyCollection, 'name' | 'displayName'>,
path: string, path: string,
) { ) {
let middleKey = parameter.name; let middleKey = parameter.name;
@ -335,7 +335,7 @@ export class I18nClass {
* `fixedCollection` param having `multipleValues: true`. * `fixedCollection` param having `multipleValues: true`.
*/ */
multipleValueButtonText( multipleValueButtonText(
{ name: parameterName, typeOptions}: INodeProperties, { name: parameterName, typeOptions}: Pick<INodeProperties, 'name' | 'typeOptions'>,
) { ) {
return context.dynamicRender({ return context.dynamicRender({
key: `${initialKey}.${parameterName}.multipleValueButtonText`, key: `${initialKey}.${parameterName}.multipleValueButtonText`,