npm - w-web-perm - Versions diffs - 1.0.0 - Mend

w-web-perm 1.0.0

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 (101) hide show

package/.editorconfig +9 -0
package/.eslintignore +3 -0
package/.eslintrc.js +55 -0
package/.github/workflows/ci-test.yml +24 -0
package/.jsdoc +25 -0
package/.vscode/launch.json +21 -0
package/LICENSE +21 -0
package/README.md +24 -0
package/SECURITY.md +5 -0
package/babel.config.js +15 -0
package/dist/css/app.79b4b59b.css +1 -0
package/dist/css/chunk-vendors.65775501.css +5 -0
package/dist/index.tmp +1 -0
package/dist/js/app-legacy.954e168c.js +2 -0
package/dist/js/app-legacy.954e168c.js.map +1 -0
package/dist/js/app.954e168c.js +2 -0
package/dist/js/app.954e168c.js.map +1 -0
package/dist/js/chunk-vendors-legacy.f5f1a231.js +13 -0
package/dist/js/chunk-vendors-legacy.f5f1a231.js.map +1 -0
package/dist/js/chunk-vendors.f5f1a231.js +13 -0
package/dist/js/chunk-vendors.f5f1a231.js.map +1 -0
package/dist/w-web-perm.umd.js +7 -0
package/dist/w-web-perm.umd.js.map +1 -0
package/docs/WWebPerm.html +826 -0
package/docs/WWebPerm.mjs.html +558 -0
package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/index.html +84 -0
package/docs/scripts/collapse.js +39 -0
package/docs/scripts/commonNav.js +28 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/nav.js +12 -0
package/docs/scripts/polyfill.js +4 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/scripts/prettify/prettify.js +28 -0
package/docs/scripts/search.js +99 -0
package/docs/styles/jsdoc.css +776 -0
package/docs/styles/prettify.css +80 -0
package/g.getSettings.mjs +17 -0
package/g.mDb.mjs +10 -0
package/g.mInitialTestData.mjs +20 -0
package/g.mOrm.mjs +24 -0
package/package.json +75 -0
package/public/index.html +23 -0
package/server/WWebPerm.mjs +486 -0
package/src/App.vue +153 -0
package/src/components/Common/CheckYes.vue +85 -0
package/src/components/Common/CheckYesNo.vue +91 -0
package/src/components/Common/LabelItem.vue +106 -0
package/src/components/Common/LoadingWinBar.vue +87 -0
package/src/components/Layout.vue +152 -0
package/src/components/LayoutContent.vue +246 -0
package/src/components/LayoutContentGroups.vue +664 -0
package/src/components/LayoutContentTargets.vue +538 -0
package/src/components/LayoutContentUsers.vue +493 -0
package/src/components/LayoutState.vue +91 -0
package/src/components/VeUser.vue +453 -0
package/src/components/ruleGroup.vue +667 -0
package/src/main.js +103 -0
package/src/perm.mjs +61 -0
package/src/plugins/mDataSelectorSchema.mjs +30 -0
package/src/plugins/mDataSupport.mjs +66 -0
package/src/plugins/mShare.mjs +366 -0
package/src/plugins/mUI.mjs +229 -0
package/src/plugins/mVuetify.mjs +12 -0
package/src/schema/gi.mjs +8 -0
package/src/schema/index.mjs +20 -0
package/src/schema/tables/ruleGroups.mjs +100 -0
package/src/schema/tables/targets.mjs +100 -0
package/src/schema/tables/users.mjs +125 -0
package/src/store/actions.mjs +1 -0
package/src/store/getters.mjs +1 -0
package/src/store/index.mjs +25 -0
package/src/store/mutations.mjs +201 -0
package/src/store/types.mjs +15 -0
package/srv.mjs +52 -0
package/tableTags-web-perm.json +1 -0
package/test/all.test.mjs +10 -0
package/toolg/addVersion.mjs +4 -0
package/toolg/cleanFolder.mjs +4 -0
package/toolg/gDistRollup.mjs +36 -0
package/toolg/genEntry.mjs +23 -0
package/toolg/modifyReadme.mjs +4 -0
package/vue.config.js +15 -0

package/docs/WWebPerm.mjs.html ADDED Viewed

