@ingenx-io/valets-schema-mcp-server 0.1.4 → 0.1.5

package/data/static/schemas.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "@valets/schema \u2014 consolidated schema bundle",
-  "generated": "2026-04-18T21:21:09.696794+00:00",
+  "generated": "2026-04-18T22:24:55.497156+00:00",
   "schemas": {
     "allowed-user": {
       "type": "object",
@@ -74,6 +74,292 @@
         "paidAt": "pai_ref123"
       }
     },
+    "analytics-backfill": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "readOnly": true,
+          "description": "(Read-only) Firestore document ID, auto-generated.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "companyId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Company document ID."
+        },
+        "siteId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Site document ID (D40)."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "running",
+            "completed",
+            "failed",
+            "cancelled"
+          ],
+          "description": "Run status."
+        },
+        "from": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) Inclusive start date (`YYYY-MM-DD`, UTC)."
+        },
+        "to": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) Inclusive end date (`YYYY-MM-DD`, UTC)."
+        },
+        "dryRun": {
+          "type": "boolean",
+          "x-immutable": true,
+          "description": "(Immutable) When true, rollup writes are skipped \u2014 only source counts are returned for diffing."
+        },
+        "processedDates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Ordered list of `YYYY-MM-DD` dates already processed by this run."
+        },
+        "errors": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "date": {
+                "type": "string",
+                "description": "`YYYY-MM-DD` date that failed."
+              },
+              "message": {
+                "type": "string",
+                "description": "Error message captured at failure."
+              },
+              "at": {
+                "$ref": "#/definitions/firestore-timestamp",
+                "description": "When the error occurred."
+              }
+            },
+            "required": [
+              "date",
+              "message",
+              "at"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Per-date errors collected during the run."
+        },
+        "triggeredBy": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) UID of the admin who triggered the backfill."
+        },
+        "startedAt": {
+          "$ref": "#/definitions/firestore-timestamp",
+          "description": "(Read-only) When the run actually started.",
+          "readOnly": true
+        },
+        "completedAt": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "readOnly": true,
+          "description": "(Read-only) When the run reached a terminal status."
+        }
+      },
+      "required": [
+        "companyId",
+        "siteId",
+        "status",
+        "from",
+        "to",
+        "dryRun",
+        "processedDates",
+        "errors",
+        "triggeredBy",
+        "startedAt"
+      ],
+      "additionalProperties": false,
+      "description": "AnalyticsBackfill run (D42 / ING-304). Collection: companies/{companyId}/sites/{siteId}/analytics_backfills/{runId}. Tracks admin-triggered rollup backfill jobs; supports dry-run.",
+      "example": {
+        "id": null,
+        "companyId": "comp_xyz789",
+        "siteId": "sit_ref123",
+        "status": "pending",
+        "from": "from",
+        "to": "to",
+        "dryRun": true,
+        "processedDates": [
+          "example"
+        ],
+        "errors": [
+          {
+            "date": "2026-02-15",
+            "message": "message",
+            "at": "at"
+          }
+        ],
+        "triggeredBy": "triggeredBy",
+        "startedAt": "startedAt",
+        "completedAt": "completedAt"
+      }
+    },
+    "analytics-daily": {
+      "type": "object",
+      "properties": {
+        "totalEvents": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Total event count within the bucket."
+        },
+        "pageViews": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `page_view` + `screen_view` events."
+        },
+        "sessions": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Distinct session count within the bucket (by `sessionId`)."
+        },
+        "uniqueUsers": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Distinct identified `userId` count. Anonymous sessions (userId=null) are excluded."
+        },
+        "anonymousSessions": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Distinct session count where `userId` was null for the entire session."
+        },
+        "orders": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `order_submitted` events (or Order documents scoped to this site, D43) within the bucket."
+        },
+        "paymentsCompleted": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `payment_completed` events within the bucket."
+        },
+        "paymentsFailed": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `payment_failed` events within the bucket."
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `error_occurred` + `exception_caught` events within the bucket."
+        },
+        "eventCounts": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          },
+          "description": "Per-event-name counts \u2014 key is the event name (canonical or custom), value is the count within the bucket."
+        },
+        "id": {
+          "readOnly": true,
+          "description": "(Read-only) Firestore document ID = `YYYY-MM-DD`.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "companyId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Company document ID."
+        },
+        "siteId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Site document ID (D40)."
+        },
+        "date": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) `YYYY-MM-DD` UTC \u2014 matches document ID."
+        },
+        "computedAt": {
+          "$ref": "#/definitions/firestore-timestamp",
+          "description": "(Read-only) When this rollup was last (re)computed. Updated on every set/merge.",
+          "readOnly": true
+        },
+        "sourceEventCount": {
+          "readOnly": true,
+          "description": "(Read-only, Optional) Total source events scanned when producing this rollup. Useful for dry-run diffing.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "totalEvents",
+        "pageViews",
+        "sessions",
+        "uniqueUsers",
+        "anonymousSessions",
+        "orders",
+        "paymentsCompleted",
+        "paymentsFailed",
+        "errors",
+        "eventCounts",
+        "companyId",
+        "siteId",
+        "date",
+        "computedAt"
+      ],
+      "additionalProperties": false,
+      "description": "AnalyticsDaily rollup (D42 / ING-304). Collection: companies/{companyId}/sites/{siteId}/analytics_daily/{YYYY-MM-DD}. Idempotent set/merge \u2014 reruns overwrite. Fall back to raw analytics_events for uncovered slices.",
+      "example": {
+        "totalEvents": 0,
+        "pageViews": 0,
+        "sessions": 0,
+        "uniqueUsers": 0,
+        "anonymousSessions": 0,
+        "orders": 0,
+        "paymentsCompleted": 0,
+        "paymentsFailed": 0,
+        "errors": 0,
+        "eventCounts": {},
+        "id": null,
+        "companyId": "comp_xyz789",
+        "siteId": "sit_ref123",
+        "date": "2026-02-15",
+        "computedAt": "computedAt",
+        "sourceEventCount": null
+      }
+    },
     "analytics-event": {
       "type": "object",
       "properties": {
@@ -277,6 +563,160 @@
         "userTraits": null
       }
     },
