Kanject.Core.Features.Annotations.Attributes 3.13.1

Kanject.Core.Features.Annotations.Attributes

The attribute and enum types for Kanject edition-locking: [EditionLadder], [LockedBehind], [PrunedBelow], [EntitlementClaims], [Claim], FeatureBinding, and LockedServiceLifetime. They are marker types only — no implementation and no dependencies. All behavior comes from the source generators in Kanject.Core.Features.Annotations.

Installation

Most projects never reference this package directly: Kanject.Core.Features.Annotations depends on it, so installing the generator brings the attributes along.

<ItemGroup>
  <PackageReference Include="Kanject.Core.Features" />
  <PackageReference Include="Kanject.Core.Features.Annotations" PrivateAssets="all" />
</ItemGroup>

dotnet add package writes an IncludeAssets line for Kanject.Core.Features.Annotations that omits compile. Delete that line (keep PrivateAssets="all") — otherwise the attribute types from this package can be stripped from compilation.

Reference it directly when a project needs the attribute types in its compilation without relying on the generator package's dependency — for example, when your tooling insists on that IncludeAssets line:

dotnet add package Kanject.Core.Features.Annotations.Attributes

Targets netstandard2.0, .NET 8, .NET 9 and .NET 10 (netstandard2.0 lets the generators, which run inside the compiler, load the same types).

The attributes do nothing on their own. The edition attributes are acted on only by the generator running in the same assembly as the [EditionLadder] enum; applying them in a library that has no ladder (or no generator) produces no registrations, prune points, or manifest.

Quick start

using Kanject.Core.Features.Annotations.Attributes;
using Kanject.Core.Features.Annotations.Attributes.Enums;
using Kanject.Core.Features.Interfaces;

[EditionLadder]
public enum Edition { Free, Pro, Enterprise }

// Registered by the generated AddLockedFeatures() only in Pro and Enterprise builds.
[LockedBehind(Edition.Pro, Lifetime = LockedServiceLifetime.Singleton)]
[PrunedBelow(Edition.Pro)]
public sealed class AdvancedExportEngine : IExportEngine { /* ... */ }

public sealed partial class Dashboard
{
    private readonly IFeatureGate _gate;
    public Dashboard(IFeatureGate gate) => _gate = gate;

    // Decided at run time through IFeatureGate.
    [LockedBehind("beta.export", Fallback = nameof(Locked))]
    public partial string Render();

    // Present in every edition, gated on the "Edition.Pro" feature key.
    [LockedBehind(Edition.Pro, Binding = FeatureBinding.Runtime)]
    public partial string RenderUpsell();

    private string RenderCore() => "high-res export";
    private string RenderUpsellCore() => "Pro dashboard";
    private string Locked() => "Upgrade to export.";
}

The Dashboard guards need the runtime package Kanject.Core.Features (for IFeatureGate) and the generator package to supply the method bodies.

Attributes

All attributes are in the Kanject.Core.Features.Annotations.Attributes namespace.

LockedBehind named properties

Enums

In the Kanject.Core.Features.Annotations.Attributes.Enums namespace.

Related packages

License

Licensed under the Kanject Code Libraries License Agreement (KCLLA); the full text ships in this package as LICENSE.md. Organizations whose trailing-twelve-month gross revenue and total funding raised are each below US$250,000 may use it at no cost under the Free Tier. At or above either threshold a commercial license is required — contact commercial@kanjectbusiness.com.