types-mediawiki-response 1.0.0-alpha.1

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

@@ -0,0 +1,30 @@
+/**
+ * `list=allrevisions` — revisions enumerated across the wiki, grouped per page,
+ * merged into {@link ApiQueryResult}. The list-side counterpart of
+ * `prop=revisions`, useful without a title list (pair it with a generator, or
+ * page the whole namespace with `arvnamespace`).
+ *
+ * Rows are formatted exactly like `prop=revisions`, so they reuse
+ * {@link ApiRevision}; `list=alldeletedrevisions` groups identically.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Allrevisions
+ */
+import type { NamespaceIndex } from "../../common";
+import type { ApiRevision } from "./revisions";
+/** One page with the revisions requested for it. */
+export interface ApiAllRevisions {
+    /** Page id. */
+    pageid: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** Revisions of the page, ordered per `arvdir`. */
+    revisions: ApiRevision[];
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Revisions grouped by page (`list=allrevisions`). */
+        allrevisions?: ApiAllRevisions[];
+    }
+}

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

@@ -0,0 +1,14 @@
+/**
+ * `list=alltransclusions` — enumerate titles that are transcluded, merged into
+ * {@link ApiQueryResult}. Shares {@link ApiAllLink} with the `alllinks` family
+ * (same MediaWiki class, `at*` parameters).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Alltransclusions
+ */
+import type { ApiAllLink } from "./alllinks";
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Transcluded titles on the wiki (`list=alltransclusions`). */
+        alltransclusions?: ApiAllLink[];
+    }
+}

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

@@ -0,0 +1,37 @@
+/**
+ * `list=allusers` — enumerate all registered users, merged into
+ * {@link ApiQueryResult} via declaration merging. `auprop` selects which fields
+ * appear, and every entry always carries `userid` and `name`.
+ *
+ * Entries share the `list=users` shape ({@link ApiUser}) minus the fields this
+ * module can never emit: `gender`, `emailable`, `cancreate`,
+ * `cancreateerror`, `groupmemberships`, `missing` and `systemuser`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Allusers
+ */
+import type { Timestamp } from "../../common";
+import type { ApiUser } from "./users";
+/** One user listed by `list=allusers`. */
+export type ApiAllusersEntry = Omit<ApiUser, "gender" | "emailable" | "cancreate" | "cancreateerror" | "groupmemberships" | "missing" | "systemuser" | "userid" | "name"> & {
+    /** User id. */
+    userid: number;
+    /** User name. */
+    name: string;
+    /**
+     * Registration timestamp, or an **empty string** for accounts created before
+     * registration timestamps were tracked (unlike the `null` of `list=users`).
+     * `auprop=registration`.
+     */
+    registration?: Timestamp | "";
+    /**
+     * Effective actions over the last `$wgActiveUserDays` days. Emitted only with
+     * `auactiveusers=1`.
+     */
+    recentactions?: number;
+};
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Users listed by `list=allusers`. */
+        allusers?: ApiAllusersEntry[];
+    }
+}

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

