Merge branch 'master' into 1.23.14-to-2.0.0

# Conflicts:
#	src/lang/en.json
#	src/util.js
#	src/util.ts

.devcontainer/README.md

@@ -6,7 +6,7 @@ You can modifiy Uptime Kuma in your browser without setting up a local developme
 
 1. Click `Code` -> `Create codespace on master`
 2. Wait a few minutes until you see there are two exposed ports
-3. Go to the `3000` url, see if it is working 
+3. Go to the `3000` url, see if it is working
 
 ![image](https://github.com/louislam/uptime-kuma/assets/1336778/909b2eb4-4c5e-44e4-ac26-6d20ed856e7f)
 

.devcontainer/devcontainer.json

@@ -13,9 +13,10 @@
     "customizations": {
         "vscode": {
             "extensions": [
-                "streetsidesoftware.code-spell-checker",
-                "dbaeumer.vscode-eslint"
-            ]
+				"streetsidesoftware.code-spell-checker",
+				"dbaeumer.vscode-eslint",
+				"GitHub.copilot-chat"
+			]
         }
     },
     "forwardPorts": [3000, 3001]

.dockerignore

@@ -1,7 +1,6 @@
 /.idea
 /node_modules
-/data
-/cypress
+/data*
 /out
 /test
 /kubernetes
@@ -30,7 +29,6 @@ SECURITY.md
 tsconfig.json
 .env
 /tmp
-/babel.config.js
 /ecosystem.config.js
 /extra/healthcheck.exe
 /extra/healthcheck

.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
     ignorePatterns: [
-        "test/*",
-        "server/modules/apicache/*",
+        "test/*.js",
+        "server/modules/*",
         "src/util.js"
     ],
     root: true,
