@translated/lara 1.7.0 → 1.7.1

package/lib/documents.d.ts

@@ -0,0 +1,57 @@
+import type { LaraClient } from "./net";
+import type { MultiPartFile } from "./net/client";
+import type { TranslationStyle } from "./translator";
+export type S3UploadFields = {
+    acl: string;
+    bucket: string;
+    key: string;
+};
+export declare enum DocumentStatus {
+    INITIALIZED = "initialized",// just been created
+    ANALYZING = "analyzing",// being analyzed for language detection and chars count
+    PAUSED = "paused",// paused after analysis, needs user confirm
+    READY = "ready",// ready to be translated
+    TRANSLATING = "translating",
+    TRANSLATED = "translated",
+    ERROR = "error"
+}
+export interface DocxExtractionParams {
+    extractComments?: boolean;
+    acceptRevisions?: boolean;
+}
+export type DocumentOptions = {
+    adaptTo?: string[];
+    glossaries?: string[];
+    noTrace?: boolean;
+    style?: TranslationStyle;
+};
+export type DocumentDownloadOptions = {
+    outputFormat?: string;
+};
+export type DocumentUploadOptions = DocumentOptions & {
+    password?: string;
+    extractionParams?: DocxExtractionParams;
+};
+export interface Document {
+    readonly id: string;
+    readonly status: DocumentStatus;
+    readonly source?: string;
+    readonly target: string;
+    readonly filename: string;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly options?: DocumentOptions;
+    readonly translatedChars?: number;
+    readonly totalChars?: number;
+    readonly errorReason?: string;
+}
+export type DocumentTranslateOptions = DocumentUploadOptions & DocumentDownloadOptions;
+export declare class Documents {
+    private readonly client;
+    private readonly s3Client;
+    constructor(client: LaraClient);
+    upload(file: MultiPartFile, filename: string, source: string | null, target: string, options?: DocumentUploadOptions): Promise<Document>;
+    status(id: string): Promise<Document>;
+    download(id: string, options?: DocumentDownloadOptions): Promise<Blob | Buffer>;
+    translate(file: MultiPartFile, filename: string, source: string | null, target: string, options?: DocumentTranslateOptions): Promise<Blob | Buffer>;
+}

package/lib/documents.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Documents = exports.DocumentStatus = void 0;
+const errors_1 = require("./errors");
+const s3_1 = __importDefault(require("./net/s3"));
+const to_snake_case_1 = __importDefault(require("./utils/to-snake-case"));
+// biome-ignore format: keep comments aligned
+var DocumentStatus;
+(function (DocumentStatus) {
+    DocumentStatus["INITIALIZED"] = "initialized";
+    DocumentStatus["ANALYZING"] = "analyzing";
+    DocumentStatus["PAUSED"] = "paused";
+    DocumentStatus["READY"] = "ready";
+    DocumentStatus["TRANSLATING"] = "translating";
+    DocumentStatus["TRANSLATED"] = "translated";
+    DocumentStatus["ERROR"] = "error";
+})(DocumentStatus || (exports.DocumentStatus = DocumentStatus = {}));
+class Documents {
+    constructor(client) {
+        this.client = client;
+        this.s3Client = (0, s3_1.default)();
+    }
+    async upload(file, filename, source, target, options) {
+        const { url, fields } = await this.client.get(`/documents/upload-url`, { filename });
+        await this.s3Client.upload(url, fields, file);
+        const headers = (options === null || options === void 0 ? void 0 : options.noTrace) ? { "X-No-Trace": "true" } : {};
+        return this.client.post("/documents", {
+            source,
+            target,
+            s3key: fields.key,
+            adapt_to: options === null || options === void 0 ? void 0 : options.adaptTo,
+            glossaries: options === null || options === void 0 ? void 0 : options.glossaries,
+            style: options === null || options === void 0 ? void 0 : options.style,
+            password: options === null || options === void 0 ? void 0 : options.password,
+            extraction_params: (options === null || options === void 0 ? void 0 : options.extractionParams) ? (0, to_snake_case_1.default)(options.extractionParams) : undefined
+        }, undefined, headers);
+    }
+    async status(id) {
+        return await this.client.get(`/documents/${id}`);
+    }
+    async download(id, options) {
+        const { url } = await this.client.get(`/documents/${id}/download-url`, {
+            output_format: options === null || options === void 0 ? void 0 : options.outputFormat
+        });
+        return await this.s3Client.download(url);
+    }
+    async translate(file, filename, source, target, options) {
+        const uploadOptions = {
+            adaptTo: options === null || options === void 0 ? void 0 : options.adaptTo,
+            glossaries: options === null || options === void 0 ? void 0 : options.glossaries,
+            noTrace: options === null || options === void 0 ? void 0 : options.noTrace,
+            style: options === null || options === void 0 ? void 0 : options.style,
+            password: options === null || options === void 0 ? void 0 : options.password,
+            extractionParams: options === null || options === void 0 ? void 0 : options.extractionParams
+        };
+        const { id } = await this.upload(file, filename, source, target, uploadOptions);
+        const downloadOptions = (options === null || options === void 0 ? void 0 : options.outputFormat) ? { outputFormat: options.outputFormat } : undefined;
+        const pollingInterval = 2000;
+        const maxWaitTime = 1000 * 60 * 15; // 15 minutes
+        const start = Date.now();
+        while (Date.now() - start < maxWaitTime) {
+            await new Promise((resolve) => setTimeout(resolve, pollingInterval));
+            const { status, errorReason } = await this.status(id);
+            if (status === DocumentStatus.TRANSLATED)
+                return await this.download(id, downloadOptions);
+            if (status === DocumentStatus.ERROR) {
+                throw new errors_1.LaraApiError(500, "DocumentError", errorReason);
+            }
+        }
+        throw new errors_1.TimeoutError();
+    }
+}
+exports.Documents = Documents;

package/lib/glossaries.d.ts

