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

package/dist/types/models/dcsaTypes.d.ts

@@ -0,0 +1,193 @@
+/**
+ * The types for DCSA.
+ */
+export declare const DcsaTypes: {
+    /**
+     * Barge.
+     */
+    readonly Barge: "Barge";
+    /**
+     * Barge transport call.
+     */
+    readonly BargeTransportCall: "BargeTransportCall";
+    /**
+     * Base equipment event.
+     */
+    readonly BaseEquipmentEvent: "BaseEquipmentEvent";
+    /**
+     * Base event.
+     */
+    readonly BaseEvent: "BaseEvent";
+    /**
+     * Base IoT event.
+     */
+    readonly BaseIoTEvent: "BaseIoTEvent";
+    /**
+     * Base reefer event.
+     */
+    readonly BaseReeferEvent: "BaseReeferEvent";
+    /**
+     * Base shipment event.
+     */
+    readonly BaseShipmentEvent: "BaseShipmentEvent";
+    /**
+     * Base transport event.
+     */
+    readonly BaseTransportEvent: "BaseTransportEvent";
+    /**
+     * Equipment event.
+     */
+    readonly EquipmentEvent: "EquipmentEvent";
+    /**
+     * Equipment payload.
+     */
+    readonly EquipmentPayload: "EquipmentPayload";
+    /**
+     * Equipment subscription body.
+     */
+    readonly EquipmentSubscriptionBody: "EquipmentSubscriptionBody";
+    /**
+     * Event.
+     */
+    readonly Event: "Event";
+    /**
+     * Event metadata (active).
+     */
+    readonly EventMetadataActive: "EventMetadataActive";
+    /**
+     * Event metadata (base).
+     */
+    readonly EventMetadataBase: "EventMetadataBase";
+    /**
+     * Event metadata (retraction).
+     */
+    readonly EventMetadataRetraction: "EventMetadataRetraction";
+    /**
+     * Event payload.
+     */
+    readonly EventPayload: "EventPayload";
+    /**
+     * Event retraction.
+     */
+    readonly EventRetraction: "EventRetraction";
+    /**
+     * Event with payload.
+     */
+    readonly EventWithPayload: "EventWithPayload";
+    /**
+     * IoT event.
+     */
+    readonly IotEvent: "IotEvent";
+    /**
+     * IoT event metadata (active).
+     */
+    readonly IotEventMetadataActive: "IotEventMetadataActive";
+    /**
+     * IoT event metadata (retraction).
+     */
+    readonly IotEventMetadataRetraction: "IotEventMetadataRetraction";
+    /**
+     * IoT payload.
+     */
+    readonly IotPayload: "IotPayload";
+    /**
+     * IoT subscription body.
+     */
+    readonly IotSubscriptionBody: "IotSubscriptionBody";
+    /**
+     * Publisher.
+     */
+    readonly Publisher: "Publisher";
+    /**
+     * Rail transport call.
+     */
+    readonly RailTransportCall: "RailTransportCall";
+    /**
+     * Reefer event.
+     */
+    readonly ReeferEvent: "ReeferEvent";
+    /**
+     * Reefer event metadata (active).
+     */
+    readonly ReeferEventMetadataActive: "ReeferEventMetadataActive";
+    /**
+     * Reefer event metadata (retraction).
+     */
+    readonly ReeferEventMetadataRetraction: "ReeferEventMetadataRetraction";
+    /**
+     * Reefer measurements.
+     */
+    readonly ReeferMeasurements: "ReeferMeasurements";
+    /**
+     * Reefer payload.
+     */
+    readonly ReeferPayload: "ReeferPayload";
+    /**
+     * Reefer setpoint.
+     */
+    readonly ReeferSetpoint: "ReeferSetpoint";
+    /**
+     * Reefer subscription body.
+     */
+    readonly ReeferSubscriptionBody: "ReeferSubscriptionBody";
+    /**
+     * Reference.
+     */
+    readonly Reference: "Reference";
+    /**
+     * Related document reference.
+     */
+    readonly RelatedDocumentReference: "RelatedDocumentReference";
+    /**
+     * Shipment event.
+     */
+    readonly ShipmentEvent: "ShipmentEvent";
+    /**
+     * Shipment payload.
+     */
+    readonly ShipmentPayload: "ShipmentPayload";
+    /**
+     * Shipment subscription body.
+     */
+    readonly ShipmentSubscriptionBody: "ShipmentSubscriptionBody";
+    /**
+     * Transport call.
+     */
+    readonly TransportCall: "TransportCall";
+    /**
+     * Transport call base.
+     */
+    readonly TransportCallBase: "TransportCallBase";
+    /**
+     * Transport call subscription body.
+     */
+    readonly TransportCallSubscriptionBody: "TransportCallSubscriptionBody";
+    /**
+     * Transport event.
+     */
+    readonly TransportEvent: "TransportEvent";
+    /**
+     * Transport payload.
+     */
+    readonly TransportPayload: "TransportPayload";
+    /**
+     * Transport subscription body.
+     */
+    readonly TransportSubscriptionBody: "TransportSubscriptionBody";
+    /**
+     * Truck transport call.
+     */
+    readonly TruckTransportCall: "TruckTransportCall";
+    /**
+     * Vessel.
+     */
+    readonly Vessel: "Vessel";
+    /**
+     * Vessel transport call.
+     */
+    readonly VesselTransportCall: "VesselTransportCall";
+};
+/**
+ * The types for DCSA.
+ */
+export type DcsaTypes = (typeof DcsaTypes)[keyof typeof DcsaTypes];

