types-mediawiki-response 1.0.0-alpha.1

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

@@ -0,0 +1,103 @@
+/**
+ * `list=recentchanges` — the recent-changes feed, merged into
+ * {@link ApiQueryResult} via declaration merging.
+ *
+ * `new` / `minor` / `bot` are real booleans (emitted under `rcprop=flags`,
+ * `false` included); `type` is always present; the `log*` fields appear only
+ * for `type=log` entries.
+ *
+ * @see https://www.mediawiki.org/wiki/API:RecentChanges
+ */
+import type { Flag, NamespaceIndex, Timestamp } from "../../common";
+/** Change type (`rctype`). Open union for forward compatibility. */
+export type RecentChangeType = "edit" | "new" | "log" | "categorize" | "external" | (string & {});
+/** One recent-changes entry. `rcprop` controls which fields appear. */
+export interface ApiRecentChange {
+    /** Change type. */
+    type: RecentChangeType;
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Page title. */
+    title?: string;
+    /** Page id; `0` for log entries without a page. `rcprop=ids`. */
+    pageid?: number;
+    /** Revision id; `0` for log entries. `rcprop=ids`. */
+    revid?: number;
+    /** Previous revision id. `rcprop=ids`. */
+    old_revid?: number;
+    /** Recent-changes record id. `rcprop=ids`. */
+    rcid?: number;
+    /** Actor user name or IP. `rcprop=user`. */
+    user?: string;
+    /** Actor user id. `rcprop=userid`. */
+    userid?: number;
+    /** Whether the change was made by a bot. `rcprop=flags`; a real `boolean`. */
+    bot?: boolean;
+    /** Whether the change created a new page. `rcprop=flags`; a real `boolean`. */
+    new?: boolean;
+    /** Whether the edit was minor. `rcprop=flags`; a real `boolean`. */
+    minor?: boolean;
+    /** Whether the target is a redirect. `rcprop=redirect`; a real `boolean`. */
+    redirect?: boolean;
+    /**
+     * Whether the change has been patrolled (manually or automatically).
+     * `rcprop=patrolled` (requires rights).
+     */
+    patrolled?: boolean;
+    /** Auto-patrolled flag. `rcprop=patrolled`. */
+    autopatrolled?: boolean;
+    /** Unpatrolled flag. `rcprop=patrolled`. */
+    unpatrolled?: boolean;
+    /** Old revision size in bytes. `rcprop=sizes`. */
+    oldlen?: number;
+    /** New revision size in bytes. `rcprop=sizes`. */
+    newlen?: number;
+    /** Change timestamp. `rcprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Raw summary. `rcprop=comment`. */
+    comment?: string;
+    /** HTML-rendered summary. `rcprop=parsedcomment`. */
+    parsedcomment?: string;
+    /** Change tags. `rcprop=tags`. */
+    tags?: string[];
+    /** Content checksum (hex). `rcprop=sha1`. */
+    sha1?: string;
+    /**
+     * Made by an anonymous (IP) editor. `rcprop=user|userid`; a {@link Flag}
+     * (appears only when true, unlike this module's real-boolean `flags`).
+     */
+    anon?: Flag;
+    /**
+     * The actor is a temporary account. `rcprop=user|userid`; a {@link Flag}.
+     *
+     * @since MediaWiki 1.42
+     */
+    temp?: Flag;
+    /** The log action is hidden (log-deleted). `rcprop=ids|title|loginfo`; a {@link Flag}. */
+    actionhidden?: Flag;
+    /** The actor is hidden. Revision/log-deleted; a {@link Flag}. */
+    userhidden?: Flag;
+    /** The summary is hidden. Revision/log-deleted; a {@link Flag}. */
+    commenthidden?: Flag;
+    /** `sha1` is withheld because the content is hidden. A {@link Flag}. */
+    sha1hidden?: Flag;
+    /**
+     * Oversight/suppression applies to this change (set together with the
+     * `*hidden` flags). A {@link Flag}.
+     */
+    suppressed?: Flag;
+    /** Log id. `rcprop=loginfo` (only for `type=log`). */
+    logid?: number;
+    /** Log type, e.g. `newusers`. `rcprop=loginfo`. */
+    logtype?: string;
+    /** Log action, e.g. `create`. `rcprop=loginfo`. */
+    logaction?: string;
+    /** Structured log parameters. `rcprop=loginfo`. */
+    logparams?: Record<string, unknown>;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Recent changes (`list=recentchanges`). */
+        recentchanges?: ApiRecentChange[];
+    }
+}

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

