Version 2.0.0

.env.template

@@ -1,13 +1,24 @@
 # Has to be either development or production
 NODE_ENV=development
 
-# Default is 8074
-HTTP_PORT=8074
-# Defaults to 0.0.0.0 (listen on all interfaces)
-HTTP_HOST=
+# Version identifier of the current API spec (needs to be incremented on breaking changes)
+API_VERSION=v2
 
 # Gotten from creating a client on https://genius.com/api-clients
 GENIUS_ACCESS_TOKEN=
 
+# Default is 8074
+HTTP_PORT=8074
+# Defaults to 0.0.0.0 (listen on all interfaces)
+#HTTP_HOST=
+# Whether to trust upstream (reverse) proxies like nginx
+TRUST_PROXY=true
+# Defaults to true - whether to serve the documentation page
+HOST_HOMEPAGE=true
+
+# Whether one of the auth tokens below is required to be able to interact with the API
+AUTH_REQUIRED=false
 # Comma-separated list of HTTP bearer tokens that are excluded from rate limiting (on geniURL's side)
+# If you want to run the unit tests or latency test, at least one token needs to be generated and entered here
+# Generate new tokens with `pnpm gen-token [<amount> <length>]`
 AUTH_TOKENS=

.github/funding.yml

@@ -0,0 +1,3 @@
+github: Sv443
+ko_fi: Sv443
+custom: ["paypal.me/Sv443"]

