backend: add a new hideBg query parameter

Author: 0l1v3rr

README.md

@@ -57,6 +57,7 @@ None of the fields are required. Every query parameter has a default value displ
 | **theme** | `?theme=github_dark` | github | The theme of the card. You can browse between the themes [here](docs/THEMES.md). |
 | **align** | `?align=center` | left | The alignment of the badges. (`left`, `center`, `right`) |
 | **showBorder** | `?showBorder=false` | true | Display the border around the card or not. (`true`, `false`) |
+| **hideBg** | `?hideBg=true` | false | If true, sets the background to transparent. (`true`, `false`) |
 | **borderRadius** | `?borderRadius=12.5` | 4.5 | Number between 0 and 50. |
 | **fontFamily** | `?fontFamily=consolas` | Segoe UI | The font family of the title. If the specified family doesn't exist, the default is used. |
 | **fontSize** | `?fontSize=20` | 18 | The size of the title. Accepts a number between 15 and 30. |

src/cards/card-builder.ts

@@ -144,6 +144,17 @@ export default class CardBuilder {
     return this;
   }
 
+  public hideBackground(hb = "false"): CardBuilder {
+    if (hb.toString() === "true") {
+      this.card.setTheme({
+        ...this.card.getTheme(),
+        backgroundColor: "#00000000",
+      });
+    }
+
+    return this;
+  }
+
   public lines(
     cb: (line: number, addBadge: (b: Badge) => void) => void
   ): CardBuilder {

src/controllers/cards-controller.ts

@@ -21,6 +21,7 @@ export const getCard = async (req: Request, res: Response) => {
     border,
     badge,
     titleColor,
+    hideBg,
   } = req.query;
 
   const card = new CardBuilder()
@@ -47,6 +48,7 @@ export const getCard = async (req: Request, res: Response) => {
     .borderColor(border?.toString())
     .badgeColor(badge?.toString())
     .titleColor(titleColor?.toString())
+    .hideBackground(hideBg?.toString())
     .build();
 
   res.setHeader("Content-Type", "image/svg+xml");