docs: deprecate document minification and link the API usage limits

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

Author: hive-bot

CHANGELOG.md

@@ -92,6 +92,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   release of this package. They use the new `SourceLanguageCodeInput`,
   `TargetLanguageCodeInput` and `LanguageCodeInput` types, which keep editor
   autocompletion for the listed codes. Result types are unchanged.
+- README: the document minification section no longer states a 30 MB upload
+  limit and links to the DeepL API usage limits instead.
 
 ### Deprecated
 - `TranslateTextOptions.__path` is deprecated. It is for internal use only
@@ -110,6 +112,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   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.
+- Document minification is deprecated: the `enableDocumentMinification` option
+  of `DocumentTranslateOptions`, the `DocumentMinifier` class, and the
+  `DocumentMinificationError` and `DocumentDeminificationError` errors. The
+  DeepL API accepts larger documents; see the
+  [usage limits](https://developers.deepl.com/docs/resources/usage-limits).
+  Minification keeps working and will be removed in the next major version.
 
 ### Fixed
 - `downloadTranslationMemoryExport()` no longer hangs on Node 16 and 17 when the output file

README.md

@@ -316,14 +316,23 @@ directly:
     the translated document. Only supported for `docx` and `pdf` output; for
     other output formats the API ignores this option.
 -   `extraRequestParameters`: same as in [Text translation options](#text-translation-options).
--   `enableDocumentMinification`: A `bool` value. If set to `true`, the library will try to minify a document 
-before translating it through the API, sending a smaller document if the file contains a lot of media. This is 
-currently only supported for `pptx` and `docx` files. See also [Document minification](#document-minification). 
+-   `enableDocumentMinification`: **deprecated**, will be removed in the next
+    major version. A `bool` value. If set to `true`, the library will try to
+    minify a document before translating it through the API, sending a smaller
+    document if the file contains a lot of media. This is currently only
+    supported for `pptx` and `docx` files. See also
+    [Document minification](#document-minification).
 
 #### Document minification
+> **Deprecated:** document minification (the `enableDocumentMinification` option and the
+> `DocumentMinifier` class) is deprecated and will be removed in the next major version.
+> It still works until then. The DeepL API accepts larger documents; see the
+> [usage limits](https://developers.deepl.com/docs/resources/usage-limits).
+
 In some contexts, one can end up with large document files (e.g. PowerPoint presentations
-or Word files with many contributors, especially in a larger organization). However, the
-DeepL API enforces a limit of 30 MB for most of these files (see Usage Limits in the docs).
+or Word files with many contributors, especially in a larger organization). The DeepL API
+limits the size of uploaded documents; see the
+[usage limits](https://developers.deepl.com/docs/resources/usage-limits) for the current values.
 In the case that most of this size comes from media included in the documents (e.g. images,
 videos, animations), document minification can help.
 In this case, the library will create a temporary directory to extract the document into,

src/documentMinifier.ts

@@ -87,6 +87,10 @@ interface IDocumentMinifier {
  *         }
  *       }
  *     }
+ *
+ * @deprecated Document minification is deprecated and will be removed in the next major version.
+ * The DeepL API accepts larger documents; see the usage limits:
+ * https://developers.deepl.com/docs/resources/usage-limits
  */
 export class DocumentMinifier implements IDocumentMinifier {
     /** Which input document types are supported for minification. */

src/errors.ts

@@ -47,12 +47,18 @@ export class DocumentNotReadyError extends DeepLError {}
 /**
  * Error thrown if an error occurs during the minification phase.
  * @see DocumentMinifier.minifyDocument
+ * @deprecated Document minification is deprecated and will be removed in the next major version.
+ * The DeepL API accepts larger documents; see the usage limits:
+ * https://developers.deepl.com/docs/resources/usage-limits
  */
 export class DocumentMinificationError extends DeepLError {}
 
 /**
  * Error thrown if an error occurs during the deminification phase.
  * @see DocumentMinifier.deminifyDocument
+ * @deprecated Document minification is deprecated and will be removed in the next major version.
+ * The DeepL API accepts larger documents; see the usage limits:
+ * https://developers.deepl.com/docs/resources/usage-limits
  */
 export class DocumentDeminificationError extends DeepLError {}
 

src/types.ts

@@ -283,7 +283,12 @@ export interface DocumentTranslateOptions extends BaseRequestOptions {
     /** Filename including extension, only required when translating documents as streams. */
     filename?: string;
 
-    /** Controls whether to use Document Minification for translation, if available. */
+    /**
+     * Controls whether to use Document Minification for translation, if available.
+     * @deprecated Document minification is deprecated and will be removed in the next major
+     * version. The DeepL API accepts larger documents; see the usage limits:
+     * https://developers.deepl.com/docs/resources/usage-limits
+     */
     enableDocumentMinification?: boolean;
 
     /**