@ingenx-io/valets-schema-mcp-server 0.2.1 → 0.2.3

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-27T13:06:59.435619+00:00",
+  "generated": "2026-05-27T15:51:06.117627+00:00",
   "schemas": {
     "allowed-user": {
       "type": "object",
@@ -3477,6 +3477,263 @@
         "month": "month"
       }
     },
+    "notification-channel": {
+      "type": "string",
+      "enum": [
+        "email",
+        "whatsapp",
+        "sms",
+        "push"
+      ],
+      "description": "Delivery channel of a NotificationRecord (GH#48)."
+    },
+    "notification-entity-type": {
+      "type": "string",
+      "enum": [
+        "order",
+        "booking",
+        "customer",
+        "digest",
+        "magic_link",
+        "other"
+      ],
+      "description": "Type of entity a NotificationRecord relates to. When `order`, the record is dual-written to the order-scoped subcollection (GH#48)."
+    },
+    "notification-record": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "readOnly": true,
+          "description": "(Read-only) Firestore document ID, auto-generated. Same ID is used in both the company-wide and order-scoped copies.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "type": {
+          "$ref": "#/definitions/notification-channel",
+          "description": "(Read-only) Delivery channel.",
+          "readOnly": true
+        },
+        "status": {
+          "$ref": "#/definitions/notification-status",
+          "description": "(Read-only) Delivery status after the send attempt.",
+          "readOnly": true
+        },
+        "subject": {
+          "readOnly": true,
+          "description": "(Read-only) Subject line. Present for email notifications only.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "recipients": {
+          "type": "object",
+          "properties": {
+            "to": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "email": {
+                    "description": "Recipient email address. Present for email notifications.",
+                    "type": "string"
+                  },
+                  "phone": {
+                    "description": "Recipient phone number (E.164). Present for whatsapp/sms notifications.",
+                    "type": "string"
+                  },
+                  "name": {
+                    "description": "Recipient display name.",
+                    "type": "string"
+                  },
+                  "role": {
+                    "description": "Recipient role (e.g. organizer, customer).",
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A notification recipient (GH#48)."
+              },
+              "description": "Primary recipients."
+            },
+            "cc": {
+              "description": "CC recipients (email).",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "email": {
+                    "description": "Recipient email address. Present for email notifications.",
+                    "type": "string"
+                  },
+                  "phone": {
+                    "description": "Recipient phone number (E.164). Present for whatsapp/sms notifications.",
+                    "type": "string"
+                  },
+                  "name": {
+                    "description": "Recipient display name.",
+                    "type": "string"
+                  },
+                  "role": {
+                    "description": "Recipient role (e.g. organizer, customer).",
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A notification recipient (GH#48)."
+              }
+            },
+            "bcc": {
+              "description": "BCC recipients (email).",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "email": {
+                    "description": "Recipient email address. Present for email notifications.",
+                    "type": "string"
+                  },
+                  "phone": {
+                    "description": "Recipient phone number (E.164). Present for whatsapp/sms notifications.",
+                    "type": "string"
+                  },
+                  "name": {
+                    "description": "Recipient display name.",
+                    "type": "string"
+                  },
+                  "role": {
+                    "description": "Recipient role (e.g. organizer, customer).",
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A notification recipient (GH#48)."
+              }
+            }
+          },
+          "required": [
+            "to"
+          ],
+          "additionalProperties": false,
+          "readOnly": true,
+          "description": "(Read-only) Recipients of the notification."
+        },
+        "relatedEntity": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "$ref": "#/definitions/notification-entity-type",
+              "description": "Entity type this notification relates to."
+            },
+            "id": {
+              "type": "string",
+              "description": "Entity document ID (e.g. orderId when type=order)."
+            }
+          },
+          "required": [
+            "type",
+            "id"
+          ],
+          "additionalProperties": false,
+          "readOnly": true,
+          "description": "(Read-only) Entity that triggered the notification. type=order triggers the dual-write to the order subcollection."
+        },
+        "wamid": {
+          "readOnly": true,
+          "description": "(Read-only) WhatsApp message ID from the Meta API response. Present on successful whatsapp sends only.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "templateParams": {
+          "readOnly": true,
+          "description": "(Read-only) Filled-in template variable values at send time. Allows reconstructing the sent message without fetching from Meta.",
+          "type": [
+            "object",
+            "null"
+          ],
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "metadata": {
+          "readOnly": true,
+          "description": "(Read-only) Channel-specific extras (e.g. senderPhoneId, templateName, orderNumber).",
+          "type": [
+            "object",
+            "null"
+          ],
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {}
+        },
+        "error": {
+          "readOnly": true,
+          "description": "(Read-only) Failure reason. Present on status=failed.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "sentAt": {
+          "$ref": "#/definitions/firestore-timestamp",
+          "description": "(Read-only) When the send was attempted.",
+          "readOnly": true
+        },
+        "createdAt": {
+          "$ref": "#/definitions/firestore-timestamp",
+          "description": "(Read-only) When the record was created.",
+          "readOnly": true
+        }
+      },
+      "required": [
+        "type",
+        "status",
+        "recipients",
+        "relatedEntity",
+        "sentAt",
+        "createdAt"
+      ],
+      "additionalProperties": false,
+      "description": "NotificationRecord \u2014 backend-written, multi-channel notification audit log (GH#48). Paths: companies/{cid}/notifications/{id} (always) and companies/{cid}/orders/{oid}/notifications/{id} (dual-write when relatedEntity.type=order). Consumers read only. Distinct from WhatsappOutboundMessage (GH#43).",
+      "example": {
+        "id": null,
+        "type": "phone",
+        "status": "status",
+        "subject": null,
+        "recipients": {
+          "to": [
+            {}
+          ]
+        },
+        "relatedEntity": {
+          "type": "phone",
+          "id": "bk_abc123def456"
+        },
+        "wamid": null,
+        "templateParams": null,
+        "metadata": null,
+        "error": null,
+        "sentAt": "sentAt",
+        "createdAt": "createdAt"
+      }
+    },
+    "notification-status": {
+      "type": "string",
+      "enum": [
+        "sent",
+        "failed",
+        "pending"
+      ],
+      "description": "Delivery status of a NotificationRecord, set by the Cloud Function after a send attempt (GH#48)."
+    },
     "order": {
       "type": "object",
       "properties": {
@@ -6118,6 +6375,10 @@
               "buttonSubType": {
                 "$ref": "#/definitions/whatsapp-button-sub-type",
                 "description": "Button sub-type (url | quick_reply). Present only when component=button."
+              },
+              "buttonUrlBase": {
+                "description": "For component=button + buttonSubType=url: the template's configured button URL incl. the placeholder, e.g. \"https://zahoui-review.web.app/{{1}}\". Meta requires the variable at the URL end, so the supplied value is the suffix appended after the static prefix. Lets the dashboard display the resulting link (GH#51).",
+                "type": "string"
               }
             },
             "required": [
@@ -6125,7 +6386,7 @@
               "component"
             ],
             "additionalProperties": false,
-            "description": "Declared WhatsApp template parameter with component placement (GH#46)."
+            "description": "Declared WhatsApp template parameter with component placement (GH#46) and, for URL buttons, the configured URL pattern (GH#51)."
           },
           "readOnly": true,
           "description": "(Read-only) Declared parameters with component placement. Supersedes the flat `variables` list (GH#46) \u2014 lets the send group values into the correct header/body/button components. A message supplies values keyed by `name` via WhatsappOutboundMessage.template.variables."

package/package.json

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