@umituz/web-polar-payment 1.0.14 → 1.0.16

package/dist/index.d.mts

@@ -1,11 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
 import { ReactNode } from 'react';
 
-/**
- * Subscription Entity
- * @description Types for subscription status and billing cycles
- */
 type SubscriptionStatusValue = 'active' | 'canceled' | 'revoked' | 'trialing' | 'past_due' | 'incomplete' | 'incomplete_expired' | 'unpaid' | 'none';
 type BillingCycle = 'monthly' | 'yearly';
 interface SubscriptionStatus {
@@ -16,14 +11,9 @@ interface SubscriptionStatus {
     currentPeriodEnd?: string;
     billingCycle?: BillingCycle;
     polarCustomerId?: string;
-    /** Token balance (for token-based projects like Aria) */
     tokens?: number;
 }
 
-/**
- * Order Entity
- * @description Types for billing history items
- */
 interface OrderItem {
     id: string;
     createdAt: string;
@@ -35,16 +25,11 @@ interface OrderItem {
     invoiceUrl?: string;
 }
 
-/**
- * Checkout Entity
- * @description Types for initiating and following process of checkouts
- */
 interface CheckoutParams {
     productId: string;
     planKey?: string;
     billingCycle?: 'monthly' | 'yearly';
     successUrl?: string;
-    /** Injected automatically by PolarProvider — do not pass manually */
     userId?: string;
 }
 interface CheckoutResult {
@@ -52,43 +37,47 @@ interface CheckoutResult {
     id: string;
 }
 
-/**
- * Cancellation Entity
- * @description Types for subscription cancellation reasons and outcomes
- */
 type CancellationReason = 'too_expensive' | 'missing_features' | 'switched_service' | 'unused' | 'customer_service' | 'low_quality' | 'too_complex' | 'other';
 interface CancelResult {
     success: boolean;
     endsAt?: string;
 }
 
-/**
- * Sync Entity
- * @description Type for subscription synchronization results
- */
 interface SyncResult {
     synced: boolean;
     plan?: string;
 }
 
-/**
- * Backend-agnostic interface every adapter must implement.
- * @description Contract for Polar billing adapters (Firebase, Supabase, etc.)
- */
 interface PolarAdapter {
     getStatus(userId: string): Promise<SubscriptionStatus>;
     createCheckout(params: CheckoutParams): Promise<CheckoutResult>;
-    /** checkoutId is read from URL by the context and passed explicitly */
     syncSubscription(userId: string, checkoutId?: string): Promise<SyncResult>;
     getBillingHistory(userId: string): Promise<OrderItem[]>;
     cancelSubscription(reason?: CancellationReason): Promise<CancelResult>;
     getPortalUrl(userId: string): Promise<string>;
 }
 
+interface PolarProviderProps {
+    adapter: PolarAdapter;
+    userId?: string;
+    children: ReactNode;
+}
+declare function PolarProvider({ adapter, userId, children }: PolarProviderProps): react_jsx_runtime.JSX.Element;
+
+interface PolarContextValue {
+    status: SubscriptionStatus;
+    loading: boolean;
+    refresh: () => Promise<void>;
+    startCheckout: (params: CheckoutParams) => Promise<void>;
+    syncSubscription: () => Promise<SyncResult>;
+    getBillingHistory: () => Promise<OrderItem[]>;
+    cancelSubscription: (reason?: CancellationReason) => Promise<CancelResult>;
+    getPortalUrl: () => Promise<string>;
+}
+declare function usePolarBilling(): PolarContextValue;
+
 interface FirebaseAdapterConfig {
-    /** Firebase Functions instance from firebase/functions */
     functions: unknown;
-    /** Firebase Firestore instance from firebase/firestore */
     firestore: unknown;
     callables?: {
         createCheckout?: string;
@@ -108,16 +97,8 @@ interface FirebaseAdapterConfig {
         currentPeriodEndField?: string;
     };
 }
-/**
- * Firebase Billing Service
- * @description Implementation of PolarAdapter for Firebase Functions and Firestore.
- */
 declare function createFirebaseAdapter(config: FirebaseAdapterConfig): PolarAdapter;
 
-/**
- * Billing Constants
- * @description Standardized subscription states and plan names
- */
 declare const SUBSCRIPTION_STATUS: Readonly<{
     ACTIVE: "active";
     CANCELED: "canceled";
@@ -129,46 +110,5 @@ declare const SUBSCRIPTION_STATUS: Readonly<{
     UNPAID: "unpaid";
     NONE: "none";
 }>;
-declare const FREE_PLAN = "free";
-
-/**
- * Normalize a raw Polar status string to a known value.
- * @description Defaults to 'none' for unknown statuses or non-string input.
- */
-declare function normalizeStatus(raw: string): SubscriptionStatusValue;
-/**
- * Normalize billing interval
- * @description Maps 'month'/'year' to 'monthly'/'yearly'. Defaults to 'monthly' for unknown values or non-string input.
- */
-declare function normalizeBillingCycle(interval: string): BillingCycle;
-
-/**
- * PolarProvider Component
- * @description Context provider for Polar billing management.
- */
-interface PolarProviderProps {
-    adapter: PolarAdapter;
-    userId?: string;
-    children: ReactNode;
-}
-declare function PolarProvider({ adapter, userId, children }: PolarProviderProps): react_jsx_runtime.JSX.Element;
-
-interface PolarContextValue {
-    status: SubscriptionStatus;
-    loading: boolean;
-    refresh: () => Promise<void>;
-    startCheckout: (params: CheckoutParams) => Promise<void>;
-    syncSubscription: () => Promise<SyncResult>;
-    getBillingHistory: () => Promise<OrderItem[]>;
-    cancelSubscription: (reason?: CancellationReason) => Promise<CancelResult>;
-    getPortalUrl: () => Promise<string>;
-}
-declare const PolarContext: react.Context<PolarContextValue | undefined>;
-/**
- * usePolarBilling Hook
- * @description Hook to access Polar billing context
- */
-declare function usePolarBilling(): PolarContextValue;
-declare const useSubscription: typeof usePolarBilling;
 
-export { type BillingCycle, type CancelResult, type CancellationReason, type CheckoutParams, type CheckoutResult, FREE_PLAN, type FirebaseAdapterConfig, type OrderItem, type PolarAdapter, PolarContext, type PolarContextValue, PolarProvider, SUBSCRIPTION_STATUS, type SubscriptionStatus, type SubscriptionStatusValue, type SyncResult, createFirebaseAdapter, normalizeBillingCycle, normalizeStatus, usePolarBilling, useSubscription };
+export { type BillingCycle, type CancelResult, type CancellationReason, type CheckoutParams, type CheckoutResult, type FirebaseAdapterConfig, type OrderItem, type PolarAdapter, type PolarContextValue, PolarProvider, SUBSCRIPTION_STATUS, type SubscriptionStatus, type SubscriptionStatusValue, type SyncResult, createFirebaseAdapter, usePolarBilling };

package/dist/index.d.ts

@@ -1,11 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
 import { ReactNode } from 'react';
 
-/**
- * Subscription Entity
- * @description Types for subscription status and billing cycles
- */
 type SubscriptionStatusValue = 'active' | 'canceled' | 'revoked' | 'trialing' | 'past_due' | 'incomplete' | 'incomplete_expired' | 'unpaid' | 'none';
 type BillingCycle = 'monthly' | 'yearly';
 interface SubscriptionStatus {
@@ -16,14 +11,9 @@ interface SubscriptionStatus {
     currentPeriodEnd?: string;
     billingCycle?: BillingCycle;
     polarCustomerId?: string;
-    /** Token balance (for token-based projects like Aria) */
     tokens?: number;
 }
 
-/**
- * Order Entity
- * @description Types for billing history items
- */
 interface OrderItem {
     id: string;
     createdAt: string;
@@ -35,16 +25,11 @@ interface OrderItem {
     invoiceUrl?: string;
 }
 
-/**
- * Checkout Entity
- * @description Types for initiating and following process of checkouts
- */
 interface CheckoutParams {
     productId: string;
     planKey?: string;
     billingCycle?: 'monthly' | 'yearly';
     successUrl?: string;
-    /** Injected automatically by PolarProvider — do not pass manually */
     userId?: string;
 }
 interface CheckoutResult {
@@ -52,43 +37,47 @@ interface CheckoutResult {
     id: string;
 }
 
-/**
- * Cancellation Entity
- * @description Types for subscription cancellation reasons and outcomes
- */
 type CancellationReason = 'too_expensive' | 'missing_features' | 'switched_service' | 'unused' | 'customer_service' | 'low_quality' | 'too_complex' | 'other';
 interface CancelResult {
     success: boolean;
     endsAt?: string;
 }
 
-/**
- * Sync Entity
- * @description Type for subscription synchronization results
- */
 interface SyncResult {
     synced: boolean;
     plan?: string;
 }
 
-/**
- * Backend-agnostic interface every adapter must implement.
- * @description Contract for Polar billing adapters (Firebase, Supabase, etc.)
- */
 interface PolarAdapter {
     getStatus(userId: string): Promise<SubscriptionStatus>;
     createCheckout(params: CheckoutParams): Promise<CheckoutResult>;
-    /** checkoutId is read from URL by the context and passed explicitly */
     syncSubscription(userId: string, checkoutId?: string): Promise<SyncResult>;
     getBillingHistory(userId: string): Promise<OrderItem[]>;
     cancelSubscription(reason?: CancellationReason): Promise<CancelResult>;
     getPortalUrl(userId: string): Promise<string>;
 }
 
+interface PolarProviderProps {
+    adapter: PolarAdapter;
+    userId?: string;
+    children: ReactNode;
+}
+declare function PolarProvider({ adapter, userId, children }: PolarProviderProps): react_jsx_runtime.JSX.Element;
+
+interface PolarContextValue {
+    status: SubscriptionStatus;
+    loading: boolean;
+    refresh: () => Promise<void>;
+    startCheckout: (params: CheckoutParams) => Promise<void>;
+    syncSubscription: () => Promise<SyncResult>;
+    getBillingHistory: () => Promise<OrderItem[]>;
+    cancelSubscription: (reason?: CancellationReason) => Promise<CancelResult>;
+    getPortalUrl: () => Promise<string>;
+}
+declare function usePolarBilling(): PolarContextValue;
+
 interface FirebaseAdapterConfig {
-    /** Firebase Functions instance from firebase/functions */
     functions: unknown;
-    /** Firebase Firestore instance from firebase/firestore */
     firestore: unknown;
     callables?: {
         createCheckout?: string;
@@ -108,16 +97,8 @@ interface FirebaseAdapterConfig {
         currentPeriodEndField?: string;
     };
 }
-/**
- * Firebase Billing Service
- * @description Implementation of PolarAdapter for Firebase Functions and Firestore.
- */
 declare function createFirebaseAdapter(config: FirebaseAdapterConfig): PolarAdapter;
 
-/**
- * Billing Constants
- * @description Standardized subscription states and plan names
- */
 declare const SUBSCRIPTION_STATUS: Readonly<{
     ACTIVE: "active";
     CANCELED: "canceled";
@@ -129,46 +110,5 @@ declare const SUBSCRIPTION_STATUS: Readonly<{
     UNPAID: "unpaid";
     NONE: "none";
 }>;
-declare const FREE_PLAN = "free";
-
-/**
- * Normalize a raw Polar status string to a known value.
- * @description Defaults to 'none' for unknown statuses or non-string input.
- */
-declare function normalizeStatus(raw: string): SubscriptionStatusValue;
-/**
- * Normalize billing interval
- * @description Maps 'month'/'year' to 'monthly'/'yearly'. Defaults to 'monthly' for unknown values or non-string input.
- */
-declare function normalizeBillingCycle(interval: string): BillingCycle;
-
-/**
- * PolarProvider Component
- * @description Context provider for Polar billing management.
- */
-interface PolarProviderProps {
-    adapter: PolarAdapter;
-    userId?: string;
-    children: ReactNode;
-}
-declare function PolarProvider({ adapter, userId, children }: PolarProviderProps): react_jsx_runtime.JSX.Element;
-
-interface PolarContextValue {
-    status: SubscriptionStatus;
-    loading: boolean;
-    refresh: () => Promise<void>;
-    startCheckout: (params: CheckoutParams) => Promise<void>;
-    syncSubscription: () => Promise<SyncResult>;
-    getBillingHistory: () => Promise<OrderItem[]>;
-    cancelSubscription: (reason?: CancellationReason) => Promise<CancelResult>;
-    getPortalUrl: () => Promise<string>;
-}
-declare const PolarContext: react.Context<PolarContextValue | undefined>;
-/**
- * usePolarBilling Hook
- * @description Hook to access Polar billing context
- */
-declare function usePolarBilling(): PolarContextValue;
-declare const useSubscription: typeof usePolarBilling;
 
-export { type BillingCycle, type CancelResult, type CancellationReason, type CheckoutParams, type CheckoutResult, FREE_PLAN, type FirebaseAdapterConfig, type OrderItem, type PolarAdapter, PolarContext, type PolarContextValue, PolarProvider, SUBSCRIPTION_STATUS, type SubscriptionStatus, type SubscriptionStatusValue, type SyncResult, createFirebaseAdapter, normalizeBillingCycle, normalizeStatus, usePolarBilling, useSubscription };
+export { type BillingCycle, type CancelResult, type CancellationReason, type CheckoutParams, type CheckoutResult, type FirebaseAdapterConfig, type OrderItem, type PolarAdapter, type PolarContextValue, PolarProvider, SUBSCRIPTION_STATUS, type SubscriptionStatus, type SubscriptionStatusValue, type SyncResult, createFirebaseAdapter, usePolarBilling };