@lokalise/polyglot-sdk 18.0.0 → 19.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist/index.d.ts +0 -1
  2. package/dist/index.js +0 -1
  3. package/dist/index.js.map +1 -1
  4. package/dist/sdk/PolyglotClient.d.ts +0 -5
  5. package/dist/sdk/PolyglotClient.js +0 -23
  6. package/dist/sdk/PolyglotClient.js.map +1 -1
  7. package/dist/sdk/schemas/common/commonSchemas.d.ts +6 -0
  8. package/dist/sdk/schemas/common/commonSchemas.js +10 -1
  9. package/dist/sdk/schemas/common/commonSchemas.js.map +1 -1
  10. package/dist/sdk/schemas/lqa/lqaAsyncSchemas.d.ts +5 -115
  11. package/dist/sdk/schemas/lqa/lqaAsyncSchemas.js +2 -4
  12. package/dist/sdk/schemas/lqa/lqaAsyncSchemas.js.map +1 -1
  13. package/dist/sdk/schemas/translation/generateVariants.d.ts +88 -1
  14. package/dist/sdk/schemas/translation/generateVariants.js +4 -2
  15. package/dist/sdk/schemas/translation/generateVariants.js.map +1 -1
  16. package/dist/sdk/schemas/translation/rewriteTextSchemas.d.ts +134 -1
  17. package/dist/sdk/schemas/translation/rewriteTextSchemas.js +4 -2
  18. package/dist/sdk/schemas/translation/rewriteTextSchemas.js.map +1 -1
  19. package/dist/sdk/schemas/translation/translateAsyncSchemas.d.ts +224 -1
  20. package/dist/sdk/schemas/translation/translateAsyncSchemas.js +3 -1
  21. package/dist/sdk/schemas/translation/translateAsyncSchemas.js.map +1 -1
  22. package/dist/sdk/schemas/translation/translateSyncSchemas.d.ts +214 -1
  23. package/dist/sdk/schemas/translation/translateSyncSchemas.js +4 -2
  24. package/dist/sdk/schemas/translation/translateSyncSchemas.js.map +1 -1
  25. package/dist/sdk/schemas/translation/translateTextSegmentSchemas.d.ts +148 -1
  26. package/dist/sdk/schemas/translation/translateTextSegmentSchemas.js +4 -2
  27. package/dist/sdk/schemas/translation/translateTextSegmentSchemas.js.map +1 -1
  28. package/dist/sdk/validation/requestSizeLimit.d.ts +2 -2
  29. package/dist/sdk/validation/requestSizeLimit.js +4 -4
  30. package/dist/sdk/validation/requestSizeLimit.js.map +1 -1
  31. package/package.json +1 -1
  32. package/dist/sdk/schemas/scoring/scoreSchemas.d.ts +0 -178
  33. package/dist/sdk/schemas/scoring/scoreSchemas.js +0 -43
  34. package/dist/sdk/schemas/scoring/scoreSchemas.js.map +0 -1
package/dist/sdk/schemas/translation/translateSyncSchemas.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import z from 'zod';
2
- export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.ZodObject<{
2
+ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
3
3
  tenantId: z.ZodOptional<z.ZodString>;
4
4
  ownerId: z.ZodOptional<z.ZodString>;
5
5
  sourceLocale: z.ZodEffects<z.ZodString, string, string>;
@@ -13,6 +13,7 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
13
13
  readonly GOOGLE_TRANSLATE: "GoogleTranslate";
14
14
  readonly MICROSOFT_TRANSLATOR: "MicrosoftTranslator";
15
15
  }>>;
16
+ forceIntegration: z.ZodOptional<z.ZodBoolean>;
16
17
  context: z.ZodOptional<z.ZodObject<{
17
18
  description: z.ZodOptional<z.ZodString>;
18
19
  styleGuide: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
@@ -495,6 +496,7 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
495
496
  }[] | undefined;
496
497
  } | undefined;
497
498
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
499
+ forceIntegration?: boolean | undefined;
498
500
  metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
499
501
  [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
500
502
  } | null)[] | {
@@ -597,6 +599,7 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
597
599
  }[] | undefined;
