types-mediawiki-response 1.0.0-alpha.1

package/dist/extensions/templatedata.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Opt-in extension pack: **TemplateData** (`action=templatedata`).
+ *
+ * Not in the default export. Standalone action response — import it directly:
+ *
+ * ```ts
+ * import type { ApiTemplateDataResponse } from 'types-mediawiki-response/ext/templatedata';
+ * ```
+ *
+ * `pages` is a **map keyed by page id** (a negative id for each missing title),
+ * not an array. Only pages carrying the `templatedata` page prop are listed;
+ * `includeMissingTitles=1` additionally returns titles that do not exist
+ * (`missing: true`) and existing pages without a `<templatedata>` block
+ * (`notemplatedata: true`), whose `params` hold just the parameter names
+ * extracted from the raw wikitext. Because `maps` is a PHP map, an empty one
+ * arrives as `[]` under `formatversion=2`.
+ *
+ * The InterfaceText fields (`label`, `description`, `default`, `example`, set
+ * labels) arrive as objects keyed by language code; passing `lang` resolves
+ * each one to a single string (requested language, then its fallbacks, then
+ * the site content language). `inherits` links between parameters are
+ * resolved when the blob is saved and never appear in a response. A corrupted
+ * block surfaces as the `templatedata-corrupt` error rather than as a page
+ * entry.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:TemplateData
+ */
+import type { ApiQueryContinue, ApiQueryNormalized } from "../core/query";
+import type { ApiRedirect } from "../core/query/redirects";
+import type { ApiEnvelope } from "../envelope";
+/**
+ * Parameter type a template expects, as accepted by the validator (`content`,
+ * `line`, `number`, `boolean`, `string`, `date`, `unbalanced-wikitext`,
+ * `unknown`, `url`, `wiki-page-name`, `wiki-user-name`, `wiki-file-name`,
+ * `wiki-template-name`). Hook handlers may register additional names, so
+ * consumers must tolerate values outside this list.
+ */
+export type TemplateDataType = "boolean" | "content" | "date" | "line" | "number" | "string" | "unbalanced-wikitext" | "unknown" | "url" | "wiki-file-name" | "wiki-page-name" | "wiki-template-name" | "wiki-user-name" | (string & {});
+/**
+ * InterfaceText as served: a map keyed by language code (`{"en": "Nowrap?"}`).
+ * A plain string only when the request passes `lang`, which resolves each text
+ * to a single language (requested language, then its fallbacks, then the site
+ * content language).
+ */
+export type ApiTemplateDataText = string | Record<string, string>;
+/** One parameter description (`params.<name>`). */
+export interface ApiTemplateDataParam {
+    /** Display label. */
+    label?: ApiTemplateDataText | null;
+    /** Longer explanation shown to editors. */
+    description?: ApiTemplateDataText | null;
+    /** The template does not work without it. Defaults to `false`. */
+    required?: boolean;
+    /** Worth filling in but not mandatory. Defaults to `false`. */
+    suggested?: boolean;
+    /**
+     * Discouraged. Either a boolean or, better, the text explaining what to use
+     * instead.
+     */
+    deprecated?: boolean | string;
+    /** Other names this parameter answers to. */
+    aliases?: string[];
+    /** Expected kind of the value. */
+    type?: TemplateDataType;
+    /** Value auto-inserted when the parameter is used, e.g. `{{subst:CURRENTYEAR}}`. */
+    autovalue?: string | null;
+    /** Assumed value when the parameter is absent from a transclusion. */
+    default?: ApiTemplateDataText | null;
+    /** Commonly used values offered as completion; free text stays allowed. */
+    suggestedvalues?: string[];
+    /** Example value shown to help editors. */
+    example?: ApiTemplateDataText | null;
+}
+/** A group of parameters presented together (`sets[]`). */
+export interface ApiTemplateDataSet {
+    /** Set label. Required by the validator, so always present. */
+    label: ApiTemplateDataText;
+    /** Names of the parameters this set groups. Required and non-empty. */
+    params: string[];
+}
+/**
+ * A consumer-specific mapping (`maps.<consumer>`). Keys are consumer-defined
+ * and not validated; each value references parameters of the template — a
+ * parameter name, a list of names, or a list of lists of names.
+ */
+export type ApiTemplateDataMap = Record<string, string | string[] | string[][]>;
+/** The stored TemplateData block of one template. */
+export interface ApiTemplateDataRoot {
+    /** One-line description of the template. */
+    description?: ApiTemplateDataText | null;
+    /**
+     * Parameter descriptions, keyed by parameter name. Full objects for pages
+     * with TemplateData; for `notemplatedata` pages only the names extracted
+     * from raw wikitext, each mapping to an empty entry.
+     */
+    params?: Record<string, ApiTemplateDataParam | unknown[]> | unknown[];
+    /**
+     * Parameter order for display — a complete permutation of the keys of
+     * `params`; the validator rejects a partial or duplicated list.
+     */
+    paramOrder?: string[];
+    /**
+     * Parameter groups. An **array** of {@link ApiTemplateDataSet} (the stored
+     * shape; a map there is rejected with `templatedata-invalid-type`).
+     */
+    sets?: ApiTemplateDataSet[];
+    /** Consumer-specific maps, keyed by consumer identifier. */
+    maps?: Record<string, ApiTemplateDataMap> | unknown[];
+    /** Preferred transclusion layout, or a FormatString. */
+    format?: "inline" | "block" | (string & {}) | null;
+}
+/** One entry of `pages`, keyed by page id. */
+export interface ApiTemplateDataPage extends ApiTemplateDataRoot {
+    /** Page title. */
+    title?: string;
+    /** `true` for a requested title that does not exist. */
+    missing?: true;
+    /** `true` when the page exists but carries no `<templatedata>` block. */
+    notemplatedata?: true;
+}
+/** Response of `action=templatedata`. */
+export interface ApiTemplateDataResponse extends ApiEnvelope {
+    continue?: ApiQueryContinue;
+    /** Title normalizations applied to the request. */
+    normalized?: ApiQueryNormalized[];
+    /** Redirects followed to reach the requested titles. */
+    redirects?: ApiRedirect[];
+    /** Entries keyed by page id (negative for missing titles). */
+    pages: Record<string, ApiTemplateDataPage>;
+}

