w-serv-orm 1.0.13 → 1.0.15

package/docs/WServOrm.mjs.html

@@ -60,37 +60,40 @@ import getProc from './getProc.mjs'
  * @param {String} url 輸入資料庫連線位址字串
  * @param {String} db 輸入資料庫名稱字串
  * @param {Object} [opt={}] 輸入設定物件，預設{}
- * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
- * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
- * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
+ * @param {Boolean} [opt.useCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
+ * @param {Function} [opt.getUserById=null] 輸入當useCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
+ * @param {Boolean} [opt.useExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
  * @returns {Object} 回傳通訊物件，可監聽事件open、error、clientChange、execute、broadcast、deliver，可使用函數broadcast
  * @example
  *
- * import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+ * // import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+ * import WOrm from 'w-orm-lowdb/src/WOrmLowdb.mjs' //自行選擇引用ORM
  * import ds from './schema/index.mjs' //先行建置schema
  * import WServOrm from './src/WServOrm.mjs'
  *
- * //st
- * let st = {
- *     dbUsername: 'username',
- *     dbPassword: 'password',
- *     dbName: 'wservorm',
- *     dbIP: 'localhost',
- *     dbPort: 27017,
- * }
+ * // //st
+ * // let st = {
+ * //     dbUsername: 'username',
+ * //     dbPassword: 'password',
+ * //     dbName: 'wservorm',
+ * //     dbIP: 'localhost',
+ * //     dbPort: 27017,
+ * // }
  *
  * //url, db
- * let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
- * let db = st.dbName
+ * // let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
+ * // let db = st.dbName
+ * let url = './db.json'
+ * let db = 'worm'
  *
  * //WServOrm
  * let opt = {
  *     getUserById: null,
- *     bCheckUser: false,
- *     bExcludeWhenNotAdmin: false,
+ *     useCheckUser: false,
+ *     useExcludeWhenNotAdmin: false,
  * }
  * let r = WServOrm(ds, WOrm, url, db, opt)
-console.log(r) //回傳server用orm相關函數
+ * console.log(r) //回傳server用orm相關函數
  * // => {
  * //   backup: [AsyncFunction: backup],
  * //   recover: [AsyncFunction: recover],
@@ -158,7 +161,7 @@ export default WServOrm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Mar 30 2025 22:12:29 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Apr 02 2025 11:26:08 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -71,7 +71,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Mar 30 2025 22:12:29 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Apr 02 2025 11:26:08 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/g-mOrm.mjs

@@ -1,26 +1,29 @@
-import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+// import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+import WOrm from 'w-orm-lowdb/src/WOrmLowdb.mjs' //自行選擇引用ORM
 import ds from './schema/index.mjs' //先行建置schema
 import WServOrm from './src/WServOrm.mjs'
 
 
-//st
-let st = {
-    dbUsername: 'username',
-    dbPassword: 'password',
-    dbName: 'wservorm',
-    dbIP: 'localhost',
-    dbPort: 27017,
-}
+// //st
+// let st = {
+//     dbUsername: 'username',
+//     dbPassword: 'password',
+//     dbName: 'wservorm',
+//     dbIP: 'localhost',
+//     dbPort: 27017,
+// }
 
 //url, db
-let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
-let db = st.dbName
+// let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
+// let db = st.dbName
+let url = './db.json'
+let db = 'worm'
 
 //WServOrm
 let opt = {
     getUserById: null,
-    bCheckUser: false,
-    bExcludeWhenNotAdmin: false,
+    useCheckUser: false,
+    useExcludeWhenNotAdmin: false,
 }
 let r = WServOrm(ds, WOrm, url, db, opt)
 console.log(r) //回傳server用orm相關函數

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "w-serv-orm",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "main": "dist/w-serv-orm.umd.js",
   "dependencies": {
     "json5": "^2.2.3",
@@ -9,8 +9,8 @@
   },
   "devDependencies": {
     "w-data-collector": "^1.0.22",
-    "w-orm-mongodb": "^1.1.32",
-    "w-package-tools": "^1.0.82"
+    "w-orm-lowdb": "^1.0.1",
+    "w-package-tools": "^1.0.85"
   },
   "scripts": {
     "test": "mocha --parallel --timeout 60000 --experimental-modules",

package/src/WServOrm.mjs

@@ -13,37 +13,40 @@ import getProc from './getProc.mjs'
  * @param {String} url 輸入資料庫連線位址字串
  * @param {String} db 輸入資料庫名稱字串
  * @param {Object} [opt={}] 輸入設定物件，預設{}
- * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
- * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
- * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
+ * @param {Boolean} [opt.useCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
+ * @param {Function} [opt.getUserById=null] 輸入當useCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
+ * @param {Boolean} [opt.useExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
  * @returns {Object} 回傳通訊物件，可監聽事件open、error、clientChange、execute、broadcast、deliver，可使用函數broadcast
  * @example
  *
- * import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+ * // import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM
+ * import WOrm from 'w-orm-lowdb/src/WOrmLowdb.mjs' //自行選擇引用ORM
  * import ds from './schema/index.mjs' //先行建置schema
  * import WServOrm from './src/WServOrm.mjs'
  *
- * //st
- * let st = {
- *     dbUsername: 'username',
- *     dbPassword: 'password',
- *     dbName: 'wservorm',
- *     dbIP: 'localhost',
- *     dbPort: 27017,
- * }
+ * // //st
+ * // let st = {
+ * //     dbUsername: 'username',
+ * //     dbPassword: 'password',
+ * //     dbName: 'wservorm',
+ * //     dbIP: 'localhost',
+ * //     dbPort: 27017,
+ * // }
  *
  * //url, db
- * let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
- * let db = st.dbName
+ * // let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
+ * // let db = st.dbName
+ * let url = './db.json'
+ * let db = 'worm'
  *
  * //WServOrm
  * let opt = {
  *     getUserById: null,
- *     bCheckUser: false,
- *     bExcludeWhenNotAdmin: false,
+ *     useCheckUser: false,
+ *     useExcludeWhenNotAdmin: false,
  * }
  * let r = WServOrm(ds, WOrm, url, db, opt)
-console.log(r) //回傳server用orm相關函數
+ * console.log(r) //回傳server用orm相關函數
  * // => {
  * //   backup: [AsyncFunction: backup],
  * //   recover: [AsyncFunction: recover],

package/src/getMapOrm.mjs

@@ -160,7 +160,7 @@ async function mapOrm(userId, woName, mode, input) {
                 })
         }
         else if (mode === 'save') {
-            r = await wo.save(input, { atomic: true })
+            r = await wo.save(input)
                 .catch((msg) => {
                     console.log(`${woName}.save catch`, msg)
                     err = '儲存資料失敗'

package/src/getProc.mjs

@@ -15,8 +15,8 @@ let _funPreProcessing = []
 let _funPostProcessing = []
 let _mapOrm = null
 let _getUserById = null
-let bCheckUser = true
-let bExcludeWhenNotAdmin = true
+let useCheckUser = true
+let useExcludeWhenNotAdmin = true
 
 
 function addFunCheck(f) {
@@ -58,7 +58,7 @@ async function procOrm(userId, woName, mode, input) {
     }
 
     //check
-    if (bCheckUser && !isestr(userId)) {
+    if (useCheckUser && !isestr(userId)) {
         console.log('userId', userId)
         console.log('找不到使用者主鍵')
         return Promise.reject(`找不到使用者主鍵`)
@@ -67,8 +67,8 @@ async function procOrm(userId, woName, mode, input) {
     //isAdmin
     let isAdmin = 'n'
 
-    //bCheckUser
-    if (bCheckUser) {
+    //useCheckUser
+    if (useCheckUser) {
 
         //check
         if (!isfun(_getUserById)) {
@@ -122,8 +122,8 @@ async function procOrm(userId, woName, mode, input) {
     //output
     let output = await _mapOrm(userId, woName, mode, input)
 
-    //bExcludeWhenNotAdmin, 非管理者則要過濾掉已刪除之數據
-    if (bExcludeWhenNotAdmin && isAdmin === 'n') {
+    //useExcludeWhenNotAdmin, 非管理者則要過濾掉已刪除之數據
+    if (useExcludeWhenNotAdmin && isAdmin === 'n') {
         if (mode === 'select' && isarr(output)) { //有可能為錯誤物件
             output = filter(output, (v) => {
                 if (haskey(v, 'isActive')) { //針對有isActive屬性
@@ -153,19 +153,19 @@ function getProc(mapOrm, opt = {}) {
     //save _mapOrm
     _mapOrm = mapOrm
 
-    //bCheckUser
-    bCheckUser = get(opt, 'bCheckUser')
-    if (!isbol(bCheckUser)) {
-        bCheckUser = true
+    //useCheckUser
+    useCheckUser = get(opt, 'useCheckUser')
+    if (!isbol(useCheckUser)) {
+        useCheckUser = true
     }
 
-    //save _getUserById, 不事先檢查, 因若bCheckUser=false可允許不給
+    //save _getUserById, 不事先檢查, 因若useCheckUser=false可允許不給
     _getUserById = get(opt, 'getUserById')
 
-    //bExcludeWhenNotAdmin
-    bExcludeWhenNotAdmin = get(opt, 'bExcludeWhenNotAdmin')
-    if (!isbol(bExcludeWhenNotAdmin)) {
-        bExcludeWhenNotAdmin = true
+    //useExcludeWhenNotAdmin
+    useExcludeWhenNotAdmin = get(opt, 'useExcludeWhenNotAdmin')
+    if (!isbol(useExcludeWhenNotAdmin)) {
+        useExcludeWhenNotAdmin = true
     }
 
     return {