@stytch/react 2.0.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @stytch/react
 
+## 3.0.0
+
+### Minor Changes
+
+- 15dbe7d: Releasing UI components for our B2B SDKs.
+
+### Patch Changes
+
+- Updated dependencies [15dbe7d]
+  - @stytch/vanilla-js@0.13.0
+
 ## 2.0.0
 
 ### Patch Changes

package/dist/b2b/index.d.ts

@@ -1,11 +1,12 @@
 /// <reference types="react" />
 import React from "react";
 import { ReactNode } from "react";
-import { Member, MemberSession, StytchB2BHeadlessClient } from "@stytch/vanilla-js/b2b";
+import { Member, MemberSession, StytchB2BHeadlessClient, StytchB2BUIClient } from "@stytch/vanilla-js/b2b";
+import { Callbacks, StyleConfig, StytchB2BUIConfig } from "@stytch/vanilla-js";
 /**
  * The Stytch Client object passed in to <StytchProvider /> in your application root.
  */
-type StytchB2BClient = StytchB2BHeadlessClient;
+type StytchB2BClient = StytchB2BHeadlessClient | StytchB2BUIClient;
 type SWRMember = {
     /**
      * Either the active {@link Member} object, or null if the user is not logged in.
@@ -89,5 +90,107 @@ type StytchB2BProviderProps = {
  * )
  */
 declare const StytchB2BProvider: ({ stytch, children }: StytchB2BProviderProps) => JSX.Element;
-export { StytchB2BProvider, useStytchB2BClient, useStytchMemberSession, useStytchMember, withStytchB2BClient, withStytchMemberSession, withStytchMember };
+interface StytchB2BProps {
+    /**
+     * An optional {@link StyleConfig} to customize the look and feel of the screen.
+     *
+     * @example
+     * {
+     *    fontFamily: 'Arial, Helvetica, sans-serif',
+     *    width: '360px',
+     *    primaryColor: '#19303D',
+     * }
+     */
+    styles?: StyleConfig;
+    /**
+     * An optional {@link Callbacks} object.
+     *
+     * @example
+     * {
+     *   onError: ({message}) => {
+     *      console.error('Stytch error', message)
+     *   }
+     * }
+     *
+     * @example
+     * {
+     *   onEvent: ({type, data}) => {
+     *     if(type === StytchEventType.B2BMagicLinkAuthenticate) {
+     *       console.log('Logged in with', data);
+     *     }
+     *   }
+     * }
+     */
+    callbacks?: Callbacks;
+    /**
+     * A {@link StytchB2BUIConfig} object. Add products and product-specific config to this object to change the login methods shown.
+     *
+     *
+     * @example
+     * {
+     *   products: ['emailMagicLinks'],
+     *   authFlowType: "Discovery",
+     *   emailMagicLinksOptions: {
+     *     discoveryRedirectURL: 'https://example.com/authenticate',
+     *   },
+     *   sessionOptions: {
+     *     sessionDurationMinutes: 60,
+     *   },
+     * }
+     *
+     * @example
+     * {
+     *   products: ['emailMagicLinks', 'sso'],
+     *   authFlowType: "Organization",
+     *   emailMagicLinksOptions: {
+     *     loginRedirectURL: 'https://example.com/authenticate',
+     *     signupRedirectURL: 'https://example.com/authenticate',
+     *   },
+     *   ssoOptions: {
+     *     loginRedirectURL: 'https://example.com/authenticate',
+     *     signupRedirectURL: 'https://example.com/authenticate',
+     *   },
+     *   sessionOptions: {
+     *     sessionDurationMinutes: 60,
+     *   },
+     * }
+     */
+    config: StytchB2BUIConfig;
+}
+/**
+ * The Stytch B2B UI component.
+ * This component can only be used with a {@link StytchB2BUIClient} client constructor
+ * passed into the {@link StytchB2BProvider}
+ *
+ * See the {@link https://stytch.com/docs/b2b/sdks/javascript-sdk online reference}
+ *
+ * @example
+ * <StytchB2B
+ *   config={{
+ *     authFlowType: "Organization",
+ *     emailMagicLinksOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     ssoOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     sessionOptions: {
+ *       sessionDurationMinutes: 60,
+ *     }
+ *   }}
+ *   styles={{
+ *     fontFamily: '"Helvetica New", Helvetica, sans-serif',
+ *     primaryColor: '#0577CA',
+ *     width: '321px',
+ *   }}
+ *   callbacks={{
+ *     onEvent: (event) => console.log(event)
+ *   }}
+ * />
+ * @param props {@link StytchB2BProps}
+ */
+declare const StytchB2B: ({ styles, callbacks, config }: StytchB2BProps) => JSX.Element;
+export { StytchB2BProvider, useStytchB2BClient, useStytchMemberSession, useStytchMember, withStytchB2BClient, withStytchMemberSession, withStytchMember, StytchB2B };
 export type { StytchB2BProviderProps };

package/dist/b2b/index.esm.d.ts

@@ -1,11 +1,12 @@
 /// <reference types="react" />
 import React from "react";
 import { ReactNode } from "react";
-import { Member, MemberSession, StytchB2BHeadlessClient } from "@stytch/vanilla-js/b2b";
+import { Member, MemberSession, StytchB2BHeadlessClient, StytchB2BUIClient } from "@stytch/vanilla-js/b2b";
+import { Callbacks, StyleConfig, StytchB2BUIConfig } from "@stytch/vanilla-js";
 /**
  * The Stytch Client object passed in to <StytchProvider /> in your application root.
  */
-type StytchB2BClient = StytchB2BHeadlessClient;
+type StytchB2BClient = StytchB2BHeadlessClient | StytchB2BUIClient;
 type SWRMember = {
     /**
      * Either the active {@link Member} object, or null if the user is not logged in.
@@ -89,5 +90,107 @@ type StytchB2BProviderProps = {
  * )
  */
 declare const StytchB2BProvider: ({ stytch, children }: StytchB2BProviderProps) => JSX.Element;
-export { StytchB2BProvider, useStytchB2BClient, useStytchMemberSession, useStytchMember, withStytchB2BClient, withStytchMemberSession, withStytchMember };
+interface StytchB2BProps {
+    /**
+     * An optional {@link StyleConfig} to customize the look and feel of the screen.
+     *
+     * @example
+     * {
+     *    fontFamily: 'Arial, Helvetica, sans-serif',
+     *    width: '360px',
+     *    primaryColor: '#19303D',
+     * }
+     */
+    styles?: StyleConfig;
+    /**
+     * An optional {@link Callbacks} object.
+     *
+     * @example
+     * {
+     *   onError: ({message}) => {
+     *      console.error('Stytch error', message)
+     *   }
+     * }
+     *
+     * @example
+     * {
+     *   onEvent: ({type, data}) => {
+     *     if(type === StytchEventType.B2BMagicLinkAuthenticate) {
+     *       console.log('Logged in with', data);
+     *     }
+     *   }
+     * }
+     */
+    callbacks?: Callbacks;
+    /**
+     * A {@link StytchB2BUIConfig} object. Add products and product-specific config to this object to change the login methods shown.
+     *
+     *
+     * @example
+     * {
+     *   products: ['emailMagicLinks'],
+     *   authFlowType: "Discovery",
+     *   emailMagicLinksOptions: {
+     *     discoveryRedirectURL: 'https://example.com/authenticate',
+     *   },
+     *   sessionOptions: {
+     *     sessionDurationMinutes: 60,
+     *   },
+     * }
+     *
+     * @example
+     * {
+     *   products: ['emailMagicLinks', 'sso'],
+     *   authFlowType: "Organization",
+     *   emailMagicLinksOptions: {
+     *     loginRedirectURL: 'https://example.com/authenticate',
+     *     signupRedirectURL: 'https://example.com/authenticate',
+     *   },
+     *   ssoOptions: {
+     *     loginRedirectURL: 'https://example.com/authenticate',
+     *     signupRedirectURL: 'https://example.com/authenticate',
+     *   },
+     *   sessionOptions: {
+     *     sessionDurationMinutes: 60,
+     *   },
+     * }
+     */
+    config: StytchB2BUIConfig;
+}
+/**
+ * The Stytch B2B UI component.
+ * This component can only be used with a {@link StytchB2BUIClient} client constructor
+ * passed into the {@link StytchB2BProvider}
+ *
+ * See the {@link https://stytch.com/docs/b2b/sdks/javascript-sdk online reference}
+ *
+ * @example
+ * <StytchB2B
+ *   config={{
+ *     authFlowType: "Organization",
+ *     emailMagicLinksOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     ssoOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     sessionOptions: {
+ *       sessionDurationMinutes: 60,
+ *     }
+ *   }}
+ *   styles={{
+ *     fontFamily: '"Helvetica New", Helvetica, sans-serif',
+ *     primaryColor: '#0577CA',
+ *     width: '321px',
+ *   }}
+ *   callbacks={{
+ *     onEvent: (event) => console.log(event)
+ *   }}
+ * />
+ * @param props {@link StytchB2BProps}
+ */
+declare const StytchB2B: ({ styles, callbacks, config }: StytchB2BProps) => JSX.Element;
+export { StytchB2BProvider, useStytchB2BClient, useStytchMemberSession, useStytchMember, withStytchB2BClient, withStytchMemberSession, withStytchMember, StytchB2B };
 export type { StytchB2BProviderProps };

package/dist/b2b/index.esm.js

@@ -1,4 +1,4 @@
-import React, { useRef, useState, useEffect, useCallback, createContext, useContext, useMemo } from 'react';
+import React, { useRef, useState, useEffect, useCallback, createContext, useContext, useMemo, useLayoutEffect } from 'react';
 
 const noProviderError = (item, provider = 'StytchProvider') => `${item} can only be used inside <${provider}>.`;
 const B2BProviderMustBeUniqueError = 'You cannot render a <StytchB2BProvider> inside another <StytchB2BProvider>.';
@@ -6,6 +6,9 @@ const noSSRError = `The @stytch/react library is not meant for use with serversi
 Use the @stytch/nextjs library instead - 
 npm remove @stytch/react && npm install @stytch/nextjs
 `;
+const noHeadlessClientError = `Tried to create a Stytch Login UI element using the Stytch Headless SDK.
+You must use the UI SDK to use UI elements.
+Please make sure you are importing from @stytch/vanilla-js and not from the @stytch/vanilla-js/headless.`;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function invariant(cond, message) {
@@ -42,6 +45,9 @@ const StytchB2BContext = createContext({ isMounted: false });
 const StytchMemberContext = createContext(initialMember);
 const StytchMemberSessionContext = createContext(initialMemberSession);
 const useIsMounted__INTERNAL = () => useContext(StytchB2BContext).isMounted;
+const isUIClient = (client) => {
+    return client.mount !== undefined;
+};
 /**
  * Returns the active Member.
  * Check the fromCache property to determine if the member data is from persistent storage.
@@ -156,4 +162,63 @@ const StytchB2BProvider = ({ stytch, children }) => {
             React.createElement(StytchMemberSessionContext.Provider, { value: finalMemberSession }, children))));
 };
 
-export { StytchB2BProvider, useStytchB2BClient, useStytchMember, useStytchMemberSession, withStytchB2BClient, withStytchMember, withStytchMemberSession };
+/**
+ * The Stytch B2B UI component.
+ * This component can only be used with a {@link StytchB2BUIClient} client constructor
+ * passed into the {@link StytchB2BProvider}
+ *
+ * See the {@link https://stytch.com/docs/b2b/sdks/javascript-sdk online reference}
+ *
+ * @example
+ * <StytchB2B
+ *   config={{
+ *     authFlowType: "Organization",
+ *     emailMagicLinksOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     ssoOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     sessionOptions: {
+ *       sessionDurationMinutes: 60,
+ *     }
+ *   }}
+ *   styles={{
+ *     fontFamily: '"Helvetica New", Helvetica, sans-serif',
+ *     primaryColor: '#0577CA',
+ *     width: '321px',
+ *   }}
+ *   callbacks={{
+ *     onEvent: (event) => console.log(event)
+ *   }}
+ * />
+ * @param props {@link StytchB2BProps}
+ */
+const StytchB2B = ({ styles, callbacks, config }) => {
+    invariant(useIsMounted__INTERNAL(), noProviderError('<StytchB2B />'));
+    const stytchClient = useStytchB2BClient();
+    const containerEl = useRef(null);
+    useLayoutEffect(() => {
+        if (!isUIClient(stytchClient)) {
+            throw Error(noHeadlessClientError);
+        }
+        if (!containerEl.current) {
+            return;
+        }
+        if (!containerEl.current.id) {
+            const randId = Math.floor(Math.random() * 1e6);
+            containerEl.current.id = `stytch-b2b-ui-${randId}`;
+        }
+        stytchClient.mount({
+            callbacks,
+            config,
+            elementId: `#${containerEl.current.id}`,
+            styles,
+        });
+    }, [stytchClient, styles, callbacks]);
+    return React.createElement("div", { ref: containerEl });
+};
+
+export { StytchB2B, StytchB2BProvider, useStytchB2BClient, useStytchMember, useStytchMemberSession, withStytchB2BClient, withStytchMember, withStytchMemberSession };

package/dist/b2b/index.js

@@ -14,6 +14,9 @@ const noSSRError = `The @stytch/react library is not meant for use with serversi
 Use the @stytch/nextjs library instead - 
 npm remove @stytch/react && npm install @stytch/nextjs
 `;
+const noHeadlessClientError = `Tried to create a Stytch Login UI element using the Stytch Headless SDK.
+You must use the UI SDK to use UI elements.
+Please make sure you are importing from @stytch/vanilla-js and not from the @stytch/vanilla-js/headless.`;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function invariant(cond, message) {
@@ -50,6 +53,9 @@ const StytchB2BContext = React.createContext({ isMounted: false });
 const StytchMemberContext = React.createContext(initialMember);
 const StytchMemberSessionContext = React.createContext(initialMemberSession);
 const useIsMounted__INTERNAL = () => React.useContext(StytchB2BContext).isMounted;
+const isUIClient = (client) => {
+    return client.mount !== undefined;
+};
 /**
  * Returns the active Member.
  * Check the fromCache property to determine if the member data is from persistent storage.
@@ -164,6 +170,66 @@ const StytchB2BProvider = ({ stytch, children }) => {
             React__default['default'].createElement(StytchMemberSessionContext.Provider, { value: finalMemberSession }, children))));
 };
 
+/**
+ * The Stytch B2B UI component.
+ * This component can only be used with a {@link StytchB2BUIClient} client constructor
+ * passed into the {@link StytchB2BProvider}
+ *
+ * See the {@link https://stytch.com/docs/b2b/sdks/javascript-sdk online reference}
+ *
+ * @example
+ * <StytchB2B
+ *   config={{
+ *     authFlowType: "Organization",
+ *     emailMagicLinksOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     ssoOptions: {
+ *       loginRedirectURL: 'https://example.com/authenticate',
+ *       signupRedirectURL: 'https://example.com/authenticate',
+ *     },
+ *     sessionOptions: {
+ *       sessionDurationMinutes: 60,
+ *     }
+ *   }}
+ *   styles={{
+ *     fontFamily: '"Helvetica New", Helvetica, sans-serif',
+ *     primaryColor: '#0577CA',
+ *     width: '321px',
+ *   }}
+ *   callbacks={{
+ *     onEvent: (event) => console.log(event)
+ *   }}
+ * />
+ * @param props {@link StytchB2BProps}
+ */
+const StytchB2B = ({ styles, callbacks, config }) => {
+    invariant(useIsMounted__INTERNAL(), noProviderError('<StytchB2B />'));
+    const stytchClient = useStytchB2BClient();
+    const containerEl = React.useRef(null);
+    React.useLayoutEffect(() => {
+        if (!isUIClient(stytchClient)) {
+            throw Error(noHeadlessClientError);
+        }
+        if (!containerEl.current) {
+            return;
+        }
+        if (!containerEl.current.id) {
+            const randId = Math.floor(Math.random() * 1e6);
+            containerEl.current.id = `stytch-b2b-ui-${randId}`;
+        }
+        stytchClient.mount({
+            callbacks,
+            config,
+            elementId: `#${containerEl.current.id}`,
+            styles,
+        });
+    }, [stytchClient, styles, callbacks]);
+    return React__default['default'].createElement("div", { ref: containerEl });
+};
+
+exports.StytchB2B = StytchB2B;
 exports.StytchB2BProvider = StytchB2BProvider;
 exports.useStytchB2BClient = useStytchB2BClient;
 exports.useStytchMember = useStytchMember;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stytch/react",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Stytch's official React Library",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
@@ -32,7 +32,7 @@
   ],
   "devDependencies": {
     "@babel/runtime": "7.18.6",
-    "@stytch/vanilla-js": "0.12.0",
+    "@stytch/vanilla-js": "0.13.0",
     "@testing-library/react": "14.0.0",
     "eslint-config-custom": "0.0.1",
     "react-test-renderer": "18.0.0",
@@ -40,7 +40,7 @@
     "typescript": "4.7.4"
   },
   "peerDependencies": {
-    "@stytch/vanilla-js": "^0.12.0",
+    "@stytch/vanilla-js": "^0.13.0",
     "react": ">= 17.0.2",
     "react-dom": ">= 17.0.2"
   }