@lizardbyte/contribkit 2025.315.185528

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Anthony Fu <https://github.com/antfu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,231 @@
+# ContribKit
+
+[![GitHub stars](https://img.shields.io/github/stars/lizardbyte/contribkit.svg?logo=github&style=for-the-badge)](https://github.com/LizardByte/contribkit)
+[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/lizardbyte/contribkit/ci.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/contribkit/actions/workflows/CI.yml?query=branch%3Amaster)
+[![Codecov](https://img.shields.io/codecov/c/gh/LizardByte/contribkit?token=WBivqQDwFw&style=for-the-badge&logo=codecov&label=codecov)](https://codecov.io/gh/LizardByte/contribkit)
+[![NPM Monthly Downloads](https://img.shields.io/npm/dm/%40lizardbyte%2Fcontribkit?style=for-the-badge&logo=npm&label=npm%20downloads/m)](https://www.npmjs.com/package/@lizardbyte/contribkit)
+[![NPM Version](https://img.shields.io/npm/v/%40lizardbyte%2Fcontribkit?style=for-the-badge&logo=npm&label=npm%20version)](https://www.npmjs.com/package/@lizardbyte/contribkit)
+
+Toolkit for fetching contributor info and generating contributor images.
+This is a fork of [sponsorkit](https://github.com/antfu-collective/sponsorkit) that supports contributors.
+
+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/)
+
+## Usage
+
+Create `.env` file with:
+
+```ini
+; GitHub provider.
+; Token requires the `read:user` and `read:org` scopes.
+CONTRIBKIT_GITHUB_TOKEN=
+CONTRIBKIT_GITHUB_LOGIN=
+
+; Patreon provider.
+; Create v2 API key at https://www.patreon.com/portal/registration/register-clients
+; and use the "Creator’s Access Token".
+CONTRIBKIT_PATREON_TOKEN=
+
+; OpenCollective provider.
+; Create an API key at https://opencollective.com/applications
+CONTRIBKIT_OPENCOLLECTIVE_KEY=
+; and provide the ID, slug or GitHub handle of your account.
+CONTRIBKIT_OPENCOLLECTIVE_ID=
+; or
+CONTRIBKIT_OPENCOLLECTIVE_SLUG=
+; or
+CONTRIBKIT_OPENCOLLECTIVE_GH_HANDLE=
+; If it is a personal account, set it to `person`. Otherwise not set or set to `collective`
+CONTRIBKIT_OPENCOLLECTIVE_TYPE=
+
+; Afdian provider.
+; Get user_id at https://afdian.com/dashboard/dev
+CONTRIBKIT_AFDIAN_USER_ID=
+; Create token at https://afdian.com/dashboard/dev
+CONTRIBKIT_AFDIAN_TOKEN=
+
+; Polar provider.
+; Get your token at https://polar.sh/settings
+CONTRIBKIT_POLAR_TOKEN=
+; The name of the organization to fetch sponsorships from.
+CONTRIBKIT_POLAR_ORGANIZATION=
+
+; Liberapay provider.
+; The name of the profile.
+CONTRIBKIT_LIBERAPAY_LOGIN=
+```
+
+> Only one provider is required to be configured.
+
+Run:
+
+```base
+npx contribkit
+```
+
+[Example Setup](./example/) | [GitHub Actions Setup](https://github.com/antfu/static/blob/master/.github/workflows/scheduler.yml) | [Generated SVG](https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg)
+
+### Configurations
+
+Create `contribkit.config.js` file with:
+
+```ts
+import { defineConfig, tierPresets } from '@lizardbyte/contribkit'
+
+export default defineConfig({
+  // Providers configs
+  github: {
+    login: 'antfu',
+    type: 'user',
+  },
+  opencollective: {
+    // ...
+  },
+  patreon: {
+    // ...
+  },
+  afdian: {
+    // ...
+  },
+  polar: {
+    // ...
+  },
+  liberapay: {
+    // ...
+  },
+
+  // Rendering configs
+  width: 800,
+  renderer: 'tiers', // or 'circles'
+  formats: ['json', 'svg', 'png', 'webp'],
+  tiers: [
+    // Past sponsors, currently only supports GitHub
+    {
+      title: 'Past Sponsors',
+      monthlyDollars: -1,
+      preset: tierPresets.xs,
+    },
+    // Default tier
+    {
+      title: 'Backers',
+      preset: tierPresets.base,
+    },
+    {
+      title: 'Sponsors',
+      monthlyDollars: 10,
+      preset: tierPresets.medium,
+    },
+    {
+      title: 'Silver Sponsors',
+      monthlyDollars: 50,
+      preset: tierPresets.large,
+    },
+    {
+      title: 'Gold Sponsors',
+      monthlyDollars: 100,
+      preset: tierPresets.xl,
+    },
+  ],
+})
+```
+
+Also check [the example](./example/).
+
+### Programmatic Utilities
+
+You can also use ContribKit programmatically:
+
+```ts
+import { fetchSponsors } from '@lizardbyte/contribkit'
+
+const sponsors = await fetchSponsors({
+  github: {
+    token,
+    login,
+  },
+  // ...
+})
+```
+
+Check the type definition or source code for more utils available.
+
+### Renderers
+
+We provide two renderers built-in:
+
+- `tiers`: Render sponsors in tiers.
+- `circles`: Render sponsors in packed circles.
+
+#### Tiers Renderer
+
+```ts
+export default defineConfig({
+  renderer: 'tiers',
+  // ...
+})
+```
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
+  </a>
+</p>
+
+#### Circles Renderer
+
+```ts
+export default defineConfig({
+  renderer: 'circles',
+  // ...
+})
+```
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.circles.svg">
+    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.circles.svg'/>
+  </a>
+</p>
+
+### Multiple Renders
+
+We also support rendering multiple images at once with different configurations, via `renders` field:
+
+```ts
+import { defineConfig, tierPresets } from '@lizardbyte/contribkit'
+
+export default defineConfig({
+  // Providers configs
+  github: { /* ... */ },
+
+  // Default configs
+  width: 800,
+  tiers: [
+    /* ... */
+  ],
+
+  // Define multiple renders, each will inherit the top-level configs
+  renders: [
+    {
+      name: 'sponsors.tiers',
+      formats: ['svg'],
+    },
+    {
+      name: 'sponsors.wide',
+      width: 1200,
+    },
+    {
+      name: 'sponsors.circles',
+      renderer: 'circles',
+      width: 600,
+    },
+    // ...
+  ],
+})
+```

package/bin/contribkit.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.mjs'

package/dist/chunks/index.mjs

@@ -0,0 +1,190 @@
+/*
+How it works:
+`this.#head` is an instance of `Node` which keeps track of its current value and nests another instance of `Node` that keeps the value that comes after it. When a value is provided to `.enqueue()`, the code needs to iterate through `this.#head`, going deeper and deeper to find the last value. However, iterating through every single item is slow. This problem is solved by saving a reference to the last value as `this.#tail` so that it can reference it to add a new value.
+*/
+
+class Node {
+	value;
+	next;
+
+	constructor(value) {
+		this.value = value;
+	}
+}
+
+class Queue {
+	#head;
+	#tail;
+	#size;
+
+	constructor() {
+		this.clear();
+	}
+
+	enqueue(value) {
+		const node = new Node(value);
+
+		if (this.#head) {
+			this.#tail.next = node;
+			this.#tail = node;
+		} else {
+			this.#head = node;
+			this.#tail = node;
+		}
+
+		this.#size++;
+	}
+
+	dequeue() {
+		const current = this.#head;
+		if (!current) {
+			return;
+		}
+
+		this.#head = this.#head.next;
+		this.#size--;
+		return current.value;
+	}
+
+	peek() {
+		if (!this.#head) {
+			return;
+		}
+
+		return this.#head.value;
+
+		// TODO: Node.js 18.
+		// return this.#head?.value;
+	}
+
+	clear() {
+		this.#head = undefined;
+		this.#tail = undefined;
+		this.#size = 0;
+	}
+
+	get size() {
+		return this.#size;
+	}
+
+	* [Symbol.iterator]() {
+		let current = this.#head;
+
+		while (current) {
+			yield current.value;
+			current = current.next;
+		}
+	}
+
+	* drain() {
+		let current;
+		while ((current = this.dequeue()) !== undefined) {
+			yield current;
+		}
+	}
+}
+
+function pLimit(concurrency) {
+	validateConcurrency(concurrency);
+
+	const queue = new Queue();
+	let activeCount = 0;
+
+	const resumeNext = () => {
+		if (activeCount < concurrency && queue.size > 0) {
+			queue.dequeue()();
+			// Since `pendingCount` has been decreased by one, increase `activeCount` by one.
+			activeCount++;
+		}
+	};
+
+	const next = () => {
+		activeCount--;
+
+		resumeNext();
+	};
+
+	const run = async (function_, resolve, arguments_) => {
+		const result = (async () => function_(...arguments_))();
+
+		resolve(result);
+
+		try {
+			await result;
+		} catch {}
+
+		next();
+	};
+
+	const enqueue = (function_, resolve, arguments_) => {
+		// Queue `internalResolve` instead of the `run` function
+		// to preserve asynchronous context.
+		new Promise(internalResolve => {
+			queue.enqueue(internalResolve);
+		}).then(
+			run.bind(undefined, function_, resolve, arguments_),
+		);
+
+		(async () => {
+			// This function needs to wait until the next microtask before comparing
+			// `activeCount` to `concurrency`, because `activeCount` is updated asynchronously
+			// after the `internalResolve` function is dequeued and called. The comparison in the if-statement
+			// needs to happen asynchronously as well to get an up-to-date value for `activeCount`.
+			await Promise.resolve();
+
+			if (activeCount < concurrency) {
+				resumeNext();
+			}
+		})();
+	};
+
+	const generator = (function_, ...arguments_) => new Promise(resolve => {
+		enqueue(function_, resolve, arguments_);
+	});
+
+	Object.defineProperties(generator, {
+		activeCount: {
+			get: () => activeCount,
+		},
+		pendingCount: {
+			get: () => queue.size,
+		},
+		clearQueue: {
+			value() {
+				queue.clear();
+			},
+		},
+		concurrency: {
+			get: () => concurrency,
+
+			set(newConcurrency) {
+				validateConcurrency(newConcurrency);
+				concurrency = newConcurrency;
+
+				queueMicrotask(() => {
+					// eslint-disable-next-line no-unmodified-loop-condition
+					while (activeCount < concurrency && queue.size > 0) {
+						resumeNext();
+					}
+				});
+			},
+		},
+	});
+
+	return generator;
+}
+
+function limitFunction(function_, option) {
+	const {concurrency} = option;
+	const limit = pLimit(concurrency);
+
+	return (...arguments_) => limit(() => function_(...arguments_));
+}
+
+function validateConcurrency(concurrency) {
+	if (!((Number.isInteger(concurrency) || concurrency === Number.POSITIVE_INFINITY) && concurrency > 0)) {
+		throw new TypeError('Expected `concurrency` to be a number from 1 and up');
+	}
+}
+
+export { pLimit as default, limitFunction };