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

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

@@ -1,44 +1,158 @@
 /**
- * EPCIS 2.0 disposition types.
+ * Supported EPCIS 2.0 `disposition` values from the GS1 Core Business
+ * Vocabulary (CBV).
  *
- * See EPCIS CVB for more details.
+ * Use the union type `EpcisDispositionTypes` to restrict a field to known CBV
+ * values.
  */
 export declare const EpcisDispositionTypes: {
+    /**
+     * A commissioned object has just been introduced into the supply chain.
+     */
     readonly Active: "active";
+    /**
+     * Object has been loaded onto a container, the doors closed, and the shipment
+     * sealed.
+     */
     readonly ContainerClosed: "container_closed";
+    /**
+     * Object is impaired in usefulness or value due to a defect.
+     */
     readonly Damaged: "damaged";
+    /**
+     * Object has been fully rendered non-usable.
+     */
     readonly Destroyed: "destroyed";
+    /**
+     * A full quantity of product is distributed to a consumer.
+     */
     readonly Dispensed: "dispensed";
+    /**
+     * Object has been returned for disposal.
+     */
     readonly Disposed: "disposed";
+    /**
+     * An instance-level identifier has been written to a barcode or RFID tag, but
+     * not yet commissioned.
+     */
     readonly Encoded: "encoded";
+    /**
+     * Object's expiration date is in the past.
+     */
     readonly Expired: "expired";
+    /**
+     * Optional disposition for objects proceeding through points in the supply
+     * chain.
+     */
     readonly InProgress: "in_progress";
+    /**
+     * Object is being shipped between two trading partners.
+     */
     readonly InTransit: "in_transit";
+    /**
+     * Decommissioned object that may be reintroduced to the supply chain.
+     */
     readonly Inactive: "inactive";
+    /**
+     * No pedigree match was found during validation, so the product is quarantined
+     * for investigation.
+     */
     readonly NoPedigreeMatch: "no_pedigree_match";
+    /**
+     * Object cannot be sold to a customer.
+     */
     readonly NonSellableOther: "non_sellable_other";
+    /**
+     * A portion of a product is distributed to a customer while additional product
+     * is retained.
+     */
     readonly PartiallyDispensed: "partially_dispensed";
+    /**
+     * Object is non-sellable because of public safety reasons.
+     */
     readonly Recalled: "recalled";
+    /**
+     * Instance-level identifier has been allocated for a third party.
+     */
     readonly Reserved: "reserved";
+    /**
+     * Product has been purchased by a customer.
+     */
     readonly RetailSold: "retail_sold";
+    /**
+     * Object has been sent or brought back for various reasons; it may or may not
+     * be sellable.
+     */
     readonly Returned: "returned";
+    /**
+     * Product can be sold as is and a customer can access it for purchase.
+     */
     readonly SellableAccessible: "sellable_accessible";
+    /**
+     * Product can be sold as is, but a customer cannot access it for purchase.
+     */
     readonly SellableNotAccessible: "sellable_not_accessible";
+    /**
+     * An object has been taken without permission or right.
+     */
     readonly Stolen: "stolen";
+    /**
+     * An object's condition is not known.
+     */
     readonly Unknown: "unknown";
+    /**
+     * Object has been returned to service or the supply chain after repair.
+     */
     readonly Available: "available";
+    /**
+     * Explicitly indicates verified integrity of an aggregation when children are
+     * unpacked or verified.
+     */
     readonly CompletenessVerified: "completeness_verified";
+    /**
+     * Indicates inferred integrity of an aggregation based on upstream aggregation
+     * information.
+     */
     readonly CompletenessInferred: "completeness_inferred";
+    /**
+     * Outcome of a successful inspection in an inspecting or repairing step.
+     */
     readonly Conformant: "conformant";
+    /**
+     * Container doors have been opened or a shipment seal has been broken.
+     */
     readonly ContainerOpen: "container_open";
+    /**
+     * Instance-level identifiers do not match what was expected.
+     */
     readonly MismatchInstance: "mismatch_instance";
+    /**
+     * Class-level identifiers do not match what was expected.
+     */
     readonly MismatchClass: "mismatch_class";
+    /**
+     * Quantities do not match what was expected.
+     */
     readonly MismatchQuantity: "mismatch_quantity";
+    /**
+     * Components or assets must be replaced to ensure functional requirements.
+     */
     readonly NeedsReplacement: "needs_replacement";
+    /**
+     * Outcome of an unsuccessful inspection in an inspecting or repairing step.
+     */
     readonly NonConformant: "non_conformant";
+    /**
+     * Object has been removed from service or the supply chain, for example pending
+     * repair.
+     */
     readonly Unavailable: "unavailable";
 };
 /**
- * EPCIS 2.0 disposition types.
+ * Supported EPCIS 2.0 `disposition` values from the GS1 Core Business
+ * Vocabulary (CBV).
+ *
+ * Use the union type `EpcisDispositionTypes` to restrict a field to known CBV
+ * values.
  */
 export type EpcisDispositionTypes = (typeof EpcisDispositionTypes)[keyof typeof EpcisDispositionTypes];

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

