@lizardbyte/contribkit 2025.315.185528 → 2025.316.4339

package/README.md

@@ -11,18 +11,45 @@ This is a fork of [sponsorkit](https://github.com/antfu-collective/sponsorkit) t
 
 Supports:
 
-- [**GitHub Sponsors**](https://github.com/sponsors)
-- [**Patreon**](https://www.patreon.com/)
-- [**OpenCollective**](https://opencollective.com/)
-- [**Afdian**](https://afdian.com/)
-- [**Polar**](https://polar.sh/)
-- [**Liberapay**](https://liberapay.com/)
+- Contributors:
+  - [**CrowdIn**](https://crowdin.com)
+  - [**GitHub**](https://github.com)
+  - [**Gitlab**](https://gitlab.com)
+- Sponsors:
+  - [**GitHub Sponsors**](https://github.com/sponsors)
+  - [**Patreon**](https://www.patreon.com/)
+  - [**OpenCollective**](https://opencollective.com/)
+  - [**Afdian**](https://afdian.com/)
+  - [**Polar**](https://polar.sh/)
+  - [**Liberapay**](https://liberapay.com/)
 
 ## Usage
 
 Create `.env` file with:
 
 ```ini
+;; Contributors
+
+; CrowdInContributors provider.
+CONTRIBKIT_CROWDIN_TOKEN=
+CONTRIBKIT_CROWDIN_PROJECT_ID=
+CONTRIBKIT_CROWDIN_MIN_TRANSLATIONS=1
+
+; GitHubContributors provider.
+; Token requires the `public_repo` and `read:user` scopes.
+CONTRIBKIT_GITHUB_CONTRIBUTORS_TOKEN=
+CONTRIBKIT_GITHUB_CONTRIBUTORS_LOGIN=
+CONTRIBKIT_GITHUB_CONTRIBUTORS_MIN=1
+CONTRIBKIT_GITHUB_CONTRIBUTORS_REPO=
+
+; GitlabContributors provider.
+; Token requires the `read_api` and `read_user` scopes.
+CONTRIBKIT_GITLAB_CONTRIBUTORS_TOKEN=
+CONTRIBKIT_GITLAB_CONTRIBUTORS_MIN=1
+CONTRIBKIT_GITLAB_CONTRIBUTORS_REPO_ID=
+
+;; Sponsors
+
 ; GitHub provider.
 ; Token requires the `read:user` and `read:org` scopes.
 CONTRIBKIT_GITHUB_TOKEN=
@@ -64,6 +91,11 @@ CONTRIBKIT_LIBERAPAY_LOGIN=
 
 > Only one provider is required to be configured.
 
+> ![NOTE]
+> The contributor providers are intended to be separated from each other, unlike the sponsor providers.
+> This will require different env variables to be set for each provider, and to be created from separate
+> commands.
+
 Run:
 
 ```base

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 import cac from 'cac';
-import { S as SvgComposer, i as generateBadge, p as partitionTiers, t as tierPresets, v as version, l as loadConfig, k as resolveProviders, j as guessProviders, r as resolveAvatars, q as outputFormats, s as svgToPng, g as svgToWebp } from './shared/contribkit.QISHqB4U.mjs';
+import { S as SvgComposer, i as generateBadge, p as partitionTiers, t as tierPresets, v as version, l as loadConfig, k as resolveProviders, j as guessProviders, r as resolveAvatars, q as outputFormats, s as svgToPng, g as svgToWebp } from './shared/contribkit.CL3hIz1T.mjs';
 import fs from 'node:fs';
 import fsp from 'node:fs/promises';
 import { resolve, dirname, relative, join } from 'node:path';
@@ -12,6 +12,7 @@ import 'dotenv';
 import 'ofetch';
 import 'sharp';
 import 'node:crypto';
+import '@crowdin/crowdin-api-client';
 
 function notNullish(v) {
   return v != null;

package/dist/index.d.mts

@@ -83,7 +83,7 @@ interface Sponsorship {
 }
 declare const outputFormats: readonly ["svg", "png", "webp", "json"];
 type OutputFormat = typeof outputFormats[number];
-type ProviderName = 'github' | 'patreon' | 'opencollective' | 'afdian' | 'polar' | 'liberapay';
+type ProviderName = 'github' | 'patreon' | 'opencollective' | 'afdian' | 'polar' | 'liberapay' | 'githubContributors' | 'gitlabContributors' | 'crowdinContributors';
 type GitHubAccountType = 'user' | 'organization';
 interface ProvidersConfig {
     github?: {
@@ -208,6 +208,76 @@ interface ProvidersConfig {
          */
         login?: string;
     };
+    githubContributors?: {
+        /**
+         * User id of your GitHub account.
+         *
+         * Will read from `CONTRIBKIT_GITHUB_CONTRIBUTORS_LOGIN` environment variable if not set.
+         */
+        login?: string;
+        /**
+         * GitHub Token that have access to your sponsorships.
+         *
+         * Will read from `CONTRIBKIT_GITHUB_CONTRIBUTORS_TOKEN` environment variable if not set.
+         *
+         * @deprecated It's not recommended set this value directly, pass from env or use `.env` file.
+         */
+        token?: string;
+        /**
+         * The minimum number of contributions to be considered a sponsor.
+         *
+         * @default 1
+         */
+        minContributions?: number;
+        /**
+         * The repository to fetch contributors from.
+         *
+         * Will read from `CONTRIBKIT_GITHUB_CONTRIBUTORS_REPO` environment variable if not set.
+         */
+        repo?: string;
+    };
+    gitlabContributors?: {
+        /**
+         * Gitlab Token that have access contributors.
+         *
+         * Will read from `CONTRIBKIT_GITLAB_CONTRIBUTORS_TOKEN` environment variable if not set.
+         *
+         * @deprecated It's not recommended set this value directly, pass from env or use `.env` file.
+         */
+        token?: string;
+        /**
+         * The minimum number of contributions to be considered a sponsor.
+         *
+         * @default 1
+         */
+        minContributions?: number;
+        /**
+         * The repository ID to fetch contributors from.
+         *
+         * Will read from `CONTRIBKIT_GITLAB_CONTRIBUTORS_REPO_ID` environment variable if not set.
+         */
+        repoId?: number;
+    };
+    crowdinContributors?: {
+        /**
+         * The Crowdin API token.
+         *
+         * Will read from `CONTRIBKIT_CROWDIN_TOKEN` environment variable if not set.
+         */
+        token?: string;
+        /**
+         * The project id on Crowdin.
+         *
+         * Will read from `CONTRIBKIT_CROWDIN_PROJECT_ID` environment variable if not set.
+         */
+        projectId?: number;
+        /**
+         * The minimum number of translations to be considered a sponsor.
+         *
+         * @default 100
+         */
+        minTranslations?: number;
+    };
 }
 interface ContribkitRenderOptions {
     /**
@@ -486,6 +556,9 @@ declare const ProvidersMap: {
     afdian: Provider;
     polar: Provider;
     liberapay: Provider;
+    githubContributors: Provider;
+    gitlabContributors: Provider;
+    crowdinContributors: Provider;
 };
 declare function guessProviders(config: ContribkitConfig): ProviderName[];
 declare function resolveProviders(names: (ProviderName | Provider)[]): Provider[];

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { F as FALLBACK_AVATAR, G as GitHubProvider, P as ProvidersMap, S as SvgComposer, c as defaultConfig, b as defaultInlineCSS, a as defaultTiers, d as defineConfig, n as fetchGitHubSponsors, m as fetchSponsors, h as genSvgImage, i as generateBadge, j as guessProviders, l as loadConfig, o as makeQuery, q as outputFormats, p as partitionTiers, e as presets, f as resizeImage, r as resolveAvatars, k as resolveProviders, s as svgToPng, g as svgToWebp, t as tierPresets } from './shared/contribkit.QISHqB4U.mjs';
+export { F as FALLBACK_AVATAR, G as GitHubProvider, P as ProvidersMap, S as SvgComposer, c as defaultConfig, b as defaultInlineCSS, a as defaultTiers, d as defineConfig, n as fetchGitHubSponsors, m as fetchSponsors, h as genSvgImage, i as generateBadge, j as guessProviders, l as loadConfig, o as makeQuery, q as outputFormats, p as partitionTiers, e as presets, f as resizeImage, r as resolveAvatars, k as resolveProviders, s as svgToPng, g as svgToWebp, t as tierPresets } from './shared/contribkit.CL3hIz1T.mjs';
 import 'unconfig';
 import 'node:process';
 import 'dotenv';
@@ -7,3 +7,4 @@ import 'consola';
 import 'ofetch';
 import 'sharp';
 import 'node:crypto';
+import '@crowdin/crowdin-api-client';

package/dist/shared/{contribkit.QISHqB4U.mjs → contribkit.CL3hIz1T.mjs}

@@ -6,6 +6,7 @@ import { consola } from 'consola';
 import { $fetch, ofetch } from 'ofetch';
 import sharp from 'sharp';
 import { createHash } from 'node:crypto';
+import { ProjectsGroups, Reports } from '@crowdin/crowdin-api-client';
 
 const none = {
   avatar: {
@@ -179,12 +180,28 @@ function loadEnv() {
     liberapay: {
       login: process.env.CONTRIBKIT_LIBERAPAY_LOGIN || process.env.LIBERAPAY_LOGIN
     },
-    outputDir: process.env.CONTRIBKIT_DIR
+    outputDir: process.env.CONTRIBKIT_DIR,
+    githubContributors: {
+      login: process.env.CONTRIBKIT_GITHUB_CONTRIBUTORS_LOGIN,
+      token: process.env.CONTRIBKIT_GITHUB_CONTRIBUTORS_TOKEN,
+      minContributions: Number(process.env.CONTRIBKIT_GITHUB_CONTRIBUTORS_MIN) || 1,
+      repo: process.env.CONTRIBKIT_GITHUB_CONTRIBUTORS_REPO
+    },
+    gitlabContributors: {
+      token: process.env.CONTRIBKIT_GITLAB_CONTRIBUTORS_TOKEN,
+      minContributions: Number(process.env.CONTRIBKIT_GITLAB_CONTRIBUTORS_MIN) || 1,
+      repoId: Number(process.env.CONTRIBKIT_GITLAB_CONTRIBUTORS_REPO_ID)
+    },
+    crowdinContributors: {
+      token: process.env.CONTRIBKIT_CROWDIN_TOKEN,
+      projectId: Number(process.env.CONTRIBKIT_CROWDIN_PROJECT_ID),
+      minTranslations: Number(process.env.CONTRIBKIT_CROWDIN_MIN_TRANSLATIONS) || 1
+    }
   };
   return JSON.parse(JSON.stringify(config));
 }
 
-const version = "2025.315.185528";
+const version = "2025.316.4339";
 
 async function fetchImage(url) {
   const arrayBuffer = await $fetch(url, {
@@ -265,10 +282,16 @@ async function loadConfig(inlineConfig = {}) {
   const { config = {} } = await loadConfig$1({
     sources: [
       {
-        files: "sponsorkit.config"
+        files: "contrib.config"
       },
       {
         files: "contribkit.config"
+      },
+      {
+        files: "sponsor.config"
+      },
+      {
+        files: "sponsorkit.config"
       }
     ],
     merge: true
@@ -503,6 +526,65 @@ function md5(token, params, ts, userId) {
   return createHash("md5").update(`${token}params${params}ts${ts}user_id${userId}`).digest("hex");
 }
 
+const CrowdinContributorsProvider = {
+  name: "crowdinContributors",
+  fetchSponsors(config) {
+    return fetchCrowdinContributors(
+      config.crowdinContributors?.token || config.token,
+      config.crowdinContributors?.projectId || 0,
+      config.crowdinContributors?.minTranslations || 1
+    );
+  }
+};
+async function fetchCrowdinContributors(token, projectId, minTranslations = 1) {
+  if (!token)
+    throw new Error("Crowdin token is required");
+  if (!projectId)
+    throw new Error("Crowdin project ID is required");
+  const credentials = {
+    token
+  };
+  const projectsGroups = new ProjectsGroups(credentials);
+  const project = await projectsGroups.getProject(projectId);
+  const reports = new Reports(credentials);
+  const dateTo = (/* @__PURE__ */ new Date()).toISOString();
+  const dateFrom = project.data.createdAt;
+  const createReportRequestBody = {
+    name: "top-members",
+    schema: {
+      unit: "words",
+      format: "json",
+      dateFrom,
+      dateTo
+    }
+  };
+  const createReport = await reports.generateReport(projectId, createReportRequestBody);
+  await new Promise((resolve) => setTimeout(resolve, 5e3));
+  const report = await reports.downloadReport(projectId, createReport.data.identifier);
+  const reportRaw = await fetch(report.data.url);
+  const reportData = await reportRaw.json();
+  const contributors = reportData.data.filter((entry) => entry.translated > minTranslations).map((entry) => ({
+    member: entry.user,
+    translations: entry.translated
+  }));
+  return contributors.filter(Boolean).map(({ member, translations }) => ({
+    sponsor: {
+      type: "User",
+      login: member.username,
+      name: member.username,
+      // fullName is also available
+      avatarUrl: member.avatarUrl,
+      linkUrl: `https://crowdin.com/profile/${member.username}`
+    },
+    isOneTime: false,
+    monthlyDollars: translations,
+    privacyLevel: "PUBLIC",
+    tierName: "Translator",
+    createdAt: member.joinedAt,
+    provider: "crowdinContributors"
+  }));
+}
+
 // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
 const DATA_URL_DEFAULT_MIME_TYPE = 'text/plain';
 const DATA_URL_DEFAULT_CHARSET = 'us-ascii';
@@ -939,6 +1021,149 @@ function makeQuery(login, type, activeOnly = true, cursor) {
 }`;
 }
 
+const GitHubContributorsProvider = {
+  name: "githubContributors",
+  fetchSponsors(config) {
+    if (!config.githubContributors?.repo)
+      throw new Error("GitHub repository is required");
+    return fetchGitHubContributors(
+      config.githubContributors?.token || config.token,
+      config.githubContributors?.login || config.login,
+      config.githubContributors.repo,
+      config.githubContributors?.minContributions
+    );
+  }
+};
+async function fetchGitHubContributors(token, login, repo, minContributions = 1) {
+  if (!token)
+    throw new Error("GitHub token is required");
+  if (!login)
+    throw new Error("GitHub login is required");
+  if (!repo)
+    throw new Error("GitHub repository is required");
+  const allContributors = [];
+  let page = 1;
+  let hasNextPage = true;
+  while (hasNextPage) {
+    const response = await $fetch(
+      `https://api.github.com/repos/${login}/${repo}/contributors`,
+      {
+        query: {
+          page: String(page),
+          per_page: "100"
+        },
+        headers: {
+          Authorization: `bearer ${token}`,
+          Accept: "application/vnd.github.v3+json"
+        }
+      }
+    );
+    if (!response || !response.length)
+      break;
+    allContributors.push(...response);
+    hasNextPage = response.length === 100;
+    page++;
+  }
+  return allContributors.filter(
+    (contributor) => contributor.type === "User" && contributor.contributions >= minContributions
+  ).map((contributor) => ({
+    sponsor: {
+      type: "User",
+      login: contributor.login,
+      name: contributor.login,
+      avatarUrl: contributor.avatar_url,
+      linkUrl: contributor.url
+    },
+    isOneTime: false,
+    monthlyDollars: contributor.contributions,
+    privacyLevel: "PUBLIC",
+    tierName: "Contributor",
+    createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+    provider: "githubContributors"
+  }));
+}
+
+const GitlabContributorsProvider = {
+  name: "gitlabContributors",
+  fetchSponsors(config) {
+    if (!config.gitlabContributors?.repoId)
+      throw new Error("Gitlab repoId is required");
+    return fetchGitlabContributors(
+      config.gitlabContributors?.token || config.token,
+      config.gitlabContributors.repoId,
+      config.gitlabContributors?.minContributions
+    );
+  }
+};
+async function fetchGitlabContributors(token, repoId, minContributions = 1) {
+  if (!token)
+    throw new Error("Gitlab token is required");
+  if (!repoId)
+    throw new Error("Gitlab repoId is required");
+  const allContributors = [];
+  let page = 1;
+  let hasNextPage = true;
+  while (hasNextPage) {
+    const response = await $fetch(
+      `https://gitlab.com/api/v4/projects/${repoId}/repository/contributors`,
+      {
+        query: {
+          page: String(page),
+          per_page: "100",
+          sort: "desc"
+        },
+        headers: {
+          "PRIVATE-TOKEN": token,
+          "Content-Type": "application/json"
+        }
+      }
+    );
+    if (!response || !response.length)
+      break;
+    allContributors.push(...response);
+    hasNextPage = response.length === 100;
+    page++;
+  }
+  const sponsorships = [];
+  for (const contributor of allContributors) {
+    if (contributor.commits < minContributions)
+      continue;
+    try {
+      const userDetails = await $fetch("https://gitlab.com/api/v4/users", {
+        query: {
+          search: contributor.email
+        },
+        headers: {
+          "PRIVATE-TOKEN": token,
+          "Content-Type": "application/json"
+        }
+      });
+      if (userDetails && userDetails.length > 0) {
+        const user = userDetails[0];
+        sponsorships.push({
+          sponsor: {
+            type: "User",
+            login: user.username,
+            name: user.username,
+            // user.name is also available
+            avatarUrl: user.avatar_url,
+            linkUrl: user.web_url
+          },
+          isOneTime: false,
+          monthlyDollars: contributor.commits,
+          privacyLevel: "PUBLIC",
+          tierName: "Contributor",
+          createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+          provider: "gitlabContributors"
+        });
+      }
+    } catch (error) {
+      console.warn(`Failed to fetch user details for ${contributor.email}:`, error);
+    }
+  }
+  return sponsorships;
+}
+
 const LiberapayProvider = {
   name: "liberapay",
   fetchSponsors(config) {
@@ -1409,7 +1634,10 @@ const ProvidersMap = {
   opencollective: OpenCollectiveProvider,
   afdian: AfdianProvider,
   polar: PolarProvider,
-  liberapay: LiberapayProvider
+  liberapay: LiberapayProvider,
+  githubContributors: GitHubContributorsProvider,
+  gitlabContributors: GitlabContributorsProvider,
+  crowdinContributors: CrowdinContributorsProvider
 };
 function guessProviders(config) {
   const items = [];
@@ -1425,6 +1653,12 @@ function guessProviders(config) {
     items.push("polar");
   if (config.liberapay && config.liberapay.login)
     items.push("liberapay");
+  if (config.githubContributors?.login && config.githubContributors?.token)
+    items.push("githubContributors");
+  if (config.gitlabContributors?.token && config.gitlabContributors?.repoId)
+    items.push("gitlabContributors");
+  if (config.crowdinContributors?.token && config.crowdinContributors?.projectId)
+    items.push("crowdinContributors");
   if (!items.length)
     items.push("github");
   return items;

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "git+https://github.com/LizardByte/contribkit.git"
   },
-  "version": "2025.315.185528",
+  "version": "2025.316.4339",
   "description": "Toolkit for generating contributor images",
   "license": "MIT",
   "funding": "https://app.lizardbyte.dev",
@@ -46,6 +46,7 @@
     "release": "bumpp && pnpm publish"
   },
   "dependencies": {
+    "@crowdin/crowdin-api-client": "^1.41.2",
     "ansis": "^3.17.0",
     "cac": "^6.7.14",
     "consola": "^3.4.0",