@mailoo/forms 1.32.2 → 1.34.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 (2) hide show
  1. package/README.md +15 -11
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -9,16 +9,17 @@ BFF route factories, client hooks, and server-side event ingest.
9
9
  pnpm add @mailoo/forms @mailoo/next-core
10
10
  ```
11
11
 
12
- Published on npm as `@mailoo/forms`. Inside this monorepo, apps use
13
- `workspace:*`.
12
+ https://www.npmjs.com/package/@mailoo/forms
13
+
14
+ Inside this monorepo, apps use `workspace:*`.
14
15
 
15
16
  ## Scopes (API keys)
16
17
 
17
- | Integration path | Required scope |
18
- |------------------|----------------|
19
- | FORM submit | `webhook.form-submission` (or FULL) |
18
+ | Integration path | Required scope |
19
+ | --------------------- | --------------------------------------- |
20
+ | FORM submit | `webhook.form-submission` (or FULL) |
20
21
  | CONTACT_FORM feedback | `webhook.feedback-submission` (or FULL) |
21
- | Lifecycle events | `lifecycle.ingest` (or FULL) |
22
+ | Lifecycle events | `lifecycle.ingest` (or FULL) |
22
23
 
23
24
  Use a **separate** key (or FULL) for lifecycle — do not reuse a form-only RESTRICTED key.
24
25
 
@@ -47,11 +48,11 @@ Feedback also reads (same prefix):
47
48
 
48
49
  ## Identity (lifecycle)
49
50
 
50
- | Field | Who owns it | Use |
51
- |-------|-------------|-----|
51
+ | Field | Who owns it | Use |
52
+ | ---------------- | ------------------------ | --------------------------------------------------------------------- |
52
53
  | `externalUserId` | Host (e.g. Firebase UID) | Stable key for ingest, status, welcome idempotency, `consent.changed` |
53
- | `email` | Host + Mailoo | Unique merge / bulk status lookup |
54
- | `contactId` | Mailoo cuid | Debug only — **not** your user id |
54
+ | `email` | Host + Mailoo | Unique merge / bulk status lookup |
55
+ | `contactId` | Mailoo cuid | Debug only — **not** your user id |
55
56
 
56
57
  Pass **both** UID and email on ingest. Do not put email into `externalUserId`.
57
58
 
@@ -121,7 +122,10 @@ Allowed `attributes` keys only: `plan`, `tier`, `country`, `signupChannel`, `ref
121
122
  After **your** app creates or activates a user:
122
123
 
123
124
  ```ts
124
- import { ingestMailooLifecycleEvent, retryMailooLifecycleEvent } from '@mailoo/forms/server'
125
+ import {
126
+ ingestMailooLifecycleEvent,
127
+ retryMailooLifecycleEvent,
128
+ } from '@mailoo/forms/server'
125
129
  import { MAILOO_LIFECYCLE_EVENTS } from '@mailoo/forms/events'
126
130
 
127
131
  const result = await ingestMailooLifecycleEvent({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mailoo/forms",
3
- "version": "1.32.2",
3
+ "version": "1.34.0",
4
4
  "description": "Mailoo FORM and CONTACT_FORM (feedback) Next.js BFF helpers, hooks, and lifecycle events",
5
5
  "license": "LicenseRef-Mailoo-NoModification",
6
6
  "homepage": "https://mailoo.app/en/support/docs/integrations/nextjs-packages",
@@ -59,7 +59,7 @@
59
59
  "react": ">=18.3.1"
60
60
  },
61
61
  "devDependencies": {
62
- "@mailoo/next-core": "1.32.2",
62
+ "@mailoo/next-core": "1.34.0",
63
63
  "@types/node": "^25.9.5",
64
64
  "@types/react": "^19.2.18",
65
65
  "next": "^16.3.4",