@@ -0,0 +1,19 @@
+/**
+ * Supported EPCIS 2.0 `error-reason` values from the GS1 EPCIS JSON Schema.
+ */
+export declare const EpcisErrorReasonTypes: {
+    /**
+     * Prior event is erroneous because it did not actually occur; no corrective
+     * events exist.
+     */
+    readonly DidNotOccur: "did_not_occur";
+    /**
+     * Prior event has incorrect data and may be corrected by subsequent linked
+     * events.
+     */
+    readonly IncorrectData: "incorrect_data";
+};
+/**
+ * Supported EPCIS 2.0 `error-reason` values from the GS1 EPCIS JSON Schema.
+ */
+export type EpcisErrorReasonTypes = (typeof EpcisErrorReasonTypes)[keyof typeof EpcisErrorReasonTypes];

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

@@ -1,29 +1,29 @@
 /**
- * EPCIS 2.0 event types.
+ * EPCIS 2.0 event type identifiers used in EPCIS JSON and XML documents.
  */
 export declare const EpcisEventTypes: {
     /**
-     * ObjectEvent.
+     * Event that observes one or more instance- or class-level objects.
      */
     readonly ObjectEvent: "ObjectEvent";
     /**
-     * Aggregation Event.
+     * Event recording child objects aggregated under a parent identifier.
      */
     readonly AggregationEvent: "AggregationEvent";
     /**
-     * Association Event.
+     * Event recording parent/child associations without implying containment.
      */
     readonly AssociationEvent: "AssociationEvent";
     /**
-     * Transformation Event.
+     * Event recording how inputs are transformed into outputs.
      */
     readonly TransformationEvent: "TransformationEvent";
     /**
-     * Transaction Event.
+     * Event linking objects or quantities to business transactions.
      */
     readonly TransactionEvent: "TransactionEvent";
 };
 /**
- * EPCIS 2.0 event types.
+ * EPCIS 2.0 event type identifiers used in EPCIS JSON and XML documents.
  */
 export type EpcisEventTypes = (typeof EpcisEventTypes)[keyof typeof EpcisEventTypes];

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

@@ -0,0 +1,11 @@
+import type { IEpcisAggregationEvent } from "./IEpcisAggregationEvent.js";
+import type { IEpcisAssociationEvent } from "./IEpcisAssociationEvent.js";
+import type { IEpcisEvent } from "./IEpcisEvent.js";
+import type { IEpcisObjectEvent } from "./IEpcisObjectEvent.js";
+import type { IEpcisTransactionEvent } from "./IEpcisTransactionEvent.js";
+import type { IEpcisTransformationEvent } from "./IEpcisTransformationEvent.js";
+/**
+ * Discriminated union covering all EPCIS 2.0 event interfaces used in this
+ * package.
+ */
+export type EpcisEvents = IEpcisObjectEvent | IEpcisAssociationEvent | IEpcisAggregationEvent | IEpcisTransactionEvent | IEpcisTransformationEvent | IEpcisEvent;

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

