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

package/docs/reference/variables/EpcisMeasurementTypes.md

@@ -0,0 +1,442 @@
+# Variable: EpcisMeasurementTypes
+
+> `const` **EpcisMeasurementTypes**: `object`
+
+Supported EPCIS 2.0 `measurementType` values.
+
+These values come from the GS1 EPCIS JSON Schema enumeration.
+Use the union type `EpcisMeasurementTypes` when you want to restrict a field to known values.
+
+## Type Declaration
+
+### AbsoluteHumidity {#absolutehumidity}
+
+> `readonly` **AbsoluteHumidity**: `"AbsoluteHumidity"` = `"AbsoluteHumidity"`
+
+Measurement type "AbsoluteHumidity".
+
+### AbsorbedDose {#absorbeddose}
+
+> `readonly` **AbsorbedDose**: `"AbsorbedDose"` = `"AbsorbedDose"`
+
+Measurement type "AbsorbedDose".
+
+### AbsorbedDoseRate {#absorbeddoserate}
+
+> `readonly` **AbsorbedDoseRate**: `"AbsorbedDoseRate"` = `"AbsorbedDoseRate"`
+
+Measurement type "AbsorbedDoseRate".
+
+### Acceleration {#acceleration}
+
+> `readonly` **Acceleration**: `"Acceleration"` = `"Acceleration"`
+
+Measurement type "Acceleration".
+
+### Radioactivity {#radioactivity}
+
+> `readonly` **Radioactivity**: `"Radioactivity"` = `"Radioactivity"`
+
+Measurement type "Radioactivity".
+
+### Altitude {#altitude}
+
+> `readonly` **Altitude**: `"Altitude"` = `"Altitude"`
+
+Measurement type "Altitude".
+
+### AmountOfSubstance {#amountofsubstance}
+
+> `readonly` **AmountOfSubstance**: `"AmountOfSubstance"` = `"AmountOfSubstance"`
+
+Measurement type "AmountOfSubstance".
+
+### AmountOfSubstancePerUnitVolume {#amountofsubstanceperunitvolume}
+
+> `readonly` **AmountOfSubstancePerUnitVolume**: `"AmountOfSubstancePerUnitVolume"` = `"AmountOfSubstancePerUnitVolume"`
+
+Measurement type "AmountOfSubstancePerUnitVolume".
+
+### Angle {#angle}
+
+> `readonly` **Angle**: `"Angle"` = `"Angle"`
+
+Measurement type "Angle".
+
+### AngularAcceleration {#angularacceleration}
+
+> `readonly` **AngularAcceleration**: `"AngularAcceleration"` = `"AngularAcceleration"`
+
+Measurement type "AngularAcceleration".
+
+### AngularMomentum {#angularmomentum}
+
+> `readonly` **AngularMomentum**: `"AngularMomentum"` = `"AngularMomentum"`
+
+Measurement type "AngularMomentum".
+
+### AngularVelocity {#angularvelocity}
+
+> `readonly` **AngularVelocity**: `"AngularVelocity"` = `"AngularVelocity"`
+
+Measurement type "AngularVelocity".
+
+### Area {#area}
+
+> `readonly` **Area**: `"Area"` = `"Area"`
+
+Measurement type "Area".
+
+### Capacitance {#capacitance}
+
+> `readonly` **Capacitance**: `"Capacitance"` = `"Capacitance"`
+
+Measurement type "Capacitance".
+
+### Conductance {#conductance}
+
+> `readonly` **Conductance**: `"Conductance"` = `"Conductance"`
+
+Measurement type "Conductance".
+
+### Conductivity {#conductivity}
+
+> `readonly` **Conductivity**: `"Conductivity"` = `"Conductivity"`
+
+Measurement type "Conductivity".
+
+### Count {#count}
+
+> `readonly` **Count**: `"Count"` = `"Count"`
+
+Measurement type "Count".
+
+### Density {#density}
+
+> `readonly` **Density**: `"Density"` = `"Density"`
+
+Measurement type "Density".
+
+### Dimensionless {#dimensionless}
+
+> `readonly` **Dimensionless**: `"Dimensionless"` = `"Dimensionless"`
+
+Measurement type "Dimensionless".
+
+### DoseEquivalent {#doseequivalent}
+
+> `readonly` **DoseEquivalent**: `"DoseEquivalent"` = `"DoseEquivalent"`
+
+Measurement type "DoseEquivalent".
+
+### DoseEquivalentRate {#doseequivalentrate}
+
+> `readonly` **DoseEquivalentRate**: `"DoseEquivalentRate"` = `"DoseEquivalentRate"`
+
+Measurement type "DoseEquivalentRate".
+
+### DynamicViscosity {#dynamicviscosity}
+
+> `readonly` **DynamicViscosity**: `"DynamicViscosity"` = `"DynamicViscosity"`
+
+Measurement type "DynamicViscosity".
+
+### ElectricCharge {#electriccharge}
+
+> `readonly` **ElectricCharge**: `"ElectricCharge"` = `"ElectricCharge"`
+
+Measurement type "ElectricCharge".
+
+### ElectricCurrent {#electriccurrent}
+
+> `readonly` **ElectricCurrent**: `"ElectricCurrent"` = `"ElectricCurrent"`
+
+Measurement type "ElectricCurrent".
+
+### ElectricCurrentDensity {#electriccurrentdensity}
+
+> `readonly` **ElectricCurrentDensity**: `"ElectricCurrentDensity"` = `"ElectricCurrentDensity"`
+
+Measurement type "ElectricCurrentDensity".
+
+### ElectricFieldStrength {#electricfieldstrength}
+
+> `readonly` **ElectricFieldStrength**: `"ElectricFieldStrength"` = `"ElectricFieldStrength"`
+
+Measurement type "ElectricFieldStrength".
+
+### Energy {#energy}
+
+> `readonly` **Energy**: `"Energy"` = `"Energy"`
+
+Measurement type "Energy".
+
+### Exposure {#exposure}
+
+> `readonly` **Exposure**: `"Exposure"` = `"Exposure"`
+
+Measurement type "Exposure".
+
+### Force {#force}
+
+> `readonly` **Force**: `"Force"` = `"Force"`
+
+Measurement type "Force".
+
+### Frequency {#frequency}
+
+> `readonly` **Frequency**: `"Frequency"` = `"Frequency"`
+
+Measurement type "Frequency".
+
+### Illuminance {#illuminance}
+
+> `readonly` **Illuminance**: `"Illuminance"` = `"Illuminance"`
+
+Measurement type "Illuminance".
+
+### Inductance {#inductance}
+
+> `readonly` **Inductance**: `"Inductance"` = `"Inductance"`
+
+Measurement type "Inductance".
+
+### Irradiance {#irradiance}
+
+> `readonly` **Irradiance**: `"Irradiance"` = `"Irradiance"`
+
+Measurement type "Irradiance".
+
+### KinematicViscosity {#kinematicviscosity}
+
+> `readonly` **KinematicViscosity**: `"KinematicViscosity"` = `"KinematicViscosity"`
+
+Measurement type "KinematicViscosity".
+
+### Length {#length}
+
+> `readonly` **Length**: `"Length"` = `"Length"`
+
+Measurement type "Length".
+
+### LinearMomentum {#linearmomentum}
+
+> `readonly` **LinearMomentum**: `"LinearMomentum"` = `"LinearMomentum"`
+
+Measurement type "LinearMomentum".
+
+### Luminance {#luminance}
+
+> `readonly` **Luminance**: `"Luminance"` = `"Luminance"`
+
+Measurement type "Luminance".
+
+### LuminousFlux {#luminousflux}
+
+> `readonly` **LuminousFlux**: `"LuminousFlux"` = `"LuminousFlux"`
+
+Measurement type "LuminousFlux".
+
+### LuminousIntensity {#luminousintensity}
+
+> `readonly` **LuminousIntensity**: `"LuminousIntensity"` = `"LuminousIntensity"`
+
+Measurement type "LuminousIntensity".
+
+### MagneticFlux {#magneticflux}
+
+> `readonly` **MagneticFlux**: `"MagneticFlux"` = `"MagneticFlux"`
+
+Measurement type "MagneticFlux".
+
+### MagneticFluxDensity {#magneticfluxdensity}
+
+> `readonly` **MagneticFluxDensity**: `"MagneticFluxDensity"` = `"MagneticFluxDensity"`
+
+Measurement type "MagneticFluxDensity".
+
+### MagneticVectorPotential {#magneticvectorpotential}
+
+> `readonly` **MagneticVectorPotential**: `"MagneticVectorPotential"` = `"MagneticVectorPotential"`
+
+Measurement type "MagneticVectorPotential".
+
+### Mass {#mass}
+
+> `readonly` **Mass**: `"Mass"` = `"Mass"`
+
+Measurement type "Mass".
+
+### MassConcentration {#massconcentration}
+
+> `readonly` **MassConcentration**: `"MassConcentration"` = `"MassConcentration"`
+
+Measurement type "MassConcentration".
+
+### MassFlowRate {#massflowrate}
+
+> `readonly` **MassFlowRate**: `"MassFlowRate"` = `"MassFlowRate"`
+
+Measurement type "MassFlowRate".
+
+### MassPerAreaTime {#massperareatime}
+
+> `readonly` **MassPerAreaTime**: `"MassPerAreaTime"` = `"MassPerAreaTime"`
+
+Measurement type "MassPerAreaTime".
+
+### MemoryCapacity {#memorycapacity}
+
+> `readonly` **MemoryCapacity**: `"MemoryCapacity"` = `"MemoryCapacity"`
+
+Measurement type "MemoryCapacity".
+
+### MolalityOfSolute {#molalityofsolute}
+
+> `readonly` **MolalityOfSolute**: `"MolalityOfSolute"` = `"MolalityOfSolute"`
+
+Measurement type "MolalityOfSolute".
+
+### MolarEnergy {#molarenergy}
+
+> `readonly` **MolarEnergy**: `"MolarEnergy"` = `"MolarEnergy"`
+
+Measurement type "MolarEnergy".
+
+### MolarMass {#molarmass}
+
+> `readonly` **MolarMass**: `"MolarMass"` = `"MolarMass"`
+
+Measurement type "MolarMass".
+
+### MolarVolume {#molarvolume}
+
+> `readonly` **MolarVolume**: `"MolarVolume"` = `"MolarVolume"`
+
+Measurement type "MolarVolume".
+
+### Power {#power}
+
+> `readonly` **Power**: `"Power"` = `"Power"`
+
+Measurement type "Power".
+
+### Pressure {#pressure}
+
+> `readonly` **Pressure**: `"Pressure"` = `"Pressure"`
+
+Measurement type "Pressure".
+
+### RadiantFlux {#radiantflux}
+
+> `readonly` **RadiantFlux**: `"RadiantFlux"` = `"RadiantFlux"`
+
+Measurement type "RadiantFlux".
+
+### RadiantIntensity {#radiantintensity}
+
+> `readonly` **RadiantIntensity**: `"RadiantIntensity"` = `"RadiantIntensity"`
+
+Measurement type "RadiantIntensity".
+
+### RelativeHumidity {#relativehumidity}
+
+> `readonly` **RelativeHumidity**: `"RelativeHumidity"` = `"RelativeHumidity"`
+
+Measurement type "RelativeHumidity".
+
+### Resistance {#resistance}
+
+> `readonly` **Resistance**: `"Resistance"` = `"Resistance"`
+
+Measurement type "Resistance".
+
+### Resistivity {#resistivity}
+
+> `readonly` **Resistivity**: `"Resistivity"` = `"Resistivity"`
+
+Measurement type "Resistivity".
+
+### SolidAngle {#solidangle}
+
+> `readonly` **SolidAngle**: `"SolidAngle"` = `"SolidAngle"`
+
+Measurement type "SolidAngle".
+
+### SpecificVolume {#specificvolume}
+
+> `readonly` **SpecificVolume**: `"SpecificVolume"` = `"SpecificVolume"`
+
+Measurement type "SpecificVolume".
+
+### Speed {#speed}
+
+> `readonly` **Speed**: `"Speed"` = `"Speed"`
+
+Measurement type "Speed".
+
+### SurfaceDensity {#surfacedensity}
+
+> `readonly` **SurfaceDensity**: `"SurfaceDensity"` = `"SurfaceDensity"`
+
+Measurement type "SurfaceDensity".
+
+### SurfaceTension {#surfacetension}
+
+> `readonly` **SurfaceTension**: `"SurfaceTension"` = `"SurfaceTension"`
+
+Measurement type "SurfaceTension".
+
+### Temperature {#temperature}
+
+> `readonly` **Temperature**: `"Temperature"` = `"Temperature"`
+
+Measurement type "Temperature".
+
+### Time {#time}
+
+> `readonly` **Time**: `"Time"` = `"Time"`
+
+Measurement type "Time".
+
+### Torque {#torque}
+
+> `readonly` **Torque**: `"Torque"` = `"Torque"`
+
+Measurement type "Torque".
+
+### Voltage {#voltage}
+
+> `readonly` **Voltage**: `"Voltage"` = `"Voltage"`
+
+Measurement type "Voltage".
+
+### Volume {#volume}
+
+> `readonly` **Volume**: `"Volume"` = `"Volume"`
+
+Measurement type "Volume".
+
+### VolumeFlowRate {#volumeflowrate}
+
+> `readonly` **VolumeFlowRate**: `"VolumeFlowRate"` = `"VolumeFlowRate"`
+
+Measurement type "VolumeFlowRate".
+
+### VolumeFraction {#volumefraction}
+
+> `readonly` **VolumeFraction**: `"VolumeFraction"` = `"VolumeFraction"`
+
+Measurement type "VolumeFraction".
+
+### VolumetricFlux {#volumetricflux}
+
+> `readonly` **VolumetricFlux**: `"VolumetricFlux"` = `"VolumetricFlux"`
+
+Measurement type "VolumetricFlux".
+
+### Wavenumber {#wavenumber}
+
+> `readonly` **Wavenumber**: `"Wavenumber"` = `"Wavenumber"`
+
+Measurement type "Wavenumber".

