w-web-api 1.0.19 → 1.0.20

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#line69">line 69</a>
+        <a href="WWebApi.mjs.html">WWebApi.mjs</a>, <a href="WWebApi.mjs.html#line78">line 78</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管理系統'
    },
    console.log(err)
+    <pre class="prettyprint"><code>import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
    getUserById: null,
    bCheckUser: false,
    bExcludeWhenNotAdmin: false,
    serverPort: 11005,
    subfolder: '', //mpai
    webName: {
        'eng': 'API Service',
        'cht': 'API管理系統'
    },
    console.log(err)
 
 
 
@@ -517,6 +517,123 @@
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>webDescription</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>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>webLogo</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    <code>''</code>
+                
+                </td>
+            
+
+            <td class="description last"><p>輸入站台logo字串，採base64格式，預設''</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>subfolder</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    <code>''</code>
+                
+                </td>
+            
+
+            <td class="description last"><p>輸入站台所在子目錄字串，提供站台位於內網採反向代理進行服務時，故需支援位於子目錄情形，預設''</p></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -604,7 +721,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed May 11 2022 17:06:59 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 Wed May 11 2022 17:56:39 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebApi.mjs.html

@@ -42,21 +42,26 @@
     
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>import get from 'lodash/get'
+            <pre class="prettyprint source linenums"><code>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'
-import isestr from 'wsemi/src/isestr'
-import ispint from 'wsemi/src/ispint'
-import isfun from 'wsemi/src/isfun'
-import cint from 'wsemi/src/cint'
-import strleft from 'wsemi/src/strleft'
-import strdelleft from 'wsemi/src/strdelleft'
-import b642str from 'wsemi/src/b642str'
-import fsIsFolder from 'wsemi/src/fsIsFolder'
+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 cint from 'wsemi/src/cint.mjs'
+import strleft from 'wsemi/src/strleft.mjs'
+import strdelleft from 'wsemi/src/strdelleft.mjs'
+import strright from 'wsemi/src/strright.mjs'
+import strdelright from 'wsemi/src/strdelright.mjs'
+import b642str from 'wsemi/src/b642str.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 ds from '../src/schema/index.mjs'
 import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
@@ -75,6 +80,9 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
  * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
  * @param {Object} [opt.webName={}] 輸入站台名稱物件，至少包含語系eng與cht鍵的名稱，預設{}
+ * @param {Object} [opt.webDescription={}] 輸入站台描述物件，至少包含語系eng與cht鍵的名稱，預設{}
+ * @param {String} [opt.webLogo=''] 輸入站台logo字串，採base64格式，預設''
+ * @param {String} [opt.subfolder=''] 輸入站台所在子目錄字串，提供站台位於內網採反向代理進行服務時，故需支援位於子目錄情形，預設''
  * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
  * @example
  *
@@ -94,6 +102,7 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  *     bExcludeWhenNotAdmin: false,
  *
  *     serverPort: 11005,