@@ -0,0 +1,96 @@
+/**
+ * `meta=authmanagerinfo` — introspection over the AuthManager providers for a
+ * given flow (`amirequestsfor`), merged into {@link ApiQueryResult} via
+ * declaration merging. Drives the `clientlogin`/`createaccount` request shapes.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Authmanagerinfo
+ */
+/**
+ * A message attached to an AuthManager request or field. Its shape follows the
+ * request's `amimessageformat` parameter (default `wikitext`): a rendered
+ * string under `wikitext`/`html`, an {@link ApiAuthManagerRawMessage} under
+ * `raw`, and the key is absent under `none`.
+ */
+export type ApiAuthManagerMessage = string | ApiAuthManagerRawMessage;
+/** A message in raw form (`amimessageformat=raw`): the i18n key plus parameters. */
+export interface ApiAuthManagerRawMessage {
+    /** i18n message key. */
+    key?: string;
+    /** i18n message parameters. */
+    params?: unknown[];
+}
+/**
+ * AuthManager / password-flow status. The uppercase values are the
+ * `AuthenticationResponse` statuses that surface through the API (`PASS`/
+ * `FAIL`/`UI`/`REDIRECT`/`RESTART`; the internal `ABSTAIN` never does); the
+ * lowercase `success` is emitted by `ApiResetPassword` itself. Open union.
+ */
+export type ApiAuthManagerStatus = "PASS" | "FAIL" | "UI" | "REDIRECT" | "RESTART" | "success" | (string & {});
+/** One AuthManager request descriptor returned by `meta=authmanagerinfo`. */
+export interface ApiQueryAuthManagerInfoRequest {
+    /** Fully-qualified request class name (PHP namespace separators escaped). */
+    id?: string;
+    /** Arbitrary provider metadata; always an object under `formatversion=2` (possibly empty). */
+    metadata?: Record<string, unknown>;
+    /** How the request is required for the flow. */
+    required?: "required" | "optional" | "primary-required" | (string & {});
+    /** Human-readable provider name. */
+    provider?: ApiAuthManagerMessage;
+    /** Provider account label (often the request class name for core providers). */
+    account?: ApiAuthManagerMessage;
+    /** Field descriptors keyed by field name. */
+    fields?: Record<string, ApiQueryAuthManagerField>;
+}
+/** A single field descriptor of an {@link ApiQueryAuthManagerInfoRequest}. */
+export interface ApiQueryAuthManagerField {
+    /** Input type (e.g. `string`, `password`, `info`). */
+    type?: string;
+    /** The field's current value (e.g. a username prefilled by a preserved session). */
+    value?: string;
+    /** Allowed values mapped to their rendered labels, for choice-like fields. */
+    options?: Record<string, string>;
+    /** Rendered label. */
+    label?: ApiAuthManagerMessage;
+    /** Help text. */
+    help?: ApiAuthManagerMessage;
+    /** The field may be omitted. */
+    optional?: boolean;
+    /** The field carries a secret (password) and is masked. */
+    sensitive?: boolean;
+    /** Additional provider-specific field metadata. */
+    [extra: string]: unknown;
+}
+/** The `authmanagerinfo` object returned under `query`. */
+export interface ApiQueryAuthManagerInfo {
+    /** Whether the current session can authenticate right now. */
+    canauthenticatenow: boolean;
+    /** Whether account creation is available. */
+    cancreateaccounts: boolean;
+    /** Whether account linking (CentralAuth) is available. */
+    canlinkaccounts: boolean;
+    /**
+     * Security-sensitive operation status, present only when
+     * `amisecuritysensitiveoperation` names an action.
+     */
+    securitysensitiveoperationstatus?: string;
+    /** Whether a preserved AuthManager state exists for the session. */
+    haspreservedstate?: boolean;
+    /** Whether a preserved *primary* AuthManager state exists. */
+    hasprimarypreservedstate?: boolean;
+    /** Preserved username, or an empty string when none. */
+    preservedusername?: string;
+    /**
+     * Field descriptors merged across all {@link requests}, present only when the
+     * request passed `amimergerequestfields=1` — the per-request `fields` are
+     * omitted in that mode.
+     */
+    fields?: Record<string, ApiQueryAuthManagerField>;
+    /** Provider requests the flow needs, ordered. */
+    requests?: ApiQueryAuthManagerInfoRequest[];
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** AuthManager provider introspection requested via `meta=authmanagerinfo`. */
+        authmanagerinfo?: ApiQueryAuthManagerInfo;
+    }
+}

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

@@ -0,0 +1,34 @@
+/**
+ * `list=backlinks` — pages that link to a given title, merged into
+ * {@link ApiQueryResult}. The title-based sibling of `prop=linkshere` (which is
+ * keyed per queried page rather than by a single `bltitle`).
+ *
+ * The module has no `blprop` parameter: every entry always carries `pageid`,
+ * `ns` and `title`. With `blredirect=1`, an entry that is itself a redirect
+ * nests the pages linking through it under `redirlinks`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Backlinks
+ */
+import type { Flag, NamespaceIndex } from "../../common";
+/** One page that links to the target title. */
+export interface ApiBacklink {
+    /** Page id. */
+    pageid: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** The linking page is itself a redirect. A {@link Flag}. */
+    redirect?: Flag;
+    /**
+     * Pages that link through this redirect to the target title. Only on a
+     * `redirect` entry, and only with `blredirect=1`.
+     */
+    redirlinks?: ApiBacklink[];
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages linking to `bltitle` (`list=backlinks`). */
+        backlinks?: ApiBacklink[];
+    }
+}

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

