npm - w-web-api - Versions diffs - 1.0.22 → 1.0.24 - Mend

w-web-api 1.0.22 → 1.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/.eslintrc.js +18 -17
package/.github/workflows/ci-test.yml +24 -0
package/.vscode/launch.json +21 -0
package/README.md +21 -4
package/babel.config.js +1 -0
package/dist/css/{chunk-vendors.b4caa718.css → chunk-vendors.ca61ed63.css} +1 -1
package/dist/img/connecting.26511805.svg +10 -0
package/dist/img/deny.e7b81b94.png +0 -0
package/dist/index.tmp +1 -1
package/dist/js/app-legacy.8589a7d0.js +2 -0
package/dist/js/app-legacy.8589a7d0.js.map +1 -0
package/dist/js/app.8589a7d0.js +2 -0
package/dist/js/app.8589a7d0.js.map +1 -0
package/dist/js/chunk-vendors-legacy.4a6f42ee.js +14 -0
package/dist/js/chunk-vendors-legacy.4a6f42ee.js.map +1 -0
package/dist/js/chunk-vendors.4a6f42ee.js +14 -0
package/dist/js/chunk-vendors.4a6f42ee.js.map +1 -0
package/dist/w-web-api.umd.js +2 -2
package/dist/w-web-api.umd.js.map +1 -1
package/docs/WWebApi.html +111 -23
package/docs/WWebApi.mjs.html +152 -30
package/docs/index.html +4 -1
package/docs/scripts/collapse.js +19 -0
package/docs/scripts/commonNav.js +28 -0
package/docs/scripts/search.js +16 -0
package/docs/styles/jsdoc.css +13 -2
package/docs/styles/prettify.css +1 -0
package/g.getSettings.mjs +1 -1
package/package.json +24 -24
package/server/WWebApi.mjs +148 -29
package/src/App.vue +63 -5
package/src/components/Layout.vue +1 -0
package/src/components/LayoutState.vue +87 -0
package/src/main.js +5 -2
package/src/plugins/mUI.mjs +12 -0
package/src/store/mutations.mjs +13 -6
package/srv.mjs +21 -2
package/tableTags-web-api.json +1 -1
package/test/all.test.mjs +10 -0
package/dist/js/app.32beae37.js +0 -2
package/dist/js/app.32beae37.js.map +0 -1
package/dist/js/chunk-vendors.69cb98c3.js +0 -24
package/dist/js/chunk-vendors.69cb98c3.js.map +0 -1
/package/dist/css/{app.5b03c2b6.css → app.e645631b.css} +0 -0

package/docs/WWebApi.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 <nav >
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebApi.html">WWebApi</a></li></ul>
 </nav>
 <div id="main">
@@ -45,7 +48,9 @@
 <header>
         <h2>
-        WWebApi
+            WWebApi
         </h2>
@@ -59,7 +64,7 @@
-    <h4 class="name" id="WWebApi"><span class="type-signature"></span>new WWebApi<span class="signature">(WOrm, url, db, 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, verifyUser, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
@@ -67,11 +72,15 @@
 <dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>基於hapi之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#line78">line 78</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line82">line 82</a>
     </li></ul></dd>
@@ -110,26 +119,20 @@
-<div class="description usertext">
-    <p>基於hapi之API伺服器</p>
-</div>
-    <h5>Example</h5>
+    <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)
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -167,6 +170,7 @@
 <span class="param-type">function</span>
             </td>
@@ -202,6 +206,7 @@
 <span class="param-type">String</span>
             </td>
@@ -237,6 +242,7 @@
 <span class="param-type">String</span>
             </td>
@@ -261,6 +267,78 @@
+        <tr>
+                <td class="name"><code>getUserByToken</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>輸入處理函數，函數會傳入使用者token，通過此函數處理後並回傳使用者資訊物件，並至少須提供'id'、'email'、'name'、'isAdmin'欄位，且'isAdmin'限輸入'y'或'n'，且輸入'y'時會複寫權限系統該使用者之'isAdmin'欄位值</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>verifyUser</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>
         <tr>
                 <td class="name"><code>opt</code></td>
