@twin.org/standards-dcsa 0.0.3-next.22

package/docs/reference/type-aliases/IDcsaEvent.md

@@ -0,0 +1,11 @@
+# Type Alias: IDcsaEvent
+
+> **IDcsaEvent** = [`IDcsaEventWithPayload`](IDcsaEventWithPayload.md) \| [`IDcsaEventRetraction`](../interfaces/IDcsaEventRetraction.md)
+
+A DCSA Event object.
+
+Source: `event` schema in the DCSA Event Domain (v3.1.0).
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaEventMetadataActive.md

@@ -0,0 +1,16 @@
+# Type Alias: IDcsaEventMetadataActive
+
+> **IDcsaEventMetadataActive** = [`IDcsaEventMetadataBase`](../interfaces/IDcsaEventMetadataBase.md) & `object`
+
+Active event metadata (not a retraction).
+
+The OpenAPI schema defines `retractedEventID` with a default of `null`, so we
+allow it to be omitted or explicitly set to `null`.
+
+## Type Declaration
+
+### retractedEventID?
+
+> `optional` **retractedEventID**: `null`
+
+Must be `null` (or omitted) for non-retraction events.

package/docs/reference/type-aliases/IDcsaEventMetadataRetraction.md

@@ -0,0 +1,15 @@
+# Type Alias: IDcsaEventMetadataRetraction
+
+> **IDcsaEventMetadataRetraction** = [`IDcsaEventMetadataBase`](../interfaces/IDcsaEventMetadataBase.md) & `object`
+
+Retraction event metadata.
+
+If `retractedEventID` is provided, the event MUST NOT include a payload.
+
+## Type Declaration
+
+### retractedEventID
+
+> **retractedEventID**: `string`
+
+The `eventID` of the event being retracted.

package/docs/reference/type-aliases/IDcsaEventPayload.md

@@ -0,0 +1,5 @@
+# Type Alias: IDcsaEventPayload
+
+> **IDcsaEventPayload** = [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md) \| [`IDcsaEquipmentPayload`](../interfaces/IDcsaEquipmentPayload.md) \| [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md)
+
+Payload union for the base `event` schema (T&T events).

package/docs/reference/type-aliases/IDcsaEventWithPayload.md

