types-mediawiki-response 1.0.0-alpha.1

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

@@ -0,0 +1,30 @@
+/**
+ * `list=exturlusage` — pages that carry a given external URL, merged into
+ * {@link ApiQueryResult}. The list-side counterpart of `prop=extlinks`, which
+ * reads a page's URLs rather than searching for a URL's pages.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Exturlusage
+ */
+import type { NamespaceIndex } from "../../common";
+/** One page whose content links to the searched URL. */
+export interface ApiExtUrlUsage {
+    /** Page id. `euprop=ids`. */
+    pageid?: number;
+    /** Namespace index. `euprop=title` (default). */
+    ns?: NamespaceIndex;
+    /** Full page title. */
+    title?: string;
+    /**
+     * The matched URL, reconstructed from the `externallinks` row (domain index
+     * plus stored path), not verbatim page text. `euprop=url` (default);
+     * `euexpandurl=1` expands protocol-relative URLs to the canonical protocol
+     * (deprecated since MediaWiki 1.43).
+     */
+    url?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages using the URL given to `euquery` (`list=exturlusage`). */
+        exturlusage?: ApiExtUrlUsage[];
+    }
+}

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

@@ -0,0 +1,91 @@
+/**
+ * `list=filearchive` — files removed by deletion (whole-page deletes and
+ * overwritten uploads alike), merged into {@link ApiQueryResult}. Viewing the
+ * description fields needs `deletedhistory`; the file itself needs `deletedtext`.
+ *
+ * Sizes are **strings** here (`"70"`, `"1"`, `"8"`): the module passes the
+ * `filearchive` columns through without casting, unlike `prop=imageinfo` (numbers)
+ * and `list=mystashedfiles` (numbers).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Filearchive
+ */
+import type { Flag, NamespaceIndex, Timestamp } from "../../common";
+import type { ApiImageMetadataItem } from "./imageinfo";
+/**
+ * One archived file. `faprop` selects the optional fields; `id`, `name`, `ns`
+ * and `title` are always present.
+ */
+export interface ApiFileArchiveEntry {
+    /** `filearchive` row id. */
+    id: number;
+    /** File name with underscores, without the `File:` prefix. */
+    name: string;
+    /** Namespace the file page lived in (always the File namespace). */
+    ns: NamespaceIndex;
+    /** Full file page title. */
+    title: string;
+    /**
+     * Stored name of a superseded version. Only on an archived *old* version —
+     * absent for the newest stored file, even with `faprop=archivename`.
+     */
+    archivename?: string;
+    /** Upload timestamp. `faprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Uploader name. `faprop=user`. */
+    user?: string;
+    /** Uploader id. `faprop=user`. */
+    userid?: number;
+    /** The file's stored content is missing. A {@link Flag}. */
+    filemissing?: Flag;
+    /** Raw upload description (the file page's text). `faprop=description`. */
+    description?: string;
+    /** HTML-rendered upload description. `faprop=parseddescription`. */
+    parseddescription?: string;
+    /**
+     * File size in bytes, as a string. Emitted with either `faprop=size` or
+     * `faprop=dimensions`.
+     */
+    size?: string;
+    /**
+     * Number of pages, for multi-page formats; absent for formats without pages.
+     * Emitted with either `faprop=size` or `faprop=dimensions`.
+     */
+    pagecount?: number;
+    /** Pixel height, as a string. Emitted with either `faprop=size` or `faprop=dimensions`. */
+    height?: string;
+    /** Pixel width, as a string. Emitted with either `faprop=size` or `faprop=dimensions`. */
+    width?: string;
+    /** Content checksum (hex). `faprop=sha1`. */
+    sha1?: string;
+    /**
+     * MIME type, e.g. `image/png`. `faprop=mime`; requires the file content to be
+     * visible to the requester (revision-delete bitfield) and present.
+     */
+    mime?: string;
+    /** MediaWiki media bucket, e.g. `BITMAP`. `faprop=mediatype`. */
+    mediatype?: string;
+    /**
+     * Colour depth in bits, as a string. `faprop=bitdepth`; same visibility gate
+     * as `mime`.
+     */
+    bitdepth?: string;
+    /**
+     * Raw format metadata (EXIF / PNG chunks / …). `faprop=metadata`; `null` when the
+     * row carries none.
+     */
+    metadata?: ApiImageMetadataItem[] | null;
+    /** The file itself is hidden. A {@link Flag}. */
+    filehidden?: Flag;
+    /** The upload description is hidden. A {@link Flag}. */
+    commenthidden?: Flag;
+    /** The uploader is hidden. A {@link Flag}. */
+    userhidden?: Flag;
+    /** Hidden from ordinary admins (oversight). A {@link Flag}. */
+    suppressed?: Flag;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Deleted/overwritten files (`list=filearchive`). */
+        filearchive?: ApiFileArchiveEntry[];
+    }
+}

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

