@clerk/clerk-react - npm Package Compare versions

Comparing version 5.20.4 to 5.21.0-snapshot.v20241218205220

dist/index.d.ts

 import * as _clerk_types from '@clerk/types';
-import { Without, SignInProps, SignUpProps, CreateOrganizationProps, OrganizationListProps, GoogleOneTapProps, WaitlistProps, UserProfileProps, UserButtonProps, OrganizationProfileProps, OrganizationSwitcherProps, SignOutOptions, SignInResource, SignUpResource, EmailAddressResource, CreateEmailLinkFlowReturn, SignInStartEmailLinkFlowParams, StartEmailLinkFlowParams, UseSignInReturn, UseSignUpReturn } from '@clerk/types';
-import React, { PropsWithChildren } from 'react';
-import { W as WithClerkProp, U as UserProfilePageProps, a as UserProfileLinkProps, b as UserButtonActionProps, c as UserButtonLinkProps, O as OrganizationProfilePageProps, d as OrganizationProfileLinkProps, S as SignInButtonProps, e as SignUpButtonProps, f as SignInWithMetamaskButtonProps, C as ClerkProviderProps } from './useAuth-Dfw9QOW7.js';
-export { A as AuthenticateWithRedirectCallback, B as BrowserClerk, h as ClerkLoaded, i as ClerkLoading, g as ClerkProp, H as HeadlessBrowserClerk, P as Protect, p as ProtectProps, n as RedirectToCreateOrganization, o as RedirectToOrganizationProfile, R as RedirectToSignIn, l as RedirectToSignUp, m as RedirectToUserProfile, k as SignedIn, j as SignedOut, q as useAuth } from './useAuth-Dfw9QOW7.js';
+import { Without, SignInProps, SignUpProps, CreateOrganizationProps, OrganizationListProps, WaitlistProps, UserProfileProps, UserButtonProps, OrganizationProfileProps, OrganizationSwitcherProps, SignOutOptions, SignInResource, SignUpResource, EmailAddressResource, CreateEmailLinkFlowReturn, SignInStartEmailLinkFlowParams, StartEmailLinkFlowParams, UseSignInReturn, UseSignUpReturn } from '@clerk/types';
+import React, { ReactNode, PropsWithChildren } from 'react';
+import { W as WithClerkProp, U as UserProfilePageProps, a as UserProfileLinkProps, b as UserButtonActionProps, c as UserButtonLinkProps, O as OrganizationProfilePageProps, d as OrganizationProfileLinkProps, S as SignInButtonProps, e as SignUpButtonProps, f as SignInWithMetamaskButtonProps, C as ClerkProviderProps } from './useAuth-Bu7xegV8.js';
+export { A as AuthenticateWithRedirectCallback, B as BrowserClerk, h as ClerkLoaded, i as ClerkLoading, g as ClerkProp, H as HeadlessBrowserClerk, P as Protect, p as ProtectProps, n as RedirectToCreateOrganization, o as RedirectToOrganizationProfile, R as RedirectToSignIn, l as RedirectToSignUp, m as RedirectToUserProfile, k as SignedIn, j as SignedOut, q as useAuth } from './useAuth-Bu7xegV8.js';
 export { useClerk, useOrganization, useOrganizationList, useReverification, useSession, useSessionList, useUser } from '@clerk/shared/react';
 
