sumor 1.3.0 → 2.0.0

package/.eslintignore

@@ -0,0 +1,6 @@
+coverage
+node_modules
+web/public
+static
+tmp
+apiExplorer

package/.eslintrc.yml

@@ -0,0 +1,4 @@
+root: true
+extends:
+  - standard
+  - plugin:prettier/recommended

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/.github/workflows/audit.yml

@@ -0,0 +1,22 @@
+name: Audit
+on:
+  schedule:
+    - cron: '0 * * * *'
+jobs:
+  audit:
+    name: Audit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install NPM dependencies
+        run: npm ci
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Run NPM audit
+        run: npm audit

package/.github/workflows/available.yml

@@ -0,0 +1,22 @@
+name: Available
+on:
+  schedule:
+    - cron: '*/1 * * * *'
+jobs:
+  install:
+    name: NPM Installation Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install NPM dependencies
+        run: npm i sumor
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Dependency Check
+        run: npm ls
+      - name: Audit
+        run: npm audit

package/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+jobs:
+  check:
+    name: Code Quality Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install NPM dependencies
+        run: npm ci
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Syntax specification checking using ESLint
+        run: npm run lint
+      - name: Run NPM audit
+        run: npm audit
+  test:
+    name: Unit Test
+    needs: check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install NPM dependencies
+        run: npm ci
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Unit test using Jest
+        run: npm test

package/.github/workflows/coverage.yml

@@ -0,0 +1,23 @@
+name: Coverage
+on:
+  push:
+    branches:
+      - main
+jobs:
+  test:
+    name: Unit Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install NPM dependencies
+        run: npm ci
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Unit test with coverage using Jest
+        run: npm run coverage

package/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish
+on:
+  push:
+    tags:
+      - '*'
+jobs:
+  publish:
+    name: Publish to NPM
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install NPM dependencies
+        run: npm ci
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Syntax specification checking using ESLint
+        run: npm run lint
+      - name: Run NPM audit
+        run: npm audit
+      - name: Unit test with coverage using Jest
+        run: npm test
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/ut.yml

@@ -0,0 +1,24 @@
+name: Test
+on:
+  schedule:
+    - cron: '0 * * * *'
+jobs:
+  test:
+    name: Unit test for latest dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Remove package-lock.json
+        run: rm -f package-lock.json
+      - name: Install NPM dependencies
+        run: npm i
+      - name: Check dependencies size
+        run: du -sh node_modules
+      - name: Unit test using Jest
+        run: npm run test

package/.husky/pre-commit

@@ -0,0 +1,10 @@
+#!/bin/sh
+#
+# 在运行 pre-commit 脚本之前打印消息
+echo "正在运行 pre-commit 脚本..."
+
+# 运行 pre-commit 命令
+npm run pre-commit
+
+# 在运行 pre-commit 脚本之后打印消息
+echo "pre-commit 脚本运行完成。"

package/.husky/pre-push

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# 在运行 pre-push 脚本之前打印消息
+echo "正在运行 pre-push 脚本..."
+
+# 运行 pre-push 命令
+npm run pre-push
+
+# 在运行 pre-push 脚本之后打印消息
+echo "pre-push 脚本运行完成。"

package/.prettierrc.yml

@@ -0,0 +1,7 @@
+singleQuote: true
+semi: false
+tabWidth: 2
+printWidth: 100
+trailingComma: none
+arrowParens: avoid
+endOfLine: lf

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sumor Cloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/demo/api/error.js

@@ -0,0 +1,3 @@
+export default (req, res) => {
+  throw new Error('This is an error')
+}

package/demo/api/file.js

@@ -0,0 +1,4 @@
+export default (req, res) => {
+  // const file = req.data.file
+  return req.data
+}

package/demo/api/file.yaml

@@ -0,0 +1,11 @@
+name: File
+methods:
+  - POST
+  - GET
+parameters:
+  file:
+    name: 文件
+    type: file
+    required: true
+  id:
+    name: 上传请求号

package/demo/api/hello.js

@@ -0,0 +1,4 @@
+export default (req, res) => {
+  const name = req.data.name
+  return `Hello ${name}!`
+}

package/demo/api/hello.yaml

