wikibase-cli 16.2.1 → 16.3.0

package/bin/wb-add-alias

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 const program = require('commander')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
-const inlineArgsParser = require('../lib/term_command_args_parser')('alias')
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+const { termCommandArgsParser } = require('../lib/common_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: termCommandArgsParser('alias')
+})
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('alias', 'add')

package/bin/wb-add-badge

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+const program = require('commander')
+const { badgesCommandArgsParser } = require('../lib/common_command_args_parser')
+const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: badgesCommandArgsParser
+})
+program.customHelpOption = require('../lib/command_with_template_custom_help')
+require('../lib/edit/edit_command')('badge', 'add')

package/bin/wb-add-claim

@@ -6,6 +6,6 @@ const inlineArgsParser = ([ id, property, value ]) => {
   if (program.rank) data.rank = program.rank
   return [ data ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('claim', 'add')

package/bin/wb-add-qualifier

@@ -6,6 +6,6 @@ const inlineArgsParser = ([ guid, property, value ]) => {
   guid = parseGuid(guid)
   return [ { guid, property, value } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('qualifier', 'add')

package/bin/wb-add-reference

@@ -6,6 +6,6 @@ const inlineArgsParser = ([ guid, property, value ]) => {
   guid = parseGuid(guid)
   return [ { guid, property, value } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('reference', 'add')

package/bin/wb-badges

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+const program = require('../lib/program')
+const { get } = require('../lib/request')
+const errors_ = require('../lib/errors')
+const entityAttributeCommand = require('../lib/entity_attribute_command')
+
+program
+.process('badges')
+
+const { instance } = program
+
+if (!instance) throw new Error('no instance set')
+
+get(`${instance}/w/api.php?action=wbavailablebadges&format=json`)
+.then(({ badges: badgesIds }) => {
+  return entityAttributeCommand('label', { ids: badgesIds })
+})
+.catch(errors_.exit)

package/bin/wb-delete-entity

@@ -2,6 +2,6 @@
 const program = require('commander')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
 const inlineArgsParser = args => [ { id: args[0] } ]
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('entity', 'delete')

package/bin/wb-merge-entity

@@ -19,6 +19,6 @@ const getSortedEntitiesIds = args => {
 
 const getNumericId = id => parseInt(id.replace(/^[A-Z]+/i, ''))
 
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('entity', 'merge')

package/bin/wb-move-claim

@@ -12,6 +12,6 @@ const inlineArgsParser = args => {
     return [ { guid, id, property } ]
   }
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('claim', 'move')

package/bin/wb-move-qualifier

@@ -13,6 +13,6 @@ const inlineArgsParser = args => {
     return [ { guid, oldProperty, newProperty } ]
   }
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('qualifier', 'move')

package/bin/wb-query

@@ -18,6 +18,7 @@ program
 .option('-f, --format <format>', "set output format: json, xml, tsv, csv, binrdf, table. Default: 'table' when 1 value is selected, 'json' otherwise")
 .option('-n, --limit <num>', 'set the request results limit')
 .option('-x, --index <variable>', "return the result as an index, instead of a list, using the passed variable as key (can't be used with the 'raw' option)")
+.option('--log-response-headers [comma-separated headers names]', 'request to output all or some HTTP header fields from the server response on stderr')
 .process('query')
 
 if (!(program.subject || program.property || program.object || program.describe || program.sample)) {

package/bin/wb-remove-alias

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 const program = require('commander')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
-const inlineArgsParser = require('../lib/term_command_args_parser')('alias')
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+const { termCommandArgsParser } = require('../lib/common_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: termCommandArgsParser('alias')
+})
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('alias', 'remove')

package/bin/wb-remove-badge

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+const program = require('commander')
+const { badgesCommandArgsParser } = require('../lib/common_command_args_parser')
+const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: badgesCommandArgsParser
+})
+program.customHelpOption = require('../lib/command_with_template_custom_help')
+require('../lib/edit/edit_command')('badge', 'remove')

package/bin/wb-remove-claim

@@ -3,6 +3,6 @@ const program = require('commander')
 const { parseGuid } = require('../lib/parse_command_utils')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
 const inlineArgsParser = guids => [ { guid: guids.map(parseGuid) } ]
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('claim', 'remove')

package/bin/wb-remove-description

@@ -4,7 +4,7 @@ const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_pa
 const inlineArgsParser = ([ id, language ]) => {
   return [ { id, language, value: null } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')({
   name: 'remove-description',

package/bin/wb-remove-label

@@ -4,7 +4,7 @@ const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_pa
 const inlineArgsParser = ([ id, language ]) => {
   return [ { id, language, value: null } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')({
   name: 'remove-label',

package/bin/wb-remove-qualifier

@@ -7,6 +7,6 @@ const inlineArgsParser = ([ guid, hash ]) => {
   hash = hash && hash.split('|')
   return [ { guid, hash } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('qualifier', 'remove')

package/bin/wb-remove-reference

@@ -7,6 +7,6 @@ const inlineArgsParser = ([ guid, hash ]) => {
   hash = hash.split('|')
   return [ { guid, hash } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('reference', 'remove')

package/bin/wb-remove-sitelink

@@ -4,7 +4,7 @@ const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_pa
 const inlineArgsParser = ([ id, site ]) => {
   return [ { id, site, title: null } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')({
   name: 'remove-sitelink',

package/bin/wb-set-alias

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 const program = require('commander')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
-const inlineArgsParser = require('../lib/term_command_args_parser')('alias')
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+const { termCommandArgsParser } = require('../lib/common_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: termCommandArgsParser('alias')
+})
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('alias', 'set')

package/bin/wb-set-description

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 const program = require('commander')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
-const inlineArgsParser = require('../lib/term_command_args_parser')('description')
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+const { termCommandArgsParser } = require('../lib/common_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: termCommandArgsParser('description')
+})
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('description', 'set')

package/bin/wb-set-label

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 const program = require('commander')
 const polymorphicCommandArgsParser = require('../lib/polymorphic_command_args_parser')
-const inlineArgsParser = require('../lib/term_command_args_parser')('label')
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+const { termCommandArgsParser } = require('../lib/common_command_args_parser')
+program.customArgsParser = polymorphicCommandArgsParser({
+  inlineArgsParser: termCommandArgsParser('label')
+})
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('label', 'set')

package/bin/wb-set-sitelink

@@ -9,6 +9,6 @@ const inlineArgsParser = ([ id, site, title, badges ]) => {
   }
   return [ { id, site, title, badges } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('sitelink', 'set')

package/bin/wb-sparql

@@ -8,6 +8,7 @@ program
 .option('-o, --open', 'open the query in the Query Service GUI')
 .option('-f, --format <format>', "set output format: json, xml, tsv, csv, binrdf, table. Default: 'table' when 1 value is selected, 'json' otherwise")
 .option('-x, --index <variable>', "return the result as an index, instead of a list, using the passed variable as key (can't be used with the 'raw' option)")
+.option('--log-response-headers [comma-separated headers names]', 'request to output all or some HTTP header fields from the server response on stderr')
 .process('sparql')
 
 const fs = require('fs')

package/bin/wb-update-claim

@@ -16,6 +16,6 @@ const inlineArgsParser = args => {
   if (program.rank) data.rank = program.rank
   return [ data ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('claim', 'update')

package/bin/wb-update-qualifier

@@ -6,6 +6,6 @@ const inlineArgsParser = ([ guid, property, oldValue, newValue ]) => {
   guid = parseGuid(guid)
   return [ { guid, property, oldValue, newValue } ]
 }
-program.customArgsParser = polymorphicCommandArgsParser(inlineArgsParser)
+program.customArgsParser = polymorphicCommandArgsParser({ inlineArgsParser })
 program.customHelpOption = require('../lib/command_with_template_custom_help')
 require('../lib/edit/edit_command')('qualifier', 'update')

package/lib/{term_command_args_parser.js → common_command_args_parser.js}

@@ -1,4 +1,4 @@
-module.exports = termType => ([ id, language, ...value ]) => {
+const termCommandArgsParser = termType => ([ id, language, ...value ]) => {
   value = dropQuotes(value.join(' '))
   if (termType === 'alias') value = value.split('|')
   return [ { id, language, value } ]
@@ -9,3 +9,13 @@ const dropQuotes = value => {
   if (value.startsWith('"') && value.endsWith('"')) return value.slice(1, -1)
   return value
 }
+
+const badgesCommandArgsParser = ([ id, site, badges ]) => {
+  badges = badges.split(/[,|]/)
+  return [ { id, site, badges } ]
+}
+
+module.exports = {
+  termCommandArgsParser,
+  badgesCommandArgsParser,
+}

package/lib/edit/edit_command.js

@@ -80,7 +80,7 @@ let wbEditConfig
 
 const runEditCommand = async (section, action, args) => {
   if (program.dry) {
-    if (args[0] != null) console.log(JSON.stringify(args[0]))
+    if (args.length > 0) console.log(JSON.stringify({ section, action, args }))
     return
   }
 

package/lib/entity_attribute_command.js

@@ -4,8 +4,13 @@ const pluralize = require('./pluralize')
 const { grey, red } = require('chalk')
 const _ = require('lodash')
 
-module.exports = attribute => {
-  const commandName = attribute
+module.exports = (attribute, extraParams) => {
+  let commandName, ids
+  if (extraParams) {
+    ids = extraParams.ids
+  } else {
+    commandName = attribute
+  }
   const pluarlizedAttribute = pluralize(attribute)
   const props = [ pluarlizedAttribute ]
 
@@ -16,7 +21,7 @@ module.exports = attribute => {
     entitiesList.forEach(logAttribute(attribute, lang, strictLang, multiEntities, maxLength, output))
   }
 
-  entityDataParser({ commandName, props, parser })
+  entityDataParser({ commandName, props, parser, ids })
 }
 
 const logAttribute = (attribute, lang, strictLang, multiEntities, maxLength, output) => entity => {

package/lib/polymorphic_command_args_parser.js

@@ -8,7 +8,7 @@ const inlineOptions = [
 
 const noInlineOptions = () => inlineOptions.filter(option => program[option] != null).length === 0
 
-module.exports = inlineArgsParser => args => {
+module.exports = ({ inlineArgsParser }) => args => {
   if ((args.length === 1 && isJsonString(args[0]) && noInlineOptions()) || isFilePathSync(args[0])) {
     return objectArgParser(args)
   } else {

package/lib/program.js

@@ -36,6 +36,7 @@ program.process = command => {
 const commandsAcceptingZeroArguments = [
   // Can be called without argument
   'props',
+  'badges',
   // All arguments are passed as options values
   // making program.args.length === 0 likely
   'query',

package/lib/request.js

@@ -1,4 +1,5 @@
 const fetch = require('node-fetch')
+const { logResponseHeaders } = require('./program')
 // Using a custom agent to set keepAlive=true
 // https://nodejs.org/api/http.html#http_class_http_agent
 // https://github.com/bitinn/node-fetch#custom-agent
@@ -11,6 +12,7 @@ const httpsAgent = new https.Agent({ keepAlive: true })
 // - accept certificates that would otherwise generate a UNABLE_TO_VERIFY_LEAF_SIGNATURE error
 const insecureHttpsAgent = new https.Agent({ keepAlive: true, rejectUnauthorized: false })
 const tlsErrorsHosts = new Set([ 'datos.bne.es' ])
+const { pick } = require('lodash')
 
 const agent = ({ host, protocol }) => {
   if (tlsErrorsHosts.has(host)) return protocol === 'http:' ? httpAgent : insecureHttpsAgent
@@ -24,24 +26,33 @@ const buildHeaders = customHeaders => {
 }
 
 module.exports = {
-  get: url => {
-    return fetch(url, { headers: globalHeaders, agent })
-    .then(rejectErrors)
+  get: async url => {
+    const res = await fetch(url, { headers: globalHeaders, agent })
+    return handleResponse({ res, url })
   },
 
-  customGet: ({ url, headers }) => {
-    return fetch(url, { headers: buildHeaders(headers), agent })
-    .then(rejectErrors)
+  customGet: async ({ url, headers }) => {
+    const res = await fetch(url, { headers: buildHeaders(headers), agent })
+    return handleResponse({ res, url })
   },
 
-  post: ({ url, body, headers }) => {
-    return fetch(url, { method: 'post', body, headers: buildHeaders(headers), agent })
-    .then(rejectErrors)
+  post: async ({ url, body, headers }) => {
+    const method = 'post'
+    const res = await fetch(url, { method, body, headers: buildHeaders(headers), agent })
+    return handleResponse({ res, url, method })
   }
 }
 
-const rejectErrors = async res => {
+const handleResponse = async ({ res, url, method }) => {
   let body = await res.text()
+  if (logResponseHeaders) {
+    let headers = res.headers.raw()
+    if (typeof logResponseHeaders === 'string') {
+      const headersSubset = logResponseHeaders.split(',')
+      headers = pick(headers, headersSubset)
+    }
+    console.error(JSON.stringify({ request: { url, method }, response: { headers } }))
+  }
   // When Wikibase crash it doesn't return JSON errors anymore
   if (body[0] === '{') body = JSON.parse(body)
   const { status: statusCode } = res

package/metadata/add-badge.js

@@ -0,0 +1,9 @@
+module.exports = {
+  alias: 'ab',
+  args: '<entity> <site> [badges]',
+  description: 'add badges on an existing sitelink, without removing other badges that might already have been set',
+  options: require('../lib/common_options').editCommands,
+  examples: [
+    { args: 'Q4115189 enwikiquote Q17437796,Q17437798', comment: 'Add Q17437796 and Q17437798 badges on Q4115189 enwikiquote sitelink' },
+  ]
+}

package/metadata/badges.js

@@ -0,0 +1,16 @@
+module.exports = {
+  args: '',
+  description: 'list sitelink badges available on a Wikibase instance',
+  options: {
+    lang: false,
+    verbose: false,
+    clipboard: true,
+    json: true,
+    instance: true,
+    sparqlEndpoint: false
+  },
+  examples: [
+    { args: '', comment: 'List badges on the Wikibase instance set in config' },
+    { args: '--instance https://test.wikidata.org', comment: 'List badges on an explicit Wikibase instance' },
+  ]
+}

package/metadata/remove-badge.js

@@ -0,0 +1,9 @@
+module.exports = {
+  alias: 'rb',
+  args: '<entity> <site> [badges]',
+  description: 'remove badges on an existing sitelink',
+  options: require('../lib/common_options').editCommands,
+  examples: [
+    { args: 'Q4115189 enwikiquote Q17437796,Q17437798', comment: 'Remove Q17437796 and Q17437798 badges on Q4115189 enwikiquote sitelink' },
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikibase-cli",
-  "version": "16.2.1",
+  "version": "16.3.0",
   "description": "A command-line interface to Wikibase",
   "main": "index.js",
   "bin": {
@@ -50,7 +50,7 @@
     "shell-quote": "^1.7.3",
     "split": "^1.0.1",
     "through": "^2.3.8",
-    "wikibase-edit": "^5.2.0",
+    "wikibase-edit": "^5.3.0",
     "wikibase-sdk": "^8.1.0",
     "wikidata-lang": "^2.0.11"
   },