@twin.org/standards-gs1 0.0.1-next.21

package/dist/types/dataTypes/gs1DataTypes.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Handle all the data types for GS1.
+ * Vocabulary https://www.gs1.org/voc .
+ */
+export declare class Gs1DataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/entities/gs1Location.d.ts

@@ -0,0 +1,69 @@
+import type { SubSiteAttributes } from "../models/gs1/subSiteAttributes";
+import type { SubSiteTypes } from "../models/gs1/subSiteTypes";
+/**
+ * Interface describing a GS1 Location master data.
+ * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
+ * Section 10.2 .
+ */
+export declare class Gs1Location {
+    /**
+     * The GS1 sgln identifier.
+     */
+    id: string;
+    /**
+     * Identifies the site in which the location is contained.
+     */
+    site?: string;
+    /**
+     * Sub site type describes the primary business function of the sub site location.
+     */
+    sst?: SubSiteTypes;
+    /**
+     * Sub site attribute further qualifies the business function of the sub site location.
+     */
+    ssa?: SubSiteAttributes;
+    /**
+     * Sub site detail provides additional proprietary information.
+     */
+    ssd?: string;
+    /**
+     * The name of the location.
+     */
+    name?: string;
+    /**
+     * The street address line 1.
+     */
+    streetAddressOne?: string;
+    /**
+     * The street address line 2.
+     */
+    streetAddressTwo?: string;
+    /**
+     * The street address line 3.
+     */
+    streetAddressThree?: string;
+    /**
+     * City.
+     */
+    city?: string;
+    /**
+     * State.
+     */
+    state?: string;
+    /**
+     * Postal Code.
+     */
+    postalCode?: string;
+    /**
+     * Country Code The ISO 3166-1 alpha-2 code specifying the country for the address.
+     */
+    countryCode?: string;
+    /**
+     * The latitude of the location in degrees.
+     */
+    latitude?: number;
+    /**
+     * The longitude of the location in degrees.
+     */
+    longitude?: number;
+}

