@translated/lara 1.4.0 → 1.5.0

package/README.md

@@ -1,3 +1,7 @@
 # Lara Node.js Library
 
-This library is a Node.js library for the Lara platform. It provides a simple way to interact with the Lara API.
+This SDK empowers you to build your own branded translation AI leveraging our translation fine-tuned language model. 
+
+All major translation features are accessible, making it easy to integrate and customize for your needs. 
+
+Lara’s SDK full documentation is available at https://developers.laratranslate.com/

package/lib/crypto/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = instance;
 const browser_crypto_1 = require("./browser-crypto");
 const node_crypto_1 = require("./node-crypto");
 let _instance = undefined;
@@ -12,4 +13,3 @@ function instance() {
     }
     return _instance;
 }
-exports.default = instance;

package/lib/crypto/node-crypto.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeCrypto = void 0;
 const crypto = __importStar(require("crypto"));

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 export { version } from "./sdk-version";
 export { Credentials } from "./credentials";
 export { LaraError, TimeoutError, LaraApiError } from "./errors";
-export { Translator, TranslatorOptions, Memories, MemoryImportCallback, TranslateOptions } from "./translator/translator";
-export { Memory, MemoryImport, TextBlock, TextResult } from "./translator/models";
+export { Translator, TranslatorOptions, Memories, MemoryImportCallback, TranslateOptions, Documents, DocumentTranslateOptions } from "./translator/translator";
+export { Memory, MemoryImport, TextBlock, TextResult, Document, DocumentUploadOptions, DocumentDownloadOptions } from "./translator/models";
 export { MultiPartFile } from "./net/client";

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Memories = exports.Translator = exports.LaraApiError = exports.TimeoutError = exports.LaraError = exports.Credentials = exports.version = void 0;
+exports.Documents = exports.Memories = exports.Translator = exports.LaraApiError = exports.TimeoutError = exports.LaraError = exports.Credentials = exports.version = void 0;
 var sdk_version_1 = require("./sdk-version");
 Object.defineProperty(exports, "version", { enumerable: true, get: function () { return sdk_version_1.version; } });
 var credentials_1 = require("./credentials");