@@ -0,0 +1,104 @@
+/**
+ * `list=blocks` — current active blocks, merged into {@link ApiQueryResult} via
+ * declaration merging. `bkprop=flags` expands each block flag into its own real
+ * boolean key under `formatversion=2` (present as `false` when unset).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Blocks
+ */
+import type { NamespaceIndex, Timestamp } from "../../common";
+/** Restriction targets of a partial block, grouped by kind. */
+export interface ApiBlockRestrictions {
+    /** Restricted pages. */
+    pages?: {
+        id: number;
+        ns?: NamespaceIndex;
+        title?: string;
+    }[];
+    /** Restricted namespace ids. */
+    namespaces?: number[];
+    /** Restricted actions; only on wikis with `$wgEnablePartialActionBlocks` enabled. */
+    actions?: string[];
+}
+/** One block record. `bkprop` controls which fields appear. */
+export interface ApiBlock {
+    /** Block id. `bkprop=id`. */
+    id?: number;
+    /**
+     * Blocked user name, IP address or IP range; absent for every autoblock.
+     * `bkprop=user`.
+     */
+    user?: string;
+    /**
+     * Blocked user id; `0` when the target is an IP address or IP range, absent
+     * for every autoblock. `bkprop=userid`.
+     */
+    userid?: number;
+    /** Name of the admin who applied the block. `bkprop=by`. */
+    by?: string;
+    /** User id of the blocking admin. `bkprop=byid`. */
+    byid?: number;
+    /** When the block was applied. `bkprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** When the block expires, or `infinity`. `bkprop=expiry`. */
+    expiry?: Timestamp | "infinity";
+    /**
+     * Human-readable duration, e.g. `3 months`, or the localized "infinite"
+     * message for a permanent block. `bkprop=expiry`.
+     *
+     * @since MediaWiki 1.44
+     */
+    "duration-l10n"?: string;
+    /** Raw block reason. `bkprop=reason`. */
+    reason?: string;
+    /**
+     * HTML-rendered block reason. `bkprop=parsedreason`; the 1.43 baseline
+     * rejects that value, so it only appears on newer wikis.
+     *
+     * @since MediaWiki 1.44
+     */
+    parsedreason?: string;
+    /**
+     * Start of the blocked IP range (hex form). `bkprop=range` on a range block;
+     * before 1.43 also emitted for single-IP blocks.
+     */
+    rangestart?: string;
+    /**
+     * End of the blocked IP range (hex form). `bkprop=range` on a range block;
+     * before 1.43 also emitted for single-IP blocks.
+     */
+    rangeend?: string;
+    /**
+     * Restriction targets of a partial block, grouped by kind; `[]` for a sitewide
+     * block. `bkprop=restrictions`.
+     */
+    restrictions?: ApiBlockRestrictions | unknown[];
+    /** Applied automatically by the autoblock feature. `bkprop=flags`. */
+    automatic?: boolean;
+    /** Blocks anonymous (edit-only) users. `bkprop=flags`. */
+    anononly?: boolean;
+    /** Prevents account creation. `bkprop=flags`. */
+    nocreate?: boolean;
+    /** Autoblock enabled for the offending IP. `bkprop=flags`. */
+    autoblock?: boolean;
+    /** Prevents sending email. `bkprop=flags`. */
+    noemail?: boolean;
+    /** Block is hidden from the block log. `bkprop=flags`. */
+    hidden?: boolean;
+    /**
+     * Suppression visibility of the block. `bkprop=flags`. Written as a separate
+     * key alongside {@link hidden}, with the same value (the block is oversighted).
+     *
+     * @since MediaWiki 1.46
+     */
+    "block-hidden"?: boolean;
+    /** Blocked user may still edit their own talk page. `bkprop=flags`. */
+    allowusertalk?: boolean;
+    /** Whether this is a partial block. `bkprop=flags`. */
+    partial?: boolean;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Active blocks (`list=blocks`). */
+        blocks?: ApiBlock[];
+    }
+}

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

