@cxtms/cx-schema 1.9.241 → 1.9.243

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cxtms/cx-schema",
3
- "version": "1.9.241",
3
+ "version": "1.9.243",
4
4
  "description": "Schema validation package for CXTMS YAML modules",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -98,6 +98,7 @@ Dispatch routing covers reusable weekly route templates, daily dispatch routes,
98
98
  |-------|------|-------|
99
99
  | `dispatchRouteStopId` | `int` | PK |
100
100
  | `dispatchRouteId` | `int` | Parent route |
101
+ | `dispatchRoute` | `DispatchRoute?` | Expandable parent route; available in GraphQL and trigger payload mapping |
101
102
  | `stopContactId` | `int?` | Store/location contact (nullable; use with or without `contactAddressId`) |
102
103
  | `contactAddressId` | `int?` | Optional stop address |
103
104
  | `stopType` | `DispatchRouteType` | Defaults to route route type when omitted |
@@ -163,6 +164,11 @@ Vertical-specific routing details belong in `customValues`.
163
164
  | `customValues` | `Dictionary` | Location, event, appointment, and metric data |
164
165
  | `trackingEvents` | `[TrackingEvent]` | Leg-level milestones |
165
166
 
167
+ Entity-trigger payloads load the status navigation before mapping when necessary. This
168
+ means `OrderMoveLeg` trigger conditions can rely on the current leg status name after an
169
+ FK-only change, and `DispatchRouteStop` trigger conditions can rely on the current stop
170
+ status and parent route.
171
+
166
172
  `OrderMoveStatus` and `OrderMoveLegStatus` are organization-scoped status dictionaries with
167
173
  `statusName`, `statusDescription`, `statusStage`, `priority`, `color`, and `customValues`.
168
174
  Moves support `OrderMove/Create@1`, `OrderMove/Update@1`, and `OrderMove/Delete@1` workflow tasks.
@@ -75,6 +75,7 @@ Order GraphQL quick search (`orders(search:)` and `orderGroupBy(search:)`) match
75
75
  | `dispatchRouteStopOrders` | `[DispatchRouteStopOrder]` | Stop membership links for this order; expand `dispatchRouteStop` to inspect route, stop status, or stop tracking events |
76
76
  | `allTags` | `[OrderAllTagsView]` | View: all tags including from commodities |
77
77
  | `allRelatedOrders` | `[OrderRelatedOrdersView]` | Orders sharing commodities |
78
+ | `relatedOrdersV3` | `[OrderRelatedOrdersV3View]` | Filter/sort navigation backed by the non-recursive V3 view; use paths such as `relatedOrdersV3[relatedOrder.orderType:BookingOrder].relatedOrder.trackingNumber` |
78
79
  | `relatedDispatchRoutes` | `[DispatchRoute]` | Routes linked through dispatch route stop order attachments; supports `filter` and `orderBy`; draft orders return an empty list |
79
80
  | `attachmentsSummary` | `OrderAttachmentSummaryView?` | DB view: `.totalCount`, `.hasAny` (active attachments) |
80
81
  | `notesSummary` | `OrderNoteSummaryView?` | DB view: `.totalCount`, `.hasAny` (non-deleted notes) |
@@ -118,6 +119,8 @@ These are virtual fields that filter `orderEntities` by type:
118
119
  | `getModeOfTransportation(idPropertyName)` | `ModeOfTransportation` | |
119
120
  | `getCustomCode(idPropertyName)` | `CustomCode` | |
120
121
  | `getRelatedOrderByProperty(idPropertyName)` | `Order` | Resolve related order from `customValues[idPropertyName]` |
122
+ | `relatedOrdersV3(filter?, orderBy?)` | `[Order]` | Related orders resolved through `fn_order_related_orders`; scoped to the current organization. Order-list filter/sort paths use the same-named entity navigation backed by `vw_order_related_orders_v3` (maximum three container levels). |
123
+ | `relatedOrderV3(filter?, orderBy?)` | `Order` | First V3 related order after filtering and sorting |
121
124
  | `relatedDispatchRoutes(filter, orderBy)` | `[DispatchRoute]` | Routes linked through dispatch route stop order attachments; draft orders return an empty list |
122
125
  | `getCharge(chargeDescription)` | `Charge` | Single charge by description |
123
126
  | `getChargesByChargeType(chargeType)` | `[Charge]` | Charges filtered by type |