bajo-extra 2.7.0 → 2.8.0

package/index.js

@@ -4,6 +4,7 @@ import path from 'path'
 import { Readable } from 'stream'
 import numbro from 'numbro'
 import sharp from 'sharp'
+import lockfile from '@bybrave/proper-lockfile2'
 
 /**
  * Plugin factory.
@@ -692,6 +693,50 @@ async function factory (pkgName) {
         }
       }
     }
+
+    /**
+     * Acquire a lock on a specified file to prevent concurrent access.
+     *
+     * @param {string} file - The path to the file to lock. If no path found, it will be saved in `{tmpDir}`. Can be in many formats, see {@link https://ardhi.github.io/bajo/App.html#getPluginFile|getPluginFile} for details.
+     * @param {Object} [options={}] - The options for locking the file.
+     * @returns {Promise<function>} - A promise that resolves to the lock release function.
+     */
+    lock = async (file, options = {}) => {
+      const { ensureFile = true, silent = true } = options
+      const { fs } = this.app.lib
+      options.fs = fs
+      try {
+        if (path.basename(file) === file) file = `${this.app.bajo.dir.tmp}/${file}`
+        else file = this.app.getPluginFile(file)
+        if (ensureFile) await fs.ensureFile(file)
+        return await lockfile.lock(file, options)
+      } catch (err) {
+        if (silent) return null
+        throw err
+      }
+    }
+
+    /**
+     * Unlock a specified file that was previously locked, allowing concurrent access again.
+     * @param {string} file - The path to the file to unlock. If no path found, it will be saved in `{tmpDir}`. Can be in many formats, see {@link https://ardhi.github.io/bajo/App.html#getPluginFile|getPluginFile} for details.
+     * @param {Object} [options={}] - The options for unlocking the file.
+     * @returns {Promise<function>} - A promise that resolves to the lock release function.
+     */
+    unlock = async (file, options = {}) => {
+      const { silent = true } = options
+      const { fs } = this.app.lib
+      options.fs = fs
+      try {
+        if (path.basename(file) === file) file = `${this.app.bajo.dir.tmp}/${file}`
+        else file = this.app.getPluginFile(file)
+        if (!fs.existsSync(file)) return true
+        await lockfile.unlock(file)
+        return true
+      } catch (err) {
+        if (silent) return null
+        throw err
+      }
+    }
   }
 
   return BajoExtra

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo-extra",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Extra package for Bajo Framework",
   "main": "index.js",
   "scripts": {
@@ -31,16 +31,17 @@
   },
   "homepage": "https://github.com/ardhi/bajo-extra#readme",
   "dependencies": {
+    "@bybrave/proper-lockfile2": "^5.0.0",
     "async": "^3.2.6",
     "bcrypt": "^6.0.0",
-    "cheerio": "^1.1.2",
-    "fast-jwt": "^6.1.0",
-    "fast-xml-parser": "^5.3.3",
+    "cheerio": "^1.2.0",
+    "fast-jwt": "^6.2.4",
+    "fast-xml-parser": "^5.10.1",
     "numbro": "^2.5.0",
     "performant-array-to-tree": "^1.11.0",
     "sharp": "^0.34.5",
     "short-crypt": "^4.0.0",
-    "undici": "^7.16.0"
+    "undici": "^8.9.0"
   },
   "devDependencies": {
     "chai": "^6.2.2",

package/wiki/CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 2026-07-28
+
+- [2.8.0] Add `lock()` & `unlock()` for file locking
+
 ## 2026-06-28
 
 - [2.7.0] Add documentations
@@ -7,26 +11,26 @@
 
 ## 2026-06-12
 
-- [2.6.0] Necessary updates to ```bajo@2.18.0``` specs
+- [2.6.0] Necessary updates to `bajo@2.18.0` specs
 
 ## 2026-05-03
 
-- [2.5.0] Add ```isHtmlLink```
+- [2.5.0] Add `isHtmlLink`
 
 ## 2026-05-02
 
-- [2.4.0] Add ```sharp``` as library
-- [2.4.0] Add ```thumbnailSizes()```
-- [2.4.0] Add ```createThumbnail()```
+- [2.4.0] Add `sharp` as library
+- [2.4.0] Add `thumbnailSizes()`
+- [2.4.0] Add `createThumbnail()`
 
 ## 2026-04-25
 
-- [2.3.0] Add ```isSha256()```
+- [2.3.0] Add `isSha256()`
 
 ## 2026-01-16
 
-- [2.2.1] Bug fix on ```fetchUrl()``` for url with query string
+- [2.2.1] Bug fix on `fetchUrl()` for url with query string
 
 ## 2025-12-28
 
-- [2.2.0] Ported to ```bajo@2.2.x``` specs
+- [2.2.0] Ported to `bajo@2.2.x` specs