@lokalise/polyglot-sdk 1.0.1

package/dist/index.d.ts

@@ -0,0 +1 @@
+export declare function add(a: number, b: number): number;

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.add = void 0;
+function add(a, b) {
+    return a + b;
+}
+exports.add = add;
+//# 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,SAAgB,GAAG,CAAC,CAAS,EAAE,CAAS;IACtC,OAAO,CAAC,GAAG,CAAC,CAAA;AACd,CAAC;AAFD,kBAEC"}

package/dist/sdk/PolyglotClient.d.ts

@@ -0,0 +1,34 @@
+import type { ClientOptions, PolyglotClientConfig } from './types/client';
+import type { GenerateVariantsRequest, LqaSyncRequest, TranslateSyncRequest } from './types/requests';
+import type { ContentUnitLqaResponse, ContentUnitTranslationResponse, PolyglotClientSyncIterativeResponse } from './types/responses';
+export declare class PolyglotClient {
+    private readonly client;
+    private readonly clientHeaders;
+    private readonly retryConfig;
+    private readonly logger?;
+    constructor({ baseUrl, jwtToken, retryConfig, logger }: PolyglotClientConfig);
+    /**
+     * Translates segments in content units via /translate-sync API. Will chunk the request automatically into batches if
+     * the amount of segments exceeds synchronous API limits and will yield the results separately.
+     */
+    translateSyncIterative(request: TranslateSyncRequest, options?: ClientOptions): AsyncGenerator<PolyglotClientSyncIterativeResponse<ContentUnitTranslationResponse>>;
+    /**
+     * Reviews segment translations via LQA process with /lqa-sync API. Will chunk the request automatically into batches if
+     * the amount of segments exceeds synchronous API limits and will yield the results separately.
+     */
+    lqaSyncIterative(request: LqaSyncRequest, options?: ClientOptions): AsyncGenerator<PolyglotClientSyncIterativeResponse<ContentUnitLqaResponse>>;
+    /**
+     * Re-translates a given translation pair and provides several different variants. Can take previously generated
+     * variants as an input - in attempt to avoid repetition.
+     */
+    generateVariants(request: GenerateVariantsRequest, { fakeProcessing, metadata, reqContext }?: ClientOptions): Promise<string[]>;
+    private callTranslateSyncApi;
+    private callLqaSyncApi;
+    /**
+     * Calls the provided request function and wraps its execution within NewRelic transaction (if manager is available)
+     * and logs the execution time and metadata with the provided logger
+     * @private
+     */
+    private wrapWithInstrumentation;
+    private wrapError;
+}

