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

package/src/common/I18n.js

@@ -1,42 +0,0 @@
-// @ts-check
-
-const FALLBACK_LOCALE = "en";
-
-/**
- * I18n translation class.
- */
-class I18n {
-  /**
-   * Constructor.
-   *
-   * @param {Object} options Options.
-   * @param {string=} options.locale Locale.
-   * @param {any} options.translations Translations.
-   */
-  constructor({ locale, translations }) {
-    this.locale = locale || FALLBACK_LOCALE;
-    this.translations = translations;
-  }
-
-  /**
-   * Get translation.
-   *
-   * @param {string} str String to translate.
-   * @returns {string} Translated string.
-   */
-  t(str) {
-    if (!this.translations[str]) {
-      throw new Error(`${str} Translation string not found`);
-    }
-
-    if (!this.translations[str][this.locale]) {
-      throw new Error(
-        `'${str}' translation not found for locale '${this.locale}'`,
-      );
-    }
-
-    return this.translations[str][this.locale];
-  }
-}
-
-export { I18n };

package/src/common/color.js

@@ -1,145 +0,0 @@
-// @ts-check
-
-import { themes } from "../themes/index.js";
-
-/**
- * Checks if a string is a valid hex color.
- *
- * @param {string} hexColor String to check.
- * @returns {boolean} True if the given string is a valid hex color.
- */
-const isValidHexColor = (hexColor) => {
-  return new RegExp(
-    /^([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3}|[A-Fa-f0-9]{4})$/,
-  ).test(hexColor);
-};
-
-/**
- * Check if the given string is a valid gradient.
- *
- * @param {string[]} colors Array of colors.
- * @returns {boolean} True if the given string is a valid gradient.
- */
-const isValidGradient = (colors) => {
-  return (
-    colors.length > 2 &&
-    colors.slice(1).every((color) => isValidHexColor(color))
-  );
-};
-
-/**
- * Retrieves a gradient if color has more than one valid hex codes else a single color.
- *
- * @param {string} color The color to parse.
- * @param {string | string[]} fallbackColor The fallback color.
- * @returns {string | string[]} The gradient or color.
- */
-const fallbackColor = (color, fallbackColor) => {
-  let gradient = null;
-
-  let colors = color ? color.split(",") : [];
-  if (colors.length > 1 && isValidGradient(colors)) {
-    gradient = colors;
-  }
-
-  return (
-    (gradient ? gradient : isValidHexColor(color) && `#${color}`) ||
-    fallbackColor
-  );
-};
-
-/**
- * Object containing card colors.
- * @typedef {{
- *  titleColor: string;
- *  iconColor: string;
- *  textColor: string;
- *  bgColor: string | string[];
- *  borderColor: string;
- *  ringColor: string;
- * }} CardColors
- */
-
-/**
- * Returns theme based colors with proper overrides and defaults.
- *
- * @param {Object} args Function arguments.
- * @param {string=} args.title_color Card title color.
- * @param {string=} args.text_color Card text color.
- * @param {string=} args.icon_color Card icon color.
- * @param {string=} args.bg_color Card background color.
- * @param {string=} args.border_color Card border color.
- * @param {string=} args.ring_color Card ring color.
- * @param {string=} args.theme Card theme.
- * @returns {CardColors} Card colors.
- */
-const getCardColors = ({
-  title_color,
-  text_color,
-  icon_color,
-  bg_color,
-  border_color,
-  ring_color,
-  theme,
-}) => {
-  const defaultTheme = themes["default"];
-  const isThemeProvided =
-    theme !== null && theme !== undefined && theme in themes;
-
-  // @ts-ignore
-  const selectedTheme = isThemeProvided ? themes[theme] : defaultTheme;
-
-  const defaultBorderColor =
-    "border_color" in selectedTheme
-      ? selectedTheme.border_color
-      : // @ts-ignore
-        defaultTheme.border_color;
-
-  // get the color provided by the user else the theme color
-  // finally if both colors are invalid fallback to default theme
-  const titleColor = fallbackColor(
-    title_color || selectedTheme.title_color,
-    "#" + defaultTheme.title_color,
-  );
-
-  // get the color provided by the user else the theme color
-  // finally if both colors are invalid we use the titleColor
-  const ringColor = fallbackColor(
-    // @ts-ignore
-    ring_color || selectedTheme.ring_color,
-    titleColor,
-  );
-  const iconColor = fallbackColor(
-    icon_color || selectedTheme.icon_color,
-    "#" + defaultTheme.icon_color,
-  );
-  const textColor = fallbackColor(
-    text_color || selectedTheme.text_color,
-    "#" + defaultTheme.text_color,
-  );
-  const bgColor = fallbackColor(
-    bg_color || selectedTheme.bg_color,
-    "#" + defaultTheme.bg_color,
-  );
-
-  const borderColor = fallbackColor(
-    border_color || defaultBorderColor,
-    "#" + defaultBorderColor,
-  );
-
-  if (
-    typeof titleColor !== "string" ||
-    typeof textColor !== "string" ||
-    typeof ringColor !== "string" ||
-    typeof iconColor !== "string" ||
-    typeof borderColor !== "string"
-  ) {
-    throw new Error(
-      "Unexpected behavior, all colors except background should be string.",
-    );
-  }
-
-  return { titleColor, iconColor, textColor, bgColor, borderColor, ringColor };
-};
-
-export { fallbackColor, getCardColors };

