Merge pull request #14 from tresabhi/1.9.1

.github/workflows/cd-docs.yml

@@ -0,0 +1,64 @@
+name: CD Docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - name: Get code
+        uses: actions/checkout@v3
+
+      - name: Use node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install Yarn
+        run: npm install --location=global yarn
+
+      - name: Use node_modules cache
+        uses: actions/cache@v3
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Build docs
+        run: yarn build:docs
+
+      - name: Configure pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/.vitepress/dist
+
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v1
+
+      - name: Archive build
+        uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: docs/.vitepress/dist

.gitignore

@@ -8,4 +8,6 @@ dist/
 yarn-error.log
 dist.zip
 commands.txt
-/test.*
+/test.*
+/docs/.vitepress/dist
+/docs/.vitepress/cache

.vscode/settings.json

@@ -6,6 +6,7 @@
     "blitzstars",
     "cleandist",
     "customperiod",
+    "Everytime",
     "fuzzysort",
     "kranvagn",
     "outfile",
@@ -28,6 +29,7 @@
     "Unicum",
     "Unregistering",
     "vickers",
+    "vitepress",
     "wargaming",
     "winrate"
   ],

docs/.vitepress/config.ts

@@ -0,0 +1,23 @@
+import { DefaultTheme, defineConfig } from 'vitepress';
+import { getSidebar } from 'vitepress-plugin-auto-sidebar';
+
+export default defineConfig({
+  title: 'blitzkrieg',
+  description: '🎉 All-in-one Discord bot for everything World of Tanks Blitz',
+  themeConfig: {
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Examples', link: '/markdown-examples' },
+    ],
+
+    sidebar: getSidebar({
+      collapsed: false,
+      contentDirs: ['guide', 'legal', 'changelogs'],
+      contentRoot: '/docs/',
+    }) as DefaultTheme.Sidebar,
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+    ],
+  },
+});

docs/.vitepress/theme/index.ts

@@ -0,0 +1,16 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import Theme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: Theme,
+  Layout: () => {
+    return h(Theme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+}

docs/.vitepress/theme/style.css

@@ -0,0 +1,91 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-brand: #646cff;
+  --vp-c-brand-light: #747bff;
+  --vp-c-brand-lighter: #9499ff;
+  --vp-c-brand-lightest: #bcc0ff;
+  --vp-c-brand-dark: #535bf2;
+  --vp-c-brand-darker: #454ce1;
+  --vp-c-brand-dimm: rgba(100, 108, 255, 0.08);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: var(--vp-c-brand-light);
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand);
+  --vp-button-brand-hover-border: var(--vp-c-brand-light);
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-light);
+  --vp-button-brand-active-border: var(--vp-c-brand-light);
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-button-brand-bg);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(40px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(72px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: var(--vp-c-brand);
+  --vp-custom-block-tip-text: var(--vp-c-brand-darker);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-dimm);
+}
+
+.dark {
+  --vp-custom-block-tip-border: var(--vp-c-brand);
+  --vp-custom-block-tip-text: var(--vp-c-brand-lightest);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-dimm);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand) !important;
+}
+

docs/changelogs/1.3.0.md

