@paynl/payparts-types 1.4.0-alpha.93

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types-pkg/src/index';

package/dist/src/core/errors/PaymentError.d.ts

@@ -0,0 +1,9 @@
+import { ApiErrorResponse, ApiFieldError } from './api-error-response';
+export declare class PaymentError extends Error {
+    readonly errorId: string;
+    readonly errorTag: string;
+    readonly errorMessage: string;
+    readonly fieldErrors?: ApiFieldError[] | undefined;
+    constructor(errorId: string, errorTag: string, errorMessage: string, fieldErrors?: ApiFieldError[] | undefined);
+    static fromResponse(response: ApiErrorResponse): PaymentError;
+}

package/dist/src/core/errors/api-error-response.d.ts

@@ -0,0 +1,10 @@
+export interface ApiFieldError {
+    field: string;
+    message: string;
+}
+export interface ApiErrorResponse {
+    errorId: string;
+    errorTag: string;
+    errorMessage: string;
+    fieldErrors?: ApiFieldError[];
+}

package/dist/src/core/payment-status.d.ts

@@ -0,0 +1,10 @@
+export type PaymentOutcome = 'success' | 'failure' | 'pending' | 'unknown';
+export interface PaymentStatusInfo {
+    code: number;
+    action: string;
+    outcome: PaymentOutcome;
+}
+export declare function getPaymentOutcome(code: number): PaymentOutcome;
+export declare function isSuccessfulPayment(code: number): boolean;
+export declare function isFailedPayment(code: number): boolean;
+export declare function isPendingPayment(code: number): boolean;

package/dist/src/core/types.d.ts

