w-web-api 1.0.0 → 1.0.3

package/dist/w-web-api.umd.js

@@ -1,5 +1,5 @@
 /*!
- * w-web-api v1.0.0
+ * w-web-api v1.0.3
  * (c) 2018-2021 yuda-lyu(semisphere)
  * Released under the MIT License.
  */

package/docs/WWebApi.html

@@ -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#line34">line 34</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line36">line 36</a>
     </li></ul></dd>
     
 
@@ -235,8 +235,6 @@
             
                 <td class="attributes">
                 
-                    &lt;optional><br>
-                
 
                 
 
@@ -247,8 +245,6 @@
             
                 <td class="default">
                 
-                    <code>''</code>
-                
                 </td>
             
 
@@ -274,8 +270,6 @@
             
                 <td class="attributes">
                 
-                    &lt;optional><br>
-                
 
                 
 
@@ -286,12 +280,45 @@
             
                 <td class="default">
                 
-                    <code>''</code>
+                </td>
+            
+
+            <td class="description last"><p>輸入資料庫名稱字串</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>WOrm</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>輸入資料庫名稱字串，預設''</p></td>
+            <td class="description last"><p>輸入資料庫ORM函數</p></td>
         </tr>
 
     
@@ -325,12 +352,12 @@
             
                 <td class="default">
                 
-                    <code>8080</code>
+                    <code>11005</code>
                 
                 </td>
             
 
-            <td class="description last"><p>輸入伺服器通訊port，預設8080</p></td>
+            <td class="description last"><p>輸入伺服器通訊port，預設11005</p></td>
         </tr>
 
     
@@ -451,6 +478,45 @@
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>webName</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    <code>{}</code>
+                
+                </td>
+            
+
+            <td class="description last"><p>輸入站台名稱物件，至少包含語系eng與cht鍵的名稱，預設{}</p></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -538,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 12:34:37 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 13:49:57 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -50,10 +50,10 @@ 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 isfun from 'wsemi/src/isfun'
 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'
 
@@ -63,62 +63,79 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  *
  * @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 {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
  * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
+ * @param {Object} [opt.webName={}] 輸入站台名稱物件，至少包含語系eng與cht鍵的名稱，預設{}
  * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
  * @example
  *
 
  *
  */
-async function WWebApi(st = {}) {
+async function WWebApi(url, db, WOrm, opt = {}) {
 
 
-    //url
-    let url = get(st, 'url')
+    //check url
     if (!isestr(url)) {
         console.log('invalid url', url)
         throw new Error('invalid url')
     }
 
 
-    //db
-    let db = get(st, 'db')
+    //check db
     if (!isestr(db)) {
         console.log('invalid db', db)
         throw new Error('invalid db')
     }
 
 
+    //check WOrm
+    if (!isfun(WOrm)) {
+        console.log('invalid WOrm', WOrm)
+        throw new Error('invalid WOrm')
+    }
+
+
     //serverPort
-    let serverPort = get(st, 'serverPort')
+    let serverPort = get(opt, 'serverPort')
     if (!ispint(serverPort)) {
-        console.log('invalid serverPort', serverPort)
-        throw new Error('invalid serverPort')
+        serverPort = 11005
     }
     serverPort = cint(serverPort)
 
 
+    //getUserById
+    let getUserById = get(opt, 'getUserById', null)
+
+
+    //bCheckUser
+    let bCheckUser = get(opt, 'bCheckUser', false)
+
+
+    //bExcludeWhenNotAdmin
+    let bExcludeWhenNotAdmin = get(opt, 'bExcludeWhenNotAdmin', false)
+
+
+    //webName
+    let webName = get(opt, 'webName', {})
+
+
     //WServOrm
-    let opt = {
-        // url: `mongodb://${st.dbUsername}:${st.dbPassword}@${st.dbIP}:${st.dbPort}`,
-        // db: st.dbName,
-        // getUserById: null,
-        // bCheckUser: false,
-        // bExcludeWhenNotAdmin: false,
+    let optWServOrm = {
         url,
         db,
-        getUserById: get(st, 'getUserById', null),
-        bCheckUser: get(st, 'bCheckUser', false),
-        bExcludeWhenNotAdmin: get(st, 'bExcludeWhenNotAdmin', false),
+        getUserById,
+        bCheckUser,
+        bExcludeWhenNotAdmin,
     }
     let wp = {}
     try {
-        wp = WServOrm(ds, WOrm, opt)
+        wp = WServOrm(ds, WOrm, optWServOrm)
     }
     catch (err) {
         console.log(err)
@@ -129,7 +146,7 @@ async function WWebApi(st = {}) {
     //getWebInfor
     let getWebInfor = (userId) => {
         return {
-            webName: get(st, 'webName', {})
+            webName,
         }
     }
 
@@ -281,7 +298,7 @@ async function WWebApi(st = {}) {
 
     //WServHapiServer
     let wshs = WServHapiServer({
-        port: st.serverPort,
+        port: opt.serverPort,
         pathStaticFiles,
         apis,
         getUserIDFromToken: async (token) => { //可使用async或sync函數
@@ -322,7 +339,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 12:34:37 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 13:49:57 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 12:34:37 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 13:49:57 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,81 +1,82 @@
-{
-  "name": "w-web-api",
-  "version": "1.0.0",
-  "main": "dist/w-web-api.umd.js",
-  "dependencies": {
-    "@mdi/js": "^6.6.96",
-    "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",
-    "wsemi": "^1.6.55"
-  },
-  "devDependencies": {
-    "eslint": "^7.26.0",
-    "eslint-config-standard": "^16.0.2",
-    "eslint-friendly-formatter": "^4.0.1",
-    "eslint-loader": "^4.0.2",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-node": "^11.1.0",
-    "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",
-    "w-package-tools": "^1.0.65"
-  },
-  "scripts": {
-    "serve": "vue-cli-service serve",
-    "build": "vue-cli-service build",
-    "lint": "vue-cli-service lint",
-    "start": "node --experimental-modules --es-module-specifier-resolution=node server/srv.mjs"
-  },
-  "eslintConfig": {
-    "root": true,
-    "env": {
-      "node": true
-    },
-    "extends": [
-      "plugin:vue/essential",
-      "eslint:recommended"
-    ],
-    "rules": {},
-    "parserOptions": {
-      "parser": "babel-eslint"
-    }
-  },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yuda-lyu/w-web-api"
-  },
-  "keywords": [
-    "lodash",
-    "color",
-    "crypto",
-    "fuzzy",
-    "xss",
-    "xlsx",
-    "tool",
-    "package ",
-    "browser",
-    "developer"
-  ],
-  "author": "yuda-lyu(semisphere)",
-  "license": "MIT"
-}
+{
+  "name": "w-web-api",
+  "version": "1.0.3",
+  "main": "dist/w-web-api.umd.js",
+  "dependencies": {
+    "@mdi/js": "^6.6.96",
+    "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",
+    "wsemi": "^1.6.55"
+  },
+  "devDependencies": {
+    "eslint": "^7.26.0",
+    "eslint-config-standard": "^16.0.2",
+    "eslint-friendly-formatter": "^4.0.1",
+    "eslint-loader": "^4.0.2",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-node": "^11.1.0",
+    "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",
+    "w-package-tools": "^1.0.65"
+  },
+  "scripts": {
+    "serve": "vue-cli-service serve",
+    "build": "vue-cli-service build",
+    "test": "mocha --parallel --timeout 60000 --experimental-modules --es-module-specifier-resolution=node",
+    "lint": "vue-cli-service lint",
+    "deploy": "gh-pages -d docs"
+  },
+  "eslintConfig": {
+    "root": true,
+    "env": {
+      "node": true
+    },
+    "extends": [
+      "plugin:vue/essential",
+      "eslint:recommended"
+    ],
+    "rules": {},
+    "parserOptions": {
+      "parser": "babel-eslint"
+    }
+  },
+  "browserslist": [
+    "> 1%",
+    "last 2 versions"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yuda-lyu/w-web-api"
+  },
+  "keywords": [
+    "lodash",
+    "color",
+    "crypto",
+    "fuzzy",
+    "xss",
+    "xlsx",
+    "tool",
+    "package ",
+    "browser",
+    "developer"
+  ],
+  "author": "yuda-lyu(semisphere)",
+  "license": "MIT"
+}