@@ -272,6 +350,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -334,6 +413,7 @@
 <span class="param-type">Integer</span>
             </td>
@@ -364,13 +444,14 @@
         <tr>
-                <td class="name"><code>getUserById</code></td>
+                <td class="name"><code>bCheckUser</code></td>
             <td class="type">
-<span class="param-type">function</span>
+<span class="param-type">Boolean</span>
@@ -391,25 +472,26 @@
                 <td class="default">
-                    <code>null</code>
+                    <code>false</code>
                 </td>
-            <td class="description last"><p>輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null</p></td>
+            <td class="description last"><p>輸入是否檢查使用者資訊布林值，預設false</p></td>
         </tr>
         <tr>
-                <td class="name"><code>bCheckUser</code></td>
+                <td class="name"><code>getUserById</code></td>
             <td class="type">
-<span class="param-type">Boolean</span>
+<span class="param-type">function</span>
@@ -430,12 +512,12 @@
                 <td class="default">
-                    <code>true</code>
+                    <code>null</code>
                 </td>
-            <td class="description last"><p>輸入是否檢查使用者資訊布林值，預設true</p></td>
+            <td class="description last"><p>輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null</p></td>
         </tr>
@@ -451,6 +533,7 @@
 <span class="param-type">Boolean</span>
             </td>
@@ -469,12 +552,12 @@
                 <td class="default">
-                    <code>true</code>
+                    <code>false</code>
                 </td>
-            <td class="description last"><p>輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true</p></td>
+            <td class="description last"><p>輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設false</p></td>
         </tr>
@@ -490,6 +573,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -529,6 +613,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -568,6 +653,7 @@
 <span class="param-type">String</span>
             </td>
@@ -607,6 +693,7 @@
 <span class="param-type">String</span>
             </td>
@@ -659,7 +746,7 @@
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -677,6 +764,7 @@
 <span class="param-type">Object</span>
     </dd>
 </dl>
@@ -721,7 +809,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Jan 23 2023 21:06:06 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 Sun Jun 18 2023 18:26:06 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 <nav >
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebApi.html">WWebApi</a></li></ul>
 </nav>
 <div id="main">
@@ -54,17 +57,19 @@ import iseobj from 'wsemi/src/iseobj.mjs'
 import isestr from 'wsemi/src/isestr.mjs'
 import ispint from 'wsemi/src/ispint.mjs'
 import isfun from 'wsemi/src/isfun.mjs'
+import ispm from 'wsemi/src/ispm.mjs'
 import cint from 'wsemi/src/cint.mjs'
 import strleft from 'wsemi/src/strleft.mjs'
 import strdelleft from 'wsemi/src/strdelleft.mjs'
 import strright from 'wsemi/src/strright.mjs'
 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 replace from 'wsemi/src/replace.mjs'
 import WServHapiServer from 'w-serv-hapi/src/WServHapiServer.mjs'
-import ds from '../src/schema/index.mjs'
 import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
+import ds from '../src/schema/index.mjs'
 /**
@@ -74,11 +79,13 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * @param {Function} WOrm 輸入資料庫ORM函數
  * @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 {Object} [opt={}] 輸入設定物件，預設{}
  * @param {Integer} [opt.serverPort=11005] 輸入伺服器通訊port，預設11005
+ * @param {Boolean} [opt.bCheckUser=false] 輸入是否檢查使用者資訊布林值，預設false
  * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
- * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
- * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
+ * @param {Boolean} [opt.bExcludeWhenNotAdmin=false] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設false
  * @param {Object} [opt.webName={}] 輸入站台名稱物件，至少包含語系eng與cht鍵的名稱，預設{}
  * @param {Object} [opt.webDescription={}] 輸入站台描述物件，至少包含語系eng與cht鍵的名稱，預設{}
  * @param {String} [opt.webLogo=''] 輸入站台logo字串，採base64格式，預設''
@@ -119,7 +126,7 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * })
  *
  */
