@automattic/plans-grid-next 1.0.1 → 1.0.3

package/dist/esm/lib/plan-pricing-utils.js

@@ -0,0 +1,129 @@
+// billingPeriod values are in days (from PERIOD_LIST in calypso-products)
+const BILLING_PERIOD_DAYS_TO_MONTHS = {
+    31: 1,
+    365: 12,
+    730: 24,
+    1095: 36,
+};
+function billingPeriodDaysToMonths(billingPeriod) {
+    if (billingPeriod === undefined || billingPeriod === null) {
+        return null;
+    }
+    return BILLING_PERIOD_DAYS_TO_MONTHS[billingPeriod] ?? null;
+}
+/**
+ * Calculates the total cost of a plan over `durationMonths` months.
+ *
+ * Handles partial billing periods via pro-ration (e.g. a yearly plan priced at
+ * $200/year costs $100 for 6 months).
+ *
+ * When `useIntroOffer` is true (default) and an active intro offer exists, the
+ * intro price is applied for the first `introOffer.durationMonths` months, and
+ * the regular (or discounted) price for the remainder.
+ *
+ * @example
+ * // Monthly plan: $10 intro for 1 month, then $20/month; cost for 6 months:
+ * // 1×$10 + 5×$20 = $110 (in cents: 1100 + 10000 = 11000)
+ * getPlanPriceForDuration( info, 6, { useIntroOffer: true } ) // 11000
+ *
+ * @example
+ * // Yearly plan: $100/yr intro, $200/yr regular; cost for 6 months:
+ * // useIntroOffer=true  → 6×($100/12) = $50   (5000 cents)
+ * // useIntroOffer=false → 6×($200/12) = $100  (10000 cents)
+ */
+export function getPlanPriceForDuration(info, durationMonths, { useIntroOffer = true } = {}) {
+    const basePricePerMonth = info.discountedPricePerMonth ?? info.regularPricePerMonth;
+    if (useIntroOffer && info.introOffer?.isActive) {
+        const introMonths = Math.min(durationMonths, info.introOffer.durationMonths);
+        const regularMonths = Math.max(0, durationMonths - info.introOffer.durationMonths);
+        return introMonths * info.introOffer.pricePerMonth + regularMonths * basePricePerMonth;
+    }
+    return durationMonths * basePricePerMonth;
+}
+/**
+ * Calculates the percentage discount between a reference price and a cheaper price.
+ *
+ * Always uses Math.floor — conservative, never overstates savings.
+ *
+ * Returns `undefined` (not 0) when there is no saving, allowing callers to
+ * distinguish "no discount" from a computed "0% discount".
+ */
+export function calculateDiscountPercentage(referencePrice, cheaperPrice) {
+    if (cheaperPrice >= referencePrice || referencePrice <= 0) {
+        return undefined;
+    }
+    return Math.floor((100 * (referencePrice - cheaperPrice)) / referencePrice);
+}
+/**
+ * Converts a `PricingMetaForGridPlan` (from @automattic/data-stores Plans hooks)
+ * into a `PlanPriceInfo` suitable for use with `getPlanPriceForDuration` and
+ * `calculateDiscountPercentage`.
+ *
+ * Returns null when required pricing data is absent (e.g. free/enterprise plans
+ * that have no monthly price, or plans whose billing period is unknown).
+ */
+export function fromPricingMetaForGridPlan(meta) {
+    const termMonths = billingPeriodDaysToMonths(meta.billingPeriod);
+    if (termMonths === null || meta.originalPrice.monthly === null) {
+        return null;
+    }
+    const isIntroActive = !!meta.introOffer && !meta.introOffer.isOfferComplete;
+    return {
+        termMonths,
+        regularPricePerMonth: meta.originalPrice.monthly,
+        // The API sometimes sets discountedPrice.monthly to the intro offer price rather than
+        // a genuine site-level discount (e.g. currency conversion, proration credit). When an
+        // intro offer is active the intro structure already captures the discounted period, so
+        // using discountedPrice here would contaminate the post-intro "regular" rate used by
+        // getPlanPriceForDuration — producing incorrect totals for the non-intro months.
+        discountedPricePerMonth: isIntroActive ? undefined : meta.discountedPrice.monthly ?? undefined,
+        introOffer: meta.introOffer
+            ? {
+                pricePerMonth: meta.introOffer.rawPrice.monthly,
+                durationMonths: meta.introOffer.intervalCount * (meta.introOffer.intervalUnit === 'year' ? 12 : 1),
+                isActive: isIntroActive,
+            }
+            : undefined,
+    };
+}
+/**
+ * Converts a variant price data object (structurally compatible with
+ * `WPCOMProductVariant`) into a `PlanPriceInfo`.
+ *
+ * `discountedPricePerMonth` is intentionally not set: `WPCOMProductVariant`
+ * does not separate site-level discounts from the intro price. Coupon discounts
+ * in checkout are tracked separately via `product.coupon_savings_integer`.
+ *
+ * Per-month values are derived by dividing full-term prices (integers in the
+ * smallest currency unit) by the number of months. The result is rounded to the
+ * nearest integer (Math.round) so that all fields in the returned `PlanPriceInfo`
+ * remain whole-cent values safe for use with currency formatters. The rounding
+ * error is at most 0.5¢ per month and is negligible for percentage comparisons.
+ */
+export function fromVariantPriceData(variant) {
+    const { termIntervalInMonths: termMonths, priceBeforeDiscounts, priceInteger, introductoryInterval, introductoryTerm, } = variant;
+    const regularPricePerMonth = Math.round(priceBeforeDiscounts / termMonths);
+    const introDurationMonths = introductoryInterval > 0 ? introductoryInterval * (introductoryTerm === 'year' ? 12 : 1) : 0;
+    let introOffer;
+    if (introDurationMonths > 0 && priceInteger < priceBeforeDiscounts) {
+        // When the intro spans the full term (introDurationMonths >= termMonths), all of
+        // priceInteger is at the intro rate and there are zero non-intro months.
+        // When the intro is shorter than the term (introDurationMonths < termMonths), we
+        // subtract the non-intro portion (billed at the regular rate) to isolate the intro cost.
+        const nonIntroMonths = Math.max(0, termMonths - introDurationMonths);
+        const introPriceTotal = priceInteger - nonIntroMonths * regularPricePerMonth;
+        // A non-positive introPriceTotal means inconsistent data (e.g. a sub-term intro
+        // with a priceInteger that is less than the non-intro months at the regular rate).
+        if (introPriceTotal > 0) {
+            // When introDurationMonths > termMonths the whole billing term is within the
+            // intro period, so we spread introPriceTotal over termMonths (not introDurationMonths).
+            introOffer = {
+                pricePerMonth: Math.round(introPriceTotal / Math.min(introDurationMonths, termMonths)),
+                durationMonths: introDurationMonths,
+                isActive: true,
+            };
+        }
+    }
+    return { termMonths, regularPricePerMonth, introOffer };
+}
+//# sourceMappingURL=plan-pricing-utils.js.map

