@kelviq/react-sdk 2.0.2-beta → 2.1.0

package/dist/components/KQFeatureList.d.ts

@@ -0,0 +1,19 @@
+import { ReactNode } from 'react';
+import { RawPricingFeature, RawPricingPlan } from '../types/api.types';
+export interface KQFeatureListProps {
+    /** The plan identifier to display features for. */
+    planIdentifier: string;
+    /** Render function called for each feature in the plan. */
+    children: (data: {
+        feature: RawPricingFeature;
+        plan: RawPricingPlan;
+        index: number;
+    }) => ReactNode;
+    /** Shown while pricing data is loading. */
+    loadingComponent?: ReactNode;
+    /** Shown when the plan is not found or has no features. */
+    fallback?: ReactNode;
+    /** Optional filter to show only specific feature types. */
+    featureType?: 'BOOLEAN' | 'METER';
+}
+export declare const KQFeatureList: React.FC<KQFeatureListProps>;

package/dist/components/KQPrice.d.ts

@@ -0,0 +1,29 @@
+import { ReactNode } from 'react';
+import { RawPricingPlan, RawPricingCharge } from '../types/api.types';
+import { KQFormatPriceOptions } from '../utils/formatPrice';
+export interface KQPriceProps {
+    /** The plan identifier to display pricing for. */
+    planIdentifier: string;
+    /** The billing period to show (e.g. "MONTHLY", "YEARLY", "ONE_TIME"). */
+    billingPeriod: string;
+    /** Options for the formattedPrice string. */
+    formatOptions?: KQFormatPriceOptions;
+    /** Render function receiving price data and currency info. */
+    children: (data: {
+        plan: RawPricingPlan;
+        charge: RawPricingCharge | null;
+        amount: number;
+        formattedPrice: string;
+        currencySymbol: string;
+        currencyCode: string;
+        pricingLocale: string;
+        isFree: boolean;
+        hasFreeTrial: boolean;
+        trialPeriod: number;
+    }) => ReactNode;
+    /** Shown while pricing data is loading. */
+    loadingComponent?: ReactNode;
+    /** Shown when the plan is not found or pricing data is unavailable. */
+    fallback?: ReactNode;
+}
+export declare const KQPrice: React.FC<KQPriceProps>;

package/dist/contexts/KelviqContext.d.ts

@@ -1,6 +1,6 @@
 import { Entitlement, EntitlementMap, EntitlementsResponse } from '../types/sdk.types';
 import { AsyncState } from '../types';
-import { RawSubscriptionData, RawCustomerApiResponse } from '../types/api.types';
+import { RawSubscriptionData, RawCustomerApiResponse, RawPricingApiResponse } from '../types/api.types';
 /** Defines the shape of the context value provided by KelviqProvider. */
 export interface KelviqContextValue {
     allEntitlements: AsyncState<EntitlementMap | null>;
@@ -23,9 +23,13 @@ export interface KelviqContextValue {
     customer: AsyncState<RawCustomerApiResponse | null>;
     /** Manually refresh customer data. */
     refreshCustomer: () => Promise<void>;
+    /** Pricing data with localized currency. Only populated when fetchPricingOnMount is true. */
+    pricing: AsyncState<RawPricingApiResponse | null>;
+    /** Manually refresh pricing data. */
+    refreshPricing: () => Promise<void>;
     isLoading: boolean;
     error: Error | null;
-    customerId: string;
+    customerId?: string;
     environment: string;
     apiUrl: string;
     entitlementsPath: string;

package/dist/contexts/KelviqProvider.d.ts

@@ -6,11 +6,13 @@ interface KelviqProviderProps {
     apiUrl?: string;
     /** Path for fetching all entitlements (e.g., "/entitlements"). Required. */
     entitlementsPath?: string;
-    /** The customer ID. Required. */
-    customerId: string;
+    /** The customer ID. Required for entitlements, subscriptions, and customer data. Optional for pricing. */
+    customerId?: string;
     environment?: 'production' | 'sandbox';
     /** Optional: The static authentication token string for API requests. */
     accessToken: string | null;
+    /** Optional: Product identifier for fetching pricing data. Required when fetchPricingOnMount is true. */
+    productId?: string;
     /** Optional: Further configuration options for API behavior. */
     config?: KelviqApiBehaviorOptions;
 }

package/dist/hooks/usePricing.d.ts

@@ -0,0 +1,9 @@
+import { AsyncState } from '../types';
+import { RawPricingApiResponse } from '../types/api.types';
+/**
+ * Hook to get pricing and plan data with localized currency.
+ * Only populated when `fetchPricingOnMount` is enabled in the provider config,
+ * or after calling `refreshPricing()` from `useKelviq()`.
+ * @returns AsyncState containing the pricing data or null.
+ */
+export declare const usePricing: () => AsyncState<RawPricingApiResponse | null>;

package/dist/index.d.ts

@@ -11,3 +11,7 @@ export * from './hooks/useCustomizableEntitlement';
 export * from './hooks/useMeteredEntitlement';
 export * from './hooks/useSubscriptions';
 export * from './hooks/useCustomer';
+export * from './hooks/usePricing';
+export * from './components/KQPrice';
+export * from './components/KQFeatureList';
+export * from './utils/formatPrice';