@l10nmonster/helpers-lqaboss 3.1.0 → 3.1.1

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## @l10nmonster/helpers-lqaboss [3.1.1](https://public-github/l10nmonster/l10nmonster/compare/@l10nmonster/helpers-lqaboss@3.1.0...@l10nmonster/helpers-lqaboss@3.1.1) (2025-12-23)
+
+
+### Bug Fixes
+
+* Improve type definitions and checks ([826b412](https://public-github/l10nmonster/l10nmonster/commit/826b412f0f7e761d404165a243b0c2b26c416ac1))
+
+## @l10nmonster/helpers-lqaboss [3.1.1](https://public-github/l10nmonster/l10nmonster/compare/@l10nmonster/helpers-lqaboss@3.1.0...@l10nmonster/helpers-lqaboss@3.1.1) (2025-12-23)
+
+
+### Bug Fixes
+
+* Improve type definitions and checks ([826b412](https://public-github/l10nmonster/l10nmonster/commit/826b412f0f7e761d404165a243b0c2b26c416ac1))
+
+
+
+
+
+### Dependencies
+
+* **@l10nmonster/core:** upgraded to 3.1.1
+
 # @l10nmonster/helpers-lqaboss [3.1.0](https://public-github/l10nmonster/l10nmonster/compare/@l10nmonster/helpers-lqaboss@3.0.0...@l10nmonster/helpers-lqaboss@3.1.0) (2025-12-20)
 
 

package/flowCapture.js

@@ -68,7 +68,9 @@ async function extractTextAndMetadataInPageContext() {
                             if (decodedJsonMetadata && decodedJsonMetadata.trim() !== '') {
                                  parsedMetadata = JSON.parse(decodedJsonMetadata);
                             }
-                        } catch (e) { parsedMetadata.decodingError = e.message; }
+                        } catch (e) {
+ parsedMetadata.decodingError = e.message; 
+}
 
                         textElements.push({
                             text: activeSegment.text,
@@ -110,7 +112,9 @@ async function extractTextAndMetadataInPageContext() {
                                 if (decodedJsonMetadata && decodedJsonMetadata.trim() !== '') {
                                      parsedMetadata = JSON.parse(decodedJsonMetadata);
                                 }
-                            } catch (e) { parsedMetadata.decodingError = e.message; }
+                            } catch (e) {
+ parsedMetadata.decodingError = e.message; 
+}
     
                             textElements.push({
                                 text: capturedText,

package/lqabossActions.js

@@ -1,10 +1,13 @@
 import { lqaboss_capture } from './lqabossCapture.js';
 
-export class LQABossActions {
-    static name = 'lqaboss';
-    static help = {
+/**
+ * CLI actions for LQA Boss integration.
+ * @type {import('@l10nmonster/core').L10nAction}
+ */
+export const LQABossActions = {
+    name: 'lqaboss',
+    help: {
         description: 'Actions to integrate with LQA Boss.',
-    };
-
-    static subActions = [ lqaboss_capture ];
-}
+    },
+    subActions: [ lqaboss_capture ],
+};

package/lqabossCapture.js

@@ -3,8 +3,13 @@ import readline from 'readline';
 import { consoleLog } from '@l10nmonster/core';
 import { FlowSnapshotter } from './flowCapture.js';
 
-export class lqaboss_capture {
-    static help = {
+/**
+ * CLI action for creating an LQA Boss flow.
+ * @type {import('@l10nmonster/core').L10nAction}
+ */
+export const lqaboss_capture = {
+    name: 'lqaboss_capture',
+    help: {
         description: 'create an lqaboss flow.',
         arguments: [
             ['<url>', 'the url of the page to capture'],
@@ -13,29 +18,30 @@ export class lqaboss_capture {
         options: [
             [ '--lang <srcLang,tgtLang>', 'source and target language pair' ],
         ],
-    };
+    },
 
-    static async action(mm, options) {
-        if (!options.url || !options.flowName) {
+    async action(mm, options) {
+        const { url, flowName, lang } = /** @type {{ url?: string, flowName?: string, lang?: string | string[] }} */ (options);
+        if (!url || !flowName) {
             throw new Error('You must specify a url and a flowName');
         }
-        const langPairs = options.lang ? (Array.isArray(options.lang) ? options.lang : options.lang.split(',')) : null;
+        const langPairs = lang ? (Array.isArray(lang) ? lang : lang.split(',')) : null;
         let tm;
         if (langPairs) {
             const [ sourceLang, targetLang ] = langPairs;
             tm = mm.tmm.getTM(sourceLang, targetLang);
         }
         // Run the capture flow
-        const lqaBossBuffer = await runCapture(options.url, options.flowName, tm);
+        const lqaBossBuffer = await runCapture(url, flowName, tm);
         if (lqaBossBuffer) {
-            const filename = `${options.flowName.replace(/[^a-z0-9_.-]/gi, '_')}.lqaboss`;
+            const filename = `${flowName.replace(/[^a-z0-9_.-]/gi, '_')}.lqaboss`;
             await fs.promises.writeFile(filename, lqaBossBuffer);
             consoleLog`Flow successfully saved as ${filename}`;
         } else {
             console.log('No pages were captured. Nothing to save.');
         }
-    }
-}
+    },
+};
 
 async function runCapture(startUrl, flowNameBase, tm) {
     const snapShotter = new FlowSnapshotter(startUrl, flowNameBase);

package/lqabossProvider.js

@@ -5,7 +5,6 @@ import { providers, logVerbose, styleString, opsManager, getBaseDir } from '@l10
 
 /**
  * @typedef {object} LQABossProviderOptions
- * @extends BaseTranslationProvider
  * @property {Object} delegate - Required file store delegate implementing file operations
  * @property {string} [urlPrefix] - Prefix for the LQA Boss URL
  * @property {string} [qualityFile] - Path to a quality model JSON file

package/lqabossRoutes.js

@@ -1,5 +1,12 @@
 import { logInfo, logVerbose, logWarn } from '@l10nmonster/core';
 
+/** @typedef {import('@l10nmonster/core').MonsterManager} MonsterManager */
+
+/**
+ * Creates LQABoss route handlers for the server extension mechanism.
+ * @param {MonsterManager} mm - MonsterManager instance.
+ * @returns {Array<[string, string, Function]>} Route definitions.
+ */
 export function createLQABossRoutes(mm) {
     return [
         ['post', '/lookup', async (req, res) => {

package/lqabossTmStore.js

@@ -1,19 +1,22 @@
 import { utils } from '@l10nmonster/core';
 
+/** @typedef {import('@l10nmonster/core').TMStore} TMStore */
+
 /**
  * Adapter class to expose LQABoss completion files as a TM store.
- *
- * @class LQABossTmStore
+ * @implements {TMStore}
  */
 export class LQABossTmStore {
     id;
     #storageDelegate;
     #tm;
 
+    /** @type {'readonly'} */
     get access() {
         return 'readonly';
     }
 
+    /** @type {'job'} */
     get partitioning() {
         return 'job';
     }
@@ -56,8 +59,13 @@ export class LQABossTmStore {
         return this.#tm;
     }
 
+    /**
+     * @returns {Promise<[string, string][]>}
+     */
     async getAvailableLangPairs() {
         const tm = await this.#getTM();
+
+        /** @type {[string, string][]} */
         const pairs = [];
         for (const [ sourceLang, targets ] of Object.entries(tm)) {
             for (const targetLang of Object.keys(targets)) {
@@ -73,21 +81,34 @@ export class LQABossTmStore {
         return Object.entries(blocks).map(([ jobGuid, job ]) => [ jobGuid, job.updatedAt ]);
     }
 
+    /**
+     * @param {string} sourceLang
+     * @param {string} targetLang
+     * @param {string[]} blockIds
+     * @returns {AsyncGenerator<import('@l10nmonster/core').JobPropsTusPair>}
+     */
     async *getTmBlocks(sourceLang, targetLang, blockIds) {
         const tm = await this.#getTM();
         const blocks = tm[sourceLang]?.[targetLang] ?? {};
         for (const jobGuid of blockIds) {
             const job = blocks[jobGuid];
             if (job) {
+                // @ts-ignore - type inference issue with TU properties
                 yield* utils.getIteratorFromJobPair(job, job);
             }
         }
     }
 
+    /**
+     * @param {string} sourceLang
+     * @param {string} targetLang
+     * @returns {Promise<import('@l10nmonster/core').TMStoreTOC>}
+     */
     async getTOC(sourceLang, targetLang) {
         const tm = await this.#getTM();
         const blocks = tm[sourceLang]?.[targetLang] ?? {};
-        const toc = { v: 1, sourceLang, targetLang, blocks: {} };
+        /** @type {import('@l10nmonster/core').TMStoreTOC} */
+        const toc = { v: 1, sourceLang, targetLang, blocks: {}, storedBlocks: [] };
         for (const [ jobGuid, job ] of Object.entries(blocks)) {
             toc.blocks[jobGuid] = { blockName: jobGuid, modified: job.updatedAt, jobs: [ [ jobGuid, job.updatedAt ] ] };
         }

package/package.json

@@ -1,18 +1,19 @@
 {
-  "name": "@l10nmonster/helpers-lqaboss",
-  "version": "3.1.0",
-  "description": "LQA Boss helper for L10n Monster",
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "start": "node index.js",
-    "test": "node --test test/*.test.js"
-  },
-  "dependencies": {
-    "jszip": "^3.10.1",
-    "puppeteer": "^24"
-  },
-  "peerDependencies": {
-    "@l10nmonster/core": "3.1.0"
-  }
+    "name": "@l10nmonster/helpers-lqaboss",
+    "version": "3.1.1",
+    "description": "LQA Boss helper for L10n Monster",
+    "main": "index.js",
+    "type": "module",
+    "scripts": {
+        "start": "node index.js",
+        "test": "node --test test/*.test.js",
+        "typecheck": "tsc --noEmit"
+    },
+    "dependencies": {
+        "jszip": "^3.10.1",
+        "puppeteer": "^24"
+    },
+    "peerDependencies": {
+        "@l10nmonster/core": "3.1.1"
+    }
 }

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../tsconfig.base.json",
+  "include": [
+    "*.js",
+    "**/*.js"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/node_modules",
+    "test/**",
+    "tests/**",
+    "**/*.test.js",
+    "**/*.spec.js",
+    "dist/**",
+    "ui/**",
+    "types/**"
+  ]
+}

package/.releaserc.json

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