@lokalise/polyglot-sdk 19.1.0 → 20.0.0

package/dist/index.d.ts

@@ -1,22 +1,22 @@
-export { PolyglotClient } from './sdk/PolyglotClient.js';
-export { PolyglotError } from './sdk/errors/PolyglotError.js';
-export type { ClientOptions, PolyglotClientConfig } from './sdk/types/client.js';
-export * from './sdk/schemas/common/asyncRequestSchemas.js';
-export * from './sdk/schemas/common/commonSchemas.js';
-export * from './sdk/schemas/common/errorSchemas.js';
-export { TRANSLATION_CONTEXT_SCHEMA, isStructuredStyleGuide, } from './sdk/schemas/common/translationContextSchemas.js';
-export type { StructuredStyleGuide, FreeformStyleGuide, StyleGuideData, GlossaryTerm, TranslationContext, TextRewritingContext, TranslationExample, } from './sdk/schemas/common/translationContextSchemas.js';
-export { LqaIssueSeverityEnum } from './sdk/schemas/lqa/commonSchemas.js';
-export * from './sdk/schemas/lqa/lqaAsyncSchemas.js';
-export * from './sdk/schemas/lqa/lqaSyncSchemas.js';
-export * from './sdk/schemas/translation/generateVariants.js';
-export * from './sdk/schemas/translation/rewriteTextSchemas.js';
-export * from './sdk/schemas/translation/translateSyncSchemas.js';
-export * from './sdk/schemas/translation/translateAsyncSchemas.js';
-export * from './sdk/schemas/translation/translateTextSegmentSchemas.js';
-export * from './sdk/schemas/translation/sharedSchemas.js';
-export { isSegmentUnderLengthLimit, isSegmentUnderLengthLimit as isSegmentExceedingLengthLimit, } from './sdk/validation/isSegmentUnderLengthLimit.js';
-export { getRequestSizeLimit, isRequestSizeUnderLimit } from './sdk/validation/requestSizeLimit.js';
-export * from './sdk/helpers/htmlEscaping.js';
-export * from './sdk/helpers/nonTranslatableContentHelper.js';
-export * from './sdk/helpers/nonTranslatableContentWrappers.js';
+export { PolyglotClient } from './sdk/PolyglotClient.ts';
+export { PolyglotError } from './sdk/errors/PolyglotError.ts';
+export type { ClientOptions, PolyglotClientConfig } from './sdk/types/client.ts';
+export * from './sdk/schemas/common/asyncRequestSchemas.ts';
+export * from './sdk/schemas/common/commonSchemas.ts';
+export * from './sdk/schemas/common/errorSchemas.ts';
+export { TRANSLATION_CONTEXT_SCHEMA, isStructuredStyleGuide, } from './sdk/schemas/common/translationContextSchemas.ts';
+export type { StructuredStyleGuide, FreeformStyleGuide, StyleGuideData, GlossaryTerm, TranslationContext, TextRewritingContext, } from './sdk/schemas/common/translationContextSchemas.ts';
+export { LqaIssueSeverityEnum } from './sdk/schemas/lqa/commonSchemas.ts';
+export * from './sdk/schemas/lqa/lqaAsyncSchemas.ts';
+export * from './sdk/schemas/lqa/lqaSyncSchemas.ts';
+export * from './sdk/schemas/translation/generateVariants.ts';
+export * from './sdk/schemas/translation/rewriteTextSchemas.ts';
+export * from './sdk/schemas/translation/translateSyncSchemas.ts';
+export * from './sdk/schemas/translation/translateAsyncSchemas.ts';
+export * from './sdk/schemas/translation/translateTextSegmentSchemas.ts';
+export * from './sdk/schemas/translation/sharedSchemas.ts';
+export { isSegmentUnderLengthLimit, isSegmentUnderLengthLimit as isSegmentExceedingLengthLimit, } from './sdk/validation/isSegmentUnderLengthLimit.ts';
+export { getRequestSizeLimit, isRequestSizeUnderLimit } from './sdk/validation/requestSizeLimit.ts';
+export * from './sdk/helpers/htmlEscaping.ts';
+export * from './sdk/helpers/nonTranslatableContentHelper.ts';
+export * from './sdk/helpers/nonTranslatableContentWrappers.ts';

package/dist/index.js

