wikibase-cli 16.3.2 → 17.0.0

package/lib/output.js

@@ -1,45 +1,47 @@
-const types = require('./types')
-const { promisify } = require('util')
+import { promisify } from 'node:util'
+import { grey } from '#lib/chalk'
+import { copyAndExit } from '#lib/copy'
+import { tabularize } from '#lib/tabularize'
+import { isArray, isCollection, isPlainObject } from '#lib/types'
+
 const stdoutWrite = promisify(process.stdout.write).bind(process.stdout)
 
 // Calling program just in time, so that code running
 // after this first level function can still change the option
-module.exports = program => async (data, optional, customColors) => {
-  const isArray = types.isArray(data)
-  const isPlainObject = types.isPlainObject(data)
-  const isCollection = types.isCollection(data)
-
-  program.json = program.json || program.format === 'json'
+export function outputFactory (program) {
+  return async function (data, optional, customColors) {
+    program.json = program.json || program.format === 'json'
 
-  // Flatten when data is one array in an array to get a chance
-  // to have a shell-friendly output
-  if (isArray && data.length === 1 && types.isArray(data[0])) data = data[0]
+    // Flatten when data is one array in an array to get a chance
+    // to have a shell-friendly output
+    if (isArray(data) && data.length === 1 && isArray(data[0])) data = data[0]
 
-  if (optional) {
-    if (!program.verbose) return
-    if (!customColors) data = require('chalk').grey(data)
-    await log(data)
-  } else {
-    if (isArray && !isCollection && !program.json) {
-      if (program.format === 'inline') data = data.join(' ')
-      else data = data.join('\n')
-    } else if (isCollection && program.format === 'table') {
-      data = require('./tabularize')(data)
-    } else if (program.json || isCollection || isPlainObject) {
-      // indent deep objects
-      data = JSON.stringify(data, null, 2)
-      // Do not copy to clipboard when the output is valid JSON
-      program.clipboard = false
-    }
-    if (data == null || (isArray && data.length === 0)) {
-      console.error('no result found')
-      return process.exit(1)
-    }
-    if (program.clipboard) {
-      require('./copy')(data)
-    } else {
+    if (optional) {
+      if (!program.verbose) return
+      if (!customColors) data = grey(data)
       await log(data)
-      process.exit(0)
+    } else {
+      if (isArray(data) && !isCollection(data) && !program.json) {
+        if (program.format === 'inline') data = data.join(' ')
+        else data = data.join('\n')
+      } else if (isCollection(data) && program.format === 'table') {
+        data = tabularize(data)
+      } else if (program.json || isCollection(data) || isPlainObject(data)) {
+      // indent deep objects
+        data = JSON.stringify(data, null, 2)
+        // Do not copy to clipboard when the output is valid JSON
+        program.clipboard = false
+      }
+      if (data == null || (isArray(data) && data.length === 0)) {
+        console.error('no result found')
+        return process.exit(1)
+      }
+      if (program.clipboard) {
+        copyAndExit(data)
+      } else {
+        await log(data)
+        process.exit(0)
+      }
     }
   }
 }

package/lib/output_templates.js

@@ -1,27 +1,14 @@
-const program = require('./program')
-const dropNonSelectedSubprops = require('./drop_non_selected_subprops')
-const minimizeClaims = require('./minimize_claims')
-const stringifyAsJsFunction = require('./stringify_as_js_function')
-const { pick } = require('lodash')
-const { simplify } = require('./wbk')(program)
-const { createMode = false } = program
-const simplifyOptions = {
-  keepIds: !createMode,
-  keepQualifiers: true,
-  keepReferences: true,
-  keepRichValues: true,
-  keepNonTruthy: true,
-  keepSnaktypes: true,
-  keepRanks: true,
-  keepBadges: true,
-  // No need to keep the hashes as every edited claim (identified with a GUID)
-  // will have it's qualifiers and references fully overriden
-  keepHashes: false
-}
+import { pick } from 'lodash-es'
+import { getStatementsKey } from 'wikibase-edit/lib/parse_instance.js'
+import { simplifyEntity } from 'wikibase-sdk'
+import dropNonSelectedSubprops from './drop_non_selected_subprops.js'
+import { minimizeClaimsOrSnaks } from './minimize_claims.js'
+import program from './program.js'
+import stringifyAsJsFunction from './stringify_as_js_function.js'
 
-module.exports = ({ batchMode, format, propsToPick, requestedPropsAndSubProps, minimize }) => {
+export function outputTemplatesFactory ({ batchMode, format, propsToPick, requestedPropsAndSubProps, minimize }) {
   const formatEntity = FormatEntity(batchMode, propsToPick, requestedPropsAndSubProps, minimize)
-  return async entities => {
+  return async function outputTemplates (entities) {
     entities = entities.map(formatEntity)
     if (format === 'js') {
       const jsFile = await stringifyAsJsFunction(entities[0], program.lang)
@@ -33,16 +20,39 @@ module.exports = ({ batchMode, format, propsToPick, requestedPropsAndSubProps, m
   }
 }
 
-const FormatEntity = (batchMode, propsToPick, requestedPropsAndSubProps, minimize) => entity => {
-  entity = simplify.entity(entity, simplifyOptions)
-  if (createMode) delete entity.id
-  entity = pick(entity, propsToPick)
-  dropNonSelectedSubprops(entity, requestedPropsAndSubProps)
-  if (!batchMode && minimize !== false) {
-    minimizeClaims(entity.claims)
-    minimizeSitelinks(entity.sitelinks)
+function FormatEntity (batchMode, propsToPick, requestedPropsAndSubProps, minimize) {
+  const { createMode = false } = program
+  const simplifyOptions = {
+    keepIds: !createMode,
+    keepQualifiers: true,
+    keepReferences: true,
+    keepRichValues: true,
+    keepNonTruthy: true,
+    keepSnaktypes: true,
+    keepRanks: true,
+    keepBadges: true,
+    // No need to keep the hashes as every edited claim (identified with a GUID)
+    // will have it's qualifiers and references fully overriden
+    keepHashes: false,
+  }
+  const statementsKey = getStatementsKey(program.instance)
+
+  return function formatEntity (entity) {
+    if (statementsKey !== 'claims') {
+      if (propsToPick.includes('claims')) {
+        propsToPick[propsToPick.indexOf('claims')] = statementsKey
+      }
+    }
+    entity = pick(entity, propsToPick)
+    entity = simplifyEntity(entity, simplifyOptions)
+    if (createMode) delete entity.id
+    dropNonSelectedSubprops(entity, requestedPropsAndSubProps)
+    if (!batchMode && minimize !== false) {
+      minimizeClaimsOrSnaks(entity[statementsKey])
+      minimizeSitelinks(entity.sitelinks)
+    }
+    return entity
   }
-  return entity
 }
 
 const minimizeSitelinks = sitelinks => {

package/lib/parse_command_utils.js

@@ -1,16 +1,15 @@
-module.exports = {
-  parseGuid: guid => {
-    return guid
-      // Normalize prefixed statements GUIDs as returned by SPARQL queries:
-      // to the format used by Wikibase API
-      //  - from: wds:Q1827902-6706334E-D27E-4F4B-B6DA-ABE7544DF11C
-      //  - to: Q1827902$6706334E-D27E-4F4B-B6DA-ABE7544DF11C
-      // Also accept Q1827902-6706334E-D27E-4F4B-B6DA-ABE7544DF11C
-      .replace(/^([a-z]+:)?([QPL]\d+)-(.*)/i, '$2$$$3')
-      // Often required when getting guids from the command line, as passing a value with a $
-      // can be challenging, and require different quoting strategies
-      .replace(/("|')/g, '')
-      .replace('\\$', '$')
-      .trim()
-  }
+export const parseGuid = guid => {
+  guid = guid
+  // Normalize prefixed statements GUIDs as returned by SPARQL queries:
+  // to the format used by Wikibase API
+  //  - from: wds:Q1827902-6706334E-D27E-4F4B-B6DA-ABE7544DF11C
+  //  - to: Q1827902$6706334E-D27E-4F4B-B6DA-ABE7544DF11C
+  // Also accept Q1827902-6706334E-D27E-4F4B-B6DA-ABE7544DF11C
+  .replace(/^([a-z]+:)?([QPLM]\d+)-(.*)/i, '$2$$$3')
+  // Often required when getting guids from the command line, as passing a value with a $
+  // can be challenging, and require different quoting strategies
+  .replace(/("|')/g, '')
+  .replace('\\$', '$')
+  .trim()
+  return guid
 }

package/lib/parse_entity_type.js

@@ -3,10 +3,10 @@ const shortTypes = {
   i: 'item',
   p: 'property',
   l: 'lexeme',
-  s: 'sense'
+  s: 'sense',
 }
 
-module.exports = (type = 'item') => {
+export default (type = 'item') => {
   // Fix plural forms
   type = type.replace(/s$/, '')
   return shortTypes[type] || type

package/lib/parse_props.js

@@ -1,13 +1,14 @@
-const { isPropertyId, isSitelinkKey } = require('wikibase-sdk')
+import { isPropertyId, isSitelinkKey } from 'wikibase-sdk'
+
 const langPattern = /^\w{2,3}(-\w{2,4})?$/
 const termSections = [
   'labels',
   'descriptions',
   'aliases',
-  'lemmas'
+  'lemmas',
 ]
 
-module.exports = propsStr => {
+export default propsStr => {
   if (!propsStr) return {}
 
   // The Wikibase API doesn't accept lemmas, forms, senses props
@@ -27,13 +28,15 @@ const getPropsAndSubKeys = propStr => {
   if (isPropertyId(prop)) return lazyProps.claims(prop)
   else if (prop.match(langPattern)) return lazyProps.terms(prop)
   else if (isSitelinkKey(prop)) return lazyProps.sitelinks(prop)
+  // Handle Wikimedia Commons weirdness: it uses entity.statements but wbgetentities expects a "claims" prop
+  else if (prop === 'statements') return [ { prop: 'claims', subkey } ]
   else return [ { prop, subkey } ]
 }
 
 const lazyProps = {
   claims: propertyId => [ { prop: 'claims', subkey: propertyId } ],
   terms: lang => termSections.map(section => ({ prop: section, subkey: lang })),
-  sitelinks: site => [ { prop: 'sitelinks', subkey: site } ]
+  sitelinks: site => [ { prop: 'sitelinks', subkey: site } ],
 }
 
 const aggregate = (index, propsData) => {

package/lib/parse_simplify_options.js

@@ -13,7 +13,7 @@ const propsMap = {
   badges: 'keepBadges',
 }
 
-module.exports = ({ simplify: simplifyOption, keep: props, timeConverter }) => {
+export default ({ simplify: simplifyOption, keep: props, timeConverter }) => {
   const options = {}
 
   if (props != null) {

package/lib/path.js

@@ -1,2 +1,3 @@
-const path = require('path')
-module.exports = process.platform === 'win32' ? path.win32 : path
+import path from 'node:path'
+
+export default process.platform === 'win32' ? path.win32 : path

package/lib/pluralize.js

@@ -1,7 +1,7 @@
 // Attributes that can't be pluralized with `${attribute}s`
 // or are already pluralized
 const plurals = {
-  aliases: 'aliases'
+  aliases: 'aliases',
 }
 
-module.exports = attribute => plurals[attribute] || `${attribute}s`
+export default attribute => plurals[attribute] || `${attribute}s`

package/lib/polymorphic_command_args_parser.js

@@ -1,17 +1,19 @@
-const objectArgParser = require('./object_arg_parser')
-const program = require('commander')
-const { isFilePathSync, isJsonString } = require('../lib/utils')
+import program from 'commander'
+import { objectArgParser } from '#lib/object_arg_parser'
+import { isFilePathSync, isJsonString } from '#lib/utils'
 
 const inlineOptions = [
-  'rank'
+  'rank',
 ]
 
 const noInlineOptions = () => inlineOptions.filter(option => program[option] != null).length === 0
 
-module.exports = ({ inlineArgsParser }) => args => {
-  if ((args.length === 1 && isJsonString(args[0]) && noInlineOptions()) || isFilePathSync(args[0])) {
-    return objectArgParser(args)
-  } else {
-    return inlineArgsParser(args)
+export function polymorphicCommandArgsParser ({ inlineArgsParser }) {
+  return async function (args) {
+    if ((args.length === 1 && isJsonString(args[0]) && noInlineOptions()) || isFilePathSync(args[0])) {
+      return objectArgParser(args)
+    } else {
+      return inlineArgsParser(args)
+    }
   }
 }

package/lib/program.js

@@ -1,13 +1,13 @@
 // Extends commander with options and functions used by all subcommands.
 
-const program = require('commander')
-const applyEnvAndConfigDefault = require('./apply_env_and_config_default')
-const logCommandExamples = require('./log_command_examples')
-const globalOptionsHelp = require('./global_options_help')
+import program from 'commander'
+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 = command => {
+program.process = async command => {
   if (command) {
-    const metadata = require(`../metadata/${command}`)
+    const { default: metadata } = await import(`../metadata/${command}.js`)
     const { args, description, options, examples, doc } = metadata
     program.arguments(args)
     program.description(description)
@@ -42,12 +42,12 @@ const commandsAcceptingZeroArguments = [
   'query',
   'convert',
   // Needs to also log the current config
-  'config'
+  'config',
 ]
 
 const commandsTakingArgsOnStdin = [
   'data',
-  'generate-template'
+  'generate-template',
 ]
 
 const parseArgv = (argv, isCommandsWithCustomHelpMenu) => {
@@ -80,4 +80,4 @@ process.stdout.on('error', err => {
   else throw err
 })
 
-module.exports = program
+export default program

package/lib/properties.js

@@ -1,24 +1,23 @@
-module.exports = {
-  mainProps: {
-    'https://www.wikidata.org': [ 'P31', 'P279' ]
-  },
-  propTypes: {
-    'external-id': { factor: 0.1, color: 'grey' },
-    string: { factor: 1 },
-    'wikibase-item': { factor: 1 },
-    time: { factor: 1 },
-    monolingualtext: { factor: 2 },
-    quantity: { factor: 1 },
-    'wikibase-property': { factor: 1 },
-    url: { factor: 0.5 },
-    commonsMedia: { factor: 0.5 },
-    'globe-coordinate': { factor: 0.5 },
-    math: { factor: 0.5 },
-    'geo-shape': { factor: 0.5 },
-    'tabular-data': { factor: 0.5 },
-    'wikibase-lexeme': { factor: 0.5 },
-    'wikibase-form': { factor: 0.5 },
-    'wikibase-sense': { factor: 0.5 },
-    'musical-notation': { factor: 0.5 }
-  }
+export const mainProps = {
+  'https://www.wikidata.org': [ 'P31', 'P279' ],
+}
+
+export const propTypes = {
+  'external-id': { factor: 0.1, color: 'grey' },
+  string: { factor: 1 },
+  'wikibase-item': { factor: 1 },
+  time: { factor: 1 },
+  monolingualtext: { factor: 2 },
+  quantity: { factor: 1 },
+  'wikibase-property': { factor: 1 },
+  url: { factor: 0.5 },
+  commonsMedia: { factor: 0.5 },
+  'globe-coordinate': { factor: 0.5 },
+  math: { factor: 0.5 },
+  'geo-shape': { factor: 0.5 },
+  'tabular-data': { factor: 0.5 },
+  'wikibase-lexeme': { factor: 0.5 },
+  'wikibase-form': { factor: 0.5 },
+  'wikibase-sense': { factor: 0.5 },
+  'musical-notation': { factor: 0.5 },
 }

package/lib/queries/all_instances.js

@@ -1,6 +1,6 @@
-const { isItemId } = require('wikibase-sdk')
+import { isItemId } from 'wikibase-sdk'
 
-module.exports = id => {
+export default id => {
   if (!isItemId(id)) throw new Error(`invalid id: ${id}`)
 
   return `SELECT ?item WHERE {

package/lib/queries/all_properties.js

@@ -1,4 +1,4 @@
-module.exports = lang => {
+export default lang => {
   return `SELECT ?property ?propertyLabel ?propertyType ?propertyDescription ?propertyAltLabel WHERE {
     ?property wikibase:propertyType ?propertyType .
     SERVICE wikibase:label { bd:serviceParam wikibase:language "${lang},en". }

package/lib/read_ids_from_stdin.js

@@ -1,9 +1,9 @@
-const split = require('split')
-const through = require('through')
+import split from 'split'
+import through from 'through'
 
 let ids = []
 
-module.exports = handleIdsBatch => {
+export function readIdsFromStdin (handleIdsBatch) {
   const write = function (id) {
     id = id.trim()
     if (id === '') return

package/lib/request.js

@@ -1,10 +1,13 @@
-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
-const http = require('http')
-const https = require('https')
+import http from 'node:http'
+import https from 'node:https'
+import { pick } from 'lodash-es'
+import fetch from 'node-fetch'
+import program from './program.js'
+import globalHeaders from './request_headers.js'
+
 const httpAgent = new http.Agent({ keepAlive: true })
 const httpsAgent = new https.Agent({ keepAlive: true })
 // Useful to:
@@ -12,39 +15,35 @@ 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
   else return protocol === 'http:' ? httpAgent : httpsAgent
 }
-
-const globalHeaders = require('./request_headers')
 const buildHeaders = customHeaders => {
   if (customHeaders) return Object.assign({}, globalHeaders, customHeaders)
   else return globalHeaders
 }
 
-module.exports = {
-  get: async url => {
-    const res = await fetch(url, { headers: globalHeaders, agent })
-    return handleResponse({ res, url })
-  },
+export const get = async url => {
+  const res = await fetch(url, { headers: globalHeaders, agent })
+  return handleResponse({ res, url })
+}
 
-  customGet: async ({ url, headers }) => {
-    const res = await fetch(url, { headers: buildHeaders(headers), agent })
-    return handleResponse({ res, url })
-  },
+export const customGet = async ({ url, headers }) => {
+  const res = await fetch(url, { headers: buildHeaders(headers), agent })
+  return handleResponse({ res, url })
+}
 
-  post: async ({ url, body, headers }) => {
-    const method = 'post'
-    const res = await fetch(url, { method, body, headers: buildHeaders(headers), agent })
-    return handleResponse({ res, url, method })
-  }
+export const 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 handleResponse = async ({ res, url, method }) => {
+async function handleResponse ({ res, url, method }) {
   let body = await res.text()
+  const { logResponseHeaders } = program
   if (logResponseHeaders) {
     let headers = res.headers.raw()
     if (typeof logResponseHeaders === 'string') {
@@ -81,5 +80,5 @@ const newError = (statusCode, body, statusMessage) => {
 }
 
 const statusCodeByErrorCode = {
-  'no-such-entity': 404
+  'no-such-entity': 404,
 }

package/lib/request_headers.js

@@ -1,2 +1,8 @@
-const { name, version } = require('../package.json')
-module.exports = { 'User-Agent': `${name}/v${version}` }
+import { resolve } from 'node:path'
+import { getDirname } from '#lib/fs'
+import { readJsonFile } from '#lib/json'
+
+const dirname = getDirname(import.meta.url)
+const { name, version } = readJsonFile(resolve(dirname, '../package.json'))
+
+export default { 'User-Agent': `${name}/v${version}` }

package/lib/reset_properties.js

@@ -1,8 +1,8 @@
-const { exec } = require('child_process')
-const { green } = require('chalk')
-const getCacheFolderPath = require('../lib/get_cache_folder_path')
+import { exec } from 'node:child_process'
+import { green } from '#lib/chalk'
+import getCacheFolderPath from '#lib/get_cache_folder_path'
 
-module.exports = () => {
+export default () => {
   return getCacheFolderPath('props')
   .then(propsDir => {
     // --force: ignore if there are no more files to delete

package/lib/sparql_query_command.js

@@ -1,10 +1,11 @@
-const makeSparqlQuery = require('./make_sparql_query')
-const program = require('./program')
-const { sparqlQuery } = require('../lib/wbk')(program)
-const output = require('./output')(program)
-const open = require('../lib/open')
+import { openUrl } from '#lib/open'
+import wbk from '#lib/wbk'
+import makeSparqlQuery from './make_sparql_query.js'
+import { outputFactory } from './output.js'
+import program from './program.js'
 
-module.exports = (sparql, format) => {
+export function sparqlQueryCommand (sparql, format) {
+  const output = outputFactory(program)
   if (program.open) {
     openQueryServiceGUI(sparql)
   } else if (program.dry) {
@@ -16,7 +17,8 @@ module.exports = (sparql, format) => {
   }
 }
 
-const openQueryServiceGUI = sparql => {
+function openQueryServiceGUI (sparql) {
+  const { sparqlQuery } = wbk(program)
   const queryServiceGUI = sparqlQuery(sparql).replace('sparql?format=json&query=', '#')
-  open(queryServiceGUI)
+  openUrl(queryServiceGUI)
 }

package/lib/stringify_as_js_function.js

@@ -1,5 +1,5 @@
-const { uniq } = require('lodash')
-const { getEntitiesLabels } = require('./get_entities_labels')
+import { uniq } from 'lodash-es'
+import { getEntitiesLabels } from './get_entities_labels.js'
 
 const formatJsObj = text => {
   return text
@@ -70,7 +70,7 @@ const getPatternComment = (line, pattern, entitiesLabels) => {
   }
 }
 
-module.exports = async (entity, lang) => {
+export default async (entity, lang) => {
   const json = JSON.stringify(entity, null, 2)
   // Use the classic syntax function to avoid the implicit return syntax
   // which might be confusion to users unfamiliar with JS