@lokalise/polyglot-sdk 20.0.0 → 20.0.2

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

@@ -1,8 +1,8 @@
 import z from 'zod';
 import { OWNER_ID_SCHEMA } from "../common/asyncRequestSchemas.js";
-import { COMMON_REQUEST_HEADERS_SCHEMA, FORCE_INTEGRATION_SCHEMA, LOCALE_SCHEMA, METADATA_SCHEMA, REAL_INTEGRATION_ENGINE_SCHEMA, TRANSLATION_EXAMPLE_SCHEMA, refineIntegrationIsPresent, } from "../common/commonSchemas.js";
+import { COMMON_REQUEST_HEADERS_SCHEMA, CONTENT_ID_PROP_SCHEMA, FORCE_INTEGRATION_SCHEMA, LOCALE_SCHEMA, METADATA_SCHEMA, REAL_INTEGRATION_ENGINE_SCHEMA, TRANSLATION_EXAMPLE_SCHEMA, refineIntegrationIsPresent, } from "../common/commonSchemas.js";
 import { TRANSLATION_CONTEXT_SCHEMA } from "../common/translationContextSchemas.js";
-import { CONTENT_ID_PROP_SCHEMA, CONTENT_UNIT_DESCRIPTION_MAX_LENGTH, HISTORY_ENTRY_SCHEMA, TranslateModeEnum, refineDifferentSourceAndTargetLang, refineHistoryIsPresent, } from "./sharedSchemas.js";
+import { HISTORY_ENTRY_SCHEMA, TranslateModeEnum, refineDifferentSourceAndTargetLang, refineHistoryIsPresent, } from "./sharedSchemas.js";
 export const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA = z
     .object({
     ownerId: OWNER_ID_SCHEMA.optional(),
@@ -10,19 +10,27 @@ export const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA = z
     targetLocale: LOCALE_SCHEMA,
     integration: REAL_INTEGRATION_ENGINE_SCHEMA.optional(),
     forceIntegration: FORCE_INTEGRATION_SCHEMA.optional(),
-    context: TRANSLATION_CONTEXT_SCHEMA.extend({
-        description: z.string().min(1).max(CONTENT_UNIT_DESCRIPTION_MAX_LENGTH).optional(),
-        translationExamples: z.array(TRANSLATION_EXAMPLE_SCHEMA).optional(),
-    }).optional(),
+    context: TRANSLATION_CONTEXT_SCHEMA.optional(),
     metadata: METADATA_SCHEMA,
     mode: z
         .nativeEnum(TranslateModeEnum)
         .describe('Specifies the translation mode for the request. Use `translate` if you just want to have a translation of the text. Use `rephrase` in combination with `history` entries to attempt to generate a different wording for the translate. Use `shorten` to try to get the translation shorter while maintaining the message.'),
+    desiredVariantsCount: z
+        .number()
+        .int()
+        .positive()
+        .max(10)
+        .optional()
+        .describe('How many variants to generate when using `rephrase` or `shorten`. Polyglot might return less than requested in case some variants were low quality.'),
     text: z.object({
         contentUnitId: CONTENT_ID_PROP_SCHEMA,
         segmentId: CONTENT_ID_PROP_SCHEMA.optional(),
         value: z.string().min(1),
         characterLimit: z.number().optional(),
+        translationExamples: z
+            .array(TRANSLATION_EXAMPLE_SCHEMA)
+            .optional()
+            .describe('When defined, the translation will attempt to follow the provided translation examples'),
     }),
     history: z
         .array(HISTORY_ENTRY_SCHEMA)
@@ -31,6 +39,16 @@ export const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA = z
 })
     .refine(...refineDifferentSourceAndTargetLang)
     .refine(...refineHistoryIsPresent)
-    .refine(...refineIntegrationIsPresent);
+    .refine(...refineIntegrationIsPresent)
+    .refine((body) => {
+    return !body.desiredVariantsCount || body.mode !== TranslateModeEnum.TRANSLATE;
+}, 'Field `desiredVariantsCount` can only be set with `mode=shorten` or `mode=rephrase`')
+    // Copy deprecated `translationExamples` from `context` to `text`
+    .transform((body) => {
+    if (!body.text.translationExamples) {
+        body.text.translationExamples = body.context?.translationExamples;
+    }
+    return body;
+});
 export const TRANSLATE_TEXT_SEGMENT_HEADERS_SCHEMA = COMMON_REQUEST_HEADERS_SCHEMA;
 //# sourceMappingURL=translateTextSegmentSchemas.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"translateTextSegmentSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/translateTextSegmentSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AACnB,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAClE,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,aAAa,EACb,eAAe,EACf,8BAA8B,EAC9B,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAA;AACnF,OAAO,EACL,sBAAsB,EACtB,mCAAmC,EACnC,oBAAoB,EACpB,iBAAiB,EACjB,kCAAkC,EAClC,sBAAsB,GACvB,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC;KAChD,MAAM,CAAC;IACN,OAAO,EAAE,eAAe,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,WAAW,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IACtD,gBAAgB,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IACrD,OAAO,EAAE,0BAA0B,CAAC,MAAM,CAAC;QACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC,QAAQ,EAAE;QAClF,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,QAAQ,EAAE;KACpE,CAAC,CAAC,QAAQ,EAAE;IACb,QAAQ,EAAE,eAAe;IACzB,IAAI,EAAE,CAAC;SACJ,UAAU,CAAC,iBAAiB,CAAC;SAC7B,QAAQ,CACP,2TAA2T,CAC5T;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,aAAa,EAAE,sBAAsB;QACrC,SAAS,EAAE,sBAAsB,CAAC,QAAQ,EAAE;QAC5C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACxB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACtC,CAAC;IACF,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,oBAAoB,CAAC;SAC3B,QAAQ,CAAC,oEAAoE,CAAC;SAC9E,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,CAAC,GAAG,kCAAkC,CAAC;KAC7C,MAAM,CAAC,GAAG,sBAAsB,CAAC;KACjC,MAAM,CAAC,GAAG,0BAA0B,CAAC,CAAA;AAExC,MAAM,CAAC,MAAM,qCAAqC,GAAG,6BAA6B,CAAA"}
