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

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,15 @@
+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 {
+    /**
+     * Vocabulary type.
+     */
+    type: string;
+    /**
+     * List of vocabulary elements.
+     */
+    vocabularyElementList?: IEpcisVocabularyElement[];
+}

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

@@ -0,0 +1,20 @@
+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 {
+    /**
+     * Element id.
+     */
+    id: string;
+    /**
+     * Attributes.
+     */
+    attributes?: IEpcisAttribute[];
+    /**
+     * Children.
+     */
+    children?: string[];
+}

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

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

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,8 @@
+import type { SingleOccurrenceArray } from "@twin.org/core";
+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.Context | SingleOccurrenceArray<IJsonLdContextDefinitionElement, typeof EpcisContexts.Context>;

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

@@ -0,0 +1,27 @@
+/**
+ * Canonical EPCIS JSON-LD context IRIs as defined by GS1.
+ */
+export declare const EpcisContexts: {
+    /**
+     * The canonical RDF namespace URI.
+     */
+    readonly Namespace: "https://ref.gs1.org/epcis/";
+    /**
+     * The value to use in JSON-LD context.
+     * Note: Context differs from Namespace (no trailing slash) as per GS1 EPCIS standard specification.
+     * The EPCIS JSON-LD context URL format does not include a trailing slash.
+     */
+    readonly Context: "https://ref.gs1.org/epcis";
+    /**
+     * The JSON-LD Context URL.
+     */
+    readonly JsonLdContext: "https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld";
+    /**
+     * The namespace location of the hosted version of the JSON Schema.
+     */
+    readonly JsonSchemaNamespace: "https://schema.twindev.org/gs1/";
+};
+/**
+ * Canonical EPCIS JSON-LD context IRIs as defined by GS1.
+ */
+export type EpcisContexts = (typeof EpcisContexts)[keyof typeof EpcisContexts];