types-mediawiki-response 1.0.1 → 1.1.0

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/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/siteinfo.d.ts

@@ -188,11 +188,11 @@ export interface ApiSiteGeneral {
     /** Site favicon URL; absent when the site sets no `$wgFavicon`. */
     favicon?: string;
     /**
-     * Host prefixes external images may be loaded from; present only when such an
-     * allow-list applies (`$wgAllowExternalImagesFrom`).
+     * Host prefixes external images may be loaded from; `[""]` when external
+     * images are allowed at large (`$wgAllowExternalImages`).
      */
     externalimages?: string[];
-    /** Gallery rendering defaults (`$wgGalleryOptions`). */
+    /** Gallery rendering defaults. */
     galleryoptions: ApiGalleryOptions;
     /**
      * Selectable thumbnail widths, in pixels, keyed by position. Always an object
@@ -214,8 +214,11 @@ export interface ApiSiteGeneral {
     externallinktarget: string | boolean;
     /** Whether interwiki prefixes may be used as magic links. A real `boolean`. */
     interwikimagic: boolean;
-    /** Magic-link keywords and whether each is enabled. */
-    magiclinks: Record<string, boolean>;
+    /**
+     * Magic-link keywords and whether each is enabled; mirrors
+     * `$wgEnableMagicLinks` verbatim, so an empty set serializes as `[]`.
+     */
+    magiclinks: Record<string, boolean> | unknown[];
     /** Method used to look up a user's central account id. */
     centralidlookupprovider: string;
     /** All available central-id lookup providers. */
@@ -234,22 +237,25 @@ export interface ApiSiteGeneral {
     /** Git commit hash of the deployment; only present on git checkouts. */
     "git-hash"?: string;
 }
-/** `general.galleryoptions`: the site's `$wgGalleryOptions`. */
+/**
+ * `general.galleryoptions`: the site's `$wgGalleryOptions`, with core's defaults
+ * filled in for any key the site omits.
+ */
 export interface ApiGalleryOptions {
     /** Images per row; `0` lets the skin decide. */
-    imagesPerRow?: number;
+    imagesPerRow: number;
     /** Thumbnail width in pixels. */
-    imageWidth?: number;
+    imageWidth: number;
     /** Thumbnail height in pixels. */
-    imageHeight?: number;
+    imageHeight: number;
     /** Whether captions are length-limited. A real `boolean`. */
-    captionLength?: boolean;
+    captionLength: boolean;
     /** Whether file sizes are shown. A real `boolean`. */
-    showBytes?: boolean;
+    showBytes: boolean;
     /** Whether dimensions are shown. A real `boolean`. */
-    showDimensions?: boolean;
+    showDimensions: boolean;
     /** Gallery layout, e.g. `traditional`, `nolines`, `packed`, `modified-packed`. */
-    mode?: string;
+    mode: string;
 }
 /** One entry of `general.imagelimits`: a selectable display size. */
 export interface ApiImageLimit {
@@ -304,20 +310,20 @@ export interface ApiUserGroup {
  */
 export interface ApiSiteRestrictions {
     /** Restriction kinds, e.g. `create`, `edit`, `move`, `upload`. */
-    types?: string[];
+    types: string[];
     /** Selectable protection levels; `""` means unrestricted. */
-    levels?: (string | string[])[];
+    levels: (string | string[])[];
     /** Levels that may cascade. */
-    cascadinglevels?: string[];
+    cascadinglevels: string[];
     /** Levels treated as semi-protection. */
-    semiprotectedlevels?: string[];
+    semiprotectedlevels: string[];
 }
 /** `siprop=rightsinfo`: where to read the site's content-rights statement. */
 export interface ApiRightsInfo {
     /** Rights-page/account URL; empty string when unset (not absent). */
-    url?: string;
+    url: string;
     /** Link text override; empty string when unset. */
-    text?: string;
+    text: string;
 }
 /** One localized namespace alias (`siprop=namespacealiases`). */
 export interface ApiNamespaceAlias {
@@ -343,8 +349,15 @@ export interface ApiFileExtension {
  * {@link type} appear only when the component's `extension.json` declares them.
  */
 export interface ApiSiteExtension {
-    /** Component class, e.g. `skin`, `media`, `parserhook`, `other`. Open union. */
-    type: string;
+    /**
+     * Component class. The names MediaWiki has display labels for are
+     * `specialpage`, `editor`, `wikifamily`, `parserhook`, `variable`, `media`,
+     * `antispam`, `skin`, `api` and `other`, but the value is never validated
+     * against them: a component declares its own `type` in `extension.json`,
+     * `$wgExtensionCredits` entries pass through as written, and the
+     * `ExtensionTypes` hook can add further names — **open union**.
+     */
+    type: "specialpage" | "editor" | "wikifamily" | "parserhook" | "variable" | "media" | "antispam" | "skin" | "api" | "other" | (string & {});
     /** Display name. */
     name?: string;
     /** Message key holding the name. */
@@ -402,9 +415,9 @@ export interface ApiMagicWord {
 /** One hook and its subscribers (`siprop=showhooks`). */
 export interface ApiShowHook {
     /** Hook name. */
-    name?: string;
+    name: string;
     /** `Class::method` handlers registered for it. */
-    subscribers?: string[];
+    subscribers: string[];
 }
 /** One database host (`siprop=dbrepllag`). */
 export interface ApiDbReplLag {
@@ -453,11 +466,11 @@ export interface ApiInterwikiMapEntry {
 /** One language entry (`siprop=languages`). */
 export interface ApiSiteLanguage {
     /** Language code. */
-    code?: string;
+    code: string;
     /** BCP 47 form of {@link code}. */
-    bcp47?: string;
+    bcp47: string;
     /** Localized language name. */
-    name?: string;
+    name: string;
 }
 /** One language variant and its fallbacks (`siprop=languagevariants`). */
 export interface ApiLanguageVariant {
@@ -512,7 +525,7 @@ export interface ApiAutoCreateTempUser {
      *
      * @since MediaWiki 1.41
      */
-    enabled?: boolean;
+    enabled: boolean;
     /**
      * Name patterns reserved for temporary accounts; only when configured.
      *
@@ -653,8 +666,11 @@ declare module "./index" {
     interface ApiQueryResult {
         /** General site configuration (`meta=siteinfo`, `siprop=general`). */
         general?: ApiSiteGeneral;
-        /** Upload-dialog config (`siprop=uploaddialog`). */
-        uploaddialog?: ApiUploadDialog;
+        /**
+         * Upload-dialog config (`siprop=uploaddialog`), mirroring `$wgUploadDialog`
+         * verbatim; an empty configuration serializes as `[]`.
+         */
+        uploaddialog?: ApiUploadDialog | unknown[];
         /**
          * Domains allowed to send authenticated CORS requests, from
          * `$wgCrossSiteAJAXdomains`; always a JSON array (empty when unconfigured).

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

@@ -18,8 +18,13 @@ export interface ApiTag {
     hitcount?: number;
     /** Whether the tag has a definition page. `tgprop=defined`; a real `boolean`. */
     defined?: boolean;
-    /** Where the tag can come from. `tgprop=source`; open union members. */
-    source?: ("extension" | "manual" | "software" | (string & {}))[];
+    /**
+     * Where the tag can come from. `tgprop=source`: `software` for a tag defined
+     * in code, `manual` for one with a definition page, and `extension` as a
+     * backwards-compatibility entry emitted alongside `software`. Emitted as a
+     * list — a tag with no source serializes as `[]`.
+     */
+    source?: ("extension" | "manual" | "software")[];
     /** Whether the tag is still applicable. `tgprop=active`; a real `boolean`. */
     active?: boolean;
 }

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

@@ -29,9 +29,9 @@ export interface ApiRateLimit {
 /** The `userinfo` object of a `meta=userinfo` response. */
 export interface ApiUserInfo extends ApiUserCore {
     /** User id; `0` for anonymous users. */
-    id?: number;
+    id: number;
     /** User name or IP address. */
-    name?: string;
+    name: string;
     /** `true` for an anonymous (IP) session. A {@link Flag}. */
     anon?: Flag;
     /**

package/dist/core/removeauthenticationdata.d.ts

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

package/dist/core/unblock.d.ts

@@ -7,7 +7,7 @@
  *
  * @see https://www.mediawiki.org/wiki/API:Block
  */
-import type { Timestamp } from "../common";
+import type { WatchlistExpiry } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** The `unblock` object of an `action=unblock` response. */
 export interface ApiUnblockResult {
@@ -22,11 +22,10 @@ export interface ApiUnblockResult {
     /** Whether the unblock added the unblocked user to the unblocker's watchlist. */
     watchuser: boolean;
     /**
-     * Expiry applied to the watched user page, present only when the request
-     * passed `watchlistexpiry` with `watchuser`; `null` when the page is not
-     * actually watched.
+     * Expiry applied to the watched user page, present only when `watchuser=1`
+     * took effect.
      */
-    watchlistexpiry?: Timestamp | null;
+    watchlistexpiry?: WatchlistExpiry;
 }
 /** Response of `action=unblock`. */
 export interface ApiUnblockResponse extends ApiEnvelope {

package/dist/core/userrights.d.ts

@@ -9,7 +9,7 @@
  *
  * @see https://www.mediawiki.org/wiki/API:User_group_membership
  */
-import type { Expiry } from "../common";
+import type { WatchlistExpiry } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** Response of `action=userrights`. */
 export interface ApiUserrightsResponse extends ApiEnvelope {
@@ -31,10 +31,9 @@ export interface ApiUserrightsResponse extends ApiEnvelope {
          */
         watchuser?: boolean;
         /**
-         * Expiry of the watch on the user's user page — an ISO 8601 timestamp or
-         * the `infinity` sentinel. Present only when `watchuser=1` took effect and a
-         * `watchlistexpiry` was supplied; the value is read back from the watchlist.
+         * Expiry of the watch on the user's user page, present only when
+         * `watchuser=1` took effect.
          */
-        watchlistexpiry?: Expiry;
+        watchlistexpiry?: WatchlistExpiry;
     };
 }

package/dist/extensions/discussiontools.d.ts

@@ -27,7 +27,7 @@
  *
  * @see https://www.mediawiki.org/wiki/Extension:DiscussionTools
  */
-import type { Flag, SuccessStatus, Timestamp } from "../common";
+import type { Flag, Timestamp, WatchlistExpiry } from "../common";
 import type { ApiEnvelope } from "../envelope";
 import type { ApiParse } from "../core/parse";
 import type { ApiThankResult } from "./thanks";
@@ -237,8 +237,11 @@ export interface ApiDiscussionToolsPreviewResponse extends ApiEnvelope {
 export interface ApiDiscussionToolsEditResponse extends ApiEnvelope {
     /** Result of `action=discussiontoolsedit`. */
     discussiontoolsedit: {
-        /** `success` when the comment was saved. */
-        result?: SuccessStatus;
+        /**
+         * Outcome of the delegated `action=visualeditoredit` call: `success` when
+         * the comment was saved, `error` when the save was rejected.
+         */
+        result?: "success" | "error";
         /** Rendered HTML of the saved comment area. */
         content?: string;
         /**
@@ -276,6 +279,6 @@ export interface ApiDiscussionToolsEditResponse extends ApiEnvelope {
         /** Whether the user now watches the page. */
         watched?: boolean;
         /** When that watch expires; `null` for a permanent watch. */
-        watchlistexpiry?: Timestamp | null;
+        watchlistexpiry?: WatchlistExpiry;
     };
 }

package/dist/extensions/echo.d.ts

@@ -31,7 +31,7 @@
  *
  * @see https://www.mediawiki.org/wiki/Extension:Echo
  */
-import type { NamespaceIndex, SuccessResult, SuccessStatus, Timestamp } from "../common";
+import type { NamespaceIndex, Timestamp } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** A notification count: numeric `rawcount` plus a localized `count` string. */
 export interface ApiEchoNotificationCount {
@@ -42,8 +42,11 @@ export interface ApiEchoNotificationCount {
 }
 /** The `echomarkread` object (returned under `query` by `action=echomarkread`). */
 export interface ApiQueryEchoMarkRead {
-    /** Echo status string; `success` on completion. */
-    result: SuccessStatus;
+    /**
+     * Success sentinel; a foreign wiki that fails is reported per wiki in
+     * {@link errors} instead of changing this value.
+     */
+    result: "success";
     /** Per-wiki error from a failed foreign (cross-wiki) subrequest. */
     errors?: {
         /** Error reported for the foreign wiki the key names. */
@@ -67,8 +70,8 @@ export interface ApiQueryEchoMarkRead {
 }
 /** The `echomarkseen` object (returned under `query` by `action=echomarkseen`). */
 export interface ApiQueryEchoMarkSeen {
-    /** Echo status string; `success` on completion. */
-    result?: SuccessStatus;
+    /** Success sentinel; a rejected call comes back as a top-level error. */
+    result?: "success";
     /** The "all notifications seen" timestamp just recorded. */
     timestamp?: Timestamp;
 }
@@ -261,11 +264,11 @@ export interface ApiQueryEchoUnreadPages {
 }
 /**
  * Response of `action=echomute`. The module writes a plain status **string**
- * (no wrapper object): `success` after muting or unmuting.
+ * rather than a wrapper object.
  */
 export interface ApiEchoMuteResponse extends ApiEnvelope {
-    /** Plain status string rather than a wrapper object; `success` after muting or unmuting. */
-    echomute: SuccessStatus;
+    /** Success sentinel; a rejected call comes back as a top-level error. */
+    echomute: "success";
 }
 /**
  * Response of `action=echocreateevent`. Shape of the `ApiEchoCreateEvent`
@@ -276,8 +279,8 @@ export interface ApiEchoMuteResponse extends ApiEnvelope {
 export interface ApiEchoCreateEventResponse extends ApiEnvelope {
     /** Result of `action=echocreateevent`. */
     echocreateevent: {
-        /** `success` when the event was stored. */
-        result?: SuccessStatus;
+        /** Success sentinel; a rejected call comes back as a top-level error. */
+        result?: "success";
     };
 }
 /**
@@ -285,8 +288,8 @@ export interface ApiEchoCreateEventResponse extends ApiEnvelope {
  * only registered when `$wgAllowArticleReminderNotification` is on.
  */
 export interface ApiQueryEchoArticleReminder {
-    /** `success` when the reminder was scheduled. */
-    result?: SuccessStatus;
+    /** Success sentinel; a rejected call comes back as a top-level error. */
+    result?: "success";
 }
 /**
  * Responses of `action=echopushsubscriptions`: the `command` value is the
@@ -296,13 +299,13 @@ export interface ApiQueryEchoArticleReminder {
 export interface ApiEchoPushSubscriptionsResponse extends ApiEnvelope {
     /** `command=create` — the subscription was stored. */
     create?: {
-        /** `Success` when the subscription was stored. */
-        result?: SuccessResult;
+        /** Success sentinel; a rejected call comes back as a top-level error. */
+        result?: "Success";
     };
     /** `command=delete` — the subscription was removed. */
     delete?: {
-        /** `Success` when the subscription was removed. */
-        result?: SuccessResult;
+        /** Success sentinel; a rejected call comes back as a top-level error. */
+        result?: "Success";
     };
 }
 declare module "types-mediawiki-response" {

package/dist/extensions/flaggedrevs.d.ts

@@ -31,7 +31,7 @@
  *
  * @see https://www.mediawiki.org/wiki/Extension:FlaggedRevs
  */
-import type { Expiry, SuccessResult, Timestamp } from "../common";
+import type { Expiry, Timestamp } from "../common";
 import type { ApiPageRef } from "../core/query/shared";
 import type { ApiEnvelope } from "../envelope";
 /** A page's FlaggedRevs state (`prop=flagged`). */
@@ -121,7 +121,7 @@ export interface ApiReviewResponse extends ApiEnvelope {
     /** Result of `action=review`. */
     review: {
         /** `Success` when the review was recorded; failures surface as API errors. */
-        result: SuccessResult;
+        result: "Success";
     };
 }
 /**

package/dist/extensions/globalpreferences.d.ts

@@ -19,7 +19,6 @@
  *
  * @see https://www.mediawiki.org/wiki/Extension:GlobalPreferences
  */
-import type { SuccessStatus } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /**
  * Value of a global preference: the stored value, returned verbatim (always a
@@ -48,7 +47,7 @@ export interface ApiGlobalPreferencesResult {
  */
 export interface ApiGlobalPreferencesResponse extends ApiEnvelope {
     /** Plain status string rather than a wrapper object; `success` on success. */
-    globalpreferences: SuccessStatus;
+    globalpreferences: "success";
 }
 /**
  * Response of `action=globalpreferenceoverrides` — same reply style as
@@ -56,7 +55,7 @@ export interface ApiGlobalPreferencesResponse extends ApiEnvelope {
  */
 export interface ApiGlobalPreferenceOverridesResponse extends ApiEnvelope {
     /** Plain status string rather than a wrapper object; `success` on success. */
-    globalpreferenceoverrides: SuccessStatus;
+    globalpreferenceoverrides: "success";
 }
 declare module "types-mediawiki-response" {
     interface ApiQueryResult {

package/dist/extensions/massmessage.d.ts

@@ -23,7 +23,6 @@
  *
  * @see https://www.mediawiki.org/wiki/Extension:MassMessage
  */
-import type { SuccessStatus } from "../common";
 import type { ApiEnvelope } from "../envelope";
 /** The `mmcontent` object of a `prop=mmcontent` response. */
 export interface ApiMmContent {
@@ -65,7 +64,7 @@ export interface ApiEditMassMessageListResult {
      * `Success` when everything applied; `Done` when any submitted target was
      * invalid (see {@link invalidadd} / {@link invalidremove}).
      */
-    result: "Success" | "Done" | (string & {});
+    result: "Success" | "Done";
     /** Targets actually added (deduplicated, canonicalized). */
     added?: ApiMassMessageTarget[];
     /** Targets removed. */
@@ -87,7 +86,7 @@ export interface ApiEditMassMessageListResponse extends ApiEnvelope {
 /** The `massmessage` object of an `action=massmessage` response. */
 export interface ApiMassMessageResult {
     /** `success` (lowercase) when delivery was queued. */
-    result: SuccessStatus;
+    result: "success";
     /** Number of targets the message was queued for. */
     count: number;
 }

package/dist/extensions/sitematrix.d.ts

@@ -44,8 +44,8 @@ export interface ApiSiteMatrixLanguage {
     name?: string | null;
     /** Localized language name (in the interface language); `smlangprop=localname`. */
     localname?: string;
-    /** Text direction of the language, `ltr` or `rtl`. */
-    dir?: "ltr" | "rtl" | (string & {});
+    /** Text direction of the language. */
+    dir?: "ltr" | "rtl";
     /** Wikis of this language in each project family. */
     site?: ApiSiteMatrixSite[];
 }

package/dist/extensions/timedmediahandler.d.ts

@@ -56,14 +56,18 @@ export interface ApiVideoTimedTextTrack {
      * `origin=*` for cross-origin playback).
      */
     src?: string;
-    /** Track kind; `subtitles` for text tracks TMH generates. */
+    /**
+     * Track kind; `subtitles` for the text tracks TMH generates. **Open union**:
+     * a track mirrored from a foreign file repository keeps the kind that
+     * repository reports.
+     */
     kind?: "subtitles" | (string & {});
     /** MIME type of the track, e.g. `text/x-srt` or `text/vtt`. */
     type?: string;
     /** Track language (BCP 47). */
     srclang?: string;
-    /** Text direction of the track language, `ltr` or `rtl`. */
-    dir?: "ltr" | "rtl" | (string & {});
+    /** Text direction of the track language. */
+    dir?: "ltr" | "rtl";
     /** Human-readable track label including the language name. */
     label?: string;
 }

package/dist/extensions/visualeditor.d.ts

@@ -16,9 +16,11 @@
  * * `templatesused` → `visualeditor` is a bare HTML **string** (a
  *   `<div class="templatesUsed">` block), not the usual object.
  *
- * `notices` and `blockinfo` show the two classic PHP-to-JSON traps: `notices` is
- * a message-keyed map once populated but an empty **array** when there are none,
- * and `blockinfo` is `null` rather than absent for an unblocked user.
+ * `notices`, `checkboxesDef`/`checkboxesMessages` and `blockinfo` show the
+ * classic PHP-to-JSON traps: each map is keyed once populated but an empty
+ * **array** when there is nothing to show (an anonymous request has no
+ * applicable save-form fields), and `blockinfo` is `null` rather than absent
+ * for an unblocked user.
  *
  * `action=visualeditoredit` requires a `paction` parameter selecting the
  * operation (`save`, `diff`, `serialize`, `serializeforcache`). `save` returns
@@ -32,7 +34,7 @@
  *
  * @see https://www.mediawiki.org/wiki/Extension:VisualEditor
  */
-import type { Flag, SuccessStatus, Timestamp } from "../common";
+import type { Flag, Timestamp, WatchlistExpiry } from "../common";
 import type { ApiEditResult } from "../core/edit";
 import type { ApiBlockInfo } from "../core/query/users";
 import type { ApiEnvelope } from "../envelope";
@@ -85,7 +87,7 @@ export interface ApiLastModified {
 /** The page frame both `visualeditor` and `visualeditoredit` return. */
 export interface ApiVisualEditorPageFrame {
     /** Outcome of the request; `error` on the save-failure branch. */
-    result?: "success" | "error" | (string & {});
+    result?: "success" | "error";
     /** Rendered page body (HTML for `parse`, wikitext for `wikitext`). */
     content?: string;
     /** Whether {@link content} came from a preload rather than the page. */
@@ -114,7 +116,7 @@ export interface ApiVisualEditorPageFrame {
     /** Whether the editor watches the page now. */
     watched?: boolean;
     /** When that watch expires; `null` when permanent. */
-    watchlistexpiry?: Timestamp | null;
+    watchlistexpiry?: WatchlistExpiry;
     /** HTML diff, from `visualeditoredit` `paction=diff`. */
     diff?: string;
     /** Key into the serialisation cache, from `visualeditoredit` `paction=serializeforcache`. */
@@ -145,10 +147,16 @@ export interface ApiVisualEditorResponse extends ApiEnvelope {
         notices: Record<string, string> | unknown[];
         /** Copyright warning HTML; `""` when none applies. */
         copyrightWarning: string;
-        /** Definitions of the save-form fields, keyed by element id. */
-        checkboxesDef: Record<string, ApiVisualEditorCheckboxDef>;
-        /** Plain text of the messages referenced by `checkboxesDef`. */
-        checkboxesMessages: Record<string, string>;
+        /**
+         * Definitions of the save-form fields, keyed by element id. An empty PHP
+         * map, so `[]` when no field applies to the requesting user.
+         */
+        checkboxesDef: Record<string, ApiVisualEditorCheckboxDef> | unknown[];
+        /**
+         * Plain text of the messages referenced by `checkboxesDef`. An empty PHP
+         * map, so `[]` when there are no messages.
+         */
+        checkboxesMessages: Record<string, string> | unknown[];
         /** CSS classes for protection state, joined into one string (`""` when none). */
         protectedClasses: string;
         /** Base timestamp for edit-conflict detection. */
@@ -186,8 +194,8 @@ export interface ApiVisualEditorTemplatesUsedResponse extends ApiEnvelope {
 export interface ApiVisualEditorParseFragmentResponse extends ApiEnvelope {
     /** Result of `action=visualeditor&paction=parsefragment`. */
     visualeditor: {
-        /** Outcome of the transform. */
-        result: SuccessStatus;
+        /** Success sentinel; a rejected call comes back as a top-level error. */
+        result: "success";
         /** Transformed wikitext fragment. */
         content: string;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "types-mediawiki-response",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "TypeScript type definitions for MediaWiki Action API responses",
   "keywords": [
     "action-api",
@@ -55,6 +55,7 @@
     "check:examples": "pnpm run build && pnpm --filter ./examples/* run typecheck",
     "check:pack": "pnpm run build && attw --pack .",
     "release": "pnpm run check && bumpp",
+    "release-notes": "tsx scripts/generate-release-notes.ts",
     "docs:dev": "pnpm --filter types-mediawiki-response-docs dev",
     "docs:build": "pnpm --filter types-mediawiki-response-docs build",
     "docs:preview": "pnpm --filter types-mediawiki-response-docs preview"