w-web-api 1.0.28 → 1.0.30

package/server/WWebApi.mjs

@@ -1,13 +1,12 @@
 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'
@@ -19,6 +18,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'
@@ -26,7 +26,7 @@ import ds from '../src/schema/index.mjs'
 
 
 /**
- * 基於hapi之API伺服器
+ * API伺服器
  *
  * @class
  * @param {Function} WOrm 輸入資料庫ORM函數
@@ -43,12 +43,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()
@@ -57,22 +57,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)
@@ -162,6 +195,10 @@ function WWebApi(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
+    //urlRedirect
+    let urlRedirect = get(opt, 'urlRedirect', '')
+
+
     //WServOrm
     let optWServOrm = {
         bCheckUser,
@@ -188,32 +225,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)
@@ -222,7 +266,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
@@ -230,37 +276,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
     }
 
@@ -280,19 +349,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
     }
@@ -312,9 +400,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) {
@@ -354,8 +451,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
                 }
@@ -378,8 +483,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' })
@@ -406,11 +519,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)
@@ -427,9 +548,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() {
@@ -437,14 +558,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
                 }

package/server/provideApis.mjs

@@ -4,8 +4,8 @@ import genPm from 'wsemi/src/genPm.mjs'
 
 
 async function provideApis(url, group, apis) {
-    //url: 指API伺服器提供的接入網址, 例如 http://localhost:11005/replaceAPIsByLevels
-    //group: 指API所屬群組, 主要呼叫replaceAPIsByLevels為主
+    //url: 指API伺服器提供的接入網址, 例如 http://localhost:11005/syncAndReplaceApis
+    //group: 指API所屬群組
 
     //pm
     let pm = genPm()

package/src/App.vue

@@ -16,6 +16,8 @@
 <script>
 import get from 'lodash/get'
 import cloneDeep from 'lodash/cloneDeep'
+import isestr from 'wsemi/src/isestr.mjs'
+import isDev from 'wsemi/src/isDev.mjs'
 import wui from 'w-ui-loginout/src/WUiLoginout.mjs'
 import Layout from './components/Layout.vue'
 import LayoutState from './components/LayoutState.vue'
@@ -50,12 +52,25 @@ export default {
             console.log('login error', cloneDeep(data))
             vo.$ui.updateConnState(data.text)
             vo.$ui.updateUserToken('')
-            vo.$ui.updateUserSelf(get(vo, `$store.state.userDef`))
+            let urlRedirect = get(window, '___pmwapi___.urlRedirect', '')
+            if (!isestr(urlRedirect)) {
+                console.log('urlRedirect', urlRedirect)
+                throw new Error(`invalid urlRedirect`)
+            }
+            if (isDev()) {
+                console.log('60s redirect to:', urlRedirect)
+                setTimeout(() => {
+                    window.location.href = urlRedirect
+                }, 60 * 1000)
+            }
+            else {
+                window.location.href = urlRedirect
+            }
         }
 
         //login
         console.log('login...')
-        let ll = wui('wperm', {
+        let ll = wui('wapi', {
             timeWaitAnimation: 2000,
             params: {},
         })
@@ -110,14 +125,6 @@ button {
     font-family: inherit;
 }
 
-.v-application, .v-application--wrap {
-    font-family: inherit;
-}
-
-.v-chip {
-    cursor: inherit;
-}
-
 .fade-enter-active {
   animation: go 1s;
 }

package/src/components/LayoutContent.vue

@@ -8,21 +8,20 @@
 
         <template v-if="syncState">
 
-            <!-- menu left, 使用opacity:0.999讓WDrawer使用浮動模式時不會遮蔽vuetify彈窗, 僅由Layout處設定即可, 其內dom皆受影響 -->
             <WDrawer
-                :style="`height:${panelHeight}px; width:100%; opacity:0.999;`"
+                :style="`height:${panelHeight}px; width:100%;`"
                 v-model="drawer"
                 :drawerWidth.sync="drawerWidth"
                 :drawerWidthMin="drawerWidthMin"
                 :drawerWidthMax="drawerWidthMax"
                 :mode="'from-left'"
-                :afloat="drawerAfloat"
                 :dragDrawerWidth="true"
+                :autoSwitch="true"
+                :switchWidth="drawerWidth*2.3"
             >
 
                 <template v-slot:drawer="props">
-
-                    <div :style="`height:${props.height}px; background:${drawerAfloat?'#fff':'transparent'}; position:relative;`">
+                    <div :style="`height:${props.height}px; background:#fff; position:relative;`">
 
                         <WTree
                             :style="`height:${props.height}px;`"
@@ -87,7 +86,6 @@
                         </div>
 
                     </div>
-
                 </template>
 
                 <template v-slot:content="props">
@@ -327,7 +325,10 @@
 
                                             <div style="border:1px solid #ddd; background:#fff">
 
-                                                <div style="" v-if="optputMenuItemSelectId==='tree'">
+                                                <div
+                                                    style="padding:10px 15px;"
+                                                    v-if="optputMenuItemSelectId==='tree'"
+                                                >
                                                     <WJsonView
                                                         style="width:100%;"
                                                         :viewHeightMax="null"
@@ -335,8 +336,11 @@
                                                     ></WJsonView>
                                                 </div>
 
-                                                <div style="padding:10px; color:#555; font-size:0.85rem;" v-if="optputMenuItemSelectId==='raw'">
-                                                    <pre>{{getOutputJson(apiSelect)}}</pre>
+                                                <div
+                                                    style="padding:15px; color:#555; font-size:0.85rem;"
+                                                    v-if="optputMenuItemSelectId==='raw'
+                                                ">
+                                                    <pre style="margin:0px; padding:0px;">{{getOutputJson(apiSelect)}}</pre>
                                                 </div>
 
                                             </div>
@@ -430,11 +434,9 @@ export default {
         return {
 
             panelWidth: 0,
-            panelWidthTemp: 0,
             panelHeight: 0,
 
             drawer: true,
-            drawerAfloat: false,
             drawerWidth: 320,
             drawerWidthMin: 200,
             drawerWidthMax: 700,
@@ -512,30 +514,6 @@ export default {
             vo.panelHeight = msg.snew.clientHeight
             // console.log('vo.panelHeight', vo.panelHeight)
 
-            //modeResize
-            let modeResize = '' //寬度可能相同故得有預設空字串的種類
-            if (vo.panelWidth > vo.panelWidthTemp) {
-                modeResize = 'toLarge'
-            }
-            else if (vo.panelWidth < vo.panelWidthTemp) {
-                modeResize = 'toSmall'
-            }
-            // console.log('modeResize', modeResize, vo.panelWidth, vo.panelWidthTemp)
-
-            //drawer
-            if (vo.drawer && modeResize === 'toSmall' && vo.panelWidth < 1.7 * vo.drawerWidthMax) { //已開啟抽屜且為變窄時才偵測
-                vo.drawer = false
-            }
-            else if (!vo.drawer && modeResize === 'toLarge' && vo.panelWidth >= 1.7 * vo.drawerWidthMax) { //已隱藏抽屜且為變寬時才偵測
-                vo.drawer = true
-            }
-
-            //drawerAfloat
-            vo.drawerAfloat = vo.panelWidth < 1.7 * vo.drawerWidthMax
-
-            //save
-            vo.panelWidthTemp = vo.panelWidth
-
         },
 
         genTree: function () {
@@ -574,6 +552,8 @@ export default {
             let tree = convertToTree(tr, { bindRoot: '全部' })
             // console.log('tree', cloneDeep(tree))
 
+            //filepathToTree
+
             //apiSelect, 預先選定api項目, 非tree選單active物件, 因id由convertToTree轉換提供, 故不能直接算得active選單物件id
             let apiSelect = get(apis, 0, null)
             // console.log('apiSelect', cloneDeep(apiSelect))

package/src/main.js

@@ -11,7 +11,6 @@ import domResize from 'w-component-vue/src/js/domResize.mjs'
 import domDragDrop from 'w-component-vue/src/js/domDragDrop.mjs'
 import App from './App.vue'
 import store from './store/index.mjs'
-import mVuetify from './plugins/mVuetify.mjs'
 import ui from './plugins/mUI.mjs'
 import mDataSelectorSchema from './plugins/mDataSelectorSchema.mjs'
 import mDataSupport from './plugins/mDataSupport.mjs'
@@ -96,7 +95,6 @@ WServHapiClient({
 
 //new
 new Vue({
-    vuetify: mVuetify,
     store,
     render: h => h(App)
 }).$mount('#app')

package/src/store/mutations.mjs

@@ -1,20 +1,9 @@
 import each from 'lodash/each'
 import set from 'lodash/set'
-import cloneDeep from 'lodash/cloneDeep'
 import * as types from './types.mjs'
 import ds from '../schema/index.mjs'
 
 
-//userDef
-let userDef = {
-    id: '', //id-for-admin
-    name: '', //測試者
-    email: '', //id-for-admin@gmail.com
-    // isVirtual: 'n',
-    isAdmin: 'n',
-    // isActive: 'n',
-}
-
 //state, 全域狀態
 let state = {
 
@@ -35,8 +24,12 @@ let state = {
     menu: {}, //初始值需為物件, 否則LayoutContent會取menu.key出錯
 
     userToken: '',
-    userDef: cloneDeep(userDef),
-    userSelf: cloneDeep(userDef),
+    user: {
+        id: '', //id-for-admin
+        name: '', //測試者
+        email: '', //admin@example.com
+        isAdmin: 'n',
+    },
 
     lang: 'cht',
     keyLangs: {