@particle-academy/resend-js 0.2.0 → 0.3.0

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 (3) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/README.md +40 -0
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -7,6 +7,40 @@ The four packages share one version, because they are generated from one
7
7
  `provider/` definition and a version that meant something different in each
8
8
  would be a version nobody could reason about.
9
9
 
10
+ ## [0.3.0] — 2026-08-24
11
+
12
+ ### Added
13
+
14
+ - **The README now says how to SET THIS CONNECTOR UP**, in the package itself.
15
+
16
+ Until now it explained what the four packages are, what they cost and why the
17
+ repo is generated — and said nothing about credentials, scopes, sandboxes or
18
+ operations. Somebody who installed it could not learn from it which credentials
19
+ a connection needs, where a human GETS them, which scopes to request, or what
20
+ the connector can actually do. All of that was already in the definition; the
21
+ one document a consumer reads was the one that omitted everything actionable.
22
+
23
+ The new **Setting it up** section carries:
24
+
25
+ - every credential, with the text saying where the value comes from, whether it
26
+ is **per installation** or **per connected account**, and whether it is secret;
27
+ - the OAuth authorize and token URLs and the exact scopes, verbatim;
28
+ - the access-token lifetime, and where refresh tokens ROTATE, the two things a
29
+ host must not do — retry a failed refresh, or refresh concurrently — because a
30
+ replay revokes the entire grant and nothing in the failure says why;
31
+ - the estate in this provider's own terms, including the cases where a
32
+ successful-looking run reaches nobody, or reaches the real one;
33
+ - every action and trigger with its method, path, inputs, and whether it is safe
34
+ to replay;
35
+ - a trigger's provider-side setup, which nobody can derive from anything else.
36
+
37
+ It is **generated from `provider/manifest.json`**, so it cannot drift from what
38
+ the packages do — which is the point at a few hundred providers, where a
39
+ hand-written setup section is a few hundred documents going quietly stale.
40
+
41
+ No code changed. This release exists because a registry and an installing agent
42
+ read the PUBLISHED artifact, and the artifact carried the old README.
43
+
10
44
  ## [0.2.0] — 2026-08-24
11
45
 
12
46
  ### Changed
@@ -82,3 +116,4 @@ only webhook the vocabulary has ever described.
82
116
 
83
117
  [0.1.0]: https://github.com/Fancy-Friends/resend/releases/tag/v0.1.0
84
118
  [0.2.0]: https://github.com/Fancy-Friends/resend/releases/tag/v0.2.0
119
+ [0.3.0]: https://github.com/Fancy-Friends/resend/releases/tag/v0.3.0
package/README.md CHANGED
@@ -27,6 +27,46 @@ dependencies.
27
27
  subject to the kit's full approval bar, and one per provider is hundreds of
28
28
  dependencies nobody is tracking.
29
29
 
30
+ ## Setting it up
31
+
32
+ Everything below is generated from `provider/manifest.json`, so it cannot disagree with what the packages do.
33
+
34
+ ### Credentials
35
+
36
+ A Resend connection holds 1 value.
37
+
38
+ Every value here is `account` scope: one per connected account, not one per installation.
39
+
40
+ | Field | Scope | Secret | Where it comes from |
41
+ |---|---|---|---|
42
+ | **API key** | per connected account | **secret** | re_... from the Resend dashboard. There is only one estate, so this key sends real email. |
43
+
44
+ ### The estate
45
+
46
+ **Resend has no test estate, and somebody checked.** Everything this connector does is real. Use the faker to build against it.
47
+
48
+ > Resend has NO test estate, and somebody checked. Its simulator RECIPIENTS -- delivered@resend.dev, bounced@resend.dev, complained@resend.dev, suppressed@resend.dev -- are not one: the send is real, it is billed, and it counts against the quota. Modelling them as a sandbox would put a live send behind a control labelled "test", so `mode` does not offer sandbox at all and `fake` is the primary development mode rather than the fallback.
49
+
50
+ ## What it can do
51
+
52
+ ### Actions
53
+
54
+ #### `email_send` — Send email
55
+
56
+ Send an email through Resend.
57
+
58
+ `POST /emails` · idempotent — safe to replay
59
+
60
+ | Input | Required | What it is |
61
+ |---|---|---|
62
+ | `from` | yes | Must be an address on a domain you have verified with Resend. An unverified sender is refused at send time, not at setup. |
63
+ | `to` | yes | One address, a comma-separated list, or an expression. Resend's simulator addresses (delivered@resend.dev, bounced@resend.dev) are LIVE sends that are billed and counted — they are not a sandbox. |
64
+ | `subject` | no | Subject |
65
+ | `html` | no | HTML body |
66
+ | `text` | no | Plain-text body |
67
+ | `replyTo` | no | Reply-To |
68
+ | `headers` | no | Sent as the email's own headers. The usual use is a threading or reference id. |
69
+
30
70
  ## Run it before you have credentials
31
71
 
32
72
  Every operation ships a **faker**, whether or not Resend has a sandbox. Set a
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@particle-academy/resend-js",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Resend for Node — the service descriptor, its faker, its webhook verification, and one function per operation. Plain HTTP on @particle-academy/fancy-connector-core; no vendor SDK.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -52,7 +52,7 @@
52
52
  },
53
53
  "peerDependencies": {
54
54
  "@particle-academy/fancy-flow": ">=0.47.1 <2.0",
55
- "@particle-academy/resend-ui": "0.2.0"
55
+ "@particle-academy/resend-ui": "0.3.0"
56
56
  },
57
57
  "peerDependenciesMeta": {
58
58
  "@particle-academy/fancy-flow": {