npm - w-comor-hapi - Versions diffs - 1.0.32 → 1.0.33 - Mend

w-comor-hapi 1.0.32 → 1.0.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/.eslintrc.js +17 -17
package/.github/workflows/ci-test.yml +1 -1
package/README.md +1 -1
package/babel.config.js +1 -0
package/dist/w-comor-hapi-client.umd.js +2 -2
package/dist/w-comor-hapi-client.umd.js.map +1 -1
package/dist/w-comor-hapi-server.umd.js +2 -2
package/dist/w-comor-hapi-server.umd.js.map +1 -1
package/docs/WComorHapiClient.mjs.html +4 -1
package/docs/WComorHapiServer.mjs.html +4 -1
package/docs/global.html +33 -18
package/docs/index.html +4 -1
package/docs/scripts/collapse.js +19 -0
package/docs/scripts/commonNav.js +28 -0
package/docs/scripts/search.js +16 -0
package/docs/styles/jsdoc.css +13 -2
package/docs/styles/prettify.css +1 -0
package/package.json +6 -6

package/docs/global.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <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>
@@ -27,7 +28,9 @@
 <nav >
     <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#WComorHapiClient">WComorHapiClient</a></li><li><a href="global.html#WComorHapiServer">WComorHapiServer</a></li></ul>
 </nav>
 <div id="main">
@@ -46,6 +49,8 @@
         <h2>
         </h2>
@@ -58,6 +63,7 @@
 <dl class="details">
@@ -132,6 +138,10 @@
 <dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>建立http API使用者(Node.js與Browser)端物件</p></li></ul></dd>
     <dt class="tag-source">Source:</dt>
@@ -175,26 +185,20 @@
-<div class="description usertext">
-    <p>建立http API使用者(Node.js與Browser)端物件</p>
-</div>
-    <h5>Example</h5>
+    <h5 class="h5-examples">Example</h5>
     <pre class="prettyprint"><code>import WComorHapiClient from 'w-comor-hapi/dist/ws-client-node.umd.js'
    url: 'http://localhost:8080/api',
    token: '*',
        error: function(err) {
            console.log('client: error:', err)
        },
        reconn: function() {
            console.log('client: reconn')
        },
    .then(function(wo) {
        console.log('client: funcs: ', wo)
        function core(ps) {
            wo.group.plus(ps)
                .then(function(r) {
                    console.log('client: plus(' + JSON.stringify(ps) + ')=' + r)
                })
                .catch(function(err) {
                    console.log('client: plus: catch: ', err)
                })
            wo.group.div(ps)
                .then(function(r) {
                    console.log('client: div(' + JSON.stringify(ps) + ')=' + r)
                })
                .catch(function(err) {
                    console.log('client: div: catch: ', err)
                })
            wo.add(ps)
                .then(function(r) {
                    console.log(`client: add(${JSON.stringify(ps)})=${r}`)
                })
                .catch(function(err) {
                    console.log('client: add: catch: ', err)
                 })
            wo.minu(ps)
                .then(function(r) {
                    console.log(`client: minu(${JSON.stringify(ps)})=${r}`)
                })
                .catch(function(err) {
                    console.log('client: minu: catch: ', err)
                 })
        }
        let i = 100
        setInterval(function() {
            i += 1
            core({
                p1: i,
                p2: 10,
            })
        }, 1000)
    })
    .catch(function(err) {
        console.log('client: catch', err)
    })</code></pre>
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -228,6 +232,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -274,6 +279,7 @@
 <span class="param-type">String</span>
             </td>
@@ -313,6 +319,7 @@
 <span class="param-type">String</span>
             </td>
@@ -352,6 +359,7 @@
 <span class="param-type">function</span>
             </td>
@@ -387,6 +395,7 @@
 <span class="param-type">function</span>
             </td>
@@ -435,7 +444,7 @@
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -453,6 +462,7 @@
 <span class="param-type">Promise</span>
     </dd>
 </dl>
@@ -473,6 +483,10 @@
 <dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>建立http API伺服器</p></li></ul></dd>
     <dt class="tag-source">Source:</dt>
@@ -516,26 +530,20 @@
-<div class="description usertext">
-    <p>建立http API伺服器</p>
-</div>
-    <h5>Example</h5>
+    <h5 class="h5-examples">Example</h5>
     <pre class="prettyprint"><code>import WComorHapiServer from 'w-comor-hapi/dist/w-comor-hapi-server.umd.js'
    return Math.floor(Math.random() * max) + min
    port: 8080,
    apiName: 'api',
    authenticate: function(token) {
        //使用token驗證使用者身份
        return new Promise(function(resolve, reject) {
            setTimeout(function() {
                resolve(true)
            }, 1000)
        })
    },
    filterFuncs: function(token, funcs) {
        //使用token驗證使用者身份與過濾可用funcs
        return new Promise(function(resolve, reject) {
            funcs = funcs.filter(function(v) {
                return v.indexOf('Hide') &lt; 0
            })
            resolve(funcs)
        })
    },
    onClientChange: function(conns, opt) {
        console.log(`Server[port:${opt.port}] now conns: ${conns.length}`)
    },
    funcs: {
        'group.plus': function({ p1, p2 }) {
            return new Promise(function(resolve, reject) {
                setTimeout(function() {
                    resolve(p1 * p2)
                }, random(100, 3000))
            })
        },
        'group.div': function({ p1, p2 }) {
            return new Promise(function(resolve, reject) {
                setTimeout(function() {
                    resolve(p1 / p2)
                }, random(100, 3000))
            })
        },
        'add': function({ p1, p2 }) {
            return new Promise(function(resolve, reject) {
                setTimeout(function() {
                    resolve(p1 + p2)
                }, random(100, 3000))
            })
        },
        'addHide': function({ p1, p2 }) {
            return new Promise(function(resolve, reject) {
                setTimeout(function() {
                    resolve(p1 + p2)
                }, random(100, 3000))
            })
        },
        'minu': function({ p1, p2 }) {
            return new Promise(function(resolve, reject) {
                setTimeout(function() {
                    resolve(p1 - p2)
                }, random(100, 3000))
            })
        },
    },
    routes: [
        {
            method: 'GET',
            path: '/code',
            handler: function (req, res) {
                //console.log(req)
                return 'get code query: ' + JSON.stringify(req.query)
                //http://localhost:8080/code?a=1&amp;bb=23.45
                // => get code query: {"a":"1","bb":"23.45"}
            }
        },
    ],
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -569,6 +577,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -615,6 +624,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -654,6 +664,7 @@
 <span class="param-type">Integer</span>
             </td>
@@ -693,6 +704,7 @@
 <span class="param-type">String</span>
             </td>
@@ -732,6 +744,7 @@
 <span class="param-type">function</span>
             </td>
@@ -767,6 +780,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -806,6 +820,7 @@
 <span class="param-type">Array</span>
             </td>
@@ -881,7 +896,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Jan 19 2023 15:14:09 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.2</a> on Fri Mar 31 2023 14:29:53 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/index.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <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>
@@ -27,7 +28,9 @@
 <nav >
     <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#WComorHapiClient">WComorHapiClient</a></li><li><a href="global.html#WComorHapiServer">WComorHapiServer</a></li></ul>
 </nav>
 <div id="main">
@@ -68,7 +71,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Jan 19 2023 15:14:09 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.2</a> on Fri Mar 31 2023 14:29:53 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/scripts/collapse.js CHANGED Viewed

@@ -1,15 +1,34 @@
 function hideAllButCurrent(){
     //by default all submenut items are hidden
     //but we need to rehide them for search
+    document.querySelectorAll("nav > ul").forEach(function(parent) {
+        if (parent.className.indexOf("collapse_top") !== -1) {
+            parent.style.display = "none";
+        }
+    });
     document.querySelectorAll("nav > ul > li > ul li").forEach(function(parent) {
         parent.style.display = "none";
     });
+    document.querySelectorAll("nav > h3").forEach(function(section) {
+        if (section.className.indexOf("collapsed_header") !== -1) {
+            section.addEventListener("click", function(){
+                if (section.nextSibling.style.display === "none") {
+                    section.nextSibling.style.display = "block";
+                } else {
+                    section.nextSibling.style.display = "none";
+                }
+            });
+        }
+    });
     //only current page (if it exists) should be opened
     var file = window.location.pathname.split("/").pop().replace(/\.html/, '');
     document.querySelectorAll("nav > ul > li > a").forEach(function(parent) {
         var href = parent.attributes.href.value.replace(/\.html/, '');
         if (file === href) {
+            if (parent.parentNode.parentNode.className.indexOf("collapse_top") !== -1) {
+                parent.parentNode.parentNode.style.display = "block";
+            }
             parent.parentNode.querySelectorAll("ul li").forEach(function(elem) {
                 elem.style.display = "block";
             });

package/docs/scripts/commonNav.js ADDED Viewed

@@ -0,0 +1,28 @@
+if (typeof fetch === 'function') {
+  const init = () => {
+    if (typeof scrollToNavItem !== 'function') return false
+    scrollToNavItem()
+    // hideAllButCurrent not always loaded
+    if (typeof hideAllButCurrent === 'function') hideAllButCurrent()
+    return true
+  }
+  fetch('./nav.inc.html')
+    .then(response => response.ok ? response.text() : `${response.url} => ${response.status} ${response.statusText}`)
+    .then(body => {
+      document.querySelector('nav').innerHTML += body
+      // nav.js should be quicker to load than nav.inc.html, a fallback just in case
+      return init()
+    })
+    .then(done => {
+      if (done) return
+      let i = 0
+      ;(function waitUntilNavJs () {
+        if (init()) return
+        if (i++ < 100) return setTimeout(waitUntilNavJs, 300)
+        console.error(Error('nav.js not loaded after 30s waiting for it'))
+      })()
+    })
+    .catch(error => console.error(error))
+} else {
+  console.error(Error('Browser too old to display commonNav (remove commonNav docdash option)'))
+}

package/docs/scripts/search.js CHANGED Viewed

@@ -33,6 +33,9 @@ document.getElementById("nav-search").addEventListener("keyup", function(event)
         document.querySelectorAll("nav > ul > li").forEach(function(elem) {
             elem.style.display = "block";
         });
+        document.querySelectorAll("nav > ul").forEach(function(elem) {
+            elem.style.display = "block";
+        });
         //hide all results
         document.querySelectorAll("nav > ul > li > ul li").forEach(function(elem) {
             elem.style.display = "none";
@@ -79,5 +82,18 @@ document.getElementById("nav-search").addEventListener("keyup", function(event)
                 parent.style.display = "none";
             }
         });
+        document.querySelectorAll("nav > ul.collapse_top").forEach(function(parent) {
+            var countVisible = 0;
+            parent.querySelectorAll("li").forEach(function(elem) {
+                if (elem.style.display !== "none") {
+                    countVisible++;
+                }
+            });
+            if (countVisible == 0) {
+                //has no child at all and does not contain text
+                parent.style.display = "none";
+            }
+        });
     }
 });

package/docs/styles/jsdoc.css CHANGED Viewed

@@ -162,12 +162,19 @@ h6 {
 }
-tt, code, kbd, samp {
+tt, code, kbd, samp, pre {
   font-family: Consolas, Monaco, 'Andale Mono', monospace;
   background: #f4f4f4;
+}
+tt, code, kbd, samp{
   padding: 1px 5px;
 }
+pre {
+  padding-bottom: 1em;
+}
 .class-description {
   font-size: 130%;
   line-height: 140%;
@@ -242,6 +249,10 @@ nav h3 {
   color: #000;
 }
+nav h3.collapsed_header {
+  cursor: pointer;
+}
 nav ul {
   font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
   font-size: 100%;
@@ -762,4 +773,4 @@ html[data-search-mode] .level-hide {
     font-weight: 300;
     font-style: normal;
-}
+}

package/docs/styles/prettify.css CHANGED Viewed

@@ -76,4 +76,5 @@
 ol.linenums {
   margin-top: 0;
   margin-bottom: 0;
+  padding-bottom: 2px;
 }

package/package.json CHANGED Viewed

@@ -1,17 +1,17 @@
 {
   "name": "w-comor-hapi",
-  "version": "1.0.32",
+  "version": "1.0.33",
   "main": "dist/w-comor-hapi-server.umd.js",
   "dependencies": {
-    "@hapi/hapi": "^21.2.0",
-    "@hapi/inert": "^7.0.0",
-    "axios": "^1.2.3",
+    "@hapi/hapi": "^21.3.1",
+    "@hapi/inert": "^7.1.0",
+    "axios": "^1.3.4",
     "lodash": "^4.17.21",
-    "wsemi": "^1.6.87",
+    "wsemi": "^1.7.2",
     "xss": "^1.0.14"
   },
   "devDependencies": {
-    "w-package-tools": "^1.0.66"
+    "w-package-tools": "^1.0.69"
   },
   "scripts": {
     "test": "mocha --parallel --timeout 60000 --experimental-modules --es-module-specifier-resolution=node",