types-mediawiki-response 1.0.0-alpha.1

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

@@ -0,0 +1,28 @@
+/**
+ * `list=iwbacklinks` — pages that link to a given interwiki target, merged into
+ * {@link ApiQueryResult}. The reverse of `prop=iwlinks`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Iwbacklinks
+ */
+import type { Flag, NamespaceIndex } from "../../common";
+/** One page carrying the searched interwiki link. */
+export interface ApiIwbacklink {
+    /** Page id of the linking page. */
+    pageid: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** `true` when the linking page is a redirect. A {@link Flag}. */
+    redirect?: Flag;
+    /** Interwiki prefix of the matched link, e.g. `q`. `iwblprop=iwprefix`. */
+    iwprefix?: string;
+    /** Target title on the remote wiki. `iwblprop=iwtitle`. */
+    iwtitle?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages linking to `iwblprefix`:`iwbltitle` (`list=iwbacklinks`). */
+        iwbacklinks?: ApiIwbacklink[];
+    }
+}

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

@@ -0,0 +1,21 @@
+/**
+ * `prop=iwlinks` — interwiki links on a page, merged into the shared
+ * {@link ApiPage} shape via declaration merging.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Iwlinks
+ */
+/** One interwiki link. */
+export interface ApiInterwikiLink {
+    /** Interwiki prefix, e.g. `en` / `m`. */
+    prefix: string;
+    /** Target title. */
+    title: string;
+    /** Resolved target URL. `iwprop=url`, or the deprecated boolean `iwurl` parameter. */
+    url?: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Interwiki links on the page (`prop=iwlinks`). */
+        iwlinks?: ApiInterwikiLink[];
+    }
+}

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

@@ -0,0 +1,28 @@
+/**
+ * `list=langbacklinks` — pages that link to a given interlanguage target,
+ * merged into {@link ApiQueryResult}. The reverse of `prop=langlinks`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Langbacklinks
+ */
+import type { Flag, NamespaceIndex } from "../../common";
+/** One page carrying the searched language link. */
+export interface ApiLangbacklink {
+    /** Page id of the linking page. */
+    pageid: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** `true` when the linking page is a redirect. A {@link Flag}. */
+    redirect?: Flag;
+    /** Language code of the matched link, e.g. `de`. `lblprop=lllang`. */
+    lllang?: string;
+    /** Target title on the other language's wiki. `lblprop=lltitle`. */
+    lltitle?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages linking to `lbllang`:`lbltitle` (`list=langbacklinks`). */
+        langbacklinks?: ApiLangbacklink[];
+    }
+}

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

@@ -0,0 +1,32 @@
+/**
+ * `prop=langlinks` — interlanguage links (links to the same subject in other
+ * language wikis), merged into {@link ApiPage}. Rows appear when the pages
+ * carry interlanguage links; a wiki (or page) without any yields none.
+ *
+ * `lang` and `title` are always present; `url` / `langname` / `autonym` come from
+ * `llprop`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Langlinks
+ */
+/** One interlanguage link. */
+export interface ApiLangLink {
+    /** Target language code, e.g. `de`. */
+    lang: string;
+    /** Title of the linked page on the target wiki. */
+    title: string;
+    /** Full URL of the linked page. `llprop=url`. */
+    url?: string;
+    /**
+     * Language name, localized to `inlanguagecode`, which defaults to the site's
+     * content language (not the requesting user's UI language). `llprop=langname`.
+     */
+    langname?: string;
+    /** Language name in its own language. `llprop=autonym`. */
+    autonym?: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Interlanguage links from this page (`prop=langlinks`). */
+        langlinks?: ApiLangLink[];
+    }
+}

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

