@translated/lara 2.0.0-beta.1 → 2.0.0-beta.3

package/lib/Documents.d.ts

@@ -1,12 +1,12 @@
 import { AxiosInstance } from 'axios';
-import { Document, DocumentDownloadOptions, DocumentTranslateOptions, DocumentUploadOptions, UploadableFile } from './models';
+import { Document, DocumentDownloadOptions, DocumentTranslateOptions, DocumentUploadOptions, DownloadResult, UploadableFile } from './models';
 export default class Documents {
     private readonly client;
     private readonly pollingInterval;
     private readonly maxWaitTime;
     constructor(client: AxiosInstance);
-    upload(file: UploadableFile, filenane: string, source: string | null, target: string, options?: DocumentUploadOptions): Promise<Document>;
+    upload(file: UploadableFile, filenane: string, source: string | undefined, target: string, options?: DocumentUploadOptions): Promise<Document>;
     status(id: string): Promise<Document>;
-    download(id: string, options?: DocumentDownloadOptions): Promise<Blob | Buffer>;
-    translate(file: UploadableFile, filenane: string, source: string | null, target: string, options?: DocumentTranslateOptions): Promise<Blob | Buffer>;
+    download(id: string, options?: DocumentDownloadOptions): Promise<DownloadResult>;
+    translate(file: UploadableFile, filenane: string, source: string | undefined, target: string, options?: DocumentTranslateOptions): Promise<DownloadResult>;
 }

package/lib/Documents.js

@@ -4,6 +4,8 @@ import toFormData from './utils/formdata';
 import toSnakeCase from './utils/toSnakeCase';
 import sleep from './utils/sleep';
 import { LaraApiError, TimeoutError } from './utils/errors';
+import toQueryString from './utils/toQueryString';
+import isNode from './utils/isNode';
 export default class Documents {
     constructor(client) {
         this.pollingInterval = 2000;
@@ -14,8 +16,8 @@ export default class Documents {
         const { data: s3UploadUrlData } = await this.client.get(`/v2/documents/upload-url?filename=${encodeURIComponent(filenane)}`);
         const { url, fields } = s3UploadUrlData;
         const [formData, headers] = toFormData({
-            file,
             ...fields,
+            file,
         });
         await axios.post(url, formData, { headers });
         const noTraceHeader = (options === null || options === void 0 ? void 0 : options.noTrace) ? { 'X-Lara-No-Trace': 'true' } : undefined;
@@ -36,13 +38,22 @@ export default class Documents {
         return data;
     }
     async download(id, options) {
-        const { data } = await this.client.get(`/v2/documents/${id}/download-url`, {
-            data: {
-                output_format: options === null || options === void 0 ? void 0 : options.outputFormat,
-            },
+        const queryString = toQueryString({
+            output_format: options === null || options === void 0 ? void 0 : options.outputFormat,
         });
-        const { data: downloadedData } = await axios.get(data.url);
-        return downloadedData;
+        const { data } = await this.client.get(`/v2/documents/${id}/download-url?${queryString}`);
+        if (isNode) {
+            const { data: downloadedData } = await axios.get(data.url, {
+                responseType: 'stream',
+            });
+            return downloadedData;
+        }
+        else {
+            const { data: downloadedData } = await axios.get(data.url, {
+                responseType: 'blob',
+            });
+            return downloadedData.stream();
+        }
     }
     async translate(file, filenane, source, target, options) {
         const uploadOptions = {

package/lib/Glossaries.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { Glossary, GlossaryCounts, GlossaryImport, UploadableFile } from './models';
+import { DownloadResult, Glossary, GlossaryCounts, GlossaryImport, UploadableFile } from './models';
 export default class Glossaries {
     private readonly client;
     private readonly pollingInterval;
@@ -13,5 +13,5 @@ export default class Glossaries {
     getImportStatus(id: string): Promise<GlossaryImport>;
     waitForImport(gImport: GlossaryImport, updateCallback?: (mImport: GlossaryImport) => void, maxWaitTime?: number): Promise<GlossaryImport>;
     counts(id: string): Promise<GlossaryCounts>;
-    export(id: string, contentType: 'csv/table-uni', source?: string): Promise<string>;
+    export(id: string, contentType: 'csv/table-uni', source?: string): Promise<DownloadResult>;
 }

package/lib/Glossaries.js

@@ -1,6 +1,8 @@
 import { TimeoutError } from './utils/errors';
 import toFormData from './utils/formdata';
 import sleep from './utils/sleep';
+import toQueryString from './utils/toQueryString';
+import isNode from './utils/isNode';
 export default class Glossaries {
     constructor(client) {
         this.pollingInterval = 2000;
@@ -52,17 +54,25 @@ export default class Glossaries {
         return gImport;
     }
     async counts(id) {
-        const { data } = await this.client.get(`/v2/glossaries/${id}/countes`);
+        const { data } = await this.client.get(`/v2/glossaries/${id}/counts`);
         return data;
     }
-    // FIXME: this method should return a Blob or Buffer
     async export(id, contentType, source) {
-        const { data } = await this.client.get(`/v2/glossaries/${id}/export`, {
-            data: {
-                content_type: contentType,
-                source: !!source ? source : undefined,
-            },
+        const queryString = toQueryString({
+            content_type: contentType,
+            source,
         });
-        return data;
+        if (isNode) {
+            const { data } = await this.client.get(`/v2/glossaries/${id}/export?${queryString}`, {
+                responseType: 'stream',
+            });
+            return data;
+        }
+        else {
+            const { data } = await this.client.get(`/v2/glossaries/${id}/export?${queryString}`, {
+                responseType: 'blob',
+            });
+            return data.stream();
+        }
     }
 }

package/lib/Translator.js

@@ -30,7 +30,7 @@ export class Translator {
         // Intercepts errors to handle authentication errors
         this.client.interceptors.response.use((response) => {
             // Convert payload in camel case if needed
-            if (response.data && typeof response.data === 'object') {
+            if (response.config.responseType !== 'stream' && response.data && typeof response.data === 'object') {
                 response.data = toCamelCase(response.data);
             }
             return response;

package/lib/models/UploadableFile.d.ts

@@ -1 +1,2 @@
 export type UploadableFile = File | import('stream').Readable;
+export type DownloadResult = ReadableStream<Uint8Array> | import('stream').Readable;

package/lib/sdk-version.d.ts

@@ -1 +1 @@
-export declare const version = "1.6.6";
+export declare const version = "2.0.0-beta.1";

package/lib/sdk-version.js

@@ -1 +1 @@
-export const version = "1.6.6";
+export const version = '2.0.0-beta.1';

package/lib/utils/isNode.d.ts

@@ -0,0 +1,2 @@
+declare const _default: boolean;
+export default _default;

package/lib/utils/isNode.js

@@ -0,0 +1 @@
+export default typeof window === 'undefined';

package/lib/utils/toQueryString.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (params: Record<string, any>) => string;
+export default _default;

package/lib/utils/toQueryString.js

@@ -0,0 +1,8 @@
+export default (params) => Object.entries(params)
+    .reduce((acc, [key, value]) => {
+    if (value !== undefined && value !== null) {
+        acc.push(`${encodeURIComponent(key)}=${encodeURIComponent(value)}`);
+    }
+    return acc;
+}, [])
+    .join('&');

package/package.json

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