Module GS1

GS1 Package

Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

⚠️ This software is in beta, with production release is scheduled for 2024Q4. To follow the status of that and other projects, go to the AIDC Toolkit projects page.

The AIDC Toolkit gs1 package provides functionality related to the GS1 identification system:

  • Check digit calculation and validation for GS1 identification keys and price/weight encoding
  • Check character pair calculation and validation for GS1 identification keys
  • GS1 identification key validation
  • GS1 identification key creation

A comprehensive overview of this package may be found in the AIDC Toolkit documentation.

Enumerations

IdentificationKeyType
PrefixType
ContentCharacterSet
LeaderType
GTINType
GTINLevel

Type Aliases

GS1LocaleStrings

Interfaces

IdentificationKeyValidation
IdentificationKeyValidator
NumericIdentificationKeyValidator
NonNumericIdentificationKeyValidation
IdentificationKeyCreator
NumericIdentificationKeyCreator

Classes

GTINValidator
NonGTINNumericIdentificationKeyValidator
SerializableNumericIdentificationKeyValidator
NonNumericIdentificationKeyValidator
GTINCreator
NonGTINNumericIdentificationKeyCreator
SerializableNumericIdentificationKeyCreator
NonNumericIdentificationKeyCreator
PrefixManager

Variables

gs1NS
gs1Resources
i18nextGS1
AI82_CREATOR
AI39_CREATOR
GTIN13_VALIDATOR
GTIN12_VALIDATOR
GTIN8_VALIDATOR
GTIN_VALIDATORS
GLN_VALIDATOR
SSCC_VALIDATOR
GRAI_VALIDATOR
GIAI_VALIDATOR
GSRN_VALIDATOR
GDTI_VALIDATOR
GINC_VALIDATOR
GSIN_VALIDATOR
GCN_VALIDATOR
CPID_VALIDATOR
GMN_VALIDATOR

Functions

i18nGS1Init
checkDigitSum
checkDigit
hasValidCheckDigit
fourDigitPriceWeightCheckDigit
fiveDigitPriceWeightCheckDigit
checkCharacterPair
hasValidCheckCharacterPair