@@ -0,0 +1,70 @@
+/**
+ * `meta=languageinfo` — information about languages, merged into
+ * {@link ApiQueryResult} as an object keyed by language code. Which fields
+ * appear depends on `liprop`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Languageinfo
+ */
+/** Information about one language (`meta=languageinfo`, keyed by code). */
+export interface ApiLanguageInfo {
+    /** Language code. `liprop=code`. */
+    code?: string;
+    /** BCP 47 language tag. `liprop=bcp47`. */
+    bcp47?: string;
+    /** Writing direction. `liprop=dir`. Open union for forward compatibility. */
+    dir?: "ltr" | "rtl" | (string & {});
+    /** Name in the language itself. `liprop=autonym`. */
+    autonym?: string;
+    /** Name in the content/`uselang` language. `liprop=name`. */
+    name?: string;
+    /** Fallback language codes, in order. `liprop=fallbacks`. */
+    fallbacks?: string[];
+    /** Language-variant codes. `liprop=variants`. */
+    variants?: string[];
+    /**
+     * Variant display names, keyed by variant code. `liprop=variantnames`.
+     *
+     * @since MediaWiki 1.40
+     */
+    variantnames?: Record<string, string>;
+    /**
+     * Digit transforms: an ASCII-digit → localized-digit mapping. `liprop=digittransforms`.
+     * A PHP map keyed `0..9`; when a language omits some entries it serializes as an
+     * object, and an empty table surfaces as `[]`.
+     *
+     * @since MediaWiki 1.47
+     */
+    digittransforms?: string[] | Record<string, string>;
+    /**
+     * CLDR digit-grouping pattern (e.g. `#,##0.###`). `liprop=digitgroupingpattern`.
+     *
+     * @since MediaWiki 1.47
+     */
+    digitgroupingpattern?: string;
+    /**
+     * Minimum number of digits required before grouping applies. `liprop=minimumgroupingdigits`.
+     *
+     * @since MediaWiki 1.47
+     */
+    minimumgroupingdigits?: number;
+    /**
+     * Localized namespace names, keyed by numeric namespace id. `liprop=namespacenames`;
+     * the main namespace's value is the empty string.
+     *
+     * @since MediaWiki 1.47
+     */
+    namespacenames?: Record<string, string>;
+    /**
+     * Localized namespace aliases, mapping each alias to its namespace id.
+     * `liprop=namespacealiases`.
+     *
+     * @since MediaWiki 1.47
+     */
+    namespacealiases?: Record<string, number>;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Language information keyed by language code (`meta=languageinfo`). */
+        languageinfo?: Record<string, ApiLanguageInfo>;
+    }
+}

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

@@ -0,0 +1,22 @@
+/**
+ * `prop=links` — the wikilinks a page makes (forward links), merged into
+ * {@link ApiPage}. The inverse of `prop=linkshere`.
+ *
+ * Under `formatversion=2` each row is exactly `{ ns, title }`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Links
+ */
+import type { NamespaceIndex } from "../../common";
+/** One link made by a page. */
+export interface ApiPageLink {
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Linked page title. */
+    title: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Pages linked-to by this page (`prop=links`). */
+        links?: ApiPageLink[];
+    }
+}

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

@@ -0,0 +1,25 @@
+/**
+ * `prop=linkshere` — pages that link to the queried page, merged into
+ * {@link ApiPage} via declaration merging. Each entry is a lightweight page
+ * reference (not a full {@link ApiPage}).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Linkshere
+ */
+import type { NamespaceIndex } from "../../common";
+/** One page in a `linkshere` result. `lhprop` controls which fields appear. */
+export interface ApiLinksHere {
+    /** Page id. `lhprop=pageid`. */
+    pageid?: number;
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Full page title. */
+    title?: string;
+    /** Whether the linking page is a redirect. `lhprop=redirect`; a real `boolean`. */
+    redirect?: boolean;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Pages linking to this page (`prop=linkshere`). */
+        linkshere?: ApiLinksHere[];
+    }
+}

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

