1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
# libnpmaccess
[](https://npm.im/libnpmaccess)
[](https://npm.im/libnpmaccess)
[](https://github.com/npm/cli/actions/workflows/ci-libnpmaccess.yml)
[`libnpmaccess`](https://github.com/npm/libnpmaccess) is a Node.js
library that provides programmatic access to the guts of the npm CLI's `npm
access` command. This includes managing account mfa settings, listing
packages and permissions, looking at package collaborators, and defining
package permissions for users, orgs, and teams.
## Example
```javascript
const access = require('libnpmaccess')
const opts = { '//registry.npmjs.org/:_authToken: 'npm_token }
// List all packages @zkat has access to on the npm registry.
console.log(Object.keys(await access.getPackages('zkat', opts)))
```
### API
#### `opts` for all `libnpmaccess` commands
`libnpmaccess` uses [`npm-registry-fetch`](https://npm.im/npm-registry-fetch).
All options are passed through directly to that library, so please refer
to [its own `opts`
documentation](https://www.npmjs.com/package/npm-registry-fetch#fetch-options)
for options that can be passed in.
#### `spec` parameter for all `libnpmaccess` commands
`spec` must be an [`npm-package-arg`](https://npm.im/npm-package-arg)-compatible
registry spec.
#### `access.getCollaborators(spec, opts) -> Promise<Object>`
Gets collaborators for a given package
#### `access.getPackages(user|scope|team, opts) -> Promise<Object>`
Gets all packages for a given user, scope, or team.
Teams should be in the format `scope:team` or `@scope:team`
Users and scopes can be in the format `@scope` or `scope`
#### `access.getVisibility(spec, opts) -> Promise<Object>`
Gets the visibility of a given package
#### `access.removePermissions(team, spec, opts) -> Promise<Boolean>`
Removes the access for a given team to a package.
Teams should be in the format `scope:team` or `@scope:team`
#### `access.setAccess(package, access, opts) -> Promise<Boolean>`
Sets access level for package described by `spec`.
The npm registry accepts the following `access` levels:
`public`: package is public
`private`: package is private
The npm registry also only allows scoped packages to have their access
level set.
#### access.setMfa(spec, level, opts) -> Promise<Boolean>`
Sets the publishing mfa requirements for a given package. Level must be one of the
following
`none`: mfa is not required to publish this package.
`publish`: mfa is required to publish this package, automation tokens
cannot be used to publish.
`automation`: mfa is required to publish this package, automation tokens
may also be used for publishing from continuous integration workflows.
#### access.setPermissions(team, spec, permssions, opts) -> Promise<Boolean>`
Sets permissions levels for a given team to a package.
Teams should be in the format `scope:team` or `@scope:team`
The npm registry accepts the following `permissions`:
`read-only`: Read only permissions
`read-write`: Read and write (aka publish) permissions
|
