@translated/lara 1.6.5 → 2.0.0-beta.0

package/lib/Translator.js

@@ -0,0 +1,152 @@
+import axios from 'axios';
+import Memories from './Memories';
+import { version } from './sdk-version';
+import Glossaries from './Glossaries';
+import Documents from './Documents';
+import toCamelCase from './utils/toCamelCase';
+const DEFAULT_BASE_URL = 'https://api.laratranslate.com';
+export class Translator {
+    constructor(accessKey, credentials, authToken, options) {
+        var _a;
+        this.accessKey = accessKey;
+        this.credentials = credentials;
+        this.authToken = authToken;
+        this.options = options || {};
+        this.client = axios.create({
+            baseURL: (_a = options === null || options === void 0 ? void 0 : options.serverUrl) !== null && _a !== void 0 ? _a : DEFAULT_BASE_URL,
+            headers: {
+                'X-Lara-SDK-Name': 'lara-node',
+                'X-Lara-SDK-Version': version,
+                'X-Lara-Date': new Date().toUTCString(),
+                ...((options === null || options === void 0 ? void 0 : options.extraHeaders) || {}),
+            },
+        });
+        // Intercept request to add authentication header
+        this.client.interceptors.request.use(async (request) => {
+            const token = await this.authenticate();
+            request.headers.Authorization = `Bearer ${token}`;
+            return request;
+        }, Promise.reject);
+        // Intercepts errors to handle authentication errors
+        this.client.interceptors.response.use((response) => {
+            response.data && console.log(response.data);
+            // Convert payload in camel case if needed
+            if (response.data && typeof response.data === 'object') {
+                response.data = toCamelCase(response.data);
+            }
+            return response;
+        }, async (error) => {
+            const originalRequest = error.config;
+            if (originalRequest.isRetry)
+                return Promise.reject(error);
+            if (error.response && error.response.status === 401 && error.response.message === 'jwt expired') {
+                this.token = undefined;
+                const token = await this.authenticate();
+                originalRequest.isRetry = true;
+                originalRequest.headers.Authorization = `Bearer ${token}`;
+                return this.client(originalRequest);
+            }
+            return Promise.reject(error);
+        });
+        this.memories = new Memories(this.client);
+        this.glossaries = new Glossaries(this.client);
+        this.documents = new Documents(this.client);
+    }
+    async authenticate() {
+        var _a, _b, _c, _d, _e, _f;
+        // If the token is set, return it
+        if (this.token)
+            return this.token;
+        // If we have a refresh token, use it to get a new token
+        if (this.refreshToken) {
+            const { data } = await axios.post(`${(_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.serverUrl) !== null && _b !== void 0 ? _b : DEFAULT_BASE_URL}/v2/auth/refresh`, null, {
+                headers: {
+                    authorization: `Bearer ${this.refreshToken}`,
+                    'X-Lara-Date': new Date().toUTCString(),
+                },
+            });
+            this.token = data.token;
+            this.refreshToken = data.refresh_token;
+            return this.token;
+        }
+        else if (this.accessKey) {
+            // Use access key to get a new token
+            const { data } = await axios.post(`${(_d = (_c = this.options) === null || _c === void 0 ? void 0 : _c.serverUrl) !== null && _d !== void 0 ? _d : DEFAULT_BASE_URL}/v2/auth`, this.accessKey, {
+                headers: {
+                    'X-Lara-Date': new Date().toUTCString(),
+                },
+            });
+            this.token = data.token;
+            this.refreshToken = data.refresh_token;
+            return this.token;
+        }
+        else if (this.credentials) {
+            // Use credentials to get a new token
+            const { data } = await axios.post(
+            //FIXME: client id should be set
+            `${(_f = (_e = this.options) === null || _e === void 0 ? void 0 : _e.serverUrl) !== null && _f !== void 0 ? _f : DEFAULT_BASE_URL}/v2/auth/Unknown/login`, this.credentials, {
+                headers: {
+                    'X-Lara-Date': new Date().toUTCString(),
+                },
+            });
+            this.token = data.token;
+            this.refreshToken = data.refresh_token;
+            return this.token;
+        }
+        else if (this.authToken) {
+            // Use the provided auth token
+            this.token = this.authToken.token;
+            this.refreshToken = this.authToken.refresh_token;
+            this.authToken = undefined;
+            return this.token;
+        }
+        else {
+            throw new Error('No authentication method provided');
+        }
+    }
+    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';
+        const { data } = await this.client.post(`/v2/translate`, {
+            q: text,
+            source: !!source ? source : undefined,
+            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,
+        }, headers);
+        return data;
+    }
+    async getLanguages() {
+        const { data } = await this.client.get(`/v2/languages`);
+        return data;
+    }
+    static async getLoginUrl(serverUrl) {
+        const { data } = await axios.get(`${serverUrl !== null && serverUrl !== void 0 ? serverUrl : DEFAULT_BASE_URL}/v2/auth/login-page`);
+        return data;
+    }
+    static byAccessKey(id, secret, options) {
+        return new Translator({ id, secret }, undefined, undefined, options);
+    }
+    static byCredentials(email, password, options) {
+        return new Translator(undefined, { email, password }, undefined, options);
+    }
+    static byAuthToken(token, refresh_token, options) {
+        return new Translator(undefined, undefined, { token, refresh_token }, options);
+    }
+}

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,17 +1,2 @@
-"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;
-var credentials_1 = require("./credentials");
-Object.defineProperty(exports, "Credentials", { enumerable: true, get: function () { return credentials_1.Credentials; } });
-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; } });
-Object.defineProperty(exports, "Translator", { enumerable: true, get: function () { return translator_1.Translator; } });
+export * from './Translator';
+export * from './models';

