Feat/preserve formatting

src/entrypoints/ConfigScreen/ConfigScreen.tsx

@@ -9,6 +9,7 @@ import {
 
 import {
   deeplFormalityLevelOptions,
+  defaultDeeplPreserveFormatting,
   fieldsOptions,
   translationServiceOptions,
 } from '../../lib/constants'
@@ -145,6 +146,27 @@ export default function ConfigScreen({ ctx }: Props) {
               />
             )}
 
+            {isDeepl && (
+              <SwitchField
+                name="deeplPreserveFormatting"
+                id="deeplPreserveFormatting"
+                label="Preserve formatting"
+                hint="Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects."
+                value={
+                  pluginParameters?.deeplPreserveFormatting ??
+                  defaultDeeplPreserveFormatting
+                }
+                onChange={(newValue) => {
+                  ctx.updatePluginParameters({
+                    ...pluginParameters,
+                    deeplPreserveFormatting: newValue,
+                  })
+
+                  ctx.notice('Settings updated successfully!')
+                }}
+              />
+            )}
+
             {isDeepl && (
               <GlossaryIdField
                 value={pluginParameters?.deeplGlossaryId || ''}

src/entrypoints/FieldAddon/FieldAddon.tsx

@@ -28,6 +28,7 @@ import {
 } from '../../lib/types'
 import {
   deeplFormalityLevelOptions,
+  defaultDeeplPreserveFormatting,
   translationFormats,
   translationServiceOptions,
 } from '../../lib/constants'
@@ -88,6 +89,11 @@ export default function FieldAddon({ ctx }: Props) {
   const deeplGlossaryId =
     pluginParameters.deeplGlossaryId || pluginGlobalParameters.deeplGlossaryId
 
+  const deeplPreserveFormatting =
+    pluginParameters.deeplPreserveFormatting ??
+    pluginGlobalParameters.deeplPreserveFormatting ??
+    defaultDeeplPreserveFormatting
+
   const deeplFormalityLevelValue =
     pluginParameters.deeplFormalityLevel?.value ||
     pluginGlobalParameters.deeplFormalityLevel?.value ||
@@ -141,6 +147,7 @@ export default function FieldAddon({ ctx }: Props) {
           deeplOptions: {
             glossaryId: deeplGlossaryId,
             formality: deeplFormalityLevelValue,
+            preserveFormatting: deeplPreserveFormatting,
           },
           openAIOptions: {
             model: modelValue,

src/entrypoints/FieldAddonConfigScreen/FieldAddonConfigScreen.tsx

@@ -1,8 +1,15 @@
 import { RenderManualFieldExtensionConfigScreenCtx } from 'datocms-plugin-sdk'
-import { Canvas, Form, SelectField, FieldGroup } from 'datocms-react-ui'
+import {
+  Canvas,
+  Form,
+  SelectField,
+  FieldGroup,
+  SwitchField,
+} from 'datocms-react-ui'
 
 import {
   deeplFormalityLevelOptions,
+  defaultDeeplPreserveFormatting,
   translationServiceOptions,
 } from '../../lib/constants'
 import {
@@ -36,6 +43,11 @@ export default function ConfigScreen({ ctx }: Props) {
     pluginGlobalParameters?.deeplFormalityLevel ||
     deeplFormalityLevelOptions[0]
 
+  const selectedPreserveFormatting =
+    pluginParameters?.deeplPreserveFormatting ??
+    pluginGlobalParameters?.deeplPreserveFormatting ??
+    defaultDeeplPreserveFormatting
+
   const excludedKeys =
     pluginParameters?.excludedKeys || pluginGlobalParameters?.excludedKeys || ''
 
@@ -112,6 +124,24 @@ export default function ConfigScreen({ ctx }: Props) {
             />
           )}
 
+          {isDeepl && (
+            <SwitchField
+              name="deeplPreserveFormatting"
+              id="deeplPreserveFormatting"
+              label="Preserve formatting"
+              hint="Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects."
+              onChange={(newValue) => {
+                ctx.setParameters({
+                  ...pluginParameters,
+                  deeplPreserveFormatting: newValue,
+                })
+
+                ctx.notice('Settings updated successfully!')
+              }}
+              value={selectedPreserveFormatting}
+            />
+          )}
+
           {isDeepl && (
             <GlossaryIdField
               value={pluginParameters?.deeplGlossaryId || ''}

src/lib/constants.ts

@@ -7,6 +7,8 @@ import {
   SettingOption,
 } from './types'
 
+export const defaultDeeplPreserveFormatting = false
+
 export const fieldsOptions: SettingOption<DatoFieldType>[] = [
   { label: 'String fields', value: DatoFieldType.stringField },
   { label: 'Text fields', value: DatoFieldType.textField },

src/lib/translation-services/deepl.ts

@@ -11,7 +11,13 @@ export default async function translate(
   const params = new URLSearchParams()
 
   params.set('target_lang', options.toLocale)
-  params.set('tag_handling', options.format === 'html' ? 'html' : 'xml')
+
+  if (options.format === 'html') {
+    params.set('tag_handling', 'html')
+  } else if (!options.deeplOptions?.preserveFormatting) {
+    params.set('tag_handling', 'xml')
+  }
+
   params.set('text', string)
 
   if (options.fromLocale) {
@@ -22,6 +28,10 @@ export default async function translate(
     params.set('glossary_id', options.deeplOptions.glossaryId)
   }
 
+  if (options.deeplOptions?.preserveFormatting) {
+    params.set('preserve_formatting', '1')
+  }
+
   if (
     options.deeplOptions?.formality &&
     options.deeplOptions.formality !== DeeplFormalityLevel.default

src/lib/types.ts

@@ -72,6 +72,7 @@ export type Parameters = {
   topP?: number
   prompt?: string
   deeplGlossaryId?: string
+  deeplPreserveFormatting?: boolean
   deeplFormalityLevel?: SettingOption<DeeplFormalityLevel>
   excludedKeys?: string
   [TranslationServiceKey.yandexKey]?: string
@@ -100,6 +101,7 @@ export type TranslationOptions = {
   deeplOptions?: {
     glossaryId?: string
     formality?: DeeplFormalityLevel
+    preserveFormatting?: boolean
   }
   openAIOptions: {
     model: string