@@ -0,0 +1,655 @@
+export interface OrderPaymentStatus {
+    code: number;
+    action: string;
+}
+export interface OrderPaymentMethodInfo {
+    id: number;
+    name?: string;
+    icon?: string;
+}
+export interface OrderPaymentInfo {
+    id: string;
+    paymentMethod: OrderPaymentMethodInfo;
+    amount: AmountDto;
+    capturedAmount: AmountDto;
+    authorizedAmount: AmountDto;
+    status: OrderPaymentStatus;
+    state: string;
+}
+export interface PartialPaymentUpdate {
+    orderId: string;
+    isFullyPaid: boolean;
+    transaction: {
+        transactionId: string;
+        amount: AmountDto;
+    };
+    order: {
+        amount: AmountDto;
+        authorizedAmount: AmountDto;
+        capturedAmount: AmountDto;
+        payments: OrderPaymentInfo[];
+    };
+}
+export interface PaymentMethodContext {
+    method: PaymentMethod;
+    amount: number;
+    currency: string;
+    language: string;
+    apiUrl: string;
+    config: CheckoutConfig;
+    getConfig: () => Readonly<Required<CheckoutConfig>>;
+    onSubmit: (data: {
+        method: string;
+        details?: Record<string, unknown>;
+    }) => void;
+    onError: (error: {
+        message: string;
+        errorId?: string;
+        errorTag?: string;
+        errors?: FieldError[];
+    }, errorId?: string, result?: string) => void;
+    onSuccess?: (data: {
+        orderId: string;
+        returnUrl: string;
+        threeDs?: ThreeDsData;
+        transaction?: TransactionData;
+    }) => void;
+    onPartialPaid?: (data: PartialPaymentEventData) => void;
+    onInfoUpdated?: (data: InfoUpdatedEvent['data']) => void;
+    onShippingUpdated?: (data: ShippingUpdatedEvent['data']) => void;
+}
+export interface InternalPaymentMethodContext extends PaymentMethodContext {
+    /** @internal */
+    _updatePartialPayment?: (response: PartialPaymentUpdate) => void;
+    /** @internal Returns the amount to display for payment (accounts for partial payments) */
+    _getOutstandingAmount: () => {
+        value: number;
+        currency: string;
+    };
+}
+export interface LocationTranslations {
+    name?: Record<string, string>;
+}
+export interface MerchantInfo {
+    code: string;
+    name: string;
+    status: string;
+}
+export interface CategoryInfo {
+    code: string;
+    name: string;
+}
+export interface PaymentMethodOption {
+    id?: string;
+    name?: unknown;
+    image?: string;
+}
+export interface CheckoutTranslations {
+    name?: unknown;
+    description?: unknown;
+    minAge?: unknown;
+}
+export interface PaymentMethod {
+    id: number;
+    name: string;
+    description?: unknown;
+    translations?: CheckoutTranslations;
+    image?: string;
+    payLink?: string;
+    targetCountries: string[];
+    options?: PaymentMethodOption[];
+    settings?: unknown;
+    minAmount: number;
+    maxAmount: number;
+}
+export interface CheckoutOption {
+    tag: string;
+    id: number;
+    smartGrouping: boolean;
+    name?: unknown;
+    translations?: CheckoutTranslations;
+    image?: string;
+    paymentMethods: PaymentMethod[];
+    requiredFields?: unknown;
+}
+export interface SequenceGroup {
+    primary: string[];
+    secondary: string[];
+}
+export interface CheckoutSequence {
+    default: SequenceGroup;
+    NL?: SequenceGroup;
+    BE?: SequenceGroup;
+}
+export type CountrySequence = 'NL' | 'BE';
+export interface LocationInfo {
+    code: string;
+    testMode: boolean;
+    name: string;
+    translations?: {
+        name?: Record<string, string>;
+    };
+    status: string;
+    merchant?: {
+        code: string;
+        name: string;
+        status: string;
+    };
+    category?: {
+        code: string;
+        name: string;
+    };
+}
+export interface AmountDto {
+    value: number;
+    currency: string;
+    formatted?: string;
+}
+export interface PaymentMethodInputDto {
+    cardNumber?: string;
+    pincode?: string;
+}
+export interface SessionPaymentMethodInfo {
+    id: number;
+    input?: PaymentMethodInputDto;
+}
+export interface PaymentStatusDto {
+    code: number;
+    action: string;
+}
+export interface SessionPaymentInfo {
+    id: string;
+    paymentMethod: number;
+    paymentMethodName?: string;
+    paymentMethodImage?: string;
+    amount: AmountDto;
+    capturedAmount: AmountDto;
+    authorizedAmount: AmountDto;
+    status: string;
+    last4?: string;
+}
+export interface PaymentInfo {
+    id: string;
+    paymentMethod: number;
+    paymentMethodName?: string;
+    paymentMethodImage?: string;
+    amount: AmountDto;
+    capturedAmount: AmountDto;
+    authorizedAmount: AmountDto;
+    status: string;
+}
+export interface CheckoutConfig {
+    sessionToken?: string;
+    sessionId?: string;
+    apiUrl: string;
+    language?: string;
+    /**
+     * Country for payment method sequencing.
+     * Independent from language - controls which checkoutSequence to use (NL, BE, or default).
+     * Use 'NL' for Nederland, 'BE' for België, or 'DEFAULT' for default sequence.
+     */
+    country?: 'DEFAULT' | 'NL' | 'BE';
+    /**
+     * Custom translations to override or extend default translations.
+     * Object with translation keys and values.
+     */
+    translations?: Record<string, unknown>;
+    amount?: number;
+    currency?: string;
+    merchantName?: string;
+    checkoutOptions?: CheckoutOption[];
+    checkoutSequence?: CheckoutSequence;
+    creditCard?: {
+        brands: string[];
+        assets?: {
+            brandIcons: Record<string, string>;
+        };
+    };
+    customer?: CustomerInfo;
+    order?: OrderInfo;
+    payments?: SessionPaymentInfo[];
+    capturedAmount?: AmountDto;
+    authorizedAmount?: AmountDto;
+    outstandingAmount?: AmountDto;
+    isFullyPaid?: boolean;
+    applePayOptions?: ApplePayOptions;
+    paypalOptions?: PayPalOptions;
+    /**
+     * Link mode for payment methods - controls how the payment URL is opened.
+     * 'same_page' (default) - navigate to the payment URL in the same tab
+     * 'new_tab' - open the payment URL in a new tab
+     */
+    methodLinkMode?: 'new_tab' | 'same_page';
+    debugMode?: boolean;
+    /**
+     * Payment method tags to exclude from display (e.g., ['PM_10', 'PM_11']).
+     * These methods will not be shown in the payment methods list.
+     */
+    excludedMethods?: string[];
+}
+export interface PaymentInfo {
+    method: 'creditcard' | 'paypal' | 'ideal' | 'bancontact' | 'sepa';
+    details?: Record<string, unknown>;
+}
+export type CheckoutState = 'NOT_READY' | 'INITIALIZING' | 'READY';
+export interface InitialisingEventData {
+    state: CheckoutState;
+}
+export interface ReadyEventData {
+    state: CheckoutState;
+    config: Readonly<Required<CheckoutConfig>>;
+}
+export interface StateChangeEventData {
+    previousState: CheckoutState;
+    currentState: CheckoutState;
+}
+export interface PaymentSubmitEventData {
+    method: string;
+    details?: Record<string, unknown>;
+}
+export interface PaymentErrorEventData {
+    error: string;
+    errorId?: string;
+    result?: string;
+}
+export interface PaymentSuccessEventData {
+    orderId?: string;
+    returnUrl?: string;
+    threeDs?: ThreeDsData;
+    transaction?: TransactionData;
+}
+export interface PartialPaymentEventData {
+    orderId: string;
+    amountPaid: number;
+    amountRemaining: number;
+    currency: string;
+    transactionId?: string;
+}
+export interface ThreeDsData {
+    nextAction?: string;
+    challengeType?: string;
+    challengeForm?: string;
+    challengeFullScreen?: string;
+    challengeWindowWidth?: string;
+    challengeWindowHeight?: string;
+    tdsApiURLStatus?: string;
+    tdsMode?: string;
+    acquirerID?: string;
+    transactionID?: string;
+    transactionStatusCode?: string;
+    checkStatusInterval?: string;
+    challengeValidUntil?: string;
+    threeDSMethodURL?: string;
+    threeDSMethodData?: string;
+}
+export interface TransactionData {
+    transactionId?: string;
+    orderId?: string;
+    paymentProfileId?: string;
+    state?: string;
+    stateName?: string;
+    amount?: {
+        value: number;
+        currency: string;
+    };
+    created?: number;
+    identifierName?: string;
+    identifierPublic?: string;
+    identifierHash?: string;
+    startIpAddress?: string;
+    completedIpAddress?: string;
+    orderNumber?: string;
+    amountOriginal?: {
+        value: number;
+        currency: string;
+    };
+    amountPaidOriginal?: {
+        value: number;
+        currency: string;
+    };
+    amountPaid?: {
+        value: number;
+        currency: string;
+    };
+    amountRefundOriginal?: {
+        value: number;
+        currency: string;
+    };
+    amountRefund?: {
+        value: number;
+        currency: string;
+    };
+    entranceCode?: string;
+}
+export type CheckoutEventType = 'initialising' | 'ready' | 'state:change' | 'payment:submit' | 'payment:success' | 'payment:error' | 'cancel' | 'close' | 'infoUpdated' | 'shippingUpdated';
+export interface MountOptions {
+    target: string | HTMLElement;
+    config: CheckoutConfig;
+    events?: MountEventHandlers;
+}
+export interface MountEventHandlers {
+    onStateChange?: (state: CheckoutState) => void;
+    onReady?: (data: ReadyEventData) => void;
+    onPaymentSubmit?: (data: PaymentSubmitEventData) => void;
+    onPaymentSuccess?: (data: PaymentSuccessEventData) => void;
+    onPaymentError?: (data: PaymentErrorEventData) => void;
+    onCancel?: () => void;
+    onClose?: () => void;
+    onSubmit?: (event: PaymentSubmitEvent) => void;
+    onSuccess?: (event: PaymentSuccessEvent) => void;
+    onError?: (event: PaymentErrorEvent) => void;
+    onPartialPaid?: (event: PartialPaymentEvent) => void;
+    onInfoUpdated?: (event: InfoUpdatedEvent) => void;
+    onShippingUpdated?: (event: ShippingUpdatedEvent) => void;
+}
+export interface MountResult {
+    unmount: () => void;
+    updateConfig: (config: Partial<CheckoutConfig>) => void;
+    getLocationInfo: () => LocationInfo | null;
+    getCheckoutSequence: () => CheckoutSequence | null;
+    getConfig: () => Readonly<Required<CheckoutConfig>>;
+    getState: () => CheckoutState;
+    isReady: () => boolean;
+}
+export interface PaymentSubmitEvent {
+    method: string;
+    details?: Record<string, unknown>;
+    resolve: (data?: unknown) => void;
+    reject: (error: Error) => void;
+}
+export interface PaymentStatusInfo {
+    code: number;
+    action: string;
+    outcome: 'success' | 'failure' | 'pending' | 'unknown';
+}
+export interface PaymentSuccessEvent {
+    orderId: string;
+    returnUrl: string;
+    paymentStatus?: PaymentStatusInfo;
+    resolve: () => void;
+    reject: (error: Error) => void;
+}
+export interface FieldError {
+    field: string;
+    message: string;
+}
+export interface PaymentErrorEvent {
+    error: string;
+    errorId?: string;
+    errorTag?: string;
+    result?: string;
+    paymentStatus?: PaymentStatusInfo;
+    errors?: FieldError[];
+    resolve: () => void;
+    reject: (error: Error) => void;
+}
+export interface PartialPaymentEvent {
+    orderId: string;
+    amountPaid: number;
+    amountRemaining: number;
+    currency: string;
+    transactionId?: string;
+    paymentStatus?: PaymentStatusInfo;
+    resolve: () => void;
+    reject: (error: Error) => void;
+}
+export interface CheckoutReadyEvent {
+    config: Readonly<Required<CheckoutConfig>>;
+}
+export interface CheckoutEventHandlers {
+    onSubmit?: (event: PaymentSubmitEvent) => void;
+    onSuccess?: (event: PaymentSuccessEvent) => void;
+    onError?: (event: PaymentErrorEvent) => void;
+    onPartialPaid?: (event: PartialPaymentEvent) => void;
+    onReady?: (event: CheckoutReadyEvent) => void;
+}
+export interface PaymentComponent {
+    bind: (target: string | HTMLElement) => void;
+    unmount: () => void;
+    updateContext: (context: Partial<PaymentMethodContext>) => void;
+    isReady: () => boolean;
+    refresh: () => Promise<void>;
+}
+export interface Checkout {
+    events: MountEventHandlers;
+    prepare: (methodOrSection: string) => PaymentComponent;
+    updateConfig: (config: Partial<CheckoutConfig>) => void;
+    getConfig: () => Readonly<Required<CheckoutConfig>>;
+}
+export interface ApplePayShippingMethod {
+    label: string;
+    amount: string;
+    detail: string;
+    identifier: string;
+    dateComponentsRange?: {
+        startDateComponents?: ApplePayDateComponents;
+        endDateComponents?: ApplePayDateComponents;
+    };
+}
+export interface ApplePayDateComponents {
+    years?: number;
+    months?: number;
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+}
+export interface ApplePayLineItem {
+    label: string;
+    amount: string;
+}
+export interface ApplePayShippingContact {
+    administrativeArea?: string;
+    country?: string;
+    countryCode?: string;
+    familyName?: string;
+    givenName?: string;
+    locality?: string;
+    postalCode?: string;
+    subAdministrativeArea?: string;
+    subLocality?: string;
+    emailAddress?: string;
+    phoneNumber?: string;
+    addressLines?: string[];
+}
+export interface ApplePayPaymentMethod {
+    displayName: string;
+    network: string;
+    type: string;
+}
+export interface ApplePayPaymentMethodUpdate {
+    newTotal: {
+        label: string;
+        amount: string;
+    };
+    newLineItems?: ApplePayLineItem[];
+}
+export interface ApplePayShippingMethodUpdate {
+    newTotal: {
+        label: string;
+        amount: string;
+    };
+    newLineItems?: ApplePayLineItem[];
+}
+export interface ApplePayShippingContactUpdate {
+    newTotal?: {
+        label: string;
+        amount: string;
+    };
+    newLineItems?: ApplePayLineItem[];
+    errors?: {
+        code: string;
+        message: string;
+    }[];
+}
+export interface ApplePayOptions {
+    shippingMethods?: ApplePayShippingMethod[];
+    requiredBillingContactFields?: string[];
+    requiredShippingContactFields?: string[];
+    lineItems?: ApplePayLineItem[];
+    total?: {
+        label: string;
+        type?: 'final' | 'pending';
+    };
+    shippingType?: 'shipping' | 'delivery' | 'store' | 'service';
+    onShippingMethodSelected?: (method: ApplePayShippingMethod) => ApplePayShippingMethodUpdate;
+    onShippingContactSelected?: (contact: ApplePayShippingContact) => ApplePayShippingContactUpdate;
+    onPaymentMethodSelected?: (method: ApplePayPaymentMethod) => ApplePayPaymentMethodUpdate;
+}
+export interface PayPalOptions {
+    clientId?: string;
+    /**
+     * PayPal button style options
+     */
+    buttonStyle?: {
+        color?: 'gold' | 'blue' | 'white' | 'black';
+        shape?: 'rect' | 'pill';
+        size?: 'small' | 'medium' | 'large';
+        layout?: 'vertical' | 'horizontal';
+    };
+    /**
+     * Custom callback when PayPal button is clicked
+     */
+    onButtonClick?: () => void;
+}
+export interface CustomerInfo {
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    billingAddress?: AddressInfo;
+    shippingAddress?: AddressInfo;
+}
+export interface OrderProduct {
+    id?: string;
+    name?: string;
+    description?: string;
+    quantity?: number;
+    unitPrice?: number;
+    totalAmount?: number;
+}
+export interface OrderInfo {
+    amount?: number;
+    currency?: string;
+    orderId?: string;
+    reference?: string;
+    description?: string;
+    products?: OrderProduct[];
+}
+export interface AddressInfo {
+    street?: string;
+    streetNumber?: string;
+    streetNumberExtension?: string;
+    city?: string;
+    country?: string;
+    countryCode?: string;
+    zipCode?: string;
+    administrativeArea?: string;
+}
+export interface InfoUpdatedEvent {
+    type: 'infoUpdated';
+    data: {
+        lineItems?: ApplePayLineItem[];
+        total?: {
+            label: string;
+            amount: string;
+        };
+        customer?: CustomerInfo;
+    };
+}
+export interface ShippingUpdatedEvent {
+    type: 'shippingUpdated';
+    data: {
+        selectedMethod?: string;
+        shippingCost?: number;
+        deliveryAddress?: AddressInfo;
+    };
+}
+export type CheckoutEvent = {
+    type: 'initialising';
+    data: InitialisingEventData;
+    timestamp: Date;
+} | {
+    type: 'ready';
+    data: ReadyEventData;
+    timestamp: Date;
+} | {
+    type: 'state:change';
+    data: StateChangeEventData;
+    timestamp: Date;
+} | {
+    type: 'payment:submit';
+    data: PaymentSubmitEventData;
+    timestamp: Date;
+} | {
+    type: 'payment:success';
+    data: PaymentSuccessEventData;
+    timestamp: Date;
+} | {
+    type: 'payment:error';
+    data: PaymentErrorEventData;
+    timestamp: Date;
+} | {
+    type: 'cancel';
+    data: null;
+    timestamp: Date;
+} | {
+    type: 'close';
+    data: null;
+    timestamp: Date;
+} | {
+    type: 'infoUpdated';
+    data: InfoUpdatedEvent['data'];
+    timestamp: Date;
+} | {
+    type: 'shippingUpdated';
+    data: ShippingUpdatedEvent['data'];
+    timestamp: Date;
+};
+export interface CheckoutEventHandlers {
+    onSubmit?: (event: PaymentSubmitEvent) => void;
+    onSuccess?: (event: PaymentSuccessEvent) => void;
+    onError?: (event: PaymentErrorEvent) => void;
+    onReady?: (event: CheckoutReadyEvent) => void;
+    onInfoUpdated?: (event: InfoUpdatedEvent) => void;
+    onShippingUpdated?: (event: ShippingUpdatedEvent) => void;
+}
+export interface InitOptions {
+    sessionToken: string;
+    apiUrl?: string;
+    language?: string;
+    /**
+     * Country for payment method sequencing.
+     * Independent from language - controls which checkoutSequence to use (NL, BE, or default).
+     */
+    country?: 'DEFAULT' | 'NL' | 'BE';
+    /**
+     * Payment method tags to exclude from display (e.g., ['PM_10', 'PM_11']).
+     * These methods will not be shown in the payment methods list.
+     */
+    excludedMethods?: string[];
+    /**
+     * Apple Pay configuration options.
+     */
+    applePayOptions?: ApplePayOptions;
+    /**
+     * PayPal configuration options.
+     */
+    paypalOptions?: PayPalOptions;
+    /**
+     * Link mode for payment methods - controls how the payment URL is opened.
+     * 'same_page' (default) - navigate to the payment URL in the same tab
+     * 'new_tab' - open the payment URL in a new tab
+     */
+    methodLinkMode?: 'new_tab' | 'same_page';
+    /**
+     * Debug mode - shows disabled/hidden payment methods with min/max amounts.
+     */
+    debugMode?: boolean;
+    /**
+     * Custom translations to override or extend default translations.
+     */
+    translations?: Record<string, unknown>;
+}
+/** @deprecated Use ApplePayOptions instead */
+export type ApplePayConfig = ApplePayOptions;