package/docs/reference/variables/EpcisSensorAlertTypes.md

@@ -0,0 +1,20 @@
+# Variable: EpcisSensorAlertTypes
+
+> `const` **EpcisSensorAlertTypes**: `object`
+
+Supported EPCIS 2.0 `sensorAlertType` values for sensor-generated alarms or
+errors.
+
+## Type Declaration
+
+### AlarmCondition {#alarmcondition}
+
+> `readonly` **AlarmCondition**: `"ALARM_CONDITION"` = `"ALARM_CONDITION"`
+
+Sensor alert indicating an alarm condition.
+
+### ErrorCondition {#errorcondition}
+
+> `readonly` **ErrorCondition**: `"ERROR_CONDITION"` = `"ERROR_CONDITION"`
+
+Sensor alert indicating an error condition.

package/docs/reference/variables/EpcisSourceDestTypes.md

@@ -0,0 +1,29 @@
+# Variable: EpcisSourceDestTypes
+
+> `const` **EpcisSourceDestTypes**: `object`
+
+Supported EPCIS 2.0 `source-dest-type` values describing the role of a party
+or location in a transfer.
+
+## Type Declaration
+
+### OwningParty {#owningparty}
+
+> `readonly` **OwningParty**: `"owning_party"` = `"owning_party"`
+
+Identifier denotes the party who owns (or will own) the objects at the
+business transfer endpoint.
+
+### PossessingParty {#possessingparty}
+
+> `readonly` **PossessingParty**: `"possessing_party"` = `"possessing_party"`
+
+Identifier denotes the party who has (or will have) physical possession of
+the objects at the endpoint.
+
+### Location {#location}
+
+> `readonly` **Location**: `"location"` = `"location"`
+
+Identifier denotes the physical location of the originating or terminating
+endpoint of the business transfer.