package/dist/types/identifiers/gs1Identifiers.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all identifier types for GS1.
+ */
+export declare class Gs1Identifiers {
+    /**
+     * Register all the identifiers.
+     */
+    static registerIdentifiers(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,34 @@
+export * from "./dataTypes/gs1DataTypes";
+export * from "./entities/gs1Location";
+export * from "./identifiers/gs1Identifiers";
+export * from "./models/epc/IEPCClassUri";
+export * from "./models/epcis20/actionTypes";
+export * from "./models/epcis20/bizStepTypes";
+export * from "./models/epcis20/dispositionTypes";
+export * from "./models/epcis20/epcisErrorTypes";
+export * from "./models/epcis20/epcisEventUnionType";
+export * from "./models/epcis20/eventTypes";
+export * from "./models/epcis20/IAggregationEvent";
+export * from "./models/epcis20/IAssociationEvent";
+export * from "./models/epcis20/IBizTransaction";
+export * from "./models/epcis20/IDestination";
+export * from "./models/epcis20/IEpcisDocument";
+export * from "./models/epcis20/IEpcisEvent";
+export * from "./models/epcis20/IEpcisEventDetails";
+export * from "./models/epcis20/IEpcisQuery";
+export * from "./models/epcis20/IEpcisQueryDocument";
+export * from "./models/epcis20/IObjectEvent";
+export * from "./models/epcis20/IQuantity";
+export * from "./models/epcis20/ISensorElement";
+export * from "./models/epcis20/ISensorMetadata";
+export * from "./models/epcis20/ISensorReport";
+export * from "./models/epcis20/ISimpleLocation";
+export * from "./models/epcis20/ISource";
+export * from "./models/gs1/gs1IdentifierTypes";
+export * from "./models/gs1/gs1IdTypes";
+export * from "./models/gs1/gs1Types";
+export * from "./models/gs1/subSiteAttributes";
+export * from "./models/gs1/subSiteTypes";
+export * from "./utils/gs1IdentifiersValidation";
+export * from "./utils/gs1Is";
+export * from "./utils/gs1Validation";

package/dist/types/models/epc/IEPCClassUri.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Interface for EPC class URI.
+ */
+export interface IEPCClassUri {
+    /**
+     * The company prefix.
+     */
+    companyPrefix: string;
+    /**
+     * The item reference number.
+     */
+    itemRefAndIndicator: string;
+    /**
+     * The batch/lot.
+     */
+    lot: string;
+}

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

@@ -0,0 +1,10 @@
+import type { IBaseAggregationEvent } from "./IBaseAggregationEvent";
+/**
+ * Describes an AggregationEvent.
+ */
+export interface IAggregationEvent extends IBaseAggregationEvent {
+    /**
+     * The type.
+     */
+    type: "AggregationEvent";
+}

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

@@ -0,0 +1,10 @@
+import type { IBaseAggregationEvent } from "./IBaseAggregationEvent";
+/**
+ * Association Event.
+ */
+export interface IAssociationEvent extends IBaseAggregationEvent {
+    /**
+     * Type.
+     */
+    type: "AssociationEvent";
+}

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

@@ -0,0 +1,19 @@
+import type { IEpcisEventDetails } from "./IEpcisEventDetails";
+import type { IQuantity } from "./IQuantity";
+/**
+ * Describes an AggregationEvent.
+ */
+export interface IBaseAggregationEvent extends IEpcisEventDetails {
+    /**
+     * Parent is only optional when action is OBSERVE.
+     */
+    parentID?: string;
+    /**
+     * The children EPC which can be empty when action is DELETE.
+     */
+    childEPCs?: string[];
+    /**
+     * Quantity in case of class-level event visibility data.
+     */
+    childQuantityList?: IQuantity[];
+}

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

@@ -0,0 +1,13 @@
+/**
+ * EPCIS Biz Transaction.
+ */
+export interface IBizTransaction {
+    /**
+     * Type.
+     */
+    type: string;
+    /**
+     * The transaction.
+     */
+    bizTransaction: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * EPCIS Destination.
+ */
+export interface IDestination {
+    /**
+     * Type.
+     */
+    type: string;
+    /**
+     * The destination.
+     */
+    destination: string;
+}

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

@@ -0,0 +1,28 @@
+import type { IJsonLdContextDefinition } from "@twin.org/data-json-ld";
+import type { IEpcisEvent } from "./IEpcisEvent";
+/**
+ * EPCIS Document.
+ */
+export interface IEpcisDocument {
+    /**
+     * The @context.
+     */
+    "@context": IJsonLdContextDefinition;
+    /**
+     * The JSON-LD document id.
+     */
+    id?: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: "EPCISDocument";
+    /**
+     * The EPCIS Body.
+     */
+    epcisBody: {
+        /**
+         * The list of events.
+         */
+        eventList: IEpcisEvent[];
+    };
+}

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

@@ -0,0 +1,44 @@
+import type { IJsonLdContextDefinition } from "@twin.org/data-json-ld";
+import type { IDestination } from "./IDestination";
+import type { ISource } from "./ISource";
+/**
+ * EPCIS Event.
+ */
+export interface IEpcisEvent {
+    /**
+     * JSON-LD @context.
+     */
+    "@context"?: IJsonLdContextDefinition;
+    /**
+     * UUID of the event.
+     */
+    id?: string;
+    /**
+     * The id of the event. Marked here as optional as we usually won't store it on Tangle.
+     */
+    eventID?: string;
+    /**
+     * Type of Event.
+     */
+    type: string;
+    /**
+     * Timestamp in UTC.
+     */
+    eventTime: string;
+    /**
+     * Timezone offset. Useful if we want to represent timestamp in local timezone.
+     */
+    eventTimeZoneOffset: string;
+    /**
+     * When the event was recorded. It will be automatically generated.
+     */
+    recordTime?: string;
+    /**
+     * Source list. Semantics according to EPCIS standard.
+     */
+    sourceList?: ISource[];
+    /**
+     * Destination list. Semantics according to EPCIS standard.
+     */
+    destinationList?: IDestination[];
+}

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

@@ -0,0 +1,35 @@
+import type { ActionTypes } from "./actionTypes";
+import type { BizStepTypes } from "./bizStepTypes";
+import type { DispositionTypes } from "./dispositionTypes";
+import type { IBizTransaction } from "./IBizTransaction";
+import type { IEpcisEvent } from "./IEpcisEvent";
+import type { ISimpleLocation } from "./ISimpleLocation";
+/**
+ * EPCIS Event Details.
+ */
+export interface IEpcisEventDetails extends IEpcisEvent {
+    /**
+     * Action: ADD, OBSERVE, DELETE.
+     */
+    action: ActionTypes;
+    /**
+     * The location of reading point.
+     */
+    readPoint?: ISimpleLocation;
+    /**
+     * The biz location where the item ends up.
+     */
+    bizLocation?: ISimpleLocation;
+    /**
+     * The business step as per EPCIS.
+     */
+    bizStep?: BizStepTypes;
+    /**
+     * The disposition as per EPCIS.
+     */
+    disposition?: DispositionTypes;
+    /**
+     * The list of related business transactions.
+     */
+    bizTransactionList?: IBizTransaction[];
+}

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

@@ -0,0 +1,6 @@
+/**
+ * EPCIS Query type.
+ */
+export interface IEpcisQuery {
+    [key: string]: string;
+}

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

@@ -0,0 +1,54 @@
+import type { IJsonLdContextDefinition } from "@twin.org/data-json-ld";
+import type { IEpcisEvent } from "./IEpcisEvent";
+/**
+ * EPCIS Query Document.
+ */
+export interface IEpcisQueryDocument {
+    /**
+     * The @context.
+     */
+    "@context": IJsonLdContextDefinition;
+    /**
+     * The JSON-LD document id.
+     */
+    id?: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: string;
+    /**
+     * Schema version.
+     */
+    schemaVersion?: string;
+    /**
+     * Creation Date.
+     */
+    creationDate?: string;
+    /**
+     * The EPCIS Body.
+     */
+    epcisBody: {
+        /**
+         * The results of the query.
+         */
+        queryResults: {
+            /**
+             * The concerned subscription.
+             */
+            subscriptionID?: string;
+            /**
+             * The concerned query.
+             */
+            queryName: string;
+            /**
+             * And now the results.
+             */
+            resultsBody: {
+                /**
+                 * The list of events.
+                 */
+                eventList: IEpcisEvent[];
+            };
+        };
+    };
+}

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

@@ -0,0 +1,25 @@
+import type { IEpcisEventDetails } from "./IEpcisEventDetails";
+import type { IQuantity } from "./IQuantity";
+import type { ISensorElement } from "./ISensorElement";
+/**
+ * Defines an EPCIS 2.0 Object Event.
+ *
+ */
+export interface IObjectEvent extends IEpcisEventDetails {
+    /**
+     * Fixed to ObjectEvent.
+     */
+    type: "ObjectEvent";
+    /**
+     * List of EPCs involved.
+     */
+    epcList: string[];
+    /**
+     * Quantity in case of class-level event visibility data.
+     */
+    quantityList?: IQuantity[];
+    /**
+     * Sensor element list.
+     */
+    sensorElementList?: ISensorElement[];
+}

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

@@ -0,0 +1,13 @@
+/**
+ * EPCIS Quantity.
+ */
+export interface IQuantity {
+    /**
+     * EPC Class.
+     */
+    epcClass: string;
+    /**
+     * Quantity.
+     */
+    quantity: number;
+}

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

@@ -0,0 +1,15 @@
+import type { ISensorMetadata } from "./ISensorMetadata";
+import type { ISensorReport } from "./ISensorReport";
+/**
+ * EPCIS SensorElement.
+ */
+export interface ISensorElement {
+    /**
+     * Sensor metadata.
+     */
+    sensorMetadata?: ISensorMetadata;
+    /**
+     * Sensor report.
+     */
+    sensorReport: ISensorReport[];
+}

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

@@ -0,0 +1,21 @@
+/**
+ * EPCIS Sensor metadata.
+ */
+export interface ISensorMetadata {
+    /**
+     * Time.
+     */
+    time: string;
+    /**
+     * Device ID.
+     */
+    deviceID: string;
+    /**
+     * Device Metadata.
+     */
+    deviceMetadata: string;
+    /**
+     * Raw data.
+     */
+    rawData: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * EPCIS SensorReport.
+ */
+export interface ISensorReport {
+    /**
+     * Type.
+     */
+    type: string;
+    /**
+     * Value.
+     */
+    value: number;
+    /**
+     * Unit of measurement.
+     */
+    uom: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * EPCIS Location.
+ */
+export interface ISimpleLocation {
+    /**
+     * The id.
+     */
+    id: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * EPCIS Biz Transaction.
+ */
+export interface ISource {
+    /**
+     * Type.
+     */
+    type: string;
+    /**
+     * The source.
+     */
+    source: string;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * EPCIS 2.0 action types.
+ */
+export declare const ActionTypes: {
+    /**
+     * ADD action.
+     */
+    readonly Add: "ADD";
+    /**
+     * OBSERVE action.
+     */
+    readonly Observe: "OBSERVE";
+    /**
+     * DELETE action.
+     */
+    readonly Delete: "DELETE";
+};
+/**
+ * EPCIS 2.0 action types.
+ */
+export type ActionTypes = (typeof ActionTypes)[keyof typeof ActionTypes];

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

@@ -0,0 +1,52 @@
+/**
+ * Supported EPCIS 2.0 bizStep.
+ *
+ * See EPCIS CVB specification for details.
+ */
+export declare const BizStepTypes: {
+    readonly Accepting: "accepting";
+    readonly Arriving: "arriving";
+    readonly Assembling: "assembling";
+    readonly Collecting: "collecting";
+    readonly Commissioning: "commissioning";
+    readonly Consigning: "consigning";
+    readonly CreatingClassInstance: "creating_class_instance";
+    readonly CycleCounting: "cycle_counting";
+    readonly Decommissioning: "decommissioning";
+    readonly Departing: "departing";
+    readonly Destroying: "destroying";
+    readonly Disassembling: "disassembling";
+    readonly Dispensing: "dispensing";
+    readonly Encoding: "encoding";
+    readonly EnteringExiting: "entering_exiting";
+    readonly Holding: "holding";
+    readonly Inspecting: "inspecting";
+    readonly Installing: "installing";
+    readonly Killing: "killing";
+    readonly Loading: "loading";
+    readonly Other: "other";
+    readonly Packing: "packing";
+    readonly Picking: "picking";
+    readonly Receiving: "receiving";
+    readonly Removing: "removing";
+    readonly Repackaging: "repackaging";
+    readonly Repairing: "repairing";
+    readonly Replacing: "replacing";
+    readonly Reserving: "reserving";
+    readonly RetailSelling: "retail_selling";
+    readonly Shipping: "shipping";
+    readonly StagingOutbound: "staging_outbound";
+    readonly StockTaking: "stock_taking";
+    readonly Stocking: "stocking";
+    readonly Storing: "storing";
+    readonly Transporting: "transporting";
+    readonly Unloading: "unloading";
+    readonly Unpacking: "unpacking";
+    readonly VoidShipping: "void_shipping";
+    readonly SensorReporting: "sensor_reporting";
+    readonly Sampling: "sampling";
+};
+/**
+ * EPCIS 2.0 action types.
+ */
+export type BizStepTypes = (typeof BizStepTypes)[keyof typeof BizStepTypes];

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

@@ -0,0 +1,44 @@
+/**
+ * EPCIS 2.0 disposition types.
+ *
+ * See EPCIS CVB for more details.
+ */
+export declare const DispositionTypes: {
+    readonly Active: "active";
+    readonly ContainerClosed: "container_closed";
+    readonly Damaged: "damaged";
+    readonly Destroyed: "destroyed";
+    readonly Dispensed: "dispensed";
+    readonly Disposed: "disposed";
+    readonly Encoded: "encoded";
+    readonly Expired: "expired";
+    readonly InProgress: "in_progress";
+    readonly InTransit: "in_transit";
+    readonly Inactive: "inactive";
+    readonly NoPedigreeMatch: "no_pedigree_match";
+    readonly NonSellableOther: "non_sellable_other";
+    readonly PartiallyDispensed: "partially_dispensed";
+    readonly Recalled: "recalled";
+    readonly Reserved: "reserved";
+    readonly RetailSold: "retail_sold";
+    readonly Returned: "returned";
+    readonly SellableAccessible: "sellable_accessible";
+    readonly SellableNotAccessible: "sellable_not_accessible";
+    readonly Stolen: "stolen";
+    readonly Unknown: "unknown";
+    readonly Available: "available";
+    readonly CompletenessVerified: "completeness_verified";
+    readonly CompletenessInferred: "completeness_inferred";
+    readonly Conformant: "conformant";
+    readonly ContainerOpen: "container_open";
+    readonly MismatchInstance: "mismatch_instance";
+    readonly MismatchClass: "mismatch_class";
+    readonly MismatchQuantity: "mismatch_quantity";
+    readonly NeedsReplacement: "needs_replacement";
+    readonly NonConformant: "non_conformant";
+    readonly Unavailable: "unavailable";
+};
+/**
+ * EPCIS 2.0 disposition types.
+ */
+export type DispositionTypes = (typeof DispositionTypes)[keyof typeof DispositionTypes];

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

@@ -0,0 +1,11 @@
+/**
+ * EPCIS Error types.
+ */
+export declare const EpcisErrorTypes: {
+    readonly ValidationFailed: "epcisException:ValidationException";
+    readonly NoSuchResource: "epcisException:NoSuchResourceException";
+};
+/**
+ * EPCIS Error types.
+ */
+export type EpcisErrorTypes = (typeof EpcisErrorTypes)[keyof typeof EpcisErrorTypes];

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

@@ -0,0 +1,7 @@
+import type { IAggregationEvent } from "./IAggregationEvent";
+import type { IAssociationEvent } from "./IAssociationEvent";
+import type { IObjectEvent } from "./IObjectEvent";
+/**
+ * The type that subsumes an EPCIS Event.
+ */
+export type EpcisEventUnionType = IObjectEvent | IAssociationEvent | IAggregationEvent;