Merge pull request #1799 from openmeterio/feat/plan-api-impl

feat: add service/repo interfaces for Plan API

openmeter/productcatalog/plan/discount.go

@@ -32,6 +32,7 @@ type discounter interface {
 	Validator
 
 	Type() DiscountType
+	RateCardKeys() []string
 	AsPercentage() (PercentageDiscount, error)
 	FromPercentage(PercentageDiscount)
 }
@@ -43,6 +44,15 @@ type Discount struct {
 	percentage *PercentageDiscount
 }
 
+func (d *Discount) RateCardKeys() []string {
+	switch d.t {
+	case PercentageDiscountType:
+		return d.percentage.RateCards
+	default:
+		return nil
+	}
+}
+
 func (d *Discount) MarshalJSON() ([]byte, error) {
 	var b []byte
 	var err error
@@ -137,6 +147,10 @@ type PercentageDiscount struct {
 
 	// Percentage defines percentage of the discount.
 	Percentage decimal.Decimal `json:"percentage"`
+
+	// RateCards is the list of specific RateCard Keys the discount is applied to.
+	// If not provided the discount applies to all RateCards in Phase.
+	RateCards []string `json:"rateCards,omitempty"`
 }
 
 func (f PercentageDiscount) Validate() error {

openmeter/productcatalog/plan/entitlement.go

@@ -159,6 +159,24 @@ func (e *EntitlementTemplate) FromBoolean(t BooleanEntitlementTemplate) {
 	e.t = entitlement.EntitlementTypeBoolean
 }
 
+func NewEntitlementTemplateFrom[T MeteredEntitlementTemplate | StaticEntitlementTemplate | BooleanEntitlementTemplate](c T) EntitlementTemplate {
+	r := &EntitlementTemplate{}
+
+	switch any(c).(type) {
+	case MeteredEntitlementTemplate:
+		e := any(c).(MeteredEntitlementTemplate)
+		r.FromMetered(e)
+	case StaticEntitlementTemplate:
+		e := any(c).(StaticEntitlementTemplate)
+		r.FromStatic(e)
+	case BooleanEntitlementTemplate:
+		e := any(c).(BooleanEntitlementTemplate)
+		r.FromBoolean(e)
+	}
+
+	return *r
+}
+
 type EntitlementTemplateMeta struct {
 	// Type defines the type of the entitlement.Entitlement.
 	Type entitlement.EntitlementType `json:"type"`

openmeter/productcatalog/plan/phase.go

@@ -44,7 +44,7 @@ func (p Phase) Validate() error {
 	var errs []error
 
 	if p.StartAfter.IsNegative() {
-		errs = append(errs, fmt.Errorf("startAfter must not be negative"))
+		errs = append(errs, fmt.Errorf("the StartAfter period must not be negative"))
 	}
 
 	// Check for
@@ -54,23 +54,29 @@ func (p Phase) Validate() error {
 	rateCardKeys := make(map[string]RateCard)
 	for _, rateCard := range p.RateCards {
 		if _, ok := rateCardKeys[rateCard.Key()]; ok {
-			errs = append(errs, fmt.Errorf("duplicated rate card: %s", rateCard.Key()))
+			errs = append(errs, fmt.Errorf("duplicated RateCard: %s", rateCard.Key()))
 		} else {
 			rateCardKeys[rateCard.Key()] = rateCard
 		}
 
 		if rateCard.Namespace() != p.Namespace {
-			errs = append(errs, fmt.Errorf("invalid rate card %s: namespace mismatch %s", rateCard.Key(), rateCard.Namespace()))
+			errs = append(errs, fmt.Errorf("invalid RateCard: namespace mismatch %s", rateCard.Namespace()))
 		}
 
 		if err := rateCard.Validate(); err != nil {
-			errs = append(errs, fmt.Errorf("invalid rate card %s: %w", rateCard.Key(), err))
+			errs = append(errs, fmt.Errorf("invalid RateCard: %w", err))
 		}
 	}
 
 	for _, discount := range p.Discounts {
 		if err := discount.Validate(); err != nil {
-			errs = append(errs, fmt.Errorf("invalid discount: %w", err))
+			errs = append(errs, fmt.Errorf("invalid Discount: %w", err))
+		}
+
+		for _, key := range discount.RateCardKeys() {
+			if _, ok := rateCardKeys[key]; !ok {
+				errs = append(errs, fmt.Errorf("invalid Discount: unknown RateCard: %s", key))
+			}
 		}
 	}
 

openmeter/productcatalog/plan/plan.go

@@ -98,10 +98,10 @@ func (p Plan) Validate() error {
 var _ Validator = (*EffectivePeriod)(nil)
 
 type EffectivePeriod struct {
-	// EffectiveFrom
+	// EffectiveFrom defines the time from the Plan becomes active.
 	EffectiveFrom *time.Time `json:"effectiveFrom,omitempty"`
 
-	// EffectiveTo
+	// EffectiveTO defines the time from the Plan becomes archived.
 	EffectiveTo *time.Time `json:"effectiveTo,omitempty"`
 }