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

@@ -0,0 +1,335 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>WWebApi.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="WWebApi.html">WWebApi</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">WWebApi.mjs</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import get from 'lodash/get'
+import map from 'lodash/map'
+import keys from 'lodash/keys'
+import cloneDeep from 'lodash/cloneDeep'
+import j2o from 'wsemi/src/j2o.mjs'
+import iseobj from 'wsemi/src/iseobj'
+import isestr from 'wsemi/src/isestr'
+import ispint from 'wsemi/src/ispint'
+import fsIsFolder from 'wsemi/src/fsIsFolder'
+import cint from 'wsemi/src/cint'
+import WServHapiServer from 'w-serv-hapi/src/WServHapiServer.mjs'
+import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs'
+import ds from '../src/schema/index.mjs'
+import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
+/**
+ * 基於hapi之API伺服器
+ *
+ * @class
+ * @param {Object} [opt={}] 輸入設定物件，預設{}
+ * @param {String} [opt.url=''] 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
+ * @param {String} [opt.db=''] 輸入資料庫名稱字串，預設''
+ * @param {Integer} [opt.serverPort=8080] 輸入伺服器通訊port，預設8080
+ * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
+ * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
+ * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
+ * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
+ * @example
+ *
+ *
+ */
+async function WWebApi(st = {}) {
+    //url
+    let url = get(st, 'url')
+    if (!isestr(url)) {
+        console.log('invalid url', url)
+        throw new Error('invalid url')
+    }
+    //db
+    let db = get(st, 'db')
+    if (!isestr(db)) {
+        console.log('invalid db', db)
+        throw new Error('invalid db')
+    }
+    //serverPort
+    let serverPort = get(st, 'serverPort')
+    if (!ispint(serverPort)) {
+        console.log('invalid serverPort', serverPort)
+        throw new Error('invalid serverPort')
+    }
+    serverPort = cint(serverPort)
+    //WServOrm
+    let opt = {
+        // url: `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`,
+        // db: st.dbName,
+        // getUserById: null,
+        // bCheckUser: false,
+        // bExcludeWhenNotAdmin: false,
+        url,
+        db,
+        getUserById: get(st, 'getUserById', null),
+        bCheckUser: get(st, 'bCheckUser', false),
+        bExcludeWhenNotAdmin: get(st, 'bExcludeWhenNotAdmin', false),
+    }
+    let wp = {}
+    try {
+        wp = WServOrm(ds, WOrm, opt)
+    }
+    catch (err) {
+        console.log(err)
+    }
+    let { woItems, procOrm } = wp
+    //getWebInfor
+    let getWebInfor = (userId) => {
+        return {
+            webName: get(st, 'webName', {})
+        }
+    }
+    //getAPIsList
+    let getAPIsList = async (userId, token) => {
+        let rs = await woItems.apis.select()
+        return rs
+    }
+    //parsePayload
+    let parsePayload = (req) => {
+        let inp = get(req, 'payload')
+        if (isestr(inp)) {
+            inp = j2o(inp)
+        }
+        if (!iseobj(inp)) {
+            inp = null
+        }
+        return inp
+    }
+    //updateAPIs
+    let updateAPIs = async (userId, params = {}) => {
+        //spread params
+        let { apis: rsApis } = params
+        // console.log('levels', levels)
+        // console.log('rsApis', rsApis)
+        //save
+        let r = await woItems.apis.save(rsApis)
+        return r
+    }
+    //replaceAPIsByLevels
+    let replaceAPIsByLevels = async (userId, params = {}) => {
+        //spread params
+        let { levels, apis: rsApis } = params
+        // console.log('levels', levels)
+        // console.log('rsApis', rsApis)
+        //delAll levels
+        await woItems.apis.delAll({ levels })
+        //rsApisTemp
+        let rsApisTemp = cloneDeep(rsApis)
+        rsApisTemp = map(rsApisTemp, (v) => {
+            v.levels = levels
+            return v
+        })
+        //insert
+        let r = await woItems.apis.insert(rsApisTemp)
+        return r
+    }
+    //pathStaticFiles
+    let pathStaticFiles = 'dist'
+    let npmPathStaticFiles = './node_modules/w-web-api/dist'
+    if (fsIsFolder(npmPathStaticFiles)) {
+        pathStaticFiles = npmPathStaticFiles
+    }
+    //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: '/getAPIsList',
+            handler: async function (req, res) {
+                //token
+                let token = get(req, 'query.token', '')
+                //getAPIsList
+                let r = await getAPIsList('', token)
+                return r
+            },
+        },
+        {
+            method: 'POST',
+            path: '/updateAPIs',
+            handler: async function (req, res) {
+                // console.log(req, res)
+                // console.log('payload', req.payload)
+                //parsePayload
+                let inp = parsePayload(req)
+                //updateAPIs
+                let r = await updateAPIs('', inp)
+                return r
+            },
+        },
+        {
+            method: 'POST',
+            path: '/replaceAPIsByLevels',
+            handler: async function (req, res) {
+                // console.log(req, res)
+                // console.log('payload', req.payload)
+                //parsePayload
+                let inp = parsePayload(req)
+                //replaceAPIsByLevels
+                let r = await replaceAPIsByLevels('', inp)
+                return r
+            },
+        },
+    ]
+    //tableNamesExec, tableNamesSync
+    let tableNamesExec = keys(ds)
+    // let tableNamesSync = filter(tableNamesExec, (v) => {
+    //     return strright(v, 5) !== 'Items'//不同步數據
+    // })
+    let tableNamesSync = tableNamesExec
+    //WServHapiServer
+    let wshs = WServHapiServer({
+        port: st.serverPort,
+        pathStaticFiles,
+        apis,
+        getUserIDFromToken: async (token) => { //可使用async或sync函數
+            return 'id-for-admin'
+        },
+        useDbORM: true,
+        dbORMs: woItems,
+        operORM: procOrm, //procOrm的輸入為: userId, tableName, methodName, input
+        tableNamesExec,
+        methodsExec: ['select', 'insert', 'save', 'del'], //mix需於procOrm內註冊以提供
+        tableNamesSync,
+        extFuncs: { //接收參數第1個為userId, 之後才是前端給予參數
+            getWebInfor,
+            getAPIsList,
+            //...
+        },
+        hookBefores: null,
+        hookAfters: null,
+    })
+    return wshs
+}
+export default WWebApi
+</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Apr 14 2022 12:34:37 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>

w-web-api 1.0.0