@payconductor/react 1.0.0

package/dist/payconductor/iframe/types.d.ts

@@ -0,0 +1,241 @@
+export declare enum PaymentMethod {
+    Pix = "Pix",
+    CreditCard = "CreditCard",
+    DebitCard = "DebitCard",
+    BankSlip = "BankSlip",
+    Crypto = "Crypto",
+    ApplePay = "ApplePay",
+    NuPay = "NuPay",
+    PicPay = "PicPay",
+    AmazonPay = "AmazonPay",
+    SepaDebit = "SepaDebit",
+    GooglePay = "GooglePay"
+}
+export declare enum PaymentMethodLayout {
+    Grid = "grid",
+    Vertical = "vertical",
+    Horizontal = "horizontal"
+}
+export declare enum PaymentStatus {
+    Succeeded = "succeeded",
+    Pending = "pending",
+    Failed = "failed"
+}
+export declare enum DeviceType {
+    Android = "android",
+    IOS = "ios",
+    Web = "web"
+}
+export declare enum InputStyleKey {
+    Padding = "padding",
+    Radius = "radius",
+    Color = "color",
+    Background = "background",
+    Shadow = "shadow"
+}
+export declare enum OutgoingMessage {
+    Init = "Init",
+    Config = "Config",
+    Update = "Update",
+    ConfirmPayment = "ConfirmPayment",
+    Validate = "Validate",
+    Reset = "Reset"
+}
+export declare enum IncomingMessage {
+    Ready = "Ready",
+    Error = "Error",
+    PaymentComplete = "PaymentComplete",
+    PaymentFailed = "PaymentFailed",
+    PaymentPending = "PaymentPending",
+    ValidationError = "ValidationError",
+    PaymentMethodSelected = "PaymentMethodSelected"
+}
+export declare enum ErrorCode {
+    InvalidClient = "InvalidClient",
+    InvalidToken = "InvalidToken",
+    NetworkError = "NetworkError",
+    IframeNotReady = "IframeNotReady",
+    PaymentDeclined = "PaymentDeclined",
+    ValidationError = "ValidationError",
+    Timeout = "Timeout"
+}
+export type InputStyleConfig = {
+    padding?: string;
+    radius?: string;
+    color?: string;
+    background?: string;
+    shadow?: string;
+};
+export type PaymentMethodsConfig = {
+    layout?: PaymentMethodLayout;
+    gap?: string;
+    inputStyle?: InputStyleConfig;
+};
+export type PaymentMethodConfig = {
+    method: PaymentMethod;
+    discount?: number;
+    showBrands?: boolean;
+    installments?: {
+        count: number;
+        amount: number;
+    }[];
+};
+export type PaymentMethodsResponse = {
+    methods: PaymentMethod[];
+    config: PaymentMethodsConfig;
+};
+export type PayConductorTheme = {
+    primaryColor?: string;
+    secondaryColor?: string;
+    backgroundColor?: string;
+    surfaceColor?: string;
+    textColor?: string;
+    textSecondaryColor?: string;
+    errorColor?: string;
+    successColor?: string;
+    warningColor?: string;
+    borderColor?: string;
+    disabledColor?: string;
+    fontFamily?: string;
+    fontSize?: {
+        xs?: string;
+        sm?: string;
+        md?: string;
+        lg?: string;
+        xl?: string;
+    };
+    fontWeight?: {
+        normal?: number;
+        medium?: number;
+        bold?: number;
+    };
+    lineHeight?: string;
+    spacing?: {
+        xs?: string;
+        sm?: string;
+        md?: string;
+        lg?: string;
+        xl?: string;
+    };
+    borderRadius?: string;
+    borderWidth?: string;
+    boxShadow?: string;
+    boxShadowHover?: string;
+    inputBackground?: string;
+    inputBorderColor?: string;
+    inputBorderRadius?: string;
+    inputHeight?: string;
+    inputPadding?: string;
+    buttonHeight?: string;
+    buttonPadding?: string;
+    buttonBorderRadius?: string;
+    transitionDuration?: string;
+    transitionTimingFunction?: string;
+};
+export declare const defaultTheme: PayConductorTheme;
+export type PayConductorConfig = {
+    publicKey: string;
+    orderId?: string;
+    theme?: PayConductorTheme;
+    locale?: string;
+    paymentMethods?: PaymentMethod[] | "all";
+    defaultPaymentMethod?: PaymentMethod;
+    paymentMethodsConfig?: PaymentMethodConfig[];
+    methodsDirection?: "vertical" | "horizontal";
+    showPaymentButtons?: boolean;
+    /** Required when NuPay is an available payment method */
+    nuPayConfig?: NuPayData;
+};
+export type BillingDetails = {
+    name: string;
+    email?: string;
+    phone?: string;
+    address?: {
+        line1: string;
+        line2?: string;
+        city: string;
+        state: string;
+        postalCode: string;
+        country: string;
+    };
+};
+export type CardData = {
+    number: string;
+    expMonth: string;
+    expYear: string;
+    cvc: string;
+};
+export type CreatePaymentMethodOptions = {
+    billingDetails: BillingDetails;
+    card?: CardData;
+};
+export type PaymentMethodResult = {
+    id: string;
+    type: PaymentMethod;
+    card?: {
+        brand: string;
+        last4: string;
+        expMonth: number;
+        expYear: number;
+    };
+    billingDetails?: BillingDetails;
+};
+export type PaymentResult = {
+    orderId: string;
+    status: PaymentStatus;
+    amount: number;
+    currency: string;
+    message?: string;
+};
+export interface MessagePayload {
+    type: OutgoingMessage | IncomingMessage;
+    data?: unknown;
+    requestId?: string;
+    error?: {
+        code: string;
+        message: string;
+        field?: string;
+    };
+}
+export type CardTokenData = {
+    token: string;
+    firstSixCardNumber?: string;
+};
+export type CardFullData = {
+    number: string;
+    holderName: string;
+    cvv: string;
+    expiration: {
+        month: number;
+        year: number;
+    };
+};
+export type CardPaymentData = CardTokenData | CardFullData;
+export type PixPaymentData = {
+    paymentMethod: PaymentMethod.Pix;
+    expirationInSeconds?: number;
+};
+export type CreditCardPaymentData = {
+    paymentMethod: PaymentMethod.CreditCard;
+    card: CardPaymentData;
+    installments: number;
+    softDescriptor?: string;
+};
+export type BankSlipPaymentData = {
+    paymentMethod: PaymentMethod.BankSlip;
+    expirationInDays?: number;
+};
+export type NuPayData = {
+    cancelUrl: string;
+    merchantName: string;
+    returnUrl: string;
+    storeName?: string;
+};
+export type NuPayPaymentData = {
+    paymentMethod: PaymentMethod.NuPay;
+    nuPay: NuPayData;
+};
+export type PicPayPaymentData = {
+    paymentMethod: PaymentMethod.PicPay;
+};
+export type PaymentConfirmData = PixPaymentData | CreditCardPaymentData | BankSlipPaymentData | NuPayPaymentData | PicPayPaymentData;