package/dist/esm/lib/plan-pricing-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-pricing-utils.js","sourceRoot":"","sources":["../../../src/lib/plan-pricing-utils.ts"],"names":[],"mappings":"AA0BA,0EAA0E;AAC1E,MAAM,6BAA6B,GAA6B;IAC/D,EAAE,EAAE,CAAC;IACL,GAAG,EAAE,EAAE;IACP,GAAG,EAAE,EAAE;IACP,IAAI,EAAE,EAAE;CACR,CAAC;AAEF,SAAS,yBAAyB,CAAE,aAAiC;IACpE,IAAK,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,IAAI,EAAG,CAAC;QAC7D,OAAO,IAAI,CAAC;IACb,CAAC;IACD,OAAO,6BAA6B,CAAE,aAAa,CAAE,IAAI,IAAI,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,uBAAuB,CACtC,IAAmB,EACnB,cAAsB,EACtB,EAAE,aAAa,GAAG,IAAI,KAAkC,EAAE;IAE1D,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,IAAI,IAAI,CAAC,oBAAoB,CAAC;IAEpF,IAAK,aAAa,IAAI,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAG,CAAC;QAClD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAE,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAE,CAAC;QAC/E,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAE,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAE,CAAC;QACrF,OAAO,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,aAAa,GAAG,iBAAiB,CAAC;IACxF,CAAC;IAED,OAAO,cAAc,GAAG,iBAAiB,CAAC;AAC3C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CAC1C,cAAsB,EACtB,YAAoB;IAEpB,IAAK,YAAY,IAAI,cAAc,IAAI,cAAc,IAAI,CAAC,EAAG,CAAC;QAC7D,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAE,CAAE,GAAG,GAAG,CAAE,cAAc,GAAG,YAAY,CAAE,CAAE,GAAG,cAAc,CAAE,CAAC;AACnF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CACzC,IAAkC;IAElC,MAAM,UAAU,GAAG,yBAAyB,CAAE,IAAI,CAAC,aAAa,CAAE,CAAC;IACnE,IAAK,UAAU,KAAK,IAAI,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,KAAK,IAAI,EAAG,CAAC;QAClE,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,aAAa,GAAG,CAAC,CAAE,IAAI,CAAC,UAAU,IAAI,CAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAE9E,OAAO;QACN,UAAU;QACV,oBAAoB,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO;QAChD,sFAAsF;QACtF,sFAAsF;QACtF,uFAAuF;QACvF,qFAAqF;QACrF,iFAAiF;QACjF,uBAAuB,EAAE,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,SAAS;QAC9F,UAAU,EAAE,IAAI,CAAC,UAAU;YAC1B,CAAC,CAAC;gBACA,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO;gBAC/C,cAAc,EACb,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,CAAE,IAAI,CAAC,UAAU,CAAC,YAAY,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE;gBACrF,QAAQ,EAAE,aAAa;aACtB;YACH,CAAC,CAAC,SAAS;KACZ,CAAC;AACH,CAAC;AA2BD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAAE,OAAyB;IAC9D,MAAM,EACL,oBAAoB,EAAE,UAAU,EAChC,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,GAChB,GAAG,OAAO,CAAC;IAEZ,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAE,oBAAoB,GAAG,UAAU,CAAE,CAAC;IAE7E,MAAM,mBAAmB,GACxB,oBAAoB,GAAG,CAAC,CAAC,CAAC,CAAC,oBAAoB,GAAG,CAAE,gBAAgB,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhG,IAAI,UAAqD,CAAC;IAE1D,IAAK,mBAAmB,GAAG,CAAC,IAAI,YAAY,GAAG,oBAAoB,EAAG,CAAC;QACtE,iFAAiF;QACjF,yEAAyE;QACzE,iFAAiF;QACjF,yFAAyF;QACzF,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAE,CAAC,EAAE,UAAU,GAAG,mBAAmB,CAAE,CAAC;QACvE,MAAM,eAAe,GAAG,YAAY,GAAG,cAAc,GAAG,oBAAoB,CAAC;QAE7E,gFAAgF;QAChF,mFAAmF;QACnF,IAAK,eAAe,GAAG,CAAC,EAAG,CAAC;YAC3B,6EAA6E;YAC7E,wFAAwF;YACxF,UAAU,GAAG;gBACZ,aAAa,EAAE,IAAI,CAAC,KAAK,CAAE,eAAe,GAAG,IAAI,CAAC,GAAG,CAAE,mBAAmB,EAAE,UAAU,CAAE,CAAE;gBAC1F,cAAc,EAAE,mBAAmB;gBACnC,QAAQ,EAAE,IAAI;aACd,CAAC;QACH,CAAC;IACF,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,CAAC;AACzD,CAAC"}