@@ -1,21 +1,21 @@
-export { PolyglotClient } from './sdk/PolyglotClient.js';
-export { PolyglotError } from './sdk/errors/PolyglotError.js';
-export * from './sdk/schemas/common/asyncRequestSchemas.js';
-export * from './sdk/schemas/common/commonSchemas.js';
-export * from './sdk/schemas/common/errorSchemas.js';
-export { TRANSLATION_CONTEXT_SCHEMA, isStructuredStyleGuide, } from './sdk/schemas/common/translationContextSchemas.js';
-export { LqaIssueSeverityEnum } from './sdk/schemas/lqa/commonSchemas.js';
-export * from './sdk/schemas/lqa/lqaAsyncSchemas.js';
-export * from './sdk/schemas/lqa/lqaSyncSchemas.js';
-export * from './sdk/schemas/translation/generateVariants.js';
-export * from './sdk/schemas/translation/rewriteTextSchemas.js';
-export * from './sdk/schemas/translation/translateSyncSchemas.js';
-export * from './sdk/schemas/translation/translateAsyncSchemas.js';
-export * from './sdk/schemas/translation/translateTextSegmentSchemas.js';
-export * from './sdk/schemas/translation/sharedSchemas.js';
-export { isSegmentUnderLengthLimit, isSegmentUnderLengthLimit as isSegmentExceedingLengthLimit, } from './sdk/validation/isSegmentUnderLengthLimit.js';
-export { getRequestSizeLimit, isRequestSizeUnderLimit } from './sdk/validation/requestSizeLimit.js';
-export * from './sdk/helpers/htmlEscaping.js';
-export * from './sdk/helpers/nonTranslatableContentHelper.js';
-export * from './sdk/helpers/nonTranslatableContentWrappers.js';
+export { PolyglotClient } from "./sdk/PolyglotClient.js";
+export { PolyglotError } from "./sdk/errors/PolyglotError.js";
+export * from "./sdk/schemas/common/asyncRequestSchemas.js";
+export * from "./sdk/schemas/common/commonSchemas.js";
+export * from "./sdk/schemas/common/errorSchemas.js";
+export { TRANSLATION_CONTEXT_SCHEMA, isStructuredStyleGuide, } from "./sdk/schemas/common/translationContextSchemas.js";
+export { LqaIssueSeverityEnum } from "./sdk/schemas/lqa/commonSchemas.js";
+export * from "./sdk/schemas/lqa/lqaAsyncSchemas.js";
+export * from "./sdk/schemas/lqa/lqaSyncSchemas.js";
+export * from "./sdk/schemas/translation/generateVariants.js";
+export * from "./sdk/schemas/translation/rewriteTextSchemas.js";
+export * from "./sdk/schemas/translation/translateSyncSchemas.js";
+export * from "./sdk/schemas/translation/translateAsyncSchemas.js";
+export * from "./sdk/schemas/translation/translateTextSegmentSchemas.js";
+export * from "./sdk/schemas/translation/sharedSchemas.js";
+export { isSegmentUnderLengthLimit, isSegmentUnderLengthLimit as isSegmentExceedingLengthLimit, } from "./sdk/validation/isSegmentUnderLengthLimit.js";
+export { getRequestSizeLimit, isRequestSizeUnderLimit } from "./sdk/validation/requestSizeLimit.js";
+export * from "./sdk/helpers/htmlEscaping.js";
+export * from "./sdk/helpers/nonTranslatableContentHelper.js";
+export * from "./sdk/helpers/nonTranslatableContentWrappers.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAG7D,cAAc,6CAA6C,CAAA;AAE3D,cAAc,uCAAuC,CAAA;AACrD,cAAc,sCAAsC,CAAA;AACpD,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,mDAAmD,CAAA;AAW1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAA;AACzE,cAAc,sCAAsC,CAAA;AACpD,cAAc,qCAAqC,CAAA;AACnD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA;AAC/D,cAAc,mDAAmD,CAAA;AACjE,cAAc,oDAAoD,CAAA;AAClE,cAAc,0DAA0D,CAAA;AACxE,cAAc,4CAA4C,CAAA;AAE1D,OAAO,EACL,yBAAyB,EACzB,yBAAyB,IAAI,6BAA6B,GAC3D,MAAM,+CAA+C,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAEnG,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAG7D,cAAc,6CAA6C,CAAA;AAE3D,cAAc,uCAAuC,CAAA;AACrD,cAAc,sCAAsC,CAAA;AACpD,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,mDAAmD,CAAA;AAU1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAA;AACzE,cAAc,sCAAsC,CAAA;AACpD,cAAc,qCAAqC,CAAA;AACnD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA;AAC/D,cAAc,mDAAmD,CAAA;AACjE,cAAc,oDAAoD,CAAA;AAClE,cAAc,0DAA0D,CAAA;AACxE,cAAc,4CAA4C,CAAA;AAE1D,OAAO,EACL,yBAAyB,EACzB,yBAAyB,IAAI,6BAA6B,GAC3D,MAAM,+CAA+C,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAEnG,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+CAA+C,CAAA;AAC7D,cAAc,iDAAiD,CAAA"}

package/dist/sdk/PolyglotClient.d.ts

@@ -1,12 +1,12 @@
 import type { Either } from '@lokalise/node-core';
 import { InternalError } from '@lokalise/node-core';