@@ -0,0 +1,28 @@
+/**
+ * `prop=categories` — the categories a page belongs to, merged into the shared
+ * {@link ApiPage} shape via declaration merging.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Categories
+ */
+import type { NamespaceIndex, Timestamp } from "../../common";
+/** One category membership entry; `clprop` selects the optional fields. */
+export interface ApiCategory {
+    /** Namespace index (the Category namespace, 14). */
+    ns: NamespaceIndex;
+    /** Full category title, e.g. `Category:Manual`. */
+    title: string;
+    /** Raw (hex) sort key. `clprop=sortkey`. */
+    sortkey?: string;
+    /** Human-readable sort key prefix. `clprop=sortkey`. */
+    sortkeyprefix?: string;
+    /** When the page was added to the category. `clprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Whether the category is hidden. `clprop=hidden`; a real `boolean` (not a `Flag`). */
+    hidden?: boolean;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Categories the page belongs to (`prop=categories`). */
+        categories?: ApiCategory[];
+    }
+}

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

@@ -0,0 +1,25 @@
+/**
+ * `prop=categoryinfo` — membership counts for a category page, merged into
+ * {@link ApiPage} as an object (not an array).
+ *
+ * @see https://www.mediawiki.org/wiki/API:Categoryinfo
+ */
+/** Category size statistics (`prop=categoryinfo`). */
+export interface ApiCategoryInfo {
+    /** Total member count: pages + subcategories + files (the raw `cat_pages` counter). */
+    size: number;
+    /** Number of content pages, excluding both subcategories and files. */
+    pages: number;
+    /** Number of files. */
+    files: number;
+    /** Number of subcategories. */
+    subcats: number;
+    /** Whether the category is a hidden category. A real `boolean`. */
+    hidden: boolean;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Category membership counts (`prop=categoryinfo`). */
+        categoryinfo?: ApiCategoryInfo;
+    }
+}

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

@@ -0,0 +1,38 @@
+/**
+ * `list=categorymembers` — the pages/subcategories/files in a category, merged
+ * into {@link ApiQueryResult} via declaration merging.
+ *
+ * Also used as a generator (`generator=categorymembers`), which instead feeds
+ * results into `query.pages` (combined with any `prop=`); the generator's
+ * cursor is `gcmcontinue`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Categorymembers
+ */
+import type { NamespaceIndex, Timestamp } from "../../common";
+/**
+ * Member type (`cmtype` / `gcmtype`). Open union for forward compatibility.
+ */
+export type CategoryMemberType = "page" | "subcat" | "file" | (string & {});
+/** One category member. `cmprop` controls which fields appear. */
+export interface ApiCategoryMember {
+    /** Page id. `cmprop=ids`. */
+    pageid?: number;
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Full page title. */
+    title?: string;
+    /** Raw (hex) sort key. `cmprop=sortkey`. */
+    sortkey?: string;
+    /** Human-readable sort key prefix. `cmprop=sortkeyprefix`. */
+    sortkeyprefix?: string;
+    /** Member type. `cmprop=type`. */
+    type?: CategoryMemberType;
+    /** When the page was added to the category. `cmprop=timestamp`. */
+    timestamp?: Timestamp;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Category members (`list=categorymembers`). */
+        categorymembers?: ApiCategoryMember[];
+    }
+}

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

@@ -0,0 +1,40 @@
+/**
+ * `list=codexicons` — fetch Codex icon definitions by name, merged into
+ * {@link ApiQueryResult}.
+ *
+ * @see https://www.mediawiki.org/wiki/API:CodexIcons
+ * @since MediaWiki 1.44
+ */
+/**
+ * Directionality/language-aware icon definition (object form of
+ * {@link ApiCodexIcon}).
+ */
+export interface ApiCodexIconDefinition {
+    /** SVG markup used when no direction-specific variant applies. */
+    default?: string;
+    /** SVG markup for left-to-right contexts. */
+    ltr?: string;
+    /** SVG markup for right-to-left contexts. */
+    rtl?: string;
+    /** Whether the icon should be flipped in right-to-left contexts. */
+    shouldFlip?: boolean;
+    /** Languages excluded from flipping, e.g. `["he", "yi"]`. */
+    shouldFlipExceptions?: string[];
+    /** Language-specific SVG markup, keyed by language code. */
+    langCodeMap?: Record<string, string>;
+}
+/** A Codex icon: raw SVG markup, or a directionality/language-aware definition. */
+export type ApiCodexIcon = string | ApiCodexIconDefinition;
+declare module "./index" {
+    interface ApiQueryResult {
+        /**
+         * Codex icon definitions, keyed by icon name (e.g. `cdxIconInfo`).
+         * `list=codexicons&names=…` (`names` is required). Simple icons are raw
+         * SVG markup strings; directionality/language-aware icons are definition
+         * objects.
+         *
+         * @since MediaWiki 1.44
+         */
+        codexicons?: Record<string, ApiCodexIcon> | unknown[];
+    }
+}

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

