@stats-forge/github-stats-forge-core 0.0.2 → 0.2.0

package/build/fetchers/stats.d.ts

@@ -1,63 +1,39 @@
-import type { CardConfig } from '../common/config.js';
-import type { RepoUserStats, StatsData } from './types.js';
+import type { CardConfig } from '../common/config.ts';
+import type { RepoUserStats, StatsData } from './types.ts';
+/** The flags that ask for a per-repository count, as the query names them. */
+interface RepoUserStatsFlags {
+    include_prs_authored?: boolean | undefined;
+    include_prs_commented?: boolean | undefined;
+    include_prs_reviewed?: boolean | undefined;
+    include_issues_authored?: boolean | undefined;
+    include_issues_commented?: boolean | undefined;
+}
 /**
  * Fetch the per-repository counts the REST search API answers, one request each.
  *
- * @param props Fetcher props.
- * @param props.username GitHub username.
- * @param props.repo Repositories the search is scoped to.
- * @param props.owner Owners the search is scoped to.
- * @param props.include_prs_authored Include count of PRs authored.
- * @param props.include_prs_commented Include count of PRs commented.
- * @param props.include_prs_reviewed Include count of PRs reviewed.
- * @param props.include_issues_authored Include count of issues authored.
- * @param props.include_issues_commented Include count of issues commented.
- * @param config Deployment config supplying the PAT pool.
  * @returns Only the counts that were asked for.
  */
