@ingenx-io/valets-schema-mcp-server 0.2.5 → 0.2.7

package/data/docs/index.md

@@ -19,7 +19,7 @@ Developers own the Zod source in `packages/schema/src/`. When schemas change, th
 
 ## What's documented
 
-### Enums (32)
+### Enums (35)
 
 Status enums that drive business logic across Order, Booking, Event, and Loyalty domains:
 
@@ -28,13 +28,16 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
 | [AppStatus](enums/app-status) | 4 values | Lifecycle status for an App (formerly Site — renamed per decision #40 / D44). Drives whether the app is reachable and whether analytics/payments flow. |
 | [AttentionStatus](enums/attention-status) | 4 values | Operational attention status for Order and Booking (D39). Controls home-page queue assignment. Server-owned — set via triggers or callable fn only. |
 | [BookingStatus](enums/booking-status) | 6 values | Booking lifecycle status. COMPLETED_MIXED = some sessions completed, others cancelled/no-show. |
+| [ContractStatus](enums/contract-status) | 4 values | Lifecycle status of a Contract. DRAFT = not yet signed. ACTIVE = in force. COMPLETED = all milestones paid and obligations met. TERMINATED = ended early by either party. |
 | [CustomerPaymentStatus](enums/customer-payment-status) | 6 values | Customer payment lifecycle status (D22). Tracks allocation progress of received payments. |
 | [CustomerPaymentTargetType](enums/customer-payment-target-type) | 3 values | Target document type for customer payment allocation. |
 | [DeliveryType](enums/delivery-type) | 3 values | 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. |
 | [DeploymentLinkType](enums/deployment-link-type) | 6 values | Category of a Site deployment link (D41). Used for UI icon/labelling and deep-link handling. |
 | [EventStatus](enums/event-status) | 4 values | Ticketed event lifecycle (D32). Mobile-only today; Dashboard in Wave 4. |
+| [ExpensePaymentStatus](enums/expense-payment-status) | 4 values | Payment status of an Expense. Stored enum — OVERDUE is not stored, it is derived at read time from dueDate (#13). |
 | [FulfillmentStatus](enums/fulfillment-status) | 6 values | Delivery/fulfillment lifecycle (D34). Optional — null for in-person orders. |
 | [LoyaltyTransactionType](enums/loyalty-transaction-type) | 6 values | Loyalty point transaction type (D07). SCREAMING_SNAKE past tense. |
+| [MilestoneStatus](enums/milestone-status) | 3 values | Status of a ContractMilestone (#17). PENDING = created, not yet invoiced. INVOICED = invoice issued, awaiting payment. PAID = payment received. |
 | [NotificationChannel](enums/notification-channel) | 4 values | Delivery channel of a NotificationRecord (GH#48). |
 | [NotificationEntityType](enums/notification-entity-type) | 6 values | Type of entity a NotificationRecord relates to. When `order`, the record is dual-written to the order-scoped subcollection (GH#48). |
 | [NotificationStatus](enums/notification-status) | 3 values | Delivery status of a NotificationRecord, set by the Cloud Function after a send attempt (GH#48). |
@@ -42,7 +45,7 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
 | [OutboundMessageFormat](enums/outbound-message-format) | 2 values | Outbound WhatsApp message format. `text` is a free-form body (only valid inside the 24h customer-care window); `template` is a pre-approved WhatsApp template send. The backend is the authority on which is allowed (GH#43). |
 | [OutboundMessagePurpose](enums/outbound-message-purpose) | 4 values | Business purpose of an outbound WhatsApp message — orthogonal to its format (see OutboundMessageFormat). `otp`/`review_request`/`adhoc` are system-originated; `conversational` is a human agent reply from the dashboard inbox. Optional signal carried for analytics/triggers (GH#43; supersedes the GH#38 OutboundMessageKind). |
 | [OutboundMessageStatus](enums/outbound-message-status) | 5 values | Outbound WhatsApp message delivery status. Lifecycle: queued → sent → delivered → read, or queued → failed. The dashboard creates the message with status `queued`; the whatsapp-server backend owns every transition after, updating in place from Meta delivery callbacks (GH#43). |
-| [PaymentMethod](enums/payment-method) | 10 values | Unified payment method set with African + global methods (D02). |
+| [PaymentMethod](enums/payment-method) | 11 values | Unified payment method set with African + global methods (D02). Note: the metrics writer historically emits "OM" instead of "ORANGE_MONEY" as a paymentsByMethod map key — treat OM as deprecated; canonical value is ORANGE_MONEY (#21). |
 | [PaymentProofStatus](enums/payment-proof-status) | 3 values | Payment proof review status. Used by Order and Booking payment proof workflows. |
 | [PaymentStatus](enums/payment-status) | 7 values | Payment lifecycle status (D01 amended). Used by Order, Sale/Purchase, Booking. |
 | [PendingIssue](enums/pending-issue) | 11 values | Specific detected conditions on an Order or Booking requiring human action (D39). Stored as an array — multiple issues can be active simultaneously. Server-owned. |
@@ -53,13 +56,13 @@ Status enums that drive business logic across Order, Booking, Event, and Loyalty
 | [StocktakeItemStatus](enums/stocktake-item-status) | 4 values | Per-line workflow status inside a Stocktake (GH#29 §4, audit Q21). |
 | [StocktakeStatus](enums/stocktake-status) | 4 values | Lifecycle status of a Stocktake session (GH#29 §3, §4). |
 | [TicketStatus](enums/ticket-status) | 3 values | Event ticket status (D32). VALID = active and unused. |
-| [WabaLabel](enums/waba-label) | 2 values | Human-readable WABA label identifying which Meta business number received the message (GH#36). |
+| [WabaLabel](enums/waba-label) | 2 values | WABA label identifying which Meta Business Account sent/received the message. cmz = Chez Miss Zahoui sender; val = Valets sender. See WhatsApp platform constraints doc (#50). |
 | [WhatsappButtonSubType](enums/whatsapp-button-sub-type) | 2 values | Sub-type of a WhatsApp template button parameter. Set when WhatsappTemplateParameter.component === "button" — maps to Meta `components[].sub_type` (GH#46). |
 | [WhatsappTemplateComponent](enums/whatsapp-template-component) | 3 values | WhatsApp template component a parameter targets. Determines which Meta `components` entry the supplied value is placed in at send time (GH#46). |
 | [WhatsappTemplateStatus](enums/whatsapp-template-status) | 6 values | Meta review status of a WhatsApp message template, synced from the WhatsApp Business API. Only APPROVED templates can be sent. The fuller Meta status set is used deliberately (vs just APPROVED/PENDING/REJECTED) so this enum has a distinct value signature from PaymentProofStatus in the JSON-Schema $ref matcher (GH#43). |
 
 
-### Models (35)
+### Models (41)
 
 Core Firestore document schemas:
 
@@ -70,14 +73,16 @@ Core Firestore document schemas:
 | [AnalyticsDaily](models/analytics-daily) | 16 | 14 | — |
 | [AnalyticsEvent](models/analytics-event) | 12 | 10 | — |
 | [AnalyticsHourly](models/analytics-hourly) | 17 | 15 | — |
-| [App](models/app) | 14 | 6 | — |
+| [App](models/app) | 14 | 5 | — |
 | [AppPayment](models/app-payment) | 10 | 9 | — |
 | [Booking](models/booking) | 52 | 7 | — |
 | [BookingVersion](models/booking-version) | 9 | 6 | — |
+| [Contract](models/contract) | 15 | 8 | — |
 | [Customer](models/customer) | 17 | 4 | — |
 | [CustomerPayment](models/customer-payment) | 17 | 12 | — |
 | [CustomerPaymentAllocation](models/customer-payment-allocation) | 14 | 8 | — |
 | [Event](models/event) | 15 | 9 | — |
+| [Expense](models/expense) | 17 | 6 | — |
 | [LoyaltyConfig](models/loyalty-config) | 11 | 2 | — |
 | [LoyaltyReward](models/loyalty-reward) | 11 | 5 | — |
 | [LoyaltyStatus](models/loyalty-status) | 9 | 2 | — |
@@ -87,8 +92,12 @@ Core Firestore document schemas:
 | [MetricsDaily](models/metrics-daily) | 31 | 26 | — |
 | [MetricsMonthly](models/metrics-monthly) | 31 | 26 | — |
 | [NotificationRecord](models/notification-record) | 12 | 6 | — |
-| [Order](models/order) | 48 | 8 | — |
+| [Order](models/order) | 49 | 8 | — |
 | [OrderItem](models/order-item) | 12 | 3 | — |
+| [OutboundPayment](models/outbound-payment) | 13 | 7 | — |
+| [OutboundPaymentAllocation](models/outbound-payment-allocation) | 7 | 4 | — |
+| [PaymentWebhookDelivery](models/payment-webhook-delivery) | 15 | 13 | — |
+| [PaymentWebhookEndpoint](models/payment-webhook-endpoint) | 6 | 5 | — |
 | [Sale](models/sale) | 12 | 1 | — |
 | [Site](models/site) | 14 | 6 | — |
 | [SitePayment](models/site-payment) | 10 | 9 | — |

package/data/docs/models/allowed-user.md

@@ -185,4 +185,4 @@ Set at creation only. This field cannot be modified after the document is create
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000

package/data/docs/models/analytics-backfill.md

@@ -391,7 +391,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Required** | No     |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/analytics-daily.md

@@ -344,7 +344,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/analytics-event.md

@@ -530,4 +530,4 @@ Must be one of:
 | **Additional properties** | Any type allowed |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000

package/data/docs/models/analytics-hourly.md

@@ -365,7 +365,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/app-payment.md

@@ -197,4 +197,4 @@ Set at creation only. This field cannot be modified after the document is create
 | **Maximum**  | ≤ 9007199254740991  |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000

package/data/docs/models/app.md

@@ -42,6 +42,8 @@ sidebar_position: 6
 - [3. Property `name`](#name)
 - [4. Property `description`](#description)
 - [5. Property `status`](#status)
+  - [5.1. Property `app-status`](#status_anyOf_i0)
+  - [5.2. Property `item 1`](#status_anyOf_i1)
 - [6. Property `deploymentLinks`](#deploymentLinks)
   - [6.1. deploymentLinks items](#deploymentLinks_items)
     - [6.1.1. Property `label`](#deploymentLinks_items_label)
@@ -81,22 +83,22 @@ sidebar_position: 6
 
 **Description:** App model (D41 / ING-304). Collection: companies/\{companyId\}/apps/\{appId\}. 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.
 
-| Property                                   | Pattern | Type             | Deprecated | Definition                  | Title/Description                                                                                                    |
-| ------------------------------------------ | ------- | ---------------- | ---------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| - [id](#id )                               | No      | string or null   | No         | -                           | (Read-only) Firestore document ID, auto-generated.                                                                   |
-| + [companyId](#companyId )                 | No      | string           | No         | -                           | (Immutable) FK → Company document ID. Scopes all app sub-collections.                                                |
-| + [name](#name )                           | No      | string           | No         | -                           | Human-readable app name shown in dashboards.                                                                         |
-| - [description](#description )             | No      | string or null   | No         | -                           | Optional freeform description.                                                                                       |
-| + [status](#status )                       | No      | enum (of string) | No         | In #/definitions/app-status | Lifecycle status (D41/D44). Clients filter by ACTIVE.                                                                |
-| + [deploymentLinks](#deploymentLinks )     | No      | array of object  | No         | -                           | Ordered list of deployment URLs (web, mobile, PWA, store links).                                                     |
-| - [expiresAt](#expiresAt )                 | No      | Combination      | No         | -                           | Optional expiration timestamp. When set and elapsed, \`isExpired\` flips true and status typically moves to EXPIRED. |
-| - [isExpired](#isExpired )                 | No      | boolean or null  | No         | -                           | (Read-only) Derived — true when \`expiresAt\` is in the past. Maintained by server trigger.                          |
-| - [createdAt](#createdAt )                 | No      | Combination      | No         | -                           | (Read-only) Server-generated creation timestamp.                                                                     |
-| - [updatedAt](#updatedAt )                 | No      | Combination      | No         | -                           | (Read-only) Server-generated update timestamp.                                                                       |
-| + [createdBy](#createdBy )                 | No      | string           | No         | -                           | (Immutable) FK → User/staff UID who created the app.                                                                 |
-| + [analyticsEnabled](#analyticsEnabled )   | No      | boolean          | No         | -                           | Feature flag — when false, clients should not emit analytics events for this app.                                    |
-| - [lastAnalyticsSync](#lastAnalyticsSync ) | No      | Combination      | No         | -                           | (Read-only) Last time the analytics rollup pipeline refreshed \`cachedMetrics\`.                                     |
-| - [cachedMetrics](#cachedMetrics )         | No      | object or null   | No         | -                           | (Read-only, Denormalized) Cached metrics snapshot for quick dashboard rendering.                                     |
+| Property                                   | Pattern | Type            | Deprecated | Definition | Title/Description                                                                                                                       |
+| ------------------------------------------ | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| - [id](#id )                               | No      | string or null  | No         | -          | (Read-only) Firestore document ID, auto-generated.                                                                                      |
+| + [companyId](#companyId )                 | No      | string          | No         | -          | (Immutable) FK → Company document ID. Scopes all app sub-collections.                                                                   |
+| + [name](#name )                           | No      | string          | No         | -          | Human-readable app name shown in dashboards.                                                                                            |
+| - [description](#description )             | No      | string or null  | No         | -          | Optional freeform description.                                                                                                          |
+| - [status](#status )                       | No      | Combination     | No         | -          | Lifecycle status (D41/D44). Optional pending backfill of pre-existing records (#26) — treat absent as ACTIVE. Clients filter by ACTIVE. |
+| + [deploymentLinks](#deploymentLinks )     | No      | array of object | No         | -          | Ordered list of deployment URLs (web, mobile, PWA, store links).                                                                        |
+| - [expiresAt](#expiresAt )                 | No      | Combination     | No         | -          | Optional expiration timestamp. When set and elapsed, \`isExpired\` flips true and status typically moves to EXPIRED.                    |
+| - [isExpired](#isExpired )                 | No      | boolean or null | No         | -          | (Read-only) Derived — true when \`expiresAt\` is in the past. Maintained by server trigger.                                             |
+| - [createdAt](#createdAt )                 | No      | Combination     | No         | -          | (Read-only) Server-generated creation timestamp.                                                                                        |
+| - [updatedAt](#updatedAt )                 | No      | Combination     | No         | -          | (Read-only) Server-generated update timestamp.                                                                                          |
+| + [createdBy](#createdBy )                 | No      | string          | No         | -          | (Immutable) FK → User/staff UID who created the app.                                                                                    |
+| + [analyticsEnabled](#analyticsEnabled )   | No      | boolean         | No         | -          | Feature flag — when false, clients should not emit analytics events for this app.                                                       |
+| - [lastAnalyticsSync](#lastAnalyticsSync ) | No      | Combination     | No         | -          | (Read-only) Last time the analytics rollup pipeline refreshed \`cachedMetrics\`.                                                        |
+| - [cachedMetrics](#cachedMetrics )         | No      | object or null  | No         | -          | (Read-only, Denormalized) Cached metrics snapshot for quick dashboard rendering.                                                        |
 
 ## <a name="id"></a>1. Property `id`
 
@@ -144,13 +146,28 @@ Set at creation only. This field cannot be modified after the document is create
 
 ## <a name="status"></a>5. Property `status`
 
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** Lifecycle status (D41/D44). Optional pending backfill of pre-existing records (#26) — treat absent as ACTIVE. Clients filter by ACTIVE.
+
+| Any of(Option)                 |
+| ------------------------------ |
+| [app-status](#status_anyOf_i0) |
+| [item 1](#status_anyOf_i1)     |
+
+### <a name="status_anyOf_i0"></a>5.1. Property `app-status`
+
 |                |                          |
 | -------------- | ------------------------ |
 | **Type**       | `enum (of string)`       |
-| **Required**   | Yes                      |
+| **Required**   | No                       |
 | **Defined in** | #/definitions/app-status |
 
-**Description:** Lifecycle status (D41/D44). Clients filter by ACTIVE.
+**Description:** Lifecycle status for an App (formerly Site — renamed per decision #40 / D44). Drives whether the app is reachable and whether analytics/payments flow.
 
 Must be one of:
 * "ACTIVE"
@@ -158,12 +175,19 @@ Must be one of:
 * "EXPIRED"
 * "ARCHIVED"
 
+### <a name="status_anyOf_i1"></a>5.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
 :::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.
+Real Firestore documents may be missing this field on pre-backfill records (#26). Treat absent as ACTIVE. A backfill script will populate status=ACTIVE on all existing documents; once confirmed, this field will be promoted to required.
 :::
 
 :::tip When to set
-Written by operators via dashboard or by server triggers (expiration). Clients filter by ACTIVE.
+Written by operators via dashboard or by server triggers (expiration). Clients must not use server-side `where(status == ACTIVE)` until backfill is complete — filter client-side instead, treating absent as ACTIVE.
 :::
 
 :::info See also
@@ -546,7 +570,7 @@ Do not include in write requests. This field is set exclusively by the server (F
 **Description:** Timestamp of the most recent analytics event seen for this app.
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:50 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/booking-version.md

@@ -270,7 +270,7 @@ Dot-notation paths for nested fields (e.g. "bookingDates.0.status"). Populated b
 | **Additional properties** | Any type allowed |
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 :::warning Server-set
 Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.

package/data/docs/models/booking.md

@@ -1739,7 +1739,7 @@ Set at creation only. This field cannot be modified after the document is create
 **Description:** When true, suppresses Firebase notification triggers (D20/IG-8).
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 12:42:51 +0000
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:57:28 +0000
 
 ## Related Decisions