package/docs/reference/variables/GS1Contexts.md

@@ -6,8 +6,16 @@ The contexts of GS1.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://gs1.org/voc/"` = `"https://gs1.org/voc/"`
+> `readonly` **Namespace**: `"https://gs1.org/voc/"` = `"https://gs1.org/voc/"`
 
-The context root for the GS1 types.
+The canonical RDF namespace URI.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://gs1.org/voc"` = `"https://gs1.org/voc"`
+
+The value to use in JSON-LD context.
+Note: Context differs from Namespace (no trailing slash) as per GS1 standard specification.
+The GS1 JSON-LD context URL format does not include a trailing slash.

package/docs/reference/variables/Gs1IdTypes.md

@@ -6,121 +6,121 @@ GS1 EPC Identifiers.
 
 ## Type Declaration
 
-### Gtin
+### Gtin {#gtin}
 
 > `readonly` **Gtin**: `"sgtin"` = `"sgtin"`
 
 GTIN - Trade Item.
 
-### Sscc
+### Sscc {#sscc}
 
 > `readonly` **Sscc**: `"sscc"` = `"sscc"`
 
 SSCC - Logistics Unit.
 
-### Gln
+### Gln {#gln}
 
 > `readonly` **Gln**: `"sgln"` = `"sgln"`
 
 GLN - Location.
 
