fix: use extraRequestParameters in RephraseTextOptions

RephraseTextOptions extends BaseRequestOptions, like the other option
types, instead of defining its own extraBodyParameters field.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: hive-bot

CHANGELOG.md

@@ -61,10 +61,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `translateDocumentWaitUntilDone()`, which polls a document translation
   until it is done and resolves with the final `DocumentStatus`, or rejects with
   a `DeepLError` if the translation fails.
-- Added the `RephraseTextOptions` type with `writingStyle`, `tone` and
-  `extraBodyParameters`. `rephraseText()` accepts it as its third argument.
-  `extraBodyParameters` are added to the request body and override parameters
-  of the same name.
+- Added the `RephraseTextOptions` type with `writingStyle` and `tone`. It
+  extends `BaseRequestOptions`, so it also accepts `extraRequestParameters`,
+  which are added to the request body and override parameters of the same
+  name. `rephraseText()` accepts it as its third argument.
 
 ### Changed
 - `getSourceLanguages()`, `getTargetLanguages()`, and `getGlossaryLanguagePairs()` now call the

README.md

@@ -1129,10 +1129,10 @@ To rephrase text, call `rephraseText()`. The first argument is a string containi
 
 The second argument is the target language code. Language codes are **case-insensitive** strings, for example, `'de'`, `'fr'`, `'en'`. The target language code can also be `null` to enable auto-detection of the target language.
 
-The third argument is optional and is a `RephraseTextOptions` object with the following properties:
+The third argument is optional and is a `RephraseTextOptions` object (it extends `BaseRequestOptions`) with the following properties:
 -   `writingStyle`: the writing style of the rephrased text. Possible values are defined in the `WritingStyle` enum.
 -   `tone`: the tone of the rephrased text. Possible values are defined in the `WritingTone` enum. The API accepts either `writingStyle` or `tone` in a request, not both.
--   `extraBodyParameters`: extra parameters to add to the request body. They can override parameters set by the library.
+-   `extraRequestParameters`: extra parameters to add to the request body. They can override parameters set by the library.
 
 Passing the writing style and tone as the third and fourth arguments, for example `rephraseText(text, 'en', WritingStyle.ACADEMIC)`, is deprecated and will be removed in the next major version.
 

src/deeplClient.ts

@@ -193,14 +193,14 @@ export class DeepLClient extends Translator {
         tone?: string | null,
     ): Promise<T extends string ? WriteResult : WriteResult[]> {
         let writingStyle: string | null | undefined;
-        let extraBodyParameters: RequestParameters | undefined;
+        let extraRequestParameters: RequestParameters | undefined;
         if (typeof writingStyleOrOptions === 'object' && writingStyleOrOptions !== null) {
             if (tone !== undefined && tone !== null) {
                 throw new ArgumentError(
                     'tone cannot be passed as a separate argument together with an options object',
                 );
             }
-            ({ writingStyle, tone, extraBodyParameters } = writingStyleOrOptions);
+            ({ writingStyle, tone, extraRequestParameters } = writingStyleOrOptions);
         } else {
             writingStyle = writingStyleOrOptions;
         }
@@ -219,9 +219,9 @@ export class DeepLClient extends Translator {
         }
 
         const singular = appendTextsAndReturnIsSingular(data, texts);
-        if (extraBodyParameters !== undefined) {
-            for (const paramName in extraBodyParameters) {
-                data.set(paramName, extraBodyParameters[paramName]);
+        if (extraRequestParameters !== undefined) {
+            for (const paramName in extraRequestParameters) {
+                data.set(paramName, extraRequestParameters[paramName]);
             }
         }
         const { statusCode, content } = await this.httpClient.sendRequestWithBackoff<string>(

src/types.ts

@@ -790,17 +790,11 @@ export interface TextResult {
 /**
  * Options that can be specified when rephrasing text with `rephraseText()`.
  */
-export interface RephraseTextOptions {
+export interface RephraseTextOptions extends BaseRequestOptions {
     /** Writing style of the rephrased text, see `WritingStyle`. Cannot be combined with `tone`. */
     writingStyle?: string;
     /** Tone of the rephrased text, see `WritingTone`. Cannot be combined with `writingStyle`. */
     tone?: string;
-    /**
-     * Extra parameters to be added to the request body.
-     * Keys in this object will be added to the request body, and can override built-in parameters.
-     * This is mostly used by DeepL employees to test functionality, or for beta programs.
-     */
-    extraBodyParameters?: RequestParameters;
 }
 
 /**

tests/offline/rephraseText.test.ts

@@ -64,7 +64,7 @@ describe('DeepLClient.rephraseText', () => {
         await makeDeeplClient().rephraseText('abc', 'en', {
             writingStyle: WritingStyle.BUSINESS,
             tone: WritingTone.CONFIDENT,
-            extraBodyParameters: { extra: 'x' },
+            extraRequestParameters: { extra: 'x' },
         });
     });
 
@@ -74,7 +74,7 @@ describe('DeepLClient.rephraseText', () => {
             .reply(200, rephrased);
 
         await makeDeeplClient().rephraseText('abc', 'en', {
-            extraBodyParameters: { target_lang: 'fr' },
+            extraRequestParameters: { target_lang: 'fr' },
         });
     });