types-mediawiki-response 1.0.0 → 1.0.1

package/dist/core/block.d.ts

@@ -1,11 +1,11 @@
 /**
- * `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
  */
@@ -72,27 +72,3 @@ 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 {
-    /** Result of `action=unblock`. */
-    unblock: ApiUnblockResult;
-}

package/dist/core/changeauthenticationdata.d.ts

@@ -4,7 +4,7 @@
  * 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
  */

package/dist/core/createaccount.d.ts

@@ -5,7 +5,7 @@
  * `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.
  *

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"`).
@@ -29,19 +29,3 @@ 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 {
-    /** Result of `action=undelete`. */
-    undelete: ApiUndeleteResult;
-}

package/dist/core/edit.d.ts

@@ -10,7 +10,7 @@
  * 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
- * {@link ApiErrorResponse}, not `result: "Failure"`.
+ * `ApiErrorResponse`, not `result: "Failure"`.
  *
  * @see https://www.mediawiki.org/wiki/API:Edit
  */

package/dist/core/emailuser.d.ts

@@ -4,25 +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/filerevert.d.ts

@@ -3,19 +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

@@ -15,7 +15,7 @@
  * @see https://www.mediawiki.org/wiki/API:Imagerotate
  */
 import type { ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 import type { ApiPageIdentity } from "./query";
 /** One file entry of an `action=imagerotate` response. */
 export interface ApiImageRotateEntry extends ApiPageIdentity {
@@ -27,8 +27,8 @@ export interface ApiImageRotateEntry extends ApiPageIdentity {
     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 {

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,15 +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,7 +8,7 @@
  * @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`. */
@@ -23,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/move.d.ts

@@ -12,20 +12,20 @@
  * @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

package/dist/core/options.d.ts

@@ -4,7 +4,7 @@
  * 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
  */

package/dist/core/query/filerepoinfo.d.ts

@@ -4,7 +4,7 @@
  * shapes that `prop=imageinfo` and `list=allimages` return.
  *
  * Config values, so the switches are real booleans (`false` is returned), not
- * {@link Flag}s. Repos report only the optional settings they configure, so
+ * `Flag`s. Repos report only the optional settings they configure, so
  * the key set varies by site; `apiurl` exists only for `ForeignAPIRepo`
  * backends.
  *

package/dist/core/query/index.d.ts

@@ -6,7 +6,7 @@
  * page shape grows as coverage expands without this file depending on them.
  */
 import type { Flag, NamespaceIndex } from "../../common";
-import type { ApiEnvelope } from "../../envelope";
+import type { ApiEnvelope, ApiMessage } from "../../envelope";
 /**
  * Continuation tokens returned by `action=query`. @see https://www.mediawiki.org/wiki/API:Continue
  *
@@ -275,8 +275,11 @@ export interface ApiPageIdentity {
     known?: Flag;
     /** `true` when the supplied title is not a valid title. */
     invalid?: Flag;
-    /** Human-readable reason a title is `invalid`. */
-    invalidreason?: string;
+    /**
+     * Why the title is `invalid`: a plain string under the default (`bc`)
+     * `errorformat`, an {@link ApiMessage} under a modern one.
+     */
+    invalidreason?: string | ApiMessage;
     /** `true` for pages in a special namespace. */
     special?: Flag;
 }

package/dist/core/query/info.d.ts

@@ -6,6 +6,7 @@
  * @see https://www.mediawiki.org/wiki/API:Info
  */
 import type { ApiWatchlistLabel, ContentFormat, ContentModel, Flag, Timestamp } from "../../common";
+import type { ApiMessageParam } from "../../envelope";
 import type { QueryPage, QueryPageExisting } from "./index";
 /** One entry of a page's `protection` array (`inprop=protection`). */
 export interface ApiPageProtection {
@@ -29,17 +30,22 @@ export interface ApiPageProtection {
 }
 /**
  * One permission-check failure reported under `intestactionsdetail=full|quick`.
- * The exact keys depend on the request's `errorformat`.
+ * The text-bearing keys depend on the request's `errorformat`: `text` for
+ * `plaintext`/`wikitext`, `html` for `html`, `key`/`params` for `raw`, and none
+ * of them for `none`. A request using the default (`bc`) format is rendered as
+ * `plaintext` here.
  */
 export interface ApiActionPermission {
     /** Machine-readable code, e.g. `sitejsprotected`. */
-    code?: string;
-    /** Rendered message text. */
+    code: string;
+    /** Rendered message text (`plaintext`/`wikitext`). */
     text?: string;
-    /** i18n message key, when the server supplies the raw message instead. */
-    message?: string;
-    /** Parameters substituted into the message. */
-    params?: unknown[];
+    /** Parsed message HTML (`html`). */
+    html?: string;
+    /** i18n message key (`raw`). */
+    key?: string;
+    /** i18n message parameters (`raw`). */
+    params?: ApiMessageParam[];
 }
 /**
  * Fields `prop=info` contributes to {@link ApiPage}. {@link InfoPage} projects
@@ -211,7 +217,7 @@ declare module "./index" {
 export type InfoPage = QueryPage<keyof ApiPageInfo>;
 /**
  * {@link InfoPage} for a page that exists: the identity fields and the
- * unconditional `prop=info` fields ({@link PropConstantKeys}) are required;
+ * unconditional `prop=info` fields (`PropConstantKeys`) are required;
  * `inprop`-gated fields stay optional.
  */
 export type InfoPageExisting = QueryPageExisting<keyof ApiPageInfo>;

package/dist/core/query/users.d.ts

@@ -5,6 +5,7 @@
  * @see https://www.mediawiki.org/wiki/API:Users
  */
 import type { ApiSpecMessage, BlockExpiry, Expiry, Flag, Timestamp } from "../../common";
+import type { ApiMessage } from "../../envelope";
 /**
  * Block details, as emitted for `usprop=blockinfo` (list=users) and
  * `uiprop=blockinfo` (meta=userinfo). Only present when the user is blocked.
@@ -135,10 +136,10 @@ export interface ApiUser extends ApiUserCore {
      */
     cancreate?: boolean;
     /**
-     * Why {@link cancreate} is `false`, as message specs (e.g. a reserved
-     * username). Emitted only when the creation check failed.
+     * Why {@link cancreate} is `false` (e.g. a reserved username), shaped per the
+     * request's `errorformat`. Emitted only when the creation check failed.
      */
-    cancreateerror?: ApiSpecMessage[];
+    cancreateerror?: ApiSpecMessage[] | ApiMessage[];
     /**
      * The user is hidden (suppressed via a hidden block); a {@link Flag}.
      * Emitted regardless of `usprop`.

package/dist/core/removeauthenticationdata.d.ts

@@ -4,7 +4,7 @@
  * address); needs a session token and the corresponding rights. On success
  * `ApiRemoveAuthenticationData` emits a single field:
  * `removeauthenticationdata.status` = `success`. An unusable removal request is
- * a top-level {@link ApiErrorResponse} (badrequest).
+ * a top-level `ApiErrorResponse` (badrequest).
  *
  * @see https://www.mediawiki.org/wiki/API:Removeauthenticationdata
  */

package/dist/core/resetpassword.d.ts

@@ -2,7 +2,7 @@
  * `action=resetpassword` response — password reset via `PasswordResetter`. On a
  * completed (or queued) reset `ApiResetPassword` emits a single field:
  * `resetpassword.status` = `success`; every other outcome is a top-level
- * {@link ApiErrorResponse} (dieStatus).
+ * `ApiErrorResponse` (dieStatus).
  *
  * @see https://www.mediawiki.org/wiki/API:Resetpassword
  */

package/dist/core/revisiondelete.d.ts

@@ -14,7 +14,7 @@
  * @see https://www.mediawiki.org/wiki/API:Revisiondelete
  */
 import type { Timestamp, ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** Per-item outcome. Open union for forward compatibility. */
 export type RevisionDeleteStatus = "Success" | "Fail" | (string & {});
 /** One item (revision / log entry / image) processed by the request. */
@@ -59,10 +59,10 @@ export interface ApiRevisionDeleteItem {
     contenthidden?: boolean;
     /** File URL, or a `Special:Revisiondelete` link when the content is deleted but viewable. File versions only. */
     url?: string;
-    /** In-band messages when this item failed. */
-    errors?: ApiSpecMessage[];
-    /** In-band warnings for this item. */
-    warnings?: ApiSpecMessage[];
+    /** In-band messages when this item failed, shaped per the request's `errorformat`. */
+    errors?: ApiSpecMessage[] | ApiMessage[];
+    /** In-band warnings for this item, shaped per the request's `errorformat`. */
+    warnings?: ApiSpecMessage[] | ApiMessage[];
 }
 /** The `revisiondelete` object of a successful response. */
 export interface ApiRevisionDeleteResult {
@@ -72,10 +72,10 @@ export interface ApiRevisionDeleteResult {
     target: string;
     /** Per-item results. */
     items: ApiRevisionDeleteItem[];
-    /** In-band messages when the overall operation failed. */
-    errors?: ApiSpecMessage[];
-    /** In-band warnings from the overall operation. */
-    warnings?: ApiSpecMessage[];
+    /** In-band messages when the overall operation failed, shaped per the request's `errorformat`. */
+    errors?: ApiSpecMessage[] | ApiMessage[];
+    /** In-band warnings from the overall operation, shaped per the request's `errorformat`. */
+    warnings?: ApiSpecMessage[] | ApiMessage[];
 }
 /** Response of `action=revisiondelete`. */
 export interface ApiRevisionDeleteResponse extends ApiEnvelope {

package/dist/core/tag.d.ts

@@ -10,7 +10,8 @@
  * @see https://www.mediawiki.org/wiki/API:Tag
  */
 import type { Flag, ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage, ApiMessageParam } from "../envelope";
+import type { ApiBlockInfo } from "./query/users";
 /** One targeted entry of an `action=tag` response. */
 export interface ApiTagEntry {
     /** Revision id the tags were applied to. */
@@ -20,9 +21,9 @@ export interface ApiTagEntry {
     /** Recent-change id the tags were applied to. */
     rcid?: number;
     /**
-     * Per-target outcome. `ApiTag` sets `success`, `failure`, `skipped` (rate
-     * throttle) or `error` (invalid target id, or the performer is blocked from
-     * the target page). Open union for forward compat.
+     * Per-target outcome: `success`, `failure`, `skipped` (rate throttle) or
+     * `error` (invalid target id, or the performer is blocked from the target
+     * page). Open union for forward compat.
      */
     status: "success" | "failure" | "skipped" | "error" | (string & {});
     /** The tag set already matched — no log entry was created. A {@link Flag}. */
@@ -33,15 +34,40 @@ export interface ApiTagEntry {
     added?: string[];
     /** Tags removed from this target. */
     removed?: string[];
-    /** In-band messages when the target could not be tagged (`failure` only). */
-    errors?: ApiSpecMessage[];
+    /** In-band messages when the target could not be tagged (`failure` only), shaped per the request's `errorformat`. */
+    errors?: ApiSpecMessage[] | ApiMessage[];
     /**
      * On `error` entries the formatted failure message is merged into the entry:
-     * `code` is the message's API code. Rendered per the `errorformat` parameter.
+     * `code` is the message's API code, and the text-bearing keys follow the
+     * request's `errorformat` — `info` under the default (`bc`) format, `text`
+     * (`plaintext`/`wikitext`), `html`, `key`/`params` (`raw`), or none of them
+     * for `none`.
      */
     code?: string;
-    /** Message text accompanying `code` (default `errorformat=bc`; other formats emit `text`/`html` or `key`/`params` instead). */
+    /** Message text under the default (`bc`) `errorformat`. */
     info?: string;
+    /** Rendered message text (`plaintext`/`wikitext`). */
+    text?: string;
+    /** Parsed message HTML (`html`). */
+    html?: string;
+    /** i18n message key (`raw`). */
+    key?: string;
+    /** i18n message parameters (`raw`). */
+    params?: ApiMessageParam[];
+    /**
+     * Structured message data, present under a modern `errorformat` (the
+     * default `bc` format merges it into the entry instead).
+     */
+    data?: {
+        blockinfo?: ApiBlockInfo;
+        [key: string]: unknown;
+    };
+    /**
+     * Block details, when the performer is blocked from the target page. Under
+     * the default (`bc`) `errorformat` it is merged into the entry itself; a
+     * modern one nests it under {@link ApiTagEntry.data}.
+     */
+    blockinfo?: ApiBlockInfo;
 }
 /** Response of `action=tag`. */
 export interface ApiTagResponse extends ApiEnvelope {

package/dist/core/unblock.d.ts

@@ -0,0 +1,35 @@
+/**
+ * `action=unblock` response — removing a block, returned under a top-level
+ * `unblock` object. Requires the `block` right.
+ *
+ * fv2 note: the unblock result uses `userid` (lowercase), unlike the block
+ * result's `userID`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Block
+ */
+import type { Timestamp } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/** 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 {
+    /** Result of `action=unblock`. */
+    unblock: ApiUnblockResult;
+}

package/dist/core/undelete.d.ts

@@ -0,0 +1,23 @@
+/**
+ * `action=undelete` response — restoring a deleted page, returned under a
+ * top-level `undelete` object. Requires the `delete` right.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Undelete
+ */
+import type { ApiEnvelope } from "../envelope";
+/** 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 {
+    /** Result of `action=undelete`. */
+    undelete: ApiUndeleteResult;
+}

package/dist/core/validatepassword.d.ts

@@ -14,7 +14,7 @@
  * @see https://www.mediawiki.org/wiki/API:Validatepassword
  */
 import type { ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiMessage } from "../envelope";
 /** Password-policy verdict mapped from `checkPasswordValidity`'s Status. Open union. */
 export type ApiPasswordValidity = "Good" | "Change" | "Invalid" | (string & {});
 /** Response of `action=validatepassword`. */
@@ -23,7 +23,7 @@ export interface ApiValidatePasswordResponse extends ApiEnvelope {
     validatepassword: {
         /** Password-policy verdict for the submitted password. */
         validity: ApiPasswordValidity;
-        /** Policy messages explaining a non-`Good` verdict. */
-        validitymessages?: ApiSpecMessage[];
+        /** Policy messages explaining a non-`Good` verdict, shaped per the request's `errorformat`. */
+        validitymessages?: ApiSpecMessage[] | ApiMessage[];
     };
 }

package/dist/core/watch.d.ts

@@ -7,7 +7,7 @@
  * @see https://www.mediawiki.org/wiki/API:Watch
  */
 import type { ApiWatchlistLabel, Expiry, NamespaceIndex, ApiSpecMessage } from "../common";
-import type { ApiEnvelope } from "../envelope";
+import type { ApiEnvelope, ApiError, ApiMessage } from "../envelope";
 /** One watched/unwatched page. */
 export interface ApiWatchEntry {
     /** Page title. */
@@ -27,10 +27,17 @@ export interface ApiWatchEntry {
      * direction only.
      */
     expiry?: Expiry;
-    /** In-band messages when the watch/unwatch operation failed (pageset mode; the legacy `title` mode dies with a top-level error instead). */
-    errors?: ApiSpecMessage[];
-    /** In-band warnings for a failed operation (present when non-empty). */
-    warnings?: ApiSpecMessage[];
+    /**
+     * In-band messages when the watch/unwatch operation failed (pageset mode; the
+     * legacy `title` mode dies with a top-level error instead). Heterogeneous:
+     * messages raised by the operation itself follow the request's `errorformat`
+     * ({@link ApiSpecMessage} under `bc`, {@link ApiMessage} under a modern one),
+     * while a watchlist-label failure carries the legacy `{ code, info }` shape
+     * under `bc`, and an {@link ApiMessage} under a modern one.
+     */
+    errors?: (ApiSpecMessage | ApiMessage | ApiError)[];
+    /** In-band warnings for a failed operation (present when non-empty), shaped per the request's `errorformat`. */
+    warnings?: ApiSpecMessage[] | ApiMessage[];
     /**
      * Watchlist labels just saved for this page, echoed back when the request
      * passed `labels` and `$wgEnableWatchlistLabels` is on.

package/dist/envelope/index.d.ts

@@ -11,6 +11,14 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Errors_and_warnings
  */
+/**
+ * A single i18n message parameter under `errorformat=raw`: a scalar, a bare
+ * nested message ({@link ApiRawMessage}, produced when a message sits inside a
+ * list), or an object spec ({@link ApiMessageParamSpec}). Plain-text parameters
+ * are inlined as scalars, and a numeric parameter may arrive as a bare number
+ * or a `{ num }` spec.
+ */
+export type ApiMessageParam = string | number | ApiRawMessage | ApiMessageParamSpec;
 /**
  * A single message under a modern `errorformat` (an entry of the `errors` or
  * `warnings` array). Which text-bearing field is present depends on the
@@ -19,19 +27,15 @@
  */
 export interface ApiMessage {
     /** Machine-readable code, e.g. `badvalue`, `unrecognizedparams`. */
-    code?: string;
+    code: string;
     /** Rendered message (`errorformat=plaintext`/`wikitext`). */
     text?: string;
     /** Parsed message HTML (`errorformat=html`). */
     html?: string;
     /** i18n message key (`errorformat=raw`). */
     key?: string;
-    /**
-     * i18n message parameters (`errorformat=raw`). A parameter is a scalar or an
-     * object spec ({@link ApiMessageParamSpec}); numeric params occur too, and a
-     * parameter may itself be a message.
-     */
-    params?: (string | number | ApiMessageParamSpec)[];
+    /** i18n message parameters (`errorformat=raw`). */
+    params?: ApiMessageParam[];
     /** Module the message originated from, e.g. `main`, `query+info`. */
     module?: string;
     /** Extra structured data some messages attach. */
@@ -45,43 +49,76 @@ export interface ApiMessage {
  */
 export interface ApiRawMessage {
     /** i18n message key of the nested message. */
-    key?: string;
+    key: string;
     /**
      * Parameters of the nested message, which may themselves be messages,
      * serialized the same way as {@link ApiMessage.params}.
      */
-    params?: (string | number | ApiMessageParamSpec)[];
+    params: ApiMessageParam[];
 }
 /**
  * Object form of a raw-format message parameter. Exactly one spec kind is
- * present at runtime: `message` (a nested message), `plaintext`
- * (pre-escaped text), `num` (a number), or `list` + `type` (a list whose items
- * are parameter specs again).
+ * present at runtime: a nested message
+ * (`message`), pre-escaped text (`plaintext`), raw text (`raw`), a number
+ * (`num`), a duration in seconds (`duration`/`period`), an expiry (`expiry`),
+ * a date/time (`datetime`/`date`/`time`), a user group (`group`), a byte size
+ * (`size`), a bit rate (`bitrate`), the deprecated object form (`object`), or a
+ * list (`list` + `type`).
  */
 export interface ApiMessageParamSpec {
     /** The parameter, when it is itself a message. */
     message?: ApiRawMessage;
     /** Pre-escaped parameter text. */
     plaintext?: string;
+    /** Raw parameter text, inserted after formatting. */
+    raw?: string;
     /** Numeric parameter. */
     num?: number;
-    /** Parameter items, when the parameter is a list. */
-    list?: ApiMessageParamSpec[];
-    /** Rendering type of the {@link ApiMessageParamSpec.list} items, e.g. `text`. */
-    type?: string;
+    /** Duration in seconds, rendered in full. */
+    duration?: number;
+    /** Duration in seconds, rendered abbreviated. */
+    period?: number;
+    /** Expiry timestamp, or `infinity`. */
+    expiry?: string;
+    /** Date and time. */
+    datetime?: string;
+    /** Date. */
+    date?: string;
+    /** Time. */
+    time?: string;
+    /** User group name. */
+    group?: string;
+    /** Size in bytes. */
+    size?: number;
+    /** Bit rate in bit/s. */
+    bitrate?: number;
+    /**
+     * Object parameter, serialized as the object's string value.
+     *
+     * @deprecated since MediaWiki 1.43; removed in 1.44.
+     */
+    object?: string;
+    /**
+     * Parameter items, when the parameter is a list. Serialized as an array
+     * from MediaWiki 1.43 on; earlier versions keep the input array's keys, so
+     * a non-contiguous list comes back as an object.
+     */
+    list?: ApiMessageParam[] | Record<string, ApiMessageParam>;
+    /** Rendering type of the {@link ApiMessageParamSpec.list} items. Open union for forward compatibility. */
+    type?: "comma" | "semicolon" | "pipe" | "text" | (string & {});
 }
 /** The `error` object under the default (`bc`) `errorformat`. */
 export interface ApiError {
     /** Machine-readable error code, e.g. `badtoken`. */
-    code?: string;
+    code: string;
     /** Human-readable description provided by the server. */
-    info?: string;
+    info: string;
     /** Docs link plus deprecation notices; nested in `error` under the `bc` format. */
     docref?: string;
     /** PHP backtrace, when `$wgShowExceptionDetails` is on (non-usage exceptions). */
     trace?: string;
     /**
-     * Structured `apiData` attached to the message by the emitting code, merged
+     * Structured data attached to the message by the emitting code, merged
      * into this object as top-level keys.
      */
     [key: string]: unknown;
@@ -89,7 +126,7 @@ export interface ApiError {
 /** One `bc`-format warning entry (the value of a module key in `warnings`). */
 export interface ApiWarningDetail {
     /** Warning text (`bc` errorformat). */
-    warnings?: string;
+    warnings: string;
 }
 /**
  * Warnings shape, polymorphic on `errorformat`:

package/dist/extensions/babel.d.ts

@@ -22,7 +22,7 @@
 /**
  * A `meta=babel` result: language code → Babel level string (e.g. `"N"`, `"1"`…
  * `"5"`). Site-configured, so the key set is open. An unknown user is an
- * {@link ApiErrorResponse}, not this type.
+ * `ApiErrorResponse`, not this type.
  */
 export type ApiBabelResult = Record<string, string>;
 declare module "types-mediawiki-response" {

package/dist/extensions/globalblocks.d.ts

@@ -111,10 +111,44 @@ export interface ApiGlobalBlockResult {
     /** Block expiry, or `infinite`. */
     expiry?: BlockExpiry;
 }
-/** Response of `action=globalblock`. */
+/**
+ * One entry of the legacy `error.globalblock` array that `action=globalblock`
+ * writes when a block or unblock fails. Unlike every other module, this one
+ * reports the failure **in-band** under the root `error` key
+ * (`{ error: { globalblock: [...] } }`) instead of a top-level error object, so
+ * that `error` carries no `code`/`info`. The shape is the same under every
+ * `errorformat`.
+ */
+export interface ApiGlobalBlockLegacyError {
+    /** Machine-readable code, e.g. `globalblocking-notblocked`. */
+    code: string;
+    /** Rendered message text. */
+    message: string;
+}
+/**
+ * Failure response of `action=globalblock`: the legacy `error.globalblock`
+ * array, written under the root `error` key rather than as a standard
+ * `ApiErrorResponse` — see {@link ApiGlobalBlockLegacyError}.
+ */
+export interface ApiGlobalBlockErrorResponse extends ApiEnvelope {
+    /** The failures, one entry per message. */
+    error: {
+        globalblock: ApiGlobalBlockLegacyError[];
+    };
+}
+/**
+ * Response of `action=globalblock`. A failed block/unblock is reported in-band
+ * under the root `error` key; with `alsolocal=1`, a failed **local** block is
+ * reported the same way while the global block still succeeds, so both keys can
+ * appear together — see {@link ApiGlobalBlockLegacyError}.
+ */
 export interface ApiGlobalBlockResponse extends ApiEnvelope {
     /** Result of `action=globalblock`. */
     globalblock: ApiGlobalBlockResult;
+    /** Legacy errors, when the global block succeeded but the local one failed. */
+    error?: {
+        globalblock: ApiGlobalBlockLegacyError[];
+    };
 }
 declare module "types-mediawiki-response" {
     interface ApiQueryResult {

package/dist/extensions/scribunto.d.ts

@@ -11,7 +11,7 @@
  * fv2 notes: `ApiScribuntoConsole` writes its result keys at the **root** of the
  * response (`addValue( null, $key, $value )`), not under a `scribunto-console`
  * wrapper. A Lua failure is reported **in band** — `type: "error"` with `html` /
- * `message` / `messagename` — rather than as an {@link ApiErrorResponse}; only
+ * `message` / `messagename` — rather than as an `ApiErrorResponse`; only
  * transport-level problems (missing `token`, oversized session …) surface as a
  * real error. `type: "normal"` carries `print` (captured `print()` output) and
  * `return` (the stringified returned value); a question with no `return` yields an

package/dist/extensions/thanks.d.ts

@@ -10,7 +10,7 @@
  *
  * A successful response is a top-level `result` object (not a `thank` key);
  * every failure (invalid revision, self-thanks, rate limit …) is a top-level
- * {@link ApiErrorResponse}. `success` is the number `1`.
+ * `ApiErrorResponse`. `success` is the number `1`.
  *
  * @see https://www.mediawiki.org/wiki/Extension:Thanks
  */

package/dist/extensions/wikilove.d.ts

@@ -14,7 +14,7 @@
  * revision through a deferred update; when Flow or Liquid Threads owns the talk
  * page the module posts through that extension and applies no tag. Failures
  * (unknown target, blocked talk page, …) are top-level
- * {@link ApiErrorResponse}s.
+ * `ApiErrorResponse`s.
  *
  * fv2 notes: the reply is a single `redirect` object at the root — not a
  * `result` wrapper; `pageName` is the DB key form (underscores).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "types-mediawiki-response",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "TypeScript type definitions for MediaWiki Action API responses",
   "keywords": [
     "action-api",
@@ -47,11 +47,12 @@
     "test": "pnpm run typecheck",
     "audit:literals": "tsx scripts/audit-literals.ts",
     "audit:paraminfo": "tsx scripts/audit-paraminfo.ts",
-    "check": "pnpm run format:check && pnpm run lint && pnpm run test && pnpm run audit:literals && pnpm run audit:paraminfo && pnpm run check:ext && pnpm run check:pack",
+    "check": "pnpm run format:check && pnpm run lint && pnpm run test && pnpm run audit:literals && pnpm run audit:paraminfo && pnpm run check:ext && pnpm run check:pack && pnpm run check:examples",
     "prepublishOnly": "pnpm run build",
     "fetch:fixtures": "tsx scripts/fetch-fixtures.ts",
     "fetch:paraminfo": "tsx scripts/fetch-paraminfo.ts",
     "check:ext": "tsx scripts/check-ext-consumer.ts",
+    "check:examples": "pnpm run build && pnpm --filter ./examples/* run typecheck",
     "check:pack": "pnpm run build && attw --pack .",
     "release": "pnpm run check && bumpp",
     "docs:dev": "pnpm --filter types-mediawiki-response-docs dev",
@@ -60,11 +61,11 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.5",
-    "@types/node": "^20.19.43",
+    "@types/node": "^26.6.3",
     "bumpp": "^12.3.0",
     "expect-type": "1.4.0",
-    "oxfmt": "0.70.0",
-    "oxlint": "1.85.0",
+    "oxfmt": "0.71.0",
+    "oxlint": "1.86.0",
     "tsx": "^4.23.13",
     "typescript": "^7.0.2"
   },