Secret Santa
Family Secret Santa: a fair constrained draw (couples excluded, no repeats from last year), a personal encrypted reveal link per person to a cheeky ASCII-Santa page, and either bulk SMS through Twilio or a private links file you send yourself (free, no Twilio needed).
Global Arguments
| Argument | Type | Description |
|---|---|---|
| eventName? | string | Event name used in the SMS body. |
| year | number | The year being drawn. Draws are stored per year, so last year's results can be avoided next time. |
| baseUrl | string | Public URL of the static reveal page, e.g. https://you.github.io/secret-santa/. The encrypted token is appended after #. |
| participants | array | Everyone taking part. At least three people are needed for a draw where nobody gets themselves and exclusions can still be satisfied. |
| exclusions? | array | Pairs of names who must not draw each other, e.g. couples. Applies in both directions. |
| avoidRepeatYears? | number | Nobody gets the same person they bought for in this many previous years. 0 turns repeat avoidance off. |
| history? | array | Earlier draws entered by hand (e.g. last year's, done on paper). Draws made by this model are remembered automatically. |
| messageTemplate? | string | SMS body. Placeholders: {name}, {event}, {year}, {link}. Must contain {link}. |
| shortener? | enum | Shorten each reveal link before it goes in the SMS. is.gd is free and keeps the #fragment, but is.gd then holds the full links (and so could read the pairings). none sends the full link. |
| Argument | Type | Description |
|---|---|---|
| redraw? | boolean | Throw away this year's existing draw and draw again. Anyone already sent a link will have a stale one. |
| Argument | Type | Description |
|---|---|---|
| path? | string | Where to write the file. Defaults to ~/secret-santa-links-<year>.txt. Keep it out of git. |
| only? | array | Export only these names (case-insensitive). Empty means everyone. |
Resources
Draw this year's Secret Santa (kept if already drawn), compose one SMS per person with an encrypted reveal link, verify every link, then text them via Twilio. Dry run by default; set testRecipient to text only yourself first. People without a phone number are skipped; hand them their link with the @aaronge/secret-santa-links workflow. Needs a Twilio account. Run manually — there is no schedule.
The free alternative to texting: draw this year's Secret Santa (kept if already drawn), compose each person's message and encrypted reveal link, verify every link, then write them all to a private file for you to send by email, WhatsApp or by hand. No Twilio account needed. Run manually; there's no schedule.
| Argument | Type | Description |
|---|---|---|
| sourceModel | string | Name of the model holding the outbox, e.g. santa-family. |
| outbox? | string | Instance name of the outbox resource on that model. |
| dryRun? | boolean | When true (the default), log what would be sent and send nothing. |
| only? | array | Send only to these recipient names (case-insensitive), e.g. yourself for a test. Empty means everyone. |
| throttleMs? | number | Pause between sends, to stay under Twilio's rate limit. |
| messages? | union | The outbox\ |
Resources
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned