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

package/build/cards/repo.js

@@ -1,13 +1,12 @@
 import { Card } from "../common/Card.js";
 import { I18n } from "../common/I18n.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 { buildSearchFilter, clampValue, parseEmojis } from "../common/ops.js";
-import { countWrappedLines, createLanguageNode, flexLayout, iconWithLabel, measureText, wrappedTextNode, wrappedTextStyles, } from "../common/render.js";
+import { countWrappedLines, createLanguageNode, createTextNode, flexLayout, iconWithLabel, measureText, wrappedTextNode, wrappedTextStyles, } from "../common/render.js";
 import { repoCardLocales } from "../translations.js";
-import { createTextNode } from "./stats.js";
 const ICON_SIZE = 16;
 const CARD_DEFAULT_WIDTH = 400;
 const X_OFFSET = 25;
@@ -17,38 +16,38 @@ const DESCRIPTION_MAX_LINES = 3;
 /**
  * Retrieves the repository description and wraps it to fit the card width.
  *
- * @param {string} label The repository description.
- * @param {string} textColor The color of the text.
- * @returns {string} Wrapped repo description SVG object.
- */
-const getBadgeSVG = (label, textColor, xOffset = 0) => `
-  <g data-testid="badge" class="badge" transform="translate(${320 + xOffset}, -18)">
-    <rect stroke="${textColor}" stroke-width="1" width="70" height="20" x="-12" y="-14" ry="10" rx="10"></rect>
-    <text
-      x="23" y="-5"
-      alignment-baseline="central"
-      dominant-baseline="central"
-      text-anchor="middle"
-      fill="${textColor}"
-    >
-      ${label}
-    </text>
-  </g>
-`;
-/**
- * @typedef {import("../fetchers/types").RepositoryData} RepositoryData Repository data.
- * @typedef {import("./types").RepoCardOptions} RepoCardOptions Repo card options.
+ * @param label The repository description.
+ * @param xOffset Horizontal offset of the badge.
+ * @returns Wrapped repo description SVG object.
  */
+const getBadgeSVG = (label, xOffset = 0) => {
+    if (!Number.isFinite(xOffset)) {
+        throw new Error(`Invalid xOffset: "${xOffset}"`);
+    }
+    return `
+    <g data-testid="badge" class="badge" transform="translate(${320 + xOffset}, -18)">
+      <rect stroke-width="1" width="70" height="20" x="-12" y="-14" ry="10" rx="10"></rect>
+      <text
+        x="23" y="-5"
+        alignment-baseline="central"
+        dominant-baseline="central"
+        text-anchor="middle"
+      >
+        ${encodeHTML(label)}
+      </text>
+    </g>
+  `;
+};
 /**
  * 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.
  */
 const renderRepoCard = (repo, options = {}) => {
-    const { name, nameWithOwner, description, primaryLanguage, isArchived, isTemplate, starCount, forkCount, totalPRsAuthored, totalPRsCommented, totalPRsReviewed, totalIssuesAuthored, totalIssuesCommented, } = repo;
-    const { hide_border = false, title_color, icon_color, text_color, bg_color, card_width_input, show_owner = false, browser_rendering = false, show = [], show_icons = true, number_format = "short", text_bold = false, line_height = 22, username, theme = "default_repocard", border_radius, border_color, locale, description_lines_count, } = options;
+    const { name, nameWithOwner, description, primaryLanguage, isArchived, isTemplate, stargazerCount, forkCount, totalPRsAuthored, totalPRsCommented, totalPRsReviewed, totalIssuesAuthored, totalIssuesCommented, } = repo;
+    const { hide_border = false, card_width_input, show_owner = false, browser_rendering = false, show = [], show_icons = true, number_format = "short", text_bold = false, line_height = 22, username, theme = "default_repocard", border_radius, locale, description_lines_count, } = options;
     const card_width = card_width_input && !isNaN(card_width_input)
         ? card_width_input
         : show.length >= 2
@@ -58,67 +57,68 @@ const renderRepoCard = (repo, options = {}) => {
         locale,
         translations: repoCardLocales,
     });
