stripe 11.18.0 → 12.0.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 12.0.0 - 2023-04-06
+* [#1743](https://github.com/stripe/stripe-node/pull/1743) Remove `Stripe.default` and `Stripe.Stripe`
+This was added to maintain backwards compatibility during the transition of stripe-node to a dual ES module / CommonJS package, and should not be functionally necessary.
+* [#1742](https://github.com/stripe/stripe-node/pull/1743) Pin latest API version as the default
+  **⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️**
+  
+  In this release, Stripe API Version `2022-11-15` (the latest at time of release) will be sent by default on all requests. 
+  The previous default was to use your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version).
+  
+  To successfully upgrade to stripe-node v12, you must either
+  
+  1. **(Recommended) Upgrade your integration to be compatible with API Version `2022-11-15`.**
+    
+     Please read the API Changelog carefully for each API Version from `2022-11-15` back to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe [Test Mode](https://stripe.com/docs/keys#test-live-modes) before deploying them to production.
+     
+     You can read the [v12 migration guide](https://github.com/stripe/stripe-node/wiki/Migration-guide-for-v12) for more detailed instructions.
+  2. **(Alternative option) Specify a version other than `2022-11-15` when initializing `stripe-node`.** 
+  
+     If you were previously initializing stripe-node without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). For example:
+    
+     ```diff
+     - const stripe = require('stripe')('sk_test_...'); 
+     + const stripe = require('stripe')('sk_test_...', {
+     +   apiVersion: 'YYYY-MM-DD' // Determine your default version from https://dashboard.stripe.com/developers
+     + })
+     ```
+  
+     If you were already initializing stripe-node with an explicit API Version, upgrading to v12 will not affect your integration.
+  
+     Read the [v12 migration guide](https://github.com/stripe/stripe-node/wiki/Migration-guide-for-v12) for more details.
+  
+  Going forward, each major release of this library will be *pinned* by default to the latest Stripe API Version at the time of release. 
+  That is, instead of upgrading stripe-node and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-node, you should also upgrade your integration to be compatible with the latest Stripe API version.
+
 ## 11.18.0 - 2023-04-06
 * [#1738](https://github.com/stripe/stripe-node/pull/1738) Update generated code
   * Add support for new value `link` on enums `Charge.payment_method_details.card.wallet.type` and `PaymentMethod.card.wallet.type`

package/README.md

@@ -97,8 +97,7 @@ We therefore encourage [upgrading your API version][api-version-upgrading]
 if you would like to take advantage of Stripe's TypeScript definitions.
 
 If you are on an older API version (e.g., `2019-10-17`) and not able to upgrade,
-you may pass another version or `apiVersion: null` to use your account's default API version,
-and use a comment like `// @ts-ignore stripe-version-2019-10-17` to silence type errors here
+you may pass another version and use a comment like `// @ts-ignore stripe-version-2019-10-17` to silence type errors here
 and anywhere the types differ between your API version and the latest.
 When you upgrade, you should remove these comments.
 
@@ -176,7 +175,7 @@ const stripe = Stripe('sk_test_...', {
 
 | Option              | Default            | Description                                                                                                                                                                                                                                       |
 | ------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `apiVersion`        | `null`             | Stripe API version to be used. If not set the account's default version will be used.                                                                                                                                                             |
+| `apiVersion`        | `null`             | Stripe API version to be used. If not set, stripe-node will use the latest version at the time of release.                                                                                                                                        |
 | `maxNetworkRetries` | 0                  | The amount of times a request should be [retried](#network-retries).                                                                                                                                                                              |
 | `httpAgent`         | `null`             | [Proxy](#configuring-a-proxy) agent to be used by the library.                                                                                                                                                                                    |
 | `timeout`           | 80000              | [Maximum time each request can take in ms.](#configuring-timeout)                                                                                                                                                                                 |

package/VERSION

@@ -1 +1 @@
-11.18.0
+12.0.0

package/cjs/stripe.core.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStripe = void 0;
 const _Error = require("./Error.js");
+const apiVersion = require("./apiVersion.js");
 const resources = require("./resources.js");
 const HttpClient_js_1 = require("./net/HttpClient.js");
 const utils_js_1 = require("./utils.js");
@@ -12,7 +13,7 @@ const Webhooks_js_1 = require("./Webhooks.js");
 const DEFAULT_HOST = 'api.stripe.com';
 const DEFAULT_PORT = '443';
 const DEFAULT_BASE_PATH = '/v1/';
-const DEFAULT_API_VERSION = null;
+const DEFAULT_API_VERSION = apiVersion.ApiVersion;
 const DEFAULT_TIMEOUT = 80000;
 const MAX_NETWORK_RETRY_DELAY_SEC = 2;
 const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;
@@ -33,17 +34,13 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '11.18.0';
+    Stripe.PACKAGE_VERSION = '12.0.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
     Stripe.StripeResource = StripeResource_js_1.StripeResource;
     Stripe.resources = resources;
     Stripe.HttpClient = HttpClient_js_1.HttpClient;
     Stripe.HttpClientResponse = HttpClient_js_1.HttpClientResponse;
     Stripe.CryptoProvider = CryptoProvider_js_1.CryptoProvider;
-    // For backwards compatibiblity after moving to separate CJS and ESM entrypoints.
-    // To be removed in the next major version.
-    Stripe.Stripe = Stripe;
-    Stripe.default = Stripe;
     function Stripe(key, config = {}) {
         if (!(this instanceof Stripe)) {
             return new Stripe(key, config);

package/esm/stripe.core.js

@@ -1,4 +1,5 @@
 import * as _Error from './Error.js';
+import * as apiVersion from './apiVersion.js';
 import * as resources from './resources.js';
 import { HttpClient, HttpClientResponse } from './net/HttpClient.js';
 import { determineProcessUserAgentProperties, pascalToCamelCase, validateInteger, } from './utils.js';
@@ -9,7 +10,7 @@ import { createWebhooks } from './Webhooks.js';
 const DEFAULT_HOST = 'api.stripe.com';
 const DEFAULT_PORT = '443';
 const DEFAULT_BASE_PATH = '/v1/';
-const DEFAULT_API_VERSION = null;
+const DEFAULT_API_VERSION = apiVersion.ApiVersion;
 const DEFAULT_TIMEOUT = 80000;
 const MAX_NETWORK_RETRY_DELAY_SEC = 2;
 const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;
@@ -30,17 +31,13 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '11.18.0';
+    Stripe.PACKAGE_VERSION = '12.0.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
     Stripe.StripeResource = StripeResource;
     Stripe.resources = resources;
     Stripe.HttpClient = HttpClient;
     Stripe.HttpClientResponse = HttpClientResponse;
     Stripe.CryptoProvider = CryptoProvider;
-    // For backwards compatibiblity after moving to separate CJS and ESM entrypoints.
-    // To be removed in the next major version.
-    Stripe.Stripe = Stripe;
-    Stripe.default = Stripe;
     function Stripe(key, config = {}) {
         if (!(this instanceof Stripe)) {
             return new Stripe(key, config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "11.18.0",
+  "version": "12.0.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",