w-web-api 1.0.37 → 1.0.39

package/docs/WWebApi.html

@@ -64,7 +64,7 @@
 
     
 
-    <h4 class="name" id="WWebApi"><span class="type-signature"></span>new WWebApi<span class="signature">(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    <h4 class="name" id="WWebApi"><span class="type-signature"></span>new WWebApi<span class="signature">(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
 
     
 
@@ -127,7 +127,7 @@
 
     <h5 class="h5-examples">Example</h5>
     
-    <pre class="prettyprint"><code>import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
    useCheckUser: false,
    getUserById: null,
    useExcludeWhenNotAdmin: false,
    serverPort: 11005,
    subfolder: '', //mapi
    urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11005/
    webName: {
        'eng': 'API Service',
        'cht': 'API管理系統',
    },
    webDescription: {
        'eng': 'A web service package as methods to send requests to and receive responses from an API.',
        'cht': 'A web service package as methods to send requests to and receive responses from an API.',
    },
    webLogo: 'data:image/svg+xml;base64,...',
    // return {} //測試無法登入
    if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
        return {
            id: 'id-for-application',
            name: 'application',
            email: 'application@example.com',
            isAdmin: 'y',
        }
    }
    if (token === 'sys') { //開發階段w-ui-loginout自動給予browser使用者(且位於localhost)的token為sys
        return {
            id: 'id-for-admin',
            name: '測試者',
            email: 'admin@example.com',
            isAdmin: 'y',
        }
    }
    console.log('invalid token', token)
    console.log('於生產環境時得加入SSO等驗證token機制')
    return {}
    console.log('verifyBrowserUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log('verifyAppUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制應用程式使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log(err)
+    <pre class="prettyprint"><code>import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
    useCheckUser: false,
    getUserById: null,
    useExcludeWhenNotAdmin: false,
    serverPort: 11005,
    subfolder: '', //mapi
    urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11005/
    webName: {
        'eng': 'API Service',
        'cht': 'API管理系統',
    },
    webDescription: {
        'eng': 'A web service package as methods to send requests to and receive responses from an API.',
        'cht': 'A web service package as methods to send requests to and receive responses from an API.',
    },
    webLogo: 'data:image/svg+xml;base64,...',
    // return {} //測試無法登入
    if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
        return {
            id: 'id-for-application',
            name: 'application',
            email: 'application@example.com',
            isAdmin: 'y',
        }
    }
    if (token === 'sys') { //開發階段w-ui-loginout自動給予browser使用者(且位於localhost)的token為sys
        return {
            id: 'id-for-admin',
            name: '測試者',
            email: 'admin@example.com',
            isAdmin: 'y',
        }
    }
    console.log('invalid token', token)
    console.log('於生產環境時得加入SSO等驗證token機制')
    return {}
    console.log('verifyClientUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log('verifyAppUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制應用程式使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log(err)
 
 
 
@@ -226,7 +226,7 @@
                 </td>
             
 
-            <td class="description last"><p>輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'</p></td>
+            <td class="description last"><p>輸入資料庫連線字串，例如w-orm-lmdb為'./db'，或w-orm-mongodb為'mongodb://username:password@$127.0.0.1:27017'</p></td>
         </tr>
 
     
@@ -305,7 +305,7 @@
 
         <tr>
             
-                <td class="name"><code>verifyBrowserUser</code></td>
+                <td class="name"><code>verifyClientUser</code></td>
             
 
             <td class="type">
@@ -885,7 +885,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri Jun 06 2025 10:18:38 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 Sat Jun 07 2025 21:13:58 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -77,10 +77,10 @@ import ds from '../src/schema/index.mjs'
  *
  * @class
  * @param {Function} WOrm 輸入資料庫ORM函數
- * @param {String} url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
+ * @param {String} url 輸入資料庫連線字串，例如w-orm-lmdb為'./db'，或w-orm-mongodb為'mongodb://username:password@$127.0.0.1:27017'
  * @param {String} db 輸入資料庫名稱字串
  * @param {Function} getUserByToken 輸入處理函數，函數會傳入使用者token，通過此函數處理後並回傳使用者資訊物件，並至少須提供'id'、'email'、'name'、'isAdmin'欄位，且'isAdmin'限輸入'y'或'n'，且輸入'y'時會複寫權限系統該使用者之'isAdmin'欄位值
- * @param {Function} verifyBrowserUser 輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
+ * @param {Function} verifyClientUser 輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
  * @param {Function} verifyAppUser 輸入驗證應用程序使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
  * @param {Object} [opt={}] 輸入設定物件，預設{}
  * @param {Integer} [opt.serverPort=11005] 輸入伺服器通訊port，預設11005
@@ -95,7 +95,7 @@ import ds from '../src/schema/index.mjs'
  * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
  * @example
  *
- * import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
+ * import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
  * import WWebApi from './server/WWebApi.mjs'
  * import getSettings from './g.getSettings.mjs'
  *
@@ -103,7 +103,7 @@ import ds from '../src/schema/index.mjs'
  * //st
  * let st = getSettings()
  *
- * let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}` //使用Mongodb測試
+ * let url = st.dbUrl
  * let db = st.dbName
  * let opt = {
  *
@@ -150,8 +150,8 @@ import ds from '../src/schema/index.mjs'
  *     return {}
  * }
  *
- * let verifyBrowserUser = (user, caller) => {
- *     console.log('verifyBrowserUser/user', user)
+ * let verifyClientUser = (user, caller) => {
+ *     console.log('verifyClientUser/user', user)
  *     // return false //測試無法登入
  *     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
  *     return user.isAdmin === 'y' //測試僅系統管理者使用
@@ -165,14 +165,14 @@ import ds from '../src/schema/index.mjs'
  * }
  *
  * //WWebApi
- * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt)
+ * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt)
  *
  * instWWebApi.on('error', (err) => {
  *     console.log(err)
  * })
  *
  */
-function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt = {}) {
+function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt = {}) {
     let instWServHapiServer = null
 
 
@@ -204,10 +204,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser
     }
 
 
-    //check verifyBrowserUser
-    if (!isfun(verifyBrowserUser)) {
-        console.log('invalid verifyBrowserUser', verifyBrowserUser)
-        throw new Error('invalid verifyBrowserUser')
+    //check verifyClientUser
+    if (!isfun(verifyClientUser)) {
+        console.log('invalid verifyClientUser', verifyClientUser)
+        throw new Error('invalid verifyClientUser')
     }
 
 
@@ -318,8 +318,8 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser
         //getTokenUser
         let userSelf = await getTokenUser(token)
 
-        //verifyBrowserUser
-        let b = verifyBrowserUser(userSelf, caller)
+        //verifyClientUser
+        let b = verifyClientUser(userSelf, caller)
         if (ispm(b)) {
             b = await b
         }
@@ -749,7 +749,7 @@ export default WWebApi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri Jun 06 2025 10:18:38 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 Sat Jun 07 2025 21:13:58 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 Fri Jun 06 2025 10:18:38 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 Sat Jun 07 2025 21:13:58 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/g.getSettings.mjs

@@ -5,11 +5,13 @@
 
 function getSettings() {
     return {
-        'dbUsername': 'username',
-        'dbPassword': 'password',
+        // 'dbUsername': 'username',
+        // 'dbPassword': 'password',
+        // 'dbName': 'wapis',
+        // 'dbIP': '127.0.0.1',
+        // 'dbPort': 27017,
+        'dbUrl': './db',
         'dbName': 'wapis',
-        'dbIP': '127.0.0.1',
-        'dbPort': 27017,
     }
 }
 

package/g.mOrm.mjs

@@ -1,4 +1,4 @@
-import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs'
+import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
 import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
 import ds from './src/schema/index.mjs'
 import getSettings from './g.getSettings.mjs'
@@ -8,7 +8,7 @@ import getSettings from './g.getSettings.mjs'
 let st = getSettings()
 
 //url, db
-let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
+let url = st.dbUrl
 let db = st.dbName
 
 //WServOrm

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "w-web-api",
-  "version": "1.0.37",
+  "version": "1.0.39",
   "main": "dist/w-web-api.umd.js",
   "dependencies": {
     "@mdi/js": "^7.4.47",
-    "axios": "^1.6.8",
+    "axios": "^1.9.0",
     "lodash-es": "^4.17.21",
     "showdown": "^2.1.0",
     "w-component-vue": "^2.4.20",
     "w-data-collector": "^1.0.22",
-    "w-serv-hapi": "^1.0.56",
+    "w-serv-hapi": "^1.0.57",
     "w-serv-orm": "^1.0.26",
     "w-ui-loginout": "^1.0.9",
     "wsemi": "^1.7.92"
@@ -28,7 +28,7 @@
     "eslint-plugin-vue": "^9.10.0",
     "vue": "^2.6.14",
     "vuex": "^3.6.2",
-    "w-orm-mongodb": "^1.1.33",
+    "w-orm-lmdb": "^1.0.1",
     "w-package-tools": "^1.1.2"
   },
   "scripts": {

package/server/WWebApi.mjs

@@ -30,10 +30,10 @@ import ds from '../src/schema/index.mjs'
  *
  * @class
  * @param {Function} WOrm 輸入資料庫ORM函數
- * @param {String} url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
+ * @param {String} url 輸入資料庫連線字串，例如w-orm-lmdb為'./db'，或w-orm-mongodb為'mongodb://username:password@$127.0.0.1:27017'
  * @param {String} db 輸入資料庫名稱字串
  * @param {Function} getUserByToken 輸入處理函數，函數會傳入使用者token，通過此函數處理後並回傳使用者資訊物件，並至少須提供'id'、'email'、'name'、'isAdmin'欄位，且'isAdmin'限輸入'y'或'n'，且輸入'y'時會複寫權限系統該使用者之'isAdmin'欄位值
- * @param {Function} verifyBrowserUser 輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
+ * @param {Function} verifyClientUser 輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
  * @param {Function} verifyAppUser 輸入驗證應用程序使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
  * @param {Object} [opt={}] 輸入設定物件，預設{}
  * @param {Integer} [opt.serverPort=11005] 輸入伺服器通訊port，預設11005
@@ -48,7 +48,7 @@ import ds from '../src/schema/index.mjs'
  * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
  * @example
  *
- * import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
+ * import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
  * import WWebApi from './server/WWebApi.mjs'
  * import getSettings from './g.getSettings.mjs'
  *
@@ -56,7 +56,7 @@ import ds from '../src/schema/index.mjs'
  * //st
  * let st = getSettings()
  *
- * let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}` //使用Mongodb測試
+ * let url = st.dbUrl
  * let db = st.dbName
  * let opt = {
  *
@@ -103,8 +103,8 @@ import ds from '../src/schema/index.mjs'
  *     return {}
  * }
  *
- * let verifyBrowserUser = (user, caller) => {
- *     console.log('verifyBrowserUser/user', user)
+ * let verifyClientUser = (user, caller) => {
+ *     console.log('verifyClientUser/user', user)
  *     // return false //測試無法登入
  *     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
  *     return user.isAdmin === 'y' //測試僅系統管理者使用
@@ -118,14 +118,14 @@ import ds from '../src/schema/index.mjs'
  * }
  *
  * //WWebApi
- * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt)
+ * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt)
  *
  * instWWebApi.on('error', (err) => {
  *     console.log(err)
  * })
  *
  */
