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

package/src/graphql/contributionsDocument.ts

@@ -1,6 +1,7 @@
-import { getGitHubYearRange, toGitHubDateTime } from '../common/date.ts';
+import type { GitHubDateRange } from '../common/date.ts';
 
-import type { YearContributionsFragment } from './generated/stats.ts';
+import { aliasedRanges } from './contributionsCollection.ts';
+import type { RangeContributionsFragment } from './generated/stats.ts';
 import type { GraphQLDocument } from './graphqlDocument.ts';
 import { graphqlDocument } from './graphqlDocument.ts';
 
@@ -9,38 +10,30 @@ interface ContributionsQueryVariables {
 }
 
 interface ContributionsQuery {
-  user: Record<`year_${number}`, YearContributionsFragment> | null;
+  user: Record<`range_${number}`, RangeContributionsFragment> | null;
 }
 
 /**
- * Build the all-time contributions query, one aliased `contributionsCollection` field per year.
- * The shape is only known at runtime.
+ * Build the contributions query for a set of ranges. The shape is only known at runtime.
  *
  * @returns Document for `createGraphQLFetcher`.
  */
 const buildContributionsDocument = (
-  years: Array<number>,
-): GraphQLDocument<ContributionsQuery, ContributionsQueryVariables> => {
-  const yearFields = years
-    .map((year) => {
-      const { from, to } = getGitHubYearRange(year);
-      return `year_${year}: contributionsCollection(from: "${toGitHubDateTime(from)}", to: "${toGitHubDateTime(to)}") { ...YearContributions }`;
-    })
-    .join('\n');
-
+  ranges: Array<GitHubDateRange>,
+): GraphQLDocument<ContributionsQuery, ContributionsQueryVariables> =>
   // fragment must match queries/stats.graphql, which generates its type