@@ -0,0 +1,37 @@
+import type { LaraClient } from "./net";
+import type { MultiPartFile } from "./net/client";
+export interface Glossary {
+    readonly id: string;
+    readonly name: string;
+    readonly ownerId: string;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+}
+export interface GlossaryImport {
+    readonly id: string;
+    readonly begin: number;
+    readonly end: number;
+    readonly channel: number;
+    readonly size: number;
+    readonly progress: number;
+}
+export interface GlossaryCounts {
+    unidirectional?: Record<string, number>;
+    multidirectional?: number;
+}
+export type GlossaryImportCallback = (glossaryImport: GlossaryImport) => void;
+export declare class Glossaries {
+    private readonly client;
+    private readonly pollingInterval;
+    constructor(client: LaraClient);
+    list(): Promise<Glossary[]>;
+    create(name: string): Promise<Glossary>;
+    get(id: string): Promise<Glossary | null>;
+    delete(id: string): Promise<Glossary>;
+    update(id: string, name: string): Promise<Glossary>;
+    importCsv(id: string, csv: MultiPartFile, gzip?: boolean): Promise<GlossaryImport>;
+    getImportStatus(id: string): Promise<GlossaryImport>;
+    waitForImport(gImport: GlossaryImport, updateCallback?: GlossaryImportCallback, maxWaitTime?: number): Promise<GlossaryImport>;
+    counts(id: string): Promise<GlossaryCounts>;
+    export(id: string, contentType: "csv/table-uni", source?: string): Promise<string>;
+}

package/lib/glossaries.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Glossaries = void 0;
+const errors_1 = require("./errors");
+class Glossaries {
+    constructor(client) {
+        this.client = client;
+        this.pollingInterval = 2000;
+    }
+    async list() {
+        return await this.client.get("/glossaries");
+    }
+    async create(name) {
+        return await this.client.post("/glossaries", { name });
+    }
+    async get(id) {
+        try {
+            return await this.client.get(`/glossaries/${id}`);
+        }
+        catch (e) {
+            if (e instanceof errors_1.LaraApiError && e.statusCode === 404) {
+                return null;
+            }
+            throw e;
+        }
+    }
+    async delete(id) {
+        return await this.client.delete(`/glossaries/${id}`);
+    }
+    async update(id, name) {
+        return await this.client.put(`/glossaries/${id}`, { name });
+    }
+    async importCsv(id, csv, gzip = false) {
+        return await this.client.post(`/glossaries/${id}/import`, {
+            compression: gzip ? "gzip" : undefined
+        }, {
+            csv
+        });
+    }
+    async getImportStatus(id) {
+        return await this.client.get(`/glossaries/imports/${id}`);
+    }
+    async waitForImport(gImport, updateCallback, maxWaitTime) {
+        const start = Date.now();
+        while (gImport.progress < 1.0) {
+            if (maxWaitTime && Date.now() - start > maxWaitTime)
+                throw new errors_1.TimeoutError();
+            await new Promise((resolve) => setTimeout(resolve, this.pollingInterval));
+            gImport = await this.getImportStatus(gImport.id);
+            if (updateCallback)
+                updateCallback(gImport);
+        }
+        return gImport;
+    }
+    async counts(id) {
+        return await this.client.get(`/glossaries/${id}/counts`);
+    }
+    async export(id, contentType, source) {
+        return await this.client.get(`/glossaries/${id}/export`, {
+            content_type: contentType,
+            source
+        });
+    }
+}
+exports.Glossaries = Glossaries;

package/lib/index.d.ts

@@ -1,6 +1,8 @@
 export { Credentials } from "./credentials";
+export { Document, DocumentDownloadOptions, DocumentStatus, Documents, DocumentTranslateOptions, DocumentUploadOptions } from "./documents";
 export { LaraApiError, LaraError, TimeoutError } from "./errors";
+export { Glossaries, GlossaryImport, GlossaryImportCallback } from "./glossaries";
+export { Memories, Memory, MemoryImport, MemoryImportCallback } from "./memories";
 export { MultiPartFile } from "./net/client";
-export { version } from "./sdk-version";
-export { Document, DocumentDownloadOptions, DocumentStatus, DocumentUploadOptions, Memory, MemoryImport, NGGlossaryMatch, NGMemoryMatch, TextBlock, TextResult, DetectResult } from "./translator/models";
-export { Documents, DocumentTranslateOptions, Memories, MemoryImportCallback, TranslateOptions, Translator, TranslatorOptions } from "./translator/translator";
+export { DetectResult, NGGlossaryMatch, NGMemoryMatch, TextBlock, TextResult, TranslateOptions, Translator, TranslatorOptions } from "./translator";
+export { version } from "./utils/sdk-version";

package/lib/index.js

@@ -1,17 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Translator = exports.Memories = exports.Documents = exports.DocumentStatus = exports.version = exports.TimeoutError = exports.LaraError = exports.LaraApiError = exports.Credentials = void 0;
+exports.version = exports.Translator = exports.Memories = exports.Glossaries = exports.TimeoutError = exports.LaraError = exports.LaraApiError = exports.Documents = exports.DocumentStatus = exports.Credentials = void 0;
 var credentials_1 = require("./credentials");
 Object.defineProperty(exports, "Credentials", { enumerable: true, get: function () { return credentials_1.Credentials; } });
+var documents_1 = require("./documents");
+Object.defineProperty(exports, "DocumentStatus", { enumerable: true, get: function () { return documents_1.DocumentStatus; } });
+Object.defineProperty(exports, "Documents", { enumerable: true, get: function () { return documents_1.Documents; } });
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "LaraApiError", { enumerable: true, get: function () { return errors_1.LaraApiError; } });
 Object.defineProperty(exports, "LaraError", { enumerable: true, get: function () { return errors_1.LaraError; } });
 Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function () { return errors_1.TimeoutError; } });
