types-mediawiki-response 1.0.1 → 1.1.1

package/dist/common/index.d.ts

@@ -23,6 +23,11 @@ export type Expiry = Timestamp | "infinity";
  * literal `infinite` for an indefinite block.
  */
 export type BlockExpiry = Timestamp | "infinite";
+/**
+ * Expiry of a watch: a timestamp, or `null` when the page is not watched or
+ * the watch is permanent.
+ */
+export type WatchlistExpiry = Timestamp | null;
 /**
  * A block of plain text (as opposed to HTML), e.g. a TextExtracts excerpt
  * requested with `explaintext`. Kept distinct from HTML-bearing string fields.
@@ -30,16 +35,6 @@ export type BlockExpiry = Timestamp | "infinite";
 export type PlainText = string;
 /** Namespace index. Negative indexes are pseudo-namespaces. */
 export type NamespaceIndex = number;
-/**
- * `success` — or the actual outcome string when an operation did not succeed.
- * **Open union**: `(string & {})` keeps other outcomes forward-compatible.
- */
-export type SuccessStatus = "success" | (string & {});
-/**
- * `Success` — or the actual result string when an operation did not succeed.
- * **Open union**: `(string & {})` keeps other outcomes forward-compatible.
- */
-export type SuccessResult = "Success" | (string & {});
 /**
  * A structured in-band message — a serialized MediaWiki `Message`/`FatalError`
  * spec (`{ message, params, code, type }`) nested inside an action result
@@ -81,7 +76,7 @@ export interface ApiWatchlistLabel {
  * promote their own models by augmenting {@link ContentModelExtension}
  * (e.g. `MassMessageListContent` from the MassMessage pack); consumers may
  * augment the same interface for site-specific models registered through
- * `$wgContentModels`.
+ * `$wgContentHandlers`.
  */
 export type ContentModel = "wikitext" | "javascript" | "css" | "json" | "text" | "Scribunto" | ContentModelExtension[keyof ContentModelExtension] | (string & {});
 /**
@@ -91,7 +86,7 @@ export type ContentModel = "wikitext" | "javascript" | "css" | "json" | "text" |
  * {@link ContentModel}.
  *
  * @example
- * // A site-specific model registered through $wgContentModels:
+ * // A site-specific model registered through $wgContentHandlers:
  * declare module "types-mediawiki-response" {
  *   interface ContentModelExtension {
  *     MyModel: "my-model";

package/dist/core/block.d.ts

@@ -9,7 +9,7 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Block
  */
