wikibase-cli 16.3.2 → 17.0.0

package/lib/get_entities_by_batches.js

@@ -1,12 +1,17 @@
-const program = require('./program')
-require('./exit_on_missing').instance(program.instance)
-const { isEntityId, getManyEntities } = require('./wbk')(program)
-const errors_ = require('./errors')
-const { get } = require('./request')
-const { wait } = require('./utils')
+import { isEntityId } from 'wikibase-sdk'
+import { exitOnMissingInstance } from '#lib/exit_on_missing'
+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'
+
 const noop = () => {}
 
-module.exports = ({ ids, props, languages, urls, onResponse, onDone = noop }) => {
+export async function getEntitiesByBatches ({ ids, props, languages, urls, onResponse, onDone = noop }) {
+  exitOnMissingInstance(program.instance)
+  const { getManyEntities } = wbk(program)
+
   if (ids != null) {
     ids.forEach(id => {
       if (!isEntityId(id)) throw new Error(`invalid entity id: ${id}`)

package/lib/get_entities_labels.js

@@ -1,6 +1,6 @@
-const getEntities = require('./get_entities')
+import getEntities from './get_entities.js'
 
-const getEntitiesLabels = async (ids, lang = 'en') => {
+export async function getEntitiesLabels (ids, lang = 'en') {
   const entities = await getEntities({ ids, languages: lang, props: 'labels' })
   return parseEntitiesLabels(entities, lang)
 }
@@ -17,11 +17,9 @@ const parseEntitiesLabels = (entities, lang) => {
 
 const parseLangLabel = (labels, lang) => labels && labels[lang] && labels[lang].value
 
-const getEntityLabel = async (id, lang) => {
+export async function getEntityLabel (id, lang) {
   const labels = await getEntitiesLabels([ id ], lang)
   const label = labels[id]
   if (!label) throw new Error(`label not found: ${id}`)
   return label
 }
-
-module.exports = { getEntitiesLabels, getEntityLabel }

package/lib/get_entities_schemas.js

@@ -1,12 +1,12 @@
-const fetch = require('node-fetch')
-const program = require('./program')
-const { isEntitySchemaId } = require('wikibase-sdk')
+import fetch from 'node-fetch'
+import { isEntitySchemaId } from 'wikibase-sdk'
+import { exitOnMissingInstance } from '#lib/exit_on_missing'
+import program from './program.js'
 
-const { instance } = program
-if (!instance) throw new Error('no instance set')
-const instanceDomain = instance.replace('/w/api.php', '')
+export function getEntitiesSchemas (ids) {
+  exitOnMissingInstance(program.instance)
+  const instanceDomain = program.instance.replace('/w/api.php', '')
 
-module.exports = ids => {
   ids.forEach(id => {
     if (!isEntitySchemaId(id)) throw new Error(`invalid entity schema id: ${id}`)
   })

package/lib/get_folder_path.js

@@ -1,9 +1,11 @@
-const path = require('path')
-const fs = require('./fs')
-const mkdirp = require('mkdirp')
-const homePath = require('os').homedir()
+import os from 'node:os'
+import path from 'node:path'
+import mkdirp from 'mkdirp'
+import { writeAccessSync } from './fs.js'
 
-module.exports = (category, subfolderName) => {
+const homePath = os.homedir()
+
+export default (category, subfolderName) => {
   let folderPath
   if (process.platform === 'win32') {
     folderPath = path.win32.join(homePath, 'wikibase-cli', category || subfolderName)
@@ -15,7 +17,7 @@ module.exports = (category, subfolderName) => {
   }
   mkdirp.sync(folderPath)
   // Make sure we have write access right in case the folder already existed
-  fs.writeAccessSync(folderPath)
+  writeAccessSync(folderPath)
 
   return folderPath
 }

package/lib/get_lang_props.js

@@ -1,38 +1,39 @@
-const fs = require('./fs')
-const { URL } = require('url')
-const getCacheFolderPath = require('../lib/get_cache_folder_path')
-const fetchLangProps = require('./fetch_lang_props')
+import { URL } from 'node:url'
+import getCacheFolderPath from '#lib/get_cache_folder_path'
+import { hashString } from '#lib/hash_string'
+import { readJsonFile } from '#lib/json'
+import fetchLangProps from './fetch_lang_props.js'
+import { writeFile } from './fs.js'
 
-module.exports = async program => {
+export default async program => {
   const { lang, sparqlEndpoint, noCache } = program
   const sparqlEndpointName = getSparqlEndpointPart(sparqlEndpoint)
 
   const propsDir = await getCacheFolderPath('props')
-  const file = `${propsDir}/${lang}${sparqlEndpointName}.v2.json`
+  const langJsonFilePath = `${propsDir}/${lang}${sparqlEndpointName}.v2.json`
 
-  if (noCache) return refreshProps(program, file)
+  if (noCache) return refreshProps(program, langJsonFilePath)
 
   try {
-    const propsSync = require(file)
-    return propsSync
+    return readJsonFile(langJsonFilePath)
   } catch (err) {
-    return refreshProps(program, file)
+    return refreshProps(program, langJsonFilePath)
   }
 }
 
-const refreshProps = async (program, file) => {
-  await fetchAndSaveProps(program, file)
-  return require(file)
+const refreshProps = async (program, langJsonFilePath) => {
+  await fetchAndSaveProps(program, langJsonFilePath)
+  return readJsonFile(langJsonFilePath)
 }
 
-const fetchAndSaveProps = async (program, filepath) => {
+const fetchAndSaveProps = async (program, langJsonFilePath) => {
   const props = await fetchLangProps(program)
-  return fs.writeFile(filepath, JSON.stringify(props))
+  return writeFile(langJsonFilePath, JSON.stringify(props))
 }
 
 const getSparqlEndpointPart = sparqlEndpoint => {
   if (!sparqlEndpoint) return ''
   const { host } = new URL(sparqlEndpoint)
-  const hash = require('./hash_string')(sparqlEndpoint)
+  const hash = hashString(sparqlEndpoint)
   return `-${host}-${hash}`
 }

package/lib/get_pattern_filter.js

@@ -1,19 +1,28 @@
-const program = require('./program')
-const { propTypes } = require('./properties')
+import program from './program.js'
+import { propTypes } from './properties.js'
 
-module.exports = (pattern, includeTypes) => {
+const normalizeTypeName = name => name.replace(/-/g, '').toLowerCase()
+const normalizedTypesNames = Object.keys(propTypes).map(normalizeTypeName)
+
+export default (pattern, includeTypes) => {
   const { type } = program
+  let normalizedType, isKnownType
+  // If --type is called without argument, `type` will be a boolean
+  if (typeof type === 'string') {
+    normalizedType = normalizeTypeName(type)
+    isKnownType = normalizedTypesNames.includes(normalizedType)
+  }
   if (!(pattern && pattern.length > 0)) {
-    if (typeof type === 'string') {
+    if (normalizedType) {
       // Consider that what was passed as a type argument was actually a pattern
-      if (!(type.toLowerCase() in propTypes)) pattern = type
+      if (!isKnownType) pattern = type
     } else {
       return
     }
   }
 
-  if (includeTypes && pattern.toLowerCase() in propTypes) {
-    return propData => propData.type === pattern
+  if (includeTypes && isKnownType) {
+    return propData => normalizeTypeName(propData.type) === normalizedType
   }
 
   // Set the insensitive case flag only if only lowercased was used
@@ -23,8 +32,8 @@ module.exports = (pattern, includeTypes) => {
   const filterRegex = new RegExp(pattern, flag)
 
   let typeFilter
-  if (typeof type === 'string' && type.toLowerCase() in propTypes) {
-    typeFilter = propData => propData.type === type
+  if (normalizedType && isKnownType) {
+    typeFilter = propData => normalizeTypeName(propData.type) === normalizedType
   } else {
     typeFilter = () => true
   }

package/lib/get_properties_data.js

@@ -1,11 +1,11 @@
-const getEntities = require('./get_entities')
-const { simplify } = require('wikibase-sdk')
+import { simplify } from 'wikibase-sdk'
+import getEntities from './get_entities.js'
 
-module.exports = async (ids, lang = 'en') => {
+export default async (ids, lang = 'en') => {
   const properties = await getEntities({
     ids,
     languages: [ lang, 'en' ],
-    props: [ 'info', 'labels' ]
+    props: [ 'info', 'labels' ],
   })
   const propertiesData = {}
   Object.keys(properties).forEach(id => {
@@ -13,7 +13,7 @@ module.exports = async (ids, lang = 'en') => {
     const labels = simplify.labels(property.labels)
     propertiesData[id] = {
       type: property.datatype,
-      label: labels[lang] || labels.en
+      label: labels[lang] || labels.en,
     }
   })
   return propertiesData

package/lib/get_redirected_sitelink_title.js

@@ -1,9 +1,9 @@
-const { get } = require('../lib/request')
-const _ = require('lodash')
+import { values } from 'lodash-es'
+import { get } from '#lib/request'
 
-module.exports = (lang, site, title) => {
+export default (lang, site, title) => {
   title = encodeURIComponent(title)
   const url = `https://${lang}.${site}.org/w/api.php?format=json&action=query&redirects&titles=${title}`
   return get(url)
-  .then(body => _.values(body.query.pages)[0].title)
+  .then(body => values(body.query.pages)[0].title)
 }

package/lib/get_sitelink_url.js

@@ -1,11 +1,12 @@
-const { get } = require('../lib/request')
-const exitOnMissing = require('../lib/exit_on_missing')
-const errors_ = require('../lib/errors')
+import errors_ from '#lib/errors'
+import { exitOnMissingInstance } from '#lib/exit_on_missing'
+import { get } from '#lib/request'
+import wbk from '#lib/wbk'
 
-module.exports = program => {
-  exitOnMissing.instance(program.instance)
-  const { getEntities } = require('../lib/wbk')(program)
-  return async (id, lang, sitelinkSuffix) => {
+export function getSitelinkUrlFactory (program) {
+  exitOnMissingInstance(program.instance)
+  const { getEntities } = wbk(program)
+  return async function (id, lang, sitelinkSuffix) {
     if (id[0] === 'P') {
       console.error("Wikibase properties don't have sitelinks")
       process.exit(1)
@@ -25,7 +26,7 @@ module.exports = program => {
 }
 
 const sitelinkDomain = {
-  wiki: 'wikipedia.org'
+  wiki: 'wikipedia.org',
 }
 
 const formatTitle = title => {

package/lib/get_stdin_input.js

@@ -1,4 +1,4 @@
-module.exports = () => {
+export function getStdinInput () {
   let input = ''
   return new Promise((resolve, reject) => {
     process.stdin

package/lib/get_ttl_entities.js

@@ -1,13 +1,13 @@
-const fetch = require('node-fetch')
-const program = require('../lib/program')
-const crypto = require('crypto')
-const { isEntityId } = require('wikibase-sdk')
+import crypto from 'node:crypto'
+import fetch from 'node-fetch'
+import { isEntityId } from 'wikibase-sdk'
+import { exitOnMissingInstance } from '#lib/exit_on_missing'
+import program from '#lib/program'
 
-const { instance } = program
-if (!instance) throw new Error('no instance set')
-const instanceDomain = instance.replace('/w/api.php', '')
+export default ids => {
+  exitOnMissingInstance(program.instance)
+  const instanceDomain = program.instance.replace('/w/api.php', '')
 
-module.exports = ids => {
   ids.forEach(id => {
     if (!isEntityId(id)) throw new Error(`invalid entity id: ${id}`)
   })

package/lib/global_options_help.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   lang: [ '-l, --lang <lang>', 'specify the language to use' ],
   verbose: [ '-v, --verbose', 'make the output more verbose' ],
   dry: [ '-d, --dry', 'output the generated data, do not run the query' ],

package/lib/hash_string.js

@@ -1,3 +1,5 @@
-const crypto = require('crypto')
+import { createHash } from 'node:crypto'
 
-module.exports = str => crypto.createHash('md5').update(str).digest('hex')
+export function hashString (str) {
+  return createHash('md5').update(str).digest('hex')
+}

package/lib/json.js

@@ -0,0 +1,5 @@
+import { readFileSync } from 'node:fs'
+
+export function readJsonFile (jsonFilePath) {
+  return JSON.parse(readFileSync(jsonFilePath, 'utf-8'))
+}

package/lib/local_lang.js

@@ -1,3 +1,4 @@
 const { LANG } = process.env
+
 // process.env.LANG is apparently not defined on Windows
-module.exports = (LANG && LANG.split(/[\W_-]/)[0]) || 'en'
+export const localLang = (LANG && LANG.split(/[\W_-]/)[0]) || 'en'

package/lib/log_claims.js

@@ -1,12 +1,12 @@
-const _ = require('lodash')
-const { isEntityId } = require('wikibase-sdk')
-const filterClaimsProperties = require('../lib/filter_claims_properties')
-const getClaimsTexts = require('../lib/get_claims_texts')
-const { getEntitiesLabels } = require('./get_entities_labels')
-const getPropertiesData = require('./get_properties_data')
-const { bgMagenta, grey } = require('chalk')
+import { chain, max, padEnd } from 'lodash-es'
+import { isEntityId } from 'wikibase-sdk'
+import { bgMagenta, grey } from '#lib/chalk'
+import filterClaimsProperties from '#lib/filter_claims_properties'
+import getClaimsTexts from '#lib/get_claims_texts'
+import { getEntitiesLabels } from './get_entities_labels.js'
+import getPropertiesData from './get_properties_data.js'
 
-module.exports = async ({ program, simplifiedClaims, extraData = {}, pattern, resort }) => {
+export default async ({ program, simplifiedClaims, extraData = {}, pattern, resort }) => {
   const { lang } = program
   const ids = collectEntityIds(simplifiedClaims, extraData)
   const labels = await getEntitiesLabels(ids, lang)
@@ -24,11 +24,11 @@ module.exports = async ({ program, simplifiedClaims, extraData = {}, pattern, re
     labels,
     simplifiedClaims,
     resort,
-    lang
+    lang,
   })
 
   const propTextLength = claimsTexts.map(data => data.propText.length)
-  const longestPropText = _.max(propTextLength) || 0
+  const longestPropText = max(propTextLength) || 0
 
   const claimsText = claimsTexts.map(propClaimsText(longestPropText))
   const lineBreaks = claimsTexts.length > 3 ? '\n\n' : '\n'
@@ -36,7 +36,7 @@ module.exports = async ({ program, simplifiedClaims, extraData = {}, pattern, re
 }
 
 const collectEntityIds = (claims, extraData) => {
-  const claimIds = _(claims)
+  const claimIds = chain(claims)
     .values()
     .flatten()
     .filter(isEntityId)
@@ -53,7 +53,7 @@ const propClaimsText = targetLength => claimsTextData => {
 }
 
 const harmonizedLength = (str, minLength) => {
-  if (minLength && str.length < minLength) str = _.padEnd(str, minLength)
+  if (minLength && str.length < minLength) str = padEnd(str, minLength)
   return str
 }
 

package/lib/log_command_examples.js

@@ -1,7 +1,7 @@
-const { grey } = require('chalk')
-const { execSync } = require('child_process')
+import { execSync } from 'node:child_process'
+import { grey } from '#lib/chalk'
 
-module.exports = (command, examples, doc, dryRun = false) => {
+export default (command, examples, doc, dryRun = false) => {
   if (examples && examples.length > 0) {
     console.log('\nExamples:')
     for (const example of examples) {

package/lib/log_ndjson.js

@@ -1,6 +1,6 @@
 // Log as newline-delimited JSON: one obj JSON per line. No comma.
 
-module.exports = array => {
+export default array => {
   for (const obj of array) {
     process.stdout.write(JSON.stringify(obj))
     process.stdout.write('\n')

package/lib/make_sparql_query.js

@@ -1,18 +1,17 @@
-const { customGet, post } = require('../lib/request')
-const errors_ = require('../lib/errors')
-const { grey } = require('chalk')
-const program = require('../lib/program')
-const output = require('../lib/output')(program)
-const { simplify } = require('wikibase-sdk')
+import { simplify } from 'wikibase-sdk'
+import { grey } from '#lib/chalk'
+import errors_ from '#lib/errors'
+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'
 
-const simplifyOption = !program.raw
-const { index: indexAttribute } = program
-
-module.exports = (sparql, format = 'json') => {
+export default (sparql, format = 'json') => {
   // JIT require to be sure program.process was already called
   // and program.sparqlEndpoint is set
-  require('../lib/exit_on_missing').sparqlEndpoint(program.sparqlEndpoint)
-  const { sparqlQuery } = require('../lib/wbk')(program)
+  exitOnMissingSparqlEndpoint(program.sparqlEndpoint)
+  const { sparqlQuery } = wbk(program)
 
   if (localFormatsDerivedFromJSON.includes(format)) format = 'json'
 
@@ -22,7 +21,8 @@ module.exports = (sparql, format = 'json') => {
   .catch(errors_.exit)
 }
 
-const makeRequest = (url, format) => {
+function makeRequest (url, format) {
+  const output = outputFactory(program)
   const acceptHeader = formatAcceptHeader[format]
   if (!acceptHeader) throw new Error(`unknown format: ${format}`)
   // Avoid making a POST request when not necessary as those aren't cached
@@ -32,8 +32,8 @@ const makeRequest = (url, format) => {
     return customGet({
       url,
       headers: {
-        Accept: formatAcceptHeader[format]
-      }
+        Accept: formatAcceptHeader[format],
+      },
     })
   } else {
     const [ postUrl, urlencodedSparql ] = url.split('?')
@@ -44,7 +44,7 @@ const makeRequest = (url, format) => {
       headers: {
         'Content-type': 'application/sparql-query',
         Accept: formatAcceptHeader[format],
-      }
+      },
     })
   }
 }
@@ -63,16 +63,20 @@ const formatAcceptHeader = {
   binrdf: 'application/x-binary-rdf-results-table',
 }
 
-const parseResult = format => results => {
-  try {
-    if (format === 'json' && simplifyOption) {
-      results = simplify.sparqlResults(results, { minimize: true })
-      if (indexAttribute) results = indexBy(results, indexAttribute)
+function parseResult (format) {
+  const simplifyOption = !program.raw
+  const { index: indexAttribute } = program
+  return results => {
+    try {
+      if (format === 'json' && simplifyOption) {
+        results = simplify.sparqlResults(results, { minimize: true })
+        if (indexAttribute) results = indexBy(results, indexAttribute)
+      }
+      return results
+    } catch (err) {
+      err.context = { results }
+      throw err
     }
-    return results
-  } catch (err) {
-    err.context = { results }
-    throw err
   }
 }
 

package/lib/matching_langs.js

@@ -1,7 +1,7 @@
-const wdLang = require('wikidata-lang')
-const { values, padEnd } = require('lodash')
+import { values, padEnd } from 'lodash-es'
+import wdLang from 'wikidata-lang'
 
-const find = input => {
+export const findMatchingLang = input => {
   const regex = new RegExp(input, 'i')
   return values(wdLang.byCode)
   .filter(matches(regex))
@@ -12,11 +12,9 @@ const matches = regex => langData => {
   return label.match(regex) || native.match(regex)
 }
 
-const format = langsData => langsData.map(formatLangData).join('\n')
+export const formatLangs = langsData => langsData.map(formatLangData).join('\n')
 
 const formatLangData = langData => {
   const { code, label, native, wd } = langData
   return `${padEnd(code, 5)} ${padEnd(wd, 10)} ${padEnd(label, 10)} ${padEnd(native, 10)} `
 }
-
-module.exports = { find, format }

package/lib/minimize_claims.js

@@ -1,4 +1,4 @@
-const minimizeSnaks = snaks => {
+export function minimizeClaimsOrSnaks (snaks) {
   if (!snaks) return
   // Support references nested snaks
   if (snaks.snaks) snaks = snaks.snaks
@@ -11,11 +11,11 @@ const minimizeSnaks = snaks => {
       if (snak.snaktype === 'value') delete snak.snaktype
       if (snak.rank === 'normal') delete snak.rank
       if (snak.qualifiers) {
-        minimizeSnaks(snak.qualifiers)
+        minimizeClaimsOrSnaks(snak.qualifiers)
         if (Object.keys(snak.qualifiers).length === 0) delete snak.qualifiers
       }
       if (snak.references) {
-        snak.references.forEach(minimizeSnaks)
+        snak.references.forEach(minimizeClaimsOrSnaks)
         if (snak.references.length === 0) delete snak.references
       }
       const keys = Object.keys(snak)
@@ -25,5 +25,3 @@ const minimizeSnaks = snaks => {
     if (snaks[property].length === 1) snaks[property] = snaks[property][0]
   })
 }
-
-module.exports = minimizeSnaks

package/lib/object_arg_parser.js

@@ -1,12 +1,12 @@
-const fs = require('fs')
-const { red } = require('chalk')
-const program = require('./program')
-const validateFunctionArgs = require('./validate_function_args')
-const { parseGuid } = require('./parse_command_utils')
-const { isFilePathSync, isJsonString, getAbsoluteFilePath, validateTemplateCommand } = require('../lib/utils')
+import { red } from '#lib/chalk'
+import { readJsonFile } from '#lib/json'
+import { isFilePathSync, isJsonString, getAbsoluteFilePath, validateTemplateCommand } from '#lib/utils'
+import { parseGuid } from './parse_command_utils.js'
+import program from './program.js'
+import validateFunctionArgs from './validate_function_args.js'
 
-module.exports = args => {
-  const data = getData(args)
+export async function objectArgParser (args) {
+  const data = await getData(args)
   if (data == null) return []
   if (data.guid != null) data.guid = parseGuid(data.guid)
   return [ data ]
@@ -31,7 +31,7 @@ const getData = args => {
 
   try {
     // Try to parse it as a JSON file
-    return getJsonFile(filepath)
+    return readJsonFile(filepath)
   } catch (err1) {
     // Try to parse it as a JS module
     try {
@@ -50,13 +50,8 @@ const getData = args => {
   }
 }
 
-const getJsonFile = filepath => {
-  const file = fs.readFileSync(filepath).toString()
-  return JSON.parse(file)
-}
-
-const getDataFromJsModule = (filepath, args) => {
-  const jsModule = require(filepath)
+async function getDataFromJsModule (filepath, args) {
+  const { default: jsModule } = await import(filepath)
   if (typeof jsModule === 'function') {
     const inputArgs = args.slice(1)
     validateFunctionArgs(jsModule, inputArgs, jsModule)
@@ -64,7 +59,7 @@ const getDataFromJsModule = (filepath, args) => {
   } else if (jsModule && typeof jsModule.template === 'function') {
     validateTemplateCommand({
       commandName: program._name.replace('wb-', ''),
-      validCommands: jsModule.commands
+      validCommands: jsModule.commands,
     })
     const inputArgs = args.slice(1)
     validateFunctionArgs(jsModule.template, inputArgs, jsModule)

package/lib/open.js

@@ -1,13 +1,13 @@
-const copy = require('./copy')
-const open = require('open')
-const program = require('./program')
-const { url: urlOnly, clipboard } = program
+import open from 'open'
+import { copyAndExit } from './copy.js'
+import program from './program.js'
 
-module.exports = url => {
+export function openUrl (url) {
+  const { url: urlOnly, clipboard } = program
   if (urlOnly) {
-    clipboard ? copy(url) : console.log(url)
+    clipboard ? copyAndExit(url) : console.log(url)
   } else {
-    if (clipboard) copy(url)
+    if (clipboard) copyAndExit(url)
     open(url, { url: true })
   }
 }