598
600
  } | undefined;
599
601
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
602
+ forceIntegration?: boolean | undefined;
600
603
  metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
601
604
  [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
602
605
  } | null)[] | {
@@ -699,6 +702,7 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
699
702
  }[] | undefined;
700
703
  } | undefined;
701
704
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
705
+ forceIntegration?: boolean | undefined;
702
706
  metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
703
707
  [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
704
708
  } | null)[] | {
@@ -801,6 +805,7 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
801
805
  }[] | undefined;
802
806
  } | undefined;
803
807
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
808
+ forceIntegration?: boolean | undefined;
804
809
  metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
805
810
  [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
806
811
  } | null)[] | {
@@ -903,6 +908,7 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
903
908
  }[] | undefined;
904
909
  } | undefined;
905
910
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
911
+ forceIntegration?: boolean | undefined;
906
912
  metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
907
913
  [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
908
914
  } | null)[] | {
@@ -1005,6 +1011,213 @@ export declare const TRANSLATE_SYNC_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.Zod
1005
1011
  }[] | undefined;
1006
1012
  } | undefined;
1007
1013
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
1014
+ forceIntegration?: boolean | undefined;
1015
+ metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
1016
+ [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
1017
+ } | null)[] | {
1018
+ [key: string]: string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null;
1019
+ } | null)[] | {
1020
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1021
+ } | null)[] | {
1022
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1023
+ } | null)[] | {
1024
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1025
+ } | null)[] | {
1026
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1027
+ } | null)[] | {
1028
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1029
+ } | null)[] | {
1030
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1031
+ } | null)[] | {
1032
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1033
+ } | null)[] | {
1034
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1035
+ } | null)[] | {
1036
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1037
+ } | null)[] | {
1038
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1039
+ } | null> | undefined;
1040
+ tenantId?: string | undefined;
1041
+ }>, {
1042
+ sourceLocale: string;
1043
+ contentUnits: [{
1044
+ id: string;
1045
+ segments: [{
1046
+ value: string;
1047
+ id: string;
1048
+ tmMatch?: {
1049
+ sourceValue: string;
1050
+ translatedValue: string;
1051
+ } | undefined;
1052
+ }, ...{
1053
+ value: string;
1054
+ id: string;
1055
+ tmMatch?: {
1056
+ sourceValue: string;
1057
+ translatedValue: string;
1058
+ } | undefined;
1059
+ }[]];
1060
+ context?: {
1061
+ description: string;
1062
+ } | undefined;
1063
+ characterLimit?: number | undefined;
1064
+ }, ...{
1065
+ id: string;
1066
+ segments: [{
1067
+ value: string;
1068
+ id: string;
1069
+ tmMatch?: {
1070
+ sourceValue: string;
1071
+ translatedValue: string;
1072
+ } | undefined;
1073
+ }, ...{
1074
+ value: string;
1075
+ id: string;
1076
+ tmMatch?: {
1077
+ sourceValue: string;
1078
+ translatedValue: string;
1079
+ } | undefined;
1080
+ }[]];
1081
+ context?: {
1082
+ description: string;
1083
+ } | undefined;
1084
+ characterLimit?: number | undefined;
1085
+ }[]];
1086
+ targetLocale: string;
1087
+ ownerId?: string | undefined;
1088
+ context?: {
1089
+ description?: string | undefined;
1090
+ styleGuide?: {
1091
+ targetAudience?: "general" | "technical" | "non-technical" | undefined;
1092
+ toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
1093
+ levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
1094
+ generalRule?: "active-voice" | "passive-voice" | undefined;
1095
+ } | {
1096
+ text: string;
1097
+ } | undefined;
1098
+ glossary?: {
1099
+ term: string;
1100
+ translatable: boolean;
1101
+ forbidden: boolean;
1102
+ caseSensitive: boolean;
1103
+ description?: string | undefined;
1104
+ translations?: {
1105
+ locale: string;
1106
+ translation: string;
1107
+ description?: string | undefined;
1108
+ }[] | undefined;
1109
+ }[] | undefined;
1110
+ targetPluralForms?: ["many" | "zero" | "one" | "two" | "few" | "other", ...("many" | "zero" | "one" | "two" | "few" | "other")[]] | undefined;
1111
+ translationExamples?: {
1112
+ sourceValue: string;
1113
+ translatedValue: string;
1114
+ }[] | undefined;
1115
+ } | undefined;
1116
+ integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
1117
+ forceIntegration?: boolean | undefined;
1118
+ metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
1119
+ [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
1120
+ } | null)[] | {
1121
+ [key: string]: string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null;
1122
+ } | null)[] | {
1123
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1124
+ } | null)[] | {
1125
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1126
+ } | null)[] | {
1127
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1128
+ } | null)[] | {
1129
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1130
+ } | null)[] | {
1131
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1132
+ } | null)[] | {
1133
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1134
+ } | null)[] | {
1135
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1136
+ } | null)[] | {
1137
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1138
+ } | null)[] | {
1139
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1140
+ } | null)[] | {
1141
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
1142
+ } | null> | undefined;
1143
+ tenantId?: string | undefined;
1144
+ }, {
1145
+ sourceLocale: string;
1146
+ contentUnits: [{
1147
+ id: string;
1148
+ segments: [{
1149
+ value: string;
1150
+ id: string;
1151
+ tmMatch?: {
1152
+ sourceValue: string;
1153
+ translatedValue: string;
1154
+ } | undefined;
1155
+ }, ...{
1156
+ value: string;
1157
+ id: string;
1158
+ tmMatch?: {
1159
+ sourceValue: string;
1160
+ translatedValue: string;
1161
+ } | undefined;
1162
+ }[]];
1163
+ context?: {
1164
+ description: string;
1165
+ } | undefined;
1166
+ characterLimit?: number | undefined;
1167
+ }, ...{
1168
+ id: string;
1169
+ segments: [{
1170
+ value: string;
1171
+ id: string;
1172
+ tmMatch?: {
1173
+ sourceValue: string;
1174
+ translatedValue: string;
1175
+ } | undefined;
1176
+ }, ...{
1177
+ value: string;
1178
+ id: string;
1179
+ tmMatch?: {
1180
+ sourceValue: string;
1181
+ translatedValue: string;
1182
+ } | undefined;
1183
+ }[]];
1184
+ context?: {
1185
+ description: string;
1186
+ } | undefined;
1187
+ characterLimit?: number | undefined;
1188
+ }[]];
1189
+ targetLocale: string;
1190
+ ownerId?: string | undefined;
1191
+ context?: {
1192
+ description?: string | undefined;
1193
+ styleGuide?: {
1194
+ targetAudience?: "general" | "technical" | "non-technical" | undefined;
1195
+ toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
1196
+ levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
1197
+ generalRule?: "active-voice" | "passive-voice" | undefined;
1198
+ } | {
1199
+ text: string;
1200
+ } | undefined;
1201
+ glossary?: {
1202
+ term: string;
1203
+ description?: string | undefined;
1204
+ translatable?: boolean | undefined;
1205
+ forbidden?: boolean | undefined;
1206
+ caseSensitive?: boolean | undefined;
1207
+ translations?: {
1208
+ locale: string;
1209
+ translation: string;
1210
+ description?: string | undefined;
1211
+ }[] | undefined;
1212
+ }[] | undefined;
1213
+ targetPluralForms?: ["many" | "zero" | "one" | "two" | "few" | "other", ...("many" | "zero" | "one" | "two" | "few" | "other")[]] | undefined;
1214
+ translationExamples?: {
1215
+ sourceValue: string;
1216
+ translatedValue: string;
1217
+ }[] | undefined;
1218
+ } | undefined;
1219
+ integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
1220
+ forceIntegration?: boolean | undefined;
1008
1221
  metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
1009
1222
  [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
1010
1223
  } | null)[] | {
package/dist/sdk/schemas/translation/translateSyncSchemas.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import z from 'zod';
2
2
  import { OWNER_ID_SCHEMA, TENANT_ID_SCHEMA } from '../common/asyncRequestSchemas.js';
3
- import { COMMON_ERROR_RESPONSE_SCHEMA, COMMON_REQUEST_HEADERS_SCHEMA, LOCALE_SCHEMA, METADATA_SCHEMA, REAL_INTEGRATION_ENGINE_SCHEMA, } from '../common/commonSchemas.js';
3
+ import { COMMON_ERROR_RESPONSE_SCHEMA, COMMON_REQUEST_HEADERS_SCHEMA, FORCE_INTEGRATION_SCHEMA, LOCALE_SCHEMA, METADATA_SCHEMA, REAL_INTEGRATION_ENGINE_SCHEMA, refineIntegrationIsPresent, } from '../common/commonSchemas.js';
4
4
  import { TRANSLATION_CONTEXT_SCHEMA } from '../common/translationContextSchemas.js';
5
5
  import { CONTENT_ID_PROP_SCHEMA, SEGMENT_WARNINGS_SCHEMA, TRANSLATE_CONTENT_UNIT_SCHEMA, refineDifferentSourceAndTargetLang, refineRequestSizeLimit, refineUniqueIds, } from './sharedSchemas.js';
6
6
  // See https://lokalise.slack.com/archives/C05FLMT3GQK/p1730293588636539 for context
@@ -12,6 +12,7 @@ export const TRANSLATE_SYNC_BODY_SCHEMA = z
12
12
  sourceLocale: LOCALE_SCHEMA,
13
13
  targetLocale: LOCALE_SCHEMA,
14
14
  integration: REAL_INTEGRATION_ENGINE_SCHEMA.optional(),
15
+ forceIntegration: FORCE_INTEGRATION_SCHEMA.optional(),
15
16
  context: TRANSLATION_CONTEXT_SCHEMA.optional(),
16
17
  metadata: METADATA_SCHEMA,
17
18
  contentUnits: z
@@ -21,7 +22,8 @@ export const TRANSLATE_SYNC_BODY_SCHEMA = z
21
22
  .refine(...refineUniqueIds),
22
23
  })
