types-mediawiki-response 1.0.0-alpha.1 → 1.0.1

package/dist/common/index.d.ts

@@ -12,6 +12,17 @@ export type Flag = true;
  * e.g. `2024-01-15T08:30:00Z`.
  */
 export type Timestamp = string;
+/**
+ * Expiry of a temporary state: a timestamp, or the literal `infinity` when it
+ * does not expire. Block records spell the permanent case `infinite` instead
+ * — see {@link BlockExpiry}.
+ */
+export type Expiry = Timestamp | "infinity";
+/**
+ * Expiry of a block as an action result reports it: a timestamp, or the
+ * literal `infinite` for an indefinite block.
+ */
+export type BlockExpiry = Timestamp | "infinite";
 /**
  * A block of plain text (as opposed to HTML), e.g. a TextExtracts excerpt
  * requested with `explaintext`. Kept distinct from HTML-bearing string fields.
@@ -19,6 +30,16 @@ export type Timestamp = string;
 export type PlainText = string;
 /** Namespace index. Negative indexes are pseudo-namespaces. */
 export type NamespaceIndex = number;
+/**
+ * `success` — or the actual outcome string when an operation did not succeed.
+ * **Open union**: `(string & {})` keeps other outcomes forward-compatible.
+ */
+export type SuccessStatus = "success" | (string & {});
+/**
+ * `Success` — or the actual result string when an operation did not succeed.
+ * **Open union**: `(string & {})` keeps other outcomes forward-compatible.
+ */
+export type SuccessResult = "Success" | (string & {});
 /**
  * A structured in-band message — a serialized MediaWiki `Message`/`FatalError`
  * spec (`{ message, params, code, type }`) nested inside an action result

package/dist/core/block.d.ts

@@ -1,15 +1,15 @@
 /**
- * `action=block` / `action=unblock` responses — (un)blocking a user or IP
- * range, each returned under a top-level object. Requires the `block` right.
+ * `action=block` response — blocking a user or IP range, returned under a
+ * top-level `block` object. Requires the `block` right.
  *
- * fv2 note: the block result uses **`userID`** (capital `D`) while the unblock
- * result uses `userid` — a real asymmetry in the API, preserved here. Block
- * flags are real booleans (present as `false`); partial-block restrictions come
- * back as `null` when the block is sitewide.
+ * fv2 note: the block result uses **`userID`** (capital `D`), unlike the
+ * unblock result's `userid`. Block flags are real booleans (present as
+ * `false`); partial-block restrictions come back as `null` when the block is
+ * sitewide.
  *
  * @see https://www.mediawiki.org/wiki/API:Block
  */
