w-web-api 1.0.52 → 1.0.53

package/server/procApis.mjs

@@ -0,0 +1,62 @@
+import iseobj from 'wsemi/src/iseobj.mjs'
+import isestr from 'wsemi/src/isestr.mjs'
+
+
+function procApis(deps = {}) {
+
+    //deps
+    let { woItems, procOrm, ds } = deps
+
+
+    let getApisList = async (userId) => {
+        return await woItems.apis.select({})
+    }
+
+
+    let saveApi = async (userId, row) => {
+
+        //check（reject err-key，由前端依 lang 反查顯示；邊界 kpFunExt 會 srLog 此 key）
+        if (!iseobj(row)) {
+            return Promise.reject('errApiRowInvalid')
+        }
+
+        //正規化：funNew 配 id/時間/預設並過濾欄位
+        let o = ds.apis.funNew(row)
+
+        //保留原 id 與創建時間（既有筆）
+        if (isestr(row.id)) {
+            o.id = row.id
+            if (isestr(row.timeCreate)) {
+                o.timeCreate = row.timeCreate
+            }
+        }
+
+        //save
+        let r = await procOrm(userId, 'apis', 'save', [o])
+
+        return r
+    }
+
+
+    let deleteApi = async (userId, id) => {
+
+        //check（reject err-key，由前端依 lang 反查顯示）
+        if (!isestr(id)) {
+            return Promise.reject('errApiIdInvalid')
+        }
+
+        let r = await procOrm(userId, 'apis', 'del', { id })
+
+        return r
+    }
+
+
+    return {
+        getApisList,
+        saveApi,
+        deleteApi,
+    }
+}
+
+
+export default procApis

package/server/procLang.mjs

@@ -247,6 +247,392 @@ let kpLang = {
         cht: '原始數據',
     },
 
