@cloudstrife21/email-sdk 0.1.2 → 0.1.3
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.
- package/README.md +29 -97
- package/dist/client.d.ts +0 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +4 -2
- package/dist/client.js.map +1 -1
- package/dist/env.d.ts +0 -0
- package/dist/env.d.ts.map +0 -0
- package/dist/env.js +0 -0
- package/dist/env.js.map +0 -0
- package/dist/errors.d.ts +0 -0
- package/dist/errors.d.ts.map +0 -0
- package/dist/errors.js +0 -0
- package/dist/errors.js.map +0 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -0
- package/dist/index.js.map +0 -0
- package/dist/types.d.ts +7 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +0 -0
- package/dist/types.js.map +0 -0
- package/package.json +12 -14
package/README.md
CHANGED
|
@@ -1,25 +1,13 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @strongstart/email-sdk
|
|
2
2
|
|
|
3
|
-
Server-side TypeScript client for the StrongStart email send
|
|
3
|
+
Server-side TypeScript client for the StrongStart email send endpoint.
|
|
4
4
|
|
|
5
5
|
## Scope
|
|
6
6
|
|
|
7
7
|
- Node.js server environments only
|
|
8
8
|
- `POST /api/esp/v1/send-template`
|
|
9
|
-
- Optional HMAC signing
|
|
10
|
-
- Typed
|
|
11
|
-
|
|
12
|
-
## Install
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
npm install @cloudstrife21/email-sdk
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
Until it is published, you can consume the sibling package directly during local development:
|
|
19
|
-
|
|
20
|
-
```bash
|
|
21
|
-
npm install ../email-sdk
|
|
22
|
-
```
|
|
9
|
+
- Optional HMAC signing
|
|
10
|
+
- Typed API errors
|
|
23
11
|
|
|
24
12
|
## Environment variables
|
|
25
13
|
|
|
@@ -35,20 +23,24 @@ EMAIL_HMAC_SECRET=sh_hmac_xxx
|
|
|
35
23
|
```ts
|
|
36
24
|
import { createEmailClient, emailClientConfigFromEnv, EmailApiError } from '@cloudstrife21/email-sdk';
|
|
37
25
|
|
|
38
|
-
const
|
|
26
|
+
const client = createEmailClient(emailClientConfigFromEnv(process.env));
|
|
39
27
|
|
|
40
28
|
try {
|
|
41
|
-
const result = await
|
|
29
|
+
const result = await client.sendTemplate({
|
|
42
30
|
templateKey: 'welcome_email',
|
|
43
31
|
to: 'user@example.com',
|
|
44
32
|
data: {
|
|
45
33
|
name: 'Ada',
|
|
46
|
-
ctaUrl: 'https://ytexas.org/welcome'
|
|
34
|
+
ctaUrl: 'https://ytexas.org/welcome',
|
|
35
|
+
items: [
|
|
36
|
+
{ description: 'Airport transfer', amount: '$250.00' },
|
|
37
|
+
{ description: 'Wait time', amount: '$150.00' },
|
|
38
|
+
],
|
|
47
39
|
},
|
|
48
|
-
category: 'transactional'
|
|
40
|
+
category: 'transactional',
|
|
49
41
|
});
|
|
50
42
|
|
|
51
|
-
console.log(result.id, result.status
|
|
43
|
+
console.log(result.id, result.status);
|
|
52
44
|
} catch (error) {
|
|
53
45
|
if (error instanceof EmailApiError) {
|
|
54
46
|
console.error(error.status, error.code, error.requestId, error.payload);
|
|
@@ -57,88 +49,28 @@ try {
|
|
|
57
49
|
}
|
|
58
50
|
```
|
|
59
51
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
### `createEmailClient(config)`
|
|
63
|
-
|
|
64
|
-
Creates a client for the StrongStart send endpoint.
|
|
65
|
-
|
|
66
|
-
Config fields:
|
|
67
|
-
|
|
68
|
-
- `baseUrl`: API origin such as `https://email.strongstart.digital`
|
|
69
|
-
- `apiKey`: tenant-scoped API key sent as `x-api-key`
|
|
70
|
-
- `clientId`: application identifier expected by the API
|
|
71
|
-
- `hmacSecret`: optional request-signing secret
|
|
72
|
-
- `fetch`: optional fetch implementation override
|
|
73
|
-
- `defaultHeaders`: optional headers applied to every request
|
|
74
|
-
- `generateIdempotencyKey`: optional idempotency key factory
|
|
75
|
-
|
|
76
|
-
### `email.sendTemplate(request, options?)`
|
|
77
|
-
|
|
78
|
-
Supported request fields:
|
|
79
|
-
|
|
80
|
-
- `templateId` or `templateKey`
|
|
81
|
-
- optional `version` when using `templateKey`
|
|
82
|
-
- `to`
|
|
83
|
-
- optional `data`
|
|
84
|
-
- optional `subject`
|
|
85
|
-
- optional `senderDomain`
|
|
86
|
-
- optional `category`
|
|
87
|
-
- optional `cc` and `bcc` for forward compatibility with the API contract
|
|
88
|
-
|
|
89
|
-
Options:
|
|
90
|
-
|
|
91
|
-
- `idempotencyKey`
|
|
92
|
-
- `requestId`
|
|
93
|
-
- `headers`
|
|
94
|
-
- `signal`
|
|
95
|
-
|
|
96
|
-
## Errors
|
|
97
|
-
|
|
98
|
-
Non-2xx responses throw `EmailApiError` with:
|
|
99
|
-
|
|
100
|
-
- `status`
|
|
101
|
-
- `code`
|
|
102
|
-
- `requestId`
|
|
103
|
-
- `payload`
|
|
52
|
+
Template data accepts JSON-compatible values, including nested objects and arrays. Stored templates support `{{value}}`, `{{nested.value}}`, `{{#if value}}...{{/if}}`, and `{{#each items}}...{{/each}}`. Values are escaped by default; triple braces render explicitly raw HTML.
|
|
104
53
|
|
|
105
54
|
## Build
|
|
106
55
|
|
|
107
56
|
```bash
|
|
108
|
-
npm run build
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Test
|
|
112
|
-
|
|
113
|
-
```bash
|
|
114
|
-
npm test
|
|
57
|
+
npm run build:sdk:email
|
|
115
58
|
```
|
|
59
|
+
## Attachments
|
|
116
60
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
Run these steps from the `email-sdk` directory before publishing:
|
|
61
|
+
`sendTemplate` accepts `attachments` containing `filename`, `contentType`, and canonical base64 `content`. Supported types are `text/calendar` with a `.ics` filename and `application/pdf` with a `.pdf` filename and PDF version header. Up to four attachments may total 512,000 decoded bytes. Invalid attachments receive HTTP 422 `invalid_attachments`.
|
|
120
62
|
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
# 4) Verify packed contents
|
|
133
|
-
npm pack --dry-run
|
|
134
|
-
|
|
135
|
-
# 5) Publish
|
|
136
|
-
npm publish --access public
|
|
63
|
+
```ts
|
|
64
|
+
await client.sendTemplate({
|
|
65
|
+
templateKey: "reservation_itinerary_updated_driver",
|
|
66
|
+
to: "driver@example.com",
|
|
67
|
+
data: { reservation_reference: "12345" },
|
|
68
|
+
attachments: [{
|
|
69
|
+
filename: "driver-sheet.pdf",
|
|
70
|
+
contentType: "application/pdf",
|
|
71
|
+
content: pdfBuffer.toString("base64"),
|
|
72
|
+
}],
|
|
73
|
+
});
|
|
137
74
|
```
|
|
138
75
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
```bash
|
|
142
|
-
npm view @cloudstrife21/email-sdk version
|
|
143
|
-
npm view @cloudstrife21/email-sdk dist-tags --json
|
|
144
|
-
```
|
|
76
|
+
The publishable package source is maintained here. From the repository root, run `npm run build:sdk:email` and the SDK tests before publishing this directory with `npm publish --access public`.
|
package/dist/client.d.ts
CHANGED
|
File without changes
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEV,iBAAiB,EAEjB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEV,iBAAiB,EAEjB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,YAAY,CAAC;AA+EpB,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAC3C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,MAAM,EAAE,iBAAiB;IAc/B,YAAY,CAAC,OAAO,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAe/G;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW,CAExE;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAE/E"}
|
package/dist/client.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createHmac, randomUUID } from 'crypto';
|
|
1
|
+
import { createHmac, randomUUID } from 'node:crypto';
|
|
2
2
|
import { EmailApiError, EmailClientConfigError } from './errors.js';
|
|
3
3
|
const SEND_TEMPLATE_PATH = '/api/esp/v1/send-template';
|
|
4
4
|
function getFetch(override) {
|
|
@@ -33,6 +33,7 @@ function createBody(config, request) {
|
|
|
33
33
|
category: request.category,
|
|
34
34
|
cc: request.cc,
|
|
35
35
|
bcc: request.bcc,
|
|
36
|
+
attachments: request.attachments,
|
|
36
37
|
};
|
|
37
38
|
if ('templateId' in request) {
|
|
38
39
|
body.templateId = request.templateId;
|
|
@@ -69,7 +70,8 @@ function buildHeaders(config, body, options) {
|
|
|
69
70
|
if (options?.requestId)
|
|
70
71
|
headers.set('x-request-id', options.requestId);
|
|
71
72
|
if (config.hmacSecret) {
|
|
72
|
-
|
|
73
|
+
const signature = createHmac('sha256', config.hmacSecret).update(body).digest('hex');
|
|
74
|
+
headers.set('x-signature', `sha256=${signature}`);
|
|
73
75
|
}
|
|
74
76
|
return headers;
|
|
75
77
|
}
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAErD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAUpE,MAAM,kBAAkB,GAAG,2BAA2B,CAAC;AAEvD,SAAS,QAAQ,CAAC,QAAoB;IACpC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,IAAI,OAAO,KAAK,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAC9C,MAAM,IAAI,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAe;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;IACpE,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,aAAa,CAAC,OAAqB;IAC1C,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,IAAI,OAAO,YAAY,OAAO;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACrE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvF,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,UAAU,CAAC,MAAyB,EAAE,OAA4B;IACzE,MAAM,IAAI,GAA4B;QACpC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,aAAa,EAAE,OAAO,CAAC,YAAY;QACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC;IAEF,IAAI,YAAY,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,QAAkB;IAC1C,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAgC,CAAC;QACzF,IAAI,OAAO,EAAE,OAAO;YAAE,OAAO,OAAO,CAAC;IACvC,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IACnD,OAAO;QACL,OAAO,EAAE,IAAI,IAAI,QAAQ,QAAQ,CAAC,MAAM,EAAE;KAC3C,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,MAAyB,EAAE,IAAY,EAAE,OAA6B;IAC1F,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAChD,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAExC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC,cAAc,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAEpF,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,MAAM,CAAC,sBAAsB,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC;IACpG,IAAI,cAAc;QAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACnE,IAAI,OAAO,EAAE,SAAS;QAAE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAEvE,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACtB,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrF,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,SAAS,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,OAAO,WAAW;IAItB,YAAY,MAAyB;QACnC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;QACnF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;QAEvF,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,MAAM;YACT,OAAO,EAAE,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC;YACzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;YAC5B,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YAChC,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,SAAS;SACnD,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAA4B,EAAE,OAA6B;QAC5E,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,kBAAkB,EAAE,EAAE;YACnF,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;YACjD,IAAI;YACJ,MAAM,EAAE,OAAO,EAAE,MAAM;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAyB,CAAC;IACzD,CAAC;CACF;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAyB;IACzD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAY,EAAE,UAAkB;IACrE,OAAO,UAAU,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACjF,CAAC"}
|
package/dist/env.d.ts
CHANGED
|
File without changes
|
package/dist/env.d.ts.map
CHANGED
|
File without changes
|
package/dist/env.js
CHANGED
|
File without changes
|
package/dist/env.js.map
CHANGED
|
File without changes
|
package/dist/errors.d.ts
CHANGED
|
File without changes
|
package/dist/errors.d.ts.map
CHANGED
|
File without changes
|
package/dist/errors.js
CHANGED
|
File without changes
|
package/dist/errors.js.map
CHANGED
|
File without changes
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { EmailClient, createEmailClient, createRequestSignature } from './client.js';
|
|
2
2
|
export { emailClientConfigFromEnv } from './env.js';
|
|
3
3
|
export { EmailApiError, EmailClientConfigError } from './errors.js';
|
|
4
|
-
export type { EmailApiErrorPayload, EmailClientConfig, EmailClientEnv, EmailRecipient, EmailTemplateData, SendTemplateOptions, SendTemplateRequest, SendTemplateResponse, } from './types.js';
|
|
4
|
+
export type { EmailAttachment, EmailApiErrorPayload, EmailClientConfig, EmailClientEnv, EmailRecipient, EmailTemplateData, SendTemplateOptions, SendTemplateRequest, SendTemplateResponse, } from './types.js';
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,YAAY,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,YAAY,CAAC"}
|
package/dist/index.js
CHANGED
|
File without changes
|
package/dist/index.js.map
CHANGED
|
File without changes
|
package/dist/types.d.ts
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
export type EmailRecipient = string | string[];
|
|
2
2
|
export type EmailTemplateData = Record<string, unknown>;
|
|
3
|
+
export type EmailAttachment = {
|
|
4
|
+
filename: string;
|
|
5
|
+
contentType: 'text/calendar' | 'application/pdf';
|
|
6
|
+
/** Canonical base64, with at most four attachments totaling 512,000 decoded bytes. */
|
|
7
|
+
content: string;
|
|
8
|
+
};
|
|
3
9
|
export type SendTemplateRequest = {
|
|
4
10
|
to: EmailRecipient;
|
|
5
11
|
data?: EmailTemplateData;
|
|
@@ -8,6 +14,7 @@ export type SendTemplateRequest = {
|
|
|
8
14
|
category?: string;
|
|
9
15
|
cc?: EmailRecipient;
|
|
10
16
|
bcc?: EmailRecipient;
|
|
17
|
+
attachments?: EmailAttachment[];
|
|
11
18
|
} & ({
|
|
12
19
|
templateId: string;
|
|
13
20
|
templateKey?: never;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAE/C,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAExD,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,cAAc,CAAC;IACnB,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,cAAc,CAAC;IACpB,GAAG,CAAC,EAAE,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAE/C,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAExD,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,eAAe,GAAG,iBAAiB,CAAC;IACjD,sFAAsF;IACtF,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,cAAc,CAAC;IACnB,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,cAAc,CAAC;IACpB,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;CACjC,GAAG,CACA;IACE,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,KAAK,CAAC;IACpB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CACJ,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAE5F,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,cAAc,CAAC,EAAE,WAAW,CAAC;IAC7B,sBAAsB,CAAC,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}
|
package/dist/types.js
CHANGED
|
File without changes
|
package/dist/types.js.map
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudstrife21/email-sdk",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Server-side TypeScript client for the StrongStart email send API.",
|
|
3
|
+
"version": "0.1.3",
|
|
5
4
|
"type": "module",
|
|
6
5
|
"sideEffects": false,
|
|
7
6
|
"main": "./dist/index.js",
|
|
8
7
|
"types": "./dist/index.d.ts",
|
|
9
|
-
"files": [
|
|
10
|
-
"dist",
|
|
11
|
-
"README.md"
|
|
12
|
-
],
|
|
13
8
|
"exports": {
|
|
14
9
|
".": {
|
|
15
10
|
"types": "./dist/index.d.ts",
|
|
16
11
|
"import": "./dist/index.js"
|
|
17
12
|
}
|
|
18
13
|
},
|
|
14
|
+
"files": [
|
|
15
|
+
"dist",
|
|
16
|
+
"README.md"
|
|
17
|
+
],
|
|
18
|
+
"description": "Server-side TypeScript client for the StrongStart email send API.",
|
|
19
19
|
"engines": {
|
|
20
20
|
"node": ">=18"
|
|
21
21
|
},
|
|
@@ -24,13 +24,11 @@
|
|
|
24
24
|
},
|
|
25
25
|
"scripts": {
|
|
26
26
|
"build": "tsc -p tsconfig.build.json",
|
|
27
|
-
"prepublishOnly": "npm run build
|
|
28
|
-
"test": "vitest run",
|
|
29
|
-
"test:watch": "vitest"
|
|
27
|
+
"prepublishOnly": "npm run build"
|
|
30
28
|
},
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"
|
|
34
|
-
"
|
|
29
|
+
"repository": {
|
|
30
|
+
"type": "git",
|
|
31
|
+
"url": "https://github.com/gilgamesh2243/esp.git",
|
|
32
|
+
"directory": "packages/email-sdk"
|
|
35
33
|
}
|
|
36
|
-
}
|
|
34
|
+
}
|