+    "analytics-hourly": {
+      "type": "object",
+      "properties": {
+        "totalEvents": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Total event count within the bucket."
+        },
+        "pageViews": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `page_view` + `screen_view` events."
+        },
+        "sessions": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Distinct session count within the bucket (by `sessionId`)."
+        },
+        "uniqueUsers": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Distinct identified `userId` count. Anonymous sessions (userId=null) are excluded."
+        },
+        "anonymousSessions": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Distinct session count where `userId` was null for the entire session."
+        },
+        "orders": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `order_submitted` events (or Order documents scoped to this site, D43) within the bucket."
+        },
+        "paymentsCompleted": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `payment_completed` events within the bucket."
+        },
+        "paymentsFailed": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `payment_failed` events within the bucket."
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Count of `error_occurred` + `exception_caught` events within the bucket."
+        },
+        "eventCounts": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          },
+          "description": "Per-event-name counts \u2014 key is the event name (canonical or custom), value is the count within the bucket."
+        },
+        "id": {
+          "readOnly": true,
+          "description": "(Read-only) Firestore document ID = `YYYY-MM-DD-HH`.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "companyId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Company document ID."
+        },
+        "siteId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Site document ID (D40)."
+        },
+        "date": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) `YYYY-MM-DD` UTC for the bucket day."
+        },
+        "hour": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "x-immutable": true,
+          "description": "(Immutable) UTC hour of day, 0\u201323."
+        },
+        "computedAt": {
+          "$ref": "#/definitions/firestore-timestamp",
+          "description": "(Read-only) When this rollup was last (re)computed.",
+          "readOnly": true
+        },
+        "sourceEventCount": {
+          "readOnly": true,
+          "description": "(Read-only, Optional) Total source events scanned when producing this rollup.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "totalEvents",
+        "pageViews",
+        "sessions",
+        "uniqueUsers",
+        "anonymousSessions",
+        "orders",
+        "paymentsCompleted",
+        "paymentsFailed",
+        "errors",
+        "eventCounts",
+        "companyId",
+        "siteId",
+        "date",
+        "hour",
+        "computedAt"
+      ],
+      "additionalProperties": false,
+      "description": "AnalyticsHourly rollup (D42 / ING-304). Collection: companies/{companyId}/sites/{siteId}/analytics_hourly/{YYYY-MM-DD-HH}. Scheduled-CF writer; idempotent set/merge.",
+      "example": {
+        "totalEvents": 0,
+        "pageViews": 0,
+        "sessions": 0,
+        "uniqueUsers": 0,
+        "anonymousSessions": 0,
+        "orders": 0,
+        "paymentsCompleted": 0,
+        "paymentsFailed": 0,
+        "errors": 0,
+        "eventCounts": {},
+        "id": null,
+        "companyId": "comp_xyz789",
+        "siteId": "sit_ref123",
+        "date": "2026-02-15",
+        "hour": 0,
+        "computedAt": "computedAt",
+        "sourceEventCount": null
+      }
+    },
     "attention-status": {
       "type": "string",
       "enum": [
@@ -1624,6 +2064,24 @@
       ],
       "description": "Fulfillment channel for an order. Determines whether the customer comes to the business (ON_SITE), collects their order themselves (PICK_UP), or receives a physical delivery (DELIVERY). Drives whether fulfillmentStatus is relevant."
     },