23
24
  .refine(...refineDifferentSourceAndTargetLang)
24
- .refine(...refineRequestSizeLimit);
25
+ .refine(...refineRequestSizeLimit)
26
+ .refine(...refineIntegrationIsPresent);
25
27
  export const TRANSLATE_SYNC_HEADERS_SCHEMA = COMMON_REQUEST_HEADERS_SCHEMA;
26
28
  export const TRANSLATE_SYNC_RESPONSE_SCHEMA = z
27
29
  .object({
package/dist/sdk/schemas/translation/translateSyncSchemas.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"translateSyncSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/translateSyncSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACpF,OAAO,EACL,4BAA4B,EAC5B,6BAA6B,EAC7B,aAAa,EACb,eAAe,EACf,8BAA8B,GAC/B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAA;AACnF,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,kCAAkC,EAClC,sBAAsB,EACtB,eAAe,GAChB,MAAM,oBAAoB,CAAA;AAE3B,oFAAoF;AACpF,MAAM,wBAAwB,GAAG,EAAE,CAAA;AAEnC,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACrC,OAAO,EAAE,eAAe,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,WAAW,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IACtD,OAAO,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,eAAe;IACzB,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,6BAA6B,CAAC;SACpC,QAAQ,EAAE;SACV,GAAG,CAAC,wBAAwB,CAAC;SAC7B,MAAM,CAAC,GAAG,eAAe,CAAC;CAC9B,CAAC;KACD,MAAM,CAAC,GAAG,kCAAkC,CAAC;KAC7C,MAAM,CAAC,GAAG,sBAAsB,CAAC,CAAA;AAEpC,MAAM,CAAC,MAAM,6BAA6B,GAAG,6BAA6B,CAAA;AAE1E,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,KAAK,CACX,CAAC,CAAC,MAAM,CAAC;QACP,aAAa,EAAE,sBAAsB;QACrC,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,EAAE;KAC7C,CAAC,CACH;IACD,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,4BAA4B,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,sBAAsB;QACrC,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;KACxB,CAAC,CACH;SACA,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,iCAAiC,CAAC,CAAA"}
1
+ {"version":3,"file":"translateSyncSchemas.js","sourceRoot":"","sources":["../../../../src/sdk/schemas/translation/translateSyncSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACpF,OAAO,EACL,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,aAAa,EACb,eAAe,EACf,8BAA8B,EAC9B,0BAA0B,GAC3B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAA;AACnF,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,kCAAkC,EAClC,sBAAsB,EACtB,eAAe,GAChB,MAAM,oBAAoB,CAAA;AAE3B,oFAAoF;AACpF,MAAM,wBAAwB,GAAG,EAAE,CAAA;AAEnC,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACrC,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,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,6BAA6B,CAAC;SACpC,QAAQ,EAAE;SACV,GAAG,CAAC,wBAAwB,CAAC;SAC7B,MAAM,CAAC,GAAG,eAAe,CAAC;CAC9B,CAAC;KACD,MAAM,CAAC,GAAG,kCAAkC,CAAC;KAC7C,MAAM,CAAC,GAAG,sBAAsB,CAAC;KACjC,MAAM,CAAC,GAAG,0BAA0B,CAAC,CAAA;AAExC,MAAM,CAAC,MAAM,6BAA6B,GAAG,6BAA6B,CAAA;AAE1E,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,KAAK,CACX,CAAC,CAAC,MAAM,CAAC;QACP,aAAa,EAAE,sBAAsB;QACrC,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,EAAE;KAC7C,CAAC,CACH;IACD,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,4BAA4B,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,sBAAsB;QACrC,SAAS,EAAE,sBAAsB;QACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;KACxB,CAAC,CACH;SACA,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,iCAAiC,CAAC,CAAA"}
package/dist/sdk/schemas/translation/translateTextSegmentSchemas.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import z from 'zod';
2
- export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.ZodObject<{
2
+ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
3
3
  ownerId: z.ZodOptional<z.ZodString>;
4
4
  sourceLocale: z.ZodEffects<z.ZodString, string, string>;
5
5
  targetLocale: z.ZodEffects<z.ZodString, string, string>;
@@ -12,6 +12,7 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
12
12
  readonly GOOGLE_TRANSLATE: "GoogleTranslate";
13
13
  readonly MICROSOFT_TRANSLATOR: "MicrosoftTranslator";
14
14
  }>>;
15
+ forceIntegration: z.ZodOptional<z.ZodBoolean>;
15
16
  context: z.ZodOptional<z.ZodObject<z.objectUtil.extendShape<{
16
17
  description: z.ZodOptional<z.ZodString>;
17
18
  styleGuide: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
@@ -312,6 +313,7 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
312
313
  }[] | undefined;
313
314
  } | undefined;
314
315
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
316
+ forceIntegration?: boolean | undefined;
315
317
  history?: {
316
318
  value: string;
317
319
  mode: "rephrase" | "shorten" | "translate";
@@ -381,6 +383,7 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
381
383
  }[] | undefined;
382
384
  } | undefined;
