@cxtms/cx-schema 1.7.2 → 1.7.3

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.
@@ -1,5 +1,12 @@
1
1
  # Accounting Transaction Entity Field Reference
2
2
 
3
+ ## Contents
4
+ - AccountingTransaction Fields
5
+ - Charge Entity
6
+ - Payment Entity
7
+ - Accounting Enums
8
+ - Accounting CustomValues
9
+
3
10
  Field names as used in workflow expressions: `{{ entity.transactionNumber }}`, `{{ entity.customValues.myField }}`.
4
11
 
5
12
  ## AccountingTransaction Fields
@@ -1,5 +1,17 @@
1
1
  # Commodity Entity Field Reference
2
2
 
3
+ ## Contents
4
+ - Commodity Scalar Fields
5
+ - Commodity Navigation Properties
6
+ - Commodity Collection Properties
7
+ - Commodity Computed/Resolved GraphQL Fields
8
+ - Commodity Container/Child Pattern (Self-Referencing)
9
+ - CommodityTrackingNumber Sub-Entity
10
+ - OrderCommodity Join Entity
11
+ - Commodity Enums
12
+ - Commodity CustomValues
13
+ - CommodityEvent (Bridge Entity)
14
+
3
15
  Field names as used in workflow expressions: `{{ entity.description }}`, `{{ entity.customValues.myField }}`.
4
16
 
5
17
  ## Scalar Fields
@@ -1,5 +1,15 @@
1
1
  # Contact Entity Field Reference
2
2
 
3
+ ## Contents
4
+ - Contact Scalar Fields
5
+ - Contact Navigation Properties
6
+ - Contact Collection Properties
7
+ - Contact Computed/Resolved GraphQL Fields
8
+ - ContactType Enum
9
+ - ContactAddress Sub-Entity
10
+ - Contact Other Related Enums
11
+ - Contact CustomValues
12
+
3
13
  Field names as used in workflow expressions: `{{ entity.name }}`, `{{ entity.customValues.myField }}`.
4
14
 
5
15
  ## Scalar Fields
@@ -1,5 +1,14 @@
1
1
  # Geography & Lookup Entity Reference
2
2
 
3
+ ## Contents
4
+ - Country
5
+ - State
6
+ - City
7
+ - Port
8
+ - Vessel
9
+ - CustomCode
10
+ - ModeOfTransportation
11
+
3
12
  Country, State, City, Port, Vessel, CustomCode, ModeOfTransportation.
4
13
 
5
14
  ## Country
@@ -1,5 +1,12 @@
1
1
  # Order Sub-Entity Field Reference
2
2
 
3
+ ## Contents
4
+ - OrderEntity
5
+ - TrackingEvent
6
+ - EventDefinition
7
+ - LinkedOrder
8
+ - OrderDocument
9
+
3
10
  Entities associated with orders: OrderEntity (parties), TrackingEvent, LinkedOrder, OrderDocument.
4
11
 
5
12
  ## OrderEntity
@@ -1,5 +1,15 @@
1
1
  # Order Entity Field Reference
2
2
 
3
+ ## Contents
4
+ - Order Scalar Fields
5
+ - Order Navigation Properties
6
+ - Order Collection Properties
7
+ - Pre-filtered OrderEntity Collections (GraphQL)
8
+ - Order Computed/Resolved GraphQL Fields
9
+ - OrderTypes Enum
10
+ - EntityTypes Enum (for OrderEntity)
11
+ - Order CustomValues
12
+
3
13
  Field names as used in workflow expressions: `{{ entity.orderId }}`, `{{ entity.customValues.myField }}`.
4
14
 
5
15
  ## Scalar Fields
@@ -1,5 +1,13 @@
1
1
  # Rate, Pricing & Accounting Lookup Reference
2
2
 
3
+ ## Contents
4
+ - Rate
5
+ - Lane
6
+ - Discount
7
+ - AccountingItem
8
+ - AccountingAccount
9
+ - PaymentTerm
10
+
3
11
  ## Rate
4
12
 
5
13
  Carrier/vendor rates with tariff rules.
@@ -1,5 +1,14 @@
1
1
  # Shared Entity Reference
2
2
 