package/lib/models/Authentication.d.ts

@@ -0,0 +1,12 @@
+export type AccessKey = {
+    id: string;
+    secret: string;
+};
+export type AuthToken = {
+    token: string;
+    refresh_token: string;
+};
+export type Credentials = {
+    email: string;
+    password: string;
+};

package/lib/models/Authentication.js

@@ -0,0 +1 @@
+export {};

package/lib/models/UploadableFile.d.ts

@@ -0,0 +1 @@
+export type UploadableFile = File | import('stream').Readable;

package/lib/models/UploadableFile.js

@@ -0,0 +1 @@
+export {};

package/lib/models/documents.d.ts

@@ -0,0 +1,51 @@
+import { TranslationStyle } from './translator';
+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 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 DocumentOptions = {
+    adaptTo?: string[];
+    glossaries?: string[];
+    noTrace?: boolean;
+    style?: TranslationStyle;
+};
+export type DocumentUploadOptions = DocumentOptions & {
+    password?: string;
+    extractionParams?: DocxExtractionParams;
+};
+export type DocumentDownloadOptions = {
+    outputFormat?: string;
+};
+export type DocumentTranslateOptions = DocumentUploadOptions & DocumentDownloadOptions;
+export interface DocxExtractionParams {
+    extractComments?: boolean;
+    accepsRevisions?: boolean;
+}
+interface S3UploadFields {
+    acl: string;
+    bucket: string;
+    key: string;
+}
+export interface UploadUrlData {
+    url: string;
+    fields: S3UploadFields;
+}
+export {};

package/lib/{translator/models.js → models/documents.js}

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

package/lib/models/glossaries.d.ts

@@ -0,0 +1,19 @@
+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/models/glossaries.js

@@ -0,0 +1 @@
+export {};

package/lib/models/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Authentication';
+export * from './documents';
+export * from './glossaries';
+export * from './memories';
+export * from './translator';
+export * from './UploadableFile';

package/lib/models/index.js

@@ -0,0 +1,6 @@
+export * from './Authentication';
+export * from './documents';
+export * from './glossaries';
+export * from './memories';
+export * from './translator';
+export * from './UploadableFile';

package/lib/models/memories.d.ts

@@ -0,0 +1,19 @@
+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;
+}

package/lib/models/memories.js

@@ -0,0 +1 @@
+export {};

package/lib/models/translator.d.ts