@@ -0,0 +1,13 @@
+name: Hello
+path:
+  - /hello
+  - /hello/:name
+parameters:
+  name:
+    name: 姓名
+    type: string
+    required: true
+    rules:
+      CHARACTER_LIMIT:
+        expression: '^[a-zA-Z][a-zA-Z0-9_]{0,19}$'
+        message: '姓名只能包含字母、数字和下划线，且不能以数字开头，长度在1-20个字符之间'

package/demo/api/login.js

@@ -0,0 +1,4 @@
+export default (req, res, next) => {
+  req.token.id = 'DEMO_TOKEN'
+  req.token.user = 'DEMO_USER'
+}

package/demo/api/logout.js

@@ -0,0 +1,4 @@
+export default (req, res, next) => {
+  req.token.id = 'DEMO_TOKEN'
+  req.token.user = 'DEMO_USER'
+}

package/demo/api/long.js

@@ -0,0 +1,9 @@
+export default (req, res) => {
+  const times = 100
+  let result = ''
+  for (let i = 0; i < times; i++) {
+    result += 'Hello!'
+  }
+
+  return result
+}

package/demo/api/long.yaml

@@ -0,0 +1,2 @@
+methods:
+  - GET

package/demo/api/user/admin.js

@@ -0,0 +1,12 @@
+export default async (req, res) => {
+  const { token } = req
+
+  token.id = 'DEMO_TOKEN'
+  token.user = 'DEMO_USER'
+
+  token.check('ADMIN')
+
+  return {
+    name: 'John Doe'
+  }
+}

package/demo/api/user/info.js

@@ -0,0 +1,8 @@
+export default async (req, res) => {
+  const { token } = req
+  token.check()
+
+  return {
+    name: 'John Doe'
+  }
+}

package/demo/config/config.yaml

@@ -0,0 +1,2 @@
+name: demo
+desc: 示例应用，用于测试和演示

package/demo/i18n/demo.yaml

@@ -0,0 +1 @@
+name: 测试

package/demo/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "scripts": {
+    "start": "../src/cli.js start"
+  }
+}

package/i18n/README.md

@@ -0,0 +1,32 @@
+# 国际化配置
+
+## 原始配置
+
+以 `<命名空间>.yaml` 的形式创建配置文件
+文件内容示例：
+
+```yaml
+NAME: Demo
+```
+
+## 国际化
+
+在i18nExt目录，以 `<命名空间>.<语言代码>.yaml` 的形式创建配置文件。
+根据原始配置，创建对应翻译后的国际化配置
+
+建议支持语言代码如下
+
+```yaml
+- zh // 简体中文
+  zh-TW // 繁体中文
+  en // 通用英语
+  de // 德语
+  es
+  fr
+  it
+  ja
+  ko
+  pt
+  ru
+  tr
+```

package/i18n/sumor_api.yaml

@@ -0,0 +1,16 @@
+API_ERROR_SHOW_MORE: '显示更多技术细节'
+API_CALL_SHOW_MORE: '显示调用详细结果'
+API_CALL_DEFAULT_TITLE: '接口调用成功'
+API_ERROR_UNKNOWN_ERROR: '接口异常，请稍后重试'
+API_ERROR_UNKNOWN_MESSAGE: '接口异常，详细错误信息请查看如下。 路径为：{path}'
+API_METHOD_NOT_ALLOWED: '接口监听路径 {path} 请求方法 {methods} 不允许，已被忽略'
+API_REGISTERED: '接口监听路径 {path}{name} 成功'
+API_REGISTERED_FAILED: '接口监听路径 {path} 失败，程序加载异常'
+API_PROGRAM_WRONG: '程序加载异常'
+API_NOT_FOUND: '接口未找到'
+API_NOT_FOUND_DETAIL: '接口未找到，请检查路径是否正确'
+API_PARAMETERS_NOT_VALID: '数据不符合要求，请检查调用接口传入参数'
+API_PARAMETER_NOT_VALID: '参数{key}的数据不符合要求'
+API_PARAMETER_REQUIRED: '必填项'
+API_PARAMETER_TOO_LONG: '长度不能超过{length}个字符'
+API_CALLED: '接口{path}被调用，数据为{data}'

package/i18n/sumor_app.yaml

@@ -0,0 +1,3 @@
+APP_STARTING: '轻呈云应用正在启动...'
+APP_STARTED: '轻呈云应用已启动，运行在 http://localhost:{port}'
+I18N_REGISTERED: 'i18n 已为命名空间 {namespace} 注册'