@@ -0,0 +1,51 @@
+/**
+ * `meta=filerepoinfo` — the wiki's file repositories (local upload dir plus any
+ * shared repo), merged into {@link ApiQueryResult}. Explains the `url`/`thumburl`
+ * 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
+ * the key set varies by site; `apiurl` exists only for `ForeignAPIRepo`
+ * backends.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Filerepoinfo
+ */
+/** One file repository: an element of the `query.repos` array. */
+export interface ApiFileRepoInfo {
+    /** Repo id; `local` is the wiki's own repo. `friprop=name` (default). */
+    name?: string;
+    /** Human-readable repo name. `friprop=displayname`. */
+    displayname?: string;
+    /** Whether this is the wiki's own repo. `friprop=local`. */
+    local?: boolean;
+    /** Public base path of the repo. `friprop=url`. */
+    url?: string;
+    /** Repo root without the hashed subpath. `friprop=rootUrl`. */
+    rootUrl?: string;
+    /** Base path for thumbnails. `friprop=thumbUrl`. */
+    thumbUrl?: string;
+    /** Base path of the repo's wiki, e.g. `https://www.mediawiki.org/w`. `friprop=scriptDirUrl`. */
+    scriptDirUrl?: string;
+    /** URL of the repo wiki's favicon. `friprop=favicon`. */
+    favicon?: string;
+    /** Whether titles on the repo wiki are capitalized on first letter. `friprop=initialCapital`. */
+    initialCapital?: boolean;
+    /** Whether the requesting user may upload here. `friprop=canUpload`. */
+    canUpload?: boolean;
+    /** Base path of the repo wiki's API, for `ForeignAPIRepo` backends. `friprop=apiurl`. */
+    apiurl?: string;
+    /** URL prefix of the repo wiki's file description pages (e.g. `…/wiki/File:`). `friprop=descBaseUrl`. */
+    descBaseUrl?: string;
+    /** URL prefix of the repo wiki's article pages. `friprop=articleUrl`. */
+    articleUrl?: string;
+    /** Whether description pages are fetched from the remote wiki. `friprop=fetchDescription`. */
+    fetchDescription?: boolean;
+    /** How long fetched descriptions are cached, in seconds. `friprop=descriptionCacheExpiry`. */
+    descriptionCacheExpiry?: number;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** File repositories (`meta=filerepoinfo`). */
+        repos?: ApiFileRepoInfo[];
+    }
+}

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

@@ -0,0 +1,26 @@
+/**
+ * `prop=fileusage` — local pages that use (embed) a file, merged into
+ * {@link ApiPage} via declaration merging. For usage across the whole wiki farm
+ * (including this wiki), use `prop=globalusage`, which offers `gufilterlocal=1`
+ * to drop the local wiki's rows.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Fileusage
+ */
+import type { NamespaceIndex } from "../../common";
+/** One local usage record. `fuprop` controls which fields appear. */
+export interface ApiFileUsage {
+    /** Page id of the using page. `fuprop=pageid`. */
+    pageid?: number;
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Full title of the using page. */
+    title?: string;
+    /** Whether the using page is a redirect. `fuprop=redirect`; a real `boolean`. */
+    redirect?: boolean;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Local pages using this file (`prop=fileusage`). */
+        fileusage?: ApiFileUsage[];
+    }
+}

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