3
+ ## Contents
4
+ - Tag
5
+ - Attachment
6
+ - Division
7
+ - EquipmentType
8
+ - PackageType
9
+ - NoteThread
10
+ - Note
11
+
3
12
  Tag, Attachment, Division, EquipmentType, PackageType, Note/NoteThread.
4
13
 
5
14
  ## Tag
@@ -1,5 +1,10 @@
1
1
  # Warehouse & Inventory Entity Reference
2
2
 
3
+ ## Contents
4
+ - InventoryItem
5
+ - WarehouseLocation
6
+ - CargoMovement
7
+
3
8
  ## InventoryItem
4
9
 
5
10
  SKU-level inventory tracking.
@@ -1,5 +1,12 @@
1
1
  # Data & Collection Components
2
2
 
3
+ ## Contents
4
+ - Collection component
5
+ - List component
6
+ - ListItem component
7
+ - Datasource component
8
+ - Script component
9
+
3
10
  ## collection
4
11
 
5
12
  Iterates over data items and renders children as templates. Supports drag-and-drop reordering.
@@ -1,5 +1,18 @@
1
1
  # Data Display Components
2
2
 
3
+ ## Contents
4
+ - DataGrid component
5
+ - Text component
6
+ - Markup component
7
+ - Badge component
8
+ - Icon component
9
+ - Image component
10
+ - Photo component
11
+ - Summary component
12
+ - Diff component
13
+ - Viewer component
14
+ - Embed component
15
+
3
16
  ## dataGrid
4
17
 
5
18
  Full-featured data table with views, filtering, sorting, pagination, and row actions.
@@ -1,5 +1,11 @@
1
1
  # Form & Input Components
2
2
 
3
+ ## Contents
4
+ - Form component
5
+ - Field component
6
+ - FieldCollection component
7
+ - BarcodeScanner component
8
+
3
9
  ## form
4
10
 
5
11
  Data entry form with validation, queries, and submission. Wraps React Hook Form's FormProvider.
@@ -1,5 +1,16 @@
1
1
  # Interactive & Navigation Components
2
2
 
3
+ ## Contents
4
+ - Button component
5
+ - Dropdown component
6
+ - MenuButton component
7
+ - Link component
8
+ - Redirect component
9
+ - Navbar component
10
+ - NavbarItem component
11
+ - NavbarLink component
12
+ - NavDropdown component
13
+
3
14
  ## button
4
15
 
5
16
  MUI Button with icon, label, loading state, and action dispatch.
@@ -1,5 +1,16 @@
1
1
  # Layout & Structure Components
2
2
 
3
+ ## Contents
4
+ - Layout component
5
+ - Row component
6
+ - Col component
7
+ - Header component
8
+ - Tabs component
9
+ - Toolbar component
10
+ - Card component
11
+ - Line component
12
+ - Slot component
13
+
3
14
  ## layout
4
15
 
5
16
  General-purpose container. Renders MUI Grid or Box with flexbox.
@@ -1,5 +1,15 @@
1
1
  # Specialized Components
2
2
 
3
+ ## Contents
4
+ - Calendar component
5
+ - Notes component
6
+ - Dashboard component
7
+ - DashboardWidget component
8
+ - Widget component
9
+ - Timeline component
10
+ - TimelineGrid component
11
+ - OAuth2 component
12
+
3
13
  ## calendar
4
14
 
5
15
  FullCalendar integration with GraphQL event sources, timezone support, and programmatic control.
@@ -1,5 +1,13 @@
1
1
  # Communication & Document Tasks Reference
2
2
 
3
+ ## Contents
4
+ - Email/Send task (send emails with templates and attachments)
5
+ - Email/VerifyCode task (send and verify email verification codes)
6
+ - Document/Render task (render PDF or Excel from HTML templates)
7
+ - Document/Send task (send a previously rendered document)
8
+ - Attachment tasks (Create, Update, Thumbnail, PdfThumbnail, RegenerateThumbnails)
9
+ - PdfDocument/Merge task (merge multiple PDFs into one)
10
+
3
11
  ## Email/Send
4
12
 
5
13
  Sends emails with optional templates and attachments.
@@ -1,5 +1,22 @@
1
1
  # Entity CRUD Tasks Reference
2
2
 
