build: minor fixes & doc updates

README.md

@@ -44,8 +44,9 @@ const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php')
 
 **在浏览器中直接使用/Use directly in the browser**
 
-```ts
-import('https://unpkg.com/wiki-saikou?module').then(({ MediaWikiApi }) => {
+```js
+import('https://unpkg.com/wiki-saikou').then(() => {
+  const { MediaWikiApi } = globalThis.WikiSaikou
   const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php')
   // ...
 })
@@ -71,9 +72,9 @@ Below is the documentation of MediaWikiApi.
   - **Not required but with conditions**: If you are using it in the browser environment, and the website runs MediaWiki. The instance will automatically use the API endpoint of current wiki.
 - `options`: {AxiosRequestConfig}
 
-#### `login(username: string, password: string): Promise<{ status: 'PASS' | 'FAIL'; username: string }>`
+#### `login(username: string, password: string): Promise<{ result: 'Success' | 'Failed'; lguserid: number; lgusername: string }>`
 
-Login you account.
+Login your account.
 
 #### `get<T = any>(params: MwApiParams, options?: AxiosRequestConfig): Promise<AxiosResponse<T>>`
 

debug/index.cjs

@@ -0,0 +1,13 @@
+const { MediaWikiApi } = require('..')
+const { env } = require('node:process')
+
+const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php', {
+  headers: {
+    'api-user-agent': env.MOEGIRL_API_USER_AGENT || '',
+  },
+})
+
+const username = env.MOEGIRL_USERNAME || ''
+const password = env.MOEGIRL_PASSWORD || ''
+
+api.login(username, password).then(console.info)

debug/index.mjs

@@ -0,0 +1,13 @@
+import { MediaWikiApi } from '../dist/index.js'
+import { env } from 'node:process'
+
+const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php', {
+  headers: {
+    'api-user-agent': env.MOEGIRL_API_USER_AGENT || '',
+  },
+})
+
+const username = env.MOEGIRL_USERNAME || ''
+const password = env.MOEGIRL_PASSWORD || ''
+
+api.login(username, password).then(console.info)

package.json

@@ -5,7 +5,6 @@
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "browser": "./dist/index.umd.js",
-  "exports": "./dist/index.mjs",
   "files": [
     "dist",
     "lib"

test/4.actions.spec.ts

@@ -0,0 +1,57 @@
+import { describe, it } from 'mocha'
+import { expect } from 'chai'
+import { env } from 'process'
+import { MediaWikiApi } from '../src/index'
+
+const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php', {
+  headers: {
+    'api-user-agent': env.MOEGIRL_API_USER_AGENT || '',
+  },
+})
+
+const username = env.MOEGIRL_USERNAME || ''
+const password = env.MOEGIRL_PASSWORD || ''
+
+const now = new Date()
+const editTitle = `User:${username}/sandbox/wiki-saikou`
+let editPageid = 0
+let editNewrevid = 0
+
+describe('Actions', () => {
+  it('Login', async () => {
+    const login = await api.login(username, password)
+    expect(login.result).to.equal('Success')
+  })
+
+  it('Do edit', async () => {
+    const {
+      data: { edit },
+    } = await api.postWithEditToken({
+      action: 'edit',
+      title: editTitle,
+      text: now.toISOString(),
+      summary: '[Automatic] Unit tests for https://npm.im/wiki-saikou',
+    })
+    expect(edit.result).to.equal('Success')
+    editPageid = edit.pageid
+    editNewrevid = edit.newrevid
+  })
+
+  it('Check edit contents', async () => {
+    const {
+      data: {
+        query: {
+          pages: [page],
+        },
+      },
+    } = await api.get({
+      action: 'query',
+      revids: editNewrevid,
+      prop: 'revisions',
+      rvprop: 'user|content',
+    })
+    expect(page.pageid).to.equal(editPageid)
+    expect(page.revisions[0].user).to.equal(username)
+    expect(page.revisions[0].content).to.equal(now.toISOString())
+  })
+})

tsup.config.ts

@@ -7,6 +7,7 @@ export default defineConfig({
   dts: true,
   outDir: 'dist',
   target: ['es2018'],
+  globalName: 'WikiSaikou',
   format: ['esm', 'cjs', 'iife'],
   legacyOutput: true,
   splitting: true,

vite.config.ts

@@ -5,10 +5,10 @@ import dts from 'vite-plugin-dts'
 export default defineConfig({
   build: {
     lib: {
-      name: 'MediaWikiApi',
+      name: 'WikiSaikou',
       fileName: 'index',
       entry: resolve(__dirname, 'src/index.ts'),
-      formats: ['cjs', 'es', 'iife', 'umd'],
+      formats: ['umd'],
     },
     sourcemap: true,
   },