fix: send configured rules and custom instructions as given in createStyleRule()

The positional configuredRules and customInstructions of createStyleRule()
take the API's shape (configured_rules, custom_instructions with
source_language), like updateStyleRuleConfiguredRules(), and are sent
unchanged. CustomInstructionInput is removed and CustomInstructionRequestBody
is no longer deprecated.

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

Author: hive-bot

CHANGELOG.md

@@ -68,10 +68,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `createStyleRule()` accepts the name, language, configured rules and custom
   instructions as separate arguments:
   `createStyleRule(name, language, configuredRules?, customInstructions?)`.
-  `configuredRules` is a `ConfiguredRules` object (camelCase categories such as
-  `datesAndTimes`) and `customInstructions` is an array of the new
-  `CustomInstructionInput` type (`label`, `prompt`, `sourceLanguage`). They are
-  sent with the API's snake_case names.
+  They use the API's names and are sent as given: `configuredRules` as
+  `configured_rules` (e.g. `{ dates_and_times: { calendar_era: 'use_bc_and_ad' } }`,
+  like `updateStyleRuleConfiguredRules()`), and `customInstructions` as
+  `custom_instructions` (`CustomInstructionRequestBody` objects with `label`,
+  `prompt` and `source_language`).
 - `createStyleRuleCustomInstruction()` and `updateStyleRuleCustomInstruction()`
   accept the label, prompt and optional source language as separate arguments:
   `createStyleRuleCustomInstruction(styleId, label, prompt, sourceLanguage?)` and
@@ -103,10 +104,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   argument instead. The positional form will be removed in the next major
   version.
 - Passing a single `CreateStyleRuleRequestBody` object to `createStyleRule()`
-  and a `CustomInstructionRequestBody` object to
+  is deprecated, as is the `CreateStyleRuleRequestBody` type; pass separate
+  arguments instead. Passing a `CustomInstructionRequestBody` object to
   `createStyleRuleCustomInstruction()` or `updateStyleRuleCustomInstruction()`
-  is deprecated, as are both types; pass separate arguments instead. The object
-  forms and types will be removed in the next major version.
+  is deprecated; pass the label, prompt and source language as separate
+  arguments instead. These object forms and `CreateStyleRuleRequestBody` will be
+  removed in the next major version.
 
 ### Fixed
 - `downloadTranslationMemoryExport()` no longer hangs on Node 16 and 17 when the output file

README.md

@@ -590,10 +590,12 @@ your account, each with a user-specified name and a uniquely-assigned ID.
 #### Creating a style rule
 
 Use `createStyleRule()` to create a new style rule with a name and language
-code. You can optionally provide `configuredRules` (a `ConfiguredRules` object,
-keyed by category such as `datesAndTimes` or `styleAndTone`) and
-`customInstructions` (an array of `CustomInstructionInput` objects with `label`,
-`prompt` and an optional `sourceLanguage`).
+code. You can optionally provide `configuredRules` and `customInstructions`,
+using the API's names: `configuredRules` is sent as given as `configured_rules`
+(the same shape `updateStyleRuleConfiguredRules()` takes, e.g.
+`{ dates_and_times: { calendar_era: 'use_bc_and_ad' } }`), and
+`customInstructions` as `custom_instructions`, an array of objects with
+`label`, `prompt` and an optional `source_language`.
 
 ```javascript
 const rule = await deeplClient.createStyleRule('My Style Rule', 'en');
@@ -602,14 +604,14 @@ console.log(`Created: ${rule.name} (${rule.styleId})`);
 const configured = await deeplClient.createStyleRule(
     'Formal English',
     'en',
-    { datesAndTimes: { calendar_era: 'use_bc_and_ad' } },
-    [{ label: 'Formal tone', prompt: 'Always use formal language', sourceLanguage: 'de' }],
+    { dates_and_times: { calendar_era: 'use_bc_and_ad' } },
+    [{ label: 'Formal tone', prompt: 'Always use formal language', source_language: 'de' }],
 );
 ```
 
-Passing a single object with the wire names (`configured_rules`,
-`custom_instructions`, `source_language`) is deprecated and will be removed in
-the next major version.
+Passing a single `CreateStyleRuleRequestBody` object
+(`{ name, language, configured_rules, custom_instructions }`) is deprecated and
+will be removed in the next major version.
 
 #### Retrieving and listing style rules
 

src/deeplClient.ts

