w-web-api 1.0.39 → 1.0.41

package/docs/WWebApi.html

@@ -80,7 +80,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line128">line 128</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line129">line 129</a>
     </li></ul></dd>
     
 
@@ -127,7 +127,7 @@
 
     <h5 class="h5-examples">Example</h5>
     
-    <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)
+    <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)
 
 
 
@@ -885,7 +885,7 @@
 <br class="clear">
 
 <footer>
-    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.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Jul 14 2025 20:28:27 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -55,6 +55,7 @@ import iseobj from 'wsemi/src/iseobj.mjs'
 import isestr from 'wsemi/src/isestr.mjs'
 import isearr from 'wsemi/src/isearr.mjs'
 import ispint from 'wsemi/src/ispint.mjs'
+import isErr from 'wsemi/src/isErr.mjs'
 import isfun from 'wsemi/src/isfun.mjs'
 import ispm from 'wsemi/src/ispm.mjs'
 import cint from 'wsemi/src/cint.mjs'
@@ -150,14 +151,14 @@ import ds from '../src/schema/index.mjs'
  *     return {}
  * }
  *
- * let verifyClientUser = (user, caller) => {
+ * let verifyClientUser = (user, from) => {
  *     console.log('verifyClientUser/user', user)
  *     // return false //測試無法登入
  *     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
  *     return user.isAdmin === 'y' //測試僅系統管理者使用
  * }
  *
- * let verifyAppUser = (user, caller) => {
+ * let verifyAppUser = (user, from) => {
  *     console.log('verifyAppUser/user', user)
  *     // return false //測試無法登入
  *     console.log('於生產環境時得加入限制應用程式使用者身份機制')
@@ -292,6 +293,37 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
     }
 
 
+    //checkUser
+    let checkUser = async(user) => {
+        let id = get(user, 'id', '')
+        if (!isestr(id)) {
+            console.log('user', user)
+            console.log('can not get the userId')
+            return Promise.reject(`can not get the userId`)
+        }
+        let email = get(user, 'email', '')
+        if (!isestr(email)) {
+            console.log('user', user)
+            console.log('can not get the email of user')
+            return Promise.reject(`can not get the email of user`)
+        }
+        let name = get(user, 'name', '')
+        if (!isestr(name)) {
+            console.log('user', user)
+            console.log('can not get userName')
+            return Promise.reject(`can not get userName`)
+        }
+        let isAdmin = get(user, 'isAdmin', '')
+        if (isAdmin !== 'y' && isAdmin !== 'n') {
+            console.log('user', user)
+            console.log('user.isAdmin is not y or n', user.isAdmin)
+            console.log('can not get the role of user')
+            return Promise.reject(`can not get the role of user`)
+        }
+        return true
+    }
+
+
     //getTokenUser
     let getTokenUser = async (token) => {
 
@@ -302,24 +334,43 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
         }
 
         //check
-        if (!iseobj(userSelf)) {
-            console.log(`token`, token)
-            console.log(`can not find the user from token`)
-            return Promise.reject(`can not find the user from token`)
+        if (true) {
+            // if (!iseobj(userSelf)) {
+            //     console.log(`token`, token)
+            //     console.log(`can not find the user from token`)
+            //     return Promise.reject(`can not find the user from token`)
+            // }
+            await checkUser(userSelf)
         }
 
         return userSelf
     }
 
 
+    //p
+    let p = {
+        checkToken: async(token) => {
+
+            //getUserByToken
+            let u = await getUserByToken(token)
+            // console.log('u', u)
+
+            //checkUser
+            await checkUser(u)
+
+            return true
+        },
+    }
+
+
     //getAndVerifyBrowserTokenUser
-    let getAndVerifyBrowserTokenUser = async (token, caller = '') => {
+    let getAndVerifyBrowserTokenUser = async (token, from = '') => {
 
         //getTokenUser
         let userSelf = await getTokenUser(token)
 
         //verifyClientUser
-        let b = verifyClientUser(userSelf, caller)
+        let b = verifyClientUser(userSelf, from)
         if (ispm(b)) {
             b = await b
         }
@@ -336,13 +387,13 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
 
     //getAndVerifyAppTokenUser
-    let getAndVerifyAppTokenUser = async (token, caller = '') => {
+    let getAndVerifyAppTokenUser = async (token, from = '') => {
 
         //getTokenUser
         let userSelf = await getTokenUser(token)
 
         //verifyAppUser
-        let b = verifyAppUser(userSelf, caller)
+        let b = verifyAppUser(userSelf, from)
         if (ispm(b)) {
             b = await b
         }
@@ -533,13 +584,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
         //         return 'someAPI'
         //     },
         // },
-        {
-            method: 'GET',
-            path: '/getWebInfor',
-            handler: async function (req, res) {
-                return getWebInfor()
-            },
-        },
+
         {
             method: 'GET',
             path: '/api/getUserByToken', //未登入界面需先檢測token是否為系統管理員, 確認後回傳為系統管理員資訊物件, getUserByToken為w-ui-loginout預設值, 若要更改兩邊須同時修改
@@ -567,6 +612,9 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)() //w-ui-loginout接收已預設格式用pm2resolve轉過, 會提取state進行判斷
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
                 // console.log('getUserByToken', r)
 
                 return r
@@ -602,7 +650,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)()
-                // console.log('verifyIdentity', r)
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
+                // console.log('getAPIsList', r)
 
                 return r
             },
@@ -641,7 +692,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)()
-                // console.log('verifyIdentity', r)
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
+                // console.log('updateAPIs', r)
 
                 return r
             },
@@ -680,7 +734,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)()
-                // console.log('verifyIdentity', r)
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
+                // console.log('syncAndReplaceApis', r)
 
                 return r
             },