@@ -0,0 +1,558 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>WWebPerm.mjs - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <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>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav >
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebPerm.html">WWebPerm</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">WWebPerm.mjs</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import path from 'path'
+import fs from 'fs'
+import get from 'lodash/get'
+import keys from 'lodash/keys'
+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 strright from 'wsemi/src/strright.mjs'
+import strdelright from 'wsemi/src/strdelright.mjs'
+import pm2resolve from 'wsemi/src/pm2resolve.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 WServOrm from 'w-serv-orm/src/WServOrm.mjs'
+import ds from '../src/schema/index.mjs'
+import { getUserRules } from '../src/plugins/mShare.mjs'
+/**
+ * 基於hapi之API伺服器
+ *
+ * @class
+ * @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 {Object} [opt={}] 輸入設定物件，預設{}
+ * @param {Integer} [opt.serverPort=11006] 輸入伺服器通訊port，預設11006
+ * @param {Boolean} [opt.bCheckUser=false] 輸入是否檢查使用者資訊布林值，預設false
+ * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
+ * @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格式，預設''
+ * @param {String} [opt.subfolder=''] 輸入站台所在子目錄字串，提供站台位於內網採反向代理進行服務時，故需支援位於子目錄情形，預設''
+ * @param {String} [opt.mappingBy='email'] 輸入外部系統識別使用者token後所提供之資料物件，與權限系統之使用者資料物件，兩者間查找之對應欄位，可選'id'、'email'、'name'，預設'email'
+ * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
+ * @example
+ */
+function WWebPerm(WOrm, url, db, getUserByToken, opt = {}) {
+    let instWServHapiServer = null
+    //check WOrm
+    if (!isfun(WOrm)) {
+        console.log('invalid WOrm', WOrm)
+        throw new Error('invalid WOrm')
+    }
+    //check url
+    if (!isestr(url)) {
+        console.log('invalid url', url)
+        throw new Error('invalid url')
+    }
+    //check db
+    if (!isestr(db)) {
+        console.log('invalid db', db)
+        throw new Error('invalid db')
+    }
+    //check getUserByToken
+    if (!isfun(getUserByToken)) {
+        console.log('invalid getUserByToken', getUserByToken)
+        throw new Error('invalid getUserByToken')
+    }
+    //serverPort
+    let serverPort = get(opt, 'serverPort')
+    if (!ispint(serverPort)) {
+        serverPort = 11006
+    }
+    serverPort = cint(serverPort)
+    //bCheckUser
+    let bCheckUser = get(opt, 'bCheckUser', false)
+    //getUserById
+    let getUserById = get(opt, 'getUserById', null)
+    //bExcludeWhenNotAdmin
+    let bExcludeWhenNotAdmin = get(opt, 'bExcludeWhenNotAdmin', false)
+    //webName
+    let webName = get(opt, 'webName', {})
+    //webDescription
+    let webDescription = get(opt, 'webDescription', {})
+    //webLogo
+    let webLogo = get(opt, 'webLogo', '')
+    //subfolder
+    let subfolder = get(opt, 'subfolder', '')
+    if (isestr(subfolder)) {
+        if (strright(subfolder, 1) === '/') { //右邊不需要給「/」
+            subfolder = strdelright(subfolder, 1)
+        }
+        if (strleft(subfolder, 1) !== '/') { //左邊需要給「/」
+            subfolder = `/${subfolder}`
+        }
+    }
+    //mappingBy
+    let mappingBy = get(opt, 'mappingBy', '')
+    if (mappingBy !== 'id' &amp;&amp; mappingBy !== 'email' &amp;&amp; mappingBy !== 'name') {
+        mappingBy = 'email'
+    }
+    //WServOrm
+    let optWServOrm = {
+        bCheckUser,
+        getUserById,
+        bExcludeWhenNotAdmin,
+    }
+    let wp = {}
+    try {
+        wp = WServOrm(ds, WOrm, url, db, optWServOrm)
+    }
+    catch (err) {
+        console.log(err)
+    }
+    let { woItems, procOrm } = wp
+    //getWebInfor
+    let getWebInfor = (userId) => {
+        return {
+            webName,
+            webDescription,
+            webLogo,
+        }
+    }
+    //getUsersList
+    let getUsersList = async (userId, token) => {
+        let rs = await woItems.users.select() //isActive為y或n都需要提供, 給前端編輯
+        return rs
+    }
+    //getRuleGroupsList
+    let getRuleGroupsList = async (userId, token) => {
+        let rs = await woItems.ruleGroups.select()
+        return rs
+    }
+    //getTargetsList
+    let getTargetsList = async (userId, token) => {
+        let rs = await woItems.targets.select()
+        return rs
+    }
+    //parseToken
+    let parseToken = (req) => {
+        //token
+        let token = get(req, 'query.token', '')
+        // console.log('token', token)
+        return token
+    }
+    //getTokenUserForSelf
+    let getTokenUserForSelf = async(token) => {
+        //userSelf
+        let userSelf = null
+        if (isestr(token)) {
+            userSelf = getUserByToken(token)
+            if (ispm(userSelf)) {
+                userSelf = await userSelf
+            }
+        }
+        // console.log('userSelf', userSelf)
+        //check
+        if (!iseobj(userSelf)) {
+            console.log('invalid userSelf')
+            return null
+        }
+        //check userSelf
+        if (true) {
+            let id = get(userSelf, 'id', '')
+            if (!isestr(id)) {
+                console.log('invalid userSelf.id')
+                return null
+            }
+            let email = get(userSelf, 'email', '')
+            if (!isestr(email)) {
+                console.log('invalid userSelf.email')
+                return null
+            }
+            let name = get(userSelf, 'name', '')
+            if (!isestr(name)) {
+                console.log('invalid userSelf.name')
+                return null
+            }
+            let isAdmin = get(userSelf, 'isAdmin', '')
+            if (isAdmin !== 'y' &amp;&amp; isAdmin !== 'n') {
+                console.log('userSelf.isAdmin is not y or n')
+                return null
+            }
+        }
+        //須反查perm內users, 提供正規化屬性
+        let vSelf = get(userSelf, mappingBy, '')
+        // console.log('vSelf', vSelf)
+        //check
+        if (!isestr(vSelf)) {
+            console.log('invalid vSelf')
+            return null
+        }
+        //userFind
+        let userFind = await woItems.users.select({ [mappingBy]: vSelf, isActive: 'y' })
+        userFind = get(userFind, 0, null)
+        console.log('userFind', userFind)
+        //複寫isAdmin
+        let isAdminSrc = get(userSelf, 'isAdmin', '')
+        let isAdminSelf = get(userFind, 'isAdmin', '')
+        if (isAdminSrc !== isAdminSelf) {
+            userFind.isAdmin = isAdminSelf
+        }
+        console.log('userFind(isAdmin)', userFind)
+        return userFind
+    }
+    //getGenUserByKV
+    let getGenUserByKV = async(keyUser, valueUser) => {
+        //userFind
+        let userFind = await woItems.users.select({ [keyUser]: valueUser, isActive: 'y' })
+        userFind = get(userFind, 0, null)
+        //check
+        if (!iseobj(userFind)) {
+            return null
+        }
+        return userFind
+    }
+    //getGenUserByUserId
+    let getGenUserByUserId = async(userId) => {
+        //userFind
+        let userFind = await getGenUserByKV('id', userId)
+        //check
+        if (!iseobj(userFind)) {
+            return null
+        }
+        return userFind
+    }
+    //getGenUserAndRulesByUserId
+    let getGenUserAndRulesByUserId = async (userId) => {
+        //userFind
+        let userFind = await getGenUserByUserId(userId)
+        // console.log('userFind', userFind)
+        //ruleGroups
+        let ruleGroups = await woItems.ruleGroups.select({})
+        // console.log('ruleGroups', ruleGroups)
+        //targets
+        let targets = await woItems.targets.select()
+        // console.log('targets', targets)
+        //getUserRules
+        let urs = getUserRules(userFind, ruleGroups, targets)
+        // console.log('getUserRules', urs)
+        //check
+        if (!iseobj(urs)) {
+            console.log('can not get permrules', userId)
+            return Promise.reject(`can not get permrules`)
+        }
+        return {
+            user: userFind,
+            roles: urs,
+        }
+    }
+    //pathStaticFiles
+    let pathStaticFiles = 'dist'
+    let npmPathStaticFiles = './node_modules/w-web-perm/dist'
+    if (fsIsFolder(npmPathStaticFiles)) {
+        pathStaticFiles = npmPathStaticFiles
+    }
+    // console.log('pathStaticFiles', pathStaticFiles)
+    //subfolder
+    let fnEntryIn = 'index.tmp'
+    let fnEntryOut = 'index.html'
+    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
+    let apis = [
+        // {
+        //     method: 'GET',
+        //     path: '/api/someAPI',
+        //     handler: async function (req, res) {
+        //         // //token
+        //         // let token = get(req, 'query.token', '')
+        //         return 'someAPI'
+        //     },
+        // },
+        {
+            method: 'GET',
+            path: '/getWebInfor',
+            handler: async function (req, res) {
+                return getWebInfor()
+            },
+        },
+        {
+            method: 'GET',
+            path: '/api/getUserByToken', //未登入界面需先檢測token是否為系統管理員, 確認後回傳為系統管理員資訊物件, getUserByToken為w-ui-loginout預設值, 若要更改兩邊須同時修改
+            handler: async function (req, res) {
+                // console.log('verifyIdentity', req)
+                async function core() {
+                    //token
+                    let token = get(req, 'query.token', '')
+                    // console.log('token', token)
+                    //getGenUserByUserId
+                    let userSelf = await getTokenUserForSelf(token)
+                    // console.log('userSelf', userSelf)
+                    //check
+                    if (get(userSelf, 'isAdmin') !== 'y') { //界面須系統管理員才能使用
+                        return Promise.reject(`user does not have permission`)
+                    }
+                    return userSelf
+                }
+                //pm2resolve core
+                let r = await pm2resolve(core)() //w-ui-loginout接收已預設格式用pm2resolve轉過, 會提取state進行判斷
+                // console.log('getUserByToken', r)
+                return r
+            },
+        },
+        {
+            method: 'GET',
+            path: '/api/getPerm', //外部系統呼叫會須先檢測token是否有效, 再依照token所代表的使用者userId提供權限資訊物件
+            handler: async function (req, res) {
+                // console.log('getPerm', req)
+                async function core() {
+                    //parseToken
+                    let token = parseToken(req)
+                    // console.log('token', token)
+                    //getGenUserByUserId
+                    let userLogin = await getTokenUserForSelf(token)
+                    // console.log('userLogin', userLogin)
+                    //check
+                    if (!iseobj(userLogin)) {
+                        return Promise.reject(`user does not have permission`)
+                    }
+                    //parseUserId
+                    let userId = get(userLogin, 'id', '')
+                    // console.log('userId', userId)
+                    //check
+                    if (!isestr(userId)) {
+                        return Promise.reject(`invalid user`)
+                    }
+                    //getGenUserAndRulesByUserId
+                    let r = await getGenUserAndRulesByUserId(userId)
+                    // console.log('getGenUserAndRulesByUserId', r)
+                    //check
+                    if (!iseobj(r)) {
+                        return Promise.reject(`user does not have permrules`)
+                    }
+                    return r
+                }
+                //pm2resolve core
+                let r = await pm2resolve(core)()
+                // console.log('getPerm r', r)
+                return r
+            },
+        },
+    ]
+    //tableNamesExec, tableNamesSync
+    let tableNamesExec = keys(ds)
+    // let tableNamesSync = filter(tableNamesExec, (v) => {
+    //     return strright(v, 5) !== 'Items'//不同步數據
+    // })
+    let tableNamesSync = tableNamesExec
+    //WServHapiServer
+    instWServHapiServer = new WServHapiServer({
+        port: opt.serverPort,
+        pathStaticFiles,
+        apis,
+        getUserIDFromToken: async (token) => { //可使用async或sync函數
+            return ''
+        },
+        useDbORM: true,
+        dbORMs: woItems,
+        operORM: procOrm, //procOrm的輸入為: userId, tableName, methodName, input
+        tableNamesExec,
+        methodsExec: ['select', 'insert', 'save', 'del', 'delAll'], //mix需於procOrm內註冊以提供
+        tableNamesSync,
+        extFuncs: { //接收參數第1個為userId, 之後才是前端給予參數
+            getWebInfor,
+            getUsersList,
+            getRuleGroupsList,
+            getTargetsList,
+            //...
+        },
+        hookBefores: null,
+        hookAfters: null,
+        fnTableTags: 'tableTags-web-perm.json',
+    })
+    return instWServHapiServer
+}
+export default WWebPerm
+</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Jul 19 2023 12:50:03 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>