feat: add Polar.sh provider (antfu-collective#66)

README.md

@@ -2,7 +2,15 @@
 
 [![NPM version](https://img.shields.io/npm/v/sponsorkit?color=a1b858&label=)](https://www.npmjs.com/package/sponsorkit)
 
-Toolkit for generating sponsors images. Supports **GitHub Sponsors**, **Patreon**, **OpenCollective** and **Afdian**.
+Toolkit for fetching sponsors info and generating sponsors images.
+
+Supports:
+
+- [**GitHub Sponsors**](https://github.com/sponsors)
+- [**Patreon**](https://www.patreon.com/)
+- [**OpenCollective**](https://opencollective.com/)
+- [**Afdian**](https://afdian.net/)
+- [**Polar**](https://polar.sh/)
 
 ## Usage
 
@@ -36,6 +44,10 @@ SPONSORKIT_OPENCOLLECTIVE_TYPE=
 SPONSORKIT_AFDIAN_USER_ID=
 ; Create token at https://afdian.net/dashboard/dev
 SPONSORKIT_AFDIAN_TOKEN=
+
+; Polar provider.
+; Get your token at https://polar.sh/settings
+SPONSORKIT_POLAR_TOKEN=
 ```
 
 > Only one provider is required to be configured.
@@ -70,6 +82,9 @@ export default defineConfig({
   afdian: {
     // ...
   },
+  polar: {
+    // ...
+  },
 
   // Rendering configs
   width: 800,

src/configs/env.ts

@@ -37,6 +37,9 @@ export function loadEnv(): Partial<SponsorkitConfig> {
     mooncell: {
       path: process.env.SPONSORKIT_MOONCELL_PATH || process.env.MOONCELL_PATH,
     },
+    polar: {
+      token: process.env.SPONSORKIT_POLAR_TOKEN || process.env.POLAR_TOKEN,
+    },
     outputDir: process.env.SPONSORKIT_DIR,
   }
 

src/providers/index.ts

@@ -4,6 +4,7 @@ import { GitHubProvider } from './github'
 import { MooncellProvider } from './mooncell'
 import { OpenCollectiveProvider } from './opencollective'
 import { PatreonProvider } from './patreon'
+import { PolarProvider } from './polar'
 
 export * from './github'
 
@@ -12,6 +13,7 @@ export const ProvidersMap = {
   patreon: PatreonProvider,
   opencollective: OpenCollectiveProvider,
   afdian: AfdianProvider,
+  polar: PolarProvider,
   mooncell: MooncellProvider,
 }
 
@@ -29,6 +31,9 @@ export function guessProviders(config: SponsorkitConfig) {
   if (config.afdian && config.afdian.userId && config.afdian.token)
     items.push('afdian')
 
+  if (config.polar && config.polar.token)
+    items.push('polar')
+
   if (config.mooncell && config.mooncell.path)
     items.push('mooncell')
 

src/providers/polar.ts

@@ -0,0 +1,58 @@
+import { ofetch } from 'ofetch'
+import type { Provider, Sponsorship } from '../types'
+
+export const PolarProvider: Provider = {
+  name: 'polar',
+  fetchSponsors(config) {
+    return fetchPolarSponsors(config.polar?.token || config.token!)
+  },
+}
+
+export async function fetchPolarSponsors(token: string): Promise<Sponsorship[]> {
+  if (!token)
+    throw new Error('Polar token is required')
+
+  const apiFetch = ofetch.create({
+    baseURL: 'https://api.polar.sh/api/v1',
+    headers: { Authorization: `Bearer ${token}` },
+  })
+
+  /**
+   * First fetch the list of all subscriptions. This is a paginated
+   * endpoint so loop through all the pages
+   */
+  let page = 1
+  let pages = 1
+  const subscriptions = []
+  do {
+    const subs = await apiFetch('/subscriptions/subscriptions/search', { params: { page } })
+    subscriptions.push(...subs.items)
+
+    pages = subs.pagination.max_page
+    page += 1
+  } while (page <= pages)
+
+  return subscriptions
+    /**
+     * - People can subscribe for free on Polar : the price is null in this case
+     */
+    .filter(sub => !!sub.price)
+    .map((sub) => {
+      const isActive = sub.status === 'active'
+
+      return {
+        sponsor: {
+          name: sub.user.public_name,
+          avatarUrl: sub.user.avatar_url,
+          login: sub.user.github_username,
+          type: sub.subscription_tier.type === 'individual' ? 'User' : 'Organization',
+        },
+        isOneTime: false,
+        provider: 'polar',
+        privacyLevel: 'PUBLIC',
+        createdAt: new Date(sub.created_at).toISOString(),
+        tierName: isActive ? sub.subscription_tier.name : undefined,
+        monthlyDollars: isActive ? sub.sub.price.price_amount / 100 : -1,
+      }
+    })
+}

src/types.ts

@@ -60,7 +60,7 @@ export interface Sponsorship {
 
 export type OutputFormat = 'svg' | 'png' | 'json'
 
-export type ProviderName = 'github' | 'patreon' | 'opencollective' | 'afdian' | 'mooncell'
+export type ProviderName = 'github' | 'patreon' | 'opencollective' | 'afdian' | 'polar' | 'mooncell'
 
 export interface ProvidersConfig {
   github?: {
@@ -166,6 +166,17 @@ export interface ProvidersConfig {
   mooncell?: {
     path?: string
   }
+  polar?: {
+    /**
+     * Polar token that have access to your sponsorships.
+     *
+     * Will read from `SPONSORKIT_POLAR_TOKEN` environment variable if not set.
+     *
+     * @see https://polar.sh/settings
+     * @deprecated It's not recommended set this value directly, pass from env or use `.env` file.
+     */
+    token?: string
+  }
 }
 
 export interface SponsorkitRenderOptions {