@@ -0,0 +1,303 @@
+/**
+ * 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.
+ */
+export declare const EpcisMeasurementTypes: {
+    /**
+     * Measurement type "AbsoluteHumidity".
+     */
+    readonly AbsoluteHumidity: "AbsoluteHumidity";
+    /**
+     * Measurement type "AbsorbedDose".
+     */
+    readonly AbsorbedDose: "AbsorbedDose";
+    /**
+     * Measurement type "AbsorbedDoseRate".
+     */
+    readonly AbsorbedDoseRate: "AbsorbedDoseRate";
+    /**
+     * Measurement type "Acceleration".
+     */
+    readonly Acceleration: "Acceleration";
+    /**
+     * Measurement type "Radioactivity".
+     */
+    readonly Radioactivity: "Radioactivity";
+    /**
+     * Measurement type "Altitude".
+     */
+    readonly Altitude: "Altitude";
+    /**
+     * Measurement type "AmountOfSubstance".
+     */
+    readonly AmountOfSubstance: "AmountOfSubstance";
+    /**
+     * Measurement type "AmountOfSubstancePerUnitVolume".
+     */
+    readonly AmountOfSubstancePerUnitVolume: "AmountOfSubstancePerUnitVolume";
+    /**
+     * Measurement type "Angle".
+     */
+    readonly Angle: "Angle";
+    /**
+     * Measurement type "AngularAcceleration".
+     */
+    readonly AngularAcceleration: "AngularAcceleration";
+    /**
+     * Measurement type "AngularMomentum".
+     */
+    readonly AngularMomentum: "AngularMomentum";
+    /**
+     * Measurement type "AngularVelocity".
+     */
+    readonly AngularVelocity: "AngularVelocity";
+    /**
+     * Measurement type "Area".
+     */
+    readonly Area: "Area";
+    /**
+     * Measurement type "Capacitance".
+     */
+    readonly Capacitance: "Capacitance";
+    /**
+     * Measurement type "Conductance".
+     */
+    readonly Conductance: "Conductance";
+    /**
+     * Measurement type "Conductivity".
+     */
+    readonly Conductivity: "Conductivity";
+    /**
+     * Measurement type "Count".
+     */
+    readonly Count: "Count";
+    /**
+     * Measurement type "Density".
+     */
+    readonly Density: "Density";
+    /**
+     * Measurement type "Dimensionless".
+     */
+    readonly Dimensionless: "Dimensionless";
+    /**
+     * Measurement type "DoseEquivalent".
+     */
+    readonly DoseEquivalent: "DoseEquivalent";
+    /**
+     * Measurement type "DoseEquivalentRate".
+     */
+    readonly DoseEquivalentRate: "DoseEquivalentRate";
+    /**
+     * Measurement type "DynamicViscosity".
+     */
+    readonly DynamicViscosity: "DynamicViscosity";
+    /**
+     * Measurement type "ElectricCharge".
+     */
+    readonly ElectricCharge: "ElectricCharge";
+    /**
+     * Measurement type "ElectricCurrent".
+     */
+    readonly ElectricCurrent: "ElectricCurrent";
+    /**
+     * Measurement type "ElectricCurrentDensity".
+     */
+    readonly ElectricCurrentDensity: "ElectricCurrentDensity";
+    /**
+     * Measurement type "ElectricFieldStrength".
+     */
+    readonly ElectricFieldStrength: "ElectricFieldStrength";
+    /**
+     * Measurement type "Energy".
+     */
+    readonly Energy: "Energy";
+    /**
+     * Measurement type "Exposure".
+     */
+    readonly Exposure: "Exposure";
+    /**
+     * Measurement type "Force".
+     */
+    readonly Force: "Force";
+    /**
+     * Measurement type "Frequency".
+     */
+    readonly Frequency: "Frequency";
+    /**
+     * Measurement type "Illuminance".
+     */
+    readonly Illuminance: "Illuminance";
+    /**
+     * Measurement type "Inductance".
+     */
+    readonly Inductance: "Inductance";
+    /**
+     * Measurement type "Irradiance".
+     */
+    readonly Irradiance: "Irradiance";
+    /**
+     * Measurement type "KinematicViscosity".
+     */
+    readonly KinematicViscosity: "KinematicViscosity";
+    /**
+     * Measurement type "Length".
+     */
+    readonly Length: "Length";
+    /**
+     * Measurement type "LinearMomentum".
+     */
+    readonly LinearMomentum: "LinearMomentum";
+    /**
+     * Measurement type "Luminance".
+     */
+    readonly Luminance: "Luminance";
+    /**
+     * Measurement type "LuminousFlux".
+     */
+    readonly LuminousFlux: "LuminousFlux";
+    /**
+     * Measurement type "LuminousIntensity".
+     */
+    readonly LuminousIntensity: "LuminousIntensity";
+    /**
+     * Measurement type "MagneticFlux".
+     */
+    readonly MagneticFlux: "MagneticFlux";
+    /**
+     * Measurement type "MagneticFluxDensity".
+     */
+    readonly MagneticFluxDensity: "MagneticFluxDensity";
+    /**
+     * Measurement type "MagneticVectorPotential".
+     */
+    readonly MagneticVectorPotential: "MagneticVectorPotential";
+    /**
+     * Measurement type "Mass".
+     */
+    readonly Mass: "Mass";
+    /**
+     * Measurement type "MassConcentration".
+     */
+    readonly MassConcentration: "MassConcentration";
+    /**
+     * Measurement type "MassFlowRate".
+     */
+    readonly MassFlowRate: "MassFlowRate";
+    /**
+     * Measurement type "MassPerAreaTime".
+     */
+    readonly MassPerAreaTime: "MassPerAreaTime";
+    /**
+     * Measurement type "MemoryCapacity".
+     */
+    readonly MemoryCapacity: "MemoryCapacity";
+    /**
+     * Measurement type "MolalityOfSolute".
+     */
+    readonly MolalityOfSolute: "MolalityOfSolute";
+    /**
+     * Measurement type "MolarEnergy".
+     */
+    readonly MolarEnergy: "MolarEnergy";
+    /**
+     * Measurement type "MolarMass".
+     */
+    readonly MolarMass: "MolarMass";
+    /**
+     * Measurement type "MolarVolume".
+     */
+    readonly MolarVolume: "MolarVolume";
+    /**
+     * Measurement type "Power".
+     */
+    readonly Power: "Power";
+    /**
+     * Measurement type "Pressure".
+     */
+    readonly Pressure: "Pressure";
+    /**
+     * Measurement type "RadiantFlux".
+     */
+    readonly RadiantFlux: "RadiantFlux";
+    /**
+     * Measurement type "RadiantIntensity".
+     */
+    readonly RadiantIntensity: "RadiantIntensity";
+    /**
+     * Measurement type "RelativeHumidity".
+     */
+    readonly RelativeHumidity: "RelativeHumidity";
+    /**
+     * Measurement type "Resistance".
+     */
+    readonly Resistance: "Resistance";
+    /**
+     * Measurement type "Resistivity".
+     */
+    readonly Resistivity: "Resistivity";
+    /**
+     * Measurement type "SolidAngle".
+     */
+    readonly SolidAngle: "SolidAngle";
+    /**
+     * Measurement type "SpecificVolume".
+     */
+    readonly SpecificVolume: "SpecificVolume";
+    /**
+     * Measurement type "Speed".
+     */
+    readonly Speed: "Speed";
+    /**
+     * Measurement type "SurfaceDensity".
+     */
+    readonly SurfaceDensity: "SurfaceDensity";
+    /**
+     * Measurement type "SurfaceTension".
+     */
+    readonly SurfaceTension: "SurfaceTension";
+    /**
+     * Measurement type "Temperature".
+     */
+    readonly Temperature: "Temperature";
+    /**
+     * Measurement type "Time".
+     */
+    readonly Time: "Time";
+    /**
+     * Measurement type "Torque".
+     */
+    readonly Torque: "Torque";
+    /**
+     * Measurement type "Voltage".
+     */
+    readonly Voltage: "Voltage";
+    /**
+     * Measurement type "Volume".
+     */
+    readonly Volume: "Volume";
+    /**
+     * Measurement type "VolumeFlowRate".
+     */
+    readonly VolumeFlowRate: "VolumeFlowRate";
+    /**
+     * Measurement type "VolumeFraction".
+     */
+    readonly VolumeFraction: "VolumeFraction";
+    /**
+     * Measurement type "VolumetricFlux".
+     */
+    readonly VolumetricFlux: "VolumetricFlux";
+    /**
+     * Measurement type "Wavenumber".
+     */
+    readonly Wavenumber: "Wavenumber";
+};
+/**
+ * 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.
+ */
+export type EpcisMeasurementTypes = (typeof EpcisMeasurementTypes)[keyof typeof EpcisMeasurementTypes];

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