+    "deployment-link-type": {
+      "type": "string",
+      "enum": [
+        "web",
+        "mobile",
+        "pwa",
+        "app-store",
+        "play-store",
+        "other"
+      ],
+      "description": "Category of a Site deployment link (D41). Used for UI icon/labelling and deep-link handling.",
+      "x-note": "Lowercase by convention \u2014 deployment link types are display-oriented labels, not lifecycle states.",
+      "x-see": {
+        "decisions": [
+          "D41"
+        ]
+      }
+    },
     "event": {
       "type": "object",
       "properties": {
@@ -3037,6 +3495,21 @@
           "x-immutable": true,
           "description": "(Immutable) FK \u2192 Company document ID. Scopes all queries."
         },
+        "siteId": {
+          "x-immutable": true,
+          "x-note": "D43 / ADR-003: optional site attribution. Absent/null means company-wide (legacy). When set, the order is attributed to a specific site for analytics and site-scoped dashboards. No migration \u2014 existing orders keep null. Flat path; Order continues to live at `companies/{companyId}/orders/{orderId}`.",
+          "x-see": {
+            "decisions": [
+              "D43"
+            ]
+          },
+          "x-when": "Set at order creation when the client knows which site the order originated from (e.g. SR Single, Lifesense). Leave null for legacy/company-wide orders. Composite index: (companyId, siteId, createdAt).",
+          "description": "(Immutable, Optional) FK \u2192 Site document ID (D43 / ADR-003). null = company-wide.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "orderNumber": {
           "type": "string",
           "readOnly": true,
@@ -3626,6 +4099,7 @@
         "id": "bk_abc123def456",
         "uid": "user_u8x92kqm",
         "companyId": "comp_xyz789",
+        "siteId": null,
         "orderNumber": "ORD-2026-0042",
         "status": "status",
         "paymentStatus": "paymentStatus",
@@ -4121,6 +4595,233 @@
       ],
       "description": "Per-date/per-slot booking session status (D19). Dashboard is sole writer; Mobile is read-only."
     },