-import type { BlockExpiry, Timestamp } from "../common";
+import type { BlockExpiry, Timestamp, WatchlistExpiry } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** The `block` object of an `action=block` response. */
 export interface ApiBlockResult {
@@ -40,19 +40,17 @@ export interface ApiBlockResult {
     /** Restrict the block to specific pages or namespaces instead of sitewide. */
     partial: boolean;
     /** Page restrictions of a partial block; `null` when sitewide. */
-    pagerestrictions: unknown;
+    pagerestrictions: string[] | null;
     /** Namespace restrictions of a partial block; `null` when sitewide. */
-    namespacerestrictions: unknown;
+    namespacerestrictions: number[] | null;
+    /** Expiry applied to the watched user page. */
+    watchlistexpiry?: WatchlistExpiry;
     /**
-     * Expiry applied to the watched user page, present only when the request
-     * passed `watchlistexpiry`; `null` when the page is not actually watched.
+     * Restricted actions of a partial action block; `null` when the block
+     * restricts no actions. Only emitted on MediaWiki 1.39–1.44 when
+     * `$wgEnablePartialActionBlocks` is on.
      */
-    watchlistexpiry?: Timestamp | null;
-    /**
-     * Restricted actions of a partial action block; only emitted when
-     * `$wgEnablePartialActionBlocks` is enabled.
-     */
-    actionrestrictions?: string[];
+    actionrestrictions?: string[] | null;
     /**
      * When the block was applied, in ISO 8601.
      *

package/dist/core/changeauthenticationdata.d.ts

@@ -8,13 +8,12 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Changeauthenticationdata
  */
-import type { SuccessStatus } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=changeauthenticationdata`. */
 export interface ApiChangeAuthenticationDataResponse extends ApiEnvelope {
     /** Result of `action=changeauthenticationdata`. */
     changeauthenticationdata: {
         /** Flow outcome; `success` when the change was applied. */
-        status: SuccessStatus;
+        status: "success";
     };
 }

package/dist/core/changecontentmodel.d.ts

@@ -6,14 +6,14 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Changecontentmodel
  */
-import type { ContentModel, SuccessResult } from "../common";
+import type { ContentModel } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=changecontentmodel`. */
 export interface ApiChangeContentModelResponse extends ApiEnvelope {
     /** Result of `action=changecontentmodel`. */
     changecontentmodel: {
         /** `Success` when the model was changed. */
-        result: SuccessResult;
+        result: "Success";
         /** Page title. */
         title: string;
         /** Page id. */

package/dist/core/checktoken.d.ts

@@ -6,14 +6,13 @@
  * `maxtokenage`), or `invalid`. `generated` is decoded from the submitted
  * token itself (MediaWiki tokens embed their generation time), so it appears
  * whenever the token carries a timestamp — an old token reports its own age.
- * Modeled as an open union for forward compatibility.
  *
  * @see https://www.mediawiki.org/wiki/API:Checktoken
  */
 import type { Timestamp } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Result values of {@link ApiCheckTokenResponse}. */
-export type ApiCheckTokenResult = "valid" | "expired" | "invalid" | (string & {});
+export type ApiCheckTokenResult = "valid" | "expired" | "invalid";
 /** Response of `action=checktoken`. */
 export interface ApiCheckTokenResponse extends ApiEnvelope {
     /** Result of `action=checktoken`. */

package/dist/core/managetags.d.ts

@@ -9,8 +9,8 @@
  */
 import type { ApiSpecMessage } from "../common";
 import type { ApiEnvelope, ApiMessage } from "../envelope";
-/** `action=managetags` operation. Open union for forward compatibility. */
-export type ApiManageTagsOperation = "activate" | "create" | "deactivate" | "delete" | (string & {});
+/** `action=managetags` operation, echoed from the request. */
+export type ApiManageTagsOperation = "activate" | "create" | "deactivate" | "delete";
 /** Response of `action=managetags`. */
 export interface ApiManageTagsResponse extends ApiEnvelope {
     /** Result of `action=managetags`. */

package/dist/core/options.d.ts

@@ -8,10 +8,9 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Options
  */
-import type { SuccessStatus } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=options`. */
 export interface ApiOptionsResponse extends ApiEnvelope {
     /** Success sentinel (`"success"`); failures come back as a top-level error. */
-    options: SuccessStatus;
+    options: "success";
 }

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

@@ -19,7 +19,7 @@ export interface ApiBlockRestrictions {
     }[];
     /** Restricted namespace ids. */
     namespaces?: number[];
-    /** Restricted actions; only on wikis with `$wgEnablePartialActionBlocks` enabled. */
+    /** Restricted actions; only on action-type entries. Before MediaWiki 1.45 these require `$wgEnablePartialActionBlocks`. */
     actions?: string[];
 }
 /** One block record. `bkprop` controls which fields appear. */

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

@@ -9,10 +9,8 @@
  * @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 & {});
+/** Member type (`cmtype` / `gcmtype`). */
+export type CategoryMemberType = "page" | "subcat" | "file";
 /** One category member. `cmprop` controls which fields appear. */
 export interface ApiCategoryMember {
     /** Page id. `cmprop=ids`. */

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

@@ -448,6 +448,7 @@ export interface ApiQueryResponse extends ApiEnvelope {
     "query-noncontinue"?: Record<string, Record<string, string | number>>;
 }
 export * from "./shared";
+export * from "./logparams";
 export * from "./info";
 export * from "./categories";
 export * from "./revisions";

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

@@ -58,8 +58,8 @@ export interface ApiPageInfo {
     pagelanguage?: string;
     /** HTML `lang` attribute value for the page language. */
     pagelanguagehtmlcode?: string;
-    /** Writing direction of the page language. Open union for forward compatibility. */
-    pagelanguagedir?: "ltr" | "rtl" | (string & {});
+    /** Writing direction of the page language. */
+    pagelanguagedir?: "ltr" | "rtl";
     /** When the page was last touched (cache/link invalidation), not last edited. Existing pages only. */
     touched?: Timestamp;
     /** Revision id of the latest revision. Existing pages only. */

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

@@ -11,8 +11,8 @@ export interface ApiLanguageInfo {
     code?: string;
     /** BCP 47 language tag. `liprop=bcp47`. */
     bcp47?: string;
-    /** Writing direction. `liprop=dir`. Open union for forward compatibility. */
-    dir?: "ltr" | "rtl" | (string & {});
+    /** Writing direction. `liprop=dir`. */
+    dir?: "ltr" | "rtl";
     /** Name in the language itself. `liprop=autonym`. */
     autonym?: string;
     /** Name in the content/`uselang` language. `liprop=name`. */

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

@@ -9,6 +9,7 @@
  */
 import type { Flag, NamespaceIndex, Timestamp } from "../../common";
 import type { ApiHiddenFlags } from "./shared";
+import type { ApiLogEventParams } from "./logparams";
 /** One log event. `leprop` controls which fields appear. */
 export interface ApiLogEvent extends ApiHiddenFlags {
     /** Log record id. `leprop=ids`. */
@@ -31,8 +32,11 @@ export interface ApiLogEvent extends ApiHiddenFlags {
     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>;
+    /**
+     * Structured log details; shape varies by `type`/`action` — see
+     * {@link ApiLogEventParams}. `leprop=details`.
+     */
+    params?: ApiLogEventParams;
     /** Performing user name (or IP). `leprop=user`. */
     user?: string;
     /** Performing user id. `leprop=userid`. */

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

@@ -0,0 +1,283 @@
+/**
+ * Structured details of log events, shared by `logevents.params`,
+ * `recentchanges.logparams` and `watchlist.logparams`.
+ */
+import type { ContentModel, Expiry, Timestamp } from "../../common";
+/**
+ * Structured log details — the `params` object of a log event (`leprop=details`
+ * on `list=logevents`, `logparams` under the log-info fields of
+ * `list=recentchanges` / `list=watchlist`).
+ *
+ * Each log action writes its own key set, which the server normalizes for the
+ * API. The keys below are the ones MediaWiki core itself writes; which of
+ * them a row carries depends on its `type`/`action`.
+ *
+ * The key space is open: extensions and site configuration can register
+ * further log actions, and rows written by older MediaWiki versions keep
+ * their historical key forms. Unknown keys therefore fall back to `unknown`
+ * instead of erroring. Consumers targeting one specific log action — or a
+ * site-custom one — can add its keys through interface merging:
+ *
+ * @example
+ * declare module "types-mediawiki-response" {
+ *   interface ApiLogEventParams {
+ *     // a site-custom log action, or a legacy key form still in the data
+ *     "4::target"?: string;
+ *   }
+ * }
+ */
+export interface ApiLogEventParams {
+    /**
+     * Block duration as configured: `'infinity'` or the raw specifier
+     * (`'2 weeks'`, …), on `block/block`, `block/reblock`, `suppress/block` and
+     * `suppress/reblock` rows. Older rows without one are normalized to
+     * `'infinity'`.
+     */
+    duration?: string;
+    /**
+     * Options in force on the block. Rows written by very old MediaWiki
+     * versions may carry the legacy values `autoblock` or `angry-autoblock`
+     * instead of the current flag set. An array (`[]` when none).
+     */
+    flags?: Array<"anononly" | "nocreate" | "noautoblock" | "noemail" | "nousertalk" | "hiddenname" | "autoblock" | "angry-autoblock">;
+    /**
+     * Absolute expiry of the block (ISO 8601), on rows with a finite duration.
+     */
+    expiry?: Timestamp;
+    /** Whether the block covers the whole site (`false` for a partial block). */
+    sitewide?: boolean;
+    /** Scope of a partial block; absent for sitewide blocks. */
+    restrictions?: ApiLogBlockRestrictions;
+    /**
+     * Id of the block the row created or changed.
+     *
+     * @since MediaWiki 1.44
+     */
+    blockId?: number;
+    /**
+     * Localized duration text (e.g. `'14 days'`, `'infinite'`), in the
+     * requesting user's language.
+     *
+     * @since MediaWiki 1.44
+     */
+    "duration-l10n"?: string;
+    /** Namespace of the move destination (on `move/move` and `move/move_redir` rows). */
+    target_ns?: number;
+    /** Title of the move destination. */
+    target_title?: string;
+    /** Whether the move left no redirect behind. */
+    suppressredirect?: boolean;
+    /**
+     * Content-language protection summary (e.g. `'[edit=autoconfirmed]
+     * (indefinite)'`), aimed at machine feeds; the structured data lives in
+     * {@link details}.
+     */
+    description?: string;
+    /** Whether cascading protection was requested. */
+    cascade?: boolean;
+    /** Protection restrictions in force. */
+    details?: ApiLogProtectDetail[];
+    /** Namespace of the title the protection moved away from. */
+    oldtitle_ns?: number;
+    /** Title the protection moved away from. */
+    oldtitle_title?: string;
+    /**
+     * How many revisions and archived file versions the undeletion restored
+     * (`delete/restore`), how many revisions an import created
+     * (`import/upload`, `import/interwiki`), or how many uses a managed tag
+     * had (`managetags/activate|deactivate|delete`).
+     */
+    count?: {
+        revisions: number;
+        files: number;
+    } | number;
+    /**
+     * What the visibility change targeted: `'revision'`, `'archive'`,
+     * `'oldimage'` or `'filearchive'` on `…/revision` rows; `'logging'` on
+     * `…/event` rows.
+     */
+    type?: "revision" | "archive" | "oldimage" | "filearchive" | "logging";
+    /**
+     * Ids of the targeted revisions, file versions or log entries — numbers on
+     * current rows, strings on legacy ones.
+     */
+    ids?: Array<number | string>;
+    /** Visibility state before the change. */
+    old?: ApiLogRevDelVisibility;
+    /** Visibility state after the change. */
+    new?: ApiLogRevDelVisibility;
+    /**
+     * Id of the account the row reports (on `newusers/create`, `newusers/create2`
+     * and `newusers/autocreate` rows).
+     */
+    userid?: number;
+    /**
+     * Groups the target user belonged to before the change (on `rights/rights`
+     * and `rights/autopromote` rows).
+     */
+    oldgroups?: string[];
+    /** Groups after the change. */
+    newgroups?: string[];
+    /**
+     * Per-group membership expiry, parallel to {@link oldgroups}; `[]` when the
+     * memberships were all permanent. Absent on `rights/autopromote` rows.
+     */
+    oldmetadata?: ApiLogGroupMetadata[];
+    /**
+     * Per-group membership expiry, parallel to {@link newgroups}; `[]` when
+     * permanent. Absent on `rights/autopromote` rows.
+     */
+    newmetadata?: ApiLogGroupMetadata[];
+    /**
+     * Content model before the change (on `contentmodel/change` and
+     * `contentmodel/new` rows).
+     */
+    oldmodel?: ContentModel;
+    /** Content model after the change. */
+    newmodel?: ContentModel;
+    /** Namespace of the page the history was merged into. */
+    dest_ns?: number;
+    /** Title of the page the history was merged into. */
+    dest_title?: string;
+    /**
+     * Namespace of the page whose history was merged in (`merge/merge-into` row
+     * filed on the destination page).
+     *
+     * @since MediaWiki 1.45
+     */
+    src_ns?: number;
+    /**
+     * Title of the page whose history was merged in (`merge/merge-into`).
+     *
+     * @since MediaWiki 1.45
+     */
+    src_title?: string;
+    /**
+     * Revision the histories were interleaved at (ISO 8601), on `merge/merge`
+     * and `merge/merge-into` rows.
+     */
+    mergepoint?: Timestamp;
+    /**
+     * Boundary revision id the merge stopped at; stored raw, so it appears as
+     * a number or its decimal string.
+     *
+     * @since MediaWiki 1.42
+     */
+    mergerevid?: number | string;
+    /**
+     * Timestamp of the first revision kept out of the merge, when a start
+     * boundary was used (ISO 8601); the id of that revision is
+     * {@link mergestartid}. Only `merge/merge` rows carry it — `merge/merge-into`
+     * rows do not report the start boundary at all.
+     *
+     * @since MediaWiki 1.45
+     */
+    mergestart?: Timestamp;
+    /**
+     * First revision id kept out of the merge; stored raw like
+     * {@link mergerevid}.
+     *
+     * @since MediaWiki 1.45
+     */
+    mergestartid?: number | string;
+    /** Namespace of the source page on the foreign wiki (`import/interwiki`). */
+    interwiki_ns?: number;
+    /** Source page on the foreign wiki, with its interwiki prefix (`import/interwiki`). */
+    interwiki_title?: string;
+    /**
+     * SHA-1 of the uploaded file (base36), on `upload/upload`, `upload/overwrite`
+     * and `upload/revert` rows.
+     */
+    img_sha1?: string;
+    /** File timestamp (ISO 8601), which can differ from the row's timestamp. */
+    img_timestamp?: Timestamp;
+    /** Revision id that was marked patrolled, on `patrol/patrol` rows. */
+    curid?: number;
+    /** Revision id the patrolled one followed. */
+    previd?: number;
+    /** Always `false`: automatic patrols are not logged. */
+    auto?: boolean;
+    /**
+     * Revision the tags were applied to (`tag/update` rows); a raw value from
+     * the tagging caller, so forms vary (a number, its decimal string, or
+     * `false` when the update targeted a log entry).
+     */
+    revid?: number | string | false;
+    /**
+     * Log entry the tags were applied to, on rows that targeted one; a raw
+     * value like {@link revid} — `false` when the update targeted a revision.
+     */
+    logid?: number | string | false;
+    /** Tags the update added. */
+    tagsAdded?: string[];
+    /** How many tags {@link tagsAdded} holds. */
+    tagsAddedCount?: number;
+    /** Tags the update removed. */
+    tagsRemoved?: string[];
+    /** How many tags {@link tagsRemoved} holds. */
+    tagsRemovedCount?: number;
+    /** Tags the target carried before the update. */
+    initialTags?: string[];
+    /** Name of the managed tag (`managetags/create|activate|deactivate|delete`). */
+    tag?: string;
+    /**
+     * Page language before the change, on `pagelang/pagelang` rows; the wiki's
+     * default language carries a `[def]` suffix (e.g. `'en[def]'`).
+     */
+    oldlanguage?: string;
+    /** Page language after the change; also `[def]`-suffixed when set to default. */
+    newlanguage?: string;
+    /**
+     * Any other parameter a log action attaches — a log action registered by an
+     * extension or site configuration, or a legacy key form on rows written by
+     * an older MediaWiki version.
+     */
+    [key: string]: unknown;
+}
+/** One page a partial block is restricted to (`restrictions.pages` entry). */
+export interface ApiLogPageRef {
+    /** Namespace index. */
+    page_ns: number;
+    /** Full page title. */
+    page_title: string;
+}
+/** Scope of a partial block (`restrictions`). */
+export interface ApiLogBlockRestrictions {
+    /** Pages the block is restricted to. */
+    pages?: ApiLogPageRef[];
+    /** Namespace indexes the block is restricted to. */
+    namespaces?: number[];
+    /** Action names the block is restricted to (e.g. `'edit'`). */
+    actions?: string[];
+}
+/** One protection restriction (`details` entry on `protect/protect`, `protect/modify`). */
+export interface ApiLogProtectDetail {
+    /** Action being restricted (e.g. `'edit'`); `'create'` for title protection. */
+    type: string;
+    /** Protection level (e.g. `'autoconfirmed'`, `'sysop'`). */
+    level: string;
+    /** When the protection lapses (ISO 8601), or `'infinite'`. */
+    expiry: Timestamp | "infinite";
+    /** Whether this restriction cascades; absent on `'create'` entries. */
+    cascade?: boolean;
+}
+/** One visibility state (`old`/`new` on a RevisionDelete row). */
+export interface ApiLogRevDelVisibility {
+    /** Raw visibility bitfield. */
+    bitmask: number;
+    /** Whether the content is hidden. */
+    content: boolean;
+    /** Whether the edit summary is hidden. */
+    comment: boolean;
+    /** Whether the performer is hidden. */
+    user: boolean;
+    /** Whether only suppressors can unhide. */
+    restricted: boolean;
+}
+/** One group-membership change with its expiry (`oldmetadata`/`newmetadata` entry). */
+export interface ApiLogGroupMetadata {
+    /** Group name. */
+    group: string;
+    /** When the membership lapses. */
+    expiry: Expiry;
+}

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

@@ -9,6 +9,7 @@
  */
 import type { Flag, NamespaceIndex, Timestamp } from "../../common";
 import type { ApiHiddenFlags } from "./shared";
+import type { ApiLogEventParams } from "./logparams";
 /** 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. */
@@ -83,8 +84,11 @@ export interface ApiRecentChange extends ApiHiddenFlags {
     logtype?: string;
     /** Log action, e.g. `create`. `rcprop=loginfo`. */
     logaction?: string;
-    /** Structured log parameters. `rcprop=loginfo`. */
-    logparams?: Record<string, unknown>;
+    /**
+     * Structured log details — see {@link ApiLogEventParams}. `rcprop=loginfo`
+     * (only for `type=log`).
+     */
+    logparams?: ApiLogEventParams;
 }
 declare module "./index" {
     interface ApiQueryResult {