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

package/index.js

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

package/lqabossProvider.js

@@ -1,5 +1,5 @@
 import JSZip from 'jszip';
-import { getRegressionMode, providers, logVerbose, logInfo, styleString, utils, opsManager, logError, logWarn } from '@l10nmonster/core';
+import { providers, logVerbose, styleString, opsManager } from '@l10nmonster/core';
 
 /**
  * @typedef {object} LQABossProviderOptions
@@ -22,47 +22,34 @@ export class LQABossProvider extends providers.BaseTranslationProvider {
         super(options);
         this.#storageDelegate = delegate;
         this.#opNames.startReviewOp = `${this.id}.startReviewOp`;
-        this.#opNames.continueReviewOp = `${this.id}.continueReviewOp`;
-        this.#opNames.completeReviewOp = `${this.id}.completeReviewOp`;
         opsManager.registerOp(this.startReviewOp.bind(this), { opName: this.#opNames.startReviewOp, idempotent: false });
-        opsManager.registerOp(this.continueReviewOp.bind(this), { opName: this.#opNames.continueReviewOp, idempotent: true });
-        opsManager.registerOp(this.completeReviewOp.bind(this), { opName: this.#opNames.completeReviewOp, idempotent: true });
     }
 
     createTask(job) {
         logVerbose`LQABossProvider creating task for job ${job.jobGuid}`;
-        const requestTranslationsTask = opsManager.createTask(this.id, this.#opNames.completeReviewOp);
-        requestTranslationsTask.rootOp.enqueue(this.#opNames.startReviewOp, { job });
-        return requestTranslationsTask;
+        return opsManager.createTask(this.id, this.#opNames.startReviewOp, { job });
     }
 
     async startReviewOp(op) {
-        const { job } = op.args;
+        const { tus, ...jobResponse } = op.args.job;
         const zip = new JSZip();
-        zip.file('job.json', JSON.stringify(job, null, 2));
+        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));
         const buffer = await zip.generateAsync({ type: 'nodebuffer', compression: 'DEFLATE', compressionOptions: { level: 6 } });
-        const filename = `${job.jobGuid}.lqaboss`;
+        const filename = `${jobResponse.jobGuid}.lqaboss`;
         await this.#storageDelegate.saveFile(filename, buffer);
-        logVerbose`LQABoss file ${filename} with ${job.tus.length} guids and ${buffer.length} bytes saved`;
-        op.parentTask.rootOp.enqueue(this.#opNames.continueReviewOp, { jobGuid: job.jobGuid });
-    }
-
-    /**
-     * Fetches the completed review job. This will error out until the review is complete.
-     * @param {object} op - The operation context containing fetch parameters.
-     * @returns {Promise<*>} The job response.
-     */
-    async continueReviewOp(op) {
-        const filename = `${op.args.jobGuid}.json`;
-        logVerbose`Trying to fetch completed LQABoss file ${filename}`;
-        return JSON.parse(await this.#storageDelegate.getFile(filename));
-    }
-
-    async completeReviewOp(op) {
-        const { tus, ...jobResponse } = op.inputs[1]; // the second op should be continueReviewOp
-        jobResponse.status = 'done';
-        const ts = getRegressionMode() ? 1 : new Date().getTime();
-        jobResponse.tus = tus.map(tu => ({ ...tu, ts, q: this.quality }));
+        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;
     }
 

package/lqabossTmStore.js

@@ -0,0 +1,96 @@
+import { logInfo, logVerbose, utils } from '@l10nmonster/core';
+
+/**
+ * Adapter class to expose LQABoss completion files as a TM store.
+ *
+ * @class LQABossTmStore
+ */
+export class LQABossTmStore {
+    id;
+    #storageDelegate;
+    #tm;
+
+    get access() {
+        return 'readonly';
+    }
+
+    get partitioning() {
+        return 'job';
+    }
+
+    /**
+     * Creates an LQABossTmStore instance
+     * @param {Object} options - Configuration options
+     * @param {Object} options.delegate - Required file store delegate implementing file operations
+     * @param {string} options.id - Required unique identifier for the store
+     * @throws {Error} If no delegate or id is provided
+     */
+    constructor(options) {
+        const { delegate, id } = options || {};
+        if (!delegate || !id) {
+            throw new Error('A delegate and an id are required to instantiate an LQABossTmStore');
+        }
+        this.#storageDelegate = delegate;
+        this.id = id;
+    }
+
+    async #getTM() {
+        if (!this.#tm) {
+            this.#tm = {};
+            const files = await this.#storageDelegate.listAllFiles();
+            for (const [ fileName ] of files) {
+                if (fileName.length === 26 && fileName.endsWith('.json')) {
+                    const job = JSON.parse(await this.#storageDelegate.getFile(fileName));
+                    const ts = job.updatedAt ? new Date(job.updatedAt).getTime() : new Date().getTime();
+                    job.tus = job.tus.map(tu => ({ ...tu, ts }));
+                    this.#tm[job.sourceLang] ??= {};
+                    this.#tm[job.sourceLang][job.targetLang] ??= {};
+                    this.#tm[job.sourceLang][job.targetLang][job.jobGuid] = job;
+                }
+            }
+        }
+        return this.#tm;
+    }
+
+    async getAvailableLangPairs() {
+        const tm = await this.#getTM();
+        const pairs = [];
+        for (const [ sourceLang, targets ] of Object.entries(tm)) {
+            for (const targetLang of Object.keys(targets)) {
+                pairs.push([ sourceLang, targetLang ]);
+            }
+        }
+        return pairs;
+    }
+
+    async listAllTmBlocks(sourceLang, targetLang) {
+        const tm = await this.#getTM();
+        const blocks = tm[sourceLang]?.[targetLang] ?? {};
+        return Object.entries(blocks).map(([ jobGuid, job ]) => [ jobGuid, job.updatedAt ]);
+    }
+
+    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) {
+                yield* utils.getIteratorFromJobPair(job, job);
+            }
+        }
+    }
+
+    async getTOC(sourceLang, targetLang) {
+        const tm = await this.#getTM();
+        const blocks = tm[sourceLang]?.[targetLang] ?? {};
+        const toc = { v: 1, sourceLang, targetLang, blocks: {} };
+        for (const [ jobGuid, job ] of Object.entries(blocks)) {
+            toc.blocks[jobGuid] = { blockName: jobGuid, modified: job.updatedAt, jobs: [ [ jobGuid, job.updatedAt ] ] };
+        }
+        return toc;
+    }
+
+    async getWriter() {
+        throw new Error(`Cannot write to readonly TM Store: ${this.id}`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@l10nmonster/helpers-lqaboss",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-alpha.9",
   "description": "LQA Boss helper for L10n Monster",
   "main": "index.js",
   "type": "module",