wikiapi

JavaScript MediaWiki API

A simple way to access MediaWiki API via JavaScript with wikitext parser. This is basically a modern syntax version of CeJS MediaWiki module. For example, using async functions.

Features

• Read / edit pages.
• Get list of categorymembers, pages transclude specified template, and more...
• Auto-limited editing rate.
• Parse wikitext / pages. You may modify parts of the wikitext, then regenerate the page just using .toString(). See wikitext parser examples.

Installation

Install node.js first.

npm install wikiapi

Usage

Here lists some examples of this module.

As node.js module

// load module
const Wikiapi = require('wikiapi');

// login
(async () => {
	const wiki = new Wikiapi(user, password, 'en');
	//wiki = new Wikiapi(user_name, password, API_URL);
	// Calling in another domain
	//wiki = new Wikiapi({user_name:'', password:'', origin:'*'});
})();

// load page
(async () => {
	// on Wikipedia...
	const wiki = new Wikiapi('en');
	// ...or other MediaWiki websites
	//const wiki = new Wikiapi('https://awoiaf.westeros.org/api.php');
	let page_data = await wiki.page('Universe', {
		// You may also set rvprop.
		//rvprop: 'ids|content|timestamp|user',
	});
	console.log(page_data.wikitext);
})();

// Get multi revisions
(async () => {
	const wiki = new Wikiapi;
	let page_data = await wiki.page('Universe', {
		// Get multi revisions
		revisions: 2
	});
	console.log(page_data.wikitext);
})();

// edit page: method 1
(async () => {
	const enwiki = new Wikiapi;
	await enwiki.login('bot name', 'password', 'en');
	const SB_page_data = await enwiki.page('Wikipedia:Sandbox');
	// You may do some operations on SB_page_data
	const parsed = SB_page_data.parse();
	parsed.each('template', template_token => {/* modify token */});
	// and then edit it. ** You MUST call enwiki.page() before enwiki.edit()! **
	await enwiki.edit(parsed.toString(), {bot: 1, minor: 1, nocreate: 1});
	// exmaple 2
	await enwiki.edit(function(page_data) {
		return page_data.wikitext
			+ '\nTest edit using {{GitHub|kanasimi/wikiapi}}.';
	}, {bot: 1});
	// exmaple 3
	await enwiki.edit('Just replace by this wikitext', {bot: 1, minor: 1, nocreate: 1});

	console.log('Done.');
})();

// edit page: method 2
(async () => {
	const enwiki = new Wikiapi;
	await enwiki.login('bot name', 'password', 'en');
	await enwiki.edit_page('Wikipedia:Sandbox', function(page_data) {
		return page_data.wikitext
			+ '\nTest edit using {{GitHub|kanasimi/wikiapi}}.';
	}, {bot: 1, nocreate: 1, minor: 1});
	console.log('Done.');
})();

// read / edit pages
(async () => {
	const enwiki = new Wikiapi('en');
	const link_from = await wiki.redirects_here('ABC');
	await wiki.for_each_page(link_from, page_data => {
		// Return `Wikiapi.skip_edit` if you just want to get the page data.
		return Wikiapi.skip_edit;
		return 'You may also modify page contents for each page';
	}, {
		// Only needed if ypu want to modify page.
		summary: 'summary',
		bot: 1, nocreate: 1, minor: 1
	});
})();

// parse wiki page (The parser is more powerful than the example. Please refer to link of wikitext parser examples showing in "Features" section.)
(async () => {
	// Usage with other language
	const zhwiki = new Wikiapi('zh');
	await zhwiki.login('user', 'password');
	let page_data = await zhwiki.page('Universe');
	// Other types:
	// @see wiki_toString @ https://github.com/kanasimi/CeJS/blob/master/application/net/wiki/parser.js
	page_data.parse().each('template',
		token => console.log(token.name));
})();

// Get information from Infobox template
(async () => {
	const wiki = new Wikiapi('en');
	const page_data = await wiki.page('JavaScript');
	const parsed = page_data.parse();
	let infobox;
	parsed.each('template', template_token => {
		if (template_token.name.startsWith('Infobox')) {
			infobox = template_token.parameters;
			return parsed.each.exit;
		}
	});
	for (const [key, value] of Object.entries(infobox))
		infobox[key] = value.toString();
	console.log(infobox);
})();

// listen to new edits
(async () => {
	const wiki = new Wikiapi;
	wiki.listen(function for_each_row() { ... }, {
		// 檢查的延遲時間。
		delay: '2m',
		filter: function filter_row() { ... },
		// also get diff
		with_diff: { LCS: true, line: true },
		namespace: '0|talk',
	});
})();

// read wikidata
(async () => {
	const wiki = new Wikiapi;
	let page_data = await wiki.data('Q1');
	// Work with other language
	console.assert(CeL.wiki.data.value_of(page_data.labels.zh) === '宇宙');
})();

// read wikidata
(async () => {
	const wiki = new Wikiapi;
	let data = await wiki.data('Universe', 'P1419');
	console.assert(data.includes('shape of the universe'));
})();

// get list of [[w:en:Category:Chemical_elements]]
(async () => {
	const wiki = new Wikiapi;
	let list = await wiki.categorymembers('Chemical elements');
	console.log(list);
	// Working on multiple pages
	await wiki.for_each_page(
		/* {Array} title liat / page data list */ list,
		page_data => { /* ... */ });
})();

// get pages transcluding {{w:en:Periodic table}}
(async () => {
	const wiki = new Wikiapi;
	let list = await wiki.embeddedin('Template:Periodic table');
	console.log(list);
})();

// upload file / media
(async () => {
	const wiki = new Wikiapi;
	await wiki.login('user', 'password', 'test');
	// Upload a local file directly:
	let result = await wiki.upload_file({ file_path: '/local/file/path', comment: '', text: '' });
	// Upload file from URL:
	result = await wiki.upload_file({ media_url: 'https://media.url/name.jpg', comment: '', text: '' });
})();

// update wikidata
(async () => {
	// Just for test
	delete CeL.wiki.query.default_maxlag;
	const wiki = new Wikiapi;
	await wiki.login('user', 'password', 'test');

	// Get https://test.wikidata.org/wiki/Q7
	let entity = await wiki.data('Q7');
	// search [ language, label ]
	//entity = await wiki.data(['en', 'Earth']);

	// Update claim
	await entity.modify({ claims: [{ P17: 'Q213280' }] });
	// Update claim: set country (P17) to 'Test Country 1' (Q213280) ([language, label] as entity)
	await entity.modify({ claims: [ { language: 'en', country: [, 'Test Country 1'] } ] });
	// Remove country (P17) : 'Test Country 1' (Q213280)
	await entity.modify({ claims: [ { language: 'en', country: [, 'Test Country 1'], remove: true } ] });

	// Update label
	await entity.modify({ labels: [ { language: 'zh-tw', value: '地球' } ] });
})();

More examples: Please see test.js.

OS support

Platform	support
Windows	✔️
macOS	✔️
UNIX, Linux	✔️

See also

For old style JavaScript, or general environment usage, please see wikibot.

Contact

Contact us at GitHub.