+    "site": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "readOnly": true,
+          "description": "(Read-only) Firestore document ID, auto-generated.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "companyId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Company document ID. Scopes all site sub-collections."
+        },
+        "name": {
+          "type": "string",
+          "description": "Human-readable site name shown in dashboards."
+        },
+        "description": {
+          "description": "Optional freeform description.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "status": {
+          "$ref": "#/definitions/site-status",
+          "description": "Lifecycle status (D41). Clients filter by ACTIVE.",
+          "x-note": "ACTIVE = live and serving traffic. INACTIVE = intentionally disabled by operators. EXPIRED = past expiresAt (derived when isExpired is true; may also be stored explicitly). ARCHIVED = soft-deleted; retained for audit but not listed by default.",
+          "x-see": {
+            "decisions": [
+              "D41"
+            ]
+          },
+          "x-when": "Written by operators via dashboard or by server triggers (expiration). Clients filter by ACTIVE."
+        },
+        "deploymentLinks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "type": "string",
+                "description": "Human-readable label shown in dashboards (e.g. \"Production\", \"Staging\")."
+              },
+              "url": {
+                "type": "string",
+                "description": "Absolute URL or store link."
+              },
+              "type": {
+                "$ref": "#/definitions/deployment-link-type",
+                "description": "Link category \u2014 drives icon/handler selection.",
+                "x-note": "Lowercase by convention \u2014 deployment link types are display-oriented labels, not lifecycle states.",
+                "x-see": {
+                  "decisions": [
+                    "D41"
+                  ]
+                }
+              },
+              "isPrimary": {
+                "description": "If true, this link is used as the canonical deployment URL for the Site.",
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "label",
+              "url",
+              "type"
+            ],
+            "additionalProperties": false,
+            "description": "Deployment link entry embedded on Site.deploymentLinks[] (D41)."
+          },
+          "description": "Ordered list of deployment URLs (web, mobile, PWA, store links)."
+        },
+        "expiresAt": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Optional expiration timestamp. When set and elapsed, `isExpired` flips true and status typically moves to EXPIRED."
+        },
+        "isExpired": {
+          "readOnly": true,
+          "description": "(Read-only) Derived \u2014 true when `expiresAt` is in the past. Maintained by server trigger.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "createdAt": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "readOnly": true,
+          "description": "(Read-only) Server-generated creation timestamp."
+        },
+        "updatedAt": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "readOnly": true,
+          "description": "(Read-only) Server-generated update timestamp."
+        },
+        "createdBy": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 User/staff UID who created the site."
+        },
+        "analyticsEnabled": {
+          "type": "boolean",
+          "description": "Feature flag \u2014 when false, clients should not emit analytics events for this site."
+        },
+        "lastAnalyticsSync": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "readOnly": true,
+          "description": "(Read-only) Last time the analytics rollup pipeline refreshed `cachedMetrics`."
+        },
+        "cachedMetrics": {
+          "readOnly": true,
+          "denormalized": true,
+          "x-note": "Updated by the rollup pipeline (D42). Readers should treat this as a hint; authoritative counts live in analytics_daily/analytics_hourly.",
+          "x-see": {
+            "decisions": [
+              "D41",
+              "D42"
+            ]
+          },
+          "description": "(Read-only, Denormalized) Cached metrics snapshot for quick dashboard rendering.",
+          "type": [
+            "object",
+            "null"
+          ],
+          "properties": {
+            "totalEvents": {
+              "type": "integer",
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "All-time event count cached on the Site."
+            },
+            "totalPageViews": {
+              "type": "integer",
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "All-time `page_view` + `screen_view` count."
+            },
+            "totalSessions": {
+              "type": "integer",
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "All-time distinct session count."
+            },
+            "totalOrders": {
+              "type": "integer",
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "All-time order count attributed to this site (via `Order.siteId`, D43)."
+            },
+            "lastEventAt": {
+              "$ref": "#/definitions/firestore-timestamp",
+              "description": "Timestamp of the most recent analytics event seen for this site."
+            }
+          },
+          "required": [
+            "totalEvents",
+            "totalPageViews",
+            "totalSessions",
+            "totalOrders"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "companyId",
+        "name",
+        "status",
+        "deploymentLinks",
+        "createdBy",
+        "analyticsEnabled"
+      ],
+      "additionalProperties": false,
+      "description": "Site model (D41 / ING-304). Collection: companies/{companyId}/sites/{siteId}. Per-company product surface. Sub-collections (magic_link_requests, allowed_users, payments, analytics_events, analytics_daily, analytics_hourly, analytics_backfills) live under this document per D40/D42.",
+      "example": {
+        "id": null,
+        "companyId": "comp_xyz789",
+        "name": "Amadou Diallo",
+        "description": null,
+        "status": "status",
+        "deploymentLinks": [
+          {
+            "label": "label",
+            "url": "https://storage.example.com/url.jpg",
+            "type": "phone"
+          }
+        ],
+        "expiresAt": "expiresAt",
+        "isExpired": null,
+        "createdAt": "createdAt",
+        "updatedAt": "updatedAt",
+        "createdBy": "staff_k0f1",
+        "analyticsEnabled": true,
+        "lastAnalyticsSync": "lastAnalyticsSync",
+        "cachedMetrics": null
+      }
+    },
     "site-payment": {
       "type": "object",
       "properties": {
@@ -4198,6 +4899,23 @@
         "paidAt": "pai_ref123"
       }
     },
+    "site-status": {
+      "type": "string",
+      "enum": [
+        "ACTIVE",
+        "INACTIVE",
+        "EXPIRED",
+        "ARCHIVED"
+      ],
+      "description": "Lifecycle status for a Site (D41). Drives whether the site is reachable and whether analytics/payments flow.",
+      "x-note": "ACTIVE = live and serving traffic. INACTIVE = intentionally disabled by operators. EXPIRED = past expiresAt (derived when isExpired is true; may also be stored explicitly). ARCHIVED = soft-deleted; retained for audit but not listed by default.",
+      "x-see": {
+        "decisions": [
+          "D41"
+        ]
+      },
+      "x-when": "Written by operators via dashboard or by server triggers (expiration). Clients filter by ACTIVE."
+    },
     "ticket": {
       "type": "object",
       "properties": {