package/dist/payconductor/internal.d.ts

@@ -0,0 +1,11 @@
+import { IncomingMessage, OutgoingMessage, PayConductorConfig, PaymentMethod, PaymentResult } from './iframe/types';
+import { ConfirmPaymentOptions, PendingRequest } from './types';
+
+export declare function createPendingRequestsMap(): Map<string, PendingRequest>;
+export declare function sendMessageToIframe(iframe: HTMLIFrameElement | Element | undefined, pendingMap: Map<string, PendingRequest> | null, type: OutgoingMessage | IncomingMessage, data?: unknown): Promise<unknown>;
+export declare function confirmPayment(iframe: HTMLIFrameElement | Element | undefined, pendingMap: Map<string, PendingRequest> | null, options: ConfirmPaymentOptions): Promise<PaymentResult>;
+export declare function validatePayment(iframe: HTMLIFrameElement | Element | undefined, pendingMap: Map<string, PendingRequest> | null, data: unknown): Promise<boolean>;
+export declare function resetPayment(iframe: HTMLIFrameElement | Element | undefined, pendingMap: Map<string, PendingRequest> | null): Promise<void>;
+export declare function sendConfig(iframe: HTMLIFrameElement | Element | undefined, pendingMap: Map<string, PendingRequest> | null, config: Pick<PayConductorConfig, "theme" | "locale" | "paymentMethods" | "defaultPaymentMethod" | "showPaymentButtons" | "nuPayConfig">): Promise<void>;
+export declare function sendInit(iframe: HTMLIFrameElement | Element | undefined, pendingMap: Map<string, PendingRequest> | null, config: PayConductorConfig): Promise<void>;
+export declare function handleMessageEvent(event: MessageEvent, pendingMap: Map<string, PendingRequest> | null, setIsReady: (value: boolean) => void, setError: (value: string | null) => void, onReady?: () => void, onError?: (error: Error) => void, onPaymentComplete?: (data: PaymentResult) => void, onPaymentFailed?: (data: PaymentResult) => void, onPaymentPending?: (data: PaymentResult) => void, onPaymentMethodSelected?: (method: PaymentMethod) => void): void;