+ *     subfolder: '', //mpai
  *
  *     webName: {
  *         'eng': 'API Service',
@@ -164,7 +173,19 @@ function WWebApi(WOrm, url, db, opt = {}) {
 
 
     //webLogo
-    let webLogo = get(opt, '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}`
+        }
+    }
 
 
     //WServOrm
@@ -286,6 +307,16 @@ function WWebApi(WOrm, url, db, opt = {}) {
     // console.log('pathStaticFiles', pathStaticFiles)
 
 
+    //subfolder
+    let fnEntryIn = 'index.tmp'
+    let fnEntryOut = 'index.html'
+    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')
+
+
     //apis
     let apis = [
         // {
@@ -407,7 +438,7 @@ export default WWebApi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed May 11 2022 17:06:59 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 Wed May 11 2022 17:56:39 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 Wed May 11 2022 17:06:59 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 Wed May 11 2022 17:56:39 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "w-web-api",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "main": "dist/w-web-api.umd.js",
   "dependencies": {
     "@mdi/js": "^6.6.96",

package/server/WWebApi.mjs

@@ -1,18 +1,23 @@
+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'
-import isestr from 'wsemi/src/isestr'
-import ispint from 'wsemi/src/ispint'
-import isfun from 'wsemi/src/isfun'
-import cint from 'wsemi/src/cint'
-import strleft from 'wsemi/src/strleft'
-import strdelleft from 'wsemi/src/strdelleft'
-import b642str from 'wsemi/src/b642str'
-import fsIsFolder from 'wsemi/src/fsIsFolder'
+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 cint from 'wsemi/src/cint.mjs'
+import strleft from 'wsemi/src/strleft.mjs'
+import strdelleft from 'wsemi/src/strdelleft.mjs'
+import strright from 'wsemi/src/strright.mjs'
+import strdelright from 'wsemi/src/strdelright.mjs'
+import b642str from 'wsemi/src/b642str.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 ds from '../src/schema/index.mjs'
 import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
@@ -31,6 +36,9 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  * @param {Boolean} [opt.bCheckUser=true] 輸入是否檢查使用者資訊布林值，預設true
  * @param {Boolean} [opt.bExcludeWhenNotAdmin=true] 輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設true
  * @param {Object} [opt.webName={}] 輸入站台名稱物件，至少包含語系eng與cht鍵的名稱，預設{}
+ * @param {Object} [opt.webDescription={}] 輸入站台描述物件，至少包含語系eng與cht鍵的名稱，預設{}
+ * @param {String} [opt.webLogo=''] 輸入站台logo字串，採base64格式，預設''
+ * @param {String} [opt.subfolder=''] 輸入站台所在子目錄字串，提供站台位於內網採反向代理進行服務時，故需支援位於子目錄情形，預設''
  * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
  * @example
  *
@@ -50,6 +58,7 @@ import WServOrm from 'w-serv-orm/src/WServOrm.mjs'
  *     bExcludeWhenNotAdmin: false,
  *
  *     serverPort: 11005,
+ *     subfolder: '', //mpai
  *
  *     webName: {
  *         'eng': 'API Service',
@@ -120,7 +129,19 @@ function WWebApi(WOrm, url, db, opt = {}) {
 
 
     //webLogo
-    let webLogo = get(opt, '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}`
+        }
+    }
 
 
     //WServOrm
@@ -242,6 +263,16 @@ function WWebApi(WOrm, url, db, opt = {}) {
     // console.log('pathStaticFiles', pathStaticFiles)
 
 
+    //subfolder
+    let fnEntryIn = 'index.tmp'
+    let fnEntryOut = 'index.html'
+    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')
+
+
     //apis
     let apis = [
         // {

package/srv.mjs

@@ -15,6 +15,7 @@ let opt = {
     bExcludeWhenNotAdmin: false,
 
     serverPort: 11005,
+    subfolder: '', //mpai
 
     webName: {
         'eng': 'API Service',

package/tableTags-web-api.json

@@ -1 +1 @@
-{"apis":"Au5CHL"}
+{"apis":"hWgeMc"}

package/toolg/genEntry.mjs

@@ -0,0 +1,23 @@
+import path from 'path'
+import fs from 'fs'
+// import _ from 'lodash'
+import w from 'wsemi'
+
+
+let fdTar = './dist'
+let fnEntryIn = 'index.html'
+let fnEntryOut = 'index.tmp'
+let fpEntryIn = path.resolve(fdTar, fnEntryIn)
+let fpEntryOut = path.resolve(fdTar, fnEntryOut)
+
+//readFileSync
+let c = fs.readFileSync(fpEntryIn, 'utf8')
+
+//replace
+c = w.replace(c, '/mapi/', '{sfd}/')
+
+//writeFileSync
+fs.writeFileSync(fpEntryOut, c, 'utf8')
+
+//unlinkSync
+fs.unlinkSync(fpEntryIn)

package/vue.config.js

@@ -11,5 +11,5 @@ module.exports = {
         }
     },
     // transpileDependencies: ['vuetify'],
-    publicPath: process.env.NODE_ENV === 'production' ? '/mapi/' : '/',
+    publicPath: process.env.NODE_ENV === 'production' ? '/mapi/' : '/', //預先編譯至mapi子目錄下, 待啟動後取代
 }