@stats-organization/github-readme-stats-core 0.0.1

package/build/common/ops.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Returns boolean if value is either "true" or "false" else the value as it is.
+ *
+ * @param {string | boolean} value The value to parse.
+ * @returns {boolean | undefined } The parsed value.
+ */
+export function parseBoolean(value: string | boolean): boolean | undefined;
+/**
+ * Parse string to array of strings.
+ *
+ * @param {string} str The string to parse.
+ * @returns {string[]} The array of strings.
+ */
+export function parseArray(str: string): string[];
+/**
+ * Clamp the given number between the given range.
+ *
+ * @param {number} number The number to clamp.
+ * @param {number} min The minimum value.
+ * @param {number} max The maximum value.
+ * @returns {number} The clamped number.
+ */
+export function clampValue(number: number, min: number, max: number): number;
+/**
+ * Lowercase and trim string.
+ *
+ * @param {string} name String to lowercase and trim.
+ * @returns {string} Lowercased and trimmed string.
+ */
+export function lowercaseTrim(name: string): string;
+/**
+ * Split array of languages in two columns.
+ *
+ * @template T Language object.
+ * @param {Array<T>} arr Array of languages.
+ * @param {number} perChunk Number of languages per column.
+ * @returns {Array<T>} Array of languages split in two columns.
+ */
+export function chunkArray<T>(arr: Array<T>, perChunk: number): Array<T>;
+/**
+ * Parse emoji from string.
+ *
+ * @param {string} str String to parse emoji from.
+ * @returns {string} String with emoji parsed.
+ */
+export function parseEmojis(str: string): string;
+/**
+ * Get diff in minutes between two dates.
+ *
+ * @param {Date} d1 First date.
+ * @param {Date} d2 Second date.
+ * @returns {number} Number of minutes between the two dates.
+ */
+export function dateDiff(d1: Date, d2: Date): number;
+/**
+ * Parse owner affiliations.
+ *
+ * @param {string[]} affiliations input affiliations to be parsed.
+ * @returns {string[]} Parsed affiliations.
+ *
+ * @throws {CustomError} If affiliations contains invalid values.
+ */
+export function parseOwnerAffiliations(affiliations: string[]): string[];
+export function buildSearchFilter(repos?: any[], owners?: any[]): string;
+//# sourceMappingURL=ops.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ops.d.ts","sourceRoot":"","sources":["../../src/common/ops.js"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,oCAHW,MAAM,GAAG,OAAO,GACd,OAAO,GAAG,SAAS,CAe/B;AAED;;;;;GAKG;AACH,gCAHW,MAAM,GACJ,MAAM,EAAE,CAOpB;AAED;;;;;;;GAOG;AACH,mCALW,MAAM,OACN,MAAM,OACN,MAAM,GACJ,MAAM,CAQlB;AAED;;;;;GAKG;AACH,oCAHW,MAAM,GACJ,MAAM,CAEsC;AAEzD;;;;;;;GAOG;AACH,2BALa,CAAC,OACH,KAAK,CAAC,CAAC,CAAC,YACR,MAAM,GACJ,KAAK,CAAC,CAAC,CAAC,CAgBpB;AAED;;;;;GAKG;AACH,iCAHW,MAAM,GACJ,MAAM,CASlB;AAED;;;;;;GAMG;AACH,6BAJW,IAAI,MACJ,IAAI,GACF,MAAM,CAOlB;AAED;;;;;;;GAOG;AACH,qDALW,MAAM,EAAE,GACN,MAAM,EAAE,CAyBpB;AAED,yEAUC"}

package/build/common/ops.js