@@ -0,0 +1,48 @@
+export interface TranslatorOptions {
+    serverUrl?: string;
+    extraHeaders?: Record<string, any>;
+}
+export interface TextBlock {
+    readonly text: string;
+    readonly translatable?: boolean;
+}
+export type TranslationStyle = 'faithful' | 'fluid' | 'creative';
+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 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[][];
+}

package/lib/models/translator.js

@@ -0,0 +1 @@
+export {};

package/lib/sdk-version.d.ts

@@ -1 +1 @@
-export declare const version = "1.6.5";
+export declare const version = "1.6.6";

package/lib/sdk-version.js

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

package/lib/utils/errors.js

@@ -0,0 +1,12 @@
+export class LaraError extends Error {
+}
+export class TimeoutError extends LaraError {
+}
+export class LaraApiError extends LaraError {
+    constructor(statusCode, type, message) {
+        super(message);
+        this.statusCode = statusCode;
+        this.type = type;
+        this.message = message;
+    }
+}

package/lib/utils/formdata/browser.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (data: Record<string, any>) => {}[];
+export default _default;

package/lib/utils/formdata/browser.js

@@ -0,0 +1,15 @@
+export default (data) => {
+    const formData = new FormData();
+    for (const [key, value] of Object.entries(data)) {
+        if (!value)
+            continue;
+        if (Array.isArray(value)) {
+            for (const v of value)
+                formData.append(key, v);
+        }
+        else {
+            formData.append(key, value);
+        }
+    }
+    return [formData, {}];
+};

package/lib/utils/formdata/index.d.ts

@@ -0,0 +1,4 @@
+declare const _default: (data: Record<string, any>) => [any, {
+    [key: string]: any;
+}];
+export default _default;

package/lib/utils/formdata/index.js

@@ -0,0 +1,10 @@
+import browserForm from './browser.js';
+import nodeForm from './node.js';
+let form;
+if (typeof window !== 'undefined') {
+    form = browserForm;
+}
+else {
+    form = nodeForm;
+}
+export default form;

package/lib/utils/formdata/node.d.ts

@@ -0,0 +1,5 @@
+import FormData from 'form-data';
+declare const _default: (data: Record<string, any>) => [FormData, {
+    [key: string]: any;
+}];
+export default _default;

package/lib/utils/formdata/node.js

@@ -0,0 +1,16 @@
+import FormData from 'form-data';
+export default (data) => {
+    const formData = new FormData();
+    for (const [key, value] of Object.entries(data)) {
+        if (!value)
+            continue;
+        if (Array.isArray(value)) {
+            for (const v of value)
+                formData.append(key, v);
+        }
+        else {
+            formData.append(key, value);
+        }
+    }
+    return [formData, { ...formData.getHeaders() }];
+};

package/lib/utils/sleep.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (millis: number) => Promise<unknown>;
+export default _default;

package/lib/utils/sleep.js

@@ -0,0 +1 @@
+export default (millis) => new Promise((resolve) => setTimeout(resolve, millis));

package/lib/utils/toCamelCase.d.ts

@@ -0,0 +1,2 @@
+declare const toCamelCase: (content: any) => any;
+export default toCamelCase;

package/lib/utils/toCamelCase.js

@@ -0,0 +1,16 @@
+const toCamelCase = (content) => {
+    if (typeof content === 'string')
+        return content;
+    if (Array.isArray(content))
+        return content.map(toCamelCase);
+    if (typeof content === 'object' && content !== null) {
+        const result = {};
+        for (const [key, value] of Object.entries(content)) {
+            const camelKey = key.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+            result[camelKey] = toCamelCase(value);
+        }
+        return result;
+    }
+    return content;
+};
+export default toCamelCase;

package/lib/utils/toSnakeCase.d.ts

@@ -0,0 +1,2 @@
+declare const toSnakeCase: (content: any) => any;
+export default toSnakeCase;

package/lib/utils/toSnakeCase.js

