w-web-api 1.0.29 → 1.0.31

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, verifyUser, 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, verifyBrowserUser, verifyAppUser, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
 
     
 
@@ -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#line115">line 115</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line128">line 128</a>
     </li></ul></dd>
     
 
@@ -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測試
    bCheckUser: false,
    getUserById: null,
    bExcludeWhenNotAdmin: false,
    serverPort: 11005,
    subfolder: '', //mapi
    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: 'admin@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('於生產環境時得加入驗證user機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log(err)
+    <pre class="prettyprint"><code>import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
    bCheckUser: false,
    getUserById: null,
    bExcludeWhenNotAdmin: 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)
 
 
 
@@ -305,7 +305,7 @@
 
         <tr>
             
-                <td class="name"><code>verifyUser</code></td>
+                <td class="name"><code>verifyBrowserUser</code></td>
             
 
             <td class="type">
@@ -334,7 +334,43 @@
                 </td>
             
 
-            <td class="description last"><p>輸入處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false</p></td>
+            <td class="description last"><p>輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>verifyAppUser</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">function</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                </td>
+            
+
+            <td class="description last"><p>輸入驗證應用程序使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false</p></td>
         </tr>
 
     
@@ -721,6 +757,46 @@
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>urlRedirect</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    <code>''</code>
+                
+                </td>
+            
+
+            <td class="description last"><p>輸入錯誤時自動轉址字串，提供站台例如無法登入或驗證失敗時須自動轉址，預設''</p></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -809,7 +885,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu Nov 02 2023 11:10:20 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 Fri Nov 03 2023 12:07:15 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -48,10 +48,8 @@
             <pre class="prettyprint source linenums"><code>import path from 'path'
 import fs from 'fs'
 import get from 'lodash/get'
-// import map from 'lodash/map'
 import each from 'lodash/each'
 import keys from 'lodash/keys'
-// import cloneDeep from 'lodash/cloneDeep'
 import j2o from 'wsemi/src/j2o.mjs'
 import iseobj from 'wsemi/src/iseobj.mjs'
 import isestr from 'wsemi/src/isestr.mjs'
@@ -67,6 +65,7 @@ import strdelright from 'wsemi/src/strdelright.mjs'
 import pm2resolve from 'wsemi/src/pm2resolve.mjs'
 import b642str from 'wsemi/src/b642str.mjs'
 import fsIsFolder from 'wsemi/src/fsIsFolder.mjs'
+import fsIsFile from 'wsemi/src/fsIsFile.mjs'
 import replace from 'wsemi/src/replace.mjs'
 import WServHapiServer from 'w-serv-hapi/src/WServHapiServer.mjs'
 import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
@@ -81,7 +80,8 @@ import ds from '../src/schema/index.mjs'
  * @param {String} url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
  * @param {String} db 輸入資料庫名稱字串
  * @param {Function} getUserByToken 輸入處理函數，函數會傳入使用者token，通過此函數處理後並回傳使用者資訊物件，並至少須提供'id'、'email'、'name'、'isAdmin'欄位，且'isAdmin'限輸入'y'或'n'，且輸入'y'時會複寫權限系統該使用者之'isAdmin'欄位值
- * @param {Function} verifyUser 輸入處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
+ * @param {Function} verifyBrowserUser 輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
+ * @param {Function} verifyAppUser 輸入驗證應用程序使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
  * @param {Object} [opt={}] 輸入設定物件，預設{}
  * @param {Integer} [opt.serverPort=11005] 輸入伺服器通訊port，預設11005
  * @param {Boolean} [opt.bCheckUser=false] 輸入是否檢查使用者資訊布林值，預設false
@@ -91,12 +91,15 @@ import ds from '../src/schema/index.mjs'
  * @param {Object} [opt.webDescription={}] 輸入站台描述物件，至少包含語系eng與cht鍵的名稱，預設{}
  * @param {String} [opt.webLogo=''] 輸入站台logo字串，採base64格式，預設''
  * @param {String} [opt.subfolder=''] 輸入站台所在子目錄字串，提供站台位於內網採反向代理進行服務時，故需支援位於子目錄情形，預設''
+ * @param {String} [opt.urlRedirect=''] 輸入錯誤時自動轉址字串，提供站台例如無法登入或驗證失敗時須自動轉址，預設''
  * @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 WWebApi from './server/WWebApi.mjs'
  * import getSettings from './g.getSettings.mjs'
  *
+ *
  * //st
  * let st = getSettings()
  *
@@ -110,6 +113,7 @@ import ds from '../src/schema/index.mjs'
  *
  *     serverPort: 11005,
  *     subfolder: '', //mapi
