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

package/build/common/render.d.ts

@@ -1,96 +1,173 @@
 /**
- * Renders error message on the card.
+ * Auto layout utility, allows us to layout things vertically or horizontally with
+ * proper gaping.
+ *
+ * The caller must ensure that the passed `items` are properly sanitized!
  *
- * @param {object} args Function arguments.
- * @param {string} args.message Main error message.
- * @param {string} [args.secondaryMessage=""] The secondary error message.
- * @param {object} [args.renderOptions={}] Render options.
- * @param {string=} args.renderOptions.title_color Card title color.
- * @param {string=} args.renderOptions.text_color Card text color.
- * @param {string=} args.renderOptions.bg_color Card background color.
- * @param {string=} args.renderOptions.border_color Card border color.
- * @param {Parameters<typeof getCardColors>[0]["theme"]=} args.renderOptions.theme Card theme.
- * @param {boolean=} args.renderOptions.show_repo_link Whether to show repo link or not.
- * @returns {string} The SVG markup.
+ * @param props Function properties.
+ * @param props.items Array of sanitized items to layout.
+ * @param props.gap Gap between items.
+ * @param props.direction Direction to layout items.
+ * @param props.sizes Array of sizes for each item.
+ * @returns Array of items with proper layout.
  */
-export function renderError({ message, secondaryMessage, renderOptions, }: {
-    message: string;
-    secondaryMessage?: string | undefined;
-    renderOptions?: {
-        title_color?: string | undefined;
-        text_color?: string | undefined;
-        bg_color?: string | undefined;
-        border_color?: string | undefined;
-        theme?: Parameters<typeof getCardColors>[0]["theme"] | undefined;
-        show_repo_link?: boolean | undefined;
-    } | undefined;
-}): string;
+declare const flexLayout: ({ items, gap, direction, sizes, }: {
+    items: Array<string>;
+    gap: number;
+    direction?: "column" | "row";
+    sizes?: Array<number>;
+}) => Array<string>;
 /**
  * Creates a node to display the primary programming language of the repository/gist.
  *
- * @param {string} langName Language name.
- * @param {string} langColor Language color.
- * @returns {string} Language display SVG object.
+ * @param langName Language name.
+ * @param langColor Language color.
+ * @returns Language display SVG object.
  */
-export function createLanguageNode(langName: string, langColor: string): string;
+declare const createLanguageNode: (langName: string, langColor: string) => string;
 /**
  * Create a node to indicate progress in percentage along a horizontal line.
  *
- * @param {Object} params Object that contains the createProgressNode parameters.
- * @param {number} params.x X-axis position.
- * @param {number} params.y Y-axis position.
- * @param {number} params.width Width of progress bar.
- * @param {string} params.color Progress color.
- * @param {number} params.progress Progress value.
- * @param {string} params.progressBarBackgroundColor Progress bar bg color.
- * @param {number} params.delay Delay before animation starts.
- * @returns {string} Progress node.
+ * @param params Object that contains the createProgressNode parameters.
+ * @param params.x X-axis position.
+ * @param params.y Y-axis position.
+ * @param params.width Width of progress bar.
+ * @param params.color Optional foreground color as an inline fill fallback.
+ *   When omitted, the color must be set via a `.lang-progress` CSS rule.
+ * @param params.progress Progress value.
+ * @param params.delay Delay before animation starts.
+ * @returns Progress node.
  */
