w-web-perm 1.1.8 → 1.1.10

package/docs/WWebPerm.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebPerm.html">WWebPerm</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createLegendMeasurer">createLegendMeasurer</a></li><li><a href="global.html#createLockSave">createLockSave</a></li><li><a href="global.html#decideLegendType">decideLegendType</a></li><li><a href="global.html#describeUpstream">describeUpstream</a></li><li><a href="global.html#fetchJson">fetchJson</a></li><li><a href="global.html#genLegend">genLegend</a></li><li><a href="global.html#maskQuery">maskQuery</a></li><li><a href="global.html#maskTok">maskTok</a></li><li><a href="global.html#maskUrl">maskUrl</a></li><li><a href="global.html#mergePickKeysOnly">mergePickKeysOnly</a></li><li><a href="global.html#reuseDeletedIds">reuseDeletedIds</a></li><li><a href="global.html#submitGuard">submitGuard</a></li><li><a href="global.html#wrapInjected">wrapInjected</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WWebPerm.html">WWebPerm</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createAuthorizeExec">createAuthorizeExec</a></li><li><a href="global.html#createLegendMeasurer">createLegendMeasurer</a></li><li><a href="global.html#createLockSave">createLockSave</a></li><li><a href="global.html#decideLegendType">decideLegendType</a></li><li><a href="global.html#describeUpstream">describeUpstream</a></li><li><a href="global.html#fetchJson">fetchJson</a></li><li><a href="global.html#genLegend">genLegend</a></li><li><a href="global.html#maskQuery">maskQuery</a></li><li><a href="global.html#maskTok">maskTok</a></li><li><a href="global.html#maskUrl">maskUrl</a></li><li><a href="global.html#mergePickKeysOnly">mergePickKeysOnly</a></li><li><a href="global.html#resolveShellWorker">resolveShellWorker</a></li><li><a href="global.html#reuseDeletedIds">reuseDeletedIds</a></li><li><a href="global.html#submitGuard">submitGuard</a></li><li><a href="global.html#validateRowsBeforeWrite">validateRowsBeforeWrite</a></li><li><a href="global.html#wrapInjected">wrapInjected</a></li><li><a href="global.html#wrapOperOrm">wrapOperOrm</a></li></ul>
     
 </nav>
 
@@ -80,7 +80,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="server_WWebPerm.mjs.html">server/WWebPerm.mjs</a>, <a href="server_WWebPerm.mjs.html#line144">line 144</a>
+        <a href="server_WWebPerm.mjs.html">server/WWebPerm.mjs</a>, <a href="server_WWebPerm.mjs.html#line140">line 140</a>
     </li></ul></dd>
     
 
@@ -127,7 +127,77 @@
 
     <h5 class="h5-examples">Example</h5>
     
-    <pre class="prettyprint"><code>import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
    useCheckUser: false,
    getUserById: null,
    useExcludeWhenNotAdmin: false,
    serverPort: 11006,
    subfolder: '', //mperm
    urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11006/
    webName: {
        'eng': 'Permission Service',
        'cht': '權限管理系統',
    },
    webDescription: {
        'eng': 'A web service package for user permissions and management targets.',
        'cht': 'A web service package for user permissions and management targets.',
    },
    webLogo: 'data:image/svg+xml;base64,...',
    // return {} //測試無法登入
    if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
        return {
            id: 'id-for-application',
            name: 'application',
            email: 'application@example.com',
            isAdmin: 'y',
        }
    }
    if (token === 'sys') { //開發階段w-ui-loginout自動給予browser使用者(且位於localhost)的token為sys
        return {
            id: 'id-for-admin',
            name: 'tester',
            email: 'admin@example.com', //mappingBy為email, 開發階段時會使用email找到所建置之使用者資料
            isAdmin: 'y',
        }
    }
    console.log('invalid token') //勿印權杖值
    console.log('於生產環境時得加入SSO等驗證token機制')
    return {}
    console.log('verifyClientUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log('verifyAppUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制應用程式使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log(err)
+    <pre class="prettyprint"><code>import WOrm from 'w-orm-lmdb/src/WOrmLmdb.mjs'
+import WWebPerm from './server/WWebPerm.mjs'
+import getSettings from './g_getSettings.mjs'
+
+
+//st
+let st = getSettings()
+
+let url = st.dbUrl
+let db = st.dbName
+let opt = {
+
+    serverPort: 11006,
+    subfolder: '', //mperm
+    urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11006/
+
+    webName: {
+        'eng': 'Permission Service',
+        'cht': '權限管理系統',
+    },
+    webDescription: {
+        'eng': 'A web service package for user permissions and management targets.',
+        'cht': 'A web service package for user permissions and management targets.',
+    },
+    webLogo: 'data:image/svg+xml;base64,...',
+
+}
+
+let getUserByToken = async (token) => {
+    // return {} //測試無法登入
+    if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
+        return {
+            id: 'id-for-application',
+            name: 'application',
+            email: 'application@example.com',
+            isAdmin: 'y',
+        }
+    }
+    if (token === 'sys') { //開發階段w-ui-loginout自動給予browser使用者(且位於localhost)的token為sys
+        return {
+            id: 'id-for-admin',
+            name: 'tester',
+            email: 'admin@example.com', //mappingBy為email, 開發階段時會使用email找到所建置之使用者資料
+            isAdmin: 'y',
+        }
+    }
+    console.log('invalid token') //勿印權杖值
+    console.log('於生產環境時得加入SSO等驗證token機制')
+    return {}
+}
+
+let verifyClientUser = (user, from) => {
+    console.log('verifyClientUser/user', user)
+    // return false //測試無法登入
+    console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
+    return user.isAdmin === 'y' //測試僅系統管理者使用
+}
+
+let verifyAppUser = (user, from) => {
+    console.log('verifyAppUser/user', user)
+    // return false //測試無法登入
+    console.log('於生產環境時得加入限制應用程式使用者身份機制')
+    return user.isAdmin === 'y' //測試僅系統管理者使用
+}
+
+//WWebPerm
+let instWWebPerm = WWebPerm(WOrm, url, db, getUserByToken, verifyClientUser, verifyAppUser, opt)
+
+instWWebPerm.on('error', (err) => {
+    console.log(err)
+})</code></pre>
 
 
 