@@ -0,0 +1,19 @@
+/**
+ * Supported EPCIS 2.0 `sensorAlertType` values for sensor-generated alarms or
+ * errors.
+ */
+export declare const EpcisSensorAlertTypes: {
+    /**
+     * Sensor alert indicating an alarm condition.
+     */
+    readonly AlarmCondition: "ALARM_CONDITION";
+    /**
+     * Sensor alert indicating an error condition.
+     */
+    readonly ErrorCondition: "ERROR_CONDITION";
+};
+/**
+ * Supported EPCIS 2.0 `sensorAlertType` values for sensor-generated alarms or
+ * errors.
+ */
+export type EpcisSensorAlertTypes = (typeof EpcisSensorAlertTypes)[keyof typeof EpcisSensorAlertTypes];

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

@@ -0,0 +1,26 @@
+/**
+ * Supported EPCIS 2.0 `source-dest-type` values describing the role of a party
+ * or location in a transfer.
+ */
+export declare const EpcisSourceDestTypes: {
+    /**
+     * Identifier denotes the party who owns (or will own) the objects at the
+     * business transfer endpoint.
+     */
+    readonly OwningParty: "owning_party";
+    /**
+     * Identifier denotes the party who has (or will have) physical possession of
+     * the objects at the endpoint.
+     */
+    readonly PossessingParty: "possessing_party";
+    /**
+     * Identifier denotes the physical location of the originating or terminating
+     * endpoint of the business transfer.
+     */
+    readonly Location: "location";
+};
+/**
+ * Supported EPCIS 2.0 `source-dest-type` values describing the role of a party
+ * or location in a transfer.
+ */
+export type EpcisSourceDestTypes = (typeof EpcisSourceDestTypes)[keyof typeof EpcisSourceDestTypes];

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