-### Grai
+### Grai {#grai}
 
 > `readonly` **Grai**: `"grai"` = `"grai"`
 
 GRAI - Returnable Asset.
 
-### Giai
+### Giai {#giai}
 
 > `readonly` **Giai**: `"giai"` = `"giai"`
 
 GIAI - Fixed Asset.
 
-### GsrnRecipient
+### GsrnRecipient {#gsrnrecipient}
 
 > `readonly` **GsrnRecipient**: `"gsrn"` = `"gsrn"`
 
 GSRN - Recipient - Hospital Admission or Club Membership.
 
-### GsrnProvider
+### GsrnProvider {#gsrnprovider}
 
 > `readonly` **GsrnProvider**: `"gsrnp"` = `"gsrnp"`
 
 GSRN - Provider - Medical Caregiver or Loyalty Club.
 
-### Gtdi
+### Gtdi {#gtdi}
 
 > `readonly` **Gtdi**: `"gtdi"` = `"gtdi"`
 
 GDTI - Document.
 
-### None
+### None {#none}
 
 > `readonly` **None**: `"cpi"` = `"cpi"`
 
 Technical Industries for unique identification of parts and components.
 
-### Gcn
+### Gcn {#gcn}
 
 > `readonly` **Gcn**: `"sgcn"` = `"sgcn"`
 
 GCN - Coupon.
 
