bajo-extra 2.0.0 → 2.2.0

package/index.js

@@ -1,17 +1,14 @@
-import bcrypt from 'bcrypt'
 import crypto from 'crypto'
 import { createGzip, createGunzip } from 'zlib'
 import path from 'path'
-import { fetch, Agent } from 'undici'
 import { Readable } from 'stream'
 import numbro from 'numbro'
-import { ShortCrypt } from 'short-crypt'
 
 async function fetching ({ url, opts, bulk, spin }) {
   const { setImmediate, print } = this.app.bajo
-  const { isEmpty, isFunction, has } = this.lib._
+  const { isEmpty, isFunction, has } = this.app.lib._
   const { validationErrorMessage } = this.app.bajoDb
-  const resp = await this.fetch(url, opts ?? {})
+  const resp = await this.fetchUrl(url, opts ?? {})
   if (isEmpty(resp)) {
     spin.fatal('noServerResponse')
     return -1
@@ -57,7 +54,7 @@ async function fetching ({ url, opts, bulk, spin }) {
 }
 
 async function handler (rec, bulk) {
-  const { isFunction, set } = this.lib._
+  const { isFunction, set } = this.app.lib._
   const { recordCreate, recordFind, recordUpdate } = this.app.bajoDb
   const save = bulk.save ?? {}
   const current = save.current ?? {}
@@ -108,13 +105,23 @@ async function handler (rec, bulk) {
   return method
 }
 
+/**
+ * Plugin factory
+ *
+ * @param {string} pkgName - NPM package name
+ * @returns {class}
+ */
 async function factory (pkgName) {
   const me = this
 
-  return class BajoExtra extends this.lib.Plugin {
+  /**
+   * BajoExtra class
+   *
+   * @class
+   */
+  class BajoExtra extends this.app.baseClass.Base {
     constructor () {
       super(pkgName, me.app)
-      this.alias = 'extra'
       this.config = {
         secret: 'hxKY8Eh63Op9js6ovU25qmq2DmCE9dIB',
         fetch: {
@@ -155,7 +162,7 @@ async function factory (pkgName) {
 
     // taken from: https://stackoverflow.com/a/41439945
     countFileLines = async (file) => {
-      const { fs } = this.lib
+      const { fs } = this.app.lib
       return new Promise((resolve, reject) => {
         let lineCount = 0
         fs.createReadStream(file)
@@ -175,9 +182,11 @@ async function factory (pkgName) {
     }
 
     download = async (url, opts = {}, extra = {}) => {
-      const { getPluginDataDir, importPkg, generateId } = this.app.bajo
-      const { fs } = this.lib
-      const { isFunction, merge } = this.lib._
+      const { getPluginDataDir, importPkg } = this.app.bajo
+      const { generateId } = this.app.lib.aneka
+      const { fetch } = await importPkg('bajoExtra:undici')
+      const { fs } = this.app.lib
+      const { isFunction, merge } = this.app.lib._
       if (typeof opts === 'string') extra = { dir: opts }
       const increment = await importPkg('bajo:add-filename-increment')
       if (!extra.dir) {
@@ -254,9 +263,11 @@ async function factory (pkgName) {
     }
 
     fetchUrl = async (url, opts = {}, extra = {}) => {
-      const { isSet } = this.lib.aneka
-      const { fs } = this.lib
-      const { isEmpty, has, isArray, isPlainObject, isString, cloneDeep, merge } = this.lib._
+      const { importPkg } = this.app.bajo
+      const { fetch, Agent } = await importPkg('bajoExtra:undici')
+      const { isSet } = this.app.lib.aneka
+      const { fs } = this.app.lib
+      const { isEmpty, has, isArray, isPlainObject, isString, cloneDeep, merge } = this.app.lib._
       if (isPlainObject(url)) {
         extra = cloneDeep(opts)
         opts = cloneDeep(url)
@@ -311,7 +322,7 @@ async function factory (pkgName) {
     }
 
     gzip = async (file, deleteOld, expand) => {
-      const { fs } = this.lib
+      const { fs } = this.app.lib
       return new Promise((resolve, reject) => {
         const newFile = expand ? file.slice(0, file.length - 3) : (file + '.gz')
         const reader = fs.createReadStream(file)
@@ -328,6 +339,8 @@ async function factory (pkgName) {
     }
 
     hash = async (text, type = 'md5', options = {}) => {
+      const { importPkg } = this.app.bajo
+      const bcrypt = await importPkg('bajoExtra:bcrypt')
       options.digest = options.digest ?? 'hex'
       options.salt = options.hash ?? 10
       if (typeof text !== 'string') text = JSON.stringify(text)
@@ -349,6 +362,8 @@ async function factory (pkgName) {
     }
 
     encrypt = async (text, { type = 'short', subType = 'qr' } = {}) => {
+      const { importPkg } = this.app.bajo
+      const { ShortCrypt } = await importPkg('bajoExtra:short-crypt')
       const short = (item) => {
         const sc = new ShortCrypt(this.config.secret)
         const method = subType === 'qr' ? 'encryptToQRCodeAlphanumeric' : 'encryptToURLComponent'
@@ -357,10 +372,12 @@ async function factory (pkgName) {
       switch (type) {
         case 'short': return short(text)
       }
-      throw this.error('invalid%s%s', this.print.write('encryption type'), type)
+      throw this.error('invalid%s%s', this.t('encryption type'), type)
     }
 
     decrypt = async (cipher, { type = 'short', subType = 'qr' } = {}) => {
+      const { importPkg } = this.app.bajo
+      const { ShortCrypt } = await importPkg('bajoExtra:short-crypt')
       const short = (item) => {
         const sc = new ShortCrypt(this.config.secret)
         const method = subType === 'qr' ? 'decryptToQRCodeAlphanumeric' : 'decryptToURLComponent'
@@ -369,7 +386,7 @@ async function factory (pkgName) {
       switch (type) {
         case 'short': return short(cipher)
       }
-      throw this.error('invalid%s%s', this.print.write('decryption type'), type)
+      throw this.error('invalid%s%s', this.t('decryption type'), type)
     }
 
     randomRange = (min, max, alpha) => {
@@ -378,6 +395,8 @@ async function factory (pkgName) {
       return String.fromCharCode(96 + num)
     }
   }
+
+  return BajoExtra
 }
 
 export default factory

package/package.json

@@ -1,42 +1,48 @@
-{
-  "name": "bajo-extra",
-  "version": "2.0.0",
-  "description": "Extra package for Bajo Framework",
-  "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/bajo-extra.git"
-  },
-  "keywords": [
-    "bajo",
-    "extra",
-    "nodejs",
-    "modular",
-    "module",
-    "package"
-  ],
-  "author": "Ardhi Lukianto <ardhi@lukianto.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ardhi/bajo-extra/issues"
-  },
-  "homepage": "https://github.com/ardhi/bajo-extra#readme",
-  "dependencies": {
-    "async": "^3.2.6",
-    "bcrypt": "^5.1.1",
-    "cheerio": "^1.1.0",
-    "fast-jwt": "^5.0.2",
-    "fast-xml-parser": "^4.5.1",
-    "numbro": "^2.5.0",
-    "performant-array-to-tree": "^1.11.0",
-    "short-crypt": "^4.0.0",
-    "undici": "^7.2.1"
-  }
-}
+{
+  "name": "bajo-extra",
+  "version": "2.2.0",
+  "description": "Extra package for Bajo Framework",
+  "main": "index.js",
+  "scripts": {
+    "build-doc": "jsdoc -c .jsdoc.conf.json",
+    "test": "mocha"
+  },
+  "type": "module",
+  "bajo": {
+    "type": "plugin",
+    "alias": "extra"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ardhi/bajo-extra.git"
+  },
+  "keywords": [
+    "bajo",
+    "extra",
+    "nodejs",
+    "modular",
+    "module",
+    "package"
+  ],
+  "author": "Ardhi Lukianto <ardhi@lukianto.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ardhi/bajo-extra/issues"
+  },
+  "homepage": "https://github.com/ardhi/bajo-extra#readme",
+  "dependencies": {
+    "async": "^3.2.6",
+    "bcrypt": "^6.0.0",
+    "cheerio": "^1.1.2",
+    "fast-jwt": "^6.1.0",
+    "fast-xml-parser": "^5.3.3",
+    "numbro": "^2.5.0",
+    "performant-array-to-tree": "^1.11.0",
+    "short-crypt": "^4.0.0",
+    "undici": "^7.16.0"
+  },
+  "devDependencies": {
+    "clean-jsdoc-theme": "^4.3.0",
+    "jsdoc-plugin-intersection": "^1.0.4"
+  }
+}

package/wiki/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 2025-12-28
+
+- [2.1.0] Ported to ```bajo@2.2.x``` specs

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.

package/wiki/toc.json

@@ -0,0 +1,5 @@
+{
+  "00-config": {
+    "title": "Config Object"
+  }
+}