feat: whitelist

api/gist.js

@@ -4,6 +4,7 @@ import {
   renderError,
   parseBoolean,
 } from "../src/common/utils.js";
+import { gistWhitelist } from "../src/common/whitelist.js";
 import { isLocaleAvailable } from "../src/translations.js";
 import { renderGistCard } from "../src/cards/gist-card.js";
 import { fetchGist } from "../src/fetchers/gist-fetcher.js";
@@ -26,6 +27,19 @@ export default async (req, res) => {
 
   res.setHeader("Content-Type", "image/svg+xml");
 
+  if (gistWhitelist && !gistWhitelist.includes(id)) {
+    return res.send(
+      renderError("This gist id is not whitelisted", "", {
+        title_color,
+        text_color,
+        bg_color,
+        border_color,
+        theme,
+        show_repo_link: false,
+      }),
+    );
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return res.send(
       renderError("Something went wrong", "Language not found", {

api/index.js

@@ -1,5 +1,6 @@
 import { renderStatsCard } from "../src/cards/stats-card.js";
 import { blacklist } from "../src/common/blacklist.js";
+import { whitelist } from "../src/common/whitelist.js";
 import {
   clampValue,
   CONSTANTS,
@@ -53,6 +54,19 @@ export default async (req, res) => {
     );
   }
 
+  if (whitelist && !whitelist.includes(username)) {
+    return res.send(
+      renderError("This username is not whitelisted", "", {
+        title_color,
+        text_color,
+        bg_color,
+        border_color,
+        theme,
+        show_repo_link: false,
+      }),
+    );
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return res.send(
       renderError("Something went wrong", "Language not found", {

api/pin.js

@@ -1,5 +1,6 @@
 import { renderRepoCard } from "../src/cards/repo-card.js";
 import { blacklist } from "../src/common/blacklist.js";
+import { whitelist } from "../src/common/whitelist.js";
 import {
   clampValue,
   CONSTANTS,
@@ -41,6 +42,19 @@ export default async (req, res) => {
     );
   }
 
+  if (whitelist && !whitelist.includes(username)) {
+    return res.send(
+      renderError("This username is not whitelisted", "", {
+        title_color,
+        text_color,
+        bg_color,
+        border_color,
+        theme,
+        show_repo_link: false,
+      }),
+    );
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return res.send(
       renderError("Something went wrong", "Language not found", {

api/top-langs.js

@@ -1,5 +1,6 @@
 import { renderTopLanguages } from "../src/cards/top-languages-card.js";
 import { blacklist } from "../src/common/blacklist.js";
+import { whitelist } from "../src/common/whitelist.js";
 import {
   clampValue,
   CONSTANTS,
@@ -48,6 +49,19 @@ export default async (req, res) => {
     );
   }
 
+  if (whitelist && !whitelist.includes(username)) {
+    return res.send(
+      renderError("This username is not whitelisted", "", {
+        title_color,
+        text_color,
+        bg_color,
+        border_color,
+        theme,
+        show_repo_link: false,
+      }),
+    );
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return res.send(renderError("Something went wrong", "Locale not found"));
   }

api/wakatime.js

@@ -6,6 +6,7 @@ import {
   parseBoolean,
   renderError,
 } from "../src/common/utils.js";
+import { whitelist } from "../src/common/whitelist.js";
 import { fetchWakatimeStats } from "../src/fetchers/wakatime-fetcher.js";
 import { isLocaleAvailable } from "../src/translations.js";
 
@@ -36,6 +37,19 @@ export default async (req, res) => {
 
   res.setHeader("Content-Type", "image/svg+xml");
 
+  if (whitelist && !whitelist.includes(username)) {
+    return res.send(
+      renderError("This username is not whitelisted", "", {
+        title_color,
+        text_color,
+        bg_color,
+        border_color,
+        theme,
+        show_repo_link: false,
+      }),
+    );
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return res.send(
       renderError("Something went wrong", "Language not found", {

src/common/utils.js

@@ -364,6 +364,7 @@ const renderError = (message, secondaryMessage = "", options = {}) => {
     bg_color,
     border_color,
     theme = "default",
+    show_repo_link = true,
   } = options;
 
   // returns theme based colors with proper overrides and defaults
@@ -388,7 +389,7 @@ const renderError = (message, secondaryMessage = "", options = {}) => {
       ERROR_CARD_LENGTH - 1
     }" height="99%" rx="4.5" fill="${bgColor}" stroke="${borderColor}"/>
     <text x="25" y="45" class="text">Something went wrong!${
-      UPSTREAM_API_ERRORS.includes(secondaryMessage)
+      UPSTREAM_API_ERRORS.includes(secondaryMessage) || !show_repo_link
         ? ""
         : " file an issue at https://tiny.one/readme-stats"
     }</text>

src/common/whitelist.js

@@ -0,0 +1,10 @@
+const whitelist = process.env.WHITELIST
+  ? process.env.WHITELIST.split(",")
+  : undefined;
+
+const gistWhitelist = process.env.GIST_WHITELIST
+  ? process.env.GIST_WHITELIST.split(",")
+  : undefined;
+
+export { whitelist, gistWhitelist };
+export default whitelist;