ewancroft.uk
my pkgs monorepo
feat: add GitHub Sponsors support via ATProto (component, store, webhook)
* add AGPL-3.0 LICENSE to supporters package
* add GitHubSponsors Svelte component with loading/empty/error states
* implement ATProto-backed GitHub Sponsors store (read/append/events)
* define GitHub Sponsors lexicon and types
* add webhook parser with HMAC verification
* export GitHub Sponsors APIs from package
* update README to include GitHub Sponsors support
+1282
-2
+661
packages/supporters/LICENSE
+661
packages/supporters/LICENSE
···
1
+
GNU AFFERO GENERAL PUBLIC LICENSE
2
+
Version 3, 19 November 2007
3
+
4
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+
Everyone is permitted to copy and distribute verbatim copies
6
+
of this license document, but changing it is not allowed.
7
+
8
+
Preamble
9
+
10
+
The GNU Affero General Public License is a free, copyleft license for
11
+
software and other kinds of works, specifically designed to ensure
12
+
cooperation with the community in the case of network server software.
13
+
14
+
The licenses for most software and other practical works are designed
15
+
to take away your freedom to share and change the works. By contrast,
16
+
our General Public Licenses are intended to guarantee your freedom to
17
+
share and change all versions of a program--to make sure it remains free
18
+
software for all its users.
19
+
20
+
When we speak of free software, we are referring to freedom, not
21
+
price. Our General Public Licenses are designed to make sure that you
22
+
have the freedom to distribute copies of free software (and charge for
23
+
them if you wish), that you receive source code or can get it if you
24
+
want it, that you can change the software or use pieces of it in new
25
+
free programs, and that you know you can do these things.
26
+
27
+
Developers that use our General Public Licenses protect your rights
28
+
with two steps: (1) assert copyright on the software, and (2) offer
29
+
you this License which gives you legal permission to copy, distribute
30
+
and/or modify the software.
31
+
32
+
A secondary benefit of defending all users' freedom is that
33
+
improvements made in alternate versions of the program, if they
34
+
receive widespread use, become available for other developers to
35
+
incorporate. Many developers of free software are heartened and
36
+
encouraged by the resulting cooperation. However, in the case of
37
+
software used on network servers, this result may fail to come about.
38
+
The GNU General Public License permits making a modified version and
39
+
letting the public access it on a server without ever releasing its
40
+
source code to the public.
41
+
42
+
The GNU Affero General Public License is designed specifically to
43
+
ensure that, in such cases, the modified source code becomes available
44
+
to the community. It requires the operator of a network server to
45
+
provide the source code of the modified version running there to the
46
+
users of that server. Therefore, public use of a modified version, on
47
+
a publicly accessible server, gives the public access to the source
48
+
code of the modified version.
49
+
50
+
An older license, called the Affero General Public License and
51
+
published by Affero, was designed to accomplish similar goals. This is
52
+
a different license, not a version of the Affero GPL, but Affero has
53
+
released a new version of the Affero GPL which permits relicensing under
54
+
this license.
55
+
56
+
The precise terms and conditions for copying, distribution and
57
+
modification follow.
58
+
59
+
TERMS AND CONDITIONS
60
+
61
+
0. Definitions.
62
+
63
+
"This License" refers to version 3 of the GNU Affero General Public License.
64
+
65
+
"Copyright" also means copyright-like laws that apply to other kinds of
66
+
works, such as semiconductor masks.
67
+
68
+
"The Program" refers to any copyrightable work licensed under this
69
+
License. Each licensee is addressed as "you". "Licensees" and
70
+
"recipients" may be individuals or organizations.
71
+
72
+
To "modify" a work means to copy from or adapt all or part of the work
73
+
in a fashion requiring copyright permission, other than the making of an
74
+
exact copy. The resulting work is called a "modified version" of the
75
+
earlier work or a work "based on" the earlier work.
76
+
77
+
A "covered work" means either the unmodified Program or a work based
78
+
on the Program.
79
+
80
+
To "propagate" a work means to do anything with it that, without
81
+
permission, would make you directly or secondarily liable for
82
+
infringement under applicable copyright law, except executing it on a
83
+
computer or modifying a private copy. Propagation includes copying,
84
+
distribution (with or without modification), making available to the
85
+
public, and in some countries other activities as well.
86
+
87
+
To "convey" a work means any kind of propagation that enables other
88
+
parties to make or receive copies. Mere interaction with a user through
89
+
a computer network, with no transfer of a copy, is not conveying.
90
+
91
+
An interactive user interface displays "Appropriate Legal Notices"
92
+
to the extent that it includes a convenient and prominently visible
93
+
feature that (1) displays an appropriate copyright notice, and (2)
94
+
tells the user that there is no warranty for the work (except to the
95
+
extent that warranties are provided), that licensees may convey the
96
+
work under this License, and how to view a copy of this License. If
97
+
the interface presents a list of user commands or options, such as a
98
+
menu, a prominent item in the list meets this criterion.
99
+
100
+
1. Source Code.
101
+
102
+
The "source code" for a work means the preferred form of the work
103
+
for making modifications to it. "Object code" means any non-source
104
+
form of a work.
105
+
106
+
A "Standard Interface" means an interface that either is an official
107
+
standard defined by a recognized standards body, or, in the case of
108
+
interfaces specified for a particular programming language, one that
109
+
is widely used among developers working in that language.
110
+
111
+
The "System Libraries" of an executable work include anything, other
112
+
than the work as a whole, that (a) is included in the normal form of
113
+
packaging a Major Component, but which is not part of that Major
114
+
Component, and (b) serves only to enable use of the work with that
115
+
Major Component, or to implement a Standard Interface for which an
116
+
implementation is available to the public in source code form. A
117
+
"Major Component", in this context, means a major essential component
118
+
(kernel, window system, and so on) of the specific operating system
119
+
(if any) on which the executable work runs, or a compiler used to
120
+
produce the work, or an object code interpreter used to run it.
121
+
122
+
The "Corresponding Source" for a work in object code form means all
123
+
the source code needed to generate, install, and (for an executable
124
+
work) run the object code and to modify the work, including scripts to
125
+
control those activities. However, it does not include the work's
126
+
System Libraries, or general-purpose tools or generally available free
127
+
programs which are used unmodified in performing those activities but
128
+
which are not part of the work. For example, Corresponding Source
129
+
includes interface definition files associated with source files for
130
+
the work, and the source code for shared libraries and dynamically
131
+
linked subprograms that the work is specifically designed to require,
132
+
such as by intimate data communication or control flow between those
133
+
subprograms and other parts of the work.
134
+
135
+
The Corresponding Source need not include anything that users
136
+
can regenerate automatically from other parts of the Corresponding
137
+
Source.
138
+
139
+
The Corresponding Source for a work in source code form is that
140
+
same work.
141
+
142
+
2. Basic Permissions.
143
+
144
+
All rights granted under this License are granted for the term of
145
+
copyright on the Program, and are irrevocable provided the stated
146
+
conditions are met. This License explicitly affirms your unlimited
147
+
permission to run the unmodified Program. The output from running a
148
+
covered work is covered by this License only if the output, given its
149
+
content, constitutes a covered work. This License acknowledges your
150
+
rights of fair use or other equivalent, as provided by copyright law.
151
+
152
+
You may make, run and propagate covered works that you do not
153
+
convey, without conditions so long as your license otherwise remains
154
+
in force. You may convey covered works to others for the sole purpose
155
+
of having them make modifications exclusively for you, or provide you
156
+
with facilities for running those works, provided that you comply with
157
+
the terms of this License in conveying all material for which you do
158
+
not control copyright. Those thus making or running the covered works
159
+
for you must do so exclusively on your behalf, under your direction
160
+
and control, on terms that prohibit them from making any copies of
161
+
your copyrighted material outside their relationship with you.
162
+
163
+
Conveying under any other circumstances is permitted solely under
164
+
the conditions stated below. Sublicensing is not allowed; section 10
165
+
makes it unnecessary.
166
+
167
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168
+
169
+
No covered work shall be deemed part of an effective technological
170
+
measure under any applicable law fulfilling obligations under article
171
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
172
+
similar laws prohibiting or restricting circumvention of such
173
+
measures.
174
+
175
+
When you convey a covered work, you waive any legal power to forbid
176
+
circumvention of technological measures to the extent such circumvention
177
+
is effected by exercising rights under this License with respect to
178
+
the covered work, and you disclaim any intention to limit operation or
179
+
modification of the work as a means of enforcing, against the work's
180
+
users, your or third parties' legal rights to forbid circumvention of
181
+
technological measures.
182
+
183
+
4. Conveying Verbatim Copies.
184
+
185
+
You may convey verbatim copies of the Program's source code as you
186
+
receive it, in any medium, provided that you conspicuously and
187
+
appropriately publish on each copy an appropriate copyright notice;
188
+
keep intact all notices stating that this License and any
189
+
non-permissive terms added in accord with section 7 apply to the code;
190
+
keep intact all notices of the absence of any warranty; and give all
191
+
recipients a copy of this License along with the Program.
192
+
193
+
You may charge any price or no price for each copy that you convey,
194
+
and you may offer support or warranty protection for a fee.
195
+
196
+
5. Conveying Modified Source Versions.
197
+
198
+
You may convey a work based on the Program, or the modifications to
199
+
produce it from the Program, in the form of source code under the
200
+
terms of section 4, provided that you also meet all of these conditions:
201
+
202
+
a) The work must carry prominent notices stating that you modified
203
+
it, and giving a relevant date.
204
+
205
+
b) The work must carry prominent notices stating that it is
206
+
released under this License and any conditions added under section
207
+
7. This requirement modifies the requirement in section 4 to
208
+
"keep intact all notices".
209
+
210
+
c) You must license the entire work, as a whole, under this
211
+
License to anyone who comes into possession of a copy. This
212
+
License will therefore apply, along with any applicable section 7
213
+
additional terms, to the whole of the work, and all its parts,
214
+
regardless of how they are packaged. This License gives no
215
+
permission to license the work in any other way, but it does not
216
+
invalidate such permission if you have separately received it.
217
+
218
+
d) If the work has interactive user interfaces, each must display
219
+
Appropriate Legal Notices; however, if the Program has interactive
220
+
interfaces that do not display Appropriate Legal Notices, your
221
+
work need not make them do so.
222
+
223
+
A compilation of a covered work with other separate and independent
224
+
works, which are not by their nature extensions of the covered work,
225
+
and which are not combined with it such as to form a larger program,
226
+
in or on a volume of a storage or distribution medium, is called an
227
+
"aggregate" if the compilation and its resulting copyright are not
228
+
used to limit the access or legal rights of the compilation's users
229
+
beyond what the individual works permit. Inclusion of a covered work
230
+
in an aggregate does not cause this License to apply to the other
231
+
parts of the aggregate.
232
+
233
+
6. Conveying Non-Source Forms.
234
+
235
+
You may convey a covered work in object code form under the terms
236
+
of sections 4 and 5, provided that you also convey the
237
+
machine-readable Corresponding Source under the terms of this License,
238
+
in one of these ways:
239
+
240
+
a) Convey the object code in, or embodied in, a physical product
241
+
(including a physical distribution medium), accompanied by the
242
+
Corresponding Source fixed on a durable physical medium
243
+
customarily used for software interchange.
244
+
245
+
b) Convey the object code in, or embodied in, a physical product
246
+
(including a physical distribution medium), accompanied by a
247
+
written offer, valid for at least three years and valid for as
248
+
long as you offer spare parts or customer support for that product
249
+
model, to give anyone who possesses the object code either (1) a
250
+
copy of the Corresponding Source for all the software in the
251
+
product that is covered by this License, on a durable physical
252
+
medium customarily used for software interchange, for a price no
253
+
more than your reasonable cost of physically performing this
254
+
conveying of source, or (2) access to copy the
255
+
Corresponding Source from a network server at no charge.
256
+
257
+
c) Convey individual copies of the object code with a copy of the
258
+
written offer to provide the Corresponding Source. This
259
+
alternative is allowed only occasionally and noncommercially, and
260
+
only if you received the object code with such an offer, in accord
261
+
with subsection 6b.
262
+
263
+
d) Convey the object code by offering access from a designated
264
+
place (gratis or for a charge), and offer equivalent access to the
265
+
Corresponding Source in the same way through the same place at no
266
+
further charge. You need not require recipients to copy the
267
+
Corresponding Source along with the object code. If the place to
268
+
copy the object code is a network server, the Corresponding Source
269
+
may be on a different server (operated by you or a third party)
270
+
that supports equivalent copying facilities, provided you maintain
271
+
clear directions next to the object code saying where to find the
272
+
Corresponding Source. Regardless of what server hosts the
273
+
Corresponding Source, you remain obligated to ensure that it is
274
+
available for as long as needed to satisfy these requirements.
275
+
276
+
e) Convey the object code using peer-to-peer transmission, provided
277
+
you inform other peers where the object code and Corresponding
278
+
Source of the work are being offered to the general public at no
279
+
charge under subsection 6d.
280
+
281
+
A separable portion of the object code, whose source code is excluded
282
+
from the Corresponding Source as a System Library, need not be
283
+
included in conveying the object code work.
284
+
285
+
A "User Product" is either (1) a "consumer product", which means any
286
+
tangible personal property which is normally used for personal, family,
287
+
or household purposes, or (2) anything designed or sold for incorporation
288
+
into a dwelling. In determining whether a product is a consumer product,
289
+
doubtful cases shall be resolved in favor of coverage. For a particular
290
+
product received by a particular user, "normally used" refers to a
291
+
typical or common use of that class of product, regardless of the status
292
+
of the particular user or of the way in which the particular user
293
+
actually uses, or expects or is expected to use, the product. A product
294
+
is a consumer product regardless of whether the product has substantial
295
+
commercial, industrial or non-consumer uses, unless such uses represent
296
+
the only significant mode of use of the product.
297
+
298
+
"Installation Information" for a User Product means any methods,
299
+
procedures, authorization keys, or other information required to install
300
+
and execute modified versions of a covered work in that User Product from
301
+
a modified version of its Corresponding Source. The information must
302
+
suffice to ensure that the continued functioning of the modified object
303
+
code is in no case prevented or interfered with solely because
304
+
modification has been made.
305
+
306
+
If you convey an object code work under this section in, or with, or
307
+
specifically for use in, a User Product, and the conveying occurs as
308
+
part of a transaction in which the right of possession and use of the
309
+
User Product is transferred to the recipient in perpetuity or for a
310
+
fixed term (regardless of how the transaction is characterized), the
311
+
Corresponding Source conveyed under this section must be accompanied
312
+
by the Installation Information. But this requirement does not apply
313
+
if neither you nor any third party retains the ability to install
314
+
modified object code on the User Product (for example, the work has
315
+
been installed in ROM).
316
+
317
+
The requirement to provide Installation Information does not include a
318
+
requirement to continue to provide support service, warranty, or updates
319
+
for a work that has been modified or installed by the recipient, or for
320
+
the User Product in which it has been modified or installed. Access to a
321
+
network may be denied when the modification itself materially and
322
+
adversely affects the operation of the network or violates the rules and
323
+
protocols for communication across the network.
324
+
325
+
Corresponding Source conveyed, and Installation Information provided,
326
+
in accord with this section must be in a format that is publicly
327
+
documented (and with an implementation available to the public in
328
+
source code form), and must require no special password or key for
329
+
unpacking, reading or copying.
330
+
331
+
7. Additional Terms.
332
+
333
+
"Additional permissions" are terms that supplement the terms of this
334
+
License by making exceptions from one or more of its conditions.
335
+
Additional permissions that are applicable to the entire Program shall
336
+
be treated as though they were included in this License, to the extent
337
+
that they are valid under applicable law. If additional permissions
338
+
apply only to part of the Program, that part may be used separately
339
+
under those permissions, but the entire Program remains governed by
340
+
this License without regard to the additional permissions.
341
+
342
+
When you convey a copy of a covered work, you may at your option
343
+
remove any additional permissions from that copy, or from any part of
344
+
it. (Additional permissions may be written to require their own
345
+
removal in certain cases when you modify the work.) You may place
346
+
additional permissions on material, added by you to a covered work,
347
+
for which you have or can give appropriate copyright permission.
348
+
349
+
Notwithstanding any other provision of this License, for material you
350
+
add to a covered work, you may (if authorized by the copyright holders of
351
+
that material) supplement the terms of this License with terms:
352
+
353
+
a) Disclaiming warranty or limiting liability differently from the
354
+
terms of sections 15 and 16 of this License; or
355
+
356
+
b) Requiring preservation of specified reasonable legal notices or
357
+
author attributions in that material or in the Appropriate Legal
358
+
Notices displayed by works containing it; or
359
+
360
+
c) Prohibiting misrepresentation of the origin of that material, or
361
+
requiring that modified versions of such material be marked in
362
+
reasonable ways as different from the original version; or
363
+
364
+
d) Limiting the use for publicity purposes of names of licensors or
365
+
authors of the material; or
366
+
367
+
e) Declining to grant rights under trademark law for use of some
368
+
trade names, trademarks, or service marks; or
369
+
370
+
f) Requiring indemnification of licensors and authors of that
371
+
material by anyone who conveys the material (or modified versions of
372
+
it) with contractual assumptions of liability to the recipient, for
373
+
any liability that these contractual assumptions directly impose on
374
+
those licensors and authors.
375
+
376
+
All other non-permissive additional terms are considered "further
377
+
restrictions" within the meaning of section 10. If the Program as you
378
+
received it, or any part of it, contains a notice stating that it is
379
+
governed by this License along with a term that is a further
380
+
restriction, you may remove that term. If a license document contains
381
+
a further restriction but permits relicensing or conveying under this
382
+
License, you may add to a covered work material governed by the terms
383
+
of that license document, provided that the further restriction does
384
+
not survive such relicensing or conveying.
385
+
386
+
If you add terms to a covered work in accord with this section, you
387
+
must place, in the relevant source files, a statement of the
388
+
additional terms that apply to those files, or a notice indicating
389
+
where to find the applicable terms.
390
+
391
+
Additional terms, permissive or non-permissive, may be stated in the
392
+
form of a separately written license, or stated as exceptions;
393
+
the above requirements apply either way.
394
+
395
+
8. Termination.
396
+
397
+
You may not propagate or modify a covered work except as expressly
398
+
provided under this License. Any attempt otherwise to propagate or
399
+
modify it is void, and will automatically terminate your rights under
400
+
this License (including any patent licenses granted under the third
401
+
paragraph of section 11).
402
+
403
+
However, if you cease all violation of this License, then your
404
+
license from a particular copyright holder is reinstated (a)
405
+
provisionally, unless and until the copyright holder explicitly and
406
+
finally terminates your license, and (b) permanently, if the copyright
407
+
holder fails to notify you of the violation by some reasonable means
408
+
prior to 60 days after the cessation.
409
+
410
+
Moreover, your license from a particular copyright holder is
411
+
reinstated permanently if the copyright holder notifies you of the
412
+
violation by some reasonable means, this is the first time you have
413
+
received notice of violation of this License (for any work) from that
414
+
copyright holder, and you cure the violation prior to 30 days after
415
+
your receipt of the notice.
416
+
417
+
Termination of your rights under this section does not terminate the
418
+
licenses of parties who have received copies or rights from you under
419
+
this License. If your rights have been terminated and not permanently
420
+
reinstated, you do not qualify to receive new licenses for the same
421
+
material under section 10.
422
+
423
+
9. Acceptance Not Required for Having Copies.
424
+
425
+
You are not required to accept this License in order to receive or
426
+
run a copy of the Program. Ancillary propagation of a covered work
427
+
occurring solely as a consequence of using peer-to-peer transmission
428
+
to receive a copy likewise does not require acceptance. However,
429
+
nothing other than this License grants you permission to propagate or
430
+
modify any covered work. These actions infringe copyright if you do
431
+
not accept this License. Therefore, by modifying or propagating a
432
+
covered work, you indicate your acceptance of this License to do so.
433
+
434
+
10. Automatic Licensing of Downstream Recipients.
435
+
436
+
Each time you convey a covered work, the recipient automatically
437
+
receives a license from the original licensors, to run, modify and
438
+
propagate that work, subject to this License. You are not responsible
439
+
for enforcing compliance by third parties with this License.
440
+
441
+
An "entity transaction" is a transaction transferring control of an
442
+
organization, or substantially all assets of one, or subdividing an
443
+
organization, or merging organizations. If propagation of a covered
444
+
work results from an entity transaction, each party to that
445
+
transaction who receives a copy of the work also receives whatever
446
+
licenses to the work the party's predecessor in interest had or could
447
+
give under the previous paragraph, plus a right to possession of the
448
+
Corresponding Source of the work from the predecessor in interest, if
449
+
the predecessor has it or can get it with reasonable efforts.
450
+
451
+
You may not impose any further restrictions on the exercise of the
452
+
rights granted or affirmed under this License. For example, you may
453
+
not impose a license fee, royalty, or other charge for exercise of
454
+
rights granted under this License, and you may not initiate litigation
455
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
456
+
any patent claim is infringed by making, using, selling, offering for
457
+
sale, or importing the Program or any portion of it.
458
+
459
+
11. Patents.
460
+
461
+
A "contributor" is a copyright holder who authorizes use under this
462
+
License of the Program or a work on which the Program is based. The
463
+
work thus licensed is called the contributor's "contributor version".
464
+
465
+
A contributor's "essential patent claims" are all patent claims
466
+
owned or controlled by the contributor, whether already acquired or
467
+
hereafter acquired, that would be infringed by some manner, permitted
468
+
by this License, of making, using, or selling its contributor version,
469
+
but do not include claims that would be infringed only as a
470
+
consequence of further modification of the contributor version. For
471
+
purposes of this definition, "control" includes the right to grant
472
+
patent sublicenses in a manner consistent with the requirements of
473
+
this License.
474
+
475
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
476
+
patent license under the contributor's essential patent claims, to
477
+
make, use, sell, offer for sale, import and otherwise run, modify and
478
+
propagate the contents of its contributor version.
479
+
480
+
In the following three paragraphs, a "patent license" is any express
481
+
agreement or commitment, however denominated, not to enforce a patent
482
+
(such as an express permission to practice a patent or covenant not to
483
+
sue for patent infringement). To "grant" such a patent license to a
484
+
party means to make such an agreement or commitment not to enforce a
485
+
patent against the party.
486
+
487
+
If you convey a covered work, knowingly relying on a patent license,
488
+
and the Corresponding Source of the work is not available for anyone
489
+
to copy, free of charge and under the terms of this License, through a
490
+
publicly available network server or other readily accessible means,
491
+
then you must either (1) cause the Corresponding Source to be so
492
+
available, or (2) arrange to deprive yourself of the benefit of the
493
+
patent license for this particular work, or (3) arrange, in a manner
494
+
consistent with the requirements of this License, to extend the patent
495
+
license to downstream recipients. "Knowingly relying" means you have
496
+
actual knowledge that, but for the patent license, your conveying the
497
+
covered work in a country, or your recipient's use of the covered work
498
+
in a country, would infringe one or more identifiable patents in that
499
+
country that you have reason to believe are valid.
500
+
501
+
If, pursuant to or in connection with a single transaction or
502
+
arrangement, you convey, or propagate by procuring conveyance of, a
503
+
covered work, and grant a patent license to some of the parties
504
+
receiving the covered work authorizing them to use, propagate, modify
505
+
or convey a specific copy of the covered work, then the patent license
506
+
you grant is automatically extended to all recipients of the covered
507
+
work and works based on it.
508
+
509
+
A patent license is "discriminatory" if it does not include within
510
+
the scope of its coverage, prohibits the exercise of, or is
511
+
conditioned on the non-exercise of one or more of the rights that are
512
+
specifically granted under this License. You may not convey a covered
513
+
work if you are a party to an arrangement with a third party that is
514
+
in the business of distributing software, under which you make payment
515
+
to the third party based on the extent of your activity of conveying
516
+
the work, and under which the third party grants, to any of the
517
+
parties who would receive the covered work from you, a discriminatory
518
+
patent license (a) in connection with copies of the covered work
519
+
conveyed by you (or copies made from those copies), or (b) primarily
520
+
for and in connection with specific products or compilations that
521
+
contain the covered work, unless you entered into that arrangement,
522
+
or that patent license was granted, prior to 28 March 2007.
523
+
524
+
Nothing in this License shall be construed as excluding or limiting
525
+
any implied license or other defenses to infringement that may
526
+
otherwise be available to you under applicable patent law.
527
+
528
+
12. No Surrender of Others' Freedom.
529
+
530
+
If conditions are imposed on you (whether by court order, agreement or
531
+
otherwise) that contradict the conditions of this License, they do not
532
+
excuse you from the conditions of this License. If you cannot convey a
533
+
covered work so as to satisfy simultaneously your obligations under this
534
+
License and any other pertinent obligations, then as a consequence you may
535
+
not convey it at all. For example, if you agree to terms that obligate you
536
+
to collect a royalty for further conveying from those to whom you convey
537
+
the Program, the only way you could satisfy both those terms and this
538
+
License would be to refrain entirely from conveying the Program.
539
+
540
+
13. Remote Network Interaction; Use with the GNU General Public License.
541
+
542
+
Notwithstanding any other provision of this License, if you modify the
543
+
Program, your modified version must prominently offer all users
544
+
interacting with it remotely through a computer network (if your version
545
+
supports such interaction) an opportunity to receive the Corresponding
546
+
Source of your version by providing access to the Corresponding Source
547
+
from a network server at no charge, through some standard or customary
548
+
means of facilitating copying of software. This Corresponding Source
549
+
shall include the Corresponding Source for any work covered by version 3
550
+
of the GNU General Public License that is incorporated pursuant to the
551
+
following paragraph.
552
+
553
+
Notwithstanding any other provision of this License, you have
554
+
permission to link or combine any covered work with a work licensed
555
+
under version 3 of the GNU General Public License into a single
556
+
combined work, and to convey the resulting work. The terms of this
557
+
License will continue to apply to the part which is the covered work,
558
+
but the work with which it is combined will remain governed by version
559
+
3 of the GNU General Public License.
560
+
561
+
14. Revised Versions of this License.
562
+
563
+
The Free Software Foundation may publish revised and/or new versions of
564
+
the GNU Affero General Public License from time to time. Such new versions
565
+
will be similar in spirit to the present version, but may differ in detail to
566
+
address new problems or concerns.
567
+
568
+
Each version is given a distinguishing version number. If the
569
+
Program specifies that a certain numbered version of the GNU Affero General
570
+
Public License "or any later version" applies to it, you have the
571
+
option of following the terms and conditions either of that numbered
572
+
version or of any later version published by the Free Software
573
+
Foundation. If the Program does not specify a version number of the
574
+
GNU Affero General Public License, you may choose any version ever published
575
+
by the Free Software Foundation.
576
+
577
+
If the Program specifies that a proxy can decide which future
578
+
versions of the GNU Affero General Public License can be used, that proxy's
579
+
public statement of acceptance of a version permanently authorizes you
580
+
to choose that version for the Program.
581
+
582
+
Later license versions may give you additional or different
583
+
permissions. However, no additional obligations are imposed on any
584
+
author or copyright holder as a result of your choosing to follow a
585
+
later version.
586
+
587
+
15. Disclaimer of Warranty.
588
+
589
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597
+
598
+
16. Limitation of Liability.
599
+
600
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608
+
SUCH DAMAGES.
609
+
610
+
17. Interpretation of Sections 15 and 16.
611
+
612
+
If the disclaimer of warranty and limitation of liability provided
613
+
above cannot be given local legal effect according to their terms,
614
+
reviewing courts shall apply local law that most closely approximates
615
+
an absolute waiver of all civil liability in connection with the
616
+
Program, unless a warranty or assumption of liability accompanies a
617
+
copy of the Program in return for a fee.
618
+
619
+
END OF TERMS AND CONDITIONS
620
+
621
+
How to Apply These Terms to Your New Programs
622
+
623
+
If you develop a new program, and you want it to be of the greatest
624
+
possible use to the public, the best way to achieve this is to make it
625
+
free software which everyone can redistribute and change under these terms.
626
+
627
+
To do so, attach the following notices to the program. It is safest
628
+
to attach them to the start of each source file to most effectively
629
+
state the exclusion of warranty; and each file should have at least
630
+
the "copyright" line and a pointer to where the full notice is found.
631
+
632
+
<one line to give the program's name and a brief idea of what it does.>
633
+
Copyright (C) <year> <name of author>
634
+
635
+
This program is free software: you can redistribute it and/or modify
636
+
it under the terms of the GNU Affero General Public License as published
637
+
by the Free Software Foundation, either version 3 of the License, or
638
+
(at your option) any later version.
639
+
640
+
This program is distributed in the hope that it will be useful,
641
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
642
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643
+
GNU Affero General Public License for more details.
644
+
645
+
You should have received a copy of the GNU Affero General Public License
646
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
647
+
648
+
Also add information on how to contact you by electronic and paper mail.
649
+
650
+
If your software can interact with users remotely through a computer
651
+
network, you should also make sure that it provides a way for users to
652
+
get its source. For example, if your program is a web application, its
653
+
interface could display a "Source" link that leads users to an archive
654
+
of the code. There are many ways you could offer source, and different
655
+
solutions will be better for different programs; see section 13 for the
656
+
specific requirements.
657
+
658
+
You should also get your employer (if you work as a programmer) or school,
659
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
660
+
For more information on this, and how to apply and follow the GNU AGPL, see
661
+
<https://www.gnu.org/licenses/>.
+2
-2
packages/supporters/README.md
+2
-2
packages/supporters/README.md
···
1
1
# @ewanc26/supporters
2
2
3
-
SvelteKit component library for displaying Ko-fi supporters, backed by an ATProto PDS.
3
+
SvelteKit component library for displaying Ko-fi supporters and GitHub Sponsors, backed by an ATProto PDS.
4
4
5
5
```bash
6
6
pnpm add @ewanc26/supporters
···
10
10
11
11
## Licence
12
12
13
-
See the root [LICENSE](../../LICENSE).
13
+
See the root [LICENSE](LICENSE).
+37
packages/supporters/lexicons/uk/ewancroft/github/sponsor.json
+37
packages/supporters/lexicons/uk/ewancroft/github/sponsor.json
···
1
+
{
2
+
"lexicon": 1,
3
+
"id": "uk.ewancroft.github.sponsor",
4
+
"defs": {
5
+
"main": {
6
+
"type": "record",
7
+
"description": "A single GitHub Sponsors event. One record per event, rkey is a TID.",
8
+
"key": "tid",
9
+
"record": {
10
+
"type": "object",
11
+
"required": ["login", "action", "tierName", "monthlyUsd"],
12
+
"properties": {
13
+
"login": {
14
+
"type": "string",
15
+
"description": "GitHub username of the sponsor."
16
+
},
17
+
"name": {
18
+
"type": "string",
19
+
"description": "Display name of the sponsor, if known."
20
+
},
21
+
"action": {
22
+
"type": "string",
23
+
"description": "Sponsorship action: created, cancelled, edited, tier_changed, pending_cancellation, or pending_tier_change."
24
+
},
25
+
"tierName": {
26
+
"type": "string",
27
+
"description": "Name of the sponsorship tier at the time of this event."
28
+
},
29
+
"monthlyUsd": {
30
+
"type": "integer",
31
+
"description": "Monthly sponsorship amount in USD at the time of this event."
32
+
}
33
+
}
34
+
}
35
+
}
36
+
}
37
+
}
+199
packages/supporters/src/lib/GitHubSponsors.svelte
+199
packages/supporters/src/lib/GitHubSponsors.svelte
···
1
+
<script lang="ts">
2
+
import type { GitHubSponsorsProps } from './github-types.js';
3
+
4
+
let {
5
+
sponsors = [],
6
+
heading = 'GitHub Sponsors',
7
+
description = 'People who sponsor my work on GitHub.',
8
+
activeOnly = true,
9
+
loading = false,
10
+
error = null
11
+
}: GitHubSponsorsProps = $props();
12
+
13
+
let visible = $derived(activeOnly ? sponsors.filter((s) => s.isActive) : sponsors);
14
+
15
+
/** Deterministic pastel colour from a login string. */
16
+
function loginToHsl(login: string): string {
17
+
let hash = 0;
18
+
for (let i = 0; i < login.length; i++) hash = login.charCodeAt(i) + ((hash << 5) - hash);
19
+
const h = Math.abs(hash) % 360;
20
+
return `hsl(${h} 55% 70%)`;
21
+
}
22
+
23
+
function initials(name: string): string {
24
+
return name
25
+
.split(/\s+/)
26
+
.slice(0, 2)
27
+
.map((w) => w[0]?.toUpperCase() ?? '')
28
+
.join('');
29
+
}
30
+
</script>
31
+
32
+
<section class="gh-sponsors" aria-label={heading}>
33
+
<header class="gh-sponsors__header">
34
+
<h2 class="gh-sponsors__heading">{heading}</h2>
35
+
{#if description}
36
+
<p class="gh-sponsors__description">{description}</p>
37
+
{/if}
38
+
</header>
39
+
40
+
{#if loading}
41
+
<ul class="gh-sponsors__grid" aria-busy="true" aria-label="Loading sponsors">
42
+
{#each { length: 6 } as _}
43
+
<li class="gh-sponsors__item gh-sponsors__item--skeleton" aria-hidden="true">
44
+
<span class="gh-sponsors__avatar gh-sponsors__avatar--skeleton"></span>
45
+
<span class="gh-sponsors__name gh-sponsors__name--skeleton"></span>
46
+
</li>
47
+
{/each}
48
+
</ul>
49
+
{:else if error}
50
+
<p class="gh-sponsors__error" role="alert">{error}</p>
51
+
{:else if visible.length === 0}
52
+
<p class="gh-sponsors__empty">No sponsors yet — be the first!</p>
53
+
{:else}
54
+
<ul class="gh-sponsors__grid">
55
+
{#each visible as sponsor (sponsor.login)}
56
+
<li class="gh-sponsors__item">
57
+
<a
58
+
class="gh-sponsors__card"
59
+
href="https://github.com/{sponsor.login}"
60
+
target="_blank"
61
+
rel="noopener noreferrer"
62
+
title="{sponsor.name ?? sponsor.login} · {sponsor.tierName}"
63
+
>
64
+
<span
65
+
class="gh-sponsors__avatar"
66
+
style="background-color: {loginToHsl(sponsor.login)}"
67
+
aria-hidden="true"
68
+
>
69
+
{initials(sponsor.name ?? sponsor.login)}
70
+
</span>
71
+
<span class="gh-sponsors__name">{sponsor.name ?? sponsor.login}</span>
72
+
<span class="gh-sponsors__tier" aria-label="Tier: {sponsor.tierName}">{sponsor.tierName}</span>
73
+
</a>
74
+
</li>
75
+
{/each}
76
+
</ul>
77
+
{/if}
78
+
</section>
79
+
80
+
<style>
81
+
.gh-sponsors {
82
+
container-type: inline-size;
83
+
}
84
+
85
+
.gh-sponsors__header {
86
+
margin-block-end: 1rem;
87
+
}
88
+
89
+
.gh-sponsors__heading {
90
+
font-size: 1.25rem;
91
+
font-weight: 700;
92
+
margin: 0;
93
+
}
94
+
95
+
.gh-sponsors__description {
96
+
margin-block-start: 0.25rem;
97
+
font-size: 0.875rem;
98
+
opacity: 0.75;
99
+
}
100
+
101
+
.gh-sponsors__grid {
102
+
display: flex;
103
+
flex-wrap: wrap;
104
+
gap: 0.75rem;
105
+
list-style: none;
106
+
margin: 0;
107
+
padding: 0;
108
+
}
109
+
110
+
.gh-sponsors__card {
111
+
display: flex;
112
+
flex-direction: column;
113
+
align-items: center;
114
+
gap: 0.25rem;
115
+
padding: 0.5rem;
116
+
border-radius: 0.5rem;
117
+
text-decoration: none;
118
+
color: inherit;
119
+
}
120
+
121
+
.gh-sponsors__card:hover .gh-sponsors__avatar {
122
+
outline: 2px solid currentColor;
123
+
outline-offset: 2px;
124
+
}
125
+
126
+
.gh-sponsors__avatar {
127
+
width: 3rem;
128
+
height: 3rem;
129
+
border-radius: 50%;
130
+
display: flex;
131
+
align-items: center;
132
+
justify-content: center;
133
+
font-size: 1rem;
134
+
font-weight: 700;
135
+
color: #fff;
136
+
flex-shrink: 0;
137
+
}
138
+
139
+
.gh-sponsors__name {
140
+
font-size: 0.75rem;
141
+
text-align: center;
142
+
max-width: 5rem;
143
+
overflow: hidden;
144
+
text-overflow: ellipsis;
145
+
white-space: nowrap;
146
+
}
147
+
148
+
.gh-sponsors__tier {
149
+
font-size: 0.6rem;
150
+
opacity: 0.65;
151
+
text-align: center;
152
+
max-width: 5rem;
153
+
overflow: hidden;
154
+
text-overflow: ellipsis;
155
+
white-space: nowrap;
156
+
}
157
+
158
+
/* Skeletons */
159
+
.gh-sponsors__item--skeleton {
160
+
display: flex;
161
+
flex-direction: column;
162
+
align-items: center;
163
+
gap: 0.375rem;
164
+
padding: 0.5rem;
165
+
}
166
+
167
+
.gh-sponsors__avatar--skeleton {
168
+
display: block;
169
+
width: 3rem;
170
+
height: 3rem;
171
+
border-radius: 50%;
172
+
background-color: color-mix(in srgb, currentColor 15%, transparent);
173
+
animation: ghs-pulse 1.4s ease-in-out infinite;
174
+
}
175
+
176
+
.gh-sponsors__name--skeleton {
177
+
display: block;
178
+
width: 4rem;
179
+
height: 0.75rem;
180
+
border-radius: 0.25rem;
181
+
background-color: color-mix(in srgb, currentColor 15%, transparent);
182
+
animation: ghs-pulse 1.4s ease-in-out 200ms infinite;
183
+
}
184
+
185
+
@keyframes ghs-pulse {
186
+
0%, 100% { opacity: 1; }
187
+
50% { opacity: 0.4; }
188
+
}
189
+
190
+
.gh-sponsors__error,
191
+
.gh-sponsors__empty {
192
+
font-size: 0.875rem;
193
+
opacity: 0.75;
194
+
}
195
+
196
+
.gh-sponsors__error {
197
+
color: #c0392b;
198
+
}
199
+
</style>
+206
packages/supporters/src/lib/github-store.ts
+206
packages/supporters/src/lib/github-store.ts
···
1
+
/**
2
+
* ATProto PDS store for GitHub Sponsors data.
3
+
*
4
+
* Each sponsorship event is stored as a separate record under:
5
+
* uk.ewancroft.github.sponsor
6
+
*
7
+
* rkeys are TIDs generated by @ewanc26/tid — one record per event.
8
+
* The aggregated GitHubSponsor view is built at read time by replaying
9
+
* events in chronological order per sponsor.
10
+
*
11
+
* Reads are public (no auth). Writes use an app password.
12
+
*
13
+
* Required environment variables:
14
+
* ATPROTO_DID — your DID, e.g. did:plc:abc123
15
+
* ATPROTO_APP_PASSWORD — an app password from your PDS settings
16
+
*/
17
+
18
+
import { AtpAgent } from '@atproto/api';
19
+
import { generateTID, decodeTid } from '@ewanc26/tid';
20
+
import type { GitHubSponsor, GitHubSponsorshipAction } from './github-types.js';
21
+
22
+
const COLLECTION = 'uk.ewancroft.github.sponsor';
23
+
24
+
const ACTIVE_ACTIONS: GitHubSponsorshipAction[] = ['created', 'tier_changed'];
25
+
const INACTIVE_ACTIONS: GitHubSponsorshipAction[] = ['cancelled'];
26
+
27
+
/** The shape of a raw record stored in the PDS. */
28
+
export interface GitHubSponsorEventRecord {
29
+
login: string;
30
+
name?: string;
31
+
action: GitHubSponsorshipAction;
32
+
tierName: string;
33
+
monthlyUsd: number;
34
+
}
35
+
36
+
/** A single sponsor event as returned by fetchSponsorEvents. */
37
+
export interface GitHubSponsorEvent {
38
+
rkey: string;
39
+
login: string;
40
+
name?: string;
41
+
action: GitHubSponsorshipAction;
42
+
tierName: string;
43
+
monthlyUsd: number;
44
+
date: Date;
45
+
}
46
+
47
+
function requireEnv(key: string): string {
48
+
const val = process.env[key];
49
+
if (!val) throw new Error(`Missing required environment variable: ${key}`);
50
+
return val;
51
+
}
52
+
53
+
async function resolvePdsUrl(did: string): Promise<string> {
54
+
const res = await fetch(
55
+
`https://slingshot.microcosm.blue/xrpc/com.bad-example.identity.resolveMiniDoc?identifier=${encodeURIComponent(did)}`
56
+
);
57
+
if (!res.ok) throw new Error(`Failed to resolve PDS for ${did}: ${res.status}`);
58
+
const data = (await res.json()) as { pds?: string };
59
+
if (!data.pds) throw new Error(`No PDS found in identity document for ${did}`);
60
+
return data.pds;
61
+
}
62
+
63
+
async function authedAgent(): Promise<{ agent: AtpAgent; did: string }> {
64
+
const did = requireEnv('ATPROTO_DID');
65
+
const password = requireEnv('ATPROTO_APP_PASSWORD');
66
+
const pdsUrl = await resolvePdsUrl(did);
67
+
const agent = new AtpAgent({ service: pdsUrl });
68
+
await agent.login({ identifier: did, password });
69
+
return { agent, did };
70
+
}
71
+
72
+
/**
73
+
* Fetch all GitHub sponsor events as a chronological timeline.
74
+
* Mirrors fetchEvents() from events.ts — returns one entry per PDS record,
75
+
* sorted most-recent-first.
76
+
* No auth required — collection is publicly readable.
77
+
*/
78
+
export async function fetchSponsorEvents(did: string): Promise<GitHubSponsorEvent[]> {
79
+
const pdsUrl = await resolvePdsUrl(did);
80
+
const agent = new AtpAgent({ service: pdsUrl });
81
+
82
+
const events: GitHubSponsorEvent[] = [];
83
+
let cursor: string | undefined;
84
+
85
+
do {
86
+
const res = await agent.com.atproto.repo.listRecords({
87
+
repo: did,
88
+
collection: COLLECTION,
89
+
limit: 100,
90
+
cursor
91
+
});
92
+
93
+
for (const record of res.data.records) {
94
+
const value = record.value as GitHubSponsorEventRecord;
95
+
const rkey = record.uri.split('/').pop() ?? '';
96
+
let date: Date;
97
+
try {
98
+
date = decodeTid(rkey).date;
99
+
} catch {
100
+
date = new Date(0);
101
+
}
102
+
events.push({
103
+
rkey,
104
+
login: value.login,
105
+
name: value.name,
106
+
action: value.action,
107
+
tierName: value.tierName,
108
+
monthlyUsd: value.monthlyUsd,
109
+
date
110
+
});
111
+
}
112
+
113
+
cursor = res.data.cursor;
114
+
} while (cursor);
115
+
116
+
return events.sort((a, b) => b.date.getTime() - a.date.getTime());
117
+
}
118
+
119
+
/**
120
+
* Read all sponsor event records from the PDS and aggregate into GitHubSponsor objects.
121
+
* Events are replayed in rkey (TID) order so the last-known state wins per sponsor.
122
+
* No auth required — collection is publicly readable.
123
+
*/
124
+
export async function readSponsors(): Promise<GitHubSponsor[]> {
125
+
const did = requireEnv('ATPROTO_DID');
126
+
const pdsUrl = await resolvePdsUrl(did);
127
+
const agent = new AtpAgent({ service: pdsUrl });
128
+
129
+
const events: Array<{ rkey: string; record: GitHubSponsorEventRecord }> = [];
130
+
let cursor: string | undefined;
131
+
132
+
do {
133
+
const res = await agent.com.atproto.repo.listRecords({
134
+
repo: did,
135
+
collection: COLLECTION,
136
+
limit: 100,
137
+
cursor
138
+
});
139
+
140
+
for (const record of res.data.records) {
141
+
const rkey = record.uri.split('/').pop() ?? '';
142
+
events.push({ rkey, record: record.value as unknown as GitHubSponsorEventRecord });
143
+
}
144
+
145
+
cursor = res.data.cursor;
146
+
} while (cursor);
147
+
148
+
events.sort((a, b) => (a.rkey < b.rkey ? -1 : 1));
149
+
150
+
return aggregateEvents(events.map((e) => e.record));
151
+
}
152
+
153
+
function aggregateEvents(events: GitHubSponsorEventRecord[]): GitHubSponsor[] {
154
+
const map = new Map<string, GitHubSponsor>();
155
+
156
+
for (const event of events) {
157
+
const existing = map.get(event.login);
158
+
const isActive = ACTIVE_ACTIONS.includes(event.action)
159
+
? true
160
+
: INACTIVE_ACTIONS.includes(event.action)
161
+
? false
162
+
: (existing?.isActive ?? true);
163
+
164
+
map.set(event.login, {
165
+
login: event.login,
166
+
name: event.name ?? existing?.name,
167
+
tierName: event.tierName,
168
+
monthlyUsd: event.monthlyUsd,
169
+
isActive
170
+
});
171
+
}
172
+
173
+
return Array.from(map.values());
174
+
}
175
+
176
+
/**
177
+
* Write a single GitHub Sponsors event as a new PDS record.
178
+
* rkey is a TID generated from the event timestamp.
179
+
*/
180
+
export async function appendSponsorEvent(
181
+
login: string,
182
+
name: string | null,
183
+
action: GitHubSponsorshipAction,
184
+
tierName: string,
185
+
monthlyUsd: number,
186
+
timestamp: string
187
+
): Promise<void> {
188
+
const { agent, did } = await authedAgent();
189
+
190
+
const record: GitHubSponsorEventRecord = {
191
+
login,
192
+
...(name ? { name } : {}),
193
+
action,
194
+
tierName,
195
+
monthlyUsd
196
+
};
197
+
198
+
const ts = timestamp.endsWith('Z') ? timestamp : timestamp + 'Z';
199
+
200
+
await agent.com.atproto.repo.putRecord({
201
+
repo: did,
202
+
collection: COLLECTION,
203
+
rkey: generateTID(ts),
204
+
record: record as unknown as { [x: string]: unknown }
205
+
});
206
+
}
+84
packages/supporters/src/lib/github-types.ts
+84
packages/supporters/src/lib/github-types.ts
···
1
+
export type GitHubSponsorshipAction =
2
+
| 'created'
3
+
| 'cancelled'
4
+
| 'edited'
5
+
| 'tier_changed'
6
+
| 'pending_cancellation'
7
+
| 'pending_tier_change';
8
+
9
+
/**
10
+
* GitHub Sponsors webhook payload.
11
+
* Sent as application/json with an X-Hub-Signature-256 header.
12
+
*
13
+
* @see https://docs.github.com/en/webhooks/webhook-events-and-payloads#sponsorship
14
+
*/
15
+
export interface GitHubSponsorshipWebhookPayload {
16
+
action: GitHubSponsorshipAction;
17
+
sponsorship: {
18
+
node_id: string;
19
+
created_at: string;
20
+
privacy_level: 'public' | 'private';
21
+
tier: {
22
+
node_id: string;
23
+
created_at: string;
24
+
name: string;
25
+
description: string;
26
+
monthly_price_in_cents: number;
27
+
monthly_price_in_dollars: number;
28
+
is_one_time: boolean;
29
+
is_custom_amount: boolean;
30
+
};
31
+
sponsorable: {
32
+
login: string;
33
+
name: string | null;
34
+
};
35
+
sponsor: {
36
+
login: string;
37
+
name: string | null;
38
+
};
39
+
};
40
+
/** Present on tier_changed and pending_tier_change actions */
41
+
changes?: {
42
+
tier?: {
43
+
from: {
44
+
node_id: string;
45
+
created_at: string;
46
+
name: string;
47
+
description: string;
48
+
monthly_price_in_cents: number;
49
+
monthly_price_in_dollars: number;
50
+
is_one_time: boolean;
51
+
is_custom_amount: boolean;
52
+
};
53
+
};
54
+
};
55
+
/** Present on pending_cancellation and pending_tier_change — effective date */
56
+
effective_date?: string;
57
+
sender: {
58
+
login: string;
59
+
};
60
+
}
61
+
62
+
/** An aggregated sponsor record, derived from one or more sponsorship events. */
63
+
export interface GitHubSponsor {
64
+
/** GitHub username */
65
+
login: string;
66
+
/** Display name, if known */
67
+
name?: string;
68
+
/** Most recent tier name */
69
+
tierName: string;
70
+
/** Most recent monthly amount in USD */
71
+
monthlyUsd: number;
72
+
/** Whether the sponsorship is currently active */
73
+
isActive: boolean;
74
+
}
75
+
76
+
export interface GitHubSponsorsProps {
77
+
sponsors: GitHubSponsor[];
78
+
heading?: string;
79
+
description?: string;
80
+
/** If true, only show active sponsors */
81
+
activeOnly?: boolean;
82
+
loading?: boolean;
83
+
error?: string | null;
84
+
}
+80
packages/supporters/src/lib/github-webhook.ts
+80
packages/supporters/src/lib/github-webhook.ts
···
1
+
/**
2
+
* Validates and parses an incoming GitHub Sponsors webhook request.
3
+
*
4
+
* GitHub signs the JSON body with HMAC-SHA256 and sends it in the
5
+
* X-Hub-Signature-256 header as `sha256=<hex>`. We verify the signature
6
+
* before parsing the payload.
7
+
*
8
+
* Required environment variable:
9
+
* GITHUB_WEBHOOK_SECRET — the secret set in your GitHub Sponsors webhook config
10
+
*
11
+
* @see https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries
12
+
*/
13
+
14
+
import type { GitHubSponsorshipWebhookPayload } from './github-types.js';
15
+
16
+
export class GitHubWebhookError extends Error {
17
+
constructor(
18
+
message: string,
19
+
public readonly status: number
20
+
) {
21
+
super(message);
22
+
}
23
+
}
24
+
25
+
export interface ParseGitHubWebhookOptions {
26
+
/** Override GITHUB_WEBHOOK_SECRET from process.env */
27
+
secret?: string;
28
+
}
29
+
30
+
/** Constant-time hex comparison to prevent timing attacks. */
31
+
async function verifySignature(secret: string, body: string, signature: string): Promise<boolean> {
32
+
const enc = new TextEncoder();
33
+
const key = await crypto.subtle.importKey(
34
+
'raw',
35
+
enc.encode(secret),
36
+
{ name: 'HMAC', hash: 'SHA-256' },
37
+
false,
38
+
['sign']
39
+
);
40
+
const mac = await crypto.subtle.sign('HMAC', key, enc.encode(body));
41
+
const expected = 'sha256=' + Array.from(new Uint8Array(mac)).map((b) => b.toString(16).padStart(2, '0')).join('');
42
+
43
+
if (expected.length !== signature.length) return false;
44
+
// Constant-time comparison
45
+
let mismatch = 0;
46
+
for (let i = 0; i < expected.length; i++) {
47
+
mismatch |= expected.charCodeAt(i) ^ signature.charCodeAt(i);
48
+
}
49
+
return mismatch === 0;
50
+
}
51
+
52
+
export async function parseGitHubSponsorsWebhook(
53
+
request: Request,
54
+
options?: ParseGitHubWebhookOptions
55
+
): Promise<GitHubSponsorshipWebhookPayload> {
56
+
const secret = options?.secret ?? process.env.GITHUB_WEBHOOK_SECRET;
57
+
if (!secret) throw new GitHubWebhookError('GITHUB_WEBHOOK_SECRET is not set', 500);
58
+
59
+
const event = request.headers.get('x-github-event');
60
+
if (event !== 'sponsorship') {
61
+
throw new GitHubWebhookError(`Unexpected event type: ${event}`, 400);
62
+
}
63
+
64
+
const signature = request.headers.get('x-hub-signature-256');
65
+
if (!signature) throw new GitHubWebhookError('Missing X-Hub-Signature-256 header', 400);
66
+
67
+
const body = await request.text();
68
+
69
+
const valid = await verifySignature(secret, body, signature);
70
+
if (!valid) throw new GitHubWebhookError('Signature verification failed', 401);
71
+
72
+
let payload: GitHubSponsorshipWebhookPayload;
73
+
try {
74
+
payload = JSON.parse(body);
75
+
} catch {
76
+
throw new GitHubWebhookError('Invalid JSON body', 400);
77
+
}
78
+
79
+
return payload;
80
+
}
+13
packages/supporters/src/lib/index.ts
+13
packages/supporters/src/lib/index.ts
···
1
+
// Ko-fi
1
2
export { default as KofiSupporters } from './KofiSupporters.svelte';
2
3
export { fetchEvents } from './events.js';
3
4
export type { KofiSupportEvent } from './events.js';
···
6
7
export type { KofiEventRecord } from './store.js';
7
8
export { parseWebhook, WebhookError } from './webhook.js';
8
9
export type { KofiSupporter, KofiWebhookPayload, KofiSupportersProps, KofiEventType } from './types.js';
10
+
11
+
// GitHub Sponsors
12
+
export { default as GitHubSponsors } from './GitHubSponsors.svelte';
13
+
export { readSponsors, appendSponsorEvent, fetchSponsorEvents } from './github-store.js';
14
+
export type { GitHubSponsorEventRecord, GitHubSponsorEvent } from './github-store.js';
15
+
export { parseGitHubSponsorsWebhook, GitHubWebhookError } from './github-webhook.js';
16
+
export type {
17
+
GitHubSponsor,
18
+
GitHubSponsorshipWebhookPayload,
19
+
GitHubSponsorsProps,
20
+
GitHubSponsorshipAction
21
+
} from './github-types.js';