w-web-api 1.0.28 → 1.0.30

package/docs/WWebApi.html

@@ -74,13 +74,13 @@
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>基於hapi之API伺服器</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>API伺服器</p></li></ul></dd>
     
 
     
     <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#line82">line 82</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line115">line 115</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測試
    getUserById: null,
    bCheckUser: false,
    bExcludeWhenNotAdmin: false,
    serverPort: 11005,
    subfolder: '', //mpai
    webName: {
        'eng': 'API Service',
        'cht': 'API管理系統'
    },
    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
    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)
 
 
 
@@ -721,6 +721,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 +849,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Jun 19 2023 08:31:52 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 Thu Nov 02 2023 22:58:48 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -48,13 +48,12 @@
             <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'
+import isearr from 'wsemi/src/isearr.mjs'
 import ispint from 'wsemi/src/ispint.mjs'
 import isfun from 'wsemi/src/isfun.mjs'
 import ispm from 'wsemi/src/ispm.mjs'
@@ -66,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'
@@ -73,7 +73,7 @@ import ds from '../src/schema/index.mjs'
 
 
 /**
- * 基於hapi之API伺服器
+ * API伺服器
  *
  * @class
  * @param {Function} WOrm 輸入資料庫ORM函數
@@ -90,12 +90,12 @@ 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 getSettings from './server/getSettings.mjs'
  * import WWebApi from './server/WWebApi.mjs'
+ * import getSettings from './g.getSettings.mjs'
  *
  * //st
  * let st = getSettings()
@@ -104,22 +104,55 @@ import ds from '../src/schema/index.mjs'
  * let db = st.dbName
  * let opt = {
  *
- *     getUserById: null,
  *     bCheckUser: false,
+ *     getUserById: null,
  *     bExcludeWhenNotAdmin: false,
  *
  *     serverPort: 11005,
- *     subfolder: '', //mpai
+ *     subfolder: '', //mapi
  *
  *     webName: {
  *         'eng': 'API Service',
- *         'cht': 'API管理系統'
+ *         '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,...',
+ *
+ * }
  *
+ * let getUserByToken = (token) => {
+ *     // 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 {}
+ * }
+ *
+ * let verifyUser = (user) => {
+ *     console.log('於生產環境時得加入驗證user機制')
+ *     return user.isAdmin === 'y' //測試僅系統管理者使用
  * }
  *
  * //WWebApi
- * let instWWebApi = WWebApi(WOrm, url, db, opt)
+ * let instWWebApi = WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt)
  *
  * instWWebApi.on('error', (err) => {
  *     console.log(err)
@@ -209,6 +242,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
+    //urlRedirect
+    let urlRedirect = get(opt, 'urlRedirect', '')
+
+
     //WServOrm
     let optWServOrm = {
         bCheckUser,
@@ -235,32 +272,39 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
-    //verifyUserByToken
-    let verifyUserByToken = async (token) => {
+    //getTokenUserForSelf
+    let getTokenUserForSelf = async (token) => {
 
         //getUserByToken
-        let user = getUserByToken(token)
-        if (ispm(user)) {
-            user = await user
+        let userSelf = getUserByToken(token)
+        if (ispm(userSelf)) {
+            userSelf = await userSelf
         }
-        if (!iseobj(user)) {
-            return Promise.reject(`token does not have permission`)
+
+        //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`)
         }
 
         //verifyUser
-        let b = verifyUser(user)
+        let b = verifyUser(userSelf)
         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 user
+        return userSelf
     }
 
+
     //getAPIsList
     let getAPIsList = async (query = {}) => {
         let rs = await woItems.apis.select(query)
@@ -269,7 +313,9 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
 
 
     //parsePayload
-    let parsePayload = (req) => {
+    let parsePayload = async (req) => {
+
+        //inp
         let inp = get(req, 'payload')
 
         //to obj
@@ -277,37 +323,60 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
             inp = j2o(inp)
         }
 
-        //cv apis for base64
-        if (iseobj(inp)) {
-
-            //spread
-            let { group, apis } = inp
-
-            //apis
-            each(apis, (api, kapi) => {
-                // console.log(kapi, api.name)
-                each(api, (v, k) => {
-                    // console.log(k, v)
-                    if (isestr(v)) {
-                        if (strleft(v, 7) === 'base64:') {
-                            // console.log(k, 'get base64')
-                            v = strdelleft(v, 7)
-                            v = b642str(v)
-                            // console.log(v)
-                            apis[kapi][k] = v
-                        }
-                    }
-                })
-            })
+        //check
+        if (!iseobj(inp)) {
+            console.log('inp', inp)
+            console.log(`invalid inp from req`)
+            return Promise.reject(`invalid inp from req`)
+        }
 
-            //resave
-            inp = { group, apis }
+        //group
+        let group = get(inp, 'group', '')
 
+        //check
+        if (!isestr(group)) {
+            console.log('inp', inp)
+            console.log('group', group)
+            console.log(`invalid group from inp`)
+            return Promise.reject(`invalid group from inp`)
         }
-        else {
-            inp = null
+
+        //apis
+        let apis = get(inp, 'apis', [])
+
+        //check
+        if (!isearr(apis)) {
+            console.log('inp', inp)
+            console.log('apis', apis)
+            console.log(`invalid apis from inp`)
+            return Promise.reject(`invalid apis from inp`)
         }
 
+        //偵測b64自動恢復
+        each(apis, (api, kapi) => {
+            // console.log(kapi, api.name)
+            each(api, (v, k) => {
+                // console.log(k, v)
+                if (isestr(v)) {
+                    if (strleft(v, 7) === 'base64:') {
+                        // console.log(k, 'get base64')
+                        v = strdelleft(v, 7)
+                        v = b642str(v)
+                        // console.log(v)
+                        apis[kapi][k] = v
+                    }
+                }
+            })
+        })
+
+        //save group
+        each(apis, (api, kapi) => {
+            apis[kapi].group = group
+        })
+
+        //resave
+        inp = { group, apis }
+
         return inp
     }
 
@@ -327,19 +396,38 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
-    //replaceAPIsByLevels
-    let replaceAPIsByLevels = async (params = {}) => {
+    //syncAndReplaceApis
+    let syncAndReplaceApis = async (params) => {
 
-        //spread params
-        let { group, apis: rsApis } = params
+        //group
+        let group = get(params, 'group', '')
         // console.log('group', group)
-        // console.log('rsApis', rsApis)
+
+        //check
+        if (!isestr(group)) {
+            console.log('params', params)
+            console.log('group', group)
+            console.log(`invalid group`)
+            return Promise.reject(`invalid group`)
+        }
+
+        //apis
+        let apis = get(params, 'apis', [])
+        // console.log('apis', apis)
+
+        //check
+        if (!isearr(apis)) {
+            console.log('params', params)
+            console.log('apis', apis)
+            console.log(`invalid apis`)
+            return Promise.reject(`invalid apis`)
+        }
 
         //delAll group
         await woItems.apis.delAll({ group })
 
         //insert
-        let r = await woItems.apis.insert(rsApis)
+        let r = await woItems.apis.insert(apis)
 
         return r
     }
@@ -359,9 +447,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) {
@@ -401,8 +498,16 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //verifyUserByToken
-                    let user = await verifyUserByToken(token)
+                    //getTokenUserForSelf
+                    let user = await getTokenUserForSelf(token)
+
+                    //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`)
+                    }
 
                     return user
                 }
@@ -425,8 +530,16 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //verifyUserByToken
-                    await verifyUserByToken(token)
+                    //getTokenUserForSelf
+                    let user = await getTokenUserForSelf(token)
+
+                    //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`)
+                    }
 
                     //getAPIsList
                     let r = await getAPIsList({ isActive: 'y' })
@@ -453,11 +566,19 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //verifyUserByToken
-                    await verifyUserByToken(token)
+                    //getTokenUserForSelf
+                    let user = await getTokenUserForSelf(token)
+
+                    //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`)
+                    }
 
                     //parsePayload
-                    let inp = parsePayload(req)
+                    let inp = await parsePayload(req)
 
                     //updateAPIs
                     let r = await updateAPIs(inp)
@@ -474,9 +595,9 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         },
         {
             method: 'POST',
-            path: '/replaceAPIsByLevels',
+            path: '/syncAndReplaceApis',
             handler: async function (req, res) {
-                // console.log('replaceAPIsByLevels', req)
+                // console.log('syncAndReplaceApis', req)
                 // console.log('payload', req.payload)
 
                 async function core() {
@@ -484,14 +605,22 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //verifyUserByToken
-                    await verifyUserByToken(token)
+                    //getTokenUserForSelf
+                    let user = await getTokenUserForSelf(token)
+
+                    //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`)
+                    }
 
                     //parsePayload
-                    let inp = parsePayload(req)
+                    let inp = await parsePayload(req)
 
-                    //replaceAPIsByLevels
-                    let r = await replaceAPIsByLevels(inp)
+                    //syncAndReplaceApis
+                    let r = await syncAndReplaceApis(inp)
 
                     return r
                 }
@@ -560,7 +689,7 @@ export default WWebApi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Jun 19 2023 08:31:52 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 Thu Nov 02 2023 22:58:48 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 Mon Jun 19 2023 08:31:52 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 Thu Nov 02 2023 22:58:48 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/{g.mDb.mjs → g.backupDb.mjs}

@@ -7,4 +7,4 @@ getDb.backup(woItems)
 
 
 //備份資料重與由備份資料重建資料庫
-//node --experimental-modules --es-module-specifier-resolution=node g.mDb.mjs
+//node --experimental-modules --es-module-specifier-resolution=node g.backupDb.mjs

package/{g.mInitialTestData.mjs → g.initialTestData.mjs}

@@ -17,4 +17,4 @@ initialTestData()
 
 
 //刪除舊檔與重建測試資料庫
-//node --experimental-modules --es-module-specifier-resolution=node g.mInitialTestData.mjs
+//node --experimental-modules --es-module-specifier-resolution=node g.initialTestData.mjs

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "w-web-api",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "main": "dist/w-web-api.umd.js",
   "dependencies": {
     "@mdi/js": "^7.2.96",
     "axios": "^1.3.4",
     "lodash": "^4.17.21",
     "showdown": "^2.1.0",
-    "w-component-vue": "^2.3.0",
+    "w-component-vue": "^2.3.47",
     "w-data-collector": "^1.0.19",
     "w-serv-hapi": "^1.0.11",
     "w-serv-orm": "^1.0.7",
-    "w-ui-loginout": "^1.0.3",
-    "wsemi": "^1.7.12"
+    "w-ui-loginout": "^1.0.4",
+    "wsemi": "^1.7.38"
   },
   "devDependencies": {
     "@vue/cli-plugin-babel": "^5.0.8",
@@ -26,15 +26,10 @@
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^4.1.0",
     "eslint-plugin-vue": "^9.10.0",
-    "sass": "^1.60.0",
-    "sass-loader": "^13.2.2",
     "vue": "^2.6.14",
-    "vue-cli-plugin-vuetify": "^2.5.8",
-    "vuetify": "^2.6.14",
-    "vuetify-loader": "^1.9.2",
     "vuex": "^3.6.2",
     "w-orm-mongodb": "^1.1.29",
-    "w-package-tools": "^1.0.69"
+    "w-package-tools": "^1.0.70"
   },
   "scripts": {
     "serve": "vue-cli-service serve",

package/public/index.html

@@ -10,7 +10,14 @@
         <link href="https://cdn.jsdelivr.net/npm/@mdi/font/css/materialdesignicons.min.css" rel="stylesheet">
 
         <!-- fontawesome -->
-        <link href="https://pro.fontawesome.com/releases/v5.15.4/css/all.css" rel="stylesheet">
+        <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;">