File Coverage

blib/lib/SBOM/CycloneDX/License/Licensing.pm

Criterion	Covered	Total	%
statement	54	54	100.0
branch	8	16	50.0
condition			n/a
subroutine	14	14	100.0
pod	1	1	100.0
total	77	85	90.5

package SBOM::CycloneDX::License::Licensing;

use 5.010001;
use strict;
use warnings;
use utf8;

use SBOM::CycloneDX::Enum;
use SBOM::CycloneDX::License::Licensee;
use SBOM::CycloneDX::License::Licensor;
use SBOM::CycloneDX::License::Purchaser;
use SBOM::CycloneDX::List;

use Types::Standard qw(Str Enum InstanceOf);
use Types::TypeTiny qw(ArrayLike);

use Moo;
use namespace::autoclean;

extends 'SBOM::CycloneDX::Base';

has alt_ids => (is => 'rw', isa => ArrayLike [Str], default => sub { SBOM::CycloneDX::List->new });

has licensor => (
    is      => 'rw',
    isa     => InstanceOf ['SBOM::CycloneDX::License::Licensor'],
    default => sub { SBOM::CycloneDX::License::Licensor->new }
);

has licensee => (
    is      => 'rw',
    isa     => InstanceOf ['SBOM::CycloneDX::License::Licensee'],
    default => sub { SBOM::CycloneDX::License::Licensee->new }
);

has purchaser => (
    is      => 'rw',
    isa     => InstanceOf ['SBOM::CycloneDX::License::Purchaser'],
    default => sub { SBOM::CycloneDX::License::Purchaser->new }
);

has purchase_order => (is => 'rw', isa => Str);

has license_types => (
    is      => 'rw',
    isa     => ArrayLike [Enum [SBOM::CycloneDX::Enum->values('LICENSE_TYPE')]],
    default => sub { SBOM::CycloneDX::List->new }
);

has last_renewal => (
    is     => 'rw',
    isa    => InstanceOf ['SBOM::CycloneDX::Timestamp'],
    coerce => sub { ref($_[0]) ? $_[0] : SBOM::CycloneDX::Timestamp->new($_[0]) }
);

has expiration => (
    is     => 'rw',
    isa    => InstanceOf ['SBOM::CycloneDX::Timestamp'],
    coerce => sub { ref($_[0]) ? $_[0] : SBOM::CycloneDX::Timestamp->new($_[0]) }
);

sub TO_JSON {

    my $self = shift;

    my $json = {};

    $json->{altIds}        = $self->alt_ids        if @{$self->alt_ids};
    $json->{licensor}      = $self->licensor       if %{$self->licensor->TO_JSON};
    $json->{licensee}      = $self->licensee       if %{$self->licensee->TO_JSON};
    $json->{purchaser}     = $self->purchaser      if %{$self->purchaser->TO_JSON};
    $json->{purchaseOrder} = $self->purchase_order if $self->purchase_order;
    $json->{licenseTypes}  = $self->license_types  if @{$self->license_types};
    $json->{lastRenewal}   = $self->last_renewal   if $self->last_renewal;
    $json->{expiration}    = $self->expiration     if $self->expiration;

    return $json;

}

1;

=encoding utf-8

=head1 NAME

SBOM::CycloneDX::License::Licensing - Licensing information

=head1 SYNOPSIS

    SBOM::CycloneDX::License::Licensing->new();


=head1 DESCRIPTION

L provides the licensing details describing the
licensor/licensee, license type, renewal and expiration dates, and other
important metadata

=head2 METHODS

L inherits all methods from L
and implements the following new ones.

=over

=item SBOM::CycloneDX::License::Licensing->new( %PARAMS )

Properties:

=over

=item * C, License identifiers that may be used to manage licenses
and their lifecycle

=item * C, The timestamp indicating when the current license
expires (if applicable).

=item * C, The timestamp indicating when the license was last
renewed. For new purchases, this is often the purchase or acquisition date.
For non-perpetual licenses or subscriptions, this is the timestamp of when
the license was last renewed.

=item * C, The type of license(s) that was granted to the
licensee.

=item * C, The individual or organization for which a license was
granted to

=item * C, The individual or organization that grants a license to
another individual or organization

=item * C, The purchase order identifier the purchaser sent
to a supplier or vendor to authorize a purchase

=item * C, The individual or organization that purchased the
license

=back

=item $licensing->alt_ids

=item $licensing->expiration

=item $licensing->last_renewal

=item $licensing->license_types

=item $licensing->licensee

=item $licensing->licensor

=item $licensing->purchase_order

=item $licensing->purchaser

=back


=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L.
You will be notified automatically of any progress on your issue.

=head2 Source Code

This is open source software.  The code repository is available for
public review and contribution under the terms of the license.

L

    git clone https://github.com/giterlizzi/perl-SBOM-CycloneDX.git


=head1 AUTHOR

=over 4

=item * Giuseppe Di Terlizzi

=back


=head1 LICENSE AND COPYRIGHT

This software is copyright (c) 2025-2026 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut