@getvitops/generator 3.0.0 → 4.1.0

package/config.schema.json

@@ -611,7 +611,7 @@
           "type": "string"
         },
         "defaultColorScheme": {
-          "description": "Initial appearance. `\"system\"` follows the OS via `prefers-color-scheme` and is what makes `<color-scheme-toggle>`'s \"System\" position resolve to anything — it removes the theme attribute, so without this the page falls through to light. It also gives a no-JS page the OS appearance. Defaults to `\"light\"`, because switching an existing site to `\"system\"` visibly flips it dark for dark-OS visitors.",
+          "description": "Initial appearance. `\"system\"` follows the OS via `prefers-color-scheme` and is what makes `<wc-color-scheme-toggle>`'s \"System\" position resolve to anything — it removes the theme attribute, so without this the page falls through to light. It also gives a no-JS page the OS appearance. Defaults to `\"light\"`, because switching an existing site to `\"system\"` visibly flips it dark for dark-OS visitors.",
           "type": "string",
           "enum": [
             "light",
@@ -1332,6 +1332,34 @@
           },
           "additionalProperties": {}
         },
+        "searchConsole": {
+          "description": "Domains to onboard as Google Search Console *domain properties* via `vitops search setup`, keyed by bare hostname (mirrors `dns`). Credentials come from the environment (CLOUDFLARE_API_TOKEN + the Google OAuth vars) — never in this file.",
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "delegatedOwners": {
+                "description": "Emails added as verification owners on the Site Verification web resource. Automated via the API — additive and idempotent, never removes an existing owner.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "email",
+                  "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+                }
+              },
+              "fullUserGroup": {
+                "description": "A Google Group to grant Full-User access in Search Console. SURFACED AS A REMINDER only: Search Console exposes no user/permission API, so this step stays manual by design.",
+                "type": "string",
+                "format": "email",
+                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
         "environments": {
           "type": "object",
           "propertyNames": {
@@ -1354,6 +1382,10 @@
                 "description": "Whether analytics fire in this environment.",
                 "type": "boolean"
               },
+              "ads": {
+                "description": "Whether `site.ads` pixels fire in this environment. Defaults to `analytics`, then true — a preview deployment sending pageviews is survivable, one firing conversion pixels is not, so this can be turned off on its own.",
+                "type": "boolean"
+              },
               "robots": {
                 "description": "Robots policy (e.g. \"noindex,nofollow\" for dev).",
                 "type": "string"
@@ -2233,7 +2265,7 @@
               "additionalProperties": false
             },
             "indexing": {
-              "description": "How `vitops notify` tells search engines about a deploy: which sitemap, IndexNow key, Search Console property, and which pages to verify afterwards.",
+              "description": "How `vitops search notify` tells search engines about a deploy: which sitemap, IndexNow key, Search Console property, and which pages to verify afterwards.",
               "type": "object",
               "properties": {
                 "sitemapUrl": {
@@ -2248,7 +2280,7 @@
                     "key": {
                       "type": "string",
                       "pattern": "^[a-zA-Z0-9-]{8,128}$",
-                      "description": "IndexNow key (8–128 chars, hex is conventional). NOT a secret — it is served publicly at `keyLocation` so the engine can verify you own the host. Generate one with `vitops notify --new-key`."
+                      "description": "IndexNow key (8–128 chars, hex is conventional). NOT a secret — it is served publicly at `keyLocation` so the engine can verify you own the host. Generate one with `vitops search notify --new-key`."
                     },
                     "keyLocation": {
                       "description": "Absolute URL of the key file. Defaults to `<canonical>/<key>.txt`; set it only when the file lives elsewhere.",
@@ -2267,7 +2299,7 @@
                   "additionalProperties": false
                 },
                 "searchConsole": {
-                  "description": "Google Search Console property. Needs a service-account credential in `VITOPS_GSC_SERVICE_ACCOUNT` or `GOOGLE_APPLICATION_CREDENTIALS` at run time — never put the key in this file.",
+                  "description": "Google Search Console property. Needs a credential at run time — either a service account in `VITOPS_GSC_SERVICE_ACCOUNT` / `GOOGLE_APPLICATION_CREDENTIALS`, or the user OAuth credential `vitops search setup` uses (`VITOPS_GOOGLE_CLIENT_ID` / `_CLIENT_SECRET` / `_REFRESH_TOKEN`). The service account wins when both are set. Never put a key in this file.",
                   "type": "object",
                   "properties": {
                     "siteUrl": {
@@ -2285,7 +2317,7 @@
                   "additionalProperties": false
                 },
                 "priorityUrls": {
-                  "description": "The pages whose indexing actually matters. `vitops notify --check` inspects these and exits non-zero if Google has not indexed one. Kept explicit because URL Inspection is quota-bound (2000/day), so checking every page is neither affordable nor informative.",
+                  "description": "The pages whose indexing actually matters. `vitops search notify --check` inspects these and exits non-zero if Google has not indexed one. Kept explicit because URL Inspection is quota-bound (2000/day), so checking every page is neither affordable nor informative.",
                   "type": "array",
                   "items": {
                     "type": "string",
@@ -2342,25 +2374,80 @@
           "additionalProperties": false
         },
         "notifications": {
-          "description": "Where site notifications (e.g. form submissions) are sent.",
+          "description": "Where site notifications (form submissions, tracked calls) are sent. TODO: `sms` and `persist` channels — only `email` is implemented.",
           "type": "object",
           "properties": {
             "email": {
-              "type": "string",
-              "format": "email",
-              "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+              "description": "Where conversion notifications are e-mailed. A bare address is shorthand for `{ provider: \"cloudflare\", to }`.",
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "email",
+                  "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "provider": {
+                      "type": "string",
+                      "const": "cloudflare",
+                      "description": "Delivery provider. Only Cloudflare Email Sending is implemented; the field is stated so adding another is additive."
+                    },
+                    "to": {
+                      "description": "Recipient. Defaults to the primary location’s `email`, then the first location that has one.",
+                      "type": "string",
+                      "format": "email",
+                      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+                    },
+                    "from": {
+                      "description": "Sender. Defaults to `noreply@<domains.canonical>`. Its domain must be onboarded (`wrangler email sending enable <domain>`) or every send fails.",
+                      "type": "string",
+                      "format": "email",
+                      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+                    },
+                    "fromName": {
+                      "description": "Display name on the From header. Defaults to `organization.name`.",
+                      "type": "string"
+                    },
+                    "replyTo": {
+                      "description": "Reply-To header.",
+                      "type": "string",
+                      "format": "email",
+                      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+                    },
+                    "binding": {
+                      "description": "Workers `send_email` binding name (default `EMAIL`). Set it when using a restricted binding.",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "provider"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
             }
           },
           "additionalProperties": false
         },
         "tracking": {
-          "description": "Marketing/conversion tracking toggles per platform.",
+          "description": "Ad-click attribution for conversion tracking.",
           "type": "object",
           "properties": {
             "enabled": {
+              "description": "Capture ad click IDs and UTMs from the landing URL into the `_ac` cookie, for attributing conversions.",
               "type": "boolean"
             },
+            "category": {
+              "description": "Consent category the `_ac` cookie waits on (default `marketing`). It is a 90-day identifier tying a visitor to the ad that brought them, so it is only written once this category is granted — and asking for it is what raises the banner.",
+              "type": "string",
+              "enum": [
+                "marketing",
+                "analytics"
+              ]
+            },
             "platforms": {
+              "description": "Informational list of ad platforms in use. Capture recognises every known click-ID parameter regardless.",
               "type": "array",
               "items": {
                 "type": "string"
@@ -2369,6 +2456,61 @@
           },
           "additionalProperties": false
         },
+        "ads": {
+          "description": "Ad properties this site is linked to, keyed by platform. Read by `vitops ads setup` (ensure the DNS verification record), `vitops ads tags` (emit the consent-gated pixel), and the generated cookie notice (disclose what each pixel stores). Credentials never live here — the DNS write uses CLOUDFLARE_API_TOKEN from the environment.",
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "enum": [
+              "google",
+              "meta",
+              "linkedin",
+              "reddit",
+              "tiktok",
+              "microsoft",
+              "pinterest",
+              "snapchat"
+            ]
+          },
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "accountId": {
+                "description": "The advertising account as the platform shows it — Google Ads customer ID, Meta ad account, LinkedIn partner ID, Reddit advertiser ID. For LinkedIn this is also the Insight Tag id; everywhere else the tag id is `pixelId`.",
+                "type": "string"
+              },
+              "pixelId": {
+                "description": "The tag/pixel ID the browser snippet initialises — Meta pixel, TikTok pixel, Reddit pixel, Microsoft UET tag ID, Pinterest tag ID, Snap pixel, or the Google Ads conversion ID (`AW-…`, which is NOT the customer ID).",
+                "type": "string"
+              },
+              "conversionLabel": {
+                "description": "Google Ads only: the conversion action label paired with the `AW-…` conversion ID.",
+                "type": "string"
+              },
+              "domain": {
+                "description": "Bare hostname to verify with this platform. Defaults to the host of `domains.canonical` — set it only when the ad account is verified against a different domain.",
+                "type": "string"
+              },
+              "domainVerification": {
+                "description": "The verification token from the platform UI, for the platforms that verify by DNS TXT (Meta, TikTok, Pinterest, Snapchat). `vitops ads setup` prompts for it and writes it here on first run. NOT a secret — it is published in DNS, and the platform fetching it back is the ownership proof, exactly like the IndexNow key. A value containing `=` is used as the whole record, which is the escape hatch if a platform changes its prefix.",
+                "type": "string"
+              },
+              "category": {
+                "description": "Consent category the tag waits on (default `marketing`). An ad pixel is advertising by default; `analytics` is for a site using one purely for its own measurement.",
+                "type": "string",
+                "enum": [
+                  "marketing",
+                  "analytics"
+                ]
+              },
+              "enabled": {
+                "description": "Set false to keep the property on record without emitting its tag.",
+                "type": "boolean"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
         "security": {
           "description": "Security integrations (bot protection).",
           "type": "object",
@@ -2485,7 +2627,32 @@
                         "description": "Why they receive it, as a noun phrase that reads after \"for\" (e.g. \"payment processing\")."
                       },
                       "country": {
-                        "description": "Where they process it, as it should read in a sentence (e.g. \"the United States\"). Feeds the cross-border-transfer disclosure.",
+                        "description": "Shorthand for the common case where one country is both where they store it and whose laws reach it: asserts BOTH `storage: [{ country }]` AND `operatorCountry`. Reads inside a sentence (e.g. \"the United States\"). When the two differ — a Canadian region operated by a US company — state `storage` and `operatorCountry` instead; setting this alongside either is rejected.",
+                        "type": "string"
+                      },
+                      "storage": {
+                        "description": "Where the information actually rests. Feeds the \"stored or processed outside of <jurisdiction>\" disclosure and nothing else. Several entries are allowed, each optionally scoped to a category of information — which is what makes a Canadian-region tenant holding identity data in the US expressible.",
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "country": {
+                              "type": "string",
+                              "description": "A country or bloc where this provider stores or processes the information, as it should read in a sentence (e.g. \"Canada\", \"the United States\", \"the European Union\"). Naming the jurisdiction the policy is written for is meaningful: it says this information does not leave it."
+                            },
+                            "scope": {
+                              "description": "Which information is held there, as a noun phrase that reads after \"in the case of\" (e.g. \"account and sign-in information\", \"mailbox contents\"). Omit when this location holds everything the provider receives — a scoped entry claims LESS than an unscoped one, so omitting it is the safe default.",
+                              "type": "string"
+                            }
+                          },
+                          "required": [
+                            "country"
+                          ],
+                          "additionalProperties": false
+                        }
+                      },
+                      "operatorCountry": {
+                        "description": "The jurisdiction that can compel this provider to hand the information over — where it is established, or from which it is controlled. Reads after \"the laws of\" (e.g. \"the United States\"); a bloc is acceptable. A SEPARATE fact from `storage`, because privacy law cares about foreign *access*, not only foreign storage: a Canadian-region service run by a US company is `storage: [{ country: \"Canada\" }]` with `operatorCountry: \"the United States\"`.",
                         "type": "string"
                       },
                       "privacyUrl": {