@@ -0,0 +1,77 @@
+/**
+ * `list=logevents` — the page/user action log, merged into {@link ApiQueryResult}
+ * via declaration merging. Central to admin tooling (audit trails).
+ *
+ * `type` + `action` together identify the event (e.g. `delete` / `delete`); the
+ * structured details live under `params` (`leprop=details`).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Logevents
+ */
+import type { Flag, NamespaceIndex, Timestamp } from "../../common";
+/** One log event. `leprop` controls which fields appear. */
+export interface ApiLogEvent {
+    /** Log record id. `leprop=ids`. */
+    logid?: number;
+    /** Namespace of the affected page. */
+    ns?: NamespaceIndex;
+    /** Title of the affected page. `leprop=title`. */
+    title?: string;
+    /** Page id of the target; `0` when there is no page. `leprop=ids`. */
+    pageid?: number;
+    /** Page id the log is filed under. `leprop=ids`. */
+    logpage?: number;
+    /**
+     * Revision id associated with the event (when applicable). `leprop=ids`.
+     *
+     * @since MediaWiki 1.40
+     */
+    revid?: number;
+    /** Log type, e.g. `delete`, `move`, `newusers`. `leprop=type`. */
+    type?: string;
+    /** Log action, e.g. `create`, `delete`. `leprop=type`. */
+    action?: string;
+    /** Structured log details; shape varies by `type`/`action`. `leprop=details`. */
+    params?: Record<string, unknown>;
+    /** Performing user name (or IP). `leprop=user`. */
+    user?: string;
+    /** Performing user id. `leprop=userid`. */
+    userid?: number;
+    /** Event timestamp. `leprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Raw log comment. `leprop=comment`. */
+    comment?: string;
+    /** HTML-rendered comment. `leprop=parsedcomment`. */
+    parsedcomment?: string;
+    /** Change tags. `leprop=tags`. */
+    tags?: string[];
+    /**
+     * Made by an anonymous (IP) actor. `leprop=user|userid`; a {@link Flag}.
+     */
+    anon?: Flag;
+    /**
+     * The actor is a temporary account. `leprop=user|userid`; a {@link Flag}.
+     *
+     * @since MediaWiki 1.42
+     */
+    temp?: Flag;
+    /**
+     * The log action/target is hidden (log-deleted). `leprop=ids|title`, or
+     * `leprop=details` on rows that have stored params. A {@link Flag}.
+     */
+    actionhidden?: Flag;
+    /** The actor is hidden. Log-deleted; a {@link Flag}. */
+    userhidden?: Flag;
+    /** The comment is hidden. Log-deleted; a {@link Flag}. */
+    commenthidden?: Flag;
+    /**
+     * Oversight/suppression applies to this log event (set together with the
+     * `*hidden` flags). A {@link Flag}.
+     */
+    suppressed?: Flag;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Log events (`list=logevents`). */
+        logevents?: ApiLogEvent[];
+    }
+}

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

@@ -0,0 +1,39 @@
+/**
+ * `list=mystashedfiles` — files the requesting user has stashed but not yet
+ * published, merged into {@link ApiQueryResult}. Requires being logged in.
+ *
+ * A stash row is produced by `action=upload` with `stash=1` (or by an interrupted
+ * chunked upload) and is consumed by a later `action=upload` with `filekey=`, so
+ * this list is how a client recovers resumable uploads. Sizes here are **numbers**,
+ * unlike the same quantities in `list=filearchive`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Mystashedfiles
+ */
+/** One stashed file. `msfprop` controls the measurement fields. */
+export interface ApiStashedFile {
+    /** Handle to pass as `action=upload`'s `filekey`. */
+    filekey: string;
+    /**
+     * Stash state. `finished` once the whole file is stored; chunked uploads sit on
+     * `chunks` until assembled. Open union for other internal states.
+     */
+    status: "finished" | "chunks" | (string & {});
+    /** Stored size in bytes. `msfprop=size`. */
+    size?: number;
+    /** Image width; `0` for non-raster files. `msfprop=size`. */
+    width?: number;
+    /** Image height; `0` for non-raster files. `msfprop=size`. */
+    height?: number;
+    /** Colour depth in bits. `msfprop=size`. */
+    bits?: number;
+    /** Full MIME type, e.g. `image/png`. `msfprop=type`. */
+    mimetype?: string;
+    /** MediaWiki media bucket, e.g. `BITMAP`. `msfprop=type`. */
+    mediatype?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Files the caller has stashed but not published (`list=mystashedfiles`). */
+        mystashedfiles?: ApiStashedFile[];
+    }
+}

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