package/dist/extensions/thanks.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Opt-in extension pack: **Thanks** (`action=thank`).
+ *
+ * Not in the default export. This is a standalone action response — import and use
+ * it directly (no declaration merging needed):
+ *
+ * ```ts
+ * import type { ApiThankResponse } from 'types-mediawiki-response/ext/thanks';
+ * ```
+ *
+ * `ApiCoreThank::markResultSuccess` writes a top-level `result` object (not a
+ * `thank` key); every failure (invalid revision, self-thanks, rate limit …) is a
+ * top-level {@link ApiErrorResponse} via `dieWithError`, so the success shape is
+ * the only body. `success` is the number `1`.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:Thanks
+ */
+import type { ApiEnvelope } from "../envelope";
+/** The `result` object of a successful `action=thank`. */
+export interface ApiThankResult {
+    /** `1` when the thanks was recorded (also for a duplicate thanks, which pretends success). */
+    success: number;
+    /** Canonical name of the thanked user. */
+    recipient: string;
+}
+/** Response of `action=thank`. */
+export interface ApiThankResponse extends ApiEnvelope {
+    result: ApiThankResult;
+}

package/dist/extensions/timedmediahandler.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Opt-in extension pack: **TimedMediaHandler** (audio/video;
+ * `prop=videoinfo`, `prop=transcodestatus`, `action=transcodereset`).
+ *
+ * Not in the default export: importing anything from this file — even just the
+ * field-group type you are about to use — activates the augmentation shipped at
+ * the bottom, which merges the field groups into the root package automatically
+ * (no manual `declare module`):
+ *
+ * ```ts
+ * import type {} from 'types-mediawiki-response/ext/timedmediahandler';
+ * ```
+ *
+ * `action=timedtext` is deliberately not modeled: it serves the raw subtitle
+ * text through `ApiFormatRaw` (an srt/vtt body, not a JSON object).
+ *
+ * fv2 notes: `transcodestatus` maps each transcode key to the raw `transcode`
+ * table row (minus `id`/`image_name`/`key`); its `time_*` keys are nullable
+ * 14-digit MediaWiki timestamps (`null` — not omission — when the step has not
+ * run) and `final_bitrate` passes the DB column through uncast, so it may be a
+ * number or a string depending on the database driver. A file without
+ * transcodes reports `[]`, since PHP's empty map serializes as an array.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:TimedMediaHandler
+ */
+import type { ApiEnvelope } from "../envelope";
+import type { ApiImageInfo } from "../core/query/imageinfo";
+/**
+ * One source of a video's `derivatives` list (the original file first, then
+ * each ready transcode). Audio files report `width`/`height` as `0`.
+ */
+export interface ApiVideoSource {
+    /** Direct URL to the file / transcode. */
+    src?: string;
+    /** MIME type, e.g. `video/webm; codecs="vp9, opus"`. */
+    type?: string;
+    /** Transcode key of a derivative (absent for the original file source). */
+    transcodekey?: string;
+    /** Video width in pixels (`0` for audio). */
+    width?: number;
+    /** Video height in pixels (`0` for audio). */
+    height?: number;
+    /** Average bandwidth in bit/s, when the handler reports one. */
+    bandwidth?: number;
+    /**
+     * Human-readable label, carried only by the HLS playlist source
+     * (`transcodekey` `m3u8`).
+     */
+    title?: string;
+    /** Short form of {@link title}. */
+    shorttitle?: string;
+}
+/** One subtitle track of `viprop=timedtext` (one entry per track format). */
+export interface ApiVideoTimedTextTrack {
+    /**
+     * URL of the subtitle stream (an `action=timedtext` API URL, already carrying
+     * `origin=*` for cross-origin playback).
+     */
+    src?: string;
+    /** Track kind; `subtitles` for text tracks TMH generates. */
+    kind?: "subtitles" | (string & {});
+    /** MIME type of the track, e.g. `text/x-srt` or `text/vtt`. */
+    type?: string;
+    /** Track language (BCP 47). */
+    srclang?: string;
+    /** Text direction of the track language, `ltr` or `rtl`. */
+    dir?: "ltr" | "rtl" | (string & {});
+    /** Human-readable track label including the language name. */
+    label?: string;
+}
+/**
+ * One video-info entry for a file page: the imageinfo fields (`viprop` mirrors
+ * the `iiprop` names) plus TMH's `derivatives` and `timedtext` lists.
+ */
+export interface ApiVideoInfo extends ApiImageInfo {
+    /** Original file source followed by every ready transcode. `viprop=derivatives`. */
+    derivatives?: ApiVideoSource[];
+    /**
+     * Available subtitle tracks (one per language and format); `[]` when the file
+     * has none. `viprop=timedtext`.
+     */
+    timedtext?: ApiVideoTimedTextTrack[];
+}
+/**
+ * One transcode state of `prop=transcodestatus`, keyed by transcode key (e.g.
+ * `240p.vp9.webm`) on the file page. The keys mirror the `transcode` table
+ * columns with the `transcode_` prefix stripped.
+ */
+export interface ApiTranscodeState {
+    /** Error output of the transcode run; `""` unless the transcode failed. */
+    error?: string;
+    /** When the job was queued; a 14-digit MediaWiki timestamp or `null`. */
+    time_addjob?: string | null;
+    /** When the job started working; a 14-digit MediaWiki timestamp or `null`. */
+    time_startwork?: string | null;
+    /** When the transcode finished; a 14-digit MediaWiki timestamp or `null`. */
+    time_success?: string | null;
+    /** When the transcode failed; a 14-digit MediaWiki timestamp or `null`. */
+    time_error?: string | null;
+    /**
+     * Achieved bitrate in bit/s of the finished transcode, passed through from
+     * the database uncast — may be a number or a numeric string.
+     */
+    final_bitrate?: number | string;
+}
+/** Response of `action=transcodereset` (requires the `transcode-reset` right). */
+export interface ApiTranscodeResetResponse extends ApiEnvelope {
+    /** `removed transcode` on success; failures are top-level error responses. */
+    success?: string;
+}
+declare module "types-mediawiki-response" {
+    interface ApiPage {
+        /** File info extended with video sources and subtitle tracks. */
+        videoinfo?: ApiVideoInfo[];
+        /**
+         * Per-transcode job states, keyed by transcode key; `[]` — an empty array,
+         * not an empty object — when the file has no transcodes at all.
+         */
+        transcodestatus?: Record<string, ApiTranscodeState> | unknown[];
+    }
+}

