@translated/lara 1.5.5 → 1.6.0

package/lib/sdk-version.d.ts

@@ -1 +1 @@
-export declare const version = "1.5.5";
+export declare const version = "1.6.0";

package/lib/sdk-version.js

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

package/lib/translator/models.d.ts

@@ -28,6 +28,7 @@ export declare enum DocumentStatus {
 }
 export type DocumentUploadOptions = {
     adaptTo?: string[];
+    glossaries?: string[];
     noTrace?: boolean;
 };
 export type DocumentDownloadOptions = {
@@ -58,3 +59,22 @@ export interface TextResult<T extends string | string[] | TextBlock[]> {
     readonly translation: T;
     readonly adaptedTo?: 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;
+}

package/lib/translator/translator.d.ts

@@ -1,6 +1,6 @@
 import { Credentials } from "../credentials";
 import { LaraClient } from "../net";
-import { Document, DocumentDownloadOptions, DocumentUploadOptions, Memory, MemoryImport, TextBlock, TextResult } from "./models";
+import { Document, DocumentDownloadOptions, DocumentUploadOptions, Glossary, GlossaryCounts, GlossaryImport, Memory, MemoryImport, TextBlock, TextResult } from "./models";
 import { MultiPartFile } from "../net/client";
 export type TranslatorOptions = {
     serverUrl?: string;
@@ -26,6 +26,7 @@ export type TranslateOptions = {
     sourceHint?: string;
     adaptTo?: string[];
     instructions?: string[];
+    glossaries?: string[];
     contentType?: string;
     multiline?: boolean;
     timeoutInMillis?: number;
@@ -33,6 +34,7 @@ export type TranslateOptions = {
     useCache?: boolean | "overwrite";
     cacheTTLSeconds?: number;
     noTrace?: boolean;
+    verbose?: boolean;
 };
 export type DocumentTranslateOptions = DocumentUploadOptions & DocumentDownloadOptions;
 export type S3UploadFields = {
@@ -49,10 +51,27 @@ export declare class Documents {
     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>>;

package/lib/translator/translator.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Translator = exports.Documents = exports.Memories = void 0;
+exports.Translator = exports.Glossaries = exports.Documents = exports.Memories = void 0;
 const net_1 = __importDefault(require("../net"));
 const s3_1 = __importDefault(require("../net/s3"));
 const models_1 = require("./models");
@@ -118,6 +118,7 @@ class Documents {
             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,
         }, undefined, headers);
     }
     async status(id) {
@@ -132,6 +133,7 @@ class Documents {
     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
         };
         const { id } = await this.upload(file, filename, source, target, uploadOptions);
@@ -152,11 +154,73 @@ class Documents {
     }
 }
 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.) {
+            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");
@@ -166,9 +230,10 @@ class Translator {
         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, instructions: options === null || options === void 0 ? void 0 : options.instructions,
+            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
+            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,
         }, undefined, headers);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@translated/lara",
-  "version": "1.5.5",
+  "version": "1.6.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "engines": {