package/dist/types-pkg/src/index.d.ts

@@ -0,0 +1,4 @@
+export type { CheckoutConfig, CheckoutOption, PaymentMethod, PaymentMethodOption, CountrySequence, CheckoutSequence, PaymentInfo, SessionPaymentInfo, OrderPaymentInfo, CheckoutState, CheckoutEventType, CheckoutEvent, InitialisingEventData, ReadyEventData, StateChangeEventData, PaymentSubmitEventData, PaymentErrorEventData, PaymentSuccessEventData, PartialPaymentEventData, ThreeDsData, TransactionData, MountOptions, MountEventHandlers, MountResult, Checkout, PaymentComponent, CheckoutEventHandlers, PaymentMethodContext, PaymentSubmitEvent, PaymentSuccessEvent, PaymentErrorEvent, FieldError, CheckoutReadyEvent, InitOptions, ShippingUpdatedEvent, InfoUpdatedEvent, PartialPaymentEvent, ApplePayOptions, ApplePayShippingMethod, ApplePayLineItem, ApplePayShippingContact, PayPalOptions, CustomerInfo, AddressInfo, OrderInfo, OrderProduct, AmountDto, MerchantInfo, LocationInfo, } from '../../src/core/types';
+export type { PaymentOutcome, PaymentStatusInfo } from '../../src/core/payment-status';
+export type { ApiErrorResponse, ApiFieldError } from '../../src/core/errors/api-error-response';
+export type { PaymentError } from '../../src/core/errors/PaymentError';

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@paynl/payparts-types",
+  "version": "1.4.0-alpha.93",
+  "description": "TypeScript type definitions for the PayParts payment SDK",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "../node_modules/.bin/tsc",
+    "postbuild": "node -e \"require('fs').writeFileSync('./dist/index.d.ts', \\\"export * from './types-pkg/src/index';\\\\n\\\")\"",
+    "typecheck": "../node_modules/.bin/tsc --noEmit"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  }
+}