@antelopejs/interface-email 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -8
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,16 +1,19 @@
1
- # `@antelopejs/interface-email`
1
+ <a href="https://github.com/AntelopeJS/antelopejs"><img data-illustration src="./.github/readme/strip.svg" width="100%" alt="INTERFACE · EMAIL: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS."></a>
2
2
 
3
3
  <div align="center">
4
- <a href="https://www.npmjs.com/package/@antelopejs/interface-email"><img data-illustration alt="npm" src="https://img.shields.io/npm/v/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000"></a>
5
- <a href="./LICENSE"><img data-illustration alt="License" src="https://img.shields.io/npm/l/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000"></a>
6
- <a href="https://discord.gg/g4pFt6eXqu"><img data-illustration alt="Discord" src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000"></a>
7
- <a href="./docs/1.introduction.md"><img data-illustration alt="Docs" src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000"></a>
4
+
5
+ # `@antelopejs/interface-email`
6
+
7
+ <a href="https://www.npmjs.com/package/@antelopejs/interface-email"><img data-illustration alt="npm" src="https://img.shields.io/npm/v/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000"></a> <a href="./LICENSE"><img data-illustration alt="License" src="https://img.shields.io/npm/l/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000"></a> <a href="https://discord.gg/g4pFt6eXqu"><img data-illustration alt="Discord" src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000"></a> <a href="./docs/1.introduction.md"><img data-illustration alt="Documentation" src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000"></a> <a href="https://github.com/AntelopeJS/antelopejs"><img data-illustration alt="Star AntelopeJS" src="https://img.shields.io/github/stars/AntelopeJS/antelopejs?label=Star%20AntelopeJS&style=for-the-badge&labelColor=000000&color=000000&logo=github"></a>
8
+
9
+ **The AntelopeJS contract for email. Send templated, batch and attachment emails without naming a provider.**
10
+
11
+ [Documentation](./docs/1.introduction.md) · [Implementations](#implementations) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem)
12
+
8
13
  </div>
9
14
 
10
15
  The AntelopeJS contract for sending email: one API for single, batch and template messages, whatever provider delivers them.
11
16
 
12
- Part of [AntelopeJS](https://github.com/AntelopeJS/antelopejs). Used by [AntelopeJS DMS](https://github.com/AntelopeJS/dms), the open-source back office for your PostgreSQL, MongoDB or RethinkDB database.
13
-
14
17
  ## What it offers
15
18
 
16
19
  - `Send` sends one message with text or HTML, recipients, threading headers and attachments.
@@ -72,7 +75,7 @@ export async function sendWelcome(address: string) {
72
75
 
73
76
  | Package | Supported | Tested with |
74
77
  | ---------------------------- | ---------------- | ----------- |
75
- | `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.2.4` |
78
+ | `@antelopejs/interface-core` | `>=0.5.1 <0.6.0` | `0.5.1` |
76
79
 
77
80
  <!-- antelopejs-docs-compat:end -->
78
81
 
@@ -89,6 +92,24 @@ pnpm lint
89
92
  pnpm build
90
93
  ```
91
94
 
95
+ ## Part of AntelopeJS
96
+
97
+ This package belongs to [AntelopeJS](https://github.com/AntelopeJS/antelopejs), the TypeScript framework where modules depend on contracts and the application chooses the provider. The open-source back office [AntelopeJS DMS](https://github.com/AntelopeJS/dms) is built on it.
98
+
99
+ <!-- antelopejs-framework-modules:start -->
100
+
101
+ | Area | Contracts | Providers |
102
+ | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
103
+ | API | [`interface-api`](https://github.com/AntelopeJS/interface-api) · [`interface-api-util`](https://github.com/AntelopeJS/interface-api-util) · [`interface-data-api`](https://github.com/AntelopeJS/interface-data-api) | [`api`](https://github.com/AntelopeJS/api) |
104
+ | Auth | [`interface-auth`](https://github.com/AntelopeJS/interface-auth) | [`auth-jwt`](https://github.com/AntelopeJS/auth-jwt) |
105
+ | Database | [`interface-database`](https://github.com/AntelopeJS/interface-database) · [`interface-database-decorators`](https://github.com/AntelopeJS/interface-database-decorators) · [`interface-database-catalog`](https://github.com/AntelopeJS/interface-database-catalog) · [`interface-mongodb`](https://github.com/AntelopeJS/interface-mongodb) · [`interface-rethinkdb`](https://github.com/AntelopeJS/interface-rethinkdb) | [`postgres`](https://github.com/AntelopeJS/postgres) · [`mysql`](https://github.com/AntelopeJS/mysql) · [`mongodb`](https://github.com/AntelopeJS/mongodb) · [`rethinkdb`](https://github.com/AntelopeJS/rethinkdb) |
106
+ | Redis | [`interface-redis`](https://github.com/AntelopeJS/interface-redis) · [`interface-redis-scheduler`](https://github.com/AntelopeJS/interface-redis-scheduler) | [`redis`](https://github.com/AntelopeJS/redis) |
107
+ | Email | **`interface-email`** | [`nodemailer`](https://github.com/AntelopeJS/nodemailer) · [`brevo`](https://github.com/AntelopeJS/brevo) |
108
+ | File storage | [`interface-file-storage`](https://github.com/AntelopeJS/interface-file-storage) | [`file-storage-local`](https://github.com/AntelopeJS/file-storage-local) · [`file-storage-s3`](https://github.com/AntelopeJS/file-storage-s3) |
109
+ | Payments | [`interface-payment`](https://github.com/AntelopeJS/interface-payment) · [`interface-subscriptions`](https://github.com/AntelopeJS/interface-subscriptions) · [`interface-stripe`](https://github.com/AntelopeJS/interface-stripe) | [`stripe`](https://github.com/AntelopeJS/stripe) · [`mollie`](https://github.com/AntelopeJS/mollie) · [`checkout-com`](https://github.com/AntelopeJS/checkout-com) · [`payment-subscriptions`](https://github.com/AntelopeJS/payment-subscriptions) |
110
+
111
+ <!-- antelopejs-framework-modules:end -->
112
+
92
113
  ## License
93
114
 
94
115
  [Apache-2.0](./LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antelopejs/interface-email",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "AntelopeJS interface for sending email: single, batch and template messages with attachments",
5
5
  "keywords": [
6
6
  "antelopejs",
@@ -35,7 +35,7 @@
35
35
  "provenance": true
36
36
  },
37
37
  "scripts": {
38
- "build": "rimraf dist && tsc -p tsconfig.build.json --skipLibCheck",
38
+ "build": "rimraf dist && tsc -p tsconfig.build.json",
39
39
  "format": "oxfmt .",
40
40
  "lint:fix": "oxlint --fix",
41
41
  "lint": "oxlint",
@@ -54,9 +54,9 @@
54
54
  "suppressions:update": "antelopejs-suppressions --update"
55
55
  },
56
56
  "devDependencies": {
57
- "@antelopejs/core": "^1.21.0",
58
- "@antelopejs/interface-core": ">=0.2.4 <1.0.0",
59
- "@antelopejs/tooling-configs": "^0.4.0",
57
+ "@antelopejs/core": "~1.23.0",
58
+ "@antelopejs/interface-core": ">=0.5.1 <0.6.0",
59
+ "@antelopejs/tooling-configs": ">=0.6.0 <0.7.0",
60
60
  "@types/node": "^22.19.15",
61
61
  "eslint-plugin-perfectionist": "^5.11.0",
62
62
  "knip": "^6.34.0",
@@ -70,7 +70,7 @@
70
70
  "typescript": "^5.9.3"
71
71
  },
72
72
  "peerDependencies": {
73
- "@antelopejs/interface-core": ">=0.2.4 <1.0.0"
73
+ "@antelopejs/interface-core": ">=0.5.1 <0.6.0"
74
74
  },
75
75
  "packageManager": "pnpm@10.6.5",
76
76
  "antelopeJs": {