@@ -0,0 +1,16 @@
+const toSnakeCase = (content) => {
+    if (typeof content === 'string')
+        return content;
+    if (Array.isArray(content))
+        return content.map(toSnakeCase);
+    if (typeof content === 'object' && content !== null) {
+        const result = {};
+        for (const [key, value] of Object.entries(content)) {
+            const snakeKey = key.replace(/([A-Z])/g, '_$1').toLowerCase();
+            result[snakeKey] = toSnakeCase(value);
+        }
+        return result;
+    }
+    return content;
+};
+export default toSnakeCase;

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@translated/lara",
-  "version": "1.6.5",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "version": "2.0.0-beta.0",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "engines": {
     "node": ">=12.*"
   },
   "scripts": {
     "build": "rm -rf lib/* lib-browser/* && node scripts/generate-sdk-version.js && tsc && webpack",
+    "_build": "rm -rf lib/* && tsc",
     "version": "node scripts/generate-sdk-version.js && git add src/sdk-version.ts",
-    "biome:check": "biome check",
-    "biome:write": "biome check --write"
+    "lint:fix": "eslint --fix .",
+    "lint:check": "eslint ."
   },
   "files": [
     "lib",
@@ -34,14 +35,23 @@
     "url": "git+ssh://git@github.com/translated/lara-node.git"
   },
   "description": "Official Lara SDK for JavaScript and Node.js",
-  "dependencies": {
-    "form-data": "^4.0.2"
-  },
   "devDependencies": {
-    "@biomejs/biome": "^2.0.6",
-    "@types/node": "^22.15.18",
-    "typescript": "^5.8.3",
-    "webpack": "^5.99.8",
-    "webpack-cli": "^5.1.4"
+    "@types/node": "^24.9.1",
+    "@typescript-eslint/eslint-plugin": "^8.46.0",
+    "@typescript-eslint/parser": "^8.46.0",
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "husky": "^9.1.7",
+    "prettier": "^3.6.2",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "webpack": "^5.102.1",
+    "webpack-cli": "^6.0.1"
+  },
+  "dependencies": {
+    "axios": "^1.12.2",
+    "form-data": "^4.0.4"
   }
 }

package/lib/credentials.d.ts

@@ -1,5 +0,0 @@
-export declare class Credentials {
-    readonly accessKeyId: string;
-    readonly accessKeySecret: string;
-    constructor(accessKeyId: string, accessKeySecret: string);
-}

package/lib/credentials.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Credentials = void 0;
-class Credentials {
-    constructor(accessKeyId, accessKeySecret) {
-        this.accessKeyId = accessKeyId;
-        this.accessKeySecret = accessKeySecret;
-    }
-}
-exports.Credentials = Credentials;

package/lib/crypto/browser-crypto.d.ts

@@ -1,11 +0,0 @@
-import type { PortableCrypto } from "./portable-crypto";
-/** @internal */
-export declare class BrowserCrypto implements PortableCrypto {
-    private readonly subtle;
-    constructor();
-    /**
-     * MD5 in browser is not supported, so we use SHA-256 instead and return the first 16 bytes
-     */
-    digest(data: string): Promise<string>;
-    hmac(key: string, data: string): Promise<string>;
-}

package/lib/crypto/browser-crypto.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BrowserCrypto = void 0;
-/** @internal */
-class BrowserCrypto {
-    constructor() {
-        this.subtle = window.crypto.subtle;
-    }
-    /**
-     * MD5 in browser is not supported, so we use SHA-256 instead and return the first 16 bytes
-     */
-    async digest(data) {
-        const encoder = new TextEncoder();
-        const buffer = (await this.subtle.digest("sha-256", encoder.encode(data))).slice(0, 16);
-        return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, "0")).join("");
-    }
-    async hmac(key, data) {
-        const encoder = new TextEncoder();
-        encoder.encode(data);
-        const cKey = await this.subtle.importKey("raw", encoder.encode(key), {
-            name: "hmac",
-            hash: { name: "sha-256" }
-        }, false, ["sign"]);
-        const buffer = await this.subtle.sign("hmac", cKey, encoder.encode(data));
-        return btoa(String.fromCharCode(...new Uint8Array(buffer)));
-    }
-}
-exports.BrowserCrypto = BrowserCrypto;

package/lib/crypto/index.d.ts

@@ -1,3 +0,0 @@
-import type { PortableCrypto } from "./portable-crypto";
-export { PortableCrypto } from "./portable-crypto";
-export default function instance(): PortableCrypto;