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

package/src/fetchers/top-languages.ts

@@ -0,0 +1,135 @@
+import { getConfig } from "../common/config.js";
+import { CustomError, MissingParamError } from "../common/error.js";
+import { wrapTextMultiline } from "../common/fmt.js";
+import { createGraphQLFetcher } from "../common/http.js";
+import { logger } from "../common/log.js";
+import { parseOwnerAffiliations } from "../common/ops.js";
+import { retryer } from "../common/retryer.js";
+import { TopLanguagesDocument } from "../graphql/generated/top-languages.js";
+import type {
+  TopLanguageFragment,
+  TopLanguagesRepositoryFragment,
+} from "../graphql/generated/top-languages.js";
+
+import type { Lang, TopLangData } from "./types.js";
+
+const fetcher = createGraphQLFetcher(TopLanguagesDocument, "token");
+
+/**
+ * Fetch top languages for a given username.
+ *
+ * @param username GitHub username.
+ * @param exclude_repo List of repositories to exclude. Default: [].
+ * @param size_weight Weightage to be given to size.
+ * @param count_weight Weightage to be given to count.
+ * @param ownerAffiliations The owner affiliations to filter by. Default: OWNER.
+ * @param pat Optional PAT override.
+ * @returns Top languages data.
+ */
+const fetchTopLanguages = async (
+  username: string,
+  exclude_repo: Array<string> = [],
+  size_weight = 1,
+  count_weight = 0,
+  ownerAffiliations: Array<string> = [],
+  pat: string | null = null,
+): Promise<TopLangData> => {
+  if (!username) {
+    throw new MissingParamError(["username"]);
+  }
+  const affiliations = parseOwnerAffiliations(ownerAffiliations);
+
+  const res = await retryer(
+    fetcher,
+    {
+      login: username,
+      ownerAffiliations: affiliations,
+    },
+    pat,
+  );
+
+  if (res.data.errors) {
+    logger.error(res.data.errors);
+    const firstError = res.data.errors[0];
+    if (firstError?.type === "NOT_FOUND") {
+      throw new CustomError(
+        firstError.message || "Could not fetch user.",
+        CustomError.USER_NOT_FOUND,
+      );
+    }
+    if (firstError?.message) {
+      throw new CustomError(
+        wrapTextMultiline(firstError.message, 525, 12)[0] ?? "",
+        res.statusText,
+      );
+    }
+    throw new CustomError(
+      "Something went wrong while trying to retrieve the language data using the GraphQL API.",
+      CustomError.GRAPHQL_ERROR,
+    );
+  }
+
+  const repoToHide: Record<string, boolean> = {};
+  const allExcludedRepos = [
+    ...exclude_repo,
+    ...getConfig().excludeRepositories,
+  ];
+
+  // populate repoToHide map for quick lookup while filtering out
+  allExcludedRepos.forEach((repoName) => {
+    repoToHide[repoName] = true;
+  });
+
+  // filter out repositories to be hidden
+  const repoNodes = (res.data.data.user?.repositories.nodes ?? []).filter(
+    (node): node is TopLanguagesRepositoryFragment =>
+      !!node && !repoToHide[node.name],
+  );
+
+  // flatten edges across repos. Order matters: `concat(acc)` prepends, and the
+  // shared repoCount below depends on visitation order.
+  const languageEdges = repoNodes.reduce<Array<TopLanguageFragment>>(
+    (acc, repo) => {
+      const edges = (repo.languages?.edges ?? []).filter(
+        (edge): edge is TopLanguageFragment => !!edge,
+      );
+      return edges.length > 0 ? edges.concat(acc) : acc;
+    },
+    [],
+  );
+
+  // accumulate size and repo count per language
+  const languageMap: Record<string, Lang> = {};
+  let repoCount: number;
+  for (const edge of languageEdges) {
+    const existing = languageMap[edge.node.name];
+
+    // same language seen again: add to its size and bump count; else reset to 1
+    let langSize = edge.size;
+    if (existing && edge.node.name === existing.name) {
+      langSize = edge.size + existing.size;
+      repoCount = existing.count + 1;
+    } else {
+      repoCount = 1;
+    }
+    languageMap[edge.node.name] = {
+      name: edge.node.name,
+      color: edge.node.color,
+      size: langSize,
+      count: repoCount,
+    };
+  }
+
+  // comparison index calculation
+  for (const lang of Object.values(languageMap)) {
+    lang.size =
+      Math.pow(lang.size, size_weight) * Math.pow(lang.count, count_weight);
+  }
+
+  // return languages sorted by (weighted) size, descending
+  return Object.fromEntries(
+    Object.entries(languageMap).sort(([, a], [, b]) => b.size - a.size),
+  );
+};
+
+export { fetchTopLanguages };

