@translated/lara 1.3.3 → 1.4.0

package/lib/index.d.ts

@@ -3,3 +3,4 @@ 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 { MultiPartFile } from "./net/client";

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

@@ -1,7 +1,8 @@
-import { BaseURL, ClientResponse, LaraClient } from "./client";
+import { BaseURL, ClientResponse, LaraClient, MultiPartFile } from "./client";
 /** @internal */
 export declare class BrowserLaraClient extends LaraClient {
     private readonly baseUrl;
     constructor(baseUrl: BaseURL, accessKeyId: string, accessKeySecret: string);
     protected send(path: string, headers: Record<string, string>, body?: Record<string, any>): Promise<ClientResponse>;
+    protected wrapMultiPartFile(file: MultiPartFile): File;
 }

package/lib/net/browser-client.js

@@ -41,5 +41,10 @@ class BrowserLaraClient extends client_1.LaraClient {
         });
         return { statusCode: response.status, body: await response.json() };
     }
+    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.BrowserLaraClient = BrowserLaraClient;

package/lib/net/client.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { Readable } from "node:stream";
 type HttpMethod = "GET" | "POST" | "PUT" | "DELETE";
 /** @internal */
 export type BaseURL = {
@@ -10,6 +12,9 @@ export type ClientResponse = {
     statusCode: number;
     body: any;
 };
+export type BrowserMultiPartFile = File;
+export type NodeMultiPartFile = Readable | string;
+export type MultiPartFile = BrowserMultiPartFile | NodeMultiPartFile;
 /** @internal */
 export declare abstract class LaraClient {
     private readonly crypto;
@@ -20,10 +25,11 @@ export declare abstract class LaraClient {
     setExtraHeader(name: string, value: string): void;
     get<T>(path: string, params?: Record<string, any>): Promise<T>;
     delete<T>(path: string, params?: Record<string, any>): Promise<T>;
-    post<T>(path: string, body?: Record<string, any>, files?: Record<string, string>): Promise<T>;
-    put<T>(path: string, body?: Record<string, any>, files?: Record<string, string>): Promise<T>;
-    protected request<T>(method: HttpMethod, path: string, body?: Record<string, any>, files?: Record<string, any>): Promise<T>;
+    post<T>(path: string, body?: Record<string, any>, files?: Record<string, MultiPartFile>): Promise<T>;
+    put<T>(path: string, body?: Record<string, any>, files?: Record<string, MultiPartFile>): Promise<T>;
+    protected request<T>(method: HttpMethod, path: string, body?: Record<string, any>, files?: Record<string, MultiPartFile>): Promise<T>;
     private sign;
     protected abstract send(path: string, headers: Record<string, string>, body?: Record<string, any>): Promise<ClientResponse>;
+    protected abstract wrapMultiPartFile(file: MultiPartFile): any;
 }
 export {};

package/lib/net/client.js

@@ -73,6 +73,9 @@ class LaraClient {
         }
         let requestBody = undefined;
         if (files) {
+            // validate files
+            for (const [key, file] of Object.entries(files))
+                files[key] = this.wrapMultiPartFile(file);
             headers["Content-Type"] = "multipart/form-data";
             requestBody = Object.assign({}, files, body);
         }

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

@@ -1,8 +1,11 @@
-import { BaseURL, ClientResponse, LaraClient } from "./client";
+/// <reference types="node" />
+import { BaseURL, ClientResponse, LaraClient, MultiPartFile } from "./client";
+import { Readable } from "stream";
 /** @internal */
 export declare class NodeLaraClient extends LaraClient {
     private readonly baseUrl;
     private readonly agent;
     constructor(baseUrl: BaseURL, accessKeyId: string, accessKeySecret: string);
     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

@@ -8,6 +8,8 @@ const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
 const form_data_1 = __importDefault(require("form-data"));
 const client_1 = require("./client");
+const stream_1 = require("stream");
+const fs_1 = __importDefault(require("fs"));
 /** @internal */
 class NodeLaraClient extends client_1.LaraClient {
     constructor(baseUrl, accessKeyId, accessKeySecret) {
@@ -70,9 +72,19 @@ class NodeLaraClient extends client_1.LaraClient {
             }
             else if (requestBody) {
                 req.write(requestBody);
+                req.end();
+            }
+            else {
+                req.end();
             }
-            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.NodeLaraClient = NodeLaraClient;

package/lib/sdk-version.d.ts

@@ -1 +1 @@
-export declare const version = "1.3.3";
+export declare const version = "1.4.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.3.3";
+exports.version = "1.4.0";

package/lib/translator/translator.d.ts

@@ -1,6 +1,7 @@
 import { Credentials } from "../credentials";
 import { LaraClient } from "../net";
 import { Memory, MemoryImport, TextBlock, TextResult } from "./models";
+import { MultiPartFile } from "../net/client";
 export type TranslatorOptions = {
     serverUrl?: string;
 };
@@ -15,7 +16,7 @@ export declare class Memories {
     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: any, gzip?: boolean): Promise<MemoryImport>;
+    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): 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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@translated/lara",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "engines": {
@@ -33,7 +33,7 @@
   },
   "description": "Official Lara SDK for JavaScript and Node.js",
   "dependencies": {
-    "form-data": "^4.0.0"
+    "form-data": "^4.0.1"
   },
   "devDependencies": {
     "@types/node": "^20.14.2",