3
+ ## Contents
4
+ - Entity/Change task (generic entity modification in Before triggers)
5
+ - Order tasks (Create, Update, Delete, Get, Copy, Split, Import, etc.)
6
+ - Contact tasks (Create, Update, Delete)
7
+ - ContactAddress tasks (Create, Update, Delete, Import)
8
+ - ContactPaymentMethod tasks (Create, Update, SendChargedAmount, VerifyChargedAmount)
9
+ - Commodity tasks (Create, Update, Split, Repack, Unpack)
10
+ - CommodityTrackingNumber tasks (Create, Update, Delete)
11
+ - Job tasks (Create, Update, Delete, Assign, Unassign)
12
+ - Charge tasks (Create, Update, Delete, DynamicUpdate, Calculate)
13
+ - Discount task (Update)
14
+ - Order sub-entity tasks (OrderCommodity, OrderCharge, OrderDocument, OrderTrackingEvent, OrderEntity)
15
+ - Inventory tasks (InventoryItem Create, Update, Delete)
16
+ - Other entity tasks (Movement, Country, Cities, Rate, TrackingEvent/Import)
17
+ - Note tasks (Create, Update, Delete, Import, Export, RenameThread)
18
+ - AccountingTransaction/ApplyCredit task
19
+
3
20
  All entity tasks follow the `Namespace/Operation@Version` pattern. Outputs are stored as `ActivityName.StepName.outputKey`.
4
21
 
5
22
  ## Generic Entity Change
@@ -1,5 +1,10 @@
1
1
  # Variable References & Expressions
2
2
 
3
+ ## Contents
4
+ - Template Expressions: `{{ path }}` (in step inputs)
5
+ - NCalc Expressions: `[variable]` (in conditions and expression directives)
6
+ - Property Path Syntax (in collection, mapping, variable paths)
7
+
3
8
  There are **two distinct syntaxes** for referencing variables, used in different contexts.
4
9
 
5
10
  ## Template Expressions: `{{ path }}` (in step inputs)
@@ -1,5 +1,12 @@
1
1
  # Flow Workflow YAML Reference
2
2
 
3
+ ## Contents
4
+ - Flow top-level structure (workflowType, entity, states, transitions, aggregations)
5
+ - Flow entity section (entity name, type, includes, query)
6
+ - Flow states section (initial, final, parent hierarchy, onEnter/onExit steps)
7
+ - Flow transitions section (manual, auto, event triggers; from/to states; conditions)
8
+ - Flow aggregations section (reusable collection expressions: all, any, sum, count)
9
+
3
10
  Flow workflows are declarative state machines for entity lifecycle management. Use `workflowType: Flow` in the workflow section.
4
11
 
5
12
  ## Top-Level Structure
@@ -1,5 +1,14 @@
1
1
  # Other Tasks Reference
2
2
 
3
+ ## Contents
4
+ - User & Auth tasks (User CRUD, verification codes, OAuth2 authentication)
5
+ - Caching tasks (SetCache and GetCache for in-memory key-value storage)
6
+ - EDI & Structured File Parsing tasks (EDI/Parse for X12/EDIFACT, StructuredFile/Parse)
7
+ - Flow/Transition task (trigger state machine transitions programmatically)
8
+ - Note tasks (Create, Update, Delete, NoteThread/Rename, bulk Import/Export)
9
+ - AppModule tasks (Create, Update, Delete app modules)
10
+ - ActionEvent/Create task (trigger UI notifications or webhooks)
11
+
3
12
  ## User & Auth
4
13
 
5
14
  | Task | Description |
@@ -1,5 +1,17 @@
1
1
  # Utilities Tasks Reference
2
2
 
3
+ ## Contents
4
+ - Available utility tasks (summary table of all Utilities/* tasks)
5
+ - SetVariable task (set variables in activity and global scope)
6
+ - Log task (log variables and messages to workflow logger)
7
+ - Error task (throw workflow error to halt execution)
8
+ - HttpRequest task (HTTP calls to external APIs with action events)
9
+ - Map task (extract and reshape data into new variables)
10
+ - Template task (Handlebars template rendering)
11
+ - CsvParse task (parse CSV content into structured data)
12
+ - Export task (export data to file format)
13
+ - Import task (import data from file content)
14
+
3
15
  ## Available Tasks
4
16
 
5
17
  | Task | Description |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cxtms/cx-schema",
3
- "version": "1.7.2",
3
+ "version": "1.7.3",
4
4
  "description": "Schema validation package for CargoXplorer YAML modules",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",