+ *     urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11005/
  *
  *     webName: {
  *         'eng': 'API Service',
@@ -123,13 +127,13 @@ import ds from '../src/schema/index.mjs'
  *
  * }
  *
- * let getUserByToken = (token) => {
+ * let getUserByToken = async (token) => {
  *     // return {} //測試無法登入
  *     if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
  *         return {
  *             id: 'id-for-application',
  *             name: 'application',
- *             email: 'admin@example.com',
+ *             email: 'application@example.com',
  *             isAdmin: 'y',
  *         }
  *     }
@@ -146,20 +150,29 @@ import ds from '../src/schema/index.mjs'
  *     return {}
  * }
  *
- * let verifyUser = (user) => {
- *     console.log('於生產環境時得加入驗證user機制')
+ * let verifyBrowserUser = (user, caller) => {
+ *     console.log('verifyBrowserUser/user', user)
+ *     // return false //測試無法登入
+ *     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
+ *     return user.isAdmin === 'y' //測試僅系統管理者使用
+ * }
+ *
+ * let verifyAppUser = (user, caller) => {
+ *     console.log('verifyAppUser/user', user)
+ *     // return false //測試無法登入
+ *     console.log('於生產環境時得加入限制應用程式使用者身份機制')
  *     return user.isAdmin === 'y' //測試僅系統管理者使用
  * }
  *
  * //WWebApi
- * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt)
+ * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt)
  *
  * instWWebApi.on('error', (err) => {
  *     console.log(err)
  * })
  *
  */
