@owostack/types 0.1.4 → 0.3.0

package/dist/index.d.ts

@@ -90,6 +90,56 @@ interface OverageDetails {
     /** Number of units per billing increment */
     billingUnits?: number | null;
 }
+/** A single tier in a usage pricing model */
+interface PricingTier {
+    /** Inclusive upper bound for this tier; null means infinity */
+    upTo: number | null;
+    /** Optional price per unit in minor currency units */
+    unitPrice?: number;
+    /** Optional flat fee charged when this tier is entered */
+    flatFee?: number;
+}
+/** How billable usage is converted into money */
+type RatingModel = "package" | "graduated" | "volume";
+/** Current tier for tiered pricing responses */
+interface CurrentPricingTier {
+    /** Zero-based tier index */
+    index: number;
+    /** Usage at which this tier starts */
+    startsAt: number;
+    /** Inclusive upper bound of the tier; null means infinity */
+    endsAt: number | null;
+    /** Price per unit for this tier; 0 when the tier is flat-only */
+    unitPrice: number;
+    /** Optional flat fee charged when this tier is entered */
+    flatFee?: number;
+}
+/** Pricing metadata returned alongside access/billing responses */
+interface PricingDetails {
+    /** Entitlement model for this feature */
+    usageModel?: "included" | "usage_based" | "prepaid";
+    /** Rating model used when usage is billable */
+    ratingModel?: RatingModel;
+    /** Package or per-unit price in minor currency units */
+    pricePerUnit?: number | null;
+    /** Package size for package pricing */
+    billingUnits?: number | null;
+    /** Current tier when using graduated or volume pricing */
+    currentTier?: CurrentPricingTier;
+}
+/** Per-tier billing breakdown for rated usage */
+interface BillingTierBreakdown {
+    /** Zero-based tier index */
+    tier: number;
+    /** Units billed in this tier */
+    units: number;
+    /** Price per unit for this tier; 0 when the tier is flat-only */
+    unitPrice: number;
+    /** Optional flat fee applied for the tier */
+    flatFee?: number;
+    /** Amount billed for this tier in minor currency units */
+    amount: number;
+}
 /**
  * Contextual details object returned alongside standard check/track fields.
  * Contains all optional/situational information that isn't part of the
@@ -114,6 +164,8 @@ interface ResponseDetails {
     addonCreditsUsed?: number;
     /** Remaining add-on credits after this request */
     addonCreditsRemaining?: number;
