@ewanc26/supporters 0.1.5 → 0.1.7

package/README.md

@@ -2,113 +2,12 @@
 
 SvelteKit component library for displaying Ko-fi supporters, backed by an ATProto PDS.
 
-Ko-fi's webhook pushes payment events to your endpoint. Each event is stored as a record under the `uk.ewancroft.kofi.supporter` lexicon on your PDS, with a TID rkey derived from the transaction timestamp. The component reads those records and renders them.
-
----
-
-## How it works
-
-1. Ko-fi POSTs a webhook event to `/webhook` on each transaction
-2. The handler verifies the `verification_token`, respects `is_public`, and calls `appendEvent`
-3. `appendEvent` writes a record to your PDS under `uk.ewancroft.kofi.supporter`
-4. `readStore` fetches all records and aggregates them into `KofiSupporter` objects
-5. Pass the result to `<KofiSupporters>` or `<LunarContributors>`
-
----
-
-## Setup
-
-### 1. Environment variables
-
-```env
-# Required — copy from ko-fi.com/manage/webhooks → Advanced → Verification Token
-KOFI_VERIFICATION_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-
-# Required — your ATProto identity and a dedicated app password
-ATPROTO_DID=did:plc:yourdidhex
-ATPROTO_PDS_URL=https://your-pds.example.com
-ATPROTO_APP_PASSWORD=xxxx-xxxx-xxxx-xxxx
-```
-
-Generate an app password at your PDS under **Settings → App Passwords**.
-
-### 2. Register the webhook
-
-Go to **ko-fi.com/manage/webhooks** and set your webhook URL to:
-
-```
-https://your-domain.com/webhook
-```
-
-### 3. Add the route
-
-Copy `src/routes/webhook/+server.ts` into your SvelteKit app's routes directory.
-
-### 4. Use the component
-
-```ts
-// +page.server.ts
-import { readStore } from '@ewanc26/supporters';
-
-export const load = async () => ({
-  supporters: await readStore()
-});
-```
-
-```svelte
-<!-- +page.svelte -->
-<script lang="ts">
-  import { KofiSupporters } from '@ewanc26/supporters';
-  let { data } = $props();
-</script>
-
-<KofiSupporters supporters={data.supporters} />
-```
-
----
-
-## Components
-
-### `<KofiSupporters>`
-
-Displays all supporters with emoji type badges (☕ donation, ⭐ subscription, 🎨 commission, 🛍️ shop order).
-
-| Prop | Type | Default |
-|---|---|---|
-| `supporters` | `KofiSupporter[]` | `[]` |
-| `heading` | `string` | `'Supporters'` |
-| `description` | `string` | `'People who support my work on Ko-fi.'` |
-| `filter` | `KofiEventType[]` | `undefined` (show all) |
-| `loading` | `boolean` | `false` |
-| `error` | `string \| null` | `null` |
-
-### `<LunarContributors>`
-
-Convenience wrapper around `<KofiSupporters>` pre-filtered to `Subscription` events.
-
----
-
-## Importing historical data
-
-Export your transaction history from **ko-fi.com/manage/transactions → Export CSV**, then:
-
 ```bash
-ATPROTO_DID=... ATPROTO_PDS_URL=... ATPROTO_APP_PASSWORD=... \
-  node node_modules/@ewanc26/supporters/scripts/import-history.mjs transactions.csv --dry-run
+pnpm add @ewanc26/supporters
 ```
 
