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

package/build/fetchers/gist.js

@@ -1,78 +1,38 @@
 import { MissingParamError } from "../common/error.js";
-import { request } from "../common/http.js";
+import { createGraphQLFetcher } 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.
- */
+import { GistInfoDocument } from "../graphql/generated/gist.js";
+const fetcher = createGraphQLFetcher(GistInfoDocument, "token");
 /**
  * This function calculates the primary language of a gist by files size.
  *
- * @param {GistFile[]} files Files.
- * @returns {string} Primary language.
+ * @param files Files.
+ * @returns Primary language, or `null` when no file has a 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;
-            }
+            languages[file.language.name] =
+                (languages[file.language.name] ?? 0) + (file.size ?? 0);
         }
     }
-    let primaryLanguage = Object.keys(languages)[0];
-    for (const language in languages) {
-        if (languages[language] > languages[primaryLanguage]) {
+    let primaryLanguage = null;
+    let maxSize = -1;
+    for (const [language, size] of Object.entries(languages)) {
+        if (size > maxSize) {
+            maxSize = size;
             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.
+ * @param id GitHub gist ID.
+ * @param pat Optional PAT override.
+ * @returns Gist data.
  */
 const fetchGist = async (id, pat = null) => {
     if (!id) {
@@ -80,19 +40,23 @@ const fetchGist = async (id, pat = null) => {
     }
     const res = await retryer(fetcher, { gistName: id }, pat);
     if (res.data.errors) {
-        throw new Error(res.data.errors[0].message);
+        throw new Error(res.data.errors[0]?.message);
     }
-    if (!res.data.data.viewer.gist) {
+    const gist = res.data.data.viewer.gist;
+    if (!gist) {
         throw new Error("Gist not found");
     }
-    const data = res.data.data.viewer.gist;
+    const firstFile = gist.files?.[0];
+    if (!firstFile?.name) {
+        throw new Error("Gist has no files");
+    }
     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,
+        name: firstFile.name,
+        nameWithOwner: `${gist.owner?.login ?? ""}/${firstFile.name}`,
+        description: gist.description,
+        language: calculatePrimaryLanguage(gist.files?.filter((file) => !!file) ?? []),
+        starsCount: gist.stargazerCount,
+        forksCount: gist.forks.totalCount,
     };
 };
 export { fetchGist };

package/build/fetchers/repo.d.ts

@@ -1,16 +1,17 @@
-/**
- * Repository data.
- */
-export type RepositoryData = any;
-/**
- * @typedef {import("./types").RepositoryData} RepositoryData Repository data.
- */
+import type { RepositoryData } from "./types.js";
 /**
  * Fetch repository data.
  *
- * @param {string} username GitHub username.
- * @param {string} reponame GitHub repository name.
- * @returns {Promise<RepositoryData>} Repository data.
+ * @param username GitHub username.
+ * @param reponame GitHub repository name.
+ * @param include_prs_authored Include count of PRs authored.
+ * @param include_prs_commented Include count of PRs commented.
+ * @param include_prs_reviewed Include count of PRs reviewed.
+ * @param include_issues_authored Include count of issues authored.
+ * @param include_issues_commented Include count of issues commented.
+ * @param pat Optional PAT override.
+ * @returns Repository data.
  */
-export function fetchRepo(username: string, reponame: string, include_prs_authored?: boolean, include_prs_commented?: boolean, include_prs_reviewed?: boolean, include_issues_authored?: boolean, include_issues_commented?: boolean, pat?: null): Promise<RepositoryData>;
+declare const fetchRepo: (username: string, reponame: string, include_prs_authored?: boolean, include_prs_commented?: boolean, include_prs_reviewed?: boolean, include_issues_authored?: boolean, include_issues_commented?: boolean, pat?: string | null) => Promise<RepositoryData>;
+export { fetchRepo };
 //# sourceMappingURL=repo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"repo.d.ts","sourceRoot":"","sources":["../../src/fetchers/repo.js"],"names":[],"mappings":";;;;AAuDA;;GAEG;AAEH;;;;;;GAMG;AACH,oCAJW,MAAM,YACN,MAAM,uLACJ,OAAO,CAAC,cAAc,CAAC,CA8FnC"}
+{"version":3,"file":"repo.d.ts","sourceRoot":"","sources":["../../src/fetchers/repo.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAMjD;;;;;;;;;;;;GAYG;AACH,QAAA,MAAM,SAAS,GACb,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,8BAA4B,EAC5B,+BAA6B,EAC7B,8BAA4B,EAC5B,iCAA+B,EAC/B,kCAAgC,EAChC,MAAK,MAAM,GAAG,IAAW,KACxB,OAAO,CAAC,cAAc,CA6ExB,CAAC;AAEF,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/build/fetchers/repo.js

@@ -1,67 +1,29 @@
 import { MissingParamError } from "../common/error.js";
-import { request } from "../common/http.js";
+import { createGraphQLFetcher } from "../common/http.js";
 import { retryer } from "../common/retryer.js";
+import { GetRepoDocument } from "../graphql/generated/repo.js";
 import { fetchRepoUserStats } from "./stats.js";
-/**
- * Repo data fetcher.
- *
- * @param {object} variables Fetcher variables.
- * @param {string} token GitHub token.
- * @returns {Promise<import('axios').AxiosResponse>} The response.
- */
-const fetcher = (variables, token) => {
-    return request({
-        query: `
-      fragment RepoInfo on Repository {
-        name
-        nameWithOwner
-        isPrivate
-        isArchived
-        isTemplate
-        stargazerCount
-        description
-        primaryLanguage {
-          color
-          id
-          name
-        }
-        forkCount
-      }
-      query getRepo($login: String!, $repo: String!) {
-        user(login: $login) {
-          repository(name: $repo) {
-            ...RepoInfo
-          }
-        }
-        organization(login: $login) {
-          repository(name: $repo) {
-            ...RepoInfo
-          }
-        }
-      }
-    `,
-        variables,
-    }, {
-        Authorization: `token ${token}`,
-    });
-};
-const urlExample = "/api/pin?username=USERNAME&amp;repo=REPO_NAME";
-/**
- * @typedef {import("./types").RepositoryData} RepositoryData Repository data.
- */
+const fetcher = createGraphQLFetcher(GetRepoDocument, "token");
+const urlExample = "/api/pin?username=USERNAME&repo=REPO_NAME";
 /**
  * Fetch repository data.
  *
- * @param {string} username GitHub username.
- * @param {string} reponame GitHub repository name.
- * @returns {Promise<RepositoryData>} Repository data.
+ * @param username GitHub username.
+ * @param reponame GitHub repository name.
+ * @param include_prs_authored Include count of PRs authored.
+ * @param include_prs_commented Include count of PRs commented.
+ * @param include_prs_reviewed Include count of PRs reviewed.
+ * @param include_issues_authored Include count of issues authored.
+ * @param include_issues_commented Include count of issues commented.
+ * @param pat Optional PAT override.
+ * @returns Repository data.
  */
 const fetchRepo = async (username, reponame, include_prs_authored = false, include_prs_commented = false, include_prs_reviewed = false, include_issues_authored = false, include_issues_commented = false, pat = null) => {
     let owner = username;
     if (reponame && reponame.includes("/")) {
-        const [parsed_owner, parsed_repo] = reponame.split("/");
-        owner = parsed_owner;
-        reponame = parsed_repo;
+        const [parsedOwner, parsedRepo] = reponame.split("/");
+        owner = parsedOwner ?? "";
+        reponame = parsedRepo ?? "";
     }
     if (owner && !username) {
         username = owner;
@@ -78,34 +40,31 @@ const fetchRepo = async (username, reponame, include_prs_authored = false, inclu
     if (!reponame) {
         throw new MissingParamError(["repo"], urlExample);
     }
-    let res = await retryer(fetcher, { login: owner, repo: reponame }, pat);
+    const res = await retryer(fetcher, { login: owner, repo: reponame }, pat);
     const data = res.data.data;
     if (!data.user && !data.organization) {
         throw new Error("Not found");
     }
-    const isUser = data.organization === null && data.user;
-    const isOrg = data.user === null && data.organization;
-    if (isUser) {
-        if (!data.user.repository || data.user.repository.isPrivate) {
+    if (data.organization === null && data.user) {
+        const repository = data.user.repository;
+        if (!repository || repository.isPrivate) {
             throw new Error("User Repository Not found");
         }
-        let repoUserStats = await fetchRepoUserStats(username, [owner + "/" + reponame], [], include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, pat);
+        const repoUserStats = await fetchRepoUserStats(username, [owner + "/" + reponame], [], include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, pat);
         return {
             ...repoUserStats,
-            ...data.user.repository,
-            starCount: data.user.repository.stargazerCount,
+            ...repository,
         };
     }
-    if (isOrg) {
-        if (!data.organization.repository ||
-            data.organization.repository.isPrivate) {
+    if (data.user === null && data.organization) {
+        const repository = data.organization.repository;
+        if (!repository || repository.isPrivate) {
             throw new Error("Organization Repository Not found");
         }
-        let repoUserStats = await fetchRepoUserStats(username, [owner + "/" + reponame], [], include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, pat);
+        const repoUserStats = await fetchRepoUserStats(username, [owner + "/" + reponame], [], include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, pat);
         return {
             ...repoUserStats,
-            ...data.organization.repository,
-            starCount: data.organization.repository.stargazerCount,
+            ...repository,
         };
     }
     throw new Error("Unexpected behavior");

package/build/fetchers/stats.d.ts

@@ -1,22 +1,29 @@
+import type { RepoUserStats, StatsData } from "./types.js";
+declare const fetchRepoUserStats: (username: string, repo: Array<string>, owner: Array<string>, include_prs_authored: boolean, include_prs_commented: boolean, include_prs_reviewed: boolean, include_issues_authored: boolean, include_issues_commented: boolean, pat: string | null) => Promise<RepoUserStats>;
 /**
  * Fetch stats for a given username.
  *
- * @param {string} username GitHub username.
- * @param {boolean} include_all_commits Include all commits.
- * @param {string[]} exclude_repo Repositories to exclude.
- * @param {boolean} include_merged_pull_requests Include merged pull requests.
- * @param {boolean} include_discussions Include discussions.
- * @param {boolean} include_discussions_answers Include discussions answers.
- * @param {number|undefined} commits_year Year to count total commits
- * @param {string[]} ownerAffiliations Owner affiliations. Default: OWNER.
- * @returns {Promise<import("./types").StatsData>} Stats data.
+ * @param username GitHub username.
+ * @param include_all_commits Include all commits.
+ * @param exclude_repo Repositories to exclude.
+ * @param include_merged_pull_requests Include merged pull requests.
+ * @param include_discussions Include discussions.
+ * @param include_discussions_answers Include discussions answers.
+ * @param commits_year Year to count total commits.
+ * @param repo Repositories to scope the REST search to.
+ * @param owner Owners to scope the REST search to.
+ * @param include_prs_authored Include count of PRs authored.
+ * @param include_prs_commented Include count of PRs commented.
+ * @param include_prs_reviewed Include count of PRs reviewed.
+ * @param include_issues_authored Include count of issues authored.
+ * @param include_issues_commented Include count of issues commented.
+ * @param ownerAffiliations Owner affiliations. Default: OWNER.
+ * @param include_contributions Include all-time contributions.
+ * @param include_all_time_contribs Include all-time count of repos contributed to.
+ * @param contribs_include_own_repos Include user-owned repos in contributed-to counts.
+ * @param pat Optional PAT override.
+ * @returns Stats data.
  */
-export function fetchStats(username: string, include_all_commits: boolean | undefined, exclude_repo: string[] | undefined, include_merged_pull_requests: boolean | undefined, include_discussions: boolean | undefined, include_discussions_answers: boolean | undefined, commits_year: number | undefined, repo?: any[], owner?: any[], include_prs_authored?: boolean, include_prs_commented?: boolean, include_prs_reviewed?: boolean, include_issues_authored?: boolean, include_issues_commented?: boolean, ownerAffiliations?: string[], pat?: null): Promise<any>;
-export function fetchRepoUserStats(username: any, repo: any, owner: any, include_prs_authored: any, include_prs_commented: any, include_prs_reviewed: any, include_issues_authored: any, include_issues_commented: any, pat: any): Promise<{
-    totalPRsAuthored: number;
-    totalPRsCommented: number;
-    totalPRsReviewed: number;
-    totalIssuesAuthored: number;
-    totalIssuesCommented: number;
-}>;
+declare const fetchStats: (username: string, include_all_commits?: boolean, exclude_repo?: Array<string>, include_merged_pull_requests?: boolean, include_discussions?: boolean, include_discussions_answers?: boolean, commits_year?: number, repo?: Array<string>, owner?: Array<string>, include_prs_authored?: boolean, include_prs_commented?: boolean, include_prs_reviewed?: boolean, include_issues_authored?: boolean, include_issues_commented?: boolean, ownerAffiliations?: Array<string>, include_contributions?: boolean, include_all_time_contribs?: boolean, contribs_include_own_repos?: boolean, pat?: string | null) => Promise<StatsData>;
+export { fetchStats, fetchRepoUserStats };
 //# sourceMappingURL=stats.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/fetchers/stats.js"],"names":[],"mappings":"AAmTA;;;;;;;;;;;;GAYG;AACH,qCAVW,MAAM,uBACN,OAAO,4BACP,MAAM,EAAE,4CACR,OAAO,mCACP,OAAO,2CACP,OAAO,4BACP,MAAM,GAAC,SAAS,2NAChB,MAAM,EAAE,eACN,OAAO,CAAC,GAA2B,CAAC,CAyJhD;AArOD;;;;;;GA+DC"}
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/fetchers/stats.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAgM3D,QAAA,MAAM,kBAAkB,GACtB,UAAU,MAAM,EAChB,MAAM,KAAK,CAAC,MAAM,CAAC,EACnB,OAAO,KAAK,CAAC,MAAM,CAAC,EACpB,sBAAsB,OAAO,EAC7B,uBAAuB,OAAO,EAC9B,sBAAsB,OAAO,EAC7B,yBAAyB,OAAO,EAChC,0BAA0B,OAAO,EACjC,KAAK,MAAM,GAAG,IAAI,KACjB,OAAO,CAAC,aAAa,CAqDvB,CAAC;AAiQF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,QAAA,MAAM,UAAU,GACd,UAAU,MAAM,EAChB,6BAA2B,EAC3B,eAAc,KAAK,CAAC,MAAM,CAAM,EAChC,sCAAoC,EACpC,6BAA2B,EAC3B,qCAAmC,EACnC,eAAe,MAAM,EACrB,OAAM,KAAK,CAAC,MAAM,CAAM,EACxB,QAAO,KAAK,CAAC,MAAM,CAAM,EACzB,8BAA4B,EAC5B,+BAA6B,EAC7B,8BAA4B,EAC5B,iCAA+B,EAC/B,kCAAgC,EAChC,oBAAmB,KAAK,CAAC,MAAM,CAAM,EACrC,+BAA6B,EAC7B,mCAAiC,EACjC,oCAAkC,EAClC,MAAK,MAAM,GAAG,IAAW,KACxB,OAAO,CAAC,SAAS,CA2JnB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC"}