File Explorer

1# libnpmaccess2 3[![npm version](https://img.shields.io/npm/v/libnpmaccess.svg)](https://npm.im/libnpmaccess)4[![license](https://img.shields.io/npm/l/libnpmaccess.svg)](https://npm.im/libnpmaccess)5[![CI - libnpmaccess](https://github.com/npm/cli/actions/workflows/ci-libnpmaccess.yml/badge.svg)](https://github.com/npm/cli/actions/workflows/ci-libnpmaccess.yml)6 7[`libnpmaccess`](https://github.com/npm/libnpmaccess) is a Node.js8library that provides programmatic access to the guts of the npm CLI's `npm9access` command. This includes managing account mfa settings, listing10packages and permissions, looking at package collaborators, and defining11package permissions for users, orgs, and teams.12 13## Example14 15```javascript16const access = require('libnpmaccess')17const opts = { '//registry.npmjs.org/:_authToken: 'npm_token }18 19// List all packages @zkat has access to on the npm registry.20console.log(Object.keys(await access.getPackages('zkat', opts)))21```22 23### API24 25#### `opts` for all `libnpmaccess` commands26 27`libnpmaccess` uses [`npm-registry-fetch`](https://npm.im/npm-registry-fetch).28 29All options are passed through directly to that library, so please refer30to [its own `opts`31documentation](https://www.npmjs.com/package/npm-registry-fetch#fetch-options)32for options that can be passed in.33 34#### `spec` parameter for all `libnpmaccess` commands35 36`spec` must be an [`npm-package-arg`](https://npm.im/npm-package-arg)-compatible37registry spec.38 39#### `access.getCollaborators(spec, opts) -> Promise<Object>`40 41Gets collaborators for a given package42 43#### `access.getPackages(user|scope|team, opts) -> Promise<Object>`44 45Gets all packages for a given user, scope, or team.46 47Teams should be in the format `scope:team` or `@scope:team`48 49Users and scopes can be in the format `@scope` or `scope`50 51#### `access.getVisibility(spec, opts) -> Promise<Object>`52 53Gets the visibility of a given package54 55#### `access.removePermissions(team, spec, opts) -> Promise<Boolean>`56 57Removes the access for a given team to a package.58 59Teams should be in the format `scope:team` or `@scope:team`60 61#### `access.setAccess(package, access, opts) -> Promise<Boolean>`62 63Sets access level for package described by `spec`.64 65The npm registry accepts the following `access` levels:66 67- `public`: package is public68- `private`: package is private69 70The npm registry also only allows scoped packages to have their access71level set.72 73#### access.setMfa(spec, level, opts) -> Promise<Boolean>`74 75Sets the publishing mfa requirements for a given package.  Level must be one of the76following:77 78- `none`: mfa is not required to publish this package.79- `publish`: mfa is required to publish this package, automation tokens80cannot be used to publish.81- `automation`: mfa is required to publish this package, automation tokens82may also be used for publishing from continuous integration workflows.83 84#### access.setPermissions(team, spec, permissions, opts) -> Promise<Boolean>`85 86Sets permissions levels for a given team to a package.87 88Teams should be in the format `scope:team` or `@scope:team`89 90The npm registry accepts the following `permissions`:91 92- `read-only`: Read only permissions93- `read-write`: Read and write (aka publish) permissions94