@l10nmonster/helpers-translated 3.0.0-alpha.1 → 3.0.0-alpha.10

package/.releaserc.json

@@ -0,0 +1,31 @@
+{
+  "branches": [
+    "main",
+    {
+      "name": "next",
+      "prerelease": "alpha"
+    },
+    {
+      "name": "beta",
+      "prerelease": "beta"
+    }
+  ],
+  "tagFormat": "@l10nmonster/helpers-translated@${version}",
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    {
+      "path": "@semantic-release/changelog",
+      "changelogFile": "CHANGELOG.md"
+    },
+    {
+      "path": "@semantic-release/npm",
+      "npmPublish": true
+    },
+    {
+      "path": "@semantic-release/git",
+      "assets": ["CHANGELOG.md", "package.json"],
+      "message": "chore(release): @l10nmonster/helpers-translated@${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

package/laraProvider.js

@@ -1,12 +1,13 @@
-import { logWarn, providers, styleString } from '@l10nmonster/core';
+import { providers, styleString } from '@l10nmonster/core';
 import { Credentials, Translator } from '@translated/lara';
 
 /**
  * @typedef {object} LaraProviderOptions
  * @extends ChunkedRemoteTranslationProviderOptions
  * @property {string} keyId - The Lara API key id. This is required.
- * @property {string} [keySecret] - The Lara API key secret. Optional, but often needed for authentication.
- * @property {string|Array<string>} [adaptTo] - An optional single translation memory ID or an array of IDs to adapt translations to.
+ * @property {Promise<string>|string} [keySecret] - The Lara API key secret. Optional, but often needed for authentication.
+ * @property {string | Array<string>} [adaptTo] - An optional single translation memory ID or an array of IDs to adapt translations to.
+ * @property {string | Array<string>} [glossaries] - Glossaries to include in the request.
  * @property {number} [maxChunkSize=60] - Maximum number of text segments (strings) allowed in a single API request chunk. Defaults to 60 if not provided.
  */
 
@@ -16,29 +17,30 @@ import { Credentials, Translator } from '@translated/lara';
 export class LaraProvider extends providers.ChunkedRemoteTranslationProvider {
     #keyId;
     #keySecret;
-    #adaptTo;
-    #lara;
     #translateOptions;
 
     /**
      * Initializes a new instance of the LaraProvider class.
      * @param {LaraProviderOptions} options - Configuration options for the provider.
      */
-    constructor({ keyId, keySecret, adaptTo, ...options }) {
+    constructor({ keyId, keySecret, adaptTo, glossaries, ...options }) {
         super({ maxChunkSize: 60, ...options }); // maximum number of strings sent to Lara is 128 including notes
         this.#keyId = keyId;
         this.#keySecret = keySecret;
-        this.#adaptTo = adaptTo && (Array.isArray(adaptTo) ? adaptTo : adaptTo.split(','));
-        const credentials = new Credentials(this.#keyId, this.#keySecret);
-        this.#lara = new Translator(credentials);
         this.#translateOptions = {
             contentType: 'text/plain',
             instructions: [],
         };
-        this.#adaptTo && (this.#translateOptions.adaptTo = this.#adaptTo);
+        adaptTo && (this.#translateOptions.adaptTo = Array.isArray(adaptTo) ? adaptTo : adaptTo.split(','));
+        glossaries && (this.#translateOptions.glossaries = Array.isArray(glossaries) ? glossaries : glossaries.split(','));
         this.defaultInstructions && this.#translateOptions.instructions.push(this.defaultInstructions);
     }
 
+    async #getLara() {
+        const credentials = new Credentials(this.#keyId, await (typeof this.#keySecret === 'function' ? this.#keySecret() : this.#keySecret));
+        return new Translator(credentials);
+    }
+
     prepareTranslateChunkArgs({ sourceLang, targetLang, xmlTus, instructions }) {
         const payload = xmlTus.map(xmlTu => {
             const textBlock = [];
@@ -52,8 +54,9 @@ export class LaraProvider extends providers.ChunkedRemoteTranslationProvider {
 
     async startTranslateChunk(args) {
         const { payload, sourceLang, targetLang, translateOptions } = args;
+        const lara = await this.#getLara();
         try {
-            return await this.#lara.translate(payload, sourceLang, targetLang, translateOptions);
+            return await lara.translate(payload, sourceLang, targetLang, translateOptions);
         } catch (e) {
             throw new Error(`Lara API error ${e.statusCode}: ${e.type}: ${e.message}`);
         }
@@ -72,15 +75,12 @@ export class LaraProvider extends providers.ChunkedRemoteTranslationProvider {
             return info;
         }
         try {
-            const credentials = new Credentials(this.#keyId, this.#keySecret);
-            const lara = new Translator(credentials);
+            const lara = await this.#getLara();
             const languages = (await lara.getLanguages()).sort();
             info.description.push(styleString`Vendor-supported languages: ${languages?.join(', ') ?? 'unknown'}`);
             const memories = await lara.memories.list();
             if (memories.length > 0) {
-                memories.forEach(m =>
-                    info.description.push(styleString`Vendor TM "${m.name}": id: ${m.id} owner: ${m.ownerId} collaborators: ${m.collaboratorsCount} created: ${m.createdAt} updated: ${m.updatedAt}`)
-                );
+                memories.forEach(m => info.description.push(styleString`Vendor TM "${m.name}": id: ${m.id} owner: ${m.ownerId} collaborators: ${m.collaboratorsCount} created: ${m.createdAt} updated: ${m.updatedAt}`));
             } else {
                 info.description.push(styleString`No TMs configured.`);
             }

package/mmtProvider.js

@@ -5,10 +5,12 @@ import { ModernMT as MMTClient } from 'modernmt';
  * @typedef {object} MMTProviderOptions
  * @extends ChunkedRemoteTranslationProviderOptions
  * @property {string} [id] - Global identifier (by default 'MMTBatch' or 'MMTRealtime')
- * @property {string} apiKey - The ModernMT API key.
+ * @property {Promise<string>|string} apiKey - The ModernMT API key.
  * @property {string} [webhook] - The webhook URL for batch translation.
  * @property {function(any): any} [chunkFetcher] - The chunk fetcher operation name.
- * @property {(string | number)[]} [hints] - Hints to include in the MMT request.
+ * @property {string | number[]} [hints] - Hints to include in the MMT request.
+ * @property {string | number[]} [glossaries] - Glossaries to include in the MMT request.
+ * @property {boolean} [ignoreGlossaryCase] - Whether to use ignore case in glossary entries.
  * @property {boolean} [multiline] - Whether to use multiline mode.
  */
 
@@ -16,11 +18,13 @@ import { ModernMT as MMTClient } from 'modernmt';
  * Provider for Translated Modern MT.
  */
 export class MMTProvider extends providers.ChunkedRemoteTranslationProvider {
+    #apiKey;
+
     /**
      * Initializes a new instance of the MMTProvider class.
      * @param {MMTProviderOptions} options - Configuration options for the provider.
      */
-    constructor({ id, apiKey, webhook, chunkFetcher, hints, multiline = true, ...options }) {
+    constructor({ id, apiKey, webhook, chunkFetcher, hints, glossaries, ignoreGlossaryCase, multiline = true, ...options }) {
         id ??= webhook ? 'MMTBatch' : 'MMTRealtime';
         super({ id, ...options });
         if (webhook) {
@@ -30,24 +34,19 @@ export class MMTProvider extends providers.ChunkedRemoteTranslationProvider {
                 throw new Error('If you specify a webhook you must also specify a chunkFetcher');
             }
         }
+        this.#apiKey = apiKey;
         this.baseRequest = {
-            mmtConstructor: [ apiKey, 'l10n.monster/MMT', '3.0' ],
             hints,
             options: {
                 multiline,
                 format: 'text/xml',
+                glossaries,
+                ignoreGlossaryCase,
             },
             webhook,
         }
     }
 
-    start(job) {
-        if (!this.baseRequest.mmtConstructor[0]) {
-            throw new Error('You must have an apiKey to start an MMT job');
-        }
-        return super.start(job);
-    }
-
     prepareTranslateChunkArgs({ sourceLang, targetLang, xmlTus, jobGuid, chunkNumber }) {
         return {
             sourceLang,
@@ -67,9 +66,8 @@ export class MMTProvider extends providers.ChunkedRemoteTranslationProvider {
 
     async startTranslateChunk(args) {
         const { sourceLang, targetLang, q, hints, contextVector, options, webhook, batchOptions } = args;
-        const [ apiKey, platform, platformVersion ] = this.baseRequest.mmtConstructor;
         try {
-            const mmt = new MMTClient(apiKey, platform, platformVersion);
+            const mmt = new MMTClient(await (typeof this.#apiKey === 'function' ? this.#apiKey() : this.#apiKey), 'l10n.monster/MMT', '3.0');
             if (webhook) {
                 const response = await mmt.batchTranslate(webhook, sourceLang, targetLang, q, hints, contextVector, batchOptions);
                 return { enqueued: response };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@l10nmonster/helpers-translated",
-    "version": "3.0.0-alpha.1",
+    "version": "3.0.0-alpha.10",
     "description": "Helpers to integrate with Translated.com",
     "main": "index.js",
     "type": "module",
@@ -10,7 +10,7 @@
     "author": "Diego Lagunas",
     "license": "MIT",
     "peerDependencies": {
-        "@l10nmonster/core": "file:../core"
+        "@l10nmonster/core": "^3.0.0-alpha.0"
     },
     "dependencies": {
         "@translated/lara": "^1.4.0",