package/i18n/sumor_internal.yaml

@@ -0,0 +1 @@
+TEST: 'Test {value}'

package/i18n/sumor_token.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: '登陆已过期，请重新登录'
+PERMISSION_DENIED: '权限不足，缺少{permission}权限'

package/i18nExt/sumor_api.de.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: 'Mehr technische Details anzeigen'
+API_ERROR_UNKNOWN_ERROR: 'Schnittstellenfehler, bitte versuchen Sie es später erneut'
+API_ERROR_UNKNOWN_MESSAGE: 'Schnittstellenfehler, detaillierte Fehlerinformationen finden Sie unten. Pfad: {path}'

package/i18nExt/sumor_api.en.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: 'Show more technical details'
+API_ERROR_UNKNOWN_ERROR: 'Interface error, please try again later'
+API_ERROR_UNKNOWN_MESSAGE: 'Interface error, detailed error information can be found below. Path: {path}'

package/i18nExt/sumor_api.es.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: 'Mostrar más detalles técnicos'
+API_ERROR_UNKNOWN_ERROR: 'Error de interfaz, inténtelo de nuevo más tarde'
+API_ERROR_UNKNOWN_MESSAGE: 'Error de interfaz, la información detallada del error se puede ver a continuación. Ruta: {path}'

package/i18nExt/sumor_api.fr.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: 'Afficher plus de détails techniques'
+API_ERROR_UNKNOWN_ERROR: "Erreur d'interface, veuillez réessayer plus tard"
+API_ERROR_UNKNOWN_MESSAGE: "Erreur d'interface, les informations détaillées sur l'erreur sont disponibles ci-dessous. Chemin : {path}"

package/i18nExt/sumor_api.it.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: 'Mostra più dettagli tecnici'
+API_ERROR_UNKNOWN_ERROR: 'Errore di interfaccia, riprova più tardi'
+API_ERROR_UNKNOWN_MESSAGE: "Errore di interfaccia, le informazioni dettagliate sull'errore sono disponibili di seguito. Percorso: {path}"

package/i18nExt/sumor_api.ja.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: '詳細な技術情報を表示'
+API_ERROR_UNKNOWN_ERROR: 'インターフェースエラー、後でもう一度お試しください'
+API_ERROR_UNKNOWN_MESSAGE: 'インターフェースエラー、詳細なエラー情報は以下をご覧ください。 パス：{path}'

package/i18nExt/sumor_api.ko.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: '기술 세부정보 더 보기'
+API_ERROR_UNKNOWN_ERROR: '인터페이스 오류, 나중에 다시 시도하세요'
+API_ERROR_UNKNOWN_MESSAGE: '인터페이스 오류, 자세한 오류 정보는 아래를 참조하세요. 경로: {path}'

package/i18nExt/sumor_api.pt.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: 'Mostrar mais detalhes técnicos'
+API_ERROR_UNKNOWN_ERROR: 'Erro de interface, tente novamente mais tarde'
+API_ERROR_UNKNOWN_MESSAGE: 'Erro de interface, informações detalhadas do erro podem ser vistas abaixo. Caminho: {path}'

package/i18nExt/sumor_api.zh-TW.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: '顯示更多技術細節'
+API_ERROR_UNKNOWN_ERROR: '介面異常，請稍後重試'
+API_ERROR_UNKNOWN_MESSAGE: '介面異常，詳細錯誤資訊請參考如下。 路徑為：{path}'

package/i18nExt/sumor_api.zh.yaml

@@ -0,0 +1,3 @@
+API_ERROR_SHOW_MORE: '显示更多技术细节'
+API_ERROR_UNKNOWN_ERROR: '接口异常，请稍后重试'
+API_ERROR_UNKNOWN_MESSAGE: '接口异常，详细错误信息请查看如下。 路径为：{path}'

package/i18nExt/sumor_app.de.yaml

@@ -0,0 +1,3 @@
+APP_STARTING: 'Sumor App startet...'
+APP_STARTED: 'Sumor App gestartet, läuft auf http://localhost:{port}'
+I18N_REGISTERED: 'i18n für Namespace {namespace} registriert'

package/i18nExt/sumor_app.en.yaml

@@ -0,0 +1,3 @@
+APP_STARTING: 'Sumor App starting...'
+APP_STARTED: 'Sumor App started, running on http://localhost:{port}'
+I18N_REGISTERED: 'i18n registered for namespace {namespace}'

