@stats-forge/github-stats-forge-core 0.0.1

package/build/fetchers/index.d.ts

@@ -0,0 +1,13 @@
+export { fetchGist } from './gist.js';
+export { fetchRepo } from './repo.js';
+export { fetchRepoUserStats, fetchStats } from './stats.js';
+export { fetchTopLanguages } from './top-languages.js';
+export { fetchWakatimeStats } from './wakatime.js';
+export type { GistData, Lang, RepoUserStats, RepositoryData, StatsData, TopLangData, WakaTimeData, WakaTimeLang, } from './types.js';
+export { CardConfig } from '../common/config.js';
+export type { CardConfigInit, PersonalAccessToken } from '../common/config.js';
+export type { FetchLike } from '../common/http.js';
+export { retryer } from '../common/retryer.js';
+export { CardError } from '../common/error.js';
+export type { ErrorCode } from '../common/error.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetchers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,YAAY,EACV,QAAQ,EACR,IAAI,EACJ,aAAa,EACb,cAAc,EACd,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,GACb,MAAM,YAAY,CAAC;AAIpB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,YAAY,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC"}

package/build/fetchers/index.js

@@ -0,0 +1,10 @@
+export { fetchGist } from './gist.js';
+export { fetchRepo } from './repo.js';
+export { fetchRepoUserStats, fetchStats } from './stats.js';
+export { fetchTopLanguages } from './top-languages.js';
+export { fetchWakatimeStats } from './wakatime.js';
+// every fetcher takes a config, so this entry carries it rather than sending a
+// consumer back to the package root for it.
+export { CardConfig } from '../common/config.js';
+export { retryer } from '../common/retryer.js';
+export { CardError } from '../common/error.js';

package/build/fetchers/repo.d.ts

@@ -0,0 +1,27 @@
+import type { CardConfig } from '../common/config.js';
+import type { RepositoryData } from './types.js';
+/**
+ * Fetch repository data.
+ *
+ * @param props Fetcher props.
+ * @param props.username GitHub username.
+ * @param props.reponame GitHub repository name.
+ * @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 Repository data.
+ */
+declare const fetchRepo: ({ username, reponame, include_prs_authored, include_prs_commented, include_prs_reviewed, include_issues_authored, include_issues_commented, }: {
+    username: string | undefined;
+    reponame: string | undefined;
+    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<RepositoryData>;
+export { fetchRepo };
+//# sourceMappingURL=repo.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repo.d.ts","sourceRoot":"","sources":["../../src/fetchers/repo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAOtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAMjD;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,SAAS,GACb,+IAQG;IACD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,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,cAAc,CA2FxB,CAAC;AAEF,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/build/fetchers/repo.js

@@ -0,0 +1,100 @@
+import { CardError, REPO_NOT_FOUND } from '../common/error.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';
+const fetcher = createGraphQLFetcher(GetRepoDocument, 'token');
+const urlExample = '/api/pin?username=USERNAME&repo=REPO_NAME';
+/**
+ * Fetch repository data.
+ *
+ * @param props Fetcher props.
+ * @param props.username GitHub username.
+ * @param props.reponame GitHub repository name.
+ * @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 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, }, config) => {
+    let owner = username;
+    if (reponame && reponame.includes('/')) {
+        const [parsedOwner, parsedRepo] = reponame.split('/');
+        owner = parsedOwner ?? '';
+        reponame = parsedRepo ?? '';
+    }
+    if (owner && !username) {
+        username = owner;
+    }
+    if (username && !owner) {
+        owner = username;
+    }
+    if (!username && !reponame) {
+        throw CardError.missingParam(['username', 'repo'], urlExample);
+    }
+    if (!username) {
+        throw CardError.missingParam(['username'], urlExample);
+    }
+    if (!reponame) {
+        throw CardError.missingParam(['repo'], urlExample);
+    }
+    // the guards above leave `username` set, and `owner` mirrors it when `repo` carried none
+    const repoOwner = owner ?? username;
+    const res = await retryer(fetcher, { login: repoOwner, repo: reponame }, config);
+    const data = res.data.data;
+    if (!data.user && !data.organization) {
+        throw new CardError('Not found', {
+            code: 'not_found',
+            secondaryMessage: REPO_NOT_FOUND,
+        });
+    }
+    if (data.organization === null && data.user) {
+        const repository = data.user.repository;
+        if (!repository || repository.isPrivate) {
+            throw new CardError('User Repository Not found', {
+                code: 'not_found',
+                secondaryMessage: REPO_NOT_FOUND,
+            });
+        }
+        const repoUserStats = await fetchRepoUserStats({
+            username,
+            repo: [`${repoOwner}/${reponame}`],
+            include_prs_authored,
+            include_prs_commented,
+            include_prs_reviewed,
+            include_issues_authored,
+            include_issues_commented,
+        }, config);
+        return {
+            ...repoUserStats,
+            ...repository,
+        };
+    }
+    if (data.user === null && data.organization) {
+        const repository = data.organization.repository;
+        if (!repository || repository.isPrivate) {
+            throw new CardError('Organization Repository Not found', {
+                code: 'not_found',
+                secondaryMessage: REPO_NOT_FOUND,
+            });
+        }
+        const repoUserStats = await fetchRepoUserStats({
+            username,
+            repo: [`${repoOwner}/${reponame}`],
+            include_prs_authored,
+            include_prs_commented,
+            include_prs_reviewed,
+            include_issues_authored,
+            include_issues_commented,
+        }, config);
+        return {
+            ...repoUserStats,
+            ...repository,
+        };
+    }
+    throw new CardError('Unexpected behavior', { code: 'upstream' });
+};
+export { fetchRepo };

package/build/fetchers/stats.d.ts

@@ -0,0 +1,74 @@
+import type { CardConfig } from '../common/config.js';
+import type { RepoUserStats, StatsData } from './types.js';
+/**
+ * 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, }: {
+    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, }: {
+    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;
+    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 | undefined;
+}, config: CardConfig) => Promise<StatsData>;
+export { fetchStats, fetchRepoUserStats };
+//# sourceMappingURL=stats.d.ts.map

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

@@ -0,0 +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"}