@stripe/stripe-js 9.13.0 → 9.15.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.
@@ -1,5 +1,5 @@
1
1
  import {StripeElements} from '../stripe-js';
2
- import {Address} from './shared';
2
+ import {Address, MetadataParam} from './shared';
3
3
  import {PaymentMethod, PaymentMethodCreateParams} from './payment-methods';
4
4
  import {PaymentIntent} from './payment-intents';
5
5
 
@@ -105,6 +105,15 @@ export interface ConfirmationTokenCreateParams {
105
105
  * The url your customer will be directed to after they complete authentication.
106
106
  */
107
107
  return_url?: string | null;
108
+
109
+ /**
110
+ * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
111
+ *
112
+ * This can be a maximum of 50 keys.
113
+ *
114
+ * @docs https://docs.stripe.com/js/confirmation_tokens/create_confirmation_token#create_confirmation_token-options-params-metadata
115
+ */
116
+ metadata?: MetadataParam;
108
117
  }
109
118
 
110
119
  export interface CreateConfirmationToken {
@@ -1,5 +1,5 @@
1
1
  import {StripeElements} from '../stripe-js';
2
- import {Address} from './shared';
2
+ import {Address, MetadataParam} from './shared';
3
3
  import {PaymentMethod, PaymentMethodCreateParams} from './payment-methods';
4
4
  import {PaymentIntent} from './payment-intents';
5
5
 
@@ -105,6 +105,15 @@ export interface ConfirmationTokenCreateParams {
105
105
  * The url your customer will be directed to after they complete authentication.
106
106
  */
107
107
  return_url?: string | null;
108
+
109
+ /**
110
+ * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
111
+ *
112
+ * This can be a maximum of 50 keys.
113
+ *
114
+ * @docs https://docs.stripe.com/js/confirmation_tokens/create_confirmation_token#create_confirmation_token-options-params-metadata
115
+ */
116
+ metadata?: MetadataParam;
108
117
  }
109
118
 
110
119
  export interface CreateConfirmationToken {
package/dist/index.js CHANGED
@@ -71,7 +71,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
71
71
 
72
72
  stripe._registerWrapper({
73
73
  name: 'stripe-js',
74
- version: "9.13.0",
74
+ version: "9.15.0",
75
75
  startTime: startTime
76
76
  });
77
77
  };
@@ -172,7 +172,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
172
172
  var expectedVersion = RELEASE_TRAIN;
173
173
 
174
174
  if (isTestKey && version !== expectedVersion) {
175
- console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.13.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
175
+ console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.15.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
176
176
  }
177
177
 
178
178
  var stripe = maybeStripe.apply(undefined, args);
package/dist/index.mjs CHANGED
@@ -67,7 +67,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
67
67
 
68
68
  stripe._registerWrapper({
69
69
  name: 'stripe-js',
70
- version: "9.13.0",
70
+ version: "9.15.0",
71
71
  startTime: startTime
72
72
  });
73
73
  };
@@ -168,7 +168,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
168
168
  var expectedVersion = RELEASE_TRAIN;
169
169
 
170
170
  if (isTestKey && version !== expectedVersion) {
171
- console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.13.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
171
+ console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.15.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
172
172
  }
173
173
 
174
174
  var stripe = maybeStripe.apply(undefined, args);
package/dist/pure.js CHANGED
@@ -71,7 +71,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
71
71
 
72
72
  stripe._registerWrapper({
73
73
  name: 'stripe-js',
74
- version: "9.13.0",
74
+ version: "9.15.0",
75
75
  startTime: startTime
76
76
  });
77
77
  };
@@ -172,7 +172,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
172
172
  var expectedVersion = RELEASE_TRAIN;
173
173
 
174
174
  if (isTestKey && version !== expectedVersion) {
175
- console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.13.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
175
+ console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.15.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
176
176
  }
177
177
 
178
178
  var stripe = maybeStripe.apply(undefined, args);
package/dist/pure.mjs CHANGED
@@ -67,7 +67,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
67
67
 
68
68
  stripe._registerWrapper({
69
69
  name: 'stripe-js',
70
- version: "9.13.0",
70
+ version: "9.15.0",
71
71
  startTime: startTime
72
72
  });
73
73
  };
@@ -168,7 +168,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
168
168
  var expectedVersion = RELEASE_TRAIN;
169
169
 
170
170
  if (isTestKey && version !== expectedVersion) {
171
- console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.13.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
171
+ console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.15.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
172
172
  }
173
173
 
174
174
  var stripe = maybeStripe.apply(undefined, args);
@@ -3,6 +3,7 @@ import {
3
3
  Layout,
4
4
  TermsOption,
5
5
  StripePaymentElement,
6
+ PaymentWalletOptionsOption,
6
7
  } from './elements/payment';