.github/issue_template/1_bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Report a bug
+title: ''
+labels: bug
+assignees: Sv443
+
+---
+
+### Checklist:
+<!-- After submitting this issue, please click on the checkboxes to check them after you have done the respective task -->
+- [ ] I checked [here](https://github.com/Sv443/geniURL/issues?q=is%3Aissue+sort%3Aupdated-desc) if someone already reported the same bug
+
+
+### Description of the bug and steps to reproduce:
+<!--
+  Please write a clear and concise description of what the bug is and also include steps to reproduce it.
+  Don't shy away from going into detail, it's much more helpful than having too little info.
+-->
+
+
+### Other info / screenshots:
+<!--
+  If you have any other info that might be helpful or if you have any screenshots, please include them here.
+  You can also drag and drop any files here.
+-->

.github/issue_template/2_feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest a new or improved feature
+title: ''
+labels: enhancement
+assignees: Sv443
+
+---
+
+### Description of the feature:
+<!-- A clear and concise description of what feature you want to be added to geniURL -->
+
+
+### Other info / sketches:
+<!-- If applicable and possible, add other information or sketches to help explain your suggestion -->

.github/issue_template/3_blank.md

@@ -0,0 +1,8 @@
+---
+name: Blank issue
+about: Use this template if you don't know which one to choose
+title: ''
+labels:
+assignees: Sv443
+
+---

.github/issue_template/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  # - name: "Contributor Guide"
+  #   about: "Read the contributor guide to learn how to contribute to the project or how to create a plugin"
+  #   url: "https://github.com/Sv443/geniURL/blob/main/contributing.md"
+  - name: "Discussions"
+    about: "Open a new thread on the discussion board if you have a question, want to show off your project, etc."
+    url: "https://github.com/Sv443/geniURL/discussions"
+  - name: "Chat on Discord"
+    about: "If you want, you can also join my Discord server"
+    url: "https://dc.sv443.net"

.github/workflows/codeql.yml

@@ -12,28 +12,32 @@ on:
 jobs:
   analyze:
     name: Analyze Code
+
     runs-on: ubuntu-latest
+
+    timeout-minutes: 6
+
     permissions:
       actions: read
       contents: read
       security-events: write
 
     strategy:
       matrix:
-        language: ["javascript"]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        language: ["javascript-typescript"]
+        # CodeQL supports "c-cpp", "csharp", "go", "java-kotlin", "javascript-typescript", "python", "ruby", "swift"
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
       - name: Checkout repository and submodules
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -42,4 +46,4 @@ jobs:
           # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/deploy-docs.yml.disabled

@@ -0,0 +1,51 @@
+name: Deploy Docs
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    env:
+      DEPLOY_BRANCH: gh-pages
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          # if your docs needs submodules, uncomment the following line
+          # submodules: true
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          run_install: true
+          version: 8
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: pnpm
+
+      - name: Build
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          pnpm run build-docs
+          > www/docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy on GH Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: ${{ env.DEPLOY_BRANCH }}
+          folder: www/docs/.vuepress/dist

.github/workflows/lint-and-test.yml

@@ -0,0 +1,65 @@
+name: "Lint and run tests"
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  lint-and-test:
+    name: Lint and Test
+
+    runs-on: ubuntu-latest
+
+    timeout-minutes: 4
+
+    strategy:
+      matrix:
+        node-version: [22]
+
+    env:
+      CI: "true"
+      STORE_PATH: ""
+      PNPM_VERSION: 9
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Set up Node.js v${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Set up pnpm store directory
+        shell: bash
+        run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Set up pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        shell: bash
+        run: pnpm install
+
+      - name: Lint the code
+        shell: bash
+        run: pnpm run lint
+
+      - name: Run unit tests
+        shell: bash
+        run: |
+          echo "${{ secrets.DOTENV_FILE }}" > .env
+          pnpm run test

.gitignore

@@ -5,4 +5,14 @@ test.ts
 
 node_modules/
 *.log
-out/
+**/out/
+**/dist/
+
+**/.vuepress/.temp
+**/.vuepress/.cache
+**/.vuepress/dist
+
+*.ignore.*
+*.ignore
+
+**/latency-test-reports/

.vscode/settings.json

@@ -1,9 +1,53 @@
 {
-  "eslint.validate": [
-    "javascript",
-  ],
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.preferences.importModuleSpecifier": "non-relative",
+  "javascript.preferences.importModuleSpecifier": "non-relative",
+  "typescript.preferences.importModuleSpecifierEnding": "js",
+  "javascript.preferences.importModuleSpecifierEnding": "js",
+  "npm.packageManager": "pnpm",
+
+  "search.exclude": {
+    "**/*.user.js": true,
+    "**/BetterYTM.css": true,
+  },
   "files.associations": {
-    ".env": "dotenv",
-    ".env.template": "dotenv",
+    "*.env": "dotenv",
+    "*.env.template": "dotenv",
+  },
+  "editor.tabSize": 2,
+
+  "deno.enable": false,
+
+  // requires extension: fabiospampinato.vscode-highlight
+  "highlight.regexes": {
+    "(TODO(\\((\\s|\\d|\\w|[,.-_+*&])+\\))?:?)": { // TODO: or TODO or TODO(xy): but not todo or todo:
+      "backgroundColor": "#ed0",
+      "color": "black",
+      "overviewRulerColor": "#ed0",
+    },
+    "((//\\s*|/\\*\\s*)?#region ([^\\S\\r\\n]*[\\(\\)\\w,.\\-_&+#*'\"/:]+)*)": { //#region test: (abc):
+      "backgroundColor": "#35b5d0",
+      "color": "#000",
+      "overviewRulerColor": "#35b5d0",
+    },
+    "((<!--\\s*)?</?\\{\\{[A-Z_-]+\\}\\}>(\\s*-->)?)": { // <!-- <{{FOO}}> --> and <!-- </{{FOO}}> --> or <{{BAR}}> and </{{BAR}}>
+      "backgroundColor": "#9af",
+      "overviewRulerColor": "#9af",
+      "color": "#000",
+    },
+    "(#?(DEBUG|DBG)#?)": { // #DEBUG or DEBUG or #DBG or #DBG#
+      "backgroundColor": "#ff3",
+      "color": "blue",
+      "overviewRulerColor": "#ff3",
+    },
+    "(IMPORTANT:)": { // IMPORTANT:
+      "backgroundColor": "#f34",
+      "color": "#000",
+    },
+    "(FIXME:)": { // FIXME:
+      "backgroundColor": "#811",
+      "color": "#fff",
+      "overviewRulerColor": "#811",
+    },
   },
 }