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

package/data/docs/models/whatsapp-inbound-message.md

@@ -0,0 +1,369 @@
+---
+title: "WhatsappInboundMessage"
+sidebar_label: "WhatsappInboundMessage"
+sidebar_position: 28
+---
+
+# WhatsappInboundMessage
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "wabaId": "wab_ref123",
+  "waba": "waba",
+  "messageId": "mes_ref123",
+  "from": "from",
+  "type": "phone",
+  "timestamp": "timestamp",
+  "receivedAt": "receivedAt",
+  "text": null,
+  "mediaId": null,
+  "caption": null,
+  "storageUrl": null,
+  "context": null
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `wabaId`](#wabaId)
+- [3. Property `waba`](#waba)
+- [4. Property `messageId`](#messageId)
+- [5. Property `from`](#from)
+- [6. Property `type`](#type)
+  - [6.1. Property `item 0`](#type_anyOf_i0)
+  - [6.2. Property `item 1`](#type_anyOf_i1)
+- [7. Property `timestamp`](#timestamp)
+  - [7.1. Property `_seconds`](#timestamp__seconds)
+  - [7.2. Property `_nanoseconds`](#timestamp__nanoseconds)
+- [8. Property `receivedAt`](#receivedAt)
+  - [8.1. Property `_seconds`](#timestamp__seconds)
+  - [8.2. Property `_nanoseconds`](#timestamp__nanoseconds)
+- [9. Property `text`](#text)
+- [10. Property `mediaId`](#mediaId)
+- [11. Property `caption`](#caption)
+- [12. Property `storageUrl`](#storageUrl)
+- [13. Property `context`](#context)
+  - [13.1. Property `id`](#context_id)
+  - [13.2. Property `from`](#context_from)
+  - [13.3. Property `forwarded`](#context_forwarded)
+
+|                           |                                        |
+| ------------------------- | -------------------------------------- |
+| **Type**                  | `object`                               |
+| **Required**              | No                                     |
+| **Additional properties** | Not allowed                            |
+| **Defined in**            | #/definitions/whatsapp-inbound-message |
+
+**Description:** WhatsappInboundMessage — inbound WhatsApp message persisted from Meta Cloud API webhook (GH#36). Collection: whatsapp_inbound_messages/\{docId\} in ratenplate project. Top-level scope: company resolution happens post-ingestion.
+
+| Property                     | Pattern | Type             | Deprecated | Definition                           | Title/Description                                                                                               |
+| ---------------------------- | ------- | ---------------- | ---------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
+| - [id](#id )                 | No      | string or null   | No         | -                                    | (Read-only) Firestore document ID — wamid from Meta Cloud API.                                                  |
+| + [wabaId](#wabaId )         | No      | string           | No         | -                                    | (Immutable) Meta WABA ID identifying which business number received the message.                                |
+| + [waba](#waba )             | No      | enum (of string) | No         | In #/definitions/waba-label          | (Immutable) Human-readable WABA label (cmz \| val). See WabaLabel enum.                                         |
+| + [messageId](#messageId )   | No      | string           | No         | -                                    | (Immutable) WhatsApp message ID (wamid) returned by Meta — mirrors the document ID.                             |
+| + [from](#from )             | No      | string           | No         | -                                    | (Immutable) Sender phone number in E.164 format.                                                                |
+| + [type](#type )             | No      | Combination      | No         | -                                    | (Immutable) Meta message type.                                                                                  |
+| + [timestamp](#timestamp )   | No      | object           | No         | In #/definitions/firestore-timestamp | (Immutable) Message timestamp as reported by Meta.                                                              |
+| + [receivedAt](#receivedAt ) | No      | object           | No         | In #/definitions/firestore-timestamp | (Read-only) Server-side ingestion time set by the Cloud Function.                                               |
+| - [text](#text )             | No      | string or null   | No         | -                                    | Message body text. Present on type=text messages only.                                                          |
+| - [mediaId](#mediaId )       | No      | string or null   | No         | -                                    | Meta media ID. Present on image, audio, video, document, sticker messages.                                      |
+| - [caption](#caption )       | No      | string or null   | No         | -                                    | Media caption text. Present when the sender included a caption.                                                 |
+| - [storageUrl](#storageUrl ) | No      | string or null   | No         | -                                    | Durable Cloud Storage URL for the downloaded media binary. Present after the CF downloads and stores the media. |
+| - [context](#context )       | No      | object or null   | No         | -                                    | Reply/forward context. Present on replies and forwarded messages.                                               |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID — wamid from Meta Cloud API.
+
+:::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.
+:::
+
+## <a name="wabaId"></a>2. Property `wabaId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) Meta WABA ID identifying which business number received the message.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="waba"></a>3. Property `waba`
+
+|                |                          |
+| -------------- | ------------------------ |
+| **Type**       | `enum (of string)`       |
+| **Required**   | Yes                      |
+| **Defined in** | #/definitions/waba-label |
+
+**Description:** (Immutable) Human-readable WABA label (cmz | val). See WabaLabel enum.
+
+Must be one of:
+* "cmz"
+* "val"
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="messageId"></a>4. Property `messageId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) WhatsApp message ID (wamid) returned by Meta — mirrors the document ID.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="from"></a>5. Property `from`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) Sender phone number in E.164 format.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="type"></a>6. Property `type`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | Yes              |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Immutable) Meta message type.
+
+| Any of(Option)           |
+| ------------------------ |
+| [item 0](#type_anyOf_i0) |
+| [item 1](#type_anyOf_i1) |
+
+### <a name="type_anyOf_i0"></a>6.1. Property `item 0`
+
+|              |                    |
+| ------------ | ------------------ |
+| **Type**     | `enum (of string)` |
+| **Required** | No                 |
+
+Must be one of:
+* "text"
+* "image"
+* "audio"
+* "video"
+* "document"
+* "sticker"
+* "reaction"
+* "location"
+* "contacts"
+* "interactive"
+* "button"
+* "order"
+* "system"
+* "unsupported"
+
+### <a name="type_anyOf_i1"></a>6.2. Property `item 1`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="timestamp"></a>7. Property `timestamp`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Immutable) Message timestamp as reported by Meta.
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#timestamp__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#timestamp__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="timestamp__seconds"></a>7.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="timestamp__nanoseconds"></a>7.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="receivedAt"></a>8. Property `receivedAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) Server-side ingestion time set by the Cloud Function.
+
+| Property                                   | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#timestamp__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#timestamp__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="timestamp__seconds"></a>8.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="timestamp__nanoseconds"></a>8.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+:::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.
+:::
+
+## <a name="text"></a>9. Property `text`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Message body text. Present on type=text messages only.
+
+## <a name="mediaId"></a>10. Property `mediaId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Meta media ID. Present on image, audio, video, document, sticker messages.
+
+## <a name="caption"></a>11. Property `caption`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Media caption text. Present when the sender included a caption.
+
+## <a name="storageUrl"></a>12. Property `storageUrl`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Durable Cloud Storage URL for the downloaded media binary. Present after the CF downloads and stores the media.
+
+## <a name="context"></a>13. Property `context`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `object or null` |
+| **Required** | No               |
+
+**Description:** Reply/forward context. Present on replies and forwarded messages.
+
+| Property                           | Pattern | Type   | Deprecated | Definition | Title/Description                                        |
+| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------- |
+| - [id](#context_id )               | No      | string | No         | -          | wamid of the quoted/replied-to message.                  |
+| - [from](#context_from )           | No      | string | No         | -          | Sender phone number of the quoted message.               |
+| - [forwarded](#context_forwarded ) | No      | const  | No         | -          | Present (true) when Meta marks the message as forwarded. |
+
+### <a name="context_id"></a>13.1. Property `id`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** wamid of the quoted/replied-to message.
+
+### <a name="context_from"></a>13.2. Property `from`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+**Description:** Sender phone number of the quoted message.
+
+### <a name="context_forwarded"></a>13.3. Property `forwarded`
+
+|              |         |
+| ------------ | ------- |
+| **Type**     | `const` |
+| **Required** | No      |
+
+**Description:** Present (true) when Meta marks the message as forwarded.
+
+Specific value: `true`
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-15 at 16:32:39 +0000

package/data/static/llms.txt

@@ -4,7 +4,7 @@
 > Source of truth: Zod schemas in packages/schema/src/
 > All Firestore documents are scoped under companies/{companyId}/
 
-> Generated: 2026-04-18
+> Generated: 2026-05-15
 
 ---
 
@@ -78,10 +78,26 @@ Values: PENDING, CONFIRMED, CANCELLATION_REQUESTED, COMPLETED, NO_SHOW, CANCELLE
 Lifecycle status for a Site (D41). Drives whether the site is reachable and whether analytics/payments flow.
 Values: ACTIVE, INACTIVE, EXPIRED, ARCHIVED
 
+### StocktakeFrequency
+Recurrence cadence of a Stocktake session (GH#29 §4).
+Values: DAILY, WEEKLY, MONTHLY, AD_HOC
+
+### StocktakeItemStatus
+Per-line workflow status inside a Stocktake (GH#29 §4, audit Q21).
+Values: PENDING, COUNTED, VERIFIED, ADJUSTED
+
+### StocktakeStatus
+Lifecycle status of a Stocktake session (GH#29 §3, §4).
+Values: PENDING, IN_PROGRESS, COMPLETED, CANCELLED
+
 ### TicketStatus
 Event ticket status (D32). VALID = active and unused.
 Values: VALID, USED, CANCELLED
 
+### WabaLabel
+Human-readable WABA label identifying which Meta business number received the message (GH#36).
+Values: cmz, val
+
 ---
 
 ## Models
@@ -1314,6 +1330,104 @@ Example:
 }
 ```
 
+### Stocktake
+Fields: 21 (11 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| id | ['string', 'null'] | no | (Read-only) Firestore document ID, auto-generated. |
+| companyId | string | yes | (Immutable) FK → Company document ID. Tenant scope. |
+| stocktakeNumber | string | yes | Human-readable session number, e.g. "STK-2026-001". Embedded as `referenceNumber` on the StockMovement rows the session emits, so the ledger remains traceable to the originating stocktake. |
+| stocktakeDate | FirestoreTimestamp | yes | Effective date of the count. Distinct from createdAt; can be backdated. |
+| warehouseId | any | no | FK → Warehouse document ID. Null = whole-company stocktake (no warehouse partition). |
+| frequency | any | no | Recurrence cadence. Optional — leave unset for ad-hoc sessions, or set to indicate this stocktake is part of a recurring schedule. |
+| scheduledStocktakeId | any | no | FK to a recurring stocktake schedule, if this session was emitted from one. Null for ad-hoc sessions. |
+| status | StocktakeStatus | yes | Lifecycle status. Transitions PENDING → IN_PROGRESS → COMPLETED are server-owned (GH#29 §3 / Q25). |
+| adjustmentsApplied | boolean | yes | True if completing the session actually emitted StockMovement adjustments. False for record-only counts. |
+| notes | any | no | Free-text session-level notes. |
+| totalItemsCount | integer | yes | (Read-only) Total number of StocktakeItem rows under this session. |
+| totalDiscrepancies | integer | yes | (Read-only) Sum of absolute deltas across counted items. |
+| totalDeltaValue | number | yes | (Read-only) Net valuation impact of the count, in XOF integer minor units. |
+| startedAt | FirestoreTimestamp | yes | When the counting session physically opened. Typically equal to createdAt for ad-hoc sessions. |
+| completedAt | any | no | (Read-only) When the session transitioned to COMPLETED. |
+| createdAt | any | no | (Read-only) Server-generated creation timestamp. |
+| createdBy | string | yes | (Immutable) FK → User UID who created the session. |
+| createdByName | string | yes | (Denormalized) Snapshot of the creator's display name at session creation. |
+| completedBy | any | no | (Read-only) FK → User UID who completed the session, set by server on COMPLETED. |
+| completedByName | any | no | (Denormalized) Snapshot of the completer's display name. |
+| updatedAt | any | no | (Read-only) Server-generated update timestamp. |
+
+Example:
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "stocktakeNumber": "stocktakeNumber",
+  "stocktakeDate": "stocktakeDate",
+  "warehouseId": "war_ref123",
+  "frequency": "frequency",
+  "scheduledStocktakeId": "sch_ref123",
+  "status": "status",
+  "adjustmentsApplied": true,
+  "notes": "VIP customer, handle with care",
+  "totalItemsCount": 2,
+  "totalDiscrepancies": 0,
+  "totalDeltaValue": 0,
+  "startedAt": "startedAt",
+  "completedAt": "completedAt",
+  "createdAt": "createdAt",
+  "createdBy": "staff_k0f1",
+  "createdByName": "Kofi Mensah",
+  "completedBy": "completedBy",
+  "completedByName": "completedByName",
+  "updatedAt": "updatedAt"
+}
+```
+
+### StocktakeItem
+Fields: 16 (8 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| stockItemId | string | yes | FK → StockItem document ID. Doubles as the item document ID. |
+| stockItemName | string | yes | (Denormalized) Snapshot of StockItem.name at session time. |
+| theoreticalQuantity | number | yes | (Immutable) System belief at session start, snapshotted when this item row was created. |
+| actualQuantity | any | no | Physical count entered by the counter. Null until counted; set when the line moves to status COUNTED. |
+| delta | number | yes | (Read-only) Signed difference between actual and theoretical. Drives the StockMovement(type=INVENTORY) emitted on session COMPLETED. |
+| unit | string | yes | (Immutable) Snapshot of StockItem.unit at session start. Locks the unit against later catalog changes. |
+| costPerUnit | number | yes | (Immutable) Snapshot of StockItem.costPerUnit at session start, in XOF integer minor units. |
+| totalValue | number | yes | (Read-only) Per-line valuation in XOF integer minor units. |
+| status | StocktakeItemStatus | yes | Per-line workflow status. Server transitions ADJUSTED on parent COMPLETED. |
+| notes | any | no | Optional per-line note from the counter (e.g. "damaged carton, 3 unsellable"). |
+| countedBy | any | no | UID of the staff member who entered actualQuantity. |
+| countedByName | any | no | (Denormalized) Snapshot of the counter's display name at count time. |
+| countedAt | any | no | When the line was counted. |
+| verifiedBy | any | no | UID of a second staff member who verified the count. Nullable per GH#29 Q21. |
+| verifiedByName | any | no | (Denormalized) Snapshot of the verifier's display name. |
+| verifiedAt | any | no | When the line was verified, if a second-eye flow was used. |
+
+Example:
+```json
+{
+  "stockItemId": "sto_ref123",
+  "stockItemName": "stockItemName",
+  "theoreticalQuantity": 2,
+  "actualQuantity": "actualQuantity",
+  "delta": 0,
+  "unit": "unit",
+  "costPerUnit": 15000,
+  "totalValue": 0,
+  "status": "status",
+  "notes": "VIP customer, handle with care",
+  "countedBy": "countedBy",
+  "countedByName": "countedByName",
+  "countedAt": "countedAt",
+  "verifiedBy": "verifiedBy",
+  "verifiedByName": "verifiedByName",
+  "verifiedAt": "verifiedAt"
+}
+```
+
 ### Ticket
 Fields: 16 (6 required)
 
@@ -1358,6 +1472,44 @@ Example:
 }
 ```
 
+### WhatsappInboundMessage
+Fields: 13 (7 required)
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| id | ['string', 'null'] | no | (Read-only) Firestore document ID — wamid from Meta Cloud API. |
+| wabaId | string | yes | (Immutable) Meta WABA ID identifying which business number received the message. |
+| waba | WabaLabel | yes | (Immutable) Human-readable WABA label (cmz | val). See WabaLabel enum. |
+| messageId | string | yes | (Immutable) WhatsApp message ID (wamid) returned by Meta — mirrors the document ID. |
+| from | string | yes | (Immutable) Sender phone number in E.164 format. |
+| type | any | yes | (Immutable) Meta message type. |
+| timestamp | FirestoreTimestamp | yes | (Immutable) Message timestamp as reported by Meta. |
+| receivedAt | FirestoreTimestamp | yes | (Read-only) Server-side ingestion time set by the Cloud Function. |
+| text | ['string', 'null'] | no | Message body text. Present on type=text messages only. |
+| mediaId | ['string', 'null'] | no | Meta media ID. Present on image, audio, video, document, sticker messages. |
+| caption | ['string', 'null'] | no | Media caption text. Present when the sender included a caption. |
+| storageUrl | ['string', 'null'] | no | Durable Cloud Storage URL for the downloaded media binary. Present after the CF downloads and stores the media. |
+| context | ['object', 'null'] | no | Reply/forward context. Present on replies and forwarded messages. |
+
+Example:
+```json
+{
+  "id": null,
+  "wabaId": "wab_ref123",
+  "waba": "waba",
+  "messageId": "mes_ref123",
+  "from": "from",
+  "type": "phone",
+  "timestamp": "timestamp",
+  "receivedAt": "receivedAt",
+  "text": null,
+  "mediaId": null,
+  "caption": null,
+  "storageUrl": null,
+  "context": null
+}
+```
+
 ---
 
 ## Proposed (Work In Progress)