@lokalise/polyglot-sdk 24.0.0 → 24.2.0

package/dist/sdk/contracts/translationContracts.js

@@ -0,0 +1,86 @@
+import { defineApiContract, sseResponse } from '@lokalise/api-contracts';
+import z from 'zod/v4';
+import { COMMON_ERROR_RESPONSE_SCHEMA } from "../schemas/common/commonSchemas.js";
+import { CONTEXT_NOT_SUPPORTED_ERROR_SCHEMA, INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA, INTEGRATION_NOT_ENABLED_ERROR_SCHEMA, LANGUAGE_PAIR_NOT_SUPPORTED_ERROR_SCHEMA, VALIDATION_ERROR_SCHEMA, } from "../schemas/common/errorSchemas.js";
+import { GENERATE_VARIANTS_BODY_SCHEMA, GENERATE_VARIANTS_HEADERS_SCHEMA, GENERATE_VARIANTS_RESPONSE_SCHEMA, } from "../schemas/translation/generateVariants.js";
+import { ERROR_EVENT_SCHEMA, TRANSLATION_EVENT_SCHEMA, } from "../schemas/translation/sharedSchemas.js";
+import { TRANSLATE_ASYNC_BODY_SCHEMA, TRANSLATE_ASYNC_HEADERS_SCHEMA, TRANSLATE_ASYNC_RESPONSE_SCHEMA, } from "../schemas/translation/translateAsyncSchemas.js";
+import { TRANSLATE_SYNC_BODY_SCHEMA, TRANSLATE_SYNC_HEADERS_SCHEMA, TRANSLATE_SYNC_RESPONSE_SCHEMA, } from "../schemas/translation/translateSyncSchemas.js";
+import { TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA, TRANSLATE_TEXT_SEGMENT_HEADERS_SCHEMA, } from "../schemas/translation/translateTextSegmentSchemas.js";
+export const translateAsyncContract = defineApiContract({
+    method: 'post',
+    pathResolver: () => '/v3/content/actions/translate-async',
+    requestBodySchema: TRANSLATE_ASYNC_BODY_SCHEMA,
+    requestHeaderSchema: TRANSLATE_ASYNC_HEADERS_SCHEMA,
+    summary: 'Translate (async) v3',
+    description: 'Schedules a translation from source language to target language. Result is delivered via sending a POST request to a given `callbackUrl`.',
+    tags: ['Translation APIs'],
+    responsesByStatusCode: {
+        202: TRANSLATE_ASYNC_RESPONSE_SCHEMA,
+        400: COMMON_ERROR_RESPONSE_SCHEMA,
+        503: COMMON_ERROR_RESPONSE_SCHEMA,
+    },
+});
+export const translateSyncContract = defineApiContract({
+    method: 'post',
+    pathResolver: () => '/v2/content/actions/translate-sync',
+    requestBodySchema: TRANSLATE_SYNC_BODY_SCHEMA,
+    requestHeaderSchema: TRANSLATE_SYNC_HEADERS_SCHEMA,
+    summary: 'Translate (sync)',
+    description: "Translates a segmented text from source language to target language. Prefer to use Translate (async) in any cases which don't require a result in real-time.",
+    tags: ['Translation APIs'],
+    responsesByStatusCode: {
+        200: TRANSLATE_SYNC_RESPONSE_SCHEMA,
+        400: z.union([
+            COMMON_ERROR_RESPONSE_SCHEMA,
+            VALIDATION_ERROR_SCHEMA,
+            LANGUAGE_PAIR_NOT_SUPPORTED_ERROR_SCHEMA,
+            CONTEXT_NOT_SUPPORTED_ERROR_SCHEMA,
+        ]),
+        503: z.union([
+            COMMON_ERROR_RESPONSE_SCHEMA,
+            INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA,
+            INTEGRATION_NOT_ENABLED_ERROR_SCHEMA,
+        ]),
+    },
+});
+export const generateVariantsContract = defineApiContract({
+    method: 'post',
+    pathResolver: () => '/v1/content/actions/generate-variants',
+    requestBodySchema: GENERATE_VARIANTS_BODY_SCHEMA,
+    requestHeaderSchema: GENERATE_VARIANTS_HEADERS_SCHEMA,
+    summary: 'Rephrase translation',
+    description: 'Generates several different variants of translation for a given text, while trying to avoid previously generated translations.',
+    tags: ['Translation APIs'],
+    responsesByStatusCode: {
+        200: GENERATE_VARIANTS_RESPONSE_SCHEMA,
+        400: z.union([COMMON_ERROR_RESPONSE_SCHEMA, VALIDATION_ERROR_SCHEMA]),
+        503: z.union([
+            COMMON_ERROR_RESPONSE_SCHEMA,
+            INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA,
+            INTEGRATION_NOT_ENABLED_ERROR_SCHEMA,
+        ]),
+    },
+});
+export const translateTextSegmentContract = defineApiContract({
+    method: 'post',
+    pathResolver: () => '/v1/content/actions/translate-text-segment',
+    requestBodySchema: TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA,
+    requestHeaderSchema: TRANSLATE_TEXT_SEGMENT_HEADERS_SCHEMA,
+    summary: 'Translate text segment',
+    description: 'Translates a single text segment from source language to target language and returns results via Server-Sent Events.',
+    tags: ['Translation APIs'],
+    responsesByStatusCode: {
+        200: sseResponse({
+            translation: TRANSLATION_EVENT_SCHEMA.shape.data,
+            error: ERROR_EVENT_SCHEMA.shape.data,
+        }),
+        400: z.union([COMMON_ERROR_RESPONSE_SCHEMA, VALIDATION_ERROR_SCHEMA]),
+        503: z.union([
+            COMMON_ERROR_RESPONSE_SCHEMA,
+            INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA,
+            INTEGRATION_NOT_ENABLED_ERROR_SCHEMA,
+        ]),
+    },
+});
+//# sourceMappingURL=translationContracts.js.map

package/dist/sdk/contracts/translationContracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translationContracts.js","sourceRoot":"","sources":["../../../src/sdk/contracts/translationContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAA;AACjF,OAAO,EACL,kCAAkC,EAClC,sCAAsC,EACtC,oCAAoC,EACpC,wCAAwC,EACxC,uBAAuB,GACxB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,6BAA6B,EAC7B,gCAAgC,EAChC,iCAAiC,GAClC,MAAM,4CAA4C,CAAA;AACnD,OAAO,EACL,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,yCAAyC,CAAA;AAChD,OAAO,EACL,2BAA2B,EAC3B,8BAA8B,EAC9B,+BAA+B,GAChC,MAAM,iDAAiD,CAAA;AACxD,OAAO,EACL,0BAA0B,EAC1B,6BAA6B,EAC7B,8BAA8B,GAC/B,MAAM,gDAAgD,CAAA;AACvD,OAAO,EACL,kCAAkC,EAClC,qCAAqC,GACtC,MAAM,uDAAuD,CAAA;AAE9D,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,qCAAqC;IACzD,iBAAiB,EAAE,2BAA2B;IAC9C,mBAAmB,EAAE,8BAA8B;IACnD,OAAO,EAAE,sBAAsB;IAC/B,WAAW,EACT,2IAA2I;IAC7I,IAAI,EAAE,CAAC,kBAAkB,CAAC;IAC1B,qBAAqB,EAAE;QACrB,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;IACrD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,oCAAoC;IACxD,iBAAiB,EAAE,0BAA0B;IAC7C,mBAAmB,EAAE,6BAA6B;IAClD,OAAO,EAAE,kBAAkB;IAC3B,WAAW,EACT,8JAA8J;IAChK,IAAI,EAAE,CAAC,kBAAkB,CAAC;IAC1B,qBAAqB,EAAE;QACrB,GAAG,EAAE,8BAA8B;QACnC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC;YACX,4BAA4B;YAC5B,uBAAuB;YACvB,wCAAwC;YACxC,kCAAkC;SACnC,CAAC;QACF,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC;YACX,4BAA4B;YAC5B,sCAAsC;YACtC,oCAAoC;SACrC,CAAC;KACH;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACxD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,uCAAuC;IAC3D,iBAAiB,EAAE,6BAA6B;IAChD,mBAAmB,EAAE,gCAAgC;IACrD,OAAO,EAAE,sBAAsB;IAC/B,WAAW,EACT,gIAAgI;IAClI,IAAI,EAAE,CAAC,kBAAkB,CAAC;IAC1B,qBAAqB,EAAE;QACrB,GAAG,EAAE,iCAAiC;QACtC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,4BAA4B,EAAE,uBAAuB,CAAC,CAAC;QACrE,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC;YACX,4BAA4B;YAC5B,sCAAsC;YACtC,oCAAoC;SACrC,CAAC;KACH;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC5D,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,4CAA4C;IAChE,iBAAiB,EAAE,kCAAkC;IACrD,mBAAmB,EAAE,qCAAqC;IAC1D,OAAO,EAAE,wBAAwB;IACjC,WAAW,EACT,sHAAsH;IACxH,IAAI,EAAE,CAAC,kBAAkB,CAAC;IAC1B,qBAAqB,EAAE;QACrB,GAAG,EAAE,WAAW,CAAC;YACf,WAAW,EAAE,wBAAwB,CAAC,KAAK,CAAC,IAAI;YAChD,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI;SACrC,CAAC;QACF,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,4BAA4B,EAAE,uBAAuB,CAAC,CAAC;QACrE,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC;YACX,4BAA4B;YAC5B,sCAAsC;YACtC,oCAAoC;SACrC,CAAC;KACH;CACF,CAAC,CAAA"}

