@stats-forge/github-stats-forge-core 0.0.1

package/build/common/log.js

@@ -0,0 +1,8 @@
+/**
+ * Return console instance based on the environment.
+ */
+const logger = {
+    log: console.log,
+    error: console.error,
+};
+export { logger };

package/build/common/ops.d.ts

@@ -0,0 +1,59 @@
+import type { RepositoryAffiliation } from '../graphql/generated/common.js';
+/**
+ * Returns boolean if value is either "true" or "false" else the value as it is.
+ *
+ * @param value The value to parse; `undefined` when the param was not sent.
+ * @returns The parsed value.
+ */
+declare const parseBoolean: (value: string | boolean | undefined) => boolean | undefined;
+/**
+ * Parse string to array of strings.
+ *
+ * @param str The string to parse; `undefined` when the param was not sent.
+ * @returns The array of strings.
+ */
+declare const parseArray: (str: string | undefined) => Array<string>;
+/**
+ * Clamp the given number between the given range.
+ *
+ * @param number The number to clamp.
+ * @param min The minimum value.
+ * @param max The maximum value.
+ * @returns The clamped number.
+ */
+declare const clampValue: (number: string | number, min: number, max: number) => number;
+/**
+ * Lowercase and trim string.
+ *
+ * @param name String to lowercase and trim.
+ * @returns Lowercased and trimmed string.
+ */
+declare const lowercaseTrim: (name: string) => string;
+/**
+ * Split array of languages in two columns.
+ *
+ * @template T Language object.
+ * @param arr Array of languages.
+ * @param perChunk Number of languages per column.
+ * @returns Array of languages split in two columns.
+ */
+declare const chunkArray: <T>(arr: Array<T>, perChunk: number) => Array<Array<T>>;
+/**
+ * Parse emoji from string.
+ *
+ * @param str String to parse emoji from.
+ * @returns String with emoji parsed.
+ */
+declare const parseEmojis: (str: string) => string;
+/**
+ * Parse owner affiliations.
+ *
+ * @param affiliations input affiliations to be parsed.
+ * @returns Parsed affiliations.
+ *
+ * @throws {CardError} If affiliations contains invalid values.
+ */
+declare const parseOwnerAffiliations: (affiliations: Array<string>) => Array<RepositoryAffiliation>;
+declare const buildSearchFilter: (repos?: Array<string> | string, owners?: Array<string> | string) => string;
+export { parseBoolean, parseArray, clampValue, lowercaseTrim, chunkArray, parseEmojis, parseOwnerAffiliations, buildSearchFilter, };
+//# 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.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAK5E;;;;;GAKG;AACH,QAAA,MAAM,YAAY,GAAI,OAAO,MAAM,GAAG,OAAO,GAAG,SAAS,KAAG,OAAO,GAAG,SAarE,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,UAAU,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,KAAK,CAAC,MAAM,CAKzD,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,UAAU,GAAI,QAAQ,MAAM,GAAG,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,KAAG,MAKvE,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,MAAmC,CAAC;AAE1E;;;;;;;GAOG;AACH,QAAA,MAAM,UAAU,GAAI,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,UAAU,MAAM,KAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAQtE,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,WAAW,GAAI,KAAK,MAAM,KAAG,MAOlC,CAAC;AAKF;;;;;;;GAOG;AACH,QAAA,MAAM,sBAAsB,GAAI,cAAc,KAAK,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,qBAAqB,CAcxF,CAAC;AAEF,QAAA,MAAM,iBAAiB,GACrB,QAAO,KAAK,CAAC,MAAM,CAAC,GAAG,MAAW,EAClC,SAAQ,KAAK,CAAC,MAAM,CAAC,GAAG,MAAW,KAClC,MAMF,CAAC;AAEF,OAAO,EACL,YAAY,EACZ,UAAU,EACV,UAAU,EACV,aAAa,EACb,UAAU,EACV,WAAW,EACX,sBAAsB,EACtB,iBAAiB,GAClB,CAAC"}

package/build/common/ops.js

