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

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-05-30T12:42:51.842715+00:00",
+  "generated": "2026-05-30T13:38:45.949066+00:00",
   "schemas": {
     "allowed-user": {
       "type": "object",
@@ -745,16 +745,23 @@
           ]
         },
         "status": {
-          "$ref": "#/definitions/app-status",
-          "description": "Lifecycle status (D41/D44). 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.",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/app-status"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "x-note": "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.",
+          "x-when": "Written by operators via dashboard or by server triggers (expiration). Clients must not use server-side `where(status == ACTIVE)` until backfill is complete \u2014 filter client-side instead, treating absent as ACTIVE.",
+          "description": "Lifecycle status (D41/D44). Optional pending backfill of pre-existing records (#26) \u2014 treat absent as ACTIVE. Clients filter by ACTIVE.",
           "x-see": {
             "decisions": [
               "D41",
               "D44"
             ]
-          },
-          "x-when": "Written by operators via dashboard or by server triggers (expiration). Clients filter by ACTIVE."
+          }
         },
         "deploymentLinks": {
           "type": "array",
@@ -915,7 +922,6 @@
       "required": [
         "companyId",
         "name",
-        "status",
         "deploymentLinks",
         "createdBy",
         "analyticsEnabled"
@@ -1919,6 +1925,192 @@
         "snapshot": {}
       }
     },
+    "contract": {
+      "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."
+        },
+        "payeeId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Payee document ID. Full Payee model tracked in #20."
+        },
+        "title": {
+          "type": "string",
+          "description": "Contract title or reference name shown in dashboards."
+        },
+        "description": {
+          "description": "Optional freeform description of the contract scope.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "status": {
+          "$ref": "#/definitions/contract-status",
+          "description": "Contract lifecycle status (#14). Query by ACTIVE \u2014 do not use an isActive boolean."
+        },
+        "currency": {
+          "type": "string",
+          "const": "XOF",
+          "description": "Currency code. Locked to XOF (#18). Multi-currency support requires a deliberate schema version bump."
+        },
+        "totalAmount": {
+          "type": "number",
+          "description": "Total contract value (XOF)."
+        },
+        "startDate": {
+          "type": "string",
+          "description": "Contract start date (ISO 8601 YYYY-MM-DD)."
+        },
+        "endDate": {
+          "description": "Contract end date (ISO 8601 YYYY-MM-DD). Absent for open-ended contracts.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "milestones": {
+          "description": "Ordered list of payment milestones. Embedded in the contract document (#17).",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Client-generated milestone ID (UUID or slug). Unique within the contract."
+              },
+              "title": {
+                "type": "string",
+                "description": "Milestone description or deliverable name."
+              },
+              "amount": {
+                "type": "number",
+                "description": "Amount due at this milestone (XOF)."
+              },
+              "dueDate": {
+                "description": "ISO 8601 date string (YYYY-MM-DD) when the milestone is due. OVERDUE is derived at read time from dueDate \u2014 not stored.",
+                "type": "string"
+              },
+              "status": {
+                "$ref": "#/definitions/milestone-status",
+                "x-note": "Existing Firestore documents may have lowercase values (pending, invoiced, paid) from before this enum was introduced (#17). Normalize on read or via migration script.",
+                "description": "Milestone payment status (#17). OVERDUE is derived at read time from dueDate, not stored."
+              },
+              "invoicedAt": {
+                "$ref": "#/definitions/firestore-timestamp",
+                "description": "When the invoice was issued for this milestone."
+              },
+              "paidAt": {
+                "$ref": "#/definitions/firestore-timestamp",
+                "description": "When payment was received for this milestone."
+              },
+              "notes": {
+                "description": "Optional notes for this milestone.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "id",
+              "title",
+              "amount",
+              "status"
+            ],
+            "additionalProperties": false,
+            "description": "ContractMilestone \u2014 embedded sub-object on Contract (#17). Not a separate collection."
+          }
+        },
+        "notes": {
+          "description": "Optional internal notes.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "createdBy": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 User/staff UID who created the contract."
+        },
+        "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."
+        }
+      },
+      "required": [
+        "companyId",
+        "payeeId",
+        "title",
+        "status",
+        "currency",
+        "totalAmount",
+        "startDate",
+        "createdBy"
+      ],
+      "additionalProperties": false,
+      "description": "Contract model (GH#14/#17/#18). Collection: companies/{companyId}/contracts/{contractId}. Service/supplier contract between a company and a Payee. No isActive field \u2014 query by status. Currency locked to XOF. Milestones use MilestoneStatus enum (no stored OVERDUE).",
+      "example": {
+        "id": null,
+        "companyId": "comp_xyz789",
+        "payeeId": "pay_ref123",
+        "title": "title",
+        "description": null,
+        "status": "status",
+        "currency": "XOF",
+        "totalAmount": 45000,
+        "startDate": "2026-02-15",
+        "endDate": null,
+        "milestones": null,
+        "notes": null,
+        "createdBy": "staff_k0f1",
+        "createdAt": "createdAt",
+        "updatedAt": "updatedAt"
+      }
+    },
+    "contract-status": {
+      "type": "string",
+      "enum": [
+        "DRAFT",
+        "ACTIVE",
+        "COMPLETED",
+        "TERMINATED"
+      ],
+      "description": "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."
+    },
     "customer": {
       "type": "object",
       "properties": {
@@ -3992,6 +4184,16 @@
         "month": "month"
       }
     },
