w-converhp 2.0.14 → 2.0.16

package/docs/WConverhpServer.mjs.html

@@ -73,6 +73,11 @@ import mergeFiles from './mergeFiles.wk.umd.js'
 // import mergeFiles from './mergeFiles.mjs'
 
 
+//回傳前端stream時(POST或GET皆可), 前端會須等stream傳完才能判斷是否為大檔或錯誤訊息, 此會導致若回傳超大檔, 會需要對超大檔進行解析會有記憶體上限問題, 故需要通過header提供基本成功或失敗訊息, 讓前端能進行解析判斷
+//回傳前端(nodejs)時, 針對超大檔, 只能用POST並用stream回傳
+//回傳前端(browser)時, 針對超大檔, 可用POST並用stream回傳但還要處理進度條, 若要交由瀏覽器下載器處理, 只能用GET並用stream回傳, 且前端只能用window.location.href或a.href+a.click()下載
+
+
 /**
  * 建立Hapi伺服器
  *
@@ -83,6 +88,7 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  * @param {String} [opt.pathStaticFiles='dist'] 輸入當useInert=true時提供瀏覽資料夾字串，預設'dist'
  * @param {String} [opt.apiName='api'] 輸入API名稱字串，預設'api'
  * @param {String} [opt.pathUploadTemp='./uploadTemp'] 輸入暫時存放切片上傳檔案資料夾字串，預設'./uploadTemp'
+ * @param {String} [opt.tokenType='Bearer'] 輸入token類型字串，預設'Bearer'
  * @param {Function} [opt.verifyConn=()=>{return true}] 輸入呼叫API時檢測函數，預設()=>{return true}
  * @param {Array} [opt.corsOrigins=['*']] 輸入允許跨域網域陣列，若給予['*']代表允許全部，預設['*']
  * @param {Integer} [opt.delayForBasic=0] 輸入基本API用延遲響應時間，單位ms，預設0
@@ -91,14 +97,24 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  * @returns {Object} 回傳事件物件，可監聽事件execute、upload、handler
  * @example
  *
+ * import fs from 'fs'
  * import _ from 'lodash-es'
- * import WConverhpServer from 'w-converhp/dist/w-converhp-server.umd.js'
+ * import w from 'wsemi'
+ * import WConverhpServer from './src/WConverhpServer.mjs'
+ *
+ * let ms = []
  *
  * let opt = {
  *     port: 8080,
  *     apiName: 'api',
  *     pathStaticFiles: '.', //要存取專案資料夾下web.html, 故不能給dist
- *     verifyConn: () => {
+ *     verifyConn: async ({ apiType, authorization, headers, query }) => {
+ *         console.log('verifyConn', `apiType[${apiType}]`, `authorization[${authorization}]`)
+ *         let token = w.strdelleft(authorization, 7) //刪除Bearer
+ *         if (!w.isestr(token)) {
+ *             return false
+ *         }
+ *         // await w.delay(3000)
  *         return true
  *     },
  * }
@@ -116,6 +132,7 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  *
  *             if (_.get(input, 'p.d.u8a', null)) {
  *                 console.log('input.p.d.u8a', input.p.d.u8a)
+ *                 ms.push({ 'input.p.d.u8a': input.p.d.u8a })
  *             }
  *
  *             let r = {
@@ -123,13 +140,7 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  *                 _data: [11, 22.22, 'abc', { x: '21', y: 65.43, z: 'test中文' }],
  *                 _bin: {
  *                     name: 'zdata.b2',
- *                     u8a: new Uint8Array([66, 97, 115]),
- *                     // name: '100mb.7z',
- *                     // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\100mb.7z')),
- *                     // name: '500mb.7z',
- *                     // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\500mb.7z')),
- *                     // name: '1000mb.7z',
- *                     // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\1000mb.7z')),
+ *                     u8a: new Uint8Array([52, 66, 97, 115]),
  *                 },
  *             }
  *
@@ -152,6 +163,7 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  *     console.log(`Server[port:${opt.port}]: upload`, input)
  *
  *     try {
+ *         ms.push({ 'receive and return': input })
  *         let output = input
  *         pm.resolve(output)
  *     }
@@ -164,29 +176,32 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  * wo.on('download', (input, pm) => {
  *     console.log(`Server[port:${opt.port}]: download`, input)
  *
+ *     let streamRead = null
  *     try {
  *         ms.push({ 'download': input })
  *
  *         //fp
  *         let fp = `./test/1mb.7z`
  *
- *         //streamRead
- *         let streamRead = fs.createReadStream(fp)
- *
- *         //fileName
- *         let fileName = `1mb.7z`
+ *         //check, 檔案存在才往下
  *
  *         //fileSize
  *         let stats = fs.statSync(fp)
  *         let fileSize = stats.size
  *
+ *         //streamRead
+ *         streamRead = fs.createReadStream(fp)
+ *
+ *         //filename
+ *         let filename = `1mb中文.7z` //測試支援中文
+ *
  *         //fileType
  *         let fileType = 'application/x-7z-compressed'
  *
  *         //output
  *         let output = {
  *             streamRead,
- *             fileName,
+ *             filename,
  *             fileSize,
  *             fileType,
  *         }
@@ -195,14 +210,27 @@ import mergeFiles from './mergeFiles.wk.umd.js'
  *     }
  *     catch (err) {
  *         console.log('download error', err)
+ *         // try {
+ *         //     streamRead.destroy() //若fs.createReadStream早於fs.statSync執行, 但fs.statSync發生錯誤時, stream得要destroy
+ *         // }
+ *         // catch (err) {}
  *         pm.reject('download error')
  *     }
  *
  * })
+ * wo.on('error', (err) => {
+ *     console.log(`Server[port:${opt.port}]: error`, err)
+ * })
  * wo.on('handler', (data) => {
  *     // console.log(`Server[port:${opt.port}]: handler`, data)
  * })
  *
+ * setTimeout(() => {
+ *     console.log('ms', ms)
+ *     // console.log('ms', JSON.stringify(ms))
+ *     wo.stop()
+ * }, 3000)
+ *
  */
 function WConverhpServer(opt = {}) {
 
@@ -230,12 +258,6 @@ function WConverhpServer(opt = {}) {
         apiName = 'api'
     }
 
-    //apiUploadSliceName
-    let apiUploadSliceName = `${apiName}slc`
-
-    //apiDownloadName
-    let apiDownloadName = `${apiName}dw`
-
     //pathUploadTemp
     let pathUploadTemp = get(opt, 'pathUploadTemp')
     if (!isestr(pathUploadTemp)) {
@@ -245,6 +267,12 @@ function WConverhpServer(opt = {}) {
         fsCreateFolder(pathUploadTemp)
     }
 
+    //tokenType
+    let tokenType = get(opt, 'tokenType')
+    if (!isestr(tokenType)) {
+        tokenType = 'Bearer'
+    }
+
     //verifyConn
     let verifyConn = get(opt, 'verifyConn')
     if (!isfun(verifyConn)) {
@@ -605,7 +633,7 @@ function WConverhpServer(opt = {}) {
 
     //apiUploadSlice
     let apiUploadSlice = {
-        path: `/${apiUploadSliceName}`,
+        path: `/${apiName}slc`,
         method: 'POST',
         options: {
             payload: {
@@ -747,7 +775,7 @@ function WConverhpServer(opt = {}) {
 
     //apiUploadSliceMerge
     let apiUploadSliceMerge = {
-        path: `/${apiUploadSliceName}m`,
+        path: `/${apiName}slcm`,
         method: 'POST',
         options: {
             payload: {
@@ -755,7 +783,7 @@ function WConverhpServer(opt = {}) {
                 maxParts: 1000 * 1000 * 1000, //預設為1000, 給予3次方
                 timeout: false, //避免請求未完成時中斷
                 // output: 'stream',
-                parse: true, //前端送obj過來
+                parse: true, //前端送obj過來須自動解析
             },
             timeout: {
                 server: false, //關閉伺服器超時
@@ -865,9 +893,263 @@ function WConverhpServer(opt = {}) {
         },
     }
 
+    //apiDownloadGetFilename
+    let apiDownloadGetFilename = {
+        path: `/${apiName}dwgfn`,
+        method: 'POST',
+        options: {
+            payload: {
+                maxBytes: 1024 * 1024 * 1024 * 1024, //預設為1mb, 調整至1tb, 也就是給予3次方
+                maxParts: 1000 * 1000 * 1000, //預設為1000, 給予3次方
+                timeout: false, //避免請求未完成時中斷
+                // output: 'stream',
+                parse: true, //前端送obj過來須自動解析
+            },
+            timeout: {
+                server: false, //關閉伺服器超時
+                socket: false, //關閉socket超時
+            },
+        },
+        handler: async function (req, res) {
+            // console.log(req, res)
+            // console.log('payload', req.payload)
+
+            //headers
+            let headers = get(req, 'headers')
+            headers = iseobj(headers) ? headers : ''
+            // console.log('headers', headers)
+
+            //query
+            let query = get(req, 'query')
+            query = iseobj(query) ? query : ''
+            // console.log('query', query)
+
+            //authorization
+            let authorization = get(headers, 'authorization', '')
+            authorization = isestr(authorization) ? authorization : ''
+
+            //check
+            if (true) {
+
+                //verifyConn
+                let m = verifyConn({ apiType: 'download-get-filename', authorization, headers, query })
+                if (ispm(m)) {
+                    m = await m
+                }
+
+                //check
+                if (m !== true) {
+                    return responseU8aStreamWithError(res, 'permission denied')
+                }
+
+            }
+
+            //eeEmit
+            eeEmit('handler', {
+                api: 'apiDownloadGetFilename',
+                headers,
+                query,
+            })
+
+            //fileId, 從payload接收
+            let fileId = get(req, 'payload.fileId', '')
+            // console.log('fileId', fileId)
+
+            //check
+            if (!isestr(fileId)) {
+                // console.log('invalid fileId in payload')
+                return responseU8aStreamWithError(res, 'invalid fileId in payload')
+            }
+
+            //inp
+            let inp = { fileId }
+
+            //procDownloadGetFilename
+            let out = {}
+            let returnType = ''
+            let returnMsg = ''
+            await procDownload(inp)
+                .then(function(msg) {
+                    out.success = msg
+                    returnType = 'success'
+                    returnMsg = 'need to parse'
+                })
+                .catch(function(msg) {
+                    out.error = msg
+                    returnType = 'error'
+                    returnMsg = 'need to parse'
+                })
+            // console.log('out', out)
+
+            //r
+            let r = get(out, 'success')
+
+            //streamRead
+            let streamRead = get(r, 'streamRead')
+
+            //destroy, 不提供stream故須預先destroy
+            try {
+                streamRead.destroy()
+            }
+            catch (err) {}
+
+            //filename
+            let filename = get(r, 'filename')
+            if (!isestr(filename)) {
+                //已於前面destroy
+                return responseU8aStreamWithError(res, 'invalid filename')
+            }
+
+            //重新提供out
+            out = {
+                success: {
+                    filename,
+                },
+            }
+
+            //u8aOut
+            let u8aOut = obj2u8arr(out)
+            // console.log('u8aOut', u8aOut)
+
+            return responseU8aStream(res, u8aOut, { returnType, returnMsg })
+        },
+    }
+
+    //apiDownloadGetFile
+    let apiDownloadGetFile = {
+        path: `/${apiName}dwgf`,
+        method: 'GET',
+        options: {
+            timeout: {
+                server: false, //關閉伺服器超時
+                socket: false, //關閉socket超時
+            },
+        },
+        handler: async function (req, res) {
+            // console.log(req, res)
+            // console.log('payload', req.payload)
+
+            //headers
+            let headers = get(req, 'headers')
+            headers = iseobj(headers) ? headers : ''
+            // console.log('headers', headers)
+
+            //query
+            let query = get(req, 'query')
+            query = iseobj(query) ? query : ''
+            // console.log('query', query)
+
+            //token
+            let token = get(query, 'token', '')
+            token = isestr(token) ? token : ''
+            // console.log('token', token)
+
+            //authorization
+            let authorization = ''
+            if (isestr(token)) {
+                authorization = `${tokenType} ${token}`
+            }
+
+            //check
+            if (true) {
+
+                //verifyConn
+                let m = verifyConn({ apiType: 'download-get-file', authorization, headers, query })
+                if (ispm(m)) {
+                    m = await m
+                }
+
+                //check
+                if (m !== true) {
+                    return responseU8aStreamWithError(res, 'permission denied')
+                }
+
+            }
+
+            //eeEmit
+            eeEmit('handler', {
+                api: 'apiDownloadGetFilename',
+                headers,
+                query,
+            })
+
+            //fileId
+            let fileId = get(query, 'fileId', '')
+            fileId = isestr(fileId) ? fileId : ''
+            // console.log('fileId', fileId)
+
+            //check
+            if (!isestr(fileId)) {
+                // console.log('invalid fileId in query')
+                return responseU8aStreamWithError(res, 'invalid fileId in query')
+            }
+
+            //inp
+            let inp = { fileId }
+
+            //procDownload
+            let out = {}
+            await procDownload(inp)
+                .then(function(msg) {
+                    out.success = msg
+                })
+                .catch(function(msg) {
+                    out.error = msg
+                })
+            // console.log('out', out)
+
+            //return
+            if (haskey(out, 'error')) {
+                // console.log('out.error', out.error)
+                return responseU8aStreamWithError(res, `can not get file from fileId`)
+            }
+
+            //r
+            let r = get(out, 'success')
+
+            //streamRead
+            let streamRead = get(r, 'streamRead')
+
+            // //filename
+            // let filename = get(r, 'filename')
+            // if (!isestr(filename)) {
+            //     return responseU8aStreamWithError(res, 'invalid filename')
+            // }
+            // filename = str2b64(filename) //headers內對中文支援度不佳須用base64傳
+            // console.log('filename', filename)
+
+            //fileSize
+            let fileSize = get(r, 'fileSize')
+            if (!isNumber(fileSize)) {
+                try {
+                    streamRead.destroy() //提供stream前發生錯誤, 得強制destroy
+                }
+                catch (err) {}
+                return responseU8aStreamWithError(res, 'invalid fileSize')
+            }
+            // fileSize = cstr(fileSize)
+
+            //fileType
+            let fileType = get(r, 'fileType')
+            if (!isestr(fileType)) {
+                try {
+                    streamRead.destroy() //提供stream前發生錯誤, 得強制destroy
+                }
+                catch (err) {}
+                return responseU8aStreamWithError(res, 'invalid fileType')
+            }
+            fileType = cstr(fileType)
+
+            return res.response(streamRead)
+                .type(fileType)
+                // .header('Content-Disposition', `attachment; filename="${filename}"`) //chrome會優先使用header內filename, 但header內支援中文度很差須用base64, 此導致chrome下載檔名只能為base64, 故一律改由前端(browser)先取得真實檔名後直接給予下載檔名, 避免用header提供真實檔名
+                .header('Content-Length', fileSize)
+        },
+    }
+
     //apiDownload
     let apiDownload = {
-        path: `/${apiDownloadName}`,
+        path: `/${apiName}dw`,
         method: 'POST',
         options: {
             payload: {
@@ -875,7 +1157,7 @@ function WConverhpServer(opt = {}) {
                 maxParts: 1000 * 1000 * 1000, //預設為1000, 給予3次方
                 timeout: false, //避免請求未完成時中斷
                 // output: 'stream',
-                parse: true, //前端送obj過來
+                parse: true, //前端送obj過來須自動解析
             },
             timeout: {
                 server: false, //關閉伺服器超時
@@ -959,16 +1241,24 @@ function WConverhpServer(opt = {}) {
             //streamRead
             let streamRead = get(r, 'streamRead')
 
-            //fileName
-            let fileName = get(r, 'fileName')
-            if (!isestr(fileName)) {
-                return responseU8aStreamWithError(res, 'invalid fileName')
+            //filename
+            let filename = get(r, 'filename')
+            if (!isestr(filename)) {
+                try {
+                    streamRead.destroy() //提供stream前發生錯誤, 得強制destroy
+                }
+                catch (err) {}
+                return responseU8aStreamWithError(res, 'invalid filename')
             }
-            fileName = str2b64(fileName) //headers內對中文支援度不佳須用base64傳
+            filename = str2b64(filename) //headers內對中文支援度不佳須用base64傳
 
             //fileSize
             let fileSize = get(r, 'fileSize')
             if (!isNumber(fileSize)) {
+                try {
+                    streamRead.destroy() //提供stream前發生錯誤, 得強制destroy
+                }
+                catch (err) {}
                 return responseU8aStreamWithError(res, 'invalid fileSize')
             }
             // fileSize = cstr(fileSize)
@@ -976,13 +1266,17 @@ function WConverhpServer(opt = {}) {
             //fileType
             let fileType = get(r, 'fileType')
             if (!isestr(fileType)) {
+                try {
+                    streamRead.destroy() //提供stream前發生錯誤, 得強制destroy
+                }
+                catch (err) {}
                 return responseU8aStreamWithError(res, 'invalid fileType')
             }
             fileType = cstr(fileType)
 
             return res.response(streamRead)
                 .type(fileType)
-                .header('Content-Disposition', `attachment; filename="${fileName}"`)
+                .header('Content-Disposition', `attachment; filename="${filename}"`) //針對前端(nodejs)用POST下載, 可基於header內base64檔名解析出並直接給予檔名, 不用預先取得檔名
                 .header('Content-Length', fileSize)
         },
     }
@@ -1018,6 +1312,8 @@ function WConverhpServer(opt = {}) {
                 apiMain,
                 apiUploadSlice,
                 apiUploadSliceMerge,
+                apiDownloadGetFilename,
+                apiDownloadGetFile,
                 apiDownload,
             ]
         }
@@ -1034,8 +1330,7 @@ function WConverhpServer(opt = {}) {
 
     //start
     if (get(opt, 'serverHapi')) {
-        // opt.serverHapi.route([apiMain, apiUploadSlice, apiUploadSliceMerge, apiDownload])
-        server.route([apiMain, apiUploadSlice, apiUploadSliceMerge, apiDownload])
+        server.route([apiMain, apiUploadSlice, apiUploadSliceMerge, apiDownloadGetFilename, apiDownloadGetFile, apiDownload])
     }
     else {
         startServer()
@@ -1068,7 +1363,7 @@ export default WConverhpServer
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Apr 08 2025 14:22:58 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 Wed Apr 09 2025 14:36:52 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -71,7 +71,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Apr 08 2025 14:22:58 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 Wed Apr 09 2025 14:36:52 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "w-converhp",
-  "version": "2.0.14",
+  "version": "2.0.16",
   "main": "dist/w-converhp-server.umd.js",
   "dependencies": {
     "@hapi/hapi": "^21.4.0",
     "@hapi/inert": "^7.1.0",
     "axios": "^1.8.4",
     "lodash-es": "^4.17.21",
-    "wsemi": "^1.7.75"
+    "wsemi": "^1.7.77"
   },
   "devDependencies": {
     "form-data": "^4.0.2",

package/scld.mjs

@@ -1,7 +1,7 @@
-import path from 'path'
-import fs from 'fs'
-import _ from 'lodash-es'
-import w from 'wsemi'
+// import path from 'path'
+// import fs from 'fs'
+// import _ from 'lodash-es'
+// import w from 'wsemi'
 import FormData from 'form-data'
 import WConverhpClient from './src/WConverhpClient.mjs'