@stats-organization/github-readme-stats-core 2.1.3 → 2.1.5

package/build/cards/top-languages.js

@@ -1,8 +1,8 @@
-// @ts-check
 import { Card } from "../common/Card.js";
 import { I18n } from "../common/I18n.js";
-import { fallbackColor, getCardColors } from "../common/color.js";
+import { fallbackColor, getCardColors, isPrefixedHexColor, } from "../common/color.js";
 import { formatBytes } from "../common/fmt.js";
+import { encodeHTML } from "../common/html.js";
 import { chunkArray, clampValue, lowercaseTrim } from "../common/ops.js";
 import { createProgressNode, flexLayout, measureText, } from "../common/render.js";
 import { langCardLocales } from "../translations.js";
@@ -202,8 +202,8 @@ const createProgressTextNode = ({ width, color, progBarBgColor, name, size, tota
     const displayValue = getDisplayValue(size, progress, statsFormat);
     return `
     <g class="stagger" style="animation-delay: ${staggerDelay}ms">
-      <text data-testid="lang-name" x="2" y="15" class="lang-name">${name}</text>
-      ${hideValues ? "" : `<text x="${progressTextX}" y="34" class="lang-name">${displayValue}</text>`}
+      <text data-testid="lang-name" x="2" y="15" class="lang-name">${encodeHTML(name)}</text>
+      ${hideValues ? "" : `<text x="${progressTextX}" y="34" class="lang-name">${encodeHTML(displayValue)}</text>`}
       ${createProgressNode({
         x: 0,
         y: 25,
@@ -233,11 +233,14 @@ const createCompactLangNode = ({ lang, totalSize, hideProgress, hideValues, stat
     const displayValue = getDisplayValue(lang.size, percentages, statsFormat);
     const staggerDelay = (index + 3) * 150;
     const color = lang.color || "#858585";
+    if (!isPrefixedHexColor(color)) {
+        throw new Error(`Invalid language color: "${color}"`);
+    }
     return `
     <g class="stagger" style="animation-delay: ${staggerDelay}ms">
       <circle cx="5" cy="6" r="5" fill="${color}" />
       <text data-testid="lang-name" x="15" y="10" class='lang-name'>
-        ${lang.name} ${hideProgress || hideValues ? "" : displayValue}
+        ${encodeHTML(lang.name)} ${hideProgress || hideValues ? "" : encodeHTML(displayValue)}
       </text>
     </g>
   `;
@@ -355,6 +358,10 @@ const renderCompactLayout = (langs, width, totalLanguageSize, hideProgress, stat
     let progressOffset = 0;
     const compactProgressBar = langs
         .map((lang) => {
+        const langColor = lang.color || DEFAULT_LANG_COLOR;
+        if (!isPrefixedHexColor(langColor)) {
+            throw new Error(`Invalid language color: "${langColor}"`);
+        }
         const percentage = parseFloat(((lang.size / totalLanguageSize) * offsetWidth).toFixed(2));
         const progress = percentage < 10 ? percentage + 10 : percentage;
         const output = `
@@ -365,7 +372,7 @@ const renderCompactLayout = (langs, width, totalLanguageSize, hideProgress, stat
           y="0"
           width="${progress}"
           height="8"
-          fill="${lang.color || "#858585"}"
+          fill="${langColor}"
         />
       `;
         progressOffset += percentage;
@@ -413,17 +420,21 @@ const renderDonutVerticalLayout = (langs, totalLanguageSize, statsFormat, hideVa
     let startDelayCoefficient = 1;
     // Generate each donut vertical chart part
     for (const lang of langs) {
+        const langColor = lang.color || DEFAULT_LANG_COLOR;
+        if (!isPrefixedHexColor(langColor)) {
+            throw new Error(`Invalid language color: "${langColor}"`);
+        }
         const percentage = (lang.size / totalLanguageSize) * 100;
         const circleLength = totalCircleLength * (percentage / 100);
         const delay = startDelayCoefficient * 100;
         circles.push(`
       <g class="stagger" style="animation-delay: ${delay}ms">
-        <circle 
+        <circle
           cx="150"
           cy="100"
           r="${radius}"
           fill="transparent"
-          stroke="${lang.color}"
+          stroke="${langColor}"
           stroke-width="25"
           stroke-dasharray="${totalCircleLength}"
           stroke-dashoffset="${indent}"
@@ -480,6 +491,10 @@ const renderPieLayout = (langs, totalLanguageSize, statsFormat, hideValues) => {
     const paths = [];
     // Generate each pie chart part
     for (const lang of langs) {
+        const langColor = lang.color || DEFAULT_LANG_COLOR;
+        if (!isPrefixedHexColor(langColor)) {
+            throw new Error(`Invalid language color: "${langColor}"`);
+        }
         if (langs.length === 1) {
             paths.push(`
         <circle
@@ -487,7 +502,7 @@ const renderPieLayout = (langs, totalLanguageSize, statsFormat, hideValues) => {
           cy="${centerY}"
           r="${radius}"
           stroke="none"
-          fill="${lang.color}"
+          fill="${langColor}"
           data-testid="lang-pie"
           size="100"
         />
@@ -514,7 +529,7 @@ const renderPieLayout = (langs, totalLanguageSize, statsFormat, hideValues) => {
           data-testid="lang-pie"
           size="${percentage}"
           d="M ${centerX} ${centerY} L ${startPoint.x} ${startPoint.y} A ${radius} ${radius} 0 ${largeArcFlag} 1 ${endPoint.x} ${endPoint.y} Z"
-          fill="${lang.color}"
+          fill="${langColor}"
         />
       </g>
     `);
@@ -583,11 +598,20 @@ const createDonutPaths = (cx, cy, radius, percentages) => {
  * @returns {string} Donut layout card SVG object.
  */
 const renderDonutLayout = (langs, width, totalLanguageSize, statsFormat, hideValues) => {
+    if (!Number.isFinite(width)) {
+        throw new Error(`Invalid width: "${width}"`);
+    }
     const centerX = width / 3;
     const centerY = width / 3;
     const radius = centerX - 60;
     const strokeWidth = 12;
-    const colors = langs.map((lang) => lang.color);
+    const colors = langs.map((lang) => {
+        const langColor = lang.color || DEFAULT_LANG_COLOR;
+        if (!isPrefixedHexColor(langColor)) {
+            throw new Error(`Invalid language color: "${langColor}"`);
+        }
+        return langColor;
+    });
     const langsPercents = langs.map((lang) => parseFloat(((lang.size / totalLanguageSize) * 100).toFixed(2)));
     const langPaths = createDonutPaths(centerX, centerY, radius, langsPercents);
     const donutPaths = langs.length === 1
@@ -638,8 +662,11 @@ const renderDonutLayout = (langs, width, totalLanguageSize, statsFormat, hideVal
  * @returns {string} No languages data SVG node string.
  */
 const noLanguagesDataNode = ({ color, text, layout }) => {
+    if (!isPrefixedHexColor(color)) {
+        throw new Error(`Invalid text color: "${color}"`);
+    }
     return `
-    <text x="${layout === "pie" || layout === "donut-vertical" ? CARD_PADDING : 0}" y="11" class="stat bold" fill="${color}">${text}</text>
+    <text x="${layout === "pie" || layout === "donut-vertical" ? CARD_PADDING : 0}" y="11" class="stat bold" fill="${color}">${encodeHTML(text)}</text>
   `;
 };
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"wakatime.d.ts","sourceRoot":"","sources":["../../src/cards/wakatime.js"],"names":[],"mappings":";;;AA+NA;;;GAGG;AAEH;;;;;;GAMG;AACH,2CAJW,OAAO,CAAC,YAAY,CAAC,YACrB,OAAO,CAAC,eAAe,CAAC,GACtB,MAAM,CA2OlB"}
+{"version":3,"file":"wakatime.d.ts","sourceRoot":"","sources":["../../src/cards/wakatime.js"],"names":[],"mappings":";;;AAoPA;;;GAGG;AAEH;;;;;;GAMG;AACH,2CAJW,OAAO,CAAC,YAAY,CAAC,YACrB,OAAO,CAAC,eAAe,CAAC,GACtB,MAAM,CA6OlB"}

package/build/cards/wakatime.js

@@ -1,7 +1,7 @@
-// @ts-check
 import { Card } from "../common/Card.js";
 import { I18n } from "../common/I18n.js";
-import { getCardColors } from "../common/color.js";
+import { getCardColors, isPrefixedHexColor } from "../common/color.js";
+import { encodeHTML } from "../common/html.js";
 import languageColors from "../common/languageColors.json" with { type: "json" };
 import { clampValue, lowercaseTrim } from "../common/ops.js";
 import { createProgressNode, flexLayout } from "../common/render.js";
@@ -23,8 +23,11 @@ const TOTAL_TEXT_WIDTH = 275;
  * @returns {string} No coding activity SVG node string.
  */
 const noCodingActivityNode = ({ color, text }) => {
+    if (!isPrefixedHexColor(color)) {
+        throw new Error(`Invalid text color: "${color}"`);
+    }
     return `
-    <text x="25" y="11" class="stat bold" fill="${color}">${text}</text>
+    <text x="25" y="11" class="stat bold" fill="${color}">${encodeHTML(text)}</text>
   `;
 };
 /**
@@ -54,6 +57,12 @@ const formatLanguageValue = ({ display_format, lang }) => {
  * @returns {string} The compact layout language SVG node.
  */
 const createCompactLangNode = ({ lang, x, y, display_format }) => {
+    if (!Number.isFinite(x)) {
+        throw new Error(`Invalid x: "${x}"`);
+    }
+    if (!Number.isFinite(y)) {
+        throw new Error(`Invalid y: "${y}"`);
+    }
     // @ts-ignore
     const color = languageColors[lang.name] || "#858585";
     const value = formatLanguageValue({ display_format, lang });
@@ -61,7 +70,7 @@ const createCompactLangNode = ({ lang, x, y, display_format }) => {
     <g transform="translate(${x}, ${y})">
       <circle cx="5" cy="6" r="5" fill="${color}" />
       <text data-testid="lang-name" x="15" y="10" class='lang-name'>
-        ${lang.name} - ${value}
+        ${encodeHTML(lang.name)} - ${encodeHTML(value)}
       </text>
     </g>
   `;
@@ -107,6 +116,12 @@ const createLanguageTextNode = ({ langs, y, display_format, card_width }) => {
  * @returns {string} The text SVG node.
  */
 const createTextNode = ({ id, label, value, index, percent, hideProgress, progressBarColor, progressBarBackgroundColor, progressBarWidth, }) => {
+    if (!Number.isFinite(index)) {
+        throw new Error(`Invalid index: "${index}"`);
+    }
+    if (!Number.isFinite(progressBarWidth)) {
+        throw new Error(`Invalid progressBarWidth: "${progressBarWidth}"`);
+    }
     const staggerDelay = (index + 3) * 150;
     const cardProgress = hideProgress
         ? null
@@ -123,12 +138,12 @@ const createTextNode = ({ id, label, value, index, percent, hideProgress, progre
         });
     return `
     <g class="stagger" style="animation-delay: ${staggerDelay}ms" transform="translate(25, 0)">
-      <text class="stat bold" y="12.5" data-testid="${id}">${label}:</text>
+      <text class="stat bold" y="12.5" data-testid="${encodeHTML(id)}">${encodeHTML(label)}:</text>
       <text
         class="stat"
         x="${hideProgress ? HIDDEN_PROGRESSBAR_PADDING : PROGRESSBAR_PADDING + progressBarWidth}"
         y="12.5"
-      >${value}</text>
+      >${encodeHTML(value)}</text>
       ${cardProgress}
     </g>
   `;
@@ -155,9 +170,12 @@ const recalculatePercentages = (languages) => {
  * @param {string} colors.textColor The text color.
  * @returns {string} Card CSS styles.
  */
-const getStyles = ({ 
+const getStyles = function ({ 
 // eslint-disable-next-line no-unused-vars
-titleColor, textColor, }) => {
+titleColor, textColor, }) {
+    if (!isPrefixedHexColor(textColor)) {
+        throw new Error(`Invalid text color: "${textColor}"`);
+    }
     return `
     .stat {
       font: 600 14px 'Segoe UI', Ubuntu, "Helvetica Neue", Sans-Serif; fill: ${textColor};
@@ -303,7 +321,9 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
                         // @ts-ignore
                         progressBarColor: titleColor,
                         // @ts-ignore
-                        progressBarBackgroundColor: textColor === titleColor ? bgColor : textColor,
+                        progressBarBackgroundColor: textColor === titleColor
+                            ? "#fff0" // transparent
+                            : textColor,
                         hideProgress: hide_progress,
                         progressBarWidth: normalizedWidth - TOTAL_TEXT_WIDTH,
                     });

package/build/common/Card.d.ts

@@ -1,49 +1,22 @@
-export default Card;
-export class Card {
-    /**
-     * Creates a new card instance.
-     *
-     * @param {object} args Card arguments.
-     * @param {number=} args.width Card width.
-     * @param {number=} args.height Card height.
-     * @param {number=} args.border_radius Card border radius.
-     * @param {string=} args.customTitle Card custom title.
-     * @param {string=} args.defaultTitle Card default title.
-     * @param {string=} args.titlePrefixIcon Card title prefix icon.
-     * @param {object} [args.colors={}] Card colors arguments.
-     * @param {string=} args.colors.titleColor Card title color.
-     * @param {string=} args.colors.textColor Card text color.
-     * @param {string=} args.colors.iconColor Card icon color.
-     * @param {string|string[]=} args.colors.bgColor Card background color.
-     * @param {string=} args.colors.borderColor Card border color.
-     */
-    constructor({ width, height, border_radius, colors, customTitle, defaultTitle, titlePrefixIcon, }: {
-        width?: number | undefined;
-        height?: number | undefined;
-        border_radius?: number | undefined;
-        customTitle?: string | undefined;
-        defaultTitle?: string | undefined;
-        titlePrefixIcon?: string | undefined;
-        colors?: {
-            titleColor?: string | undefined;
-            textColor?: string | undefined;
-            iconColor?: string | undefined;
-            bgColor?: (string | string[]) | undefined;
-            borderColor?: string | undefined;
-        } | undefined;
-    });
+interface CardColors {
+    /** Card title color. */
+    titleColor?: string;
+    /** Card text color. */
+    textColor?: string;
+    /** Card icon color. */
+    iconColor?: string;
+    /** Card background color. */
+    bgColor?: string | Array<string>;
+    /** Card border color. */
+    borderColor?: string;
+}
+declare class Card {
     width: number;
     height: number;
     hideBorder: boolean;
     hideTitle: boolean;
     border_radius: number;
-    colors: {
-        titleColor?: string | undefined;
-        textColor?: string | undefined;
-        iconColor?: string | undefined;
-        bgColor?: (string | string[]) | undefined;
-        borderColor?: string | undefined;
-    };
+    colors: CardColors;
     title: string;
     css: string;
     paddingX: number;
@@ -53,57 +26,78 @@ export class Card {
     a11yTitle: string;
     a11yDesc: string;
     /**
-     * @returns {void}
+     * Creates a new card instance.
+     *
+     * The caller must ensure that the passed `titlePrefixIcon` is properly sanitized!
+     *
+     * @param props Card arguments.
+     * @param props.width Card width.
+     * @param props.height Card height.
+     * @param props.border_radius Card border radius.
+     * @param props.colors Card colors arguments.
+     * @param props.customTitle Card custom title.
+     * @param props.defaultTitle Card default title.
+     * @param props.titlePrefixIcon Sanitized card title prefix icon.
      */
+    constructor({ width, height, border_radius, colors, customTitle, defaultTitle, titlePrefixIcon, }: {
+        width?: number;
+        height?: number;
+        border_radius?: number;
+        colors?: CardColors;
+        customTitle?: string;
+        defaultTitle?: string;
+        titlePrefixIcon?: string;
+    });
     disableAnimations(): void;
     /**
-     * @param {Object} props The props object.
-     * @param {string} props.title Accessibility title.
-     * @param {string} props.desc Accessibility description.
-     * @returns {void}
+     * @param props The props object.
+     * @param props.title Accessibility title.
+     * @param props.desc Accessibility description.
      */
-    setAccessibilityLabel({ title, desc }: {
+    setAccessibilityLabel({ title, desc, }: {
         title: string;
         desc: string;
     }): void;
     /**
-     * @param {string} value The CSS to add to the card.
-     * @returns {void}
+     * The caller must ensure that the passed `css` string is properly sanitized!
+     *
+     * @param value The sanitized CSS to add to the card.
      */
     setCSS(value: string): void;
     /**
-     * @param {boolean} value Whether to hide the border or not.
-     * @returns {void}
+     * @param value Whether to hide the border or not.
      */
     setHideBorder(value: boolean): void;
     /**
-     * @param {boolean} value Whether to hide the title or not.
-     * @returns {void}
+     * @param value Whether to hide the title or not.
      */
     setHideTitle(value: boolean): void;
     /**
-     * @param {string} text The title to set.
-     * @returns {void}
+     * @param text The title to set.
      */
     setTitle(text: string): void;
     /**
-     * @returns {string} The rendered card title.
+     * @returns The rendered card title.
      */
     renderTitle(): string;
     /**
-     * @returns {string} The rendered card gradient.
+     * @returns The rendered card gradient.
      */
     renderGradient(): string;
     /**
      * Retrieves css animations for a card.
      *
-     * @returns {string} Animation css.
+     * @returns Animation css.
      */
     getAnimations: () => string;
     /**
-     * @param {string} body The inner body of the card.
-     * @returns {string} The rendered card.
+     * The caller must ensure that the passed `body` string is properly sanitized!
+     *
+     * @param body The sanitized inner body of the card.
+     * @returns The rendered card.
      */
     render(body: string): string;
 }
+export { Card };
+export default Card;
 //# sourceMappingURL=Card.d.ts.map

package/build/common/Card.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Card.d.ts","sourceRoot":"","sources":["../../src/common/Card.js"],"names":[],"mappings":";AAKA;IACE;;;;;;;;;;;;;;;;OAgBG;IACH,mGAbG;QAAsB,KAAK,GAAnB,MAAM,YAAC;QACO,MAAM,GAApB,MAAM,YAAC;QACO,aAAa,GAA3B,MAAM,YAAC;QACO,WAAW,GAAzB,MAAM,YAAC;QACO,YAAY,GAA1B,MAAM,YAAC;QACO,eAAe,GAA7B,MAAM,YAAC;QACO,MAAM;yBACpB,MAAM,YAAC;wBACP,MAAM,YAAC;wBACP,MAAM,YAAC;sBACP,CAAA,MAAM,GAAC,MAAM,EAAE,aAAC;0BAChB,MAAM,YAAC;;KACjB,EAiCA;IAvBC,cAAkB;IAClB,eAAoB;IAEpB,oBAAuB;IACvB,mBAAsB;IAEtB,sBAAkC;IAGlC;qBAxBS,MAAM,YAAC;oBACP,MAAM,YAAC;oBACP,MAAM,YAAC;kBACP,CAAA,MAAM,GAAC,MAAM,EAAE,aAAC;sBAChB,MAAM,YAAC;MAoBI;IACpB,cAG6B;IAE7B,YAAa;IAEb,iBAAkB;IAClB,iBAAkB;IAClB,oCAAsC;IACtC,oBAAsB;IACtB,kBAAmB;IACnB,iBAAkB;IAGpB;;OAEG;IACH,qBAFa,IAAI,CAIhB;IAED;;;;;OAKG;IACH,uCAJG;QAAsB,KAAK,EAAnB,MAAM;QACQ,IAAI,EAAlB,MAAM;KACd,GAAU,IAAI,CAKhB;IAED;;;OAGG;IACH,cAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;OAGG;IACH,qBAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;OAGG;IACH,oBAHW,OAAO,GACL,IAAI,CAOhB;IAED;;;OAGG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;OAEG;IACH,eAFa,MAAM,CAoClB;IAED;;OAEG;IACH,kBAFa,MAAM,CAwBlB;IAED;;;;OAIG;IACH,qBAFa,MAAM,CAsBjB;IAEF;;;OAGG;IACH,aAHW,MAAM,GACJ,MAAM,CAiElB;CACF"}
+{"version":3,"file":"Card.d.ts","sourceRoot":"","sources":["../../src/common/Card.ts"],"names":[],"mappings":"AAIA,UAAU,UAAU;IAClB,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IACjC,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,cAAM,IAAI;IACR,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;OAaG;gBACS,EACV,KAAW,EACX,MAAY,EACZ,aAAmB,EACnB,MAAW,EACX,WAAW,EACX,YAAiB,EACjB,eAAe,GAChB,EAAE;QACD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAuBD,iBAAiB,IAAI,IAAI;IAIzB;;;;OAIG;IACH,qBAAqB,CAAC,EACpB,KAAK,EACL,IAAI,GACL,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,IAAI;IAKR;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3B;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAInC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAUlC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5B;;OAEG;IACH,WAAW,IAAI,MAAM;IAoCrB;;OAEG;IACH,cAAc,IAAI,MAAM;IA2BxB;;;;OAIG;IACH,aAAa,QAAO,MAAM,CAoBxB;IAEF;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CA0F7B;AAED,OAAO,EAAE,IAAI,EAAE,CAAC;AAChB,eAAe,IAAI,CAAC"}