-var sdk_version_1 = require("./sdk-version");
-Object.defineProperty(exports, "version", { enumerable: true, get: function () { return sdk_version_1.version; } });
-var models_1 = require("./translator/models");
-Object.defineProperty(exports, "DocumentStatus", { enumerable: true, get: function () { return models_1.DocumentStatus; } });
-var translator_1 = require("./translator/translator");
-Object.defineProperty(exports, "Documents", { enumerable: true, get: function () { return translator_1.Documents; } });
-Object.defineProperty(exports, "Memories", { enumerable: true, get: function () { return translator_1.Memories; } });
+var glossaries_1 = require("./glossaries");
+Object.defineProperty(exports, "Glossaries", { enumerable: true, get: function () { return glossaries_1.Glossaries; } });
+var memories_1 = require("./memories");
+Object.defineProperty(exports, "Memories", { enumerable: true, get: function () { return memories_1.Memories; } });
+var translator_1 = require("./translator");
 Object.defineProperty(exports, "Translator", { enumerable: true, get: function () { return translator_1.Translator; } });
+var sdk_version_1 = require("./utils/sdk-version");
+Object.defineProperty(exports, "version", { enumerable: true, get: function () { return sdk_version_1.version; } });

package/lib/memories.d.ts

@@ -0,0 +1,38 @@
+import type { LaraClient } from "./net";
+import type { MultiPartFile } from "./net/client";
+export interface Memory {
+    readonly id: string;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly sharedAt: Date;
+    readonly name: string;
+    readonly externalId?: string;
+    readonly secret?: string;
+    readonly ownerId: string;
+    readonly collaboratorsCount: number;
+}
+export interface MemoryImport {
+    readonly id: string;
+    readonly begin: number;
+    readonly end: number;
+    readonly channel: number;
+    readonly size: number;
+    readonly progress: number;
+}
+export type MemoryImportCallback = (memoryImport: MemoryImport) => void;
+export declare class Memories {
+    private readonly client;
+    private readonly pollingInterval;
+    constructor(client: LaraClient);
+    list(): Promise<Memory[]>;
+    create(name: string, externalId?: string): Promise<Memory>;
+    get(id: string): Promise<Memory | null>;
+    delete(id: string): Promise<Memory>;
+    update(id: string, name: string): Promise<Memory>;
+    connect<T extends string | string[]>(ids: T): Promise<T extends string ? Memory : Memory[]>;
+    importTmx(id: string, tmx: MultiPartFile, gzip?: boolean): Promise<MemoryImport>;
+    addTranslation(id: string | string[], source: string, target: string, sentence: string, translation: string, tuid?: string, sentenceBefore?: string, sentenceAfter?: string, headers?: Record<string, string>): Promise<MemoryImport>;
+    deleteTranslation(id: string | string[], source: string, target: string, sentence?: string, translation?: string, tuid?: string, sentenceBefore?: string, sentenceAfter?: string): Promise<MemoryImport>;
+    getImportStatus(id: string): Promise<MemoryImport>;
+    waitForImport(mImport: MemoryImport, updateCallback?: MemoryImportCallback, maxWaitTime?: number): Promise<MemoryImport>;
+}

package/lib/memories.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Memories = void 0;
+const errors_1 = require("./errors");
+class Memories {
+    constructor(client) {
+        this.client = client;
+        this.pollingInterval = 2000;
+    }
+    async list() {
+        return await this.client.get("/memories");
+    }
+    async create(name, externalId) {
+        return await this.client.post("/memories", {
+            name,
+            external_id: externalId
+        });
+    }
+    async get(id) {
+        try {
+            return await this.client.get(`/memories/${id}`);
+        }
+        catch (e) {
+            if (e instanceof errors_1.LaraApiError && e.statusCode === 404) {
+                return null;
+            }
+            throw e;
+        }
+    }
+    async delete(id) {
+        return await this.client.delete(`/memories/${id}`);
+    }
+    async update(id, name) {
+        return await this.client.put(`/memories/${id}`, { name });
+    }
+    async connect(ids) {
+        const memories = await this.client.post("/memories/connect", {
+            ids: Array.isArray(ids) ? ids : [ids]
+        });
+        return (Array.isArray(ids) ? memories : memories[0]);
+    }
+    async importTmx(id, tmx, gzip = false) {
+        return await this.client.post(`/memories/${id}/import`, {
+            compression: gzip ? "gzip" : undefined
+        }, {
+            tmx
+        });
+    }
+    async addTranslation(id, source, target, sentence, translation, tuid, sentenceBefore, sentenceAfter, headers) {
+        const body = {
+            source,
+            target,
+            sentence,
+            translation,
+            tuid,
+            sentence_before: sentenceBefore,
+            sentence_after: sentenceAfter
+        };
+        if (Array.isArray(id)) {
+            body.ids = id;
+            return await this.client.put("/memories/content", body, undefined, headers);
+        }
+        else {
+            return await this.client.put(`/memories/${id}/content`, body, undefined, headers);
+        }
+    }
+    async deleteTranslation(id, source, target, sentence, translation, tuid, sentenceBefore, sentenceAfter) {
+        const body = {
+            source,
+            target,
+            sentence,
+            translation,
+            tuid,
+            sentence_before: sentenceBefore,
+            sentence_after: sentenceAfter
+        };
+        if (Array.isArray(id)) {
+            body.ids = id;
+            return await this.client.delete("/memories/content", body);
+        }
+        else {
+            return await this.client.delete(`/memories/${id}/content`, body);
+        }
+    }
+    async getImportStatus(id) {
+        return await this.client.get(`/memories/imports/${id}`);
+    }
+    async waitForImport(mImport, updateCallback, maxWaitTime) {
+        const start = Date.now();
+        while (mImport.progress < 1.0) {
+            if (maxWaitTime && Date.now() - start > maxWaitTime)
+                throw new errors_1.TimeoutError();
+            await new Promise((resolve) => setTimeout(resolve, this.pollingInterval));
+            mImport = await this.getImportStatus(mImport.id);
+            if (updateCallback)
+                updateCallback(mImport);
+        }
+        return mImport;
+    }
+}
+exports.Memories = Memories;