-import { PolyglotError } from './errors/PolyglotError.js';
-import { type LqaAsyncBody, type LqaAsyncResponse } from './schemas/lqa/lqaAsyncSchemas.js';
-import type { LqaSyncBody, LqaSyncResponse } from './schemas/lqa/lqaSyncSchemas.js';
-import type { GenerateVariantsBody, GenerateVariantsResponse } from './schemas/translation/generateVariants.js';
-import type { TranslateAsyncBody, TranslateAsyncResponse } from './schemas/translation/translateAsyncSchemas.js';
-import { type TranslateSyncBody, type TranslateSyncResponse } from './schemas/translation/translateSyncSchemas.js';
-import type { ClientOptions, PolyglotClientConfig } from './types/client.js';
+import { PolyglotError } from './errors/PolyglotError.ts';
+import { type LqaAsyncBody, type LqaAsyncResponse } from './schemas/lqa/lqaAsyncSchemas.ts';
+import type { LqaSyncBody, LqaSyncResponse } from './schemas/lqa/lqaSyncSchemas.ts';
+import type { GenerateVariantsBody, GenerateVariantsResponse } from './schemas/translation/generateVariants.ts';
+import type { TranslateAsyncBody, TranslateAsyncResponse } from './schemas/translation/translateAsyncSchemas.ts';
+import { type TranslateSyncBody, type TranslateSyncResponse } from './schemas/translation/translateSyncSchemas.ts';
+import type { ClientOptions, PolyglotClientConfig } from './types/client.ts';
 type InstrumentationOutput<T> = Either<PolyglotError | InternalError, T>;
 export declare class PolyglotClient {
     private readonly client;

package/dist/sdk/PolyglotClient.js

@@ -1,12 +1,12 @@
 import { buildClient, isResponseStatusError, sendPost } from '@lokalise/backend-http-client';
 import { InternalError } from '@lokalise/node-core';
 import pino from 'pino';
-import { PolyglotError } from './errors/PolyglotError.js';
-import { LQA_ASYNC_RESPONSE_SCHEMA, } from './schemas/lqa/lqaAsyncSchemas.js';
-import { LQA_SYNC_RESPONSE_SCHEMA } from './schemas/lqa/lqaSyncSchemas.js';
-import { GENERATE_VARIANTS_RESPONSE_SCHEMA } from './schemas/translation/generateVariants.js';
-import { TRANSLATE_ASYNC_RESPONSE_SCHEMA } from './schemas/translation/translateAsyncSchemas.js';
-import { TRANSLATE_SYNC_RESPONSE_SCHEMA, } from './schemas/translation/translateSyncSchemas.js';
+import { PolyglotError } from "./errors/PolyglotError.js";
+import { LQA_ASYNC_RESPONSE_SCHEMA, } from "./schemas/lqa/lqaAsyncSchemas.js";
+import { LQA_SYNC_RESPONSE_SCHEMA } from "./schemas/lqa/lqaSyncSchemas.js";
+import { GENERATE_VARIANTS_RESPONSE_SCHEMA } from "./schemas/translation/generateVariants.js";
+import { TRANSLATE_ASYNC_RESPONSE_SCHEMA } from "./schemas/translation/translateAsyncSchemas.js";
+import { TRANSLATE_SYNC_RESPONSE_SCHEMA, } from "./schemas/translation/translateSyncSchemas.js";
 const DEFAULT_CLIENT_OPTIONS = {
     timeout: 30000,
 };

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

@@ -1,3 +1,3 @@
-import { type IntegrationEngineEnum } from '../schemas/common/commonSchemas.js';
+import { type IntegrationEngineEnum } from '../schemas/common/commonSchemas.ts';
 export declare const handleHtmlEscape: (text: string, integration?: IntegrationEngineEnum) => string;
 export declare const handleHtmlUnescape: (text: string, integration?: IntegrationEngineEnum) => string;

package/dist/sdk/helpers/htmlEscaping.js

@@ -1,6 +1,6 @@
 import { escape as escapeHtml, unescape as unescapeHtml } from 'html-escaper';
-import { MtIntegrationEngineEnum, } from '../schemas/common/commonSchemas.js';
-import { isEnumValue } from './isEnumValue.js';
+import { MtIntegrationEngineEnum, } from "../schemas/common/commonSchemas.js";
+import { isEnumValue } from "./isEnumValue.js";
 const isHtmlEscapingNeededByMtIntegration = {
     [MtIntegrationEngineEnum.DEEPL]: true,
     [MtIntegrationEngineEnum.GOOGLE_TRANSLATE]: true,

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

@@ -1,4 +1,4 @@
-import type { IntegrationEngineEnum } from '../schemas/common/commonSchemas.js';
+import type { IntegrationEngineEnum } from '../schemas/common/commonSchemas.ts';
 export type TextWithNonTranslatableRegions = {
     wrappedText: string;
     nonTranslatableRegions: string[];

package/dist/sdk/helpers/nonTranslatableContentHelper.js

@@ -1,5 +1,5 @@
 import { NON_TRANSLATABLE_END_TAG, NON_TRANSLATABLE_START_TAG, } from '@lokalise/non-translatable-markup';
-import { getWrapperByIntegration } from './nonTranslatableContentWrappers.js';
+import { getWrapperByIntegration } from "./nonTranslatableContentWrappers.js";
 export const NON_TRANSLATABLE_REGION_REGEX = new RegExp(String.raw `${NON_TRANSLATABLE_START_TAG}[\s\S]*?${NON_TRANSLATABLE_END_TAG}`, 'g');
 /**
  * Extracts matches from a string using a regular expression

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

@@ -1,4 +1,4 @@
-import { type IntegrationEngineEnum } from '../schemas/common/commonSchemas.js';
+import { type IntegrationEngineEnum } from '../schemas/common/commonSchemas.ts';
 export type WrapperDefinition = {
     wrap: (content: string, id: number) => string;
     regexp: RegExp;

package/dist/sdk/helpers/nonTranslatableContentWrappers.js

@@ -1,5 +1,5 @@
-import { MtIntegrationEngineEnum, } from '../schemas/common/commonSchemas.js';
-import { isEnumValue } from './isEnumValue.js';
+import { MtIntegrationEngineEnum, } from "../schemas/common/commonSchemas.js";
+import { isEnumValue } from "./isEnumValue.js";
 const createWrapperMatchingRegexp = (tagWithAttributes) => {
     const tag = tagWithAttributes.trim().split(' ').shift();
     return new RegExp(String.raw `<${tagWithAttributes} id=\\*["'](\d+)\\*["']>([\s\S]*?)</${tag}>`, 'g');

package/dist/sdk/schemas/common/asyncRequestSchemas.d.ts

@@ -1,5 +1,5 @@
 import z from 'zod';
-import type { ObjectValues } from '../../types/common.js';
+import type { ObjectValues } from '../../types/common.ts';
 export declare const ORIGIN_CORRELATION_ID_SCHEMA: z.ZodString;
 export declare const OWNER_ID_SCHEMA: z.ZodString;
 export declare const TENANT_ID_SCHEMA: z.ZodString;

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

@@ -1,5 +1,5 @@
 import z from 'zod';
-import type { ObjectValues } from '../../types/common.js';
+import type { ObjectValues } from '../../types/common.ts';
 export declare const FinetunedIntegrationEngineEnum: {
     readonly FINETUNED_OPENAI: "FT-OpenAI";
 };
@@ -7,16 +7,21 @@ export type FinetunedIntegrationEngineEnum = ObjectValues<typeof FinetunedIntegr
 export declare const AiIntegrationEngineEnum: {
     readonly FINETUNED_OPENAI: "FT-OpenAI";
     readonly CLAUDE: "Claude";
-    readonly CHAT_GPT4: "ChatGPT-4";
+    readonly GPT: "GPT";
     readonly GEMINI: "Gemini";
 };
 export type AiIntegrationEngineEnum = ObjectValues<typeof AiIntegrationEngineEnum>;
-export declare const AI_INTEGRATION_ENGINE_SCHEMA: z.ZodNativeEnum<{
-    readonly FINETUNED_OPENAI: "FT-OpenAI";
-    readonly CLAUDE: "Claude";
+export declare const DeprecatedAiIntegrationEngineEnum: {
     readonly CHAT_GPT4: "ChatGPT-4";
-    readonly GEMINI: "Gemini";
-}>;
+};
+export type DeprecatedAiIntegrationEngineEnum = ObjectValues<typeof DeprecatedAiIntegrationEngineEnum>;
+export declare const AI_INTEGRATION_ENGINE_SCHEMA: z.ZodEffects<z.ZodNativeEnum<{
+    CHAT_GPT4: "ChatGPT-4";
+    FINETUNED_OPENAI: "FT-OpenAI";
+    CLAUDE: "Claude";
+    GPT: "GPT";
+    GEMINI: "Gemini";
+}>, "FT-OpenAI" | "Claude" | "GPT" | "Gemini", "FT-OpenAI" | "Claude" | "GPT" | "Gemini" | "ChatGPT-4">;
 export declare const MtIntegrationEngineEnum: {
     readonly DEEPL: "DeepL";
     readonly GOOGLE_TRANSLATE: "GoogleTranslate";
@@ -31,22 +36,23 @@ export declare const MT_INTEGRATION_ENGINE_SCHEMA: z.ZodNativeEnum<{
 export declare const RealIntegrationEngineEnum: {
     readonly FINETUNED_OPENAI: "FT-OpenAI";
     readonly CLAUDE: "Claude";
-    readonly CHAT_GPT4: "ChatGPT-4";
+    readonly GPT: "GPT";
     readonly GEMINI: "Gemini";
     readonly DEEPL: "DeepL";
     readonly GOOGLE_TRANSLATE: "GoogleTranslate";
     readonly MICROSOFT_TRANSLATOR: "MicrosoftTranslator";
 };
 export type RealIntegrationEngineEnum = ObjectValues<typeof RealIntegrationEngineEnum>;
-export declare const REAL_INTEGRATION_ENGINE_SCHEMA: z.ZodNativeEnum<{
-    readonly FINETUNED_OPENAI: "FT-OpenAI";
-    readonly CLAUDE: "Claude";
-    readonly CHAT_GPT4: "ChatGPT-4";
-    readonly GEMINI: "Gemini";
-    readonly DEEPL: "DeepL";
-    readonly GOOGLE_TRANSLATE: "GoogleTranslate";
-    readonly MICROSOFT_TRANSLATOR: "MicrosoftTranslator";
-}>;
+export declare const REAL_INTEGRATION_ENGINE_SCHEMA: z.ZodEffects<z.ZodNativeEnum<{
+    CHAT_GPT4: "ChatGPT-4";
+    FINETUNED_OPENAI: "FT-OpenAI";
+    CLAUDE: "Claude";
+    GPT: "GPT";
+    GEMINI: "Gemini";
+    DEEPL: "DeepL";
+    GOOGLE_TRANSLATE: "GoogleTranslate";
+    MICROSOFT_TRANSLATOR: "MicrosoftTranslator";
+}>, "FT-OpenAI" | "Claude" | "GPT" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator", "FT-OpenAI" | "Claude" | "GPT" | "Gemini" | "ChatGPT-4" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator">;
 export declare const FORCE_INTEGRATION_SCHEMA: z.ZodBoolean;
 export declare const refineIntegrationIsPresent: readonly [(data: {
     integration?: string;
@@ -56,7 +62,7 @@ export declare const IntegrationEngineEnum: {
     readonly FAKE: "Fake";
     readonly FINETUNED_OPENAI: "FT-OpenAI";
     readonly CLAUDE: "Claude";
-    readonly CHAT_GPT4: "ChatGPT-4";
+    readonly GPT: "GPT";
     readonly GEMINI: "Gemini";
     readonly DEEPL: "DeepL";
     readonly GOOGLE_TRANSLATE: "GoogleTranslate";
@@ -77,14 +83,14 @@ export declare const COMMON_ERROR_RESPONSE_SCHEMA: z.ZodObject<{
     details?: Record<string, unknown> | undefined;
 }>;
 export type CommonErrorResponse = z.infer<typeof COMMON_ERROR_RESPONSE_SCHEMA>;
-export declare const COMMON_FAILED_OPERATION_CALLBACK_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+export declare const COMMON_FAILED_OPERATION_CALLBACK_SCHEMA: z.ZodObject<{
     message: z.ZodString;
     errorCode: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, {
+} & {
     status: z.ZodLiteral<"error">;
     originCorrelationId: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     originCorrelationId: string;
     message: string;
     status: "error";
@@ -117,6 +123,17 @@ export declare const TM_MATCH_SCHEMA: z.ZodOptional<z.ZodObject<{
     sourceValue: string;
     translatedValue: string;
 }>>;
+export declare const TRANSLATION_EXAMPLE_SCHEMA: z.ZodObject<{
+    sourceValue: z.ZodString;
+    translatedValue: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    sourceValue: string;
+    translatedValue: string;
+}, {
+    sourceValue: string;
+    translatedValue: string;
+}>;
+export type TranslationExample = z.infer<typeof TRANSLATION_EXAMPLE_SCHEMA>;
 export declare const SEGMENT_VALUE_MAX_LENGTH_DEFAULT = 16384;
 export declare const REQUEST_SIZE_LIMIT_MAP: Record<IntegrationEngineEnum, number>;
 declare const JSON_PRIMITIVE_DATA_SCHEMA: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;

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

@@ -1,18 +1,27 @@
 import { isSupportedLocale } from '@lokalise/supported-languages';
 import { toBooleanPreprocessor } from '@lokalise/zod-extras';
 import z from 'zod';
-import { AsyncRequestCallbackStatusEnum } from './asyncRequestSchemas.js';
+import { AsyncRequestCallbackStatusEnum } from "./asyncRequestSchemas.js";
 export const FinetunedIntegrationEngineEnum = {
     FINETUNED_OPENAI: 'FT-OpenAI',
 };
 export const AiIntegrationEngineEnum = {
     CLAUDE: 'Claude',
-    CHAT_GPT4: 'ChatGPT-4',
+    GPT: 'GPT',
     GEMINI: 'Gemini',
     ...FinetunedIntegrationEngineEnum,
 };
+export const DeprecatedAiIntegrationEngineEnum = {
+    CHAT_GPT4: 'ChatGPT-4', // ChatGPT-4 is depreciated in favour of GPT
+};
 export const AI_INTEGRATION_ENGINE_SCHEMA = z
-    .nativeEnum(AiIntegrationEngineEnum)
+    .nativeEnum({ ...AiIntegrationEngineEnum, ...DeprecatedAiIntegrationEngineEnum })
+    .transform((val) => {
+    if (val === DeprecatedAiIntegrationEngineEnum.CHAT_GPT4) {
+        return AiIntegrationEngineEnum.GPT;
+    }
+    return val;
+})
     .describe('Indicates which integration should be used to process the request');
 export const MtIntegrationEngineEnum = {
     DEEPL: 'DeepL',
@@ -27,7 +36,13 @@ export const RealIntegrationEngineEnum = {
     ...AiIntegrationEngineEnum,
 };
 export const REAL_INTEGRATION_ENGINE_SCHEMA = z
-    .nativeEnum(RealIntegrationEngineEnum)
+    .nativeEnum({ ...RealIntegrationEngineEnum, ...DeprecatedAiIntegrationEngineEnum })
+    .transform((val) => {
+    if (val === DeprecatedAiIntegrationEngineEnum.CHAT_GPT4) {
+        return AiIntegrationEngineEnum.GPT;
+    }
+    return val;
+})
     .describe('Indicates which integration should be used to process the request (preferably)');
 export const FORCE_INTEGRATION_SCHEMA = z
     .boolean()
@@ -76,6 +91,10 @@ export const TM_MATCH_SCHEMA = z
 })
     .optional()
     .describe('When defined, the translation will attempt to follow the provided sourceValue and translatedValue translation example');
+export const TRANSLATION_EXAMPLE_SCHEMA = z.object({
+    sourceValue: z.string().min(1).max(50_000),
+    translatedValue: z.string().min(1).max(50_000),
+});
 export const SEGMENT_VALUE_MAX_LENGTH_DEFAULT = 16384;
 export const REQUEST_SIZE_LIMIT_MAP = {
     /**
@@ -101,7 +120,7 @@ export const REQUEST_SIZE_LIMIT_MAP = {
      */
     [IntegrationEngineEnum.GEMINI]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,
     [IntegrationEngineEnum.CLAUDE]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,
-    [IntegrationEngineEnum.CHAT_GPT4]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,
+    [IntegrationEngineEnum.GPT]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,
     [IntegrationEngineEnum.FINETUNED_OPENAI]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,
     [IntegrationEngineEnum.FAKE]: SEGMENT_VALUE_MAX_LENGTH_DEFAULT,
 };

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

@@ -1 +1 @@
-{"version":3,"file":"commonSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/common/commonSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,CAAC,MAAM,KAAK,CAAA;AAGnB,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAA;AAEzE,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,gBAAgB,EAAE,WAAW;CACrB,CAAA;AAGV,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,GAAG,8BAA8B;CACzB,CAAA;AAGV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,UAAU,CAAC,uBAAuB,CAAC;KACnC,QAAQ,CAAC,mEAAmE,CAAC,CAAA;AAEhF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,KAAK,EAAE,OAAO;IACd,gBAAgB,EAAE,iBAAiB;IACnC,oBAAoB,EAAE,qBAAqB;CACnC,CAAA;AAGV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,UAAU,CAAC,uBAAuB,CAAC;KACnC,QAAQ,CAAC,mEAAmE,CAAC,CAAA;AAEhF,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,GAAG,uBAAuB;IAC1B,GAAG,uBAAuB;CAClB,CAAA;AAGV,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,UAAU,CAAC,yBAAyB,CAAC;KACrC,QAAQ,CAAC,gFAAgF,CAAC,CAAA;AAE7F,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,OAAO,EAAE;KACT,QAAQ,CACP,+HAA+H,CAChI,CAAA;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,CAAC,IAA0D,EAAE,EAAE;QAC7D,OAAO,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAA;IAC9E,CAAC;IACD,oEAAoE;CAC5D,CAAA;AAEV,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,GAAG,yBAAyB;IAC5B,IAAI,EAAE,MAAM;CACJ,CAAA;AAGV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACrD,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC/B,QAAQ,CAAC,+DAA+D,CAAC;SACzE,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,0CAA0C,CAAC,CAAA;AAIvD,MAAM,CAAC,MAAM,uCAAuC,GAAG,4BAA4B,CAAC,MAAM,CAAC;IACzF,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC;IACvD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;CAChC,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAA;AAIrC,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,mBAAmB,EAAE,CAAC;SACnB,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC9C,QAAQ,CACP,0FAA0F,CAC3F;SACA,QAAQ,EAAE;CACd,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,wCAAwC,CAAC;KAClD,MAAM,CAAC,iBAAiB,EAAE;IACzB,OAAO,EAAE,gBAAgB;CAC1B,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACxC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;CAC7C,CAAC;KACD,QAAQ,EAAE;KACV,QAAQ,CACP,uHAAuH,CACxH,CAAA;AAEH,MAAM,CAAC,MAAM,gCAAgC,GAAG,KAAK,CAAA;AAErD,MAAM,CAAC,MAAM,sBAAsB,GAA0C;IAC3E;;;OAGG;IACH,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,KAAK;IAC/C;;;;OAIG;IACH,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,MAAM;IACrC;;;;OAIG;IACH,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,EAAE,KAAK;IACnD;;;OAGG;IACH,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,gCAAgC;IAChE,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,gCAAgC;IAChE,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAAE,gCAAgC;IACnE,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,gCAAgC;IAC1E,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,gCAAgC;CAC/D,CAAA;AAED,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAK3F,MAAM,gBAAgB,GAAwB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CACxD,CAAC,CAAC,KAAK,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAC7F,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC,gBAAgB,CAAC;KACxB,QAAQ,CAAC,qEAAqE,CAAC;KAC/E,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"commonSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/common/commonSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,CAAC,MAAM,KAAK,CAAA;AAGnB,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAA;AAEzE,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,gBAAgB,EAAE,WAAW;CACrB,CAAA;AAGV,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;IAChB,GAAG,8BAA8B;CACzB,CAAA;AAGV,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,SAAS,EAAE,WAAW,EAAE,4CAA4C;CAC5D,CAAA;AAKV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,UAAU,CAAC,EAAE,GAAG,uBAAuB,EAAE,GAAG,iCAAiC,EAAE,CAAC;KAChF,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;IACjB,IAAI,GAAG,KAAK,iCAAiC,CAAC,SAAS,EAAE,CAAC;QACxD,OAAO,uBAAuB,CAAC,GAAG,CAAA;IACpC,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAC;KACD,QAAQ,CAAC,mEAAmE,CAAC,CAAA;AAEhF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,KAAK,EAAE,OAAO;IACd,gBAAgB,EAAE,iBAAiB;IACnC,oBAAoB,EAAE,qBAAqB;CACnC,CAAA;AAGV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,UAAU,CAAC,uBAAuB,CAAC;KACnC,QAAQ,CAAC,mEAAmE,CAAC,CAAA;AAEhF,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,GAAG,uBAAuB;IAC1B,GAAG,uBAAuB;CAClB,CAAA;AAGV,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,UAAU,CAAC,EAAE,GAAG,yBAAyB,EAAE,GAAG,iCAAiC,EAAE,CAAC;KAClF,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;IACjB,IAAI,GAAG,KAAK,iCAAiC,CAAC,SAAS,EAAE,CAAC;QACxD,OAAO,uBAAuB,CAAC,GAAG,CAAA;IACpC,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAC;KACD,QAAQ,CAAC,gFAAgF,CAAC,CAAA;AAE7F,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,OAAO,EAAE;KACT,QAAQ,CACP,+HAA+H,CAChI,CAAA;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,CAAC,IAA0D,EAAE,EAAE;QAC7D,OAAO,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAA;IAC9E,CAAC;IACD,oEAAoE;CAC5D,CAAA;AAEV,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,GAAG,yBAAyB;IAC5B,IAAI,EAAE,MAAM;CACJ,CAAA;AAGV,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACrD,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC/B,QAAQ,CAAC,+DAA+D,CAAC;SACzE,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,0CAA0C,CAAC,CAAA;AAIvD,MAAM,CAAC,MAAM,uCAAuC,GAAG,4BAA4B,CAAC,MAAM,CAAC;IACzF,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC;IACvD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;CAChC,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAA;AAIrC,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,mBAAmB,EAAE,CAAC;SACnB,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC9C,QAAQ,CACP,0FAA0F,CAC3F;SACA,QAAQ,EAAE;CACd,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,wCAAwC,CAAC;KAClD,MAAM,CAAC,iBAAiB,EAAE;IACzB,OAAO,EAAE,gBAAgB;CAC1B,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACxC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;CAC7C,CAAC;KACD,QAAQ,EAAE;KACV,QAAQ,CACP,uHAAuH,CACxH,CAAA;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IAC1C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;CAC/C,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,gCAAgC,GAAG,KAAK,CAAA;AAErD,MAAM,CAAC,MAAM,sBAAsB,GAA0C;IAC3E;;;OAGG;IACH,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,KAAK;IAC/C;;;;OAIG;IACH,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,MAAM;IACrC;;;;OAIG;IACH,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,EAAE,KAAK;IACnD;;;OAGG;IACH,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,gCAAgC;IAChE,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,gCAAgC;IAChE,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,gCAAgC;IAC7D,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,gCAAgC;IAC1E,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,gCAAgC;CAC/D,CAAA;AAED,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAK3F,MAAM,gBAAgB,GAAwB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CACxD,CAAC,CAAC,KAAK,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAC7F,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC,gBAAgB,CAAC;KACxB,QAAQ,CAAC,qEAAqE,CAAC;KAC/E,QAAQ,EAAE,CAAA"}

package/dist/sdk/schemas/common/errorSchemas.d.ts

@@ -1,5 +1,5 @@
 import z from 'zod';
-import type { ObjectValues } from '../../types/common.js';
+import type { ObjectValues } from '../../types/common.ts';
 export declare const ErrorCodeEnum: {
     readonly ValidationError: "VALIDATION_ERROR";
     readonly ContextNotSupportedError: "CONTEXT_NOT_SUPPORTED";
@@ -8,13 +8,12 @@ export declare const ErrorCodeEnum: {
     readonly LanguagePairNotSupportedError: "LANGUAGE_PAIR_NOT_SUPPORTED";
 };
 export type ErrorCodeEnum = ObjectValues<typeof ErrorCodeEnum>;
-export declare const VALIDATION_ERROR_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+export declare const VALIDATION_ERROR_SCHEMA: z.ZodObject<{
     message: z.ZodString;
-    errorCode: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, {
+} & {
     errorCode: z.ZodLiteral<"VALIDATION_ERROR">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     message: string;
     errorCode: "VALIDATION_ERROR";
     details?: Record<string, unknown> | undefined;
@@ -23,13 +22,12 @@ export declare const VALIDATION_ERROR_SCHEMA: z.ZodObject<z.objectUtil.extendSha
     errorCode: "VALIDATION_ERROR";
     details?: Record<string, unknown> | undefined;
 }>;
-export declare const CONTEXT_NOT_SUPPORTED_ERROR_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+export declare const CONTEXT_NOT_SUPPORTED_ERROR_SCHEMA: z.ZodObject<{
     message: z.ZodString;
-    errorCode: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, {
+} & {
     errorCode: z.ZodLiteral<"CONTEXT_NOT_SUPPORTED">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     message: string;
     errorCode: "CONTEXT_NOT_SUPPORTED";
     details?: Record<string, unknown> | undefined;
@@ -38,13 +36,12 @@ export declare const CONTEXT_NOT_SUPPORTED_ERROR_SCHEMA: z.ZodObject<z.objectUti
     errorCode: "CONTEXT_NOT_SUPPORTED";
     details?: Record<string, unknown> | undefined;
 }>;
-export declare const INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+export declare const INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA: z.ZodObject<{
     message: z.ZodString;
-    errorCode: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, {
+} & {
     errorCode: z.ZodLiteral<"INTEGRATION_NOT_AVAILABLE_ERROR">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     message: string;
     errorCode: "INTEGRATION_NOT_AVAILABLE_ERROR";
     details?: Record<string, unknown> | undefined;
@@ -53,13 +50,12 @@ export declare const INTEGRATION_NOT_AVAILABLE_ERROR_SCHEMA: z.ZodObject<z.objec
     errorCode: "INTEGRATION_NOT_AVAILABLE_ERROR";
     details?: Record<string, unknown> | undefined;
 }>;
-export declare const INTEGRATION_NOT_ENABLED_ERROR_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+export declare const INTEGRATION_NOT_ENABLED_ERROR_SCHEMA: z.ZodObject<{
     message: z.ZodString;
-    errorCode: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, {
+} & {
     errorCode: z.ZodLiteral<"INTEGRATION_NOT_ENABLED_ERROR">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     message: string;
     errorCode: "INTEGRATION_NOT_ENABLED_ERROR";
     details?: Record<string, unknown> | undefined;
@@ -68,13 +64,12 @@ export declare const INTEGRATION_NOT_ENABLED_ERROR_SCHEMA: z.ZodObject<z.objectU
     errorCode: "INTEGRATION_NOT_ENABLED_ERROR";
     details?: Record<string, unknown> | undefined;
 }>;
-export declare const LANGUAGE_PAIR_NOT_SUPPORTED_ERROR_SCHEMA: z.ZodObject<z.objectUtil.extendShape<{
+export declare const LANGUAGE_PAIR_NOT_SUPPORTED_ERROR_SCHEMA: z.ZodObject<{
     message: z.ZodString;
-    errorCode: z.ZodString;
     details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, {
+} & {
     errorCode: z.ZodLiteral<"LANGUAGE_PAIR_NOT_SUPPORTED">;
-}>, "strip", z.ZodTypeAny, {
+}, "strip", z.ZodTypeAny, {
     message: string;
     errorCode: "LANGUAGE_PAIR_NOT_SUPPORTED";
     details?: Record<string, unknown> | undefined;

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

@@ -1,5 +1,5 @@
 import z from 'zod';
-import { COMMON_ERROR_RESPONSE_SCHEMA } from './commonSchemas.js';
+import { COMMON_ERROR_RESPONSE_SCHEMA } from "./commonSchemas.js";
 export const ErrorCodeEnum = {
     ValidationError: 'VALIDATION_ERROR',
     ContextNotSupportedError: 'CONTEXT_NOT_SUPPORTED',

package/dist/sdk/schemas/common/translationContextSchemas.d.ts

@@ -133,17 +133,6 @@ export declare const GLOSSARY_TERM_SCHEMA: z.ZodEffects<z.ZodObject<{
     }[] | undefined;
 }>;
 export type GlossaryTerm = z.infer<typeof GLOSSARY_TERM_SCHEMA>;
-export declare const TRANSLATION_EXAMPLE_SCHEMA: z.ZodObject<{
-    sourceValue: z.ZodString;
-    translatedValue: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    sourceValue: string;
-    translatedValue: string;
-}, {
-    sourceValue: string;
-    translatedValue: string;
-}>;
-export type TranslationExample = z.infer<typeof TRANSLATION_EXAMPLE_SCHEMA>;
 export declare const TRANSLATION_CONTEXT_SCHEMA: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     styleGuide: z.ZodOptional<z.ZodUnion<[z.ZodObject<{

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

@@ -1,5 +1,5 @@
 import z from 'zod';
-import { LOCALE_SCHEMA } from './commonSchemas.js';
+import { LOCALE_SCHEMA, TRANSLATION_EXAMPLE_SCHEMA } from "./commonSchemas.js";
 // ------------------------------------------
 // Style guide
 // ------------------------------------------
@@ -66,10 +66,6 @@ export const GLOSSARY_TERM_SCHEMA = z
     .refine(({ translations, translatable, forbidden, caseSensitive }) => !!translations || !translatable || caseSensitive || forbidden, {
     message: 'You should either provide `translations` for the term or mark it as `translatable: false`, `caseSensitive: true`, or `forbidden: true`',
 });
-export const TRANSLATION_EXAMPLE_SCHEMA = z.object({
-    sourceValue: z.string().min(1).max(50_000),
-    translatedValue: z.string().min(1).max(50_000),
-});
 export const TRANSLATION_CONTEXT_SCHEMA = z
     .object({
     description: z
@@ -89,7 +85,7 @@ export const TRANSLATION_CONTEXT_SCHEMA = z
     translationExamples: z
         .array(TRANSLATION_EXAMPLE_SCHEMA)
         .optional()
-        .describe('When defined, the translation will attempt to follow the provided sourceValue and translatedValue translation example'),
+        .describe('This field is deprecated, please use "translationExamples" at the "segment" level instead. When defined, the translation will attempt to follow the provided sourceValue and translatedValue translation example'),
 })
     .describe('Helpful translation context');
 export const TEXT_REWRITING_CONTEXT = TRANSLATION_CONTEXT_SCHEMA.omit({ targetPluralForms: true });

package/dist/sdk/schemas/common/translationContextSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"translationContextSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/common/translationContextSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,6CAA6C;AAC7C,cAAc;AACd,6CAA6C;AAE7C,MAAM,6BAA6B,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5E,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;SACxE,QAAQ,EAAE;IACb,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtE,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE;CAClE,CAAC;KACD,QAAQ,CAAC,gDAAgD,CAAC;KAC1D,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE;IAC1D,OAAO,EAAE,4CAA4C;CACtD,CAAC,CAAA;AAIJ,MAAM,2BAA2B,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iEAAiE,CAAC;CAC7F,CAAC;KACD,QAAQ,CAAC,2BAA2B,CAAC,CAAA;AAIxC,MAAM,kBAAkB,GAAG,CAAC;KACzB,KAAK,CAAC,CAAC,2BAA2B,EAAE,6BAA6B,CAAC,CAAC;KACnE,QAAQ,CACP,4GAA4G,CAC7G,CAAA;AAIH,MAAM,UAAU,sBAAsB,CACpC,KAA8B;IAE9B,OAAO,CACL,KAAK,CAAC,cAAc,KAAK,SAAS;QAClC,KAAK,CAAC,WAAW,KAAK,SAAS;QAC/B,KAAK,CAAC,gBAAgB,KAAK,SAAS;QACpC,KAAK,CAAC,WAAW,KAAK,SAAS,CAChC,CAAA;AACH,CAAC;AAED,6CAA6C;AAC7C,WAAW;AACX,6CAA6C;AAE7C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAChE,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,iOAAiO,CAClO;SACA,QAAQ,EAAE;IACb,YAAY,EAAE,CAAC;SACZ,OAAO,EAAE;SACT,QAAQ,CAAC,yEAAyE,CAAC;SACnF,OAAO,CAAC,IAAI,CAAC;IAChB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5F,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,CACP,2GAA2G,CAC5G;SACA,OAAO,CAAC,KAAK,CAAC;IACjB,YAAY,EAAE,CAAC;SACZ,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,aAAa;QACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC;QAC9E,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,CAAC,iDAAiD,CAAC;aAC3D,QAAQ,EAAE;KACd,CAAC,CACH;SACA,QAAQ,CAAC,iFAAiF,CAAC;SAC3F,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,eAAe,CAAC;KACzB,MAAM,CACL,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE,CAC3D,CAAC,CAAC,YAAY,IAAI,CAAC,YAAY,IAAI,aAAa,IAAI,SAAS,EAC/D;IACE,OAAO,EACL,wIAAwI;CAC3I,CACF,CAAA;AAIH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IAC1C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;CAC/C,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,qFAAqF,CACtF;SACA,QAAQ,EAAE;IACb,UAAU,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;IACrF,iBAAiB,EAAE,CAAC;SACjB,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;SAC7D,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,EACzD,6BAA6B,CAC9B;SACA,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,mCAAmC,CAAC;SACzF,QAAQ,CACP,mGAAmG,CACpG;IACH,mBAAmB,EAAE,CAAC;SACnB,KAAK,CAAC,0BAA0B,CAAC;SACjC,QAAQ,EAAE;SACV,QAAQ,CACP,uHAAuH,CACxH;CACJ,CAAC;KACD,QAAQ,CAAC,6BAA6B,CAAC,CAAA;AAI1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,0BAA0B,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAA"}
+{"version":3,"file":"translationContextSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/common/translationContextSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,OAAO,EAAE,aAAa,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAA;AAE9E,6CAA6C;AAC7C,cAAc;AACd,6CAA6C;AAE7C,MAAM,6BAA6B,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5E,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;SACxE,QAAQ,EAAE;IACb,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtE,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,QAAQ,EAAE;CAClE,CAAC;KACD,QAAQ,CAAC,gDAAgD,CAAC;KAC1D,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE;IAC1D,OAAO,EAAE,4CAA4C;CACtD,CAAC,CAAA;AAIJ,MAAM,2BAA2B,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iEAAiE,CAAC;CAC7F,CAAC;KACD,QAAQ,CAAC,2BAA2B,CAAC,CAAA;AAIxC,MAAM,kBAAkB,GAAG,CAAC;KACzB,KAAK,CAAC,CAAC,2BAA2B,EAAE,6BAA6B,CAAC,CAAC;KACnE,QAAQ,CACP,4GAA4G,CAC7G,CAAA;AAIH,MAAM,UAAU,sBAAsB,CACpC,KAA8B;IAE9B,OAAO,CACL,KAAK,CAAC,cAAc,KAAK,SAAS;QAClC,KAAK,CAAC,WAAW,KAAK,SAAS;QAC/B,KAAK,CAAC,gBAAgB,KAAK,SAAS;QACpC,KAAK,CAAC,WAAW,KAAK,SAAS,CAChC,CAAA;AACH,CAAC;AAED,6CAA6C;AAC7C,WAAW;AACX,6CAA6C;AAE7C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAChE,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,iOAAiO,CAClO;SACA,QAAQ,EAAE;IACb,YAAY,EAAE,CAAC;SACZ,OAAO,EAAE;SACT,QAAQ,CAAC,yEAAyE,CAAC;SACnF,OAAO,CAAC,IAAI,CAAC;IAChB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5F,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,CACP,2GAA2G,CAC5G;SACA,OAAO,CAAC,KAAK,CAAC;IACjB,YAAY,EAAE,CAAC;SACZ,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,aAAa;QACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC;QAC9E,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,CAAC,iDAAiD,CAAC;aAC3D,QAAQ,EAAE;KACd,CAAC,CACH;SACA,QAAQ,CAAC,iFAAiF,CAAC;SAC3F,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,eAAe,CAAC;KACzB,MAAM,CACL,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE,CAC3D,CAAC,CAAC,YAAY,IAAI,CAAC,YAAY,IAAI,aAAa,IAAI,SAAS,EAC/D;IACE,OAAO,EACL,wIAAwI;CAC3I,CACF,CAAA;AAIH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,qFAAqF,CACtF;SACA,QAAQ,EAAE;IACb,UAAU,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;IACrF,iBAAiB,EAAE,CAAC;SACjB,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;SAC7D,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,EACzD,6BAA6B,CAC9B;SACA,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,mCAAmC,CAAC;SACzF,QAAQ,CACP,mGAAmG,CACpG;IACH,mBAAmB,EAAE,CAAC;SACnB,KAAK,CAAC,0BAA0B,CAAC;SACjC,QAAQ,EAAE;SACV,QAAQ,CACP,kNAAkN,CACnN;CACJ,CAAC;KACD,QAAQ,CAAC,6BAA6B,CAAC,CAAA;AAI1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,0BAA0B,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAA"}

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

@@ -1,4 +1,4 @@
-import type { ObjectValues } from '../../types/common.js';
+import type { ObjectValues } from '../../types/common.ts';
 export declare const LqaIssueSeverityEnum: {
     readonly NEUTRAL: "neutral";
     readonly MINOR: "minor";