package/dist/extensions/titleblacklist.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Opt-in extension pack: **TitleBlacklist** (`action=titleblacklist`).
+ *
+ * Not in the default export. Standalone action response — import it directly:
+ *
+ * ```ts
+ * import type { ApiTitleBlacklistResponse } from 'types-mediawiki-response/ext/titleblacklist';
+ * ```
+ *
+ * `ApiTitleBlacklist` reports the check under `titleblacklist`: `result` is `ok`
+ * (no match) or `blacklisted`; on a match it returns the offending `line` plus a
+ * human `reason` and the `message` key.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:TitleBlacklist
+ */
+import type { ApiEnvelope } from "../envelope";
+/** Response of `action=titleblacklist`. */
+export interface ApiTitleBlacklistResponse extends ApiEnvelope {
+    titleblacklist: {
+        /** Whether the title matched the blacklist. Open union for forward compat. */
+        result: "ok" | "blacklisted" | (string & {});
+        /** Reason shown to the user (parsed HTML or plain text); only on a match. */
+        reason?: string;
+        /** Message key of the match: the entry's custom message when set, else `titleblacklist-forbidden-{action}` (`create` uses the `edit` variant). Only on a match. */
+        message?: string;
+        /** The matching blacklist line, HTML-escaped. Only on a match. */
+        line?: string;
+    };
+}

