wikibase-cli 17.0.1 → 17.0.3

package/README.md

@@ -44,6 +44,7 @@ This project received [a Wikimedia Project Grant](https://meta.wikimedia.org/wik
   - [Read operations](docs/read_operations.md)
   - [Write operations](docs/write_operations.md)
   - [Config](docs/config.md)
+- [Debug](#debug)
 - [See Also](#see-also)
 - [You may also like](#you-may-also-like)
 - [License](#license)
@@ -108,6 +109,17 @@ Allows to persist options
 
 See [Config](docs/config.md)
 
+## Debug
+To get debugging informations, set the `DEBUG` environment variable:
+```sh
+# Print all wikibase-cli-specific debugging information
+export DEBUG=wikibase-cli ; wb
+# Also print wikibase-edit debugging information
+export DEBUG=wikibase-* ; wb
+# Print only request debugging information
+export DEBUG=wikibase-cli:request ; wd label Q1
+```
+
 ## See Also
 * [wikibase-sdk](https://www.npmjs.com/package/wikibase-sdk): A javascript tool suite to query and work with Wikibase data, heavily used by wikibase-cli
 * [wikibase-edit](https://www.npmjs.com/package/wikibase-edit): Edit Wikibase from NodeJS, used in wikibase-cli for all [write operations](docs/write_operations.md)

package/bin/wb-generate-template.js

@@ -7,7 +7,7 @@ import parseProps from '#lib/parse_props'
 import program from '#lib/program'
 import { readIdsFromStdin } from '#lib/read_ids_from_stdin'
 import { tolerantIdParserFactory } from '#lib/tolerant_id_parser'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 await program
 .option('-p, --props <props>', 'request only certain properties (info, sitelinks, aliases, labels, descriptions, claims, datatype)')
@@ -22,7 +22,7 @@ const parseId = tolerantIdParserFactory()
 const ids = program.args.map(parseId)
 exitOnMissingInstance(program.instance)
 
-const { getEntityRevision, getManyEntities } = wbk(program)
+const { getEntityRevision, getManyEntities } = getWbk(program)
 
 const { revision, minimize } = program
 let { format, json } = program

package/bin/wb-id.js

@@ -6,13 +6,13 @@ import getRedirectedSitelinkTitle from '#lib/get_redirected_sitelink_title'
 import { outputFactory } from '#lib/output'
 import program from '#lib/program'
 import { get } from '#lib/request'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 await program.process('id')
 
 exitOnMissingInstance(program.instance)
 
-const { getEntitiesFromSitelinks } = wbk(program)
+const { getEntitiesFromSitelinks } = getWbk(program)
 
 let { lang } = program
 const output = outputFactory(program)

package/bin/wb-open.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
-import { isPropertyId } from 'wikibase-sdk'
+import { isMediaInfoId, isPropertyId } from 'wikibase-sdk'
 import errors_ from '#lib/errors'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import { getSitelinkUrlFactory } from '#lib/get_sitelink_url'
+import { getMediaInfoEntityTitle } from '#lib/mediainfo'
 import { openUrl } from '#lib/open'
 import program from '#lib/program'
 import { tolerantIdParserFactory } from '#lib/tolerant_id_parser'
@@ -52,6 +53,9 @@ if (!ids || ids.length === 0) {
     } else if (program.history) {
       if (isPropertyId(id)) {
         openUrl(`${instance}/w/index.php?title=Property:${id}&action=history`)
+      } else if (isMediaInfoId(id)) {
+        const title = await getMediaInfoEntityTitle(id)
+        openUrl(`${instance}/w/index.php?title=${title}&action=history`)
       } else {
         // Will be redirected to title=${id} if Item is the main namespace
         openUrl(`${instance}/w/index.php?title=Item:${id}&action=history`)

package/bin/wb-revisions.js

@@ -7,7 +7,7 @@ import logNdjson from '#lib/log_ndjson'
 import program from '#lib/program'
 import { get } from '#lib/request'
 import { isPositiveIntegerString } from '#lib/types'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 await program
 .option('-s, --start <date>', 'start date')
@@ -17,7 +17,7 @@ await program
 
 exitOnMissingInstance(program.instance)
 
-const { getRevisions } = wbk(program)
+const { getRevisions } = getWbk(program)
 
 // Not parsing the ids with ../lib/tolerant_id_parser as that would
 // remove prefixes which are required for entities out of the main namespace

package/bin/wb-search.js

@@ -7,7 +7,7 @@ import parseEntityType from '#lib/parse_entity_type'
 import program from '#lib/program'
 import { get } from '#lib/request'
 import { isValidLang } from '#lib/validate'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 await program
 .option('-p, --properties <properties>', 'request additional properties (separated by a comma) (implies verbose mode)')
@@ -33,7 +33,7 @@ if (!isValidLang(language)) {
 }
 exitOnMissingInstance(program.instance)
 
-const { searchEntities, cirrusSearchPages } = wbk(program)
+const { searchEntities, cirrusSearchPages } = getWbk(program)
 
 type = parseEntityType(type)
 

package/bin/wb.js

@@ -2,6 +2,7 @@
 import fs from 'node:fs'
 import path, { resolve } from 'node:path'
 import program from 'commander'
+import { debug } from '#lib/debug'
 import { getDirname } from '#lib/fs'
 import { readJsonFile } from '#lib/json'
 
@@ -11,6 +12,8 @@ const pkg = readJsonFile(resolve(dirname, '../package.json'))
 program.version(pkg.version)
 program.description(pkg.description)
 
+debug('program:metadata', { name: pkg.name, version: pkg.version })
+
 // To add a new command, create a file in ../metadata/${new-command-name}
 // and add an executable at ./wb-${new-command-name}
 

package/lib/chalk.js

@@ -4,6 +4,7 @@ export const bgBlue = chalk.bgBlue
 export const bgGreen = chalk.bgGreen
 export const bgMagenta = chalk.bgMagenta
 export const blue = chalk.blue
+export const cyan = chalk.cyan
 export const green = chalk.green
 export const grey = chalk.grey
 export const inverse = chalk.inverse

package/lib/debug.js

@@ -0,0 +1,19 @@
+import { cyan, grey } from '#lib/chalk'
+
+const { DEBUG = '' } = process.env
+const namespace = 'wikibase-cli'
+const debugMode = DEBUG === '*' || (DEBUG.length > 0 && namespace.startsWith(DEBUG.replace(/\*$/, ''))) || DEBUG.startsWith(`${namespace}:`)
+const debugSection = DEBUG.split(':').slice(1).join(':').replace(/\*$/, '')
+
+export function debug (section, ...args) {
+  if (!debugMode) return
+  if (debugSection && !section.startsWith(debugSection)) return
+  console.error(`${grey(new Date().toISOString())} ${cyan(`${namespace}:${section}`)}`, ...args.map(stringify))
+}
+
+function stringify (data) {
+  if (typeof data === 'string') return data
+  const str = JSON.stringify(data)
+  if (str === '{}' || str === '[]') return ''
+  else return str
+}

package/lib/drop_non_selected_subprops.js

@@ -3,6 +3,11 @@ import { pick } from 'lodash-es'
 export default (entity, requestedPropsAndSubProps) => {
   if (!requestedPropsAndSubProps) return
 
+  if (requestedPropsAndSubProps.claims && entity.statements) {
+    requestedPropsAndSubProps.statements = requestedPropsAndSubProps.claims
+    delete requestedPropsAndSubProps.claims
+  }
+
   const requestedProps = Object.keys(requestedPropsAndSubProps)
   requestedProps.forEach(prop => {
     const subkeys = Object.keys(requestedPropsAndSubProps[prop])

package/lib/edit/assert_credentials.js

@@ -1,4 +1,5 @@
 import { yellow } from '#lib/chalk'
+import { debug } from '#lib/debug'
 import { initCredentials } from './init_credentials.js'
 
 export default async ({ instance, credentials, batch }) => {
@@ -11,6 +12,8 @@ export default async ({ instance, credentials, batch }) => {
   if (!(oauth || (username && password))) {
     return requestCredentials(instance, batch)
   }
+
+  debug('credentials', Object.keys(instanceCredentials))
 }
 
 const requestCredentials = (instance, batch) => {

package/lib/edit/edit_command.js

@@ -2,6 +2,7 @@ import { inspect } from 'node:util'
 import split from 'split'
 import wbEdit from 'wikibase-edit'
 import { red } from '#lib/chalk'
+import { debug } from '#lib/debug'
 import { config } from '../config/config.js'
 import errors_ from '../errors.js'
 import program from '../program.js'
@@ -10,6 +11,7 @@ import parseBatchLine from './parse_batch_line.js'
 import parseObjectValue from './parse_object_value.js'
 
 export async function execEditCommand (section, action) {
+  debug('edit_command', { section, action })
   let name
   if (typeof section === 'object') {
     // Pass a name when it can not be deduced from the wikibase-edit section

package/lib/entity_attribute_command.js

@@ -1,10 +1,12 @@
 import { max, padEnd, values } from 'lodash-es'
 import { grey, red } from '#lib/chalk'
+import { debug } from '#lib/debug'
 import entityAttributeParser from './entity_attribute_parser.js'
 import { entityDataParser } from './entity_data_parser.js'
 import pluralize from './pluralize.js'
 
 export async function entityAttributeCommand (attribute, extraParams) {
+  debug('entity_attribute_command', { attribute, extraParams })
   let commandName, ids
   if (extraParams) {
     ids = extraParams.ids

package/lib/entity_data_parser.js

@@ -4,7 +4,7 @@ import { outputFactory } from '#lib/output'
 import program from '#lib/program'
 import { get } from '#lib/request'
 import { tolerantIdParserFactory } from '#lib/tolerant_id_parser'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 const parseId = tolerantIdParserFactory()
 
@@ -21,7 +21,7 @@ export async function entityDataParser (params) {
 
   exitOnMissingInstance(program.instance)
 
-  const { getEntities } = wbk(program)
+  const { getEntities } = getWbk(program)
   const output = outputFactory(program)
 
   const { args, lang, strictLang } = program

package/lib/fetch_and_log_entity_revision.js

@@ -3,13 +3,13 @@ import { simplifyEntity } from 'wikibase-sdk'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import optionsFactory from '#lib/parse_simplify_options'
 import { get } from '#lib/request'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 import program from './program.js'
 
 exitOnMissingInstance(program.instance)
 
 export async function fetchAndLogEntityRevision (id, revision) {
-  const { getEntityRevision } = wbk(program)
+  const { getEntityRevision } = getWbk(program)
   const { simplify: simplifyOption } = program
   const options = optionsFactory(program)
   const url = getEntityRevision({ id, revision })

package/lib/fetch_and_log_guid_data.js

@@ -4,13 +4,13 @@ import { simplifyClaim } from 'wikibase-sdk'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import optionsFactory from '#lib/parse_simplify_options'
 import { get } from '#lib/request'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 import { outputFactory } from './output.js'
 import program from './program.js'
 
 export async function fetchAndLogGuidData (guid) {
   exitOnMissingInstance(program.instance)
-  const { getEntities } = wbk(program)
+  const { getEntities } = getWbk(program)
   const options = optionsFactory(program)
   const { simplify: simplifyOption } = program
   const output = outputFactory(program)

package/lib/fetch_and_log_property_claims_data.js

@@ -3,13 +3,13 @@ import { simplifyPropertyClaims } from 'wikibase-sdk'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import optionsFactory from '#lib/parse_simplify_options'
 import { get } from '#lib/request'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 import { outputFactory } from './output.js'
 import program from './program.js'
 
 export async function fetchAndLogPropertyClaimsData (propertyClaimsId) {
   exitOnMissingInstance(program.instance)
-  const { getEntities } = wbk(program)
+  const { getEntities } = getWbk(program)
   const options = optionsFactory(program)
   const { simplify: simplifyOption } = program
   const output = outputFactory(program)

package/lib/fetch_lang_props.js

@@ -2,14 +2,14 @@ import { simplifySparqlResults } from 'wikibase-sdk'
 import { red, yellow } from '#lib/chalk'
 import { get } from '#lib/request'
 import { isValidLang } from '#lib/validate'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 import { exitOnMissingSparqlEndpoint } from './exit_on_missing.js'
 import queryAllProperties from './queries/all_properties.js'
 
 export default async program => {
   const { lang, sparqlEndpoint } = program
   exitOnMissingSparqlEndpoint(program.sparqlEndpoint)
-  const { sparqlQuery } = wbk(program)
+  const { sparqlQuery } = getWbk(program)
 
   if (!isValidLang(lang)) throw Error(red(`invalid language: ${lang}`))
 

package/lib/get_entities.js

@@ -1,11 +1,11 @@
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 import program from './program.js'
 import { get } from './request.js'
 
 export default async params => {
   // JIT require to be sure program.process was already called
   // and program.instance is set
-  const { getManyEntities } = wbk(program)
+  const { getManyEntities } = getWbk(program)
 
   const urls = getManyEntities(params)
   const allEntities = {}

package/lib/get_entities_by_batches.js

@@ -4,13 +4,13 @@ import errors_ from './errors.js'
 import program from './program.js'
 import { get } from './request.js'
 import { wait } from './utils.js'
-import wbk from './wbk.js'
+import { getWbk } from './wbk.js'
 
 const noop = () => {}
 
 export async function getEntitiesByBatches ({ ids, props, languages, urls, onResponse, onDone = noop }) {
   exitOnMissingInstance(program.instance)
-  const { getManyEntities } = wbk(program)
+  const { getManyEntities } = getWbk(program)
 
   if (ids != null) {
     ids.forEach(id => {

package/lib/get_sitelink_url.js

@@ -1,11 +1,11 @@
 import errors_ from '#lib/errors'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import { get } from '#lib/request'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 export function getSitelinkUrlFactory (program) {
   exitOnMissingInstance(program.instance)
-  const { getEntities } = wbk(program)
+  const { getEntities } = getWbk(program)
   return async function (id, lang, sitelinkSuffix) {
     if (id[0] === 'P') {
       console.error("Wikibase properties don't have sitelinks")

package/lib/make_sparql_query.js

@@ -5,13 +5,13 @@ import { exitOnMissingSparqlEndpoint } from '#lib/exit_on_missing'
 import { outputFactory } from '#lib/output'
 import program from '#lib/program'
 import { customGet, post } from '#lib/request'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 
 export default (sparql, format = 'json') => {
   // JIT require to be sure program.process was already called
   // and program.sparqlEndpoint is set
   exitOnMissingSparqlEndpoint(program.sparqlEndpoint)
-  const { sparqlQuery } = wbk(program)
+  const { sparqlQuery } = getWbk(program)
 
   if (localFormatsDerivedFromJSON.includes(format)) format = 'json'
 

package/lib/mediainfo.js

@@ -0,0 +1,11 @@
+import program from '#lib/program'
+import { get } from '#lib/request'
+import { getWbk } from '#lib/wbk'
+
+export async function getMediaInfoEntityTitle (id) {
+  const { getEntities } = getWbk(program)
+  const url = getEntities({ ids: [ id ], props: [ 'info' ] })
+  const body = await get(url)
+  const { title } = Object.values(body.entities)[0]
+  return title
+}

package/lib/program.js

@@ -1,14 +1,17 @@
 // Extends commander with options and functions used by all subcommands.
 
 import program from 'commander'
+import { debug } from '#lib/debug'
 import { applyEnvAndConfigDefault } from './apply_env_and_config_default.js'
 import globalOptionsHelp from './global_options_help.js'
 import logCommandExamples from './log_command_examples.js'
 
 program.process = async command => {
+  let options
   if (command) {
     const { default: metadata } = await import(`../metadata/${command}.js`)
-    const { args, description, options, examples, doc } = metadata
+    const { args, description, examples, doc } = metadata
+    ;({ options } = metadata)
     program.arguments(args)
     program.description(description)
     Object.keys(globalOptionsHelp).forEach(key => {
@@ -31,6 +34,18 @@ program.process = async command => {
     }
   }
   applyEnvAndConfigDefault(program)
+  if (command) {
+    debug('program:process', { argv, command, args: program.args, options: getOptionsKeyValues(options), showHelp })
+  } else {
+    debug('program:process', { argv, showHelp })
+  }
+}
+
+function getOptionsKeyValues (options) {
+  const optionsEntries = Object.entries(options)
+    .filter(([ , used ]) => used)
+    .map(([ option ]) => [ option, program[option] ])
+  return Object.fromEntries(optionsEntries)
 }
 
 const commandsAcceptingZeroArguments = [

package/lib/request.js

@@ -5,6 +5,7 @@ import http from 'node:http'
 import https from 'node:https'
 import { pick } from 'lodash-es'
 import fetch from 'node-fetch'
+import { debug } from '#lib/debug'
 import program from './program.js'
 import globalHeaders from './request_headers.js'
 
@@ -25,19 +26,25 @@ const buildHeaders = customHeaders => {
   else return globalHeaders
 }
 
+function request (url, options) {
+  const { method = 'get', headers, body } = options
+  debug('request', method.toUpperCase(), url, { headers, body })
+  return fetch(url, options)
+}
+
 export const get = async url => {
-  const res = await fetch(url, { headers: globalHeaders, agent })
+  const res = await request(url, { headers: globalHeaders, agent })
   return handleResponse({ res, url })
 }
 
 export const customGet = async ({ url, headers }) => {
-  const res = await fetch(url, { headers: buildHeaders(headers), agent })
+  const res = await request(url, { headers: buildHeaders(headers), agent })
   return handleResponse({ res, url })
 }
 
 export const post = async ({ url, body, headers }) => {
   const method = 'post'
-  const res = await fetch(url, { method, body, headers: buildHeaders(headers), agent })
+  const res = await request(url, { method, body, headers: buildHeaders(headers), agent })
   return handleResponse({ res, url, method })
 }
 

package/lib/sparql_query_command.js

@@ -1,5 +1,5 @@
 import { openUrl } from '#lib/open'
-import wbk from '#lib/wbk'
+import { getWbk } from '#lib/wbk'
 import makeSparqlQuery from './make_sparql_query.js'
 import { outputFactory } from './output.js'
 import program from './program.js'
@@ -18,7 +18,7 @@ export function sparqlQueryCommand (sparql, format) {
 }
 
 function openQueryServiceGUI (sparql) {
-  const { sparqlQuery } = wbk(program)
+  const { sparqlQuery } = getWbk(program)
   const queryServiceGUI = sparqlQuery(sparql).replace('sparql?format=json&query=', '#')
   openUrl(queryServiceGUI)
 }

package/lib/summary_parser.js

@@ -37,13 +37,17 @@ const parseEntity = async (entity, params) => {
   }
 
   const { lang, program } = params
-  const { type, datatype } = entity
+  const { type, datatype, title } = entity
+
+  if (type === 'mediainfo') {
+    console.log(grey('title'), title)
+  }
 
   if (datatype) {
     console.log(bgMagenta(white('Datatype')), datatype)
   }
 
-  if (type === 'item' || type === 'property') {
+  if (type === 'item' || type === 'property' || type === 'mediainfo') {
     const label = entityAttributeParser(entity, 'label', lang)
     console.log(bgGreen(white('Label')), label)
     const description = entityAttributeParser(entity, 'description', lang)

package/lib/wbk.js

@@ -1,7 +1,7 @@
 // A wrapper of wikidata SDK to customize the Wikibase instance if requested in config
 import WBK from 'wikibase-sdk'
 
-export default program => {
+export function getWbk (program) {
   const { instance, sparqlEndpoint } = program
   program.wbk = program.wbk || WBK({ instance, sparqlEndpoint })
   return program.wbk

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikibase-cli",
-  "version": "17.0.1",
+  "version": "17.0.3",
   "description": "A command-line interface to Wikibase",
   "type": "module",
   "main": "index.js",
@@ -58,8 +58,8 @@
     "shell-quote": "^1.8.1",
     "split": "^1.0.1",
     "through": "^2.3.8",
-    "wikibase-edit": "^6.0.1",
-    "wikibase-sdk": "^9.2.0",
+    "wikibase-edit": "^6.0.3",
+    "wikibase-sdk": "^9.2.1",
     "wikidata-lang": "^2.0.11"
   },
   "devDependencies": {