+    "milestone-status": {
+      "type": "string",
+      "enum": [
+        "PENDING",
+        "INVOICED",
+        "PAID"
+      ],
+      "x-note": "OVERDUE is intentionally excluded \u2014 due-date derivation should be computed at read time from dueDate, not stored. Stored OVERDUE would require a cron to keep it consistent. Existing lowercase values (pending, invoiced, paid) from pre-schema documents need normalization on read or via migration (#17).",
+      "description": "Status of a ContractMilestone (#17). PENDING = created, not yet invoiced. INVOICED = invoice issued, awaiting payment. PAID = payment received."
+    },
     "notification-channel": {
       "type": "string",
       "enum": [
@@ -4288,6 +4490,15 @@
           "readOnly": true,
           "description": "(Read-only) Server-generated order number."
         },
+        "followUpUrl": {
+          "x-note": "Standardized casing is followUpUrl (not followUpURL). Mobile legacy code reads both casings for backward compat but writes followUpUrl going forward (#6).",
+          "x-when": "Used by mobile to generate QR codes on printed receipts. If absent, the mobile app derives a deterministic fallback: https://zahoui.web.app/reviews?orderNumber={orderNumber}.",
+          "description": "Optional URL for receipt QR code / post-order follow-up. Canonical casing: followUpUrl (#6).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "status": {
           "$ref": "#/definitions/order-status",
           "description": "Core lifecycle status (D34, MIG-11). See OrderStatus enum for the legacy value migration mapping.",
@@ -4874,6 +5085,7 @@
         "companyId": "comp_xyz789",
         "appId": null,
         "orderNumber": "ORD-2026-0042",
+        "followUpUrl": null,
         "status": "status",
         "paymentStatus": "paymentStatus",
         "fulfillmentStatus": "fulfillmentStatus",
@@ -5196,6 +5408,191 @@
       ],
       "description": "Outbound WhatsApp message delivery status. Lifecycle: queued \u2192 sent \u2192 delivered \u2192 read, or queued \u2192 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)."
     },