package/dist/extensions/urlshortener.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Opt-in extension pack: **UrlShortener** (`action=shortenurl`).
+ *
+ * A standalone action response — import and use it directly (no declaration
+ * merging needed):
+ *
+ * ```ts
+ * import type { ApiShortenUrlResponse } from 'types-mediawiki-response/ext/urlshortener';
+ * ```
+ *
+ * Requires the `urlshortener-create-url` right (granted to all users by
+ * default) and that the target URL matches `$wgUrlShortenerAllowedDomains`;
+ * disallowed domains are top-level `ApiErrorResponse`s. The short URL template
+ * follows `$wgUrlShortenerTemplate` / `$wgUrlShortenerServer`. On wikis with
+ * QR codes enabled, `qrcode=1` returns the code as SVG markup in `qrcode`, and
+ * the short URL keys are then omitted unless the URL was long enough to need
+ * shortening.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:UrlShortener
+ */
+import type { ApiEnvelope } from "../envelope";
+/** The `shortenurl` object of an `action=shortenurl` response. */
+export interface ApiShortenUrlResult {
+    /** Full short URL carrying the base-32 short code. */
+    shorturl?: string;
+    /**
+     * Alternative short URL using the alternate code mapping (a string whose
+     * characters are individually base-32-shifted), kept valid in parallel.
+     */
+    shorturlalt?: string;
+    /**
+     * SVG markup of a QR code encoding the target URL, when `qrcode=1` was passed
+     * and the wiki has QR codes enabled.
+     *
+     * @since MediaWiki 1.41
+     */
+    qrcode?: string;
+}
+/** Response of `action=shortenurl`. */
+export interface ApiShortenUrlResponse extends ApiEnvelope {
+    shortenurl: ApiShortenUrlResult;
+}

