@twin.org/standards-gs1 0.0.3-next.1 → 0.0.3-next.11

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

@@ -1,13 +1,16 @@
-import type { IJsonLdContextDefinition } from "@twin.org/data-json-ld";
-import type { IEpcisEvent } from "./IEpcisEvent.js";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+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 {
+export interface IEpcisQueryDocument extends IJsonLdNodeObject {
     /**
      * The @context.
      */
-    "@context": IJsonLdContextDefinition;
+    "@context": EpcisContextType;
     /**
      * The JSON-LD document id.
      */
@@ -15,7 +18,7 @@ export interface IEpcisQueryDocument {
     /**
      * JSON-LD Type.
      */
-    type: string;
+    type: typeof EpcisTypes.EPCISQueryDocument;
     /**
      * Schema version.
      */
@@ -27,28 +30,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,12 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+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 extends IJsonLdNodeObject {
+    /**
+     * The results of the query.
+     */
+    queryResults: IEpcisQueryResults;
+}

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

@@ -0,0 +1,20 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+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 extends IJsonLdNodeObject {
+    /**
+     * 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,17 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+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 extends IJsonLdNodeObject {
+    /**
+     * The list of events.
+     */
+    eventList: EpcisEvents[];
+    /**
+     * Optional master data.
+     */
+    vocabularyList?: IEpcisVocabulary[];
+}

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

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

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

@@ -0,0 +1,48 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * EPCIS 2.0 SensorMetadata describing timing, device, and processing details for
+ * sensor observations.
+ * @see https://ref.gs1.org/epcis/SensorMetadata
+ */
+export interface IEpcisSensorMetadata extends IJsonLdNodeObject {
+    /**
+     * (Optional) The actual point in time of an observation as transmitted by a
+     * sensor device.
+     */
+    time?: string;
+    /**
+     * (Optional) Device from which the sensor data originates.
+     */
+    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) 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

@@ -0,0 +1,131 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { EpcisComponentTypes } from "./epcisComponentTypes.js";
+import type { EpcisMeasurementTypes } from "./epcisMeasurementTypes.js";
+import type { EpcisSensorAlertTypes } from "./epcisSensorAlertTypes.js";
+/**
+ * EPCIS 2.0 SensorReport containing measurement values and related sensor
+ * observation details.
+ * @see https://ref.gs1.org/epcis/SensorReport
+ */
+export interface IEpcisSensorReport extends IJsonLdNodeObject {
+    /**
+     * Identifier indicating what kind of measurement the SensorReport pertains to
+     * (e.g. Length, Mass, Temperature).
+     *
+     * Use {@link EpcisMeasurementTypes} for known values.
+     */
+    type: EpcisMeasurementTypes | string;
+    /**
+     * A sensor alert value (alarm condition or error condition); extra details may
+     * be provided via booleanValue or uriValue.
+     *
+     * Use {@link EpcisSensorAlertTypes} for known values.
+     */
+    exception?: EpcisSensorAlertTypes | string;
+    /**
+     * (Optional) Device from which the sensor data originates.
+     */
+    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

@@ -0,0 +1,20 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { EpcisSourceDestTypes } from "./epcisSourceDestTypes.js";
+/**
+ * EPCIS 2.0 Source element identifying the origin of a business transfer.
+ * @see https://ref.gs1.org/epcis/SourceOrDestination
+ */
+export interface IEpcisSource extends IJsonLdNodeObject {
+    /**
+     * Identifier indicating the role of SourceOrDestination in a transfer (Owning
+     * Party, Possessing Party, or Location).
+     *
+     * Use {@link EpcisSourceDestTypes} for known values.
+     */
+    type: EpcisSourceDestTypes | string;
+    /**
+     * 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[];
+}

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

@@ -0,0 +1,96 @@
+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";
+/**
+ * EPCIS 2.0 TransformationEvent describing how inputs are transformed into
+ * outputs during a business process.
+ * @see https://ref.gs1.org/epcis/TransformationEvent
+ */
+export interface IEpcisTransformationEvent extends IEpcisEvent {
+    /**
+     * Fixed to TransformationEvent.
+     */
+    type: typeof EpcisTypes.TransformationEvent;
+    /**
+     * (Optional) Unordered list of one or more EPCs identifying (at the instance
+     * level) objects that were inputs to the transformation.
+     */
+    inputEPCList?: string[];
+    /**
+     * (Optional) Unordered list of one or more QuantityElements identifying
+     * class-level inputs; may be omitted subject to the EPCIS quantity-list
+     * constraints.
+     */
+    inputQuantityList?: IEpcisQuantity[];
+    /**
+     * (Optional) Unordered list of one or more EPCs naming (at the instance level)
+     * objects that were outputs from the transformation.
+     */
+    outputEPCList?: string[];
+    /**
+     * (Optional) Unordered list of one or more QuantityElements identifying
+     * class-level outputs; may be omitted subject to the EPCIS quantity-list
+     * constraints.
+     */
+    outputQuantityList?: IEpcisQuantity[];
+    /**
+     * A unique identifier linking TransformationEvents; shared values connect inputs
+     * and outputs across those events.
+     */
+    transformationID?: string;
+    /**
+     * (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;
+    /**
+     * An 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/IEpcisVocabulary.d.ts

@@ -0,0 +1,16 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IEpcisVocabularyElement } from "./IEpcisVocabularyElement.js";
+/**
+ * EPCIS 2.0 Vocabulary container that groups related vocabulary elements.
+ * @see https://ref.gs1.org/epcis/Vocabulary
+ */
+export interface IEpcisVocabulary extends IJsonLdNodeObject {
+    /**
+     * Vocabulary type.
+     */
+    type: string;
+    /**
+     * List of vocabulary elements.
+     */
+    vocabularyElementList?: IEpcisVocabularyElement[];
+}

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

@@ -0,0 +1,21 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IEpcisAttribute } from "./IEpcisAttribute.js";
+/**
+ * EPCIS 2.0 VocabularyElement representing a master data entity with
+ * attributes and optional children.
+ * @see https://ref.gs1.org/epcis/VocabularyElement
+ */
+export interface IEpcisVocabularyElement extends IJsonLdNodeObject {
+    /**
+     * Element id.
+     */
+    id: string;
+    /**
+     * Attributes.
+     */
+    attributes?: IEpcisAttribute[];
+    /**
+     * Children.
+     */
+    children?: string[];
+}

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

@@ -0,0 +1,25 @@
+/**
+ * GS1 EPCIS 2.0 action values capturing whether an event adds, observes, or
+ * removes associations.
+ */
+export declare const EpcisActionTypes: {
+    /**
+     * Indicates that associations described by the event are created as of
+     * eventTime.
+     */
+    readonly Add: "ADD";
+    /**
+     * Reports an observation of existing associations without changing them.
+     */
+    readonly Observe: "OBSERVE";
+    /**
+     * Indicates that associations described by the event no longer hold as of
+     * eventTime.
+     */
+    readonly Delete: "DELETE";
+};
+/**
+ * GS1 EPCIS 2.0 action values capturing whether an event adds, observes, or
+ * removes associations.
+ */
+export type EpcisActionTypes = (typeof EpcisActionTypes)[keyof typeof EpcisActionTypes];