-export function createProgressNode({ x, y, width, color, progress, progressBarBackgroundColor, delay, }: {
+declare const createProgressNode: ({ x, y, width, color, progress, delay, }: {
     x: number;
     y: number;
     width: number;
-    color: string;
+    color?: string;
     progress: number;
-    progressBarBackgroundColor: string;
     delay: number;
-}): string;
+}) => string;
+/**
+ * Renders multi-line text via a `foreignObject` so the browser performs
+ * native, font-aware wrapping. Content overflowing `lineCount` lines is
+ * clipped (with an ellipsis on the last visible line) by CSS line-clamp.
+ *
+ * @param props Function properties.
+ * @param props.text Text to render (will be HTML-encoded).
+ * @param props.x X position of the foreignObject.
+ * @param props.y Y position of the foreignObject.
+ * @param props.width Width of the wrap box.
+ * @param props.height Height of the wrap box.
+ * @param props.lineCount Maximum number of lines to display.
+ * @param props.className CSS class applied to the inner element.
+ * @param props.testId Optional test id for the inner element.
+ * @returns foreignObject SVG node.
+ */
+declare const wrappedTextNode: ({ text, x, y, width, height, lineCount, className, testId, }: {
+    text: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    lineCount: number;
+    className: string;
+    testId?: string;
+}) => string;
+/**
+ * CSS rules used to render multi-line text inside a `foreignObject`. Apply this
+ * to a CSS class (e.g. `.description`) shared with `wrappedTextNode` so the
+ * browser handles wrapping and the line count is taken from the `--lines`
+ * custom property set on the element.
+ *
+ * @param color Text color (CSS `color` property).
+ * @returns CSS rules block (without the surrounding selector).
+ */
+declare const wrappedTextStyles: (color: string) => string;
 /**
  * Creates an icon with label to display repository/gist stats like forks, stars, etc.
  *
- * @param {string} icon The icon to display.
- * @param {number|string} label The label to display.
- * @param {string} testid The testid to assign to the label.
- * @param {number} iconSize The size of the icon.
- * @returns {string} Icon with label SVG object.
+ * The caller must ensure that the passed `icon` is properly sanitized!
+ *
+ * @param icon The sanitized icon to display.
+ * @param label The label to display.
+ * @param testid The testid to assign to the label.
+ * @param iconSize The size of the icon.
+ * @returns Icon with label SVG object.
  */
-export function iconWithLabel(icon: string, label: number | string, testid: string, iconSize: number): string;
+declare const iconWithLabel: (icon: string, label: number | string, testid: string, iconSize: number) => string;
 /**
- * Auto layout utility, allows us to layout things vertically or horizontally with
- * proper gaping.
+ * Create a labelled stat text item
+ * (a label and its value, optionally with an icon and link).
+ * Shared by the stats and repo cards.
+ *
+ * The caller must ensure that the passed `icon` and `link` are properly sanitized!
  *
- * @param {object} props Function properties.
- * @param {string[]} props.items Array of items to layout.
- * @param {number} props.gap Gap between items.
- * @param {"column" | "row"=} props.direction Direction to layout items.
- * @param {number[]=} props.sizes Array of sizes for each item.
- * @returns {string[]} Array of items with proper layout.
+ * @param params Object that contains the createTextNode parameters.
+ * @param params.icon The sanitized icon to display.
+ * @param params.label The label to display.
+ * @param params.value The value to display.
+ * @param params.id The id of the stat.
+ * @param params.unitSymbol The unit symbol of the stat.
+ * @param params.index The index of the stat.
+ * @param params.showIcons Whether to show icons.
+ * @param params.shiftValuePos Number of pixels the value has to be shifted to the right.
+ * @param params.bold Whether to bold the label.
+ * @param params.numberFormat The format of numbers on card.
+ * @param params.numberPrecision The precision of numbers on card.
+ * @param params.link Sanitized url to link to.
+ * @param params.labelXOffset horizontal offset for label.
+ * @returns The stats card text item SVG object.
  */
-export function flexLayout({ items, gap, direction, sizes }: {
-    items: string[];
-    gap: number;
-    direction?: ("column" | "row") | undefined;
-    sizes?: number[] | undefined;
-}): string[];
+declare const createTextNode: ({ icon, label, value, id, unitSymbol, index, showIcons, shiftValuePos, bold, numberFormat, numberPrecision, link, labelXOffset, }: {
+    icon: string;
+    label: string;
+    value: number | string;
+    id: string;
+    unitSymbol?: string | undefined;
+    index: number;
+    showIcons: boolean;
+    shiftValuePos: number;
+    bold: boolean;
+    numberFormat: string;
+    numberPrecision?: number | undefined;
+    link?: string | undefined;
+    labelXOffset?: number;
+}) => string;
+/**
+ * Renders error message on the card.
+ *
+ * @param args Function arguments.
+ * @param args.message Main error message.
+ * @param args.secondaryMessage The secondary error message.
+ * @param args.renderOptions Render options.
+ * @param args.renderOptions.title_color Card title color.
+ * @param args.renderOptions.text_color Card text color.
+ * @param args.renderOptions.bg_color Card background color.
+ * @param args.renderOptions.border_color Card border color.
+ * @param args.renderOptions.theme Card theme.
+ * @param args.renderOptions.show_repo_link Whether to show repo link or not.
+ * @returns The SVG markup.
+ */
+declare const renderError: ({ message, secondaryMessage, renderOptions, }: {
+    message: string;
+    secondaryMessage?: string;
+    renderOptions?: {
+        title_color?: string;
+        text_color?: string;
+        bg_color?: string;
+        border_color?: string;
+        theme?: string;
+        show_repo_link?: boolean;
+    };
+}) => string;
 /**
  * Retrieve text length based on Segoe UI font.
  *
  * @see https://stackoverflow.com/a/48172630/10629172
- * @param {string} str String to measure.
- * @param {number} fontSize Font size.
- * @returns {number} Text length.
+ * @param str String to measure.
+ * @param fontSize Font size.
+ * @returns Text length.
  */
