fix: keep DocumentStatus.status typed as DocumentStatusCode

Widening the released response type to accept any string breaks callers
that assign it to DocumentStatusCode or switch on it exhaustively. The
type stays as released; ok() still treats unknown statuses as not failed,
so polling continues through them.

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

Author: hive-bot

CHANGELOG.md

@@ -106,9 +106,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `updateStyleRuleCustomInstruction(styleId, instructionId, label, prompt, sourceLanguage?)`.
 
 ### Changed
-- `DocumentStatus.status` is typed as `DocumentStatusCode | string`, so statuses
-  the API adds later are typed correctly. At runtime the value was already
-  the string the API returned.
 - `Formality`, `SentenceSplittingMode`, `TagHandlingMode`, `TagHandlingVersion`
   and `ModelType` accept any string in addition to their listed values, so values
   the API adds later can be passed without a type cast.

README.md

@@ -317,10 +317,10 @@ deprecated aliases of these methods and will be removed in the next major
 version.
 
 A `DocumentStatus` has `documentId`, `status` (`'queued'`, `'translating'`,
-`'done'`, `'error'`, or another string for a status this library does not know
-yet), `secondsRemaining`, `billedCharacters` and `errorMessage`. `done()` is
-true when the status is `'done'`; `ok()` is true unless the status is
-`'error'`, so the polling methods keep waiting through unknown statuses.
+`'done'` or `'error'`), `secondsRemaining`, `billedCharacters` and
+`errorMessage`. `done()` is true when the status is `'done'`; `ok()` is true
+unless the status is `'error'`, so the polling methods keep waiting through
+statuses this library does not know.
 
 #### Document translation options
 

src/parsing.ts

@@ -288,14 +288,14 @@ class UsageImpl implements Usage {
 }
 
 class DocumentStatusImpl implements DocumentStatus {
-    public status: DocumentStatusCode | (string & Record<never, never>);
+    public status: DocumentStatusCode;
     public secondsRemaining?: number;
     public billedCharacters?: number;
     public errorMessage?: string;
     public documentId?: string;
 
     constructor(
-        status: DocumentStatusCode | (string & Record<never, never>),
+        status: DocumentStatusCode,
         secondsRemaining?: number,
         billedCharacters?: number,
         errorMessage?: string,
@@ -541,7 +541,7 @@ export function parseDocumentStatus(json: string): DocumentStatus {
     try {
         const obj = JSON.parse(json) as DocumentStatusApiResponse;
         return new DocumentStatusImpl(
-            obj.status,
+            obj.status as DocumentStatusCode,
             obj.seconds_remaining,
             obj.billed_characters,
             obj.error_message,

src/types.ts

@@ -792,11 +792,10 @@ export interface DocumentStatus {
     readonly documentId?: string;
 
     /**
-     * One of the status values defined in DocumentStatusCode, or another string if the API
-     * returns a status this version of the library does not know.
+     * One of the status values defined in DocumentStatusCode.
      * @see DocumentStatusCode
      */
-    readonly status: DocumentStatusCode | (string & Record<never, never>);
+    readonly status: DocumentStatusCode;
 
     /**
      * Estimated time until document translation completes in seconds, otherwise undefined if

tests/offline/translateDocument.test.ts

@@ -213,10 +213,8 @@ describe('Translator.translateDocumentGetStatus', () => {
         nock(serverUrl).post('/v2/document/doc-id', keyBody).reply(200, { status: 'resyncing' });
 
         const status = await makeDeeplClient().translateDocumentGetStatus(handle);
-        // Compiles only while DocumentStatus.status accepts strings outside DocumentStatusCode.
-        const expected: deepl.DocumentStatus['status'] = 'resyncing';
 
-        expect([status.status, status.ok(), status.done()]).toEqual([expected, true, false]);
+        expect([status.status, status.ok(), status.done()]).toEqual(['resyncing', true, false]);
     });
 
     it('URL-encodes the document ID in the path', async () => {