-declare const fetchRepoUserStats: ({ username, repo, owner, include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, }: {
+declare const fetchRepoUserStats: ({ username, repo, owner, ...flags }: RepoUserStatsFlags & {
     username: string;
     repo?: Array<string>;
     owner?: Array<string>;
-    include_prs_authored?: boolean | undefined;
-    include_prs_commented?: boolean | undefined;
-    include_prs_reviewed?: boolean | undefined;
-    include_issues_authored?: boolean | undefined;
-    include_issues_commented?: boolean | undefined;
 }, config: CardConfig) => Promise<RepoUserStats>;
 /**
  * Fetch stats for a given username.
  *
- * @param props Fetcher props.
- * @param props.username GitHub username.
- * @param props.include_all_commits Include all commits.
- * @param props.exclude_repo Repositories to exclude.
- * @param props.include_merged_pull_requests Include merged pull requests.
- * @param props.include_discussions Include discussions.
- * @param props.include_discussions_answers Include discussions answers.
- * @param props.commits_year Year to count total commits.
- * @param props.repo Repositories to scope the REST search to.
- * @param props.owner Owners to scope the REST search to.
- * @param props.include_prs_authored Include count of PRs authored.
- * @param props.include_prs_commented Include count of PRs commented.
- * @param props.include_prs_reviewed Include count of PRs reviewed.
- * @param props.include_issues_authored Include count of issues authored.
- * @param props.include_issues_commented Include count of issues commented.
- * @param props.ownerAffiliations Owner affiliations. Default: OWNER.
- * @param props.include_contributions Include all-time contributions.
- * @param props.include_all_time_contribs Include all-time count of repos contributed to.
- * @param props.contribs_include_own_repos Include user-owned repos in contributed-to counts.
- * @param config Deployment config supplying the PAT pool.
  * @returns Stats data.
  */
-declare const fetchStats: ({ username, include_all_commits, exclude_repo, include_merged_pull_requests, include_discussions, include_discussions_answers, commits_year, repo, owner, include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, ownerAffiliations, include_contributions, include_all_time_contribs, contribs_include_own_repos, }: {
+declare const fetchStats: ({ username, include_all_commits, exclude_repo, include_merged_pull_requests, include_discussions, include_discussions_answers, from, to, repo, owner, include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, ownerAffiliations, include_contributions, include_all_time_contribs, contribs_include_own_repos, }: {
     username: string | undefined;
     include_all_commits?: boolean | undefined;
     exclude_repo?: Array<string>;
     include_merged_pull_requests?: boolean;
     include_discussions?: boolean;
     include_discussions_answers?: boolean;
-    commits_year?: number | undefined;
+    /** Start of the range the commit count covers; GitHub's own last year when neither end is given. */
+    from?: Date | undefined;
+    /** End of that range. */
+    to?: Date | undefined;
     repo?: Array<string>;
     owner?: Array<string>;
     include_prs_authored?: boolean;

package/build/fetchers/stats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/fetchers/stats.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAuBtD,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AA+M3D;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,kBAAkB,GACtB,kJASG;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5C,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,uBAAuB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9C,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD,EACD,QAAQ,UAAU,KACjB,OAAO,CAAC,aAAa,CA+DvB,CAAC;AAsLF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,QAAA,MAAM,UAAU,GACd,oXAmBG;IACD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAClC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,0BAA0B,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAClD,EACD,QAAQ,UAAU,KACjB,OAAO,CAAC,SAAS,CA+JnB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/fetchers/stats.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AA4BtD,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAoL3D,8EAA8E;AAC9E,UAAU,kBAAkB;IAC1B,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5C,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,uBAAuB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9C,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD;AAyBD;;;;GAIG;AACH,QAAA,MAAM,kBAAkB,wCAMnB,kBAAkB,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB,UACO,UAAU,KACjB,OAAO,CAAC,aAAa,CAWvB,CAAC;AA6CF;;;;GAIG;AACH,QAAA,MAAM,UAAU,mXAqBX;IACD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,oGAAoG;IACpG,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,yBAAyB;IACzB,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACtB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAClC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,0BAA0B,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAClD,UACO,UAAU,KACjB,OAAO,CAAC,SAAS,CAsKnB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC"}

package/build/fetchers/stats.js

@@ -1,36 +1,27 @@
-import githubUsernameRegex from 'github-username-regex';
 import { calculateRank } from '../calculateRank.js';
-import { getGitHubYearRange, toGitHubDateTime } from '../common/date.js';
+import { GITHUB_USERNAME_PATTERN } from '../common/constants.js';
+import { getWidestRange, toContributionRanges, toGitHubDateTime, toRange, toYearRanges, } from '../common/date.js';
 import { CardError, USER_NOT_FOUND } from '../common/error.js';
-import { wrapTextMultiline } from '../common/fmt.js';
 import { createGraphQLFetcher, httpRequest } from '../common/http.js';
 import { logger } from '../common/log.js';
-import { buildSearchFilter, chunkArray, parseOwnerAffiliations } from '../common/ops.js';
+import { buildSearchFilter, parseOwnerAffiliations } from '../common/ops.js';
 import { retryer } from '../common/retryer.js';
 import { buildContributionsDocument } from '../graphql/contributionsDocument.js';
 import { UserInfoDocument, UserReposDocument } from '../graphql/generated/stats.js';
-import { MAX_REPOSITORIES_LIMIT, buildReposContributedToDocument, } from '../graphql/reposContributedToDocument.js';
+import { fetchReposContributedTo } from './contributed-to.js';
+import { graphqlError } from './graphql-error.js';
 const fetcher = createGraphQLFetcher(UserInfoDocument, 'bearer');
 /** Fetcher for the pages after the first, which only need `repositories`. */
 const reposFetcher = createGraphQLFetcher(UserReposDocument, 'bearer');
 /**
  * Fetch stats information for a given username.
  *
- * @param variables Fetcher variables.
- * @param variables.username GitHub username.
- * @param variables.includeMergedPullRequests Include merged pull requests.
- * @param variables.includeDiscussions Include discussions.
- * @param variables.includeDiscussionsAnswers Include discussions answers.
- * @param variables.startTime Time to start the count of total commits.
- * @param variables.ownerAffiliations The owner affiliations to filter by. Default: OWNER.
- * @param variables.includeUserRepositories Whether to include the user's own repositories in the repos contributed to.
- * @param config Deployment config supplying the PAT pool.
- * @returns The stats response, with every fetched page's repos merged in.
- *
  * @description Supports multi-page fetching when the `FETCH_MULTI_PAGE_STARS`
  * env variable is `true` or a fetch limit.
+ *
+ * @returns The stats response, with every fetched page's repos merged in.
  */
-const statsFetcher = async ({ username, includeMergedPullRequests, includeDiscussions, includeDiscussionsAnswers, startTime, ownerAffiliations, includeUserRepositories, }, config) => {
+const statsFetcher = async ({ username, includeMergedPullRequests, includeDiscussions, includeDiscussionsAnswers, commitsRange, ownerAffiliations, includeUserRepositories, }, config) => {
     // only the first request carries the stats themselves
     let stats = await retryer(fetcher, {
         login: username,
@@ -38,7 +29,9 @@ const statsFetcher = async ({ username, includeMergedPullRequests, includeDiscus
         includeMergedPullRequests,
         includeDiscussions,
         includeDiscussionsAnswers,
-        startTime,
+        // both ends together: an open `to` would run the range into the next 1st of January
+        startTime: commitsRange && toGitHubDateTime(commitsRange.from),
+        endTime: commitsRange && toGitHubDateTime(commitsRange.to),
         ownerAffiliations,
         includeUserRepositories,
     }, config);
@@ -69,10 +62,10 @@ const statsFetcher = async ({ username, includeMergedPullRequests, includeDiscus
         }
         pageRepositories = page.data.data.user?.repositories;
         extraRepoNodes.push(...(pageRepositories?.nodes ?? []));
-        fetchedPages++;
+        fetchedPages += 1;
     }
     if (extraRepoNodes.length > 0) {
-        // deep copy to avoid mutating the response cached by the frontend
+        // defensive: the merge below is the only place a parsed response is mutated
         stats = structuredClone({
             data: stats.data,
             statusText: stats.statusText,
@@ -84,48 +77,29 @@ const statsFetcher = async ({ username, includeMergedPullRequests, includeDiscus
 /**
  * Fetch total items count using the REST search API.
  *
- * @param variables Fetcher variables.
- * @param token GitHub token.
- * @param context What the retryer supplies each attempt.
- * @param context.fetch Transport to send the request with.
- * @returns The search response, carrying `total_count`.
- *
  * @see https://developer.github.com/v3/search/#search-commits
+ *
+ * @returns The search response, carrying `total_count`.
  */
-const fetchTotalItems = (variables, token, { fetch }) => {
-    const type = String(variables['type']);
-    const filter = String(variables['filter']);
-    const repo = variables['repo'];
-    const owner = variables['owner'];
-    return httpRequest(fetch, `https://api.github.com/search/${type}?per_page=1&q=` +
-        buildSearchFilter(repo, owner).replaceAll(' ', '+') +
-        filter, {
-        method: 'GET',
-        headers: {
-            'Content-Type': 'application/json',
-            Accept: 'application/vnd.github.cloak-preview',
-            Authorization: `token ${token}`,
-        },
-    });
-};
+const fetchTotalItems = ({ type, filter, repo, owner }, token, { fetch }) => httpRequest(fetch, `https://api.github.com/search/${type}?per_page=1&q=${buildSearchFilter(repo, owner).replaceAll(' ', '+')}${filter}`, {
+    method: 'GET',
+    headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/vnd.github.cloak-preview',
+        Authorization: `token ${token}`,
+    },
+});
 /**
  * Fetch a total count for a given username via the REST search API.
  *
- * @param props Fetcher props.
- * @param props.username GitHub username.
- * @param props.repo Repositories the search is scoped to.
- * @param props.owner Owners the search is scoped to.
- * @param props.type Search endpoint to hit, `issues` or `commits`.
- * @param props.filter Query fragment appended to the scope filter.
- * @param config Deployment config supplying the PAT pool.
- * @returns Total count.
- *
  * The GraphQL API can't return this.
  * @see https://github.com/anuraghazra/github-readme-stats/issues/92#issuecomment-661026467
  * @see https://github.com/anuraghazra/github-readme-stats/pull/211
+ *
+ * @returns Total count.
  */
-const totalItemsFetcher = async ({ username, repo, owner, type, filter, }, config) => {
-    if (!githubUsernameRegex.test(username)) {
+const totalItemsFetcher = async ({ username, ...search }, config) => {
+    if (!GITHUB_USERNAME_PATTERN.test(username)) {
         logger.log('Invalid username provided.');
         throw new CardError('Invalid username provided.', {
             code: 'invalid_param',
@@ -134,242 +108,90 @@ const totalItemsFetcher = async ({ username, repo, owner, type, filter, }, confi
     }
     let res;
     try {
-        res = await retryer(fetchTotalItems, { login: username, repo, owner, type, filter }, config);
+        res = await retryer(fetchTotalItems, search, config);
     }
-    catch (err) {
-        logger.log(err);
-        throw err;
+    catch (error) {
+        logger.log(error);
+        throw error;
     }
     const totalCount = res.data.total_count;
-    if (totalCount === undefined || isNaN(totalCount)) {
-        logger.error('GitHub error: ' + JSON.stringify(res.data));
+    if (typeof totalCount !== 'number' || Number.isNaN(totalCount)) {
+        logger.error(`GitHub error: ${JSON.stringify(res.data)}`);
         throw new CardError('Could not fetch data from GitHub REST API.', {
             code: 'upstream',
         });
     }
     return totalCount;
 };
+/** Each count the REST search API answers: the flag asking for it, and the qualifiers that find it. */
+const REPO_USER_SEARCHES = [
+    ['include_prs_authored', 'totalPRsAuthored', (username) => `author:${username}+type:pr`],
+    [
+        'include_prs_commented',
+        'totalPRsCommented',
+        (username) => `commenter:${username}+-author:${username}+type:pr`,
+    ],
+    [
+        'include_prs_reviewed',
+        'totalPRsReviewed',
+        (username) => `reviewed-by:${username}+-author:${username}+type:pr`,
+    ],
+    ['include_issues_authored', 'totalIssuesAuthored', (username) => `author:${username}+type:issue`],
+    [
+        'include_issues_commented',
+        'totalIssuesCommented',
+        (username) => `commenter:${username}+-author:${username}+type:issue`,
+    ],
+];
 /**
  * Fetch the per-repository counts the REST search API answers, one request each.
  *
- * @param props Fetcher props.
- * @param props.username GitHub username.
- * @param props.repo Repositories the search is scoped to.
- * @param props.owner Owners the search is scoped to.
- * @param props.include_prs_authored Include count of PRs authored.
- * @param props.include_prs_commented Include count of PRs commented.
- * @param props.include_prs_reviewed Include count of PRs reviewed.
- * @param props.include_issues_authored Include count of issues authored.
- * @param props.include_issues_commented Include count of issues commented.
- * @param config Deployment config supplying the PAT pool.
  * @returns Only the counts that were asked for.
  */
-const fetchRepoUserStats = async ({ username, repo = [], owner = [], include_prs_authored = false, include_prs_commented = false, include_prs_reviewed = false, include_issues_authored = false, include_issues_commented = false, }, config) => {
+const fetchRepoUserStats = async ({ username, repo = [], owner = [], ...flags }, config) => {
     const stats = {};
-    if (include_prs_authored) {
-        stats.totalPRsAuthored = await totalItemsFetcher({
-            username,
-            repo,
-            owner,
-            type: 'issues',
-            filter: `author:${username}+type:pr`,
-        }, config);
-    }
-    if (include_prs_commented) {
-        stats.totalPRsCommented = await totalItemsFetcher({
-            username,
-            repo,
-            owner,
-            type: 'issues',
-            filter: `commenter:${username}+-author:${username}+type:pr`,
-        }, config);
-    }
-    if (include_prs_reviewed) {
-        stats.totalPRsReviewed = await totalItemsFetcher({
-            username,
-            repo,
-            owner,
-            type: 'issues',
-            filter: `reviewed-by:${username}+-author:${username}+type:pr`,
-        }, config);
-    }
-    if (include_issues_authored) {
-        stats.totalIssuesAuthored = await totalItemsFetcher({
-            username,
-            repo,
-            owner,
-            type: 'issues',
-            filter: `author:${username}+type:issue`,
-        }, config);
-    }
-    if (include_issues_commented) {
-        stats.totalIssuesCommented = await totalItemsFetcher({
-            username,
-            repo,
-            owner,
-            type: 'issues',
-            filter: `commenter:${username}+-author:${username}+type:issue`,
-        }, config);
+    for (const [flag, stat, filter] of REPO_USER_SEARCHES) {
+        if (flags[flag]) {
+            stats[stat] = await totalItemsFetcher({ username, repo, owner, type: 'issues', filter: filter(username) }, config);
+        }
     }
     return stats;
 };
 /**
- * Turn a GraphQL `errors` payload into the error to throw.
- *
- * @param errors Errors from the response envelope.
- * @param statusText HTTP status text, used as the error type when GitHub gave a message.
- * @param fallback Message when GitHub gave none.
- */
-const graphqlError = (errors, statusText, fallback) => {
-    logger.error(errors);
-    const message = errors[0]?.message;
-    return message
-        ? new CardError(wrapTextMultiline(message, 525, 12)[0] ?? '', {
-            code: 'upstream',
-            secondaryMessage: statusText,
-        })
-        : new CardError(fallback, { code: 'upstream' });
-};
-/**
- * Fetch all-time contributions by building a single GraphQL query
- * for all the given years.
+ * Sum one figure over a set of ranges, fetched as aliased fields of a single query.
  *
  * Whether private contributions are included depends on the user's profile settings:
  * https://docs.github.com/en/account-and-profile/how-tos/contribution-settings/manage-visibility-settings-for-private-contributions-and-achievements#changing-the-visibility-of-your-private-contributions
+ *
+ * @returns The total over every range, and 0 when there are none.
  */
-const fetchTotalContributions = async (username, years, config) => {
-    if (years.length === 0) {
+const sumOverRanges = async (username, ranges, 
+/** What one range contributes to the total. */
+pick, config) => {
+    if (ranges.length === 0) {
         return 0;
     }
-    const contributionsFetcher = createGraphQLFetcher(buildContributionsDocument(years), 'bearer');
+    const contributionsFetcher = createGraphQLFetcher(buildContributionsDocument(ranges), 'bearer');
     const contribRes = await retryer(contributionsFetcher, { login: username }, config);
     if (contribRes.data.errors) {
         throw graphqlError(contribRes.data.errors, contribRes.statusText, 'Something went wrong while trying to retrieve the contributions data using the GraphQL API.');
     }
-    const user = contribRes.data.data.user;
+    const { user } = contribRes.data.data;
     if (!user) {
         return 0;
     }
     let total = 0;
-    for (const year of years) {
-        const yearBlock = user[`year_${year}`];
-        if (yearBlock?.contributionCalendar.totalContributions) {
-            total += yearBlock.contributionCalendar.totalContributions;
-        }
+    for (const block of Object.values(user)) {
+        total += pick(block);
     }
     return total;
 };
-const MS_PER_DAY = 24 * 60 * 60 * 1000;
-/**
- * Ranges per request.
- * Each costs roughly `4 * MAX_REPOSITORIES_LIMIT` nodes,
- * so an unchunked round of a heavily split account would breach GitHub's 500k node ceiling
- * and lose the ranges that had already resolved along with it.
- */
-const MAX_RANGES_PER_REQUEST = 100;
-const REPOS_CONTRIBUTED_TO_ERROR = 'Something went wrong while trying to retrieve the repository contributions data using the GraphQL API.';
-/**
- * Count the repositories a user contributed to across every contribution year.
- *
- * `repositoriesContributedTo` spans at most one year,
- * so every year is fetched as an aliased `contributionsCollection(from, to)` in one request and the repos de-duplicated.
- * A range returning `MAX_REPOSITORIES_LIMIT` results may have more,
- * so it is halved and requeried in the next round.
- *
- * Whether private contributions are included depends on the used PAT.
- *
- * @param canonicalUsername Username as GitHub reports it; `nameWithOwner` uses its
- *        casing, which the raw query-string username need not match.
- * @param years Contribution years to walk.
- * @param includeOwnRepos Whether to count the user's own repositories.
- * @param config Deployment config supplying the PAT pool.
- * @returns Count of repositories.
- */
-const fetchAllTimeReposContributedTo = async (canonicalUsername, years, includeOwnRepos, config) => {
-    const repos = new Set();
-    let pending = years.map(getGitHubYearRange);
-    while (pending.length > 0) {
-        const nextPending = [];
-        for (const chunk of chunkArray(pending, MAX_RANGES_PER_REQUEST)) {
-            const fetcher = createGraphQLFetcher(buildReposContributedToDocument(chunk, includeOwnRepos), 'bearer');
-            const res = await retryer(fetcher, { login: canonicalUsername, maxRepositories: MAX_REPOSITORIES_LIMIT }, config);
-            if (res.data.errors) {
-                throw graphqlError(res.data.errors, res.statusText, REPOS_CONTRIBUTED_TO_ERROR);
-            }
-            const user = res.data.data.user;
-            if (!user) {
-                throw new CardError(REPOS_CONTRIBUTED_TO_ERROR, { code: 'upstream' });
-            }
-            for (const [index, range] of chunk.entries()) {
-                const rangeResponse = user[`range_${index}`];
-                if (!rangeResponse) {
-                    throw new CardError(REPOS_CONTRIBUTED_TO_ERROR, {
-                        code: 'upstream',
-                    });
-                }
-                const lists = [
-                    rangeResponse.commitContributionsByRepository,
-                    rangeResponse.issueContributionsByRepository,
-                    rangeResponse.pullRequestContributionsByRepository,
-                    (rangeResponse.repositoryContributions?.nodes ?? []).filter((node) => node !== null),
-                ];
-                const isSaturated = lists.some((list) => list.length >= MAX_REPOSITORIES_LIMIT);
-                const rangeDays = Math.round((range.to.getTime() - range.from.getTime()) / MS_PER_DAY);
-                // a range of 1 day or less can't be split any further
-                if (isSaturated && rangeDays >= 2) {
-                    // every `from` sits on UTC midnight, so the split lands on a day boundary too
-                    const mid = new Date(range.from.getTime() + Math.floor(rangeDays / 2) * MS_PER_DAY);
-                    // GitHub only reads the date portion,
-                    // so the first half ends 1 second before `mid` to keep the halves from sharing a day
-                    nextPending.push({ from: range.from, to: new Date(mid.getTime() - 1000) }, { from: mid, to: range.to });
-                    continue;
-                }
-                if (isSaturated) {
-                    logger.log(`Range ${range.from.toISOString()} - ${range.to.toISOString()} is saturated but cannot be split further.`);
-                }
-                for (const { repository } of lists.flat()) {
-                    const name = repository.nameWithOwner;
-                    if (includeOwnRepos || !name.startsWith(`${canonicalUsername}/`)) {
-                        repos.add(name);
-                    }
-                }
-            }
-        }
-        // each saturated range pushes both of its halves
-        const saturatedCount = nextPending.length / 2;
-        if (saturatedCount > 0) {
-            logger.log(`found ${saturatedCount} saturated ranges, splitting and retrying...`);
-        }
-        pending = nextPending;
-    }
-    return repos.size;
-};
 /**
  * Fetch stats for a given username.
  *
- * @param props Fetcher props.
- * @param props.username GitHub username.
- * @param props.include_all_commits Include all commits.
- * @param props.exclude_repo Repositories to exclude.
- * @param props.include_merged_pull_requests Include merged pull requests.
- * @param props.include_discussions Include discussions.
- * @param props.include_discussions_answers Include discussions answers.
- * @param props.commits_year Year to count total commits.
- * @param props.repo Repositories to scope the REST search to.
- * @param props.owner Owners to scope the REST search to.
- * @param props.include_prs_authored Include count of PRs authored.
- * @param props.include_prs_commented Include count of PRs commented.
- * @param props.include_prs_reviewed Include count of PRs reviewed.
- * @param props.include_issues_authored Include count of issues authored.
- * @param props.include_issues_commented Include count of issues commented.
- * @param props.ownerAffiliations Owner affiliations. Default: OWNER.
- * @param props.include_contributions Include all-time contributions.
- * @param props.include_all_time_contribs Include all-time count of repos contributed to.
- * @param props.contribs_include_own_repos Include user-owned repos in contributed-to counts.
- * @param config Deployment config supplying the PAT pool.
  * @returns Stats data.
  */
-const fetchStats = async ({ username, include_all_commits = false, exclude_repo = [], include_merged_pull_requests = false, include_discussions = false, include_discussions_answers = false, commits_year, repo = [], owner = [], include_prs_authored = false, include_prs_commented = false, include_prs_reviewed = false, include_issues_authored = false, include_issues_commented = false, ownerAffiliations = [], include_contributions = false, include_all_time_contribs = false, contribs_include_own_repos = false, }, config) => {
+const fetchStats = async ({ username, include_all_commits = false, exclude_repo = [], include_merged_pull_requests = false, include_discussions = false, include_discussions_answers = false, from, to, repo = [], owner = [], include_prs_authored = false, include_prs_commented = false, include_prs_reviewed = false, include_issues_authored = false, include_issues_commented = false, ownerAffiliations = [], include_contributions = false, include_all_time_contribs = false, contribs_include_own_repos = false, }, config) => {
     if (!username) {
         throw CardError.missingParam(['username']);
     }
@@ -380,6 +202,7 @@ const fetchStats = async ({ username, include_all_commits = false, exclude_repo
         mergedPRsPercentage: 0,
         totalReviews: 0,
         totalCommits: 0,
+        commitsRange: undefined,
         totalIssues: 0,
         totalStars: 0,
         totalDiscussionsStarted: 0,
@@ -395,36 +218,24 @@ const fetchStats = async ({ username, include_all_commits = false, exclude_repo
         rank: { level: 'C', percentile: 100 },
     };
     const affiliations = parseOwnerAffiliations(ownerAffiliations);
+    // neither end given leaves GitHub's trailing year in place, which `userInfo` already carries
+    const commitsRange = from === undefined && to === undefined ? undefined : toRange(from, to);
+    const commitsYearRanges = commitsRange ? toYearRanges(commitsRange) : [];
+    // one calendar year is a range `userInfo` can ask for itself; anything else is summed separately
+    const inlineRange = commitsYearRanges.length === 1 ? commitsYearRanges[0] : undefined;
     const res = await statsFetcher({
         username,
         includeMergedPullRequests: include_merged_pull_requests,
         includeDiscussions: include_discussions,
         includeDiscussionsAnswers: include_discussions_answers,
-        startTime: commits_year === undefined
-            ? undefined
-            : toGitHubDateTime(getGitHubYearRange(commits_year).from),
+        commitsRange: inlineRange,
         ownerAffiliations: affiliations,
         includeUserRepositories: contribs_include_own_repos,
     }, config);
-    // Catch GraphQL errors.
     if (res.data.errors) {
-        logger.error(res.data.errors);
-        const firstError = res.data.errors[0];
-        if (firstError?.type === 'NOT_FOUND') {
-            throw new CardError(firstError.message || 'Could not fetch user.', {
-                code: 'not_found',
-                secondaryMessage: USER_NOT_FOUND,
-            });
-        }
-        if (firstError?.message) {
-            throw new CardError(wrapTextMultiline(firstError.message, 525, 12)[0] ?? '', {
-                code: 'upstream',
-                secondaryMessage: res.statusText,
-            });
-        }
-        throw new CardError('Something went wrong while trying to retrieve the stats data using the GraphQL API.', { code: 'upstream' });
+        throw graphqlError(res.data.errors, res.statusText, 'Something went wrong while trying to retrieve the stats data using the GraphQL API.');
     }
-    const user = res.data.data.user;
+    const { user } = res.data.data;
     if (!user) {
         throw new CardError('Could not fetch user.', {
             code: 'not_found',
@@ -443,7 +254,12 @@ const fetchStats = async ({ username, include_all_commits = false, exclude_repo
         }, config);
     }
     else {
-        stats.totalCommits = user.commits.totalCommitContributions;
+        stats.commitsRange = commitsRange;
+        // an inverted range sums no years, which is no commits rather than GitHub's default year
+        stats.totalCommits =
+            commitsRange && !inlineRange
+                ? await sumOverRanges(username, commitsYearRanges, (block) => block.totalCommitContributions, config)
+                : user.commits.totalCommitContributions;
     }
     const repoUserStats = await fetchRepoUserStats({
         username,
@@ -471,11 +287,13 @@ const fetchStats = async ({ username, include_all_commits = false, exclude_repo
         stats.totalDiscussionsAnswered = user.repositoryDiscussionComments?.totalCount ?? 0;
     }
     stats.contributedTo = user.repositoriesContributedTo.totalCount;
+    const contributionRanges = toContributionRanges(user.contributionsCollection.contributionYears, getWidestRange());
     if (include_contributions) {
-        stats.totalContributions = await fetchTotalContributions(username, user.contributionsCollection.contributionYears, config);
+        stats.totalContributions = await sumOverRanges(username, contributionRanges, (block) => block.contributionCalendar.totalContributions, config);
     }
     if (include_all_time_contribs) {
-        stats.allTimeContributedTo = await fetchAllTimeReposContributedTo(user.login, user.contributionsCollection.contributionYears, contribs_include_own_repos, config);
+        const reposContributedTo = await fetchReposContributedTo(user.login, contributionRanges, contribs_include_own_repos, config);
+        stats.allTimeContributedTo = reposContributedTo.size;
     }
     // Retrieve stars while filtering out repositories to be hidden.
     const allExcludedRepos = [...exclude_repo, ...config.excludeRepositories];

package/build/fetchers/top-languages.d.ts

@@ -1,15 +1,8 @@
-import type { CardConfig } from '../common/config.js';
-import type { TopLangData } from './types.js';
+import type { CardConfig } from '../common/config.ts';
+import type { TopLangData } from './types.ts';
 /**
  * Fetch top languages for a given username.
  *
- * @param props Fetcher props.
- * @param props.username GitHub username.
- * @param props.exclude_repo List of repositories to exclude. Default: [].
- * @param props.size_weight Weightage to be given to size.
- * @param props.count_weight Weightage to be given to count.
- * @param props.ownerAffiliations The owner affiliations to filter by. Default: OWNER.
- * @param config Deployment config supplying the PAT pool.
  * @returns Top languages data.
  */
 declare const fetchTopLanguages: ({ username, exclude_repo, size_weight, count_weight, ownerAffiliations, }: {

package/build/fetchers/top-languages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"top-languages.d.ts","sourceRoot":"","sources":["../../src/fetchers/top-languages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAatD,OAAO,KAAK,EAAQ,WAAW,EAAE,MAAM,YAAY,CAAC;AAIpD;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,iBAAiB,GACrB,2EAMG;IACD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACnC,EACD,QAAQ,UAAU,KACjB,OAAO,CAAC,WAAW,CAuFrB,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"top-languages.d.ts","sourceRoot":"","sources":["../../src/fetchers/top-languages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAYtD,OAAO,KAAK,EAAQ,WAAW,EAAE,MAAM,YAAY,CAAC;AAIpD;;;;GAIG;AACH,QAAA,MAAM,iBAAiB,8EAOlB;IACD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACnC,UACO,UAAU,KACjB,OAAO,CAAC,WAAW,CAmErB,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,CAAC"}