dobo-extra 2.0.1 → 2.3.0

package/extend/bajo/config-handlers.js

@@ -0,0 +1,42 @@
+import ndjson from 'ndjson'
+import { Readable } from 'stream'
+import fs from 'fs'
+
+const ndjsonReadHandler = function (data, opts = {}) {
+  return new Promise((resolve, reject) => {
+    const reader = opts.readFromFile ? fs.createReadStream(data) : Readable.from(data)
+    const results = []
+    reader.pipe(ndjson.parse({ strict: opts.strict ?? true }))
+      .on('data', data => {
+        results.push(data)
+      })
+      .on('error', reject)
+      .on('end', () => {
+        resolve(results)
+      })
+  })
+}
+
+const ndjsonWriteHandler = function (data, opts = {}) {
+  return new Promise((resolve, reject) => {
+    const stream = ndjson.stringify()
+    const results = []
+    stream.on('data', line => {
+      results.push(line)
+    })
+    stream.on('finish', () => {
+      const items = results.join('\n')
+      if (opts.writeToFile) {
+        fs.writeFileSync(data, items, 'utf8')
+        resolve()
+      } else resolve(items)
+    })
+    stream.write(data)
+    stream.end()
+  })
+}
+
+export default [
+  { ext: '.ndjson', readHandler: ndjsonReadHandler, writeHandler: ndjsonWriteHandler },
+  { ext: '.jsonl', readHandler: ndjsonReadHandler, writeHandler: ndjsonWriteHandler }
+]

package/index.js

@@ -1,3 +1,6 @@
+import exportTo from './lib/export-to.js'
+import importFrom from './lib/import-from.js'
+
 /**
  * Plugin factory
  *
@@ -12,10 +15,7 @@ async function factory (pkgName) {
    *
    * @class
    */
-  class DoboExtra extends this.app.pluginClass.base {
-    static alias = 'dbx'
-    static dependencies = ['dobo', 'bajo-extra']
-
+  class DoboExtra extends this.app.baseClass.Base {
     constructor () {
       super(pkgName, me.app)
       this.config = {
@@ -36,6 +36,8 @@ async function factory (pkgName) {
           runEarly: true
         }
       }
+
+      this.selfBind(['exportTo', 'importFrom'])
     }
 
     init = async () => {
@@ -74,6 +76,9 @@ async function factory (pkgName) {
         })
       }, this.config.archive.checkInterval * 60 * 1000)
     }
+
+    exportTo = exportTo
+    importFrom = importFrom
   }
 
   return DoboExtra

package/{method → lib}/export-to.js

@@ -1,11 +1,10 @@
 import path from 'path'
-import format from '../lib/ndjson-csv-xlsx.js'
+import { json, ndjson, csv, xlsx } from './ndjson-csv-xlsx.js'
 import { createGzip } from 'node:zlib'
 import scramjet from 'scramjet'
-import supportedExt from '../lib/io-exts.js'
+import supportedExt from './io-exts.js'
 
 const { DataStream } = scramjet
-const { json, ndjson, csv, xlsx } = format
 
 async function getFile (dest, ensureDir) {
   const { importPkg, getPluginDataDir } = this.app.bajo

package/{method → lib}/import-from.js

@@ -1,11 +1,10 @@
 import path from 'path'
-import format from '../lib/ndjson-csv-xlsx.js'
+import { json, ndjson, csv, xlsx } from './ndjson-csv-xlsx.js'
 import { createGunzip } from 'zlib'
-import supportedExt from '../lib/io-exts.js'
+import supportedExt from './io-exts.js'
 import scramjet from 'scramjet'
 
 const { DataStream } = scramjet
-const { json, ndjson, csv, xlsx } = format
 
 async function importFrom (source, dest, { trashOld = true, batch = 1, progressFn, converterFn, useHeader = true, fileType, createOpts = {} } = {}, opts = {}) {
   const { getPluginDataDir } = this.app.bajo

package/lib/ndjson-csv-xlsx.js

@@ -1,7 +1,7 @@
 // Borrowed from: https://github.com/fanlia/ndjson-csv-xlsx/blob/main/index.js
 
-import ndjson from 'ndjson'
-import csv from 'fast-csv'
+import ndj from 'ndjson'
+import fastCsv from 'fast-csv'
 import xlsxparse from 'xlsx-parse-stream'
 import XLSXWriteStream from '@atomictech/xlsx-write-stream'
 import StreamArray from 'stream-json/streamers/StreamArray.js'
@@ -11,27 +11,28 @@ import chain from 'stream-chain'
 
 const XLSXStreamer = XLSXWriteStream.default
 
-export default {
-  ndjson: {
-    parse: (...args) => ndjson.parse(...args),
-    stringify: (...args) => ndjson.stringify(...args)
-  },
-  csv: {
-    parse: (...args) => csv.parse(...args),
-    stringify: (...args) => csv.format(...args)
-  },
-  xlsx: {
-    parse: (...args) => xlsxparse(...args),
-    stringify: (...args) => new XLSXStreamer(...args)
-  },
-  json: {
-    parse: (...args) => chain([
-      StreamArray.withParser(...args),
-      data => data.value
-    ]),
-    stringify: (options, ...args) => chain([
-      new Disassembler(),
-      new Stringer({ ...options, makeArray: true })
-    ])
-  }
+export const ndjson = {
+  parse: (...args) => ndj.parse(...args),
+  stringify: (...args) => ndj.stringify(...args)
+}
+
+export const csv = {
+  parse: (...args) => fastCsv.parse(...args),
+  stringify: (...args) => fastCsv.format(...args)
+}
+
+export const xlsx = {
+  parse: (...args) => xlsxparse(...args),
+  stringify: (...args) => new XLSXStreamer(...args)
+}
+
+export const json = {
+  parse: (...args) => chain([
+    StreamArray.withParser(...args),
+    data => data.value
+  ]),
+  stringify: (options, ...args) => chain([
+    new Disassembler(),
+    new Stringer({ ...options, makeArray: true })
+  ])
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dobo-extra",
-  "version": "2.0.1",
+  "version": "2.3.0",
   "description": "Bajo DB Extra Tools/Utility",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,9 @@
   },
   "type": "module",
   "bajo": {
-    "type": "plugin"
+    "type": "plugin",
+    "alias": "dbx",
+    "dependencies": ["dobo", "bajo-extra"]
   },
   "repository": {
     "type": "git",

package/wiki/CHANGES.md

@@ -0,0 +1,9 @@
+# Changes
+
+## 2026-03-22
+
+- [2.3.0] Add ```.ndjson``` and published to be a ```config handler```
+
+## 2025-12-28
+
+- [2.1.0] Ported to ```bajo@2.2.x``` & ```dobo@2.2.x``` specs