@@ -0,0 +1,18 @@
+/**
+ * `list=pagepropnames` — every page property name in use on the wiki, merged
+ * into {@link ApiQueryResult}. Feeds `pwppropname` of `list=pageswithprop` and
+ * `ppprop` of `prop=pageprops`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Pagepropnames
+ */
+/** One page property name in use. */
+export interface ApiPagePropName {
+    /** Property name as stored in `page_props`, e.g. `displaytitle`. */
+    propname: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Distinct page property names (`list=pagepropnames`). */
+        pagepropnames?: ApiPagePropName[];
+    }
+}

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

@@ -0,0 +1,19 @@
+/**
+ * `prop=pageprops` — page properties set by wikitext magic words, parser
+ * functions or extensions (e.g. `wikibase_item`, `displaytitle`, `defaultsort`),
+ * merged into {@link ApiPage} as a flat map.
+ *
+ * Values are strings; boolean-ish properties (e.g. `notoc`, `forceuncategorized`)
+ * serialize as the empty string `""`. A page that has none of the requested
+ * properties is returned without the `pageprops` key at all.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Pageprops
+ */
+/** The set of known property values is open-ended and site/extension-specific. */
+export type ApiPageProps = Record<string, string>;
+declare module "./index" {
+    interface ApiPage {
+        /** Page properties (`prop=pageprops`), keyed by property name. */
+        pageprops?: ApiPageProps;
+    }
+}

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

@@ -0,0 +1,28 @@
+/**
+ * `list=pageswithprop` — pages carrying a given page property, merged into
+ * {@link ApiQueryResult}. The reverse lookup of `prop=pageprops`; enumerate the
+ * usable property names with `list=pagepropnames`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Pageswithprop
+ */
+import type { NamespaceIndex } from "../../common";
+/** One page that defines the requested property. */
+export interface ApiPagesWithProp {
+    /** Page id. `pwpprop=ids`. */
+    pageid?: number;
+    /** Namespace index. `pwpprop=title` (default). */
+    ns?: NamespaceIndex;
+    /** Full page title. */
+    title?: string;
+    /**
+     * Property value. `pwpprop=value` — a string, empty for switch-like
+     * properties (`__DISAMBIG__`), same as `prop=pageprops`.
+     */
+    value?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages defining `pwppropname` (`list=pageswithprop`). */
+        pageswithprop?: ApiPagesWithProp[];
+    }
+}

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

@@ -0,0 +1,27 @@
+/**
+ * `list=prefixsearch` — titles beginning with a given prefix (the autocomplete
+ * backend of the search box), merged into {@link ApiQueryResult}.
+ *
+ * As `generator=prefixsearch` it populates `query.pages`, injecting only `index`
+ * into each entry.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Prefixsearch
+ */
+import type { Flag, NamespaceIndex } from "../../common";
+/** One prefix-search hit. */
+export interface ApiPrefixSearchResult {
+    /** Page id. Absent on a {@link special} hit, which takes its place. */
+    pageid?: number;
+    /** The hit is a special page; takes the place of `pageid`. A {@link Flag}. */
+    special?: Flag;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Prefix-search results (`list=prefixsearch`). */
+        prefixsearch?: ApiPrefixSearchResult[];
+    }
+}

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

