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

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

@@ -1,52 +1,193 @@
 /**
- * Supported EPCIS 2.0 bizStep.
+ * Supported EPCIS 2.0 `bizStep` values.
  *
- * See EPCIS CVB specification for details.
+ * These values come from the GS1 EPCIS / CBV (Core Business Vocabulary).
+ * Use the union type `EpcisBizStepTypes` when you want to restrict a field to known CBV values.
  */
 export declare const EpcisBizStepTypes: {
+    /**
+     * Activity where an object changes possession and/or ownership.
+     */
     readonly Accepting: "accepting";
+    /**
+     * Activity where an object arrives at a location.
+     */
     readonly Arriving: "arriving";
+    /**
+     * Combining one or more objects to create a new finished product while originals
+     * remain recognisable.
+     */
     readonly Assembling: "assembling";
+    /**
+     * Picking up and collecting an object for future disposal, recycling, or re-use.
+     */
     readonly Collecting: "collecting";
+    /**
+     * Associating a new instance- or class-level identifier with a specific object
+     * for the first time.
+     */
     readonly Commissioning: "commissioning";
+    /**
+     * Overall process covering staging_outbound, loading, departing, and accepting
+     * when granular steps are unknown.
+     */
     readonly Consigning: "consigning";
+    /**
+     * Step where an instance or increased quantity of a class-level identifier is
+     * produced and may repeat.
+     */
     readonly CreatingClassInstance: "creating_class_instance";
+    /**
+     * Counting objects within a location for business needs other than accounting.
+     */
     readonly CycleCounting: "cycle_counting";
+    /**
+     * Disassociating an instance-level identifier from an object; it may be
+     * re-commissioned later with a new identifier.
+     */
     readonly Decommissioning: "decommissioning";
+    /**
+     * Activity where an object leaves a location on its way to a destination.
+     */
     readonly Departing: "departing";
+    /**
+     * Process of terminating an object so it should not be subject of subsequent events.
+     */
     readonly Destroying: "destroying";
+    /**
+     * Breaking down an object into separate, uniquely identified component parts.
+     */
     readonly Disassembling: "disassembling";
+    /**
+     * Making a product available in full or part to a consumer.
+     */
     readonly Dispensing: "dispensing";
+    /**
+     * Writing an instance-level identifier to a barcode or RFID tag before
+     * association with an object.
+     */
     readonly Encoding: "encoding";
+    /**
+     * Activity at a facility entrance/exit where customers leave with purchases or
+     * enter with returns.
+     */
     readonly EnteringExiting: "entering_exiting";
+    /**
+     * Segregating an object for further review.
+     */
     readonly Holding: "holding";
+    /**
+     * Reviewing objects to address potential defects while keeping them viable in the
+     * supply chain.
+     */
     readonly Inspecting: "inspecting";
+    /**
+     * Putting an object into a composite object that already exists.
+     */
     readonly Installing: "installing";
+    /**
+     * Terminating an RFID tag previously associated with an object while the object
+     * continues to exist.
+     */
     readonly Killing: "killing";
+    /**
+     * Loading an object into a shipping conveyance.
+     */
     readonly Loading: "loading";
+    /**
+     * A business step not identified by the CBV list.
+     */
     readonly Other: "other";
+    /**
+     * Putting objects into a larger container for shipping, typically where
+     * aggregation occurs.
+     */
     readonly Packing: "packing";
+    /**
+     * Selecting objects to fill an order.
+     */
     readonly Picking: "picking";
+    /**
+     * Indicating an object is being received at a location and added to inventory.
+     */
     readonly Receiving: "receiving";
+    /**
+     * Taking an object out of a composite object; opposite of installing.
+     */
     readonly Removing: "removing";
+    /**
+     * Changing an object's packaging configuration.
+     */
     readonly Repackaging: "repackaging";
+    /**
+     * Repairing a malfunctioning product without replacing it.
+     */
     readonly Repairing: "repairing";
+    /**
+     * Substituting or exchanging an object for another object.
+     */
     readonly Replacing: "replacing";
+    /**
+     * Providing a set of not-yet-commissioned instance identifiers for use by another party.
+     */
     readonly Reserving: "reserving";
+    /**
+     * Point-of-sale activity transferring ownership to a customer for value.
+     */
     readonly RetailSelling: "retail_selling";
+    /**
+     * Overall process covering staging_outbound, loading, and departing when finer
+     * detail is unavailable.
+     */
     readonly Shipping: "shipping";
+    /**
+     * Moving an object from a facility to an area where it awaits transport pick-up.
+     */
     readonly StagingOutbound: "staging_outbound";
+    /**
+     * Counting objects within a location following established rules for accounting purposes.
+     */
     readonly StockTaking: "stock_taking";
+    /**
+     * Activity within a location to make an object available to customers or order
+     * fulfilment.
+     */
     readonly Stocking: "stocking";
+    /**
+     * Moving an object into and out of storage within a location.
+     */
     readonly Storing: "storing";
+    /**
+     * Moving an object from one location to another using a vehicle.
+     */
     readonly Transporting: "transporting";
+    /**
+     * Unloading an object from a shipping conveyance.
+     */
     readonly Unloading: "unloading";
+    /**
+     * Removing products from a larger container, usually after receiving or
+     * accepting.
+     */
     readonly Unpacking: "unpacking";
+    /**
+     * Declaring that objects in a prior outbound process were not shipped as previously indicated.
+     */
     readonly VoidShipping: "void_shipping";
+    /**
+     * Returning sensor data about the physical properties or condition of an object or location.
+     */
     readonly SensorReporting: "sensor_reporting";
+    /**
+     * Testing activity where portions of an object are examined, rendering the
+     * sampled object no longer viable.
+     */
     readonly Sampling: "sampling";
 };
 /**
- * EPCIS 2.0 action types.
+ * Supported EPCIS 2.0 `bizStep` values.
+ *
+ * These values come from the GS1 EPCIS / CBV (Core Business Vocabulary).
+ * Use the union type `EpcisBizStepTypes` when you want to restrict a field to known CBV values.
  */
 export type EpcisBizStepTypes = (typeof EpcisBizStepTypes)[keyof typeof EpcisBizStepTypes];

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

