{"id":26066549,"url":"https://github.com/juansesdev/waitlist-mailer","last_synced_at":"2026-02-27T08:05:34.762Z","repository":{"id":277255198,"uuid":"931833146","full_name":"JuansesDev/waitlist-mailer","owner":"JuansesDev","description":"A tool to manage waitlists and send confirmation emails.","archived":false,"fork":false,"pushed_at":"2025-03-06T00:47:09.000Z","size":19688,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T21:10:32.772Z","etag":null,"topics":["github","nodejs","npm-package","open-source"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JuansesDev.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-12T23:37:05.000Z","updated_at":"2025-03-06T00:43:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"aafcb58a-80a3-4be4-bda2-f124638fdeef","html_url":"https://github.com/JuansesDev/waitlist-mailer","commit_stats":null,"previous_names":["juanses03/waitlist-mailer","juansesdev/waitlist-mailer"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuansesDev%2Fwaitlist-mailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuansesDev%2Fwaitlist-mailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuansesDev%2Fwaitlist-mailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuansesDev%2Fwaitlist-mailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JuansesDev","download_url":"https://codeload.github.com/JuansesDev/waitlist-mailer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248439680,"owners_count":21103659,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","nodejs","npm-package","open-source"],"created_at":"2025-03-08T20:52:41.827Z","updated_at":"2026-02-27T08:05:34.757Z","avatar_url":"https://github.com/JuansesDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WaitlistMailer v2.1.0\n\nA **modern, modular, and lightweight** TypeScript library for managing email waitlists with **zero required dependencies** for basic usage. Built with clean architecture principles: **dependency injection**, **adapter pattern**, and **event-driven design**.\n\n### ✨ Key Features\n\n- ✅ **Modular Adapters**: Pluggable storage and mail providers\n  \n- ✅ **Zero Bloat**: No forced dependencies unless you use them\n  \n- ✅ **Dependency Injection**: Clean, testable architecture\n  \n- ✅ **TypeScript-First**: Full type safety with generic support\n  \n- ✅ **Event-Driven**: Rich event system for integrations\n  \n- ✅ **Production-Ready**: 44+ tests, comprehensive coverage\n  \n- ✅ **Smart Defaults**: Works out of the box with in-memory storage\n\n- ✅ **Scalable**: Database-level search \u0026 streaming for large datasets (NEW in v2.1)\n  \n\n## 📦 Installation\n\n```\nnpm install waitlist-mailer\n```\n\n### For Database Support\n\nChoose the storage adapter you need:\n\n```\n# For MongoDB\nnpm install mongoose\n\n# For PostgreSQL\nnpm install sequelize pg\n\n# For MySQL\nnpm install sequelize mysql2\n\n# For SQLite\nnpm install sequelize better-sqlite3\n```\n\n## 🚀 Quick Start\n\n### Minimal Setup (Default)\n\nBy default, `WaitlistManager` uses in-memory storage, perfect for rapid prototyping.\n\n```\nimport { WaitlistManager } from 'waitlist-mailer';\n\n// Defaults to MemoryStorage automatically\nconst manager = new WaitlistManager({\n  companyName: 'My App'\n});\n\n// Add someone to the waitlist\nconst result = await manager.join('user@example.com', {\n  name: 'John Doe',\n  source: 'Twitter'\n});\n\nconsole.log(result); \n// Output: { success: true, message: 'Successfully joined...', email: 'user@example.com' }\n```\n\n### With Email Sending\n\nTo send emails, simply provide a mailer adapter.\n\n```\nimport { WaitlistManager, NodemailerProvider } from 'waitlist-mailer';\n\nconst manager = new WaitlistManager({\n  // Storage defaults to MemoryStorage if not provided\n  mailer: new NodemailerProvider({\n    host: 'smtp.gmail.com',\n    port: 587,\n    user: 'your-email@gmail.com',\n    pass: 'your-app-password'\n  }),\n  companyName: 'My Startup'\n});\n\n// When users join, they'll automatically receive a confirmation email\nawait manager.join('alice@example.com');\n```\n\n### With MongoDB\n\nFor persistent storage, inject the Mongoose adapter.\n\n```\nimport { WaitlistManager, MongooseStorage } from 'waitlist-mailer';\nimport mongoose from 'mongoose';\n\n// Connect to MongoDB\nawait mongoose.connect('mongodb://localhost:27017/waitlist');\n\n// Define schema\nconst schema = new mongoose.Schema({\n  email: { type: String, required: true, unique: true },\n  metadata: { type: mongoose.Schema.Types.Mixed },\n  createdAt: { type: Date, default: Date.now }\n});\nconst WaitlistModel = mongoose.model('Waitlist', schema);\n\n// Initialize manager\nconst manager = new WaitlistManager({\n  storage: new MongooseStorage({ model: WaitlistModel }),\n  companyName: 'My App'\n});\n```\n\n## 📖 Documentation\n\n**→** [**Complete Documentation Map**](./DOCS.md) Quick Links:\n\n- [**API Reference**](./API.md) — Complete method documentation, event system, and type definitions\n\n- [**Customization Guide**](./CUSTOMIZATION.md) — Email templates, custom adapters, and advanced examples\n\n- [**Practical Examples**](./EXAMPLES.md) — Real-world scenarios: MVP setup, production patterns, campaigns\n\n- [**Architecture**](./ARCHITECTURE.md) — Design patterns and extensibility\n\n- [**Migration Guide**](./MIGRATION.md) — Upgrading from v1.x to v2.0\n## 📄 License\n\nMIT License - see [LICENSE](./LICENSE) file for details.\n\n## 🤝 Contributing\n\nContributions are welcome! Please open an issue or pull request on [GitHub](https://github.com/JuansesDev/waitlist-mailer).\n\n## 📞 Support\n\n- **Issues**: [GitHub Issues](https://github.com/JuansesDev/waitlist-mailer/issues)\n  \n- **Documentation**: See [DOCS.md](./DOCS.md) for complete reference\n  \n- **NPM**: [waitlist-mailer](https://www.npmjs.com/package/waitlist-mailer)\n  \n\n**Made with ❤️ by** [**JuansesDev**](https://github.com/JuansesDev)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuansesdev%2Fwaitlist-mailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuansesdev%2Fwaitlist-mailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuansesdev%2Fwaitlist-mailer/lists"}