@zuplo/zudoku-plugin-monetization 0.0.35 → 0.0.36-pre.1

package/dist/pricing-ui.d.mts

@@ -0,0 +1,296 @@
+import { ReactNode } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/types/PlanType.d.ts
+type EntitlementTemplate = MeteredEntitlementTemplate | StaticEntitlementTemplate | BooleanEntitlementTemplate;
+interface MeteredEntitlementTemplate {
+  type: "metered";
+  isSoftLimit?: boolean;
+  issueAfterReset?: number;
+  issueAfterResetPriority?: number;
+  preserveOverageAtReset?: boolean;
+  usagePeriod?: string;
+}
+interface StaticEntitlementTemplate {
+  type: "static";
+  config: string;
+}
+interface BooleanEntitlementTemplate {
+  type: "boolean";
+}
+interface PriceTier {
+  flatPrice?: {
+    amount: string;
+  };
+  unitPrice?: {
+    amount: string;
+  };
+  upToAmount?: string;
+}
+type Price = FlatPrice | UnitPrice | TieredPrice | DynamicPrice | PackagePrice;
+interface FlatPrice {
+  type: "flat";
+  amount: string;
+  paymentTerm?: "in_advance" | "in_arrears";
+}
+interface UnitPrice {
+  type: "unit";
+  amount: string;
+}
+interface TieredPrice {
+  type: "tiered";
+  mode: "volume" | "graduated";
+  tiers: PriceTier[];
+}
+interface DynamicPrice {
+  type: "dynamic";
+  multiplier?: string;
+}
+interface PackagePrice {
+  type: "package";
+  amount: string;
+  quantityPerPackage: string;
+  minimumAmount?: string;
+  maximumAmount?: string;
+}
+type RateCard = FlatFeeRateCard | UsageBasedRateCard;
+interface RateCardBase {
+  key: string;
+  name: string;
+  description?: string;
+  metadata?: Record<string, unknown> | null;
+  featureKey?: string;
+  entitlementTemplate?: EntitlementTemplate;
+}
+interface UsageBasedRateCard extends RateCardBase {
+  type: "usage_based";
+  billingCadence: string;
+  price: Price | null;
+}
+interface FlatFeeRateCard extends RateCardBase {
+  type: "flat_fee";
+  billingCadence: string | null;
+  price: FlatPrice | null;
+}
+interface PlanPhase {
+  key: string;
+  name: string;
+  description?: string;
+  metadata?: Record<string, unknown>;
+  duration?: string | null;
+  rateCards: RateCard[];
+}
+interface Quota {
+  key: string;
+  name: string;
+  limit: number;
+  period: string;
+  overagePrice?: string;
+  tierPrices?: string[];
+}
+interface Feature {
+  key: string;
+  name: string;
+  value?: string;
+}
+interface Alignment {
+  billablesMustAlign?: boolean;
+}
+interface ProRatingConfig {
+  enabled: boolean;
+  mode: "prorate_prices" | "prorate_quantities";
+}
+interface ValidationError {
+  message: string;
+  path?: string;
+  code?: string;
+}
+interface PlanDefaultTaxConfig {
+  /** When set (e.g. Stripe-style `exclusive` / `inclusive`), pricing may include or exclude tax. */
+  behavior?: string;
+}
+interface Plan {
+  id: string;
+  key: string;
+  name: string;
+  description?: string;
+  paymentRequired?: boolean;
+  metadata?: Record<string, unknown>;
+  version?: number;
+  currency?: string;
+  billingCadence: string;
+  defaultTaxConfig?: PlanDefaultTaxConfig;
+  status?: "draft" | "active" | "archived" | "scheduled";
+  effectiveFrom?: string;
+  effectiveTo?: string;
+  alignment?: Alignment;
+  proRatingConfig?: ProRatingConfig;
+  validationErrors?: ValidationError[] | null;
+  createdAt?: string;
+  updatedAt?: string;
+  deletedAt?: string;
+  phases: PlanPhase[];
+  monthlyPrice: string | null;
+  yearlyPrice: string | null;
+}
+//#endregion
+//#region src/pricing-ui/FeatureItem.d.ts
+declare const FeatureItem: ({
+  feature,
+  className
+}: {
+  feature: Feature;
+  className?: string;
+}) => _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/pricing-ui/PlanEntitlements.d.ts
+declare const PlanEntitlements: ({
+  phases,
+  currency,
+  billingCadence,
+  units,
+  itemClassName
+}: {
+  phases: PlanPhase[];
+  currency?: string;
+  billingCadence?: string;
+  units?: Record<string, string>;
+  itemClassName?: string;
+}) => _$react_jsx_runtime0.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;
+};
+declare const PricingCard: ({
+  plan,
+  isPopular,
+  showYearlyPrice,
+  units,
+  action,
+  className
+}: PricingCardProps) => _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#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.
+   * Receives the plan and whether it is the popular plan.
+   */
+  renderAction?: (plan: Plan, isPopular: boolean) => ReactNode;
+  /**
+   * Override or wrap the rendering of each card. Receives the plan and a
+   * context with the `isPopular` flag and the default `<PricingCard>`
+   * element. Return `defaultCard` to keep behavior, wrap it (e.g. with a
+   * drag handle, kebab menu, or overlay), or return something entirely
+   * different to render a custom card for that plan.
+   *
+   * @example
+   *   renderCard={(plan, { defaultCard }) => (
+   *     <div className="relative">
+   *       <DragHandle planId={plan.id} />
+   *       {defaultCard}
+   *     </div>
+   *   )}
+   */
+  renderCard?: (plan: Plan, ctx: {
+    isPopular: boolean;
+    defaultCard: ReactNode;
+  }) => ReactNode;
+  /**
+   * Predicate that decides which plan gets the "Most Popular" badge.
+   * Defaults to `plan.metadata.zuplo_most_popular === "true"`.
+   */
+  isPopular?: (plan: Plan) => boolean; /** Render override for the empty (no plans) state. */
+  emptyState?: ReactNode; /** Show the tax legend underneath the grid when the first plan has a defaultTaxConfig.behavior. Defaults to true. */
+  showTaxLegend?: boolean;
+  className?: string;
+  cardClassName?: string;
+};
+declare const PricingTable: ({
+  plans,
+  showYearlyPrice,
+  units,
+  renderAction,
+  renderCard,
+  isPopular,
+  emptyState,
+  showTaxLegend,
+  className,
+  cardClassName
+}: PricingTableProps) => _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/pricing-ui/QuotaItem.d.ts
+declare const QuotaItem: ({
+  quota,
+  className
+}: {
+  quota: Quota;
+  className?: string;
+}) => _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/utils/categorizeRateCards.d.ts
+declare const categorizeRateCards: (rateCards: RateCard[], options?: {
+  currency?: string;
+  units?: Record<string, string>;
+  planBillingCadence?: string | null;
+}) => {
+  quotas: Quota[];
+  features: Feature[];
+};
+//#endregion
+//#region src/utils/formatDuration.d.ts
+declare const formatDuration: (iso: string) => string;
+declare const formatDurationInterval: (iso: string) => string;
+/**
+ * Returns an adjective form suitable for possessive context
+ * e.g. "your monthly quota", "your weekly limit".
+ * Falls back to "billing period" for multi-unit cadences
+ * where "every 3 months" would be grammatically awkward.
+ */
+declare const formatDurationAdjective: (iso: string) => string;
+//#endregion
+//#region src/utils/formatPrice.d.ts
+declare const formatPrice: (amount: number, currency?: string) => string;
+/** Amount is in the smallest currency unit (e.g. Stripe); divisor from `Intl` / ISO 4217. */
+declare const formatMinorCurrencyAmount: (amountInMinorUnits: number, currency?: string) => string;
+//#endregion
+//#region src/utils/formatStaticEntitlementConfig.d.ts
+declare const formatStaticEntitlementConfig: (config: string | undefined) => string | undefined;
+//#endregion
+//#region src/utils/formatTieredPriceBreakdown.d.ts
+type TieredPriceBreakdownTier = {
+  upToAmount?: string;
+  unitPriceAmount?: string;
+  flatPriceAmount?: string;
+};
+declare const formatTieredPriceBreakdown: (opts: {
+  tiers: TieredPriceBreakdownTier[];
+  currency?: string;
+  unitLabel: string;
+  includedLabel: string;
+  omitIncludedUpToAmount?: number;
+}) => string[] | undefined;
+//#endregion
+//#region src/utils/getPriceFromPlan.d.ts
+declare const getPriceFromPlan: (plan: Plan) => {
+  monthly: number;
+  yearly: number;
+};
+//#endregion
+//#region src/utils/pricingTaxLegend.d.ts
+type CanonicalTaxBehavior = "exclusive" | "inclusive" | "unspecified";
+declare const planHasDefaultTaxBehavior: (plan: Plan) => boolean;
+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, formatDuration, formatDurationAdjective, formatDurationInterval, formatMinorCurrencyAmount, formatPrice, formatStaticEntitlementConfig, formatTieredPriceBreakdown, getPriceFromPlan, planHasDefaultTaxBehavior, subscriptionTaxLegendSentence, taxBehaviorLegendSentence };

