npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

m3api-botpassword

v0.2.1

Published

m3api extension package to authenticate using a bot password.

Downloads

5

Readme

m3api-botpassword

npm documentation

m3api-botpassword is an extension package for m3api, making it easy to make requests authenticated by a bot password.

Usage

import Session from 'm3api/node.js';
import { login } from 'm3api-botpassword/index.js';

// create credentials on Special:BotPasswords,
// then load them e.g. from process.env
const username = '...@...';
const password = '...';

// create a session
const session = new Session( 'en.wikipedia.org', {
	formatversion: 2,
}, {
	userAgent: 'm3api-botpassword-README-example',
} );

// log in
await login( session, username, password );

// make other requests, now authenticated
await session.request( {
	action: 'edit',
	title: '...',
	text: '...',
	bot: true,
}, { method: 'POST', tokenType: 'csrf' } );

There is also a logout() function.

By default, m3api-botpassword adds assert=user after logging in, but does not set the assertuser parameter. Both of these can be changed using request options, e.g. when creating the session:

const session = new Session( 'en.wikipedia.org', {
	formatversion: 2,
}, {
	userAgent: 'm3api-botpassword-README-example',
	'm3api-botpassword/assert': true, // default
	'm3api-botpassword/assertUser': true, // also add assertuser=[username]
} );

Request options can also be specified after the other login()/logout() arguments, i.e. login( session, username, password, options ) and logout( session, options ). This can be useful for the m3api options, but is not recommended for m3api-botpassword options: using different assert/assertUser options for login and logout will most likely produce confusing errors.

License

Published under the ISC License. By contributing to this software, you agree to publish your contribution under the same license.