@@ -0,0 +1,137 @@
+// @ts-check
+import toEmoji from "emoji-name-map";
+import { OWNER_AFFILIATIONS } from "./constants.js";
+import { CustomError } from "./error.js";
+/**
+ * Returns boolean if value is either "true" or "false" else the value as it is.
+ *
+ * @param {string | boolean} value The value to parse.
+ * @returns {boolean | undefined } The parsed value.
+ */
+const parseBoolean = (value) => {
+    if (typeof value === "boolean") {
+        return value;
+    }
+    if (typeof value === "string") {
+        if (value.toLowerCase() === "true") {
+            return true;
+        }
+        else if (value.toLowerCase() === "false") {
+            return false;
+        }
+    }
+    return undefined;
+};
+/**
+ * Parse string to array of strings.
+ *
+ * @param {string} str The string to parse.
+ * @returns {string[]} The array of strings.
+ */
+const parseArray = (str) => {
+    if (!str) {
+        return [];
+    }
+    return str.split(",");
+};
+/**
+ * Clamp the given number between the given range.
+ *
+ * @param {number} number The number to clamp.
+ * @param {number} min The minimum value.
+ * @param {number} max The maximum value.
+ * @returns {number} The clamped number.
+ */
+const clampValue = (number, min, max) => {
+    // @ts-ignore
+    if (Number.isNaN(parseInt(number, 10))) {
+        return min;
+    }
+    return Math.max(min, Math.min(number, max));
+};
+/**
+ * Lowercase and trim string.
+ *
+ * @param {string} name String to lowercase and trim.
+ * @returns {string} Lowercased and trimmed string.
+ */
+const lowercaseTrim = (name) => name.toLowerCase().trim();
+/**
+ * Split array of languages in two columns.
+ *
+ * @template T Language object.
+ * @param {Array<T>} arr Array of languages.
+ * @param {number} perChunk Number of languages per column.
+ * @returns {Array<T>} Array of languages split in two columns.
+ */
+const chunkArray = (arr, perChunk) => {
+    return arr.reduce((resultArray, item, index) => {
+        const chunkIndex = Math.floor(index / perChunk);
+        if (!resultArray[chunkIndex]) {
+            // @ts-ignore
+            resultArray[chunkIndex] = []; // start a new chunk
+        }
+        // @ts-ignore
+        resultArray[chunkIndex].push(item);
+        return resultArray;
+    }, []);
+};
+/**
+ * Parse emoji from string.
+ *
+ * @param {string} str String to parse emoji from.
+ * @returns {string} String with emoji parsed.
+ */
+const parseEmojis = (str) => {
+    if (!str) {
+        throw new Error("[parseEmoji]: str argument not provided");
+    }
+    return str.replace(/:\w+:/gm, (emoji) => {
+        return toEmoji.get(emoji) || "";
+    });
+};
+/**
+ * Get diff in minutes between two dates.
+ *
+ * @param {Date} d1 First date.
+ * @param {Date} d2 Second date.
+ * @returns {number} Number of minutes between the two dates.
+ */
+const dateDiff = (d1, d2) => {
+    const date1 = new Date(d1);
+    const date2 = new Date(d2);
+    const diff = date1.getTime() - date2.getTime();
+    return Math.round(diff / (1000 * 60));
+};
+/**
+ * Parse owner affiliations.
+ *
+ * @param {string[]} affiliations input affiliations to be parsed.
+ * @returns {string[]} Parsed affiliations.
+ *
+ * @throws {CustomError} If affiliations contains invalid values.
+ */
+const parseOwnerAffiliations = (affiliations) => {
+    // Set default value for ownerAffiliations.
+    // NOTE: Done here since parseArray() will always return an empty array even nothing
+    //was specified.
+    affiliations =
+        affiliations && affiliations.length > 0
+            ? affiliations.map((affiliation) => affiliation.toUpperCase())
+            : ["OWNER"];
+    // Check if ownerAffiliations contains valid values.
+    if (affiliations.some((affiliation) => !OWNER_AFFILIATIONS.includes(affiliation))) {
+        throw new CustomError("Invalid query parameter", CustomError.INVALID_AFFILIATION);
+    }
+    return affiliations;
+};
+const buildSearchFilter = (repos = [], owners = []) => {
+    let repoFilter = Array.isArray(repos) && repos.length > 0
+        ? repos.map((r) => `repo:${r} `).join("")
+        : "";
+    let orgFilter = Array.isArray(owners) && owners.length > 0
+        ? owners.map((o) => `owner:${o} `).join("")
+        : "";
+    return repoFilter + orgFilter;
+};
+export { parseBoolean, parseArray, clampValue, lowercaseTrim, chunkArray, parseEmojis, dateDiff, parseOwnerAffiliations, buildSearchFilter, };

package/build/common/render.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Renders error message on the card.
+ *
+ * @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.
+ */
+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;
+/**
+ * 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.
+ */
+export function 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.
+ */
+export function createProgressNode({ x, y, width, color, progress, progressBarBackgroundColor, delay, }: {
+    x: number;
+    y: number;
+    width: number;
+    color: string;
+    progress: number;
+    progressBarBackgroundColor: string;
+    delay: number;
+}): 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.
+ */
+export function 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.
+ *
+ * @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.
+ */
+export function flexLayout({ items, gap, direction, sizes }: {
+    items: string[];
+    gap: number;
+    direction?: ("column" | "row") | undefined;
+    sizes?: number[] | undefined;
+}): 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.
+ */
+export function 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
+ * estimate reflects actual font metrics rather than a fixed character count.
+ * 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.
+ */
+export function splitWrappedText(text: string, fontSize: number, maxWidth: number): 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).
+ */
+export function wrappedTextStyles(color: string): string;
+import { getCardColors } from "./color.js";
+//# sourceMappingURL=render.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/common/render.js"],"names":[],"mappings":"AAyLA;;;;;;;;;;;;;;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"}