Merge branch 'master' into DEVORTEX-5439

Author: dnetrebenko-smartling

.eslintrc

@@ -69,7 +69,8 @@
     "react/jsx-indent-props": ["error", 4],
     "react/no-unescaped-entities": "off",
     "react/prefer-stateless-function": "off",
-    "react/require-default-props": "off"
+    "react/require-default-props": "off",
+    "flowtype/no-types-missing-file-annotation": "off"
   },
   env: {
     browser: true,

.nvmrc

@@ -0,0 +1 @@
+v18.20.8

CLAUDE.md

@@ -0,0 +1,67 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+This is the Smartling Translation API SDK for Node.js, providing TypeScript interfaces for interacting with Smartling's translation services. The SDK covers all major API endpoints including files, jobs, locales, projects, and translation management.
+
+## Commands
+
+### Build Commands
+- `npm run build` - Production build (TypeScript compilation to `built/` directory)
+- `npm run build:dev` - Development build (includes test files)
+
+### Testing
+- `npm test` - Run full test suite with lint, build, and coverage
+- `npm run test:dev` - Run tests without JUnit reporting (for development)
+
+### Linting
+- `npm run pretest` - Run ESLint on all TypeScript files
+- ESLint configuration in `.eslintrc` with TypeScript, Airbnb, and custom rules
+
+### Single Test Execution
+Run individual test files using Mocha directly:
+```bash
+npm run build:dev && npx mocha built/test/[specific-test].spec.js
+```
+
+## Architecture
+
+### Core Structure
+- **API Layer**: Organized by feature domains (`/api/`)
+  - `auth/` - Authentication and token management
+  - `files/` - File upload/download operations
+  - `jobs/` - Translation job management
+  - `locales/` - Language and locale handling
+  - `projects/` - Project management
+  - `strings/` - String resource management
+  - `context/` - Context matching for translations
+  - `job-batches/` - Batch job processing
+  - `published-files/` - Published file management
+  - `file-translations/` - File translation services
+  - `mt/` - Machine translation services
+
+### Pattern Structure
+Each API domain follows a consistent pattern:
+- `index.ts` - Main API client class
+- `dto/` - Data transfer objects (response/request types)
+- `params/` - Parameter classes for API calls
+
+### Key Components
+- **SmartlingApiClientBuilder**: Main entry point for creating API clients
+- **AccessTokenProvider**: Interface for authentication (with StaticAccessTokenProvider implementation)
+- **SmartlingListResponse**: Generic wrapper for paginated API responses
+- **Logger**: Centralized logging utility
+
+### TypeScript Configuration
+- Uses `tsconfig.json` for production builds
+- Uses `tsconfig.dev.json` for development (includes test files)
+- Targets ES6 with CommonJS modules
+- Generates declaration files and source maps
+
+### Testing Framework
+- Mocha test runner with TypeScript support
+- Sinon for mocking and stubbing
+- NYC for code coverage reporting
+- Tests located in `/test/` directory matching API structure

api/auth/access-token-provider.ts

@@ -0,0 +1,5 @@
+export interface AccessTokenProvider {
+    getAccessToken(): Promise<string>;
+    getTokenType(): Promise<string>;
+    resetToken(): void;
+}

api/auth/index.ts

@@ -1,9 +1,10 @@
 import { SmartlingBaseApi } from "../base/index";
 import { SmartlingException } from "../exception/index";
 import { Logger } from "../logger";
+import { AccessTokenProvider } from "./access-token-provider";
 import { AccessTokenDto } from "./dto/access-token-dto";
 
-export class SmartlingAuthApi extends SmartlingBaseApi {
+export class SmartlingAuthApi extends SmartlingBaseApi implements AccessTokenProvider {
     private ttlCorrectionSec: number;
     private userIdentifier: string;
     private tokenSecret: string;

api/auth/static-access-token-provider.ts

@@ -0,0 +1,27 @@
+import { AccessTokenProvider } from "./access-token-provider";
+
+export class StaticAccessTokenProvider implements AccessTokenProvider {
+    private accessToken: string;
+    private tokenType: string;
+
+    constructor(
+        accessToken: string,
+        tokenType: string
+    ) {
+        this.accessToken = accessToken;
+        this.tokenType = tokenType;
+    }
+
+    async getAccessToken(): Promise<string> {
+        return this.accessToken;
+    }
+
+    async getTokenType(): Promise<string> {
+        return this.tokenType;
+    }
+
+    resetToken(): void {
+        this.accessToken = null;
+        this.tokenType = null;
+    }
+}

api/base/index.ts

@@ -5,14 +5,14 @@ import fetch from "cross-fetch";
 import { ParsedUrlQueryInput, stringify } from "querystring";
 import { Logger } from "../logger";
 import { SmartlingException } from "../exception/index";
-import { SmartlingAuthApi } from "../auth/index";
+import { AccessTokenProvider } from "../auth/access-token-provider";
 import { ResponseBodyType } from "./enum/response-body-type";
 
 /* eslint-disable-next-line @typescript-eslint/no-var-requires */
 const packageJson = require("../../package.json");
 
 export class SmartlingBaseApi {
-    protected authApi: SmartlingAuthApi = undefined;
+    protected authApi: AccessTokenProvider = undefined;
     protected entrypoint: string;
     protected defaultClientLibId: string;
     protected defaultClientVersion: string;

api/builder/index.ts

@@ -1,3 +1,4 @@
+import { AccessTokenProvider } from "../auth/access-token-provider";
 import { SmartlingAuthApi } from "../auth/index";
 import { SmartlingBaseApi } from "../base/index";
 import { Logger } from "../logger";
@@ -6,7 +7,7 @@ import { Logger } from "../logger";
 const packageJson = require("../../package.json");
 
 export class SmartlingApiClientBuilder {
-    protected authApiClient: SmartlingAuthApi = null;
+    protected authApiClient: AccessTokenProvider = null;
     protected userId: string = null;
     protected userSecret: string = null;
     protected baseSmartlingApiUrl: string;
@@ -60,14 +61,14 @@ export class SmartlingApiClientBuilder {
         return this;
     }
 
-    public authWithAuthApiClient(authApiClient: SmartlingAuthApi): SmartlingApiClientBuilder {
+    public authWithAuthApiClient(authApiClient: AccessTokenProvider): SmartlingApiClientBuilder {
         this.authApiClient = authApiClient;
 
         return this;
     }
 
     public build<T extends SmartlingBaseApi>(
-        constructor: new (baseUrl: string, authApi: SmartlingAuthApi, logger) => T
+        constructor: new (baseUrl: string, authApi: AccessTokenProvider, logger) => T
     ): T {
         if (this.authApiClient === null && this.userId !== null && this.userSecret !== null) {
             this.authApiClient = new SmartlingAuthApi(
@@ -77,9 +78,11 @@ export class SmartlingApiClientBuilder {
                 this.logger
             );
 
-            this.authApiClient.setClientLibId(this.clientLibId);
-            this.authApiClient.setClientLibVersion(this.clientLibVersion);
-            this.authApiClient.setOptions(this.httpClientOptions);
+            if (this.authApiClient instanceof SmartlingAuthApi) {
+                this.authApiClient.setClientLibVersion(this.clientLibVersion);
+                this.authApiClient.setClientLibId(this.clientLibId);
+                this.authApiClient.setOptions(this.httpClientOptions);
+            }
         }
 
         const instance = new constructor(this.baseSmartlingApiUrl, this.authApiClient, this.logger);

api/context/index.ts

@@ -1,7 +1,7 @@
 import string2fileStream from "string-to-file-stream";
 import FormData from "form-data";
 import { SmartlingBaseApi } from "../base/index";
-import { SmartlingAuthApi } from "../auth/index";
+import { AccessTokenProvider } from "../auth/access-token-provider";
 import { ContextUploadParameters } from "./params/context-upload-parameters";
 import { ContextDto } from "./dto/context-dto";
 import { ContextAutomaticMatchParameters } from "./params/context-automatic-match-parameters";
@@ -13,7 +13,7 @@ import { ListParameters } from "./params/list-parameters";
 import { Logger } from "../logger";
 
 export class SmartlingContextApi extends SmartlingBaseApi {
-    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
+    constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger) {
         super(logger);
 
         this.authApi = authApi;

api/file-translations/index.ts

@@ -1,6 +1,6 @@
 import FormData from "form-data";
 import { SmartlingBaseApi } from "../base";
-import { SmartlingAuthApi } from "../auth";
+import { AccessTokenProvider } from "../auth/access-token-provider";
 import { Logger } from "../logger";
 import { FtsUploadedFileDto } from "./dto/fts-uploaded-file-dto";
 import { FtsUploadFileParameters } from "./params/fts-upload-file-parameters";
@@ -14,7 +14,7 @@ import { ResponseBodyType } from "../base/enum/response-body-type";
 import { LanguageDetectionParameters } from "./params/language-detection-parameters";
 
 export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
-    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
+    constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger) {
         super(logger);
         this.authApi = authApi;
         this.entrypoint = `${smartlingApiBaseUrl}/file-translations-api/v2/accounts`;