+    "outbound-payment": {
+      "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."
+        },
+        "payeeId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Payee document ID. Full Payee model tracked in #20."
+        },
+        "contractId": {
+          "x-immutable": true,
+          "description": "(Immutable, Optional) FK \u2192 Contract document ID. Absent for ad-hoc payments outside a formal contract.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "amount": {
+          "type": "number",
+          "description": "Amount paid (XOF)."
+        },
+        "currency": {
+          "type": "string",
+          "const": "XOF",
+          "description": "Currency code. Locked to XOF \u2014 consistent with Contract and CustomerPayment."
+        },
+        "method": {
+          "$ref": "#/definitions/payment-method",
+          "description": "Payment method used (e.g. BANK_TRANSFER, MOBILE_MONEY, CHECK)."
+        },
+        "reference": {
+          "description": "Optional payment reference \u2014 bank transaction number, check number, Wave ref, etc.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "paidAt": {
+          "$ref": "#/definitions/firestore-timestamp",
+          "description": "When the payment was made."
+        },
+        "notes": {
+          "description": "Optional internal notes.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "createdBy": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 User/staff UID who recorded the payment."
+        },
+        "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."
+        }
+      },
+      "required": [
+        "companyId",
+        "payeeId",
+        "amount",
+        "currency",
+        "method",
+        "paidAt",
+        "createdBy"
+      ],
+      "additionalProperties": false,
+      "description": "OutboundPayment (GH#15). Collection: companies/{companyId}/outboundPayments/{paymentId}. Single outbound transfer to a Payee. Canonical name chosen over SupplierPayment/VendorPayment \u2014 direction-based, agnostic of payee type. Currency locked to XOF.",
+      "example": {
+        "id": null,
+        "companyId": "comp_xyz789",
+        "payeeId": "pay_ref123",
+        "contractId": null,
+        "amount": 45000,
+        "currency": "XOF",
+        "method": "method",
+        "reference": null,
+        "paidAt": "pai_ref123",
+        "notes": null,
+        "createdBy": "staff_k0f1",
+        "createdAt": "createdAt",
+        "updatedAt": "updatedAt"
+      }
+    },
+    "outbound-payment-allocation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "readOnly": true,
+          "description": "(Read-only) Firestore document ID, auto-generated.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "outboundPaymentId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 OutboundPayment document ID (parent)."
+        },
+        "expenseId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Expense document ID. Full Expense model tracked in #20."
+        },
+        "companyId": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) FK \u2192 Company document ID. Denormalized for collection-group queries."
+        },
+        "amount": {
+          "type": "number",
+          "description": "Amount of this payment allocated to the referenced expense (XOF)."
+        },
+        "notes": {
+          "description": "Optional notes about this allocation.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "allocatedAt": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "readOnly": true,
+          "description": "(Read-only) When this allocation was recorded."
+        }
+      },
+      "required": [
+        "outboundPaymentId",
+        "expenseId",
+        "companyId",
+        "amount"
+      ],
+      "additionalProperties": false,
+      "description": "OutboundPaymentAllocation (GH#15). Subcollection: companies/{companyId}/outboundPayments/{paymentId}/allocations/{allocationId}. Links an OutboundPayment to an Expense. Supports partial and multi-expense allocations.",
+      "example": {
+        "id": null,
+        "outboundPaymentId": "out_ref123",
+        "expenseId": "exp_ref123",
+        "companyId": "comp_xyz789",
+        "amount": 45000,
+        "notes": null,
+        "allocatedAt": "allocatedAt"
+      }
+    },
     "payment-method": {
       "type": "string",
       "enum": [
@@ -5234,6 +5631,70 @@
       ],
       "description": "Payment lifecycle status (D01 amended). Used by Order, Sale/Purchase, Booking."
     },
+    "payment-webhook-endpoint": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) base64url-encoded 24-byte random token. Also the Firestore document ID and the URL path segment."
+        },
+        "company": {
+          "type": "string",
+          "x-immutable": true,
+          "description": "(Immutable) Company slug (e.g. gerko_studios). Identifies the tenant that owns this endpoint."
+        },
+        "provider": {
+          "type": "string",
+          "enum": [
+            "wave",
+            "jeko"
+          ],
+          "x-immutable": true,
+          "description": "(Immutable) Payment provider whose webhooks this endpoint accepts."
+        },
+        "secret": {
+          "type": "string",
+          "x-note": "Provider-specific webhook signing secret. Used to verify HMAC-SHA256 signatures on inbound payloads. Never expose to clients.",
+          "readOnly": true,
+          "description": "Webhook signing secret for HMAC verification. Backend-only \u2014 never returned to dashboard or mobile clients."
+        },
+        "active": {
+          "type": "boolean",
+          "description": "Whether this endpoint is currently active. Inactive endpoints reject incoming webhooks."
+        },
+        "createdAt": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/firestore-timestamp"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "readOnly": true,
+          "description": "(Read-only) When this endpoint was provisioned."
+        }
+      },
+      "required": [
+        "token",
+        "company",
+        "provider",
+        "secret",
+        "active"
+      ],
+      "additionalProperties": false,
+      "x-internal": true,
+      "description": "PaymentWebhookEndpoint (GH#41). Collection: payment_webhook_endpoints/{token}. Top-level, not tenant-scoped. Provisioned by superadmin; used by the backend to verify inbound payment webhooks from Wave and Jeko. The delivery log collection (raw webhook payloads + verification outcomes) is tracked in GH#41 \u2014 shape TBD.",
+      "example": {
+        "token": "token",
+        "company": "company",
+        "provider": "wave",
+        "secret": "secret",
+        "active": true,
+        "createdAt": "createdAt"
+      }
+    },
     "pending-issue": {
       "type": "string",
       "enum": [
@@ -6431,7 +6892,8 @@
         "cmz",
         "val"
       ],
-      "description": "Human-readable WABA label identifying which Meta business number received the message (GH#36)."
+      "x-note": "cmz = \"IngenX - Chez Miss Zahoui\", phone number ID 446424085225188, used for chez_miss_zahoui_* companies. val = \"IngenX - Valets\", phone number ID 425582173979125, used for all other companies. Templates are approved at WABA level \u2014 if cmz and val share a WABA ID, all templates are available to both. Routing logic: functions/src/orders/order.ts#isSender2Company. See messaging/whatsapp-platform-constraints (#50).",
+      "description": "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)."
     },
     "whatsapp-button-sub-type": {
       "type": "string",
@@ -6459,6 +6921,7 @@
         },
         "waba": {
           "$ref": "#/definitions/waba-label",
+          "x-note": "cmz = \"IngenX - Chez Miss Zahoui\", phone number ID 446424085225188, used for chez_miss_zahoui_* companies. val = \"IngenX - Valets\", phone number ID 425582173979125, used for all other companies. Templates are approved at WABA level \u2014 if cmz and val share a WABA ID, all templates are available to both. Routing logic: functions/src/orders/order.ts#isSender2Company. See messaging/whatsapp-platform-constraints (#50).",
           "description": "(Immutable) Human-readable WABA label (cmz | val). See WabaLabel enum.",
           "x-immutable": true
         },
