@lokalise/polyglot-sdk 21.0.0 → 21.0.2

package/dist/sdk/schemas/lqa/commonSchemas.d.ts

@@ -1,3 +1,4 @@
+import z from 'zod';
 import type { ObjectValues } from '../../types/common.ts';
 export declare const LqaIssueSeverityEnum: {
     readonly NEUTRAL: "neutral";
@@ -6,3 +7,332 @@ export declare const LqaIssueSeverityEnum: {
     readonly CRITICAL: "critical";
 };
 export type LqaIssueSeverityEnum = ObjectValues<typeof LqaIssueSeverityEnum>;
+export declare const LQA_TRANSLATION_ID_SCHEMA: z.ZodString;
+export declare const LQA_CONTENT_UNIT_ID_SCHEMA: z.ZodString;
+export declare const LQA_SEGMENT_SCHEMA: z.ZodEffects<z.ZodObject<{
+    sourceValue: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+    translations: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        locale: z.ZodEffects<z.ZodString, string, string>;
+        value: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        id: string;
+        locale: string;
+    }, {
+        value: string;
+        id: string;
+        locale: string;
+    }>, "atleastone">;
+    tmMatch: z.ZodOptional<z.ZodObject<{
+        sourceValue: z.ZodEffects<z.ZodString, string, string>;
+        translatedValue: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        sourceValue: string;
+        translatedValue: string;
+    }, {
+        sourceValue: string;
+        translatedValue: string;
+    }>>;
+    translationExamples: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        sourceValue: z.ZodEffects<z.ZodString, string, string>;
+        translatedValue: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        sourceValue: string;
+        translatedValue: string;
+    }, {
+        sourceValue: string;
+        translatedValue: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    sourceValue: string;
+    translations: [{
+        value: string;
+        id: string;
+        locale: string;
+    }, ...{
+        value: string;
+        id: string;
+        locale: string;
+    }[]];
+    tmMatch?: {
+        sourceValue: string;
+        translatedValue: string;
+    } | undefined;
+    translationExamples?: {
+        sourceValue: string;
+        translatedValue: string;
+    }[] | undefined;
+}, {
+    sourceValue: string;
+    translations: [{
+        value: string;
+        id: string;
+        locale: string;
+    }, ...{
+        value: string;
+        id: string;
+        locale: string;
+    }[]];
+    tmMatch?: {
+        sourceValue: string;
+        translatedValue: string;
+    } | undefined;
+    translationExamples?: {
+        sourceValue: string;
+        translatedValue: string;
+    }[] | undefined;
+}>, {
+    sourceValue: string;
+    translations: [{
+        value: string;
+        id: string;
+        locale: string;
+    }, ...{
+        value: string;
+        id: string;
+        locale: string;
+    }[]];
+    tmMatch?: {
+        sourceValue: string;
+        translatedValue: string;
+    } | undefined;
+    translationExamples?: {
+        sourceValue: string;
+        translatedValue: string;
+    }[] | undefined;
+}, {
+    sourceValue: string;
+    translations: [{
+        value: string;
+        id: string;
+        locale: string;
+    }, ...{
+        value: string;
+        id: string;
+        locale: string;
+    }[]];
+    tmMatch?: {
+        sourceValue: string;
+        translatedValue: string;
+    } | undefined;
+    translationExamples?: {
+        sourceValue: string;
+        translatedValue: string;
+    }[] | undefined;
+}>;
+export declare const LQA_CONTENT_UNIT_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    context: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+    segments: z.ZodArray<z.ZodEffects<z.ZodObject<{
+        sourceValue: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+        translations: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            locale: z.ZodEffects<z.ZodString, string, string>;
+            value: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            id: string;
+            locale: string;
+        }, {
+            value: string;
+            id: string;
+            locale: string;
+        }>, "atleastone">;
+        tmMatch: z.ZodOptional<z.ZodObject<{
+            sourceValue: z.ZodEffects<z.ZodString, string, string>;
+            translatedValue: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            sourceValue: string;
+            translatedValue: string;
+        }, {
+            sourceValue: string;
+            translatedValue: string;
+        }>>;
+        translationExamples: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            sourceValue: z.ZodEffects<z.ZodString, string, string>;
+            translatedValue: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            sourceValue: string;
+            translatedValue: string;
+        }, {
+            sourceValue: string;
+            translatedValue: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }, {
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }>, {
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }, {
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }>, "atleastone">;
+    characterLimit: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    segments: [{
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }, ...{
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }[]];
+    id: string;
+    context?: {
+        description?: string | undefined;
+    } | undefined;
+    characterLimit?: number | undefined;
+}, {
+    segments: [{
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }, ...{
+        sourceValue: string;
+        translations: [{
+            value: string;
+            id: string;
+            locale: string;
+        }, ...{
+            value: string;
+            id: string;
+            locale: string;
+        }[]];
+        tmMatch?: {
+            sourceValue: string;
+            translatedValue: string;
+        } | undefined;
+        translationExamples?: {
+            sourceValue: string;
+            translatedValue: string;
+        }[] | undefined;
+    }[]];
+    id: string;
+    context?: {
+        description?: string | undefined;
+    } | undefined;
+    characterLimit?: number | undefined;
+}>;
+export type LqaAsyncContentUnit = z.infer<typeof LQA_CONTENT_UNIT_SCHEMA>;
+export type LqaAsyncSegment = z.infer<typeof LQA_SEGMENT_SCHEMA>;

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

