OpenXpdUuidLib 1.0.0

open-xpd-uuid-lib (C# Version)

A library of common functions used when creating and managing open-xpd-uuid,
a common, globally-unique name space (uuid) for Product Declarations, including HPDs and EPDs,
to help users find all environmental and health information related to a single product.

Open xPD UUID (short readable GUIDs)

open-xpd-uuid is a string that consists of 8 or 10 (8+2) alphanumeric characters and any number of dashes.
Examples:

• 123ABCED
• 123ABCEDAR
• ASB21M01
• avbDK93S
• -AB-11-cc-Ll---

Canonical GUIDs

GUIDs consisting of the following characters are called canonical:
1234567890ABCDEFGHJKMNPRQRSTUVWXYZ
(L and O are not included).

Examples:

• 12345678
• ABCDEFG1
• 123ABCEDAR

Checksums

• GUIDs that consist of 10 characters represent an 8-character GUID with an appended 2-character checksum.
• Checksums allow detection of single-character entry errors, character swaps, and most other errors.

Character Treatment

• - or dash → ignored
• L, l, I, i → treated as 1
• O, o → treated as 0 (zero)

Install

Add the package via NuGet:

dotnet add package OpenXpdUuidLib

Or edit your .csproj:

<ItemGroup>
  <PackageReference Include="OpenXpdUuidLib" Version="1.0.0" />
</ItemGroup>

Supported Versions

• .NET Standard 2.0 (for compatibility with .NET Framework, Xamarin, and older platforms)
• .NET 6.0 and higher
• Tested on .NET 8

Usage

Generate short readable GUID

using OpenXpdUuidLib.OpenXpdUuid;

var guid = OpenXpdUuid.Generate();
Console.WriteLine(guid); // e.g. "JKGEE5PN"

Generate short readable GUID with prefix

var guid = OpenXpdUuid.Generate("CQD");
Console.WriteLine(guid); // e.g. "CQD55PG0"

Sanitize short readable GUIDs

Use Sanitize to replace ambiguous characters (0, o, O, 1, L, l, I, i) with correct ones
and remove dashes (-).

var guid = OpenXpdUuid.Sanitize("as-b2-lm-oL");
Console.WriteLine(guid); // "ASB21M01"

Validate short readable GUID

Validate ensures the GUID is correct.
It only accepts canonical GUIDs. Use Sanitize first if needed.

try
{
    OpenXpdUuid.Validate("ASB21M01");
    Console.WriteLine("Valid GUID!");
}
catch (GuidValidationException ex)
{
    Console.WriteLine(ex.Message);
}

Generate and use checksum

var guid = OpenXpdUuid.Generate();   // "JKGEE5PN"
var checksum = OpenXpdUuid.Checksum(guid); // "ME"
var guidWithChecksum = guid + checksum;    // "JKGEE5PNME"

Console.WriteLine($"cqd.io/e/{guidWithChecksum}"); 
// "cqd.io/e/JKGEE5PNME"