-export function measureText(str: string, fontSize?: number): number;
+declare const measureText: (str: string, fontSize?: number) => number;
 /**
  * Split text into the lines it would wrap to when laid out greedily at the
  * given font size inside a box of width `maxWidth`. Uses `measureText` so the
@@ -98,58 +175,22 @@ export function measureText(str: string, fontSize?: number): number;
  * The browser still does the real wrap inside the foreignObject; this is only
  * used to size the SVG.
  *
- * @param {string} text Text to split.
- * @param {number} fontSize Font size in px (matches `measureText`).
- * @param {number} maxWidth Available wrap width in px.
- * @returns {string[]} Estimated wrapped lines.
+ * @param text Text to split.
+ * @param fontSize Font size in px (matches `measureText`).
+ * @param maxWidth Available wrap width in px.
+ * @returns Estimated wrapped lines.
  */
-export function splitWrappedText(text: string, fontSize: number, maxWidth: number): string[];
+declare const splitWrappedText: (text: string, fontSize: number, maxWidth: number) => Array<string>;
 /**
  * Estimate how many lines a string will wrap to when laid out greedily at the
  * given font size inside a box of width `maxWidth`, capped at `maxLines`.
  *
- * @param {string} text Text to estimate.
- * @param {number} fontSize Font size in px (matches `measureText`).
- * @param {number} maxWidth Available wrap width in px.
- * @param {number} maxLines Cap on the returned line count.
- * @returns {number} Estimated line count, at least 1, at most `maxLines`.
- */
-export function countWrappedLines(text: string, fontSize: number, maxWidth: number, maxLines: number): number;
-/**
- * Renders multi-line text via a `foreignObject` so the browser performs
- * native, font-aware wrapping. Content overflowing `lineCount` lines is
- * clipped (with an ellipsis on the last visible line) by CSS line-clamp.
- *
- * @param {object} props Function properties.
- * @param {string} props.text Text to render (will be HTML-encoded).
- * @param {number} props.x X position of the foreignObject.
- * @param {number} props.y Y position of the foreignObject.
- * @param {number} props.width Width of the wrap box.
- * @param {number} props.height Height of the wrap box.
- * @param {number} props.lineCount Maximum number of lines to display.
- * @param {string} props.className CSS class applied to the inner element.
- * @param {string=} props.testId Optional test id for the inner element.
- * @returns {string} foreignObject SVG node.
- */
-export function wrappedTextNode({ text, x, y, width, height, lineCount, className, testId, }: {
-    text: string;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    lineCount: number;
-    className: string;
-    testId?: string | undefined;
-}): string;
-/**
- * CSS rules used to render multi-line text inside a `foreignObject`. Apply this
- * to a CSS class (e.g. `.description`) shared with `wrappedTextNode` so the
- * browser handles wrapping and the line count is taken from the `--lines`
- * custom property set on the element.
- *
- * @param {string} color Text color (CSS `color` property).
- * @returns {string} CSS rules block (without the surrounding selector).
+ * @param text Text to estimate.
+ * @param fontSize Font size in px (matches `measureText`).
+ * @param maxWidth Available wrap width in px.
+ * @param maxLines Cap on the returned line count.
+ * @returns Estimated line count, at least 1, at most `maxLines`.
  */