package/dist/extensions/visualeditor.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Opt-in extension pack: **VisualEditor** (`action=visualeditor`,
+ * `action=visualeditoredit`, `action=editcheckreferenceurl`).
+ *
+ * Not in the default export. Standalone action responses — import what you need:
+ *
+ * ```ts
+ * import type { ApiVisualEditorResponse } from 'types-mediawiki-response/ext/visualeditor';
+ * ```
+ *
+ * `paction` selects which fields appear, and both modules write at the **root**
+ * of the envelope (next to `query`, not inside it):
+ * * `metadata` → the edit-form frame only (`canEdit`, `blockinfo`, timestamps…);
+ * * `wikitext` / `parse` → add `content` (+ `preloaded`); `parsefragment`
+ *   returns only `{ result, content }`;
+ * * `templatesused` → `visualeditor` is a bare HTML **string** (a
+ *   `<div class="templatesUsed">` block), not the usual object.
+ *
+ * `notices` and `blockinfo` show the two classic PHP-to-JSON traps: `notices` is
+ * a message-keyed map once populated but an empty **array** when there are none,
+ * and `blockinfo` is `null` rather than absent for an unblocked user.
+ *
+ * `action=visualeditoredit` requires a `paction` parameter selecting the
+ * operation (`save`, `diff`, `serialize`, `serializeforcache`). `save` returns
+ * the same page-frame shape as an `action=edit`-style response; `serialize*` need
+ * `html` rather than a page; `page` is required throughout — a title that does
+ * not exist yet is fine, but omitting `page` is a `missingparam` error.
+ *
+ * These are internal modules (`isInternal`), not part of the published API
+ * surface. Permission failures from the Parsoid render step surface as the
+ * REST-layer `rest-permission-error` error, not as a `blockinfo` field.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:VisualEditor
+ */
+import type { Flag, Timestamp } from "../common";
+import type { ApiEditResult } from "../core/edit";
+import type { ApiEnvelope } from "../envelope";
+/** One field of the edit form (`checkboxesDef.wpMinoredit`, `wpWatchthis`, `wpWatchlistExpiry`). */
+export interface ApiVisualEditorCheckboxDef {
+    /** Element id, e.g. `wpMinoredit`. */
+    id?: string;
+    /** Message key holding the label. */
+    "label-message"?: string;
+    /** Message key for the label's `title` attribute; hook-provided checkboxes only. */
+    "title-message"?: string;
+    /** DOM id of the labelled element. */
+    "label-id"?: string;
+    /** Legacy form field name. */
+    "legacy-name"?: string;
+    /** Access-key/tooltip message slug, e.g. `minoredit`. */
+    tooltip?: string;
+    /** PHP class of the OOUI widget; set for the `wpWatchlistExpiry` dropdown. */
+    class?: string;
+    /** Dropdown options as label/value pairs (`wpWatchlistExpiry` only). */
+    options?: {
+        data?: string;
+        label?: string;
+    }[];
+    /** Widget config option carrying the current value (`wpWatchlistExpiry` only). */
+    "value-attr"?: string;
+    /** Label rendered invisibly (`wpWatchlistExpiry` only). */
+    invisibleLabel?: true;
+    /**
+     * Whether the box starts checked — or the preselected expiry string for the
+     * `wpWatchlistExpiry` dropdown. A real `boolean` under fv2 for checkboxes.
+     */
+    default?: boolean | string;
+}
+/**
+ * `lastModified` display parts of the edited page, as emitted by
+ * `action=visualeditor`/`visualeditoredit` and by DiscussionTools'
+ * `discussiontoolsedit` (both render the same last-modified widget data).
+ */
+export interface ApiLastModified {
+    /** Localized date, e.g. `15 January 2024`. */
+    date?: string;
+    /** Localized time, e.g. `18:34`. */
+    time?: string;
+    /** Full sentence combining both. */
+    message?: string;
+}
+/** The page frame both `visualeditor` and `visualeditoredit` return. */
+export interface ApiVisualEditorPageFrame {
+    /** Outcome of the request; `error` on the save-failure branch. */
+    result?: "success" | "error" | (string & {});
+    /** Rendered page body (HTML for `parse`, wikitext for `wikitext`). */
+    content?: string;
+    /** Whether {@link content} came from a preload rather than the page. */
+    preloaded?: boolean;
+    /** Page subtitle ("Revision as of …") HTML. */
+    contentSub?: string;
+    /** Display title HTML. */
+    displayTitleHtml?: string;
+    /** Category bar HTML. */
+    categorieshtml?: string;
+    /** Section index of the edited/loaded page. */
+    sections?: unknown[];
+    /** ResourceLoader modules the response needs. */
+    modules?: string[];
+    /** ResourceLoader config variables (e.g. `wgEchoSeenTime`). */
+    jsconfigvars?: Record<string, unknown>;
+    /**
+     * Empty string for a normal page — this is the legacy empty-string flag
+     * pattern rather than a boolean.
+     */
+    isRedirect?: string;
+    /** When the page last changed, in display parts. */
+    lastModified?: ApiLastModified;
+    /** New revision id, from `visualeditoredit` `paction=save`. */
+    newrevid?: number;
+    /** Whether the editor watches the page now. */
+    watched?: boolean;
+    /** When that watch expires; `null` when permanent. */
+    watchlistexpiry?: Timestamp | null;
+    /** HTML diff, from `visualeditoredit` `paction=diff`. */
+    diff?: string;
+    /** Key into the serialisation cache, from `visualeditoredit` `paction=serializeforcache`. */
+    cachekey?: string;
+    /** `true` when the save asked to skip the re-render (`nocontent` parameter), so no `content` follows. */
+    nocontent?: Flag;
+    /** The underlying `action=edit` result, on the save failure branch (`result: "error"`). */
+    edit?: ApiEditResult;
+    /** `true` when a temporary account was created by this edit. */
+    tempusercreated?: Flag;
+    /** Redirect URL for a just-created temporary account, when one applies. */
+    tempusercreatedredirect?: string;
+}
+/**
+ * Response of `action=visualeditor` for `paction=parse`, `wikitext` and
+ * `metadata`, which share one payload. The other `paction` values return
+ * different shapes — see {@link ApiVisualEditorTemplatesUsedResponse} and
+ * {@link ApiVisualEditorParseFragmentResponse}.
+ */
+export interface ApiVisualEditorResponse extends ApiEnvelope {
+    visualeditor: ApiVisualEditorPageFrame & {
+        /**
+         * Notices the editor should show above the form, keyed by message name
+         * (e.g. `newarticletext` for a page that does not exist yet). An empty PHP
+         * map, so `[]` when there is nothing to show.
+         */
+        notices: Record<string, string> | unknown[];
+        /** Copyright warning HTML; `""` when none applies. */
+        copyrightWarning: string;
+        /** Definitions of the save-form fields, keyed by element id. */
+        checkboxesDef: Record<string, ApiVisualEditorCheckboxDef>;
+        /** Plain text of the messages referenced by `checkboxesDef`. */
+        checkboxesMessages: Record<string, string>;
+        /** CSS classes for protection state, joined into one string (`""` when none). */
+        protectedClasses: string;
+        /** Base timestamp for edit-conflict detection. */
+        basetimestamp: Timestamp;
+        /** Server timestamp when the request started. */
+        starttimestamp: Timestamp;
+        /** Revision id the content was taken from. */
+        oldid: number;
+        /** Block state of the requesting user; `null` when not blocked. */
+        blockinfo: Record<string, unknown> | null;
+        /**
+         * Whether an auto-created temporary account would be used for the edit.
+         *
+         * @since MediaWiki 1.41
+         */
+        wouldautocreate?: boolean;
+        /** Whether the user may edit this page at all. */
+        canEdit: boolean;
+        /** Restbase/Parsoid ETag for conditional requests. */
+        etag?: string;
+    };
+}
+/**
+ * Response of `action=visualeditor` with `paction=templatesused`, where the
+ * module writes an HTML string instead of the usual object.
+ */
+export interface ApiVisualEditorTemplatesUsedResponse extends ApiEnvelope {
+    visualeditor: string;
+}
+/**
+ * Response of `action=visualeditor` with `paction=parsefragment`: just the
+ * transformed fragment and the outcome flag.
+ */
+export interface ApiVisualEditorParseFragmentResponse extends ApiEnvelope {
+    visualeditor: {
+        /** Outcome of the transform. */
+        result: "success" | (string & {});
+        /** Transformed wikitext fragment. */
+        content: string;
+    };
+}
+/**
+ * Response of `action=visualeditoredit`.
+ */
+export interface ApiVisualEditorEditResponse extends ApiEnvelope {
+    visualeditoredit: ApiVisualEditorPageFrame;
+}
+/**
+ * Response of `action=editcheckreferenceurl`: the verdict for the checked URL —
+ * `"allowed"` or `"blocked"`. Always exactly one entry, keyed by the requested
+ * URL.
+ *
+ * @since MediaWiki 1.42
+ */
+export interface ApiEditCheckReferenceUrlResponse extends ApiEnvelope {
+    editcheckreferenceurl: Record<string, "allowed" | "blocked" | (string & {})>;
+}