+    /** Pricing metadata for chargeable metered features */
+    pricing?: PricingDetails;
 }
 /** Plan credit breakdown for credit system features */
 interface PlanCredits {
@@ -209,6 +261,14 @@ interface BillingFeatureUsage {
     estimatedAmount: number;
     /** Usage billing model */
     usageModel: string;
+    /** Rating model used to calculate the estimated amount */
+    ratingModel?: RatingModel;
+    /** Package or per-unit price in minor currency units */
+    pricePerUnit?: number | null;
+    /** Package size when using package pricing */
+    billingUnits?: number | null;
+    /** Optional tier breakdown for graduated or volume pricing */
+    tierBreakdown?: BillingTierBreakdown[];
 }
 interface BillingUsageResult {
     /** Whether the request succeeded */
@@ -232,10 +292,14 @@ interface InvoiceLineItem {
     description: string;
     /** Quantity */
     quantity: number;
-    /** Unit price in minor currency units */
+    /** Unit price component in minor currency units; tiered lines rely on tierBreakdown for exact pricing */
     unitPrice: number;
-    /** Line total in minor currency units */
+    /** Line total in minor currency units; may include package rounding or flat tier amounts */
     amount: number;
+    /** Rating model used for tiered usage lines */
+    ratingModel?: RatingModel;
+    /** Optional tier breakdown for graduated or volume usage lines */
+    tierBreakdown?: BillingTierBreakdown[];
 }
 interface Invoice {
     /** Invoice ID */
@@ -332,7 +396,7 @@ interface AddonResult {
 type PaymentChannel = "card" | "bank" | "bank_transfer" | "ussd" | "mobile_money" | "qr";
 type Currency = "NGN" | "GHS" | "ZAR" | "KES" | "USD" | "CAD" | "EUR" | "GBP" | "CHF" | "SEK" | "NOK" | "DKK" | "PLN" | "CZK" | "JPY" | "CNY" | "INR" | "SGD" | "HKD" | "AUD" | "NZD" | "BRL" | "MXN" | "ARS" | "COP" | "AED" | "SAR" | "EGP" | (string & {});
 type PlanInterval = "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
-type ResetInterval = "never" | "5min" | "15min" | "30min" | "hourly" | "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
+type ResetInterval = "none" | "never" | "5min" | "15min" | "30min" | "hourly" | "daily" | "weekly" | "monthly" | "quarterly" | "semi_annual" | "yearly";
 type SubscriptionStatus = "active" | "canceled" | "expired" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid";
 /**
  * Plan and feature definitions
@@ -425,7 +489,7 @@ interface UsageRecord {
  * Used by metered(), boolean(), and plan() builder functions.
  */
 /** Union of all catalog entries passed to OwostackConfig.catalog */
-type CatalogEntry = PlanDefinition | CreditSystemDefinition;
+type CatalogEntry = PlanDefinition | CreditSystemDefinition | CreditPackDefinition;
 /** Configuration for a metered feature within a plan */
 interface MeteredFeatureConfig {
     /** Limit for this plan (null = unlimited) */
@@ -440,6 +504,14 @@ interface MeteredFeatureConfig {
     maxOverageUnits?: number;
     /** Billing units for overage */
     billingUnits?: number;
+    /** Entitlement model for this feature */
+    usageModel?: "included" | "usage_based" | "prepaid";
+    /** Package or per-unit price in minor currency units */
+    pricePerUnit?: number;
+    /** Rating model used for billable usage */
+    ratingModel?: RatingModel;
+    /** Tiers used for graduated or volume pricing */
+    tiers?: PricingTier[];
     /** Credit cost for credit systems */
     creditCost?: number;
     /** Whether feature is enabled (default: true) */
@@ -491,6 +563,10 @@ interface PlanDefinition {
     provider?: string;
     /** Custom metadata */
     metadata?: Record<string, unknown>;
+    /** Auto-assign this plan to new customers */
+    autoEnable?: boolean;
+    /** Optional: Is this an add-on plan? */
+    isAddon?: boolean;
 }
 /** A feature entry within a credit system */
 interface CreditSystemFeatureEntry {
@@ -512,6 +588,29 @@ interface CreditSystemDefinition {
     /** Features that consume credits from this system with their credit costs */
     features: CreditSystemFeatureEntry[];
 }
+/** A credit pack definition in the catalog */
+interface CreditPackDefinition {
+    /** @internal */
+    _type: "credit_pack";
+    /** Credit pack slug (used as unique identifier) */
+    slug: string;
+    /** Human-readable credit pack name */
+    name: string;
+    /** Credit pack description */
+    description?: string;
+    /** Number of credits included in this pack */
+    credits: number;
+    /** Price in minor currency units (e.g. kobo) */
+    price: number;
+    /** Currency code */
+    currency: Currency;
+    /** Credit system this pack is tied to (required) */
+    creditSystem: string;
+    /** Provider for this pack (overrides default) */
+    provider?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
 /**
  * wallet() - Payment Methods
  */
@@ -600,6 +699,16 @@ interface PublicPlanFeature {
     overage?: "block" | "charge";
     /** Overage price per unit in minor currency units */
     overagePrice?: number | null;
+    /** Entitlement model for metered features */
+    usageModel?: "included" | "usage_based" | "prepaid";
+    /** Package or per-unit price in minor currency units */
+    pricePerUnit?: number | null;
+    /** Package size for package pricing */
+    billingUnits?: number | null;
+    /** Rating model used for billable usage */
+    ratingModel?: RatingModel;
+    /** Tier definitions for graduated or volume pricing */
+    tiers?: PricingTier[] | null;
 }
 /** A plan as returned by the public API — safe for client-side consumption */
 interface PublicPlan {
@@ -644,6 +753,7 @@ interface SyncPayload {
         slug: string;
         type: "metered" | "boolean";
         name: string;
+        meterType?: "consumable" | "non_consumable";
     }>;
     creditSystems: Array<{
         slug: string;
@@ -654,6 +764,17 @@ interface SyncPayload {
             creditCost: number;
         }>;
     }>;
+    creditPacks: Array<{
+        slug: string;
+        name: string;
+        description?: string;
+        credits: number;
+        price: number;
+        currency: Currency;
+        creditSystem: string;
+        provider?: string;
+        metadata?: Record<string, unknown>;
+    }>;
     plans: Array<{
         slug: string;
         name: string;
@@ -665,11 +786,17 @@ interface SyncPayload {
         trialDays?: number;
         provider?: string;
         metadata?: Record<string, unknown>;
+        autoEnable?: boolean;
+        isAddon?: boolean;
         features: Array<{
             slug: string;
             enabled: boolean;
             limit?: number | null;
             reset?: ResetInterval;
+            usageModel?: "included" | "usage_based" | "prepaid";
+            pricePerUnit?: number;
+            ratingModel?: RatingModel;
+            tiers?: PricingTier[];
             overage?: "block" | "charge";
             overagePrice?: number;
             maxOverageUnits?: number;
@@ -689,6 +816,7 @@ interface SyncResult {
     success: boolean;
     features: SyncChanges;
     creditSystems: SyncChanges;
+    creditPacks: SyncChanges;
     plans: SyncChanges;
     warnings: string[];
 }
@@ -803,4 +931,4 @@ interface ListEntitiesResult {
     total: number;
 }
 
-export type { AddEntityParams, AddEntityResult, AddonParams, AddonResult, AttachParams, AttachResult, BillingFeatureUsage, BillingUsageParams, BillingUsageResult, BooleanFeatureConfig, CardInfo, CatalogEntry, CheckCode, CheckParams, CheckResult, CreditSystemDefinition, CreditSystemFeatureEntry, Currency, Customer, CustomerData, CustomerParams, CustomerResult, Entitlement, Entity, Feature, FeatureLimit, Invoice, InvoiceLineItem, InvoiceParams, InvoiceResult, InvoicesParams, InvoicesResult, ListEntitiesParams, ListEntitiesResult, MeteredFeatureConfig, OverageDetails, OwostackConfig, PayInvoiceParams, PayInvoiceResult, PaymentChannel, PaymentMethodInfo, Plan, PlanCredits, PlanDefinition, PlanFeatureEntry, PlanInterval, PlansParams, PlansResult, PublicPlan, PublicPlanFeature, RemoveEntityParams, RemoveEntityResult, ResetInterval, ResponseDetails, Subscription, SubscriptionStatus, SyncChanges, SyncPayload, SyncResult, TrackCode, TrackParams, TrackResult, UsageRecord, WalletRemoveResult, WalletResult, WalletSetupParams, WalletSetupResult };
+export type { AddEntityParams, AddEntityResult, AddonParams, AddonResult, AttachParams, AttachResult, BillingFeatureUsage, BillingTierBreakdown, BillingUsageParams, BillingUsageResult, BooleanFeatureConfig, CardInfo, CatalogEntry, CheckCode, CheckParams, CheckResult, CreditPackDefinition, CreditSystemDefinition, CreditSystemFeatureEntry, Currency, CurrentPricingTier, Customer, CustomerData, CustomerParams, CustomerResult, Entitlement, Entity, Feature, FeatureLimit, Invoice, InvoiceLineItem, InvoiceParams, InvoiceResult, InvoicesParams, InvoicesResult, ListEntitiesParams, ListEntitiesResult, MeteredFeatureConfig, OverageDetails, OwostackConfig, PayInvoiceParams, PayInvoiceResult, PaymentChannel, PaymentMethodInfo, Plan, PlanCredits, PlanDefinition, PlanFeatureEntry, PlanInterval, PlansParams, PlansResult, PricingDetails, PricingTier, PublicPlan, PublicPlanFeature, RatingModel, RemoveEntityParams, RemoveEntityResult, ResetInterval, ResponseDetails, Subscription, SubscriptionStatus, SyncChanges, SyncPayload, SyncResult, TrackCode, TrackParams, TrackResult, UsageRecord, WalletRemoveResult, WalletResult, WalletSetupParams, WalletSetupResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owostack/types",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "description": "Shared TypeScript types for Owostack",
   "license": "Apache-2.0",
   "repository": {