@lokalise/polyglot-sdk 15.0.0 → 16.0.0

package/dist/index.d.ts

@@ -17,3 +17,5 @@ export * from './sdk/schemas/translation/translateAsyncSchemas';
 export * from './sdk/schemas/translation/sharedSchemas';
 export { isSegmentUnderLengthLimit, isSegmentUnderLengthLimit as isSegmentExceedingLengthLimit, } from './sdk/validation/isSegmentUnderLengthLimit';
 export { getRequestSizeLimit, isRequestSizeUnderLimit } from './sdk/validation/requestSizeLimit';
+export * from './sdk/helpers/nonTranslatableContentHelper';
+export * from './sdk/helpers/nonTranslatableContentWrappers';

package/dist/index.js

@@ -28,4 +28,6 @@ Object.defineProperty(exports, "isSegmentExceedingLengthLimit", { enumerable: tr
 var requestSizeLimit_1 = require("./sdk/validation/requestSizeLimit");
 Object.defineProperty(exports, "getRequestSizeLimit", { enumerable: true, get: function () { return requestSizeLimit_1.getRequestSizeLimit; } });
 Object.defineProperty(exports, "isRequestSizeUnderLimit", { enumerable: true, get: function () { return requestSizeLimit_1.isRequestSizeUnderLimit; } });
+tslib_1.__exportStar(require("./sdk/helpers/nonTranslatableContentHelper"), exports);
+tslib_1.__exportStar(require("./sdk/helpers/nonTranslatableContentWrappers"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,uDAAqD;AAA5C,gHAAA,cAAc,OAAA;AACvB,4DAA0D;AAAjD,8GAAA,aAAa,OAAA;AAGtB,mFAAwD;AAExD,6EAAkD;AAClD,4EAAiD;AACjD,4FAGuD;AAFrD,uIAAA,0BAA0B,OAAA;AAC1B,mIAAA,sBAAsB,OAAA;AASxB,iEAAsE;AAA7D,qHAAA,oBAAoB,OAAA;AAC7B,4EAAiD;AACjD,6EAAkD;AAClD,+EAAoD;AACpD,uFAA4D;AAC5D,yFAA8D;AAC9D,yFAA8D;AAC9D,0FAA+D;AAC/D,kFAAuD;AAEvD,wFAGmD;AAFjD,sIAAA,yBAAyB,OAAA;AACzB,0IAAA,yBAAyB,OAAiC;AAE5D,sEAAgG;AAAvF,uHAAA,mBAAmB,OAAA;AAAE,2HAAA,uBAAuB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,uDAAqD;AAA5C,gHAAA,cAAc,OAAA;AACvB,4DAA0D;AAAjD,8GAAA,aAAa,OAAA;AAGtB,mFAAwD;AAExD,6EAAkD;AAClD,4EAAiD;AACjD,4FAGuD;AAFrD,uIAAA,0BAA0B,OAAA;AAC1B,mIAAA,sBAAsB,OAAA;AASxB,iEAAsE;AAA7D,qHAAA,oBAAoB,OAAA;AAC7B,4EAAiD;AACjD,6EAAkD;AAClD,+EAAoD;AACpD,uFAA4D;AAC5D,yFAA8D;AAC9D,yFAA8D;AAC9D,0FAA+D;AAC/D,kFAAuD;AAEvD,wFAGmD;AAFjD,sIAAA,yBAAyB,OAAA;AACzB,0IAAA,yBAAyB,OAAiC;AAE5D,sEAAgG;AAAvF,uHAAA,mBAAmB,OAAA;AAAE,2HAAA,uBAAuB,OAAA;AAErD,qFAA0D;AAC1D,uFAA4D"}

package/dist/sdk/helpers/nonTranslatableContentHelper.d.ts

@@ -0,0 +1,26 @@
+import type { IntegrationEngineEnum } from '../schemas/common/commonSchemas';
+export type TextWithNonTranslatableRegions = {
+    wrappedText: string;
+    nonTranslatableRegions: string[];
+};
+export declare const NON_TRANSLATABLE_REGION_REGEX: RegExp;
+/**
+ * Extracts matches from a string using a regular expression
+ */
+export declare const extractTextWithRegexp: (text: string, regex: RegExp) => string[];
+/**
+ * Takes a string with zero or more non-translatable regions (text wrapped within \uE101 and \uE102 characters) and
+ * returns it with regions re-wrapped into tags with an attribute indicating a position of
+ * such region. Also returns a list of detected non-translatable regions ordered in the same way.
+ *
+ * You can use that to reinsert original regions back into a translated version of such string
+ *
+ * @returns {TextWithNonTranslatableRegions} An object containing a segment with non-translatable regions wrapped into tags
+ * and an array of detected non-translatable regions for future reinsertion
+ */
+export declare const wrapSegmentAndExtractNonTranslatableRegions: (segment: string, integration?: IntegrationEngineEnum) => TextWithNonTranslatableRegions;
+/**
+ * Takes a string with zero or more non-translatable regions (text wrapped within \uE101 and \uE102 characters) and
+ * returns it with regions re-wrapped into ordered XML `<lok-nt>` tags
+ */
+export declare const wrapNonTranslatableRegions: (segment: string, integration?: IntegrationEngineEnum) => string;

package/dist/sdk/helpers/nonTranslatableContentHelper.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapNonTranslatableRegions = exports.wrapSegmentAndExtractNonTranslatableRegions = exports.extractTextWithRegexp = exports.NON_TRANSLATABLE_REGION_REGEX = void 0;
+const non_translatable_markup_1 = require("@lokalise/non-translatable-markup");
+const nonTranslatableContentWrappers_1 = require("./nonTranslatableContentWrappers");
+exports.NON_TRANSLATABLE_REGION_REGEX = new RegExp(String.raw `${non_translatable_markup_1.NON_TRANSLATABLE_START_TAG}[\s\S]*?${non_translatable_markup_1.NON_TRANSLATABLE_END_TAG}`, 'g');
+/**
+ * Extracts matches from a string using a regular expression
+ */
+const extractTextWithRegexp = (text, regex) => {
+    const pieces = [];
+    const matches = text.matchAll(regex);
+    for (const match of matches) {
+        for (const [i, group] of match.entries()) {
+            if (i === 0)
+                pieces.push(group);
+        }
+    }
+    return pieces;
+};
+exports.extractTextWithRegexp = extractTextWithRegexp;
+/**
+ * Takes a string with zero or more non-translatable regions (text wrapped within \uE101 and \uE102 characters) and
+ * returns it with regions re-wrapped into tags with an attribute indicating a position of
+ * such region. Also returns a list of detected non-translatable regions ordered in the same way.
+ *
+ * You can use that to reinsert original regions back into a translated version of such string
+ *
+ * @returns {TextWithNonTranslatableRegions} An object containing a segment with non-translatable regions wrapped into tags
+ * and an array of detected non-translatable regions for future reinsertion
+ */
+const wrapSegmentAndExtractNonTranslatableRegions = (segment, integration) => {
+    let wrappedText = segment;
+    const wrapperFormat = (0, nonTranslatableContentWrappers_1.getFormatByIntegration)(integration);
+    const nonTranslatableRegions = (0, exports.extractTextWithRegexp)(segment, exports.NON_TRANSLATABLE_REGION_REGEX);
+    let index = 0;
+    for (const region of nonTranslatableRegions) {
+        const replacement = nonTranslatableContentWrappers_1.WRAPPER_FORMATS[wrapperFormat].wrap(region.slice(1, -1), index);
+        wrappedText = wrappedText.replace(region, replacement);
+        index++;
+    }
+    return {
+        wrappedText,
+        nonTranslatableRegions,
+    };
+};
+exports.wrapSegmentAndExtractNonTranslatableRegions = wrapSegmentAndExtractNonTranslatableRegions;
+/**
+ * Takes a string with zero or more non-translatable regions (text wrapped within \uE101 and \uE102 characters) and
+ * returns it with regions re-wrapped into ordered XML `<lok-nt>` tags
+ */
+const wrapNonTranslatableRegions = (segment, integration) => {
+    const { wrappedText } = (0, exports.wrapSegmentAndExtractNonTranslatableRegions)(segment, integration);
+    return wrappedText;
+};
+exports.wrapNonTranslatableRegions = wrapNonTranslatableRegions;
+//# sourceMappingURL=nonTranslatableContentHelper.js.map

package/dist/sdk/helpers/nonTranslatableContentHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nonTranslatableContentHelper.js","sourceRoot":"","sources":["../../../src/sdk/helpers/nonTranslatableContentHelper.ts"],"names":[],"mappings":";;;AAAA,+EAG0C;AAE1C,qFAA0F;AAO7E,QAAA,6BAA6B,GAAG,IAAI,MAAM,CACrD,MAAM,CAAC,GAAG,CAAA,GAAG,oDAA0B,WAAW,kDAAwB,EAAE,EAC5E,GAAG,CACJ,CAAA;AAED;;GAEG;AACI,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAE,KAAa,EAAY,EAAE;IAC7E,MAAM,MAAM,GAAG,EAAE,CAAA;IACjB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IAEpC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAXY,QAAA,qBAAqB,yBAWjC;AAED;;;;;;;;;GASG;AACI,MAAM,2CAA2C,GAAG,CACzD,OAAe,EACf,WAAmC,EACH,EAAE;IAClC,IAAI,WAAW,GAAG,OAAO,CAAA;IACzB,MAAM,aAAa,GAAG,IAAA,uDAAsB,EAAC,WAAW,CAAC,CAAA;IACzD,MAAM,sBAAsB,GAAG,IAAA,6BAAqB,EAAC,OAAO,EAAE,qCAA6B,CAAC,CAAA;IAE5F,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,KAAK,MAAM,MAAM,IAAI,sBAAsB,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,gDAAe,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QACnF,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACtD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,OAAO;QACL,WAAW;QACX,sBAAsB;KACvB,CAAA;AACH,CAAC,CAAA;AAnBY,QAAA,2CAA2C,+CAmBvD;AAED;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CACxC,OAAe,EACf,WAAmC,EAC3B,EAAE;IACV,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,mDAA2C,EAAC,OAAO,EAAE,WAAW,CAAC,CAAA;IAEzF,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA;AAPY,QAAA,0BAA0B,8BAOtC"}

package/dist/sdk/helpers/nonTranslatableContentWrappers.d.ts

@@ -0,0 +1,10 @@
+import { IntegrationEngineEnum } from '../schemas/common/commonSchemas';
+export declare const WRAPPER_FORMATS: Record<string, WrapperDefinition>;
+export type WrapperDefinition = {
+    wrap: (content: string, id: number) => string;
+    regexp: RegExp;
+    cleanupRegexp: RegExp | null;
+};
+export type WrapperFormat = keyof typeof WRAPPER_FORMATS;
+export declare const DEFAULT_WRAPPER_FORMAT: WrapperFormat;
+export declare function getFormatByIntegration(integration?: IntegrationEngineEnum): WrapperFormat;

package/dist/sdk/helpers/nonTranslatableContentWrappers.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_WRAPPER_FORMAT = exports.WRAPPER_FORMATS = void 0;
+exports.getFormatByIntegration = getFormatByIntegration;
+const commonSchemas_1 = require("../schemas/common/commonSchemas");
+const createWrapperMatchingRegexp = (tagWithAttributes) => {
+    const tag = tagWithAttributes.trim().split(' ').shift();
+    return new RegExp(String.raw `<${tagWithAttributes} id=\\*["'](\d+)\\*["']>([\s\S]*?)</${tag}>`, 'g');
+};
+const createBBWrapperMatchingRegexp = (tagWithAttributes) => {
+    const tag = tagWithAttributes.trim().split(' ').shift();
+    return new RegExp(String.raw `\[${tagWithAttributes}=(\d+)\]([\s\S]*?)\[/${tag}\]`, 'g');
+};
+const createCleanupRegexp = (tag) => {
+    return new RegExp(String.raw `[<\[]/?${tag}[\s\S]*?[>\]]`, 'g');
+};
+exports.WRAPPER_FORMATS = {
+    BBCode: {
+        wrap: (content, id) => `[nt=${id}]${content}[/nt]`,
+        regexp: createBBWrapperMatchingRegexp('nt'),
+        cleanupRegexp: createCleanupRegexp('nt'),
+    },
+    XML: {
+        wrap: (content, id) => `<lok-nt id="${id}">${content}</lok-nt>`,
+        regexp: createWrapperMatchingRegexp('lok-nt'),
+        cleanupRegexp: createCleanupRegexp('lok-nt'),
+    },
+    GOOGLE_TRANSLATE_HTML: {
+        wrap: (content, id) => `<span translate="no" id="${id}">${content}</span>`,
+        regexp: createWrapperMatchingRegexp('span translate="no"'),
+        cleanupRegexp: null,
+    },
+    MS_TRANSLATOR_HTML: {
+        wrap: (content, id) => `<div class="notranslate" id="${id}">${content}</div>`,
+        regexp: createWrapperMatchingRegexp('div class="notranslate"'),
+        cleanupRegexp: null,
+    },
+};
+exports.DEFAULT_WRAPPER_FORMAT = 'BBCode';
+function getFormatByIntegration(integration) {
+    switch (integration) {
+        case commonSchemas_1.IntegrationEngineEnum.GOOGLE_TRANSLATE:
+            return 'GOOGLE_TRANSLATE_HTML';
+        case commonSchemas_1.IntegrationEngineEnum.MICROSOFT_TRANSLATOR:
+            return 'MS_TRANSLATOR_HTML';
+        case commonSchemas_1.IntegrationEngineEnum.DEEPL:
+            return 'XML';
+        default:
+            return exports.DEFAULT_WRAPPER_FORMAT;
+    }
+}
+//# sourceMappingURL=nonTranslatableContentWrappers.js.map

package/dist/sdk/helpers/nonTranslatableContentWrappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nonTranslatableContentWrappers.js","sourceRoot":"","sources":["../../../src/sdk/helpers/nonTranslatableContentWrappers.ts"],"names":[],"mappings":";;;AAsDA,wDAWC;AAjED,mEAAuE;AAEvE,MAAM,2BAA2B,GAAG,CAAC,iBAAyB,EAAU,EAAE;IACxE,MAAM,GAAG,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA;IACvD,OAAO,IAAI,MAAM,CACf,MAAM,CAAC,GAAG,CAAA,IAAI,iBAAiB,uCAAuC,GAAG,GAAG,EAC5E,GAAG,CACJ,CAAA;AACH,CAAC,CAAA;AAED,MAAM,6BAA6B,GAAG,CAAC,iBAAyB,EAAU,EAAE;IAC1E,MAAM,GAAG,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA;IACvD,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,KAAK,iBAAiB,wBAAwB,GAAG,IAAI,EAAE,GAAG,CAAC,CAAA;AACzF,CAAC,CAAA;AAED,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAU,EAAE;IAClD,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,UAAU,GAAG,eAAe,EAAE,GAAG,CAAC,CAAA;AAChE,CAAC,CAAA;AAEY,QAAA,eAAe,GAAsC;IAChE,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,OAAe,EAAE,EAAU,EAAU,EAAE,CAAC,OAAO,EAAE,IAAI,OAAO,OAAO;QAC1E,MAAM,EAAE,6BAA6B,CAAC,IAAI,CAAC;QAC3C,aAAa,EAAE,mBAAmB,CAAC,IAAI,CAAC;KACzC;IACD,GAAG,EAAE;QACH,IAAI,EAAE,CAAC,OAAe,EAAE,EAAU,EAAU,EAAE,CAAC,eAAe,EAAE,KAAK,OAAO,WAAW;QACvF,MAAM,EAAE,2BAA2B,CAAC,QAAQ,CAAC;QAC7C,aAAa,EAAE,mBAAmB,CAAC,QAAQ,CAAC;KAC7C;IACD,qBAAqB,EAAE;QACrB,IAAI,EAAE,CAAC,OAAe,EAAE,EAAU,EAAU,EAAE,CAC5C,4BAA4B,EAAE,KAAK,OAAO,SAAS;QACrD,MAAM,EAAE,2BAA2B,CAAC,qBAAqB,CAAC;QAC1D,aAAa,EAAE,IAAI;KACpB;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,CAAC,OAAe,EAAE,EAAU,EAAU,EAAE,CAC5C,gCAAgC,EAAE,KAAK,OAAO,QAAQ;QACxD,MAAM,EAAE,2BAA2B,CAAC,yBAAyB,CAAC;QAC9D,aAAa,EAAE,IAAI;KACpB;CACO,CAAA;AAUG,QAAA,sBAAsB,GAAkB,QAAQ,CAAA;AAE7D,SAAgB,sBAAsB,CAAC,WAAmC;IACxE,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,qCAAqB,CAAC,gBAAgB;YACzC,OAAO,uBAAuB,CAAA;QAChC,KAAK,qCAAqB,CAAC,oBAAoB;YAC7C,OAAO,oBAAoB,CAAA;QAC7B,KAAK,qCAAqB,CAAC,KAAK;YAC9B,OAAO,KAAK,CAAA;QACd;YACE,OAAO,8BAAsB,CAAA;IACjC,CAAC;AACH,CAAC"}

package/dist/sdk/schemas/translation/generateVariantsV1.d.ts

@@ -174,8 +174,8 @@ export declare const GENERATE_VARIANTS_V1_BODY_SCHEMA: z.ZodEffects<z.ZodEffects
     }>>;
 }, "strip", z.ZodTypeAny, {
     sourceValue: string;
-    sourceLocale: string;
     mode: "REPHRASE" | "SHORTEN";
+    sourceLocale: string;
     targetLocale: string;
     targetValue: string;
     integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
@@ -209,8 +209,8 @@ export declare const GENERATE_VARIANTS_V1_BODY_SCHEMA: z.ZodEffects<z.ZodEffects
     }[] | undefined;
 }, {
     sourceValue: string;
-    sourceLocale: string;
     mode: string;
+    sourceLocale: string;
     targetLocale: string;
     targetValue: string;
     integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
@@ -244,8 +244,8 @@ export declare const GENERATE_VARIANTS_V1_BODY_SCHEMA: z.ZodEffects<z.ZodEffects
     }[] | undefined;
 }>, {
     sourceValue: string;
-    sourceLocale: string;
     mode: "REPHRASE" | "SHORTEN";
+    sourceLocale: string;
     targetLocale: string;
     targetValue: string;
     integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
@@ -279,8 +279,8 @@ export declare const GENERATE_VARIANTS_V1_BODY_SCHEMA: z.ZodEffects<z.ZodEffects
     }[] | undefined;
 }, {
     sourceValue: string;
-    sourceLocale: string;
     mode: string;
+    sourceLocale: string;
     targetLocale: string;
     targetValue: string;
     integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
@@ -314,8 +314,8 @@ export declare const GENERATE_VARIANTS_V1_BODY_SCHEMA: z.ZodEffects<z.ZodEffects
     }[] | undefined;
 }>, {
     sourceValue: string;
-    sourceLocale: string;
     mode: "REPHRASE" | "SHORTEN";
+    sourceLocale: string;
     targetLocale: string;
     targetValue: string;
     integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;
@@ -349,8 +349,8 @@ export declare const GENERATE_VARIANTS_V1_BODY_SCHEMA: z.ZodEffects<z.ZodEffects
     }[] | undefined;
 }, {
     sourceValue: string;
-    sourceLocale: string;
     mode: string;
+    sourceLocale: string;
     targetLocale: string;
     targetValue: string;
     integration?: "Claude" | "ChatGPT-4" | "Gemini" | undefined;

package/dist/sdk/schemas/translation/sharedSchemas.d.ts

@@ -186,6 +186,80 @@ export declare const TRANSLATE_CONTENT_UNIT_SCHEMA: z.ZodObject<{
 }>;
 export type TranslateSegment = z.infer<typeof TRANSLATE_SEGMENT_SCHEMA>;
 export type TranslateContentUnit = z.infer<typeof TRANSLATE_CONTENT_UNIT_SCHEMA>;
+/**
+ * Text rewriting schemas
+ */
+export declare const REWRITE_SEGMENT_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    id: string;
+}, {
+    value: string;
+    id: string;
+}>;
+export declare const REWRITE_CONTENT_UNIT_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    context: z.ZodOptional<z.ZodObject<{
+        description: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        description: string;
+    }, {
+        description: string;
+    }>>;
+    characterLimit: z.ZodOptional<z.ZodNumber>;
+    segments: z.ZodEffects<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        id: string;
+    }, {
+        value: string;
+        id: string;
+    }>, "atleastone">, [{
+        value: string;
+        id: string;
+    }, ...{
+        value: string;
+        id: string;
+    }[]], [{
+        value: string;
+        id: string;
+    }, ...{
+        value: string;
+        id: string;
+    }[]]>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    segments: [{
+        value: string;
+        id: string;
+    }, ...{
+        value: string;
+        id: string;
+    }[]];
+    context?: {
+        description: string;
+    } | undefined;
+    characterLimit?: number | undefined;
+}, {
+    id: string;
+    segments: [{
+        value: string;
+        id: string;
+    }, ...{
+        value: string;
+        id: string;
+    }[]];
+    context?: {
+        description: string;
+    } | undefined;
+    characterLimit?: number | undefined;
+}>;
+export type RewriteSegment = z.infer<typeof REWRITE_SEGMENT_SCHEMA>;
+export type RewriteContentUnit = z.infer<typeof REWRITE_CONTENT_UNIT_SCHEMA>;
 /**
  * Variant generation
  */

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HISTORY_REQUEST_SCHEMA = exports.VariantsModeEnum = exports.TRANSLATE_CONTENT_UNIT_SCHEMA = exports.TRANSLATE_SEGMENT_SCHEMA = exports.CONTENT_ID_PROP_SCHEMA = exports.SEGMENT_WARNINGS_SCHEMA = exports.SEGMENT_TRANSLATION_WARNING_SCHEMA = exports.TRANSLATION_QUALITY_WARNING_KINDS = exports.refineUniqueIds = exports.refineRequestSizeLimit = exports.refineSingleSegmentSizeLimit = exports.refineDifferentSourceAndTargetLang = void 0;
+exports.HISTORY_REQUEST_SCHEMA = exports.VariantsModeEnum = exports.REWRITE_CONTENT_UNIT_SCHEMA = exports.REWRITE_SEGMENT_SCHEMA = exports.TRANSLATE_CONTENT_UNIT_SCHEMA = exports.TRANSLATE_SEGMENT_SCHEMA = exports.CONTENT_ID_PROP_SCHEMA = exports.SEGMENT_WARNINGS_SCHEMA = exports.SEGMENT_TRANSLATION_WARNING_SCHEMA = exports.TRANSLATION_QUALITY_WARNING_KINDS = exports.refineUniqueIds = exports.refineRequestSizeLimit = exports.refineSingleSegmentSizeLimit = exports.refineDifferentSourceAndTargetLang = void 0;
 const tslib_1 = require("tslib");
 const zod_1 = tslib_1.__importDefault(require("zod"));
 const isSegmentUnderLengthLimit_1 = require("../../validation/isSegmentUnderLengthLimit");
