@ingenx-io/valets-schema-mcp-server 0.1.1 → 0.1.3

package/data/docs/models/order-item.md

@@ -0,0 +1,361 @@
+---
+title: "OrderItem"
+sidebar_label: "OrderItem"
+sidebar_position: 15
+---
+
+# OrderItem
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "name": "Shea Butter Body Lotion",
+  "quantity": 3,
+  "price": 15000,
+  "productId": null,
+  "increment": null,
+  "variantId": null,
+  "supplierId": null,
+  "supplierName": null,
+  "sentAt": "sentAt",
+  "startedCookingAt": "startedCookingAt",
+  "readyAt": "readyAt",
+  "servedAt": "servedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `name`](#name)
+- [2. Property `quantity`](#quantity)
+- [3. Property `price`](#price)
+- [4. Property `productId`](#productId)
+- [5. Property `increment`](#increment)
+- [6. Property `variantId`](#variantId)
+- [7. Property `supplierId`](#supplierId)
+- [8. Property `supplierName`](#supplierName)
+- [9. Property `sentAt`](#sentAt)
+  - [9.1. Property `firestore-timestamp`](#sentAt_anyOf_i0)
+    - [9.1.1. Property `_seconds`](#sentAt_anyOf_i0__seconds)
+    - [9.1.2. Property `_nanoseconds`](#sentAt_anyOf_i0__nanoseconds)
+  - [9.2. Property `item 1`](#sentAt_anyOf_i1)
+- [10. Property `startedCookingAt`](#startedCookingAt)
+  - [10.1. Property `firestore-timestamp`](#startedCookingAt_anyOf_i0)
+  - [10.2. Property `item 1`](#startedCookingAt_anyOf_i1)
+- [11. Property `readyAt`](#readyAt)
+  - [11.1. Property `firestore-timestamp`](#readyAt_anyOf_i0)
+  - [11.2. Property `item 1`](#readyAt_anyOf_i1)
+- [12. Property `servedAt`](#servedAt)
+  - [12.1. Property `firestore-timestamp`](#servedAt_anyOf_i0)
+  - [12.2. Property `item 1`](#servedAt_anyOf_i1)
+
+|                           |                          |
+| ------------------------- | ------------------------ |
+| **Type**                  | `object`                 |
+| **Required**              | No                       |
+| **Additional properties** | Not allowed              |
+| **Defined in**            | #/definitions/order-item |
+
+**Description:** Line item within an Order or Sale/Purchase. Canonical fields: name, quantity, price, productId. Optional commerce fields (increment, variantId, supplierId, supplierName) and kitchen tracking fields (sentAt, startedCookingAt, readyAt, servedAt) are TBD/WIP pending cross-platform alignment.
+
+| Property                                 | Pattern | Type           | Deprecated | Definition | Title/Description                                                                                 |
+| ---------------------------------------- | ------- | -------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------- |
+| + [name](#name )                         | No      | string         | No         | -          | Display name of the product or service.                                                           |
+| + [quantity](#quantity )                 | No      | number         | No         | -          | Number of units ordered.                                                                          |
+| + [price](#price )                       | No      | number         | No         | -          | Unit price. Canonical name per D11.                                                               |
+| - [productId](#productId )               | No      | string or null | No         | -          | FK → Product document ID.                                                                         |
+| - [increment](#increment )               | No      | number or null | No         | -          | Quantity step for bundle/bulk items (e.g. 5 for a 5-pack). Dashboard/Firebase only.               |
+| - [variantId](#variantId )               | No      | string or null | No         | -          | FK → ProductVariant ID within the product. Dashboard/Firebase only.                               |
+| - [supplierId](#supplierId )             | No      | string or null | No         | -          | FK → Supplier document ID. B2B orders only.                                                       |
+| - [supplierName](#supplierName )         | No      | string or null | No         | -          | (Denormalized) From Supplier.name at write time. B2B orders only.                                 |
+| - [sentAt](#sentAt )                     | No      | Combination    | No         | -          | (Read-only) Timestamp when the item was sent to the kitchen. TBD/WIP — archived CBL flow.         |
+| - [startedCookingAt](#startedCookingAt ) | No      | Combination    | No         | -          | (Read-only) Timestamp when the kitchen started preparing this item. TBD/WIP — archived CBL flow.  |
+| - [readyAt](#readyAt )                   | No      | Combination    | No         | -          | (Read-only) Timestamp when the item was ready for pickup or service. TBD/WIP — archived CBL flow. |
+| - [servedAt](#servedAt )                 | No      | Combination    | No         | -          | (Read-only) Timestamp when the item was served to the customer. TBD/WIP — archived CBL flow.      |
+
+## <a name="name"></a>1. Property `name`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Display name of the product or service.
+
+## <a name="quantity"></a>2. Property `quantity`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Number of units ordered.
+
+## <a name="price"></a>3. Property `price`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Unit price. Canonical name per D11.
+
+## <a name="productId"></a>4. Property `productId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** FK → Product document ID.
+
+## <a name="increment"></a>5. Property `increment`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** Quantity step for bundle/bulk items (e.g. 5 for a 5-pack). Dashboard/Firebase only.
+
+:::note
+TBD/WIP — Dashboard/Firebase only. Canonical status pending cross-platform alignment.
+:::
+
+## <a name="variantId"></a>6. Property `variantId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** FK → ProductVariant ID within the product. Dashboard/Firebase only.
+
+:::note
+TBD/WIP — Dashboard/Firebase only. Canonical status pending cross-platform alignment.
+:::
+
+## <a name="supplierId"></a>7. Property `supplierId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** FK → Supplier document ID. B2B orders only.
+
+:::note
+TBD/WIP — B2B orders only. Canonical status pending cross-platform alignment.
+:::
+
+## <a name="supplierName"></a>8. Property `supplierName`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Denormalized) From Supplier.name at write time. B2B orders only.
+
+:::note
+TBD/WIP — B2B orders only. Canonical status pending cross-platform alignment.
+:::
+
+## <a name="sentAt"></a>9. Property `sentAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Timestamp when the item was sent to the kitchen. TBD/WIP — archived CBL flow.
+
+| Any of(Option)                          |
+| --------------------------------------- |
+| [firestore-timestamp](#sentAt_anyOf_i0) |
+| [item 1](#sentAt_anyOf_i1)              |
+
+### <a name="sentAt_anyOf_i0"></a>9.1. Property `firestore-timestamp`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | No                                |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** Firestore Timestamp serialized representation
+
+| Property                                         | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#sentAt_anyOf_i0__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#sentAt_anyOf_i0__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+#### <a name="sentAt_anyOf_i0__seconds"></a>9.1.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+#### <a name="sentAt_anyOf_i0__nanoseconds"></a>9.1.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="sentAt_anyOf_i1"></a>9.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+:::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.
+:::
+
+:::note
+TBD/WIP — Originally from the archived Couchbase Lite (CBL) restaurant flow. Canonical inclusion in Firestore model is pending review.
+:::
+
+## <a name="startedCookingAt"></a>10. Property `startedCookingAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Timestamp when the kitchen started preparing this item. TBD/WIP — archived CBL flow.
+
+| Any of(Option)                                    |
+| ------------------------------------------------- |
+| [firestore-timestamp](#startedCookingAt_anyOf_i0) |
+| [item 1](#startedCookingAt_anyOf_i1)              |
+
+### <a name="startedCookingAt_anyOf_i0"></a>10.1. Property `firestore-timestamp`
+
+|                           |                                     |
+| ------------------------- | ----------------------------------- |
+| **Type**                  | `object`                            |
+| **Required**              | No                                  |
+| **Additional properties** | Not allowed                         |
+| **Same definition as**    | [sentAt_anyOf_i0](#sentAt_anyOf_i0) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="startedCookingAt_anyOf_i1"></a>10.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+:::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.
+:::
+
+:::note
+TBD/WIP — Originally from the archived Couchbase Lite (CBL) restaurant flow. Canonical inclusion in Firestore model is pending review.
+:::
+
+## <a name="readyAt"></a>11. Property `readyAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Timestamp when the item was ready for pickup or service. TBD/WIP — archived CBL flow.
+
+| Any of(Option)                           |
+| ---------------------------------------- |
+| [firestore-timestamp](#readyAt_anyOf_i0) |
+| [item 1](#readyAt_anyOf_i1)              |
+
+### <a name="readyAt_anyOf_i0"></a>11.1. Property `firestore-timestamp`
+
+|                           |                                     |
+| ------------------------- | ----------------------------------- |
+| **Type**                  | `object`                            |
+| **Required**              | No                                  |
+| **Additional properties** | Not allowed                         |
+| **Same definition as**    | [sentAt_anyOf_i0](#sentAt_anyOf_i0) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="readyAt_anyOf_i1"></a>11.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+:::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.
+:::
+
+:::note
+TBD/WIP — Originally from the archived Couchbase Lite (CBL) restaurant flow. Canonical inclusion in Firestore model is pending review.
+:::
+
+## <a name="servedAt"></a>12. Property `servedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Timestamp when the item was served to the customer. TBD/WIP — archived CBL flow.
+
+| Any of(Option)                            |
+| ----------------------------------------- |
+| [firestore-timestamp](#servedAt_anyOf_i0) |
+| [item 1](#servedAt_anyOf_i1)              |
+
+### <a name="servedAt_anyOf_i0"></a>12.1. Property `firestore-timestamp`
+
+|                           |                                     |
+| ------------------------- | ----------------------------------- |
+| **Type**                  | `object`                            |
+| **Required**              | No                                  |
+| **Additional properties** | Not allowed                         |
+| **Same definition as**    | [sentAt_anyOf_i0](#sentAt_anyOf_i0) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="servedAt_anyOf_i1"></a>12.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-06 at 19:27:48 +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.
+:::
+
+:::note
+TBD/WIP — Originally from the archived Couchbase Lite (CBL) restaurant flow. Canonical inclusion in Firestore model is pending review.
+:::