@@ -1,7 +1,76 @@
+import z from 'zod';
+import { removeUnicodeNullCharacters } from "../../helpers/removeUnicodeNullCharacters.js";
+import { isSegmentUnderLengthLimit } from "../../validation/isSegmentUnderLengthLimit.js";
+import { CONTENT_ID_PROP_SCHEMA, LOCALE_SCHEMA, SEGMENT_VALUE_MAX_LENGTH_DEFAULT, TM_MATCH_SCHEMA, TRANSLATION_EXAMPLE_SCHEMA, } from "../common/commonSchemas.js";
 export const LqaIssueSeverityEnum = {
     NEUTRAL: 'neutral',
     MINOR: 'minor',
     MAJOR: 'major',
     CRITICAL: 'critical',
 };
+const LQA_SEGMENT_TRANSLATIONS_MAX_LENGTH = 10;
+const LQA_CONTENT_UNIT_DESCRIPTION_MAX_LENGTH = 32768;
+const LQA_CONTENT_UNIT_SEGMENTS_MAX_LENGTH = 500;
+export const LQA_TRANSLATION_ID_SCHEMA = CONTENT_ID_PROP_SCHEMA.describe('Unique ID of the segment translation');
+export const LQA_CONTENT_UNIT_ID_SCHEMA = CONTENT_ID_PROP_SCHEMA.describe('Unique ID of the content unit');
+const LQA_TRANSLATION_SCHEMA = z.object({
+    id: LQA_TRANSLATION_ID_SCHEMA,
+    locale: LOCALE_SCHEMA,
+    value: z
+        .string()
+        .min(1)
+        .refine((value) => isSegmentUnderLengthLimit(value), `Too long translation value, max length is ${SEGMENT_VALUE_MAX_LENGTH_DEFAULT} characters`)
+        .transform(removeUnicodeNullCharacters)
+        .describe('Translation of this segment in target language'),
+});
+export const LQA_SEGMENT_SCHEMA = z
+    .object({
+    sourceValue: z
+        .string()
+        .min(1)
+        .refine((value) => isSegmentUnderLengthLimit(value), `Too long segment value, max length is ${SEGMENT_VALUE_MAX_LENGTH_DEFAULT} characters`)
+        .transform(removeUnicodeNullCharacters)
+        .describe('Text content of the segment in source language'),
+    translations: z
+        .array(LQA_TRANSLATION_SCHEMA)
+        .nonempty()
+        .max(LQA_SEGMENT_TRANSLATIONS_MAX_LENGTH)
+        .describe('List of translations for this segment'),
+    tmMatch: TM_MATCH_SCHEMA.describe('This field is deprecated, please use "translationExamples" instead'),
+    translationExamples: z
+        .array(TRANSLATION_EXAMPLE_SCHEMA)
+        .optional()
+        .describe('When defined, the translation will attempt to follow the provided translation example'),
+})
+    .transform((segment) => {
+    if (segment.tmMatch) {
+        segment.translationExamples = segment.translationExamples
+            ? [...segment.translationExamples, segment.tmMatch]
+            : [segment.tmMatch];
+    }
+    if (segment.translationExamples?.length === 0) {
+        segment.translationExamples = undefined;
+    }
+    return segment;
+});
+export const LQA_CONTENT_UNIT_SCHEMA = z.object({
+    id: LQA_CONTENT_UNIT_ID_SCHEMA,
+    context: z
+        .object({
+        description: z
+            .string()
+            .min(1)
+            .max(LQA_CONTENT_UNIT_DESCRIPTION_MAX_LENGTH)
+            .describe('Unit description, something that applies to each segment in a unit. This will be passed as a helpful context to LLM calls')
+            .transform(removeUnicodeNullCharacters)
+            .optional(),
+    })
+        .optional(),
+    segments: z
+        .array(LQA_SEGMENT_SCHEMA)
+        .nonempty()
+        .max(LQA_CONTENT_UNIT_SEGMENTS_MAX_LENGTH)
+        .describe('List of segments to be reviewed'),
+    characterLimit: z.number().optional(),
+});
 //# sourceMappingURL=commonSchemas.js.map

