@stripe/connect-js 3.3.55-preview-1 → 3.4.1

package/{types/checks.ts → src/components/componentsAndSettersChecks.ts}

@@ -1,5 +1,5 @@
-import type { ConnectElementCustomMethodConfig } from "./config";
-import type { ConnectElementTagName } from "./shared.d";
+import type { ConnectElementTagName } from "../exportedTypes";
+import type { ConnectElementCustomMethodConfig } from "./componentsAndSetters";
 
 // ensure that keys of ConnectElementCustomMethodConfig are from ConnectElementTagName
 export type HasType<T, Q extends T> = Q;

package/src/exportedTypes/index.ts

@@ -0,0 +1,4 @@
+// We export all types in this folder
+
+export * from "./shared";
+export * from "../components/componentsAndSetters";

package/{types/shared.d.ts → src/exportedTypes/shared.ts}

@@ -1,19 +1,23 @@
 import type {
-  ConnectElementCustomMethodConfig,
   ConnectElementCommonMethodConfig,
-  EmbeddedError,
-  EmbeddedErrorType,
-} from "./config";
-export declare type LoadConnectAndInitialize = (
+  ConnectElementCustomMethodConfig,
+  connectElementTagNames,
+} from "../components/componentsAndSetters";
+
+export type LoadConnectAndInitialize = (
   initParams: IStripeConnectInitParams
 ) => StripeConnectInstance;
 
-export declare type OverlayOption = "dialog" | "drawer";
+export interface StripeConnectWrapper {
+  initialize: (params: IStripeConnectInitParams) => StripeConnectInstance;
+}
+
+export type OverlayOption = "dialog" | "drawer";
 
 /*
  * Use a `CssFontSource` to pass custom fonts via a stylesheet URL when initializing a Connect instance.
  */
