@stripe/connect-js 3.3.41-preview-1 → 3.3.43-preview-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/connect-js",
-  "version": "3.3.41-preview-1",
+  "version": "3.3.43-preview-1",
   "description": "Connect.js loading utility package",
   "main": "dist/connect.js",
   "module": "dist/connect.esm.js",

package/types/config.ts

@@ -385,6 +385,9 @@ export const ConnectElementCustomMethodConfig = {
       _listener: (({ id }: { id: string }) => void) | undefined
     ): void => {},
     setDisplayCountries: (_countries: string[] | undefined): void => {},
+    setOnAfterTaxRegistrationExpired: (
+      _listener: (({ id }: { id: string }) => void) | undefined
+    ): void => {},
   },
   "tax-threshold-monitoring": {
     setDisplayCountries: (_countries: string[] | undefined): void => {},

package/types/shared.d.ts

@@ -1,6 +1,8 @@
 import type {
   ConnectElementCustomMethodConfig,
   ConnectElementCommonMethodConfig,
+  EmbeddedError,
+  EmbeddedErrorType,
 } from "./config";
 export declare type LoadConnectAndInitialize = (
   initParams: IStripeConnectInitParams
@@ -417,6 +419,67 @@ export type IStripeConnectUpdateParams = {
   locale?: string;
 };
 
+/**
+ * Reasons why risk signals collection was skipped.
+ */
+export declare type RiskSignalsCollectionSkippedReason =
+  /**
+   * Required component (account_onboarding) not enabled.
+   */
+  | "required_component_not_enabled"
+  /**
+   * The account doesn't have a risk signals collection requirement.
+   */
+  | "not_required"
+  /**
+   * The risk signals collection requirement has already been fulfilled.
+   */
+  | "requirement_fulfilled";
+
+/**
+ * Error types that can occur during risk signals collection.
+ */
+export declare type RiskSignalsCollectionErrorType = Extract<
+  EmbeddedErrorType,
+  | "api_connection_error"
+  | "invalid_request_error"
+  | "rate_limit_error"
+  | "api_error"
+>;
+
+/**
+ * Errors that can occur during risk signals collection.
+ */
+export declare type RiskSignalsCollectionError =
+  /**
+   * Error occurred during general Connect.js loading.
+   */
+  | { type: "load_error"; loadError: EmbeddedError }
+
+  /**
+   * Error occurred during risk signals collection.
+   */
+  | { type: RiskSignalsCollectionErrorType; message?: string };
+
+/**
+ * Event emitted during risk signals collection.
+ */
+export declare type RiskSignalsCollectionEvent =
+  /**
+   * Risk signals collection completed and successfully received by Stripe.
+   */
+  | { status: "completed" }
+
+  /**
+   * Risk signals collection skipped with reason.
+   */
+  | { status: "skipped"; skippedReason: RiskSignalsCollectionSkippedReason }
+
+  /**
+   * Risk signals collection failed due to error and was not sent to Stripe server.
+   */
+  | { status: "failed"; error: RiskSignalsCollectionError };
+
 /**
  * Initialization parameters for Connect JS. See https://stripe.com/docs/connect/get-started-connect-embedded-components#configuring-connect-js for more details.
  */
@@ -447,6 +510,12 @@ export interface IStripeConnectInitParams {
    * An array of custom fonts, which embedded components created from a ConnectInstance can use.
    */
   fonts?: Array<CssFontSource | CustomFontSource>;
+
+  /**
+   * Callback for risk signals collection event
+   * @param {RiskSignalsCollectionEvent} event - The risk signals collection event containing status and additional details.
+   */
+  onRiskSignalsCollection?: (event: RiskSignalsCollectionEvent) => void;
 }
 
 type ConnectElementCustomMethods = typeof ConnectElementCustomMethodConfig;

package/dist/connect.esm.js

@@ -1,331 +0,0 @@
-/* eslint-disable @typescript-eslint/no-empty-function */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-const ConnectElementCommonMethodConfig = {
-  setOnLoadError: _listener => {},
-  setOnLoaderStart: _listener => {}
-};
-const ConnectElementCustomMethodConfig = {
-  payments: {
-    setDefaultFilters: _filters => {}
-  },
-  "payment-details": {
-    setPayment: _payment => {},
-    setOnClose: _listener => {}
-  },
-  "payment-disputes": {
-    setPayment: _payment => {},
-    setOnDisputesLoaded: _listener => {}
-  },
-  "account-onboarding": {
-    setFullTermsOfServiceUrl: _termOfServiceUrl => {},
-    setRecipientTermsOfServiceUrl: _recipientTermsOfServiceUrl => {},
-    setPrivacyPolicyUrl: _privacyPolicyUrl => {},
-    setSkipTermsOfServiceCollection: _skipTermsOfServiceCollection => {},
-    setCollectionOptions: _collectionOptions => {},
-    setOnExit: _listener => {},
-    setOnStepChange: _listener => {}
-  },
-  "account-management": {
-    setCollectionOptions: _collectionOptions => {}
-  },
-  "notification-banner": {
-    setCollectionOptions: _collectionOptions => {},
-    setOnNotificationsChange: _listener => {}
-  },
-  "instant-payouts-promotion": {
-    setOnInstantPayoutsPromotionLoaded: _listener => {},
-    setOnInstantPayoutCreated: _listener => {}
-  },
-  "issuing-card": {
-    setDefaultCard: _defaultCard => {},
-    setCardSwitching: _cardSwitching => {},
-    setFetchEphemeralKey: _fetchEphemeralKey => {},
-    setShowSpendControls: _showSpendControls => {}
-  },
-  "issuing-cards-list": {
-    setFetchEphemeralKey: _fetchEphemeralKey => {},
-    setShowSpendControls: _showSpendControls => {},
-    setIssuingProgram: _issuingProgram => {}
-  },
-  "financial-account": {
-    setFinancialAccount: _financialAccount => {}
-  },
-  "financial-account-transactions": {
-    setFinancialAccount: _financialAccount => {}
-  },
-  recipients: {
-    setDataSource: _dataSource => {}
-  },
-  "app-install": {
-    setApp: _app => {},
-    setOnAppInstallStateFetched: _listener => {},
-    setOnAppInstallStateChanged: _listener => {}
-  },
-  "app-viewport": {
-    setApp: _app => {},
-    setAppData: _appData => {}
-  },
-  "payment-method-settings": {
-    setPaymentMethodConfiguration: _paymentMethodConfiguration => {}
-  },
-  "capital-financing": {
-    setDefaultFinancingOffer: _defaultFinancingOffer => {},
-    setShowFinancingSelector: _showFinancingSelector => {},
-    setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
-    setSupportUrl: _supportUrl => {},
-    setOnFinancingsLoaded: _listener => {}
-  },
-  "capital-financing-application": {
-    setOnApplicationSubmitted: _listener => {},
-    setPrivacyPolicyUrl: _privacyPolicyUrl => {},
-    setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
-    setOnApplicationStepChange: _listener => {}
-  },
-  "capital-financing-promotion": {
-    setLayout: _layout => {},
-    setOnApplicationSubmitted: _listener => {},
-    setOnEligibleFinancingOfferLoaded: _listener => {},
-    setPrivacyPolicyUrl: _privacyPolicyUrl => {},
-    setHowCapitalWorksUrl: _howCapitalWorksUrl => {},
-    setEligibilityCriteriaUrl: _eligibilityCriteriaUrl => {},
-    setOnApplicationStepChange: _listener => {}
-  },
-  "reporting-chart": {
-    setReportName: _reportName => {},
-    setIntervalStart: _intervalStart => {},
-    setIntervalEnd: _intervalEnd => {},
-    setIntervalType: _intervalType => {}
-  },
-  "tax-settings": {
-    setHideProductTaxCodeSelector: _hidden => {},
-    setDisplayHeadOfficeCountries: _countries => {},
-    setOnTaxSettingsUpdated: _listener => {}
-  },
-  "tax-registrations": {
-    setOnAfterTaxRegistrationAdded: _listener => {},
-    setDisplayCountries: _countries => {}
-  },
-  "tax-threshold-monitoring": {
-    setDisplayCountries: _countries => {}
-  },
-  "product-tax-code-selector": {
-    setOnTaxCodeSelect: _listener => {},
-    setHideDescription: _hideDescription => {},
-    setDisabled: _disabled => {},
-    setInitialTaxCode: _initialTaxCode => {}
-  },
-  "export-tax-transactions": {},
-  "payout-details": {
-    setPayout: _payout => {},
-    setOnClose: _listener => {}
-  }
-};
-
-const componentNameMapping = {
-  payments: "stripe-connect-payments",
-  payouts: "stripe-connect-payouts",
-  "payment-details": "stripe-connect-payment-details",
-  "payment-disputes": "stripe-connect-payment-disputes",
-  "disputes-list": "stripe-connect-disputes-list",
-  "account-onboarding": "stripe-connect-account-onboarding",
-  "payment-method-settings": "stripe-connect-payment-method-settings",
-  "account-management": "stripe-connect-account-management",
-  "notification-banner": "stripe-connect-notification-banner",
-  "instant-payouts": "stripe-connect-instant-payouts",
-  "instant-payouts-promotion": "stripe-connect-instant-payouts-promotion",
-  "issuing-card": "stripe-connect-issuing-card",
-  "issuing-cards-list": "stripe-connect-issuing-cards-list",
-  "financial-account": "stripe-connect-financial-account",
-  recipients: "stripe-connect-recipients",
-  "financial-account-transactions": "stripe-connect-financial-account-transactions",
-  "capital-financing": "stripe-connect-capital-financing",
-  "capital-financing-application": "stripe-connect-capital-financing-application",
-  "capital-financing-promotion": "stripe-connect-capital-financing-promotion",
-  "capital-overview": "stripe-connect-capital-overview",
-  documents: "stripe-connect-documents",
-  "product-tax-code-selector": "stripe-connect-product-tax-code-selector",
-  "export-tax-transactions": "stripe-connect-export-tax-transactions",
-  "tax-registrations": "stripe-connect-tax-registrations",
-  "tax-settings": "stripe-connect-tax-settings",
-  "tax-threshold-monitoring": "stripe-connect-tax-threshold-monitoring",
-  balances: "stripe-connect-balances",
-  "payouts-list": "stripe-connect-payouts-list",
-  "payout-details": "stripe-connect-payout-details",
-  "app-install": "stripe-connect-app-install",
-  "app-viewport": "stripe-connect-app-viewport",
-  "reporting-chart": "stripe-connect-reporting-chart"
-};
-const EXISTING_SCRIPT_MESSAGE = "loadConnect was called but an existing Connect.js script already exists in the document; existing script parameters will be used";
-const V0_URL = "https://connect-js.stripe.com/v0.1/connect.js";
-const V1_URL = "https://connect-js.stripe.com/v1.0/connect.js";
-const findScript = () => {
-  return document.querySelectorAll(`script[src="${V0_URL}"]`)[0] || document.querySelectorAll(`script[src="${V1_URL}"]`)[0] || null;
-};
-const injectScript = () => {
-  const script = document.createElement("script");
-  script.src = V1_URL;
-  const head = document.head;
-  if (!head) {
-    throw new Error("Expected document.head not to be null. Connect.js requires a <head> element.");
-  }
-  document.head.appendChild(script);
-  return script;
-};
-let stripePromise = null;
-const isWindowStripeConnectDefined = stripeConnect => {
-  // We only consider `StripeConnect` defined if `init` is a function
-  // Why? HTML markup like:
-  // <a id="StripeConnect"><a id="StripeConnect" name="init" href="stripe"></a></a> in the <head> of the page
-  // can end up "contaminating" the window.StripeConnect object and cause issues in connect.js initialization
-  return !!(stripeConnect && typeof stripeConnect === "object" && "init" in stripeConnect && typeof stripeConnect.init === "function");
-};
-const loadScript = () => {
-  // Ensure that we only attempt to load Connect.js at most once
-  if (stripePromise !== null) {
-    return stripePromise;
-  }
-  stripePromise = new Promise((resolve, reject) => {
-    if (typeof window === "undefined") {
-      reject("ConnectJS won't load when rendering code in the server - it can only be loaded on a browser. This error is expected when loading ConnectJS in SSR environments, like NextJS. It will have no impact in the UI, however if you wish to avoid it, you can switch to the `pure` version of the connect.js loader: https://github.com/stripe/connect-js#importing-loadconnect-without-side-effects.");
-      return;
-    }
-    if (isWindowStripeConnectDefined(window.StripeConnect)) {
-      console.warn(EXISTING_SCRIPT_MESSAGE);
-      const wrapper = createWrapper(window.StripeConnect);
-      resolve(wrapper);
-      return;
-    }
-    try {
-      let script = findScript();
-      if (script) {
-        console.warn(EXISTING_SCRIPT_MESSAGE);
-      } else if (!script) {
-        script = injectScript();
-      }
-      script.addEventListener("load", () => {
-        if (isWindowStripeConnectDefined(window.StripeConnect)) {
-          const wrapper = createWrapper(window.StripeConnect);
-          resolve(wrapper);
-        } else {
-          reject(new Error("Connect.js did not load the necessary objects"));
-        }
-      });
-      script.addEventListener("error", () => {
-        reject(new Error("Failed to load Connect.js"));
-      });
-    } catch (error) {
-      reject(error);
-    }
-  });
-  return stripePromise;
-};
-const hasCustomMethod = tagName => {
-  return tagName in ConnectElementCustomMethodConfig;
-};
-const initStripeConnect = (stripePromise, initParams) => {
-  var _a;
-  const eagerClientSecretPromise = (() => {
-    try {
-      return initParams.fetchClientSecret();
-    } catch (error) {
-      return Promise.reject(error);
-    }
-  })();
-  const metaOptions = (_a = initParams.metaOptions) !== null && _a !== void 0 ? _a : {};
-  const stripeConnectInstance = stripePromise.then(wrapper => wrapper.initialize(Object.assign(Object.assign({}, initParams), {
-    metaOptions: Object.assign(Object.assign({}, metaOptions), {
-      eagerClientSecretPromise
-    })
-  })));
-  return {
-    create: tagName => {
-      let htmlName = componentNameMapping[tagName];
-      if (!htmlName) {
-        htmlName = tagName;
-      }
-      const element = document.createElement(htmlName);
-      const customMethods = hasCustomMethod(tagName) ? ConnectElementCustomMethodConfig[tagName] : {};
-      const methods = Object.assign(Object.assign({}, customMethods), ConnectElementCommonMethodConfig);
-      for (const method in methods) {
-        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.3.41-preview-1`);
-            }
-            this[`${method}InternalOnly`](value);
-          });
-        };
-      }
-      stripeConnectInstance.then(instance => {
-        if (!element.isConnected && !element.setConnector) {
-          // If the element is not connected to the DOM and the `setConnector` method is not
-          // defined, this indicates the element was created before connect.js was loaded, and has
-          // not been transformed into a custom element yet
-          // To load the custom element code on it, we need to connect and disconnect it to the DOM
-          // This isn't a problem, as the element will be invisible, and we know the element is already
-          // not currently connected to the DOM
-          const oldDisplay = element.style.display;
-          element.style.display = "none";
-          document.body.appendChild(element);
-          document.body.removeChild(element);
-          element.style.display = oldDisplay;
-        }
-        if (!element || !element.setConnector) {
-          throw new Error(`Element ${tagName} was not transformed into a custom element. Are you using a documented component? See https://docs.stripe.com/connect/supported-embedded-components for a list of supported components`);
-        }
-        element.setConnector(instance.connect);
-      });
-      return element;
-    },
-    update: updateOptions => {
-      stripeConnectInstance.then(instance => {
-        instance.update(updateOptions);
-      });
-    },
-    debugInstance: () => {
-      return stripeConnectInstance;
-    },
-    logout: () => {
-      return stripeConnectInstance.then(instance => {
-        return instance.logout();
-      });
-    }
-  };
-};
-const createWrapper = stripeConnect => {
-  window.StripeConnect = window.StripeConnect || {};
-  window.StripeConnect.optimizedLoading = true;
-  const wrapper = {
-    initialize: params => {
-      var _a;
-      const metaOptions = (_a = params.metaOptions) !== null && _a !== void 0 ? _a : {};
-      const stripeConnectInstance = stripeConnect.init(Object.assign(Object.assign({}, params), {
-        metaOptions: Object.assign(Object.assign({}, metaOptions), {
-          sdk: true,
-          sdkOptions: {
-            // This will be replaced by the npm package version when bundling
-            sdkVersion: "3.3.41-preview-1"
-          }
-        })
-      }));
-      return stripeConnectInstance;
-    }
-  };
-  return wrapper;
-};
-
-// Execute our own script injection after a tick to give users time to do their
-// own script injection.
-const stripePromise$1 = Promise.resolve().then(() => loadScript());
-let loadCalled = false;
-stripePromise$1.catch(err => {
-  if (!loadCalled) {
-    console.warn(err);
-  }
-});
-const loadConnectAndInitialize = initParams => {
-  loadCalled = true;
-  return initStripeConnect(stripePromise$1, initParams);
-};
-
-export { loadConnectAndInitialize };