@twin.org/standards-gs1 0.0.3-next.9 → 0.9.0

package/dist/types/models/epcis20/IEpcisIlmd.d.ts

@@ -0,0 +1,7 @@
+/**
+ * EPCIS 2.0 Instance/Lot Master Data (ILMD) container for event-level master
+ * data extensions.
+ * @see https://ref.gs1.org/epcis/ILMD
+ */
+export interface IEpcisIlmd {
+}

package/dist/types/models/epcis20/IEpcisLocation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * EPCIS 2.0 Location reference (readPoint/bizLocation) that wraps a location
+ * identifier.
+ * @see https://ref.gs1.org/epcis/ReadPoint
+ */
+export interface IEpcisLocation {
+    /**
+     * The location identifier (URI/IRI per EPCIS schema and SHACL).
+     */
+    id: string;
+}

package/dist/types/models/epcis20/IEpcisObjectEvent.d.ts

@@ -1,25 +1,85 @@
-import type { IEpcisEventDetails } from "./IEpcisEventDetails.js";
-import type { IQuantity } from "./IEpcisQuantity.js";
-import type { ISensorElement } from "./IEpcisSensorElement.js";
+import type { EpcisActionTypes } from "./epcisActionTypes.js";
+import type { EpcisBizStepTypes } from "./epcisBizStepTypes.js";
+import type { EpcisDispositionTypes } from "./epcisDispositionTypes.js";
+import type { EpcisTypes } from "./epcisTypes.js";
+import type { IEpcisBizTransaction } from "./IEpcisBizTransaction.js";
+import type { IEpcisDestination } from "./IEpcisDestination.js";
+import type { IEpcisEvent } from "./IEpcisEvent.js";
+import type { IEpcisIlmd } from "./IEpcisIlmd.js";
+import type { IEpcisLocation } from "./IEpcisLocation.js";
+import type { IEpcisPersistentDisposition } from "./IEpcisPersistentDisposition.js";
+import type { IEpcisQuantity } from "./IEpcisQuantity.js";
+import type { IEpcisSensorElement } from "./IEpcisSensorElement.js";
+import type { IEpcisSource } from "./IEpcisSource.js";
 /**
- * Defines an EPCIS 2.0 Object Event.
+ * EPCIS 2.0 ObjectEvent describing one or more objects (instance- or class-level)
+ * observed at a point in the business process.
  *
+ * @see https://ref.gs1.org/epcis/ObjectEvent
  */