package/i18nExt/sumor_app.es.yaml

@@ -0,0 +1,3 @@
+APP_STARTING: 'Sumor App iniciando...'
+APP_STARTED: 'Sumor App iniciado, ejecutándose en http://localhost:{port}'
+I18N_REGISTERED: 'i18n registrado para el espacio de nombres {namespace}'

package/i18nExt/sumor_app.zh-TW.yaml

@@ -0,0 +1,3 @@
+APP_STARTING: 'Sumor 應用啟動中...'
+APP_STARTED: 'Sumor 應用已啟動，運行在 http://localhost:{port}'
+I18N_REGISTERED: 'i18n 已為命名空間 {namespace} 註冊'

package/i18nExt/sumor_app.zh.yaml

@@ -0,0 +1,3 @@
+APP_STARTING: 'Sumor 应用启动中...'
+APP_STARTED: 'Sumor 应用已启动，运行在 http://localhost:{port}'
+I18N_REGISTERED: 'i18n 已为命名空间 {namespace} 注册'

package/i18nExt/sumor_internal.de.yaml

@@ -0,0 +1 @@
+TEST: 'Test {value}'

package/i18nExt/sumor_internal.en.yaml

@@ -0,0 +1 @@
+TEST: 'Test {value}'

package/i18nExt/sumor_internal.es.yaml

@@ -0,0 +1 @@
+TEST: 'Prueba {value}'

package/i18nExt/sumor_internal.zh-TW.yaml

@@ -0,0 +1 @@
+TEST: '測試 {value}'

package/i18nExt/sumor_internal.zh.yaml

@@ -0,0 +1 @@
+TEST: '测试 {value}'

package/i18nExt/sumor_token.de.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'Anmeldung abgelaufen'
+PERMISSION_DENIED: 'Zugriff verweigert: {permission}'

package/i18nExt/sumor_token.es.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'La sesión ha expirado'
+PERMISSION_DENIED: 'Permiso denegado: {permission}'

package/i18nExt/sumor_token.fr.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'La session a expiré'
+PERMISSION_DENIED: 'Autorisation refusée : {permission}'

package/i18nExt/sumor_token.it.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'La sessione è scaduta'
+PERMISSION_DENIED: 'Permesso negato: {permission}'

package/i18nExt/sumor_token.ja.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'ログインの有効期限が切れました'
+PERMISSION_DENIED: '権限がありません: {permission}'

package/i18nExt/sumor_token.ko.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: '로그인 만료'
+PERMISSION_DENIED: '권한이 없습니다: {permission}'

package/i18nExt/sumor_token.pt.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'Sessão expirada'
+PERMISSION_DENIED: 'Permissão negada: {permission}'

package/i18nExt/sumor_token.ru.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'Время сеанса истекло'
+PERMISSION_DENIED: 'Доступ запрещен: {permission}'

package/i18nExt/sumor_token.tr.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: 'Oturum süresi doldu'
+PERMISSION_DENIED: 'İzin reddedildi: {permission}'

package/i18nExt/sumor_token.zh-TW.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: '登入已過期'
+PERMISSION_DENIED: '權限不足: {permission}'

package/i18nExt/sumor_token.zh.yaml

@@ -0,0 +1,2 @@
+LOGIN_EXPIRED: '登陆已过期，请重新登录'
+PERMISSION_DENIED: '权限不足，缺少{permission}权限'

package/jest.config.json

@@ -0,0 +1,26 @@
+{
+  "maxWorkers": 10,
+  "reporters": [
+    "default",
+    [
+      "jest-html-reporter",
+      {
+        "pageTitle": "Test Report",
+        "outputPath": "./output/unit/index.html"
+      }
+    ]
+  ],
+  "coverageThreshold": {
+    "global": {
+      "branches": 80,
+      "functions": 80,
+      "lines": 80,
+      "statements": 80
+    }
+  },
+  "coverageDirectory": "output/test/all/coverage",
+  "coverageReporters": ["json", "lcov", "text", "clover"],
+  "collectCoverageFrom": ["modules/**/*.js"],
+  "testPathIgnorePatterns": ["node_modules", "output", "static", "dist", "tmp"],
+  "coveragePathIgnorePatterns": ["node_modules", "output", "static", "dist", "tmp"]
+}