@bigcommerce/checkout-sdk 1.369.0 → 1.369.2

package/dist/checkout-sdk.d.ts

@@ -1191,7 +1191,7 @@ declare interface BasePaymentInitializeOptions extends PaymentRequestOptions {
      * The options that are required to initialize the PayPal Commerce payment method.
      * They can be omitted unless you need to support PayPal Commerce.
      */
-    paypalcommerce?: PaypalCommerceInitializeOptions;
+    paypalcommerce?: PaypalCommercePaymentInitializeOptions;
     /**
      * The options that are required to initialize the Square payment method.
      * They can be omitted unless you need to support Square.
@@ -4522,6 +4522,13 @@ declare interface CustomerRequestOptions extends RequestOptions {
     methodId?: string;
 }
 
+declare interface DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions {
+    /**
+     * The form is data for Credit Card Form
+     */
+    form?: HostedFormOptions_2;
+}
+
 declare interface DigitalItem extends LineItem {
     downloadFileUrls: string[];
     downloadPageUrl: string;
@@ -6043,6 +6050,87 @@ declare interface PayPalCommerceCreditButtonInitializeOptions {
     onComplete?(): void;
 }
 
+/**
+ * A set of options that are required to initialize the PayPal Commerce payment
+ * method for presenting its credit card form.
+ *
+ * ```html
+ * <!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
+ * <div id="card-number"></div>
+ * <div id="card-name"></div>
+ * <div id="card-expiry"></div>
+ * <div id="card-code"></div>
+ * ```
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'paypalcommercecreditcard',
+ *     paypalcommercecreditcard: {
+ *         form: {
+ *             fields: {
+ *                 cardNumber: { containerId: 'card-number' },
+ *                 cardName: { containerId: 'card-name' },
+ *                 cardExpiry: { containerId: 'card-expiry' },
+ *                 cardCode: { containerId: 'card-code' },
+ *             },
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * Additional options can be passed in to customize the fields and register
+ * event callbacks.
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'paypalcommercecreditcard',
+ *     paypalcommercecreditcard: {
+ *         form: {
+ *             fields: {
+ *                 cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
+ *                 cardName: { containerId: 'card-name', placeholder: 'Name of card' },
+ *                 cardExpiry: { containerId: 'card-expiry', placeholder: 'Expiry of card' },
+ *                 cardCode: { containerId: 'card-code', placeholder: 'Code of card' },
+ *             },
+ *             styles: {
+ *                 default: {
+ *                     color: '#000',
+ *                 },
+ *                 error: {
+ *                     color: '#f00',
+ *                 },
+ *                 focus: {
+ *                     color: '#0f0',
+ *                 },
+ *             },
+ *             onBlur({ fieldType }) {
+ *                 console.log(fieldType);
+ *             },
+ *             onFocus({ fieldType }) {
+ *                 console.log(fieldType);
+ *             },
+ *             onEnter({ fieldType }) {
+ *                 console.log(fieldType);
+ *             },
+ *             onCardTypeChange({ cardType }) {
+ *                 console.log(cardType);
+ *             },
+ *             onValidate({ errors, isValid }) {
+ *                 console.log(errors);
+ *                 console.log(isValid);
+ *             },
+ *         },
+ *     },
+ * });
+ * ```
+ */
+declare interface PayPalCommerceCreditCardsPaymentInitializeOptions {
+    /**
+     * The form is data for Credit Card Form
+     */
+    form: HostedFormOptions_2;
+}
+
 declare interface PayPalCommerceCreditCustomerInitializeOptions {
     /**
      * The ID of a container which the checkout button should be inserted into.
@@ -6142,7 +6230,7 @@ declare interface PayPalInstrument extends BaseAccountInstrument {
     method: 'paypal';
 }
 
-declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
+declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithPayPalCommerceCreditCardsPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
 
 declare type PaymentInstrument = CardInstrument | AccountInstrument;
 
@@ -6261,209 +6349,6 @@ declare enum PaypalButtonStyleSizeOption {
     RESPONSIVE = "responsive"
 }
 
-/**
- * A set of options that are required to initialize the PayPal Commerce payment
- * method for presenting its credit card form.
- *
- * ```html
- * <!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
- * <div id="card-number"></div>
- * <div id="card-name"></div>
- * <div id="card-expiry"></div>
- * <div id="card-code"></div>
- * ```
- *
- * ```js
- * service.initializePayment({
- *     methodId: 'paypalcommerce',
- *     paypalcommerce: {
- *         form: {
- *             fields: {
- *                 cardNumber: { containerId: 'card-number' },
- *                 cardName: { containerId: 'card-name' },
- *                 cardExpiry: { containerId: 'card-expiry' },
- *                 cardCode: { containerId: 'card-code' },
- *             },
- *         },
- *     },
- * });
- * ```
- *
- * Additional options can be passed in to customize the fields and register
- * event callbacks.
- *
- * ```js
- * service.initializePayment({
- *     methodId: 'paypalcommerce',
- *     creditCard: {
- *         form: {
- *             fields: {
- *                 cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
- *                 cardName: { containerId: 'card-name', placeholder: 'Name of card' },
- *                 cardExpiry: { containerId: 'card-expiry', placeholder: 'Expiry of card' },
- *                 cardCode: { containerId: 'card-code', placeholder: 'Code of card' },
- *             },
- *             styles: {
- *                 default: {
- *                     color: '#000',
- *                 },
- *                 error: {
- *                     color: '#f00',
- *                 },
- *                 focus: {
- *                     color: '#0f0',
- *                 },
- *             },
- *             onBlur({ fieldType }) {
- *                 console.log(fieldType);
- *             },
- *             onFocus({ fieldType }) {
- *                 console.log(fieldType);
- *             },
- *             onEnter({ fieldType }) {
- *                 console.log(fieldType);
- *             },
- *             onCardTypeChange({ cardType }) {
- *                 console.log(cardType);
- *             },
- *             onValidate({ errors, isValid }) {
- *                 console.log(errors);
- *                 console.log(isValid);
- *             },
- *         },
- *     },
- * });
- * ```
- */
-declare interface PaypalCommerceCreditCardPaymentInitializeOptions {
-    /**
-     * The form is data for Credit Card Form
-     */
-    form: PaypalCommerceFormOptions;
-}
-
-declare type PaypalCommerceFormFieldBlurEventData = PaypalCommerceFormFieldKeyboardEventData;
-
-declare interface PaypalCommerceFormFieldCardTypeChangeEventData {
-    cardType?: string;
-}
-
-declare type PaypalCommerceFormFieldEnterEventData = PaypalCommerceFormFieldKeyboardEventData;
-
-declare type PaypalCommerceFormFieldFocusEventData = PaypalCommerceFormFieldKeyboardEventData;
-
-declare interface PaypalCommerceFormFieldKeyboardEventData {
-    fieldType: string;
-}
-
-declare interface PaypalCommerceFormFieldOptions {
-    containerId: string;
-    placeholder?: string;
-}
-
-declare type PaypalCommerceFormFieldStyles = Partial<Pick<CSSStyleDeclaration, 'color' | 'fontFamily' | 'fontSize' | 'fontWeight'>>;
-
-declare interface PaypalCommerceFormFieldStylesMap {
-    default?: PaypalCommerceFormFieldStyles;
-    error?: PaypalCommerceFormFieldStyles;
-    focus?: PaypalCommerceFormFieldStyles;
-}
-
-declare enum PaypalCommerceFormFieldType {
-    CardCode = "cardCode",
-    CardCodeVerification = "cardCodeVerification",
-    CardExpiry = "cardExpiry",
-    CardName = "cardName",
-    CardNumber = "cardNumber",
-    CardNumberVerification = "cardNumberVerification"
-}
-
-declare interface PaypalCommerceFormFieldValidateErrorData {
-    fieldType: string;
-    message: string;
-    type: string;
-}
-
-declare interface PaypalCommerceFormFieldValidateEventData {
-    errors: {
-        [PaypalCommerceFormFieldType.CardCode]?: PaypalCommerceFormFieldValidateErrorData[];
-        [PaypalCommerceFormFieldType.CardExpiry]?: PaypalCommerceFormFieldValidateErrorData[];
-        [PaypalCommerceFormFieldType.CardName]?: PaypalCommerceFormFieldValidateErrorData[];
-        [PaypalCommerceFormFieldType.CardNumber]?: PaypalCommerceFormFieldValidateErrorData[];
-        [PaypalCommerceFormFieldType.CardCodeVerification]?: PaypalCommerceFormFieldValidateErrorData[];
-        [PaypalCommerceFormFieldType.CardNumberVerification]?: PaypalCommerceFormFieldValidateErrorData[];
-    };
-    isValid: boolean;
-}
-
-declare interface PaypalCommerceFormFieldsMap {
-    [PaypalCommerceFormFieldType.CardCode]?: PaypalCommerceFormFieldOptions;
-    [PaypalCommerceFormFieldType.CardExpiry]: PaypalCommerceFormFieldOptions;
-    [PaypalCommerceFormFieldType.CardName]: PaypalCommerceFormFieldOptions;
-    [PaypalCommerceFormFieldType.CardNumber]: PaypalCommerceFormFieldOptions;
-}
-
-declare interface PaypalCommerceFormOptions {
-    /**
-     * Containers for fields can be to present in one set of values
-     *
-     * ```js
-     * { cardNumber: { containerId: 'card-number' },
-     *   cardName: { containerId: 'card-name' },
-     *   cardExpiry: { containerId: 'card-expiry' },
-     *   cardCode: { containerId: 'card-code' }, }
-     * ```
-     *
-     *   Or in another set of values.
-     *
-     * ```js
-     * { cardCodeVerification: { containerId: 'card-number' },
-     *   cardNumberVerification: { containerId: 'card-name' }, }
-     * ```
-     */
-    fields: PaypalCommerceFormFieldsMap | PaypalCommerceStoredCardFieldsMap;
-    /**
-     * Styles for inputs. Change the width, height and other styling.
-     *
-     * ```js
-     *  default: { color: '#000' },
-     *  error: { color: '#f00' },
-     *  focus: { color: '#0f0' }
-     * ```
-     */
-    styles?: PaypalCommerceFormFieldStylesMap;
-    /**
-     * A callback that gets called when a field loses focus.
-     */
-    onBlur?(data: PaypalCommerceFormFieldBlurEventData): void;
-    /**
-     * A callback that gets called when activity within
-     * the number field has changed such that the possible
-     * card type has changed.
-     */
-    onCardTypeChange?(data: PaypalCommerceFormFieldCardTypeChangeEventData): void;
-    /**
-     * A callback that gets called when a field gains focus.
-     */
-    onFocus?(data: PaypalCommerceFormFieldFocusEventData): void;
-    /**
-     * A callback that gets called when the validity of a field has changed.
-     */
-    onValidate?(data: PaypalCommerceFormFieldValidateEventData): void;
-    /**
-     * A callback that gets called when the user requests submission
-     * of an input field, by pressing the Enter or Return key
-     * on their keyboard, or mobile equivalent.
-     */
-    onEnter?(data: PaypalCommerceFormFieldEnterEventData): void;
-}
-
-/**
- * A set of options that are required to initialize the PayPal Commerce payment
- * method could be used for PayPal Smart Payment Buttons or PayPal Credit Card methods.
- */
-declare type PaypalCommerceInitializeOptions = PaypalCommercePaymentInitializeOptions | PaypalCommerceCreditCardPaymentInitializeOptions;
-
 /**
  * A set of options that are required to initialize the PayPal Commerce payment
  * method for presenting its PayPal button.
@@ -6577,15 +6462,6 @@ declare interface PaypalCommercePaymentInitializeOptions {
     onError?(error: Error): void;
 }
 
-declare interface PaypalCommerceStoredCardFieldOptions extends PaypalCommerceFormFieldOptions {
-    instrumentId: string;
-}
-
-declare interface PaypalCommerceStoredCardFieldsMap {
-    [PaypalCommerceFormFieldType.CardCodeVerification]?: PaypalCommerceStoredCardFieldOptions;
-    [PaypalCommerceFormFieldType.CardNumberVerification]?: PaypalCommerceStoredCardFieldOptions;
-}
-
 /**
  * A set of options that are required to initialize the PayPal Express payment
  * method.
@@ -7691,6 +7567,11 @@ declare interface WithPayPalCommerceCreditButtonInitializeOptions {
     paypalcommercecredit?: PayPalCommerceCreditButtonInitializeOptions;
 }
 
+declare interface WithPayPalCommerceCreditCardsPaymentInitializeOptions {
+    paypalcommercecreditcards?: PayPalCommerceCreditCardsPaymentInitializeOptions;
+    paypalcommerce?: DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions;
+}
+
 declare interface WithPayPalCommerceCreditCustomerInitializeOptions {
     paypalcommercecredit?: PayPalCommerceCreditCustomerInitializeOptions;
 }