package/dist/payconductor/payconductor-element.d.ts

@@ -0,0 +1,5 @@
+export interface PayConductorCheckoutElementProps {
+    height?: string;
+}
+declare function PayConductorCheckoutElement(props: PayConductorCheckoutElementProps): import("react/jsx-runtime").JSX.Element;
+export default PayConductorCheckoutElement;

package/dist/payconductor/payconductor.d.ts

@@ -0,0 +1,14 @@
+import { PayConductorConfig, PaymentMethod, PaymentResult } from './iframe/types';
+export interface PayConductorEmbedProps extends Omit<PayConductorConfig, "orderId"> {
+    children?: any;
+    showActionButtons?: boolean;
+    debug?: boolean;
+    onReady?: () => void;
+    onError?: (error: Error) => void;
+    onPaymentComplete?: (result: PaymentResult) => void;
+    onPaymentFailed?: (result: PaymentResult) => void;
+    onPaymentPending?: (result: PaymentResult) => void;
+    onPaymentMethodSelected?: (method: PaymentMethod) => void;
+}
+declare function PayConductor(props: PayConductorEmbedProps): import("react/jsx-runtime").JSX.Element;
+export default PayConductor;

package/dist/payconductor/types.d.ts

@@ -0,0 +1,44 @@
+import { PayConductorConfig, PaymentMethod, PaymentResult } from './iframe/types';
+
+export type * from './iframe/types';
+export type ConfirmPaymentOptions = {
+    orderId: string;
+    returnUrl?: string;
+};
+export type SubmitResult = {
+    error?: {
+        message: string;
+        code?: string;
+        type?: "validation_error" | "payment_error";
+    };
+    paymentMethod?: PaymentMethod;
+};
+export type PayConductorApi = {
+    confirmPayment: (options: ConfirmPaymentOptions) => Promise<PaymentResult>;
+    validate: (data: unknown) => Promise<boolean>;
+    reset: () => Promise<void>;
+    getSelectedPaymentMethod: () => PaymentMethod | null;
+};
+export type PayConductorFrame = {
+    iframe: HTMLIFrameElement | Element | unknown | null;
+    iframeUrl?: string;
+    isReady: boolean;
+    error: string | null;
+};
+export type PayConductorContextValue = {
+    frame: PayConductorFrame | null;
+    config: PayConductorConfig | null;
+    api: PayConductorApi;
+    selectedPaymentMethod?: PaymentMethod | null;
+};
+export type PayConductorState = {
+    isLoaded: boolean;
+    isReady: boolean;
+    error: string | null;
+    iframeUrl: string;
+    selectedPaymentMethod: PaymentMethod | null;
+};
+export type PendingRequest = {
+    resolve: (value: unknown) => void;
+    reject: (error: unknown) => void;
+};

package/dist/payconductor/utils.d.ts

@@ -0,0 +1,5 @@
+import { PayConductorConfig } from './iframe/types';
+
+export declare function buildIframeUrl(config: PayConductorConfig): string;
+export declare function generateRequestId(): string;
+export declare function isValidOrigin(origin: string, allowedOrigins: string[]): boolean;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@payconductor/react",
+  "version": "1.0.0",
+  "description": "React SDK for PayConductor",
+  "type": "module",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -b && vite build",
+    "build:watch": "vite build --watch",
+    "dev": "vite build --watch"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/payconductor-ai/payconductor-sdk-web"
+  },
+  "bugs": {
+    "url": "https://github.com/payconductor-ai/payconductor-sdk-web/issues"
+  },
+  "homepage": "https://github.com/payconductor-ai/payconductor-sdk-web#readme",
+  "license": "MIT",
+  "author": "PayConductor",
+  "keywords": [
+    "payconductor",
+    "payment",
+    "gateway",
+    "react",
+    "sdk",
+    "checkout"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.9.0"
+  }
+}