w-web-api 1.0.4 → 1.0.7

package/docs/WWebApi.html

@@ -59,7 +59,7 @@
 
     
 
-    <h4 class="name" id="WWebApi"><span class="type-signature">(async) </span>new WWebApi<span class="signature">(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">(async) </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>
 
     
 
@@ -71,7 +71,7 @@
     
     <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#line66">line 66</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -124,7 +124,7 @@
 
     <h5>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,
    webName: {
        'eng': 'API Service',
        'cht': 'API管理系統'
    },
    .catch((err) => {
        console.log(err)
    })</code></pre>
+    <pre class="prettyprint"><code>import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
    getUserById: null,
    bCheckUser: false,
    bExcludeWhenNotAdmin: false,
    serverPort: 11005,
    webName: {
        'eng': 'API Service',
        'cht': 'API管理系統'
    },
    .catch((err) => {
        console.log(err)
    })</code></pre>
 
 
 
@@ -158,13 +158,13 @@
 
         <tr>
             
-                <td class="name"><code>opt</code></td>
+                <td class="name"><code>WOrm</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">Object</span>
+<span class="param-type">function</span>
 
 
             
@@ -173,8 +173,6 @@
             
                 <td class="attributes">
                 
-                    &lt;optional><br>
-                
 
                 
 
@@ -185,37 +183,12 @@
             
                 <td class="default">
                 
-                    <code>{}</code>
-                
                 </td>
             
 
-            <td class="description last"><p>輸入設定物件，預設{}</p>
-                <h6>Properties</h6>
-                
-
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
-
-        <th>Type</th>
-
-        
-        <th>Attributes</th>
-        
-
-        
-        <th>Default</th>
-        
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+            <td class="description last"><p>輸入資料庫ORM函數</p></td>
+        </tr>
 
-    <tbody>
     
 
         <tr>
@@ -290,13 +263,13 @@
 
         <tr>
             
-                <td class="name"><code>WOrm</code></td>
+                <td class="name"><code>opt</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">function</span>
+<span class="param-type">Object</span>
 
 
             
@@ -305,6 +278,8 @@
             
                 <td class="attributes">
                 
+                    &lt;optional><br>
+                
 
                 
 
@@ -315,12 +290,37 @@
             
                 <td class="default">
                 
+                    <code>{}</code>
+                
                 </td>
             
 
-            <td class="description last"><p>輸入資料庫ORM函數</p></td>
-        </tr>
+            <td class="description last"><p>輸入設定物件，預設{}</p>
+                <h6>Properties</h6>
+                
 
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+        <th>Attributes</th>
+        
+
+        
+        <th>Default</th>
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
     
 
         <tr>
@@ -604,7 +604,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Apr 14 2022 13:52:10 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 3.6.10</a> on Thu Apr 14 2022 16:47:26 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -62,10 +62,10 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * 基於hapi之API伺服器
  *
  * @class
+ * @param {Function} WOrm 輸入資料庫ORM函數
+ * @param {String} url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
+ * @param {String} db 輸入資料庫名稱字串
  * @param {Object} [opt={}] 輸入設定物件，預設{}
- * @param {String} opt.url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
- * @param {String} opt.db 輸入資料庫名稱字串
- * @param {Function} opt.WOrm 輸入資料庫ORM函數
  * @param {Integer} [opt.serverPort=11005] 輸入伺服器通訊port，預設11005
  * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
  * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
@@ -78,7 +78,6 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * import getSettings from './server/getSettings.mjs'
  * import WWebApi from './server/WWebApi.mjs'
  *
- *
  * //st
  * let st = getSettings()
  *
@@ -100,14 +99,20 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * }
  *
  * //WWebApi
- * WWebApi(url, db, WOrm, opt)
+ * WWebApi(WOrm, url, db, opt)
  *     .catch((err) => {
  *         console.log(err)
  *     })
  *
- *
  */