package/src/common/config.js

@@ -1,78 +0,0 @@
-// @ts-check
-
-/**
- * @param {string | undefined} value Comma-separated string.
- * @returns {string[] | undefined} Parsed string values.
- */
-const parseCsv = (value) => {
-  if (!value) {
-    return undefined;
-  }
-  return value.split(",");
-};
-
-/**
- * @param {Record<string, string | undefined>} env Environment variables to inspect.
- * @returns {{name: string, value: string}[]} Personal access tokens found in the environment.
- */
-const parsePATsFromEnv = (env) => {
-  return Object.keys(env)
-    .filter((key) => /PAT_\d*$/.exec(key))
-    .map((name) => ({
-      name,
-      value: env[name],
-    }));
-};
-
-/**
- * @returns {Record<string, string | undefined>} `process.env` if available, otherwise `{}`.
- */
-const getDefaultEnv = () => {
-  if (typeof process !== "undefined" && process?.env) {
-    return process.env;
-  }
-  return {};
-};
-
-/**
- * @param {Partial<ReturnType<typeof loadConfigFromEnv>>} config (Partial) config values to normalize.
- * @returns {{
- *   whitelist: string[] | undefined,
- *   gistWhitelist: string[] | undefined,
- *   excludeRepositories: string[],
- *   fetchMultiPageStars: string | undefined,
- *   pats: {name: string, value: string}[],
- * }} Normalized config object with defaults applied.
- */
-const normalizeConfig = (config = {}) => {
-  return {
-    whitelist: config.whitelist,
-    gistWhitelist: config.gistWhitelist,
-    excludeRepositories: config.excludeRepositories || [],
-    fetchMultiPageStars: config.fetchMultiPageStars,
-    pats: config.pats || [],
-  };
-};
-
-let currentConfig;
-
-/**
- * @param {Record<string, string | undefined>} env Environment variables used to build the runtime config.
- */
-export const loadConfigFromEnv = (env = getDefaultEnv()) => {
-  const whitelist = parseCsv(env.WHITELIST);
-  const gistWhitelist = parseCsv(env.GIST_WHITELIST);
-  const excludeRepositories = parseCsv(env.EXCLUDE_REPO) || [];
-
-  currentConfig = normalizeConfig({
-    whitelist,
-    gistWhitelist,
-    excludeRepositories,
-    fetchMultiPageStars: env.FETCH_MULTI_PAGE_STARS,
-    pats: parsePATsFromEnv(env),
-  });
-};
-
-loadConfigFromEnv();
-
-export const getConfig = () => currentConfig;

package/src/common/constants.js

@@ -1,9 +0,0 @@
-// @ts-check
-
-/**
- * Valid owner affiliations for GitHub API queries.
- * @type {Array<string>}
- */
-const OWNER_AFFILIATIONS = ["OWNER", "COLLABORATOR", "ORGANIZATION_MEMBER"];
-
-export { OWNER_AFFILIATIONS };

package/src/common/http.js

@@ -1,21 +0,0 @@
-// @ts-check
-
-import axios from "axios";
-
-/**
- * Send GraphQL request to GitHub API.
- *
- * @param {import('axios').AxiosRequestConfig['data']} data Request data.
- * @param {import('axios').AxiosRequestConfig['headers']} headers Request headers.
- * @returns {Promise<any>} Request response.
- */
-const request = (data, headers) => {
-  return axios({
-    url: "https://api.github.com/graphql",
-    method: "post",
-    headers,
-    data,
-  });
-};
-
-export { request };

package/src/common/retryer.js

