@quitscope/discord-welcomecard 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 QuitScope
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# @quitscope/discord-welcomecard
+
+Render Discord welcome cards as static **PNG** or animated **GIF** from one builder.
+
+![centered preset](examples/centered.png)
+
+- **One API, two outputs** — the same builder renders `.toPNG()` and `.toGIF()`.
+- **Animated GIFs** — background sheen, text fade-in, pulsing avatar glow. Autoplays in Discord.
+- **No compile pain** — built on `@napi-rs/canvas` (prebuilt binaries, no node-gyp).
+- **Bundled font** — cards look the same on every server.
+- **TypeScript** — full types, ESM + CJS.
+
+## Install
+
+```bash
+npm install @quitscope/discord-welcomecard
+```
+
+## Usage
+
+```ts
+import { WelcomeCard } from '@quitscope/discord-welcomecard';
+import { toAttachment } from '@quitscope/discord-welcomecard/discord';
+
+const card = new WelcomeCard()
+  .setPreset('centered')
+  .setUsername('Quit')
+  .setAvatar('https://cdn.discordapp.com/avatars/.../avatar.png')
+  .setSubtitle('Welcome to the server!')
+  .setMemberCount(1234)
+  .setTheme('dark')
+  .setAnimations(['background', 'text', 'avatar']);
+
+const png = await card.toPNG();
+const gif = await card.toGIF();
+
+// discord.js
+channel.send({ files: [toAttachment(gif, 'welcome.gif')] });
+```
+
+### With discord.js events
+
+```ts
+client.on('guildMemberAdd', async (member) => {
+  const gif = await new WelcomeCard()
+    .setUsername(member.user.displayName)
+    .setAvatar(member.user.displayAvatarURL({ extension: 'png', size: 256 }))
+    .setSubtitle(`Welcome to ${member.guild.name}!`)
+    .setMemberCount(member.guild.memberCount)
+    .setAnimations(['text', 'avatar'])
+    .toGIF();
+
+  const channel = member.guild.systemChannel;
+  channel?.send({ files: [toAttachment(gif, 'welcome.gif')] });
+});
+```
+
+## Presets
+
+| `centered` (default) | `neon` |
+| --- | --- |
+| ![centered](examples/centered.png) | ![neon](examples/neon.png) |
+
+| `minimal` | `hero` |
+| --- | --- |
+| ![minimal](examples/minimal.png) | ![hero](examples/hero.png) |
+
+## Animated
+
+`setAnimations([...])` + `toGIF()` — background sheen, text fade-in, avatar glow:
+
+![animated](examples/animated.gif)
+
+## API
+
+| Method | Description |
+| --- | --- |
+| `setPreset(name)` | `'centered'` (default), `'neon'`, `'minimal'`, `'hero'` |
+| `setUsername(name)` | Main text (required) |
+| `setAvatar(urlOrBuffer)` | Avatar image; falls back to a colored circle if it fails to load |
+| `setSubtitle(text)` | Secondary line, e.g. "Welcome to the server!" |
+| `setMemberCount(n)` | Renders "MEMBER #n" — optional, omit to hide |
+| `setMemberCountPosition(pos)` | 3×3 grid: `'top-left'`, `'top-center'`, `'top-right'`, `'center-left'`, `'center'`, `'center-right'`, `'bottom-left'`, `'bottom-center'`, `'bottom-right'`. `'corner'` is an alias for `'bottom-right'`. Defaults: `'bottom-center'` in the centered presets, `'bottom-right'` in `hero`. |
+| `setBackground(value)` | Hex color (`#1e1e2e`) or image URL |
+| `setTheme(theme)` | `'dark'` (default) or `'light'` |
+| `setFont({ family, color, size })` | Override the bundled font settings |
+| `setAnimations(list)` | Any of `'background'`, `'text'`, `'avatar'` — used by `toGIF()` |
+| `toPNG()` | `Promise<Buffer>` — static card |
+| `toGIF()` | `Promise<Buffer>` — animated card |
+
+The `toAttachment(buffer, name?)` helper lives in `@quitscope/discord-welcomecard/discord` and requires
+`discord.js` (optional peer dependency). The core package works without it.
+
+Only `setUsername()` is required — everything else has sensible defaults or fallbacks.
+
+## Requirements
+
+- Node.js ≥ 18
+
+## License
+
+MIT. Font: [Poppins](https://fonts.google.com/specimen/Poppins) (SIL Open Font License, bundled).

package/dist/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The Poppins Project Authors (https://github.com/itfoundry/Poppins)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+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, 
+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
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+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.

package/dist/chunk-PZ5AY32C.js

@@ -0,0 +1,10 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+export {
+  __export
+};
+//# sourceMappingURL=chunk-PZ5AY32C.js.map

package/dist/chunk-PZ5AY32C.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/discord.cjs

@@ -0,0 +1,34 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/discord.ts
+var discord_exports = {};
+__export(discord_exports, {
+  toAttachment: () => toAttachment
+});
+module.exports = __toCommonJS(discord_exports);
+var import_discord = require("discord.js");
+function toAttachment(buffer, name = "welcome.png") {
+  return new import_discord.AttachmentBuilder(buffer, { name });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  toAttachment
+});
+//# sourceMappingURL=discord.cjs.map

package/dist/discord.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/discord.ts"],"sourcesContent":["import { AttachmentBuilder } from 'discord.js';\n\nexport function toAttachment(buffer: Buffer, name = 'welcome.png'): AttachmentBuilder {\n  return new AttachmentBuilder(buffer, { name });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAAkC;AAE3B,SAAS,aAAa,QAAgB,OAAO,eAAkC;AACpF,SAAO,IAAI,iCAAkB,QAAQ,EAAE,KAAK,CAAC;AAC/C;","names":[]}

package/dist/discord.d.cts

@@ -0,0 +1,5 @@
+import { AttachmentBuilder } from 'discord.js';
+
+declare function toAttachment(buffer: Buffer, name?: string): AttachmentBuilder;
+
+export { toAttachment };

package/dist/discord.d.ts

@@ -0,0 +1,5 @@
+import { AttachmentBuilder } from 'discord.js';
+
+declare function toAttachment(buffer: Buffer, name?: string): AttachmentBuilder;
+
+export { toAttachment };

package/dist/discord.js

@@ -0,0 +1,11 @@
+import "./chunk-PZ5AY32C.js";
+
+// src/discord.ts
+import { AttachmentBuilder } from "discord.js";
+function toAttachment(buffer, name = "welcome.png") {
+  return new AttachmentBuilder(buffer, { name });
+}
+export {
+  toAttachment
+};
+//# sourceMappingURL=discord.js.map

package/dist/discord.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/discord.ts"],"sourcesContent":["import { AttachmentBuilder } from 'discord.js';\n\nexport function toAttachment(buffer: Buffer, name = 'welcome.png'): AttachmentBuilder {\n  return new AttachmentBuilder(buffer, { name });\n}\n"],"mappings":";;;AAAA,SAAS,yBAAyB;AAE3B,SAAS,aAAa,QAAgB,OAAO,eAAkC;AACpF,SAAO,IAAI,kBAAkB,QAAQ,EAAE,KAAK,CAAC;AAC/C;","names":[]}