+{"version":3,"file":"translateTextSegmentSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/translateTextSegmentSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AACnB,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAClE,OAAO,EACL,6BAA6B,EAC7B,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,EACb,eAAe,EACf,8BAA8B,EAC9B,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAA;AACnF,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kCAAkC,EAClC,sBAAsB,GACvB,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC;KAChD,MAAM,CAAC;IACN,OAAO,EAAE,eAAe,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,WAAW,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IACtD,gBAAgB,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IACrD,OAAO,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,eAAe;IACzB,IAAI,EAAE,CAAC;SACJ,UAAU,CAAC,iBAAiB,CAAC;SAC7B,QAAQ,CACP,2TAA2T,CAC5T;IACH,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,GAAG,CAAC,EAAE,CAAC;SACP,QAAQ,EAAE;SACV,QAAQ,CACP,qJAAqJ,CACtJ;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,aAAa,EAAE,sBAAsB;QACrC,SAAS,EAAE,sBAAsB,CAAC,QAAQ,EAAE;QAC5C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACxB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACrC,mBAAmB,EAAE,CAAC;aACnB,KAAK,CAAC,0BAA0B,CAAC;aACjC,QAAQ,EAAE;aACV,QAAQ,CACP,wFAAwF,CACzF;KACJ,CAAC;IACF,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,oBAAoB,CAAC;SAC3B,QAAQ,CAAC,oEAAoE,CAAC;SAC9E,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,CAAC,GAAG,kCAAkC,CAAC;KAC7C,MAAM,CAAC,GAAG,sBAAsB,CAAC;KACjC,MAAM,CAAC,GAAG,0BAA0B,CAAC;KACrC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;IACf,OAAO,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC,SAAS,CAAA;AAChF,CAAC,EAAE,qFAAqF,CAAC;IACzF,iEAAiE;KAChE,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;IAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAA;IACnE,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,qCAAqC,GAAG,6BAA6B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/polyglot-sdk",
-    "version": "20.0.0",
+    "version": "20.0.2",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com/"
@@ -38,32 +38,32 @@
     },
     "dependencies": {
         "@lokalise/backend-http-client": "^5.0.0",
-        "@lokalise/id-utils": "^3.0.0",
-        "@lokalise/node-core": "^13.6.0",
+        "@lokalise/id-utils": "^3.0.1",
+        "@lokalise/node-core": "^14.1.0",
         "@lokalise/non-translatable-markup": "^3.0.0",
         "@lokalise/supported-languages": "^3.1.0",
         "@lokalise/zod-extras": "^2.1.0",
         "html-escaper": "^3.0.3",
-        "undici": "^7.7.0",
+        "undici": "^7.10.0",
         "undici-retry": "^6.0.0",
-        "zod": "^3.24.3"
+        "zod": "^3.25.56"
     },
     "peerDependencies": {
         "@lokalise/fastify-extras": ">=27.0.0"
     },
     "devDependencies": {
-        "@amplitude/analytics-types": "^2.9.0",
+        "@amplitude/analytics-types": "^2.9.2",
         "@biomejs/biome": "^1.9.4",
         "@lokalise/biome-config": "^2.0.0",
         "@lokalise/fastify-extras": "^27.3.0",
         "@lokalise/tsconfig": "^1.1.0",
         "@types/html-escaper": "^3.0.4",
-        "@types/node": "^22.15.3",
-        "@vitest/coverage-v8": "^3.1.2",
+        "@types/node": "^22.15.30",
+        "@vitest/coverage-v8": "^3.2.3",
         "auto-changelog": "^2.5.0",
         "mockttp": "^3.17.1",
         "rimraf": "^6.0.1",
-        "ts-deepmerge": "^7.0.1",
+        "ts-deepmerge": "^7.0.3",
         "typescript": "5.8.3",
         "vitest": "^3.0.4"
     }