@@ -13,7 +13,7 @@ exports.refineDifferentSourceAndTargetLang = [
     'The sourceLocale and targetLocale must be different.',
 ];
 exports.refineSingleSegmentSizeLimit = [
-    (data) => (0, isSegmentUnderLengthLimit_1.isSegmentUnderLengthLimit)(data.value ?? data.sourceValue ?? '', (0, requestSizeLimit_1.getRequestSizeLimit)(data.integration)),
+    (data) => (0, isSegmentUnderLengthLimit_1.isSegmentUnderLengthLimit)(data.value ?? data.sourceValue ?? '', data.integration),
     (data) => ({
         message: `Text value is too large, max length is ${(0, requestSizeLimit_1.getRequestSizeLimit)(data.integration)} characters`,
     }),
@@ -62,6 +62,27 @@ exports.TRANSLATE_CONTENT_UNIT_SCHEMA = zod_1.default.object({
         .max(CONTENT_UNIT_SEGMENTS_MAX_LENGTH)
         .refine(...exports.refineUniqueIds),
 });
+/**
+ * Text rewriting schemas
+ */
+exports.REWRITE_SEGMENT_SCHEMA = zod_1.default.object({
+    id: exports.CONTENT_ID_PROP_SCHEMA,
+    value: zod_1.default.string().min(1),
+});
+exports.REWRITE_CONTENT_UNIT_SCHEMA = zod_1.default.object({
+    id: exports.CONTENT_ID_PROP_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.REWRITE_SEGMENT_SCHEMA)
+        .nonempty()
+        .max(CONTENT_UNIT_SEGMENTS_MAX_LENGTH)
+        .refine(...exports.refineUniqueIds),
+});
 /**
  * Variant generation
  */

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

