@lokalise/tm-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './sdk/TranslationMemoryClient';
+export * from './sdk/errors/TranslationMemoryClientError';
+export * from './sdk/types/requests';
+export * from './sdk/types/models';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './sdk/TranslationMemoryClient';
+export * from './sdk/errors/TranslationMemoryClientError';
+export * from './sdk/types/requests';
+export * from './sdk/types/models';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2CAA2C,CAAA;AACzD,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA"}

package/dist/sdk/TranslationMemoryClient.d.ts

@@ -0,0 +1,26 @@
+import type { MandatoryPaginationParams } from '@lokalise/api-common';
+import type { ErrorReporter } from '@lokalise/node-core';
+import type { RetryConfig } from 'undici-retry';
+import type { BulkTranslationMemoryMatches, TranslationMemoryMatch, TranslationMemoryRecordsResponse, UpsertRecordDto } from './types/models';
+import type { BulkFindMatchesRequest, FindMatchesRequest } from './types/requests';
+export type TranslationMemoryClientConfig = {
+    baseUrl: string;
+    jwtToken: string;
+    retryConfig?: Partial<RetryConfig>;
+    errorReporter?: ErrorReporter;
+};
+export declare class TranslationMemoryClient {
+    private readonly maxFindMatchesRequestSize;
+    private readonly httpClient;
+    private readonly retryConfig;
+    private readonly headers;
+    private readonly errorReporter?;
+    constructor(config: TranslationMemoryClientConfig);
+    findMatches(groupId: string, request: FindMatchesRequest): Promise<TranslationMemoryMatch[]>;
+    bulkFindMatches(groupId: string, request: BulkFindMatchesRequest): Promise<BulkTranslationMemoryMatches[]>;
+    bulkFindMatchesIterative(groupId: string, request: BulkFindMatchesRequest): AsyncGenerator<BulkTranslationMemoryMatches[]>;
+    getRecords(groupId: string, pagination?: MandatoryPaginationParams): Promise<TranslationMemoryRecordsResponse>;
+    upsertRecords(groupId: string, records: UpsertRecordDto[]): Promise<void>;
+    private internalBulkFindMatches;
+    private handleError;
+}

package/dist/sdk/TranslationMemoryClient.js