@@ -23,8 +23,6 @@ import {
     StyleRuleInfoApiResponse,
     StyleId,
     CustomInstruction,
-    CustomInstructionInput,
-    ConfiguredRules,
     TranslationMemoryId,
     TranslationMemoryInfo,
     TranslationMemoryExport,
@@ -107,12 +105,6 @@ function styleProfileOptionsToJson(
     return body;
 }
 
-/**
- * @deprecated Pass the label, prompt and source language as separate arguments to
- * `createStyleRuleCustomInstruction()` and `updateStyleRuleCustomInstruction()`, and use
- * {@link CustomInstructionInput} with `createStyleRule()`. This type will be removed in the next
- * major version.
- */
 export type CustomInstructionRequestBody = {
     label: string;
     prompt: string;
@@ -140,19 +132,6 @@ function customInstructionToWire(
     return body;
 }
 
-// Converts the camelCase category keys (e.g. datesAndTimes) to the wire's snake_case; the rule
-// names and values inside each category are sent unchanged.
-function configuredRulesToWire(
-    configuredRules: ConfiguredRules,
-): Record<string, Record<string, string>> {
-    const body: Record<string, Record<string, string>> = {};
-    for (const [category, rules] of Object.entries(configuredRules)) {
-        if (rules === undefined) continue;
-        body[category.replace(/[A-Z]/g, (c) => `_${c.toLowerCase()}`)] = rules;
-    }
-    return body;
-}
-
 export enum WritingStyle {
     ACADEMIC = 'academic',
     BUSINESS = 'business',
@@ -1487,17 +1466,19 @@ export class DeepLClient extends Translator {
      *
      * @param name: The name of the style rule.
      * @param language: The language code of the style rule.
-     * @param configuredRules: Optional predefined rules to enable, see {@link ConfiguredRules}.
-     * @param customInstructions: Optional custom instructions, see {@link CustomInstructionInput}.
+     * @param configuredRules: Optional configured rules, sent as given as `configured_rules`,
+     *     e.g. `{ dates_and_times: { calendar_era: 'use_bc_and_ad' } }`.
+     * @param customInstructions: Optional custom instructions, sent as given as
+     *     `custom_instructions`, e.g. `[{ label, prompt, source_language: 'de' }]`.
      * @returns {Promise<StyleRuleInfo>} The created style rule info.
      *
      * @throws {DeepLError} If any error occurs while communicating with the DeepL API.
      */
     async createStyleRule(
         name: string,
         language: string,
-        configuredRules?: ConfiguredRules,
-        customInstructions?: CustomInstructionInput[],
+        configuredRules?: Record<string, Record<string, string>>,
+        customInstructions?: CustomInstructionRequestBody[],
     ): Promise<StyleRuleInfo>;
     /**
      * @deprecated Pass the name, language, configured rules and custom instructions as separate
@@ -1507,24 +1488,14 @@ export class DeepLClient extends Translator {
     async createStyleRule(
         nameOrStyleRule: string | CreateStyleRuleRequestBody,
         language?: string,
-        configuredRules?: ConfiguredRules,
-        customInstructions?: CustomInstructionInput[],
+        configuredRules?: Record<string, Record<string, string>>,
+        customInstructions?: CustomInstructionRequestBody[],
     ): Promise<StyleRuleInfo> {
         let body: CreateStyleRuleRequestBody;
         if (typeof nameOrStyleRule === 'string') {
             body = { name: nameOrStyleRule, language: language as string };
-            if (configuredRules !== undefined) {
-                body.configured_rules = configuredRulesToWire(configuredRules);
-            }
-            if (customInstructions !== undefined) {
-                body.custom_instructions = customInstructions.map((instruction) =>
-                    customInstructionToWire(
-                        instruction.label,
-                        instruction.prompt,
-                        instruction.sourceLanguage,
-                    ),
-                );
-            }
+            if (configuredRules !== undefined) body.configured_rules = configuredRules;
+            if (customInstructions !== undefined) body.custom_instructions = customInstructions;
         } else {
             body = nameOrStyleRule;
         }

src/types.ts

@@ -870,18 +870,6 @@ export interface CustomInstruction {
     readonly sourceLanguage?: string;
 }
 
-/**
- * Custom instruction to create or update on a style rule.
- */
-export interface CustomInstructionInput {
-    /** Label for the custom instruction. */
-    readonly label: string;
-    /** Prompt text for the custom instruction. */
-    readonly prompt: string;
-    /** Optional source language code for the custom instruction. */
-    readonly sourceLanguage?: string;
-}
-
 /**
  * Configuration rules for a style rule list.
  */

tests/offline/styleRules.test.ts

@@ -80,33 +80,26 @@ describe('DeepLClient.createStyleRule', () => {
         await makeDeeplClient().createStyleRule(body);
     });
 
-    it('sends the same JSON for the positional arguments, converting them to the wire names', async () => {
+    it('sends the positional configured rules and custom instructions unchanged', async () => {
+        const configuredRules = { dates_and_times: { calendar_era: 'use_bc_and_ad' } };
+        const customInstructions = [
+            { label: 'Label', prompt: 'Prompt', source_language: 'de' },
+            { label: 'L2', prompt: 'P2' },
+        ];
         nock(serverUrl)
             .post('/v3/style_rules', {
                 name: 'my rule',
                 language: 'en',
-                configured_rules: {
-                    dates_and_times: { calendar_era: 'use_bc_and_ad' },
-                    spelling_and_grammar: { color: 'british' },
-                },
-                custom_instructions: [
-                    { label: 'Label', prompt: 'Prompt', source_language: 'de' },
-                    { label: 'L2', prompt: 'P2' },
-                ],
+                configured_rules: configuredRules,
+                custom_instructions: customInstructions,
             })
             .reply(201, styleRuleReply);
 
         const styleRule = await makeDeeplClient().createStyleRule(
             'my rule',
             'en',
-            {
-                datesAndTimes: { calendar_era: 'use_bc_and_ad' },
-                spellingAndGrammar: { color: 'british' },
-            },
-            [
-                { label: 'Label', prompt: 'Prompt', sourceLanguage: 'de' },
-                { label: 'L2', prompt: 'P2' },
-            ],
+            configuredRules,
+            customInstructions,
         );
 
         expect(styleRule.styleId).toBe('s-1');