-export function wrappedTextStyles(color: string): string;
-import { getCardColors } from "./color.js";
+declare const countWrappedLines: (text: string, fontSize: number, maxWidth: number, maxLines: number) => number;
+export { renderError, createLanguageNode, createProgressNode, createTextNode, iconWithLabel, flexLayout, measureText, splitWrappedText, countWrappedLines, wrappedTextNode, wrappedTextStyles, };
 //# sourceMappingURL=render.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/common/render.js"],"names":[],"mappings":"AAuLA;;;;;;;;;;;;;;GAcG;AACH,2EAXG;IAAqB,OAAO,EAApB,MAAM;IACQ,gBAAgB;IAChB,aAAa;sBAC3B,MAAM,YAAC;qBACP,MAAM,YAAC;mBACP,MAAM,YAAC;uBACP,MAAM,YAAC;gBACP,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAC;yBAC7C,OAAO,YAAC;;CAChB,GAAU,MAAM,CAgDlB;AAtND;;;;;;GAMG;AACH,6CAJW,MAAM,aACN,MAAM,GACJ,MAAM,CASlB;AAED;;;;;;;;;;;;GAYG;AACH,yGATG;IAAuB,CAAC,EAAhB,MAAM;IACS,CAAC,EAAhB,MAAM;IACS,KAAK,EAApB,MAAM;IACS,KAAK,EAApB,MAAM;IACS,QAAQ,EAAvB,MAAM;IACS,0BAA0B,EAAzC,MAAM;IACS,KAAK,EAApB,MAAM;CACd,GAAU,MAAM,CA2BlB;AA8DD;;;;;;;;GAQG;AACH,oCANW,MAAM,SACN,MAAM,GAAC,MAAM,UACb,MAAM,YACN,MAAM,GACJ,MAAM,CAoBlB;AAxKD;;;;;;;;;;GAUG;AACH,6DANG;IAAwB,KAAK,EAArB,MAAM,EAAE;IACM,GAAG,EAAjB,MAAM;IACmB,SAAS,GAAlC,CAAA,QAAQ,GAAG,KAAK,aAAC;IACA,KAAK,GAAtB,MAAM,EAAE,YAAC;CACjB,GAAU,MAAM,EAAE,CAcpB;AA0ND;;;;;;;GAOG;AACH,iCAJW,MAAM,aACN,MAAM,GACJ,MAAM,CA6DlB;AAED;;;;;;;;;;;GAWG;AACH,uCALW,MAAM,YACN,MAAM,YACN,MAAM,GACJ,MAAM,EAAE,CAoFpB;AAED;;;;;;;;;GASG;AACH,wCANW,MAAM,YACN,MAAM,YACN,MAAM,YACN,MAAM,GACJ,MAAM,CAOlB;AApVD;;;;;;;;;;;;;;;GAeG;AACH,8FAVG;IAAsB,IAAI,EAAlB,MAAM;IACQ,CAAC,EAAf,MAAM;IACQ,CAAC,EAAf,MAAM;IACQ,KAAK,EAAnB,MAAM;IACQ,MAAM,EAApB,MAAM;IACQ,SAAS,EAAvB,MAAM;IACQ,SAAS,EAAvB,MAAM;IACS,MAAM,GAArB,MAAM,YAAC;CACf,GAAU,MAAM,CAoBlB;AAED;;;;;;;;GAQG;AACH,yCAHW,MAAM,GACJ,MAAM,CAelB;8BAhJ6B,YAAY"}
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/common/render.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;GAYG;AACH,QAAA,MAAM,UAAU,GAAI,mCAKjB;IACD,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;IAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB,KAAG,KAAK,CAAC,MAAM,CAgBf,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB,GAAI,UAAU,MAAM,EAAE,WAAW,MAAM,KAAG,MAWjE,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,QAAA,MAAM,kBAAkB,GAAI,0CAOzB;IACD,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,KAAG,MAiCH,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,eAAe,GAAI,8DAStB;IACD,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,MAyBH,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,iBAAiB,GAAI,OAAO,MAAM,KAAG,MAmB1C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,QAAA,MAAM,aAAa,GACjB,MAAM,MAAM,EACZ,OAAO,MAAM,GAAG,MAAM,EACtB,QAAQ,MAAM,EACd,UAAU,MAAM,KACf,MAuBF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,QAAA,MAAM,cAAc,GAAI,mIAcrB;IACD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,OAAO,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,KAAG,MAoDH,CAAC;AAUF;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,WAAW,GAAI,+CAIlB;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH,KAAG,MAyCH,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,WAAW,GAAI,KAAK,MAAM,EAAE,iBAAa,KAAG,MA2DjD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,gBAAgB,GACpB,MAAM,MAAM,EACZ,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,KAAK,CAAC,MAAM,CAkFd,CAAC;AAEF;;;;;;;;;GASG;AACH,QAAA,MAAM,iBAAiB,GACrB,MAAM,MAAM,EACZ,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,MAKF,CAAC;AAEF,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,GAClB,CAAC"}