@@ -1,104 +0,0 @@
-// @ts-check
-
-import { getConfig } from "./config.js";
-import { CustomError } from "./error.js";
-import { logger } from "./log.js";
-
-/**
- * Returns a random integer from 0 (inclusive) to `max` (exclusive).
- *
- * The value is generated using `Math.random()` and uniformly distributed
- * across the range.
- *
- * @param {number} max The upper bound (exclusive). Must be a positive number.
- *
- * @returns {number} A random integer `n` such that `0 <= n < max`.
- */
-function getRandomInt(max) {
-  return Math.floor(Math.random() * max);
-}
-
-/**
- * @typedef {import("axios").AxiosResponse} AxiosResponse Axios response.
- * @typedef {(variables: any, token: string, retriesForTests?: number) => Promise<AxiosResponse>} FetcherFunction Fetcher function.
- */
-
-/**
- * Try to execute the fetcher function until it succeeds or the max number of retries is reached.
- *
- * @param {FetcherFunction} fetcher The fetcher function.
- * @param {any} variables Object with arguments to pass to the fetcher function.
- * @param {string | null} pat Optional PAT override.
- * @returns {Promise<any>} The response from the fetcher function.
- */
-const retryer = async (fetcher, variables, pat = null) => {
-  let PATs;
-  if (pat) {
-    PATs = [{ name: "user PAT from database", value: pat }];
-  } else {
-    PATs = getConfig().pats;
-  }
-
-  if (!PATs.length) {
-    throw new CustomError("No GitHub API tokens found", CustomError.NO_TOKENS);
-  }
-  const startPAT = getRandomInt(PATs.length);
-
-  for (let retries = 0; retries < PATs.length; retries++) {
-    const currentPAT = PATs[(startPAT + retries) % PATs.length];
-
-    try {
-      let response = await fetcher(
-        variables,
-        // @ts-ignore
-        currentPAT.value,
-        // used in tests for faking rate limit
-        retries,
-      );
-
-      // react on both type and message-based rate-limit signals.
-      // https://github.com/anuraghazra/github-readme-stats/issues/4425
-      const errors = response?.data?.errors;
-      const errorType = errors?.[0]?.type;
-      const errorMsg = errors?.[0]?.message || "";
-      const isRateLimited =
-        (errors && errorType === "RATE_LIMITED") ||
-        /rate limit/i.test(errorMsg);
-
-      if (isRateLimited) {
-        logger.log(`${currentPAT.name} Failed due to rate limiting`);
-      } else {
-        return response;
-      }
-    } catch (err) {
-      /** @type {any} */
-      const e = err;
-
-      // network/unexpected error → let caller treat as failure
-      if (!e?.response) {
-        throw e;
-      }
-
-      // prettier-ignore
-      // also checking for bad credentials if any tokens gets invalidated
-      const isBadCredential =
-        e?.response?.data?.message === "Bad credentials";
-      const isAccountSuspended =
-        e?.response?.data?.message === "Sorry. Your account was suspended.";
-
-      if (isBadCredential || isAccountSuspended) {
-        logger.log(`${currentPAT.name} Failed due to bad credentials`);
-      } else {
-        // HTTP error with a response → return it for caller-side handling
-        return e.response;
-      }
-    }
-  }
-
-  throw new CustomError(
-    "Downtime due to GitHub API rate limiting",
-    CustomError.MAX_RETRY,
-  );
-};
-
-export { retryer };

package/src/fetchers/gist.js

@@ -1,114 +0,0 @@
-// @ts-check
-
-import { MissingParamError } from "../common/error.js";
-import { request } from "../common/http.js";
-import { retryer } from "../common/retryer.js";
-
-const QUERY = `
-query gistInfo($gistName: String!) {
-    viewer {
-        gist(name: $gistName) {
-            description
-            owner {
-                login
-            }
-            stargazerCount
-            forks {
-                totalCount
-            }
-            files {
-                name
-                language {
-                    name
-                }
-                size
-            }
-        }
-    }
-}
-`;
-
-/**
- * Gist data fetcher.
- *
- * @param {object} variables Fetcher variables.
- * @param {string} token GitHub token.
- * @returns {Promise<import('axios').AxiosResponse>} The response.
- */
-const fetcher = async (variables, token) => {
-  return await request(
-    { query: QUERY, variables },
-    { Authorization: `token ${token}` },
-  );
-};
-
-/**
- * @typedef {{ name: string; language: { name: string; }, size: number }} GistFile Gist file.
- */
-
-/**
- * This function calculates the primary language of a gist by files size.
- *
- * @param {GistFile[]} files Files.
- * @returns {string} Primary language.
- */
-const calculatePrimaryLanguage = (files) => {
-  /** @type {Record<string, number>} */
-  const languages = {};
-
-  for (const file of files) {
-    if (file.language) {
-      if (languages[file.language.name]) {
-        languages[file.language.name] += file.size;
-      } else {
-        languages[file.language.name] = file.size;
-      }
-    }
-  }
-
-  let primaryLanguage = Object.keys(languages)[0];
-  for (const language in languages) {
-    if (languages[language] > languages[primaryLanguage]) {
-      primaryLanguage = language;
-    }
-  }
-
-  return primaryLanguage;
-};
-
-/**
- * @typedef {import('./types').GistData} GistData Gist data.
- */
-
-/**
- * Fetch GitHub gist information by given username and ID.
- *
- * @param {string} id GitHub gist ID.
- * @param {string | null} pat Optional PAT override.
- * @returns {Promise<GistData>} Gist data.
- */
-const fetchGist = async (id, pat = null) => {
-  if (!id) {
-    throw new MissingParamError(["id"], "/api/gist?id=GIST_ID");
-  }
-  const res = await retryer(fetcher, { gistName: id }, pat);
-  if (res.data.errors) {
-    throw new Error(res.data.errors[0].message);
-  }
-  if (!res.data.data.viewer.gist) {
-    throw new Error("Gist not found");
-  }
-  const data = res.data.data.viewer.gist;
-  return {
-    name: data.files[Object.keys(data.files)[0]].name,
-    nameWithOwner: `${data.owner.login}/${
-      data.files[Object.keys(data.files)[0]].name
-    }`,
-    description: data.description,
-    language: calculatePrimaryLanguage(data.files),
-    starsCount: data.stargazerCount,
-    forksCount: data.forks.totalCount,
-  };
-};
-
-export { fetchGist };