@t4h.framework/smtp 0.7.7 → 0.7.9

package/.ai/skills/framework-smtp/SKILL.md

@@ -29,20 +29,29 @@ export const environments = EnvDesign({
 ```
 
 ```typescript
+import { Workflow } from '@t4h.framework/core'
 import { Smtp } from '@t4h.framework/smtp'
+import Type from 'typebox'
 
 import { environments } from '../constants/environments.js'
 
-const smtp = new Smtp(environments.SMTP_URL, { from: 'noreply@example.com' })
-
-const result = await smtp.send({
-  to: input.email,
-  subject: 'Report',
-  html: '<p>See attached.</p>',
-  attachments: [{ filename: 'report.pdf', content: reportBinary }],
-})
-
-result.messageId
+export const sendReport = new Workflow(
+  { id: 'send-report', schema: Type.Object({ email: Type.String() }) },
+  async input => {
+    const smtp = new Smtp(environments.SMTP_URL, {
+      from: 'noreply@example.com',
+    })
+
+    const result = await smtp.send({
+      to: input.email,
+      subject: 'Report',
+      html: '<p>See attached.</p>',
+      attachments: [{ filename: 'report.pdf', content: reportBinary }],
+    })
+
+    return { messageId: result.messageId }
+  },
+)
 ```
 
 ## Traps
@@ -51,6 +60,8 @@ result.messageId
   `sendEmail`.
 - `new Smtp(...)` takes a `Secret`. A string literal or a `String` env entry is
   a type error.
+- Create the client in the workflow body. A test that imports the module has
+  no env, so a key read at module top level throws `No env storage`.
 - The body field is `html`. There is no `text` field.
 - An attachment `content` is a `Binary` (from `sftp.get`, an HTTP body, `write`
   of `@t4h.framework/fs`). Never build a `Binary` by hand; see the
@@ -71,6 +82,7 @@ normalized input: `to`, `cc` and `bcc` are always arrays.
 ```typescript
 import { TestWorkflowEnvironment, mockClaim } from '@t4h.framework/core/testing'
 import { SmtpSendEmailClaim } from '@t4h.framework/smtp'
+import { expect, vi } from 'vitest'
 
 const send = vi.fn().mockResolvedValue({ messageId: 'msg-123' })
 

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @t4h.framework/smtp
 
+## 0.7.9
+
+### Patch Changes
+
+- [#276](https://github.com/tech4humans-brasil/framework/pull/276) [`7b38934`](https://github.com/tech4humans-brasil/framework/commit/7b38934e8f9207c98c33afcd76e3a7a4da7e8b14) Thanks [@gusteycamargo](https://github.com/gusteycamargo)! - The `framework-smtp` skill creates the `Smtp` client in the workflow body. A
+  read of `environments` at the top of the module throws `No env storage`. The
+  test sample imports `expect` and `vi` from `vitest`.
+
+## 0.7.8
+
 ## 0.7.7
 
 ### Patch Changes

package/README.md

@@ -31,9 +31,9 @@ import { Smtp } from '@t4h.framework/smtp'
 
 import { environments } from './constants/environments.js'
 
-const smtp = new Smtp(environments.SMTP_URL, { from: 'noreply@example.com' })
-
 const notify = new Workflow({ id: 'notify' }, async () => {
+  const smtp = new Smtp(environments.SMTP_URL, { from: 'noreply@example.com' })
+
   const result = await smtp.send({
     to: 'recipient@example.com',
     subject: 'Hello',
@@ -44,6 +44,9 @@ const notify = new Workflow({ id: 'notify' }, async () => {
 })
 ```
 
+Create the `Smtp` client in the workflow body. A test that imports the module
+has no env, so a key read at module top level throws `No env storage`.
+
 ## Documentation
 
 https://tech4humans-brasil.github.io/framework/smtp/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t4h.framework/smtp",
-  "version": "0.7.7",
+  "version": "0.7.9",
   "description": "SMTP module for the T4H Framework",
   "homepage": "https://github.com/tech4humans-brasil/framework/tree/main/packages/smtp",
   "bugs": "https://github.com/tech4humans-brasil/framework/issues",
@@ -33,7 +33,7 @@
     "test:watch": "vitest"
   },
   "devDependencies": {
-    "@t4h.framework/core": "^0.21.0",
+    "@t4h.framework/core": "^0.21.2",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"
   },