@stripe/connect-js 1.0.6 → 1.0.8

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/dist/connect.esm.js

@@ -22,6 +22,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+var version = "1.0.8";
+
 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 = () => {
@@ -89,7 +91,10 @@ const createWrapper = stripeConnect => {
       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
+          sdk: true,
+          sdkOptions: {
+            sdkVersion: version
+          }
         })
       }));
     },

package/dist/connect.js

@@ -26,6 +26,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+var version = "1.0.8";
+
 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 = () => {
@@ -93,7 +95,10 @@ const createWrapper = stripeConnect => {
       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
+          sdk: true,
+          sdkOptions: {
+            sdkVersion: version
+          }
         })
       }));
     },

package/dist/pure.esm.js

@@ -22,6 +22,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+var version = "1.0.8";
+
 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 = () => {
@@ -89,7 +91,10 @@ const createWrapper = stripeConnect => {
       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
+          sdk: true,
+          sdkOptions: {
+            sdkVersion: version
+          }
         })
       }));
     },

package/dist/pure.js

@@ -26,6 +26,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+var version = "1.0.8";
+
 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 = () => {
@@ -93,7 +95,10 @@ const createWrapper = stripeConnect => {
       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
+          sdk: true,
+          sdkOptions: {
+            sdkVersion: version
+          }
         })
       }));
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/connect-js",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Connect.js loading utility package",
   "main": "dist/connect.js",
   "module": "dist/connect.esm.js",
@@ -65,5 +65,8 @@
     "typescript": "^4.1.2",
     "yalc": "^1.0.0-pre.53",
     "zx": "^4.2.0"
+  },
+  "dependencies": {
+    "@rollup/plugin-json": "^6.0.0"
   }
 }

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>;