@@ -0,0 +1,214 @@
+/**
+ * `prop=imageinfo` — metadata about a file (image) page's current (or archived)
+ * version, merged into the shared {@link ApiPage} via declaration merging.
+ * Central to any file-heavy wiki. Which sub-fields appear depends on `iiprop`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Imageinfo
+ */
+import type { Flag, Timestamp } from "../../common";
+/** One entry in a file's raw format `metadata` array (may nest further items). */
+export interface ApiImageMetadataItem {
+    /** Metadata field name, e.g. `width`, `XResolution`. */
+    name?: string;
+    /**
+     * Field value; a scalar (booleans occur, e.g. through `META_BC_BOOLS`
+     * serialization; EXIF RATIONALs serialize as `"num/den"` strings) or a
+     * nested list of {@link ApiImageMetadataItem}.
+     */
+    value?: string | number | boolean | ApiImageMetadataItem[];
+}
+/**
+ * A multilang metadata value (`iiextmetadatamultilang=1`): the map of language
+ * codes to values that the API otherwise collapses to the best-matching
+ * language. `x-default` holds the fallback translation.
+ */
+export interface ApiExtMetadataMultilangValue {
+    /** Serialization marker of the multilang map. */
+    _type?: "lang";
+    /** The value per language code (e.g. `en`, `de`, `x-default`). */
+    [lang: string]: string | number | undefined;
+}
+/** One structured `extmetadata` field. */
+export interface ApiExtMetadataField {
+    /**
+     * Field value: a string for most fields, numeric for a few (e.g. the
+     * extension version), or the raw {@link ApiExtMetadataMultilangValue} map
+     * when the request set `iiextmetadatamultilang=1`.
+     */
+    value?: string | number | ApiExtMetadataMultilangValue;
+    /** Where the value came from, e.g. `mediawiki-metadata`. */
+    source?: string;
+    /** Presentation hint; serialized as an empty string when set (fv2 quirk). */
+    hidden?: string;
+}
+/** One scaled thumbnail entry (a keyed value of {@link ApiImageInfo.thumburls}). */
+export interface ApiThumbUrlEntry {
+    /** Thumbnail source URL. */
+    url?: string;
+    /** Rendered width in pixels. */
+    width?: number;
+    /** Rendered height in pixels. */
+    height?: number;
+    /**
+     * Additional pre-rendered `<img>` attributes merged by the transform
+     * (typically `src`, `decoding` and `loading`, plus `srcset` when HiDPI
+     * variants exist), same shape as {@link ApiImageInfo.thumbattribs}.
+     */
+    [attribute: string]: string | number | undefined;
+}
+/** One image-info entry for a file page. */
+export interface ApiImageInfo {
+    /** Timestamp of the file's upload/reversion. `iiprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Uploader user name. `iiprop=user`. */
+    user?: string;
+    /** Uploader user id. `iiprop=userid`. */
+    userid?: number;
+    /** Raw upload comment. `iiprop=comment`. */
+    comment?: string;
+    /** HTML-rendered comment. `iiprop=parsedcomment`. */
+    parsedcomment?: string;
+    /** File size in bytes. `iiprop=size|dimensions`. */
+    size?: number;
+    /**
+     * Width in pixels; `0` for files without dimensions (e.g. audio).
+     * `iiprop=size|dimensions`.
+     */
+    width?: number;
+    /**
+     * Height in pixels; `0` for files without dimensions (e.g. audio).
+     * `iiprop=size|dimensions`.
+     */
+    height?: number;
+    /** Canonical localized file title. `iiprop=canonicaltitle`. */
+    canonicaltitle?: string;
+    /** Direct URL to the file. `iiprop=url`. */
+    url?: string;
+    /** URL of the file description page. `iiprop=url`. */
+    descriptionurl?: string;
+    /** Shortened description-page URL. `iiprop=url`. */
+    descriptionshorturl?: string;
+    /**
+     * Scaled thumbnail URL. Requires `iiprop=url`, plus a transform requested
+     * via `iiurlwidth`, `iiurlheight` or `iiurlparam`.
+     */
+    thumburl?: string;
+    /**
+     * Scaled thumbnail width (px). Falls back to the file's own width when the
+     * thumbnail URL equals the original URL (no resize happened). Same
+     * requirements as {@link thumburl}.
+     */
+    thumbwidth?: number;
+    /**
+     * Scaled thumbnail height (px). Falls back to the file's own height like
+     * {@link thumbwidth}.
+     */
+    thumbheight?: number;
+    /**
+     * Pre-rendered `<img>` attributes for the thumbnail (e.g. `src`, `width`,
+     * `srcset`).
+     *
+     * @since MediaWiki 1.47
+     */
+    thumbattribs?: Record<string, string | number>;
+    /**
+     * Scaled thumbnail URLs at multiple widths, keyed by the produced
+     * thumbnail's width (normally the requested width; e.g. `"400"`, `"800"`).
+     * `iiprop=thumburls`. Each entry also folds in the transform's HTML `<img>`
+     * attributes.
+     *
+     * @since MediaWiki 1.47
+     */
+    thumburls?: Record<string, ApiThumbUrlEntry>;
+    /**
+     * HiDPI (`2x`, …) source URLs keyed by pixel-density multiplier. Requires
+     * `iiprop=url`, plus a successful transform.
+     */
+    responsiveUrls?: Record<string, string>;
+    /** File SHA-1 (hex). `iiprop=sha1`. */
+    sha1?: string;
+    /** MIME type, e.g. `image/png`. `iiprop=mime`. */
+    mime?: string;
+    /** Media type, e.g. `BITMAP`, `OFFICE`, `ARCHIVE`. `iiprop=mediatype`. */
+    mediatype?: string;
+    /** Color bit depth; `0` for files without dimensions (e.g. audio). `iiprop=bitdepth`. */
+    bitdepth?: number;
+    /**
+     * Raw format metadata (EXIF / PNG chunks / …). `iiprop=metadata`; an
+     * explicit `null` when the file has no metadata at all.
+     */
+    metadata?: ApiImageMetadataItem[] | null;
+    /**
+     * Metadata keys common to all file types, same item shape as {@link metadata}.
+     * `iiprop=commonmetadata`; an empty PHP map, so `[]` when there is none.
+     */
+    commonmetadata?: ApiImageMetadataItem[];
+    /** Structured/extended metadata keyed by field name. `iiprop=extmetadata`. */
+    extmetadata?: Record<string, ApiExtMetadataField>;
+    /**
+     * MIME type the thumbnail will be rendered as. `iiprop=thumbmime`, which
+     * requires `iiprop=url` and a transform via `iiurlwidth`/`iiurlheight`.
+     */
+    thumbmime?: string;
+    /**
+     * Rendered text of the thumbnail error, when the thumbnail could not be
+     * made. Requires `iiprop=url`, plus a transform.
+     */
+    thumberror?: string;
+    /**
+     * Upload-warning HTML ("a file with this name exists already…").
+     * `iiprop=uploadwarning`; `""` when there is nothing to warn about.
+     */
+    html?: string;
+    /** `true` when the file itself does not exist on this wiki (a stub row). A {@link Flag}. */
+    filemissing?: Flag;
+    /**
+     * Media duration in seconds (audio/video), when the handler reports one.
+     * Emitted under `iiprop=size|dimensions`; there is no `iiprop=duration`.
+     */
+    duration?: number;
+    /**
+     * Page count (multi-page documents such as PDFs/TIFFs), when the handler
+     * supports one. Emitted under `iiprop=size|dimensions`; there is no
+     * `iiprop=pagecount`.
+     */
+    pagecount?: number;
+    /** Archive name for a historical version. `iiprop=archivename`. */
+    archivename?: string;
+    /** The uploader is hidden (file revision-deleted). A {@link Flag}. */
+    userhidden?: Flag;
+    /** The upload comment is hidden. A {@link Flag}. */
+    commenthidden?: Flag;
+    /** The file itself is hidden. A {@link Flag}. */
+    filehidden?: Flag;
+    /** Made by an anonymous (IP) uploader. A {@link Flag}. */
+    anon?: Flag;
+    /**
+     * The uploader is a temporary account. A {@link Flag}.
+     *
+     * @since MediaWiki 1.42
+     */
+    temp?: Flag;
+    /**
+     * Oversight/suppression applies to this file revision (set together with the
+     * `*hidden` flags). A {@link Flag}.
+     */
+    suppressed?: Flag;
+}
+declare module "./index" {
+    interface ApiPage {
+        /**
+         * Where the file is hosted: the repository name, `local` for this wiki;
+         * `''` when the file does not exist. Framework field for file pages.
+         */
+        imagerepository?: "local" | "shared" | (string & {});
+        /**
+         * Whether the file is on the "bad images" list (`$wgBadImageList`).
+         * `iiprop=badfile` — a real `boolean`, and a **page-level sibling** of
+         * {@link ApiPage.imageinfo}, not a member of the imageinfo entry.
+         */
+        badfile?: boolean;
+        /** Image/file info entries (`prop=imageinfo`); usually one for the current file. */
+        imageinfo?: ApiImageInfo[];
+    }
+}

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