-  return graphqlDocument<ContributionsQuery, ContributionsQueryVariables>(`
+  graphqlDocument<ContributionsQuery, ContributionsQueryVariables>(`
 query userContributions($login: String!) {
   user(login: $login) {
-    ${yearFields}
+    ${aliasedRanges(ranges, 'RangeContributions')}
   }
 }
-fragment YearContributions on ContributionsCollection {
+fragment RangeContributions on ContributionsCollection {
+  totalCommitContributions
   contributionCalendar {
     totalContributions
   }
 }`);
-};
 
 export { buildContributionsDocument };
 export type { ContributionsQuery };

package/src/graphql/generated/contributed-to.ts

@@ -0,0 +1,25 @@
+// 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.ts';
+export type UserContributionYearsQueryVariables = Exact<{
+  login: string;
+}>;
+
+export type UserContributionYearsQuery = {
+  user: { login: string; contributionsCollection: { contributionYears: Array<number> } } | null;
+};
+
+export const UserContributionYearsDocument = graphqlDocument<
+  UserContributionYearsQuery,
+  UserContributionYearsQueryVariables
+>(`
+query userContributionYears($login: String!) {
+  user(login: $login) {
+    login
+    contributionsCollection {
+      contributionYears
+    }
+  }
+}`);

package/src/graphql/generated/stats.ts

@@ -42,6 +42,7 @@ export type UserInfoQueryVariables = Exact<{
   includeDiscussions: boolean;
   includeDiscussionsAnswers: boolean;
   startTime?: string | null | undefined;
+  endTime?: string | null | undefined;
   ownerAffiliations?:
     | Array<Types.RepositoryAffiliation | null | undefined>
     | Types.RepositoryAffiliation
@@ -73,12 +74,24 @@ export type UserInfoQuery = {
   } | null;
 };
 
-export type YearContributionsFragment = { contributionCalendar: { totalContributions: number } };
+export type RangeContributionsFragment = {
+  totalCommitContributions: number;
+  contributionCalendar: { totalContributions: number };
+};
 
 export type RangeContributionsByRepoFragment = {
-  commitContributionsByRepository: Array<{ repository: { nameWithOwner: string } }>;
-  issueContributionsByRepository: Array<{ repository: { nameWithOwner: string } }>;
-  pullRequestContributionsByRepository: Array<{ repository: { nameWithOwner: string } }>;
+  commitContributionsByRepository: Array<{
+    repository: { nameWithOwner: string };
+    contributions: { totalCount: number };
+  }>;
+  issueContributionsByRepository: Array<{
+    repository: { nameWithOwner: string };
+    contributions: { totalCount: number };
+  }>;
+  pullRequestContributionsByRepository: Array<{
+    repository: { nameWithOwner: string };
+    contributions: { totalCount: number };
+  }>;
   repositoryContributions?: {
     nodes: Array<{ repository: { nameWithOwner: string } } | null> | null;
   };
@@ -113,11 +126,11 @@ fragment RepoNode on Repository {
 }`);
 
 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!) {
+query userInfo($login: String!, $after: String, $includeMergedPullRequests: Boolean!, $includeDiscussions: Boolean!, $includeDiscussionsAnswers: Boolean!, $startTime: DateTime = null, $endTime: DateTime = null, $ownerAffiliations: [RepositoryAffiliation], $includeUserRepositories: Boolean!) {
   user(login: $login) {
     name
     login
-    commits: contributionsCollection(from: $startTime) {
+    commits: contributionsCollection(from: $startTime, to: $endTime) {
       totalCommitContributions
     }
     reviews: contributionsCollection {

package/src/graphql/graphqlDocument.ts

@@ -3,7 +3,7 @@
  *
  * `text` is what goes over the wire; the other two members only carry types and are never assigned.
  * Documents are generated from `queries/*.graphql`
- * See `scripts/generate-graphql-types.js`.
+ * See `scripts/generate-graphql-types.ts`.
  */
 interface GraphQLDocument<TResult, TVariables> {
   readonly text: string;

package/src/graphql/queries/contributed-to.graphql

@@ -0,0 +1,8 @@
+query userContributionYears($login: String!) {
+  user(login: $login) {
+    login
+    contributionsCollection {
+      contributionYears
+    }
+  }
+}

package/src/graphql/queries/stats.graphql

@@ -34,13 +34,14 @@ query userInfo(
   $includeDiscussions: Boolean!
   $includeDiscussionsAnswers: Boolean!
   $startTime: DateTime = null
+  $endTime: DateTime = null
   $ownerAffiliations: [RepositoryAffiliation]
   $includeUserRepositories: Boolean!
 ) {
   user(login: $login) {
     name
     login
-    commits: contributionsCollection(from: $startTime) {
+    commits: contributionsCollection(from: $startTime, to: $endTime) {
       totalCommitContributions
     }
     reviews: contributionsCollection {
@@ -81,27 +82,38 @@ query userInfo(
   }
 }
 
-fragment YearContributions on ContributionsCollection {
+fragment RangeContributions on ContributionsCollection {
+  totalCommitContributions
   contributionCalendar {
     totalContributions
   }
 }
 
+# `contributions` takes no slicing argument on purpose: `totalCount` alone costs no nodes.
 fragment RangeContributionsByRepo on ContributionsCollection {
   commitContributionsByRepository(maxRepositories: $maxRepositories) {
     repository {
       nameWithOwner
     }
+    contributions {
+      totalCount
+    }
   }
   issueContributionsByRepository(maxRepositories: $maxRepositories) {
     repository {
       nameWithOwner
     }
+    contributions {
+      totalCount
+    }
   }
   pullRequestContributionsByRepository(maxRepositories: $maxRepositories) {
     repository {
       nameWithOwner
     }
+    contributions {
+      totalCount
+    }
   }
   repositoryContributions(first: $maxRepositories) @include(if: $includeOwnRepos) {
     nodes {

package/src/graphql/reposContributedToDocument.ts

@@ -1,6 +1,6 @@
 import type { GitHubDateRange } from '../common/date.ts';
-import { toGitHubDateTime } from '../common/date.ts';
 
+import { aliasedRanges } from './contributionsCollection.ts';
 import type { RangeContributionsByRepoFragment } from './generated/stats.ts';
 import type { GraphQLDocument } from './graphqlDocument.ts';
 import { graphqlDocument } from './graphqlDocument.ts';
@@ -31,13 +31,6 @@ const buildReposContributedToDocument = (
   ranges: Array<GitHubDateRange>,
   includeOwnRepos: boolean,
 ): GraphQLDocument<ReposContributedToQuery, ReposContributedToQueryVariables> => {
-  const rangeFields = ranges
-    .map(
-      ({ from, to }, index) =>
-        `range_${index}: contributionsCollection(from: "${toGitHubDateTime(from)}", to: "${toGitHubDateTime(to)}") { ...RangeContributionsByRepo }`,
-    )
-    .join('\n');
-
   // `repositoryContributions` only ever returns repos the user owns,
   // so it is left out rather than gated with @include: an excluded field still counts toward the query's node cost.
   // stats.graphql carries the directive so the generated type marks the field optional.
@@ -55,7 +48,7 @@ const buildReposContributedToDocument = (
   return graphqlDocument<ReposContributedToQuery, ReposContributedToQueryVariables>(`
 query userReposContributedTo($login: String!, $maxRepositories: Int!) {
   user(login: $login) {
-    ${rangeFields}
+    ${aliasedRanges(ranges, 'RangeContributionsByRepo')}
   }
 }
 fragment RangeContributionsByRepo on ContributionsCollection {
@@ -63,16 +56,25 @@ fragment RangeContributionsByRepo on ContributionsCollection {
     repository {
       nameWithOwner
     }
+    contributions {
+      totalCount
+    }
   }
   issueContributionsByRepository(maxRepositories: $maxRepositories) {
     repository {
       nameWithOwner
     }
+    contributions {
+      totalCount
+    }
   }
   pullRequestContributionsByRepository(maxRepositories: $maxRepositories) {
     repository {
       nameWithOwner
     }
+    contributions {
+      totalCount
+    }
   }
   ${ownRepoField}
 }`);

package/src/translations.ts

@@ -355,6 +355,9 @@ const statCardLocales = ({ name, apostrophe }: { name: string; apostrophe: strin
   'statcard.all-time-contribs': {
     en: 'Contributed to (all time)',
   },
+  'statcard.rank': {
+    en: 'Rank',
+  },
   'statcard.reviews': {
     en: 'Total PRs Reviewed',
     ar: 'طلبات السحب التي تم مراجعتها',
@@ -625,6 +628,12 @@ const statCardLocales = ({ name, apostrophe }: { name: string; apostrophe: strin
 });
 
 const repoCardLocales = {
+  'repocard.no-description': {
+    en: 'No description provided',
+  },
+  'repocard.unspecified-language': {
+    en: 'Unspecified',
+  },
   'repocard.template': {
     en: 'Template',
     ar: 'قالب',
@@ -1143,6 +1152,72 @@ const wakatimeCardLocales = {
   },
 };
 
+const gistCardLocales = {
+  'gistcard.no-description': {
+    en: 'No description provided',
+  },
+  'gistcard.unspecified-language': {
+    en: 'Unspecified',
+  },
+  'gistcard.language': {
+    en: 'Language',
+  },
+  'gistcard.stars': {
+    en: 'Stars',
+  },
+  'gistcard.forks': {
+    en: 'Forks',
+  },
+};
+
+/** The values the contributed-to card's strings interpolate. */
+interface ContributedToValues {
+  login: string;
+  /** How many repositories the card draws, which is at most `totalRepos`. */
+  shown: number;
+  totalRepos: number;
+}
+
+/**
+ * Retrieves contributed-to card labels in the available locales.
+ *
+ * @see https://www.andiamo.co.uk/resources/iso-language-codes/ for language codes.
+ *
+ * @returns The locales object.
+ */
+// The literal key union is what `I18n#t` checks a card's `t('…')` call against, so the
+// return type is left to inference.
+// oxlint-disable-next-line typescript/explicit-function-return-type, typescript/explicit-module-boundary-types
+const contributedToCardLocales = ({ login, shown, totalRepos }: ContributedToValues) => {
+  // English's own plural rule; another locale picks its wording inside its own entry.
+  const repoWord = totalRepos === 1 ? 'repository' : 'repositories';
+
+  return {
+    'contributedtocard.title': {
+      en: `Repositories ${login} contributed to`,
+    },
+    // Drawn instead of the title above when naming the account overruns the card.
+    'contributedtocard.title-unnamed': {
+      en: 'Repositories contributed to',
+    },
+    'contributedtocard.no-contributions': {
+      en: 'No contributions found',
+    },
+    'contributedtocard.footer-all': {
+      en: `${totalRepos} ${repoWord}`,
+    },
+    'contributedtocard.footer-top': {
+      en: `top ${shown} of ${totalRepos} ${repoWord}`,
+    },
+    'contributedtocard.contributions': {
+      en: 'contributions',
+    },
+    'contributedtocard.years': {
+      en: 'years',
+    },
+  };
+};
+
 const availableLocales = Object.keys(repoCardLocales['repocard.archived']);
 
 /**
@@ -1154,6 +1229,8 @@ const isLocaleAvailable = (locale: string): boolean =>
   availableLocales.includes(locale.toLowerCase());
 
 export {
+  contributedToCardLocales,
+  gistCardLocales,
   isLocaleAvailable,
   langCardLocales,
   repoCardLocales,