@@ -0,0 +1,27 @@
+/**
+ * `prop=redirects` — pages that redirect to the queried page, merged into
+ * {@link ApiPage} via declaration merging.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Redirects
+ */
+import type { NamespaceIndex } from "../../common";
+/** One redirect entry. `rdprop` controls which fields appear. */
+export interface ApiRedirect {
+    /** Page id of the redirect. `rdprop=pageid`. */
+    pageid?: number;
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Full title of the redirect page. */
+    title?: string;
+    /**
+     * Section/anchor fragment the redirect points to. `rdprop=fragment`.
+     * Omitted entirely when the redirect has no fragment.
+     */
+    fragment?: string;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Redirects pointing at this page (`prop=redirects`). */
+        redirects?: ApiRedirect[];
+    }
+}

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

@@ -0,0 +1,176 @@
+/**
+ * `prop=revisions` — a page's revision history, merged into the shared
+ * {@link ApiPage} shape via declaration merging.
+ *
+ * Which fields appear depends on `rvprop`; content-related fields come back in
+ * the `slots` map when `rvslots=` is used (see {@link ApiRevision.slots}).
+ * Under `formatversion=2`, `minor` is a real `boolean`, while `anon` / `temp`
+ * are {@link Flag}s that appear only when true.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Revisions
+ */
+import type { ContentFormat, ContentModel, Flag, Timestamp } from "../../common";
+/** One content slot of a revision (a revision may have multiple named slots). */
+export interface ApiRevisionSlot {
+    /** Content model of this slot, e.g. `wikitext`. `rvprop=contentmodel`. */
+    contentmodel?: ContentModel;
+    /** Serialization format of this slot, e.g. `text/x-wiki`. `rvprop=content`. */
+    contentformat?: ContentFormat;
+    /** Slot size in bytes. `rvprop=slotsize`. */
+    size?: number;
+    /** Slot content checksum (hex). `rvprop=slotsha1`. May be empty (`''`). */
+    sha1?: string;
+    /** The slot content is hidden (revision-deleted). `rvprop=content`; a {@link Flag}. */
+    texthidden?: Flag;
+    /** The slot checksum is hidden (revision-deleted). `rvprop=slotsha1`; a {@link Flag}. */
+    sha1hidden?: Flag;
+    /** The slot could not be read for this revision; a {@link Flag}. */
+    missing?: Flag;
+    /** The slot has no content to return (e.g. deleted text); a {@link Flag}. */
+    textmissing?: Flag;
+    /**
+     * The requested `rvsection` does not exist in this slot; a {@link Flag}.
+     * Without `rvslots=` the same condition surfaces as a `nosuchsection` API
+     * error instead.
+     */
+    nosuchsection?: Flag;
+    /** The requested content format is not supported by this slot's model. `rvprop=content`; a {@link Flag}. */
+    badcontentformat?: Flag;
+    /**
+     * Slot body. `rvprop=content`. Absent when the text is suppressed
+     * (see {@link ApiRevisionSlot.texthidden}) or not requested.
+     */
+    content?: string;
+}
+/**
+ * The `slots` map, keyed by slot role. `main` is the default slot; extensions
+ * may add others (e.g. `top`, `bottom`). The index signature keeps it open.
+ */
+export interface ApiRevisionSlots {
+    /** The default slot. */
+    main?: ApiRevisionSlot;
+    [role: string]: ApiRevisionSlot | undefined;
+}
+/**
+ * Diff output attached to a revision (`rvdiffto`/`rvdifftotext`; both request
+ * parameters are deprecated — prefer `action=compare`).
+ */
+export interface ApiRevisionDiff {
+    /** Revision id the diff starts from. */
+    from?: number;
+    /** Revision id the diff ends at. */
+    to?: number;
+    /** Rendered HTML diff table. */
+    body?: string;
+    /** The diff was not cached and was computed at request time; a {@link Flag}. */
+    notcached?: Flag;
+    /** The content format is not supported, so no diff was built; a {@link Flag}. */
+    badcontentformat?: Flag;
+}
+/** A single revision entry in `pages[].revisions`. */
+export interface ApiRevision {
+    /** Revision id. `rvprop=ids`. */
+    revid?: number;
+    /** Previous revision id; `0` for the first revision of a page. `rvprop=ids`. */
+    parentid?: number;
+    /** Whether the edit was marked minor. `rvprop=flags`; a real `boolean` (present as `false`). */
+    minor?: boolean;
+    /** Made by an anonymous (IP) editor. `rvprop=user|userid`; a {@link Flag}. */
+    anon?: Flag;
+    /** Editor user name. `rvprop=user`. */
+    user?: string;
+    /** Editor user id; `0` for anonymous editors. `rvprop=userid`. */
+    userid?: number;
+    /** Revision timestamp. `rvprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** Revision size in bytes. `rvprop=size`. */
+    size?: number;
+    /** SHA-1 of the revision content (hex). `rvprop=sha1`. May be empty (`''`). */
+    sha1?: string;
+    /**
+     * Content model of the main slot at this revision. `rvprop=contentmodel`,
+     * and also emitted alongside the legacy top-level {@link content} body
+     * (`rvprop=content`). Top level only when `rvslots=` is not used; with
+     * `rvslots=` the content model lives in each slot.
+     */
+    contentmodel?: ContentModel;
+    /**
+     * Legacy top-level content body. Only when `rvslots=` is **not** used,
+     * together with `rvprop=content`; with `rvslots=` the body lives in each
+     * slot.
+     */
+    content?: string;
+    /**
+     * Serialization format of the legacy top-level {@link content}. Only when
+     * `rvslots=` is not used, with `rvprop=content`.
+     */
+    contentformat?: ContentFormat;
+    /** Raw edit summary. `rvprop=comment`. */
+    comment?: string;
+    /** HTML-rendered edit summary. `rvprop=parsedcomment`. */
+    parsedcomment?: string;
+    /** Change tags applied to this revision. `rvprop=tags`. */
+    tags?: string[];
+    /** Slot roles present on this revision, e.g. `["main"]`. `rvprop=roles`. */
+    roles?: string[];
+    /**
+     * Content slots. Requires `rvslots=` together with one of `rvprop=content`,
+     * `contentmodel`, `slotsize`, `slotsha1`; with none of those `rvprop` values
+     * no `slots` map is returned. Without `rvslots=` the content fields appear at
+     * the top level instead (legacy).
+     */
+    slots?: ApiRevisionSlots;
+    /**
+     * The edit summary is hidden (revision-deleted). `rvprop=comment|parsedcomment`
+     * on a suppressed revision; a {@link Flag}. Reviewers with the delete right
+     * still see `comment` (often the empty string); other viewers see it withheld.
+     */
+    commenthidden?: Flag;
+    /** The author is hidden. Revision-delete; a {@link Flag}. */
+    userhidden?: Flag;
+    /**
+     * The revision content is hidden (revision-deleted); a {@link Flag}.
+     * Top level only when `rvslots=` is not used; with `rvslots=` each slot
+     * carries its own `texthidden`.
+     */
+    texthidden?: Flag;
+    /**
+     * The requested content format is not supported by this revision's model.
+     * Top level only when `rvslots=` is not used; with `rvslots=` each slot
+     * carries its own `badcontentformat`. A {@link Flag}.
+     */
+    badcontentformat?: Flag;
+    /**
+     * The editor is a temporary account. `rvprop=user|userid` on a temp-account
+     * revision; a {@link Flag}.
+     *
+     * @since MediaWiki 1.42
+     */
+    temp?: Flag;
+    /**
+     * The SHA-1 (`sha1`) is withheld because the content is revision-deleted.
+     * `rvprop=sha1`; a {@link Flag}.
+     */
+    sha1hidden?: Flag;
+    /**
+     * Oversight/suppression is in effect on this revision (set when any visibility
+     * restriction applies, alongside the `*hidden` flags). A {@link Flag}.
+     */
+    suppressed?: Flag;
+    /** Diff of this revision against `rvdiffto`/`rvdifftotext` (both deprecated; prefer `action=compare`). */
+    diff?: ApiRevisionDiff;
+    /** A slot could not be read for this revision (slot access failure); a {@link Flag}. */
+    slotsmissing?: Flag;
+    /**
+     * The revision has no content to return (e.g. deleted text). Top level only
+     * when `rvslots=` is not used; with `rvslots=` each slot carries its own
+     * `textmissing`. A {@link Flag}.
+     */
+    textmissing?: Flag;
+}
+declare module "./index" {
+    interface ApiPage {
+        /** Revisions of the page (`prop=revisions`), newest first unless `rvdir=newer`. */
+        revisions?: ApiRevision[];
+    }
+}

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

