@stats-organization/github-readme-stats-core 2.1.4 → 2.2.0

package/src/api/top-langs.js

@@ -1,4 +1,5 @@
 import { renderTopLanguages } from "../cards/top-languages.js";
+import { findInvalidColorParam, pickColorParams } from "../common/color.js";
 import {
   MissingParamError,
   retrieveSecondaryMessage,
@@ -16,11 +17,6 @@ export default async (
     hide_title,
     hide_border,
     card_width,
-    title_color,
-    text_color,
-    bg_color,
-    prog_bar_bg_color,
-    theme,
     layout,
     langs_count,
     exclude_repo,
@@ -29,70 +25,76 @@ export default async (
     custom_title,
     locale,
     border_radius,
-    border_color,
     role,
     disable_animations,
     hide_progress,
     hide_values,
     stats_format,
+    ...remainingParams
   },
   pat = null,
 ) => {
+  const colorParams = pickColorParams(remainingParams);
+
+  const invalidColorInput = findInvalidColorParam(colorParams);
+
+  if (invalidColorInput) {
+    return {
+      status: "error - permanent",
+      content: renderError({
+        message: "Something went wrong",
+        secondaryMessage: `Invalid color input for parameter "${invalidColorInput}"`,
+      }),
+    };
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return {
       status: "error - permanent",
       content: renderError({
         message: "Something went wrong",
         secondaryMessage: "Locale not found",
-        renderOptions: {
-          title_color,
-          text_color,
-          bg_color,
-          border_color,
-          theme,
-        },
+        renderOptions: colorParams,
+      }),
+    };
+  }
+
+  const safePattern = /^[-\w/.,]+$/;
+  if (username && !safePattern.test(username)) {
+    return {
+      status: "error - permanent",
+      content: renderError({
+        message: "Something went wrong",
+        secondaryMessage: "Username contains unsafe characters",
+        renderOptions: colorParams,
       }),
     };
   }
 
   if (
     layout !== undefined &&
-    (typeof layout !== "string" ||
-      !["compact", "normal", "donut", "donut-vertical", "pie"].includes(layout))
+    !["compact", "normal", "donut", "donut-vertical", "pie"].includes(layout)
   ) {
     return {
       status: "error - permanent",
       content: renderError({
         message: "Something went wrong",
         secondaryMessage: "Incorrect layout input",
-        renderOptions: {
-          title_color,
-          text_color,
-          bg_color,
-          border_color,
-          theme,
-        },
+        renderOptions: colorParams,
       }),
     };
   }
 
   if (
     stats_format !== undefined &&
-    (typeof stats_format !== "string" ||
-      !["bytes", "percentages"].includes(stats_format))
+    !["bytes", "percentages"].includes(stats_format)
   ) {
     return {
       status: "error - permanent",
       content: renderError({
         message: "Something went wrong",
         secondaryMessage: "Incorrect stats_format input",
-        renderOptions: {
-          title_color,
-          text_color,
-          bg_color,
-          border_color,
-          theme,
-        },
+        renderOptions: colorParams,
       }),
     };
   }
@@ -110,20 +112,15 @@ export default async (
     return {
       status: "success",
       content: renderTopLanguages(topLangs, {
+        ...colorParams,
         custom_title,
         hide_title: parseBoolean(hide_title),
         hide_border: parseBoolean(hide_border),
         card_width: parseInt(card_width, 10),
         hide: parseArray(hide),
-        title_color,
-        text_color,
-        bg_color,
-        prog_bar_bg_color,
-        theme,
         layout,
         langs_count,
         border_radius,
-        border_color,
         locale: locale ? locale.toLowerCase() : null,
         disable_animations: parseBoolean(disable_animations),
         hide_progress: parseBoolean(hide_progress),
@@ -139,11 +136,7 @@ export default async (
           message: err.message,
           secondaryMessage: retrieveSecondaryMessage(err),
           renderOptions: {
-            title_color,
-            text_color,
-            bg_color,
-            border_color,
-            theme,
+            ...colorParams,
             show_repo_link: !(err instanceof MissingParamError),
           },
         }),
@@ -153,13 +146,7 @@ export default async (
       status: "error - temporary",
       content: renderError({
         message: "An unknown error occurred",
-        renderOptions: {
-          title_color,
-          text_color,
-          bg_color,
-          border_color,
-          theme,
-        },
+        renderOptions: colorParams,
       }),
     };
   }

package/src/api/wakatime.js

@@ -1,4 +1,5 @@
 import { renderWakatimeCard } from "../cards/wakatime.js";
+import { findInvalidColorParam, pickColorParams } from "../common/color.js";
 import {
   MissingParamError,
   retrieveSecondaryMessage,
@@ -11,14 +12,9 @@ import { isLocaleAvailable } from "../translations.js";
 // @ts-ignore
 export default async ({
   username,
-  title_color,
-  icon_color,
   hide_border,
   card_width,
   line_height,
-  text_color,
-  bg_color,
-  theme,
   hide_title,
   hide_progress,
   custom_title,
@@ -28,23 +24,42 @@ export default async ({
   hide,
   api_domain,
   border_radius,
-  border_color,
   display_format,
   disable_animations,
+  ...remainingParams
 }) => {
+  const colorParams = pickColorParams(remainingParams);
+
+  const invalidColorInput = findInvalidColorParam(colorParams);
+  if (invalidColorInput) {
+    return {
+      status: "error - permanent",
+      content: renderError({
+        message: "Something went wrong",
+        secondaryMessage: `Invalid color input for parameter "${invalidColorInput}"`,
+      }),
+    };
+  }
+
   if (locale && !isLocaleAvailable(locale)) {
     return {
       status: "error - permanent",
       content: renderError({
         message: "Something went wrong",
         secondaryMessage: "Language not found",
-        renderOptions: {
-          title_color,
-          text_color,
-          bg_color,
-          border_color,
-          theme,
-        },
+        renderOptions: colorParams,
+      }),
+    };
+  }
+
+  const safePattern = /^[-\w/.,]+$/;
+  if (username && !safePattern.test(username)) {
+    return {
+      status: "error - permanent",
+      content: renderError({
+        message: "Something went wrong",
+        secondaryMessage: "Username contains unsafe characters",
+        renderOptions: colorParams,
       }),
     };
   }
@@ -55,20 +70,15 @@ export default async ({
     return {
       status: "success",
       content: renderWakatimeCard(stats, {
+        ...colorParams,
         custom_title,
         hide_title: parseBoolean(hide_title),
         hide_border: parseBoolean(hide_border),
         card_width: parseInt(card_width, 10),
         hide: parseArray(hide),
         line_height,
-        title_color,
-        icon_color,
-        text_color,
-        bg_color,
-        theme,
         hide_progress,
         border_radius,
-        border_color,
         locale: locale ? locale.toLowerCase() : null,
         layout,
         langs_count,
@@ -84,11 +94,7 @@ export default async ({
           message: err.message,
           secondaryMessage: retrieveSecondaryMessage(err),
           renderOptions: {
-            title_color,
-            text_color,
-            bg_color,
-            border_color,
-            theme,
+            ...colorParams,
             show_repo_link: !(err instanceof MissingParamError),
           },
         }),
@@ -98,13 +104,7 @@ export default async ({
       status: "error - temporary",
       content: renderError({
         message: "An unknown error occurred",
-        renderOptions: {
-          title_color,
-          text_color,
-          bg_color,
-          border_color,
-          theme,
-        },
+        renderOptions: colorParams,
       }),
     };
   }

package/src/{calculateRank.js → calculateRank.ts}

@@ -1,20 +1,20 @@
 /**
  * Calculates the exponential cdf.
  *
- * @param {number} x The value.
- * @returns {number} The exponential cdf.
+ * @param x The value.
+ * @returns The exponential cdf.
  */
-function exponential_cdf(x) {
+function exponential_cdf(x: number): number {
   return 1 - 2 ** -x;
 }
 
 /**
  * Calculates the log normal cdf.
  *
- * @param {number} x The value.
- * @returns {number} The log normal cdf.
+ * @param x The value.
+ * @returns The log normal cdf.
  */
-function log_normal_cdf(x) {
+function log_normal_cdf(x: number): number {
   // approximation
   return x / (1 + x);
 }
@@ -22,16 +22,16 @@ function log_normal_cdf(x) {
 /**
  * Calculates the users rank.
  *
- * @param {object} params Parameters on which the user's rank depends.
- * @param {boolean} params.all_commits Whether `include_all_commits` was used.
- * @param {number} params.commits Number of commits.
- * @param {number} params.prs The number of pull requests.
- * @param {number} params.issues The number of issues.
- * @param {number} params.reviews The number of reviews.
- * @param {number} params.repos Total number of repos.
- * @param {number} params.stars The number of stars.
- * @param {number} params.followers The number of followers.
- * @returns {{ level: string, percentile: number }} The users rank.
+ * @param params Parameters on which the user's rank depends.
+ * @param params.all_commits Whether `include_all_commits` was used.
+ * @param params.commits Number of commits.
+ * @param params.prs The number of pull requests.
+ * @param params.issues The number of issues.
+ * @param params.reviews The number of reviews.
+ * @param params.repos Total number of repos (accepted for compatibility, unused in the calculation).
+ * @param params.stars The number of stars.
+ * @param params.followers The number of followers.
+ * @returns The users rank.
  */
 function calculateRank({
   all_commits,
@@ -39,11 +39,18 @@ function calculateRank({
   prs,
   issues,
   reviews,
-  // eslint-disable-next-line no-unused-vars
-  repos, // unused
   stars,
   followers,
-}) {
+}: {
+  all_commits: boolean;
+  commits: number;
+  prs: number;
+  issues: number;
+  reviews: number;
+  repos: number;
+  stars: number;
+  followers: number;
+}): { level: string; percentile: number } {
   const COMMITS_MEDIAN = all_commits ? 1000 : 250,
     COMMITS_WEIGHT = 2;
   const PRS_MEDIAN = 50,
@@ -79,6 +86,9 @@ function calculateRank({
       TOTAL_WEIGHT;
 
   const level = LEVELS[THRESHOLDS.findIndex((t) => rank * 100 <= t)];
+  if (level === undefined) {
+    throw new Error("Unable to determine rank level");
+  }
 
   return { level, percentile: rank * 100 };
 }

package/src/cards/common-options.ts

@@ -0,0 +1,13 @@
+import type { ThemeName } from "../themes/index.js";
+
+export interface CommonOptions {
+  title_color: string;
+  icon_color: string;
+  text_color: string;
+  bg_color: string;
+  theme: ThemeName;
+  border_radius: number;
+  border_color: string;
+  locale: string;
+  hide_border: boolean;
+}

package/src/cards/{gist.js → gist.ts}

@@ -1,9 +1,9 @@
 import { default as Card } from "../common/Card.js";
-import { getCardColors } from "../common/color.js";
+import { getLightDarkColors } from "../common/color.js";
 import { kFormatter, wrapTextMultiline } from "../common/fmt.js";
 import { encodeHTML } from "../common/html.js";
 import { icons } from "../common/icons.js";
-import languageColors from "../common/languageColors.json" with { type: "json" };
+import { getLanguageColor } from "../common/languageColors.js";
 import { parseEmojis } from "../common/ops.js";
 import {
   countWrappedLines,
@@ -14,6 +14,9 @@ import {
   wrappedTextNode,
   wrappedTextStyles,
 } from "../common/render.js";
+import type { GistData } from "../fetchers/types.js";
+
+import type { CommonOptions } from "./common-options.js";
 
 const ICON_SIZE = 16;
 const CARD_DEFAULT_WIDTH = 400;
@@ -24,48 +27,39 @@ const DESCRIPTION_FONT_SIZE = 13;
 const DESCRIPTION_LINE_HEIGHT_PX = 16;
 const DESCRIPTION_MAX_LINES = 10;
 
-/**
- * @typedef {import('./types').GistCardOptions} GistCardOptions Gist card options.
- * @typedef {import('../fetchers/types').GistData} GistData Gist data.
- */
+interface GistCardOptions extends CommonOptions {
+  show_owner: boolean;
+  browser_rendering: boolean;
+}
 
 /**
  * Render gist card.
  *
- * @param {GistData} gistData Gist data.
- * @param {Partial<GistCardOptions>} options Gist card options.
- * @returns {string} Gist card.
+ * @param gistData Gist data.
+ * @param options Gist card options.
+ * @returns Gist card.
  */
-const renderGistCard = (gistData, options = {}) => {
+const renderGistCard = (
+  gistData: GistData,
+  options: Partial<GistCardOptions> = {},
+): string => {
   const { name, nameWithOwner, description, language, starsCount, forksCount } =
     gistData;
   const {
-    title_color,
-    icon_color,
-    text_color,
-    bg_color,
     theme = "default_repocard",
     border_radius,
-    border_color,
     show_owner = false,
     browser_rendering = false,
     hide_border = false,
   } = options;
 
-  // returns theme based colors with proper overrides and defaults
-  const { titleColor, textColor, iconColor, bgColor, borderColor } =
-    getCardColors({
-      title_color,
-      icon_color,
-      text_color,
-      bg_color,
-      border_color,
-      theme,
-    });
+  const { lightColors, darkColors } = getLightDarkColors({ ...options, theme });
+  const { textColor, iconColor } = lightColors;
 
   const desc = parseEmojis(description || "No description provided");
 
-  let descriptionLines, descriptionSvg;
+  let descriptionLines: number;
+  let descriptionSvg: string;
   if (browser_rendering) {
     // The browser performs the actual text wrapping inside the foreignObject;
     // we only estimate the line count server-side so the SVG can reserve enough
@@ -128,8 +122,7 @@ const renderGistCard = (gistData, options = {}) => {
   );
 
   const languageName = language || "Unspecified";
-  // @ts-ignore
-  const languageColor = languageColors[languageName] || "#858585";
+  const languageColor = getLanguageColor(languageName);
 
   const svgLanguage = createLanguageNode(languageName, languageColor);
 
@@ -154,23 +147,30 @@ const renderGistCard = (gistData, options = {}) => {
     width: CARD_DEFAULT_WIDTH,
     height,
     border_radius,
-    colors: {
-      titleColor,
-      textColor,
-      iconColor,
-      bgColor,
-      borderColor,
-    },
+    colors: { light: lightColors, dark: darkColors },
   });
 
-  card.setCSS(`
+  card.setCSS({
+    light: `
     .description {
       font: 400 ${DESCRIPTION_FONT_SIZE}px 'Segoe UI', Ubuntu, Sans-Serif;fill: ${textColor};
       ${browser_rendering ? wrappedTextStyles(textColor) : ""}
     }
     .gray { font: 400 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${textColor} }
     .icon { fill: ${iconColor} }
-  `);
+  `,
+    dark: darkColors
+      ? `
+      .description {
+        fill: ${darkColors.textColor};
+        ${browser_rendering ? wrappedTextStyles(darkColors.textColor) : ""}
+      }
+      .gray { fill: ${darkColors.textColor} }
+      .icon { fill: ${darkColors.iconColor} }
+    `
+      : null,
+  });
+
   card.setHideBorder(hide_border);
 
   return card.render(`