@@ -473,127 +543,7 @@
                 </td>
             
 
-            <td class="description last"><p>輸入伺服器通訊port，預設11006</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>useCheckUser</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Boolean</span>
-
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-                <td class="default">
-                
-                    <code>false</code>
-                
-                </td>
-            
-
-            <td class="description last"><p>輸入是否檢查使用者資訊布林值，預設false</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>getUserById</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">function</span>
-
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-                <td class="default">
-                
-                    <code>null</code>
-                
-                </td>
-            
-
-            <td class="description last"><p>輸入當useCheckUser=true時依照使用者ID取得使用者資訊物件函數，預設null</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>useExcludeWhenNotAdmin</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Boolean</span>
-
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-                <td class="default">
-                
-                    <code>false</code>
-                
-                </td>
-            
-
-            <td class="description last"><p>輸入使用ORM的select方法時是否自動刪除數據內isActive欄位之布林值，預設false</p></td>
+            <td class="description last"><p>輸入伺服器通訊port，預設11006。註：原opt.useCheckUser、opt.getUserById、opt.useExcludeWhenNotAdmin已隨w-serv-orm 1.1.9移除，給予undefined、null、false以外之值時建構即拋錯(錯誤訊息出自w-serv-orm之checkOptRemoved，並記srLog)；資料通道之使用者授權由verifyConn(verifyClientUser)負責、表操作只開放select，刪除該三鍵即可，無須替代設定</p></td>
         </tr>
 
     
@@ -828,12 +778,12 @@
             
                 <td class="default">
                 
-                    <code>'email'</code>
+                    <code>'id'</code>
                 
                 </td>
             
 
-            <td class="description last"><p>輸入外部系統識別使用者token後所提供之資料物件，與權限系統之使用者資料物件，兩者間查找之對應欄位，可選'id'、'email'、'name'，預設'email'</p></td>
+            <td class="description last"><p>輸入外部系統識別使用者token後所提供之資料物件，與權限系統之使用者資料物件，兩者間查找之對應欄位，可選'id'、'email'、'name'，未給或非此三者時為'id'，預設'id'</p></td>
         </tr>
 
     
@@ -986,7 +936,7 @@
 
         
 <div class="param-desc">
-    <p>回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件</p>
+    <p>回傳w-serv-hapi之WServHapiServer事件物件，可監聽error事件；另提供ready函數(回傳promise，啟動成功resolve為hapi伺服器實體，失敗如埠被占用時reject)、stop函數(釋放資料同步等下游資源後停止伺服器)、getServer函數與getInstWConverServer函數。資料通道之表操作只開放select(新增、修改、刪除一律經updateTargets等函數)；設定錯誤(含已移除之opt鍵)於建構時同步拋出並記srLog</p>
 </div>
 
 
@@ -1045,7 +995,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sun Oct 11 2026 16:35:27 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 4.0.5</a> on Tue Oct 20 2026 06:46:43 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>