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

package/dist/es/schemas/DcsaTransportCallSubscriptionBody.json

@@ -0,0 +1,37 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaTransportCallSubscriptionBody",
+    "description": "Transport call subscription filters.\n\nSource: `transportCallSubscriptionBody` schema in the DCSA Event Domain (v3.1.0).",
+    "type": "object",
+    "properties": {
+        "transportCallReference": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific transport call."
+        },
+        "vesselIMONumber": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific vessel IMO number."
+        },
+        "carrierExportVoyageNumber": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific carrier export voyage number."
+        },
+        "universalExportVoyageReference": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific universal export voyage reference."
+        },
+        "carrierServiceCode": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific carrier service code."
+        },
+        "universalServiceReference": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific universal service reference."
+        },
+        "UNLocationCode": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific UN/LOCODE."
+        }
+    },
+    "additionalProperties": false
+}

package/dist/es/schemas/DcsaTransportEvent.json

@@ -0,0 +1,107 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaTransportEvent",
+    "description": "The `TransportEvent` is a specialized event to handle all events related to transportation.\n\nSource: `transportEvent` schema in the DCSA Event Domain (v3.1.0).",
+    "anyOf": [
+        {
+            "type": "object",
+            "properties": {
+                "metadata": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "eventType": {
+                            "$ref": "https://schema.twindev.org/dcsa/DcsaEventTypes",
+                            "description": "Event type discriminator.\n\nFor the base `event` schema (T&T polling), the discriminator is limited to SHIPMENT/EQUIPMENT/TRANSPORT and is further narrowed by the concrete event union types. Other event hub schemas (e.g. IoT/Reefer) constrain this to IOT/REEFER."
+                        },
+                        "retractedEventID": {
+                            "type": "null",
+                            "description": "Must be `null` (or omitted) for non-retraction events."
+                        },
+                        "eventID": {
+                            "type": "string",
+                            "description": "The unique identifier for this event message (not the source system)."
+                        },
+                        "eventCreatedDateTime": {
+                            "type": "string",
+                            "description": "Timestamp of when the event was created by the publisher. Format: ISO 8601 date-time."
+                        },
+                        "publisher": {
+                            "$ref": "https://schema.twindev.org/dcsa/DcsaPublisher",
+                            "description": "The party publishing this event."
+                        },
+                        "publisherRole": {
+                            "$ref": "https://schema.twindev.org/dcsa/DcsaTntPublisherRole",
+                            "description": "Publisher role (context of the publisher). For Track & Trace events, this is the `tntPublisherRole` code list."
+                        }
+                    },
+                    "required": [
+                        "eventCreatedDateTime",
+                        "eventID",
+                        "eventType",
+                        "publisher",
+                        "publisherRole"
+                    ],
+                    "description": "Event metadata (eventType = TRANSPORT)."
+                },
+                "payload": {
+                    "$ref": "https://schema.twindev.org/dcsa/DcsaTransportPayload",
+                    "description": "Business attributes related to the `TransportEvent`."
+                }
+            },
+            "required": [
+                "metadata",
+                "payload"
+            ],
+            "additionalProperties": false
+        },
+        {
+            "type": "object",
+            "properties": {
+                "metadata": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "eventType": {
+                            "$ref": "https://schema.twindev.org/dcsa/DcsaEventTypes",
+                            "description": "Event type discriminator.\n\nFor the base `event` schema (T&T polling), the discriminator is limited to SHIPMENT/EQUIPMENT/TRANSPORT and is further narrowed by the concrete event union types. Other event hub schemas (e.g. IoT/Reefer) constrain this to IOT/REEFER."
+                        },
+                        "retractedEventID": {
+                            "type": "string",
+                            "description": "The `eventID` of the event being retracted."
+                        },
+                        "eventID": {
+                            "type": "string",
+                            "description": "The unique identifier for this event message (not the source system)."
+                        },
+                        "eventCreatedDateTime": {
+                            "type": "string",
+                            "description": "Timestamp of when the event was created by the publisher. Format: ISO 8601 date-time."
+                        },
+                        "publisher": {
+                            "$ref": "https://schema.twindev.org/dcsa/DcsaPublisher",
+                            "description": "The party publishing this event."
+                        },
+                        "publisherRole": {
+                            "$ref": "https://schema.twindev.org/dcsa/DcsaTntPublisherRole",
+                            "description": "Publisher role (context of the publisher). For Track & Trace events, this is the `tntPublisherRole` code list."
+                        }
+                    },
+                    "required": [
+                        "eventCreatedDateTime",
+                        "eventID",
+                        "eventType",
+                        "publisher",
+                        "publisherRole",
+                        "retractedEventID"
+                    ],
+                    "description": "Retraction metadata (eventType = TRANSPORT)."
+                }
+            },
+            "required": [
+                "metadata"
+            ],
+            "additionalProperties": false
+        }
+    ]
+}