@@ -0,0 +1,74 @@
+/**
+ * Supported EPCIS 2.0 `bizTransaction-type` values.
+ */
+export declare const EpcisBizTransactionTypes: {
+    /**
+     * A document issued by a carrier to a shipper, listing and acknowledging receipt
+     * of goods for transport and specifying terms of delivery.
+     */
+    readonly Bol: "bol";
+    /**
+     * A document confirming certain characteristics of an object, person, or
+     * organisation, typically issued by a third party.
+     */
+    readonly Cert: "cert";
+    /**
+     * A document/message by which the seller or consignor informs the consignee
+     * about the despatch of goods (Advanced Shipment Notice).
+     */
+    readonly Desadv: "desadv";
+    /**
+     * A document/message claiming payment for goods or services supplied under agreed
+     * conditions.
+     */
+    readonly Inv: "inv";
+    /**
+     * A record that traces the ownership or custody and transactions of a product as
+     * it moves among trading partners.
+     */
+    readonly Pedigree: "pedigree";
+    /**
+     * A document/message that specifies details for goods and services ordered under
+     * agreed conditions.
+     */
+    readonly Po: "po";
+    /**
+     * A document that provides confirmation from an external supplier to the request
+     * of a purchaser to deliver a specified quantity/service.
+     */
+    readonly Poc: "poc";
+    /**
+     * An organisation-internal document or message issued by a producer that
+     * initiates a manufacturing process of goods.
+     */
+    readonly Prodorder: "prodorder";
+    /**
+     * A document/message that lets the receiver inform the shipper of actual goods
+     * received compared to what was advised.
+     */
+    readonly Recadv: "recadv";
+    /**
+     * A document issued by the seller that authorises a buyer to return merchandise
+     * for credit determination.
+     */
+    readonly Rma: "rma";
+    /**
+     * A document that provides a formal specification of a sequence of instructions
+     * for verifying one or several criteria.
+     */
+    readonly Testprd: "testprd";
+    /**
+     * A document that includes the outcome of the execution of a given test
+     * procedure.
+     */
+    readonly Testres: "testres";
+    /**
+     * Event ID URI(s) of event(s) provided by an upstream supplier, such as packing
+     * and shipping events.
+     */
+    readonly Upevt: "upevt";
+};
+/**
+ * Supported EPCIS 2.0 `bizTransaction-type` values.
+ */
+export type EpcisBizTransactionTypes = (typeof EpcisBizTransactionTypes)[keyof typeof EpcisBizTransactionTypes];

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

