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

package/src/common/constants.ts

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

package/src/common/{error.js → error.ts}

@@ -1,14 +1,12 @@
-// @ts-check
-
 import { OWNER_AFFILIATIONS } from "./constants.js";
 
 /**
- * @type {string} A general message to ask user to try again later.
+ * A general message to ask user to try again later.
  */
 const TRY_AGAIN_LATER = "Please try again later";
 
 /**
- * @type {Object<string, string>} A map of error types to secondary error messages.
+ * A map of error types to secondary error messages.
  */
 const SECONDARY_ERROR_MESSAGES = {
   MAX_RETRY:
@@ -28,16 +26,21 @@ const SECONDARY_ERROR_MESSAGES = {
  * Custom error class to handle custom GRS errors.
  */
 class CustomError extends Error {
+  type: string;
+  secondaryMessage: string;
+
   /**
    * Custom error constructor.
    *
-   * @param {string} message Error message.
-   * @param {string} type Error type.
+   * @param message Error message.
+   * @param type Error type.
    */
-  constructor(message, type) {
+  constructor(message: string, type: string) {
     super(message);
     this.type = type;
-    this.secondaryMessage = SECONDARY_ERROR_MESSAGES[type] || type;
+    type PartialRecord = Partial<Record<string, string>>;
+    this.secondaryMessage =
+      (SECONDARY_ERROR_MESSAGES as PartialRecord)[type] ?? type;
   }
 
   static MAX_RETRY = "MAX_RETRY";
@@ -53,13 +56,16 @@ class CustomError extends Error {
  * Missing query parameter class.
  */
 class MissingParamError extends Error {
+  missedParams: Array<string>;
+  secondaryMessage: string | undefined;
+
   /**
    * Missing query parameter error constructor.
    *
-   * @param {string[]} missedParams An array of missing parameters names.
-   * @param {string=} secondaryMessage Optional secondary message to display.
+   * @param missedParams An array of missing parameters names.
+   * @param secondaryMessage Optional secondary message to display.
    */
-  constructor(missedParams, secondaryMessage) {
+  constructor(missedParams: Array<string>, secondaryMessage?: string) {
     const msg = `Missing params ${missedParams
       .map((p) => `"${p}"`)
       .join(", ")} make sure you pass the parameters in URL`;
@@ -72,10 +78,10 @@ class MissingParamError extends Error {
 /**
  * Retrieve secondary message from an error object.
  *
- * @param {Error} err The error object.
- * @returns {string|undefined} The secondary message if available, otherwise undefined.
+ * @param err The error object.
+ * @returns The secondary message if available, otherwise undefined.
  */
-const retrieveSecondaryMessage = (err) => {
+const retrieveSecondaryMessage = (err: Error): string | undefined => {
   return "secondaryMessage" in err && typeof err.secondaryMessage === "string"
     ? err.secondaryMessage
     : undefined;

package/src/common/{fmt.js → fmt.ts}

@@ -1,16 +1,14 @@
-// @ts-check
-
 import { encodeHTML } from "./html.js";
 import { splitWrappedText } from "./render.js";
 
 /**
  * Retrieves num with suffix k(thousands) precise to given decimal places.
  *
- * @param {number} num The number to format.
- * @param {number=} precision The number of decimal places to include.
- * @returns {string|number} The formatted number.
+ * @param num The number to format.
+ * @param precision The number of decimal places to include.
+ * @returns The formatted number.
  */
-const kFormatter = (num, precision) => {
+const kFormatter = (num: number, precision?: number): string | number => {
   const abs = Math.abs(num);
   const sign = Math.sign(num);
 
@@ -22,17 +20,17 @@ const kFormatter = (num, precision) => {
     return sign * abs;
   }
 
-  return sign * parseFloat((abs / 1000).toFixed(1)) + "k";
+  return `${sign * parseFloat((abs / 1000).toFixed(1))}k`;
 };
 
 /**
  * Convert bytes to a human-readable string representation.
  *
- * @param {number} bytes The number of bytes to convert.
- * @returns {string} The human-readable representation of bytes.
+ * @param bytes The number of bytes to convert.
+ * @returns The human-readable representation of bytes.
  * @throws {Error} If bytes is negative or too large.
  */
-const formatBytes = (bytes) => {
+const formatBytes = (bytes: number): string => {
   if (bytes < 0) {
     throw new Error("Bytes must be a non-negative number");
   }
@@ -45,23 +43,29 @@ const formatBytes = (bytes) => {
   const base = 1024;
   const i = Math.floor(Math.log(bytes) / Math.log(base));
 
-  if (i >= sizes.length) {
+  const unit = sizes[i];
+  if (unit === undefined) {
     throw new Error("Bytes is too large to convert to a human-readable string");
   }
 
-  return `${(bytes / Math.pow(base, i)).toFixed(1)} ${sizes[i]}`;
+  return `${(bytes / Math.pow(base, i)).toFixed(1)} ${unit}`;
 };
 
 /**
  * Split text over multiple lines based on the card width.
  *
- * @param {string} text Text to split.
- * @param {number} width Available wrap width in px.
- * @param {number} fontSize Font size in px.
- * @param {number} maxLines Maximum number of lines.
- * @returns {string[]} Array of lines.
+ * @param text Text to split.
+ * @param width Available wrap width in px.
+ * @param fontSize Font size in px.
+ * @param maxLines Maximum number of lines.
+ * @returns Array of lines.
  */
-const wrapTextMultiline = (text, width, fontSize, maxLines = 3) => {
+const wrapTextMultiline = (
+  text: string,
+  width: number,
+  fontSize: number,
+  maxLines = 3,
+): Array<string> => {
   const wrapped = splitWrappedText(text, fontSize, width);
   const lines = wrapped
     .map((line) => encodeHTML(line.trim()))
@@ -69,7 +73,11 @@ const wrapTextMultiline = (text, width, fontSize, maxLines = 3) => {
 
   // Add "..." to the last line if the text exceeds maxLines
   if (wrapped.length > maxLines) {
-    lines[maxLines - 1] += "...";
+    const lastIndex = maxLines - 1;
+    const lastLine = lines[lastIndex];
+    if (lastLine !== undefined) {
+      lines[lastIndex] = `${lastLine}...`;
+    }
   }
 
   // Remove empty lines if text fits in less than maxLines lines

package/src/common/{html.js → html.ts}

@@ -1,18 +1,13 @@
-// @ts-check
-
 /**
  * Encode string as HTML.
  *
  * @see https://stackoverflow.com/a/48073476/10629172
- *
- * @param {string} str String to encode.
- * @returns {string} Encoded string.
  */
-const encodeHTML = (str) => {
+const encodeHTML = (str: string): string => {
   return (
     str
-      .replace(/[\u00A0-\u9999<>&](?!#)/gim, (i) => {
-        return "&#" + i.charCodeAt(0) + ";";
+      .replace(/[\u00A0-\u9999<>&](?!#)/gim, (i: string) => {
+        return `&#${i.charCodeAt(0)};`;
       })
       // eslint-disable-next-line no-control-regex
       .replace(/\u0008/gim, "")

package/src/common/http.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import axios from "axios";
 
 /**

package/src/common/{icons.js → icons.ts}

@@ -1,5 +1,3 @@
-// @ts-check
-
 /*
 The icons in this file are based on https://github.com/primer/octicons which is released under the MIT license:
 
@@ -46,12 +44,16 @@ const icons = {
 /**
  * Get rank icon
  *
- * @param {string} rankIcon - The rank icon type.
- * @param {string} rankLevel - The rank level.
- * @param {number} percentile - The rank percentile.
- * @returns {string} - The SVG code of the rank icon
+ * @param rankIcon - The rank icon type.
+ * @param rankLevel - The rank level.
+ * @param percentile - The rank percentile.
+ * @returns The SVG code of the rank icon
  */
-const rankIcon = (rankIcon, rankLevel, percentile) => {
+const rankIcon = (
+  rankIcon: string,
+  rankLevel: string,
+  percentile: number,
+): string => {
   switch (rankIcon) {
     case "github":
       return `

package/src/common/ops.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import toEmoji from "emoji-name-map";
 
 import { OWNER_AFFILIATIONS } from "./constants.js";

package/src/common/render.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { getCardColors } from "./color.js";
 import { SECONDARY_ERROR_MESSAGES, TRY_AGAIN_LATER } from "./error.js";
 import { encodeHTML } from "./html.js";

package/src/common/{retryer.js → retryer.ts}

@@ -1,43 +1,56 @@
-// @ts-check
+import type { AxiosResponse } from "axios";
 
 import { getConfig } from "./config.js";
 import { CustomError } from "./error.js";
 import { logger } from "./log.js";
 
+/**
+ * Subset of the response payload the retryer inspects to detect
+ * rate-limiting and credential failures.
+ */
+interface ResponseData {
+  errors?: Array<{ type?: string; message?: string }>;
+  message?: string;
+}
+
 /**
  * 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.
+ * @param max The upper bound (exclusive). Must be a positive number.
  *
- * @returns {number} A random integer `n` such that `0 <= n < max`.
+ * @returns A random integer `n` such that `0 <= n < max`.
  */
-function getRandomInt(max) {
+function getRandomInt(max: number): number {
   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.
- */
+type FetcherResponse = AxiosResponse<ResponseData>;
+
+type FetcherFunction = (
+  variables: Record<string, unknown>,
+  token: string,
+  retriesForTests?: number,
+) => Promise<FetcherResponse>;
 
 /**
  * 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.
+ * @param fetcher The fetcher function.
+ * @param variables Object with arguments to pass to the fetcher function.
+ * @param pat Optional PAT override.
+ * @returns 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;
-  }
+const retryer = async (
+  fetcher: FetcherFunction,
+  variables: Record<string, unknown>,
+  pat: string | null = null,
+): Promise<FetcherResponse> => {
+  const PATs = pat
+    ? [{ name: "user PAT from database", value: pat }]
+    : getConfig().pats;
 
   if (!PATs.length) {
     throw new CustomError("No GitHub API tokens found", CustomError.NO_TOKENS);
@@ -46,11 +59,13 @@ const retryer = async (fetcher, variables, pat = null) => {
 
   for (let retries = 0; retries < PATs.length; retries++) {
     const currentPAT = PATs[(startPAT + retries) % PATs.length];
+    if (!currentPAT) {
+      continue;
+    }
 
     try {
-      let response = await fetcher(
+      const response = await fetcher(
         variables,
-        // @ts-ignore
         currentPAT.value,
         // used in tests for faking rate limit
         retries,
@@ -58,11 +73,11 @@ const retryer = async (fetcher, variables, pat = null) => {
 
       // 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 errors = response.data.errors;
       const errorType = errors?.[0]?.type;
-      const errorMsg = errors?.[0]?.message || "";
+      const errorMsg = errors?.[0]?.message ?? "";
       const isRateLimited =
-        (errors && errorType === "RATE_LIMITED") ||
+        (!!errors && errorType === "RATE_LIMITED") ||
         /rate limit/i.test(errorMsg);
 
       if (isRateLimited) {
@@ -71,20 +86,18 @@ const retryer = async (fetcher, variables, pat = null) => {
         return response;
       }
     } catch (err) {
-      /** @type {any} */
-      const e = err;
+      const e = err as { response?: FetcherResponse };
 
       // network/unexpected error → let caller treat as failure
-      if (!e?.response) {
-        throw e;
+      if (!e.response) {
+        throw err;
       }
 
-      // prettier-ignore
       // also checking for bad credentials if any tokens gets invalidated
-      const isBadCredential =
-        e?.response?.data?.message === "Bad credentials";
+      const message = e.response.data.message;
+      const isBadCredential = message === "Bad credentials";
       const isAccountSuspended =
-        e?.response?.data?.message === "Sorry. Your account was suspended.";
+        message === "Sorry. Your account was suspended.";
 
       if (isBadCredential || isAccountSuspended) {
         logger.log(`${currentPAT.name} Failed due to bad credentials`);

package/src/fetchers/gist.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { MissingParamError } from "../common/error.js";
 import { request } from "../common/http.js";
 import { retryer } from "../common/retryer.js";

package/src/fetchers/repo.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { MissingParamError } from "../common/error.js";
 import { request } from "../common/http.js";
 import { retryer } from "../common/retryer.js";
@@ -23,9 +21,7 @@ const fetcher = (variables, token) => {
         isPrivate
         isArchived
         isTemplate
-        stargazers {
-          totalCount
-        }
+        stargazerCount
         description
         primaryLanguage {
           color
@@ -130,7 +126,7 @@ const fetchRepo = async (
     return {
       ...repoUserStats,
       ...data.user.repository,
-      starCount: data.user.repository.stargazers.totalCount,
+      starCount: data.user.repository.stargazerCount,
     };
   }
 
@@ -155,7 +151,7 @@ const fetchRepo = async (
     return {
       ...repoUserStats,
       ...data.organization.repository,
-      starCount: data.organization.repository.stargazers.totalCount,
+      starCount: data.organization.repository.stargazerCount,
     };
   }
 

package/src/fetchers/stats.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import axios from "axios";
 import githubUsernameRegex from "github-username-regex";
 
@@ -18,9 +16,7 @@ const GRAPHQL_REPOS_FIELD = `
     totalCount
     nodes {
       name
-      stargazers {
-        totalCount
-      }
+      stargazerCount
     }
     pageInfo {
       hasNextPage
@@ -159,7 +155,7 @@ const statsFetcher = async ({
     // Disable multi page fetching on public Vercel instance due to rate limits.
     fetchedPages++;
     const repoNodesWithStars = repoNodes.filter(
-      (node) => node.stargazers.totalCount !== 0,
+      (node) => node.stargazerCount !== 0,
     );
 
     hasNextPage =
@@ -458,7 +454,7 @@ const fetchStats = async (
       return !repoToHide.has(data.name);
     })
     .reduce((prev, curr) => {
-      return prev + curr.stargazers.totalCount;
+      return prev + curr.stargazerCount;
     }, 0);
 
   stats.rank = calculateRank({

package/src/fetchers/top-languages.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { getConfig } from "../common/config.js";
 import { CustomError, MissingParamError } from "../common/error.js";
 import { wrapTextMultiline } from "../common/fmt.js";

package/src/fetchers/types.d.ts

@@ -13,7 +13,7 @@ export interface RepositoryData {
   isPrivate: boolean;
   isArchived: boolean;
   isTemplate: boolean;
-  stargazers: { totalCount: number };
+  stargazerCount: number;
   description: string;
   primaryLanguage: {
     color: string;

package/src/fetchers/wakatime.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import axios from "axios";
 
 import { CustomError, MissingParamError } from "../common/error.js";

package/src/{translations.js → translations.ts}

@@ -1,18 +1,22 @@
-// @ts-check
-
 import { encodeHTML } from "./common/html.js";
 
 /**
  * Retrieves stat card labels in the available locales.
  *
- * @param {object} props Function arguments.
- * @param {string} props.name The name of the locale.
- * @param {string} props.apostrophe Whether to use apostrophe or not.
- * @returns {object} The locales object.
+ * @param props Function arguments.
+ * @param props.name The name of the locale.
+ * @param props.apostrophe Whether to use apostrophe or not.
+ * @returns The locales object.
  *
  * @see https://www.andiamo.co.uk/resources/iso-language-codes/ for language codes.
  */
-const statCardLocales = ({ name, apostrophe }) => {
+const statCardLocales = ({
+  name,
+  apostrophe,
+}: {
+  name: string;
+  apostrophe: string;
+}) => {
   const encodedName = encodeHTML(name);
   return {
     "statcard.title": {
@@ -1140,10 +1144,10 @@ const availableLocales = Object.keys(repoCardLocales["repocard.archived"]);
 /**
  * Checks whether the locale is available or not.
  *
- * @param {string} locale The locale to check.
- * @returns {boolean} Boolean specifying whether the locale is available or not.
+ * @param locale The locale to check.
+ * @returns Boolean specifying whether the locale is available or not.
  */
-const isLocaleAvailable = (locale) => {
+const isLocaleAvailable = (locale: string): boolean => {
   return availableLocales.includes(locale.toLowerCase());
 };
 

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/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 };