-import type { Timestamp } from "../common";
+import type { BlockExpiry, Timestamp } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** The `block` object of an `action=block` response. */
 export interface ApiBlockResult {
@@ -20,7 +20,7 @@ export interface ApiBlockResult {
     /** Block id. */
     id: number;
     /** Expiry timestamp, or `infinite` for an indefinite block. */
-    expiry: Timestamp | "infinite";
+    expiry: BlockExpiry;
     /** Block reason (echoed back). */
     reason: string;
     /** Block only anonymous users editing from an IP address range. */
@@ -60,10 +60,8 @@ export interface ApiBlockResult {
      */
     timestamp?: Timestamp;
     /**
-     * Extra statuses set by extensions during a successful block. Always
-     * emitted; core never fills it, so it is `[]` unless `$wgEnableMultiBlocks`
-     * is on and an extension populates it via the `ApiBlockSucceeded` hook, in
-     * which case a PHP map (thus the `unknown[]` empty case).
+     * Extra statuses set by extensions during a successful block; `[]` when none
+     * is set.
      *
      * @since MediaWiki 1.46
      */
@@ -71,28 +69,6 @@ export interface ApiBlockResult {
 }
 /** Response of `action=block`. */
 export interface ApiBlockResponse extends ApiEnvelope {
+    /** Result of `action=block`. */
     block: ApiBlockResult;
 }
-/** The `unblock` object of an `action=unblock` response. */
-export interface ApiUnblockResult {
-    /** Removed block id. */
-    id: number;
-    /** Unblocked user name / IP; empty string when removing an autoblock. */
-    user: string;
-    /** Unblocked user id (`0` for IPs and autoblocks). Note lowercase, unlike the block result. */
-    userid: number;
-    /** Unblock reason (echoed back). */
-    reason: string;
-    /** Whether the unblock added the unblocked user to the unblocker's watchlist. */
-    watchuser: boolean;
-    /**
-     * Expiry applied to the watched user page, present only when the request
-     * passed `watchlistexpiry` with `watchuser`; `null` when the page is not
-     * actually watched.
-     */
-    watchlistexpiry?: Timestamp | null;
-}
-/** Response of `action=unblock`. */
-export interface ApiUnblockResponse extends ApiEnvelope {
-    unblock: ApiUnblockResult;
-}

package/dist/core/changeauthenticationdata.d.ts

@@ -4,15 +4,17 @@
  * token, the `editmyprivateinfo` right, and a fully-configured secondary-provider
  * session. On success `ApiChangeAuthenticationData` emits a single field:
  * `changeauthenticationdata.status` = `success`. Any refusal or incomplete flow
- * is a top-level {@link ApiErrorResponse} (dieStatus / badrequest).
+ * is a top-level `ApiErrorResponse` (dieStatus / badrequest).
  *
  * @see https://www.mediawiki.org/wiki/API:Changeauthenticationdata
  */
+import type { SuccessStatus } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=changeauthenticationdata`. */
 export interface ApiChangeAuthenticationDataResponse extends ApiEnvelope {
+    /** Result of `action=changeauthenticationdata`. */
     changeauthenticationdata: {
         /** Flow outcome; `success` when the change was applied. */
-        status: "success" | (string & {});
+        status: SuccessStatus;
     };
 }

package/dist/core/changecontentmodel.d.ts

@@ -6,13 +6,14 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Changecontentmodel
  */
-import type { ContentModel } from "../common";
+import type { ContentModel, SuccessResult } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=changecontentmodel`. */
 export interface ApiChangeContentModelResponse extends ApiEnvelope {
+    /** Result of `action=changecontentmodel`. */
     changecontentmodel: {
         /** `Success` when the model was changed. */
-        result: "Success" | (string & {});
+        result: SuccessResult;
         /** Page title. */
         title: string;
         /** Page id. */

package/dist/core/checktoken.d.ts

@@ -16,6 +16,7 @@ import type { ApiEnvelope } from "../envelope";
 export type ApiCheckTokenResult = "valid" | "expired" | "invalid" | (string & {});
 /** Response of `action=checktoken`. */
 export interface ApiCheckTokenResponse extends ApiEnvelope {
+    /** Result of `action=checktoken`. */
     checktoken: {
         /** Outcome of the token check. */
         result: ApiCheckTokenResult;

package/dist/core/clientlogin.d.ts

@@ -44,5 +44,6 @@ export interface ApiClientLogin {
 }
 /** Response of `action=clientlogin`. */
 export interface ApiClientLoginResponse extends ApiEnvelope {
+    /** Result of `action=clientlogin`. */
     clientlogin: ApiClientLogin;
 }

package/dist/core/compare.d.ts

@@ -88,5 +88,6 @@ export interface ApiCompareResult {
 }
 /** Response of `action=compare`. */
 export interface ApiCompareResponse extends ApiEnvelope {
+    /** Result of `action=compare`. */
     compare: ApiCompareResult;
 }

package/dist/core/createaccount.d.ts

@@ -1,21 +1,21 @@
 /**
  * `action=createaccount` response — AuthManager-driven account creation. The
- * result keys under `createaccount`, produced by `ApiAuthManagerHelper::
- * formatAuthenticationResponse` (the same builder as `clientlogin`): `status`
- * drives the flow (`PASS` on success, plus in-band `FAIL`/`UI`/`RESTART`/
- * `REDIRECT`), and failures carry `message`/`messagecode`.
+ * result keys under `createaccount`: `status` drives the flow (`PASS` on
+ * success, plus in-band `FAIL`/`UI`/`RESTART`/`REDIRECT`), and failures carry
+ * `message`/`messagecode`.
  *
  * These are **in-band** AuthManager outcomes, not a top-level
- * {@link ApiErrorResponse}. `username` appears on `PASS`; `UI`/`RESTART`/
+ * `ApiErrorResponse`. `username` appears on `PASS`; `UI`/`RESTART`/
  * `REDIRECT` outcomes add the `requests` descriptors; `canpreservestate` marks
  * whether state can be kept.
  *
  * @see https://www.mediawiki.org/wiki/API:Createaccount
  */
-import type { ApiAuthManagerMessage, ApiAuthManagerStatus } from "./query/authmanagerinfo";
+import type { ApiAuthManagerMessage, ApiAuthManagerStatus, ApiQueryAuthManagerInfoRequest } from "./query/authmanagerinfo";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=createaccount`. */
 export interface ApiCreateAccountResponse extends ApiEnvelope {
+    /** Result of `action=createaccount`. */
     createaccount: {
         /** AuthManager outcome of the account-creation flow. */
         status?: ApiAuthManagerStatus;
@@ -36,6 +36,6 @@ export interface ApiCreateAccountResponse extends ApiEnvelope {
         /** Extra API data accompanying a `REDIRECT` outcome. */
         redirectdata?: Record<string, unknown>;
         /** AuthManager request descriptors for interactive (`UI`/`RESTART`) and `REDIRECT` steps. */
-        requests?: Record<string, unknown>[];
+        requests?: ApiQueryAuthManagerInfoRequest[];
     };
 }

package/dist/core/delete.d.ts

@@ -1,6 +1,6 @@
 /**
- * `action=delete` / `action=undelete` responses — page deletion and its undo,
- * each returned under a top-level object. Requires the `delete` right.
+ * `action=delete` response — page deletion, returned under a top-level `delete`
+ * object. Requires the `delete` right.
  *
  * Under `formatversion=2` a successful delete carries **no `result` key**
  * (older clients branched on `result: "Success"`).
@@ -26,20 +26,6 @@ export interface ApiDeleteResult {
 }
 /** Response of `action=delete`. */
 export interface ApiDeleteResponse extends ApiEnvelope {
+    /** Result of `action=delete`. */
     delete: ApiDeleteResult;
 }
-/** The `undelete` object of an `action=undelete` response. */
-export interface ApiUndeleteResult {
-    /** Restored page title. */
-    title: string;
-    /** Number of revisions restored. */
-    revisions: number;
-    /** Number of file versions restored. */
-    fileversions: number;
-    /** Undelete reason (echoed back). */
-    reason: string;
-}
-/** Response of `action=undelete`. */
-export interface ApiUndeleteResponse extends ApiEnvelope {
-    undelete: ApiUndeleteResult;
-}

package/dist/core/edit.d.ts

@@ -6,9 +6,11 @@
  * - create: `new: true` plus `oldrevid: 0` / `newrevid` / `newtimestamp`;
  * - changed: `oldrevid` / `newrevid` / `newtimestamp` (no `new`);
  * - nochange: `nochange: true`, no revision ids.
- * `watched` appears when the edit applied a watch. Most hard failures (bad
- * token, protected page, `createonly` on an existing page) surface as a
- * top-level {@link ApiErrorResponse}, not `result: "Failure"`.
+ * A save aborted by a hook that carries status data (ConfirmEdit's captcha
+ * challenge) returns the in-band failure branch: `result: "Failure"` plus that
+ * data and no revision ids. Most hard failures (bad token, protected page,
+ * `createonly` on an existing page) surface as a top-level
+ * `ApiErrorResponse`, not `result: "Failure"`.
  *
  * @see https://www.mediawiki.org/wiki/API:Edit
  */
@@ -59,8 +61,26 @@ export interface ApiEditResult {
     code?: string;
     /** Human-readable failure description. */
     info?: string;
+    /**
+     * Captcha challenge returned when ConfirmEdit aborted the save. Present only
+     * in the in-band failure branch; {@link ApiEditCaptcha.id} and
+     * {@link ApiEditCaptcha.question} are per-request random values.
+     */
+    captcha?: ApiEditCaptcha;
+}
+/** The captcha challenge of a `result: "Failure"` edit, as emitted by ConfirmEdit. */
+export interface ApiEditCaptcha {
+    /** Captcha implementation, e.g. `simple` (arithmetic challenge) or `image`. Open union. */
+    type?: string;
+    /** MIME type the challenge renders as, e.g. `text/plain`, `image/png`, `text/html`. */
+    mime?: string;
+    /** Cache key of the pending challenge; pass it back as `captchaid` alongside the `captchaword` answer. */
+    id?: string;
+    /** Challenge text: an arithmetic expression for the sample implementation, the prompt for a question captcha. */
+    question?: string;
 }
 /** Response of `action=edit`. */
 export interface ApiEditResponse extends ApiEnvelope {
+    /** Result of `action=edit`. */
     edit: ApiEditResult;
 }

package/dist/core/emailuser.d.ts

@@ -4,24 +4,25 @@
  * under `emailuser`.
  *
  * `ApiEmailUser` reports the outcome **in-band** (not as a top-level
- * {@link ApiErrorResponse}): `result` is `Success`, `Warnings`, or `Failure`,
- * and `warnings`/`errors` carry message specs. The keys are dropped when the
- * status carries none of that kind — except under the default `bc`
- * `errorformat`, which keeps them as empty arrays. A `Failure` also occurs on
- * a wiki without a mail transport.
+ * `ApiErrorResponse`): `result` is `Success`, `Warnings`, or `Failure`,
+ * and `warnings`/`errors` carry the messages, shaped per the request's
+ * `errorformat`. The keys are dropped when the status carries none of that
+ * kind — except under the default `bc` `errorformat`, which keeps them as
+ * empty arrays. A `Failure` also occurs on a wiki without a mail transport.
  *
  * @see https://www.mediawiki.org/wiki/API:Email
  */
 import type { ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** Response of `action=emailuser`. */
 export interface ApiEmailUserResponse extends ApiEnvelope {
+    /** Result of `action=emailuser`. */
     emailuser: {
         /** Whether the message was accepted, or accepted with warnings, or failed. */
         result: "Success" | "Warnings" | "Failure" | (string & {});
-        /** Non-fatal messages (e.g. subject/text transformations). */
-        warnings?: ApiSpecMessage[];
-        /** In-band delivery errors (present when `result` is `Failure`). */
-        errors?: ApiSpecMessage[];
+        /** Non-fatal messages (e.g. subject/text transformations), shaped per the request's `errorformat`. */
+        warnings?: ApiSpecMessage[] | ApiMessage[];
+        /** In-band delivery errors (present when `result` is `Failure`), shaped per the request's `errorformat`. */
+        errors?: ApiSpecMessage[] | ApiMessage[];
     };
 }

package/dist/core/expandtemplates.d.ts

@@ -53,6 +53,7 @@ export interface ApiExpandTemplatesResult {
 }
 /** Response of `action=expandtemplates`. */
 export interface ApiExpandTemplatesResponse extends ApiEnvelope {
+    /** Result of `action=expandtemplates`. */
     expandtemplates: ApiExpandTemplatesResult;
     /**
      * XML parse tree of the input wikitext, emitted at the root level (outside

package/dist/core/filerevert.d.ts

@@ -3,18 +3,19 @@
  * needs CSRF, title-level `edit`/`upload` rights on the file, and `reupload`
  * (or `reupload-own` when reverting one's own upload). The result keys under
  * `filerevert`: `result` is `Success`, or `Failure` with an in-band `errors`
- * array (a per-item outcome, not a top-level {@link ApiErrorResponse}).
+ * array (a per-item outcome, not a top-level `ApiErrorResponse`).
  *
  * @see https://www.mediawiki.org/wiki/API:Filerevert
  */
 import type { ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** Response of `action=filerevert`. */
 export interface ApiFileRevertResponse extends ApiEnvelope {
+    /** Result of `action=filerevert`. */
     filerevert: {
         /** Outcome of the revert. */
         result: "Success" | "Failure" | (string & {});
-        /** In-band messages when the revert did not apply. */
-        errors?: ApiSpecMessage[];
+        /** In-band messages when the revert did not apply, shaped per the request's `errorformat`. */
+        errors?: ApiSpecMessage[] | ApiMessage[];
     };
 }

package/dist/core/imagerotate.d.ts

@@ -14,38 +14,24 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Imagerotate
  */
-import type { Flag, NamespaceIndex, ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiSpecMessage } from "../common";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
+import type { ApiPageIdentity } from "./query";
 /** One file entry of an `action=imagerotate` response. */
-export interface ApiImageRotateEntry {
+export interface ApiImageRotateEntry extends ApiPageIdentity {
     /** Page id of the file (keyed as `id`, not `pageid`). */
     id?: number;
-    /** Page id, for entries describing a `pageid=` that did not resolve. */
-    pageid?: number;
     /** Revision id, for entries describing a `revid=` that did not resolve. */
     revid?: number;
-    /** Namespace index (6 = File). */
-    ns?: NamespaceIndex;
-    /** File title. */
-    title?: string;
-    /** The title does not correspond to an existing page. A {@link Flag}. */
-    missing?: Flag;
-    /** A `missing` title that is nonetheless "known" (e.g. a redlinked file). A {@link Flag}. */
-    known?: Flag;
-    /** The requested title is malformed or otherwise invalid. A {@link Flag}. */
-    invalid?: Flag;
-    /** Reason the title is invalid (localized wikitext), alongside `invalid`. */
-    invalidreason?: string;
-    /** The requested title is a Special: page (not rotated). A {@link Flag}. */
-    special?: Flag;
     /** Interwiki prefix, for entries describing an interwiki title. */
     iw?: string;
     /** Per-file outcome. */
     result?: "Success" | "Failure" | (string & {});
-    /** In-band messages when the rotation failed. */
-    errors?: ApiSpecMessage[];
+    /** In-band messages when the rotation failed, shaped per the request's `errorformat`. */
+    errors?: ApiSpecMessage[] | ApiMessage[];
 }
 /** Response of `action=imagerotate`. */
 export interface ApiImageRotateResponse extends ApiEnvelope {
+    /** Result of `action=imagerotate`; one entry per rotated image. */
     imagerotate: ApiImageRotateEntry[];
 }

package/dist/core/import.d.ts

@@ -4,8 +4,7 @@
  * uploads) right. The result is a top-level `import` **array**, one entry per
  * imported page.
  *
- * Shape comes from `ApiImportReporter::reportPage` (via `ApiQueryBase::addTitleInfo`):
- * a successful page carries `ns`/`title` plus a `revisions` count; an
+ * A successful page carries `ns`/`title` plus a `revisions` count; an
  * un-importable title carries `title` + an `invalid` flag.
  *
  * @see https://www.mediawiki.org/wiki/API:Import
@@ -25,5 +24,6 @@ export interface ApiImportEntry {
 }
 /** Response of `action=import`. */
 export interface ApiImportResponse extends ApiEnvelope {
+    /** Result of `action=import`; one entry per imported page. */
     import: ApiImportEntry[];
 }

package/dist/core/index.d.ts

@@ -5,7 +5,9 @@ export * from "./edit";
 export * from "./move";
 export * from "./purge";
 export * from "./delete";
+export * from "./undelete";
 export * from "./block";
+export * from "./unblock";
 export * from "./watch";
 export * from "./rollback";
 export * from "./patrol";

package/dist/core/login.d.ts

@@ -12,14 +12,19 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Login
  */
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** Response of the deprecated `action=login`. */
 export interface ApiLoginResponse extends ApiEnvelope {
+    /** Result of `action=login`. */
     login: {
         /** Login outcome. */
         result: "Success" | "Failed" | "NeedToken" | "WrongToken" | "Aborted" | (string & {});
-        /** Human-readable reason, emitted when `result` is `Failed` or `Aborted`. */
-        reason?: string;
+        /**
+         * Why the login failed, emitted when `result` is `Failed` or `Aborted`:
+         * a plain string under the default (`bc`) `errorformat`, an
+         * {@link ApiMessage} under a modern one.
+         */
+        reason?: string | ApiMessage;
         /** Login token echoed back on a `NeedToken` round trip. */
         token?: string;
         /** User id of the logged-in account (legacy `lguserid` spelling). */

package/dist/core/managetags.d.ts

@@ -8,11 +8,12 @@
  * @see https://www.mediawiki.org/wiki/API:Managetags
  */
 import type { ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** `action=managetags` operation. Open union for forward compatibility. */
 export type ApiManageTagsOperation = "activate" | "create" | "deactivate" | "delete" | (string & {});
 /** Response of `action=managetags`. */
 export interface ApiManageTagsResponse extends ApiEnvelope {
+    /** Result of `action=managetags`. */
     managetags: {
         /** The operation that was performed. */
         operation: ApiManageTagsOperation;
@@ -22,7 +23,7 @@ export interface ApiManageTagsResponse extends ApiEnvelope {
         success: boolean;
         /** Log entry id recorded for the operation. */
         logid?: number;
-        /** Non-fatal messages (e.g. a deprecation notice). */
-        warnings?: ApiSpecMessage[];
+        /** Non-fatal messages (e.g. a deprecation notice), shaped per the request's `errorformat`. */
+        warnings?: ApiSpecMessage[] | ApiMessage[];
     };
 }

package/dist/core/mergehistory.d.ts

@@ -9,6 +9,7 @@ import type { Timestamp } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=mergehistory`. */
 export interface ApiMergeHistoryResponse extends ApiEnvelope {
+    /** Result of `action=mergehistory`. */
     mergehistory: {
         /** Source page title (history moved out of). */
         from: string;

package/dist/core/move.d.ts

@@ -4,28 +4,28 @@
  *
  * Note under `formatversion=2`: `redirectcreated` / `moveoverredirect` /
  * `talkmoveoverredirect` are real booleans (present as `false`), `reason` is
- * always present (`''` when none was supplied), and there is **no `result`
- * key** on a successful move. `subpages` is polymorphic: an array of per-subpage
+ * `''` when none was supplied, and there is **no `result` key** on a
+ * successful move. `subpages` is polymorphic: an array of per-subpage
  * outcomes when any subpage could be processed, or an object `{ errors }` when
  * the whole subpage move failed (e.g. the namespace forbids them).
  *
  * @see https://www.mediawiki.org/wiki/API:Move
  */
 import type { ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** One subpage move outcome within `subpages`/`subpages-talk`. */
 export interface ApiMoveSubpage {
     /** Old subpage title. */
     from?: string;
     /** New subpage title, when the subpage moved. */
     to?: string;
-    /** Why the subpage did not move, when it failed. */
-    errors?: ApiSpecMessage[];
+    /** Why the subpage did not move, when it failed, shaped per the request's `errorformat`. */
+    errors?: ApiSpecMessage[] | ApiMessage[];
 }
 /** The object form of `subpages`, returned only when the whole move failed. */
 export interface ApiMoveSubpageErrors {
-    /** Why no subpage could be moved. */
-    errors?: ApiSpecMessage[];
+    /** Why no subpage could be moved, shaped per the request's `errorformat`. */
+    errors?: ApiSpecMessage[] | ApiMessage[];
 }
 /** The `move` object of a successful `action=move` response. */
 export interface ApiMoveResult {
@@ -45,8 +45,8 @@ export interface ApiMoveResult {
     talkto?: string;
     /** Whether the talk-page destination already existed (redirect or not). A real `boolean`. */
     talkmoveoverredirect?: boolean;
-    /** Why the talk-page move failed, instead of `talkfrom`/`talkto`. */
-    "talkmove-errors"?: ApiSpecMessage[];
+    /** Why the talk-page move failed, instead of `talkfrom`/`talkto`, shaped per the request's `errorformat`. */
+    "talkmove-errors"?: ApiSpecMessage[] | ApiMessage[];
     /**
      * Subpage move outcome (`movesubpages=1`). `formatversion=2` returns either
      * an array of per-subpage outcomes or an object of errors, so both shapes are
@@ -58,5 +58,6 @@ export interface ApiMoveResult {
 }
 /** Response of `action=move`. */
 export interface ApiMoveResponse extends ApiEnvelope {
+    /** Result of `action=move`. */
     move: ApiMoveResult;
 }

package/dist/core/options.d.ts

@@ -4,13 +4,14 @@
  * CSRF token.
  *
  * On success `options` is the plain string `"success"`. Errors surface as a
- * top-level {@link ApiErrorResponse}.
+ * top-level `ApiErrorResponse`.
  *
  * @see https://www.mediawiki.org/wiki/API:Options
  */
+import type { SuccessStatus } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=options`. */
 export interface ApiOptionsResponse extends ApiEnvelope {
     /** Success sentinel (`"success"`); failures come back as a top-level error. */
-    options: "success" | (string & {});
+    options: SuccessStatus;
 }

package/dist/core/parse.d.ts

@@ -42,12 +42,12 @@ export interface ApiParseLangLink {
     /** Full URL of the target page. */
     url?: string;
     /**
-     * Localized language name, in the request `uselang` language. Always emitted
-     * when the target title is valid (`action=parse` has no `llprop` parameter).
+     * Localized language name, in the request `uselang` language. Present when
+     * the target title is valid (`action=parse` has no `llprop` parameter).
      */
     langname?: string;
     /**
-     * Native language name. Always emitted when the target title is valid
+     * Native language name. Present when the target title is valid
      * (`action=parse` has no `llprop` parameter).
      */
     autonym?: string;
@@ -74,10 +74,7 @@ export interface ApiParseRedirect {
  * A table-of-contents entry (`prop=sections`) — the legacy projection of the
  * same outline `prop=tocdata` emits, with lowercase keys here (`fromtitle`,
  * `byteoffset`) against camelCase there (`fromTitle`, `codepointOffset`); see
- * {@link ApiParseTocSection}.
- *
- * `SectionMetadata::toLegacy()` fills every key below unconditionally except
- * `extensionData`, which is only emitted when non-empty.
+ * {@link ApiParseTocSection}. `extensionData` appears only when non-empty.
  */
 export interface ApiParseSection {
     /** Nesting level in the TOC. */
@@ -139,11 +136,7 @@ export interface ApiParseTocSection {
     /** Extension-supplied data for this section; `[]` when empty. */
     extensionData?: Record<string, unknown> | unknown[];
 }
-/**
- * The `tocdata` object (`prop=tocdata`). `TOCData::toJsonArray()` writes both
- * keys unconditionally; individual section keys are the conditional ones (see
- * {@link ApiParseTocSection}).
- */
+/** The `tocdata` object (`prop=tocdata`). */
 export interface ApiParseTocData {
     /** The outline, in camelCase keys. */
     sections: ApiParseTocSection[];
@@ -248,8 +241,7 @@ export interface ApiParse {
     /**
      * The script-bearing subset of {@link modules}.
      *
-     * @deprecated since MediaWiki 1.32 — core hard-codes this to `[]`, so it is always
-     * empty; read {@link modules} instead.
+     * @deprecated since MediaWiki 1.32 — always empty; read {@link modules} instead.
      */
     modulescripts?: never[];
     /**
@@ -305,6 +297,7 @@ export interface ApiParse {
 }
 /** Response of `action=parse`. */
 export interface ApiParseResponse extends ApiEnvelope {
+    /** Result of `action=parse`. */
     parse: ApiParse;
 }
 /**
@@ -313,6 +306,7 @@ export interface ApiParseResponse extends ApiEnvelope {
  * `title`/`pageid` and none of the `prop` sub-objects of {@link ApiParse}.
  */
 export interface ApiParseOnlyPstResponse extends ApiEnvelope {
+    /** Result of `action=parse&onlypst=1`. */
     parse: {
         /** Pre-save-transformed wikitext. */
         text: string;

package/dist/core/patrol.d.ts

@@ -17,5 +17,6 @@ export interface ApiPatrolResult {
 }
 /** Response of `action=patrol`. */
 export interface ApiPatrolResponse extends ApiEnvelope {
+    /** Result of `action=patrol`. */
     patrol: ApiPatrolResult;
 }

package/dist/core/protect.d.ts

@@ -39,5 +39,6 @@ export interface ApiProtectResult {
 }
 /** Response of `action=protect`. */
 export interface ApiProtectResponse extends ApiEnvelope {
+    /** Result of `action=protect`. */
     protect: ApiProtectResult;
 }