-    let repoFilter = encodeURIComponent(buildSearchFilter([nameWithOwner], []));
+    const repoFilter = encodeURIComponent(buildSearchFilter([nameWithOwner], []));
+    const encodedUsername = encodeURIComponent(username ?? "");
     const STATS = {};
     if (show.includes("prs_authored")) {
-        STATS.prs_authored = {
+        STATS["prs_authored"] = {
             icon: icons.prs,
             label: i18n.t("repocard.prs-authored"),
             value: totalPRsAuthored,
             id: "prs_authored",
-            link: `https://github.com/search?q=${repoFilter}author%3A${username}&amp;type=pullrequests`,
+            link: `https://github.com/search?q=${repoFilter}author%3A${encodedUsername}&amp;type=pullrequests`,
         };
     }
     if (show.includes("prs_commented")) {
-        STATS.prs_commented = {
+        STATS["prs_commented"] = {
             icon: icons.comments,
             label: i18n.t("repocard.prs-commented"),
             value: totalPRsCommented,
             id: "prs_commented",
-            link: `https://github.com/search?q=${repoFilter}commenter%3A${username}+-author%3A${username}&amp;type=pullrequests`,
+            link: `https://github.com/search?q=${repoFilter}commenter%3A${encodedUsername}+-author%3A${encodedUsername}&amp;type=pullrequests`,
         };
     }
     if (show.includes("prs_reviewed")) {
-        STATS.prs_reviewed = {
+        STATS["prs_reviewed"] = {
             icon: icons.reviews,
             label: i18n.t("repocard.prs-reviewed"),
             value: totalPRsReviewed,
             id: "prs_reviewed",
-            link: `https://github.com/search?q=${repoFilter}reviewed-by%3A${username}+-author%3A${username}&amp;type=pullrequests`,
+            link: `https://github.com/search?q=${repoFilter}reviewed-by%3A${encodedUsername}+-author%3A${encodedUsername}&amp;type=pullrequests`,
         };
     }
     if (show.includes("issues_authored")) {
-        STATS.issues_authored = {
+        STATS["issues_authored"] = {
             icon: icons.issues,
             label: i18n.t("repocard.issues-authored"),
             value: totalIssuesAuthored,
             id: "issues_authored",
-            link: `https://github.com/search?q=${repoFilter}author%3A${username}&amp;type=issues`,
+            link: `https://github.com/search?q=${repoFilter}author%3A${encodedUsername}&amp;type=issues`,
         };
     }
     if (show.includes("issues_commented")) {
-        STATS.issues_commented = {
+        STATS["issues_commented"] = {
             icon: icons.discussions_started,
             label: i18n.t("repocard.issues-commented"),
             value: totalIssuesCommented,
             id: "issues_commented",
-            link: `https://github.com/search?q=${repoFilter}commenter%3A${username}+-author%3A${username}&amp;type=issues`,
+            link: `https://github.com/search?q=${repoFilter}commenter%3A${encodedUsername}+-author%3A${encodedUsername}&amp;type=issues`,
         };
     }
-    const statItems = Object.keys(STATS).map((key, index) => 
+    const statItems = Object.values(STATS).map((stat, index) => 
     // create the text nodes, and pass index so that we can calculate the line spacing
     createTextNode({
-        icon: STATS[key].icon,
-        label: STATS[key].label,
-        value: STATS[key].value,
-        id: STATS[key].id,
-        unitSymbol: STATS[key].unitSymbol,
+        icon: stat.icon,
+        label: stat.label,
+        value: stat.value ?? 0,
+        id: stat.id,
+        unitSymbol: stat.unitSymbol,
         index,
         showIcons: show_icons,
         shiftValuePos: 14.01,
         bold: text_bold,
         numberFormat: number_format,
-        link: STATS[key].link,
+        link: stat.link,
         labelXOffset: 23,
     }));
     const extraLHeight = parseInt(String(line_height), 10);
@@ -128,7 +128,8 @@ const renderRepoCard = (repo, options = {}) => {
     const langColor = (primaryLanguage && primaryLanguage.color) || "#333";
     const desc = parseEmojis(description || "No description provided");
     const descriptionBoxWidth = card_width - 2 * X_OFFSET;
-    let descriptionLinesCount, descriptionSvg;
+    let descriptionLinesCount;
+    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
@@ -169,19 +170,11 @@ const renderRepoCard = (repo, options = {}) => {
     const height = (descriptionLinesCount > 1 ? 120 : 110) +
         descriptionLinesCount * lineHeight +
         extraHeight;
-    // returns theme based colors with proper overrides and defaults
-    const colors = getCardColors({
-        title_color,
-        icon_color,
-        text_color,
-        bg_color,
-        border_color,
-        theme,
-    });
+    const { lightColors, darkColors } = getLightDarkColors({ ...options, theme });
     const svgLanguage = primaryLanguage
         ? createLanguageNode(langName, langColor)
         : "";
-    const totalStars = kFormatter(starCount);
+    const totalStars = kFormatter(stargazerCount);
     const totalForks = kFormatter(forkCount);
     const svgStars = iconWithLabel(icons.star, totalStars, "stargazers", ICON_SIZE);
     const svgForks = iconWithLabel(icons.fork, totalForks, "forkcount", ICON_SIZE);
@@ -194,7 +187,7 @@ const renderRepoCard = (repo, options = {}) => {
         ],
         gap: 25,
     }).join("");
-    let extraRows = [];
+    const extraRows = [];
     for (let i = 0; i < statItems.length; i += 2) {
         extraRows.push(flexLayout({
             items: statItems.slice(i, i + 2),
@@ -217,21 +210,23 @@ const renderRepoCard = (repo, options = {}) => {
         width: card_width,
         height,
         border_radius,
-        colors,
+        colors: { light: lightColors, dark: darkColors },
     });
     card.disableAnimations();
     card.setHideBorder(hide_border);
     card.setHideTitle(false);
-    card.setCSS(`
+    card.setCSS({
+        light: `
     .description {
-      font: 400 ${DESCRIPTION_FONT_SIZE}px 'Segoe UI', Ubuntu, Sans-Serif;fill: ${colors.textColor};
-      ${browser_rendering ? wrappedTextStyles(colors.textColor) : ""}
+      font: 400 ${DESCRIPTION_FONT_SIZE}px 'Segoe UI', Ubuntu, Sans-Serif;fill: ${lightColors.textColor};
+      ${browser_rendering ? wrappedTextStyles(lightColors.textColor) : ""}
     }
-    .gray { font: 400 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${colors.textColor} }
+    .gray { font: 400 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${lightColors.textColor} }
     .badge { font: 600 11px 'Segoe UI', Ubuntu, Sans-Serif; }
-    .badge rect { opacity: 0.2 }
+    .badge rect { opacity: 0.2; stroke: ${lightColors.textColor} }
+    .badge text { fill: ${lightColors.textColor} }
 
-    .stat { font: 400 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${colors.textColor} }
+    .stat { font: 400 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${lightColors.textColor} }
     .stagger {
       opacity: 0;
       animation: fadeInAnimation 0.3s ease-in-out forwards;
@@ -239,17 +234,29 @@ const renderRepoCard = (repo, options = {}) => {
     .not_bold { font-weight: 400 }
     .bold { font-weight: 700 }
     .icon {
-      fill: ${colors.iconColor};
+      fill: ${lightColors.iconColor};
       display: block;
     }
-  `);
+  `,
+        dark: darkColors
+            ? `
+      .description {
+        fill: ${darkColors.textColor};
+        ${browser_rendering ? wrappedTextStyles(darkColors.textColor) : ""}
+      }
+      .gray { fill: ${darkColors.textColor} }
+      .badge rect { stroke: ${darkColors.textColor} }
+      .badge text { fill: ${darkColors.textColor} }
+      .stat { fill: ${darkColors.textColor} }
+      .icon { fill: ${darkColors.iconColor}; }
+    `
+            : null,
+    });
     return card.render(`
     ${isTemplate
-        ? // @ts-ignore
-            getBadgeSVG(i18n.t("repocard.template"), colors.textColor, card_width - CARD_DEFAULT_WIDTH)
+        ? getBadgeSVG(i18n.t("repocard.template"), card_width - CARD_DEFAULT_WIDTH)
         : isArchived
-            ? // @ts-ignore
-                getBadgeSVG(i18n.t("repocard.archived"), colors.textColor, card_width - CARD_DEFAULT_WIDTH)
+            ? getBadgeSVG(i18n.t("repocard.archived"), card_width - CARD_DEFAULT_WIDTH)
             : ""}
 
     ${descriptionSvg}

package/build/cards/stats.d.ts

@@ -1,49 +1,34 @@
-export type StatsData = any;
-export type StatCardOptions = any;
-/**
- * @typedef {import('../fetchers/types').StatsData} StatsData
- * @typedef {import('./types').StatCardOptions} StatCardOptions
- */
+import type { StatsData } from "../fetchers/types.js";
+import type { CommonOptions } from "./common-options.js";
+type RankIcon = "default" | "github" | "percentile";
+interface StatCardOptions extends CommonOptions {
+    hide: Array<string>;
+    show_icons: boolean;
+    hide_title: boolean;
+    card_width: number;
+    hide_rank: boolean;
+    include_all_commits: boolean;
+    commits_year: number;
+    line_height: number | string;
+    custom_title: string;
+    disable_animations: boolean;
+    number_format: string;
+    number_precision: number;
+    ring_color: string;
+    text_bold: boolean;
+    rank_icon: RankIcon;
+    show: Array<string>;
+}
 /**
  * Renders the stats card.
  *
- * @param {StatsData} stats The stats data.
- * @param {Partial<StatCardOptions>} options The card options.
- * @returns {string} The stats card SVG object.
- */
-export function renderStatsCard(stats: StatsData, options: Partial<StatCardOptions>, username: any, repo?: any[], owner?: any[]): string;
-/**
- * Create a stats card text item.
- *
- * @param {object} params Object that contains the createTextNode parameters.
- * @param {string} params.icon The icon to display.
- * @param {string} params.label The label to display.
- * @param {number} params.value The value to display.
- * @param {string} params.id The id of the stat.
- * @param {string=} params.unitSymbol The unit symbol of the stat.
- * @param {number} params.index The index of the stat.
- * @param {boolean} params.showIcons Whether to show icons.
- * @param {number} params.shiftValuePos Number of pixels the value has to be shifted to the right.
- * @param {boolean} params.bold Whether to bold the label.
- * @param {string} params.numberFormat The format of numbers on card.
- * @param {number=} params.numberPrecision The precision of numbers on card.
- * @param {string} params.link Url to link to.
- * @param {number} params.labelXOffset horizontal offset for label.
- * @returns {string} The stats card text item SVG object.
+ * @param stats The stats data.
+ * @param options The card options.
+ * @param username GitHub username, used to build stat search links.
+ * @param repo Repositories to scope the search links to.
+ * @param owner Owners to scope the search links to.
+ * @returns The stats card SVG object.
  */
-export function createTextNode({ icon, label, value, id, unitSymbol, index, showIcons, shiftValuePos, bold, numberFormat, numberPrecision, link, labelXOffset, }: {
-    icon: string;
-    label: string;
-    value: number;
-    id: string;
-    unitSymbol?: string | undefined;
-    index: number;
-    showIcons: boolean;
-    shiftValuePos: number;
-    bold: boolean;
-    numberFormat: string;
-    numberPrecision?: number | undefined;
-    link: string;
-    labelXOffset: number;
-}): string;
+declare const renderStatsCard: (stats: StatsData, options?: Partial<StatCardOptions>, username?: string, repo?: Array<string>, owner?: Array<string>) => string;
+export { renderStatsCard };
 //# sourceMappingURL=stats.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/cards/stats.js"],"names":[],"mappings":";;AA4PA;;;GAGG;AAEH;;;;;;GAMG;AACH,uCAJW,SAAS,WACT,OAAO,CAAC,eAAe,CAAC,+CACtB,MAAM,CAsZlB;AAzmBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,kKAfG;IAAuB,IAAI,EAAnB,MAAM;IACS,KAAK,EAApB,MAAM;IACS,KAAK,EAApB,MAAM;IACS,EAAE,EAAjB,MAAM;IACU,UAAU,GAA1B,MAAM,YAAC;IACQ,KAAK,EAApB,MAAM;IACU,SAAS,EAAzB,OAAO;IACQ,aAAa,EAA5B,MAAM;IACU,IAAI,EAApB,OAAO;IACQ,YAAY,EAA3B,MAAM;IACU,eAAe,GAA/B,MAAM,YAAC;IACQ,IAAI,EAAnB,MAAM;IACS,YAAY,EAA3B,MAAM;CACd,GAAU,MAAM,CAuDlB"}
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/cards/stats.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AASzD,KAAK,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEpD,UAAU,eAAgB,SAAQ,aAAa;IAC7C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,QAAQ,CAAC;IACpB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAiLD;;;;;;;;;GASG;AACH,QAAA,MAAM,eAAe,GACnB,OAAO,SAAS,EAChB,UAAS,OAAO,CAAC,eAAe,CAAM,EACtC,WAAW,MAAM,EACjB,OAAM,KAAK,CAAC,MAAM,CAAM,EACxB,QAAO,KAAK,CAAC,MAAM,CAAM,KACxB,MAgZF,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,CAAC"}