@@ -1 +1 @@
-{"version":3,"file":"sharedSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/sharedSchemas.ts"],"names":[],"mappings":";;;;AAAA,sDAAmB;AAEnB,0FAAsF;AACtF,wEAAgG;AAChG,2DAAqF;AAMxE,QAAA,kCAAkC,GAAG;IAChD,CAAC,IAAoD,EAAE,EAAE;QACvD,OAAO,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,CAAA;IAChD,CAAC;IACD,sDAAsD;CAC9C,CAAA;AAEG,QAAA,4BAA4B,GAAG;IAC1C,CAAC,IAAmF,EAAE,EAAE,CACtF,IAAA,qDAAyB,EACvB,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE,EACpC,IAAA,sCAAmB,EAAC,IAAI,CAAC,WAAW,CAAC,CACtC;IACH,CAAC,IAA6C,EAAE,EAAE,CAAC,CAAC;QAClD,OAAO,EAAE,0CAA0C,IAAA,sCAAmB,EAAC,IAAI,CAAC,WAAW,CAAC,aAAa;KACtG,CAAC;CACM,CAAA;AAEG,QAAA,sBAAsB,GAAG;IACpC,CAAC,IAA8E,EAAE,EAAE,CACjF,IAAA,0CAAuB,EAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC;IAC9D,CAAC,IAA6C,EAAE,EAAE,CAAC,CAAC;QAClD,OAAO,EAAE,6DAA6D,IAAA,sCAAmB,EAAC,IAAI,CAAC,WAAW,CAAC,aAAa;KACzH,CAAC;CACM,CAAA;AAEG,QAAA,eAAe,GAAG;IAC7B,CAAC,IAAsB,EAAE,EAAE;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QACpC,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,CAAA;IACzC,CAAC;IACD,0CAA0C;CAClC,CAAA;AAEG,QAAA,iCAAiC,GAAG;IAC/C,iCAAiC;IACjC,oBAAoB;CACZ,CAAA;AAGG,QAAA,kCAAkC,GAAG,aAAC,CAAC,MAAM,CAAC;IACzD,IAAI,EAAE,aAAC,CAAC,IAAI,CAAC,yCAAiC,CAAC;CAChD,CAAC,CAAA;AAEW,QAAA,uBAAuB,GAAG,aAAC,CAAC,KAAK,CAAC,0CAAkC,CAAC,CAAA;AAElF,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAC9B,MAAM,mCAAmC,GAAG,KAAK,CAAA;AACjD,MAAM,gCAAgC,GAAG,IAAI,CAAA,CAAC,+EAA+E;AAEhH,QAAA,sBAAsB,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;AAElE,QAAA,wBAAwB,GAAG,aAAC,CAAC,MAAM,CAAC;IAC/C,EAAE,EAAE,8BAAsB;IAC1B,OAAO,EAAE,+BAAe;IACxB,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACzB,CAAC,CAAA;AAEW,QAAA,6BAA6B,GAAG,aAAC,CAAC,MAAM,CAAC;IACpD,EAAE,EAAE,8BAAsB;IAC1B,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,gCAAwB,CAAC;SAC/B,QAAQ,EAAE;SACV,GAAG,CAAC,gCAAgC,CAAC;SACrC,MAAM,CAAC,GAAG,uBAAe,CAAC;CAC9B,CAAC,CAAA;AAKF;;GAEG;AAEU,QAAA,gBAAgB,GAAG;IAC9B,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;CACV,CAAA;AAGG,QAAA,sBAAsB,GAAG,aAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,aAAC;SACN,KAAK,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,2CAA2C,CAAC;IACxD,IAAI,EAAE,aAAC;SACJ,MAAM,EAAE;SACR,WAAW,EAAE;SACb,IAAI,CAAC,aAAC,CAAC,UAAU,CAAC,wBAAgB,CAAC,CAAC;SACpC,QAAQ,CAAC,iCAAiC,CAAC;CAC/C,CAAC,CAAA"}
+{"version":3,"file":"sharedSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/sharedSchemas.ts"],"names":[],"mappings":";;;;AAAA,sDAAmB;AAEnB,0FAAsF;AACtF,wEAAgG;AAChG,2DAAqF;AAMxE,QAAA,kCAAkC,GAAG;IAChD,CAAC,IAAoD,EAAE,EAAE;QACvD,OAAO,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,CAAA;IAChD,CAAC;IACD,sDAAsD;CAC9C,CAAA;AAEG,QAAA,4BAA4B,GAAG;IAC1C,CAAC,IAAmF,EAAE,EAAE,CACtF,IAAA,qDAAyB,EAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC;IACnF,CAAC,IAA6C,EAAE,EAAE,CAAC,CAAC;QAClD,OAAO,EAAE,0CAA0C,IAAA,sCAAmB,EAAC,IAAI,CAAC,WAAW,CAAC,aAAa;KACtG,CAAC;CACM,CAAA;AAEG,QAAA,sBAAsB,GAAG;IACpC,CAAC,IAA8E,EAAE,EAAE,CACjF,IAAA,0CAAuB,EAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC;IAC9D,CAAC,IAA6C,EAAE,EAAE,CAAC,CAAC;QAClD,OAAO,EAAE,6DAA6D,IAAA,sCAAmB,EAAC,IAAI,CAAC,WAAW,CAAC,aAAa;KACzH,CAAC;CACM,CAAA;AAEG,QAAA,eAAe,GAAG;IAC7B,CAAC,IAAsB,EAAE,EAAE;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QACpC,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,CAAA;IACzC,CAAC;IACD,0CAA0C;CAClC,CAAA;AAEG,QAAA,iCAAiC,GAAG;IAC/C,iCAAiC;IACjC,oBAAoB;CACZ,CAAA;AAGG,QAAA,kCAAkC,GAAG,aAAC,CAAC,MAAM,CAAC;IACzD,IAAI,EAAE,aAAC,CAAC,IAAI,CAAC,yCAAiC,CAAC;CAChD,CAAC,CAAA;AAEW,QAAA,uBAAuB,GAAG,aAAC,CAAC,KAAK,CAAC,0CAAkC,CAAC,CAAA;AAElF,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAC9B,MAAM,mCAAmC,GAAG,KAAK,CAAA;AACjD,MAAM,gCAAgC,GAAG,IAAI,CAAA,CAAC,+EAA+E;AAEhH,QAAA,sBAAsB,GAAG,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;AAElE,QAAA,wBAAwB,GAAG,aAAC,CAAC,MAAM,CAAC;IAC/C,EAAE,EAAE,8BAAsB;IAC1B,OAAO,EAAE,+BAAe;IACxB,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACzB,CAAC,CAAA;AAEW,QAAA,6BAA6B,GAAG,aAAC,CAAC,MAAM,CAAC;IACpD,EAAE,EAAE,8BAAsB;IAC1B,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,gCAAwB,CAAC;SAC/B,QAAQ,EAAE;SACV,GAAG,CAAC,gCAAgC,CAAC;SACrC,MAAM,CAAC,GAAG,uBAAe,CAAC;CAC9B,CAAC,CAAA;AAKF;;GAEG;AAEU,QAAA,sBAAsB,GAAG,aAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,8BAAsB;IAC1B,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACzB,CAAC,CAAA;AAEW,QAAA,2BAA2B,GAAG,aAAC,CAAC,MAAM,CAAC;IAClD,EAAE,EAAE,8BAAsB;IAC1B,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,8BAAsB,CAAC;SAC7B,QAAQ,EAAE;SACV,GAAG,CAAC,gCAAgC,CAAC;SACrC,MAAM,CAAC,GAAG,uBAAe,CAAC;CAC9B,CAAC,CAAA;AAKF;;GAEG;AAEU,QAAA,gBAAgB,GAAG;IAC9B,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;CACV,CAAA;AAGG,QAAA,sBAAsB,GAAG,aAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,aAAC;SACN,KAAK,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,2CAA2C,CAAC;IACxD,IAAI,EAAE,aAAC;SACJ,MAAM,EAAE;SACR,WAAW,EAAE;SACb,IAAI,CAAC,aAAC,CAAC,UAAU,CAAC,wBAAgB,CAAC,CAAC;SACpC,QAAQ,CAAC,iCAAiC,CAAC;CAC/C,CAAC,CAAA"}