+type FallbackProp = {
+    /**
+     * An optional element to render while the component is mounting.
+     */
+    fallback?: ReactNode;
+};
 type UserProfileExportType = typeof _UserProfile & {
@@ -20,4 +26,3 @@ Page: typeof UserProfilePage;
      * The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
-     * of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages
-     * that could be mounted
+     * of the `<UserButton />` without affecting its configuration or any custom pages that could be mounted
      * @experimental This API is experimental and may change at any moment.
@@ -45,4 +50,3 @@ */
      * The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
-     * of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages
-     * that could be mounted
+     * of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages that could be mounted
      * @experimental This API is experimental and may change at any moment.
@@ -62,7 +66,7 @@ */
 declare const SignIn: {
-    (props: Without<WithClerkProp<SignInProps>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<SignInProps & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
 };
 declare const SignUp: {
-    (props: Without<WithClerkProp<SignUpProps>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<SignUpProps & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
@@ -73,3 +77,3 @@ };
 declare const _UserProfile: {
-    (props: Without<WithClerkProp<PropsWithChildren<Without<UserProfileProps, "customPages">>>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<PropsWithChildren<Without<UserProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
@@ -79,3 +83,3 @@ };
 declare const _UserButton: {
-    (props: Without<WithClerkProp<PropsWithChildren<UserButtonPropsWithoutCustomPages>>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<PropsWithChildren<UserButtonPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
@@ -91,3 +95,3 @@ };
 declare const _OrganizationProfile: {
-    (props: Without<WithClerkProp<PropsWithChildren<Without<OrganizationProfileProps, "customPages">>>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<PropsWithChildren<Without<OrganizationProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
@@ -97,7 +101,7 @@ };
 declare const CreateOrganization: {
-    (props: Without<WithClerkProp<CreateOrganizationProps>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<CreateOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
 };
 declare const _OrganizationSwitcher: {
-    (props: Without<WithClerkProp<PropsWithChildren<OrganizationSwitcherPropsWithoutCustomPages>>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<PropsWithChildren<OrganizationSwitcherPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
@@ -108,11 +112,16 @@ };
 declare const OrganizationList: {
-    (props: Without<WithClerkProp<OrganizationListProps>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<OrganizationListProps & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
 };
 declare const GoogleOneTap: {
-    (props: Without<WithClerkProp<GoogleOneTapProps>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<_clerk_types.SignInForceRedirectUrl & _clerk_types.SignUpForceRedirectUrl & {
+        cancelOnTapOutside?: boolean;
+        itpSupport?: boolean;
+        fedCmSupport?: boolean;
+        appearance?: _clerk_types.SignInTheme;
+    } & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
 };
 declare const Waitlist: {
-    (props: Without<WithClerkProp<WaitlistProps>, "clerk">): React.JSX.Element | null;
+    (props: Without<WithClerkProp<WaitlistProps & FallbackProp>, "clerk">): React.JSX.Element | null;
     displayName: string;
@@ -119,0 +128,0 @@ };

dist/internal.d.ts

 import { ErrorThrowerOptions } from '@clerk/shared/error';
-export { M as MultisessionAppSupport, u as useDerivedAuth } from './useAuth-Dfw9QOW7.js';
+export { M as MultisessionAppSupport, u as useDerivedAuth } from './useAuth-Bu7xegV8.js';
 import { RoutingOptions } from '@clerk/types';
@@ -4,0 +4,0 @@ export { buildClerkJsScriptAttributes, clerkJsScriptUrl, setClerkJsLoadingErrorPackageName } from '@clerk/shared/loadClerkJsScript';

dist/internal.js

@@ -191,9 +191,11 @@ "use strict";
 var import_react10 = __toESM(require("react"));
-var withClerk = (Component, displayName) => {
-  displayName = displayName || Component.displayName || Component.name || "Component";
+var withClerk = (Component, displayNameOrOptions) => {
+  const passedDisplayedName = typeof displayNameOrOptions === "string" ? displayNameOrOptions : displayNameOrOptions == null ? void 0 : displayNameOrOptions.component;
+  const displayName = passedDisplayedName || Component.displayName || Component.name || "Component";
   Component.displayName = displayName;
+  const options = typeof displayNameOrOptions === "string" ? void 0 : displayNameOrOptions;
   const HOC = (props) => {
     useAssertWrappedByClerkProvider(displayName || "withClerk");
     const clerk = useIsomorphicClerkContext();
-    if (!clerk.loaded) {
+    if (!clerk.loaded && !(options == null ? void 0 : options.renderWhileLoading)) {
       return null;
@@ -205,2 +207,3 @@ }
         ...props,
+        component: displayName,
         clerk
@@ -207,0 +210,0 @@ }

package.json

 {
   "name": "@clerk/clerk-react",
-  "version": "5.20.4",
+  "version": "5.21.0-snapshot.v20241218205220",
   "description": "Clerk React library",
@@ -66,4 +66,4 @@ "keywords": [
     "tslib": "2.4.1",
-    "@clerk/shared": "^2.20.4",
-    "@clerk/types": "^4.40.0"
+    "@clerk/shared": "^2.20.2",
+    "@clerk/types": "^4.39.4"
   },
@@ -75,4 +75,4 @@ "devDependencies": {
     "@clerk/eslint-config-custom": "0.0.2",
-    "@clerk/localizations": "3.9.4",
-    "@clerk/themes": "2.2.3"
+    "@clerk/localizations": "3.9.3",
+    "@clerk/themes": "2.2.2"
   },
@@ -79,0 +79,0 @@ "peerDependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

624149

increased by7.81%

Lines of code

5952

increased by6.65%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• Updated@clerk/shared@^2.20.2

• Updated@clerk/types@^4.39.4