7
8
  import {ContactOption, StripeAddressElement} from './elements/address';
8
9
  import {Appearance, CssFontSource, CustomFontSource} from './elements-group';
@@ -405,6 +406,7 @@ export type StripeCheckoutPaymentElementOptions = {
405
406
  terms?: TermsOption;
406
407
  fields?: FieldsOption;
407
408
  wallets?: PaymentWalletsOption;
409
+ walletOptions?: PaymentWalletOptionsOption;
408
410
  };
409
411
 
410
412
  export type StripeCheckoutAddressElementOptions = {
@@ -3,6 +3,7 @@ import {
3
3
  Layout,
4
4
  TermsOption,
5
5
  StripePaymentElement,
6
+ PaymentWalletOptionsOption,
6
7
  } from './elements/payment';
7
8
  import {ContactOption, StripeAddressElement} from './elements/address';
8
9
  import {Appearance, CssFontSource, CustomFontSource} from './elements-group';
@@ -405,6 +406,7 @@ export type StripeCheckoutPaymentElementOptions = {
405
406
  terms?: TermsOption;
406
407
  fields?: FieldsOption;
407
408
  wallets?: PaymentWalletsOption;
409
+ walletOptions?: PaymentWalletOptionsOption;
408
410
  };
409
411
 
410
412
  export type StripeCheckoutAddressElementOptions = {
@@ -607,6 +607,7 @@ export interface StripeExpressCheckoutElementAvailablePaymentMethodsChangeEvent
607
607
  paypal?: {available: boolean};
608
608
  amazonPay?: {available: boolean};
609
609
  klarna?: {available: boolean};
610
+ [customPaymentMethodId: string]: {available: boolean} | undefined;
610
611
  }
611
612
  | undefined;
612
613
  }
@@ -607,6 +607,7 @@ export interface StripeExpressCheckoutElementAvailablePaymentMethodsChangeEvent
607
607
  paypal?: {available: boolean};
608
608
  amazonPay?: {available: boolean};
609
609
  klarna?: {available: boolean};
610
+ [customPaymentMethodId: string]: {available: boolean} | undefined;
610
611
  }
611
612
  | undefined;
612
613
  }
@@ -336,6 +336,11 @@ export interface PaymentWalletsOption {
336
336
  link?: PaymentWalletOption;
337
337
  }
338
338
 
339
+ export interface PaymentWalletOptionsOption {
340
+ emailRequired?: boolean;
341
+ phoneNumberRequired?: boolean;
342
+ }
343
+
339
344
  export type Layout = 'tabs' | 'accordion' | 'auto';
340
345
  type RadiosOption = 'auto' | 'never' | 'always' | 'if_multiple';
341
346
 
@@ -392,6 +397,11 @@ export interface StripePaymentElementOptions {
392
397
  */
393
398
  wallets?: PaymentWalletsOption;
394
399
 
400
+ /**
401
+ * Control wallet behavior options in the Payment Element.
402
+ */
403
+ walletOptions?: PaymentWalletOptionsOption;
404
+
395
405
  /**
396
406
  * Specify a layout to use when rendering a Payment Element.
397
407
  */
@@ -419,6 +429,7 @@ export type StripePaymentElementUpdateOptions = Pick<
419
429
  | 'terms'
420
430
  | 'layout'
421
431
  | 'applePay'
432
+ | 'walletOptions'
422
433
  >;
423
434
 
424
435
  export interface StripePaymentElementChangeEvent {
@@ -336,6 +336,11 @@ export interface PaymentWalletsOption {
336
336
  link?: PaymentWalletOption;
337
337
  }
338
338
 
339
+ export interface PaymentWalletOptionsOption {
340
+ emailRequired?: boolean;
341
+ phoneNumberRequired?: boolean;
342
+ }
343
+
339
344
  export type Layout = 'tabs' | 'accordion' | 'auto';
340
345
  type RadiosOption = 'auto' | 'never' | 'always' | 'if_multiple';
341
346
 
@@ -392,6 +397,11 @@ export interface StripePaymentElementOptions {
392
397
  */
393
398
  wallets?: PaymentWalletsOption;
394
399
 
400
+ /**
401
+ * Control wallet behavior options in the Payment Element.
402
+ */
403
+ walletOptions?: PaymentWalletOptionsOption;
404
+
395
405
  /**
396
406
  * Specify a layout to use when rendering a Payment Element.
397
407
  */
@@ -419,6 +429,7 @@ export type StripePaymentElementUpdateOptions = Pick<
419
429
  | 'terms'
420
430
  | 'layout'
421
431
  | 'applePay'
432
+ | 'walletOptions'
422
433
  >;
423
434
 
424
435
  export interface StripePaymentElementChangeEvent {
@@ -1247,6 +1247,7 @@ export interface Appearance {
1247
1247
  colorWarning?: string;
1248
1248
 
1249
1249
  // Buttons
1250
+ buttonBoxShadow?: string;
1250
1251
  buttonColorBackground?: string;
1251
1252
  buttonColorText?: string;
1252
1253
  buttonFontSize?: string;
@@ -1404,15 +1405,94 @@ export interface CustomPaymentMethod {
1404
1405
  /**
1405
1406
  * Additional options to configure the Custom Payment Method.
1406
1407
  */
1407
- options: {
1408
+ options?: {
1408
1409
  /**
1409
1410
  * The payment form type.
1410
1411
  */
1411
- type: 'static';
1412
+ type: 'static' | 'embedded';
1412
1413
 
1413
1414
  /**
1414
1415
  * Display additional information about the payment method, max 100 characters.
1415
1416
  */
1416
1417
  subtitle?: string;
1418
+
1419
+ /**
1420
+ * Requires beta access:
1421
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
1422
+ *
1423
+ * Options for the embedded Custom Payment Method. Required for type: 'embedded'.
1424
+ */
1425
+ embedded?: {
1426
+ /**
1427
+ * Function for rendering custom content in the Custom Payment Method form, called on mount.
1428
+ */
1429
+ handleRender: (container: HTMLDivElement) => void;
1430
+
1431
+ /**
1432
+ * Function for cleaning up the Custom Payment Method form, called when the Custom Payment Method is removed and on unmount.
1433
+ */
1434
+ handleDestroy?: () => void;
1435
+ };
1436
+ };
1437
+
1438
+ /**
1439
+ * Additional options to configure the Custom Payment Method in the Payment Element. Alias for `options`.
1440
+ */
1441
+ payment?: {
1442
+ /**
1443
+ * The payment form type.
1444
+ */
1445
+ type: 'static' | 'embedded';
1446
+
1447
+ /**
1448
+ * Display additional information about the payment method, max 100 characters.
1449
+ */
1450
+ subtitle?: string;
1451
+
1452
+ /**
1453
+ * Requires beta access:
1454
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
1455
+ *
1456
+ * Options for the embedded Custom Payment Method. Required for type: 'embedded'.
1457
+ */
1458
+ embedded?: {
1459
+ /**
1460
+ * Function for rendering custom content in the Custom Payment Method form, called on mount.
1461
+ */
1462
+ handleRender: (container: HTMLDivElement) => void;
1463
+
1464
+ /**
1465
+ * Function for cleaning up the Custom Payment Method form, called when the Custom Payment Method is removed and on unmount.
1466
+ */
1467
+ handleDestroy?: () => void;
1468
+ };
1469
+ };
1470
+
1471
+ /**
1472
+ * Requires beta access:
1473
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
1474
+ *
1475
+ * Additional options to configure the Custom Payment Method in the Express Checkout Element.
1476
+ */
1477
+ expressCheckout?: {
1478
+ /**
1479
+ * The payment button type.
1480
+ */
1481
+ type: 'embedded';
1482
+
1483
+ /**
1484
+ * Options for the embedded Custom Payment Method.
1485
+ */
1486
+ embedded: {
1487
+ /**
1488
+ * Function for rendering custom content in the Custom Payment Method button, called on mount.
1489
+ */
1490
+ handleRender: (container: HTMLDivElement) => void;
1491
+
1492
+ /**
1493
+ * Function for cleaning up the Custom Payment Method button, called when the Custom Payment Method is removed and on unmount.
1494
+ */
1495
+ handleDestroy?: () => void;
1496
+ };
1417
1497
  };
1418
1498
  }
@@ -1247,6 +1247,7 @@ export interface Appearance {
1247
1247
  colorWarning?: string;
1248
1248
 
1249
1249
  // Buttons
1250
+ buttonBoxShadow?: string;
1250
1251
  buttonColorBackground?: string;
1251
1252
  buttonColorText?: string;
1252
1253
  buttonFontSize?: string;
@@ -1404,15 +1405,94 @@ export interface CustomPaymentMethod {
1404
1405
  /**
1405
1406
  * Additional options to configure the Custom Payment Method.
1406
1407
  */
1407
- options: {
1408
+ options?: {
1408
1409
  /**
1409
1410
  * The payment form type.
1410
1411
  */
1411
- type: 'static';
1412
+ type: 'static' | 'embedded';
1412
1413
 
1413
1414
  /**
1414
1415
  * Display additional information about the payment method, max 100 characters.
1415
1416
  */
1416
1417
  subtitle?: string;
1418
+
1419
+ /**
1420
+ * Requires beta access:
1421
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
1422
+ *
1423
+ * Options for the embedded Custom Payment Method. Required for type: 'embedded'.
1424
+ */
1425
+ embedded?: {
1426
+ /**
1427
+ * Function for rendering custom content in the Custom Payment Method form, called on mount.
1428
+ */
1429
+ handleRender: (container: HTMLDivElement) => void;
1430
+
1431
+ /**
1432
+ * Function for cleaning up the Custom Payment Method form, called when the Custom Payment Method is removed and on unmount.
1433
+ */
1434
+ handleDestroy?: () => void;
1435
+ };
1436
+ };
1437
+
1438
+ /**
1439
+ * Additional options to configure the Custom Payment Method in the Payment Element. Alias for `options`.
1440
+ */
1441
+ payment?: {
1442
+ /**
1443
+ * The payment form type.
1444
+ */
1445
+ type: 'static' | 'embedded';
1446
+
1447
+ /**
1448
+ * Display additional information about the payment method, max 100 characters.
1449
+ */
1450
+ subtitle?: string;
1451
+
1452
+ /**
1453
+ * Requires beta access:
1454
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
1455
+ *
1456
+ * Options for the embedded Custom Payment Method. Required for type: 'embedded'.
1457
+ */
1458
+ embedded?: {
1459
+ /**
1460
+ * Function for rendering custom content in the Custom Payment Method form, called on mount.
1461
+ */
1462
+ handleRender: (container: HTMLDivElement) => void;
1463
+
1464
+ /**
1465
+ * Function for cleaning up the Custom Payment Method form, called when the Custom Payment Method is removed and on unmount.
1466
+ */
1467
+ handleDestroy?: () => void;
1468
+ };
1469
+ };
1470
+
1471
+ /**
1472
+ * Requires beta access:
1473
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
1474
+ *
1475
+ * Additional options to configure the Custom Payment Method in the Express Checkout Element.
1476
+ */
1477
+ expressCheckout?: {
1478
+ /**
1479
+ * The payment button type.
1480
+ */
1481
+ type: 'embedded';
1482
+
1483
+ /**
1484
+ * Options for the embedded Custom Payment Method.
1485
+ */
1486
+ embedded: {
1487
+ /**
1488
+ * Function for rendering custom content in the Custom Payment Method button, called on mount.
1489
+ */
1490
+ handleRender: (container: HTMLDivElement) => void;
1491
+
1492
+ /**
1493
+ * Function for cleaning up the Custom Payment Method button, called when the Custom Payment Method is removed and on unmount.
1494
+ */
1495
+ handleDestroy?: () => void;
1496
+ };
1417
1497
  };
1418
1498
  }
@@ -162,10 +162,7 @@ export interface StripeEmbeddedCheckoutOptions {
162
162
  */
163
163
  onComplete?: () => void;
164
164
  /**
165
- * onShippingDetailsChange is called when the customer completes the shipping details form.
166
- *
167
- * The callback is required when [permissions.update.shipping_details](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-permissions-update-shipping_details) is set to `server_only`.
168
- * For a step-by-step guide on using this callback to customize shipping options during checkout, see [Customize Shipping Options](https://docs.stripe.com/payments/checkout/custom-shipping-options).
165
+ * @deprecated Dynamic shipping updates are deprecated in Embedded Checkout.
169
166
  */
170
167
  onShippingDetailsChange?: (
171
168
  event: StripeEmbeddedCheckoutShippingDetailsChangeEvent
@@ -162,10 +162,7 @@ export interface StripeEmbeddedCheckoutOptions {
162
162
  */
163
163
  onComplete?: () => void;
164
164
  /**
165
- * onShippingDetailsChange is called when the customer completes the shipping details form.
166
- *
167
- * The callback is required when [permissions.update.shipping_details](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-permissions-update-shipping_details) is set to `server_only`.
168
- * For a step-by-step guide on using this callback to customize shipping options during checkout, see [Customize Shipping Options](https://docs.stripe.com/payments/checkout/custom-shipping-options).
165
+ * @deprecated Dynamic shipping updates are deprecated in Embedded Checkout.
169
166
  */
170
167
  onShippingDetailsChange?: (
171
168
  event: StripeEmbeddedCheckoutShippingDetailsChangeEvent
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stripe/stripe-js",
3
- "version": "9.13.0",
3
+ "version": "9.15.0",
4
4
  "description": "Stripe.js loading utility",
5
5
  "repository": "github:stripe/stripe-js",
6
6
  "main": "lib/index.js",