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

package/build/api/wakatime.js

@@ -1,24 +1,41 @@
 import { renderWakatimeCard } from "../cards/wakatime.js";
+import { findInvalidColorParam, pickColorParams } from "../common/color.js";
 import { MissingParamError, retrieveSecondaryMessage, } from "../common/error.js";
 import { parseArray, parseBoolean } from "../common/ops.js";
 import { renderError } from "../common/render.js";
 import { fetchWakatimeStats } from "../fetchers/wakatime.js";
 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, locale, layout, langs_count, hide, api_domain, border_radius, border_color, display_format, disable_animations, }) => {
+export default async ({ username, hide_border, card_width, line_height, hide_title, hide_progress, custom_title, locale, layout, langs_count, hide, api_domain, border_radius, 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,
             }),
         };
     }
@@ -27,20 +44,15 @@ export default async ({ username, title_color, icon_color, hide_border, card_wid
         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,
@@ -57,11 +69,7 @@ export default async ({ username, title_color, icon_color, hide_border, card_wid
                     message: err.message,
                     secondaryMessage: retrieveSecondaryMessage(err),
                     renderOptions: {
-                        title_color,
-                        text_color,
-                        bg_color,
-                        border_color,
-                        theme,
+                        ...colorParams,
                         show_repo_link: !(err instanceof MissingParamError),
                     },
                 }),
@@ -71,13 +79,7 @@ export default async ({ username, title_color, icon_color, hide_border, card_wid
             status: "error - temporary",
             content: renderError({
                 message: "An unknown error occurred",
-                renderOptions: {
-                    title_color,
-                    text_color,
-                    bg_color,
-                    border_color,
-                    theme,
-                },
+                renderOptions: colorParams,
             }),
         };
     }

package/build/calculateRank.d.ts

@@ -1,18 +1,18 @@
 /**
  * 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.
  */
-export function calculateRank({ all_commits, commits, prs, issues, reviews, repos, stars, followers, }: {
+declare function calculateRank({ all_commits, commits, prs, issues, reviews, stars, followers, }: {
     all_commits: boolean;
     commits: number;
     prs: number;
@@ -25,4 +25,5 @@ export function calculateRank({ all_commits, commits, prs, issues, reviews, repo
     level: string;
     percentile: number;
 };
+export { calculateRank };
 //# sourceMappingURL=calculateRank.d.ts.map

package/build/calculateRank.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calculateRank.d.ts","sourceRoot":"","sources":["../src/calculateRank.js"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;GAaG;AACH,wGAVG;IAAwB,WAAW,EAA3B,OAAO;IACQ,OAAO,EAAtB,MAAM;IACS,GAAG,EAAlB,MAAM;IACS,MAAM,EAArB,MAAM;IACS,OAAO,EAAtB,MAAM;IACS,KAAK,EAApB,MAAM;IACS,KAAK,EAApB,MAAM;IACS,SAAS,EAAxB,MAAM;CACd,GAAU;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAkDjD"}
+{"version":3,"file":"calculateRank.d.ts","sourceRoot":"","sources":["../src/calculateRank.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;GAaG;AACH,iBAAS,aAAa,CAAC,EACrB,WAAW,EACX,OAAO,EACP,GAAG,EACH,MAAM,EACN,OAAO,EACP,KAAK,EACL,SAAS,GACV,EAAE;IACD,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAyCxC;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/build/calculateRank.js

@@ -1,8 +1,8 @@
 /**
  * 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) {
     return 1 - 2 ** -x;
@@ -10,8 +10,8 @@ function exponential_cdf(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) {
     // approximation
@@ -20,21 +20,18 @@ 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, commits, prs, issues, reviews, 
-// eslint-disable-next-line no-unused-vars
-repos, // unused
-stars, followers, }) {
+function calculateRank({ all_commits, commits, prs, issues, reviews, stars, followers, }) {
     const COMMITS_MEDIAN = all_commits ? 1000 : 250, COMMITS_WEIGHT = 2;
     const PRS_MEDIAN = 50, PRS_WEIGHT = 3;
     const ISSUES_MEDIAN = 25, ISSUES_WEIGHT = 1;
@@ -58,6 +55,9 @@ stars, followers, }) {
             FOLLOWERS_WEIGHT * log_normal_cdf(followers / FOLLOWERS_MEDIAN)) /
             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 };
 }
 export { calculateRank };

package/build/cards/common-options.d.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;
+}
+//# sourceMappingURL=common-options.d.ts.map

package/build/cards/common-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-options.d.ts","sourceRoot":"","sources":["../../src/cards/common-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,SAAS,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;CACtB"}

package/build/cards/common-options.js

@@ -0,0 +1 @@
+export {};

package/build/cards/gist.d.ts

@@ -1,21 +1,16 @@
-/**
- * Gist card options.
- */
-export type GistCardOptions = any;
-/**
- * Gist data.
- */
-export type GistData = any;
-/**
- * @typedef {import('./types').GistCardOptions} GistCardOptions Gist card options.
- * @typedef {import('../fetchers/types').GistData} GistData Gist data.
- */
+import type { GistData } from "../fetchers/types.js";
+import type { CommonOptions } from "./common-options.js";
+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.
  */
-export function renderGistCard(gistData: GistData, options?: Partial<GistCardOptions>): string;
+declare const renderGistCard: (gistData: GistData, options?: Partial<GistCardOptions>) => string;
+export { renderGistCard };
 //# sourceMappingURL=gist.d.ts.map

package/build/cards/gist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gist.d.ts","sourceRoot":"","sources":["../../src/cards/gist.js"],"names":[],"mappings":";;;;;;;;AA0BA;;;GAGG;AAEH;;;;;;GAMG;AACH,yCAJW,QAAQ,YACR,OAAO,CAAC,eAAe,CAAC,GACtB,MAAM,CAkJlB"}
+{"version":3,"file":"gist.d.ts","sourceRoot":"","sources":["../../src/cards/gist.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAWzD,UAAU,eAAgB,SAAQ,aAAa;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,QAAA,MAAM,cAAc,GAClB,UAAU,QAAQ,EAClB,UAAS,OAAO,CAAC,eAAe,CAAM,KACrC,MA0IF,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/build/cards/gist.js

@@ -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, createLanguageNode, flexLayout, iconWithLabel, measureText, wrappedTextNode, wrappedTextStyles, } from "../common/render.js";
 const ICON_SIZE = 16;
@@ -14,31 +14,21 @@ const DESCRIPTION_BOX_WIDTH = CARD_DEFAULT_WIDTH - 2 * X_OFFSET;
 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.
- */
 /**
  * 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 { 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 { theme = "default_repocard", border_radius, show_owner = false, browser_rendering = false, hide_border = false, } = options;
+    const { lightColors, darkColors } = getLightDarkColors({ ...options, theme });
+    const { textColor, iconColor } = lightColors;
     const desc = parseEmojis(description || "No description provided");
-    let descriptionLines, descriptionSvg;
+    let descriptionLines;
+    let descriptionSvg;
     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
@@ -74,8 +64,7 @@ const renderGistCard = (gistData, options = {}) => {
     const svgStars = iconWithLabel(icons.star, totalStars, "starsCount", ICON_SIZE);
     const svgForks = iconWithLabel(icons.fork, totalForks, "forksCount", ICON_SIZE);
     const languageName = language || "Unspecified";
-    // @ts-ignore
-    const languageColor = languageColors[languageName] || "#858585";
+    const languageColor = getLanguageColor(languageName);
     const svgLanguage = createLanguageNode(languageName, languageColor);
     const starAndForkCount = flexLayout({
         items: [svgLanguage, svgStars, svgForks],
@@ -95,22 +84,28 @@ 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(`
     ${descriptionSvg}

package/build/cards/repo.d.ts

@@ -1,21 +1,24 @@
-/**
- * Repository data.
- */
-export type RepositoryData = any;
-/**
- * Repo card options.
- */
-export type RepoCardOptions = any;
-/**
- * @typedef {import("../fetchers/types").RepositoryData} RepositoryData Repository data.
- * @typedef {import("./types").RepoCardOptions} RepoCardOptions Repo card options.
- */
+import type { RepositoryData } from "../fetchers/types.js";
+import type { CommonOptions } from "./common-options.js";
+interface RepoCardOptions extends CommonOptions {
+    show_owner: boolean;
+    browser_rendering: boolean;
+    description_lines_count: number;
+    card_width_input: number;
+    show: Array<string>;
+    show_icons: boolean;
+    number_format: string;
+    text_bold: boolean;
+    line_height: number | string;
+    username: string;
+}
 /**
  * Renders repository card details.
  *
- * @param {RepositoryData} repo Repository data.
- * @param {Partial<RepoCardOptions>} options Card options.
- * @returns {string} Repository card SVG object.
+ * @param repo Repository data.
+ * @param options Card options.
+ * @returns Repository card SVG object.
  */
-export function renderRepoCard(repo: RepositoryData, options?: Partial<RepoCardOptions>): string;
+declare const renderRepoCard: (repo: RepositoryData, options?: Partial<RepoCardOptions>) => string;
+export { renderRepoCard };
 //# sourceMappingURL=repo.d.ts.map

package/build/cards/repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repo.d.ts","sourceRoot":"","sources":["../../src/cards/repo.js"],"names":[],"mappings":";;;;;;;;AAiDA;;;GAGG;AAEH;;;;;;GAMG;AACH,qCAJW,cAAc,YACd,OAAO,CAAC,eAAe,CAAC,GACtB,MAAM,CA6SlB"}
+{"version":3,"file":"repo.d.ts","sourceRoot":"","sources":["../../src/cards/repo.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAG3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AASzD,UAAU,eAAgB,SAAQ,aAAa;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAsCD;;;;;;GAMG;AACH,QAAA,MAAM,cAAc,GAClB,MAAM,cAAc,EACpB,UAAS,OAAO,CAAC,eAAe,CAAM,KACrC,MA4SF,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,CAAC"}