@l10nmonster/helpers-lqaboss 3.0.0-alpha.9 → 3.1.1

package/CHANGELOG.md

@@ -1,3 +1,45 @@
+## @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)
+
+
+### Bug Fixes
+
+* Calibrate log severities ([2b3350a](https://public-github/l10nmonster/l10nmonster/commit/2b3350a3123abb91e7f91a9c1864daeb6275c3ad))
+* **helpers-lqaboss:** Fix typo ([209dd07](https://public-github/l10nmonster/l10nmonster/commit/209dd071724c6f15464a1be0ebf140f23efc3f56))
+* **helpers-lqaboss:** Move lqaboss ingestion to tm syncdown ([ebda63f](https://public-github/l10nmonster/l10nmonster/commit/ebda63f3b1651b44265ba62ce0f4ff876e9c97ed))
+* **helpers-lqaboss:** Relax LQABossTmStore glob to allow for custom flow names ([5568c81](https://public-github/l10nmonster/l10nmonster/commit/5568c81d55f07c95d4af337904bc0367f5f71d68))
+* **helpers-lqaboss:** Support old jobs without updatedAt property ([7c8cf75](https://public-github/l10nmonster/l10nmonster/commit/7c8cf759dfe9df379f537ef8a278b76949c19783))
+* **lqaboss:** Support new response type ([ecaec02](https://public-github/l10nmonster/l10nmonster/commit/ecaec029b509d88267ac66374c5993c1537737c0))
+* **server:** Fix cart cleanup ([9bbcab9](https://public-github/l10nmonster/l10nmonster/commit/9bbcab93e1fd20aeb09f59c828665159f091f37c))
+
+
+### Features
+
+* **core:** Major refactor ([6992ee4](https://public-github/l10nmonster/l10nmonster/commit/6992ee4d74ad2e25afef6220f92f2e72dfd02457))
+* Improve LQA Boss ([fcb0818](https://public-github/l10nmonster/l10nmonster/commit/fcb0818181f1a7bd46764596c9d2b8d8f362375c))
+* **lqaboss:** Support for new Chrome extension ([dc6f86f](https://public-github/l10nmonster/l10nmonster/commit/dc6f86f417dde5e5942bdad2c81c0fbbac59fb80))
+
 # Changelog
 
 All notable changes to this project will be documented in this file.

package/flowCapture.js

@@ -1,3 +1,4 @@
+/* eslint-disable complexity */
 import JSZip from 'jszip';
 import puppeteer from 'puppeteer';
 import { logInfo, logVerbose } from '@l10nmonster/core';
@@ -24,7 +25,7 @@ async function extractTextAndMetadataInPageContext() {
 
     const textElements = [];
     const START_MARKER_REGEX = /(?<![''<])\u200B([\uFE00-\uFE0F]+)/g;
-    const END_MARKER = '\u200B';
+    const END_MARKER = '\u200C';
 
     if (!document.body) {
         return { error: 'Document body not found.' };
@@ -67,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,
@@ -109,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,
@@ -221,12 +226,8 @@ export class FlowSnapshotter {
             const job = {
                 sourceLang: tm.sourceLang,
                 targetLang: tm.targetLang,
-                tus: [],
+                tus: Object.values(await tm.getEntries(Array.from(guids))),
             };
-            guids.forEach(guid => {
-                const tu = tm.getEntryByGuid(guid);
-                tu && job.tus.push(tu);
-            });
             if (job.tus.length > 0) {
                 zip.file('job.json', JSON.stringify(job, null, 2));
             }

package/index.js

@@ -1,3 +1,4 @@
 export { LQABossActions } from './lqabossActions.js';
 export { LQABossProvider } from './lqabossProvider.js';
 export { LQABossTmStore } from './lqabossTmStore.js';
+export { createLQABossRoutes } from './lqabossRoutes.js';

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

@@ -1,10 +1,13 @@
 import JSZip from 'jszip';
-import { providers, logVerbose, styleString, opsManager } from '@l10nmonster/core';
+import path from 'path';
+import { readFileSync } from 'fs';
+import { providers, logVerbose, styleString, opsManager, getBaseDir } from '@l10nmonster/core';
 
 /**
  * @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
  */
 
 /**
@@ -12,15 +15,19 @@ import { providers, logVerbose, styleString, opsManager } from '@l10nmonster/cor
  */
 export class LQABossProvider extends providers.BaseTranslationProvider {
     #storageDelegate;
+    urlPrefix;
+    #qualityFilePath;
     #opNames = {};
 
     /**
      * Initializes a new instance of the LQABossProvider class.
      * @param {LQABossProviderOptions} options - Configuration options for the provider.
      */
-    constructor({ delegate, ...options }) {
+    constructor({ delegate, urlPrefix, qualityFile, ...options }) {
         super(options);
         this.#storageDelegate = delegate;
+        this.urlPrefix = urlPrefix;
+        qualityFile && (this.#qualityFilePath = path.resolve(getBaseDir(), qualityFile));
         this.#opNames.startReviewOp = `${this.id}.startReviewOp`;
         opsManager.registerOp(this.startReviewOp.bind(this), { opName: this.#opNames.startReviewOp, idempotent: false });
     }
@@ -31,26 +38,30 @@ export class LQABossProvider extends providers.BaseTranslationProvider {
     }
 
     async startReviewOp(op) {
-        const { tus, ...jobResponse } = op.args.job;
+        const filename = op.args.job.jobName ?
+            `${op.args.job.jobName.replace(/\s+/g, '_')}-${op.args.job.jobGuid.substring(0, 5)}.lqaboss` :
+            `${op.args.job.jobGuid}.lqaboss`;
+        const jobRequest = {
+            ...op.args.job,
+            statusDescription: `Created LQA Boss file ${this.urlPrefix ? `at ${this.urlPrefix}/${filename}` : `: ${filename}`}`,
+            providerData: { quality: this.quality },
+        };
         const zip = new JSZip();
-        zip.file('job.json', JSON.stringify({
-            ...jobResponse,
-            tus: tus.map(tu => ({
-                rid: tu.rid,
-                sid: tu.sid,
-                guid: tu.guid,
-                nsrc: tu.nsrc,
-                notes: tu.notes,
-                ntgt: tu.ntgt,
-                q: this.quality,
-            })),
-        }, null, 2));
+        zip.file('job.json', JSON.stringify(jobRequest, null, 2));
+        
+        // Add quality model if configured
+        if (this.#qualityFilePath) {
+            const qualityModel = JSON.parse(readFileSync(this.#qualityFilePath, 'utf-8'));
+            zip.file('quality.json', JSON.stringify(qualityModel, null, 2));
+        }
+        
         const buffer = await zip.generateAsync({ type: 'nodebuffer', compression: 'DEFLATE', compressionOptions: { level: 6 } });
-        const filename = `${jobResponse.jobGuid}.lqaboss`;
         await this.#storageDelegate.saveFile(filename, buffer);
-        logVerbose`Saved LQABoss file ${filename} with ${tus.length} guids and ${buffer.length} bytes`;
-        jobResponse.tus = []; // remove tus so that job is cancelled and won't be stored
-        return jobResponse;
+        logVerbose`Saved LQABoss file ${filename} with ${jobRequest.tus.length} guids and ${buffer.length} bytes`;
+        return {
+            ...jobRequest,
+            tus: [], // remove tus so that job is cancelled and won't be stored
+        };
     }
 
     async info() {

package/lqabossRoutes.js

@@ -0,0 +1,35 @@
+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) => {
+            logInfo`LQABossRoute:/lookup`;
+            try {
+                const { sourceLang, targetLang, segments } = req.body;
+                const tm = mm.tmm.getTM(sourceLang, targetLang);
+                const guids = new Set(segments.map(segment => segment.g));
+                let tus = [];
+                if (guids.size > 0) {
+                    tus = await tm.queryByGuids(Array.from(guids));
+                }
+                const guidMap = new Map(tus.map(tu => [ tu.guid, tu ]));
+                const results = segments.map(segment => guidMap.get(segment.g) ?? {});
+                logVerbose`Matched ${tus.length} segments out of ${guids.size}`;
+                res.json({ results });
+            } catch (error) {
+                logWarn`Error in LQABossRoute:/lookup: ${error.message}`;
+                res.status(500).json({
+                    error: 'Failed to lookup translation memory',
+                    message: error.message
+                });
+            }
+        }]
+    ]
+}

package/lqabossTmStore.js

@@ -1,19 +1,22 @@
-import { logInfo, logVerbose, utils } from '@l10nmonster/core';
+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';
     }
@@ -39,9 +42,13 @@ export class LQABossTmStore {
             this.#tm = {};
             const files = await this.#storageDelegate.listAllFiles();
             for (const [ fileName ] of files) {
-                if (fileName.length === 26 && fileName.endsWith('.json')) {
+                if (fileName.endsWith('.json')) {
                     const job = JSON.parse(await this.#storageDelegate.getFile(fileName));
-                    const ts = job.updatedAt ? new Date(job.updatedAt).getTime() : new Date().getTime();
+                    if (!job.sourceLang || !job.targetLang || !job.jobGuid) {
+                        continue;
+                    }
+                    !job.updatedAt && (job.updatedAt = '2025-08-29T21:29:36.269Z'); // workaround for old jobs that don't have an updatedAt
+                    const ts = new Date(job.updatedAt).getTime();
                     job.tus = job.tus.map(tu => ({ ...tu, ts }));
                     this.#tm[job.sourceLang] ??= {};
                     this.#tm[job.sourceLang][job.targetLang] ??= {};
@@ -52,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)) {
@@ -69,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.0.0-alpha.9",
-  "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.0.0-alpha.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": true
-    },
-    {
-      "path": "@semantic-release/git",
-      "assets": ["CHANGELOG.md", "package.json"],
-      "message": "chore(release): @l10nmonster/helpers-lqaboss@${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-    }
-  ]
-}