@stigg/react-sdk 5.26.0 → 5.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/dist/components/BooleanEntitlementGuard.d.ts +8 -0
  2. package/dist/components/MeteredEntitlementGuard.d.ts +8 -0
  3. package/dist/components/NumericEntitlementGuard.d.ts +8 -0
  4. package/dist/components/StiggProvider.d.ts +1 -1
  5. package/dist/hooks/index.d.ts +7 -0
  6. package/dist/hooks/useActiveSubscriptions.d.ts +6 -0
  7. package/dist/hooks/useBooleanEntitlement.d.ts +5 -0
  8. package/dist/hooks/useCustomerPortal.d.ts +6 -0
  9. package/dist/hooks/useFetch.d.ts +8 -0
  10. package/dist/hooks/useMeteredEntitlement.d.ts +6 -0
  11. package/dist/hooks/useNumericEntitlement.d.ts +6 -0
  12. package/dist/hooks/usePaywall.d.ts +6 -0
  13. package/dist/hooks/useStiggContext.d.ts +7 -0
  14. package/dist/index.d.ts +5 -1
  15. package/dist/react-sdk.cjs.development.js +449 -200
  16. package/dist/react-sdk.cjs.development.js.map +1 -1
  17. package/dist/react-sdk.cjs.production.min.js +1 -1
  18. package/dist/react-sdk.cjs.production.min.js.map +1 -1
  19. package/dist/react-sdk.esm.js +442 -202
  20. package/dist/react-sdk.esm.js.map +1 -1
  21. package/package.json +2 -2
  22. package/src/components/BooleanEntitlementGuard.tsx +22 -0
  23. package/src/components/MeteredEntitlementGuard.tsx +22 -0
  24. package/src/components/NumericEntitlementGuard.tsx +22 -0
  25. package/src/components/StiggProvider.tsx +4 -9
  26. package/src/components/checkout/hooks/useLoadCheckout.ts +1 -1
  27. package/src/components/checkout/hooks/usePreviewSubscription.ts +1 -1
  28. package/src/components/customerPortal/hooks/useCustomerPortal.ts +1 -1
  29. package/src/components/hooks/useWaitForCheckoutCompleted.ts +1 -1
  30. package/src/components/paywall/hooks/useLoadPaywallData.ts +1 -1
  31. package/src/hooks/index.ts +7 -0
  32. package/src/hooks/useActiveSubscriptions.ts +21 -0
  33. package/src/hooks/useBooleanEntitlement.ts +20 -0
  34. package/src/hooks/useCustomerPortal.ts +21 -0
  35. package/src/hooks/useFetch.ts +31 -0
  36. package/src/hooks/useMeteredEntitlement.ts +20 -0
  37. package/src/hooks/useNumericEntitlement.ts +20 -0
  38. package/src/hooks/usePaywall.ts +21 -0
  39. package/src/hooks/useStiggContext.ts +13 -0
  40. package/src/index.ts +13 -7
  41. package/src/theme/Theme.tsx +2 -1
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ import { GetBooleanEntitlement } from '@stigg/js-client-sdk';
3
+ declare type BooleanEntitlementGuardProps = GetBooleanEntitlement & {
4
+ noAccessComponent?: React.ReactNode;
5
+ children: React.ReactElement;
6
+ };
7
+ export declare function BooleanEntitlementGuard({ noAccessComponent, children, ...rest }: BooleanEntitlementGuardProps): JSX.Element;
8
+ export {};
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ import { GetMeteredEntitlement } from '@stigg/js-client-sdk';
3
+ declare type MeteredEntitlementGuardProps = GetMeteredEntitlement & {
4
+ noAccessComponent?: React.ReactNode;
5
+ children: React.ReactElement;
6
+ };
7
+ export declare function MeteredEntitlementGuard({ noAccessComponent, children, ...rest }: MeteredEntitlementGuardProps): JSX.Element;
8
+ export {};
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ import { GetNumericEntitlement } from '@stigg/js-client-sdk';
3
+ declare type NumericEntitlementGuardProps = GetNumericEntitlement & {
4
+ noAccessComponent?: React.ReactNode;
5
+ children: React.ReactElement;
6
+ };
7
+ export declare function NumericEntitlementGuard({ noAccessComponent, children, ...rest }: NumericEntitlementGuardProps): JSX.Element;
8
+ export {};
@@ -23,6 +23,7 @@ export declare type StiggProviderProps = {
23
23
  resourceId?: string;
24
24
  theme?: CustomizedTheme;
25
25
  locale?: string;
26
+ offline?: boolean;
26
27
  cacheTtlMs?: number;
27
28
  /** @deprecated not longer in use */
28
29
  useEntitlementPolling?: boolean;
@@ -33,4 +34,3 @@ export declare type StiggProviderProps = {
33
34
  clientVersion?: string;
34
35
  };
35
36
  export declare const StiggProvider: React.FC<PropsWithChildren<StiggProviderProps>>;
36
- export declare const useStiggContext: () => StiggContextValue;
@@ -0,0 +1,7 @@
1
+ export { useBooleanEntitlement } from './useBooleanEntitlement';
2
+ export { useNumericEntitlement } from './useNumericEntitlement';
3
+ export { useMeteredEntitlement } from './useMeteredEntitlement';
4
+ export { useActiveSubscriptions } from './useActiveSubscriptions';
5
+ export { usePaywall } from './usePaywall';
6
+ export { useCustomerPortal } from './useCustomerPortal';
7
+ export { useStiggContext } from './useStiggContext';
@@ -0,0 +1,6 @@
1
+ import { GetActiveSubscriptions } from '@stigg/js-client-sdk';
2
+ export declare function useActiveSubscriptions(params?: GetActiveSubscriptions): {
3
+ activeSubscriptions: import("@stigg/js-client-sdk").Subscription[] | null;
4
+ isLoaded: boolean;
5
+ error: Error | null;
6
+ };
@@ -0,0 +1,5 @@
1
+ import { BooleanEntitlement, GetBooleanEntitlement } from '@stigg/js-client-sdk';
2
+ export declare type TypedGetBooleanEntitlement<T> = Omit<GetBooleanEntitlement, 'featureId'> & {
3
+ featureId: T;
4
+ };
5
+ export declare function useBooleanEntitlement<T extends string>(params: TypedGetBooleanEntitlement<T>): BooleanEntitlement;
@@ -0,0 +1,6 @@
1
+ import { GetCustomerPortal } from '@stigg/js-client-sdk';
2
+ export declare function useCustomerPortal(params?: GetCustomerPortal): {
3
+ customerPortal: import("@stigg/js-client-sdk").CustomerPortal | null;
4
+ isLoaded: boolean;
5
+ error: Error | null;
6
+ };
@@ -0,0 +1,8 @@
1
+ export declare type FetchResult<T> = {
2
+ isLoaded: boolean;
3
+ error: Error | null;
4
+ data: T | null;
5
+ };
6
+ export declare function useFetch<T>({ func }: {
7
+ func: () => Promise<T>;
8
+ }): FetchResult<T>;
@@ -0,0 +1,6 @@
1
+ import { GetMeteredEntitlement, MeteredEntitlement } from '@stigg/js-client-sdk';
2
+ declare type TypedGetMeteredEntitlement<T> = Omit<GetMeteredEntitlement, 'featureId'> & {
3
+ featureId: T;
4
+ };
5
+ export declare function useMeteredEntitlement<T extends string>(params: TypedGetMeteredEntitlement<T>): MeteredEntitlement;
6
+ export {};
@@ -0,0 +1,6 @@
1
+ import { NumericEntitlement, GetNumericEntitlement } from '@stigg/js-client-sdk';
2
+ declare type TypedGetNumericEntitlement<T> = Omit<GetNumericEntitlement, 'featureId'> & {
3
+ featureId: T;
4
+ };
5
+ export declare function useNumericEntitlement<T extends string>(params: TypedGetNumericEntitlement<T>): NumericEntitlement;
6
+ export {};
@@ -0,0 +1,6 @@
1
+ import { GetPaywall } from '@stigg/js-client-sdk';
2
+ export declare function usePaywall(params?: GetPaywall): {
3
+ paywall: import("@stigg/js-client-sdk").Paywall | null;
4
+ isLoaded: boolean;
5
+ error: Error | null;
6
+ };
@@ -0,0 +1,7 @@
1
+ import { StiggContextValue } from '../components/StiggProvider';
2
+ export declare function useStiggContext(options?: {
3
+ optional?: false;
4
+ }): StiggContextValue;
5
+ export declare function useStiggContext(options: {
6
+ optional: true;
7
+ }): StiggContextValue | null;
package/dist/index.d.ts CHANGED
@@ -2,8 +2,12 @@ import './styles.css';
2
2
  export * from '@stigg/js-client-sdk';
3
3
  export { Paywall, PaywallProps, OnPlanSelectedCallbackFn, PaywallPlan, SubscribeIntentionType, PaywallLocalization, PlanPriceText, CurrentPlanParams, PaywallData, SelectDefaultTierIndexFn, ShouldHidePlanFn, } from './components/paywall';
4
4
  export { CustomerPortalProvider, CustomerPortal, CustomerPortalProps, CustomerPortalSection, AddonsList, PaymentDetailsSection, InvoicesSection, CustomerUsageData, CustomerUsageDataProps, SubscriptionsOverview, SubscriptionsOverviewProps, Promotions, CustomerPortalIntentionType, OnBuyMoreCallbackFn, OnManageSubscriptionFn, CustomerPortalLocalization, CustomerPortalTheme, } from './components/customerPortal';
5
- export { StiggProvider, StiggProviderProps, useStiggContext, StiggContextValue, StiggContext, } from './components/StiggProvider';
5
+ export { StiggProvider, StiggProviderProps, StiggContextValue, StiggContext } from './components/StiggProvider';
6
6
  export { Checkout, CheckoutProps, CheckoutProviderProps, CheckoutContainerProps, CheckoutLocalization, CheckoutResult, OnCheckoutCompletedParams, OnCheckoutParams, CheckoutTheme, CheckoutMockProps, MockCheckoutPreviewCallback, MockCheckoutStateCallback, BillingInformation, TaxDetailsInput, } from './components/checkout';
7
7
  export { useWaitForCheckoutCompleted, ProvisionStatus } from './components/hooks';
8
+ export { useBooleanEntitlement, useMeteredEntitlement, useNumericEntitlement, useActiveSubscriptions, useCustomerPortal, useStiggContext, usePaywall, } from './hooks';
8
9
  export { HorizontalAlignment, TextAlignment, FontVariant, FontWeight, StiggTheme } from './theme/types';
9
10
  export { CustomizedTheme as Theme } from './theme/Theme';
11
+ export { BooleanEntitlementGuard } from './components/BooleanEntitlementGuard';
12
+ export { NumericEntitlementGuard } from './components/NumericEntitlementGuard';
13
+ export { MeteredEntitlementGuard } from './components/MeteredEntitlementGuard';