-async function WWebApi(url, db, WOrm, opt = {}) {
+async function WWebApi(WOrm, url, db, opt = {}) {
+
+
+    //check WOrm
+    if (!isfun(WOrm)) {
+        console.log('invalid WOrm', WOrm)
+        throw new Error('invalid WOrm')
+    }
 
 
     //check url
@@ -124,13 +129,6 @@ async function WWebApi(url, db, WOrm, opt = {}) {
     }
 
 
-    //check WOrm
-    if (!isfun(WOrm)) {
-        console.log('invalid WOrm', WOrm)
-        throw new Error('invalid WOrm')
-    }
-
-
     //serverPort
     let serverPort = get(opt, 'serverPort')
     if (!ispint(serverPort)) {
@@ -139,14 +137,14 @@ async function WWebApi(url, db, WOrm, opt = {}) {
     serverPort = cint(serverPort)
 
 
-    //getUserById
-    let getUserById = get(opt, 'getUserById', null)
-
-
     //bCheckUser
     let bCheckUser = get(opt, 'bCheckUser', false)
 
 
+    //getUserById
+    let getUserById = get(opt, 'getUserById', null)
+
+
     //bExcludeWhenNotAdmin
     let bExcludeWhenNotAdmin = get(opt, 'bExcludeWhenNotAdmin', false)
 
@@ -157,15 +155,13 @@ async function WWebApi(url, db, WOrm, opt = {}) {
 
     //WServOrm
     let optWServOrm = {
-        url,
-        db,
-        getUserById,
         bCheckUser,
+        getUserById,
         bExcludeWhenNotAdmin,
     }
     let wp = {}
     try {
-        wp = WServOrm(ds, WOrm, optWServOrm)
+        wp = WServOrm(ds, WOrm, url, db, optWServOrm)
     }
     catch (err) {
         console.log(err)
@@ -247,6 +243,7 @@ async function WWebApi(url, db, WOrm, opt = {}) {
     if (fsIsFolder(npmPathStaticFiles)) {
         pathStaticFiles = npmPathStaticFiles
     }
+    // console.log('pathStaticFiles', pathStaticFiles)
 
 
     //apis
@@ -347,6 +344,7 @@ async function WWebApi(url, db, WOrm, opt = {}) {
         },
         hookBefores: null,
         hookAfters: null,
+        fnTableTags: 'tableTags-web-api.json',
     })
 
 
@@ -369,7 +367,7 @@ export default WWebApi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Apr 14 2022 13:52:10 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 3.6.10</a> on Thu Apr 14 2022 16:47:26 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -68,7 +68,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Apr 14 2022 13:52:10 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 3.6.10</a> on Thu Apr 14 2022 16:47:26 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

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

@@ -3,8 +3,8 @@ import fs from 'fs'
 // import _ from 'lodash'
 import w from 'wsemi'
 import br from 'w-serv-orm/src/getDbBackupAndRecover.mjs'
-import { woItems } from './mOrm.mjs'
-// import { genModels } from './mOrmGenModels.mjs'
+import { woItems } from './g.mOrm.mjs'
+// import { genModels } from './g.mOrmGenModels.mjs'
 
 
 //mOrmGenModels.mjs
@@ -73,4 +73,4 @@ function recover() {
 
 
 //備份資料重與由備份資料重建資料庫
-//node --experimental-modules --es-module-specifier-resolution=node server/mDb.mjs
+//node --experimental-modules --es-module-specifier-resolution=node g.mDb.mjs

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

@@ -2,8 +2,8 @@
 // import fs from 'fs'
 // import _ from 'lodash'
 import w from 'wsemi'
-import { woItems } from './mOrm.mjs'
-import ds from '../src/schema/index.mjs'
+import ds from './src/schema/index.mjs'
+import { woItems } from './g.mOrm.mjs'
 
 
 async function initialTestData() {
@@ -37,4 +37,4 @@ initialTestData()
 
 
 //刪除舊檔與重建測試資料庫
-//node --experimental-modules --es-module-specifier-resolution=node server/mInitialTestData.mjs
+//node --experimental-modules --es-module-specifier-resolution=node g.mInitialTestData.mjs

package/{server/mOrm.mjs → g.mOrm.mjs}

@@ -1,21 +1,23 @@
 import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs'
-import ds from '../src/schema/index.mjs'
-import getSettings from './getSettings.mjs'
 import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
+import ds from './src/schema/index.mjs'
+import getSettings from './g.getSettings.mjs'
 
 
 //getSettings
 let st = getSettings()
 
+//url, db
+let url = `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`
+let db = st.dbName
+
 //WServOrm
 let opt = {
-    url: `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`,
-    db: st.dbName,
     getUserById: null,
     bCheckUser: false,
     bExcludeWhenNotAdmin: false,
 }
-let r = WServOrm(ds, WOrm, opt)
+let r = WServOrm(ds, WOrm, url, db, opt)
 let { woItems, procOrm } = r
 
 

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "w-web-api",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "main": "dist/w-web-api.umd.js",
   "dependencies": {
     "@mdi/js": "^6.6.96",
+    "axios": "^0.26.1",
     "lodash": "^4.17.21",
     "showdown": "^2.0.3",
     "w-component-vue": "^2.2.6",
     "w-data-collector": "^1.0.13",
-    "w-orm-mongodb": "^1.1.26",
-    "w-serv-hapi": "^1.0.5",
-    "w-serv-orm": "^1.0.0",
+    "w-serv-hapi": "^1.0.6",
+    "w-serv-orm": "^1.0.1",
     "wsemi": "^1.6.55"
   },
   "devDependencies": {
+    "@vue/cli-plugin-babel": "^4.5.13",
+    "@vue/cli-plugin-eslint": "^4.5.13",
+    "@vue/cli-service": "^4.5.13",
+    "cheerio": "^1.0.0-rc.10",
     "eslint": "^7.26.0",
     "eslint-config-standard": "^16.0.2",
     "eslint-friendly-formatter": "^4.0.1",
@@ -23,17 +27,14 @@
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^4.1.0",
     "eslint-plugin-vue": "^7.9.0",
-    "@vue/cli-plugin-babel": "^4.5.13",
-    "@vue/cli-plugin-eslint": "^4.5.13",
-    "@vue/cli-service": "^4.5.13",
-    "cheerio": "^1.0.0-rc.10",
     "sass": "^1.34.0",
     "sass-loader": "^10.1.1",
     "vue": "^2.6.14",
-    "vuex": "^3.6.2",
     "vue-cli-plugin-vuetify": "^2.4.8",
     "vuetify": "^2.6.4",
     "vuetify-loader": "^1.7.3",
+    "vuex": "^3.6.2",
+    "w-orm-mongodb": "^1.1.26",
     "w-package-tools": "^1.0.65"
   },
   "scripts": {
@@ -66,16 +67,9 @@
     "url": "https://github.com/yuda-lyu/w-web-api"
   },
   "keywords": [
-    "lodash",
-    "color",
-    "crypto",
-    "fuzzy",
-    "xss",
-    "xlsx",
-    "tool",
-    "package ",
-    "browser",
-    "developer"
+    "web",
+    "service",
+    "api"
   ],
   "author": "yuda-lyu(semisphere)",
   "license": "MIT"

package/server/WWebApi.mjs

@@ -18,10 +18,10 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * 基於hapi之API伺服器
  *
  * @class
+ * @param {Function} WOrm 輸入資料庫ORM函數
+ * @param {String} url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
+ * @param {String} db 輸入資料庫名稱字串
  * @param {Object} [opt={}] 輸入設定物件，預設{}
- * @param {String} opt.url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
- * @param {String} opt.db 輸入資料庫名稱字串
- * @param {Function} opt.WOrm 輸入資料庫ORM函數
  * @param {Integer} [opt.serverPort=11005] 輸入伺服器通訊port，預設11005
  * @param {Function} [opt.getUserById=null] 輸入當bCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null
  * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
@@ -34,7 +34,6 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * import getSettings from './server/getSettings.mjs'
  * import WWebApi from './server/WWebApi.mjs'
  *
- *
  * //st
  * let st = getSettings()
  *
@@ -56,14 +55,20 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * }
  *
  * //WWebApi
- * WWebApi(url, db, WOrm, opt)
+ * WWebApi(WOrm, url, db, opt)
  *     .catch((err) => {
  *         console.log(err)
  *     })
  *
- *
  */
-async function WWebApi(url, db, WOrm, opt = {}) {
+async function WWebApi(WOrm, url, db, opt = {}) {
+
+
+    //check WOrm
+    if (!isfun(WOrm)) {
+        console.log('invalid WOrm', WOrm)
+        throw new Error('invalid WOrm')
+    }
 
 
     //check url
@@ -80,13 +85,6 @@ async function WWebApi(url, db, WOrm, opt = {}) {
     }
 
 
-    //check WOrm
-    if (!isfun(WOrm)) {
-        console.log('invalid WOrm', WOrm)
-        throw new Error('invalid WOrm')
-    }
-
-
     //serverPort
     let serverPort = get(opt, 'serverPort')
     if (!ispint(serverPort)) {
@@ -95,14 +93,14 @@ async function WWebApi(url, db, WOrm, opt = {}) {
     serverPort = cint(serverPort)
 
 
-    //getUserById
-    let getUserById = get(opt, 'getUserById', null)
-
-
     //bCheckUser
     let bCheckUser = get(opt, 'bCheckUser', false)
 
 
+    //getUserById
+    let getUserById = get(opt, 'getUserById', null)
+
+
     //bExcludeWhenNotAdmin
     let bExcludeWhenNotAdmin = get(opt, 'bExcludeWhenNotAdmin', false)
 
@@ -113,15 +111,13 @@ async function WWebApi(url, db, WOrm, opt = {}) {
 
     //WServOrm
     let optWServOrm = {
-        url,
-        db,
-        getUserById,
         bCheckUser,
+        getUserById,
         bExcludeWhenNotAdmin,
     }
     let wp = {}
     try {
-        wp = WServOrm(ds, WOrm, optWServOrm)
+        wp = WServOrm(ds, WOrm, url, db, optWServOrm)
     }
     catch (err) {
         console.log(err)
@@ -203,6 +199,7 @@ async function WWebApi(url, db, WOrm, opt = {}) {
     if (fsIsFolder(npmPathStaticFiles)) {
         pathStaticFiles = npmPathStaticFiles
     }
+    // console.log('pathStaticFiles', pathStaticFiles)
 
 
     //apis
@@ -303,6 +300,7 @@ async function WWebApi(url, db, WOrm, opt = {}) {
         },
         hookBefores: null,
         hookAfters: null,
+        fnTableTags: 'tableTags-web-api.json',
     })
 
 

package/server/provideApis.mjs

@@ -0,0 +1,70 @@
+import axios from 'axios'
+import map from 'lodash/map'
+import ltdtpick from 'wsemi/src/ltdtpick.mjs'
+
+
+async function provideApis(url, levels, apis) {
+    //url: 指API伺服器提供的接入網址, 例如 http://localhost:11005/replaceAPIsByLevels
+
+    //ks
+    let ks = [
+        'id', //'id-for-apis-pets-guineapigs-1'
+        'name', //'取得天竺鼠清單資訊'
+        'description', //'取得天竺鼠清單資訊'
+        'url', //指api網址, 例如 http://localhost:11005/getDogsList
+        'method', //'get'
+        'version', //'v1'
+        'levels', //'寵物.天竺鼠'
+        'keywords', //'pets;guineapigs'
+        'state', //'ok'
+        'creator', //'pets-system'
+        'dataSource', //'pets-data'
+        'mdInputParams', //輸入方式說明, markdown格式
+        'outputExample', //輸出範例數據, json格式
+    ]
+
+    //ltdtpick
+    apis = ltdtpick(apis, ks)
+
+    //update levels
+    apis = map(apis, (v) => {
+        v.levels = levels
+        return v
+    })
+
+    //rin
+    let rin = {
+        levels,
+        apis,
+    }
+
+    //axios
+    let rout
+    await axios({
+        method: 'post',
+        url,
+        headers: { 'Content-Type': 'application/json; charset=utf-8' },
+        data: rin,
+    })
+        .then((res) => {
+            // console.log(res)
+            rout = {
+                state: 'success',
+                msg: '成功傳輸API清單',
+                res,
+            }
+        })
+        .catch((err) => {
+            // console.log(err)
+            rout = {
+                state: 'success',
+                msg: '無法傳輸API清單',
+                res: err,
+            }
+        })
+
+    return rout
+}
+
+
+export default provideApis

package/srv.mjs

@@ -1,6 +1,6 @@
 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
@@ -24,7 +24,7 @@ let opt = {
 }
 
 //WWebApi
-WWebApi(url, db, WOrm, opt)
+WWebApi(WOrm, url, db, opt)
     .catch((err) => {
         console.log(err)
     })

package/tableTags-web-api.json

@@ -0,0 +1 @@
+{"apis":"dJSgfx"}

package/toolg/gDistRollup.mjs

@@ -1,12 +1,14 @@
-import rollupFiles from 'w-package-tools/src/rollupFiles.mjs'
+// import rollupFiles from 'w-package-tools/src/rollupFiles.mjs'
+import rollupFile from 'w-package-tools/src/rollupFile.mjs' //因只有1檔案且不需刪除dsit故改用rollupFile
 
 
 let fdSrc = './server' //'./src'
 let fdTar = './dist'
 
 
-rollupFiles({
-    fns: ['WWebApi.mjs'],
+rollupFile({
+    // fns: ['WWebApi.mjs'],
+    fn: 'WWebApi.mjs',
     fdSrc,
     fdTar,
     nameDistType: 'kebabCase',

package/tableTags.json

@@ -1 +0,0 @@
-{"apis":"gertCD"}