Bump deepl-node from 1.17.3 to 1.18.0 (#161)

fabasoad · web-flow · commit e989a21f7567 · 2025-05-24T22:23:54.000+09:00
diff --git a/.tool-versions b/.tool-versions
@@ -1 +1 @@
-nodejs 23.10.0
+nodejs 24.1.0
diff --git a/.yarn/releases/yarn-4.7.0.cjs b/.yarn/releases/yarn-4.7.0.cjs
diff --git a/.yarn/releases/yarn-4.9.1.cjs b/.yarn/releases/yarn-4.9.1.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -4,4 +4,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-outdated.cjs
     spec: "https://mskelton.dev/yarn-outdated/v2"
 
-yarnPath: .yarn/releases/yarn-4.7.0.cjs
+yarnPath: .yarn/releases/yarn-4.9.1.cjs
diff --git a/README.md b/README.md
@@ -52,7 +52,8 @@ more details for each provider below.
 ### DeepL
 
 * Identifier is `deepl`.
-* Supported translation directions can be found [here](https://www.deepl.com/docs-api/general/get-languages/).
+* See [supported translation directions](https://www.deepl.com/docs-api/general/get-languages/)
+  for more details.
   * Be aware that source and target languages should be separated by `-` (hyphen)
   character while using them in `lang` input. For example, `en-uk` should be used
   in case you want to translate text from English into Ukrainian. See example
@@ -92,7 +93,8 @@ Translation is 'Любов'
 ### Google
 
 * Identifier is `google`.
-* Supported translation directions can be found [here](https://github.com/AidanWelch/google-translate-api/blob/master/index.d.ts#L67).
+* See [supported translation directions](https://github.com/AidanWelch/google-translate-api/blob/master/index.d.ts#L67)
+  for more details.
   * Be aware that source and target languages should be separated by `-` (hyphen)
   character while using them in `lang` input. For example, `ms-en` should be used
   in case you want to translate text from Malay into English. See example below
@@ -128,7 +130,8 @@ Translation is 'Victory'
 ### LibreTranslate
 
 * Identifier is `libretranslate`.
-* Supported translation directions can be found [here](https://libretranslate.com/languages).
+* See [supported translation directions](https://libretranslate.com/languages)
+  for more details.
   * Be aware that source and target languages should be separated by `-` (hyphen)
     character while using them in `lang` input. For example, `en-es` should be used
     in case you want to translate text from English into Spanish. See example
@@ -199,10 +202,10 @@ with:
 ### MyMemory
 
 * Identifier is `mymemory`.
-* Supported translation directions:
+* [Supported translation directions](https://mymemory.translated.net/doc/spec.php):
 
 Language direction should be separated by `|` character. For example, `en|it`
-(from English to Italian). More details [here](https://mymemory.translated.net/doc/spec.php).
+(from English to Italian).
 
 * How to get API key:
 
@@ -215,10 +218,11 @@ and generate a new key.
 ### FunTranslations
 
 * Identifier is `funtranslations`.
-* Supported translation directions:
+* [Supported translation directions](https://funtranslations.com/api/):
+
+> `from` direction is English only at this moment.
 
-`from` direction is English only at this moment, so `lang` parameter can be
-found [here](https://funtranslations.com/api/). Example:
+Example:
 
 ```yaml
 - uses: fabasoad/translation-action@main
diff --git a/dist/index.js b/dist/index.js
diff --git a/package.json b/package.json
@@ -27,19 +27,19 @@
   "dependencies": {
     "@actions/core": "1.11.1",
     "cross-fetch": "4.1.0",
-    "deepl-node": "1.17.3",
+    "deepl-node": "1.18.0",
     "google-translate-api-x": "10.7.2",
     "typed-rest-client": "2.1.0"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@types/jest": "29.5.14",
     "@vercel/ncc": "0.38.3",
-    "dotenv": "16.4.7",
+    "dotenv": "16.5.0",
     "jest": "29.7.0",
     "jest-circus": "29.7.0",
-    "ts-jest": "29.2.6",
-    "typescript": "5.8.2"
+    "ts-jest": "29.3.4",
+    "typescript": "5.8.3"
   },
-  "packageManager": "yarn@4.7.0"
+  "packageManager": "yarn@4.9.1"
 }
diff --git a/src/index.ts b/src/index.ts
@@ -8,9 +8,9 @@ async function run() {
     const source: string = extract(core.getInput('source'))
     const providerFactory: ProviderFactory = new ProviderFactory()
     const provider: ProviderBase = providerFactory.getProvider(
-      core.getInput('provider') as ProviderType,
-      core.getInput('api_key'),
-      core.getInput('api_additional_parameter')
+      core.getInput('provider', { required: true, trimWhitespace: true }) as ProviderType,
+      core.getInput('api_key', { required: false, trimWhitespace: true }),
+      core.getInput('api_additional_parameter', { required: false, trimWhitespace: true })
     )
     let text: string
     try {
diff --git a/src/providers/DeeplProvider.ts b/src/providers/DeeplProvider.ts
@@ -1,5 +1,10 @@
 import ProviderBase from './ProviderBase'
-import {SourceLanguageCode, TargetLanguageCode, Translator} from 'deepl-node'
+import {
+  SourceLanguageCode,
+  TargetLanguageCode,
+  TextResult,
+  Translator
+} from 'deepl-node'
 
 export default class DeeplProvider extends ProviderBase {
   private translator: Translator
@@ -11,7 +16,7 @@ export default class DeeplProvider extends ProviderBase {
 
   async translate(text: string, lang: string): Promise<string[]> {
     const l: string[] = lang.split('-')
-    const result = await this.translator.translateText<string>(
+    const result: TextResult = await this.translator.translateText<string>(
       text, l[0] as SourceLanguageCode, l[1] as TargetLanguageCode
     )
     return Promise.resolve([result.text])
diff --git a/src/providers/FunTranslationsProvider.ts b/src/providers/FunTranslationsProvider.ts
@@ -10,14 +10,13 @@ export default class FunTranslationsProvider extends ProviderBase {
 
   async translate(text: string, lang: string): Promise<string[]> {
     const url = `/translate/${lang}.json?text=${text}`
-    return this.api<FunTranslationsResponse>({ url, method: 'GET' })
-      .then(({ success, contents }) => {
-        if (success && success.total > 0) {
-          return [contents.translated]
-        }
-        console.warn(
-          'Result is either not success or doesn\'t have any translations')
-        return [text]
-      })
+    const { success, contents }: FunTranslationsResponse =
+      await this.api<FunTranslationsResponse>({ url, method: 'GET' })
+    if (success && success.total > 0) {
+      return [contents.translated]
+    }
+    console.warn(
+      'Result is either not success or doesn\'t have any translations')
+    return [text]
   }
 }
diff --git a/src/providers/GoogleProvider.ts b/src/providers/GoogleProvider.ts
@@ -1,6 +1,7 @@
 import ProviderBase from './ProviderBase'
-import { translate } from 'google-translate-api-x'
+import { googleTranslateApi, translate } from 'google-translate-api-x'
 import fetch from 'cross-fetch'
+import TranslationResponse = googleTranslateApi.TranslationResponse
 
 export default class GoogleProvider extends ProviderBase {
   constructor() {
@@ -9,8 +10,9 @@ export default class GoogleProvider extends ProviderBase {
 
   async translate(text: string, lang: string): Promise<string[]> {
     const [from, to]: string[] = lang.split('-')
-    return translate<string>(text, {
+    const response: TranslationResponse = await translate<string>(text, {
       from, to, requestFunction: fetch
-    }).then(({ text }) => [text])
+    })
+    return [response.text]
   }
 }
diff --git a/src/providers/LibreTranslateProvider.ts b/src/providers/LibreTranslateProvider.ts
@@ -11,7 +11,7 @@ export default class LibreTranslateProvider extends ProviderBase {
     this.apiKey = apiKey
   }
 
-  translate(text: string, lang: string): Promise<string[]> {
+  async translate(text: string, lang: string): Promise<string[]> {
     const [source, target] = lang.split('-', 2)
     const data = {
       q: text,
@@ -20,7 +20,8 @@ export default class LibreTranslateProvider extends ProviderBase {
       format: 'text',
       api_key: this.apiKey
     }
-    return this.api<LibreTranslateResponse>({ data, url: '/', method: 'POST' })
-      .then(({ translatedText }) => [translatedText])
+    const { translatedText }: LibreTranslateResponse =
+      await this.api<LibreTranslateResponse>({ data, url: '/', method: 'POST' })
+    return [translatedText]
   }
 }
diff --git a/src/providers/LinguaToolsProvider.ts b/src/providers/LinguaToolsProvider.ts
@@ -1,7 +1,7 @@
 import ProviderBase from './ProviderBase';
 
 /* eslint-disable camelcase */
-type LinguaToolsResponse = { freq: number, l1_text: string }[]
+type LinguaToolsResponse = { freq: number, l1_text: string }
 
 export default class LinguaToolsProvider extends ProviderBase {
   constructor() {
@@ -10,9 +10,9 @@ export default class LinguaToolsProvider extends ProviderBase {
 
   translate(text: string, lang: string): Promise<string[]> {
     const url = `/?langpair=${lang}&query=${text}`
-    return this.api<LinguaToolsResponse>({ url, method: 'GET' })
-      .then((translations) => {
-        translations.sort((a, b) => a.freq > b.freq ? 1 : -1)
+    return this.api<LinguaToolsResponse[]>({ url, method: 'GET' })
+      .then((translations: LinguaToolsResponse[]) => {
+        translations.sort((a: LinguaToolsResponse, b: LinguaToolsResponse) => a.freq > b.freq ? 1 : -1)
         return translations.map(({ l1_text }) => l1_text)
       })
   }
diff --git a/src/providers/MicrosoftProvider.ts b/src/providers/MicrosoftProvider.ts
@@ -1,6 +1,6 @@
 import ProviderBase from './ProviderBase'
 
-type MicrosoftResponse = { translations: { text: string }[] }[]
+type MicrosoftResponse = { translations: { text: string }[] }
 
 export default class MicrosoftProvider extends ProviderBase {
   private readonly apiKey: string
@@ -12,9 +12,9 @@ export default class MicrosoftProvider extends ProviderBase {
     this.addParam = addParam
   }
 
-  translate(text: string, lang: string): Promise<string[]> {
+  async translate(text: string, lang: string): Promise<string[]> {
     const url = `/translate?api-version=3.0&to=${lang}`
-    return this.api<MicrosoftResponse>({
+    const response: MicrosoftResponse[] = await this.api<MicrosoftResponse[]>({
       url,
       headers: {
         'ocp-apim-subscription-key': this.apiKey,
@@ -23,6 +23,7 @@ export default class MicrosoftProvider extends ProviderBase {
       },
       method: 'POST',
       data: { Text: text }
-    }).then((resp) => resp[0].translations.map(({ text }) => text))
+    })
+    return response[0].translations.map(({ text }) => text)
   }
 }
diff --git a/src/providers/MyMemoryProvider.ts b/src/providers/MyMemoryProvider.ts
@@ -10,13 +10,11 @@ export default class MyMemoryProvider extends ProviderBase {
     this.apiKey = apiKey;
   }
 
-  translate(text: string, lang: string): Promise<string[]> {
+  async translate(text: string, lang: string): Promise<string[]> {
     let url = `/get?q=${text}&langpair=${lang}`;
     url += (this.apiKey ? `&key=${this.apiKey}` : '');
-    return this.api<MyMemoryResponse>({ url, method: 'GET' })
-      .then(({ matches }) => {
-        matches.sort((a, b) => a.match > b.match ? -1 : 1);
-        return matches.map(({ translation }) => translation);
-      });
+    const { matches }: MyMemoryResponse = await this.api<MyMemoryResponse>({ url, method: 'GET' })
+    matches.sort((a, b) => a.match > b.match ? -1 : 1);
+    return matches.map(({ translation }) => translation);
   }
 }
diff --git a/yarn.lock b/yarn.lock