383
385
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
386
+ forceIntegration?: boolean | undefined;
384
387
  history?: {
385
388
  value: string;
386
389
  mode: "rephrase" | "shorten" | "translate";
@@ -450,6 +453,7 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
450
453
  }[] | undefined;
451
454
  } | undefined;
452
455
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
456
+ forceIntegration?: boolean | undefined;
453
457
  history?: {
454
458
  value: string;
455
459
  mode: "rephrase" | "shorten" | "translate";
@@ -519,6 +523,7 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
519
523
  }[] | undefined;
520
524
  } | undefined;
521
525
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
526
+ forceIntegration?: boolean | undefined;
522
527
  history?: {
523
528
  value: string;
524
529
  mode: "rephrase" | "shorten" | "translate";
@@ -588,6 +593,7 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
588
593
  }[] | undefined;
589
594
  } | undefined;
590
595
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
596
+ forceIntegration?: boolean | undefined;
591
597
  history?: {
592
598
  value: string;
593
599
  mode: "rephrase" | "shorten" | "translate";
@@ -657,6 +663,147 @@ export declare const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA: z.ZodEffects<z.ZodEffec
657
663
  }[] | undefined;
658
664
  } | undefined;
659
665
  integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
666
+ forceIntegration?: boolean | undefined;
667
+ history?: {
668
+ value: string;
669
+ mode: "rephrase" | "shorten" | "translate";
670
+ }[] | undefined;
671
+ metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
672
+ [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
673
+ } | null)[] | {
674
+ [key: string]: string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null;
675
+ } | null)[] | {
676
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
677
+ } | null)[] | {
678
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
679
+ } | null)[] | {
680
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
681
+ } | null)[] | {
682
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
683
+ } | null)[] | {
684
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
685
+ } | null)[] | {
686
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
687
+ } | null)[] | {
688
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
689
+ } | null)[] | {
690
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
691
+ } | null)[] | {
692
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
693
+ } | null)[] | {
694
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
695
+ } | null> | undefined;
696
+ }>, {
697
+ text: {
698
+ value: string;
699
+ contentUnitId: string;
700
+ characterLimit?: number | undefined;
701
+ segmentId?: string | undefined;
702
+ };
703
+ mode: "rephrase" | "shorten" | "translate";
704
+ sourceLocale: string;
705
+ targetLocale: string;
706
+ ownerId?: string | undefined;
707
+ context?: {
708
+ description?: string | undefined;
709
+ styleGuide?: {
710
+ targetAudience?: "general" | "technical" | "non-technical" | undefined;
711
+ toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
712
+ levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
713
+ generalRule?: "active-voice" | "passive-voice" | undefined;
714
+ } | {
715
+ text: string;
716
+ } | undefined;
717
+ glossary?: {
718
+ term: string;
719
+ translatable: boolean;
720
+ forbidden: boolean;
721
+ caseSensitive: boolean;
722
+ description?: string | undefined;
723
+ translations?: {
724
+ locale: string;
725
+ translation: string;
726
+ description?: string | undefined;
727
+ }[] | undefined;
728
+ }[] | undefined;
729
+ targetPluralForms?: ["many" | "zero" | "one" | "two" | "few" | "other", ...("many" | "zero" | "one" | "two" | "few" | "other")[]] | undefined;
730
+ translationExamples?: {
731
+ sourceValue: string;
732
+ translatedValue: string;
733
+ }[] | undefined;
734
+ } | undefined;
735
+ integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
736
+ forceIntegration?: boolean | undefined;
737
+ history?: {
738
+ value: string;
739
+ mode: "rephrase" | "shorten" | "translate";
740
+ }[] | undefined;
741
+ metadata?: Record<string, string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | {
742
+ [key: string]: string | number | boolean | /*elided*/ any | /*elided*/ any | null;
743
+ } | null)[] | {
744
+ [key: string]: string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null;
745
+ } | null)[] | {
746
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
747
+ } | null)[] | {
748
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
749
+ } | null)[] | {
750
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
751
+ } | null)[] | {
752
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
753
+ } | null)[] | {
754
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
755
+ } | null)[] | {
756
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
757
+ } | null)[] | {
758
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
759
+ } | null)[] | {
760
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
761
+ } | null)[] | {
762
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
763
+ } | null)[] | {
764
+ [key: string]: string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null)[] | /*elided*/ any | null;
765
+ } | null> | undefined;
766
+ }, {
767
+ text: {
768
+ value: string;
769
+ contentUnitId: string;
770
+ characterLimit?: number | undefined;
771
+ segmentId?: string | undefined;
772
+ };
773
+ mode: "rephrase" | "shorten" | "translate";
774
+ sourceLocale: string;
775
+ targetLocale: string;
776
+ ownerId?: string | undefined;
777
+ context?: {
778
+ description?: string | undefined;
779
+ styleGuide?: {
780
+ targetAudience?: "general" | "technical" | "non-technical" | undefined;
781
+ toneOfVoice?: "friendly" | "empowering" | "informative" | "supportive" | "elegant" | undefined;
782
+ levelOfFormality?: "informal" | "formal" | "neutral" | undefined;
783
+ generalRule?: "active-voice" | "passive-voice" | undefined;
784
+ } | {
785
+ text: string;
786
+ } | undefined;
787
+ glossary?: {
788
+ term: string;
789
+ description?: string | undefined;
790
+ translatable?: boolean | undefined;
791
+ forbidden?: boolean | undefined;
792
+ caseSensitive?: boolean | undefined;
793
+ translations?: {
794
+ locale: string;
795
+ translation: string;
796
+ description?: string | undefined;
797
+ }[] | undefined;
798
+ }[] | undefined;
799
+ targetPluralForms?: ["many" | "zero" | "one" | "two" | "few" | "other", ...("many" | "zero" | "one" | "two" | "few" | "other")[]] | undefined;
800
+ translationExamples?: {
801
+ sourceValue: string;
802
+ translatedValue: string;
803
+ }[] | undefined;
804
+ } | undefined;
805
+ integration?: "FT-OpenAI" | "Claude" | "ChatGPT-4" | "Gemini" | "DeepL" | "GoogleTranslate" | "MicrosoftTranslator" | undefined;
806
+ forceIntegration?: boolean | undefined;
660
807
  history?: {
661
808
  value: string;
662
809
  mode: "rephrase" | "shorten" | "translate";
package/dist/sdk/schemas/translation/translateTextSegmentSchemas.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import z from 'zod';
2
2
  import { OWNER_ID_SCHEMA } from '../common/asyncRequestSchemas.js';
3
- import { COMMON_REQUEST_HEADERS_SCHEMA, LOCALE_SCHEMA, METADATA_SCHEMA, REAL_INTEGRATION_ENGINE_SCHEMA, } from '../common/commonSchemas.js';
3
+ import { COMMON_REQUEST_HEADERS_SCHEMA, FORCE_INTEGRATION_SCHEMA, LOCALE_SCHEMA, METADATA_SCHEMA, REAL_INTEGRATION_ENGINE_SCHEMA, refineIntegrationIsPresent, } from '../common/commonSchemas.js';
4
4
  import { TRANSLATION_CONTEXT_SCHEMA, TRANSLATION_EXAMPLE_SCHEMA, } from '../common/translationContextSchemas.js';
5
5
  import { CONTENT_ID_PROP_SCHEMA, CONTENT_UNIT_DESCRIPTION_MAX_LENGTH, HISTORY_ENTRY_SCHEMA, TranslateModeEnum, refineDifferentSourceAndTargetLang, refineHistoryIsPresent, } from './sharedSchemas.js';
6
6
  export const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA = z
@@ -9,6 +9,7 @@ export const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA = z
9
9
  sourceLocale: LOCALE_SCHEMA,
10
10
  targetLocale: LOCALE_SCHEMA,
11
11
  integration: REAL_INTEGRATION_ENGINE_SCHEMA.optional(),
12
+ forceIntegration: FORCE_INTEGRATION_SCHEMA.optional(),
12
13
  context: TRANSLATION_CONTEXT_SCHEMA.extend({
13
14
  description: z.string().min(1).max(CONTENT_UNIT_DESCRIPTION_MAX_LENGTH).optional(),
14
15
  translationExamples: z.array(TRANSLATION_EXAMPLE_SCHEMA).optional(),
@@ -29,6 +30,7 @@ export const TRANSLATE_TEXT_SEGMENT_BODY_SCHEMA = z
29
30
  .optional(),
30
31
  })
31
32
  .refine(...refineDifferentSourceAndTargetLang)
32
- .refine(...refineHistoryIsPresent);
33
+ .refine(...refineHistoryIsPresent)
34
+ .refine(...refineIntegrationIsPresent);
33
35
  export const TRANSLATE_TEXT_SEGMENT_HEADERS_SCHEMA = COMMON_REQUEST_HEADERS_SCHEMA;
34
36
  //# sourceMappingURL=translateTextSegmentSchemas.js.map
package/dist/sdk/schemas/translation/translateTextSegmentSchemas.js.map CHANGED
@@ -1 +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,aAAa,EACb,eAAe,EACf,8BAA8B,GAC/B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,wCAAwC,CAAA;AAC/C,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,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,CAAA;AAEpC,MAAM,CAAC,MAAM,qCAAqC,GAAG,6BAA6B,CAAA"}
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,GAC3B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,wCAAwC,CAAA;AAC/C,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"}
package/dist/sdk/validation/requestSizeLimit.d.ts CHANGED
@@ -3,11 +3,11 @@ import type { ContentUnitLike } from '../schemas/translation/sharedSchemas.js';
3
3
  /**
4
4
  * Checks if every segment in the content unit is under the size limit.
5
5
  */
6
- export declare const isContentUnitSizeUnderLimit: (segments: ContentUnitLike["segments"], forcedIntegration?: IntegrationEngineEnum) => boolean;
6
+ export declare const isContentUnitSizeUnderLimit: (segments: ContentUnitLike["segments"], preferredIntegration?: IntegrationEngineEnum) => boolean;
7
7
  /**
8
8
  * Checks if every content unit in the request is under the size limit.
9
9
  */
10
- export declare const isRequestSizeUnderLimit: (contentUnits: ContentUnitLike[], forcedIntegration?: IntegrationEngineEnum) => boolean;
10
+ export declare const isRequestSizeUnderLimit: (contentUnits: ContentUnitLike[], preferredIntegration?: IntegrationEngineEnum) => boolean;
11
11
  /**
12
12
  * Returns the request size limit based on the integration.
13
13
  */
package/dist/sdk/validation/requestSizeLimit.js CHANGED
@@ -3,14 +3,14 @@ import { isSegmentUnderLengthLimit } from './isSegmentUnderLengthLimit.js';
3
3
  /**
4
4
  * Checks if every segment in the content unit is under the size limit.
5
5
  */
6
- export const isContentUnitSizeUnderLimit = (segments, forcedIntegration) => {
7
- return segments.every(({ value }) => isSegmentUnderLengthLimit(value, forcedIntegration));
6
+ export const isContentUnitSizeUnderLimit = (segments, preferredIntegration) => {
7
+ return segments.every(({ value }) => isSegmentUnderLengthLimit(value, preferredIntegration));
8
8
  };
9
9
  /**
10
10
  * Checks if every content unit in the request is under the size limit.
11
11
  */
12
- export const isRequestSizeUnderLimit = (contentUnits, forcedIntegration) => {
13
- return contentUnits.every((contentUnit) => isContentUnitSizeUnderLimit(contentUnit.segments, forcedIntegration));
12
+ export const isRequestSizeUnderLimit = (contentUnits, preferredIntegration) => {
13
+ return contentUnits.every((contentUnit) => isContentUnitSizeUnderLimit(contentUnit.segments, preferredIntegration));
14
14
  };
15
15
  /**
16
16
  * Returns the request size limit based on the integration.
package/dist/sdk/validation/requestSizeLimit.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"requestSizeLimit.js","sourceRoot":"","sources":["../../../src/sdk/validation/requestSizeLimit.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,sBAAsB,EACtB,gCAAgC,GACjC,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,QAAqC,EACrC,iBAAyC,EAChC,EAAE;IACX,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAA;AAC3F,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,YAA+B,EAC/B,iBAAyC,EAChC,EAAE;IACX,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CACxC,2BAA2B,CAAC,WAAW,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CACrE,CAAA;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,WAAmC,EAAU,EAAE;IACjF,IAAI,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,EAAE,WAAW,CAAC,EAAE,CAAC;QACtE,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAC5C,CAAC;IAED,OAAO,gCAAgC,CAAA;AACzC,CAAC,CAAA"}
1
+ {"version":3,"file":"requestSizeLimit.js","sourceRoot":"","sources":["../../../src/sdk/validation/requestSizeLimit.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,sBAAsB,EACtB,gCAAgC,GACjC,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,QAAqC,EACrC,oBAA4C,EACnC,EAAE;IACX,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAA;AAC9F,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,YAA+B,EAC/B,oBAA4C,EACnC,EAAE;IACX,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CACxC,2BAA2B,CAAC,WAAW,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CACxE,CAAA;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,WAAmC,EAAU,EAAE;IACjF,IAAI,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,EAAE,WAAW,CAAC,EAAE,CAAC;QACtE,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAC5C,CAAC;IAED,OAAO,gCAAgC,CAAA;AACzC,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/polyglot-sdk",
3
- "version": "18.0.0",
3
+ "version": "19.0.0",
4
4
  "author": {
5
5
  "name": "Lokalise",
6
6
  "url": "https://lokalise.com/"