@stripe/connect-js 3.4.6-preview.0 → 3.4.7-preview.0

package/README.md

@@ -0,0 +1,80 @@
+# Connect.js ES Module
+
+The [Connect.js library](https://stripe.com/docs/connect/get-started-connect-embedded-components) and its supporting API allows you to add connected account dashboard functionality to your website.
+This NPM package contains initialization logic for Connect embedded components along with related types.
+
+Calling `loadConnectAndInitialize` always loads the latest version of Connect.js, regardless of which version of `@stripe/connect-js` you use. Updates for this package only impact tooling around the `loadConnectAndInitialize` helper itself and the TypeScript type definitions provided for Connect.js. Updates do not affect runtime availability of features of Connect.js.
+
+The embedded onboarding component is generally available now. Please refer to our [documentation](https://stripe.com/docs/connect/supported-embedded-components#account-onboarding) for more information.
+
+Note: Some Connect embedded components are in preview. These can be [viewed on our doc site](https://docs.stripe.com/connect/supported-embedded-components), where you can also request preview access.
+
+## Installation
+
+Use `npm` to install the Connect.js module:
+
+```sh
+npm install @stripe/connect-js
+```
+
+## Documentation
+
+- [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
+- [Quickstart guide](https://stripe.com/docs/connect/connect-embedded-components/quickstart)
+
+## Usage
+
+### `loadConnectAndInitialize`
+
+This synchronous function takes in a publishable key, a function to retrieve the client secret returned from the [Account Session API](https://stripe.com/docs/api/account_sessions/create), and other [initialization parameters](https://stripe.com/docs/connect/get-started-connect-embedded-components#configuring-connect-js). It returns a `StripeConnectInstance`. If necessary, it will load Connect.js for you by inserting the Connect.js script tag.
+
+```js
+import { loadConnectAndInitialize } from "@stripe/connect-js";
+const fetchClientSecret = async () => {
+  // Fetch the AccountSession client secret by making an API call to your service
+};
+
+const instance = loadConnectAndInitialize({
+  publishableKey: "{{pk test123}}",
+  fetchClientSecret: fetchClientSecret,
+});
+```
+
+We’ve placed a random API key in this example. Replace it with your
+[actual publishable API keys](https://dashboard.stripe.com/account/apikeys) to
+test this code through your Connect account.
+
+If you have deployed a
+[Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/Security/CSP),
+make sure to
+[include Connect.js in your directives](https://stripe.com/docs/connect/get-started-connect-embedded-components?platform=web#csp-and-http-header-requirements).
+
+### Import as a side effect
+
+Import `@stripe/connect-js` as a side effect in code that will be included
+throughout your site (e.g. your root module). This will make sure the Connect.js
+script tag is inserted immediately upon page load.
+
+```js
+import "@stripe/connect-js";
+```
+
+### Importing `loadConnectAndInitialize` without side effects
+
+If you would like to use `loadConnectAndInitialize` in your application, but defer loading the
+Connect.js script until `loadConnectAndInitialize` is first called, use the alternative
+`@stripe/connect-js/pure` import path:
+
+```js
+import { loadConnectAndInitialize } from "@stripe/connect-js/pure";
+
+// Connect.js will not be loaded until `loadConnect` is called
+const instance = loadConnectAndInitialize({
+  publishableKey: "{{pk test123}}",
+  fetchClientSecret: fetchClientSecret,
+});
+```
+
+## Preview/GA
+
+To work with the [preview](https://docs.stripe.com/connect/supported-embedded-components) version of embedded components, use the [preview](/preview) folder. For the stable GA version, use [/ga](/ga).

package/dist/components/componentsAndSetters.d.ts

@@ -196,6 +196,8 @@ export declare const ConnectElementCustomMethodConfig: {
         setHowCapitalWorksUrl: (_howCapitalWorksUrl: string | undefined) => void;
         setOnApplicationStepChange: (_listener: (({ step }: StepChange) => void) | undefined) => void;
         setDefaultFinancingOffer: (_defaultFinancingOffer: string | undefined) => void;
+        setOnApplicationInitiated: (_listener: (() => void) | undefined) => void;
+        setResumeInitiatedApplication: (_resumeInitiatedApplication: boolean | undefined) => void;
     };
     "capital-financing-promotion": {
         setLayout: (_layout: FinancingPromotionLayoutType | undefined) => void;
@@ -205,6 +207,8 @@ export declare const ConnectElementCustomMethodConfig: {
         setHowCapitalWorksUrl: (_howCapitalWorksUrl: string | undefined) => void;
         setEligibilityCriteriaUrl: (_eligibilityCriteriaUrl: string | undefined) => void;
         setOnApplicationStepChange: (_listener: (({ step }: StepChange) => void) | undefined) => void;
+        setOnAdvanceToCapitalFinancingApplication: (_listener: (() => void) | undefined) => void;
+        setDisableNestedCapitalFinancingApplication: (_disableNestedCapitalFinancingApplication: boolean | undefined) => void;
     };
     "reporting-chart": {
         setReportName: (_reportName: ReportName) => void;

package/dist/connect.esm.js

@@ -82,7 +82,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setOnApplicationStepChange: _listener => {},
-    setDefaultFinancingOffer: _defaultFinancingOffer => {}
+    setDefaultFinancingOffer: _defaultFinancingOffer => {},
+    setOnApplicationInitiated: _listener => {},
+    setResumeInitiatedApplication: _resumeInitiatedApplication => {}
   },
   "capital-financing-promotion": {
     setLayout: _layout => {},
@@ -91,7 +93,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setEligibilityCriteriaUrl: _eligibilityCriteriaUrl => {},
-    setOnApplicationStepChange: _listener => {}
+    setOnApplicationStepChange: _listener => {},
+    setOnAdvanceToCapitalFinancingApplication: _listener => {},
+    setDisableNestedCapitalFinancingApplication: _disableNestedCapitalFinancingApplication => {}
   },
   "reporting-chart": {
     setReportName: _reportName => {},
@@ -237,7 +241,7 @@ const initStripeConnect = (stripePromise, initParams) => {
         element[method] = function (value) {
           stripeConnectInstance.then(() => {
             if (!this[`${method}InternalOnly`]) {
-              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.6-preview.0`);
+              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.7-preview.0`);
             }
             this[`${method}InternalOnly`](value);
           });
@@ -291,7 +295,7 @@ const createWrapper = stripeConnect => {
           sdk: true,
           sdkOptions: {
             // This will be replaced by the npm package version when bundling
-            sdkVersion: "3.4.6-preview.0"
+            sdkVersion: "3.4.7-preview.0"
           }
         })
       }));

package/dist/connect.js

@@ -86,7 +86,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setOnApplicationStepChange: _listener => {},
-    setDefaultFinancingOffer: _defaultFinancingOffer => {}
+    setDefaultFinancingOffer: _defaultFinancingOffer => {},
+    setOnApplicationInitiated: _listener => {},
+    setResumeInitiatedApplication: _resumeInitiatedApplication => {}
   },
   "capital-financing-promotion": {
     setLayout: _layout => {},
@@ -95,7 +97,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setEligibilityCriteriaUrl: _eligibilityCriteriaUrl => {},
-    setOnApplicationStepChange: _listener => {}
+    setOnApplicationStepChange: _listener => {},
+    setOnAdvanceToCapitalFinancingApplication: _listener => {},
+    setDisableNestedCapitalFinancingApplication: _disableNestedCapitalFinancingApplication => {}
   },
   "reporting-chart": {
     setReportName: _reportName => {},
@@ -241,7 +245,7 @@ const initStripeConnect = (stripePromise, initParams) => {
         element[method] = function (value) {
           stripeConnectInstance.then(() => {
             if (!this[`${method}InternalOnly`]) {
-              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.6-preview.0`);
+              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.7-preview.0`);
             }
             this[`${method}InternalOnly`](value);
           });
@@ -295,7 +299,7 @@ const createWrapper = stripeConnect => {
           sdk: true,
           sdkOptions: {
             // This will be replaced by the npm package version when bundling
-            sdkVersion: "3.4.6-preview.0"
+            sdkVersion: "3.4.7-preview.0"
           }
         })
       }));

package/dist/pure.esm.js

@@ -82,7 +82,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setOnApplicationStepChange: _listener => {},
-    setDefaultFinancingOffer: _defaultFinancingOffer => {}
+    setDefaultFinancingOffer: _defaultFinancingOffer => {},
+    setOnApplicationInitiated: _listener => {},
+    setResumeInitiatedApplication: _resumeInitiatedApplication => {}
   },
   "capital-financing-promotion": {
     setLayout: _layout => {},
@@ -91,7 +93,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setEligibilityCriteriaUrl: _eligibilityCriteriaUrl => {},
-    setOnApplicationStepChange: _listener => {}
+    setOnApplicationStepChange: _listener => {},
+    setOnAdvanceToCapitalFinancingApplication: _listener => {},
+    setDisableNestedCapitalFinancingApplication: _disableNestedCapitalFinancingApplication => {}
   },
   "reporting-chart": {
     setReportName: _reportName => {},
@@ -237,7 +241,7 @@ const initStripeConnect = (stripePromise, initParams) => {
         element[method] = function (value) {
           stripeConnectInstance.then(() => {
             if (!this[`${method}InternalOnly`]) {
-              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.6-preview.0`);
+              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.7-preview.0`);
             }
             this[`${method}InternalOnly`](value);
           });
@@ -291,7 +295,7 @@ const createWrapper = stripeConnect => {
           sdk: true,
           sdkOptions: {
             // This will be replaced by the npm package version when bundling
-            sdkVersion: "3.4.6-preview.0"
+            sdkVersion: "3.4.7-preview.0"
           }
         })
       }));

package/dist/pure.js

@@ -86,7 +86,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setOnApplicationStepChange: _listener => {},
-    setDefaultFinancingOffer: _defaultFinancingOffer => {}
+    setDefaultFinancingOffer: _defaultFinancingOffer => {},
+    setOnApplicationInitiated: _listener => {},
+    setResumeInitiatedApplication: _resumeInitiatedApplication => {}
   },
   "capital-financing-promotion": {
     setLayout: _layout => {},
@@ -95,7 +97,9 @@ const ConnectElementCustomMethodConfig = {
     setPrivacyPolicyUrl: _privacyPolicyUrl => {},
     setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
     setEligibilityCriteriaUrl: _eligibilityCriteriaUrl => {},
-    setOnApplicationStepChange: _listener => {}
+    setOnApplicationStepChange: _listener => {},
+    setOnAdvanceToCapitalFinancingApplication: _listener => {},
+    setDisableNestedCapitalFinancingApplication: _disableNestedCapitalFinancingApplication => {}
   },
   "reporting-chart": {
     setReportName: _reportName => {},
@@ -241,7 +245,7 @@ const initStripeConnect = (stripePromise, initParams) => {
         element[method] = function (value) {
           stripeConnectInstance.then(() => {
             if (!this[`${method}InternalOnly`]) {
-              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.6-preview.0`);
+              throw new Error(`Method ${method} is not available in the ${tagName} HTML element. Are you using a supported version of the "@stripe/connect-js" package? Using version: 3.4.7-preview.0`);
             }
             this[`${method}InternalOnly`](value);
           });
@@ -295,7 +299,7 @@ const createWrapper = stripeConnect => {
           sdk: true,
           sdkOptions: {
             // This will be replaced by the npm package version when bundling
-            sdkVersion: "3.4.6-preview.0"
+            sdkVersion: "3.4.7-preview.0"
           }
         })
       }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/connect-js",
-  "version": "3.4.6-preview.0",
+  "version": "3.4.7-preview.0",
   "description": "Connect.js loading utility package (preview version)",
   "main": "dist/connect.js",
   "module": "dist/connect.esm.js",

package/src/components/componentsAndSetters.ts

@@ -402,6 +402,12 @@ export const ConnectElementCustomMethodConfig = {
     setDefaultFinancingOffer: (
       _defaultFinancingOffer: string | undefined
     ): void => {},
+    setOnApplicationInitiated: (
+      _listener: (() => void) | undefined
+    ): void => {},
+    setResumeInitiatedApplication: (
+      _resumeInitiatedApplication: boolean | undefined
+    ): void => {},
   },
   "capital-financing-promotion": {
     setLayout: (_layout: FinancingPromotionLayoutType | undefined): void => {},
@@ -426,6 +432,12 @@ export const ConnectElementCustomMethodConfig = {
     setOnApplicationStepChange: (
       _listener: (({ step }: StepChange) => void) | undefined
     ): void => {},
+    setOnAdvanceToCapitalFinancingApplication: (
+      _listener: (() => void) | undefined
+    ): void => {},
+    setDisableNestedCapitalFinancingApplication: (
+      _disableNestedCapitalFinancingApplication: boolean | undefined
+    ): void => {},
   },
   "reporting-chart": {
     setReportName: (_reportName: ReportName): void => {},