@@ -0,0 +1,20 @@
+/**
+ * `prop=images` — the files (images) used/embedded by a page, merged into
+ * {@link ApiPage}. `formatversion=2` returns `{ ns, title }` per image.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Images
+ */
+import type { NamespaceIndex } from "../../common";
+/** One image used by a page. */
+export interface ApiUsedImage {
+    /** Namespace index (the File namespace). */
+    ns: NamespaceIndex;
+    /** Full file title, e.g. `File:Example.png`. */
+    title: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Files embedded by this page (`prop=images`). */
+        images?: ApiUsedImage[];
+    }
+}

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

@@ -0,0 +1,36 @@
+/**
+ * `list=imageusage` — pages that use a given file, merged into
+ * {@link ApiQueryResult}. The title-based sibling of `prop=fileusage` (which is
+ * keyed per queried file rather than by a single `iutitle`).
+ *
+ * The module has no `iuprop` parameter: every entry always carries `pageid`,
+ * `ns` and `title`. `iufilterredir` selects which using pages are listed
+ * (default `all`, i.e. redirects included); a listed page that is itself a
+ * redirect carries a `redirect` flag, and with `iuredirect=1` such an entry
+ * nests the pages using the file through it under `redirlinks`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Imageusage
+ */
+import type { Flag, NamespaceIndex } from "../../common";
+/** One page that uses the target file. */
+export interface ApiImageUsage {
+    /** Page id of the using page. */
+    pageid: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** The using page is itself a redirect. A {@link Flag}. */
+    redirect?: Flag;
+    /**
+     * Pages that use the file through this redirect. Only on a `redirect`
+     * entry, and only with `iuredirect=1`.
+     */
+    redirlinks?: ApiImageUsage[];
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages using the file given to `iutitle` (`list=imageusage`). */
+        imageusage?: ApiImageUsage[];
+    }
+}