@lokalise/polyglot-sdk 6.0.1 → 7.0.0

package/dist/sdk/schemas/translation/syncTranslationV2Schemas.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SYNC_TRANSLATION_V2_RESPONSE_SCHEMA = exports.SYNC_TRANSLATION_V2_HEADERS_SCHEMA = exports.SYNC_TRANSLATION_V2_BODY_SCHEMA = exports.SYNC_TRANSLATION_V2_CONTENT_UNIT_SCHEMA = exports.SYNC_TRANSLATION_V2_SEGMENT_SCHEMA = void 0;
+const tslib_1 = require("tslib");
+const zod_1 = tslib_1.__importDefault(require("zod"));
+const commonSchemas_1 = require("../common/commonSchemas");
+const requestContextSchemas_1 = require("../common/requestContextSchemas");
+const sharedSchemas_1 = require("./sharedSchemas");
+const SEGMENT_ID_MAX_LENGTH = 100;
+const SEGMENT_VALUE_MAX_LENGTH = 5000;
+const CONTENT_UNIT_ID_MAX_LENGTH = 100;
+const CONTENT_UNIT_DESCRIPTION_MAX_LENGTH = 500;
+const CONTENT_UNIT_SEGMENTS_MAX_LENGTH = 500;
+const CONTENT_UNITS_MAX_LENGTH = 50;
+const SYNC_TRANSLATION_V2_SEGMENT_ID_SCHEMA = zod_1.default.string().min(1).max(SEGMENT_ID_MAX_LENGTH);
+exports.SYNC_TRANSLATION_V2_SEGMENT_SCHEMA = zod_1.default.object({
+    id: SYNC_TRANSLATION_V2_SEGMENT_ID_SCHEMA,
+    tmMatch: commonSchemas_1.TM_MATCH_SCHEMA,
+    value: zod_1.default.string().min(1).max(SEGMENT_VALUE_MAX_LENGTH),
+});
+const SYNC_TRANSLATION_V2_CONTENT_UNIT_ID_SCHEMA = zod_1.default.string().min(1).max(CONTENT_UNIT_ID_MAX_LENGTH);
+exports.SYNC_TRANSLATION_V2_CONTENT_UNIT_SCHEMA = zod_1.default.object({
+    id: SYNC_TRANSLATION_V2_CONTENT_UNIT_ID_SCHEMA,
+    context: zod_1.default
+        .object({
+        description: zod_1.default.string().min(1).max(CONTENT_UNIT_DESCRIPTION_MAX_LENGTH),
+    })
+        .optional(),
+    characterLimit: zod_1.default.number().optional(),
+    segments: zod_1.default
+        .array(exports.SYNC_TRANSLATION_V2_SEGMENT_SCHEMA)
+        .nonempty()
+        .max(CONTENT_UNIT_SEGMENTS_MAX_LENGTH),
+});
+exports.SYNC_TRANSLATION_V2_BODY_SCHEMA = zod_1.default
+    .object({
+    sourceLocale: commonSchemas_1.LOCALE_SCHEMA,
+    targetLocale: commonSchemas_1.LOCALE_SCHEMA,
+    integration: commonSchemas_1.REAL_INTEGRATION_ENGINE_SCHEMA.optional(),
+    context: requestContextSchemas_1.REQUEST_CONTEXT_SCHEMA.optional(),
+    contentUnits: zod_1.default
+        .array(exports.SYNC_TRANSLATION_V2_CONTENT_UNIT_SCHEMA)
+        .nonempty()
+        .max(CONTENT_UNITS_MAX_LENGTH),
+})
+    .refine(...sharedSchemas_1.refineDifferentSourceAndTargetLang);
+exports.SYNC_TRANSLATION_V2_HEADERS_SCHEMA = commonSchemas_1.COMMON_REQUEST_HEADERS_SCHEMA;
+exports.SYNC_TRANSLATION_V2_RESPONSE_SCHEMA = zod_1.default
+    .object({
+    data: zod_1.default.array(zod_1.default.object({
+        contentUnitId: SYNC_TRANSLATION_V2_SEGMENT_ID_SCHEMA,
+        segmentId: SYNC_TRANSLATION_V2_SEGMENT_ID_SCHEMA,
+        integration: zod_1.default.string(),
+        translation: zod_1.default.string(),
+    })),
+    errors: zod_1.default
+        .array(commonSchemas_1.COMMON_ERROR_RESPONSE_SCHEMA.extend({
+        contentUnitId: SYNC_TRANSLATION_V2_SEGMENT_ID_SCHEMA,
+        segmentId: SYNC_TRANSLATION_V2_SEGMENT_ID_SCHEMA,
+        integration: zod_1.default.string(),
+    }))
+        .optional(),
+})
+    .describe('Results of the sync translation');
+//# sourceMappingURL=syncTranslationV2Schemas.js.map

