@getvitops/generator 8.3.0-alpha.3 → 8.3.0-alpha.5

package/config.schema.json

@@ -158,6 +158,11 @@
                                 "dark"
                               ],
                               "description": "Polarity of `text-on-<role>`, the foreground for a filled surface. Default is whichever of near-white / near-black has more contrast on the solid. Set `\"dark\"` so a bright fill carries dark text (or `\"light\"` for the reverse). The build still fails if the forced pair is below APCA Lc 60."
+                            },
+                            "acknowledgeContrast": {
+                              "type": "number",
+                              "exclusiveMinimum": 0,
+                              "description": "Acknowledge a near miss on this role: a pairing that falls short of its APCA bar by no more than this many Lc is reported as a build warning instead of failing the build (e.g. `1` for a brand colour that lands at Lc 59.5 against 60). A larger shortfall still fails. Applies to this role only."
                             }
                           },
                           "required": [
@@ -2095,7 +2100,7 @@
             "type": "string"
           },
           "additionalProperties": {
-            "anyOf": [
+            "oneOf": [
               {
                 "type": "object",
                 "properties": {
@@ -2178,6 +2183,7 @@
                             "textarea",
                             "select",
                             "checkbox",
+                            "checkboxes",
                             "radio",
                             "date",
                             "file",
@@ -2332,6 +2338,160 @@
           },
           "additionalProperties": false
         },
+        "chrome": {
+          "description": "Page furniture: the masthead (top bar — position, hide-on-scroll, glass/transparent surface, inset/floating layout, shadow/border) and how its navigation behaves at each width (compact drawer or dropdown, mega tier). Read by `<Masthead />` and `<SiteNav />` via `resolveMasthead()` / `resolveNavOptions()`; a prop overrides a field per layout.",
+          "type": "object",
+          "properties": {
+            "masthead": {
+              "description": "The top bar: position, scroll behaviour, surface, layout, elevation.",
+              "type": "object",
+              "properties": {
+                "position": {
+                  "description": "`static` scrolls away; `sticky` stays in flow and pins to the top; `fixed` is out of flow and overlays the first section (for a transparent masthead over a hero). Default `static`.",
+                  "type": "string",
+                  "enum": [
+                    "static",
+                    "sticky",
+                    "fixed"
+                  ]
+                },
+                "behavior": {
+                  "description": "`hide-on-scroll` slides the masthead away while scrolling down and back on scrolling up. Ignored when `position` is `static`. It never hides while a menu inside it is open or has focus. Uses `scroll-state()`; in a browser without it (Firefox today) the masthead just stays visible. Default `always`.",
+                  "type": "string",
+                  "enum": [
+                    "always",
+                    "hide-on-scroll"
+                  ]
+                },
+                "surface": {
+                  "description": "`solid`, `glass` (blurred + tinted via `--surface-glass`), `transparent`, or `transparent-until-scrolled` (clear while the page is at the top, solid once it scrolls; a browser without `scroll-state()` shows it solid throughout). Default `solid`.",
+                  "type": "string",
+                  "enum": [
+                    "solid",
+                    "glass",
+                    "transparent",
+                    "transparent-until-scrolled"
+                  ]
+                },
+                "tone": {
+                  "description": "A `colors.roles` key, optionally `<role>:solid`, applied as the masthead `.tone` so text contrast stays the generator's guarantee.",
+                  "type": "string"
+                },
+                "layout": {
+                  "description": "`full` is flush to the viewport edges; `inset` leaves a gap to them; `floating` is inset with a panel radius. Default `full`.",
+                  "type": "string",
+                  "enum": [
+                    "full",
+                    "inset",
+                    "floating"
+                  ]
+                },
+                "width": {
+                  "description": "`content` keeps the masthead row on the page's `.centered` track; `full` lets it span the masthead. Default `content`.",
+                  "type": "string",
+                  "enum": [
+                    "full",
+                    "content"
+                  ]
+                },
+                "elevation": {
+                  "description": "Shadow and border.",
+                  "type": "object",
+                  "properties": {
+                    "shadow": {
+                      "description": "A `designSystem.shadows` key (e.g. `sm`). Omit for no shadow.",
+                      "type": "string"
+                    },
+                    "border": {
+                      "description": "A bottom border (a full outline when `layout` is not `full`).",
+                      "type": "boolean"
+                    },
+                    "onScroll": {
+                      "description": "Apply the shadow/border only once the page has scrolled, so the masthead sits flush with the page at the top. Uses `scroll-state()` container queries; in a browser without them (Firefox today) the elevation is simply always on.",
+                      "type": "boolean"
+                    }
+                  },
+                  "additionalProperties": false
+                },
+                "height": {
+                  "description": "CSS length for the masthead row (default `4rem`). `calc()`, `clamp()`, `min()` and `max()` are accepted, so it can be fluid: `clamp(3.5rem, 8cqi, 4.5rem)`. `cqi` resolves against the nearest size container (`body`, the same one the nav breakpoints use), `vw` against the viewport. Becomes `--masthead-height` and, when the masthead is sticky or fixed, `--header-offset` so in-page anchors land below it.",
+                  "type": "string"
+                },
+                "inset": {
+                  "description": "Gap between a `layout: inset` or `floating` masthead and the viewport edge (default `0.75rem`). Same length grammar as `height`, e.g. `clamp(0.5rem, 2cqi, 1.5rem)`. Ignored when `layout` is `full`. Becomes `--masthead-inset` and is counted in `--header-offset`.",
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false
+            },
+            "nav": {
+              "description": "How the masthead navigation behaves at each width.",
+              "type": "object",
+              "properties": {
+                "breakpoint": {
+                  "description": "Container width where the default `primary` menu promotes from the compact control to a navbar. Default `md`.",
+                  "type": "string",
+                  "enum": [
+                    "sm",
+                    "md",
+                    "lg",
+                    "xl"
+                  ]
+                },
+                "mobileBreakpoint": {
+                  "description": "Where a `primary-mobile` menu hands over to `primary`. Default = `breakpoint`.",
+                  "type": "string",
+                  "enum": [
+                    "sm",
+                    "md",
+                    "lg",
+                    "xl"
+                  ]
+                },
+                "megaBreakpoint": {
+                  "description": "Where a `primary-mega` menu takes over. Default `xl`.",
+                  "type": "string",
+                  "enum": [
+                    "sm",
+                    "md",
+                    "lg",
+                    "xl"
+                  ]
+                },
+                "depth": {
+                  "description": "Levels in the default nav (1–3). Default 3.",
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 3
+                },
+                "megaDepth": {
+                  "description": "Levels in the mega panel (1–3). Default 3.",
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 3
+                },
+                "compact": {
+                  "description": "What the toggle opens below its breakpoint: an edge `drawer`, or a columnar `dropdown` panel anchored under the toggle. Default `drawer`.",
+                  "type": "string",
+                  "enum": [
+                    "drawer",
+                    "dropdown"
+                  ]
+                },
+                "drawerSide": {
+                  "description": "Edge the drawer slides from when `compact` is `drawer`. Default `end`.",
+                  "type": "string",
+                  "enum": [
+                    "start",
+                    "end"
+                  ]
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
         "seo": {
           "description": "SEO defaults: site name, title/description defaults, robots policy, verification tokens, Open Graph + Twitter cards, and post-deploy indexing notification. Read by `<Seo />`, `vitops robots` and `vitops search notify`.",
           "type": "object",
@@ -2708,6 +2868,46 @@
               "items": {
                 "type": "string"
               }
+            },
+            "phoneNumbers": {
+              "description": "Show a visitor from an ad the tracking number for that platform instead of the real one. Swapped in by the capture script from the landing URL (immediately) or the `_ac` cookie (later pages, once `marketing` is granted); the matching `tel:` links are rewritten too. An organic visitor is never swapped. Needs `enabled: true`.",
+              "type": "object",
+              "properties": {
+                "number": {
+                  "type": "string",
+                  "description": "The real phone number exactly as the site displays it. Server-rendered HTML always carries this one, so crawlers, structured data and visitors without JavaScript see it."
+                },
+                "sources": {
+                  "type": "object",
+                  "propertyNames": {
+                    "type": "string",
+                    "enum": [
+                      "google",
+                      "meta",
+                      "linkedin",
+                      "reddit",
+                      "tiktok",
+                      "microsoft",
+                      "pinterest",
+                      "snapchat",
+                      "default-paid"
+                    ]
+                  },
+                  "additionalProperties": {
+                    "type": "string"
+                  },
+                  "description": "Tracking numbers keyed by ad platform (the `site.ads` provider names), each provisioned with a call-tracking provider and forwarding to `number`. `default-paid` is the fallback for a paid visit from a platform with no number of its own. Google needs no entry when `site.ads.google.callTracking` is set — Google supplies its own."
+                },
+                "provider": {
+                  "description": "The call-tracking provider (e.g. `twilio`, `callrail`). Informational, but it records callers’ numbers, so it must be named in the privacy policy — declare it in `site.legal.privacyPolicy.processors` unless it is a known one.",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "number",
+                "sources"
+              ],
+              "additionalProperties": false
             }
           },
           "additionalProperties": false
@@ -2740,7 +2940,7 @@
                 "type": "string"
               },
               "conversionLabel": {
-                "description": "Google Ads only: the conversion action label(s) paired with the `AW-…` conversion ID — either one bare label (back-compat, treated as the `call` action) or a map of action → label, so a call, an email click and a form submission each fire their own Google Ads conversion action instead of all three reporting as the same one.",
+                "description": "Google Ads only: the conversion action label(s) paired with the `AW-…` conversion ID — the category (Phone call lead, Contact, …) is a property of the action in Google Ads, not of the tag call, so a wrong category can't be fixed from code; either one bare label (back-compat, treated as the `call` action) or a map of action → label, so a call, an email click and a form submission each fire their own Google Ads conversion action instead of all three reporting as the same one.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -2749,15 +2949,15 @@
                     "type": "object",
                     "properties": {
                       "call": {
-                        "description": "Fired on a tel: link click.",
+                        "description": "Fired on a tel: link click. Create the action in Google Ads with category \"Phone call lead\".",
                         "type": "string"
                       },
                       "email": {
-                        "description": "Fired on a mailto: link click.",
+                        "description": "Fired on a mailto: link click. Create the action in Google Ads with category \"Contact\".",
                         "type": "string"
                       },
                       "form": {
-                        "description": "Fired client-side by `vitopsFormConversion()` — the consumer's own submit handler calls it once a form POST succeeds.",
+                        "description": "Fired client-side by `vitopsFormConversion()` — the consumer's own submit handler calls it once a form POST succeeds. Create the action in Google Ads with category \"Submit lead form\". Don't fire it from a success-page query parameter: that replays on refresh and the honeypot returns the same success page.",
                         "type": "string"
                       }
                     },
@@ -2791,6 +2991,29 @@
                   }
                 ]
               },
+              "callTracking": {
+                "description": "Google Ads only: **website call conversions**. The Google tag fetches a Google forwarding number for visitors who arrived from a Google ad and swaps it in for `number`, so a phone call (not just a `tel:` tap) is attributed to the click. Google decides who sees it; this toolchain also rewrites the matching `tel:` links, which Google does not. Counts the same call as `conversionLabel.call` if both are primary — make one secondary in Google Ads. Any other platform has no equivalent: see `site.tracking.phoneNumbers`.",
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "type": "string",
+                    "description": "The conversion action label of a **separate** Google Ads action of type \"Calls from a phone number on your website\" (not the `conversionLabel.call` action, which counts `tel:` taps). Paired with `pixelId` as `AW-…/<label>`."
+                  },
+                  "number": {
+                    "type": "string",
+                    "description": "The phone number exactly as the site displays it, e.g. `613-555-0100`. Google swaps its forwarding number in only where the page text matches these digits, so a differently formatted number on the page is silently never replaced."
+                  },
+                  "cache": {
+                    "description": "Set false to stop Google caching the fetched forwarding number in a cookie (`phone_conversion_options.cache`). Default true, so the number follows the visitor across pages.",
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "label",
+                  "number"
+                ],
+                "additionalProperties": false
+              },
               "reporting": {
                 "description": "Google Ads only: `\"client\"` (default) fires the conversion via `gtag.js` in the browser at click/submit time; `\"server\"` uploads it via the Ads API from the conversion endpoint instead (see `conversionActionId`). An action with no matching `conversionActionId` keeps firing client-side regardless of this setting, so setting it before `conversionActionId` is filled in never silently drops a conversion.",
                 "type": "string",