sinfactura-types 1.1.0 → 1.1.2

package/dist/subscription.d.ts

@@ -13,8 +13,11 @@
  *   flow now sets status='active' on fundador subscriptions).
  * - `FeatureKey` uses flat camelCase (not the dotted `reports.advanced` from the design kit).
  * - Monetary amounts are integers in minor units (ARS cents) to avoid float issues.
- * - WhatsApp-specific feature keys + `customDomain` are intentionally OUT of scope here;
- *   they ship with their own epics (#1072, #1152) after Product sign-off.
+ * - Feature keys now match the BE wire format directly (renamed afip→afipInvoicing,
+ *   cash→cashManagement, stripePayments→paymentIntegrations, reportsAdvanced→advancedReports
+ *   as of 2026-04-26). New keys whatsappCommerce/aiFeatures/mobileApp/customDomain are
+ *   declared here even when their epics haven't shipped — the matrix can set
+ *   enabled:false until they do.
  */
 declare global {
     type PlanTier = 'basico' | 'emprendedor' | 'profesional' | 'avanzado' | 'fundador';
@@ -44,16 +47,19 @@ declare global {
     type EntitlementType = 'boolean' | 'numeric' | 'metered';
     interface Entitlement {
         type: EntitlementType;
-        enabled: boolean;
+        /** `null` for `numeric`/`metered` types where on/off semantics don't apply (limit-driven). */
+        enabled: boolean | null;
         /** Required for `numeric` and `metered`. `Infinity`-equivalent — treat sentinel value for "unlimited". */
         limit?: number;
+        /** Origin of this entitlement entry. `plan` = from the tier matrix; `override` = tenant-specific override; `trial` = trial bonus. */
+        source?: 'plan' | 'override' | 'trial';
     }
     /**
      * All gated features. Add new keys here when a new feature becomes gateable;
      * every existing plan in `FEATURE_MATRIX` must then declare the new key
      * (TypeScript enforces this via `Record<FeatureKey, Entitlement>`).
      */
-    type FeatureKey = 'maxOrdersMonth' | 'maxInvoicesMonth' | 'maxProducts' | 'maxUsers' | 'maxCustomers' | 'maxStores' | 'afip' | 'stripePayments' | 'suppliers' | 'cash' | 'multiStore' | 'importExport' | 'reportsAdvanced' | 'customBranding' | 'apiAccess' | 'prioritySupport';
+    type FeatureKey = 'maxOrdersMonth' | 'maxInvoicesMonth' | 'maxProducts' | 'maxUsers' | 'maxCustomers' | 'maxStores' | 'afipInvoicing' | 'paymentIntegrations' | 'suppliers' | 'cashManagement' | 'multiStore' | 'importExport' | 'advancedReports' | 'customBranding' | 'apiAccess' | 'prioritySupport' | 'whatsappCommerce' | 'aiFeatures' | 'mobileApp' | 'customDomain';
     /** Full feature matrix — every tier declares every feature. */
     type FeatureMatrix = Record<PlanTier, Record<FeatureKey, Entitlement>>;
     /** Resolved entitlements for a specific tenant (matrix + overrides applied). */
@@ -71,12 +77,17 @@ declare global {
         label: string;
         /** Short marketing tagline (Spanish). */
         blurb?: string;
-        /** Price in ARS cents for monthly billing. `null` = contactar. */
+        /** Price in the plan's `currency` smallest unit for monthly billing. `null` = contactar. */
         priceMonthly: number | null;
-        /** Price in ARS cents for annual billing (total / 12; ~20% discount). `null` = contactar. */
+        /** Price in the plan's `currency` smallest unit for annual billing (total / 12; ~20% discount). `null` = contactar. */
         priceAnnual: number | null;
-        /** 'ARS' at launch. Reserved for future multi-currency. */
-        currency: 'ARS';
+        /**
+         * Currency the prices are denominated in. `'ARS'` at launch; `'USD'`
+         * is the migration target (api#841). Widened from the launch-only
+         * `'ARS'` literal in api#842 so the FE can render either currency
+         * without a type change once the platform flips.
+         */
+        currency: 'ARS' | 'USD';
         /**
          * Whether the plan is accepting new subscribers. Closed-cohort plans
          * (e.g. Founders after 2026-05-31) set this to `false` without deleting
@@ -93,6 +104,14 @@ declare global {
         /** Stripe Price IDs once the plan is wired to Stripe Products (api#627). */
         stripeMonthlyPriceId?: string;
         stripeAnnualPriceId?: string;
+        /**
+         * MercadoPago PreApprovalPlan IDs — populated by the future
+         * `seed-mercadopago-plans` Lambda (api#843). Coexist with the Stripe
+         * IDs above on the same Plan row so both providers' state can live
+         * in one place; unused fields stay dormant.
+         */
+        mpPreApprovalPlanIdMonthly?: string;
+        mpPreApprovalPlanIdAnnual?: string;
         /** Per-tier entitlement configuration. */
         entitlements: Record<FeatureKey, Entitlement>;
         createdAt: number;
@@ -107,6 +126,15 @@ declare global {
         planTier: PlanTier;
         status: SubscriptionStatus;
         billingCycle: BillingCycle;
+        /**
+         * Currency this subscription was billed in at checkout time.
+         * Snapshotted from the Plan's `currency` field so it survives
+         * platform-wide currency switches (api#841 / api#842) — a customer
+         * who signed up on ARS keeps being charged in ARS even after the
+         * platform flips to USD for new signups. Required for accurate
+         * historical reporting + AFIP invoices.
+         */
+        currency?: 'ARS' | 'USD';
         /** Current period window (Unix ms). */
         currentPeriodStart: number;
         currentPeriodEnd: number;
@@ -148,14 +176,39 @@ declare global {
         counters: Partial<Record<FeatureKey, number>>;
         updatedAt: number;
     }
+    /** A single entitlement entry as returned by GET /subscription. */
+    interface SubscriptionEntitlementEntry {
+        key: FeatureKey;
+        type: EntitlementType;
+        enabled: boolean | null;
+        limit: number | null;
+        source: 'plan' | 'override' | 'trial';
+    }
+    /** A single usage entry as returned by GET /subscription. */
+    interface SubscriptionUsageEntry {
+        key: FeatureKey;
+        /** Period in YYYYMM format. */
+        period: string;
+        current: number;
+        limit: number;
+        remaining: number;
+    }
     /**
      * Full subscription snapshot pushed to the frontend on subscription/entitlement
-     * changes. Consumers use this to invalidate RTK Query caches and re-render gates.
+     * changes. Flat shape — matches GET /subscription wire format directly.
      */
     interface SubscriptionSyncPayload {
-        subscription: Subscription;
-        entitlements: ResolvedEntitlements;
-        usage?: UsageCounters;
+        planTier: PlanTier;
+        status: SubscriptionStatus;
+        billingCycle: BillingCycle | null;
+        currentPeriodStart: number | null;
+        currentPeriodEnd: number | null;
+        trialEndsAt: number | null;
+        freeUntil?: string;
+        cancelAt: number | null;
+        canceledAt: number | null;
+        entitlements: SubscriptionEntitlementEntry[];
+        usage: SubscriptionUsageEntry[];
     }
 }
 export {};

package/dist/subscription.js

@@ -13,7 +13,10 @@
  *   flow now sets status='active' on fundador subscriptions).
  * - `FeatureKey` uses flat camelCase (not the dotted `reports.advanced` from the design kit).
  * - Monetary amounts are integers in minor units (ARS cents) to avoid float issues.
- * - WhatsApp-specific feature keys + `customDomain` are intentionally OUT of scope here;
- *   they ship with their own epics (#1072, #1152) after Product sign-off.
+ * - Feature keys now match the BE wire format directly (renamed afip→afipInvoicing,
+ *   cash→cashManagement, stripePayments→paymentIntegrations, reportsAdvanced→advancedReports
+ *   as of 2026-04-26). New keys whatsappCommerce/aiFeatures/mobileApp/customDomain are
+ *   declared here even when their epics haven't shipped — the matrix can set
+ *   enabled:false until they do.
  */
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sinfactura-types",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "main": "dist/index.js",
   "type": "module",
   "types": "./dist/index.d.ts",