package/src/fetchers/types.ts

@@ -1,3 +1,5 @@
+import type { RepoInfoFragment } from "../graphql/generated/repo.js";
+
 export interface GistData {
   name: string;
   nameWithOwner: string;
@@ -7,28 +9,29 @@ export interface GistData {
   forksCount: number;
 }
 
-export interface RepositoryData {
-  name: string;
-  nameWithOwner: string;
-  isPrivate: boolean;
-  isArchived: boolean;
-  isTemplate: boolean;
-  stargazerCount: number;
-  description: string;
+/**
+ * What the repo query returns, with `primaryLanguage` loosened:
+ * the schema says `name` is non-null, but the card falls back to defaults for callers passing untyped data.
+ */
+type RepoInfo = Omit<RepoInfoFragment, "primaryLanguage"> & {
   primaryLanguage: {
-    color: string;
-    id: string;
-    name: string;
-  };
-  forkCount: number;
-  starCount: number;
-  totalPRsAuthored: number;
-  totalPRsCommented: number;
-  totalPRsReviewed: number;
-  totalIssuesAuthored: number;
-  totalIssuesCommented: number;
+    color: string | null;
+    id?: string;
+    name: string | null;
+  } | null;
+};
+
+export interface RepoUserStats {
+  // only present when the matching include_* flag is set (see fetchRepoUserStats)
+  totalPRsAuthored?: number;
+  totalPRsCommented?: number;
+  totalPRsReviewed?: number;
+  totalIssuesAuthored?: number;
+  totalIssuesCommented?: number;
 }
 
+export type RepositoryData = RepoInfo & RepoUserStats;
+
 export interface StatsData {
   name: string;
   totalPRs: number;
@@ -41,18 +44,23 @@ export interface StatsData {
   totalDiscussionsStarted: number;
   totalDiscussionsAnswered: number;
   contributedTo: number;
+  allTimeContributedTo: number;
   totalPRsAuthored: number;
   totalPRsCommented: number;
   totalPRsReviewed: number;
   totalIssuesAuthored: number;
   totalIssuesCommented: number;
+  totalContributions: number;
   rank: { level: string; percentile: number };
 }
 
 export interface Lang {
   name: string;
-  color: string;
+  // GitHub's GraphQL `Language.color` is nullable — the card falls back to a default.
+  color: string | null;
   size: number;
+  /** Number of repositories the language appears in. */
+  count: number;
 }
 
 export type TopLangData = Record<string, Lang>;

package/src/fetchers/{wakatime.js → wakatime.ts}

@@ -2,19 +2,29 @@ import axios from "axios";
 
 import { CustomError, MissingParamError } from "../common/error.js";
 
+import type { WakaTimeData } from "./types.js";
+
 /**
  * WakaTime data fetcher.
  *
- * @param {{username: string, api_domain: string }} props Fetcher props.
- * @returns {Promise<import("./types").WakaTimeData>} WakaTime data response.
+ * @param props Fetcher props.
+ * @param props.username WakaTime username.
+ * @param props.api_domain Optional WakaTime API domain (defaults to `wakatime.com`).
+ * @returns WakaTime data response.
  */
-const fetchWakatimeStats = async ({ username, api_domain }) => {
+const fetchWakatimeStats = async ({
+  username,
+  api_domain,
+}: {
+  username: string;
+  api_domain?: string;
+}): Promise<WakaTimeData> => {
   if (!username) {
     throw new MissingParamError(["username"]);
   }
 
   try {
-    const { data } = await axios.get(
+    const { data } = await axios.get<{ data: WakaTimeData }>(
       `https://${
         api_domain ? api_domain.replace(/\/$/gi, "") : "wakatime.com"
       }/api/v1/users/${username}/stats?is_including_today=true`,
@@ -22,7 +32,11 @@ const fetchWakatimeStats = async ({ username, api_domain }) => {
 
     return data.data;
   } catch (err) {
-    if (err.response.status < 200 || err.response.status > 299) {
+    if (
+      axios.isAxiosError(err) &&
+      err.response &&
+      (err.response.status < 200 || err.response.status > 299)
+    ) {
       throw new CustomError(
         `Could not resolve to a User with the login of '${username}'`,
         "WAKATIME_USER_NOT_FOUND",

package/src/graphql/contributionsDocument.ts

@@ -0,0 +1,44 @@
+import { getGitHubYearRange, toGitHubDateTime } from "../common/date.js";
+
+import type { YearContributionsFragment } from "./generated/stats.js";
+import { graphqlDocument } from "./graphqlDocument.js";
+
+interface ContributionsQueryVariables {
+  login: string;
+}
+
+interface ContributionsQuery {
+  user: Record<`year_${number}`, YearContributionsFragment> | null;
+}
+
+/**
+ * Build the all-time contributions query, one aliased `contributionsCollection` field per year.
+ * The shape is only known at runtime.
+ *
+ * @param years Contribution years, one `year_<year>` alias each.
+ * @returns Document for `createGraphQLFetcher`.
+ */
+const buildContributionsDocument = (years: Array<number>) => {
+  const yearFields = years
+    .map((year) => {
+      const { from, to } = getGitHubYearRange(year);
+      return `year_${year}: contributionsCollection(from: "${toGitHubDateTime(from)}", to: "${toGitHubDateTime(to)}") { ...YearContributions }`;
+    })
+    .join("\n");
+
+  // fragment must match queries/stats.graphql, which generates its type
+  return graphqlDocument<ContributionsQuery, ContributionsQueryVariables>(`
+query userContributions($login: String!) {
+  user(login: $login) {
+    ${yearFields}
+  }
+}
+fragment YearContributions on ContributionsCollection {
+  contributionCalendar {
+    totalContributions
+  }
+}`);
+};
+
+export { buildContributionsDocument };
+export type { ContributionsQuery };

package/src/graphql/generated/common.ts

@@ -0,0 +1,26 @@
+// Generated file — see .github/CONTRIBUTING.md
+
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+  ID: { input: string; output: string };
+  String: { input: string; output: string };
+  Boolean: { input: boolean; output: boolean };
+  Int: { input: number; output: number };
+  Float: { input: number; output: number };
+  /** An ISO-8601 encoded UTC date string. */
+  DateTime: { input: string; output: string };
+};
+
+/** The affiliation of a user to a repository */
+export type RepositoryAffiliation =
+  /** Repositories that the user has been added to as a collaborator. */
+  | "COLLABORATOR"
+  /**
+   * Repositories that the user has access to through being a member of an
+   * organization. This includes every repository on every team that the user is on.
+   */
+  | "ORGANIZATION_MEMBER"
+  /** Repositories that are owned by the authenticated user. */
+  | "OWNER";

package/src/graphql/generated/gist.ts

@@ -0,0 +1,59 @@
+// Generated file — see .github/CONTRIBUTING.md
+
+/** Internal type. DO NOT USE DIRECTLY. */
+type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+import { graphqlDocument } from "../graphqlDocument.js";
+export type GistFileInfoFragment = {
+  name: string | null;
+  size: number | null;
+  language: { name: string } | null;
+};
+
+export type GistInfoQueryVariables = Exact<{
+  gistName: string;
+}>;
+
+export type GistInfoQuery = {
+  viewer: {
+    gist: {
+      description: string | null;
+      stargazerCount: number;
+      owner: { login: string } | { login: string } | null;
+      forks: { totalCount: number };
+      files: Array<{
+        name: string | null;
+        size: number | null;
+        language: { name: string } | null;
+      } | null> | null;
+    } | null;
+  };
+};
+
+export const GistInfoDocument = graphqlDocument<
+  GistInfoQuery,
+  GistInfoQueryVariables
+>(`
+query gistInfo($gistName: String!) {
+  viewer {
+    gist(name: $gistName) {
+      description
+      owner {
+        login
+      }
+      stargazerCount
+      forks {
+        totalCount
+      }
+      files {
+        ...GistFileInfo
+      }
+    }
+  }
+}
+fragment GistFileInfo on GistFile {
+  name
+  language {
+    name
+  }
+  size
+}`);

package/src/graphql/generated/repo.ts

@@ -0,0 +1,90 @@
+// Generated file — see .github/CONTRIBUTING.md
+
+/** Internal type. DO NOT USE DIRECTLY. */
+type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+import { graphqlDocument } from "../graphqlDocument.js";
+export type RepoInfoFragment = {
+  name: string;
+  nameWithOwner: string;
+  isPrivate: boolean;
+  isArchived: boolean;
+  isTemplate: boolean;
+  stargazerCount: number;
+  description: string | null;
+  forkCount: number;
+  primaryLanguage: { color: string | null; id: string; name: string } | null;
+};
+
+export type GetRepoQueryVariables = Exact<{
+  login: string;
+  repo: string;
+}>;
+
+export type GetRepoQuery = {
+  user: {
+    repository: {
+      name: string;
+      nameWithOwner: string;
+      isPrivate: boolean;
+      isArchived: boolean;
+      isTemplate: boolean;
+      stargazerCount: number;
+      description: string | null;
+      forkCount: number;
+      primaryLanguage: {
+        color: string | null;
+        id: string;
+        name: string;
+      } | null;
+    } | null;
+  } | null;
+  organization: {
+    repository: {
+      name: string;
+      nameWithOwner: string;
+      isPrivate: boolean;
+      isArchived: boolean;
+      isTemplate: boolean;
+      stargazerCount: number;
+      description: string | null;
+      forkCount: number;
+      primaryLanguage: {
+        color: string | null;
+        id: string;
+        name: string;
+      } | null;
+    } | null;
+  } | null;
+};
+
+export const GetRepoDocument = graphqlDocument<
+  GetRepoQuery,
+  GetRepoQueryVariables
+>(`
+query getRepo($login: String!, $repo: String!) {
+  user(login: $login) {
+    repository(name: $repo) {
+      ...RepoInfo
+    }
+  }
+  organization(login: $login) {
+    repository(name: $repo) {
+      ...RepoInfo
+    }
+  }
+}
+fragment RepoInfo on Repository {
+  name
+  nameWithOwner
+  isPrivate
+  isArchived
+  isTemplate
+  stargazerCount
+  description
+  primaryLanguage {
+    color
+    id
+    name
+  }
+  forkCount
+}`);

package/src/graphql/generated/stats.ts

@@ -0,0 +1,194 @@
+// Generated file — see .github/CONTRIBUTING.md
+
+/** Internal type. DO NOT USE DIRECTLY. */
+type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+import type * as Types from "./common.js";
+
+import { graphqlDocument } from "../graphqlDocument.js";
+export type RepoNodeFragment = { name: string; stargazerCount: number };
+
+export type RepoStarsFragment = {
+  repositories: {
+    totalCount: number;
+    nodes: Array<{ name: string; stargazerCount: number } | null> | null;
+    pageInfo: { hasNextPage: boolean; endCursor: string | null };
+  };
+};
+
+export type UserReposQueryVariables = Exact<{
+  login: string;
+  after?: string | null | undefined;
+  ownerAffiliations?:
+    | Array<Types.RepositoryAffiliation | null | undefined>
+    | Types.RepositoryAffiliation
+    | null
+    | undefined;
+}>;
+
+export type UserReposQuery = {
+  user: {
+    repositories: {
+      totalCount: number;
+      nodes: Array<{ name: string; stargazerCount: number } | null> | null;
+      pageInfo: { hasNextPage: boolean; endCursor: string | null };
+    };
+  } | null;
+};
+
+export type UserInfoQueryVariables = Exact<{
+  login: string;
+  after?: string | null | undefined;
+  includeMergedPullRequests: boolean;
+  includeDiscussions: boolean;
+  includeDiscussionsAnswers: boolean;
+  startTime?: string | null | undefined;
+  ownerAffiliations?:
+    | Array<Types.RepositoryAffiliation | null | undefined>
+    | Types.RepositoryAffiliation
+    | null
+    | undefined;
+  includeUserRepositories: boolean;
+}>;
+
+export type UserInfoQuery = {
+  user: {
+    name: string | null;
+    login: string;
+    commits: { totalCommitContributions: number };
+    reviews: { totalPullRequestReviewContributions: number };
+    repositoriesContributedTo: { totalCount: number };
+    pullRequests: { totalCount: number };
+    mergedPullRequests?: { totalCount: number };
+    openIssues: { totalCount: number };
+    closedIssues: { totalCount: number };
+    followers: { totalCount: number };
+    repositoryDiscussions?: { totalCount: number };
+    repositoryDiscussionComments?: { totalCount: number };
+    contributionsCollection: { contributionYears: Array<number> };
+    repositories: {
+      totalCount: number;
+      nodes: Array<{ name: string; stargazerCount: number } | null> | null;
+      pageInfo: { hasNextPage: boolean; endCursor: string | null };
+    };
+  } | null;
+};
+
+export type YearContributionsFragment = {
+  contributionCalendar: { totalContributions: number };
+};
+
+export type RangeContributionsByRepoFragment = {
+  commitContributionsByRepository: Array<{
+    repository: { nameWithOwner: string };
+  }>;
+  issueContributionsByRepository: Array<{
+    repository: { nameWithOwner: string };
+  }>;
+  pullRequestContributionsByRepository: Array<{
+    repository: { nameWithOwner: string };
+  }>;
+  repositoryContributions?: {
+    nodes: Array<{ repository: { nameWithOwner: string } } | null> | null;
+  };
+};
+
+export const UserReposDocument = graphqlDocument<
+  UserReposQuery,
+  UserReposQueryVariables
+>(`
+query userRepos($login: String!, $after: String, $ownerAffiliations: [RepositoryAffiliation]) {
+  user(login: $login) {
+    ...RepoStars
+  }
+}
+fragment RepoStars on User {
+  repositories(
+    first: 100
+    after: $after
+    ownerAffiliations: $ownerAffiliations
+    orderBy: {direction: DESC, field: STARGAZERS}
+  ) {
+    totalCount
+    nodes {
+      ...RepoNode
+    }
+    pageInfo {
+      hasNextPage
+      endCursor
+    }
+  }
+}
+fragment RepoNode on Repository {
+  name
+  stargazerCount
+}`);
+
+export const UserInfoDocument = graphqlDocument<
+  UserInfoQuery,
+  UserInfoQueryVariables
+>(`
+query userInfo($login: String!, $after: String, $includeMergedPullRequests: Boolean!, $includeDiscussions: Boolean!, $includeDiscussionsAnswers: Boolean!, $startTime: DateTime = null, $ownerAffiliations: [RepositoryAffiliation], $includeUserRepositories: Boolean!) {
+  user(login: $login) {
+    name
+    login
+    commits: contributionsCollection(from: $startTime) {
+      totalCommitContributions
+    }
+    reviews: contributionsCollection {
+      totalPullRequestReviewContributions
+    }
+    repositoriesContributedTo(
+      first: 1
+      contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]
+      includeUserRepositories: $includeUserRepositories
+    ) {
+      totalCount
+    }
+    pullRequests(first: 1) {
+      totalCount
+    }
+    mergedPullRequests: pullRequests(states: MERGED) @include(if: $includeMergedPullRequests) {
+      totalCount
+    }
+    openIssues: issues(states: OPEN) {
+      totalCount
+    }
+    closedIssues: issues(states: CLOSED) {
+      totalCount
+    }
+    followers {
+      totalCount
+    }
+    repositoryDiscussions @include(if: $includeDiscussions) {
+      totalCount
+    }
+    repositoryDiscussionComments(onlyAnswers: true) @include(if: $includeDiscussionsAnswers) {
+      totalCount
+    }
+    contributionsCollection {
+      contributionYears
+    }
+    ...RepoStars
+  }
+}
+fragment RepoStars on User {
+  repositories(
+    first: 100
+    after: $after
+    ownerAffiliations: $ownerAffiliations
+    orderBy: {direction: DESC, field: STARGAZERS}
+  ) {
+    totalCount
+    nodes {
+      ...RepoNode
+    }
+    pageInfo {
+      hasNextPage
+      endCursor
+    }
+  }
+}
+fragment RepoNode on Repository {
+  name
+  stargazerCount
+}`);