@stripe/connect-js 1.0.6 → 1.0.7

package/README.md

@@ -3,6 +3,8 @@
 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 `loadConnect` 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 `loadConnect` helper itself and the TypeScript type definitions provided for Connect.js. Updates do not affect runtime availability of features of Connect.js.
+
 Note: Connect embedded components is currently still in beta. Please [contact us](https://stripe.com/docs/connect/get-started-connect-embedded-components#access) to request beta access.
 
 ## Installation

package/package.json

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

package/src/shared.ts

@@ -1,3 +1,4 @@
+import { version } from ".././package.json";
 import { StripeConnectWrapper, IStripeConnectInitParams } from "../types";
 
 export type LoadConnect = () => Promise<StripeConnectWrapper>;
@@ -95,7 +96,10 @@ const createWrapper = (stripeConnect: any) => {
         ...params,
         metaOptions: {
           ...metaOptions,
-          sdk: true
+          sdk: true,
+          sdkOptions: {
+            sdkVersion: version
+          }
         }
       });
     },

package/types/shared.d.ts

@@ -116,20 +116,42 @@ export interface IStripeConnectInitParams {
 }
 
 export interface StripeConnectWrapper {
+  /**
+   * Initializes a Connect JS instance that can be used to create and update Connect components.
+   * @param params Initialization parameters for Connect JS. See https://stripe.com/docs/connect/get-started-connect-embedded-components#configuring-connect-js for more details.
+   * @returns A Connect JS instance.
+   */
   initialize: (params: IStripeConnectInitParams) => StripeConnectInstance;
+
+  /**
+   * Logs the user out of Connect JS sessions
+   * @returns A promise that resolves when the user is logged out.
+   */
   logout: () => Promise<void>;
 }
 
 export interface StripeConnectInstance {
+  /**
+   * Creates a Connect element.
+   * @tagName Name of the Connect component to create.
+   * @returns An HTML component corresponding to that connect component
+   */
   create: (tagName: ConnectElementTagName) => HTMLElement | null;
+
+  /**
+   * Updates the Connect instance with new parameters.
+   * @options New parameters to update the Connect instance with.
+   */
   update: (options: IStripeConnectUpdateParams) => void;
 }
 
-export type ConnectElementTagName =
+export type ConnectElementHTMLName =
   | "stripe-connect-payments"
   | "stripe-connect-payouts"
   | "stripe-connect-payment-details";
 
+export type ConnectElementTagName = "payments" | "payouts" | "payment-details";
+
 export declare const findScript: () => HTMLScriptElement | null;
 
 export declare const loadScript: () => Promise<any | null>;

package/dist/connect.esm.js

