@usgb/forms 1.0.2 → 1.0.4

package/forms-manifest.json

@@ -1,13 +1,12 @@
 {
-    "schemaVersion": "1.0.0",
+    "schemaVersion": "1.1.0",
     "package": {
         "name": "@usgb/forms",
         "compatiblePackageVersions": "^1.0.2"
     },
     "submissionContract": {
         "version": "1.0.0",
-        "transport": "server-proxy",
-        "payloadShape": "data-and-context"
+        "transport": "server-proxy"
     },
     "trackingRegistry": {
         "page_url": {
@@ -152,40 +151,105 @@
             "states": ["collected", "unavailable"]
         }
     },
+    "editorOptions": {
+        "appearance": {
+            "label": "Appearance",
+            "control": "select",
+            "reactProp": "appearance",
+            "attribute": "appearance",
+            "required": false,
+            "default": "on-light",
+            "valuesFrom": "supportedAppearances",
+            "description": "Recolors the form for a light or dark host surface. It never paints a background, padding, or radius — the host container owns those."
+        },
+        "variant": {
+            "label": "Size variant",
+            "control": "select",
+            "reactProp": "variant",
+            "attribute": "variant",
+            "required": false,
+            "default": "dense",
+            "valuesFrom": "supportedVariants",
+            "description": "Select exactly one size treatment: `dense`, `large`, or `sidebar`."
+        },
+        "twoColumn": {
+            "label": "Two-column name row",
+            "control": "checkbox",
+            "reactProp": "twoColumn",
+            "attribute": "two-column",
+            "required": false,
+            "default": false,
+            "description": "Places grouped name fields in two columns when the form container is wide enough."
+        },
+        "heading": {
+            "label": "Heading",
+            "control": "text",
+            "reactProp": "heading",
+            "attribute": "heading",
+            "required": false,
+            "description": "Placement copy above the fields. Omit to render no heading."
+        },
+        "subheading": {
+            "label": "Subheading",
+            "control": "text",
+            "reactProp": "subheading",
+            "attribute": "subheading",
+            "required": false,
+            "description": "Supporting copy under the heading. Omit to render none."
+        },
+        "ctaLabel": {
+            "label": "Button label",
+            "control": "text",
+            "reactProp": "ctaLabel",
+            "attribute": "cta",
+            "required": false,
+            "defaultFrom": "ctaLabel",
+            "description": "Overrides the catalog submit label for this placement."
+        },
+        "legalUrls": {
+            "label": "Legal document URLs",
+            "control": "url-group",
+            "reactProp": "legalUrls",
+            "attributes": {
+                "clientAgreement": "client-agreement-url",
+                "privacyPolicy": "privacy-policy-url",
+                "userAgreement": "user-agreement-url",
+                "marketLossPolicy": "market-loss-policy-url",
+                "electronicDisclaimer": "electronic-disclaimer-url",
+                "termsOfSale": "terms-of-sale-url"
+            },
+            "required": true,
+            "valuesFrom": "requiredLegalUrls",
+            "description": "Host CMS hrefs for the documents named in this form's consent copy. Every key in `requiredLegalUrls` must be a non-empty URL or the form does not render."
+        },
+        "successMessage": {
+            "label": "Thank-you message",
+            "control": "text",
+            "reactProp": "successMessage",
+            "attribute": "success-message",
+            "required": false,
+            "description": "Inline copy shown after accept. Ignored when a thank-you URL is set; omitted values fall back to a package default line."
+        },
+        "successUrl": {
+            "label": "Thank-you URL",
+            "control": "url",
+            "reactProp": "successUrl",
+            "attribute": "success-url",
+            "required": false,
+            "description": "Redirect after accept. A full navigation can cut off analytics beacons — prefer measuring the conversion on the thank-you page."
+        }
+    },
     "forms": {
-        "main-investors-kit": {
+        "magento-fik": {
             "definitionVersion": "1",
             "kind": "lead",
             "flow": { "type": "single" },
-            "supportedHosts": ["pwa", "wordpress"],
             "fields": [
                 { "name": "firstname", "required": true, "group": "name" },
                 { "name": "lastname", "required": true, "group": "name" },
                 { "name": "email", "required": true },
                 { "name": "phone", "required": false }
             ],
-            "trackingFields": [
-                "page_url",
-                "page_title",
-                "referrer",
-                "first_touch_url",
-                "utm_source",
-                "utm_medium",
-                "utm_campaign",
-                "utm_term",
-                "utm_content",
-                "gclid",
-                "msclkid",
-                "gbraid",
-                "wbraid",
-                "hubspot_utk",
-                "ga_client_id",
-                "ga_session_id",
-                "snowplow_id",
-                "vwo_uuid",
-                "user_agent",
-                "ip_address"
-            ],
             "ctaLabel": "GET MY FREE GUIDE",
             "consents": [
                 {
@@ -205,98 +269,168 @@
                 }
             ],
             "editor": {
-                "label": "Main Investors Kit",
-                "description": "Standard lead form: name, email, phone, plus optional TCPA, marketing SMS, and terms/privacy checkboxes. Use on full-width landing pages and PWA kit/sidebar placements.",
-                "whenToUse": "Default kit request with optional consent checkboxes. Do not use for affiliate landers or IRA-specific leads.",
-                "whenNotToUse": "Affiliate pages (separate definition). IRA kit (separate definition when added). Clickwrap-only kit (`main-investors-kit-notice`).",
+                "label": "Magento FIK",
+                "description": "First name, last name, and email required; phone optional. Optional checkboxes: transactional SMS (lead-tcpa v1), marketing SMS (lead-sms v1), and terms and privacy (lead-tospp v1).",
+                "whenToUse": "TBD",
+                "whenNotToUse": "TBD",
+                "options": [
+                    "appearance",
+                    "variant",
+                    "twoColumn",
+                    "heading",
+                    "subheading",
+                    "ctaLabel",
+                    "legalUrls",
+                    "successMessage",
+                    "successUrl"
+                ],
                 "supportedAppearances": ["on-light", "on-dark"],
-                "supportedVariants": ["dense", "large", "sidebar", "two-column"]
+                "supportedVariants": ["dense", "large", "sidebar"],
+                "requiredLegalUrls": ["userAgreement", "privacyPolicy"]
             }
         },
-        "main-investors-kit-notice": {
+        "magento-ira-kick-article": {
             "definitionVersion": "1",
             "kind": "lead",
             "flow": { "type": "single" },
-            "supportedHosts": ["pwa", "wordpress"],
             "fields": [
                 { "name": "firstname", "required": true, "group": "name" },
                 { "name": "lastname", "required": true, "group": "name" },
                 { "name": "email", "required": true },
-                { "name": "phone", "required": false }
+                { "name": "phone", "required": true }
             ],
-            "trackingFields": [
-                "page_url",
-                "page_title",
-                "referrer",
-                "first_touch_url",
-                "utm_source",
-                "utm_medium",
-                "utm_campaign",
-                "utm_term",
-                "utm_content",
-                "gclid",
-                "msclkid",
-                "gbraid",
-                "wbraid",
-                "hubspot_utk",
-                "ga_client_id",
-                "ga_session_id",
-                "snowplow_id",
-                "vwo_uuid",
-                "user_agent",
-                "ip_address"
+            "ctaLabel": "GET MY FREE GUIDE",
+            "consents": [
+                {
+                    "definitionId": "lead-tcpa",
+                    "definitionVersion": "2",
+                    "required": false
+                }
+            ],
+            "editor": {
+                "label": "Magento IRA Kick Article",
+                "description": "First name, last name, email, and phone required. Optional telephone and SMS consent checkbox with linked terms and privacy (lead-tcpa v2).",
+                "whenToUse": "TBD",
+                "whenNotToUse": "TBD",
+                "options": [
+                    "appearance",
+                    "variant",
+                    "twoColumn",
+                    "heading",
+                    "subheading",
+                    "ctaLabel",
+                    "legalUrls",
+                    "successMessage",
+                    "successUrl"
+                ],
+                "supportedAppearances": ["on-light", "on-dark"],
+                "supportedVariants": ["dense", "large", "sidebar"],
+                "requiredLegalUrls": ["userAgreement", "privacyPolicy"]
+            }
+        },
+        "magento-fik-blog-rail": {
+            "definitionVersion": "1",
+            "kind": "lead",
+            "flow": { "type": "single" },
+            "fields": [
+                { "name": "firstname", "required": true, "group": "name" },
+                { "name": "lastname", "required": true, "group": "name" },
+                { "name": "email", "required": true },
+                { "name": "phone", "required": true }
             ],
             "ctaLabel": "GET MY FREE GUIDE",
             "consents": [
-                { "definitionId": "lead-clickwrap", "definitionVersion": "1" }
+                {
+                    "definitionId": "lead-tcpa",
+                    "definitionVersion": "3",
+                    "required": true
+                }
+            ],
+            "editor": {
+                "label": "Magento FIK Blog Rail",
+                "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).",
+                "whenToUse": "TBD",
+                "whenNotToUse": "TBD",
+                "options": [
+                    "appearance",
+                    "variant",
+                    "twoColumn",
+                    "heading",
+                    "subheading",
+                    "ctaLabel",
+                    "legalUrls",
+                    "successMessage",
+                    "successUrl"
+                ],
+                "supportedAppearances": ["on-light", "on-dark"],
+                "supportedVariants": ["dense", "large", "sidebar"],
+                "requiredLegalUrls": ["userAgreement", "privacyPolicy"]
+            }
+        },
+        "main-investors-kit-notice": {
+            "definitionVersion": "1",
+            "kind": "lead",
+            "flow": { "type": "single" },
+            "fields": [
+                { "name": "firstname", "required": true, "group": "name" },
+                { "name": "lastname", "required": true, "group": "name" },
+                { "name": "email", "required": true },
+                { "name": "phone", "required": false }
+            ],
+            "ctaLabel": "CLAIM YOUR OFFER",
+            "consents": [
+                { "definitionId": "lead-clickwrap", "definitionVersion": "2" }
             ],
             "editor": {
                 "label": "Main Investors Kit (clickwrap)",
-                "description": "Same fields as Main Investors Kit with a clickwrap notice only — no consent checkboxes.",
-                "whenToUse": "Kit request where submit acknowledges legal docs via notice copy instead of checkboxes.",
-                "whenNotToUse": "Placements that need TCPA / marketing SMS / terms checkboxes (`main-investors-kit`).",
+                "description": "First name, last name, and email required; phone optional. Clickwrap notice only (lead-clickwrap v2); no consent checkboxes.",
+                "whenToUse": "TBD",
+                "whenNotToUse": "TBD",
+                "options": [
+                    "appearance",
+                    "variant",
+                    "twoColumn",
+                    "heading",
+                    "subheading",
+                    "ctaLabel",
+                    "legalUrls",
+                    "successMessage",
+                    "successUrl"
+                ],
                 "supportedAppearances": ["on-light", "on-dark"],
-                "supportedVariants": ["dense", "large", "sidebar", "two-column"]
+                "supportedVariants": ["dense", "large", "sidebar"],
+                "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
             }
         },
         "newsletter": {
             "definitionVersion": "1",
             "kind": "newsletter",
             "flow": { "type": "single" },
-            "supportedHosts": ["pwa"],
             "fields": [{ "name": "email", "required": true }],
-            "trackingFields": [
-                "page_url",
-                "page_title",
-                "referrer",
-                "utm_source",
-                "utm_medium",
-                "utm_campaign",
-                "utm_term",
-                "utm_content"
-            ],
             "ctaLabel": "SUBSCRIBE",
             "editor": {
                 "label": "Newsletter",
-                "description": "Email-only newsletter signup. No TCPA consent.",
-                "whenToUse": "Footer or landing newsletter capture where only an email is required.",
-                "whenNotToUse": "Lead kits that need name, phone, or TCPA consent.",
+                "description": "Email only. No consent.",
+                "whenToUse": "TBD",
+                "whenNotToUse": "TBD",
+                "options": [
+                    "appearance",
+                    "heading",
+                    "subheading",
+                    "ctaLabel",
+                    "successMessage",
+                    "successUrl"
+                ],
                 "supportedAppearances": ["on-light", "on-dark"],
-                "supportedVariants": []
+                "supportedVariants": [],
+                "requiredLegalUrls": []
             }
         }
     },
     "hostAdapterContract": {
         "hosts": ["pwa", "wordpress"],
-        "mayProvide": [
-            "browser cookies",
-            "URL parameters",
-            "page and placement context",
-            "host/store identity"
-        ],
+        "mayProvide": ["legal document URLs", "host/store identity"],
         "mustNotDefine": [
-            "new tracking keys",
-            "destination property names",
             "consent definitions",
             "form fields",
             "submission endpoints"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@usgb/forms",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "description": "Shared USGB lead-form package for PWA and WordPress",
     "type": "module",
     "license": "MIT",