package/dist/sdk/PolyglotClient.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolyglotClient = void 0;
+const node_core_1 = require("@lokalise/node-core");
+const PolyglotError_1 = require("./errors/PolyglotError");
+const polyglotChunkHandler_1 = require("./polyglotChunkHandler");
+const DEFAULT_CLIENT_OPTIONS = {};
+class PolyglotClient {
+    client;
+    clientHeaders;
+    retryConfig;
+    logger;
+    constructor({ baseUrl, jwtToken, retryConfig, logger }) {
+        this.client = (0, node_core_1.buildClient)(baseUrl);
+        this.clientHeaders = {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${jwtToken}`,
+        };
+        this.retryConfig = {
+            retryOnTimeout: false,
+            maxAttempts: 5,
+            delayBetweenAttemptsInMsecs: 250,
+            statusCodesToRetry: [
+                408, // Request timeout
+                423, // Resource is blocked
+                429, // Too Many requests
+                500, // Internal server error
+                503, // Service unavailable
+                504, // Gateway timeout,
+            ],
+            ...retryConfig,
+        };
+        this.logger = logger;
+    }
+    /**
+     * Translates segments in content units via /translate-sync API. Will chunk the request automatically into batches if
+     * the amount of segments exceeds synchronous API limits and will yield the results separately.
+     */
+    async *translateSyncIterative(request, options = DEFAULT_CLIENT_OPTIONS) {
+        const chunks = (0, polyglotChunkHandler_1.getChunkedTranslationRequest)(request);
+        for (const requestChunked of chunks) {
+            yield {
+                response: await this.callTranslateSyncApi(requestChunked, options),
+                segmentIdsProcessedByContentUnitId: requestChunked.contentUnits.reduce((acc, cu) => {
+                    if (!acc[cu.id])
+                        acc[cu.id] = [];
+                    acc[cu.id].push(...cu.segments.map((s) => s.id));
+                    return acc;
+                }, {}),
+            };
+        }
+    }
+    /**
+     * Reviews segment translations via LQA process with /lqa-sync API. Will chunk the request automatically into batches if
+     * the amount of segments exceeds synchronous API limits and will yield the results separately.
+     */
+    async *lqaSyncIterative(request, options = DEFAULT_CLIENT_OPTIONS) {
+        const chunks = (0, polyglotChunkHandler_1.getChunkedLqaRequest)(request);
+        for (const requestChunked of chunks) {
+            yield {
+                response: await this.callLqaSyncApi(requestChunked, options),
+                segmentIdsProcessedByContentUnitId: requestChunked.contentUnits.reduce((acc, cu) => {
+                    if (!acc[cu.id])
+                        acc[cu.id] = [];
+                    acc[cu.id].push(...cu.segments.flatMap((s) => s.translations).map((t) => t.id));
+                    return acc;
+                }, {}),
+            };
+        }
+    }
+    /**
+     * Re-translates a given translation pair and provides several different variants. Can take previously generated
+     * variants as an input - in attempt to avoid repetition.
+     */
+    async generateVariants(request, { fakeProcessing, metadata, reqContext } = DEFAULT_CLIENT_OPTIONS) {
+        if (request.sourceValue.trim() === '' || request.targetValue.trim() === '') {
+            return [];
+        }
+        const requestLabel = 'Generate variants (Polyglot)';
+        const response = await this.wrapWithInstrumentation(() => {
+            return (0, node_core_1.sendPost)(this.client, '/v1/content/actions/generate-variants', request, {
+                reqContext,
+                retryConfig: this.retryConfig,
+                headers: {
+                    ...this.clientHeaders,
+                    'x-fake-processing': fakeProcessing ? 'true' : undefined,
+                },
+                requestLabel,
+            });
+        }, {
+            requestLabel,
+            callMetadata: {
+                ...metadata,
+                reqContext: JSON.stringify(reqContext),
+            },
+        });
+        return response.body.variants;
+    }
+    async callTranslateSyncApi(request, { fakeProcessing, metadata, reqContext }) {
+        const requestLabel = 'Translate synchronously (Polyglot)';
+        const result = await this.wrapWithInstrumentation(() => {
+            return (0, node_core_1.sendPost)(this.client, '/v1/content/actions/translate-sync', request, {
+                reqContext,
+                retryConfig: this.retryConfig,
+                headers: {
+                    ...this.clientHeaders,
+                    'x-fake-processing': fakeProcessing ? 'true' : undefined,
+                },
+                requestLabel,
+            });
+        }, {
+            requestLabel,
+            callMetadata: {
+                ...metadata,
+                reqContext: JSON.stringify(reqContext),
+            },
+        });
+        return result.body.contentUnits;
+    }
+    async callLqaSyncApi(request, { fakeProcessing, metadata, reqContext }) {
+        const requestLabel = 'Review with LQA synchronously (Polyglot)';
+        const result = await this.wrapWithInstrumentation(() => {
+            return (0, node_core_1.sendPost)(this.client, '/v1/content/actions/lqa-sync', request, {
+                reqContext,
+                retryConfig: this.retryConfig,
+                headers: {
+                    ...this.clientHeaders,
+                    'x-fake-processing': fakeProcessing ? 'true' : undefined,
+                },
+                requestLabel,
+            });
+        }, {
+            requestLabel,
+            callMetadata: {
+                ...metadata,
+                reqContext: JSON.stringify(reqContext),
+            },
+        });
+        return result.body.contentUnits;
+    }
+    /**
+     * Calls the provided request function and wraps its execution within NewRelic transaction (if manager is available)
+     * and logs the execution time and metadata with the provided logger
+     * @private
+     */
+    async wrapWithInstrumentation(innerFn, { callMetadata, requestLabel }) {
+        let successful = false;
+        const startTime = performance.now();
+        try {
+            const { result, error } = await innerFn();
+            // We might receive an non-satisfactory response, but it might not be an Error object - so we have to wrap it
+            if (error) {
+                // noinspection ExceptionCaughtLocallyJS
+                throw error;
+            }
+            successful = true;
+            return result;
+        }
+        catch (e) {
+            throw this.wrapError(e);
+        }
+        finally {
+            this.logger?.info({
+                ...callMetadata,
+                successful,
+                msg: `Completed ${requestLabel}`,
+                duration: performance.now() - startTime,
+            });
+        }
+    }
+    wrapError(e) {
+        let error;
+        if (e instanceof Error) {
+            error = (0, node_core_1.isResponseStatusError)(e) ? new PolyglotError_1.PolyglotError(e) : e;
+        }
+        else {
+            error = new node_core_1.InternalError({
+                message: 'Unknown error',
+                errorCode: 'UNKNOWN_ERROR',
+                details: { error: JSON.stringify(e) },
+            });
+        }
+        return error;
+    }
+}
+exports.PolyglotClient = PolyglotClient;
+//# sourceMappingURL=PolyglotClient.js.map

package/dist/sdk/PolyglotClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PolyglotClient.js","sourceRoot":"","sources":["../../src/sdk/PolyglotClient.ts"],"names":[],"mappings":";;;AAAA,mDAAiG;AAMjG,0DAAsD;AACtD,iEAA2F;AAe3F,MAAM,sBAAsB,GAAkB,EAAE,CAAA;AAEhD,MAAa,cAAc;IACR,MAAM,CAAQ;IACd,aAAa,CAAyB;IACtC,WAAW,CAAa;IACxB,MAAM,CAAS;IAEhC,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAwB;QAC1E,IAAI,CAAC,MAAM,GAAG,IAAA,uBAAW,EAAC,OAAO,CAAC,CAAA;QAClC,IAAI,CAAC,aAAa,GAAG;YACnB,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,QAAQ,EAAE;SACpC,CAAA;QACD,IAAI,CAAC,WAAW,GAAG;YACjB,cAAc,EAAE,KAAK;YACrB,WAAW,EAAE,CAAC;YACd,2BAA2B,EAAE,GAAG;YAChC,kBAAkB,EAAE;gBAClB,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,sBAAsB;gBAC3B,GAAG,EAAE,oBAAoB;gBACzB,GAAG,EAAE,wBAAwB;gBAC7B,GAAG,EAAE,sBAAsB;gBAC3B,GAAG,EAAE,mBAAmB;aACzB;YACD,GAAG,WAAW;SACf,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,CAAC,sBAAsB,CAC3B,OAA6B,EAC7B,UAAyB,sBAAsB;QAE/C,MAAM,MAAM,GAAG,IAAA,mDAA4B,EAAC,OAAO,CAAC,CAAA;QAEpD,KAAK,MAAM,cAAc,IAAI,MAAM,EAAE,CAAC;YACpC,MAAM;gBACJ,QAAQ,EAAE,MAAM,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,OAAO,CAAC;gBAClE,kCAAkC,EAAE,cAAc,CAAC,YAAY,CAAC,MAAM,CACpE,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;oBACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;wBAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAA;oBAChC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;oBAChD,OAAO,GAAG,CAAA;gBACZ,CAAC,EACD,EAA8B,CAC/B;aACF,CAAA;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,CAAC,gBAAgB,CACrB,OAAuB,EACvB,UAAyB,sBAAsB;QAE/C,MAAM,MAAM,GAAG,IAAA,2CAAoB,EAAC,OAAO,CAAC,CAAA;QAE5C,KAAK,MAAM,cAAc,IAAI,MAAM,EAAE,CAAC;YACpC,MAAM;gBACJ,QAAQ,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,OAAO,CAAC;gBAC5D,kCAAkC,EAAE,cAAc,CAAC,YAAY,CAAC,MAAM,CACpE,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;oBACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;wBAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAA;oBAChC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;oBAC/E,OAAO,GAAG,CAAA;gBACZ,CAAC,EACD,EAA8B,CAC/B;aACF,CAAA;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAgC,EAChC,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,KAAoB,sBAAsB;QAEhF,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3E,OAAO,EAAE,CAAA;QACX,CAAC;QAED,MAAM,YAAY,GAAG,8BAA8B,CAAA;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CACjD,GAAG,EAAE;YACH,OAAO,IAAA,oBAAQ,EACb,IAAI,CAAC,MAAM,EACX,uCAAuC,EACvC,OAAO,EACP;gBACE,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE;oBACP,GAAG,IAAI,CAAC,aAAa;oBACrB,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;iBACzD;gBACD,YAAY;aACb,CACF,CAAA;QACH,CAAC,EACD;YACE,YAAY;YACZ,YAAY,EAAE;gBACZ,GAAG,QAAQ;gBACX,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;aACvC;SACF,CACF,CAAA;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAA;IAC/B,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,OAA6B,EAC7B,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAiB;QAEvD,MAAM,YAAY,GAAG,oCAAoC,CAAA;QACzD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAC/C,GAAG,EAAE;YACH,OAAO,IAAA,oBAAQ,EACb,IAAI,CAAC,MAAM,EACX,oCAAoC,EACpC,OAAO,EACP;gBACE,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE;oBACP,GAAG,IAAI,CAAC,aAAa;oBACrB,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;iBACzD;gBACD,YAAY;aACb,CACF,CAAA;QACH,CAAC,EACD;YACE,YAAY;YACZ,YAAY,EAAE;gBACZ,GAAG,QAAQ;gBACX,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;aACvC;SACF,CACF,CAAA;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAA;IACjC,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,OAAuB,EACvB,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAiB;QAEvD,MAAM,YAAY,GAAG,0CAA0C,CAAA;QAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAC/C,GAAG,EAAE;YACH,OAAO,IAAA,oBAAQ,EACb,IAAI,CAAC,MAAM,EACX,8BAA8B,EAC9B,OAAO,EACP;gBACE,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE;oBACP,GAAG,IAAI,CAAC,aAAa;oBACrB,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;iBACzD;gBACD,YAAY;aACb,CACF,CAAA;QACH,CAAC,EACD;YACE,YAAY;YACZ,YAAY,EAAE;gBACZ,GAAG,QAAQ;gBACX,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;aACvC;SACF,CACF,CAAA;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,uBAAuB,CACnC,OAAgF,EAChF,EAAE,YAAY,EAAE,YAAY,EAA0B;QAEtD,IAAI,UAAU,GAAG,KAAK,CAAA;QACtB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;QAEnC,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,OAAO,EAAE,CAAA;YAEzC,6GAA6G;YAC7G,IAAI,KAAK,EAAE,CAAC;gBACV,wCAAwC;gBACxC,MAAM,KAAK,CAAA;YACb,CAAC;YAED,UAAU,GAAG,IAAI,CAAA;YACjB,OAAO,MAAM,CAAA;QACf,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC;gBAChB,GAAG,YAAY;gBACf,UAAU;gBACV,GAAG,EAAE,aAAa,YAAY,EAAE;gBAChC,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;aACxC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,CAAU;QAC1B,IAAI,KAAwB,CAAA;QAC5B,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;YACvB,KAAK,GAAG,IAAA,iCAAqB,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,6BAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7D,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,yBAAa,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;QACJ,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AA9OD,wCA8OC"}

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

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

package/dist/sdk/errors/PolyglotError.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolyglotError = void 0;
+const node_core_1 = require("@lokalise/node-core");
+class PolyglotError extends node_core_1.InternalError {
+    constructor(error) {
+        super({
+            message: `Polyglot service failed with error: ${error.message}`,
+            details: {
+                responseBody: JSON.stringify(error.response.body),
+                details: error.details,
+            },
+            errorCode: error.errorCode,
+        });
+    }
+}
+exports.PolyglotError = PolyglotError;
+//# sourceMappingURL=PolyglotError.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PolyglotError.js","sourceRoot":"","sources":["../../../src/sdk/errors/PolyglotError.ts"],"names":[],"mappings":";;;AACA,mDAAmD;AAEnD,MAAa,aAAc,SAAQ,yBAAa;IAC9C,YAAY,KAA0B;QACpC,KAAK,CAAC;YACJ,OAAO,EAAE,uCAAuC,KAAK,CAAC,OAAO,EAAE;YAC/D,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;AAXD,sCAWC"}

package/dist/sdk/polyglotChunkHandler.d.ts

@@ -0,0 +1,16 @@
+import type { LqaSyncRequest, TranslateSyncRequest } from './types/requests';
+/**
+ * Polyglot synchronous APIs are limited to X items at once - to keep the response time reasonable and not hit
+ * any sort of API gateway timeouts.
+ */
+export declare const REQUEST_SIZE_LIMIT_TRANSLATE_SYNC = 15;
+export declare const REQUEST_SIZE_LIMIT_LQA_SYNC = 15;
+export type ContentUnitSegment = {
+    id: string;
+};
+export type ContentUnitResponse<T extends ContentUnitSegment> = {
+    id: string;
+    segments: T[];
+};
+export declare function getChunkedTranslationRequest(request: TranslateSyncRequest, polyglotSegmentMaxProcessLimit?: number): Generator<TranslateSyncRequest>;
+export declare function getChunkedLqaRequest(request: LqaSyncRequest, polyglotSegmentMaxProcessLimit?: number): Generator<LqaSyncRequest>;

package/dist/sdk/polyglotChunkHandler.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChunkedLqaRequest = exports.getChunkedTranslationRequest = exports.REQUEST_SIZE_LIMIT_LQA_SYNC = exports.REQUEST_SIZE_LIMIT_TRANSLATE_SYNC = void 0;
+const node_core_1 = require("@lokalise/node-core");
+/**
+ * Polyglot synchronous APIs are limited to X items at once - to keep the response time reasonable and not hit
+ * any sort of API gateway timeouts.
+ */
+exports.REQUEST_SIZE_LIMIT_TRANSLATE_SYNC = 15;
+exports.REQUEST_SIZE_LIMIT_LQA_SYNC = 15;
+// TODO: AP-1395 - Look at refactoring the chunk methods into smaller alternatives
+// eslint-disable-next-line max-statements
+function* getChunkedTranslationRequest(request, polyglotSegmentMaxProcessLimit = exports.REQUEST_SIZE_LIMIT_TRANSLATE_SYNC) {
+    const contentUnits = request.contentUnits.filter((contentUnit) => contentUnit.segments.length > 0);
+    if (contentUnits.length === 0) {
+        return;
+    }
+    const chunkedRequest = {
+        context: request.context,
+        sourceLocale: request.sourceLocale,
+        targetLocale: request.targetLocale,
+        contentUnits: [],
+    };
+    let totalSegmentsInRequest = 0;
+    for (const contentUnit of contentUnits) {
+        let segmentsChunked = [];
+        let startOffset = 0;
+        do {
+            segmentsChunked = contentUnit.segments.slice(startOffset, polyglotSegmentMaxProcessLimit + startOffset - totalSegmentsInRequest);
+            startOffset += polyglotSegmentMaxProcessLimit - totalSegmentsInRequest;
+            if (segmentsChunked.length === 0) {
+                startOffset = 0;
+                continue;
+            }
+            totalSegmentsInRequest += segmentsChunked.length;
+            chunkedRequest.contentUnits.push({ ...contentUnit, segments: segmentsChunked });
+            if (totalSegmentsInRequest === polyglotSegmentMaxProcessLimit) {
+                yield (0, node_core_1.deepClone)(chunkedRequest);
+                chunkedRequest.contentUnits = [];
+                totalSegmentsInRequest = 0;
+            }
+        } while (segmentsChunked.length !== 0);
+    }
+    if (chunkedRequest.contentUnits.length) {
+        yield (0, node_core_1.deepClone)(chunkedRequest);
+    }
+}
+exports.getChunkedTranslationRequest = getChunkedTranslationRequest;
+// TODO: AP-1395 - Look at refactoring the chunk methods into smaller alternatives
+// eslint-disable-next-line max-statements
+function* getChunkedLqaRequest(request, polyglotSegmentMaxProcessLimit = exports.REQUEST_SIZE_LIMIT_LQA_SYNC) {
+    const contentUnits = request.contentUnits.filter((contentUnit) => contentUnit.segments.length > 0);
+    if (contentUnits.length === 0) {
+        return;
+    }
+    const chunkedRequest = {
+        sourceLocale: request.sourceLocale,
+        contentUnits: [],
+        assets: request.assets,
+    };
+    let chunkedContentUnit = {
+        id: '',
+        segments: [],
+    };
+    let totalTranslationsInRequest = 0;
+    for (const contentUnit of contentUnits) {
+        let translationsChunked = [];
+        let startOffset = 0;
+        // ** We have existing translations from a previous contentUnit. Add it to the chunkRequest.
+        if (totalTranslationsInRequest !== 0) {
+            chunkedRequest.contentUnits.push(chunkedContentUnit);
+        }
+        // Start a new chunkedContentUnit.
+        chunkedContentUnit = {
+            id: contentUnit.id,
+            segments: [],
+        };
+        // Cycle through a contentUnit's segment assigning it to translationsChunked until we cannot extract anything
+        // further from that segment array.
+        for (const segment of contentUnit.segments) {
+            do {
+                if (!segment.translations || segment.translations.length === 0) {
+                    continue;
+                }
+                // Grab translations based off a start index, and it's length calculated by how many translations we
+                // have already fetched e.g. We are on the first segment, and we have collected nothing. As a result it
+                // will start: 0, end: 15. However, this segment only has four translations, so we add this to the
+                // chunkedContentUnit and get out of the current loop and move onto the next segment within the current
+                // contentUnit. That next segment has 20 translations. We fetch the next batch of translations
+                // start: 0, end: (15 - 4) and add this to the chunkedContentUnit array.
+                //
+                // We have now reached the limit to chunk-by we yield chunkedContentUnit with the contentUnits with
+                // segments and it's translations, reset the start index and stay within the loop because the current
+                // segment still has translations to process.
+                //
+                // If we haven't reached the limit for translations within a contentUnit, we persist it further up in
+                // the previous loop **
+                //
+                // Rinse, wash, and repeat
+                translationsChunked = segment.translations.slice(startOffset, polyglotSegmentMaxProcessLimit + startOffset - totalTranslationsInRequest);
+                startOffset += polyglotSegmentMaxProcessLimit - totalTranslationsInRequest;
+                if (translationsChunked.length === 0) {
+                    startOffset = 0;
+                    continue;
+                }
+                // Any translations that do not have a locale will be removed
+                translationsChunked = filterTranslationsWithoutLanguages(translationsChunked);
+                totalTranslationsInRequest += translationsChunked.length;
+                if (translationsChunked) {
+                    chunkedContentUnit.segments.push({
+                        position: segment.position,
+                        sourceValue: segment.sourceValue,
+                        translations: translationsChunked,
+                    });
+                }
+                // If we have reached the limit of the number of translations, yield the result and reset everything,
+                // except translationChunked.
+                if (totalTranslationsInRequest === polyglotSegmentMaxProcessLimit) {
+                    chunkedRequest.contentUnits.push(chunkedContentUnit);
+                    yield (0, node_core_1.deepClone)(chunkedRequest);
+                    chunkedContentUnit = {
+                        id: contentUnit.id,
+                        segments: [],
+                    };
+                    chunkedRequest.contentUnits = [];
+                    totalTranslationsInRequest = 0;
+                }
+                // Did we manage to find any translations from the slice? If not, that means the segment no longer has
+                // anything more, move onto the next segment keep whatever chunkedContentUnit we have, persist it
+                // further up in the method **.
+            } while (translationsChunked.length !== 0);
+        }
+    }
+    // In the possibility we have anything left over yield it back.
+    if (totalTranslationsInRequest !== 0) {
+        chunkedRequest.contentUnits.push(chunkedContentUnit);
+        yield (0, node_core_1.deepClone)(chunkedRequest);
+    }
+}
+exports.getChunkedLqaRequest = getChunkedLqaRequest;
+const filterTranslationsWithoutLanguages = (translations) => {
+    return translations.filter((translation) => translation.locale && translation.locale.length !== 0);
+};
+//# sourceMappingURL=polyglotChunkHandler.js.map

package/dist/sdk/polyglotChunkHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polyglotChunkHandler.js","sourceRoot":"","sources":["../../src/sdk/polyglotChunkHandler.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAS/C;;;GAGG;AACU,QAAA,iCAAiC,GAAG,EAAE,CAAA;AACtC,QAAA,2BAA2B,GAAG,EAAE,CAAA;AAW7C,kFAAkF;AAClF,0CAA0C;AAC1C,QAAe,CAAC,CAAC,4BAA4B,CAC3C,OAA6B,EAC7B,iCAAyC,yCAAiC;IAE1E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAClG,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAM;IACR,CAAC;IAED,MAAM,cAAc,GAAyB;QAC3C,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,EAAE;KACjB,CAAA;IAED,IAAI,sBAAsB,GAAG,CAAC,CAAA;IAC9B,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,eAAe,GAAG,EAAE,CAAA;QACxB,IAAI,WAAW,GAAG,CAAC,CAAA;QAEnB,GAAG,CAAC;YACF,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAC1C,WAAW,EACX,8BAA8B,GAAG,WAAW,GAAG,sBAAsB,CACtE,CAAA;YAED,WAAW,IAAI,8BAA8B,GAAG,sBAAsB,CAAA;YACtE,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACjC,WAAW,GAAG,CAAC,CAAA;gBACf,SAAQ;YACV,CAAC;YAED,sBAAsB,IAAI,eAAe,CAAC,MAAM,CAAA;YAChD,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAA;YAE/E,IAAI,sBAAsB,KAAK,8BAA8B,EAAE,CAAC;gBAC9D,MAAM,IAAA,qBAAS,EAAC,cAAc,CAAC,CAAA;gBAC/B,cAAc,CAAC,YAAY,GAAG,EAAE,CAAA;gBAChC,sBAAsB,GAAG,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC,QAAQ,eAAe,CAAC,MAAM,KAAK,CAAC,EAAC;IACxC,CAAC;IAED,IAAI,cAAc,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QACvC,MAAM,IAAA,qBAAS,EAAC,cAAc,CAAC,CAAA;IACjC,CAAC;AACH,CAAC;AA/CD,oEA+CC;AAED,kFAAkF;AAClF,0CAA0C;AAC1C,QAAe,CAAC,CAAC,oBAAoB,CACnC,OAAuB,EACvB,iCAAyC,mCAA2B;IAEpE,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAClG,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAM;IACR,CAAC;IAED,MAAM,cAAc,GAAmB;QACrC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,EAAE;QAChB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAA;IACD,IAAI,kBAAkB,GAAmB;QACvC,EAAE,EAAE,EAAE;QACN,QAAQ,EAAE,EAAE;KACb,CAAA;IACD,IAAI,0BAA0B,GAAG,CAAC,CAAA;IAClC,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,mBAAmB,GAAqB,EAAE,CAAA;QAC9C,IAAI,WAAW,GAAG,CAAC,CAAA;QAEnB,4FAA4F;QAC5F,IAAI,0BAA0B,KAAK,CAAC,EAAE,CAAC;YACrC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACtD,CAAC;QAED,kCAAkC;QAClC,kBAAkB,GAAG;YACnB,EAAE,EAAE,WAAW,CAAC,EAAE;YAClB,QAAQ,EAAE,EAAE;SACb,CAAA;QAED,6GAA6G;QAC7G,mCAAmC;QACnC,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC3C,GAAG,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/D,SAAQ;gBACV,CAAC;gBAED,oGAAoG;gBACpG,uGAAuG;gBACvG,kGAAkG;gBAClG,uGAAuG;gBACvG,8FAA8F;gBAC9F,wEAAwE;gBACxE,EAAE;gBACF,mGAAmG;gBACnG,qGAAqG;gBACrG,6CAA6C;gBAC7C,EAAE;gBACF,qGAAqG;gBACrG,uBAAuB;gBACvB,EAAE;gBACF,0BAA0B;gBAC1B,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAC9C,WAAW,EACX,8BAA8B,GAAG,WAAW,GAAG,0BAA0B,CAC1E,CAAA;gBAED,WAAW,IAAI,8BAA8B,GAAG,0BAA0B,CAAA;gBAC1E,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACrC,WAAW,GAAG,CAAC,CAAA;oBACf,SAAQ;gBACV,CAAC;gBAED,6DAA6D;gBAC7D,mBAAmB,GAAG,kCAAkC,CAAC,mBAAmB,CAAC,CAAA;gBAC7E,0BAA0B,IAAI,mBAAmB,CAAC,MAAM,CAAA;gBACxD,IAAI,mBAAmB,EAAE,CAAC;oBACxB,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAC/B,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,YAAY,EAAE,mBAAmB;qBAClC,CAAC,CAAA;gBACJ,CAAC;gBAED,qGAAqG;gBACrG,6BAA6B;gBAC7B,IAAI,0BAA0B,KAAK,8BAA8B,EAAE,CAAC;oBAClE,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;oBACpD,MAAM,IAAA,qBAAS,EAAC,cAAc,CAAC,CAAA;oBAE/B,kBAAkB,GAAG;wBACnB,EAAE,EAAE,WAAW,CAAC,EAAE;wBAClB,QAAQ,EAAE,EAAE;qBACb,CAAA;oBAED,cAAc,CAAC,YAAY,GAAG,EAAE,CAAA;oBAChC,0BAA0B,GAAG,CAAC,CAAA;gBAChC,CAAC;gBAED,sGAAsG;gBACtG,iGAAiG;gBACjG,+BAA+B;YACjC,CAAC,QAAQ,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAC;QAC5C,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,IAAI,0BAA0B,KAAK,CAAC,EAAE,CAAC;QACrC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACpD,MAAM,IAAA,qBAAS,EAAC,cAAc,CAAC,CAAA;IACjC,CAAC;AACH,CAAC;AA1GD,oDA0GC;AAED,MAAM,kCAAkC,GAAG,CAAC,YAA8B,EAAE,EAAE;IAC5E,OAAO,YAAY,CAAC,MAAM,CACxB,CAAC,WAA2B,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CACvF,CAAA;AACH,CAAC,CAAA"}

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

@@ -0,0 +1,19 @@
+import type { RequestContext } from '@lokalise/fastify-extras';
+import type { Logger } from 'pino';
+import type { RetryConfig } from 'undici-retry';
+export type ClientOptions = {
+    fakeProcessing?: boolean;
+    reqContext?: RequestContext;
+    metadata?: Record<string, string>;
+};
+export type InstrumentationOptions = {
+    requestLabel: string;
+    callMetadata?: Record<string, string>;
+};
+export type PolyglotClientConfig = {
+    baseUrl: string;
+    jwtToken: string;
+    isEnabled?: boolean;
+    retryConfig?: Partial<RetryConfig>;
+    logger?: Logger;
+};

package/dist/sdk/types/client.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=client.js.map

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

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

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

@@ -0,0 +1,70 @@
+export type TranslateSyncRequest = {
+    sourceLocale: string;
+    targetLocale: string;
+    contentUnits: TranslateSyncContentUnits[];
+    context?: PolyglotAssetsRequest;
+};
+export type TranslateSyncContentUnits = {
+    id: string;
+    segments: {
+        id: string;
+        position: number;
+        value: string;
+    }[];
+};
+export type LqaSyncRequest = {
+    sourceLocale: string;
+    assets?: Omit<PolyglotAssetsRequest, 'styleGuide'>;
+    contentUnits: LqaContentUnit[];
+};
+export type LqaContentUnit = {
+    id: string;
+    segments: LqaSegment[];
+};
+export type LqaSegment = {
+    sourceValue: string;
+    position: number;
+    translations: LqaTranslation[];
+};
+export type LqaTranslation = {
+    id: string;
+    locale: string;
+    value: string;
+};
+type SegmentVariantsMode = 'REPHRASE' | 'SHORTEN';
+type SegmentVariantsHistory = {
+    values: string[];
+    mode: SegmentVariantsMode;
+};
+export type GenerateVariantsRequest = {
+    mode: SegmentVariantsMode;
+    sourceLocale: string;
+    sourceValue: string;
+    targetLocale: string;
+    targetValue: string;
+    history?: SegmentVariantsHistory[];
+    assets?: PolyglotAssetsRequest;
+};
+export type StyleGuideAnswers = {
+    targetAudience: string;
+    toneOfVoice: string;
+    levelOfFormality: string;
+    generalRule: string;
+};
+export type PolyglotAssetsRequest = {
+    description?: string;
+    styleGuide?: StyleGuideAnswers;
+    glossary?: PolyglotGlossaryTermRequest[];
+};
+export type PolyglotGlossaryTermRequest = {
+    term: string;
+    description?: string;
+    translatable: boolean;
+    caseSensitive: boolean;
+    translations: {
+        locale: string;
+        translation: string;
+        description?: string;
+    }[];
+};
+export {};

package/dist/sdk/types/requests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/types/responses.d.ts

@@ -0,0 +1,38 @@
+export type PolyglotClientSyncIterativeResponse<T extends ContentUnitLqaResponse | ContentUnitTranslationResponse> = {
+    segmentIdsProcessedByContentUnitId: Record<string, string[]>;
+    response: T[];
+};
+export type PolyglotSyncResponse<T extends object> = {
+    generatedAt: string;
+    sourceLocale: string;
+    contentUnits: T[];
+};
+export type ContentUnitTranslationResponse = {
+    id: string;
+    segments: {
+        id: string;
+        locale: string;
+        position: number;
+        translation: string;
+        engine: string;
+    }[];
+};
+export type LqaSeverityResponse = 'neutral' | 'minor' | 'major' | 'critical';
+export type LqaCategoryResponse = 'accuracy' | 'fluency' | 'terminology' | 'locale convention' | 'style' | 'consistency' | 'coherence' | 'design' | 'markup' | 'internationalization' | 'verity';
+export type ContentUnitLqaResponse = {
+    id: string;
+    segments: SegmentLqaResponse[];
+};
+export type SegmentLqaResponse = {
+    id: string;
+    value: string;
+    issues: {
+        severity: LqaSeverityResponse;
+        category: LqaCategoryResponse;
+        comment?: string;
+    }[];
+    suggestion?: string;
+};
+export type PolyglotGenerateVariantsResponse = {
+    variants: string[];
+};

package/dist/sdk/types/responses.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=responses.js.map

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

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

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@lokalise/polyglot-sdk",
+  "version": "1.0.1",
+  "author": {
+    "name": "Lokalise",
+    "url": "https://lokalise.com/"
+  },
+  "description": "REST API client for the Lokalise Polyglot service",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/lokalise/polyglot-service.git"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "shx rm -rf ./dist && tsc",
+    "build:publish": "shx rm -rf ./dist && tsc -p tsconfig.publish.json",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint .  --ext .ts --fix",
+    "test": "vitest",
+    "test:coverage": "npm test -- --coverage",
+    "test:ci": "npm run test:coverage",
+    "prepublishOnly": "npm run build:publish"
+  },
+  "dependencies": {
+    "@amplitude/analytics-types": "^2.5.0",
+    "@lokalise/fastify-extras": "^16.5.0",
+    "@lokalise/id-utils": "^1.0.0",
+    "@lokalise/node-core": "^9.10.1",
+    "@lokalise/zod-extras": "^2.0.1",
+    "undici": "^6.6.2",
+    "undici-retry": "^5.0.2",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.2",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
+    "@vitest/coverage-v8": "^0.34.6",
+    "auto-changelog": "^2.4.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-vitest": "^0.3.22",
+    "mockttp": "^3.10.1",
+    "prettier": "^3.2.5",
+    "shx": "^0.3.4",
+    "ts-deepmerge": "^7.0.0",
+    "typescript": "5.3.3",
+    "vitest": "^0.34.6"
+  }
+}