@l10nmonster/helpers-lqaboss 3.0.0-alpha.8 → 3.1.0

package/.releaserc.json

@@ -20,7 +20,7 @@
     },
     {
       "path": "@semantic-release/npm",
-      "npmPublish": true
+      "npmPublish": false
     },
     {
       "path": "@semantic-release/git",

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# @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.' };
@@ -221,12 +222,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/lqabossProvider.js

@@ -1,10 +1,14 @@
 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 +16,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 +39,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,28 @@
+import { logInfo, logVerbose, logWarn } from '@l10nmonster/core';
+
+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,4 +1,4 @@
-import { logInfo, logVerbose, utils } from '@l10nmonster/core';
+import { utils } from '@l10nmonster/core';
 
 /**
  * Adapter class to expose LQABoss completion files as a TM store.
@@ -39,9 +39,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] ??= {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@l10nmonster/helpers-lqaboss",
-  "version": "3.0.0-alpha.8",
+  "version": "3.1.0",
   "description": "LQA Boss helper for L10n Monster",
   "main": "index.js",
   "type": "module",
@@ -13,6 +13,6 @@
     "puppeteer": "^24"
   },
   "peerDependencies": {
-    "@l10nmonster/core": "^3.0.0-alpha.0"
+    "@l10nmonster/core": "3.1.0"
   }
 }