types-mediawiki-response 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BearBin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# types-mediawiki-response
+
+English | [简体中文](https://github.com/BearBin1215/types-mediawiki-response/blob/main/README.zh.md) | [Document](https://bearbin1215.github.io/types-mediawiki-response/)
+
+Reusable typings for MediaWiki Action API responses.
+
+- **Pure types**: type declarations only — no impact on your bundle size.
+- **Cross-version**: field union spanning MediaWiki 1.39–1.47.
+- **JSDoc coverage**: every field annotated with its parameter and semantics; hover in your IDE and it is there.
+- **Bundled extensions**: extension fields are opt-in (see [Extensions](#extensions)).
+
+## Installation
+
+```bash
+npm install -D types-mediawiki-response
+```
+
+## Usage
+
+Import the response type for the `action` you called:
+
+```ts
+import type { ApiQueryResponse } from "types-mediawiki-response";
+
+const res = (await api.get({
+  action: "query",
+  prop: "revisions",
+  titles,
+  formatversion: "2",
+})) as ApiQueryResponse;
+```
+
+Wrap with `ApiResponseWith<T>` to get the full error response type — see the [envelope and error handling guide](https://bearbin1215.github.io/types-mediawiki-response/guide/errors.html).
+
+When using `ApiQueryResponse`, `query.pages[]` in the response is the union of every covered `prop=` field; project it with `QueryPage<K>` to scope a page to the props you requested — see the [query responses guide](https://bearbin1215.github.io/types-mediawiki-response/guide/query.html).
+
+## Extensions
+
+Extension response types ship as opt-in packs under `types-mediawiki-response/ext/*`. The fields a pack adds to query responses are activated by a one-line type import:
+
+```ts
+// mw-extensions.d.ts — declared once per repository, in any file covered by your tsconfig
+import type {} from "types-mediawiki-response/ext/flaggedrevs";
+import type {} from "types-mediawiki-response/ext/globalusage";
+```
+
+The augmentation applies to the whole project, after which field types such as `page.flagged` / `query.notifications` are added where they belong.
+
+An extension action (`action=thank`, `action=wikilove`, …) instead exports a standalone response type — import it by name where you call it, like any core action:
+
+```ts
+import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks";
+
+const res = (await api.post({ action: "thank", rev })) as ApiThankResponse;
+```
+
+Bundled packs are listed in the [extension packs guide](https://bearbin1215.github.io/types-mediawiki-response/guide/ext-packs.html). Extensions this package does not cover can be augmented the same way with a hand-written `declare module 'types-mediawiki-response' { … }`.

package/README.zh.md

@@ -0,0 +1,57 @@
+# types-mediawiki-response
+
+[English](https://github.com/BearBin1215/types-mediawiki-response/blob/main/README.md) | 简体中文 | [在线文档](https://bearbin1215.github.io/types-mediawiki-response/zh/)
+
+为 MediaWiki Action API 响应提供可复用类型。
+
+- **纯类型**：产物仅类型声明，不影响产物体积。
+- **跨版本支持**：覆盖 MediaWiki 1.39–1.47 的字段并集。
+- **JSDoc 覆盖**：逐字段标注参数与语义，IDE 悬停即文档。
+- **内置扩展**：支持按需引入扩展内容（见[扩展](#扩展)）。
+
+## 安装
+
+```bash
+npm install -D types-mediawiki-response
+```
+
+## 用法
+
+按调用的 `action` 导入对应响应类型：
+
+```ts
+import type { ApiQueryResponse } from "types-mediawiki-response";
+
+const res = (await api.get({
+  action: "query",
+  prop: "revisions",
+  titles,
+  formatversion: "2",
+})) as ApiQueryResponse;
+```
+
+可用 `ApiResponseWith<T>` 包装以获得含错误结果的响应类型，见文档[信封与错误处理指南](https://bearbin1215.github.io/types-mediawiki-response/zh/guide/errors.html)。
+
+使用 `ApiQueryResponse` 的情况下，响应里的 `query.pages[]` 类型是所有已覆盖 `prop=` 字段的并集，可用 `QueryPage<K>` 收窄到本次请求的 prop，见文档[query 响应指南](https://bearbin1215.github.io/types-mediawiki-response/zh/guide/query.html)。
+
+## 扩展
+
+扩展响应类型以可选包形式放在 `types-mediawiki-response/ext/*`。扩展往 query 响应中加入的字段通过一行类型导入来激活：
+
+```ts
+// mw-extensions.d.ts —— 每个仓库声明一次，放在任意被 tsconfig include 的文件里
+import type {} from "types-mediawiki-response/ext/flaggedrevs";
+import type {} from "types-mediawiki-response/ext/globalusage";
+```
+
+增广对整个项目生效，此后 `page.flagged` / `query.notifications` 等字段类型就会被添加到对应位置。
+
+扩展的 action（`action=thank`、`action=wikilove` 等）则导出独立响应类型，在调用处按名导入，像核心 action 一样使用：
+
+```ts
+import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks";
+
+const res = (await api.post({ action: "thank", rev })) as ApiThankResponse;
+```
+
+内置包清单见文档站的[扩展包指南](https://bearbin1215.github.io/types-mediawiki-response/zh/guide/ext-packs.html)。本包未覆盖的扩展，手写 `declare module 'types-mediawiki-response' { … }` 走同一接缝增广。

package/dist/common/index.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Shared primitive types used across response modules.
+ */
+/**
+ * MediaWiki boolean-style flags: present as `true` when set, otherwise absent.
+ *
+ * @see https://www.mediawiki.org/wiki/API:JSON_version_2
+ */
+export type Flag = true;
+/**
+ * A MediaWiki timestamp in ISO 8601 format (UTC),
+ * e.g. `2024-01-15T08:30:00Z`.
+ */
+export type Timestamp = string;
+/**
+ * A block of plain text (as opposed to HTML), e.g. a TextExtracts excerpt
+ * requested with `explaintext`. Kept distinct from HTML-bearing string fields.
+ */
+export type PlainText = string;
+/** Namespace index. Negative indexes are pseudo-namespaces. */
+export type NamespaceIndex = number;
+/**
+ * A structured in-band message — a serialized MediaWiki `Message`/`FatalError`
+ * spec (`{ message, params, code, type }`) nested inside an action result
+ * (e.g. password-policy messages, file-backend errors, AuthManager failures).
+ * Distinct from `ApiMessage`, which models the `errorformat`-based envelope.
+ */
+export interface ApiSpecMessage {
+    /** i18n message key, e.g. `passwordtooshort`. */
+    message?: string;
+    /** Parameters substituted into the message (may be numbers). */
+    params?: unknown[];
+    /** Machine-readable code (usually mirrors `message`). */
+    code?: string;
+    /** Severity, e.g. `error`. Open union. */
+    type?: string;
+    /** Pre-rendered HTML, when the server supplies it. */
+    html?: string;
+}
+/**
+ * A watchlist label (`{ id, name }`), as returned by `meta=userinfo`
+ * `uiprop=watchlistlabels`, `prop=info` `inprop=watchlistlabels`,
+ * `list=watchlist` `wlprop=labels`, and echoed by `action=watch`. Requires
+ * `$wgEnableWatchlistLabels`. Emitted as a list; an empty set serializes as `[]`.
+ *
+ * @since MediaWiki 1.46
+ */
+export interface ApiWatchlistLabel {
+    /** Stable numeric label id. */
+    id?: number;
+    /** Label text. */
+    name?: string;
+}
+/**
+ * Content model of a page. **Open union** — known values are autocomplete
+ * sugar only; `(string & {})` accepts any model a response may carry.
+ *
+ * Coverage policy: MediaWiki core models are listed directly; `Scribunto`
+ * is included as the one near-universal extension model; extension packs
+ * promote their own models by augmenting {@link ContentModelExtension}
+ * (e.g. `MassMessageListContent` from the MassMessage pack); consumers may
+ * augment the same interface for site-specific models registered through
+ * `$wgContentModels`.
+ */
+export type ContentModel = "wikitext" | "javascript" | "css" | "json" | "text" | "Scribunto" | ContentModelExtension[keyof ContentModelExtension] | (string & {});
+/**
+ * Augmentation target for content models beyond MediaWiki core: extension
+ * packs and consumers merge members here (each mapping the model name to
+ * itself) to promote them to first-class known values of
+ * {@link ContentModel}.
+ *
+ * @example
+ * // A site-specific model registered through $wgContentModels:
+ * declare module "types-mediawiki-response" {
+ *   interface ContentModelExtension {
+ *     MyModel: "my-model";
+ *   }
+ * }
+ */
+export interface ContentModelExtension {
+}
+/**
+ * Serialization format of a revision slot, e.g. `text/x-wiki`. **Open union**:
+ * known core formats are listed for autocomplete and `(string & {})` keeps the
+ * type forward-compatible with extension-provided formats.
+ */
+export type ContentFormat = "text/x-wiki" | "text/plain" | "text/javascript" | "text/css" | "application/json" | (string & {});

package/dist/core/acquiretempusername.d.ts

@@ -0,0 +1,17 @@
+/**
+ * `action=acquiretempusername` response — acquires a temporary account
+ * username and stashes it in the current session, so that the name is reused
+ * when a later action auto-creates the account (also usable in previews).
+ * Write mode: requires a POST, a logged-out session, temporary-account
+ * auto-creation enabled on the wiki, and the `createaccount` right. Repeated
+ * calls return the same stashed name.
+ *
+ * @see https://www.mediawiki.org/wiki/Help:Temporary_accounts
+ * @since MediaWiki 1.41
+ */
+import type { ApiEnvelope } from "../envelope";
+/** Response of `action=acquiretempusername`. */
+export interface ApiAcquireTempUserNameResponse extends ApiEnvelope {
+    /** The stashed temporary username (e.g. `~2024-9`). */
+    acquiretempusername?: string;
+}

package/dist/core/block.d.ts

@@ -0,0 +1,98 @@
+/**
+ * `action=block` / `action=unblock` responses — (un)blocking a user or IP
+ * range, each returned under a top-level 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.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Block
+ */
+import type { Timestamp } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/** The `block` object of an `action=block` response. */
+export interface ApiBlockResult {
+    /** Blocked user name / IP. */
+    user: string;
+    /** Blocked user id (`0` for IPs / autoblocks). Note the capital `D`. */
+    userID: number;
+    /** Block id. */
+    id: number;
+    /** Expiry timestamp, or `infinite` for an indefinite block. */
+    expiry: Timestamp | "infinite";
+    /** Block reason (echoed back). */
+    reason: string;
+    /** Block only anonymous users editing from an IP address range. */
+    anononly: boolean;
+    /** Prevent new account creation from the blocked user or IP range. */
+    nocreate: boolean;
+    /** Also block the IP addresses this user edits from. */
+    autoblock: boolean;
+    /** Prevent the user from sending email via `Special:Emailuser`. */
+    noemail: boolean;
+    /** Hide the username in logs and contributions. */
+    hidename: boolean;
+    /** Let the blocked user keep editing their own user talk page. */
+    allowusertalk: boolean;
+    /** Add the blocked user's user and talk pages to the blocker's watchlist. */
+    watchuser: boolean;
+    /** Restrict the block to specific pages or namespaces instead of sitewide. */
+    partial: boolean;
+    /** Page restrictions of a partial block; `null` when sitewide. */
+    pagerestrictions: unknown;
+    /** Namespace restrictions of a partial block; `null` when sitewide. */
+    namespacerestrictions: unknown;
+    /**
+     * Expiry applied to the watched user page, present only when the request
+     * passed `watchlistexpiry`; `null` when the page is not actually watched.
+     */
+    watchlistexpiry?: Timestamp | null;
+    /**
+     * Restricted actions of a partial action block; only emitted when
+     * `$wgEnablePartialActionBlocks` is enabled.
+     */
+    actionrestrictions?: string[];
+    /**
+     * When the block was applied, in ISO 8601.
+     *
+     * @since MediaWiki 1.47
+     */
+    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).
+     *
+     * @since MediaWiki 1.46
+     */
+    additionalBlocksStatuses?: Record<string, unknown> | unknown[];
+}
+/** Response of `action=block`. */
+export interface ApiBlockResponse extends ApiEnvelope {
+    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

@@ -0,0 +1,18 @@
+/**
+ * `action=changeauthenticationdata` response — AuthManager flow that changes a
+ * logged-in user's authentication data (e.g. email, password); needs a session
+ * 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).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Changeauthenticationdata
+ */
+import type { ApiEnvelope } from "../envelope";
+/** Response of `action=changeauthenticationdata`. */
+export interface ApiChangeAuthenticationDataResponse extends ApiEnvelope {
+    changeauthenticationdata: {
+        /** Flow outcome; `success` when the change was applied. */
+        status: "success" | (string & {});
+    };
+}

package/dist/core/changecontentmodel.d.ts

@@ -0,0 +1,27 @@
+/**
+ * `action=changecontentmodel` response — changes a page's content model (e.g.
+ * wikitext → JavaScript); requires CSRF and `edit` + `editcontentmodel` rights
+ * (on the page under both the current and the new model). The result keys under
+ * `changecontentmodel`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Changecontentmodel
+ */
+import type { ContentModel } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/** Response of `action=changecontentmodel`. */
+export interface ApiChangeContentModelResponse extends ApiEnvelope {
+    changecontentmodel: {
+        /** `Success` when the model was changed. */
+        result: "Success" | (string & {});
+        /** Page title. */
+        title: string;
+        /** Page id. */
+        pageid: number;
+        /** The content model now in effect. */
+        contentmodel: ContentModel;
+        /** New revision id created by the change. */
+        revid: number;
+        /** Log entry id recorded for the change. */
+        logid: number;
+    };
+}

package/dist/core/checktoken.d.ts

@@ -0,0 +1,28 @@
+/**
+ * `action=checktoken` response — validates a token the client already holds
+ * (e.g. before a write), returning `checktoken.result`. No write side effects.
+ *
+ * `ApiCheckToken` sets `result` to `valid`, `expired` (a token older than
+ * `maxtokenage`), or `invalid`. `generated` is decoded from the submitted
+ * token itself (MediaWiki tokens embed their generation time), so it appears
+ * whenever the token carries a timestamp — an old token reports its own age.
+ * Modeled as an open union for forward compatibility.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Checktoken
+ */
+import type { Timestamp } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/** Result values of {@link ApiCheckTokenResponse}. */
+export type ApiCheckTokenResult = "valid" | "expired" | "invalid" | (string & {});
+/** Response of `action=checktoken`. */
+export interface ApiCheckTokenResponse extends ApiEnvelope {
+    checktoken: {
+        /** Outcome of the token check. */
+        result: ApiCheckTokenResult;
+        /**
+         * ISO-8601 timestamp when the submitted token was generated; present
+         * whenever the token embeds one (including old tokens).
+         */
+        generated?: Timestamp;
+    };
+}

package/dist/core/clearhasmsg.d.ts

@@ -0,0 +1,15 @@
+/**
+ * `action=clearhasmsg` response — clears the "you have new messages" flag on the
+ * current (logged-in) user. The payload is a bare status string under the
+ * `clearhasmsg` key (a `success` value in 1.43; historically an empty string).
+ *
+ * Takes no token; passing one draws an `Unrecognized parameter: token` warning.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Watch#Clearing_the_new_messages_flag
+ */
+import type { ApiEnvelope } from "../envelope";
+/** Response of `action=clearhasmsg`. */
+export interface ApiClearHasMsgResponse extends ApiEnvelope {
+    /** Status string; `success` on 1.43 (older builds returned an empty string). */
+    clearhasmsg: string;
+}

package/dist/core/clientlogin.d.ts

@@ -0,0 +1,48 @@
+/**
+ * `action=clientlogin` response — the recommended login flow (replaces the
+ * deprecated `action=login`), returning a `clientlogin` object.
+ *
+ * `status` drives the flow: `PASS` (logged in), `FAIL`, `UI` (needs further
+ * interaction, e.g. 2FA), `RESTART` (third-party auth succeeded but no local
+ * account exists yet), `REDIRECT` (continue at `redirecttarget`). Which other
+ * fields appear depends on `status` and the `messageformat` parameter.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Client_login
+ */
+import type { ApiAuthManagerMessage, ApiQueryAuthManagerField, ApiQueryAuthManagerInfoRequest } from "./query/authmanagerinfo";
+import type { ApiEnvelope } from "../envelope";
+/** The `clientlogin` object of an `action=clientlogin` response. */
+export interface ApiClientLogin {
+    /** Login outcome. */
+    status?: "PASS" | "FAIL" | "UI" | "REDIRECT" | "RESTART" | (string & {});
+    /** Authenticated user name; `PASS` only. */
+    username?: string;
+    /**
+     * Failure / interaction message, rendered per the `messageformat` parameter:
+     * a string under `wikitext`/`html`, a `{ key, params }` object under `raw`,
+     * absent under `none`. `FAIL`/`UI`/`RESTART` only.
+     */
+    message?: ApiAuthManagerMessage;
+    /** Machine-readable message code accompanying `message`; `FAIL`/`UI`/`RESTART` only. */
+    messagecode?: string;
+    /** URL to continue the flow at. `REDIRECT` only. */
+    redirecttarget?: string;
+    /**
+     * Data for a `REDIRECT` response the client may use to query the remote site
+     * via its API instead of following `redirecttarget`.
+     */
+    redirectdata?: Record<string, unknown>;
+    /** AuthManager request descriptors to continue the flow; `UI`/`RESTART`/`REDIRECT` only. */
+    requests?: ApiQueryAuthManagerInfoRequest[];
+    /**
+     * Field descriptors merged across all `requests`, present only when the
+     * request passed `mergerequestfields`.
+     */
+    fields?: Record<string, ApiQueryAuthManagerField>;
+    /** Whether the current AuthManager state can be preserved across requests; `FAIL`/`RESTART` only. */
+    canpreservestate?: boolean;
+}
+/** Response of `action=clientlogin`. */
+export interface ApiClientLoginResponse extends ApiEnvelope {
+    clientlogin: ApiClientLogin;
+}

package/dist/core/compare.d.ts

@@ -0,0 +1,92 @@
+/**
+ * `action=compare` response — compares two pages/revisions/texts and returns
+ * the result under a top-level `compare` object.
+ *
+ * The rendered diff HTML is `compare.body`, or `compare.bodies` keyed by slot
+ * role when comparing specific slots. Which `from*` / `to*` metadata appear
+ * depends on `prop`; the `*hidden` markers do not.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Compare_pages
+ */
+import type { Flag, Timestamp } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/** The `compare` object of a successful `action=compare` response. */
+export interface ApiCompareResult {
+    /** Diff HTML. `prop=diff`; only when the diff is not split per slot. */
+    body?: string;
+    /**
+     * Per-slot diff bodies, keyed by slot role. `prop=diff` when comparing
+     * specific slots (`fromslots`/`toslots`); takes the place of {@link body}.
+     */
+    bodies?: Record<string, string>;
+    /** Size of the diff HTML in bytes. `prop=diffsize`. */
+    diffsize?: number;
+    /** Revision id preceding the `from` side. `prop=rel`. */
+    prev?: number;
+    /** Revision id following the `to` side. `prop=rel`. */
+    next?: number;
+    /** Page id of the `from` side. `prop=ids`. */
+    fromid?: number;
+    /** Revision id of the `from` side. `prop=ids`. */
+    fromrevid?: number;
+    /** Namespace index of the `from` side. `prop=title`. */
+    fromns?: number;
+    /** Page title of the `from` side. `prop=title`. */
+    fromtitle?: string;
+    /** Revision size in bytes of the `from` side. `prop=size`. */
+    fromsize?: number;
+    /** Timestamp of the `from` revision. `prop=timestamp`. */
+    fromtimestamp?: Timestamp;
+    /** Editor of the `from` revision. `prop=user`. */
+    fromuser?: string;
+    /** Editor user id of the `from` revision. `prop=user`. */
+    fromuserid?: number;
+    /** Edit summary of the `from` revision. `prop=comment`. */
+    fromcomment?: string;
+    /** HTML-rendered summary of the `from` revision. `prop=comment` or `prop=parsedcomment`. */
+    fromparsedcomment?: string;
+    /** The `from` revision's content is hidden (revision-deleted). A {@link Flag}. */
+    fromtexthidden?: Flag;
+    /** The `from` revision's author is hidden. A {@link Flag}. */
+    fromuserhidden?: Flag;
+    /** The `from` revision's summary is hidden. A {@link Flag}. */
+    fromcommenthidden?: Flag;
+    /** Suppression (oversight) applies to the `from` revision, alongside the `*hidden` flags. A {@link Flag}. */
+    fromsuppressed?: Flag;
+    /** The `from` revision was read from the archive (deleted since it was referenced). A {@link Flag}. */
+    fromarchive?: Flag;
+    /** Page id of the `to` side. `prop=ids`. */
+    toid?: number;
+    /** Revision id of the `to` side. `prop=ids`. */
+    torevid?: number;
+    /** Namespace index of the `to` side. `prop=title`. */
+    tons?: number;
+    /** Page title of the `to` side. `prop=title`. */
+    totitle?: string;
+    /** Revision size in bytes of the `to` side. `prop=size`. */
+    tosize?: number;
+    /** Timestamp of the `to` revision. `prop=timestamp`. */
+    totimestamp?: Timestamp;
+    /** Editor of the `to` revision. `prop=user`. */
+    touser?: string;
+    /** Editor user id of the `to` revision. `prop=user`. */
+    touserid?: number;
+    /** Edit summary of the `to` revision. `prop=comment`. */
+    tocomment?: string;
+    /** HTML-rendered summary of the `to` revision. `prop=comment` or `prop=parsedcomment`. */
+    toparsedcomment?: string;
+    /** The `to` revision's content is hidden (revision-deleted). A {@link Flag}. */
+    totexthidden?: Flag;
+    /** The `to` revision's author is hidden. A {@link Flag}. */
+    touserhidden?: Flag;
+    /** The `to` revision's summary is hidden. A {@link Flag}. */
+    tocommenthidden?: Flag;
+    /** Suppression (oversight) applies to the `to` revision, alongside the `*hidden` flags. A {@link Flag}. */
+    tosuppressed?: Flag;
+    /** The `to` revision was read from the archive (deleted since it was referenced). A {@link Flag}. */
+    toarchive?: Flag;
+}
+/** Response of `action=compare`. */
+export interface ApiCompareResponse extends ApiEnvelope {
+    compare: ApiCompareResult;
+}

package/dist/core/createaccount.d.ts

@@ -0,0 +1,41 @@
+/**
+ * `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`.
+ *
+ * These are **in-band** AuthManager outcomes, not a top-level
+ * {@link 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 { ApiEnvelope } from "../envelope";
+/** Response of `action=createaccount`. */
+export interface ApiCreateAccountResponse extends ApiEnvelope {
+    createaccount: {
+        /** AuthManager outcome of the account-creation flow. */
+        status?: ApiAuthManagerStatus;
+        /** Created (or attempted) user name; present on `PASS`. */
+        username?: string;
+        /**
+         * Failure / interaction message, rendered per the `messageformat`
+         * parameter: a string under `wikitext`/`html`, a `{ key, params }` object
+         * under `raw`, absent under `none`. `FAIL`/`UI`/`RESTART` only.
+         */
+        message?: ApiAuthManagerMessage;
+        /** Machine-readable message code (e.g. `invaliduser`). */
+        messagecode?: string;
+        /** Whether the current AuthManager state can be preserved across requests; `FAIL`/`RESTART` only. */
+        canpreservestate?: boolean;
+        /** Redirect target for a `REDIRECT` outcome. */
+        redirecttarget?: string;
+        /** 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>[];
+    };
+}

package/dist/core/delete.d.ts

@@ -0,0 +1,45 @@
+/**
+ * `action=delete` / `action=undelete` responses — page deletion and its undo,
+ * each returned under a top-level object. Requires the `delete` right.
+ *
+ * Under `formatversion=2` a successful delete carries **no `result` key**
+ * (older clients branched on `result: "Success"`).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Delete
+ */
+import type { Flag } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/** The `delete` object of an `action=delete` response. */
+export interface ApiDeleteResult {
+    /** Deleted page title. */
+    title: string;
+    /** Deletion reason (echoed back). */
+    reason: string;
+    /**
+     * The deletion was scheduled for asynchronous processing instead of running
+     * inline (large pages, above `$wgDeleteRevisionsBatchSize`). Mutually
+     * exclusive with {@link logid}: a scheduled deletion has no log entry yet.
+     */
+    scheduled?: Flag;
+    /** Log id of the new deletion log entry. */
+    logid?: number;
+}
+/** Response of `action=delete`. */
+export interface ApiDeleteResponse extends ApiEnvelope {
+    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;
+}