-function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
+function WWebApi(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt = {}) {
     let instWServHapiServer = null
 
 
@@ -191,10 +204,17 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
-    //check verifyUser
-    if (!isfun(verifyUser)) {
-        console.log('invalid verifyUser', verifyUser)
-        throw new Error('invalid verifyUser')
+    //check verifyBrowserUser
+    if (!isfun(verifyBrowserUser)) {
+        console.log('invalid verifyBrowserUser', verifyBrowserUser)
+        throw new Error('invalid verifyBrowserUser')
+    }
+
+
+    //check verifyAppUser
+    if (!isfun(verifyAppUser)) {
+        console.log('invalid verifyAppUser', verifyAppUser)
+        throw new Error('invalid verifyAppUser')
     }
 
 
@@ -242,6 +262,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
+    //urlRedirect
+    let urlRedirect = get(opt, 'urlRedirect', '')
+
+
     //WServOrm
     let optWServOrm = {
         bCheckUser,
@@ -268,8 +292,8 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
-    //getTokenUserForSelf
-    let getTokenUserForSelf = async (token) => {
+    //getTokenUser
+    let getTokenUser = async (token) => {
 
         //getUserByToken
         let userSelf = getUserByToken(token)
@@ -279,12 +303,46 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
 
         //check
         if (!iseobj(userSelf)) {
-            console.log(`can not find the user from token`, token)
+            console.log(`token`, token)
+            console.log(`can not find the user from token`)
             return Promise.reject(`can not find the user from token`)
         }
 
-        //verifyUser
-        let b = verifyUser(userSelf)
+        return userSelf
+    }
+
+
+    //getAndVerifyBrowserTokenUser
+    let getAndVerifyBrowserTokenUser = async (token, caller = '') => {
+
+        //getTokenUser
+        let userSelf = await getTokenUser(token)
+
+        //verifyBrowserUser
+        let b = verifyBrowserUser(userSelf, caller)
+        if (ispm(b)) {
+            b = await b
+        }
+
+        //check
+        if (!b) {
+            console.log('userSelf', userSelf)
+            console.log(`user does not have permission`)
+            return Promise.reject(`user does not have permission`)
+        }
+
+        return userSelf
+    }
+
+
+    //getAndVerifyAppTokenUser
+    let getAndVerifyAppTokenUser = async (token, caller = '') => {
+
+        //getTokenUser
+        let userSelf = await getTokenUser(token)
+
+        //verifyAppUser
+        let b = verifyAppUser(userSelf, caller)
         if (ispm(b)) {
             b = await b
         }
@@ -292,6 +350,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         //check
         if (!b) {
             console.log('userSelf', userSelf)
+            console.log(`user does not have permission`)
             return Promise.reject(`user does not have permission`)
         }
 
@@ -308,6 +367,8 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
 
     //parsePayload
     let parsePayload = async (req) => {
+
+        //inp
         let inp = get(req, 'payload')
 
         //to obj
@@ -318,6 +379,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         //check
         if (!iseobj(inp)) {
             console.log('inp', inp)
+            console.log(`invalid inp from req`)
             return Promise.reject(`invalid inp from req`)
         }
 
@@ -328,6 +390,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         if (!isestr(group)) {
             console.log('inp', inp)
             console.log('group', group)
+            console.log(`invalid group from inp`)
             return Promise.reject(`invalid group from inp`)
         }
 
@@ -338,6 +401,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         if (!isearr(apis)) {
             console.log('inp', inp)
             console.log('apis', apis)
+            console.log(`invalid apis from inp`)
             return Promise.reject(`invalid apis from inp`)
         }
 
@@ -396,6 +460,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         if (!isestr(group)) {
             console.log('params', params)
             console.log('group', group)
+            console.log(`invalid group`)
             return Promise.reject(`invalid group`)
         }
 
@@ -407,6 +472,7 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         if (!isearr(apis)) {
             console.log('params', params)
             console.log('apis', apis)
+            console.log(`invalid apis`)
             return Promise.reject(`invalid apis`)
         }
 
@@ -434,9 +500,18 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     let fnEntryOut = 'index.html'
     try {
         let fpEntryIn = path.resolve(pathStaticFiles, fnEntryIn)
+        if (!fsIsFile(fpEntryIn)) {
+            fpEntryIn = path.resolve(pathStaticFiles, fnEntryOut) //本機開發另使用html替代tmp
+        }
+        if (!fsIsFile(fpEntryIn)) {
+            console.log('fpEntryIn', fpEntryIn)
+            throw new Error(`invalid fpEntryIn`)
+        }
         let fpEntryOut = path.resolve(pathStaticFiles, fnEntryOut)
         let c = fs.readFileSync(fpEntryIn, 'utf8')
+        c = replace(c, '/mapi/', '{sfd}/') //方法同genEntry
         c = replace(c, '{sfd}', subfolder)
+        c = replace(c, '{urlRedirect}', urlRedirect)
         fs.writeFileSync(fpEntryOut, c, 'utf8')
     }
     catch (err) {
@@ -476,13 +551,14 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyBrowserTokenUser
+                    let user = await getAndVerifyBrowserTokenUser(token, 'getUserByToken')
 
                     //check
                     if (!iseobj(user)) {
                         console.log('token', token)
                         console.log('[API]getUserByToken/check user: invalid user')
+                        console.log(`token does not have permission`)
                         return Promise.reject(`token does not have permission`)
                     }
 
@@ -507,13 +583,14 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyBrowserTokenUser
+                    let user = await getAndVerifyBrowserTokenUser(token, 'getAPIsList')
 
                     //check
                     if (!iseobj(user)) {
                         console.log('token', token)
                         console.log('[API]getAPIsList/check user: invalid user')
+                        console.log(`token does not have permission`)
                         return Promise.reject(`token does not have permission`)
                     }
 
@@ -542,13 +619,14 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyBrowserTokenUser
+                    let user = await getAndVerifyBrowserTokenUser(token, 'updateAPIs')
 
                     //check
                     if (!iseobj(user)) {
                         console.log('token', token)
                         console.log('[API]updateAPIs/check user: invalid user')
+                        console.log(`token does not have permission`)
                         return Promise.reject(`token does not have permission`)
                     }
 
@@ -580,13 +658,14 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyAppTokenUser
+                    let user = await getAndVerifyAppTokenUser(token, 'syncAndReplaceApis')
 
                     //check
                     if (!iseobj(user)) {
                         console.log('token', token)
                         console.log('[API]syncAndReplaceApis/check user: invalid user')
+                        console.log(`token does not have permission`)
                         return Promise.reject(`token does not have permission`)
                     }
 
@@ -663,7 +742,7 @@ export default WWebApi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu Nov 02 2023 11:10:20 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 Fri Nov 03 2023 12:07:15 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 Thu Nov 02 2023 11:10:20 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 Fri Nov 03 2023 12:07:15 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "w-web-api",
-  "version": "1.0.29",
+  "version": "1.0.31",
   "main": "dist/w-web-api.umd.js",
   "dependencies": {
     "@mdi/js": "^7.2.96",
@@ -11,7 +11,7 @@
     "w-data-collector": "^1.0.19",
     "w-serv-hapi": "^1.0.11",
     "w-serv-orm": "^1.0.7",
-    "w-ui-loginout": "^1.0.4",
+    "w-ui-loginout": "^1.0.5",
     "wsemi": "^1.7.38"
   },
   "devDependencies": {

package/public/index.html

@@ -12,6 +12,13 @@
         <!-- fontawesome -->
         <link href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.4.2/css/all.min.css" rel="stylesheet">
 
+        <!-- ___pmwapi___ -->
+        <script>
+            window.___pmwapi___={
+                urlRedirect: '{urlRedirect}',
+            }
+        </script>
+
     </head>
     <body style="font-family:'Microsoft JhengHei','Avenir','Helvetica', 'Arial', 'sans-serif'; padding:0px; margin:0px;">
         <noscript>