-export interface IObjectEvent extends IEpcisEventDetails {
+export interface IEpcisObjectEvent extends IEpcisEvent {
     /**
      * Fixed to ObjectEvent.
      */
-    type: "ObjectEvent";
+    type: typeof EpcisTypes.ObjectEvent;
     /**
-     * List of EPCs involved.
+     * (Optional) Unordered list of one or more EPCs naming specific objects to which
+     * the event pertained.
      */
-    epcList: string[];
+    epcList?: string[];
     /**
-     * Quantity in case of class-level event visibility data.
+     * Unordered list of one or more QuantityElements identifying contained objects at
+     * the class level.
      */
-    quantityList?: IQuantity[];
+    quantityList?: IEpcisQuantity[];
     /**
-     * Sensor element list.
+     * How this event relates to the lifecycle of the EPCs named in this event.
      */
-    sensorElementList?: ISensorElement[];
+    action: EpcisActionTypes;
+    /**
+     * (Optional) The business step of which this event was a part.
+     */
+    bizStep?: EpcisBizStepTypes | string;
+    /**
+     * (Optional) The business condition of the objects associated with the EPCs,
+     * presumed to hold true until contradicted by a subsequent event.
+     */
+    disposition?: EpcisDispositionTypes | string;
+    /**
+     * Persistent disposition.
+     */
+    persistentDisposition?: IEpcisPersistentDisposition;
+    /**
+     * (Optional) The read point at which the event took place.
+     */
+    readPoint?: IEpcisLocation;
+    /**
+     * (Optional) The business location where the objects associated with the EPCs may
+     * be found, until contradicted by a subsequent event.
+     */
+    bizLocation?: IEpcisLocation;
+    /**
+     * (Optional) Unordered list of business transactions that define the context of
+     * this event.
+     */
+    bizTransactionList?: IEpcisBizTransaction[];
+    /**
+     * (Optional) Unordered list of Source elements that provide context about the
+     * originating endpoint of a business transfer of which this event is a part.
+     */
+    sourceList?: IEpcisSource[];
+    /**
+     * (Optional) Unordered list of Destination elements that provide context about the
+     * terminating endpoint of a business transfer of which this event is a part.
+     */
+    destinationList?: IEpcisDestination[];
+    /**
+     * (Optional) Connects event to one or more SensorElements.
+     */
+    sensorElementList?: IEpcisSensorElement[];
+    /**
+     * (Optional) Instance/Lot master data that describes the objects created during
+     * this event.
+     */
+    ilmd?: IEpcisIlmd;
 }

package/dist/types/models/epcis20/IEpcisPersistentDisposition.d.ts

@@ -0,0 +1,16 @@
+import type { EpcisDispositionTypes } from "./epcisDispositionTypes.js";
+/**
+ * EPCIS 2.0 PersistentDisposition indicating business conditions to set or unset
+ * independently of event disposition.
+ * @see https://ref.gs1.org/epcis/PersistentDisposition
+ */
+export interface IEpcisPersistentDisposition {
+    /**
+     * (Optional) List of persistentDisposition URI values to be set.
+     */
+    set?: (EpcisDispositionTypes | string)[];
+    /**
+     * (Optional) List of persistentDisposition URI values to be unset (revoked).
+     */
+    unset?: (EpcisDispositionTypes | string)[];
+}

package/dist/types/models/epcis20/IEpcisQuantity.d.ts

@@ -1,13 +1,21 @@
 /**
- * EPCIS Quantity.
+ * EPCIS 2.0 QuantityElement defining class-level identifiers and amounts.
+ * @see https://ref.gs1.org/epcis/QuantityElement
  */
-export interface IQuantity {
+export interface IEpcisQuantity {
     /**
-     * EPC Class.
+     * A class-level identifier for the class to which the specified quantity of
+     * objects belongs.
      */
     epcClass: string;
     /**
-     * Quantity.
+     * (Optional) A number that specifies how many or how much of the specified
+     * EPCClass is denoted by this QuantityElement.
      */
-    quantity: number;
+    quantity?: number;
+    /**
+     * (Optional) Unit of measure by which the specified value(s) of the property
+     * specified by type should be interpreted.
+     */
+    uom?: string;
 }

package/dist/types/models/epcis20/IEpcisQuery.d.ts

@@ -1,5 +1,6 @@
 /**
- * EPCIS Query type.
+ * EPCIS 2.0 Query key/value parameter map used in query documents.
+ * @see https://ref.gs1.org/epcis/Query
  */
 export interface IEpcisQuery {
     [key: string]: string;

package/dist/types/models/epcis20/IEpcisQueryDocument.d.ts

@@ -1,13 +1,15 @@
-import type { IJsonLdContextDefinition } from "@twin.org/data-json-ld";
-import type { IEpcisEvent } from "./IEpcisEvent.js";
+import type { EpcisContextType } from "./epcisContextType.js";
+import type { EpcisTypes } from "./epcisTypes.js";
+import type { IEpcisQueryDocumentBody } from "./IEpcisQueryDocumentBody.js";
 /**
- * EPCIS Query Document.
+ * EPCIS 2.0 QueryDocument used to submit queries to an EPCIS repository.
+ * @see https://ref.gs1.org/epcis/EPCISQueryDocument
  */
 export interface IEpcisQueryDocument {
     /**
      * The @context.
      */
-    "@context": IJsonLdContextDefinition;
+    "@context": EpcisContextType;
     /**
      * The JSON-LD document id.
      */
@@ -15,7 +17,7 @@ export interface IEpcisQueryDocument {
     /**
      * JSON-LD Type.
      */
-    type: string;
+    type: typeof EpcisTypes.EPCISQueryDocument;
     /**
      * Schema version.
      */
@@ -27,28 +29,5 @@ export interface IEpcisQueryDocument {
     /**
      * The EPCIS Body.
      */
-    epcisBody: {
-        /**
-         * The results of the query.
-         */
-        queryResults: {
-            /**
-             * The concerned subscription.
-             */
-            subscriptionID?: string;
-            /**
-             * The concerned query.
-             */
-            queryName: string;
-            /**
-             * And now the results.
-             */
-            resultsBody: {
-                /**
-                 * The list of events.
-                 */
-                eventList: IEpcisEvent[];
-            };
-        };
-    };
+    epcisBody: IEpcisQueryDocumentBody;
 }

package/dist/types/models/epcis20/IEpcisQueryDocumentBody.d.ts

@@ -0,0 +1,11 @@
+import type { IEpcisQueryResults } from "./IEpcisQueryResults.js";
+/**
+ * EPCIS 2.0 QueryDocumentBody wrapper that carries query results.
+ * @see https://ref.gs1.org/epcis/QueryDocumentBody
+ */
+export interface IEpcisQueryDocumentBody {
+    /**
+     * The results of the query.
+     */
+    queryResults: IEpcisQueryResults;
+}

package/dist/types/models/epcis20/IEpcisQueryResults.d.ts

@@ -0,0 +1,19 @@
+import type { IEpcisQueryResultsBody } from "./IEpcisQueryResultsBody.js";
+/**
+ * EPCIS 2.0 QueryResults payload returned from a repository query.
+ * @see https://ref.gs1.org/epcis/QueryResults
+ */
+export interface IEpcisQueryResults {
+    /**
+     * The concerned subscription.
+     */
+    subscriptionID?: string;
+    /**
+     * The concerned query.
+     */
+    queryName: string;
+    /**
+     * The query results payload.
+     */
+    resultsBody: IEpcisQueryResultsBody;
+}

package/dist/types/models/epcis20/IEpcisQueryResultsBody.d.ts

@@ -0,0 +1,16 @@
+import type { EpcisEvents } from "./epcisEvents.js";
+import type { IEpcisVocabulary } from "./IEpcisVocabulary.js";
+/**
+ * EPCIS 2.0 QueryResultsBody containing events and optional master data.
+ * @see https://ref.gs1.org/epcis/QueryResultsBody
+ */
+export interface IEpcisQueryResultsBody {
+    /**
+     * The list of events.
+     */
+    eventList: EpcisEvents[];
+    /**
+     * Optional master data.
+     */
+    vocabularyList?: IEpcisVocabulary[];
+}

package/dist/types/models/epcis20/IEpcisSensorElement.d.ts

@@ -1,15 +1,19 @@
-import type { ISensorMetadata } from "./IEpcisSensorMetadata.js";
-import type { ISensorReport } from "./IEpcisSensorReport.js";
+import type { IEpcisSensorMetadata } from "./IEpcisSensorMetadata.js";
+import type { IEpcisSensorReport } from "./IEpcisSensorReport.js";
 /**
- * EPCIS SensorElement.
+ * EPCIS 2.0 SensorElement grouping metadata and one or more SensorReport
+ * entries.
+ * @see https://ref.gs1.org/epcis/SensorElement
  */
-export interface ISensorElement {
+export interface IEpcisSensorElement {
     /**
-     * Sensor metadata.
+     * (Optional) Element containing metadata attributes applicable to all
+     * sensorReport entries within this sensorElement.
      */
-    sensorMetadata?: ISensorMetadata;
+    sensorMetadata?: IEpcisSensorMetadata;
     /**
-     * Sensor report.
+     * An element containing one or several attributes that pertain to a specific
+     * sensor observation.
      */
-    sensorReport: ISensorReport[];
+    sensorReport: IEpcisSensorReport[];
 }

package/dist/types/models/epcis20/IEpcisSensorMetadata.d.ts

@@ -1,21 +1,47 @@
 /**
- * EPCIS Sensor metadata.
+ * EPCIS 2.0 SensorMetadata describing timing, device, and processing details for
+ * sensor observations.
+ * @see https://ref.gs1.org/epcis/SensorMetadata
  */
-export interface ISensorMetadata {
+export interface IEpcisSensorMetadata {
     /**
-     * Time.
+     * (Optional) The actual point in time of an observation as transmitted by a
+     * sensor device.
      */
-    time: string;
+    time?: string;
     /**
-     * Device ID.
+     * (Optional) Device from which the sensor data originates.
      */
-    deviceID: string;
+    deviceID?: string;
     /**
-     * Device Metadata.
+     * (Optional) Storage location of an electronic document accommodating metadata
+     * of the device from which the sensor data originates.
      */
-    deviceMetadata: string;
+    deviceMetadata?: string;
     /**
-     * Raw data.
+     * (Optional) Storage/service location of the raw sensor data on which the
+     * aggregated/business-oriented data contained in the sensorElement is based.
      */
-    rawData: string;
+    rawData?: string;
+    /**
+     * (Optional) The lowest (earliest) value of a given observation period as
+     * transmitted by a sensor device.
+     */
+    startTime?: string;
+    /**
+     * (Optional) The highest (most recent) value of a given observation period, as
+     * transmitted by a sensor device.
+     */
+    endTime?: string;
+    /**
+     * (Optional) Storage location of an electronic document accommodating the data
+     * processing method of the contained sensor data, if applicable.
+     */
+    dataProcessingMethod?: string;
+    /**
+     * (Optional) Storage location of an electronic document accommodating product- or
+     * application-specific business rules on which basis the EPCIS event was
+     * triggered.
+     */
+    bizRules?: string;
 }

package/dist/types/models/epcis20/IEpcisSensorReport.d.ts

@@ -1,17 +1,130 @@
+import type { EpcisComponentTypes } from "./epcisComponentTypes.js";
+import type { EpcisMeasurementTypes } from "./epcisMeasurementTypes.js";
+import type { EpcisSensorAlertTypes } from "./epcisSensorAlertTypes.js";
 /**
- * EPCIS SensorReport.
+ * EPCIS 2.0 SensorReport containing measurement values and related sensor
+ * observation details.
+ * @see https://ref.gs1.org/epcis/SensorReport
  */
-export interface ISensorReport {
+export interface IEpcisSensorReport {
     /**
-     * Type.
+     * Identifier indicating what kind of measurement the SensorReport pertains to
+     * (e.g. Length, Mass, Temperature).
+     *
+     * Use {@link EpcisMeasurementTypes} for known values.
      */
-    type: string;
+    type: EpcisMeasurementTypes | string;
     /**
-     * Value.
+     * A sensor alert value (alarm condition or error condition); extra details may
+     * be provided via booleanValue or uriValue.
+     *
+     * Use {@link EpcisSensorAlertTypes} for known values.
      */
-    value: number;
+    exception?: EpcisSensorAlertTypes | string;
     /**
-     * Unit of measurement.
+     * (Optional) Device from which the sensor data originates.
      */
-    uom: string;
+    deviceID?: string;
+    /**
+     * (Optional) Storage location of an electronic document accommodating metadata
+     * of the device from which the sensor data originates.
+     */
+    deviceMetadata?: string;
+    /**
+     * (Optional) Storage/service location of the raw sensor data on which the
+     * aggregated/business-oriented data contained in the sensorElement is based.
+     */
+    rawData?: string;
+    /**
+     * (Optional) Storage location of an electronic document accommodating the data
+     * processing method of the contained sensor data, if applicable.
+     */
+    dataProcessingMethod?: string;
+    /**
+     * (Optional) Storage location of an electronic document accommodating product- or
+     * application-specific business rules on which basis the EPCIS event was
+     * triggered.
+     */
+    bizRules?: string;
+    /**
+     * (Optional) The actual point in time of an observation as transmitted by a
+     * sensor device.
+     */
+    time?: string;
+    /**
+     * (Optional) Identifies a specific microorganism species; SHALL NOT be present
+     * if chemicalSubstance is included.
+     */
+    microorganism?: string;
+    /**
+     * (Optional) Identifies a specific chemical substance; SHALL NOT be present
+     * together with microorganism.
+     */
+    chemicalSubstance?: string;
+    /**
+     * (Optional) A URI identifying the Coordinate Reference System; if omitted,
+     * WGS-84 is assumed.
+     */
+    coordinateReferenceSystem?: string;
+    /**
+     * (Optional) Value of the property specified by the type; if a time field is
+     * present, it pertains to that time, otherwise to the eventTime.
+     */
+    value?: number;
+    /**
+     * (Optional) Vector component identifier for measurements with magnitude and
+     * direction (e.g. force, pressure); repeat SensorReport per component.
+     */
+    component?: EpcisComponentTypes | string;
+    /**
+     * (Optional) The String value of the property specified by the type as part of
+     * the sensorReport element.
+     */
+    stringValue?: string;
+    /**
+     * (Optional) Similar to stringValue, for Boolean value.
+     */
+    booleanValue?: boolean;
+    /**
+     * (Optional) Similar to stringValue, for HexBinary value.
+     */
+    hexBinaryValue?: string;
+    /**
+     * (Optional) Similar to stringValue, for a URI value.
+     */
+    uriValue?: string;
+    /**
+     * (Optional) Minimum quantitative value of the property specified by type, as
+     * part of the sensorReport element.
+     */
+    minValue?: number;
+    /**
+     * (Optional) Similar to minValue, for the maximum quantitative value.
+     */
+    maxValue?: number;
+    /**
+     * (Optional) The arithmetic mean of the values of the property specified by the
+     * type as part of the sensorReport element.
+     */
+    meanValue?: number;
+    /**
+     * (Optional) Standard deviation of the values of the property specified by type,
+     * as part of the sensorReport element.
+     */
+    sDev?: number;
+    /**
+     * (Optional) Percentile rank, signifying the percentage of observations in a
+     * frequency distribution that are equal to or lower than it.
+     */
+    percRank?: number;
+    /**
+     * (Optional) The percentile value, at or below which a given percentage of
+     * observations may be found.
+     */
+    percValue?: number;
+    /**
+     * (Optional) Unit of measure by which the specified value(s) of the property
+     * specified by type should be interpreted.
+     */
+    uom?: string;
 }

package/dist/types/models/epcis20/IEpcisSource.d.ts

@@ -1,13 +1,19 @@
+import type { EpcisSourceDestTypes } from "./epcisSourceDestTypes.js";
 /**
- * EPCIS Biz Transaction.
+ * EPCIS 2.0 Source element identifying the origin of a business transfer.
+ * @see https://ref.gs1.org/epcis/SourceOrDestination
  */
-export interface ISource {
+export interface IEpcisSource {
     /**
-     * Type.
+     * Identifier indicating the role of SourceOrDestination in a transfer (Owning
+     * Party, Possessing Party, or Location).
+     *
+     * Use {@link EpcisSourceDestTypes} for known values.
      */
-    type: string;
+    type: EpcisSourceDestTypes | string;
     /**
-     * The source.
+     * Identifier that denotes the specific source or destination of a business
+     * transfer; must correlate with the selected type.
      */
     source: string;
 }

package/dist/types/models/epcis20/IEpcisTransactionEvent.d.ts

@@ -0,0 +1,78 @@
+import type { EpcisActionTypes } from "./epcisActionTypes.js";
+import type { EpcisBizStepTypes } from "./epcisBizStepTypes.js";
+import type { EpcisDispositionTypes } from "./epcisDispositionTypes.js";
+import type { EpcisTypes } from "./epcisTypes.js";
+import type { IEpcisBizTransaction } from "./IEpcisBizTransaction.js";
+import type { IEpcisDestination } from "./IEpcisDestination.js";
+import type { IEpcisEvent } from "./IEpcisEvent.js";
+import type { IEpcisLocation } from "./IEpcisLocation.js";
+import type { IEpcisQuantity } from "./IEpcisQuantity.js";
+import type { IEpcisSensorElement } from "./IEpcisSensorElement.js";
+import type { IEpcisSource } from "./IEpcisSource.js";
+/**
+ * EPCIS 2.0 TransactionEvent relating objects or quantities to one or more
+ * business transactions, optionally with a parent identifier.
+ * @see https://ref.gs1.org/epcis/TransactionEvent
+ */
+export interface IEpcisTransactionEvent extends IEpcisEvent {
+    /**
+     * Fixed to TransactionEvent.
+     */
+    type: typeof EpcisTypes.TransactionEvent;
+    /**
+     * Business transaction list (required by schema).
+     */
+    bizTransactionList: IEpcisBizTransaction[];
+    /**
+     * (Optional when action is OBSERVE, required otherwise) Identifier of the parent
+     * of the aggregation or association; use the pure identity URI when the parent is
+     * an EPC.
+     */
+    parentID?: string;
+    /**
+     * (Optional) An unordered list of one or more EPCs naming specific objects to
+     * which the event pertained.
+     */
+    epcList?: string[];
+    /**
+     * An unordered list of one or more QuantityElements identifying (at the class
+     * level) contained objects.
+     */
+    quantityList?: IEpcisQuantity[];
+    /**
+     * How this event relates to the lifecycle of the EPCs named in this event.
+     */
+    action: EpcisActionTypes;
+    /**
+     * (Optional) The business step of which this event was a part.
+     */
+    bizStep?: EpcisBizStepTypes | string;
+    /**
+     * (Optional) The business condition of the objects associated with the EPCs,
+     * presumed to hold true until contradicted by a subsequent event.
+     */
+    disposition?: EpcisDispositionTypes | string;
+    /**
+     * (Optional) The read point at which the event took place.
+     */
+    readPoint?: IEpcisLocation;
+    /**
+     * (Optional) The business location where the objects associated with the EPCs
+     * may be found, until contradicted by a subsequent event.
+     */
+    bizLocation?: IEpcisLocation;
+    /**
+     * (Optional) Unordered list of Source elements that provide context about the
+     * originating endpoint of a business transfer of which this event is a part.
+     */
+    sourceList?: IEpcisSource[];
+    /**
+     * (Optional) Unordered list of Destination elements that provide context about the
+     * terminating endpoint of a business transfer of which this event is a part.
+     */
+    destinationList?: IEpcisDestination[];
+    /**
+     * (Optional) Connects event to one or more SensorElements.
+     */
+    sensorElementList?: IEpcisSensorElement[];
+}