package/lib/net/client.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LaraClient = void 0;
 const crypto_1 = __importDefault(require("../crypto"));
 const errors_1 = require("../errors");
-const sdk_version_1 = require("../sdk-version");
+const sdk_version_1 = require("../utils/sdk-version");
 function parseContent(content) {
     if (content === undefined || content === null)
         return content;

package/lib/net/index.d.ts

@@ -1,3 +1,3 @@
 import type { LaraClient } from "./client";
 export { LaraClient } from "./client";
-export default function create(accessKeyId: string, accessKeySecret: string, baseUrl?: string): LaraClient;
+export default function create(accessKeyId: string, accessKeySecret: string, baseUrl?: string, keepAlive?: boolean): LaraClient;

package/lib/net/index.js

@@ -7,7 +7,7 @@ const node_client_1 = require("./node-client");
 var client_1 = require("./client");
 Object.defineProperty(exports, "LaraClient", { enumerable: true, get: function () { return client_1.LaraClient; } });
 const DEFAULT_BASE_URL = "https://api.laratranslate.com";
-function create(accessKeyId, accessKeySecret, baseUrl) {
+function create(accessKeyId, accessKeySecret, baseUrl, keepAlive) {
     const url = new URL(baseUrl || DEFAULT_BASE_URL);
     if (url.protocol !== "https:" && url.protocol !== "http:")
         throw new TypeError(`Invalid URL (protocol): ${url.protocol}`);
@@ -19,5 +19,5 @@ function create(accessKeyId, accessKeySecret, baseUrl) {
     if (typeof window !== "undefined")
         return new browser_client_1.BrowserLaraClient(parsedURL, accessKeyId, accessKeySecret);
     else
-        return new node_client_1.NodeLaraClient(parsedURL, accessKeyId, accessKeySecret);
+        return new node_client_1.NodeLaraClient(parsedURL, accessKeyId, accessKeySecret, keepAlive !== null && keepAlive !== void 0 ? keepAlive : true);
 }

package/lib/net/node-client.d.ts

@@ -4,7 +4,7 @@ import { type BaseURL, type ClientResponse, LaraClient, type MultiPartFile } fro
 export declare class NodeLaraClient extends LaraClient {
     private readonly baseUrl;
     private readonly agent;
-    constructor(baseUrl: BaseURL, accessKeyId: string, accessKeySecret: string);
+    constructor(baseUrl: BaseURL, accessKeyId: string, accessKeySecret: string, keepAlive?: boolean);
     protected send(path: string, headers: Record<string, string>, body?: Record<string, any>): Promise<ClientResponse>;
     protected wrapMultiPartFile(file: MultiPartFile): Readable;
 }

package/lib/net/node-client.js

@@ -12,10 +12,10 @@ const form_data_1 = __importDefault(require("form-data"));
 const client_1 = require("./client");
 /** @internal */
 class NodeLaraClient extends client_1.LaraClient {
-    constructor(baseUrl, accessKeyId, accessKeySecret) {
+    constructor(baseUrl, accessKeyId, accessKeySecret, keepAlive = true) {
         super(accessKeyId, accessKeySecret);
         this.baseUrl = baseUrl;
-        this.agent = baseUrl.secure ? new node_https_1.default.Agent({ keepAlive: true }) : new node_http_1.default.Agent({ keepAlive: true });
+        this.agent = baseUrl.secure ? new node_https_1.default.Agent({ keepAlive }) : new node_http_1.default.Agent({ keepAlive });
     }
     async send(path, headers, body) {
         let requestBody;
@@ -71,15 +71,24 @@ class NodeLaraClient extends client_1.LaraClient {
                         json = JSON.parse(data);
                     }
                     catch (_e) {
-                        reject(new SyntaxError("Invalid JSON response"));
+                        return reject(new SyntaxError("Invalid JSON response"));
                     }
                     resolve({
                         statusCode: res.statusCode,
                         body: json
                     });
                 });
+                // close connection on error
+                res.on("error", (err) => {
+                    req.destroy();
+                    return reject(err);
+                });
+            });
+            // close connection on error
+            req.on("error", (err) => {
+                req.destroy();
+                return reject(err);
             });
-            req.on("error", reject);
             if (requestBody instanceof form_data_1.default) {
                 requestBody.pipe(req);
             }

package/lib/net/s3/browser-client.d.ts

@@ -1,4 +1,4 @@
-import type { S3UploadFields } from "../../translator/translator";
+import type { S3UploadFields } from "../../documents";
 import type { MultiPartFile } from "../client";
 import { S3Client } from "./client";
 /** @internal */

package/lib/net/s3/client.d.ts

@@ -1,4 +1,4 @@
-import type { S3UploadFields } from "../../translator/translator";
+import type { S3UploadFields } from "../../documents";
 import type { MultiPartFile } from "../client";
 /** @internal */
 export declare abstract class S3Client {

package/lib/net/s3/node-client.d.ts

@@ -1,5 +1,5 @@
 import { Readable } from "node:stream";
-import type { S3UploadFields } from "../../translator/translator";
+import type { S3UploadFields } from "../../documents";
 import type { MultiPartFile } from "../client";
 import { S3Client } from "./client";
 /** @internal */

package/lib/translator.d.ts

@@ -0,0 +1,67 @@
+import type { Credentials } from "./credentials";
+import { Documents } from "./documents";
+import { Glossaries } from "./glossaries";
+import { Memories } from "./memories";
+import { type LaraClient } from "./net";
+export type TranslatorOptions = {
+    serverUrl?: string;
+    keepAlive?: boolean;
+};
+export interface NGMemoryMatch {
+    memory: string;
+    tuid?: string;
+    language: [string, string];
+    sentence: string;
+    translation: string;
+    score: number;
+}
+export interface NGGlossaryMatch {
+    glossary: string;
+    language: [string, string];
+    term: string;
+    translation: string;
+}
+export interface TextBlock {
+    readonly text: string;
+    readonly translatable?: boolean;
+}
+export interface TextResult<T extends string | string[] | TextBlock[]> {
+    readonly contentType: string;
+    readonly sourceLanguage: string;
+    readonly translation: T;
+    readonly adaptedTo?: string[];
+    readonly glossaries?: string[];
+    readonly adaptedToMatches?: NGMemoryMatch[] | NGMemoryMatch[][];
+    readonly glossariesMatches?: NGGlossaryMatch[] | NGGlossaryMatch[][];
+}
+export type TranslateOptions = {
+    sourceHint?: string;
+    adaptTo?: string[];
+    instructions?: string[];
+    glossaries?: string[];
+    contentType?: string;
+    multiline?: boolean;
+    timeoutInMillis?: number;
+    priority?: "normal" | "background";
+    useCache?: boolean | "overwrite";
+    cacheTTLSeconds?: number;
+    noTrace?: boolean;
+    verbose?: boolean;
+    headers?: Record<string, string>;
+    style?: TranslationStyle;
+};
+export type TranslationStyle = "faithful" | "fluid" | "creative";
+export interface DetectResult {
+    language: string;
+    contentType: string;
+}
+export declare class Translator {
+    protected readonly client: LaraClient;
+    readonly memories: Memories;
+    readonly documents: Documents;
+    readonly glossaries: Glossaries;
+    constructor(credentials: Credentials, options?: TranslatorOptions);
+    getLanguages(): Promise<string[]>;
+    translate<T extends string | string[] | TextBlock[]>(text: T, source: string | null, target: string, options?: TranslateOptions): Promise<TextResult<T>>;
+    detect(text: string | string[], hint?: string, passlist?: string[]): Promise<DetectResult>;
+}

package/lib/translator.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Translator = void 0;
+const documents_1 = require("./documents");
+const glossaries_1 = require("./glossaries");
+const memories_1 = require("./memories");
+const net_1 = __importDefault(require("./net"));
+class Translator {
+    constructor(credentials, options) {
+        this.client = (0, net_1.default)(credentials.accessKeyId, credentials.accessKeySecret, options === null || options === void 0 ? void 0 : options.serverUrl, options === null || options === void 0 ? void 0 : options.keepAlive);
+        this.memories = new memories_1.Memories(this.client);
+        this.documents = new documents_1.Documents(this.client);
+        this.glossaries = new glossaries_1.Glossaries(this.client);
+    }
+    async getLanguages() {
+        return await this.client.get("/languages");
+    }
+    async translate(text, source, target, options) {
+        const headers = {};
+        if (options === null || options === void 0 ? void 0 : options.headers) {
+            for (const [name, value] of Object.entries(options.headers)) {
+                headers[name] = value;
+            }
+        }
+        if (options === null || options === void 0 ? void 0 : options.noTrace) {
+            headers["X-No-Trace"] = "true";
+        }
+        return await this.client.post("/translate", {
+            q: text,
+            source,
+            target,
+            source_hint: options === null || options === void 0 ? void 0 : options.sourceHint,
+            content_type: options === null || options === void 0 ? void 0 : options.contentType,
+            multiline: (options === null || options === void 0 ? void 0 : options.multiline) !== false,
+            adapt_to: options === null || options === void 0 ? void 0 : options.adaptTo,
+            glossaries: options === null || options === void 0 ? void 0 : options.glossaries,
+            instructions: options === null || options === void 0 ? void 0 : options.instructions,
+            timeout: options === null || options === void 0 ? void 0 : options.timeoutInMillis,
+            priority: options === null || options === void 0 ? void 0 : options.priority,
+            use_cache: options === null || options === void 0 ? void 0 : options.useCache,
+            cache_ttl: options === null || options === void 0 ? void 0 : options.cacheTTLSeconds,
+            verbose: options === null || options === void 0 ? void 0 : options.verbose,
+            style: options === null || options === void 0 ? void 0 : options.style
+        }, undefined, headers);
+    }
+    async detect(text, hint, passlist) {
+        return await this.client.post("/detect", {
+            q: text,
+            hint,
+            passlist
+        });
+    }
+}
+exports.Translator = Translator;

package/lib/utils/sdk-version.d.ts

@@ -0,0 +1 @@
+export declare const version = "1.7.1";

package/lib/{sdk-version.js → utils/sdk-version.js}

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = "1.7.0";
+exports.version = "1.7.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@translated/lara",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "engines": {
@@ -8,7 +8,7 @@
   },
   "scripts": {
     "build": "rm -rf lib/* lib-browser/* && node scripts/generate-sdk-version.js && tsc && webpack",
-    "version": "node scripts/generate-sdk-version.js && git add src/sdk-version.ts",
+    "version": "node scripts/generate-sdk-version.js && git add src/utils/sdk-version.ts",
     "biome:check": "biome check",
     "biome:write": "biome check --write"
   },

package/lib/sdk-version.d.ts

@@ -1 +0,0 @@
-export declare const version = "1.7.0";

package/lib/translator/models.d.ts

@@ -1,109 +0,0 @@
-export interface Memory {
-    readonly id: string;
-    readonly createdAt: Date;
-    readonly updatedAt: Date;
-    readonly sharedAt: Date;
-    readonly name: string;
-    readonly externalId?: string;
-    readonly secret?: string;
-    readonly ownerId: string;
-    readonly collaboratorsCount: number;
-}
-export interface MemoryImport {
-    readonly id: string;
-    readonly begin: number;
-    readonly end: number;
-    readonly channel: number;
-    readonly size: number;
-    readonly progress: number;
-}
-export declare enum DocumentStatus {
-    INITIALIZED = "initialized",// just been created
-    ANALYZING = "analyzing",// being analyzed for language detection and chars count
-    PAUSED = "paused",// paused after analysis, needs user confirm
-    READY = "ready",// ready to be translated
-    TRANSLATING = "translating",
-    TRANSLATED = "translated",
-    ERROR = "error"
-}
-export interface DocxExtractionParams {
-    extractComments?: boolean;
-    acceptRevisions?: boolean;
-}
-export type DocumentOptions = {
-    adaptTo?: string[];
-    glossaries?: string[];
-    noTrace?: boolean;
-    style?: TranslationStyle;
-};
-export type DocumentDownloadOptions = {
-    outputFormat?: string;
-};
-export type DocumentUploadOptions = DocumentOptions & {
-    password?: string;
-    extractionParams?: DocxExtractionParams;
-};
-export interface Document {
-    readonly id: string;
-    readonly status: DocumentStatus;
-    readonly source?: string;
-    readonly target: string;
-    readonly filename: string;
-    readonly createdAt: Date;
-    readonly updatedAt: Date;
-    readonly options?: DocumentOptions;
-    readonly translatedChars?: number;
-    readonly totalChars?: number;
-    readonly errorReason?: string;
-}
-export interface TextBlock {
-    readonly text: string;
-    readonly translatable?: boolean;
-}
-export interface NGMemoryMatch {
-    memory: string;
-    tuid?: string;
-    language: [string, string];
-    sentence: string;
-    translation: string;
-    score: number;
-}
-export interface NGGlossaryMatch {
-    glossary: string;
-    language: [string, string];
-    term: string;
-    translation: string;
-}
-export interface TextResult<T extends string | string[] | TextBlock[]> {
-    readonly contentType: string;
-    readonly sourceLanguage: string;
-    readonly translation: T;
-    readonly adaptedTo?: string[];
-    readonly glossaries?: string[];
-    readonly adaptedToMatches?: NGMemoryMatch[] | NGMemoryMatch[][];
-    readonly glossariesMatches?: NGGlossaryMatch[] | NGGlossaryMatch[][];
-}
-export interface DetectResult {
-    language: string;
-    contentType: string;
-}
-export interface Glossary {
-    readonly id: string;
-    readonly name: string;
-    readonly ownerId: string;
-    readonly createdAt: Date;
-    readonly updatedAt: Date;
-}
-export interface GlossaryImport {
-    readonly id: string;
-    readonly begin: number;
-    readonly end: number;
-    readonly channel: number;
-    readonly size: number;
-    readonly progress: number;
-}
-export interface GlossaryCounts {
-    unidirectional?: Record<string, number>;
-    multidirectional?: number;
-}
-export type TranslationStyle = "faithful" | "fluid" | "creative";

package/lib/translator/models.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentStatus = void 0;
-// biome-ignore format: keep comments aligned
-var DocumentStatus;
-(function (DocumentStatus) {
-    DocumentStatus["INITIALIZED"] = "initialized";
-    DocumentStatus["ANALYZING"] = "analyzing";
-    DocumentStatus["PAUSED"] = "paused";
-    DocumentStatus["READY"] = "ready";
-    DocumentStatus["TRANSLATING"] = "translating";
-    DocumentStatus["TRANSLATED"] = "translated";
-    DocumentStatus["ERROR"] = "error";
-})(DocumentStatus || (exports.DocumentStatus = DocumentStatus = {}));

package/lib/translator/translator.d.ts

@@ -1,81 +0,0 @@
-import type { Credentials } from "../credentials";
-import { type LaraClient } from "../net";
-import type { MultiPartFile } from "../net/client";
-import { type DetectResult, type Document, type DocumentDownloadOptions, type DocumentUploadOptions, type Glossary, type GlossaryCounts, type GlossaryImport, type Memory, type MemoryImport, type TextBlock, type TextResult, type TranslationStyle } from "./models";
-export type TranslatorOptions = {
-    serverUrl?: string;
-};
-export type MemoryImportCallback = (memoryImport: MemoryImport) => void;
-export declare class Memories {
-    private readonly client;
-    private readonly pollingInterval;
-    constructor(client: LaraClient);
-    list(): Promise<Memory[]>;
-    create(name: string, externalId?: string): Promise<Memory>;
-    get(id: string): Promise<Memory | null>;
-    delete(id: string): Promise<Memory>;
-    update(id: string, name: string): Promise<Memory>;
-    connect<T extends string | string[]>(ids: T): Promise<T extends string ? Memory : Memory[]>;
-    importTmx(id: string, tmx: MultiPartFile, gzip?: boolean): Promise<MemoryImport>;
-    addTranslation(id: string | string[], source: string, target: string, sentence: string, translation: string, tuid?: string, sentenceBefore?: string, sentenceAfter?: string, headers?: Record<string, string>): Promise<MemoryImport>;
-    deleteTranslation(id: string | string[], source: string, target: string, sentence?: string, translation?: string, tuid?: string, sentenceBefore?: string, sentenceAfter?: string): Promise<MemoryImport>;
-    getImportStatus(id: string): Promise<MemoryImport>;
-    waitForImport(mImport: MemoryImport, updateCallback?: MemoryImportCallback, maxWaitTime?: number): Promise<MemoryImport>;
-}
-export type TranslateOptions = {
-    sourceHint?: string;
-    adaptTo?: string[];
-    instructions?: string[];
-    glossaries?: string[];
-    contentType?: string;
-    multiline?: boolean;
-    timeoutInMillis?: number;
-    priority?: "normal" | "background";
-    useCache?: boolean | "overwrite";
-    cacheTTLSeconds?: number;
-    noTrace?: boolean;
-    verbose?: boolean;
-    headers?: Record<string, string>;
-    style?: TranslationStyle;
-};
-export type DocumentTranslateOptions = DocumentUploadOptions & DocumentDownloadOptions;
-export type S3UploadFields = {
-    acl: string;
-    bucket: string;
-    key: string;
-};
-export declare class Documents {
-    private readonly client;
-    private readonly s3Client;
-    constructor(client: LaraClient);
-    upload(file: MultiPartFile, filename: string, source: string | null, target: string, options?: DocumentUploadOptions): Promise<Document>;
-    status(id: string): Promise<Document>;
-    download(id: string, options?: DocumentDownloadOptions): Promise<Blob | Buffer>;
-    translate(file: MultiPartFile, filename: string, source: string | null, target: string, options?: DocumentTranslateOptions): Promise<Blob | Buffer>;
-}
-export type GlossaryImportCallback = (glossaryImport: GlossaryImport) => void;
-export declare class Glossaries {
-    private readonly client;
-    private readonly pollingInterval;
-    constructor(client: LaraClient);
-    list(): Promise<Glossary[]>;
-    create(name: string): Promise<Glossary>;
-    get(id: string): Promise<Glossary | null>;
-    delete(id: string): Promise<Glossary>;
-    update(id: string, name: string): Promise<Glossary>;
-    importCsv(id: string, csv: MultiPartFile, gzip?: boolean): Promise<GlossaryImport>;
-    getImportStatus(id: string): Promise<GlossaryImport>;
-    waitForImport(gImport: GlossaryImport, updateCallback?: GlossaryImportCallback, maxWaitTime?: number): Promise<GlossaryImport>;
-    counts(id: string): Promise<GlossaryCounts>;
-    export(id: string, contentType: "csv/table-uni", source?: string): Promise<string>;
-}
-export declare class Translator {
-    protected readonly client: LaraClient;
-    readonly memories: Memories;
-    readonly documents: Documents;
-    readonly glossaries: Glossaries;
-    constructor(credentials: Credentials, options?: TranslatorOptions);
-    getLanguages(): Promise<string[]>;
-    translate<T extends string | string[] | TextBlock[]>(text: T, source: string | null, target: string, options?: TranslateOptions): Promise<TextResult<T>>;
-    detect(text: string | string[], hint?: string, passlist?: string[]): Promise<DetectResult>;
-}

package/lib/translator/translator.js

@@ -1,272 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Translator = exports.Glossaries = exports.Documents = exports.Memories = void 0;
-const errors_1 = require("../errors");
-const net_1 = __importDefault(require("../net"));
-const s3_1 = __importDefault(require("../net/s3"));
-const toSnakeCase_1 = __importDefault(require("../utils/toSnakeCase"));
-const models_1 = require("./models");
-class Memories {
-    constructor(client) {
-        this.client = client;
-        this.pollingInterval = 2000;
-    }
-    async list() {
-        return await this.client.get("/memories");
-    }
-    async create(name, externalId) {
-        return await this.client.post("/memories", {
-            name,
-            external_id: externalId
-        });
-    }
-    async get(id) {
-        try {
-            return await this.client.get(`/memories/${id}`);
-        }
-        catch (e) {
-            if (e instanceof errors_1.LaraApiError && e.statusCode === 404) {
-                return null;
-            }
-            throw e;
-        }
-    }
-    async delete(id) {
-        return await this.client.delete(`/memories/${id}`);
-    }
-    async update(id, name) {
-        return await this.client.put(`/memories/${id}`, { name });
-    }
-    async connect(ids) {
-        const memories = await this.client.post("/memories/connect", {
-            ids: Array.isArray(ids) ? ids : [ids]
-        });
-        return (Array.isArray(ids) ? memories : memories[0]);
-    }
-    async importTmx(id, tmx, gzip = false) {
-        return await this.client.post(`/memories/${id}/import`, {
-            compression: gzip ? "gzip" : undefined
-        }, {
-            tmx
-        });
-    }
-    async addTranslation(id, source, target, sentence, translation, tuid, sentenceBefore, sentenceAfter, headers) {
-        const body = {
-            source,
-            target,
-            sentence,
-            translation,
-            tuid,
-            sentence_before: sentenceBefore,
-            sentence_after: sentenceAfter
-        };
-        if (Array.isArray(id)) {
-            body.ids = id;
-            return await this.client.put("/memories/content", body, undefined, headers);
-        }
-        else {
-            return await this.client.put(`/memories/${id}/content`, body, undefined, headers);
-        }
-    }
-    async deleteTranslation(id, source, target, sentence, translation, tuid, sentenceBefore, sentenceAfter) {
-        const body = {
-            source,
-            target,
-            sentence,
-            translation,
-            tuid,
-            sentence_before: sentenceBefore,
-            sentence_after: sentenceAfter
-        };
-        if (Array.isArray(id)) {
-            body.ids = id;
-            return await this.client.delete("/memories/content", body);
-        }
-        else {
-            return await this.client.delete(`/memories/${id}/content`, body);
-        }
-    }
-    async getImportStatus(id) {
-        return await this.client.get(`/memories/imports/${id}`);
-    }
-    async waitForImport(mImport, updateCallback, maxWaitTime) {
-        const start = Date.now();
-        while (mImport.progress < 1.0) {
-            if (maxWaitTime && Date.now() - start > maxWaitTime)
-                throw new errors_1.TimeoutError();
-            await new Promise((resolve) => setTimeout(resolve, this.pollingInterval));
-            mImport = await this.getImportStatus(mImport.id);
-            if (updateCallback)
-                updateCallback(mImport);
-        }
-        return mImport;
-    }
-}
-exports.Memories = Memories;
-class Documents {
-    constructor(client) {
-        this.client = client;
-        this.s3Client = (0, s3_1.default)();
-    }
-    async upload(file, filename, source, target, options) {
-        const { url, fields } = await this.client.get(`/documents/upload-url`, { filename });
-        await this.s3Client.upload(url, fields, file);
-        const headers = (options === null || options === void 0 ? void 0 : options.noTrace) ? { "X-No-Trace": "true" } : {};
-        return this.client.post("/documents", {
-            source,
-            target,
-            s3key: fields.key,
-            adapt_to: options === null || options === void 0 ? void 0 : options.adaptTo,
-            glossaries: options === null || options === void 0 ? void 0 : options.glossaries,
-            style: options === null || options === void 0 ? void 0 : options.style,
-            password: options === null || options === void 0 ? void 0 : options.password,
-            extraction_params: (options === null || options === void 0 ? void 0 : options.extractionParams) ? (0, toSnakeCase_1.default)(options.extractionParams) : undefined
-        }, undefined, headers);
-    }
-    async status(id) {
-        return await this.client.get(`/documents/${id}`);
-    }
-    async download(id, options) {
-        const { url } = await this.client.get(`/documents/${id}/download-url`, {
-            output_format: options === null || options === void 0 ? void 0 : options.outputFormat
-        });
-        return await this.s3Client.download(url);
-    }
-    async translate(file, filename, source, target, options) {
-        const uploadOptions = {
-            adaptTo: options === null || options === void 0 ? void 0 : options.adaptTo,
-            glossaries: options === null || options === void 0 ? void 0 : options.glossaries,
-            noTrace: options === null || options === void 0 ? void 0 : options.noTrace,
-            style: options === null || options === void 0 ? void 0 : options.style,
-            password: options === null || options === void 0 ? void 0 : options.password,
-            extractionParams: options === null || options === void 0 ? void 0 : options.extractionParams
-        };
-        const { id } = await this.upload(file, filename, source, target, uploadOptions);
-        const downloadOptions = (options === null || options === void 0 ? void 0 : options.outputFormat) ? { outputFormat: options.outputFormat } : undefined;
-        const pollingInterval = 2000;
-        const maxWaitTime = 1000 * 60 * 15; // 15 minutes
-        const start = Date.now();
-        while (Date.now() - start < maxWaitTime) {
-            await new Promise((resolve) => setTimeout(resolve, pollingInterval));
-            const { status, errorReason } = await this.status(id);
-            if (status === models_1.DocumentStatus.TRANSLATED)
-                return await this.download(id, downloadOptions);
-            if (status === models_1.DocumentStatus.ERROR) {
-                throw new errors_1.LaraApiError(500, "DocumentError", errorReason);
-            }
-        }
-        throw new errors_1.TimeoutError();
-    }
-}
-exports.Documents = Documents;
-class Glossaries {
-    constructor(client) {
-        this.client = client;
-        this.pollingInterval = 2000;
-    }
-    async list() {
-        return await this.client.get("/glossaries");
-    }
-    async create(name) {
-        return await this.client.post("/glossaries", { name });
-    }
-    async get(id) {
-        try {
-            return await this.client.get(`/glossaries/${id}`);
-        }
-        catch (e) {
-            if (e instanceof errors_1.LaraApiError && e.statusCode === 404) {
-                return null;
-            }
-            throw e;
-        }
-    }
-    async delete(id) {
-        return await this.client.delete(`/glossaries/${id}`);
-    }
-    async update(id, name) {
-        return await this.client.put(`/glossaries/${id}`, { name });
-    }
-    async importCsv(id, csv, gzip = false) {
-        return await this.client.post(`/glossaries/${id}/import`, {
-            compression: gzip ? "gzip" : undefined
-        }, {
-            csv
-        });
-    }
-    async getImportStatus(id) {
-        return await this.client.get(`/glossaries/imports/${id}`);
-    }
-    async waitForImport(gImport, updateCallback, maxWaitTime) {
-        const start = Date.now();
-        while (gImport.progress < 1.0) {
-            if (maxWaitTime && Date.now() - start > maxWaitTime)
-                throw new errors_1.TimeoutError();
-            await new Promise((resolve) => setTimeout(resolve, this.pollingInterval));
-            gImport = await this.getImportStatus(gImport.id);
-            if (updateCallback)
-                updateCallback(gImport);
-        }
-        return gImport;
-    }
-    async counts(id) {
-        return await this.client.get(`/glossaries/${id}/counts`);
-    }
-    async export(id, contentType, source) {
-        return await this.client.get(`/glossaries/${id}/export`, {
-            content_type: contentType,
-            source
-        });
-    }
-}
-exports.Glossaries = Glossaries;
-class Translator {
-    constructor(credentials, options) {
-        this.client = (0, net_1.default)(credentials.accessKeyId, credentials.accessKeySecret, options === null || options === void 0 ? void 0 : options.serverUrl);
-        this.memories = new Memories(this.client);
-        this.documents = new Documents(this.client);
-        this.glossaries = new Glossaries(this.client);
-    }
-    async getLanguages() {
-        return await this.client.get("/languages");
-    }
-    async translate(text, source, target, options) {
-        const headers = {};
-        if (options === null || options === void 0 ? void 0 : options.headers) {
-            for (const [name, value] of Object.entries(options.headers)) {
-                headers[name] = value;
-            }
-        }
-        if (options === null || options === void 0 ? void 0 : options.noTrace) {
-            headers["X-No-Trace"] = "true";
-        }
-        return await this.client.post("/translate", {
-            q: text,
-            source,
-            target,
-            source_hint: options === null || options === void 0 ? void 0 : options.sourceHint,
-            content_type: options === null || options === void 0 ? void 0 : options.contentType,
-            multiline: (options === null || options === void 0 ? void 0 : options.multiline) !== false,
-            adapt_to: options === null || options === void 0 ? void 0 : options.adaptTo,
-            glossaries: options === null || options === void 0 ? void 0 : options.glossaries,
-            instructions: options === null || options === void 0 ? void 0 : options.instructions,
-            timeout: options === null || options === void 0 ? void 0 : options.timeoutInMillis,
-            priority: options === null || options === void 0 ? void 0 : options.priority,
-            use_cache: options === null || options === void 0 ? void 0 : options.useCache,
-            cache_ttl: options === null || options === void 0 ? void 0 : options.cacheTTLSeconds,
-            verbose: options === null || options === void 0 ? void 0 : options.verbose,
-            style: options === null || options === void 0 ? void 0 : options.style
-        }, undefined, headers);
-    }
-    async detect(text, hint, passlist) {
-        return await this.client.post("/detect", {
-            q: text,
-            hint,
-            passlist
-        });
-    }
-}
-exports.Translator = Translator;