-function WWebApi(WOrm, url, db, opt = {}) {
+function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     let instWServHapiServer = null
@@ -144,6 +151,20 @@ function WWebApi(WOrm, url, db, opt = {}) {
     }
+    //check getUserByToken
+    if (!isfun(getUserByToken)) {
+        console.log('invalid getUserByToken', getUserByToken)
+        throw new Error('invalid getUserByToken')
+    }
+    //check verifyUser
+    if (!isfun(verifyUser)) {
+        console.log('invalid verifyUser', verifyUser)
+        throw new Error('invalid verifyUser')
+    }
     //serverPort
     let serverPort = get(opt, 'serverPort')
     if (!ispint(serverPort)) {
@@ -214,9 +235,35 @@ function WWebApi(WOrm, url, db, opt = {}) {
     }
+    //verifyUserByToken
+    let verifyUserByToken = async (token) => {
+        //getUserByToken
+        let user = getUserByToken(token)
+        if (ispm(user)) {
+            user = await user
+        }
+        if (!iseobj(user)) {
+            return Promise.reject(`token does not have permission`)
+        }
+        //verifyUser
+        let b = verifyUser(user)
+        if (ispm(b)) {
+            b = await b
+        }
+        //check
+        if (!b) {
+            return Promise.reject(`user does not have permission`)
+        }
+        return user
+    }
     //getAPIsList
-    let getAPIsList = async (userId, token) => {
-        let rs = await woItems.apis.select()
+    let getAPIsList = async (query = {}) => {
+        let rs = await woItems.apis.select(query)
         return rs
     }
@@ -266,7 +313,7 @@ function WWebApi(WOrm, url, db, opt = {}) {
     //updateAPIs
-    let updateAPIs = async (userId, params = {}) => {
+    let updateAPIs = async (params = {}) => {
         //spread params
         let { apis: rsApis } = params
@@ -281,7 +328,7 @@ function WWebApi(WOrm, url, db, opt = {}) {
     //replaceAPIsByLevels
-    let replaceAPIsByLevels = async (userId, params = {}) => {
+    let replaceAPIsByLevels = async (params = {}) => {
         //spread params
         let { group, apis: rsApis } = params
@@ -310,11 +357,17 @@ function WWebApi(WOrm, url, db, opt = {}) {
     //subfolder
     let fnEntryIn = 'index.tmp'
     let fnEntryOut = 'index.html'
-    let fpEntryIn = path.resolve(pathStaticFiles, fnEntryIn)
-    let fpEntryOut = path.resolve(pathStaticFiles, fnEntryOut)
-    let c = fs.readFileSync(fpEntryIn, 'utf8')
-    c = replace(c, '{sfd}', subfolder)
-    fs.writeFileSync(fpEntryOut, c, 'utf8')
+    try {
+        let fpEntryIn = path.resolve(pathStaticFiles, fnEntryIn)
+        let fpEntryOut = path.resolve(pathStaticFiles, fnEntryOut)
+        let c = fs.readFileSync(fpEntryIn, 'utf8')
+        c = replace(c, '{sfd}', subfolder)
+        fs.writeFileSync(fpEntryOut, c, 'utf8')
+    }
+    catch (err) {
+        console.log(err)
+        console.log(`can not generate ${fnEntryOut}`)
+    }
     //apis
@@ -337,16 +390,53 @@ function WWebApi(WOrm, url, db, opt = {}) {
                 return getWebInfor()
             },
         },
+        {
+            method: 'GET',
+            path: '/api/getUserByToken', //未登入界面需先檢測token是否為系統管理員, 確認後回傳為系統管理員資訊物件
+            handler: async function (req, res) {
+                // console.log('getUserByToken', req)
+                async function core() {
+                    //token
+                    let token = get(req, 'query.token', '')
+                    //verifyUserByToken
+                    let user = await verifyUserByToken(token)
+                    return user
+                }
+                //pm2resolve core
+                let r = await pm2resolve(core)()
+                // console.log('verifyIdentity', r)
+                return r
+            },
+        },
         {
             method: 'GET',
             path: '/getAPIsList',
             handler: async function (req, res) {
+                // console.log('getAPIsList', req)
+                async function core() {
+                    //token
+                    let token = get(req, 'query.token', '')
-                //token
-                let token = get(req, 'query.token', '')
+                    //verifyUserByToken
+                    await verifyUserByToken(token)
-                //getAPIsList
-                let r = await getAPIsList('', token)
+                    //getAPIsList
+                    let r = await getAPIsList({ isActive: 'y' })
+                    return r
+                }
+                //pm2resolve core
+                let r = await pm2resolve(core)()
+                // console.log('verifyIdentity', r)
                 return r
             },
@@ -355,14 +445,29 @@ function WWebApi(WOrm, url, db, opt = {}) {
             method: 'POST',
             path: '/updateAPIs',
             handler: async function (req, res) {
-                // console.log(req, res)
+                // console.log('updateAPIs', req)
                 // console.log('payload', req.payload)
-                //parsePayload
-                let inp = parsePayload(req)
+                async function core() {
+                    //token
+                    let token = get(req, 'query.token', '')
+                    //verifyUserByToken
+                    await verifyUserByToken(token)
+                    //parsePayload
+                    let inp = parsePayload(req)
+                    //updateAPIs
+                    let r = await updateAPIs(inp)
+                    return r
+                }
-                //updateAPIs
-                let r = await updateAPIs('', inp)
+                //pm2resolve core
+                let r = await pm2resolve(core)()
+                // console.log('verifyIdentity', r)
                 return r
             },
@@ -371,14 +476,29 @@ function WWebApi(WOrm, url, db, opt = {}) {
             method: 'POST',
             path: '/replaceAPIsByLevels',
             handler: async function (req, res) {
-                // console.log(req, res)
+                // console.log('replaceAPIsByLevels', req)
                 // console.log('payload', req.payload)
-                //parsePayload
-                let inp = parsePayload(req)
+                async function core() {
-                //replaceAPIsByLevels
-                let r = await replaceAPIsByLevels('', inp)
+                    //token
+                    let token = get(req, 'query.token', '')
+                    //verifyUserByToken
+                    await verifyUserByToken(token)
+                    //parsePayload
+                    let inp = parsePayload(req)
+                    //replaceAPIsByLevels
+                    let r = await replaceAPIsByLevels(inp)
+                    return r
+                }
+                //pm2resolve core
+                let r = await pm2resolve(core)()
+                // console.log('verifyIdentity', r)
                 return r
             },
@@ -400,7 +520,7 @@ function WWebApi(WOrm, url, db, opt = {}) {
         pathStaticFiles,
         apis,
         getUserIDFromToken: async (token) => { //可使用async或sync函數
-            return 'id-for-admin'
+            return ''
         },
         useDbORM: true,
         dbORMs: woItems,
@@ -410,7 +530,9 @@ function WWebApi(WOrm, url, db, opt = {}) {
         tableNamesSync,
         extFuncs: { //接收參數第1個為userId, 之後才是前端給予參數
             getWebInfor,
-            getAPIsList,
+            getAPIsList: (userId, query = {}) => {
+                return getAPIsList(query)
+            },
             //...
         },
         hookBefores: null,
@@ -438,7 +560,7 @@ export default WWebApi
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Jan 23 2023 21:06:06 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 Sun Jun 18 2023 18:26:06 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/index.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 <nav >
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebApi.html">WWebApi</a></li></ul>
 </nav>
 <div id="main">
@@ -68,7 +71,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Jan 23 2023 21:06:06 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 Sun Jun 18 2023 18:26:06 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>