@@ -1,117 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-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 findScript = () => {
-  return document.querySelectorAll(`script[src="${V0_URL}"]`)[0];
-};
-const injectScript = () => {
-  const script = document.createElement("script");
-  script.src = "https://connect-js.stripe.com/v0.1/connect.js";
-  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 loadScript = () => {
-  // Ensure that we only attempt to load Connect.js at most once
-  if (stripePromise !== null) {
-    return stripePromise;
-  }
-  stripePromise = new Promise((resolve, reject) => {
-    if (window.StripeConnect) {
-      console.warn(EXISTING_SCRIPT_MESSAGE);
-    }
-    if (window.StripeConnect) {
-      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 (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 initStripeConnect = stripeConnectPromise => {
-  if (stripeConnectPromise === null) {
-    return null;
-  }
-  return stripeConnectPromise;
-};
-const createWrapper = stripeConnect => {
-  const wrapper = {
-    initialize: params => {
-      var _a;
-      const metaOptions = (_a = params.metaOptions) !== null && _a !== void 0 ? _a : {};
-      return stripeConnect.init(Object.assign(Object.assign({}, params), {
-        metaOptions: Object.assign(Object.assign({}, metaOptions), {
-          sdk: true
-        })
-      }));
-    },
-    logout: () => __awaiter(void 0, void 0, void 0, function* () {
-      yield stripeConnect.logout();
-    })
-  };
-  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 loadConnect = () => {
-  loadCalled = true;
-  return stripePromise$1.then(maybeConnect => initStripeConnect(maybeConnect));
-};
-
-export { loadConnect };

package/dist/connect.js

@@ -1,121 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-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 findScript = () => {
-  return document.querySelectorAll(`script[src="${V0_URL}"]`)[0];
-};
-const injectScript = () => {
-  const script = document.createElement("script");
-  script.src = "https://connect-js.stripe.com/v0.1/connect.js";
-  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 loadScript = () => {
-  // Ensure that we only attempt to load Connect.js at most once
-  if (stripePromise !== null) {
-    return stripePromise;
-  }
-  stripePromise = new Promise((resolve, reject) => {
-    if (window.StripeConnect) {
-      console.warn(EXISTING_SCRIPT_MESSAGE);
-    }
-    if (window.StripeConnect) {
-      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 (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 initStripeConnect = stripeConnectPromise => {
-  if (stripeConnectPromise === null) {
-    return null;
-  }
-  return stripeConnectPromise;
-};
-const createWrapper = stripeConnect => {
-  const wrapper = {
-    initialize: params => {
-      var _a;
-      const metaOptions = (_a = params.metaOptions) !== null && _a !== void 0 ? _a : {};
-      return stripeConnect.init(Object.assign(Object.assign({}, params), {
-        metaOptions: Object.assign(Object.assign({}, metaOptions), {
-          sdk: true
-        })
-      }));
-    },
-    logout: () => __awaiter(void 0, void 0, void 0, function* () {
-      yield stripeConnect.logout();
-    })
-  };
-  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 loadConnect = () => {
-  loadCalled = true;
-  return stripePromise$1.then(maybeConnect => initStripeConnect(maybeConnect));
-};
-
-exports.loadConnect = loadConnect;

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-import { LoadConnect } from "./shared";
-export declare const loadConnect: LoadConnect;
-export {};

package/dist/pure.d.ts

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

package/dist/pure.esm.js

@@ -1,107 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-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 findScript = () => {
-  return document.querySelectorAll(`script[src="${V0_URL}"]`)[0];
-};
-const injectScript = () => {
-  const script = document.createElement("script");
-  script.src = "https://connect-js.stripe.com/v0.1/connect.js";
-  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 loadScript = () => {
-  // Ensure that we only attempt to load Connect.js at most once
-  if (stripePromise !== null) {
-    return stripePromise;
-  }
-  stripePromise = new Promise((resolve, reject) => {
-    if (window.StripeConnect) {
-      console.warn(EXISTING_SCRIPT_MESSAGE);
-    }
-    if (window.StripeConnect) {
-      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 (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 initStripeConnect = stripeConnectPromise => {
-  if (stripeConnectPromise === null) {
-    return null;
-  }
-  return stripeConnectPromise;
-};
-const createWrapper = stripeConnect => {
-  const wrapper = {
-    initialize: params => {
-      var _a;
-      const metaOptions = (_a = params.metaOptions) !== null && _a !== void 0 ? _a : {};
-      return stripeConnect.init(Object.assign(Object.assign({}, params), {
-        metaOptions: Object.assign(Object.assign({}, metaOptions), {
-          sdk: true
-        })
-      }));
-    },
-    logout: () => __awaiter(void 0, void 0, void 0, function* () {
-      yield stripeConnect.logout();
-    })
-  };
-  return wrapper;
-};
-
-const loadConnect = () => {
-  return loadScript().then(maybeStripe => initStripeConnect(maybeStripe));
-};
-
-export { loadConnect };

package/dist/pure.js

@@ -1,111 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-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 findScript = () => {
-  return document.querySelectorAll(`script[src="${V0_URL}"]`)[0];
-};
-const injectScript = () => {
-  const script = document.createElement("script");
-  script.src = "https://connect-js.stripe.com/v0.1/connect.js";
-  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 loadScript = () => {
-  // Ensure that we only attempt to load Connect.js at most once
-  if (stripePromise !== null) {
-    return stripePromise;
-  }
-  stripePromise = new Promise((resolve, reject) => {
-    if (window.StripeConnect) {
-      console.warn(EXISTING_SCRIPT_MESSAGE);
-    }
-    if (window.StripeConnect) {
-      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 (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 initStripeConnect = stripeConnectPromise => {
-  if (stripeConnectPromise === null) {
-    return null;
-  }
-  return stripeConnectPromise;
-};
-const createWrapper = stripeConnect => {
-  const wrapper = {
-    initialize: params => {
-      var _a;
-      const metaOptions = (_a = params.metaOptions) !== null && _a !== void 0 ? _a : {};
-      return stripeConnect.init(Object.assign(Object.assign({}, params), {
-        metaOptions: Object.assign(Object.assign({}, metaOptions), {
-          sdk: true
-        })
-      }));
-    },
-    logout: () => __awaiter(void 0, void 0, void 0, function* () {
-      yield stripeConnect.logout();
-    })
-  };
-  return wrapper;
-};
-
-const loadConnect = () => {
-  return loadScript().then(maybeStripe => initStripeConnect(maybeStripe));
-};
-
-exports.loadConnect = loadConnect;

package/dist/shared.d.ts

@@ -1,5 +0,0 @@
-import { StripeConnectWrapper } from "../types";
-export type LoadConnect = () => Promise<StripeConnectWrapper>;
-export declare const findScript: () => HTMLScriptElement | null;
-export declare const loadScript: () => Promise<StripeConnectWrapper | null>;
-export declare const initStripeConnect: (stripeConnectPromise: StripeConnectWrapper | null) => any | null;

package/dist/utils/jestHelpers.d.ts

@@ -1,2 +0,0 @@
-export declare const SCRIPT_SELECTOR = "script[src^=\"https://connect-js.stripe.com/v0.1/connect.js\"]";
-export {};

package/dist/utils/jestSetup.d.ts

@@ -1 +0,0 @@
-export {};