package/dist/sdk/schemas/translation/syncTranslationV2Schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"syncTranslationV2Schemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/syncTranslationV2Schemas.ts"],"names":[],"mappings":";;;;AAAA,sDAAmB;AAEnB,2DAMgC;AAChC,2EAAwE;AAExE,mDAAoE;AAEpE,MAAM,qBAAqB,GAAG,GAAG,CAAA;AACjC,MAAM,wBAAwB,GAAG,IAAI,CAAA;AACrC,MAAM,0BAA0B,GAAG,GAAG,CAAA;AACtC,MAAM,mCAAmC,GAAG,GAAG,CAAA;AAC/C,MAAM,gCAAgC,GAAG,GAAG,CAAA;AAC5C,MAAM,wBAAwB,GAAG,EAAE,CAAA;AAEnC,MAAM,qCAAqC,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;AAE7E,QAAA,kCAAkC,GAAG,aAAC,CAAC,MAAM,CAAC;IACzD,EAAE,EAAE,qCAAqC;IACzC,OAAO,EAAE,+BAAe;IACxB,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC;CACvD,CAAC,CAAA;AAEF,MAAM,0CAA0C,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;AAEvF,QAAA,uCAAuC,GAAG,aAAC,CAAC,MAAM,CAAC;IAC9D,EAAE,EAAE,0CAA0C;IAC9C,OAAO,EAAE,aAAC;SACP,MAAM,CAAC;QACN,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mCAAmC,CAAC;KACxE,CAAC;SACD,QAAQ,EAAE;IACb,cAAc,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,QAAQ,EAAE,aAAC;SACR,KAAK,CAAC,0CAAkC,CAAC;SACzC,QAAQ,EAAE;SACV,GAAG,CAAC,gCAAgC,CAAC;CACzC,CAAC,CAAA;AAEW,QAAA,+BAA+B,GAAG,aAAC;KAC7C,MAAM,CAAC;IACN,YAAY,EAAE,6BAAa;IAC3B,YAAY,EAAE,6BAAa;IAC3B,WAAW,EAAE,8CAA8B,CAAC,QAAQ,EAAE;IACtD,OAAO,EAAE,8CAAsB,CAAC,QAAQ,EAAE;IAC1C,YAAY,EAAE,aAAC;SACZ,KAAK,CAAC,+CAAuC,CAAC;SAC9C,QAAQ,EAAE;SACV,GAAG,CAAC,wBAAwB,CAAC;CACjC,CAAC;KACD,MAAM,CAAC,GAAG,kDAAkC,CAAC,CAAA;AAEnC,QAAA,kCAAkC,GAAG,6CAA6B,CAAA;AAElE,QAAA,mCAAmC,GAAG,aAAC;KACjD,MAAM,CAAC;IACN,IAAI,EAAE,aAAC,CAAC,KAAK,CACX,aAAC,CAAC,MAAM,CAAC;QACP,aAAa,EAAE,qCAAqC;QACpD,SAAS,EAAE,qCAAqC;QAChD,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE;QACvB,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE;KACxB,CAAC,CACH;IACD,MAAM,EAAE,aAAC;SACN,KAAK,CACJ,4CAA4B,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,qCAAqC;QACpD,SAAS,EAAE,qCAAqC;QAChD,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE;KACxB,CAAC,CACH;SACA,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,iCAAiC,CAAC,CAAA"}

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