package/dist/pricing-ui.mjs

@@ -0,0 +1,2 @@
+import { _ as formatDurationAdjective, a as subscriptionTaxLegendSentence, c as PlanEntitlements, d as categorizeRateCards, f as formatTieredPriceBreakdown, g as formatDuration, h as formatPrice, i as planHasDefaultTaxBehavior, l as QuotaItem, m as formatMinorCurrencyAmount, n as PricingCard, o as taxBehaviorLegendSentence, p as formatStaticEntitlementConfig, r as collectDefaultTaxBehaviors, s as getPriceFromPlan, t as PricingTable, u as FeatureItem, v as formatDurationInterval } from "./PricingTable-DfYAmAjk.mjs";
+export { FeatureItem, PlanEntitlements, PricingCard, PricingTable, QuotaItem, categorizeRateCards, collectDefaultTaxBehaviors, formatDuration, formatDurationAdjective, formatDurationInterval, formatMinorCurrencyAmount, formatPrice, formatStaticEntitlementConfig, formatTieredPriceBreakdown, getPriceFromPlan, planHasDefaultTaxBehavior, subscriptionTaxLegendSentence, taxBehaviorLegendSentence };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/zudoku-plugin-monetization",
-  "version": "0.0.35",
+  "version": "0.0.36-pre.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/zuplo/zudoku",
@@ -11,14 +11,20 @@
   "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.mts"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./pricing-ui": {
+      "types": "./dist/pricing-ui.d.mts",
+      "import": "./dist/pricing-ui.mjs"
     }
   },
   "files": [
     "dist"
   ],
   "dependencies": {
+    "clsx": "2.1.1",
+    "tailwind-merge": "3.5.0",
     "tinyduration": "3.4.1"
   },
   "devDependencies": {
@@ -38,6 +44,11 @@
     "react-dom": ">=19.2.0",
     "zudoku": "*"
   },
+  "peerDependenciesMeta": {
+    "zudoku": {
+      "optional": true
+    }
+  },
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",