@usgb/forms 1.0.5 → 1.0.6

package/README.md

@@ -35,7 +35,7 @@ Use `listFormDefinitions()` (or the manifest) when a CMS needs a picker of avail
 | -------------------------------- | ------------ | --------------------------------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------ |
 | `magento-fik-10dlc`              | `lead`       | First name, last name, email (required); phone (optional) | Optional TCPA (v1), marketing SMS, and terms/privacy checkboxes | `dense`, `large`, or `sidebar`; optional two-column name row |
 | `magento-ira-401k`               | `lead`       | First name, last name, email, phone (all required)        | Optional TCPA checkbox (v2, links terms and privacy)            | `dense`, `large`, or `sidebar`; optional two-column name row |
-| `magento-fik`                    | `lead`       | First name, last name, email, phone (all required)        | Required TCPA checkbox (v3, links terms and privacy)            | `dense`, `large`, or `sidebar`; optional two-column name row |
+| `magento-fik`                    | `lead`       | First name, last name, email, phone (all required)        | Required TCPA checkbox (v2, links terms and privacy)            | `dense`, `large`, or `sidebar`; optional two-column name row |
 | `magento-footer`                 | `newsletter` | Email only                                                | None                                                            | None — omit `variant` and `twoColumn` / `two-column`         |
 | `wp-full-lead`                   | `lead`       | First name, last name, email, phone (all required)        | Clickwrap notice only (`lead-clickwrap` v2)                     | `dense`, `large`, or `sidebar`; optional two-column name row |
 | `wp-request-call-back`           | `lead`       | Same as `wp-full-lead`                                    | Same as `wp-full-lead`                                          | Same as `wp-full-lead`                                       |
