@paddle/paddle-js/types/index.d.ts

Wrapper to load Paddle.js as a module and use TypeScript definitions when working with methods.

import {
  CheckoutLineItem,
  CheckoutOpenLineItem,
  CheckoutOpenOptions,
  PaddleSetupOptions,
  CheckoutSettings,
  PaddleEventData,
  PaddleSetupPwCustomer,
  CheckoutUpdateOptions,
  CheckoutUpsell,
  CheckoutUpsellSettings,
} from './checkout/checkout';
import { CheckoutCustomer, CheckoutCustomerAddress, CheckoutCustomerBusiness } from './checkout/customer';
import { PricePreviewItem, PricePreviewParams, PricePreviewResponse } from './price-preview/price-preview';
import {
  RetainCancellationFlowAttributeProps,
  RetainCancellationFlowResult,
  RetainDemoAttributeProps,
} from './checkout/retain';
import {
  TransactionPreviewParams,
  TransactionPreviewResponse,
  TransactionPreviewItem,
} from './transaction-preview/transaction-preview';

export * from './shared/shared';

export { CurrencyCode } from './shared/currency-code';
export { CountryCode } from './shared/country-code';

export {
  CheckoutEventNames,
  CheckoutEventsCustomer,
  CheckoutEventsItem,
  CheckoutEventsPayment,
  CheckoutEventsPaymentMethodDetails,
  CheckoutEventsPaymentMethodCardDetails,
  CheckoutEventsPaymentMethodTypes,
  CheckoutEventsCustomerAddress,
  CheckoutEventsCustomerBusiness,
  CheckoutEventsData,
  CheckoutEventsPaymentMethodCardTypes,
  CheckoutEventsDiscount,
  CheckoutEventsItemProduct,
  CheckoutEventsSettings,
  CheckoutEventsStatus,
  CheckoutEventsTimePeriod,
  CheckoutEventsTimePeriodInterval,
  CheckoutEventsTotals,
  CheckoutEventError,
  CheckoutEventUpsell,
} from './checkout/events';

export type DisplayMode = 'inline' | 'overlay';
export type Environments = 'production' | 'sandbox';
export type Version = 'classic' | 'v1';
export type Theme = 'light' | 'dark';

export {
  PaddleSetupPwCustomer,
  CheckoutOpenOptions,
  CheckoutUpdateOptions,
  PaddleSetupOptions,
  CheckoutLineItem,
  CheckoutOpenLineItem,
  CheckoutSettings,
  PaddleEventData,
  CheckoutCustomer,
  CheckoutCustomerAddress,
  CheckoutCustomerBusiness,
  PricePreviewItem,
  PricePreviewParams,
  PricePreviewResponse,
  RetainCancellationFlowAttributeProps,
  RetainCancellationFlowResult,
  RetainDemoAttributeProps,
  TransactionPreviewItem,
  TransactionPreviewParams,
  TransactionPreviewResponse,
  CheckoutUpsellSettings,
  CheckoutUpsell,
};

export interface Paddle {
  Checkout: {
    open(input: CheckoutOpenOptions): void;
    updateCheckout(input: CheckoutUpdateOptions): void;
    updateItems(items: CheckoutLineItem[]): void;
    close(): void;
  };
  Environment: {
    set(environment: Environments): void;
  };
  Retain: {
    demo: (parameters: RetainDemoAttributeProps) => void;
    initCancellationFlow: (parameters: RetainCancellationFlowAttributeProps) => Promise<RetainCancellationFlowResult>;
  };
  PricePreview: (params: PricePreviewParams) => Promise<PricePreviewResponse>;
  TransactionPreview: (params: TransactionPreviewParams) => Promise<TransactionPreviewResponse>;
  /**
    @deprecated. Use `Paddle.Initialize` instead.
   */
  Setup(options: PaddleSetupOptions): void;
  Spinner: {
    show(): void;
    hide(): void;
  };
  Status: {
    libraryVersion: string;
  };
  Initialized: boolean;
  Initialize(options: PaddleSetupOptions): void;
  Update(options: Partial<PaddleSetupOptions>): void;
  Version: Version;
}

declare global {
  interface Window {
    // Paddle.JS will be downloaded directly from our CDN and added to global variable
    // We don't recommend using `Paddle` or `PaddleBillingV1` or `PaddleClassic` directly.
    // Please use `getPaddleInstance` function to get Paddle instance.
    Paddle?: Paddle | undefined;
    PaddleBillingV1?: Paddle | undefined;
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    PaddleClassic?: any;
  }
}

export type InitializePaddleOptions = PaddleSetupOptions & {
  version?: Version;
  environment?: Environments;
};

export function initializePaddle(options?: InitializePaddleOptions): Promise<Paddle | undefined>;
export function getPaddleInstance(version: 'v1'): Paddle | undefined;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function getPaddleInstance(version: 'classic'): any;
export function getPaddleInstance(): Paddle | undefined;