@@ -0,0 +1,37 @@
+/**
+ * JSON-LD type IRIs used across EPCIS 2.0 documents and events.
+ */
+export declare const EpcisTypes: {
+    /**
+     * EPCISDocument root type for capture payloads.
+     */
+    readonly EPCISDocument: "EPCISDocument";
+    /**
+     * EPCISQueryDocument root type for query requests.
+     */
+    readonly EPCISQueryDocument: "EPCISQueryDocument";
+    /**
+     * ObjectEvent type identifier.
+     */
+    readonly ObjectEvent: "ObjectEvent";
+    /**
+     * AssociationEvent type identifier.
+     */
+    readonly AssociationEvent: "AssociationEvent";
+    /**
+     * AggregationEvent type identifier.
+     */
+    readonly AggregationEvent: "AggregationEvent";
+    /**
+     * TransactionEvent type identifier.
+     */
+    readonly TransactionEvent: "TransactionEvent";
+    /**
+     * TransformationEvent type identifier.
+     */
+    readonly TransformationEvent: "TransformationEvent";
+};
+/**
+ * JSON-LD type IRIs used across EPCIS 2.0 documents and events.
+ */
+export type EpcisTypes = (typeof EpcisTypes)[keyof typeof EpcisTypes];

package/dist/types/models/gs1/gs1Contexts.d.ts

@@ -3,9 +3,15 @@
  */
 export declare const GS1Contexts: {
     /**
-     * The context root for the GS1 types.
+     * The canonical RDF namespace URI.
      */
-    readonly ContextRoot: "https://gs1.org/voc/";
+    readonly Namespace: "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.
+     */
+    readonly Context: "https://gs1.org/voc";
 };
 /**
  * The contexts of GS1.

package/dist/types/utils/gs1Is.d.ts

@@ -9,9 +9,10 @@ export declare class Gs1Is {
      */
     static isEpcHex(value: string): boolean;
     /**
-     * Is the value a valid geo uri https://en.wikipedia.org/wiki/Geo_URI_scheme.
+     * Is the value a valid geo URI.
      * @param value The value to check.
-     * @returns True if the value matches a geo uri.
+     * @returns True if the value matches the geo URI scheme.
+     * @see https://en.wikipedia.org/wiki/Geo_URI_scheme
      */
     static isGeoUri(value: string): boolean;
 }