@@ -258,7 +258,7 @@ interface HostAdapter {
 
 ### Payload shape (summary)
 
-Successful submits send `formId`, `definitionVersion`, `submissionContractVersion`, `idempotencyKey`, `data`, and optional `consents` (grant booleans, opt-in dates, and `*_consent_language` strings). `data` is an array of `{ name, value }` entries in catalog field order:
+Successful submits send `formId`, `definitionVersion`, `submissionContractVersion`, `idempotencyKey`, `data`, and optional `consents`. `data` and `consents` are both arrays of `{ name, value }` entries. `data` follows catalog field order:
 
 ```json
 "data": [
@@ -269,7 +269,22 @@ Successful submits send `formId`, `definitionVersion`, `submissionContractVersio
 ]
 ```
 
-Exact field sets come from the form’s catalog entry.
+`consents` uses the same shape. Each pinned policy sends the language shown, including when its checkbox is unchecked. A checkbox also sends its grant flag as `true` or `false`. Its opt-in date is included only when that checkbox is checked. A notice has no grant flag: submit is the acknowledgment, so the payload sends `tcpa_consent_language` and `tcpa_form_opt_in_date`. Opt-in dates are `YYYY-MM-DD` in UTC. The timezone is not confirmed. This package does not keep a previously stored consent date.
+
+```json
+"consents": [
+    { "name": "tcpa_consent_language", "value": "…" },
+    { "name": "tcpa_form_consent_granted", "value": true },
+    { "name": "tcpa_form_opt_in_date", "value": "2026-10-06" },
+    { "name": "sms_consent_language", "value": "…" },
+    { "name": "sms_form_consent_granted", "value": false },
+    { "name": "tospp_consent_language", "value": "…" },
+    { "name": "tospp_form_consent_granted", "value": true },
+    { "name": "tospp_form_opt_in_date", "value": "2026-10-06" }
+]
+```
+
+Exact field sets come from the form’s catalog entry. `sms_form_opt_in_date` and `tospp_form_opt_in_date` are sent by this package when those checkboxes are checked. Creating and mapping those fields in HubSpot and Workato is separate work.
 
 ## Consent and legal URLs
 
@@ -277,15 +292,15 @@ Consent policies are versioned and package-owned (checkboxes and/or clickwrap no
 
 -   `magento-fik-10dlc` pins `lead-tcpa`, `lead-sms`, and `lead-tospp` (all v1, optional checkboxes). Required URLs: `userAgreement`, `privacyPolicy` (`user-agreement-url`, `privacy-policy-url`).
 -   `magento-ira-401k` pins `lead-tcpa` v2 only (optional checkbox). Unlike v1, v2 links the terms and privacy policy, so required URLs: `userAgreement`, `privacyPolicy`.
--   `magento-fik` pins `lead-tcpa` v3 only (required checkbox: automated text-message consent; “Terms of Service” links `userAgreement`, “Privacy Policy” links `privacyPolicy`). It shares the v1 payload keys. Required URLs: `userAgreement`, `privacyPolicy`.
--   WordPress lead forms pin `lead-clickwrap` v2 (notice only: Privacy Policy, Terms & Conditions, and text/call consent). Required URLs: `privacyPolicy`, `userAgreement`. They share the v1 payload key `clickwrap_consent_language`. `lead-clickwrap` v1 (five document links) stays in the catalog and is not pinned.
+-   `magento-fik` pins `lead-tcpa` v2 only (required checkbox: telephone and SMS consent, including autodialer disclosure; “terms and conditions” links `userAgreement`, “privacy policy” links `privacyPolicy`). It shares the v1 payload keys. Required URLs: `userAgreement`, `privacyPolicy`.
+-   WordPress lead forms pin `lead-clickwrap` v2 (notice only: Privacy Policy, Terms & Conditions, and text/call consent). Required URLs: `privacyPolicy`, `userAgreement`. Both clickwrap versions record the shown copy as `tcpa_consent_language` and the submit date as `tcpa_form_opt_in_date` (the same keys as the TCPA checkboxes). They do not send a grant flag. `lead-clickwrap` v1 (five document links) stays in the catalog and is not pinned.
 -   `magento-footer` has no consents and needs no legal URLs.
 -   `LEGAL_URL_ATTRS` lists every host-owned slot, including `clientAgreement` / `client-agreement-url`. No current catalog consent requires `clientAgreement`; it is still valid on `legalUrls` / the attribute (PWA Magento ships it in `PWA_LEGAL_URLS`).
 -   PWA Magento defaults (`PWA_LEGAL_URLS`): `/content/client-agreement`, `/content/privacy-policy`, `/content/user-agreement`, `/content/market-loss-policy`, `/content/electronic-disclaimer`, `/content/terms-of-sale`.
 -   WordPress must pass every URL required by the selected consents. A form with a missing required URL **does not render**. CMS pickers can compute the list with `getFormDefinition`, `resolveFormConsents`, and `collectRequiredLegalUrls`, then map keys through `LEGAL_URL_ATTRS`.
 -   `isCompleteLegalUrls(legalUrls, requiredKeys)` is the same check the renderer uses.
--   Checkbox grants land in `consents` only (`tcpa_form_consent_granted`, `sms_form_consent_granted`, `tospp_form_consent_granted`). The exact copy shown is `tcpa_consent_language` (and the matching keys for other policies), even when unchecked.
--   Checking the TCPA box also adds `tcpa_form_opt_in_date` (YYYY-MM-DD). Clickwrap forms only send `clickwrap_consent_language`.
+-   Checkbox grants land in `consents` only (`tcpa_form_consent_granted`, `sms_form_consent_granted`, `tospp_form_consent_granted`), each as `true` or `false`. The exact copy shown is `tcpa_consent_language`, `sms_consent_language`, or `tospp_consent_language`, even when that checkbox is unchecked.
+-   A checked TCPA, SMS, or terms/privacy box also adds `tcpa_form_opt_in_date`, `sms_form_opt_in_date`, or `tospp_form_opt_in_date` (`YYYY-MM-DD`, UTC). An unchecked box omits its date. Clickwrap notices send `tcpa_consent_language` and `tcpa_form_opt_in_date`, and no grant flag.
 -   Hosts supply document hrefs only. Consent wording stays in this package.
 
 ## Success behavior

package/dist/{forms-manifest.1.0.5.json → forms-manifest.1.0.6.json}

@@ -342,13 +342,13 @@
             "consents": [
                 {
                     "definitionId": "lead-tcpa",
-                    "definitionVersion": "3",
+                    "definitionVersion": "2",
                     "required": true
                 }
             ],
             "editor": {
                 "label": "Magento FIK",
-                "description": "First name, last name, email, and phone required. Required automated text-message consent checkbox with linked terms of service and privacy policy (lead-tcpa v3).",
+                "description": "First name, last name, email, and phone required. Required telephone and SMS consent checkbox with linked terms and privacy (lead-tcpa v2).",
                 "whenToUse": "TBD",
                 "whenNotToUse": "TBD",
                 "options": [

package/dist/forms-manifest.json

@@ -342,13 +342,13 @@
             "consents": [
                 {
                     "definitionId": "lead-tcpa",
-                    "definitionVersion": "3",
+                    "definitionVersion": "2",
                     "required": true
                 }
             ],
             "editor": {
                 "label": "Magento FIK",
-                "description": "First name, last name, email, and phone required. Required automated text-message consent checkbox with linked terms of service and privacy policy (lead-tcpa v3).",
+                "description": "First name, last name, email, and phone required. Required telephone and SMS consent checkbox with linked terms and privacy (lead-tcpa v2).",
                 "whenToUse": "TBD",
                 "whenNotToUse": "TBD",
                 "options": [