@@ -0,0 +1,117 @@
+import { buildClient, chunk, InternalError, isResponseStatusError, sendGet, sendPost, sendPut, } from '@lokalise/node-core';
+import { TranslationMemoryClientError } from './errors/TranslationMemoryClientError';
+import { transformToQueryParam } from './utils';
+export class TranslationMemoryClient {
+    maxFindMatchesRequestSize = 20; // TODO: TBD
+    httpClient;
+    retryConfig;
+    headers;
+    errorReporter;
+    constructor(config) {
+        this.httpClient = buildClient(config.baseUrl);
+        this.headers = {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${config.jwtToken}`,
+        };
+        this.retryConfig = {
+            retryOnTimeout: false,
+            maxAttempts: 5,
+            delayBetweenAttemptsInMsecs: 250,
+            statusCodesToRetry: [
+                408,
+                423,
+                429,
+                500,
+                503,
+                504, // Gateway timeout,
+            ],
+            ...config.retryConfig,
+        };
+        this.errorReporter = config.errorReporter;
+    }
+    async findMatches(groupId, request) {
+        try {
+            const response = await sendGet(this.httpClient, `/v1/groups/${groupId}/actions/find-matches`, {
+                headers: this.headers,
+                retryConfig: this.retryConfig,
+                requestLabel: '(tm-sdk) Find matches',
+                query: transformToQueryParam(request),
+            });
+            return response.result.body.data;
+        }
+        catch (e) {
+            throw this.handleError(e);
+        }
+    }
+    async bulkFindMatches(groupId, request) {
+        const response = [];
+        for (const filters of chunk(request.filters, this.maxFindMatchesRequestSize)) {
+            const partialResponse = await this.internalBulkFindMatches(groupId, { filters });
+            response.push(...partialResponse);
+        }
+        return response;
+    }
+    async *bulkFindMatchesIterative(groupId, request) {
+        for (const filters of chunk(request.filters, this.maxFindMatchesRequestSize)) {
+            yield await this.internalBulkFindMatches(groupId, { filters });
+        }
+    }
+    async getRecords(groupId, pagination) {
+        try {
+            const response = await sendGet(this.httpClient, `/v1/groups/${groupId}/records`, {
+                headers: this.headers,
+                retryConfig: this.retryConfig,
+                requestLabel: '(tm-sdk) Get records',
+                query: pagination,
+            });
+            return {
+                records: response.result.body.data,
+                meta: response.result.body.meta,
+            };
+        }
+        catch (e) {
+            throw this.handleError(e);
+        }
+    }
+    async upsertRecords(groupId, records) {
+        try {
+            await sendPut(this.httpClient, `/v1/groups/${groupId}/records`, records, {
+                headers: this.headers,
+                retryConfig: this.retryConfig,
+                requestLabel: '(tm-sdk) Create or update records',
+            });
+        }
+        catch (e) {
+            throw this.handleError(e);
+        }
+    }
+    async internalBulkFindMatches(groupId, request) {
+        try {
+            const response = await sendPost(this.httpClient, `/v1/groups/${groupId}/actions/bulk-find-matches`, request, {
+                headers: this.headers,
+                retryConfig: this.retryConfig,
+                requestLabel: '(tm-sdk) Bulk find matches',
+            });
+            return response.result.body.data;
+        }
+        catch (e) {
+            throw this.handleError(e);
+        }
+    }
+    handleError(e) {
+        let error;
+        if (e instanceof Error) {
+            error = isResponseStatusError(e) ? new TranslationMemoryClientError(e) : e;
+        }
+        else {
+            error = new InternalError({
+                message: 'Unknown error',
+                errorCode: 'UNKNOWN_ERROR',
+                details: { error: JSON.stringify(e) },
+            });
+        }
+        this.errorReporter?.report({ error });
+        return error;
+    }
+}
+//# sourceMappingURL=TranslationMemoryClient.js.map

package/dist/sdk/TranslationMemoryClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationMemoryClient.js","sourceRoot":"","sources":["../../src/sdk/TranslationMemoryClient.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,KAAK,EACL,aAAa,EACb,qBAAqB,EACrB,OAAO,EACP,QAAQ,EACR,OAAO,GACR,MAAM,qBAAqB,CAAA;AAI5B,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAA;AAapF,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAS/C,MAAM,OAAO,uBAAuB;IACjB,yBAAyB,GAAG,EAAE,CAAA,CAAC,YAAY;IAE3C,UAAU,CAAQ;IAClB,WAAW,CAAa;IACxB,OAAO,CAAyB;IAChC,aAAa,CAAgB;IAE9C,YAAY,MAAqC;QAC/C,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAC7C,IAAI,CAAC,OAAO,GAAG;YACb,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,MAAM,CAAC,QAAQ,EAAE;SAC3C,CAAA;QACD,IAAI,CAAC,WAAW,GAAG;YACjB,cAAc,EAAE,KAAK;YACrB,WAAW,EAAE,CAAC;YACd,2BAA2B,EAAE,GAAG;YAChC,kBAAkB,EAAE;gBAClB,GAAG;gBACH,GAAG;gBACH,GAAG;gBACH,GAAG;gBACH,GAAG;gBACH,GAAG,EAAE,mBAAmB;aACzB;YACD,GAAG,MAAM,CAAC,WAAW;SACtB,CAAA;QACD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAAe,EACf,OAA2B;QAE3B,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC5B,IAAI,CAAC,UAAU,EACf,cAAc,OAAO,uBAAuB,EAC5C;gBACE,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,YAAY,EAAE,uBAAuB;gBACrC,KAAK,EAAE,qBAAqB,CAAC,OAAO,CAAC;aACtC,CACF,CAAA;YAED,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;SACjC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,OAAe,EACf,OAA+B;QAE/B,MAAM,QAAQ,GAAmC,EAAE,CAAA;QACnD,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,yBAAyB,CAAC,EAAE;YAC5E,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;YAChF,QAAQ,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAA;SAClC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,CAAC,wBAAwB,CAC7B,OAAe,EACf,OAA+B;QAE/B,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,yBAAyB,CAAC,EAAE;YAC5E,MAAM,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;SAC/D;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,OAAe,EACf,UAAsC;QAEtC,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC5B,IAAI,CAAC,UAAU,EACf,cAAc,OAAO,UAAU,EAC/B;gBACE,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,YAAY,EAAE,sBAAsB;gBACpC,KAAK,EAAE,UAAU;aAClB,CACF,CAAA;YAED,OAAO;gBACL,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI;gBAClC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI;aAChC,CAAA;SACF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,OAA0B;QAC7D,IAAI;YACF,MAAM,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,OAAO,UAAU,EAAE,OAAO,EAAE;gBACvE,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,YAAY,EAAE,mCAAmC;aAClD,CAAC,CAAA;SACH;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;SAC1B;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACnC,OAAe,EACf,OAA+B;QAE/B,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAC7B,IAAI,CAAC,UAAU,EACf,cAAc,OAAO,4BAA4B,EACjD,OAAO,EACP;gBACE,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,YAAY,EAAE,4BAA4B;aAC3C,CACF,CAAA;YAED,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;SACjC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;SAC1B;IACH,CAAC;IAEO,WAAW,CAAC,CAAU;QAC5B,IAAI,KAAwB,CAAA;QAC5B,IAAI,CAAC,YAAY,KAAK,EAAE;YACtB,KAAK,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;SAC3E;aAAM;YACL,KAAK,GAAG,IAAI,aAAa,CAAC;gBACxB,OAAO,EAAE,eAAe;gBACxB,SAAS,EAAE,eAAe;gBAC1B,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;aACtC,CAAC,CAAA;SACH;QAED,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACrC,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}

package/dist/sdk/errors/TranslationMemoryClientError.d.ts

@@ -0,0 +1,5 @@
+import type { ResponseStatusError } from '@lokalise/node-core';
+import { InternalError } from '@lokalise/node-core';
+export declare class TranslationMemoryClientError extends InternalError {
+    constructor(error: ResponseStatusError);
+}

package/dist/sdk/errors/TranslationMemoryClientError.js

@@ -0,0 +1,14 @@
+import { InternalError } from '@lokalise/node-core';
+export class TranslationMemoryClientError extends InternalError {
+    constructor(error) {
+        super({
+            message: `Translation memory service failed with error: ${error.message}`,
+            details: {
+                responseBody: JSON.stringify(error.response.body),
+                details: error.details,
+            },
+            errorCode: error.errorCode,
+        });
+    }
+}
+//# sourceMappingURL=TranslationMemoryClientError.js.map

package/dist/sdk/errors/TranslationMemoryClientError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationMemoryClientError.js","sourceRoot":"","sources":["../../../src/sdk/errors/TranslationMemoryClientError.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,OAAO,4BAA6B,SAAQ,aAAa;IAC7D,YAAY,KAA0B;QACpC,KAAK,CAAC;YACJ,OAAO,EAAE,iDAAiD,KAAK,CAAC,OAAO,EAAE;YACzE,OAAO,EAAE;gBACP,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjD,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB;YACD,SAAS,EAAE,KAAK,CAAC,SAAS;SAC3B,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/sdk/types/apiResponses.d.ts

@@ -0,0 +1,12 @@
+import type { PaginationMeta } from '@lokalise/api-common';
+import type { BulkTranslationMemoryMatches, TranslationMemoryMatch, TranslationMemoryRecord } from './models';
+export type GetFindMatchesResponse = {
+    data: TranslationMemoryMatch[];
+};
+export type PostBulkFindMatchesResponse = {
+    data: BulkTranslationMemoryMatches[];
+};
+export type GetRecordsResponse = {
+    data: TranslationMemoryRecord[];
+    meta: PaginationMeta;
+};

package/dist/sdk/types/apiResponses.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=apiResponses.js.map

package/dist/sdk/types/apiResponses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiResponses.js","sourceRoot":"","sources":["../../../src/sdk/types/apiResponses.ts"],"names":[],"mappings":""}

package/dist/sdk/types/models.d.ts

@@ -0,0 +1,26 @@
+import type { PaginationMeta } from '@lokalise/api-common';
+import type { MayOmit } from '@lokalise/node-core';
+export type TranslationMemoryMatch = {
+    targetText: string;
+};
+export type BulkTranslationMemoryMatches = {
+    filterId?: string;
+    matches: TranslationMemoryMatch[];
+};
+export type TranslationMemoryRecord = {
+    id: string;
+    groupId: string;
+    ownerId: string;
+    sourceText: string;
+    targetText: string;
+    sourceLocale: string;
+    targetLocale: string;
+    sourcePrevContent?: string;
+    sourceNextContent?: string;
+    createdAt: Date;
+};
+export type TranslationMemoryRecordsResponse = {
+    records: TranslationMemoryRecord[];
+    meta: PaginationMeta;
+};
+export type UpsertRecordDto = Omit<MayOmit<TranslationMemoryRecord, 'id'>, 'groupId' | 'createdAt'>;

package/dist/sdk/types/models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=models.js.map

package/dist/sdk/types/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/sdk/types/models.ts"],"names":[],"mappings":""}

package/dist/sdk/types/requests.d.ts

@@ -0,0 +1,14 @@
+export type FindMatchesRequest = {
+    sourceText: string;
+    sourceLocale: string;
+    targetLocale: string;
+    prevContent?: string;
+    nextContent?: string;
+    maxMatches?: number;
+};
+export type BulkFindMatchesFilter = FindMatchesRequest & {
+    filterId?: string;
+};
+export type BulkFindMatchesRequest = {
+    filters: BulkFindMatchesFilter[];
+};

package/dist/sdk/types/requests.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=requests.js.map

package/dist/sdk/types/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../src/sdk/types/requests.ts"],"names":[],"mappings":""}

package/dist/sdk/utils.d.ts

@@ -0,0 +1,6 @@
+type TransformObjectKeys<T> = {
+    [K in keyof T as K extends string ? TransformKey<K> : never]: T[K] extends object ? TransformObjectKeys<T[K]> : T[K];
+};
+type TransformKey<T extends string> = T extends `${infer F}${infer R}` ? F extends Capitalize<F> ? `-${Lowercase<F>}${TransformKey<R>}` : `${F}${TransformKey<R>}` : Lowercase<T>;
+export declare const transformToQueryParam: <T extends object>(object: T) => TransformObjectKeys<T>;
+export {};

package/dist/sdk/utils.js

@@ -0,0 +1,12 @@
+// TODO: could this be useful on node-core?
+export const transformToQueryParam = (object) => {
+    const transformed = {};
+    for (const key in object) {
+        const value = object[key];
+        const transformedKey = key.replace(/[A-Z]/g, (char) => `-${char.toLowerCase()}`);
+        transformed[transformedKey] =
+            typeof value === 'object' ? transformToQueryParam(value) : value;
+    }
+    return transformed;
+};
+//# sourceMappingURL=utils.js.map

package/dist/sdk/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/sdk/utils.ts"],"names":[],"mappings":"AAYA,2CAA2C;AAC3C,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAmB,MAAS,EAA0B,EAAE;IAC3F,MAAM,WAAW,GAA4B,EAAE,CAAA;IAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QACzB,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;QAEhF,WAAW,CAAC,cAAc,CAAC;YACzB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC,KAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;KAC7E;IAED,OAAO,WAAqC,CAAA;AAC9C,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@lokalise/tm-sdk",
+  "version": "1.0.0",
+  "author": {
+    "name": "Lokalise",
+    "url": "https://lokalise.com/"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/lokalise/tm-service.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "scripts": {
+    "build": "shx rm -rf ./dist && tsc",
+    "build:publish": "shx rm -rf ./dist && tsc -p tsconfig.publish.json",
+    "lint": "eslint . --ext .ts && prettier --check \"**/*.{json,md,ts}\" && tsc --noEmit",
+    "lint:fix": "eslint .  --ext .ts --fix && prettier --write --log-level warn \"**/*.{json,md,ts}\"",
+    "test": "vitest",
+    "test:coverage": "npm test -- --coverage",
+    "test:ci": "npm run test:coverage",
+    "version": "auto-changelog -p && git add CHANGELOG.md",
+    "prepublishOnly": "npm run build:publish"
+  },
+  "dependencies": {
+    "@lokalise/api-common": "^2.0.0",
+    "@lokalise/node-core": "^9.7.0",
+    "undici": "^6.4.0",
+    "undici-retry": "^5.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
+    "@vitest/coverage-v8": "^1.2.1",
+    "auto-changelog": "^2.4.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-vitest": "^0.3.20",
+    "mockttp": "^3.10.1",
+    "prettier": "^3.2.4",
+    "shx": "^0.3.4",
+    "typescript": "5.3.3",
+    "vitest": "^1.2.1"
+  }
+}