StrongTypeIdGenerator.Json 1.0.1

StrongTypeIdGenerator

StrongTypeIdGenerator is a C# source generator for strongly typed identifiers. It helps prevent primitive ID mix-ups by generating domain-specific ID types for string, Guid, and combined (composite) keys.

Why this library

• Removes boilerplate for strongly typed IDs.
• Prevents accidental mixing of identifiers across boundaries.
• Keeps validation close to the ID type via CheckValue hooks.
• Supports factory-oriented design with optional private constructors.
• Works with System.ComponentModel.TypeConverter out of the box.

Design decisions:

• Reference types by design. This project prioritizes invariant safety and controlled construction over minimizing allocations, so invalid IDs are harder to create and propagate.
• Built-in precondition hooks. If an ID class defines CheckValue(...), the method is called from the generated constructor and can validate or normalize input.
• Serializer-agnostic core. The main package only relies on System.ComponentModel.TypeConverter and has no direct dependency on System.Text.Json, Newtonsoft.Json, or EF Core converters.
• netstandard2.0-friendly usage. IDs can live in netstandard2.0 libraries without extra serialization dependencies. For System.Text.Json, use the optional StrongTypeIdGenerator.Json package.
• First-class composite identifiers. CombinedId exists for real-world composite business keys, avoiding ad-hoc wrapper implementations.

Main features

• StringId and GuidId generation with value semantics.
• CombinedId generation for composite identifiers.
• Generated equality, comparison, formatting, and operators.
• Optional custom value property name for scalar identifiers.
• Optional constructor privacy (GenerateConstructorPrivate = true).
• Optional System.Text.Json integration package.

Quick start

Install package:

dotnet add package StrongTypeIdGenerator

Define identifiers:

using StrongTypeIdGenerator;

[StringId]
public sealed partial class OrderId
{
}

[GuidId]
public sealed partial class CustomerId
{
}

[CombinedId(typeof(CustomerId), "CustomerId", typeof(OrderId), "OrderId")]
public sealed partial class CustomerOrderId
{
}

<details> <summary>Generated structure (example for <code>OrderId</code>)</summary>

[TypeConverter(typeof(OrderIdConverter))]
public sealed partial class OrderId : ITypedIdentifier<OrderId, string>
{
	public OrderId(string value) { ... }
	public static OrderId Unspecified { get; } = ...;

	public string Value { get; }

	public static implicit operator OrderId?(string? value) { ... }
	public static implicit operator string?(OrderId? value) { ... }

	public bool Equals(OrderId? other) { ... }
	public int CompareTo(OrderId? other) { ... }
	public override bool Equals(object? obj) { ... }
	public override int GetHashCode() { ... }
	public override string ToString() { ... }
	public string ToString(string? format, IFormatProvider? provider) { ... }

	public static bool operator ==(OrderId left, OrderId right) { ... }
	public static bool operator !=(OrderId left, OrderId right) { ... }
	public static bool operator <(OrderId left, OrderId right) { ... }
	public static bool operator <=(OrderId left, OrderId right) { ... }
	public static bool operator >(OrderId left, OrderId right) { ... }
	public static bool operator >=(OrderId left, OrderId right) { ... }

	private sealed partial class OrderIdConverter : TypeToStringConverter<OrderId>
	{
		protected override string? InternalConvertToString(OrderId value) { ... }
		protected override OrderId? InternalConvertFromString(string value) { ... }
	}
}

</details>

The generator creates immutable reference-type identifiers with:

• constructor (public or private based on attribute options)
• typed value/component properties
• Unspecified
• Equals, GetHashCode, comparison operators
• ToString and format overloads
• implicit conversion operators
• nested TypeConverter

Optional JSON integration

For System.Text.Json, install:

dotnet add package StrongTypeIdGenerator.Json

Configure serializer:

using StrongTypeIdGenerator.Json;

var options = new JsonSerializerOptions();
options.Converters.Add(new TypeConverterJsonConverterFactory());

Documentation

Detailed docs are in the docs folder:

• Docs Index
• Getting Started
• String IDs
• Guid IDs
• Combined IDs
• Custom Validation (CheckValue)
• Custom Value Property Name
• Private Constructors and Factories
• TypeConverter and System.Text.Json
• Design Decisions
• FAQ

Acknowledgements

Inspired by StronglyTypedId.