-### Ginc
+### Ginc {#ginc}
 
 > `readonly` **Ginc**: `"ginc"` = `"ginc"`
 
 Logical grouping of goods intended for transport as a whole assigned by a freight forwarder.
 
-### Gsin
+### Gsin {#gsin}
 
 > `readonly` **Gsin**: `"gsin"` = `"gsin"`
 
 Logical grouping of logistic units travelling under one dispatch advice and/or bill of lading.
 
-### Ai
+### Ai {#ai}
 
 > `readonly` **Ai**: `"itip"` = `"itip"`
 
 One of multiple pieces comprising, and subordinate to, a whole.
 
-### GtinTpx
+### GtinTpx {#gtintpx}
 
 > `readonly` **GtinTpx**: `"upui"` = `"upui"`
 
 Pack identification to combat illicit trade.
 
-### GlnAi
+### GlnAi {#glnai}
 
 > `readonly` **GlnAi**: `"pgln"` = `"pgln"`
 
 Identification of Economic Operator, Owning party or processing party in CoC/CoO.
 
-### Unspecified
+### Unspecified {#unspecified}
 
 > `readonly` **Unspecified**: `"gid"` = `"gid"`
 
 Unspecified.
 
-### UsDod
+### UsDod {#usdod}
 
 > `readonly` **UsDod**: `"usdod"` = `"usdod"`
 
 US Dept of Defense supply chain.
 
-### AerospaceDefence
+### AerospaceDefence {#aerospacedefence}
 
 > `readonly` **AerospaceDefence**: `"adi"` = `"adi"`
 
 Aerospace and Defense sector for unique identification of aircraft and other parts and items.
 
-### Intermodal
+### Intermodal {#intermodal}
 
 > `readonly` **Intermodal**: `"bic"` = `"bic"`
 
 Intermodal shipping containers.
 
-### Vessel
+### Vessel {#vessel}
 
 > `readonly` **Vessel**: `"imovn"` = `"imovn"`
 

package/docs/reference/variables/Gs1IdentifierTypes.md

@@ -6,25 +6,25 @@ The types of GS1 Identifier data.
 
 ## Type Declaration
 
-### EpcId
+### EpcId {#epcid}
 
 > `readonly` **EpcId**: `"epc:id"` = `"epc:id"`
 
 Identifier epc id namespace.
 
-### EpcIdGtin
+### EpcIdGtin {#epcidgtin}
 
 > `readonly` **EpcIdGtin**: `"epc:id:sgtin"`
 
 Identifier epc:id:gtin namespace.
 
-### EpcIdGln
+### EpcIdGln {#epcidgln}
 
 > `readonly` **EpcIdGln**: `"epc:id:sgln"`
 
 Identifier epc:id:sgln namespace.
 
-### EpcClass
+### EpcClass {#epcclass}
 
 > `readonly` **EpcClass**: `"epc:class"` = `"epc:class"`