@@ -6716,10 +7179,13 @@
         "to": {
           "type": "string",
           "x-immutable": true,
-          "description": "(Immutable) Recipient phone number in E.164 format. Must match the inbound `from` for the same conversation."
+          "x-note": "This is the Meta wa_id (digits only, no leading +), NOT a literal E.164 string. Meta normalizes phone numbers in non-obvious ways (e.g. +2250777471485 \u2192 wa_id 22577471485, dropping the trunk zero). The only reliable source is Meta's contacts[].wa_id from the send response \u2014 do not derive from E.164 by stripping + alone. The dashboard conversational sends and the whatsapp-server OTP path both use the wa_id form. Confirmed in prod: ING-368.",
+          "x-when": "Set at enqueue time to the recipient's Meta wa_id. Use inbound WhatsappInboundMessage.from (also wa_id) as the join key for the conversation thread.",
+          "description": "(Immutable) Recipient Meta wa_id \u2014 digits only, no leading + (e.g. 22577471485). Equal to the inbound `from` for the same conversation. NOT literal E.164; see x-note (#54)."
         },
         "waba": {
           "$ref": "#/definitions/waba-label",
+          "x-note": "cmz = \"IngenX - Chez Miss Zahoui\", phone number ID 446424085225188, used for chez_miss_zahoui_* companies. val = \"IngenX - Valets\", phone number ID 425582173979125, used for all other companies. Templates are approved at WABA level \u2014 if cmz and val share a WABA ID, all templates are available to both. Routing logic: functions/src/orders/order.ts#isSender2Company. See messaging/whatsapp-platform-constraints (#50).",
           "description": "(Immutable) WABA that will send the message. Mirrors inbound `waba`.",
           "x-immutable": true
         },
@@ -6826,6 +7292,7 @@
         },
         "wamid": {
           "readOnly": true,
+          "x-note": "Useful for audit and dedup. Does NOT enable reply-threading for template messages \u2014 Meta silently ignores context.message_id on templates. Threading only works for kind=text within the 24-hour service window (#50).",
           "description": "(Read-only) WhatsApp message ID returned by Meta once the backend sends. Absent while queued or on failure.",
           "type": [
             "string",
@@ -6936,6 +7403,7 @@
         },
         "waba": {
           "$ref": "#/definitions/waba-label",
+          "x-note": "cmz = \"IngenX - Chez Miss Zahoui\", phone number ID 446424085225188, used for chez_miss_zahoui_* companies. val = \"IngenX - Valets\", phone number ID 425582173979125, used for all other companies. Templates are approved at WABA level \u2014 if cmz and val share a WABA ID, all templates are available to both. Routing logic: functions/src/orders/order.ts#isSender2Company. See messaging/whatsapp-platform-constraints (#50).",
           "description": "(Read-only) WABA label this template is approved on. Templates are WABA-scoped. Mirrors WhatsappOutboundMessage.waba.",
           "readOnly": true
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ingenx-io/valets-schema-mcp-server",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "MCP server exposing @valets/schema documentation to AI agents",
   "type": "module",
   "main": "index.js",