wikibase-cli 17.0.6 → 17.0.8

package/bin/wb.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import fs from 'node:fs'
-import path, { resolve } from 'node:path'
+import { readdirSync } from 'node:fs'
+import { resolve } from 'node:path'
 import program from 'commander'
 import { debug } from '#lib/debug'
 import { getDirname } from '#lib/fs'
@@ -17,7 +17,7 @@ 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}
 
-const commandsNames = fs.readdirSync(path.resolve(dirname, '../metadata'))
+const commandsNames = readdirSync(resolve(dirname, '../metadata'))
   .map(filename => filename.replace('.js', ''))
 
 await Promise.all(commandsNames.map(async commandName => {

package/lib/fetch_and_log_entity_revision.js

@@ -1,7 +1,9 @@
 import { values } from 'lodash-es'
 import { simplifyEntity } from 'wikibase-sdk'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
+import parseProps from '#lib/parse_props'
 import optionsFactory from '#lib/parse_simplify_options'
+import pickSelectedSubprops from '#lib/pick_selected_subprops'
 import { get } from '#lib/request'
 import { getWbk } from '#lib/wbk'
 import program from './program.js'
@@ -15,6 +17,8 @@ export async function fetchAndLogEntityRevision (id, revision) {
   const url = getEntityRevision({ id, revision })
   const body = await get(url)
   let entity = values(body.entities)[0]
+  const requestedPropsAndSubProps = parseProps(program.props)
+  entity = pickSelectedSubprops(entity, requestedPropsAndSubProps)
   if (simplifyOption) entity = simplifyEntity(entity, options)
   console.log(JSON.stringify(entity))
 }

package/lib/fetch_and_log_ids_data.js

@@ -1,12 +1,12 @@
 import { isEntitySchemaId, simplifyEntity } from 'wikibase-sdk'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import optionsFactory from '#lib/parse_simplify_options'
-import dropNonSelectedSubprops from './drop_non_selected_subprops.js'
 import { getEntitiesByBatches } from './get_entities_by_batches.js'
 import { getEntitiesSchemas } from './get_entities_schemas.js'
 import getTtlEntities from './get_ttl_entities.js'
 import logNdjson from './log_ndjson.js'
 import parseProps from './parse_props.js'
+import pickSelectedSubprops from './pick_selected_subprops.js'
 import program from './program.js'
 
 export function fetchAndLogIdsData (ids) {
@@ -23,7 +23,7 @@ export function fetchAndLogIdsData (ids) {
   if (entitiesSchemasIds.length > 0) return getEntitiesSchemas(entitiesSchemasIds)
 
   const onResponse = entities => {
-    entities.forEach(entity => dropNonSelectedSubprops(entity, requestedPropsAndSubProps))
+    entities = entities.map(entity => pickSelectedSubprops(entity, requestedPropsAndSubProps))
     if (simplifyFlag) {
       entities = entities.map(entity => simplifyEntity(entity, options))
     }

package/lib/fs.js

@@ -1,5 +1,6 @@
 import { accessSync, constants } from 'node:fs'
 import { access } from 'node:fs/promises'
+import { fileURLToPath } from 'node:url'
 
 export const exists = path => access(path)
 
@@ -11,5 +12,5 @@ export const assertWriteAccessSync = path => {
 }
 
 export function getDirname (fileUrl) {
-  return new URL('.', fileUrl).pathname
+  return fileURLToPath(new URL('.', fileUrl))
 }

package/lib/output_templates.js

@@ -1,8 +1,8 @@
 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 pickSelectedSubprops from './pick_selected_subprops.js'
 import program from './program.js'
 import stringifyAsJsFunction from './stringify_as_js_function.js'
 
@@ -43,10 +43,11 @@ function FormatEntity (batchMode, propsToPick, requestedPropsAndSubProps, minimi
         propsToPick[propsToPick.indexOf('claims')] = statementsKey
       }
     }
-    entity = pick(entity, propsToPick)
+    // Always include type, for the needs of simplifyEntity
+    entity = pick(entity, propsToPick.concat([ 'type' ]))
     entity = simplifyEntity(entity, simplifyOptions)
     if (createMode) delete entity.id
-    dropNonSelectedSubprops(entity, requestedPropsAndSubProps)
+    entity = pickSelectedSubprops(entity, requestedPropsAndSubProps)
     if (!batchMode && minimize !== false) {
       minimizeClaimsOrSnaks(entity[statementsKey])
       minimizeSitelinks(entity.sitelinks)

package/lib/pick_selected_subprops.js

@@ -0,0 +1,42 @@
+import { pick } from 'lodash-es'
+
+export default (entity, requestedPropsAndSubProps) => {
+  if (!requestedPropsAndSubProps || Object.keys(requestedPropsAndSubProps).length === 0) return entity
+
+  if (requestedPropsAndSubProps.claims && entity.statements) {
+    requestedPropsAndSubProps.statements = requestedPropsAndSubProps.claims
+    delete requestedPropsAndSubProps.claims
+  }
+
+  const trimedEntity = {
+    id: entity.id,
+  }
+
+  // Preserve info key/values, as some are needed downstream
+  // Ex: type is required by simplifyEntity
+  for (const key of Object.keys(entity)) {
+    if (!requestedPropsAndSubProps[key] && !key.includes(omittableProps)) {
+      trimedEntity[key] = entity[key]
+    }
+  }
+
+  const requestedProps = Object.keys(requestedPropsAndSubProps)
+  for (const prop of requestedProps) {
+    const subkeys = Object.keys(requestedPropsAndSubProps[prop])
+    if (subkeys && subkeys.length > 0) {
+      trimedEntity[prop] = pick(entity[prop], subkeys)
+      subkeys.forEach(subkey => {
+        if (!entity[prop]?.[subkey]) {
+          trimedEntity[prop] = trimedEntity[prop] || {}
+          trimedEntity[prop][subkey] = null
+        }
+      })
+    } else {
+      trimedEntity[prop] = entity[prop]
+    }
+  }
+
+  return trimedEntity
+}
+
+const omittableProps = [ 'info', 'sitelinks', 'aliases', 'labels', 'descriptions', 'claims', 'datatype' ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikibase-cli",
-  "version": "17.0.6",
+  "version": "17.0.8",
   "description": "A command-line interface to Wikibase",
   "type": "module",
   "main": "index.js",
@@ -58,7 +58,7 @@
     "shell-quote": "^1.8.1",
     "split": "^1.0.1",
     "through": "^2.3.8",
-    "wikibase-edit": "^6.0.3",
+    "wikibase-edit": "^6.0.4",
     "wikibase-sdk": "^9.2.3",
     "wikidata-lang": "^2.0.11"
   },

package/lib/drop_non_selected_subprops.js

@@ -1,21 +0,0 @@
-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])
-    if (subkeys && subkeys.length > 0) {
-      entity[prop] = pick(entity[prop], subkeys)
-      subkeys.forEach(subkey => {
-        if (!entity[prop][subkey]) entity[prop][subkey] = null
-      })
-    }
-  })
-}