package/dist/es/schemas/DcsaTransportPayload.json

@@ -0,0 +1,53 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaTransportPayload",
+    "description": "Transport payload.\n\nSource: `transportPayload` schema in the DCSA Event Domain (v3.1.0).",
+    "type": "object",
+    "properties": {
+        "eventClassifierCode": {
+            "$ref": "https://schema.twindev.org/dcsa/Exclude%3CDcsaEventClassifierCode%2C%22REQ%22%3E",
+            "description": "Event classifier code."
+        },
+        "eventDateTime": {
+            "type": "string",
+            "description": "The local date and time when the event took place (or will take place). Format: ISO 8601 date-time."
+        },
+        "transportEventTypeCode": {
+            "$ref": "https://schema.twindev.org/dcsa/DcsaTransportEventTypeCodes",
+            "description": "Transport event type code."
+        },
+        "transportCall": {
+            "$ref": "https://schema.twindev.org/dcsa/DcsaTransportCall",
+            "description": "Transport call context."
+        },
+        "delayReasonCode": {
+            "type": "string",
+            "description": "Delay reason code. The authoritative schema references the shared `delayReasonCode` from DCSA_DOMAIN."
+        },
+        "changeRemark": {
+            "type": "string",
+            "description": "Free-text field to provide information as to why the TransportEvent was sent."
+        },
+        "relatedDocumentReferences": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/dcsa/DcsaRelatedDocumentReference"
+            },
+            "description": "Related documents."
+        },
+        "references": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/dcsa/DcsaReference"
+            },
+            "description": "Additional references."
+        }
+    },
+    "required": [
+        "eventClassifierCode",
+        "eventDateTime",
+        "transportCall",
+        "transportEventTypeCode"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/DcsaTransportSubscriptionBody.json

@@ -0,0 +1,44 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaTransportSubscriptionBody",
+    "description": "Transport subscription filters.\n\nSource: `transportSubscriptionBody` schema in the DCSA Event Domain (v3.1.0).",
+    "type": "object",
+    "properties": {
+        "transportCallReference": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific transport call."
+        },
+        "vesselIMONumber": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific vessel IMO number."
+        },
+        "carrierExportVoyageNumber": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific carrier export voyage number."
+        },
+        "universalExportVoyageReference": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific universal export voyage reference."
+        },
+        "carrierServiceCode": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific carrier service code."
+        },
+        "universalServiceReference": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific universal service reference."
+        },
+        "UNLocationCode": {
+            "type": "string",
+            "description": "Filters to only receive events for a specific UN/LOCODE."
+        },
+        "transportEventTypeCodes": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/dcsa/DcsaTransportEventTypeCodes"
+            },
+            "description": "Transport event type codes to filter by."
+        }
+    },
+    "additionalProperties": false
+}

package/dist/es/schemas/DcsaTruckTransportCall.json

