@linkpane/newsletter-subscribe 0.1.0 → 1.0.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.
- package/README.md +20 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# @linkpane/newsletter-subscribe
|
|
2
2
|
|
|
3
|
-
Subscribe-only SDK for Linkpane Newsletter endpoints.
|
|
3
|
+
Subscribe-only SDK for Linkpane Newsletter endpoints. Use this to add email
|
|
4
|
+
subscribers without building your own newsletter backend.
|
|
5
|
+
|
|
6
|
+
Linkpane Mailer is a hosted form and email capture service by Haqqman. It allows you to collect form submissions and newsletter signups without building, deploying, or maintaining your own backend.
|
|
4
7
|
|
|
5
8
|
## Install
|
|
6
9
|
|
|
@@ -30,5 +33,19 @@ if (!result.ok) {
|
|
|
30
33
|
|
|
31
34
|
## Notes
|
|
32
35
|
|
|
33
|
-
|
|
34
|
-
|
|
36
|
+
### Required Fields
|
|
37
|
+
Required fields depend on your Linkpane Newsletter configuration.
|
|
38
|
+
Most setups require:
|
|
39
|
+
- `email`
|
|
40
|
+
|
|
41
|
+
Common optional fields:
|
|
42
|
+
- `firstName`
|
|
43
|
+
- `lastName`
|
|
44
|
+
|
|
45
|
+
### Origin Rules
|
|
46
|
+
For browser usage, ensure the request Origin matches the configured source domain.
|
|
47
|
+
For server-side usage, you must set an `Origin` header that matches the configured
|
|
48
|
+
source domain.
|
|
49
|
+
|
|
50
|
+
### Server Usage
|
|
51
|
+
You can supply a custom `fetch` for server environments.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@linkpane/newsletter-subscribe",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Subscribe-only SDK for Linkpane Newsletter endpoints",
|
|
5
5
|
"main": "dist-cjs/index.js",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -19,4 +19,4 @@
|
|
|
19
19
|
"engines": {
|
|
20
20
|
"node": ">=16"
|
|
21
21
|
}
|
|
22
|
-
}
|
|
22
|
+
}
|