@@ -700,7 +757,30 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
     instWServHapiServer = new WServHapiServer({
         port: opt.serverPort,
         pathStaticFiles,
+        apiName: 'api',
         apis,
+        tokenType: 'Bearer',
+        verifyConn: async ({ apiType, authorization, query, headers, req }) => {
+            // console.log('verifyConn', `apiType[${apiType}]`, `authorization[${authorization}]`)
+
+            //token
+            let token = strdelleft(authorization, 7) //刪除Bearer
+            // console.log('token', token)
+
+            //check
+            if (!isestr(token)) {
+                console.log('apiType', apiType)
+                console.log('authorization', authorization)
+                console.log('invalid token')
+                return false
+            }
+
+            //checkToken
+            let b = await p.checkToken(token)
+            // console.log('b', b)
+
+            return b
+        },
         getUserIdByToken: async (token) => { //可使用async或sync函數
             // console.log('getUserIdByToken', token)
             return ''
@@ -720,11 +800,17 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
         methodsExec: ['select', 'insert', 'save', 'del'], //mix需於procOrm內註冊以提供
         tableNamesSync,
         kpFunExt: { //接收參數第1個為userId, 之後才是前端給予參數
+
             getWebInfor,
+
             getAPIsList: (userId, query = {}) => {
                 return getAPIsList(query)
             },
-            //...
+
+            // updateApis: (userId, rows) => {
+            //     return updateApis(rows)
+            // },
+
         },
         fnTableTags: 'tableTags-web-api.json',
     })
@@ -749,7 +835,7 @@ export default WWebApi
 <br class="clear">
 
 <footer>
-    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.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Jul 14 2025 20:28:27 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 Sat Jun 07 2025 21:13:58 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 Mon Jul 14 2025 20:28:27 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "w-web-api",
-  "version": "1.0.39",
+  "version": "1.0.41",
   "main": "dist/w-web-api.umd.js",
   "dependencies": {
     "@mdi/js": "^7.4.47",
     "axios": "^1.9.0",
     "lodash-es": "^4.17.21",
     "showdown": "^2.1.0",
-    "w-component-vue": "^2.4.20",
+    "w-component-vue": "^2.4.22",
     "w-data-collector": "^1.0.22",
-    "w-serv-hapi": "^1.0.57",
-    "w-serv-orm": "^1.0.26",
+    "w-serv-hapi": "^1.0.60",
+    "w-serv-orm": "^1.0.29",
     "w-ui-loginout": "^1.0.9",
-    "wsemi": "^1.7.92"
+    "wsemi": "^1.8.15"
   },
   "devDependencies": {
     "@vue/cli-plugin-babel": "^5.0.8",
@@ -28,7 +28,7 @@
     "eslint-plugin-vue": "^9.10.0",
     "vue": "^2.6.14",
     "vuex": "^3.6.2",
-    "w-orm-lmdb": "^1.0.1",
+    "w-orm-lmdb": "^1.0.2",
     "w-package-tools": "^1.1.2"
   },
   "scripts": {

package/public/index.html

@@ -7,7 +7,7 @@
         <title></title>
 
         <!-- mdi font -->
-        <link href="https://cdn.jsdelivr.net/npm/@mdi/font/css/materialdesignicons.min.css" rel="stylesheet">
+        <link href="https://cdn.jsdelivr.net/npm/@mdi/font@7.4.47/css/materialdesignicons.min.css" rel="stylesheet">
 
         <!-- fontawesome -->
         <link href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.4.2/css/all.min.css" rel="stylesheet">

package/script.txt

@@ -19,4 +19,3 @@ npm run deploy
 #npm test
 
 #npm publish
-

package/server/WWebApi.mjs

@@ -8,6 +8,7 @@ import iseobj from 'wsemi/src/iseobj.mjs'
 import isestr from 'wsemi/src/isestr.mjs'
 import isearr from 'wsemi/src/isearr.mjs'
 import ispint from 'wsemi/src/ispint.mjs'
+import isErr from 'wsemi/src/isErr.mjs'
 import isfun from 'wsemi/src/isfun.mjs'
 import ispm from 'wsemi/src/ispm.mjs'
 import cint from 'wsemi/src/cint.mjs'
@@ -103,14 +104,14 @@ import ds from '../src/schema/index.mjs'
  *     return {}
  * }
  *
- * let verifyClientUser = (user, caller) => {
+ * let verifyClientUser = (user, from) => {
  *     console.log('verifyClientUser/user', user)
  *     // return false //測試無法登入
  *     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
  *     return user.isAdmin === 'y' //測試僅系統管理者使用
  * }
  *
- * let verifyAppUser = (user, caller) => {
+ * let verifyAppUser = (user, from) => {
  *     console.log('verifyAppUser/user', user)
  *     // return false //測試無法登入
  *     console.log('於生產環境時得加入限制應用程式使用者身份機制')
@@ -245,6 +246,37 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
     }
 
 
+    //checkUser
+    let checkUser = async(user) => {
+        let id = get(user, 'id', '')
+        if (!isestr(id)) {
+            console.log('user', user)
+            console.log('can not get the userId')
+            return Promise.reject(`can not get the userId`)
+        }
+        let email = get(user, 'email', '')
+        if (!isestr(email)) {
+            console.log('user', user)
+            console.log('can not get the email of user')
+            return Promise.reject(`can not get the email of user`)
+        }
+        let name = get(user, 'name', '')
+        if (!isestr(name)) {
+            console.log('user', user)
+            console.log('can not get userName')
+            return Promise.reject(`can not get userName`)
+        }
+        let isAdmin = get(user, 'isAdmin', '')
+        if (isAdmin !== 'y' && isAdmin !== 'n') {
+            console.log('user', user)
+            console.log('user.isAdmin is not y or n', user.isAdmin)
+            console.log('can not get the role of user')
+            return Promise.reject(`can not get the role of user`)
+        }
+        return true
+    }
+
+
     //getTokenUser
     let getTokenUser = async (token) => {
 
@@ -255,24 +287,43 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
         }
 
         //check
-        if (!iseobj(userSelf)) {
-            console.log(`token`, token)
-            console.log(`can not find the user from token`)
-            return Promise.reject(`can not find the user from token`)
+        if (true) {
+            // if (!iseobj(userSelf)) {
+            //     console.log(`token`, token)
+            //     console.log(`can not find the user from token`)
+            //     return Promise.reject(`can not find the user from token`)
+            // }
+            await checkUser(userSelf)
         }
 
         return userSelf
     }
 
 
+    //p
+    let p = {
+        checkToken: async(token) => {
+
+            //getUserByToken
+            let u = await getUserByToken(token)
+            // console.log('u', u)
+
+            //checkUser
+            await checkUser(u)
+
+            return true
+        },
+    }
+
+
     //getAndVerifyBrowserTokenUser
-    let getAndVerifyBrowserTokenUser = async (token, caller = '') => {
+    let getAndVerifyBrowserTokenUser = async (token, from = '') => {
 
         //getTokenUser
         let userSelf = await getTokenUser(token)
 
         //verifyClientUser
-        let b = verifyClientUser(userSelf, caller)
+        let b = verifyClientUser(userSelf, from)
         if (ispm(b)) {
             b = await b
         }
@@ -289,13 +340,13 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
 
     //getAndVerifyAppTokenUser
-    let getAndVerifyAppTokenUser = async (token, caller = '') => {
+    let getAndVerifyAppTokenUser = async (token, from = '') => {
 
         //getTokenUser
         let userSelf = await getTokenUser(token)
 
         //verifyAppUser
-        let b = verifyAppUser(userSelf, caller)
+        let b = verifyAppUser(userSelf, from)
         if (ispm(b)) {
             b = await b
         }
@@ -486,13 +537,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
         //         return 'someAPI'
         //     },
         // },
-        {
-            method: 'GET',
-            path: '/getWebInfor',
-            handler: async function (req, res) {
-                return getWebInfor()
-            },
-        },
+
         {
             method: 'GET',
             path: '/api/getUserByToken', //未登入界面需先檢測token是否為系統管理員, 確認後回傳為系統管理員資訊物件, getUserByToken為w-ui-loginout預設值, 若要更改兩邊須同時修改
@@ -520,6 +565,9 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)() //w-ui-loginout接收已預設格式用pm2resolve轉過, 會提取state進行判斷
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
                 // console.log('getUserByToken', r)
 
                 return r
@@ -555,7 +603,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)()
-                // console.log('verifyIdentity', r)
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
+                // console.log('getAPIsList', r)
 
                 return r
             },
@@ -594,7 +645,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)()
-                // console.log('verifyIdentity', r)
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
+                // console.log('updateAPIs', r)
 
                 return r
             },
@@ -633,7 +687,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
 
                 //pm2resolve core
                 let r = await pm2resolve(core)()
-                // console.log('verifyIdentity', r)
+                if (isErr(r.msg)) {
+                    r.msg = r.msg.message
+                }
+                // console.log('syncAndReplaceApis', r)
 
                 return r
             },
@@ -653,7 +710,30 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
     instWServHapiServer = new WServHapiServer({
         port: opt.serverPort,
         pathStaticFiles,
+        apiName: 'api',
         apis,
+        tokenType: 'Bearer',
+        verifyConn: async ({ apiType, authorization, query, headers, req }) => {
+            // console.log('verifyConn', `apiType[${apiType}]`, `authorization[${authorization}]`)
+
+            //token
+            let token = strdelleft(authorization, 7) //刪除Bearer
+            // console.log('token', token)
+
+            //check
+            if (!isestr(token)) {
+                console.log('apiType', apiType)
+                console.log('authorization', authorization)
+                console.log('invalid token')
+                return false
+            }
+
+            //checkToken
+            let b = await p.checkToken(token)
+            // console.log('b', b)
+
+            return b
+        },
         getUserIdByToken: async (token) => { //可使用async或sync函數
             // console.log('getUserIdByToken', token)
             return ''
@@ -673,11 +753,17 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser,
         methodsExec: ['select', 'insert', 'save', 'del'], //mix需於procOrm內註冊以提供
         tableNamesSync,
         kpFunExt: { //接收參數第1個為userId, 之後才是前端給予參數
+
             getWebInfor,
+
             getAPIsList: (userId, query = {}) => {
                 return getAPIsList(query)
             },
-            //...
+
+            // updateApis: (userId, rows) => {
+            //     return updateApis(rows)
+            // },
+
         },
         fnTableTags: 'tableTags-web-api.json',
     })