@@ -0,0 +1,141 @@
+/**
+ * `list=search` — full-text search results, merged into {@link ApiQueryResult}
+ * via declaration merging, together with the `searchinfo` summary object.
+ *
+ * As `generator=search` the same hit fields are injected into `query.pages`
+ * entries — and into a `query.redirects` entry whose source is one of those
+ * pages — where the `g`-prefixed parameter forms apply (`gsrprop` / `gsrinfo`)
+ * and the framework adds `index`.
+ *
+ * Interwiki hits are reported outside `query.search`: `srinterwiki=1` collects
+ * them under `query.interwikisearch` keyed by interwiki prefix, and
+ * `enablerewrites=1` may surface backend-rewritten hits inline under
+ * `query.additionalsearch`. Each section carries its own totalhits counter
+ * under `<section>searchinfo`.
+ *
+ * @see https://www.mediawiki.org/wiki/API:Search
+ */
+import type { Flag, NamespaceIndex, Timestamp } from "../../common";
+/**
+ * One search hit (`list=search`), and the page data `generator=search` injects
+ * into a `query.pages` entry.
+ *
+ * Which fields appear is controlled by `srprop` for `list=search` and by
+ * `gsrprop` for `generator=search`. The two differ in their default: `gsrprop`
+ * defaults to empty in generator mode, so only `ns`, `title`, `pageid` and the
+ * injected `index` appear unless `gsrprop` is passed explicitly.
+ */
+export interface ApiSearchResult {
+    /** Namespace index. */
+    ns?: NamespaceIndex;
+    /** Full page title. */
+    title?: string;
+    /** Page id. */
+    pageid?: number;
+    /** Page size in bytes. `srprop=size`. */
+    size?: number;
+    /** Word count. `srprop=wordcount`. */
+    wordcount?: number;
+    /** Last-edit timestamp. `srprop=timestamp`. */
+    timestamp?: Timestamp;
+    /** HTML snippet of the match, with highlights. `srprop=snippet`. */
+    snippet?: string;
+    /** HTML snippet of the title. `srprop=titlesnippet`. */
+    titlesnippet?: string;
+    /** Snippet of the matching category. `srprop=categorysnippet`. */
+    categorysnippet?: string;
+    /** Title of the section the match is in. `srprop=sectiontitle`. */
+    sectiontitle?: string;
+    /** HTML snippet of the section heading. `srprop=sectionsnippet`. */
+    sectionsnippet?: string;
+    /** Title of the redirect target, if this hit redirects. `srprop=redirecttitle`. */
+    redirecttitle?: string;
+    /** HTML snippet of the redirect target title. `srprop=redirectsnippet`. */
+    redirectsnippet?: string;
+    /** Whether the hit matched a file. `srprop=isfilematch`; a real `boolean`. */
+    isfilematch?: boolean;
+    /** Search-backend extension data, keyed by augmentor name. `srprop=extensiondata`. */
+    extensiondata?: unknown;
+}
+/**
+ * A `list=search` hit. The module writes `ns`, `title` and `pageid` for every
+ * hit, before any `srprop` value is considered, so they are required here —
+ * unlike {@link ApiSearchResult}, which stays all-optional because
+ * `generator=search` merges the same shape into {@link ApiPage} entries.
+ */
+export type ApiSearchHit = ApiSearchResult & {
+    /** Namespace index. */
+    ns: NamespaceIndex;
+    /** Full page title. */
+    title: string;
+    /** Page id. */
+    pageid: number;
+};
+/**
+ * One interwiki search hit, an element of
+ * {@link ApiQueryResult.interwikisearch} / {@link ApiQueryResult.additionalsearch}.
+ * Fields follow `srprop` exactly like {@link ApiSearchResult}, except `title`
+ * is the bare page name without the namespace, `pageid` is always `0`, and the
+ * interwiki namespace/URL fields below are added.
+ */
+export interface ApiSearchInterwikiResult extends ApiSearchResult {
+    /** Namespace name on the foreign wiki, as text. */
+    namespace?: string;
+    /** Full URL of the hit on the foreign wiki. */
+    url?: string;
+}
+/** Total-hit counter of an interwiki search section. */
+export interface ApiSearchInterwikiInfo {
+    /** Total number of interwiki hits across prefixes. */
+    totalhits?: number;
+}
+/** Per-search metadata (`list=search`'s `searchinfo` sibling). */
+export interface ApiSearchInfo {
+    /** Total number of matches (may be capped by the search backend). */
+    totalhits?: number;
+    /**
+     * Present (and `true`) when {@link totalhits} is only an approximation, i.e.
+     * the backend stopped counting early. A {@link Flag}: the key is omitted
+     * rather than set to `false`.
+     *
+     * @since MediaWiki 1.44
+     */
+    approximate_totalhits?: Flag;
+    /** Suggested rewrite when the query had no/few results (`srinfo=suggestion`). */
+    suggestion?: string;
+    /** HTML snippet of the suggestion, with the changed terms highlighted (`srinfo=suggestion`). */
+    suggestionsnippet?: string;
+    /** The query after search-side rewriting (`srinfo=rewrittenquery`). */
+    rewrittenquery?: string;
+    /** HTML snippet of the rewritten query, with the changes highlighted (`srinfo=rewrittenquery`). */
+    rewrittenquerysnippet?: string;
+}
+declare module "./index" {
+    interface ApiQueryResult {
+        /** Search results (`list=search`). */
+        search?: ApiSearchHit[];
+        /**
+         * Search summary metadata. Emitted by `list=search`, or by
+         * `generator=search` when the request passes `gsrinfo` — the generator
+         * form defaults to no `searchinfo` at all.
+         */
+        searchinfo?: ApiSearchInfo;
+        /**
+         * Interwiki search hits keyed by interwiki prefix (`srinterwiki=1`).
+         */
+        interwikisearch?: Record<string, ApiSearchInterwikiResult[]>;
+        /** Total-hit counter for {@link interwikisearch}. */
+        interwikisearchinfo?: ApiSearchInterwikiInfo;
+        /**
+         * Interwiki hits the backend matched inline (`enablerewrites=1`), same
+         * shape as {@link interwikisearch}.
+         */
+        additionalsearch?: Record<string, ApiSearchInterwikiResult[]>;
+        /** Total-hit counter for {@link additionalsearch}. */
+        additionalsearchinfo?: ApiSearchInterwikiInfo;
+    }
+    interface ApiPage extends ApiSearchResult {
+    }
+    interface ApiQueryResolvedRedirect extends ApiSearchResult {
+    }
+}