----
-
-## Lexicon
+Full documentation at **[docs.ewancroft.uk](https://docs.ewancroft.uk/projects/supporters)**.
 
-Records are stored under `uk.ewancroft.kofi.supporter` (see `lexicons/`). Each record contains:
-
-```ts
-{
-  name: string        // display name from Ko-fi
-  type: string        // "Donation" | "Subscription" | "Commission" | "Shop Order"
-  tier?: string       // subscription tier name, if applicable
-}
-```
+## Licence
 
-rkeys are TIDs derived from the transaction timestamp via [`@ewanc26/tid`](https://npmjs.com/package/@ewanc26/tid).
+See the root [LICENSE](../../LICENSE).

package/dist/events.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Fetches Ko-fi supporter events as a chronological timeline.
+ *
+ * Unlike readStore (which aggregates per-person), this returns every
+ * individual event record ordered most-recent-first.
+ *
+ * No auth required — records are publicly readable.
+ *
+ * @param did  - The ATProto DID to read records from.
+ */
+import type { KofiEventType } from './types.js';
+export type { KofiEventType };
+export interface KofiSupportEvent {
+    rkey: string;
+    name: string;
+    type: KofiEventType;
+    tier?: string;
+    date: Date;
+}
+export declare function fetchEvents(did: string): Promise<KofiSupportEvent[]>;

package/dist/events.js

@@ -0,0 +1,50 @@
+/**
+ * Fetches Ko-fi supporter events as a chronological timeline.
+ *
+ * Unlike readStore (which aggregates per-person), this returns every
+ * individual event record ordered most-recent-first.
+ *
+ * No auth required — records are publicly readable.
+ *
+ * @param did  - The ATProto DID to read records from.
+ */
+import { AtpAgent } from '@atproto/api';
+import { decodeTid } from '@ewanc26/tid';
+const COLLECTION = 'uk.ewancroft.kofi.supporter';
+async function resolvePdsUrl(did) {
+    const res = await fetch(`https://slingshot.microcosm.blue/xrpc/com.bad-example.identity.resolveMiniDoc?identifier=${encodeURIComponent(did)}`);
+    if (!res.ok)
+        throw new Error(`Failed to resolve PDS for ${did}: ${res.status}`);
+    const data = (await res.json());
+    if (!data.pds)
+        throw new Error(`No PDS found in identity document for ${did}`);
+    return data.pds;
+}
+export async function fetchEvents(did) {
+    const pdsUrl = await resolvePdsUrl(did);
+    const agent = new AtpAgent({ service: pdsUrl });
+    const events = [];
+    let cursor;
+    do {
+        const res = await agent.com.atproto.repo.listRecords({
+            repo: did,
+            collection: COLLECTION,
+            limit: 100,
+            cursor
+        });
+        for (const record of res.data.records) {
+            const value = record.value;
+            const rkey = record.uri.split('/').pop() ?? '';
+            let date;
+            try {
+                date = decodeTid(rkey).date;
+            }
+            catch {
+                date = new Date(0);
+            }
+            events.push({ rkey, name: value.name, type: value.type, tier: value.tier, date });
+        }
+        cursor = res.data.cursor;
+    } while (cursor);
+    return events.sort((a, b) => b.date.getTime() - a.date.getTime());
+}

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export { default as KofiSupporters } from './KofiSupporters.svelte';
+export { fetchEvents } from './events.js';
+export type { KofiSupportEvent } from './events.js';
 export { default as LunarContributors } from './LunarContributors.svelte';
 export { readStore, appendEvent } from './store.js';
 export type { KofiEventRecord } from './store.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export { default as KofiSupporters } from './KofiSupporters.svelte';
+export { fetchEvents } from './events.js';
 export { default as LunarContributors } from './LunarContributors.svelte';
 export { readStore, appendEvent } from './store.js';
 export { parseWebhook, WebhookError } from './webhook.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ewanc26/supporters",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "SvelteKit component library for displaying Ko-fi supporters, backed by an ATProto PDS.",
   "author": "Ewan Croft",
   "license": "AGPL-3.0-only",
@@ -32,20 +32,20 @@
     "svelte": "^5.0.0"
   },
   "devDependencies": {
-    "@atproto/api": "^0.18.1",
-    "@sveltejs/adapter-auto": "^7.0.0",
-    "@sveltejs/kit": "^2.50.2",
+    "@atproto/api": "^0.19.3",
+    "@sveltejs/adapter-auto": "^7.0.1",
+    "@sveltejs/kit": "^2.55.0",
     "@sveltejs/package": "^2.5.7",
     "@sveltejs/vite-plugin-svelte": "^6.2.4",
     "@tailwindcss/typography": "^0.5.19",
-    "@tailwindcss/vite": "^4.1.18",
+    "@tailwindcss/vite": "^4.2.1",
     "prettier": "^3.8.1",
-    "prettier-plugin-svelte": "^3.4.1",
+    "prettier-plugin-svelte": "^3.5.1",
     "prettier-plugin-tailwindcss": "^0.7.2",
-    "publint": "^0.3.17",
-    "svelte": "^5.51.0",
-    "svelte-check": "^4.4.2",
-    "tailwindcss": "^4.1.18",
+    "publint": "^0.3.18",
+    "svelte": "^5.53.11",
+    "svelte-check": "^4.4.5",
+    "tailwindcss": "^4.2.1",
     "typescript": "^5.9.3",
     "vite": "^7.3.1"
   },