dobo-extra 2.0.0 → 2.0.1

package/extend/bajoCli/applet/import-from.js

@@ -3,7 +3,7 @@ import _path from 'path'
 const batch = 100
 
 function makeProgress (spin) {
-  const { secToHms } = this.lib.aneka
+  const { secToHms } = this.app.lib.aneka
   return async function ({ batchNo, data, batchStart, batchEnd } = {}) {
     spin.setText('batch%d%s', batchNo, secToHms(batchEnd.toTime() - batchStart.toTime(), true))
   }
@@ -11,28 +11,28 @@ function makeProgress (spin) {
 
 async function importFrom (...args) {
   const { importPkg } = this.app.bajo
-  const { isEmpty, map } = this.lib._
+  const { isEmpty, map } = this.app.lib._
   const { getInfo, start } = this.app.dobo
 
   const [input, select, confirm] = await importPkg('bajoCli:@inquirer/input',
     'bajoCli:@inquirer/select', 'bajoCli:@inquirer/confirm')
   const schemas = map(this.app.dobo.schemas, 'name')
-  if (isEmpty(schemas)) return this.print.fatal('notFound%s', this.print.write('field.schema'))
+  if (isEmpty(schemas)) return this.print.fatal('notFound%s', this.t('field.schema'))
   let [dest, model] = args
   if (isEmpty(dest)) {
     dest = await input({
-      message: this.print.write('enterSourceFile'),
+      message: this.t('enterSourceFile'),
       validate: (item) => !isEmpty(item)
     })
   }
   if (isEmpty(model)) {
     model = await select({
-      message: this.print.write('chooseModel'),
+      message: this.t('chooseModel'),
       choices: map(schemas, s => ({ value: s }))
     })
   }
   const answer = await confirm({
-    message: this.print.write('aboutToReplaceAllRecords'),
+    message: this.t('aboutToReplaceAllRecords'),
     default: false
   })
   if (!answer) return this.print.fatal('aborted')

package/index.js

@@ -1,11 +1,23 @@
+/**
+ * Plugin factory
+ *
+ * @param {string} pkgName - NPM package name
+ * @returns {class}
+ */
 async function factory (pkgName) {
   const me = this
 
-  return class DoboExtra extends this.lib.Plugin {
+  /**
+   * DoboExtra class
+   *
+   * @class
+   */
+  class DoboExtra extends this.app.pluginClass.base {
+    static alias = 'dbx'
+    static dependencies = ['dobo', 'bajo-extra']
+
     constructor () {
       super(pkgName, me.app)
-      this.alias = 'dbx'
-      this.dependencies = ['dobo', 'bajo-extra']
       this.config = {
         export: {
           maxBatch: 1000,
@@ -33,7 +45,7 @@ async function factory (pkgName) {
       async function handler ({ item }) {
         const { join } = this.app.bajo
         const { getSchema } = this.app.dobo
-        const { has } = this.lib._
+        const { has } = this.app.lib._
         for (const f of ['source', 'destination']) {
           if (!has(item, f)) throw this.error('taskMustHaveModel%s', f)
           const key = `${f}Field`
@@ -47,7 +59,7 @@ async function factory (pkgName) {
         item.maxAge = item.maxAge ?? 1 // in days, less then 1 is ignored
       }
 
-      this.archivers = await buildCollections({ ns: this.name, handler, container: 'archive.tasks', dupChecks: ['source'], useDefaultName: false })
+      this.archivers = await buildCollections({ ns: this.ns, handler, container: 'archive.tasks', dupChecks: ['source'], useDefaultName: false })
     }
 
     start = async () => {
@@ -63,6 +75,8 @@ async function factory (pkgName) {
       }, this.config.archive.checkInterval * 60 * 1000)
     }
   }
+
+  return DoboExtra
 }
 
 export default factory

package/method/export-to.js

@@ -9,12 +9,12 @@ const { json, ndjson, csv, xlsx } = format
 
 async function getFile (dest, ensureDir) {
   const { importPkg, getPluginDataDir } = this.app.bajo
-  const { fs } = this.lib
+  const { fs } = this.app.lib
   const increment = await importPkg('bajo:add-filename-increment')
   let file
   if (path.isAbsolute(dest)) file = dest
   else {
-    file = `${getPluginDataDir(this.name)}/export/${dest}`
+    file = `${getPluginDataDir(this.ns)}/export/${dest}`
     fs.ensureDirSync(path.dirname(file))
   }
   file = increment(file, { fs: true })
@@ -36,7 +36,7 @@ async function getFile (dest, ensureDir) {
 
 async function getData ({ source, filter, count, stream, progressFn, fields }) {
   let cnt = count ?? 0
-  const { find } = this.lib._
+  const { find } = this.app.lib._
   const { recordFind, getSchema } = this.app.dobo
   const { maxLimit, hardLimit } = this.app.dobo.config.default.filter
   filter.limit = maxLimit
@@ -72,8 +72,8 @@ async function getData ({ source, filter, count, stream, progressFn, fields }) {
 }
 
 function exportTo (source, dest, { filter = {}, ensureDir, useHeader = true, batch = 500, progressFn, fields } = {}, opts = {}) {
-  const { fs } = this.lib
-  const { merge } = this.lib._
+  const { fs } = this.app.lib
+  const { merge } = this.app.lib._
   const { getInfo } = this.app.dobo
 
   filter.page = 1

package/method/import-from.js

@@ -10,14 +10,14 @@ 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
   const { recordCreate } = this.app.dobo
-  const { merge } = this.lib._
-  const { fs } = this.lib
+  const { merge } = this.app.lib._
+  const { fs } = this.app.lib
 
   if (dest !== false) this.app.dobo.getInfo(dest) // make sure dest model is valid
   let file
   if (path.isAbsolute(source)) file = source
   else {
-    file = `${getPluginDataDir(this.name)}/import/${source}`
+    file = `${getPluginDataDir(this.ns)}/import/${source}`
     fs.ensureDirSync(path.dirname(file))
   }
   if (!fs.existsSync(file)) throw this.error('sourceFileNotExists%s', file)

package/package.json

@@ -1,40 +1,45 @@
-{
-  "name": "dobo-extra",
-  "version": "2.0.0",
-  "description": "Bajo DB Extra Tools/Utility",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "type": "module",
-  "bajo": {
-    "type": "plugin"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ardhi/dobo-extra.git"
-  },
-  "keywords": [
-    "extra",
-    "db",
-    "driver",
-    "bajo",
-    "framework",
-    "modular"
-  ],
-  "author": "Ardhi Lukianto <ardhi@lukianto.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ardhi/dobo-extra/issues"
-  },
-  "homepage": "https://github.com/ardhi/dobo-extra#readme",
-  "dependencies": {
-    "@atomictech/xlsx-write-stream": "^2.0.2",
-    "fast-csv": "^5.0.2",
-    "ndjson": "^2.0.0",
-    "scramjet": "^4.37.0",
-    "stream-chain": "^3.3.2",
-    "stream-json": "^1.9.1",
-    "xlsx-parse-stream": "^1.1.0"
-  }
-}
+{
+  "name": "dobo-extra",
+  "version": "2.0.1",
+  "description": "Bajo DB Extra Tools/Utility",
+  "main": "index.js",
+  "scripts": {
+    "build-doc": "jsdoc -c .jsdoc.conf.json",
+    "test": "mocha"
+  },
+  "type": "module",
+  "bajo": {
+    "type": "plugin"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ardhi/dobo-extra.git"
+  },
+  "keywords": [
+    "extra",
+    "db",
+    "driver",
+    "bajo",
+    "framework",
+    "modular"
+  ],
+  "author": "Ardhi Lukianto <ardhi@lukianto.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ardhi/dobo-extra/issues"
+  },
+  "homepage": "https://github.com/ardhi/dobo-extra#readme",
+  "dependencies": {
+    "@atomictech/xlsx-write-stream": "^2.0.2",
+    "fast-csv": "^5.0.2",
+    "ndjson": "^2.0.0",
+    "scramjet": "^4.37.0",
+    "stream-chain": "^3.3.2",
+    "stream-json": "^1.9.1",
+    "xlsx-parse-stream": "^1.1.0"
+  },
+  "devDependencies": {
+    "clean-jsdoc-theme": "^4.3.0",
+    "jsdoc-plugin-intersection": "^1.0.4"
+  }
+}

package/wiki/CONFIG.md

@@ -0,0 +1,3 @@
+# Config Object
+
+TBD

package/wiki/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thanks very much to everyone who wants to join as a contributor, but I have committed to devoting 100% of my time to this project. Therefore, I'm currently unable to accept pull requests from anyone until the project is large enough for me to manage it independently.
+
+However, I am available if you encounter any bugs that require immediate fixes. Please report your issues in a GitHub issue, and I'll try to address them promptly. I'm also open to criticism and suggestions for improvements or requests for new features.