types-mediawiki-response 1.1.1 → 1.2.0

package/README.md

@@ -1,6 +1,6 @@
 # types-mediawiki-response
 
-English | [简体中文](https://github.com/BearBin1215/types-mediawiki-response/blob/main/README.zh.md) | [Document](https://bearbin1215.github.io/types-mediawiki-response/)
+English | [简体中文](https://github.com/BearBin1215/types-mediawiki-response/blob/main/README.zh.md) | [Document](https://types-mediawiki-response.pages.dev/)
 
 Reusable typings for MediaWiki Action API responses.
 
@@ -30,9 +30,9 @@ const res = (await api.get({
 })) as ApiQueryResponse;
 ```
 
-Wrap with `ApiResponseWith<T>` to get the full error response type — see the [envelope and error handling guide](https://bearbin1215.github.io/types-mediawiki-response/guide/errors.html).
+Wrap with `ApiResponseWith<T>` to get the full error response type — see the [envelope and error handling guide](https://types-mediawiki-response.pages.dev/guide/errors).
 
-When using `ApiQueryResponse`, `query.pages[]` in the response is the union of every covered `prop=` field; project it with `QueryPage<K>` to scope a page to the props you requested — see the [query responses guide](https://bearbin1215.github.io/types-mediawiki-response/guide/query.html).
+When using `ApiQueryResponse`, `query.pages[]` in the response is the union of every covered `prop=` field; project it with `QueryPage<K>` to scope a page to the props you requested — see the [query responses guide](https://types-mediawiki-response.pages.dev/guide/query).
 
 ## Extensions
 
@@ -54,4 +54,4 @@ import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks";
 const res = (await api.post({ action: "thank", rev })) as ApiThankResponse;
 ```
 
-Bundled packs are listed in the [extension packs guide](https://bearbin1215.github.io/types-mediawiki-response/guide/ext-packs.html). Extensions this package does not cover can be augmented the same way with a hand-written `declare module 'types-mediawiki-response' { … }`.
+Bundled packs are listed in the [extension packs guide](https://types-mediawiki-response.pages.dev/guide/ext-packs). Extensions this package does not cover can be augmented the same way with a hand-written `declare module 'types-mediawiki-response' { … }`.

package/README.zh.md

@@ -1,6 +1,6 @@
 # types-mediawiki-response
 
-[English](https://github.com/BearBin1215/types-mediawiki-response/blob/main/README.md) | 简体中文 | [在线文档](https://bearbin1215.github.io/types-mediawiki-response/zh/)
+[English](https://github.com/BearBin1215/types-mediawiki-response/blob/main/README.md) | 简体中文 | [在线文档](https://types-mediawiki-response.pages.dev/zh/)
 
 为 MediaWiki Action API 响应提供可复用类型。
 
@@ -30,9 +30,9 @@ const res = (await api.get({
 })) as ApiQueryResponse;
 ```
 
-可用 `ApiResponseWith<T>` 包装以获得含错误结果的响应类型，见文档[信封与错误处理指南](https://bearbin1215.github.io/types-mediawiki-response/zh/guide/errors.html)。
+可用 `ApiResponseWith<T>` 包装以获得含错误结果的响应类型，见文档[信封与错误处理指南](https://types-mediawiki-response.pages.dev/zh/guide/errors)。
 
-使用 `ApiQueryResponse` 的情况下，响应里的 `query.pages[]` 类型是所有已覆盖 `prop=` 字段的并集，可用 `QueryPage<K>` 收窄到本次请求的 prop，见文档[query 响应指南](https://bearbin1215.github.io/types-mediawiki-response/zh/guide/query.html)。
+使用 `ApiQueryResponse` 的情况下，响应里的 `query.pages[]` 类型是所有已覆盖 `prop=` 字段的并集，可用 `QueryPage<K>` 收窄到本次请求的 prop，见文档[query 响应指南](https://types-mediawiki-response.pages.dev/zh/guide/query)。
 
 ## 扩展
 
@@ -54,4 +54,4 @@ import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks";
 const res = (await api.post({ action: "thank", rev })) as ApiThankResponse;
 ```
 
-内置包清单见文档站的[扩展包指南](https://bearbin1215.github.io/types-mediawiki-response/zh/guide/ext-packs.html)。本包未覆盖的扩展，手写 `declare module 'types-mediawiki-response' { … }` 走同一接缝增广。
+内置包清单见文档站的[扩展包指南](https://types-mediawiki-response.pages.dev/zh/guide/ext-packs)。本包未覆盖的扩展，手写 `declare module 'types-mediawiki-response' { … }` 走同一接缝增广。

package/dist/extensions/readinglists.d.ts

@@ -0,0 +1,210 @@
+/**
+ * Opt-in extension pack: **ReadingLists** (`meta=readinglists`,
+ * `list=readinglistentries`, `action=readinglists`).
+ *
+ * Not in the default export. Two shapes live here:
+ *
+ * - `meta=readinglists` / `list=readinglistentries` merge their result arrays
+ *   into `ApiQueryResult` automatically — importing anything from this file
+ *   activates the augmentation shipped at the bottom:
+ *
+ *   ```ts
+ *   import type {} from 'types-mediawiki-response/ext/readinglists';
+ *   ```
+ *
+ * - `action=readinglists` writes a root-level key named after the `command`
+ *   submodule (`create`, `update`, `setup`, …); import the matching response
+ *   type directly:
+ *
+ *   ```ts
+ *   import type { ApiReadingListsCreateResponse } from 'types-mediawiki-response/ext/readinglists';
+ *   ```
+ *
+ * Both modules require a logged-in user: the reads check the
+ * `viewmyprivateinfo` right and the writes `editmyprivateinfo`, so an anonymous
+ * request gets a top-level `notloggedin` error and lists are always the current
+ * user's own. The extension marks its API internal (`isInternal()`), so the
+ * modules are omitted from public listings but still callable.
+ *
+ * fv2 notes: an id is a `number` inside a list/entry record but a *string* at
+ * the root of a write response (`id` / `ids`) — those carry the raw database
+ * value, uncoupled from the cast record. `duplicate` appears only while a
+ * write's repository row is merge-flagged (the create commands), never on a
+ * plain read. `deleted` (`true`) appears only in `changedsince` mode; a deleted
+ * list is reported under a `deleted-<hash>` name. The read continuation cursor
+ * (`rlcontinue`) is the extension's own and is not merged into
+ * `ApiQueryContinue`.
+ *
+ * @see https://www.mediawiki.org/wiki/Extension:ReadingLists
+ */
+import type { Timestamp } from "../common";
+import type { ApiEnvelope } from "../envelope";
+/**
+ * One reading list (`meta=readinglists`, and the `list`/`lists` payload of the
+ * `create` / `update` / `setup` commands).
+ */
+export interface ApiReadingListItem {
+    /** List id. */
+    id: number;
+    /** List title as set by the owner. */
+    name: string;
+    /** Whether this is the user's catch-all default list. */
+    default: boolean;
+    /** Free-text description; `""` when none was set. */
+    description: string;
+    /** Creation time (ISO 8601). */
+    created: Timestamp;
+    /** Last update time (ISO 8601). */
+    updated: Timestamp;
+    /**
+     * Whether a list with the same name already existed, carried by the `create`
+     * command; absent on plain reads.
+     */
+    duplicate?: boolean;
+    /**
+     * `true` for a list soft-deleted within the retention window; appears only in
+     * `changedsince` mode, where the list is reported under a `deleted-<hash>`
+     * `name`.
+     */
+    deleted?: true;
+}
+/**
+ * One page saved in a reading list (`list=readinglistentries`, and the
+ * `entry`/`entries` payload of the `createentry` command).
+ */
+export interface ApiReadingListEntry {
+    /** Entry id. */
+    id: number;
+    /** Id of the list this entry belongs to. */
+    listId: number;
+    /**
+     * Canonical base URL of the wiki the entry points to (port omitted, e.g.
+     * `https://www.mediawiki.org`). Entries are cross-wiki; the `@local` project
+     * value resolves to the serving wiki's own URL here.
+     */
+    project: string;
+    /** Page title on {@link project}. */
+    title: string;
+    /** Creation time (ISO 8601). */
+    created: Timestamp;
+    /** Last update time (ISO 8601). */
+    updated: Timestamp;
+    /** Merge-detection flag of the `createentry` command; absent on plain reads. */
+    duplicate?: boolean;
+    /** `true` for an entry soft-deleted within the retention window; changes mode only. */
+    deleted?: true;
+}
+/** Response of `action=readinglists&command=setup` (no arguments). */
+export interface ApiReadingListsSetupResponse extends ApiEnvelope {
+    /** Result of the `setup` command. */
+    setup: {
+        /** The user's default list, created for them. */
+        list: ApiReadingListItem;
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+/**
+ * Response of `action=readinglists&command=create`. A single `name` returns
+ * `id` + `list`; a `batch` returns `ids` + `lists`.
+ */
+export interface ApiReadingListsCreateResponse extends ApiEnvelope {
+    /** Result of the `create` command. */
+    create: {
+        /** New list id (raw database value) for a single create. */
+        id?: string;
+        /** New list for a single create. */
+        list?: ApiReadingListItem;
+        /** New list ids for a batch create. */
+        ids?: string[];
+        /** New lists for a batch create. */
+        lists?: ApiReadingListItem[];
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+/**
+ * Response of `action=readinglists&command=update`. A single `list` returns
+ * `id` + `list`; a `batch` returns `ids` + `lists`.
+ */
+export interface ApiReadingListsUpdateResponse extends ApiEnvelope {
+    /** Result of the `update` command. */
+    update: {
+        /** Updated list id (raw database value) for a single update. */
+        id?: string;
+        /** Updated list for a single update. */
+        list?: ApiReadingListItem;
+        /** Updated list ids for a batch update. */
+        ids?: string[];
+        /** Updated lists for a batch update. */
+        lists?: ApiReadingListItem[];
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+/** Response of `action=readinglists&command=delete` (single `list` or `batch`). */
+export interface ApiReadingListsDeleteResponse extends ApiEnvelope {
+    /** Result of the `delete` command — a bare success sentinel. */
+    delete: {
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+/**
+ * Response of `action=readinglists&command=createentry`. A single `project` +
+ * `title` returns `id` + `entry`; a `batch` returns `ids` + `entries`.
+ */
+export interface ApiReadingListsCreateEntryResponse extends ApiEnvelope {
+    /** Result of the `createentry` command. */
+    createentry: {
+        /** New entry id (raw database value) for a single create. */
+        id?: string;
+        /** New entry for a single create. */
+        entry?: ApiReadingListEntry;
+        /** New entry ids for a batch create. */
+        ids?: string[];
+        /** New entries for a batch create. */
+        entries?: ApiReadingListEntry[];
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+/**
+ * Response of `action=readinglists&command=deleteentry` (single `entry` or
+ * `batch`).
+ */
+export interface ApiReadingListsDeleteEntryResponse extends ApiEnvelope {
+    /** Result of the `deleteentry` command — a bare success sentinel. */
+    deleteentry: {
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+/** Response of `action=readinglists&command=teardown` (no arguments). */
+export interface ApiReadingListsTeardownResponse extends ApiEnvelope {
+    /** Result of the `teardown` command — a bare success sentinel. */
+    teardown: {
+        /** Always `Success` on the success branch; failures are top-level errors. */
+        result: "Success";
+    };
+}
+declare module "types-mediawiki-response" {
+    interface ApiQueryResult {
+        /**
+         * The current user's reading lists. `meta=readinglists`.
+         */
+        readinglists?: ApiReadingListItem[];
+        /**
+         * A sync watermark: querying with this timestamp as `changedsince`
+         * guarantees no intervening change is skipped. Sibling of {@link readinglists},
+         * `meta=readinglists`; omitted on continuation requests.
+         */
+        "readinglists-synctimestamp"?: Timestamp;
+        /**
+         * Pages saved in the requested list(s). `list=readinglistentries` (or
+         * `generator=readinglistentries`, where the entries feed `pages` and this
+         * array comes back empty).
+         */
+        readinglistentries?: ApiReadingListEntry[];
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "types-mediawiki-response",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "TypeScript type definitions for MediaWiki Action API responses",
   "keywords": [
     "action-api",
@@ -10,7 +10,7 @@
     "typescript",
     "wiki"
   ],
-  "homepage": "https://bearbin1215.github.io/types-mediawiki-response/",
+  "homepage": "https://types-mediawiki-response.pages.dev/",
   "bugs": {
     "url": "https://github.com/BearBin1215/types-mediawiki-response/issues"
   },
@@ -65,8 +65,8 @@
     "@types/node": "^26.6.3",
     "bumpp": "^12.3.0",
     "expect-type": "1.4.0",
-    "oxfmt": "0.71.0",
-    "oxlint": "1.86.0",
+    "oxfmt": "0.72.0",
+    "oxlint": "1.87.0",
     "tsx": "^4.23.13",
     "typescript": "^7.0.2"
   },