package/dist/sdk/schemas/lqa/commonSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"commonSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/lqa/commonSchemas.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;CACZ,CAAA"}
+{"version":3,"file":"commonSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/lqa/commonSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AACnB,OAAO,EAAE,2BAA2B,EAAE,MAAM,8CAA8C,CAAA;AAE1F,OAAO,EAAE,yBAAyB,EAAE,MAAM,+CAA+C,CAAA;AACzF,OAAO,EACL,sBAAsB,EACtB,aAAa,EACb,gCAAgC,EAChC,eAAe,EACf,0BAA0B,GAC3B,MAAM,4BAA4B,CAAA;AAEnC,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;CACZ,CAAA;AAIV,MAAM,mCAAmC,GAAG,EAAE,CAAA;AAC9C,MAAM,uCAAuC,GAAG,KAAK,CAAA;AACrD,MAAM,oCAAoC,GAAG,GAAG,CAAA;AAEhD,MAAM,CAAC,MAAM,yBAAyB,GAAG,sBAAsB,CAAC,QAAQ,CACtE,sCAAsC,CACvC,CAAA;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,sBAAsB,CAAC,QAAQ,CACvE,+BAA+B,CAChC,CAAA;AAED,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,yBAAyB;IAC7B,MAAM,EAAE,aAAa;IACrB,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAC3C,6CAA6C,gCAAgC,aAAa,CAC3F;SACA,SAAS,CAAC,2BAA2B,CAAC;SACtC,QAAQ,CAAC,gDAAgD,CAAC;CAC9D,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAC3C,yCAAyC,gCAAgC,aAAa,CACvF;SACA,SAAS,CAAC,2BAA2B,CAAC;SACtC,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,sBAAsB,CAAC;SAC7B,QAAQ,EAAE;SACV,GAAG,CAAC,mCAAmC,CAAC;SACxC,QAAQ,CAAC,uCAAuC,CAAC;IACpD,OAAO,EAAE,eAAe,CAAC,QAAQ,CAC/B,oEAAoE,CACrE;IACD,mBAAmB,EAAE,CAAC;SACnB,KAAK,CAAC,0BAA0B,CAAC;SACjC,QAAQ,EAAE;SACV,QAAQ,CACP,uFAAuF,CACxF;CACJ,CAAC;KACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;IACrB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB;YACvD,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,OAAO,CAAC;YACnD,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACvB,CAAC;IACD,IAAI,OAAO,CAAC,mBAAmB,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAA;IACzC,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,0BAA0B;IAC9B,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,uCAAuC,CAAC;aAC5C,QAAQ,CACP,2HAA2H,CAC5H;aACA,SAAS,CAAC,2BAA2B,CAAC;aACtC,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,EAAE;IACb,QAAQ,EAAE,CAAC;SACR,KAAK,CAAC,kBAAkB,CAAC;SACzB,QAAQ,EAAE;SACV,GAAG,CAAC,oCAAoC,CAAC;SACzC,QAAQ,CAAC,iCAAiC,CAAC;IAC9C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAA"}