package/dist/sdk/schemas/common/commonSchemas.js

@@ -111,7 +111,7 @@ export const REQUEST_SIZE_LIMIT_MAP = {
      */
     [IntegrationEngineEnum.DEEPL]: 100000,
     /**
-     * AI integrations use the default 5000 characters limit until we find way to process larger segments
+     * AI integrations use the default limit until we find a way to process larger segments
      * stable and efficiently.
      */
     [IntegrationEngineEnum.GEMINI]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,

package/dist/sdk/validation/isSegmentUnderLengthLimit.js

@@ -1,10 +1,7 @@
-import { handleHtmlEscape } from "../helpers/htmlEscaping.js";
-import { wrapNonTranslatableRegions } from "../helpers/nonTranslatableContentHelper.js";
+import { NON_TRANSLATABLE_END_TAG, NON_TRANSLATABLE_START_TAG, } from '@lokalise/non-translatable-markup';
 import { getRequestSizeLimit } from "./requestSizeLimit.js";
+const NTC_MARKERS_REGEX = new RegExp(`[${NON_TRANSLATABLE_START_TAG}${NON_TRANSLATABLE_END_TAG}]`, 'g');
 export const isSegmentUnderLengthLimit = (value, integration) => {
-    const limit = getRequestSizeLimit(integration);
-    const htmlEscaped = handleHtmlEscape(value, integration);
-    const ntcWrapped = wrapNonTranslatableRegions(htmlEscaped, integration);
-    return ntcWrapped.length <= limit;
+    return value.replace(NTC_MARKERS_REGEX, '').length <= getRequestSizeLimit(integration);
 };
 //# sourceMappingURL=isSegmentUnderLengthLimit.js.map

package/dist/sdk/validation/isSegmentUnderLengthLimit.js.map

@@ -1 +1 @@
-{"version":3,"file":"isSegmentUnderLengthLimit.js","sourceRoot":"","sources":["../../../src/sdk/validation/isSegmentUnderLengthLimit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,4CAA4C,CAAA;AAEvF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,KAAa,EACb,WAAmC,EAC1B,EAAE;IACX,MAAM,KAAK,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAA;IAC9C,MAAM,WAAW,GAAG,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;IACxD,MAAM,UAAU,GAAG,0BAA0B,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;IAEvE,OAAO,UAAU,CAAC,MAAM,IAAI,KAAK,CAAA;AACnC,CAAC,CAAA"}
+{"version":3,"file":"isSegmentUnderLengthLimit.js","sourceRoot":"","sources":["../../../src/sdk/validation/isSegmentUnderLengthLimit.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,0BAA0B,GAC3B,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D,MAAM,iBAAiB,GAAG,IAAI,MAAM,CAClC,IAAI,0BAA0B,GAAG,wBAAwB,GAAG,EAC5D,GAAG,CACJ,CAAA;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,KAAa,EACb,WAAmC,EAC1B,EAAE;IACX,OAAO,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAA;AACxF,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/polyglot-sdk",
-    "version": "24.0.0",
+    "version": "24.2.0",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com/"
@@ -39,6 +39,7 @@
         "postversion": "biome check --write package.json"
     },
     "dependencies": {
+        "@lokalise/api-contracts": "^6.9.0",
         "@lokalise/backend-http-client": "^10.3.0",
         "@lokalise/fastify-extras": "^30.2.1",
         "@lokalise/id-utils": "^3.0.1",
@@ -53,17 +54,17 @@
     },
     "devDependencies": {
         "@amplitude/analytics-types": "^2.11.0",
-        "@biomejs/biome": "^2.3.8",
-        "@lokalise/biome-config": "^3.1.0",
-        "@lokalise/tsconfig": "^3.0.0",
+        "@biomejs/biome": "^2.4.13",
+        "@lokalise/biome-config": "^3.1.1",
+        "@lokalise/tsconfig": "^4.0.0",
         "@types/html-escaper": "^3.0.4",
         "@types/node": "^25.6.0",
-        "@vitest/coverage-v8": "^4.1.4",
+        "@vitest/coverage-v8": "^4.1.5",
         "auto-changelog": "^2.5.0",
         "mockttp": "^4.2.3",
         "rimraf": "^6.1.3",
         "ts-deepmerge": "^7.0.3",
-        "typescript": "5.9.3",
+        "typescript": "^6.0.3",
         "vitest": "^4.0.14"
     }
 }