@@ -0,0 +1,76 @@
+/**
+ * Supported EPCIS 2.0 `component` values.
+ */
+export declare const EpcisComponentTypes: {
+    /**
+     * Component or projection along the x axis in Cartesian coordinates (X, Y, Z).
+     */
+    readonly X: "x";
+    /**
+     * Component or projection along the y axis in Cartesian coordinates (X, Y, Z).
+     */
+    readonly Y: "y";
+    /**
+     * Component or projection along the z axis in Cartesian coordinates (X, Y, Z).
+     */
+    readonly Z: "z";
+    /**
+     * Radial distance from the cylindrical axis in a cylindrical polar coordinate
+     * system.
+     */
+    readonly AxialDistance: "axial_distance";
+    /**
+     * Angle measured in the XY plane, anticlockwise from the X axis to the plane
+     * containing the vector and the Z axis.
+     */
+    readonly Azimuth: "azimuth";
+    /**
+     * Height parallel to the cylindrical axis in a cylindrical polar coordinate
+     * system.
+     */
+    readonly Height: "height";
+    /**
+     * Radial distance from the centre of a sphere in a spherical polar coordinate
+     * system.
+     */
+    readonly SphericalRadius: "spherical_radius";
+    /**
+     * Angle measured from the Z axis to the vector in a spherical polar coordinate
+     * system.
+     */
+    readonly PolarAngle: "polar_angle";
+    /**
+     * Angle measured from the XY plane to the vector in a spherical polar coordinate
+     * system.
+     */
+    readonly ElevationAngle: "elevation_angle";
+    /**
+     * Component or projection along an east-pointing axis in a geographic Cartesian
+     * coordinate system.
+     */
+    readonly Easting: "easting";
+    /**
+     * Component or projection along a north-pointing axis in a geographic Cartesian
+     * coordinate system.
+     */
+    readonly Northing: "northing";
+    /**
+     * Angle of elevation from the equatorial plane in a geographic coordinate
+     * system.
+     */
+    readonly Latitude: "latitude";
+    /**
+     * Angle, measured within the equatorial plane, east of the prime meridian in a
+     * geographic coordinate system.
+     */
+    readonly Longitude: "longitude";
+    /**
+     * Height above a defined surface (such as mean sea level) in a geographic
+     * coordinate system.
+     */
+    readonly Altitude: "altitude";
+};
+/**
+ * Supported EPCIS 2.0 `component` values.
+ */
+export type EpcisComponentTypes = (typeof EpcisComponentTypes)[keyof typeof EpcisComponentTypes];

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

@@ -0,0 +1,15 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { EpcisContexts } from "./epcisContexts.js";
+/**
+ * Allowed shapes for an EPCIS 2.0 JSON-LD `@context`, anchored on the GS1
+ * context root and optionally augmented with custom entries.
+ */
+export type EpcisContextType = typeof EpcisContexts.Namespace | [typeof EpcisContexts.Namespace] | [
+    ...IJsonLdContextDefinitionElement[],
+    typeof EpcisContexts.Namespace,
+    IJsonLdContextDefinitionElement
+] | [
+    IJsonLdContextDefinitionElement,
+    typeof EpcisContexts.Namespace,
+    ...IJsonLdContextDefinitionElement[]
+];

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

@@ -0,0 +1,17 @@
+/**
+ * Canonical EPCIS JSON-LD context IRIs as defined by GS1.
+ */
+export declare const EpcisContexts: {
+    /**
+     * The namespace for the objects.
+     */
+    readonly Namespace: "https://ref.gs1.org/epcis/";
+    /**
+     * The JSON-LD Context URL.
+     */
+    readonly JsonLdContext: "https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld";
+};
+/**
+ * Canonical EPCIS JSON-LD context IRIs as defined by GS1.
+ */
+export type EpcisContexts = (typeof EpcisContexts)[keyof typeof EpcisContexts];

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;