package/docs/changelog.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [0.0.3-next.22](https://github.com/twinfoundation/standards/compare/standards-dcsa-v0.0.3-next.21...standards-dcsa-v0.0.3-next.22) (2026-01-29)
+
+
+### Features
+
+* add dcsa package ([#124](https://github.com/twinfoundation/standards/issues/124)) ([ac443f5](https://github.com/twinfoundation/standards/commit/ac443f5a8ac55a8e28e699c44686eb7470624444))
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/standards-dcsa Examples

package/docs/reference/classes/DcsaDataTypes.md

@@ -0,0 +1,37 @@
+# Abstract Class: DcsaDataTypes
+
+Data Type registration for DCSA
+
+## Constructors
+
+### Constructor
+
+> **new DcsaDataTypes**(): `DcsaDataTypes`
+
+#### Returns
+
+`DcsaDataTypes`
+
+## Methods
+
+### registerRedirects()
+
+> `static` **registerRedirects**(): `void`
+
+Register redirects for DCSA namespace to enable offline JSON-LD processing.
+
+#### Returns
+
+`void`
+
+***
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,96 @@
+# @twin.org/standards-dcsa
+
+## Classes
+
+- [DcsaDataTypes](classes/DcsaDataTypes.md)
+
+## Interfaces
+
+- [IDcsaBarge](interfaces/IDcsaBarge.md)
+- [IDcsaBargeTransportCall](interfaces/IDcsaBargeTransportCall.md)
+- [IDcsaBaseEvent](interfaces/IDcsaBaseEvent.md)
+- [IDcsaBaseIoTEvent](interfaces/IDcsaBaseIoTEvent.md)
+- [IDcsaBaseReeferEvent](interfaces/IDcsaBaseReeferEvent.md)
+- [IDcsaEquipmentPayload](interfaces/IDcsaEquipmentPayload.md)
+- [IDcsaEquipmentSubscriptionBody](interfaces/IDcsaEquipmentSubscriptionBody.md)
+- [IDcsaEventMetadataBase](interfaces/IDcsaEventMetadataBase.md)
+- [IDcsaEventRetraction](interfaces/IDcsaEventRetraction.md)
+- [IDcsaIotEventMetadataActive](interfaces/IDcsaIotEventMetadataActive.md)
+- [IDcsaIotEventMetadataRetraction](interfaces/IDcsaIotEventMetadataRetraction.md)
+- [IDcsaIotSubscriptionBody](interfaces/IDcsaIotSubscriptionBody.md)
+- [IDcsaPublisher](interfaces/IDcsaPublisher.md)
+- [IDcsaRailTransportCall](interfaces/IDcsaRailTransportCall.md)
+- [IDcsaReeferEventMetadataActive](interfaces/IDcsaReeferEventMetadataActive.md)
+- [IDcsaReeferEventMetadataRetraction](interfaces/IDcsaReeferEventMetadataRetraction.md)
+- [IDcsaReeferMeasurements](interfaces/IDcsaReeferMeasurements.md)
+- [IDcsaReeferSetpoint](interfaces/IDcsaReeferSetpoint.md)
+- [IDcsaReeferSubscriptionBody](interfaces/IDcsaReeferSubscriptionBody.md)
+- [IDcsaReference](interfaces/IDcsaReference.md)
+- [IDcsaRelatedDocumentReference](interfaces/IDcsaRelatedDocumentReference.md)
+- [IDcsaShipmentPayload](interfaces/IDcsaShipmentPayload.md)
+- [IDcsaShipmentSubscriptionBody](interfaces/IDcsaShipmentSubscriptionBody.md)
+- [IDcsaTransportCallBase](interfaces/IDcsaTransportCallBase.md)
+- [IDcsaTransportCallSubscriptionBody](interfaces/IDcsaTransportCallSubscriptionBody.md)
+- [IDcsaTransportPayload](interfaces/IDcsaTransportPayload.md)
+- [IDcsaTransportSubscriptionBody](interfaces/IDcsaTransportSubscriptionBody.md)
+- [IDcsaTruckTransportCall](interfaces/IDcsaTruckTransportCall.md)
+- [IDcsaVessel](interfaces/IDcsaVessel.md)
+- [IDcsaVesselTransportCall](interfaces/IDcsaVesselTransportCall.md)
+
+## Type Aliases
+
+- [IDcsaBaseEquipmentEvent](type-aliases/IDcsaBaseEquipmentEvent.md)
+- [IDcsaBaseShipmentEvent](type-aliases/IDcsaBaseShipmentEvent.md)
+- [IDcsaBaseTransportEvent](type-aliases/IDcsaBaseTransportEvent.md)
+- [IDcsaEquipmentEvent](type-aliases/IDcsaEquipmentEvent.md)
+- [IDcsaEvent](type-aliases/IDcsaEvent.md)
+- [IDcsaEventMetadataActive](type-aliases/IDcsaEventMetadataActive.md)
+- [IDcsaEventMetadataRetraction](type-aliases/IDcsaEventMetadataRetraction.md)
+- [IDcsaEventPayload](type-aliases/IDcsaEventPayload.md)
+- [IDcsaEventWithPayload](type-aliases/IDcsaEventWithPayload.md)
+- [IDcsaIotEvent](type-aliases/IDcsaIotEvent.md)
+- [IDcsaIotPayload](type-aliases/IDcsaIotPayload.md)
+- [IDcsaReeferEvent](type-aliases/IDcsaReeferEvent.md)
+- [IDcsaReeferPayload](type-aliases/IDcsaReeferPayload.md)
+- [IDcsaShipmentEvent](type-aliases/IDcsaShipmentEvent.md)
+- [IDcsaTransportCall](type-aliases/IDcsaTransportCall.md)
+- [IDcsaTransportEvent](type-aliases/IDcsaTransportEvent.md)
+- [DcsaContexts](type-aliases/DcsaContexts.md)
+- [DcsaDocumentTypeCodes](type-aliases/DcsaDocumentTypeCodes.md)
+- [DcsaEquipmentEventTypeCodes](type-aliases/DcsaEquipmentEventTypeCodes.md)
+- [DcsaEventClassifierCode](type-aliases/DcsaEventClassifierCode.md)
+- [DcsaEventTypes](type-aliases/DcsaEventTypes.md)
+- [DcsaIotEventCode](type-aliases/DcsaIotEventCode.md)
+- [DcsaIotEventTypeCodes](type-aliases/DcsaIotEventTypeCodes.md)
+- [DcsaModeOfTransport](type-aliases/DcsaModeOfTransport.md)
+- [DcsaOperationsEventTypeCodes](type-aliases/DcsaOperationsEventTypeCodes.md)
+- [DcsaPortCallPhaseTypeCodes](type-aliases/DcsaPortCallPhaseTypeCodes.md)
+- [DcsaPortCallServiceTypeCodes](type-aliases/DcsaPortCallServiceTypeCodes.md)
+- [DcsaPublisherRole](type-aliases/DcsaPublisherRole.md)
+- [DcsaReeferEventTypeCodes](type-aliases/DcsaReeferEventTypeCodes.md)
+- [DcsaShipmentEventTypeCodes](type-aliases/DcsaShipmentEventTypeCodes.md)
+- [DcsaTntPublisherRole](type-aliases/DcsaTntPublisherRole.md)
+- [DcsaTransportCallFacilityTypeCodes](type-aliases/DcsaTransportCallFacilityTypeCodes.md)
+- [DcsaTransportEventTypeCodes](type-aliases/DcsaTransportEventTypeCodes.md)
+- [DcsaTypes](type-aliases/DcsaTypes.md)
+
+## Variables
+
+- [DcsaContexts](variables/DcsaContexts.md)
+- [DcsaDocumentTypeCodes](variables/DcsaDocumentTypeCodes.md)
+- [DcsaEquipmentEventTypeCodes](variables/DcsaEquipmentEventTypeCodes.md)
+- [DcsaEventClassifierCodes](variables/DcsaEventClassifierCodes.md)
+- [DcsaEventTypes](variables/DcsaEventTypes.md)
+- [DcsaIotEventCodes](variables/DcsaIotEventCodes.md)
+- [DcsaIotEventTypeCodes](variables/DcsaIotEventTypeCodes.md)
+- [DcsaModeOfTransport](variables/DcsaModeOfTransport.md)
+- [DcsaOperationsEventTypeCodes](variables/DcsaOperationsEventTypeCodes.md)
+- [DcsaPortCallPhaseTypeCodes](variables/DcsaPortCallPhaseTypeCodes.md)
+- [DcsaPortCallServiceTypeCodes](variables/DcsaPortCallServiceTypeCodes.md)
+- [DcsaPublisherRoles](variables/DcsaPublisherRoles.md)
+- [DcsaReeferEventTypeCodes](variables/DcsaReeferEventTypeCodes.md)
+- [DcsaShipmentEventTypeCodes](variables/DcsaShipmentEventTypeCodes.md)
+- [DcsaTntPublisherRoles](variables/DcsaTntPublisherRoles.md)
+- [DcsaTransportCallFacilityTypeCodes](variables/DcsaTransportCallFacilityTypeCodes.md)
+- [DcsaTransportEventTypeCodes](variables/DcsaTransportEventTypeCodes.md)
+- [DcsaTypes](variables/DcsaTypes.md)

package/docs/reference/interfaces/IDcsaBarge.md

@@ -0,0 +1,59 @@
+# Interface: IDcsaBarge
+
+Barge.
+
+Source: `barge` schema in the DCSA Event Domain (v3.1.0).
+
+Note: Most properties are defined in DCSA_DOMAIN; this package models them as strings.
+
+## See
+
+https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Barge name.
+
+***
+
+### vesselIMONumber?
+
+> `optional` **vesselIMONumber**: `string`
+
+Barge IMO number (when available).
+
+***
+
+### flag?
+
+> `optional` **flag**: `string`
+
+Barge flag.
+
+***
+
+### callSign?
+
+> `optional` **callSign**: `string`
+
+Barge call sign.
+
+***
+
+### operatorCarrierCode?
+
+> `optional` **operatorCarrierCode**: `string`
+
+Carrier code of the barge operator.
+
+***
+
+### operatorCarrierCodeListProvider?
+
+> `optional` **operatorCarrierCodeListProvider**: `string`
+
+Provider of the operator carrier code list.

package/docs/reference/interfaces/IDcsaBargeTransportCall.md

@@ -0,0 +1,135 @@
+# Interface: IDcsaBargeTransportCall
+
+Barge transport call details.
+
+Source: `bargeTransportCall` 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
+
+## Extends
+
+- [`IDcsaTransportCallBase`](IDcsaTransportCallBase.md)
+
+## Properties
+
+### modeOfTransport
+
+> **modeOfTransport**: `"BARGE"`
+
+Discriminator for the transport mode.
+
+***
+
+### barge?
+
+> `optional` **barge**: [`IDcsaBarge`](IDcsaBarge.md)
+
+Barge.
+
+***
+
+### portVisitReference?
+
+> `optional` **portVisitReference**: `string`
+
+Port visit reference.
+
+***
+
+### carrierServiceCode?
+
+> `optional` **carrierServiceCode**: `string`
+
+Carrier service code.
+
+***
+
+### universalServiceReference?
+
+> `optional` **universalServiceReference**: `string`
+
+Universal service reference.
+
+***
+
+### carrierExportVoyageNumber?
+
+> `optional` **carrierExportVoyageNumber**: `string`
+
+Carrier export voyage number.
+
+***
+
+### universalExportVoyageReference?
+
+> `optional` **universalExportVoyageReference**: `string`
+
+Universal export voyage reference.
+
+***
+
+### carrierImportVoyageNumber?
+
+> `optional` **carrierImportVoyageNumber**: `string`
+
+Carrier import voyage number.
+
+***
+
+### universalImportVoyageReference?
+
+> `optional` **universalImportVoyageReference**: `string`
+
+Universal import voyage reference.
+
+***
+
+### transportCallReference
+
+> **transportCallReference**: `string`
+
+Unique reference for the transport call.
+
+#### Inherited from
+
+[`IDcsaTransportCallBase`](IDcsaTransportCallBase.md).[`transportCallReference`](IDcsaTransportCallBase.md#transportcallreference)
+
+***
+
+### transportCallSequenceNumber?
+
+> `optional` **transportCallSequenceNumber**: `number`
+
+Sequence number of the transport call.
+
+#### Inherited from
+
+[`IDcsaTransportCallBase`](IDcsaTransportCallBase.md).[`transportCallSequenceNumber`](IDcsaTransportCallBase.md#transportcallsequencenumber)
+
+***
+
+### location?
+
+> `optional` **location**: `unknown`
+
+Location of the transport call.
+
+Kept as unknown since the authoritative schema references LOCATION_DOMAIN types.
+
+#### Inherited from
+
+[`IDcsaTransportCallBase`](IDcsaTransportCallBase.md).[`location`](IDcsaTransportCallBase.md#location)
+
+***
+
+### facilityTypeCode?
+
+> `optional` **facilityTypeCode**: [`DcsaTransportCallFacilityTypeCodes`](../type-aliases/DcsaTransportCallFacilityTypeCodes.md)
+
+Facility type code.
+
+#### Inherited from
+
+[`IDcsaTransportCallBase`](IDcsaTransportCallBase.md).[`facilityTypeCode`](IDcsaTransportCallBase.md#facilitytypecode)

package/docs/reference/interfaces/IDcsaBaseEvent.md

@@ -0,0 +1,35 @@
+# Interface: IDcsaBaseEvent
+
+Base event attributes shared by all payloads.
+
+Source: `baseEvent` 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
+
+## Extended by
+
+- [`IDcsaEquipmentPayload`](IDcsaEquipmentPayload.md)
+- [`IDcsaShipmentPayload`](IDcsaShipmentPayload.md)
+- [`IDcsaTransportPayload`](IDcsaTransportPayload.md)
+
+## Properties
+
+### eventClassifierCode
+
+> **eventClassifierCode**: [`DcsaEventClassifierCode`](../type-aliases/DcsaEventClassifierCode.md)
+
+Code for the event classifier.
+
+Note: allowed values depend on event type. Some event categories in the upstream spec
+constrain this to a subset (e.g. Shipment/IoT/Reefer are always ACT).
+
+***
+
+### eventDateTime
+
+> **eventDateTime**: `string`
+
+The local date and time when the event took place (or will take place).
+Format: ISO 8601 date-time.

package/docs/reference/interfaces/IDcsaBaseIoTEvent.md

@@ -0,0 +1,67 @@
+# Interface: IDcsaBaseIoTEvent
+
+Base IoT event attributes.
+
+Source: `baseIoTEvent` 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
+
+## Properties
+
+### eventDateTime
+
+> **eventDateTime**: `string`
+
+Local date-time when the event happened.
+
+***
+
+### eventClassifierCode
+
+> **eventClassifierCode**: `"ACT"`
+
+IoT events are always "ACT".
+
+***
+
+### iotEventTypeCode
+
+> **iotEventTypeCode**: `"DETC"`
+
+IoT event type code.
+
+***
+
+### iotEventCode
+
+> **iotEventCode**: `"DRO"`
+
+IoT event code.
+
+***
+
+### geoLocation?
+
+> `optional` **geoLocation**: `unknown`
+
+Geo location.
+
+Kept as unknown since the authoritative schema references LOCATION_DOMAIN types.
+
+***
+
+### equipmentReference
+
+> **equipmentReference**: `string`
+
+Equipment reference.
+
+***
+
+### relatedDocumentReferences?
+
+> `optional` **relatedDocumentReferences**: [`IDcsaRelatedDocumentReference`](IDcsaRelatedDocumentReference.md)[]
+
+Related document references.