+    //--- API 管理（展示/編輯/測試）---
+
+    docInput: {
+        eng: 'Input',
+        cht: '輸入參數',
+    },
+    docOutputFields: {
+        eng: 'Output fields',
+        cht: '回傳欄位',
+    },
+    docRequest: {
+        eng: 'Request',
+        cht: '請求',
+    },
+
+    tabDocs: {
+        eng: 'Docs',
+        cht: '文件',
+    },
+    tabEdit: {
+        eng: 'Edit',
+        cht: '編輯',
+    },
+    tabTest: {
+        eng: 'Test',
+        cht: '測試',
+    },
+
+    //左側垂直主選單
+    mmApi: {
+        eng: 'API',
+        cht: 'API',
+    },
+    mmStaInfor: {
+        eng: 'Statistics',
+        cht: '統計資訊',
+    },
+
+    //統計資訊頁
+    statisticsInformation: {
+        eng: 'Statistics Information',
+        cht: '統計資訊',
+    },
+    statisticsInformationDescription: {
+        eng: 'Frequency of backend logged events (APIs, kpFunExt, connection verification).',
+        cht: '後端各事件（API、kpFunExt、連線驗證）之發生頻率統計。',
+    },
+    eventFrequency: {
+        eng: 'Event Frequency',
+        cht: '事件發生頻率',
+    },
+    showIndividually: {
+        eng: 'Show individually',
+        cht: '個別顯示',
+    },
+    selectEvents: {
+        eng: 'Select events',
+        cht: '選擇事件',
+    },
+    selectAll: {
+        eng: 'All',
+        cht: '全選',
+    },
+    selectNone: {
+        eng: 'Clear',
+        cht: '清除',
+    },
+    eventStatsTable: {
+        eng: 'Event Statistics',
+        cht: '事件統計表',
+    },
+    colEvent: {
+        eng: 'Event',
+        cht: '事件',
+    },
+    colRecent1day: {
+        eng: 'Last 1 day',
+        cht: '最近1日',
+    },
+    colRecent8hr: {
+        eng: 'Last 8 hr',
+        cht: '最近8時',
+    },
+    colRecent4hr: {
+        eng: 'Last 4 hr',
+        cht: '最近4時',
+    },
+    colRecent1hr: {
+        eng: 'Last 1 hr',
+        cht: '最近1時',
+    },
+    countTotal: {
+        eng: 'Total',
+        cht: '總次數',
+    },
+    timeRange: {
+        eng: 'Time range',
+        cht: '時間範圍',
+    },
+    selectItem1hr: {
+        eng: '1 hour',
+        cht: '1小時',
+    },
+    selectItem4hr: {
+        eng: '4 hours',
+        cht: '4小時',
+    },
+    selectItem8hr: {
+        eng: '8 hours',
+        cht: '8小時',
+    },
+    selectItem1day: {
+        eng: '1 day',
+        cht: '1天',
+    },
+    noStaData: {
+        eng: 'No statistics data',
+        cht: '尚無統計資料',
+    },
+    getDataError: {
+        eng: 'Failed to get data',
+        cht: '取得資料失敗',
+    },
+
+    addApi: {
+        eng: 'New API',
+        cht: '新增API',
+    },
+    editApiTitle: {
+        eng: 'Edit API',
+        cht: '編輯API',
+    },
+    confirmDeleteApi: {
+        eng: 'Are you sure you want to delete this API?',
+        cht: '確定要刪除此API？',
+    },
+    saveSuccess: {
+        eng: 'Saved',
+        cht: '已儲存',
+    },
+    deleteSuccess: {
+        eng: 'Deleted',
+        cht: '已刪除',
+    },
+    searchApiPlaceholder: {
+        eng: 'Search API...',
+        cht: '搜尋API...',
+    },
+
+    fieldMethod: {
+        eng: 'Method',
+        cht: '方法',
+    },
+    fieldGroup: {
+        eng: 'Group',
+        cht: '群組',
+    },
+    fieldOrder: {
+        eng: 'Order',
+        cht: '順序',
+    },
+    fieldTestBaseUrl: {
+        eng: 'Test base URL',
+        cht: '測試基底網址',
+    },
+    fieldAuthType: {
+        eng: 'Auth type',
+        cht: '認證類型',
+    },
+    fieldAuthConfigJson: {
+        eng: 'Auth config (JSON)',
+        cht: '認證設定(JSON)',
+    },
+    fieldDefaultHeadersJson: {
+        eng: 'Default headers (JSON)',
+        cht: '預設標頭(JSON)',
+    },
+    fieldDefaultQueryJson: {
+        eng: 'Default query (JSON)',
+        cht: '預設查詢參數(JSON)',
+    },
+    fieldDefaultBodyJson: {
+        eng: 'Default body (JSON)',
+        cht: '預設請求內容(JSON)',
+    },
+    fieldContentType: {
+        eng: 'Content type',
+        cht: '內容類型',
+    },
+
+    hintTestBaseUrl: {
+        eng: 'Fallback request URL, used only when API url is empty. e.g. https://api.example.com',
+        cht: '送請求的後備網址：「API url」有填則優先，留空時才用此值。範例：https://api.example.com',
+    },
+    hintAuthType: {
+        eng: 'Auth auto-applied when sending. none = none; bearer / apikey / basic are built from the Auth config below.',
+        cht: '送出時自動帶入的認證方式。none＝不帶；bearer / apikey / basic 依下方「認證設定(JSON)」組出。',
+    },
+    hintAuthConfigJson: {
+        eng: 'JSON by auth type:\nbearer → {"token":"your-token"}\napikey → {"name":"X-API-Key","value":"your-key","in":"header"}  (in: header or query)\nbasic → {"username":"user","password":"pass"}',
+        cht: '依認證類型填 JSON：\nbearer → {"token":"你的token"}（留空則退用上方 tokens 欄第一個）\napikey → {"name":"X-API-Key","value":"你的key","in":"header"}（in 可為 header 或 query）\nbasic → {"username":"帳號","password":"密碼"}',
+    },
+    hintDefaultHeadersJson: {
+        eng: 'Default request headers, a JSON object. e.g. {"Accept":"application/json"}',
+        cht: '預設請求標頭，JSON 物件。範例：{"Accept":"application/json"}',
+    },
+    hintDefaultQueryJson: {
+        eng: 'Default query params, a JSON object. e.g. {"page":"1","size":"20"}',
+        cht: '預設查詢參數，JSON 物件。範例：{"page":"1","size":"20"}',
+    },
+    hintDefaultBodyJson: {
+        eng: 'Default request body (for POST/PUT); falls back to Input example if empty. e.g. {"name":"foo"}',
+        cht: '預設請求內容（POST/PUT 用），留空則退用「輸入範例」。範例：{"name":"小明"}',
+    },
+    hintContentType: {
+        eng: 'Request content type, added as a Content-Type header. e.g. application/json',
+        cht: '請求內容類型，會帶成 Content-Type 標頭。範例：application/json',
+    },
+
+    authNone: {
+        eng: 'None',
+        cht: '無',
+    },
+    authBearer: {
+        eng: 'Bearer token',
+        cht: 'Bearer token',
+    },
+    authApikey: {
+        eng: 'API key',
+        cht: 'API key',
+    },
+    authBasic: {
+        eng: 'Basic',
+        cht: 'Basic',
+    },
+
+    secBasic: {
+        eng: 'Basic',
+        cht: '基本資訊',
+    },
+    secDocs: {
+        eng: 'Documentation',
+        cht: '文件說明',
+    },
+    secTest: {
+        eng: 'Test settings',
+        cht: '測試設定',
+    },
+
+    reqSend: {
+        eng: 'Send',
+        cht: '送出請求',
+    },
+    reqUrlPlaceholder: {
+        eng: 'Request URL',
+        cht: '請求網址',
+    },
+    reqQuery: {
+        eng: 'Query params',
+        cht: '查詢參數',
+    },
+    reqHeaders: {
+        eng: 'Headers',
+        cht: '標頭',
+    },
+    reqBody: {
+        eng: 'Body',
+        cht: '請求內容',
+    },
+    reqAddRow: {
+        eng: 'Add',
+        cht: '新增一列',
+    },
+    colKey: {
+        eng: 'Key',
+        cht: '鍵',
+    },
+    colValue: {
+        eng: 'Value',
+        cht: '值',
+    },
+    colOn: {
+        eng: 'On',
+        cht: '啟用',
+    },
+
+    resTitle: {
+        eng: 'Response',
+        cht: '回應',
+    },
+    resStatus: {
+        eng: 'Status',
+        cht: '狀態碼',
+    },
+    resTime: {
+        eng: 'Time',
+        cht: '耗時',
+    },
+    resHeaders: {
+        eng: 'Response headers',
+        cht: '回應標頭',
+    },
+    resBody: {
+        eng: 'Response body',
+        cht: '回應內容',
+    },
+    resEmpty: {
+        eng: 'No response yet. Click Send to test.',
+        cht: '尚無回應，點擊送出請求進行測試。',
+    },
+
+    valRequired: {
+        eng: 'This field is required',
+        cht: '此欄位必填',
+    },
+    valInvalidJson: {
+        eng: 'Invalid JSON format',
+        cht: 'JSON格式錯誤',
+    },
+
+    //後端錯誤 err-key（後端 reject 此 key、srLog 此 key；前端依當前 lang 反查下列文字顯示）
+    errReqUrlInvalid: {
+        eng: 'The request URL is invalid (must start with http:// or https://)',
+        cht: '請求網址無效（須以 http:// 或 https:// 開頭）',
+    },
+    errReqTargetNotAllowed: {
+        eng: 'The target address is not allowed',
+        cht: '目標位址不被允許',
+    },
+    errProxyRequestFailed: {
+        eng: 'The request failed to send',
+        cht: '請求發送失敗',
+    },
+    errApiRowInvalid: {
+        eng: 'Invalid API data',
+        cht: 'API 資料無效',
+    },
+    errApiIdInvalid: {
+        eng: 'Invalid API id',
+        cht: 'API id 無效',
+    },
+    errUserIdMissing: {
+        eng: 'Unable to get user id',
+        cht: '無法取得使用者 id',
+    },
+    errUserEmailMissing: {
+        eng: 'Unable to get user email',
+        cht: '無法取得使用者 email',
+    },
+    errUserNameMissing: {
+        eng: 'Unable to get user name',
+        cht: '無法取得使用者名稱',
+    },
+    errUserRoleMissing: {
+        eng: 'Unable to get user role',
+        cht: '無法取得使用者權限',
+    },
+    errUserNoPermission: {
+        eng: 'User does not have permission',
+        cht: '使用者沒有權限',
+    },
+    errUserNotFound: {
+        eng: 'Unable to find user from token',
+        cht: '無法依 token 找到使用者',
+    },
+    errPayloadInvalid: {
+        eng: 'Invalid request payload',
+        cht: '請求內容無效',
+    },
+    errGroupInvalid: {
+        eng: 'Invalid group',
+        cht: '群組無效',
+    },
+    errRowsInvalid: {
+        eng: 'Invalid rows',
+        cht: '資料列無效',
+    },
+    errTokenNoPermission: {
+        eng: 'Token does not have permission',
+        cht: 'token 沒有權限',
+    },
+    errKeyTableInvalid: {
+        eng: 'Invalid table',
+        cht: '資料表無效',
+    },
+
 }
 
 