@@ -12,3 +12,4 @@ Object.defineProperty(exports, "LaraApiError", { enumerable: true, get: function
 var translator_1 = require("./translator/translator");
 Object.defineProperty(exports, "Translator", { enumerable: true, get: function () { return translator_1.Translator; } });
 Object.defineProperty(exports, "Memories", { enumerable: true, get: function () { return translator_1.Memories; } });
+Object.defineProperty(exports, "Documents", { enumerable: true, get: function () { return translator_1.Documents; } });

package/lib/net/client.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Readable } from "node:stream";
 type HttpMethod = "GET" | "POST" | "PUT" | "DELETE";
 /** @internal */

package/lib/net/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LaraClient = void 0;
+exports.default = create;
 const browser_client_1 = require("./browser-client");
 const node_client_1 = require("./node-client");
 var client_1 = require("./client");
@@ -20,4 +21,3 @@ function create(accessKeyId, accessKeySecret, baseUrl) {
     else
         return new node_client_1.NodeLaraClient(parsedURL, accessKeyId, accessKeySecret);
 }
-exports.default = create;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { BaseURL, ClientResponse, LaraClient, MultiPartFile } from "./client";
 import { Readable } from "stream";
 /** @internal */

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

@@ -0,0 +1,10 @@
+import { S3Client } from "./client";
+import { S3UploadFields } from "../../translator/translator";
+import { MultiPartFile } from "../client";
+/** @internal */
+export declare class BrowserS3Client extends S3Client {
+    constructor();
+    _upload(url: string, fields: S3UploadFields, file: File): Promise<void>;
+    download(url: string): Promise<Blob>;
+    wrapMultiPartFile(file: MultiPartFile): File;
+}

package/lib/net/s3/browser-client.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserS3Client = void 0;
+const client_1 = require("./client");
+/** @internal */
+class BrowserS3Client extends client_1.S3Client {
+    constructor() {
+        super();
+    }
+    async _upload(url, fields, file) {
+        const formdata = new FormData();
+        for (const [key, value] of Object.entries(fields)) {
+            formdata.append(key, value);
+        }
+        formdata.append("file", file);
+        await fetch(url, {
+            method: 'POST',
+            body: formdata,
+        });
+    }
+    async download(url) {
+        const response = await fetch(url);
+        return response.blob();
+    }
+    wrapMultiPartFile(file) {
+        if (file instanceof File)
+            return file;
+        throw new TypeError(`Invalid file input in the browser. Expected an instance of File but received ${typeof file}.`);
+    }
+}
+exports.BrowserS3Client = BrowserS3Client;

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

@@ -0,0 +1,9 @@
+import { S3UploadFields } from "../../translator/translator";
+import { MultiPartFile } from "../client";
+/** @internal */
+export declare abstract class S3Client {
+    upload(url: string, fields: S3UploadFields, file: MultiPartFile): Promise<void>;
+    protected abstract _upload(url: string, fields: S3UploadFields, file: any): Promise<void>;
+    protected abstract download(url: string): Promise<Blob | Buffer>;
+    protected abstract wrapMultiPartFile(file: MultiPartFile): any;
+}

package/lib/net/s3/client.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S3Client = void 0;
+/** @internal */
+class S3Client {
+    async upload(url, fields, file) {
+        return this._upload(url, fields, this.wrapMultiPartFile(file));
+    }
+}
+exports.S3Client = S3Client;

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

@@ -0,0 +1,3 @@
+import { BrowserS3Client } from "./browser-client";
+import { NodeS3Client } from "./node-client";
+export default function create(): BrowserS3Client | NodeS3Client;

package/lib/net/s3/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = create;
+const browser_client_1 = require("./browser-client");
+const node_client_1 = require("./node-client");
+function create() {
+    if (typeof window !== "undefined") {
+        return new browser_client_1.BrowserS3Client();
+    }
+    else {
+        return new node_client_1.NodeS3Client();
+    }
+}

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

@@ -0,0 +1,10 @@
+import { S3Client } from "./client";
+import { Readable } from "stream";
+import { S3UploadFields } from "../../translator/translator";
+import { MultiPartFile } from "../client";
+/** @internal */
+export declare class NodeS3Client extends S3Client {
+    protected _upload(url: string, fields: S3UploadFields, file: Readable): Promise<void>;
+    download(url: string): Promise<Buffer>;
+    wrapMultiPartFile(file: MultiPartFile): Readable;
+}

package/lib/net/s3/node-client.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeS3Client = void 0;
+const client_1 = require("./client");
+const stream_1 = require("stream");
+const form_data_1 = __importDefault(require("form-data"));
+const https_1 = __importDefault(require("https"));
+const fs_1 = __importDefault(require("fs"));
+/** @internal */
+class NodeS3Client extends client_1.S3Client {
+    async _upload(url, fields, file) {
+        const formData = new form_data_1.default();
+        for (const [key, value] of Object.entries(fields)) {
+            formData.append(key, value);
+        }
+        formData.append("file", file);
+        return new Promise((resolve, reject) => {
+            formData.submit(url, (err) => {
+                if (err)
+                    return reject(err);
+                resolve();
+            });
+        });
+    }
+    async download(url) {
+        return new Promise((resolve, reject) => {
+            const req = https_1.default.request(url, { method: 'GET' }, (res) => {
+                const chunks = [];
+                res.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
+                res.on('end', () => resolve(Buffer.concat(chunks)));
+            });
+            req.on('error', reject);
+            req.end();
+        });
+    }
+    wrapMultiPartFile(file) {
+        if (typeof file === 'string')
+            file = fs_1.default.createReadStream(file);
+        if (file instanceof stream_1.Readable)
+            return file;
+        throw new TypeError(`Invalid file input in Node.js. Expected a Readable stream or a valid file path, but received ${typeof file}.`);
+    }
+}
+exports.NodeS3Client = NodeS3Client;

package/lib/sdk-version.d.ts

@@ -1 +1 @@
-export declare const version = "1.4.0";
+export declare const version = "1.5.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.4.0";
+exports.version = "1.5.0";

package/lib/translator/models.d.ts

@@ -17,6 +17,36 @@ export interface MemoryImport {
     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 type DocumentUploadOptions = {
+    adaptTo?: string[];
+};
+export type DocumentDownloadOptions = {
+    outputFormat?: string;
+};
+export interface DocumentOptions extends DocumentUploadOptions {
+}
+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;

package/lib/translator/models.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentStatus = void 0;
+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,6 +1,6 @@
 import { Credentials } from "../credentials";
 import { LaraClient } from "../net";
-import { Memory, MemoryImport, TextBlock, TextResult } from "./models";
+import { Document, DocumentDownloadOptions, DocumentUploadOptions, Memory, MemoryImport, TextBlock, TextResult } from "./models";
 import { MultiPartFile } from "../net/client";
 export type TranslatorOptions = {
     serverUrl?: string;
@@ -33,9 +33,25 @@ export type TranslateOptions = {
     useCache?: boolean | "overwrite";
     cacheTTLSeconds?: number;
 };
+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<ArrayBufferLike>>;
+    translate(file: MultiPartFile, filename: string, source: string | null, target: string, options?: DocumentTranslateOptions): Promise<Blob | Buffer<ArrayBufferLike>>;
+}
 export declare class Translator {
     protected readonly client: LaraClient;
     readonly memories: Memories;
+    readonly documents: Documents;
     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,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Translator = exports.Memories = void 0;
+exports.Translator = exports.Documents = exports.Memories = void 0;
 const net_1 = __importDefault(require("../net"));
+const s3_1 = __importDefault(require("../net/s3"));
+const models_1 = require("./models");
 const errors_1 = require("../errors");
 class Memories {
     constructor(client) {
@@ -102,10 +104,55 @@ class Memories {
     }
 }
 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);
+        return this.client.post('/documents', {
+            source,
+            target,
+            s3key: fields.key,
+            adapt_to: options === null || options === void 0 ? void 0 : options.adaptTo,
+        });
+    }
+    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 = (options === null || options === void 0 ? void 0 : options.adaptTo) ? { adaptTo: options.adaptTo } : undefined;
+        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 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);
     }
     async getLanguages() {
         return await this.client.get("/languages");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@translated/lara",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "engines": {
@@ -22,23 +22,23 @@
     "api"
   ],
   "author": {
-    "name": "Davide Caroselli",
-    "email": "davide.caroselli@translated.com"
+    "name": "Translated",
+    "email": "support@laratranslate.com"
   },
   "license": "MIT",
-  "homepage": "https://lara.translated.com",
+  "homepage": "https://laratranslate.com",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/translated/lara-node.git"
   },
   "description": "Official Lara SDK for JavaScript and Node.js",
   "dependencies": {
-    "form-data": "^4.0.1"
+    "form-data": "^4.0.2"
   },
   "devDependencies": {
-    "@types/node": "^20.14.2",
-    "typescript": "^5.4.5",
-    "webpack": "^5.97.1",
+    "@types/node": "^22.15.18",
+    "typescript": "^5.8.3",
+    "webpack": "^5.99.8",
     "webpack-cli": "^5.1.4"
   }
 }