@@ -0,0 +1,115 @@
+import toEmoji from 'emoji-name-map';
+import { OWNER_AFFILIATIONS } from './constants.js';
+import { CardError, INVALID_AFFILIATION } from './error.js';
+/**
+ * Returns boolean if value is either "true" or "false" else the value as it is.
+ *
+ * @param value The value to parse; `undefined` when the param was not sent.
+ * @returns 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 str The string to parse; `undefined` when the param was not sent.
+ * @returns The array of strings.
+ */
+const parseArray = (str) => {
+    if (!str) {
+        return [];
+    }
+    return str.split(',');
+};
+/**
+ * Clamp the given number between the given range.
+ *
+ * @param number The number to clamp.
+ * @param min The minimum value.
+ * @param max The maximum value.
+ * @returns The clamped number.
+ */
+const clampValue = (number, min, max) => {
+    if (Number.isNaN(parseInt(String(number), 10))) {
+        return min;
+    }
+    return Math.max(min, Math.min(Number(number), max));
+};
+/**
+ * Lowercase and trim string.
+ *
+ * @param name String to lowercase and trim.
+ * @returns Lowercased and trimmed string.
+ */
+const lowercaseTrim = (name) => name.toLowerCase().trim();
+/**
+ * Split array of languages in two columns.
+ *
+ * @template T Language object.
+ * @param arr Array of languages.
+ * @param perChunk Number of languages per column.
+ * @returns Array of languages split in two columns.
+ */
+const chunkArray = (arr, perChunk) => {
+    return arr.reduce((resultArray, item, index) => {
+        const chunkIndex = Math.floor(index / perChunk);
+        const chunk = resultArray[chunkIndex] ?? [];
+        chunk.push(item);
+        resultArray[chunkIndex] = chunk;
+        return resultArray;
+    }, []);
+};
+/**
+ * Parse emoji from string.
+ *
+ * @param str String to parse emoji from.
+ * @returns 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) || '';
+    });
+};
+const isOwnerAffiliation = (value) => OWNER_AFFILIATIONS.some((affiliation) => affiliation === value);
+/**
+ * Parse owner affiliations.
+ *
+ * @param affiliations input affiliations to be parsed.
+ * @returns Parsed affiliations.
+ *
+ * @throws {CardError} 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.
+    const normalized = affiliations.length > 0
+        ? affiliations.map((affiliation) => affiliation.toUpperCase())
+        : ['OWNER'];
+    // Check if ownerAffiliations contains valid values.
+    if (!normalized.every(isOwnerAffiliation)) {
+        throw CardError.invalidParam('role', INVALID_AFFILIATION);
+    }
+    return normalized;
+};
+const buildSearchFilter = (repos = [], owners = []) => {
+    const repoFilter = Array.isArray(repos) && repos.length > 0 ? repos.map((r) => `repo:${r} `).join('') : '';
+    const orgFilter = Array.isArray(owners) && owners.length > 0 ? owners.map((o) => `owner:${o} `).join('') : '';
+    return repoFilter + orgFilter;
+};
+export { parseBoolean, parseArray, clampValue, lowercaseTrim, chunkArray, parseEmojis, parseOwnerAffiliations, buildSearchFilter, };

package/build/common/render.d.ts

@@ -0,0 +1,196 @@
+/**
+ * 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 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.
+ */
+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 langName Language name.
+ * @param langColor Language color.
+ * @returns Language display SVG object.
+ */
+declare const createLanguageNode: (langName: string, langColor: string) => string;
+/**
+ * Create a node to indicate progress in percentage along a horizontal line.
+ *
+ * @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.
+ */
+declare const createProgressNode: ({ x, y, width, color, progress, delay, }: {
+    x: number;
+    y: number;
+    width: number;
+    color?: string;
+    progress: number;
+    delay: number;
+}) => 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.
+ *
+ * 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.
+ */
+declare const iconWithLabel: (icon: string, label: number | string, testid: string, iconSize: number) => string;
+/**
+ * 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 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.
+ */
+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 | undefined;
+    renderOptions?: {
+        title_color?: string | undefined;
+        text_color?: string | undefined;
+        bg_color?: string | undefined;
+        border_color?: string | undefined;
+        theme?: string | undefined;
+        show_repo_link?: boolean | undefined;
+    };
+}) => string;
+/**
+ * Retrieve text length based on Segoe UI font.
+ *
+ * @see https://stackoverflow.com/a/48172630/10629172
+ * @param str String to measure.
+ * @param fontSize Font size.
+ * @returns Text length.
+ */
+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
+ * 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 text Text to split.
+ * @param fontSize Font size in px (matches `measureText`).
+ * @param maxWidth Available wrap width in px.
+ * @returns Estimated wrapped lines.
+ */
+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 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`.
+ */
+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

@@ -0,0 +1 @@
+{"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,MAgDH,CAAC;AAOF;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,WAAW,GAAI,+CAIlB;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,aAAa,CAAC,EAAE;QACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACjC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC9B,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAClC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACtC,CAAC;CACH,KAAG,MA2CH,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,WAAW,GAAI,KAAK,MAAM,EAAE,iBAAa,KAAG,MA2DjD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,gBAAgB,GAAI,MAAM,MAAM,EAAE,UAAU,MAAM,EAAE,UAAU,MAAM,KAAG,KAAK,CAAC,MAAM,CAkFxF,CAAC;AAEF;;;;;;;;;GASG;AACH,QAAA,MAAM,iBAAiB,GACrB,MAAM,MAAM,EACZ,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,MAEF,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"}