@@ -0,0 +1,43 @@
+/**
+ * `list=protectedtitles` — titles protected against creation (pre-emptive
+ * protection of pages that do not exist yet), merged into {@link ApiQueryResult}.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Protectedtitles
+ */
+import type { NamespaceIndex, Timestamp } from "../../common";
+/**
+ * Create-protection level of a protected title — an entry of
+ * `$wgRestrictionLevels` (core default: `autoconfirmed`, `sysop`). **Open
+ * union**: `sreview` comes from FlaggedRevs, so the set is site-dependent.
+ */
+export type ProtectedTitleLevel = "autoconfirmed" | "sysop" | (string & {});
+/** One protected title. `ptprop` controls which fields appear. */
+export interface ApiProtectedTitle {
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** The protected (non-existent) title. */
+    title: string;
+    /** Restriction level applied, e.g. `sysop`. `ptprop=level`. */
+    level?: ProtectedTitleLevel;
+    /** When the protection was applied. `ptprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Name of the protecting user. `ptprop=user`. */
+    user?: string;
+    /**
+     * Id of the protecting user. `ptprop=userid`; also emitted with
+     * `ptprop=user` (B/C).
+     */
+    userid?: number;
+    /** Raw protection reason. `ptprop=comment`. */
+    comment?: string;
+    /** HTML-rendered protection reason. `ptprop=parsedcomment`. */
+    parsedcomment?: string;
+    /** When the protection lapses, or `infinity`. `ptprop=expiry`. */
+    expiry?: Timestamp | "infinity";
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Titles protected against creation (`list=protectedtitles`). */
+        protectedtitles?: ApiProtectedTitle[];
+    }
+}

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

@@ -0,0 +1,59 @@
+/**
+ * `list=querypage` — one of the wiki's special-page reports (`Special:Ancientpages`,
+ * `Special:Longpages`, …), merged into {@link ApiQueryResult}.
+ *
+ * Pagination uses the numeric `qpoffset` cursor rather than a string one. A row's
+ * columns depend on the report: every report yields `ns`/`title`, most add a
+ * `value`, and date-keyed reports add a formatted `timestamp`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Querypage
+ */
+import type { Flag, NamespaceIndex, Timestamp } from "../../common";
+/** One row of a report. */
+export interface ApiQueryPageResult {
+    /**
+     * The report's sort value — a **string** even when it carries a count or a
+     * `yyyymmddhhmmss` date (e.g. `"4"`, `"20240115083000"`).
+     */
+    value?: string;
+    /** Row timestamp; appears on date-keyed reports (`Ancientpages`). */
+    timestamp?: Timestamp;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /**
+     * Raw database columns the report did not fold into named fields, keyed by
+     * column name (all values are strings). Reports that select extra columns —
+     * `DoubleRedirects` exposes its `b_*`/`c_*` redirect columns this way — leak
+     * them here instead of surfacing each one.
+     */
+    databaseResult?: Record<string, string>;
+}
+/** The `querypage` container: the requested report and its rows. */
+export interface ApiQueryPage {
+    /** CamelCase report name, e.g. `Ancientpages`. */
+    name: string;
+    /** The rows come from the job cache. A {@link Flag}. */
+    cached?: Flag;
+    /**
+     * The report is cached but not cacheable, so its rows are withheld. A
+     * {@link Flag}.
+     */
+    disabled?: Flag;
+    /**
+     * When the cached report was built; appears alongside {@link cached} when
+     * the cache timestamp is known.
+     */
+    cachedtimestamp?: Timestamp;
+    /** Largest result set the report can yield, independent of `qplimit`. */
+    maxresults?: number;
+    /** Rows of the report. */
+    results?: ApiQueryPageResult[];
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** The requested special-page report (`list=querypage`). */
+        querypage?: ApiQueryPage;
+    }
+}

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

@@ -0,0 +1,30 @@
+/**
+ * `list=random` — a random selection of pages, merged into
+ * {@link ApiQueryResult}. Entries carry no `prop=` data; pair the module with
+ * `generator=random` to feed the selection into other modules instead.
+ *
+ * Note the id key is `id`, not the `pageid` other modules use.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Random
+ */
+import type { NamespaceIndex } from "../../common";
+/** One randomly selected page. */
+export interface ApiRandomPage {
+    /** Page id — keyed `id` here, unlike the `pageid` elsewhere. */
+    id: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /**
+     * The page is a redirect. A real `boolean` (explicitly `false` too);
+     * present only with `rnfilterredir=all`.
+     */
+    redirect?: boolean;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Randomly selected pages (`list=random`). */
+        random?: ApiRandomPage[];
+    }
+}