@@ -0,0 +1,23 @@
+/**
+ * `prop=contributors` — the distinct editors of a page, merged into the shared
+ * {@link ApiPage} shape via declaration merging. Only logged-in contributors
+ * (registered and temporary accounts) are listed; anonymous (IP) editors are
+ * not, and only their distinct count is reported as `anoncontributors`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Contributors
+ */
+/** One contributor entry: a logged-in (registered or temporary) editor. */
+export interface ApiContributor {
+    /** User id of the contributor. */
+    userid: number;
+    /** Contributor name (IPs never appear as contributors). */
+    name: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Distinct logged-in contributors to the page (`prop=contributors`). */
+        contributors?: ApiContributor[];
+        /** Number of anonymous (IP) contributors to the page (`prop=contributors`). */
+        anoncontributors?: number;
+    }
+}

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

@@ -0,0 +1,21 @@
+/**
+ * `prop=deletedrevisions` — revisions of a page that have been deleted
+ * (revision-deleted), merged into the shared {@link ApiPage}. Viewing revision
+ * comment fields requires the `deletedhistory` right, and viewing slot content
+ * requires `deletedtext` (or `undelete`).
+ *
+ * Rows share {@link ApiRevision} with `prop=revisions`: MediaWiki formats both
+ * with the same revision formatter, so the suppressed-field flags
+ * (`userhidden`/`commenthidden`/`texthidden`) apply here as well.
+ *
+ * Fully deleted pages come back with `missing` plus their archived revisions.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Deletedrevisions
+ */
+import type { ApiRevision } from "./revisions";
+declare module "./index" {
+    interface ApiPage {
+        /** Deleted revisions of the page (`prop=deletedrevisions`). */
+        deletedrevisions?: ApiRevision[];
+    }
+}

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

@@ -0,0 +1,84 @@
+/**
+ * `list=deletedrevs` — deleted revisions across the wiki, grouped per page.
+ *
+ * @deprecated since MediaWiki 1.25. Core answers the request with a deprecation
+ * notice in `warnings`; use `prop=deletedrevisions` for a known title or
+ * `list=alldeletedrevisions` to enumerate. Modeled anyway because clients still call it.
+ *
+ * Its `drprop` names predate the modern modules: `revid`/`parentid`/`minor`/`len`
+ * rather than `ids`/`flags`/`size`, and {@link ApiDeletedRev.len} is a **string**.
+ * Pages are grouped under a synthetic counter, which `formatversion=2` emits as a
+ * list — unlike `list=alldeletedrevisions`, which carries the real `pageid`.
+ *
+ * On 1.41+ `drprop=content` fails with an internal error; the other `drprop`
+ * values (including the deprecated `token`) still answer.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Deletedrevs
+ */
+import type { Flag, NamespaceIndex, Timestamp } from "../../common";
+/** One archived revision, as `list=deletedrevs` formats it. */
+export interface ApiDeletedRev {
+    /** Revision timestamp — returned unconditionally, not a `drprop` value. */
+    timestamp: Timestamp;
+    /** Revision id. `drprop=revid`. */
+    revid?: number;
+    /** Parent revision id; `0` for a page's first revision. `drprop=parentid`. */
+    parentid?: number;
+    /** Editor name. `drprop=user`. */
+    user?: string;
+    /** Editor user id. `drprop=userid`. */
+    userid?: number;
+    /** Raw edit summary. `drprop=comment`. */
+    comment?: string;
+    /** HTML-rendered edit summary. `drprop=parsedcomment`. */
+    parsedcomment?: string;
+    /** Whether the edit was marked minor. `drprop=minor`; a real `boolean`. */
+    minor?: boolean;
+    /**
+     * Revision size in bytes, **as a string** (`"19"`) — this module passes the raw
+     * archive column through. `drprop=len`.
+     */
+    len?: string;
+    /** Content checksum (hex), or `''` when unavailable. `drprop=sha1`. */
+    sha1?: string;
+    /** Change tags. `drprop=tags`; `[]` when none. */
+    tags?: string[];
+    /** The author is hidden. Revision-delete; a {@link Flag}. */
+    userhidden?: Flag;
+    /** The edit summary is hidden. Revision-delete; a {@link Flag}. */
+    commenthidden?: Flag;
+    /** The content is hidden, which also hides `sha1`. Revision-delete; a {@link Flag}. */
+    texthidden?: Flag;
+    /** The checksum is withheld. A {@link Flag}. */
+    sha1hidden?: Flag;
+    /** The revision is oversighted (in addition to being deleted). A {@link Flag}. */
+    suppressed?: Flag;
+}
+/** One page group. `drprop=content` also yields the revision text, which is not modeled. */
+export interface ApiDeletedRevs {
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** The page's archived revisions. */
+    revisions: ApiDeletedRev[];
+    /**
+     * Token for restoring the revisions; a CSRF token (the same value for every
+     * page), issued only to callers with the `undelete` right on same-origin
+     * requests. `drprop=token`.
+     *
+     * @deprecated since MediaWiki 1.24; request a CSRF token from `meta=tokens`
+     * instead.
+     */
+    token?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /**
+         * Deleted revisions grouped per page (`list=deletedrevs`).
+         *
+         * @deprecated since MediaWiki 1.25; prefer {@link ApiQueryResult.alldeletedrevisions}.
+         */
+        deletedrevs?: ApiDeletedRevs[];
+    }
+}

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

