IdParser.Core 1.0.0-beta5

This is a prerelease version of IdParser.Core.
There is a newer version of this package available.
See the version list below for details.
dotnet add package IdParser.Core --version 1.0.0-beta5
                    
NuGet\Install-Package IdParser.Core -Version 1.0.0-beta5
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IdParser.Core" Version="1.0.0-beta5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="IdParser.Core" Version="1.0.0-beta5" />
                    
Directory.Packages.props
<PackageReference Include="IdParser.Core" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add IdParser.Core --version 1.0.0-beta5
                    
#r "nuget: IdParser.Core, 1.0.0-beta5"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package IdParser.Core@1.0.0-beta5
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=IdParser.Core&version=1.0.0-beta5&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=IdParser.Core&version=1.0.0-beta5&prerelease
                    
Install as a Cake Tool

IdParser.Core

publish NuGet

This is a fork of Connor O'Shea's IdParser library. Big thanks to him for all of his work.

The main changes I made are:

  • Dropped support for .NET Framework. If you need that, please use the original IdParser.
  • Supports only .NET 6 and above. If you need support for earlier versions of .NET/.NET Core, please use the original IdParser.
  • The parser classes are now static and no longer instantiated by Activator.CreateInstance. This reduced memory allocations per call considerably, and also sped things up.
  • The Abbreviation, Country, and Description attribute values are now cached so that we don't have to repeatedly use reflection to get their values.
  • Unhandled parsing exceptions are now rethrown, regardless of what the caller passes for the validation level (None or Strict).
  • Where possible, modernized the code base to use newer framework and language features, such as Span<T>.
  • The return value of Parse is now an object that returns both the ID card and a collection of any unknown element Ids.
  • Parse now accepts an optional TextWriter parameter. When not null, the library will log to the TextWriter.

The original README follows, slightly modified to match this updated version of the library.

ID Parser

ID Parser can be used to parse AAMVA-compliant driver's licenses and ID cards into objects that you can work with. More information on the versions of the AAMVA standard can be found here. More information on the D20 Data Dictionary can be found here.

Usage

  1. Include the using
using IdParser.Core;
  1. Then you're off to the races!
var parseResult = Barcode.Parse(barcode);
Console.WriteLine(parseResult.Card.Address.StreetLine1); // "123 NORTH STATE ST."
Console.WriteLine(parseResult.Card.IssuerIdentificationNumber.GetDescriptionOrDefault()); // "New York"

if (parseResult.Card is DriversLicense license)
{
    Console.WriteLine(license.Jurisdiction.VehicleClass); // "C"
}

More Examples

Take a look at the unit test project for more examples and usage.

Client

The IdParser.Core.Client project is a handy GUI application to help test and verify that an ID will be parsed correctly. The app works with both OPOS and HID keyboard emulation scanners.

alternate text is missing from this package README image

FAQ

  • I can't build IdParser.Core.Client. It's missing a required dependency. You need to have Microsoft POS for .NET installed. The Microsoft.PointOfService dll is GAC'd and will allow you to build and run the client app.

  • The Height class has the wrong TotalInches or Centimeters. The AAMVA standard has no decimal places in the height subfile record. As a result, the conversion between inches and centimeters will be off.

  • The library is throwing ArgumentExcpetions for every barcode I'm passing in. By default, all barcodes are parsed using the Strict validation level. All barcodes are expected to adhere exactly to the AAMVA standard as defined in the PDFs for parsing to succeed. This is the recommended level for scanners using OPOS. However, if HID keyboard emulation is used, especially when scanning using a web browser, the expected data can become malformed. You can try using the None validation level, however this is not guaranteed to work in all cases. Data elements may be skipped and exceptions may still be thrown.

Find IDs Not in Tests Regex

DAJ(?!(AL|AR|AZ|AK|CA|CO|CT|DE|FL|GA|HI|IA|ID|IL|IN|KS|KY|LA|MA|MD|ME|MI|MN|MO|MS|MT|NC|ND|NH|NJ|NM|NV|NY|OH|ON|OR|PA|PE|PR|RI|SC|TN|TX|UT|VA|VT|WA|WI|WV|QC|OK|NS|NE|NB|AB|SD|DC))[A-Z]+
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.1.0 571 11/20/2024
3.0.0 869 3/28/2024
3.0.0-beta3 138 3/21/2024
3.0.0-beta2 100 3/21/2024
3.0.0-beta1 117 3/12/2024
3.0.0-alpha2 110 3/12/2024
3.0.0-alpha1 121 3/7/2024
2.0.0 192 3/7/2024
2.0.0-alpha5 206 1/10/2024
2.0.0-alpha4 113 1/10/2024
2.0.0-alpha3 100 1/10/2024
2.0.0-alpha2 147 12/23/2023
2.0.0-alpha1 163 12/16/2023
1.1.0 306 12/14/2023
1.0.4 230 12/5/2023
1.0.3 246 10/26/2023
1.0.2 211 9/27/2023
1.0.1 195 9/27/2023
1.0.0 185 9/20/2023
1.0.0-beta8 178 9/8/2023
1.0.0-beta7 165 9/8/2023
1.0.0-beta6 168 9/8/2023
1.0.0-beta5 161 9/8/2023
1.0.0-beta4 180 8/8/2023
1.0.0-beta3 180 7/24/2023
1.0.0-beta2 184 7/23/2023
1.0.0-beta1 171 7/22/2023
1.0.0-alpha9 181 7/22/2023
1.0.0-alpha8 174 7/22/2023
1.0.0-alpha7 193 7/22/2023
1.0.0-alpha6 184 7/22/2023
1.0.0-alpha5 184 7/22/2023
1.0.0-alpha4 178 7/22/2023
1.0.0-alpha3 174 7/22/2023
1.0.0-alpha2 166 7/22/2023
1.0.0-alpha11 175 7/22/2023
1.0.0-alpha10 173 7/22/2023
1.0.0-alpha1 169 7/22/2023