@@ -0,0 +1,41 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaTruckTransportCall",
+    "description": "Truck transport call details.\n\nSource: `truckTransportCall` schema in the DCSA Event Domain (v3.1.0).",
+    "type": "object",
+    "properties": {
+        "transportCallReference": {
+            "type": "string",
+            "description": "Unique reference for the transport call."
+        },
+        "transportCallSequenceNumber": {
+            "type": "number",
+            "description": "Sequence number of the transport call."
+        },
+        "location": {
+            "description": "Location of the transport call.\n\nKept as unknown since the authoritative schema references LOCATION_DOMAIN types."
+        },
+        "facilityTypeCode": {
+            "$ref": "https://schema.twindev.org/dcsa/DcsaTransportCallFacilityTypeCodes",
+            "description": "Facility type code."
+        },
+        "modeOfTransport": {
+            "type": "string",
+            "const": "TRUCK",
+            "description": "Discriminator for the transport mode."
+        },
+        "licencePlate": {
+            "type": "string",
+            "description": "Truck license plate."
+        },
+        "chassisLicencePlate": {
+            "type": "string",
+            "description": "Chassis license plate."
+        }
+    },
+    "required": [
+        "modeOfTransport",
+        "transportCallReference"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/DcsaVessel.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaVessel",
+    "description": "Vessel.\n\nSource: `vessel` schema in the DCSA Event Domain (v3.1.0).\n\nNote: Most properties are defined in DCSA_DOMAIN; this package models them as strings.",
+    "type": "object",
+    "properties": {
+        "vesselIMONumber": {
+            "type": "string",
+            "description": "Vessel IMO number."
+        },
+        "name": {
+            "type": "string",
+            "description": "Vessel name."
+        },
+        "flag": {
+            "type": "string",
+            "description": "Vessel flag."
+        },
+        "callSign": {
+            "type": "string",
+            "description": "Vessel call sign."
+        },
+        "operatorCarrierCode": {
+            "type": "string",
+            "description": "Carrier code of the vessel operator."
+        },
+        "operatorCarrierCodeListProvider": {
+            "type": "string",
+            "description": "Provider of the operator carrier code list."
+        }
+    },
+    "required": [
+        "vesselIMONumber"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/DcsaVesselTransportCall.json

@@ -0,0 +1,65 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dcsa/DcsaVesselTransportCall",
+    "description": "Vessel transport call details.\n\nSource: `vesselTransportCall` schema in the DCSA Event Domain (v3.1.0).",
+    "type": "object",
+    "properties": {
+        "transportCallReference": {
+            "type": "string",
+            "description": "Unique reference for the transport call."
+        },
+        "transportCallSequenceNumber": {
+            "type": "number",
+            "description": "Sequence number of the transport call."
+        },
+        "location": {
+            "description": "Location of the transport call.\n\nKept as unknown since the authoritative schema references LOCATION_DOMAIN types."
+        },
+        "facilityTypeCode": {
+            "$ref": "https://schema.twindev.org/dcsa/DcsaTransportCallFacilityTypeCodes",
+            "description": "Facility type code."
+        },
+        "modeOfTransport": {
+            "type": "string",
+            "const": "VESSEL",
+            "description": "Discriminator for the transport mode."
+        },
+        "portVisitReference": {
+            "type": "string",
+            "description": "Port visit reference."
+        },
+        "carrierServiceCode": {
+            "type": "string",
+            "description": "Carrier service code."
+        },
+        "universalServiceReference": {
+            "type": "string",
+            "description": "Universal service reference."
+        },
+        "carrierExportVoyageNumber": {
+            "type": "string",
+            "description": "Carrier export voyage number."
+        },
+        "universalExportVoyageReference": {
+            "type": "string",
+            "description": "Universal export voyage reference."
+        },
+        "carrierImportVoyageNumber": {
+            "type": "string",
+            "description": "Carrier import voyage number."
+        },
+        "universalImportVoyageReference": {
+            "type": "string",
+            "description": "Universal import voyage reference."
+        },
+        "vessel": {
+            "$ref": "https://schema.twindev.org/dcsa/DcsaVessel",
+            "description": "Vessel."
+        }
+    },
+    "required": [
+        "modeOfTransport",
+        "transportCallReference"
+    ],
+    "additionalProperties": false
+}

package/dist/types/dataTypes/dcsaDataTypes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Data Type registration for DCSA
+ */
+export declare abstract class DcsaDataTypes {
+    /**
+     * Register redirects for DCSA namespace to enable offline JSON-LD processing.
+     */
+    static registerRedirects(): void;
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,65 @@
+export * from "./dataTypes/dcsaDataTypes.js";
+export * from "./models/dcsaContexts.js";
+export * from "./models/dcsaDocumentTypeCodes.js";
+export * from "./models/dcsaEquipmentEventTypeCodes.js";
+export * from "./models/dcsaEventClassifierCode.js";
+export * from "./models/dcsaEventTypes.js";
+export * from "./models/dcsaIotEventCode.js";
+export * from "./models/dcsaIotEventTypeCodes.js";
+export * from "./models/dcsaModeOfTransport.js";
+export * from "./models/dcsaOperationsEventTypeCodes.js";
+export * from "./models/dcsaPortCallPhaseTypeCodes.js";
+export * from "./models/dcsaPortCallServiceTypeCodes.js";
+export * from "./models/dcsaPublisherRole.js";
+export * from "./models/dcsaReeferEventTypeCodes.js";
+export * from "./models/dcsaShipmentEventTypeCodes.js";
+export * from "./models/dcsaTntPublisherRole.js";
+export * from "./models/dcsaTransportCallFacilityTypeCodes.js";
+export * from "./models/dcsaTransportEventTypeCodes.js";
+export * from "./models/dcsaTypes.js";
+export * from "./models/IDcsaBarge.js";
+export * from "./models/IDcsaBargeTransportCall.js";
+export * from "./models/IDcsaBaseEquipmentEvent.js";
+export * from "./models/IDcsaBaseEvent.js";
+export * from "./models/IDcsaBaseIoTEvent.js";
+export * from "./models/IDcsaBaseReeferEvent.js";
+export * from "./models/IDcsaBaseShipmentEvent.js";
+export * from "./models/IDcsaBaseTransportEvent.js";
+export * from "./models/IDcsaEquipmentEvent.js";
+export * from "./models/IDcsaEquipmentPayload.js";
+export * from "./models/IDcsaEquipmentSubscriptionBody.js";
+export * from "./models/IDcsaEvent.js";
+export * from "./models/IDcsaEventMetadataActive.js";
+export * from "./models/IDcsaEventMetadataBase.js";
+export * from "./models/IDcsaEventMetadataRetraction.js";
+export * from "./models/IDcsaEventPayload.js";
+export * from "./models/IDcsaEventRetraction.js";
+export * from "./models/IDcsaEventWithPayload.js";
+export * from "./models/IDcsaIotEvent.js";
+export * from "./models/IDcsaIotEventMetadataActive.js";
+export * from "./models/IDcsaIotEventMetadataRetraction.js";
+export * from "./models/IDcsaIotPayload.js";
+export * from "./models/IDcsaIotSubscriptionBody.js";
+export * from "./models/IDcsaPublisher.js";
+export * from "./models/IDcsaRailTransportCall.js";
+export * from "./models/IDcsaReeferEvent.js";
+export * from "./models/IDcsaReeferEventMetadataActive.js";
+export * from "./models/IDcsaReeferEventMetadataRetraction.js";
+export * from "./models/IDcsaReeferMeasurements.js";
+export * from "./models/IDcsaReeferPayload.js";
+export * from "./models/IDcsaReeferSetpoint.js";
+export * from "./models/IDcsaReeferSubscriptionBody.js";
+export * from "./models/IDcsaReference.js";
+export * from "./models/IDcsaRelatedDocumentReference.js";
+export * from "./models/IDcsaShipmentEvent.js";
+export * from "./models/IDcsaShipmentPayload.js";
+export * from "./models/IDcsaShipmentSubscriptionBody.js";
+export * from "./models/IDcsaTransportCallBase.js";
+export * from "./models/IDcsaTransportCall.js";
+export * from "./models/IDcsaTransportCallSubscriptionBody.js";
+export * from "./models/IDcsaTransportEvent.js";
+export * from "./models/IDcsaTransportPayload.js";
+export * from "./models/IDcsaTransportSubscriptionBody.js";
+export * from "./models/IDcsaTruckTransportCall.js";
+export * from "./models/IDcsaVessel.js";
+export * from "./models/IDcsaVesselTransportCall.js";

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

@@ -0,0 +1,34 @@
+/**
+ * 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
+ */
+export interface IDcsaBarge {
+    /**
+     * Barge name.
+     */
+    name: string;
+    /**
+     * Barge IMO number (when available).
+     */
+    vesselIMONumber?: string;
+    /**
+     * Barge flag.
+     */
+    flag?: string;
+    /**
+     * Barge call sign.
+     */
+    callSign?: string;
+    /**
+     * Carrier code of the barge operator.
+     */
+    operatorCarrierCode?: string;
+    /**
+     * Provider of the operator carrier code list.
+     */
+    operatorCarrierCodeListProvider?: string;
+}

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

@@ -0,0 +1,47 @@
+import type { DcsaModeOfTransport } from "./dcsaModeOfTransport.js";
+import type { IDcsaBarge } from "./IDcsaBarge.js";
+import type { IDcsaTransportCallBase } from "./IDcsaTransportCallBase.js";
+/**
+ * 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
+ */
+export interface IDcsaBargeTransportCall extends IDcsaTransportCallBase {
+    /**
+     * Discriminator for the transport mode.
+     */
+    modeOfTransport: typeof DcsaModeOfTransport.BARGE;
+    /**
+     * Barge.
+     */
+    barge?: IDcsaBarge;
+    /**
+     * Port visit reference.
+     */
+    portVisitReference?: string;
+    /**
+     * Carrier service code.
+     */
+    carrierServiceCode?: string;
+    /**
+     * Universal service reference.
+     */
+    universalServiceReference?: string;
+    /**
+     * Carrier export voyage number.
+     */
+    carrierExportVoyageNumber?: string;
+    /**
+     * Universal export voyage reference.
+     */
+    universalExportVoyageReference?: string;
+    /**
+     * Carrier import voyage number.
+     */
+    carrierImportVoyageNumber?: string;
+    /**
+     * Universal import voyage reference.
+     */
+    universalImportVoyageReference?: string;
+}

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

@@ -0,0 +1,12 @@
+import type { IDcsaEquipmentPayload } from "./IDcsaEquipmentPayload.js";
+/**
+ * Base equipment event attributes.
+ *
+ * Note: In the upstream OpenAPI, `equipmentPayload` is defined as `baseEvent` +
+ * `baseEquipmentEvent`. In this package, those are already represented by
+ * `IDcsaEquipmentPayload` extending `IDcsaBaseEvent`.
+ *
+ * Source: `baseEquipmentEvent` 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
+ */
+export type IDcsaBaseEquipmentEvent = IDcsaEquipmentPayload;

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

@@ -0,0 +1,21 @@
+import type { DcsaEventClassifierCode } from "./dcsaEventClassifierCode.js";
+/**
+ * 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
+ */
+export interface IDcsaBaseEvent {
+    /**
+     * 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).
+     */
+    eventClassifierCode: DcsaEventClassifierCode;
+    /**
+     * The local date and time when the event took place (or will take place).
+     * Format: ISO 8601 date-time.
+     */
+    eventDateTime: string;
+}

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

@@ -0,0 +1,42 @@
+import type { DcsaEventClassifierCodes } from "./dcsaEventClassifierCode.js";
+import type { DcsaIotEventCode } from "./dcsaIotEventCode.js";
+import type { DcsaIotEventTypeCodes } from "./dcsaIotEventTypeCodes.js";
+import type { IDcsaRelatedDocumentReference } from "./IDcsaRelatedDocumentReference.js";
+/**
+ * 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
+ */
+export interface IDcsaBaseIoTEvent {
+    /**
+     * Local date-time when the event happened.
+     */
+    eventDateTime: string;
+    /**
+     * IoT events are always "ACT".
+     */
+    eventClassifierCode: typeof DcsaEventClassifierCodes.ACT;
+    /**
+     * IoT event type code.
+     */
+    iotEventTypeCode: DcsaIotEventTypeCodes;
+    /**
+     * IoT event code.
+     */
+    iotEventCode: DcsaIotEventCode;
+    /**
+     * Geo location.
+     *
+     * Kept as unknown since the authoritative schema references LOCATION_DOMAIN types.
+     */
+    geoLocation?: unknown;
+    /**
+     * Equipment reference.
+     */
+    equipmentReference: string;
+    /**
+     * Related document references.
+     */
+    relatedDocumentReferences?: IDcsaRelatedDocumentReference[];
+}