kira-arts 1.4.1 → 1.5.0

package/README.md

@@ -2,6 +2,8 @@
 
 A TypeScript library for generating Discord-style visual cards — profiles, welcome/leave events, level-ups, achievements, leaderboards, compatibility "ship" cards, now-playing music cards, and giveaways — rendered natively for speed and zero runtime dependencies on a browser or headless Chromium.
 
+<img src="https://i.imgur.com/AMk4jWr.png" alt="Kira Arts" width="100%">
+
 **📚 Full documentation, live examples, and a Playground: [documentation](https://guide.worddevs.dev/docs/kira-arts)**
 
 [![npm version](https://img.shields.io/npm/v/kira-arts.svg)](https://www.npmjs.com/package/kira-arts)
@@ -22,8 +24,9 @@ A TypeScript library for generating Discord-style visual cards — profiles, wel
 
 ## ✨ Features
 
-- 🖼️ Profile, Welcome/Leave, Level Up, Achievement, Leaderboard, Ship (compatibility), Now Playing, and Giveaway cards
+- 🖼️ Profile, Welcome/Leave, Level Up, Achievement, Leaderboard, Ship (compatibility), Now Playing, Giveaway, Birthday, Marriage, Weekly Recap, and Code Snippet cards
 - 🎵 Now Playing card ships with adapters for moonlink.js, Lavalink-based clients (erela.js, Shoukaku, Kazagumo, Riffy, Magmastream, lavalink-client), discord-player, and distube
+- 💻 Code Snippet card renders syntax-highlighted code screenshots (JavaScript, TypeScript, Python, Java, C#, JSON, Bash, plaintext) in 6 built-in editor themes, without needing a Discord user ID
 - 🎨 8 built-in themes (`discord`, `midnight`, `sunset`, `neon`, `forest`, `sakura`, `monochrome`, `gold`), Nitro/role-color aware borders, and up to 4-color custom gradients
 - 🧾 Output as `png`, `jpeg`, or `webp`, ready to use as a discord.js `AttachmentBuilder` via `toAttachment()`
 - ⚡ Built-in, configurable in-memory cache for fetched user data (`setCacheOptions`, `clearCache`, `getCacheSize`)
@@ -79,17 +82,21 @@ Every other card, the music adapters, theming, caching, error handling, and outp
 
 ## 🃏 Cards at a glance
 
-| Card        | Function                                      | What it's for                               |
-| ----------- | --------------------------------------------- | ------------------------------------------- |
-| Profile     | `profileImage(userId, options)`               | Avatar, badges, nameplate, server tag, rank |
-| Welcome     | `welcomeImage(userId, guildName, options)`    | Member join events                          |
-| Leave       | `leaveImage(userId, guildName, options)`      | Member leave events                         |
-| Level Up    | `levelUpImage(userId, level, options)`        | XP progress bar on level-up                 |
-| Achievement | `achievementImage(userId, title, options)`    | Unlockable achievements with rarity tiers   |
-| Leaderboard | `leaderboardImage(entries, options)`          | Server ranking table                        |
-| Ship        | `shipImage(leftUserId, rightUserId, options)` | Compatibility between two users             |
-| Now Playing | `nowPlayingImage(track, options)`             | Music player card with source detection     |
-| Giveaway    | `giveawayImage(prize, options)`               | Prize, host, entry count, winners on end    |
+| Card         | Function                                          | What it's for                                             |
+| ------------ | ------------------------------------------------- | --------------------------------------------------------- |
+| Profile      | `profileImage(userId, options)`                   | Avatar, badges, nameplate, server tag, rank               |
+| Welcome      | `welcomeImage(userId, guildName, options)`        | Member join events                                        |
+| Leave        | `leaveImage(userId, guildName, options)`          | Member leave events                                       |
+| Level Up     | `levelUpImage(userId, level, options)`            | XP progress bar on level-up                               |
+| Achievement  | `achievementImage(userId, title, options)`        | Unlockable achievements with rarity tiers                 |
+| Leaderboard  | `leaderboardImage(entries, options)`              | Server ranking table                                      |
+| Ship         | `shipImage(leftUserId, rightUserId, options)`     | Compatibility between two users                           |
+| Now Playing  | `nowPlayingImage(track, options)`                 | Music player card with source detection                   |
+| Giveaway     | `giveawayImage(prize, options)`                   | Prize, host, entry count, winners on end                  |
+| Birthday     | `birthdayImage(userId, options)`                  | Balloons, confetti, and an optional age/years counter     |
+| Marriage     | `marriageImage(leftUserId, rightUserId, options)` | Certificate-style card with automatic days-together count |
+| Weekly Recap | `weeklyRecapImage(userId, options)`               | Wrapped-style weekly summary with a 7-day activity chart  |
+| Code Snippet | `codeSnippetImage(code, options)`                 | Carbon-style syntax-highlighted code screenshot           |
 
 ## 🛠️ Utilities
 
@@ -103,7 +110,7 @@ Every other card, the music adapters, theming, caching, error handling, and outp
 | `clearCache()`                                  | Clears the internal user-data cache                                    |
 | `getCacheSize()`                                | Returns the number of entries currently cached                         |
 | `computeCompatibility(leftUserId, rightUserId)` | Deterministic compatibility percentage for the Ship card               |
-| `pickShipMessage(percentage)`                   | Flavor text matching a compatibility percentage                        |
+| `pickShipMessage(leftId, rightId, percentage)`  | Flavor text matching a compatibility percentage                        |
 | `getThemePalette(theme)`                        | Resolves a `KiraThemeName` to its full color palette                   |
 | `fromMoonlinkTrack(track)`                      | Adapter: moonlink.js track → `NowPlayingTrack`                         |
 | `fromLavalinkTrack(track)`                      | Adapter: Lavalink-based clients → `NowPlayingTrack`                    |

package/dist/Public/Fonts/licenses/Anton-OFL.txt

@@ -18,7 +18,7 @@ with others.
 
 The OFL allows the licensed fonts to be used, studied, modified and
 redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded, 
+fonts, including any derivative works, can be bundled, embedded,
 redistributed and/or sold with any software provided that any reserved
 names are not used by derivative works. The fonts and derivatives,
 however, cannot be released under any other type of license. The

package/dist/Public/Fonts/licenses/Arimo-OFL.txt

@@ -18,7 +18,7 @@ with others.
 
 The OFL allows the licensed fonts to be used, studied, modified and
 redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded, 
+fonts, including any derivative works, can be bundled, embedded,
 redistributed and/or sold with any software provided that any reserved
 names are not used by derivative works. The fonts and derivatives,
 however, cannot be released under any other type of license. The

package/dist/Public/Fonts/licenses/Cousine-OFL.txt

@@ -18,7 +18,7 @@ with others.
 
 The OFL allows the licensed fonts to be used, studied, modified and
 redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded, 
+fonts, including any derivative works, can be bundled, embedded,
 redistributed and/or sold with any software provided that any reserved
 names are not used by derivative works. The fonts and derivatives,
 however, cannot be released under any other type of license. The
@@ -90,4 +90,4 @@ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
 DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/Public/Fonts/licenses/Gelasio-OFL.txt

@@ -18,7 +18,7 @@ with others.
 
 The OFL allows the licensed fonts to be used, studied, modified and
 redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded, 
+fonts, including any derivative works, can be bundled, embedded,
 redistributed and/or sold with any software provided that any reserved
 names are not used by derivative works. The fonts and derivatives,
 however, cannot be released under any other type of license. The