@@ -18,6 +18,7 @@ export type TranslateSyncContentUnits = {
     context?: {
         description: string;
     };
+    characterLimit?: number;
     segments: {
         id: string;
         position: number;
@@ -38,6 +39,7 @@ export type LqaContentUnit = {
     context?: {
         description?: string;
     };
+    characterLimit?: number;
     segments: LqaSegment[];
 };
 export type LqaSyncRequestBody = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/polyglot-sdk",
-  "version": "6.0.1",
+  "version": "7.0.0",
   "author": {
     "name": "Lokalise",
     "url": "https://lokalise.com/"
@@ -12,18 +12,18 @@
     "url": "git://github.com/lokalise/polyglot-service.git"
   },
   "files": [
-    "dist/**"
+    "dist"
   ],
+  "type": "commonjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "type": "commonjs",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "shx rm -rf ./dist && tsc",
+    "build": "shx rm -rf ./dist && tsc -p tsconfig.publish.json",
     "build:publish": "shx rm -rf ./dist && tsc -p tsconfig.publish.json",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint . --ext .ts && tsc -p tsconfig.lint.json --noEmit",
     "lint:fix": "eslint .  --ext .ts --fix && prettier --write . ",
     "test": "vitest",
     "test:coverage": "npm test -- --coverage",
@@ -32,17 +32,18 @@
     "prepublishOnly": "npm run build:publish"
   },
   "dependencies": {
-    "@amplitude/analytics-types": "^2.5.1",
-    "@lokalise/fastify-extras": "^21.2.0",
+    "@amplitude/analytics-types": "^2.6.0",
+    "@lokalise/fastify-extras": "^21.3.0",
     "@lokalise/id-utils": "^2.1.0",
     "@lokalise/node-core": "^9.20.0",
+    "@lokalise/supported-languages": "^2.0.0",
     "@lokalise/zod-extras": "^2.1.0",
     "undici": "^6.19.2",
     "undici-retry": "^5.0.2",
     "zod": "^3.23.4"
   },
   "devDependencies": {
-    "@types/node": "^20.14.8",
+    "@types/node": "^20.14.10",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
     "@vitest/coverage-v8": "^1.6.0",
@@ -50,11 +51,11 @@
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-vitest": "^0.4.1",
-    "mockttp": "^3.12.0",
+    "mockttp": "^3.13.0",
     "prettier": "^3.2.5",
     "shx": "^0.3.4",
     "ts-deepmerge": "^7.0.0",
-    "typescript": "5.4.5",
+    "typescript": "5.5.3",
     "vitest": "^1.6.0"
   }
 }

package/dist/sdk/polyglotChunkHandler.d.ts

@@ -1,7 +0,0 @@
-import type { 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 function getChunkedTranslationRequest(request: TranslateSyncRequest, polyglotSegmentMaxProcessLimit?: number): Generator<TranslateSyncRequest>;

package/dist/sdk/polyglotChunkHandler.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getChunkedTranslationRequest = 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;
-// 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;
-//# sourceMappingURL=polyglotChunkHandler.js.map

package/dist/sdk/polyglotChunkHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"polyglotChunkHandler.js","sourceRoot":"","sources":["../../src/sdk/polyglotChunkHandler.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAI/C;;;GAGG;AACU,QAAA,iCAAiC,GAAG,EAAE,CAAA;AAEnD,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"}

package/dist/sdk/segmentUtils.d.ts

@@ -1,2 +0,0 @@
-import type { TranslateSyncContentUnits } from './types/requests';
-export declare function groupTranslationSegmentIdsProcessedByContentUnitId(contentUnits: readonly TranslateSyncContentUnits[]): Record<string, string[]>;

package/dist/sdk/segmentUtils.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.groupTranslationSegmentIdsProcessedByContentUnitId = void 0;
-function groupTranslationSegmentIdsProcessedByContentUnitId(contentUnits) {
-    return contentUnits.reduce((acc, cu) => {
-        if (!acc[cu.id])
-            acc[cu.id] = [];
-        acc[cu.id].push(...cu.segments.map((s) => s.id));
-        return acc;
-    }, {});
-}
-exports.groupTranslationSegmentIdsProcessedByContentUnitId = groupTranslationSegmentIdsProcessedByContentUnitId;
-//# sourceMappingURL=segmentUtils.js.map

package/dist/sdk/segmentUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"segmentUtils.js","sourceRoot":"","sources":["../../src/sdk/segmentUtils.ts"],"names":[],"mappings":";;;AAEA,SAAgB,kDAAkD,CAChE,YAAkD;IAElD,OAAO,YAAY,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;QACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAA;QAChC,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;QAChD,OAAO,GAAG,CAAA;IACZ,CAAC,EACD,EAA8B,CAC/B,CAAA;AACH,CAAC;AAXD,gHAWC"}