@@ -0,0 +1,30 @@
+/**
+ * `prop=duplicatefiles` — other files that share a file's checksum, merged into
+ * the shared {@link ApiPage}. How a client discovers a “this file already exists”
+ * answer after the fact; `list=allimages` and `prop=imageinfo` reach the same
+ * rows by `sha1`.
+ *
+ * The module takes no `prop` parameter: `name`, `timestamp` and `shared` are
+ * always present, while `user` needs a visible uploader.
+ * `dflocalonly` limits it to the local repo, `dfdir`/`dfcontinue` page it.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Duplicatefiles
+ */
+import type { Timestamp } from "../../common";
+/** One other file with the same content. */
+export interface ApiDuplicateFile {
+    /** File name with underscores, without the `File:` prefix. */
+    name: string;
+    /** When that file's current version was uploaded. */
+    timestamp: Timestamp;
+    /** Whether the file lives on a shared repo rather than this wiki. A real `boolean`. */
+    shared: boolean;
+    /** Uploader of that file's current version. Absent when the uploader is hidden. */
+    user?: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Files whose content matches this one (`prop=duplicatefiles`). */
+        duplicatefiles?: ApiDuplicateFile[];
+    }
+}

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

@@ -0,0 +1,28 @@
+/**
+ * `list=embeddedin` — pages that transclude (embed) a given title, merged into
+ * {@link ApiQueryResult}. The title-based sibling of `prop=transcludedin`.
+ *
+ * The module has no `eiprop` parameter: every entry always carries `pageid`,
+ * `ns` and `title`. Unlike `list=backlinks`, there is no redirect parameter, so
+ * results are never nested.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Embeddedin
+ */
+import type { Flag, NamespaceIndex } from "../../common";
+/** One page that embeds the target title. */
+export interface ApiEmbeddedIn {
+    /** Page id. */
+    pageid: number;
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** The embedding page is itself a redirect. A {@link Flag}. */
+    redirect?: Flag;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Pages embedding `eititle` (`list=embeddedin`). */
+        embeddedin?: ApiEmbeddedIn[];
+    }
+}

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

@@ -0,0 +1,17 @@
+/**
+ * `prop=extlinks` — external (non-wiki) URLs linked by a page, merged into
+ * {@link ApiPage}.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Extlinks
+ */
+/** One external link used by a page. */
+export interface ApiExternalLink {
+    /** Full external URL. */
+    url: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** External links on this page (`prop=extlinks`). */
+        extlinks?: ApiExternalLink[];
+    }
+}