-export declare type CssFontSource = {
+export type CssFontSource = {
   /**
    * A relative or absolute URL pointing to a CSS file with [@font-face](https://developer.mozilla.org/en/docs/Web/CSS/@font-face) definitions, for example:
    *
@@ -27,7 +31,7 @@ export declare type CssFontSource = {
 /*
  * Use a `CustomFontSource` to pass custom fonts when initializing a Connect instance.
  */
-export declare type CustomFontSource = {
+export type CustomFontSource = {
   /**
    * The name to give the font
    */
@@ -63,7 +67,7 @@ export declare type CustomFontSource = {
 /**
  * Appearance options for the Connect instance.
  */
-export declare type AppearanceOptions = {
+export type AppearanceOptions = {
   /**
    * The type of overlay used throughout the Connect.js design system. Set this to be either a Dialog or Drawer.
    */
@@ -71,7 +75,7 @@ export declare type AppearanceOptions = {
   variables?: AppearanceVariables;
 };
 
-export declare type AppearanceVariables = {
+export type AppearanceVariables = {
   // Commonly used
 
   /**
@@ -507,67 +511,6 @@ 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.
  */
@@ -598,12 +541,6 @@ 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;
@@ -643,46 +580,4 @@ export interface StripeConnectInstance {
 /**
  * Tagnames to be used with the `create` method of the Connect instance.
  */
-export type ConnectElementTagName =
-  | "payments"
-  | "payouts"
-  | "payment-details"
-  | "payment-disputes"
-  | "disputes-list"
-  | "account-onboarding"
-  | "payment-method-settings"
-  | "account-management"
-  | "notification-banner"
-  | "instant-payouts"
-  | "instant-payouts-promotion"
-  | "issuing-card"
-  | "issuing-cards-list"
-  | "financial-account"
-  | "financial-account-transactions"
-  | "recipients"
-  | "capital-financing"
-  | "capital-financing-application"
-  | "capital-financing-promotion"
-  | "capital-overview"
-  | "documents"
-  | "product-tax-code-selector"
-  | "export-tax-transactions"
-  | "tax-registrations"
-  | "tax-settings"
-  | "tax-threshold-monitoring"
-  | "balances"
-  | "payouts-list"
-  | "payout-details"
-  | "app-install"
-  | "app-viewport"
-  | "reporting-chart"
-  | "check-scanning"
-  | "agentic-commerce-settings"
-  | "terminal-hardware-orders"
-  | "terminal-hardware-shop"
-  | "network-cost-passthrough-report"
-  | "balance-report"
-  | "payout-reconciliation-report"
-  | "recipients-list"
-  | "financial-accounts"
-  | "financial-accounts-transactions";
+export type ConnectElementTagName = (typeof connectElementTagNames)[number];

package/src/index.ts

@@ -1,6 +1,9 @@
-import type { IStripeConnectInitParams, StripeConnectInstance } from "../types";
-import type { LoadConnectAndInitialize } from "./shared";
-import { loadScript, initStripeConnect } from "./shared";
+import { initStripeConnect, loadScript } from "./init";
+import type {
+  IStripeConnectInitParams,
+  StripeConnectInstance,
+  LoadConnectAndInitialize,
+} from "./exportedTypes/shared";
 
 // Execute our own script injection after a tick to give users time to do their
 // own script injection.
@@ -20,3 +23,6 @@ export const loadConnectAndInitialize: LoadConnectAndInitialize = (
   loadCalled = true;
   return initStripeConnect(stripePromise, initParams);
 };
+
+// Export all types from the exportedTypes folder
+export * from "./exportedTypes";

package/src/{shared.ts → init.ts}

@@ -1,156 +1,35 @@
+import {
+  ConnectElementCommonMethodConfig,
+  ConnectElementCustomMethodConfig,
+  connectElementTagNames,
+} from "./components/componentsAndSetters";
+import type { ConnectHTMLElementRecord } from "./exportedTypes/shared";
 import type {
+  ConnectElementTagName,
   IStripeConnectInitParams,
   StripeConnectInstance,
-  ConnectElementTagName,
-  ConnectHTMLElementRecord,
-} from "../types";
+  StripeConnectWrapper,
+} from "./exportedTypes/shared";
 import {
-  ConnectElementCommonMethodConfig,
-  ConnectElementCustomMethodConfig,
-} from "../types/config";
-
-export type LoadConnectAndInitialize = (
-  initParams: IStripeConnectInitParams
-) => StripeConnectInstance;
+  EXISTING_SCRIPT_MESSAGE,
+  findScript,
+  injectScript,
+} from "./utils/scriptUtils";
 
-export type ConnectElementHTMLName =
-  | "stripe-connect-payments"
-  | "stripe-connect-payouts"
-  | "stripe-connect-payment-details"
-  | "stripe-connect-payment-disputes"
-  | "stripe-connect-disputes-list"
-  | "stripe-connect-account-onboarding"
-  | "stripe-connect-payment-method-settings"
-  | "stripe-connect-account-management"
-  | "stripe-connect-notification-banner"
-  | "stripe-connect-instant-payouts"
-  | "stripe-connect-instant-payouts-promotion"
-  | "stripe-connect-issuing-card"
-  | "stripe-connect-issuing-cards-list"
-  | "stripe-connect-financial-account"
-  | "stripe-connect-financial-account-transactions"
-  | "stripe-connect-recipients"
-  | "stripe-connect-capital-financing"
-  | "stripe-connect-capital-financing-application"
-  | "stripe-connect-capital-financing-promotion"
-  | "stripe-connect-capital-overview"
-  | "stripe-connect-documents"
-  | "stripe-connect-product-tax-code-selector"
-  | "stripe-connect-export-tax-transactions"
-  | "stripe-connect-tax-registrations"
-  | "stripe-connect-tax-settings"
-  | "stripe-connect-tax-threshold-monitoring"
-  | "stripe-connect-balances"
-  | "stripe-connect-payouts-list"
-  | "stripe-connect-payout-details"
-  | "stripe-connect-app-install"
-  | "stripe-connect-app-viewport"
-  | "stripe-connect-reporting-chart"
-  | "stripe-connect-check-scanning"
-  | "stripe-connect-agentic-commerce-settings"
-  | "stripe-connect-terminal-hardware-orders"
-  | "stripe-connect-terminal-hardware-shop"
-  | "stripe-connect-network-cost-passthrough-report"
-  | "stripe-connect-balance-report"
-  | "stripe-connect-payout-reconciliation-report"
-  | "stripe-connect-recipients-list"
-  | "stripe-connect-financial-accounts"
-  | "stripe-connect-financial-accounts-transactions";
+export type ConnectElementHTMLName = `stripe-connect-${ConnectElementTagName}`;
 
-export const componentNameMapping: Record<
-  ConnectElementTagName,
-  ConnectElementHTMLName
-> = {
-  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",
-  "check-scanning": "stripe-connect-check-scanning",
-  "agentic-commerce-settings": "stripe-connect-agentic-commerce-settings",
-  "terminal-hardware-orders": "stripe-connect-terminal-hardware-orders",
-  "terminal-hardware-shop": "stripe-connect-terminal-hardware-shop",
-  "network-cost-passthrough-report":
-    "stripe-connect-network-cost-passthrough-report",
-  "balance-report": "stripe-connect-balance-report",
-  "payout-reconciliation-report": "stripe-connect-payout-reconciliation-report",
-  "recipients-list": "stripe-connect-recipients-list",
-  "financial-accounts": "stripe-connect-financial-accounts",
-  "financial-accounts-transactions":
-    "stripe-connect-financial-accounts-transactions",
-};
+export const componentNameMapping = connectElementTagNames.reduce(
+  (acc, name) => {
+    acc[name] = `stripe-connect-${name}`;
+    return acc;
+  },
+  {} as Record<ConnectElementTagName, ConnectElementHTMLName>
+);
 
 type StripeConnectInstanceExtended = StripeConnectInstance & {
   debugInstance: () => Promise<StripeConnectInstance>;
 };
 
-interface StripeConnectWrapper {
-  initialize: (params: IStripeConnectInitParams) => StripeConnectInstance;
-}
-
-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";
-
-export const findScript = (): HTMLScriptElement | null => {
-  return (
-    document.querySelectorAll<HTMLScriptElement>(
-      `script[src="${V0_URL}"]`
-    )[0] ||
-    document.querySelectorAll<HTMLScriptElement>(
-      `script[src="${V1_URL}"]`
-    )[0] ||
-    null
-  );
-};
-
-const injectScript = (): HTMLScriptElement => {
-  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: Promise<StripeConnectWrapper> | null = null;
 
 export const isWindowStripeConnectDefined = (stripeConnect: unknown) => {

package/src/pure.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 
-import type { IStripeConnectInitParams } from "../types";
+import type { IStripeConnectInitParams } from "./exportedTypes/shared";
 import { SCRIPT_SELECTOR } from "./utils/jestHelpers";
 
 describe("pure module", () => {

package/src/pure.ts

@@ -1,6 +1,9 @@
-import type { IStripeConnectInitParams, StripeConnectInstance } from "../types";
-import type { LoadConnectAndInitialize } from "./shared";
-import { loadScript, initStripeConnect } from "./shared";
+import { initStripeConnect, loadScript } from "./init";
+import type {
+  IStripeConnectInitParams,
+  LoadConnectAndInitialize,
+  StripeConnectInstance,
+} from "./exportedTypes/shared";
 
 export const loadConnectAndInitialize: LoadConnectAndInitialize = (
   initParams: IStripeConnectInitParams
@@ -13,3 +16,6 @@ export const loadConnectAndInitialize: LoadConnectAndInitialize = (
   }
   return initStripeConnect(maybeConnect, initParams);
 };
+
+// Export all types from the exportedTypes folder
+export * from "./exportedTypes";

package/src/utils/scriptUtils.ts

@@ -0,0 +1,33 @@
+export 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";
+
+export const findScript = (): HTMLScriptElement | null => {
+  return (
+    document.querySelectorAll<HTMLScriptElement>(
+      `script[src="${V1_URL}"]`
+    )[0] ||
+    document.querySelectorAll<HTMLScriptElement>(
+      `script[src="${V0_URL}"]`
+    )[0] ||
+    null
+  );
+};
+
+export const injectScript = (): HTMLScriptElement => {
+  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;
+};

package/dist/src/index.d.ts

@@ -1,2 +0,0 @@
-import type { LoadConnectAndInitialize } from "./shared";
-export declare const loadConnectAndInitialize: LoadConnectAndInitialize;

package/dist/src/pure.d.ts

@@ -1,2 +0,0 @@
-import type { LoadConnectAndInitialize } from "./shared";
-export declare const loadConnectAndInitialize: LoadConnectAndInitialize;

package/dist/src/shared.d.ts

@@ -1,15 +0,0 @@
-import type { IStripeConnectInitParams, StripeConnectInstance, ConnectElementTagName } from "../types";
-export type LoadConnectAndInitialize = (initParams: IStripeConnectInitParams) => StripeConnectInstance;
-export type ConnectElementHTMLName = "stripe-connect-payments" | "stripe-connect-payouts" | "stripe-connect-payment-details" | "stripe-connect-payment-disputes" | "stripe-connect-disputes-list" | "stripe-connect-account-onboarding" | "stripe-connect-payment-method-settings" | "stripe-connect-account-management" | "stripe-connect-notification-banner" | "stripe-connect-instant-payouts" | "stripe-connect-instant-payouts-promotion" | "stripe-connect-issuing-card" | "stripe-connect-issuing-cards-list" | "stripe-connect-financial-account" | "stripe-connect-financial-account-transactions" | "stripe-connect-recipients" | "stripe-connect-capital-financing" | "stripe-connect-capital-financing-application" | "stripe-connect-capital-financing-promotion" | "stripe-connect-capital-overview" | "stripe-connect-documents" | "stripe-connect-product-tax-code-selector" | "stripe-connect-export-tax-transactions" | "stripe-connect-tax-registrations" | "stripe-connect-tax-settings" | "stripe-connect-tax-threshold-monitoring" | "stripe-connect-balances" | "stripe-connect-payouts-list" | "stripe-connect-payout-details" | "stripe-connect-app-install" | "stripe-connect-app-viewport" | "stripe-connect-reporting-chart" | "stripe-connect-check-scanning" | "stripe-connect-agentic-commerce-settings" | "stripe-connect-terminal-hardware-orders" | "stripe-connect-terminal-hardware-shop" | "stripe-connect-network-cost-passthrough-report" | "stripe-connect-balance-report" | "stripe-connect-payout-reconciliation-report" | "stripe-connect-recipients-list" | "stripe-connect-financial-accounts" | "stripe-connect-financial-accounts-transactions";
-export declare const componentNameMapping: Record<ConnectElementTagName, ConnectElementHTMLName>;
-type StripeConnectInstanceExtended = StripeConnectInstance & {
-    debugInstance: () => Promise<StripeConnectInstance>;
-};
-interface StripeConnectWrapper {
-    initialize: (params: IStripeConnectInitParams) => StripeConnectInstance;
-}
-export declare const findScript: () => HTMLScriptElement | null;
-export declare const isWindowStripeConnectDefined: (stripeConnect: unknown) => boolean;
-export declare const loadScript: () => Promise<StripeConnectWrapper>;
-export declare const initStripeConnect: (stripePromise: Promise<StripeConnectWrapper>, initParams: IStripeConnectInitParams) => StripeConnectInstanceExtended;
-export {};

package/types/.eslintrc.yml

@@ -1,3 +0,0 @@
-rules:
-  "@typescript-eslint/triple-slash-reference": 0
-  "@typescript-eslint/adjacent-overload-signatures": 0

package/types/index.d.ts

@@ -1,7 +0,0 @@
-import type { IStripeConnectInitParams, StripeConnectInstance } from "../types";
-
-export declare const loadConnectAndInitialize: (
-  initParams: IStripeConnectInitParams
-) => StripeConnectInstance;
-export * from "./shared";
-export * from "./config";