@@ -0,0 +1,9 @@
+# Blitzkrieg 1.3.0
+
+This release of Blitzkrieg focuses mainly on **performance**. Blitzkrieg now uses **Satori** and **resvg** under the hood to render images resulting in a solid **2x to 8x performance boost** depending on the situation.
+
+This only applies to `/today` and /stats` as they're the only commands that render an image currently.
+
+We're working further on **performance optimizations**. Our goal is to deliver a message within **3 seconds or less**. We're close and we'll get there!
+
+**Thank you to ba·ka**, the creator of aftermath, for telling me about Satori!

docs/changelogs/1.3.1.md

@@ -0,0 +1,8 @@
+# Blitzkrieg 1.3.1
+
+In this **minor update**, Blitzkrieg received several little **safety features** and **bug fixes**!
+
+- The bot is now more verbose
+  - Every time you use a command, the bot will now store data on what parameters you provided and if any errors were caused
+- This update also eliminates the redundant usage of truthy type checking after API calls
+  - _Hopefully_ the bot let you know why it won't respond to you

docs/changelogs/1.3.2.md

@@ -0,0 +1,5 @@
+# Blitzkrieg 1.3.2
+
+From now on, I **won't be pinging** the Blitzkrieg role for minor updates. Anyway, this **minor update** includes an optimization for `/today`. The tank icons on the left were fetched every time someone used the command. The bot now caches those images allowing for an instantaneous load.
+
+I noticed rendering times up to `3000ms` for rendering stats of about 10 tanks. Cached images should now be indifferent to this.

docs/changelogs/1.3.3.md

@@ -0,0 +1,8 @@
+# Blitzkrieg 1.3.3
+
+This **minor update** fixes a few things :partying_face:
+
+- Rating battles now no longer count in `/today`
+  - This resolves the issue where some tanks had `NaN` stats
+- Stats with the value of `-Infinity` are now ommited
+- Images are not longer cached in `dev` `env`

docs/changelogs/1.4.0.md

@@ -0,0 +1,28 @@
+# Blitzkrieg 1.4.0
+
+A **few features** :star: and a **few much needed fixes** :wrench:!
+
+## Changes
+
+- Added an "today" row to `/today` which displays your overall statistics
+- Gave `/tankstats` the new blitzkrieg look
+  - Also added "today", "60 days", and "career" stats
+- Added a beta warning to generated images
+- Updated the logo for match the new slate theme
+  - Canary versions now use the canary logo variant
+- Added subtle polka dots to the background
+
+## Fixes
+
+- Rewrote `/stats` to precisely calculate stats on a per-tank basis
+  - This should stop the bot from hallucinating about stats
+  - This should also stop the bot from giving stats from like a week ago
+  - Also added "60 day" stats
+- Tank autocomplete is now more human-tolerant just like username autocomplete
+- Titlebar discriminators are now truncated on overflow
+
+## Technical Changes
+
+- The bot now uses `bepaint`, a library that I made that standardizes the color palette
+  - Also updated the logo to follow this
+- Optimized how fonts are imported by fetching them all asynchronously

docs/changelogs/1.4.1.md

@@ -0,0 +1,3 @@
+# Blitzkrieg 1.4.1
+
+A quick fix for the `/help` command not accepting the new theme colors.

docs/changelogs/1.5.0.md

@@ -0,0 +1,23 @@
+# Blitzkrieg 1.5.0
+
+So so many **quality-of-life** changes and nasty **bug squashes**!
+
+## Changes
+
+- Added WN8 to `/today`, `/stats`, and `/tankstats`
+- Added average tier to `/stats` and `/tankstats`
+  - Average tier in `/tankstats` is simply the tier of the tank that you are looking up
+- Added an indicator of WN8 ranging from "very bad" (gray) to "super unicum" (purple)
+- Replaced ellipses with simple clipping
+- Added a "large image" warning to `/today` if displaying `6` or more tanks
+
+## Fixes
+
+- Removed random 0 that'd show up in `/today` where there was no difference between career and today's stats
+- Added stricter checks for username autocomplete via a new REGEX pattern
+- Fixed wonky ellipses that'd cut off usernames, tank names, and clan names unnecessarily
+- Fixed the delta indicator showing up in battle counts
+
+## Technical Changes
+
+- Optimized and cleaned up tankopedia cache

docs/changelogs/1.5.1.md

@@ -0,0 +1,3 @@
+# Blitzkrieg 1.5.1
+
+An emergency patch that fixes failed image caching.

docs/changelogs/1.5.2.md

@@ -0,0 +1,14 @@
+# Blitzkrieg 1.5.2
+
+Quite a few **bug fixes** with a **bunch more** on their way next update!
+
+## Fixes
+
+- Disabled image encoding as it seems to have broken in `1.5.0` and simply spams the console now
+- `/stats` now ignores tanks that don't have any averages
+  - Tanks may not have averages registered in Blitz Stars because they are new or are in testing
+  - Take a look at \_34's testing tanks in the image below
+- Fixed the "large image" prompt by simply removing the whole prompt
+  - _Kaboom? Yes Rico, kaboom._
+- `/today` now displays `--` when there is no WN8 to display
+  - This is unlike `/stats` which just shows 0 (this will be fixed soon)

docs/changelogs/1.5.3.md

@@ -0,0 +1,10 @@
+# Blitzkrieg 1.5.3
+
+Just a few more fixes that weren't that important so were deffered to this update.
+
+## Fixes
+
+- `/stats` now uses `--` just like `/today` when WN8 is not available
+- Removed an unnecessary try/catch during the execution of a command
+- Added error handling for an edge case where accounts with 0 battles were looked up
+  - This only applies to when `api/tanks/stats` is fetched; most other commands still need this fix

docs/changelogs/1.5.4.md

@@ -0,0 +1,8 @@
+# Blitzkrieg 1.5.4
+
+A last batch of fixes before the next update!
+
+## Fixes
+
+- Career WN8 in the `/today` command now accumulates the WN8 for all tanks instead of just the ones shown
+- WN8 and average tiers are now displayed in `/stats` in the `career` period

docs/changelogs/1.6.0.md

@@ -0,0 +1,25 @@
+# Blitzkrieg 1.6.0
+
+Spread the beauty! Spread the ease!
+
+## Features
+
+- Commands no longer require you to provide an username
+  - They are automatically inferred from your Discord nickname
+- Re-implemented the `/eligible` command
+  - This command checks a player's eligibility for any of the Skilled clans
+  - This command is only available in the [Skilled](https://discord.gg/ZPvcEG7DS8) and [TresAbhi Discord](https://discord.gg/nDt7AjGJQH) servers
+- Gave `/ownedtanks` and `/inactive` the new Blitzkrieg look
+- Added "Powered by Wargaming" to commands where Blitz Stars is not utilized
+
+## Fixes
+
+- Removed image encoding all together
+  - As it turns out, encoding them in `base64` made rendering slower!
+- Tank images in `/today` now don't make parent rows incorrectly taller
+- Added a "No tanks found" when a player does not own tanks in a tier
+
+## Technical Changes
+
+- Added a mature error handling system
+  - Commands can now just `throw errorWithCause(...)` without caring about the error reporting to the user

docs/changelogs/1.7.0.md

@@ -0,0 +1,20 @@
+# Blitzkrieg 1.7.0
+
+This is mostly a technical update to make migrating to cyclic.sh easier.
+
+## Changes
+
+- The bot's new deferred caching approach allows the bot to start up almost `4x` as fast
+
+## Technical Changes
+
+- Made numerous caches non-blocking
+  - Removed an unnecessary root-blocking await where fonts are imported
+    - Further improved performance by deferring font imports until after the declaration
+  - Tank averages and tankopedia are now declared fully empty only to be populated after a deferred fetch
+- Reordered error handler, client login, and client event listener registration orders
+- Removed `vite` all together
+  - This reduces bundle sizes
+  - To do this, a more primitive way of importing commands is used
+- Removed the redundant usage of `args` to get the Discord token and Wargaming Application ID on each use
+- Added a build script using `esbuild`

docs/changelogs/1.7.1.md

@@ -0,0 +1,3 @@
+# Blitzkrieg 1.7.1
+
+A hot fix to bring the bot back online with `vite-node`.

docs/changelogs/1.7.2.md

@@ -0,0 +1,7 @@
+# Blitzkrieg 1.7.2
+
+A quick, tiny, cute bug fix
+
+## Fixes
+
+- Tanks now once again show up in `/tankstats`

docs/changelogs/1.7.3-1.7.4.md

@@ -0,0 +1,3 @@
+# Blitzkrieg 1.7.3 & 1.7.4
+
+These minor updates fix compatibility issues with cyclic.

docs/changelogs/1.7.5.md

@@ -0,0 +1,11 @@
+# Blitzkrieg 1.7.5
+
+This minor release aids the migration to build-based hosting.
+
+## Technical Changes
+
+- Removed `env` logging
+- Fixed constant IDs and token naming conventions
+- Moved `esbuild` to a `js` script
+- Updated the workflow to use the latest binaries
+- Added a `zip` command for `dist`

docs/changelogs/1.7.6.md

@@ -0,0 +1,14 @@
+# Blitzkrieg 1.7.6
+
+Public service announcements and a few developer quality-of-life changes.
+
+## Changes
+
+- Added a PSA system
+  - Lets me create announcements without having to release a new update every single time
+- Added fixed choices for tank stats instead of typing in numbers like before
+
+## Technical Changes
+
+- Command executions now return a payload and the executor now fully handles the interaction replies
+- The build script now skips certain steps to speed up building time when building in dev mode

docs/changelogs/1.7.7.md

@@ -0,0 +1,7 @@
+# Blitzkrieg 1.7.7
+
+A tiny fix related to hosting.
+
+## Technical Changes
+
+- `index.cjs` is now run at root instead of `dist`

docs/changelogs/1.8.0.md

@@ -0,0 +1,26 @@
+# Blitzkrieg 1.8.0
+
+A slick new command and new potentials unlocked.
+
+## Changes
+
+- Added `/ping`
+  - Allows you to see if the bot and Blitz are alive
+- Added custom periods for `/stats`
+  - To do this, `/stats` received two sub command groups: `/stats player` and `/stats tank` (hence merging the two)
+  - All periods, including cusotm ones, now live as subcommands
+- Added tier weights to `/stats`
+- Added `/evolution`
+  - Shows your winrate and battles over a period
+
+## Fixes
+
+- `Infinity` and `NaN` values now show up as `--` in `/stats`
+- WN8 shortcomings in `/eligible` now rounds to nearest integer
+- Average tiers now, once again, show up in `/stats`
+
+## Technical Changes
+
+- Dev command names are implemented centrally in `interactionCreated`
+- Abstracted the renderers of `/stats`, `/evolution`, and `/today`
+- The bot now logs the number of server it's in on start up

docs/changelogs/1.8.1.md

@@ -0,0 +1,7 @@
+# Blitzkrieg 1.8.1
+
+A tiny oversight fixed.
+
+# Fixes
+
+- The min and max dates now show up in `/evolution`

docs/changelogs/1.9.0.md

@@ -0,0 +1,32 @@
+# Blitzkrieg 1.9.0
+
+The biggest, the baddest update yet!
+
+## Changes
+
+- Spiced up `/stats` with a graphics update
+  - This command now only shows a few of the stats as most of them were pretty pointless
+- Renamed the old `/stats` to `/statsfull`
+- Added embeds for `/stats`
+  - This is a URL that can be visited to load a "naked" variant of the command that auto-refreshes with the latest data every `60` seconds meant to be used the streamers
+- Added refresh buttons to a few commands
+  - This lets you reuse a command on the click of a button
+- Fixed many readibility issues with `/evolution` thanks to @heldenklage
+
+## Fixes
+
+- Fixed several type issues for compatibility with `express`
+
+## Technical Changes
+
+- Added a seperate `server.ts` from `bot.ts`
+  - Split builds appropriately
+- Added the ability for routes to respond with svg counterparts of commands
+- Cached `tankopedia.json` and `tankaverages.json` at build time
+  - This may be reverted in a minor release i favor of `Promise<Tankopedia>`
+- Organized files as it was important to seperate the server and the bot code
+- Split `resolvePeriod` and `resolvePlayer` for command, button, and express counterparts
+- Switched a few instances of `Number(...)` to `parseInt(...)` and `parseLong(...)`
+- Disabled canary commands for the public
+- Merged `poweredBy` footers
+- `dist` now ships with a `package.json` for Cyclic

docs/changelogs/1.9.1.md

@@ -0,0 +1,3 @@
+# Blitzkrieg 1.9.1
+
+Created a website for Blitzkrieg! Check it out: https://tresabhi.github.io/blitzkrieg/

docs/guide/install.md

@@ -0,0 +1,17 @@
+# Installing Blitzkrieg
+
+It's easy as 1, 2, 3!
+
+## Step 1
+
+Join a server that already has Blitzkrieg or [join our official Discord server](https://discord.gg/nDt7AjGJQH).
+
+## Step 2
+
+View the bot's profile and click "Add to Server".
+
+<video src="https://i.imgur.com/Zq0P3m2.mp4" autoplay loop muted width=320 title="how to install"></video>
+
+## Step 3
+
+Review the permissions the bot is asking for and add it to your server!

docs/guide/permissions.md

@@ -0,0 +1,6 @@
+# Permissions
+
+The following Discord permissions are required by the bot to ensure full functionality:
+
+- Attach files
+- View channels

docs/index.md

@@ -0,0 +1,30 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: 'blitzkrieg'
+  text: Everything Blitz, right in Discord
+  tagline: All-in-one Discord bot for everything World of Tanks Blitz
+  image:
+    src: '/assets/images/hero.png'
+    alt: 'blitzkrieg'
+  actions:
+    - theme: brand
+      text: Add to Discord Server
+      link: guide/install
+    - theme: alt
+      text: Guide
+      link: /guide
+
+features:
+  - title: Clean and Efficient UI
+    icon: 🚀
+    details: Blitzkrieg is where concise meets efficient. Get the information you need in the way you want.
+  - title: Endless Possibilities
+    icon: 🛠
+    details: With endless ways to customize the output, it's guaranteed that you'll always get the information you need.
+  - title: Easy to Use
+    icon: 💻
+    details: Leveraging Discord's, Blitz Stars', and Wargaming's powerful APIS, Blitzkrieg does all the hard work for you.
+---

docs/legal/privacy-policy.md

@@ -0,0 +1,23 @@
+# Blitzkrieg Privacy Policy
+
+Blitzkrieg collects little to no data. Regardless, here is an exhaustive list of Blitzkrieg's data collection practices.
+
+## Logs
+
+All Blitzkrieg logs are available to the public as an effort for open source transparency. A history of all logs [can be found on GitHub](https://github.com/tresabhi/blitzkrieg/actions/workflows/host.yml). All logs expire automatically and are permanently deleted after 30 days. However, anyone may chose to save a local copy of the logs which is not tracked by GitHub.
+
+## Commands
+
+Everytime a command a command is used, the command name and parameters provided is logged. Any identifying information like manually provided in-game usernames are also recorded.
+
+## Errors
+
+Everytime an error occurs, a detailed stack trace, scope of the error, and the error message is logged both in the GitHub logs and in the public channel [#🔲︱blitzkrieg-logs](https://discord.com/channels/734786591205359697/880650462540476416) in [the official Discord server](https://discord.gg/nDt7AjGJQH).
+
+## Databases
+
+No databases are used by Blitzkrieg meaning that no data is collected outside of what has already been mentioned above. This is no permanent state.
+
+## 3rd Party
+
+The privacy policies of Discord, Wargaming, and Blitz Stars apply too since they are utilized by the bot.

docs/legal/terms-of-service.md

@@ -0,0 +1,13 @@
+# Blitzkrieg Terms of Service
+
+## About
+
+Blitzkrieg is a multi-function Discord bot that serves users with needs specific to the game World of Tanks Blitz.
+
+## License
+
+Blitzkrieg is licensed under the MIT License.
+
+## 3rd Party
+
+The terms of services of Discord, Wargaming, and Blitz Stars apply too since they are utilized by the bot.

package.json

@@ -7,11 +7,14 @@
   "scripts": {
     "build:bot": "node scripts/build --build=bot",
     "build:server": "node scripts/build --build=server",
+    "build:docs": "vitepress build docs",
     "build": "node scripts/build --build=all",
     "dev:bot": "yarn build:bot --dev && yarn start:bot",
     "dev:server": "yarn build:server --dev && yarn start:server",
+    "dev:docs": "vitepress dev docs",
     "start:bot": "node --enable-source-maps --trace-warnings dist/bot.cjs",
     "start:server": "node --enable-source-maps --trace-warnings dist/server.cjs",
+    "host:docs": "vitepress preview docs",
     "zip": "zip -r dist.zip dist",
     "lint": "npx tsc"
   },
@@ -28,7 +31,8 @@
     "lodash": "^4.17.21",
     "markdown-escape": "^2.0.0",
     "react": "^18.2.0",
-    "satori": "^0.9.1"
+    "satori": "^0.9.1",
+    "vitepress-plugin-auto-sidebar": "^1.1.0"
   },
   "devDependencies": {
     "@total-typescript/ts-reset": "^0.4.2",
@@ -38,6 +42,7 @@
     "@types/markdown-escape": "^1.1.0",
     "@types/node": "^20.2.1",
     "@types/react": "^18.2.7",
-    "typescript": "^5.0.4"
+    "typescript": "^5.0.4",
+    "vitepress": "^1.0.0-beta.3"
   }
 }