package/server/procProxy.mjs

@@ -0,0 +1,120 @@
+import get from 'lodash-es/get.js'
+import isestr from 'wsemi/src/isestr.mjs'
+import isobj from 'wsemi/src/isobj.mjs'
+import axios from 'axios'
+
+
+function procProxy(opt = {}) {
+
+    //srLog（後端 log；錯誤一律 log err-key，axios 例外另 log 真實訊息供排查）
+    let srLog = get(opt, 'srLog', null)
+
+    //isAllowTarget
+    let isAllowTarget = get(opt, 'isAllowTarget', null)
+
+
+    let proxyRequest = (inp = {}) => {
+        return new Promise(async (resolve, reject) => {
+
+            //method
+            let method = get(inp, 'method', 'GET')
+            if (!isestr(method)) {
+                method = 'GET'
+            }
+            method = method.toUpperCase()
+
+            //url
+            let url = get(inp, 'url', '')
+            if (!isestr(url)) {
+                reject('errReqUrlInvalid')
+                return
+            }
+            if (!url.startsWith('http://') && !url.startsWith('https://')) {
+                reject('errReqUrlInvalid')
+                return
+            }
+
+            //isAllowTarget check
+            if (typeof isAllowTarget === 'function') {
+                let allowed = isAllowTarget(url)
+                if (allowed === false) {
+                    reject('errReqTargetNotAllowed')
+                    return
+                }
+            }
+
+            //headers
+            let headers = get(inp, 'headers', {})
+            if (!isobj(headers)) {
+                headers = {}
+            }
+            //移除 host 與 content-length (交給 axios)
+            delete headers['host']
+            delete headers['Host']
+            delete headers['content-length']
+            delete headers['Content-Length']
+
+            //query
+            let query = get(inp, 'query', null)
+            let params = null
+            if (isobj(query) && Object.keys(query).length > 0) {
+                params = query
+            }
+
+            //body
+            let body = get(inp, 'body', undefined)
+            let data = undefined
+            if (method !== 'GET' && method !== 'HEAD') {
+                if (body !== undefined) {
+                    data = body
+                }
+            }
+
+            //timeout
+            let timeout = get(inp, 'timeout', 30000)
+            if (typeof timeout !== 'number' || timeout <= 0) {
+                timeout = 30000
+            }
+
+            //send
+            let t0 = Date.now()
+            try {
+                let res = await axios({
+                    method,
+                    url,
+                    headers,
+                    params,
+                    data,
+                    timeout,
+                    validateStatus: () => true,
+                })
+
+                let durationMs = Date.now() - t0
+
+                resolve({
+                    status: res.status,
+                    statusText: res.statusText,
+                    headers: res.headers,
+                    data: res.data,
+                    durationMs,
+                })
+            }
+            catch (err) {
+                //axios 例外（timeout/DNS 等）：log 真實訊息供排查，但回前端只給 err-key（前端依 lang 顯示）
+                if (srLog) {
+                    srLog.error({ event: 'proxyRequest-axios', msg: get(err, 'message', String(err)) })
+                }
+                reject('errProxyRequestFailed')
+            }
+
+        })
+    }
+
+
+    return {
+        proxyRequest,
+    }
+}
+
+
+export default procProxy

package/server/srLog.mjs

@@ -0,0 +1,30 @@
+import get from 'lodash-es/get.js'
+import isestr from 'wsemi/src/isestr.mjs'
+import WSyslog from 'w-syslog/src/WSyslog.mjs'
+
+
+//後端 log（比照 w-web-sso server/srLog.mjs）：包 w-syslog，依時段輪檔寫入 ./_logs。
+//用法：srLog.info({ event, ... }) / srLog.warn({...}) / srLog.error({ event, err, ... })。
+//錯誤一律 log 其 err key（對齊「後端錯誤須 log err key」原則），供事後識別。
+let init = (opt = {}) => {
+
+    let fdLog = get(opt, 'logFd', '')
+    if (!isestr(fdLog)) {
+        fdLog = './_logs'
+    }
+
+    let interval = get(opt, 'logInterval', '')
+    if (!isestr(interval)) {
+        interval = 'hr'
+    }
+
+    let srLog = WSyslog({
+        fdLog,
+        interval,
+    })
+
+    return srLog
+}
+
+
+export default init