-function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt = {}) {
+function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt = {}) {
     let instWServHapiServer = null
 
 
@@ -157,10 +157,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser
     }
 
 
-    //check verifyBrowserUser
-    if (!isfun(verifyBrowserUser)) {
-        console.log('invalid verifyBrowserUser', verifyBrowserUser)
-        throw new Error('invalid verifyBrowserUser')
+    //check verifyClientUser
+    if (!isfun(verifyClientUser)) {
+        console.log('invalid verifyClientUser', verifyClientUser)
+        throw new Error('invalid verifyClientUser')
     }
 
 
@@ -271,8 +271,8 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser
         //getTokenUser
         let userSelf = await getTokenUser(token)
 
-        //verifyBrowserUser
-        let b = verifyBrowserUser(userSelf, caller)
+        //verifyClientUser
+        let b = verifyClientUser(userSelf, caller)
         if (ispm(b)) {
             b = await b
         }

package/src/main.js

@@ -1,4 +1,4 @@
-import get from 'lodash-es/get.js'
+import get from 'lodash-es/get.js'
 // import '@babel/polyfill' //需提供Vuetify的Symbol等API
 // import 'core-js/stable' //需提供Vuetify的Symbol等API, 官網說使用transpileDependencies但不夠, 改用之前提到的@babel/polyfill會被提示已廢棄, 改使用給webpack的polyfill方式才行
 // import 'regenerator-runtime/runtime'
@@ -56,10 +56,9 @@ Vue.directive('domdragdrop', domDragDrop())
 let bFirstSync = false
 WServHapiClient({
     showLog: false,
-    getUrl: () => {
-        return window.location.origin + window.location.pathname
-    },
+    url: window.location.origin + window.location.pathname,
     useWaitToken: true,
+    apiName: 'api',
     getToken: () => {
         let token = get(Vue.prototype, `$store.state.userToken`, '')
         // console.log('getToken', token)

package/srv.mjs

@@ -1,4 +1,4 @@
-import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
+import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
 import WWebApi from './server/WWebApi.mjs'
 import getSettings from './g.getSettings.mjs'
 
@@ -6,7 +6,7 @@ import getSettings from './g.getSettings.mjs'
 //st
 let st = getSettings()
 
-let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}` //使用Mongodb測試
+let url = st.dbUrl
 let db = st.dbName
 let opt = {
 
@@ -53,8 +53,8 @@ let getUserByToken = async (token) => {
     return {}
 }
 
-let verifyBrowserUser = (user, caller) => {
-    console.log('verifyBrowserUser/user', user)
+let verifyClientUser = (user, caller) => {
+    console.log('verifyClientUser/user', user)
     // return false //測試無法登入
     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
     return user.isAdmin === 'y' //測試僅系統管理者使用
@@ -68,7 +68,7 @@ let verifyAppUser = (user, caller) => {
 }
 
 //WWebApi
-let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt)
+let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt)
 
 instWWebApi.on('error', (err) => {
     console.log(err)

package/tableTags.json

@@ -1 +1 @@
-{"apis":"2025-05-18T21:42:02+08:00|wTOmyF"}
+{"apis":"2025-06-07T21:07:37+08:00|SJWbEU"}