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

package/docs/reference/interfaces/IEpcisSensorElement.md

@@ -0,0 +1,34 @@
+# Interface: IEpcisSensorElement
+
+EPCIS 2.0 SensorElement grouping metadata and one or more SensorReport
+entries.
+
+## See
+
+https://ref.gs1.org/epcis/SensorElement
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### sensorMetadata?
+
+> `optional` **sensorMetadata**: [`IEpcisSensorMetadata`](IEpcisSensorMetadata.md)
+
+(Optional) Element containing metadata attributes applicable to all
+sensorReport entries within this sensorElement.
+
+***
+
+### sensorReport
+
+> **sensorReport**: [`IEpcisSensorReport`](IEpcisSensorReport.md)[]
+
+An element containing one or several attributes that pertain to a specific
+sensor observation.

package/docs/reference/interfaces/IEpcisSensorMetadata.md

@@ -0,0 +1,88 @@
+# Interface: IEpcisSensorMetadata
+
+EPCIS 2.0 SensorMetadata describing timing, device, and processing details for
+sensor observations.
+
+## See
+
+https://ref.gs1.org/epcis/SensorMetadata
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### time?
+
+> `optional` **time**: `string`
+
+(Optional) The actual point in time of an observation as transmitted by a
+sensor device.
+
+***
+
+### deviceID?
+
+> `optional` **deviceID**: `string`
+
+(Optional) Device from which the sensor data originates.
+
+***
+
+### deviceMetadata?
+
+> `optional` **deviceMetadata**: `string`
+
+(Optional) Storage location of an electronic document accommodating metadata
+of the device from which the sensor data originates.
+
+***
+
+### rawData?
+
+> `optional` **rawData**: `string`
+
+(Optional) Storage/service location of the raw sensor data on which the
+aggregated/business-oriented data contained in the sensorElement is based.
+
+***
+
+### startTime?
+
+> `optional` **startTime**: `string`
+
+(Optional) The lowest (earliest) value of a given observation period as
+transmitted by a sensor device.
+
+***
+
+### endTime?
+
+> `optional` **endTime**: `string`
+
+(Optional) The highest (most recent) value of a given observation period, as
+transmitted by a sensor device.
+
+***
+
+### dataProcessingMethod?
+
+> `optional` **dataProcessingMethod**: `string`
+
+(Optional) Storage location of an electronic document accommodating the data
+processing method of the contained sensor data, if applicable.
+
+***
+
+### bizRules?
+
+> `optional` **bizRules**: `string`
+
+(Optional) Storage location of an electronic document accommodating product- or
+application-specific business rules on which basis the EPCIS event was
+triggered.

package/docs/reference/interfaces/IEpcisSensorReport.md

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

package/docs/reference/interfaces/IEpcisSource.md

@@ -0,0 +1,35 @@
+# Interface: IEpcisSource
+
+EPCIS 2.0 Source element identifying the origin of a business transfer.
+
+## See
+
+https://ref.gs1.org/epcis/SourceOrDestination
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+Identifier indicating the role of SourceOrDestination in a transfer (Owning
+Party, Possessing Party, or Location).
+
+Use [EpcisSourceDestTypes](../variables/EpcisSourceDestTypes.md) for known values.
+
+***
+
+### source
+
+> **source**: `string`
+
+Identifier that denotes the specific source or destination of a business
+transfer; must correlate with the selected type.

package/docs/reference/interfaces/IEpcisTransactionEvent.md

@@ -0,0 +1,220 @@
+# Interface: IEpcisTransactionEvent
+
+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
+
+## Extends
+
+- [`IEpcisEvent`](IEpcisEvent.md)
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context
+
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
+
+JSON-LD @context.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
+
+***
+
+### eventID?
+
+> `optional` **eventID**: `string`
+
+URI identifier of a specific EPCIS event (alias of id in JSON or XML).
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventID`](IEpcisEvent.md#eventid)
+
+***
+
+### certificationInfo?
+
+> `optional` **certificationInfo**: `string` \| `string`[]
+
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
+
+***
+
+### errorDeclaration?
+
+> `optional` **errorDeclaration**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
+
+Error declaration.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
+
+***
+
+### eventTime
+
+> **eventTime**: `string`
+
+The date and time at which the EPCIS Capturing Applications asserts the event
+occurred.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTime`](IEpcisEvent.md#eventtime)
+
+***
+
+### eventTimeZoneOffset
+
+> **eventTimeZoneOffset**: `string`
+
+The time zone offset in effect at the time and place the event occurred,
+expressed as an offset from UTC.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTimeZoneOffset`](IEpcisEvent.md#eventtimezoneoffset)
+
+***
+
+### recordTime?
+
+> `optional` **recordTime**: `string`
+
+(Optional) The date and time at which this event was recorded by an EPCIS
+Repository; ignored at capture and present on query results.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`recordTime`](IEpcisEvent.md#recordtime)
+
+***
+
+### type
+
+> **type**: `"TransactionEvent"`
+
+Fixed to TransactionEvent.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### bizTransactionList
+
+> **bizTransactionList**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
+
+Business transaction list (required by schema).
+
+***
+
+### parentID?
+
+> `optional` **parentID**: `string`
+
+(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.
+
+***
+
+### epcList?
+
+> `optional` **epcList**: `string`[]
+
+(Optional) An unordered list of one or more EPCs naming specific objects to
+which the event pertained.
+
+***
+
+### quantityList?
+
+> `optional` **quantityList**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
+
+An unordered list of one or more QuantityElements identifying (at the class
+level) contained objects.
+
+***
+
+### action
+
+> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
+
+How this event relates to the lifecycle of the EPCs named in this event.
+
+***
+
+### bizStep?
+
+> `optional` **bizStep**: `string`
+
+(Optional) The business step of which this event was a part.
+
+***
+
+### disposition?
+
+> `optional` **disposition**: `string`
+
+(Optional) The business condition of the objects associated with the EPCs,
+presumed to hold true until contradicted by a subsequent event.
+
+***
+
+### readPoint?
+
+> `optional` **readPoint**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The read point at which the event took place.
+
+***
+
+### bizLocation?
+
+> `optional` **bizLocation**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The business location where the objects associated with the EPCs
+may be found, until contradicted by a subsequent event.
+
+***
+
+### sourceList?
+
+> `optional` **sourceList**: [`IEpcisSource`](IEpcisSource.md)[]
+
+(Optional) Unordered list of Source elements that provide context about the
+originating endpoint of a business transfer of which this event is a part.
+
+***
+
+### destinationList?
+
+> `optional` **destinationList**: [`IEpcisDestination`](IEpcisDestination.md)[]
+
+(Optional) Unordered list of Destination elements that provide context about the
+terminating endpoint of a business transfer of which this event is a part.
+
+***
+
+### sensorElementList?
+
+> `optional` **sensorElementList**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
+
+(Optional) Connects event to one or more SensorElements.