package/dist/extensions/wikibase.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Opt-in extension pack: **Wikibase** (`meta=wikibase`, `prop=pageterms`,
+ * `prop=wbentityusage`, `list=wblistentityusage`).
+ *
+ * Not in the default export: importing anything from this file — even just the
+ * field-group type you are about to use — activates the augmentation shipped at
+ * the bottom, which merges the field groups into the root package automatically
+ * (no manual `declare module`):
+ *
+ * ```ts
+ * import type {} from 'types-mediawiki-response/ext/wikibase';
+ * ```
+ *
+ * These are the **client-side** Wikibase modules (a wiki linked to a repo wiki);
+ * the entity read/write actions (`wbgetentities`, …) live on the repo
+ * and are out of scope. fv2 notes:
+ *
+ * * `prop=pageterms` (`wbpt`) puts `terms` on each page, keyed by term type and
+ *   holding a `string[]` (aliases always plural, label/description a one-element
+ *   list). Only the three known types occur; a page without a linked entity gets
+ *   no `terms`.
+ * * `prop=wbentityusage` (`wbeu`) and the per-row `wblistentityusage` both return
+ *   a **map keyed by entity id** (`{ "Q84": { … } }`), not an array. An `aspects`
+ *   entry is an opaque code, often compound — `"CQR"`, `"D.en"`, `"S"`, `"T"`,
+ *   `"O"` — so it is modeled as an open `string[]`, not the `S|L|D|T|C|X|O` the
+ *   `wbleuaspect`/`wbeuaspect` *filter* accepts. `url` appears only with `…prop=url`.
+ * * `list=wblistentityusage` (`wbleu`) lands under **`query.entityusage`** (not a
+ *   `wblistentityusage` key); each row is a page carrying the usage map under the
+ *   `wblistentityusage` key. Continuation uses `wbleucontinue` (covered by the
+ *   core continuation index signature).
+ *
+ * @see https://www.mediawiki.org/wiki/Wikibase/API
+ */
+import type { NamespaceIndex } from "../common";
+/** A single entity's usage record: which aspects were used, and an optional repo link. */
+export interface ApiEntityUsage {
+    /**
+     * Usage aspects, as opaque codes — often compound (`"CQR"` = statements +
+     * qualifiers + references, `"D.en"` = English description). Open string list.
+     */
+    aspects?: string[];
+    /** Link to the entity page on the repo. Only with `wbeuprop=url` / `wbleuprop=url`. */
+    url?: string;
+}
+/** Entity id → usage. Each row always carries at least one entity; an empty map does not occur. */
+export type ApiEntityUsageMap = Record<string, ApiEntityUsage>;
+/** Terms of the entity linked to a page (`prop=pageterms`). */
+export interface ApiPageTerms {
+    /** Label(s) in the requested language. */
+    label?: string[];
+    /** Description(s) in the requested language. */
+    description?: string[];
+    /** Alias(es) in the requested language. */
+    alias?: string[];
+}
+/** Repo location info (`meta=wikibase`, `wbprop=url`). */
+export interface ApiWikibaseRepoUrl {
+    /** Repo base URL. */
+    base?: string;
+    /** Repo script path, e.g. `/w`. */
+    scriptpath?: string;
+    /** Repo article path with the `$1` placeholder. */
+    articlepath?: string;
+}
+/** The `repo` object of `meta=wikibase`. */
+export interface ApiWikibaseRepo {
+    url?: ApiWikibaseRepoUrl;
+}
+/** The `wikibase` object of a `meta=wikibase` response. */
+export interface ApiWikibaseInfo {
+    /** Repo URL info. `wbprop=url`. */
+    repo?: ApiWikibaseRepo;
+    /** This wiki's global site id, e.g. `mediawikiwiki`. `wbprop=siteid`. */
+    siteid?: string;
+}
+/** One row of `list=wblistentityusage` (a local page using the queried entity). */
+export interface ApiEntityUsageRow {
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Page title, prefixed for non-main namespaces. */
+    title?: string;
+    /** Local page id. */
+    pageid?: number;
+    /** Entities used by this page and their usage (the queried entities). */
+    wblistentityusage?: ApiEntityUsageMap;
+}
+declare module "types-mediawiki-response" {
+    interface ApiPage {
+        /** `prop=pageterms`: terms of the entity linked to this page. */
+        terms?: ApiPageTerms;
+        /** `prop=wbentityusage`: entities used by this page, keyed by entity id. */
+        wbentityusage?: ApiEntityUsageMap;
+    }
+    interface ApiQueryResult {
+        /** `meta=wikibase`: info about the associated repo. */
+        wikibase?: ApiWikibaseInfo;
+        /** `list=wblistentityusage`: pages using the requested entities. */
+        entityusage?: ApiEntityUsageRow[];
+    }
+}