@@ -14,13 +14,18 @@ module.exports = {
     extends: [
         "eslint:recommended",
         "plugin:vue/vue3-recommended",
+        "plugin:jsdoc/recommended-error",
     ],
     parser: "vue-eslint-parser",
     parserOptions: {
-        parser: "@babel/eslint-parser",
+        parser: "@typescript-eslint/parser",
         sourceType: "module",
         requireConfigFile: false,
     },
+    plugins: [
+        "jsdoc",
+        "@typescript-eslint",
+    ],
     rules: {
         "yoda": "error",
         eqeqeq: [ "warn", "smart" ],
@@ -71,7 +76,7 @@ module.exports = {
         "no-var": "error",
         "key-spacing": "warn",
         "keyword-spacing": "warn",
-        "space-infix-ops": "warn",
+        "space-infix-ops": "error",
         "arrow-spacing": "warn",
         "no-trailing-spaces": "error",
         "no-constant-condition": [ "error", {
@@ -98,7 +103,43 @@ module.exports = {
         }],
         "no-control-regex": "off",
         "one-var": [ "error", "never" ],
-        "max-statements-per-line": [ "error", { "max": 1 }]
+        "max-statements-per-line": [ "error", { "max": 1 }],
+        "jsdoc/check-tag-names": [
+            "error",
+            {
+                "definedTags": [ "link" ]
+            }
+        ],
+        "jsdoc/no-undefined-types": "off",
+        "jsdoc/no-defaults": [
+            "error",
+            { "noOptionalParamNames": true }
+        ],
+        "jsdoc/require-throws": "warn",
+        "jsdoc/require-jsdoc": [
+            "error",
+            {
+                "require": {
+                    "FunctionDeclaration": true,
+                    "MethodDefinition": true,
+                }
+            }
+        ],
+        "jsdoc/no-blank-block-descriptions": "error",
+        "jsdoc/require-returns-description": "warn",
+        "jsdoc/require-returns-check": [
+            "error",
+            { "reportMissingReturnForUndefinedTypes": false }
+        ],
+        "jsdoc/require-returns": [
+            "warn",
+            {
+                "forceRequireReturn": true,
+                "forceReturnsWithAsync": true
+            }
+        ],
+        "jsdoc/require-param-type": "warn",
+        "jsdoc/require-param-description": "warn"
     },
     "overrides": [
         {
@@ -108,21 +149,20 @@ module.exports = {
             }
         },
 
-        // Override for jest puppeteer
+        // Override for TypeScript
         {
             "files": [
-                "**/*.spec.js",
-                "**/*.spec.jsx"
+                "**/*.ts",
             ],
-            env: {
-                jest: true,
-            },
-            globals: {
-                page: true,
-                browser: true,
-                context: true,
-                jestPuppeteer: true,
-            },
+            extends: [
+                "plugin:@typescript-eslint/recommended",
+            ],
+            "rules": {
+                "jsdoc/require-returns-type": "off",
+                "jsdoc/require-param-type": "off",
+                "@typescript-eslint/no-explicit-any": "off",
+                "prefer-const": "off",
+            }
         }
     ]
 };

.github/ISSUE_TEMPLATE/ask-for-help.yaml

@@ -6,7 +6,7 @@ body:
   - type: checkboxes
     id: no-duplicate-issues
     attributes:
-      label: "⚠️ Please verify that this bug has NOT been raised before."
+      label: "⚠️ Please verify that this question has NOT been raised before."
       description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
       options:
         - label: "I checked and didn't find similar issue"
@@ -24,7 +24,7 @@ body:
       required: true
     attributes:
       label: "📝 Describe your problem"
-      description: "Please walk us through it step by step."
+      description: "Please walk us through it step by step. Include all important details and add screenshots where appropriate"
       placeholder: "Describe what are you asking for..."
   - type: textarea
     id: error-msg
@@ -56,19 +56,20 @@ body:
       placeholder: "Ex. Google Chrome 95.0.4638.69"
     validations:
       required: true
-  - type: input
-    id: docker-version
-    attributes:
-      label: "🐋 Docker Version"
-      description: "If running with Docker, which version are you running?"
-      placeholder: "Ex. Docker 20.10.9 / K8S / Podman"
-    validations:
-      required: false
-  - type: input
-    id: nodejs-version
+  - type: textarea
+    id: deployment-info
     attributes:
-      label: "🟩 NodeJS Version"
-      description: "If running with Node.js? which version are you running?"
-      placeholder: "Ex. 14.18.0"
+      label: "🖥️ Deployment Environment"
+      description: |
+        examples:
+          - **Runtime**: Docker 20.10.9 / nodejs 14.18.0 / K8S via ... v1.3.3 / ..
+          - **Database**: sqlite/embedded mariadb/external mariadb
+          - **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC
+          - **number of monitors**: 42
+      value: |
+        - Runtime: 
+        - Database: 
+        - Filesystem used to store the database on: 
+        - number of monitors: 
     validations:
-      required: false
+      required: true

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -3,14 +3,14 @@ description: "Submit a bug report to help us improve"
 #title: "[Bug] "
 labels: [bug]
 body:
-  - type: checkboxes
-    id: no-duplicate-issues
+  - type: textarea
+    id: related-issues
+    validations:
+      required: true
     attributes:
-      label: "⚠️ Please verify that this bug has NOT been raised before."
-      description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
-      options:
-        - label: "I checked and didn't find similar issue"
-          required: true
+      label: "📑 I have found these related issues/pull requests"
+      description: "Search related issues by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain what the difference between them or explain that you are unable to find any related issues"
+      placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
   - type: checkboxes
     attributes:
       label: "🛡️ Security Policy"
@@ -31,7 +31,7 @@ body:
       required: true
     attributes:
       label: "👟 Reproduction steps"
-      description: "How do you trigger this bug? Please walk us through it step by step."
+      description: "How do you trigger this bug? Please walk us through it step by step. Include all important details and add screenshots where appropriate"
       placeholder: "..."
   - type: textarea
     id: expected-behavior
@@ -73,22 +73,23 @@ body:
       placeholder: "Ex. Google Chrome 95.0.4638.69"
     validations:
       required: true
-  - type: input
-    id: docker-version
-    attributes:
-      label: "🐋 Docker Version"
-      description: "If running with Docker, which version are you running?"
-      placeholder: "Ex. Docker 20.10.9 / K8S / Podman"
-    validations:
-      required: false
-  - type: input
-    id: nodejs-version
+  - type: textarea
+    id: deployment-info
     attributes:
-      label: "🟩 NodeJS Version"
-      description: "If running with Node.js? which version are you running?"
-      placeholder: "Ex. 14.18.0"
+      label: "🖥️ Deployment Environment"
+      description: |
+        examples:
+          - **Runtime**: Docker 20.10.9 / nodejs 18.17.1 / K8S via ... v1.3.3 / ..
+          - **Database**: sqlite/embedded mariadb/external mariadb
+          - **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC
+          - **number of monitors**: 42
+      value: |
+        - Runtime: 
+        - Database: 
+        - Filesystem used to store the database on: 
+        - number of monitors: 
     validations:
-      required: false
+      required: true
   - type: textarea
     id: logs
     attributes:

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -3,25 +3,32 @@ description: "Submit a proposal for a new feature"
 #title: "[Feature] "
 labels: [feature-request]
 body:
-  - type: checkboxes
-    id: no-duplicate-issues
+  - type: textarea
+    id: related-issues
+    validations:
+      required: true
     attributes:
-      label: "⚠️ Please verify that this feature request has NOT been suggested before."
-      description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
-      options:
-        - label: "I checked and didn't find similar feature request"
-          required: true
+      label: "📑 I have found these related issues/pull requests"
+      description: "Search related issues by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain what the difference between them or explain that you are unable to find any related issues"
+      placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
   - type: dropdown
     id: feature-area
     attributes:
       label: "🏷️ Feature Request Type"
       description: "What kind of feature request is this?"
       multiple: true
       options:
-        - API
-        - New Notification
-        - New Monitor
-        - UI Feature
+        - API / automation options
+        - New notification-provider
+        - Change to existing notification-provider
+        - New monitor
+        - Change to existing monitor
+        - Dashboard
+        - Status-page
+        - Maintenance
+        - Deployment
+        - Certificate expiry
+        - Settings
         - Other
     validations:
       required: true

.github/ISSUE_TEMPLATE/security.md

@@ -12,8 +12,6 @@ labels:
 
 DO NOT PROVIDE ANY DETAILS HERE. Please privately report to https://github.com/louislam/uptime-kuma/security/advisories/new.
 
-
 Why need this issue? It is because GitHub Advisory do not send a notification to @louislam, it is a workaround to do so.
 
 Your GitHub Advisory URL:
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 ⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules:
 https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma
 
-Tick the checkbox if you understand [x]: 
+Tick the checkbox if you understand [x]:
 - [ ] I have read and understand the pull request rules.
 
 # Description
@@ -15,7 +15,7 @@ Please delete any options that are not relevant.
 - Bug fix (non-breaking change which fixes an issue)
 - User interface (UI)
 - New feature (non-breaking change which adds functionality)
-- Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- Breaking change (a fix or feature that would cause existing functionality to not work as expected)
 - Other
 - This change requires a documentation update
 
@@ -24,9 +24,8 @@ Please delete any options that are not relevant.
 - [ ] My code follows the style guidelines of this project
 - [ ] I ran ESLint and other linters for modified files
 - [ ] I have performed a self-review of my own code and tested it
-- [ ] I have commented my code, particularly in hard-to-understand areas
-  (including JSDoc for methods)
-- [ ] My changes generate no new warnings
+- [ ] I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods)
+- [ ] My changes generates no new warnings
 - [ ] My code needed automated testing. I have added them (this is optional task)
 
 ## Screenshots (if any)