@zuplo/zudoku-plugin-monetization 0.0.41 → 0.0.43

package/dist/pricing-ui.d.mts

@@ -130,8 +130,6 @@ interface Plan {
   updatedAt?: string;
   deletedAt?: string;
   phases: PlanPhase[];
-  monthlyPrice: string | null;
-  yearlyPrice: string | null;
 }
 //#endregion
 //#region src/pricing-ui/FeatureItem.d.ts
@@ -144,6 +142,13 @@ declare const FeatureItem: ({
 }) => import("react/jsx-runtime").JSX.Element;
 //#endregion
 //#region src/pricing-ui/PlanEntitlements.d.ts
+/**
+ * A plan's entitlements, phase by phase. Multi-phase plans whose phases all
+ * resolve to the same entitlements collapse into a single list (the phases
+ * only differ in price, which the price schedule already tells); phases with
+ * genuinely different entitlements render as separate sections headed by the
+ * phase name, duration, and that phase's own price.
+ */
 declare const PlanEntitlements: ({
   phases,
   currency,
@@ -158,11 +163,102 @@ declare const PlanEntitlements: ({
   itemClassName?: string;
 }) => import("react/jsx-runtime").JSX.Element;
 //#endregion
+//#region src/utils/formatPlanPrice.d.ts
+type PlanPriceLabel = {
+  type: "free";
+} | {
+  type: "payg";
+  main: "Pay as you go";
+  sub: "Usage-based pricing";
+} | {
+  type: "priced";
+  amount: number;
+};
+/**
+ * Headline pricing for plan cards. Centralizes the "Pay as you go" detection:
+ * plans whose flat-fee total is zero but that bill on usage shouldn't render
+ * as "Free" - they're charged per-unit.
+ */
+declare const formatPlanPrice: (plan: Plan) => PlanPriceLabel;
+//#endregion
+//#region src/utils/getPlanPriceSchedule.d.ts
+type PlanPriceScheduleRow = {
+  /** Stable row key — the phase key, falling back to the phase index. */key: string; /** Left-column label, e.g. "First 3 months" / "Next 2 months" / "After that". */
+  label: string; /** The phase's own price, derived from its rate cards alone. */
+  price: PlanPriceLabel;
+};
+/**
+ * A stacked price schedule for a multi-phase plan: one row per phase, each
+ * priced from its own rate cards (e.g. "First 3 months — Free" then
+ * "After that — $750/month"). This is how an intro/ramp phase's price gets
+ * surfaced instead of only the steady-state price from {@link getPlanPrice}.
+ *
+ * Returns `undefined` when there is nothing to stack — fewer than two phases,
+ * or every phase resolving to the same price label (a free trial into a free
+ * plan, two identically-priced phases, …) — so callers fall back to the
+ * single-headline rendering.
+ */
+declare const getPlanPriceSchedule: (plan: Plan) => PlanPriceScheduleRow[] | undefined;
+//#endregion
+//#region src/pricing-ui/PlanPriceSchedule.d.ts
+/**
+ * Stacked per-phase price rows for a multi-phase plan, replacing the single
+ * headline price (which only reflects the steady-state phase): each row pairs
+ * a phase label ("First 3 months", "After that") with that phase's own price.
+ * Every row gets equal visual weight — the intro price is part of the plan's
+ * price, not a footnote.
+ *
+ * Callers derive the rows via {@link getPlanPriceSchedule} and fall back to
+ * the single-price rendering when it returns `undefined`. `size` picks the
+ * typographic treatment: `"lg"` for a card's headline area, `"sm"` for
+ * compact contexts (plan-change rows, summary cards).
+ */
+declare const PlanPriceSchedule: ({
+  schedule,
+  currency,
+  billingCadence,
+  size,
+  className
+}: {
+  schedule: PlanPriceScheduleRow[];
+  currency?: string; /** Render each priced row with the `/cadence` suffix (the plan's billing cadence). */
+  billingCadence?: string;
+  size?: "sm" | "lg";
+  className?: string;
+}) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/pricing-ui/PlanPriceTag.d.ts
+/**
+ * Headline price for a plan/subscription: `$X/cadence`, "Pay as you go", or
+ * "Free", from a {@link PlanPriceLabel}. Shared by the subscription details
+ * page, the Switch Plan baseline, each plan-change card, and the checkout /
+ * plan-change summary cards so they all render the price identically.
+ *
+ * `size` selects the typographic treatment:
+ *   - `"inline"` (default): compact, primary-colored text for use beside a name.
+ *   - `"lg"`: a large foreground headline for a summary card's price column.
+ *
+ * Pass `description` to surface the "Usage-based pricing" subline under the
+ * "Pay as you go" headline (used where there's room for it).
+ */
+declare const PlanPriceTag: ({
+  label,
+  currency,
+  billingCadence,
+  description,
+  size
+}: {
+  label: PlanPriceLabel;
+  currency?: string; /** Render the `/cadence` suffix (omit for prices shown without a cadence). */
+  billingCadence?: string;
+  description?: boolean;
+  size?: "inline" | "lg";
+}) => import("react/jsx-runtime").JSX.Element;
+//#endregion
 //#region src/pricing-ui/PricingCard.d.ts
 type PricingCardProps = {
   plan: Plan;
   isPopular?: boolean;
-  showYearlyPrice?: boolean;
   units?: Record<string, string>; /** CTA element rendered at the bottom of the card (e.g. a Subscribe button). */
   action?: ReactNode;
   className?: string;
@@ -170,7 +266,6 @@ type PricingCardProps = {
 declare const PricingCard: ({
   plan,
   isPopular,
-  showYearlyPrice,
   units,
   action,
   className
@@ -179,7 +274,6 @@ declare const PricingCard: ({
 //#region src/pricing-ui/PricingTable.d.ts
 type PricingTableProps = {
   plans: Plan[];
-  showYearlyPrice?: boolean;
   units?: Record<string, string>;
   /**
    * Render the CTA (e.g. Subscribe / Contact Sales button) for each plan.
@@ -217,7 +311,6 @@ type PricingTableProps = {
 };
 declare const PricingTable: ({
   plans,
-  showYearlyPrice,
   units,
   renderAction,
   renderCard,
@@ -280,35 +373,37 @@ declare const formatTieredPriceBreakdown: (opts: {
   includedLabel: string;
 }) => string[] | undefined;
 //#endregion
-//#region src/utils/getPriceFromPlan.d.ts
+//#region src/utils/getPhasePriceLabel.d.ts
 /**
- * Derive a (monthly, yearly) headline price from a plan's last phase by
- * summing all `flat_fee` rate-card amounts and converting from the plan's
- * `billingCadence` to a monthly equivalent.
+ * Headline price for a SINGLE phase, derived only from that phase's own rate
+ * cards. Mirrors {@link formatPlanPrice}'s rules, but scoped to the phase:
+ * a positive recurring flat-fee total is `priced`; otherwise a priced
+ * `usage_based` card in this phase makes it `payg`; otherwise it's `free`.
  *
- * Returns `null` for either field when no value can be derived (no
- * phases, or an unparseable / sub-day cadence). A flat-fee sum of 0
- * returns `{ monthly: 0, yearly: 0 }` (Free).
- *
- * Useful for consumers whose source data doesn't already include
- * pre-computed `monthlyPrice` / `yearlyPrice` — pass the result through
- * (or rely on `getPriceFromPlan`'s built-in fallback).
+ * Like {@link getPlanPrice}, one-time fees (`flat_fee` with
+ * `billingCadence: null`) and `price: null` rate cards contribute nothing —
+ * an intro phase whose fees all have `price: null` derives as `free`.
  */
-declare const derivePriceFromPlan: (plan: Plan) => {
-  monthly: number | null;
-  yearly: number | null;
-};
+declare const getPhasePriceLabel: (phase: PlanPhase) => PlanPriceLabel;
+//#endregion
+//#region src/utils/getPlanPrice.d.ts
 /**
- * Returns the monthly and yearly headline price for a plan. Prefers the
- * server-provided `monthlyPrice` / `yearlyPrice` strings when present;
- * otherwise falls back to {@link derivePriceFromPlan}. Values that can't
- * be resolved are reported as `0`, which the pricing card renders as
- * "Free".
+ * The plan's headline recurring price: the sum of every recurring `flat_fee`
+ * rate-card amount on the plan's steady-state (last) phase, expressed in the
+ * plan's own `billingCadence`. One-time fees (`flat_fee` with
+ * `billingCadence: null`, e.g. a setup fee) are excluded.
+ *
+ * This is derived entirely from the plan's rate cards. It deliberately does
+ * NOT read any server-provided `monthlyPrice` / `yearlyPrice` and performs no
+ * cadence conversion, so it stays correct for any billing cadence — hourly
+ * (`PT1H`), weekly, monthly, yearly, etc. Callers pair the returned amount
+ * with `formatDuration(plan.billingCadence)` to render e.g. `$2.99/hour`.
+ *
+ * Returns `0` when there are no phases or no recurring flat fee, which callers
+ * render as "Free" (or "Pay as you go" when the plan bills on usage — see
+ * {@link formatPlanPrice}).
  */
-declare const getPriceFromPlan: (plan: Plan) => {
-  monthly: number;
-  yearly: number;
-};
+declare const getPlanPrice: (plan: Plan) => number;
 //#endregion
 //#region src/utils/pricingTaxLegend.d.ts
 type CanonicalTaxBehavior = "exclusive" | "inclusive" | "unspecified";
@@ -317,4 +412,4 @@ declare const collectDefaultTaxBehaviors: (plan: Plan) => CanonicalTaxBehavior;
 declare const taxBehaviorLegendSentence: (behavior: string) => string | undefined;
 declare const subscriptionTaxLegendSentence: (behavior: string) => string | undefined;
 //#endregion
-export { type Alignment, type BooleanEntitlementTemplate, type DynamicPrice, type EntitlementTemplate, type Feature, FeatureItem, type FlatFeeRateCard, type FlatPrice, type MeteredEntitlementTemplate, type PackagePrice, type Plan, type PlanDefaultTaxConfig, PlanEntitlements, type PlanPhase, type Price, type PriceTier, PricingCard, type PricingCardProps, PricingTable, type PricingTableProps, type ProRatingConfig, type Quota, QuotaItem, type RateCard, type StaticEntitlementTemplate, type TieredPrice, type TieredPriceBreakdownTier, type UnitPrice, type UsageBasedRateCard, type ValidationError, categorizeRateCards, collectDefaultTaxBehaviors, derivePriceFromPlan, formatDuration, formatDurationAdjective, formatDurationInterval, formatMinorCurrencyAmount, formatPrice, formatStaticEntitlementConfig, formatTieredPriceBreakdown, getPriceFromPlan, planHasDefaultTaxBehavior, subscriptionTaxLegendSentence, taxBehaviorLegendSentence };
+export { type Alignment, type BooleanEntitlementTemplate, type DynamicPrice, type EntitlementTemplate, type Feature, FeatureItem, type FlatFeeRateCard, type FlatPrice, type MeteredEntitlementTemplate, type PackagePrice, type Plan, type PlanDefaultTaxConfig, PlanEntitlements, type PlanPhase, type PlanPriceLabel, PlanPriceSchedule, type PlanPriceScheduleRow, PlanPriceTag, type Price, type PriceTier, PricingCard, type PricingCardProps, PricingTable, type PricingTableProps, type ProRatingConfig, type Quota, QuotaItem, type RateCard, type StaticEntitlementTemplate, type TieredPrice, type TieredPriceBreakdownTier, type UnitPrice, type UsageBasedRateCard, type ValidationError, categorizeRateCards, collectDefaultTaxBehaviors, formatDuration, formatDurationAdjective, formatDurationInterval, formatMinorCurrencyAmount, formatPlanPrice, formatPrice, formatStaticEntitlementConfig, formatTieredPriceBreakdown, getPhasePriceLabel, getPlanPrice, getPlanPriceSchedule, planHasDefaultTaxBehavior, subscriptionTaxLegendSentence, taxBehaviorLegendSentence };

package/dist/pricing-ui.mjs

@@ -1,2 +1,2 @@
-import { _ as formatDuration, a as subscriptionTaxLegendSentence, c as getPriceFromPlan, d as FeatureItem, f as categorizeRateCards, g as formatPrice, h as formatMinorCurrencyAmount, i as planHasDefaultTaxBehavior, l as PlanEntitlements, m as formatStaticEntitlementConfig, n as PricingCard, o as taxBehaviorLegendSentence, p as formatTieredPriceBreakdown, r as collectDefaultTaxBehaviors, s as derivePriceFromPlan, t as PricingTable, u as QuotaItem, v as formatDurationAdjective, y as formatDurationInterval } from "./PricingTable-DNop2iX9.mjs";
-export { FeatureItem, PlanEntitlements, PricingCard, PricingTable, QuotaItem, categorizeRateCards, collectDefaultTaxBehaviors, derivePriceFromPlan, formatDuration, formatDurationAdjective, formatDurationInterval, formatMinorCurrencyAmount, formatPrice, formatStaticEntitlementConfig, formatTieredPriceBreakdown, getPriceFromPlan, planHasDefaultTaxBehavior, subscriptionTaxLegendSentence, taxBehaviorLegendSentence };
+import { C as formatStaticEntitlementConfig, D as formatDurationAdjective, E as formatDuration, O as formatDurationInterval, S as formatTieredPriceBreakdown, T as formatPrice, _ as formatPlanPrice, a as planHasDefaultTaxBehavior, c as getPlanPriceSchedule, d as PlanEntitlements, g as getPhasePriceLabel, h as FeatureItem, i as collectDefaultTaxBehaviors, l as PlanPriceTag, m as QuotaItem, n as PricingCard, o as subscriptionTaxLegendSentence, s as taxBehaviorLegendSentence, t as PricingTable, u as PlanPriceSchedule, v as getPlanPrice, w as formatMinorCurrencyAmount, x as categorizeRateCards } from "./PricingTable-WkG2n7V-.mjs";
+export { FeatureItem, PlanEntitlements, PlanPriceSchedule, PlanPriceTag, PricingCard, PricingTable, QuotaItem, categorizeRateCards, collectDefaultTaxBehaviors, formatDuration, formatDurationAdjective, formatDurationInterval, formatMinorCurrencyAmount, formatPlanPrice, formatPrice, formatStaticEntitlementConfig, formatTieredPriceBreakdown, getPhasePriceLabel, getPlanPrice, getPlanPriceSchedule, planHasDefaultTaxBehavior, subscriptionTaxLegendSentence, taxBehaviorLegendSentence };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/zudoku-plugin-monetization",
-  "version": "0.0.41",
+  "version": "0.0.43",
   "repository": {
     "type": "git",
     "url": "https://github.com/zuplo/zudoku",