| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241 |
- const npa = require('npm-package-arg')
- const npmFetch = require('npm-registry-fetch')
- const pacote = require('pacote')
- const { log, output } = require('proc-log')
- const { otplease } = require('../utils/auth.js')
- const pkgJson = require('@npmcli/package-json')
- const BaseCommand = require('../base-cmd.js')
- const { redact } = require('@npmcli/redact')
- const readJson = async (path) => {
- try {
- const { content } = await pkgJson.normalize(path)
- return content
- } catch {
- return {}
- }
- }
- class Owner extends BaseCommand {
- static description = 'Manage package owners'
- static name = 'owner'
- static params = [
- 'registry',
- 'otp',
- 'workspace',
- 'workspaces',
- ]
- static usage = [
- 'add <user> <package-spec>',
- 'rm <user> <package-spec>',
- 'ls <package-spec>',
- ]
- static workspaces = true
- static ignoreImplicitWorkspace = false
- static async completion (opts, npm) {
- const argv = opts.conf.argv.remain
- if (argv.length > 3) {
- return []
- }
- if (argv[1] !== 'owner') {
- argv.unshift('owner')
- }
- if (argv.length === 2) {
- return ['add', 'rm', 'ls']
- }
- // reaches registry in order to autocomplete rm
- if (argv[2] === 'rm') {
- if (npm.global) {
- return []
- }
- const { name } = await readJson(npm.prefix)
- if (!name) {
- return []
- }
- const spec = npa(name)
- const data = await pacote.packument(spec, {
- ...npm.flatOptions,
- fullMetadata: true,
- _isRoot: true,
- })
- if (data && data.maintainers && data.maintainers.length) {
- return data.maintainers.map(m => m.name)
- }
- }
- return []
- }
- async exec ([action, ...args]) {
- if (action === 'ls' || action === 'list') {
- await this.ls(args[0])
- } else if (action === 'add') {
- await this.changeOwners(args[0], args[1], 'add')
- } else if (action === 'rm' || action === 'remove') {
- await this.changeOwners(args[0], args[1], 'rm')
- } else {
- throw this.usageError()
- }
- }
- async execWorkspaces ([action, ...args]) {
- await this.setWorkspaces()
- // ls pkg or owner add/rm package
- if ((action === 'ls' && args.length > 0) || args.length > 1) {
- const implicitWorkspaces = this.npm.config.get('workspace', 'default')
- if (implicitWorkspaces.length === 0) {
- log.warn(`Ignoring specified workspace(s)`)
- }
- return this.exec([action, ...args])
- }
- for (const [name] of this.workspaces) {
- if (action === 'ls' || action === 'list') {
- await this.ls(name)
- } else if (action === 'add') {
- await this.changeOwners(args[0], name, 'add')
- } else if (action === 'rm' || action === 'remove') {
- await this.changeOwners(args[0], name, 'rm')
- } else {
- throw this.usageError()
- }
- }
- }
- async ls (pkg) {
- pkg = await this.getPkg(this.npm.prefix, pkg)
- const spec = npa(pkg)
- try {
- const packumentOpts = {
- ...this.npm.flatOptions,
- fullMetadata:
- true,
- preferOnline: true,
- _isRoot: true,
- }
- const { maintainers } = await pacote.packument(spec, packumentOpts)
- if (!maintainers || !maintainers.length) {
- output.standard('no admin found')
- } else {
- output.standard(maintainers.map(m => `${m.name} <${m.email}>`).join('\n'))
- }
- } catch (err) {
- log.error('owner ls', "Couldn't get owner data", redact(pkg))
- throw err
- }
- }
- async getPkg (prefix, pkg) {
- if (!pkg) {
- if (this.npm.global) {
- throw this.usageError()
- }
- const { name } = await readJson(prefix)
- if (!name) {
- throw this.usageError()
- }
- return name
- }
- return pkg
- }
- async changeOwners (user, pkg, addOrRm) {
- if (!user) {
- throw this.usageError()
- }
- pkg = await this.getPkg(this.npm.prefix, pkg)
- log.verbose(`owner ${addOrRm}`, '%s to %s', user, pkg)
- const spec = npa(pkg)
- const uri = `/-/user/org.couchdb.user:${encodeURIComponent(user)}`
- let u
- try {
- u = await npmFetch.json(uri, this.npm.flatOptions)
- } catch (err) {
- log.error('owner mutate', `Error getting user data for ${user}`)
- throw err
- }
- // normalize user data
- u = { name: u.name, email: u.email }
- const data = await pacote.packument(spec, {
- ...this.npm.flatOptions,
- fullMetadata: true,
- preferOnline: true,
- _isRoot: true,
- })
- const owners = data.maintainers || []
- let maintainers
- if (addOrRm === 'add') {
- const existing = owners.find(o => o.name === u.name)
- if (existing) {
- log.info(
- 'owner add',
- `Already a package owner: ${existing.name} <${existing.email}>`
- )
- return
- }
- maintainers = [
- ...owners,
- u,
- ]
- } else {
- maintainers = owners.filter(o => o.name !== u.name)
- if (maintainers.length === owners.length) {
- log.info('owner rm', 'Not a package owner: ' + u.name)
- return false
- }
- if (!maintainers.length) {
- throw Object.assign(
- new Error(
- 'Cannot remove all owners of a package. Add someone else first.'
- ),
- { code: 'EOWNERRM' }
- )
- }
- }
- const dataPath = `/${spec.escapedName}/-rev/${encodeURIComponent(data._rev)}`
- try {
- const res = await otplease(this.npm, this.npm.flatOptions, opts => {
- return npmFetch.json(dataPath, {
- ...opts,
- method: 'PUT',
- body: {
- _id: data._id,
- _rev: data._rev,
- maintainers,
- },
- spec,
- })
- })
- if (addOrRm === 'add') {
- output.standard(`+ ${user} (${spec.name})`)
- } else {
- output.standard(`- ${user} (${spec.name})`)
- }
- return res
- } catch (err) {
- throw Object.assign(
- new Error('Failed to update package: ' + JSON.stringify(err.message)),
- { code: 'EOWNERMUTATE' }
- )
- }
- }
- }
- module.exports = Owner
|