@@ -0,0 +1,67 @@
+# Type Alias: IDcsaEventWithPayload
+
+> **IDcsaEventWithPayload** = \{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md); \} \| \{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaEquipmentPayload`](../interfaces/IDcsaEquipmentPayload.md); \} \| \{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md); \}
+
+Event with payload (i.e., not a retraction).
+
+## Type Declaration
+
+\{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`
+
+Event metadata (eventType = SHIPMENT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`SHIPMENT`](../variables/DcsaEventTypes.md#shipment)
+
+### payload
+
+> **payload**: [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md)
+
+Event payload.
+
+\{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaEquipmentPayload`](../interfaces/IDcsaEquipmentPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`
+
+Event metadata (eventType = EQUIPMENT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`EQUIPMENT`](../variables/DcsaEventTypes.md#equipment)
+
+### payload
+
+> **payload**: [`IDcsaEquipmentPayload`](../interfaces/IDcsaEquipmentPayload.md)
+
+Event payload.
+
+\{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`
+
+Event metadata (eventType = TRANSPORT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`TRANSPORT`](../variables/DcsaEventTypes.md#transport)
+
+### payload
+
+> **payload**: [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md)
+
+Event payload.

package/docs/reference/type-aliases/IDcsaIotEvent.md

@@ -0,0 +1,43 @@
+# Type Alias: IDcsaIotEvent
+
+> **IDcsaIotEvent** = \{ `metadata`: [`IDcsaIotEventMetadataActive`](../interfaces/IDcsaIotEventMetadataActive.md); `payload`: [`IDcsaIotPayload`](IDcsaIotPayload.md); \} \| \{ `metadata`: [`IDcsaIotEventMetadataRetraction`](../interfaces/IDcsaIotEventMetadataRetraction.md); `payload?`: `never`; \}
+
+IoT event.
+
+Source: `iotEvent` schema in the DCSA Event Domain (v3.1.0).
+
+Retraction rule: if `metadata.retractedEventID` is set, `payload` MUST NOT be present.
+
+## Type Declaration
+
+\{ `metadata`: [`IDcsaIotEventMetadataActive`](../interfaces/IDcsaIotEventMetadataActive.md); `payload`: [`IDcsaIotPayload`](IDcsaIotPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaIotEventMetadataActive`](../interfaces/IDcsaIotEventMetadataActive.md)
+
+Event metadata.
+
+### payload
+
+> **payload**: [`IDcsaIotPayload`](IDcsaIotPayload.md)
+
+Event payload.
+
+\{ `metadata`: [`IDcsaIotEventMetadataRetraction`](../interfaces/IDcsaIotEventMetadataRetraction.md); `payload?`: `never`; \}
+
+### metadata
+
+> **metadata**: [`IDcsaIotEventMetadataRetraction`](../interfaces/IDcsaIotEventMetadataRetraction.md)
+
+Retraction metadata.
+
+### payload?
+
+> `optional` **payload**: `never`
+
+Must not be present for retractions.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaIotPayload.md

@@ -0,0 +1,11 @@
+# Type Alias: IDcsaIotPayload
+
+> **IDcsaIotPayload** = [`IDcsaBaseEvent`](../interfaces/IDcsaBaseEvent.md) & [`IDcsaBaseIoTEvent`](../interfaces/IDcsaBaseIoTEvent.md)
+
+IoT payload.
+
+Source: `iotPayload` schema in the DCSA Event Domain (v3.1.0).
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaReeferEvent.md

@@ -0,0 +1,43 @@
+# Type Alias: IDcsaReeferEvent
+
+> **IDcsaReeferEvent** = \{ `metadata`: [`IDcsaReeferEventMetadataActive`](../interfaces/IDcsaReeferEventMetadataActive.md); `payload`: [`IDcsaReeferPayload`](IDcsaReeferPayload.md); \} \| \{ `metadata`: [`IDcsaReeferEventMetadataRetraction`](../interfaces/IDcsaReeferEventMetadataRetraction.md); `payload?`: `never`; \}
+
+Reefer event.
+
+Source: `reeferEvent` schema in the DCSA Event Domain (v3.1.0).
+
+Retraction rule: if `metadata.retractedEventID` is set, `payload` MUST NOT be present.
+
+## Type Declaration
+
+\{ `metadata`: [`IDcsaReeferEventMetadataActive`](../interfaces/IDcsaReeferEventMetadataActive.md); `payload`: [`IDcsaReeferPayload`](IDcsaReeferPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaReeferEventMetadataActive`](../interfaces/IDcsaReeferEventMetadataActive.md)
+
+Event metadata.
+
+### payload
+
+> **payload**: [`IDcsaReeferPayload`](IDcsaReeferPayload.md)
+
+Event payload.
+
+\{ `metadata`: [`IDcsaReeferEventMetadataRetraction`](../interfaces/IDcsaReeferEventMetadataRetraction.md); `payload?`: `never`; \}
+
+### metadata
+
+> **metadata**: [`IDcsaReeferEventMetadataRetraction`](../interfaces/IDcsaReeferEventMetadataRetraction.md)
+
+Retraction metadata.
+
+### payload?
+
+> `optional` **payload**: `never`
+
+Must not be present for retractions.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaReeferPayload.md

@@ -0,0 +1,11 @@
+# Type Alias: IDcsaReeferPayload
+
+> **IDcsaReeferPayload** = [`IDcsaBaseEvent`](../interfaces/IDcsaBaseEvent.md) & [`IDcsaBaseReeferEvent`](../interfaces/IDcsaBaseReeferEvent.md)
+
+Reefer payload.
+
+Source: `reeferPayload` schema in the DCSA Event Domain (v3.1.0).
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaShipmentEvent.md

@@ -0,0 +1,53 @@
+# Type Alias: IDcsaShipmentEvent
+
+> **IDcsaShipmentEvent** = \{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md); \} \| \{ `metadata`: [`IDcsaEventMetadataRetraction`](IDcsaEventMetadataRetraction.md) & `object`; `payload?`: `never`; \}
+
+The `ShipmentEvent` is a specialized event to handle all events related to documentation.
+
+Source: `shipmentEvent` schema in the DCSA Event Domain (v3.1.0).
+
+## Type Declaration
+
+\{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`
+
+Event metadata (eventType = SHIPMENT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`SHIPMENT`](../variables/DcsaEventTypes.md#shipment)
+
+### payload
+
+> **payload**: [`IDcsaShipmentPayload`](../interfaces/IDcsaShipmentPayload.md)
+
+Business attributes related to the `ShipmentEvent`.
+
+\{ `metadata`: [`IDcsaEventMetadataRetraction`](IDcsaEventMetadataRetraction.md) & `object`; `payload?`: `never`; \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataRetraction`](IDcsaEventMetadataRetraction.md) & `object`
+
+Retraction metadata (eventType = SHIPMENT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`SHIPMENT`](../variables/DcsaEventTypes.md#shipment)
+
+### payload?
+
+> `optional` **payload**: `never`
+
+Retractions do not carry payloads.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaTransportCall.md

@@ -0,0 +1,13 @@
+# Type Alias: IDcsaTransportCall
+
+> **IDcsaTransportCall** = [`IDcsaVesselTransportCall`](../interfaces/IDcsaVesselTransportCall.md) \| [`IDcsaBargeTransportCall`](../interfaces/IDcsaBargeTransportCall.md) \| [`IDcsaRailTransportCall`](../interfaces/IDcsaRailTransportCall.md) \| [`IDcsaTruckTransportCall`](../interfaces/IDcsaTruckTransportCall.md)
+
+Transport call.
+
+Discriminator: `modeOfTransport`.
+
+Source: `transportCall` schema in the DCSA Event Domain (v3.1.0).
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/type-aliases/IDcsaTransportEvent.md

@@ -0,0 +1,53 @@
+# Type Alias: IDcsaTransportEvent
+
+> **IDcsaTransportEvent** = \{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md); \} \| \{ `metadata`: [`IDcsaEventMetadataRetraction`](IDcsaEventMetadataRetraction.md) & `object`; `payload?`: `never`; \}
+
+The `TransportEvent` is a specialized event to handle all events related to transportation.
+
+Source: `transportEvent` schema in the DCSA Event Domain (v3.1.0).
+
+## Type Declaration
+
+\{ `metadata`: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`; `payload`: [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md); \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataActive`](IDcsaEventMetadataActive.md) & `object`
+
+Event metadata (eventType = TRANSPORT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`TRANSPORT`](../variables/DcsaEventTypes.md#transport)
+
+### payload
+
+> **payload**: [`IDcsaTransportPayload`](../interfaces/IDcsaTransportPayload.md)
+
+Business attributes related to the `TransportEvent`.
+
+\{ `metadata`: [`IDcsaEventMetadataRetraction`](IDcsaEventMetadataRetraction.md) & `object`; `payload?`: `never`; \}
+
+### metadata
+
+> **metadata**: [`IDcsaEventMetadataRetraction`](IDcsaEventMetadataRetraction.md) & `object`
+
+Retraction metadata (eventType = TRANSPORT).
+
+#### Type Declaration
+
+##### eventType
+
+> **eventType**: *typeof* [`TRANSPORT`](../variables/DcsaEventTypes.md#transport)
+
+### payload?
+
+> `optional` **payload**: `never`
+
+Retractions do not carry payloads.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/variables/DcsaContexts.md

@@ -0,0 +1,13 @@
+# Variable: DcsaContexts
+
+> `const` **DcsaContexts**: `object`
+
+The LD Contexts concerning DCSA.
+
+## Type Declaration
+
+### Namespace
+
+> `readonly` **Namespace**: `"https://dcsa.org/"` = `"https://dcsa.org/"`
+
+The canonical RDF namespace URI.

package/docs/reference/variables/DcsaDocumentTypeCodes.md

@@ -0,0 +1,151 @@
+# Variable: DcsaDocumentTypeCodes
+
+> `const` **DcsaDocumentTypeCodes**: `object`
+
+DCSA document type codes.
+
+Source: `documentTypeCode` enum in the DCSA Event Domain (v3.1.0).
+
+## Type Declaration
+
+### CBR
+
+> `readonly` **CBR**: `"CBR"` = `"CBR"`
+
+Carrier Booking Request.
+
+### BKG
+
+> `readonly` **BKG**: `"BKG"` = `"BKG"`
+
+Booking.
+
+### SHI
+
+> `readonly` **SHI**: `"SHI"` = `"SHI"`
+
+Shipping Instruction.
+
+### TRD
+
+> `readonly` **TRD**: `"TRD"` = `"TRD"`
+
+Transport Document.
+
+### DEI
+
+> `readonly` **DEI**: `"DEI"` = `"DEI"`
+
+Delivery Instructions.
+
+### DEO
+
+> `readonly` **DEO**: `"DEO"` = `"DEO"`
+
+Delivery Order.
+
+### TRO
+
+> `readonly` **TRO**: `"TRO"` = `"TRO"`
+
+Transport Order.
+
+### CRO
+
+> `readonly` **CRO**: `"CRO"` = `"CRO"`
+
+Container Release Order.
+
+### ARN
+
+> `readonly` **ARN**: `"ARN"` = `"ARN"`
+
+Arrival Notice.
+
+### VGM
+
+> `readonly` **VGM**: `"VGM"` = `"VGM"`
+
+Verified Gross Mass.
+
+### CAS
+
+> `readonly` **CAS**: `"CAS"` = `"CAS"`
+
+Cargo Survey.
+
+### CUC
+
+> `readonly` **CUC**: `"CUC"` = `"CUC"`
+
+Customs Clearance.
+
+### DGD
+
+> `readonly` **DGD**: `"DGD"` = `"DGD"`
+
+Dangerous Goods Declaration.
+
+### OOG
+
+> `readonly` **OOG**: `"OOG"` = `"OOG"`
+
+Out of Gauge.
+
+### CQU
+
+> `readonly` **CQU**: `"CQU"` = `"CQU"`
+
+Contract Quotation.
+
+### INV
+
+> `readonly` **INV**: `"INV"` = `"INV"`
+
+Invoice.
+
+### HCE
+
+> `readonly` **HCE**: `"HCE"` = `"HCE"`
+
+Health Certificate.
+
+### PCE
+
+> `readonly` **PCE**: `"PCE"` = `"PCE"`
+
+Phytosanitary Certificate.
+
+### VCE
+
+> `readonly` **VCE**: `"VCE"` = `"VCE"`
+
+Veterinary Certificate.
+
+### FCE
+
+> `readonly` **FCE**: `"FCE"` = `"FCE"`
+
+Fumigation Certificate.
+
+### ICE
+
+> `readonly` **ICE**: `"ICE"` = `"ICE"`
+
+Inspection Certificate.
+
+### CEA
+
+> `readonly` **CEA**: `"CEA"` = `"CEA"`
+
+Certificate of Analysis.
+
+### CEO
+
+> `readonly` **CEO**: `"CEO"` = `"CEO"`
+
+Certificate of Origin.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/variables/DcsaEquipmentEventTypeCodes.md

@@ -0,0 +1,115 @@
+# Variable: DcsaEquipmentEventTypeCodes
+
+> `const` **DcsaEquipmentEventTypeCodes**: `object`
+
+DCSA equipment event type codes.
+
+Source: `equipmentEventTypeCode` enum in the DCSA Event Domain (v3.1.0).
+
+## Type Declaration
+
+### LOAD
+
+> `readonly` **LOAD**: `"LOAD"` = `"LOAD"`
+
+Loaded.
+
+### DISC
+
+> `readonly` **DISC**: `"DISC"` = `"DISC"`
+
+Discharged.
+
+### GTIN
+
+> `readonly` **GTIN**: `"GTIN"` = `"GTIN"`
+
+Gated in.
+
+### GTOT
+
+> `readonly` **GTOT**: `"GTOT"` = `"GTOT"`
+
+Gated out.
+
+### STUF
+
+> `readonly` **STUF**: `"STUF"` = `"STUF"`
+
+Stuffed.
+
+### STRP
+
+> `readonly` **STRP**: `"STRP"` = `"STRP"`
+
+Stripped.
+
+### PICK
+
+> `readonly` **PICK**: `"PICK"` = `"PICK"`
+
+Pick-up.
+
+### AVPU
+
+> `readonly` **AVPU**: `"AVPU"` = `"AVPU"`
+
+Available for pick-up.
+
+### DROP
+
+> `readonly` **DROP**: `"DROP"` = `"DROP"`
+
+Drop-off.
+
+### AVDO
+
+> `readonly` **AVDO**: `"AVDO"` = `"AVDO"`
+
+Available for drop-off.
+
+### INSP
+
+> `readonly` **INSP**: `"INSP"` = `"INSP"`
+
+Inspected.
+
+### RSEA
+
+> `readonly` **RSEA**: `"RSEA"` = `"RSEA"`
+
+Resealed.
+
+### RMVD
+
+> `readonly` **RMVD**: `"RMVD"` = `"RMVD"`
+
+Removed.
+
+### CUSS
+
+> `readonly` **CUSS**: `"CUSS"` = `"CUSS"`
+
+Customs selected for scan.
+
+### CUSI
+
+> `readonly` **CUSI**: `"CUSI"` = `"CUSI"`
+
+Customs selected for inspection.
+
+### CUSR
+
+> `readonly` **CUSR**: `"CUSR"` = `"CUSR"`
+
+Customs released.
+
+### CROS
+
+> `readonly` **CROS**: `"CROS"` = `"CROS"`
+
+Crossed.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

package/docs/reference/variables/DcsaEventClassifierCodes.md

@@ -0,0 +1,38 @@
+# Variable: DcsaEventClassifierCodes
+
+> `const` **DcsaEventClassifierCodes**: `object`
+
+DCSA event classifier codes.
+
+Note: Allowed values depend on event type.
+Source: `eventClassifierCode` schema in the DCSA Event Domain (v3.1.0).
+
+## Type Declaration
+
+### ACT
+
+> `readonly` **ACT**: `"ACT"` = `"ACT"`
+
+Actual.
+
+### PLN
+
+> `readonly` **PLN**: `"PLN"` = `"PLN"`
+
+Planned.
+
+### EST
+
+> `readonly` **EST**: `"EST"` = `"EST"`
+
+Estimated.
+
+### REQ
+
+> `readonly` **REQ**: `"REQ"` = `"REQ"`
+
+Requested.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml