Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use React.JSX instead of the global JSX namespace #1427

Merged
merged 1 commit into from
Dec 10, 2024
Merged

use React.JSX instead of the global JSX namespace #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/react-oidc-context.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export interface AuthContextProps extends AuthState {
}

// @public
export const AuthProvider: (props: AuthProviderProps) => JSX.Element;
export const AuthProvider: (props: AuthProviderProps) => React_2.JSX.Element;

// @public (undocumented)
export interface AuthProviderBaseProps {
Expand Down Expand Up @@ -107,7 +107,7 @@ export const withAuthenticationRequired: <P extends object>(Component: React_2.C
// @public (undocumented)
export interface WithAuthenticationRequiredProps {
onBeforeSignin?: () => Promise<void> | void;
OnRedirecting?: () => JSX.Element;
OnRedirecting?: () => React_2.JSX.Element;
signinRedirectArgs?: SigninRedirectArgs;
}

Expand Down
2 changes: 1 addition & 1 deletion src/AuthProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ const UserManagerImpl =
*
* @public
*/
export const AuthProvider = (props: AuthProviderProps): JSX.Element => {
export const AuthProvider = (props: AuthProviderProps): React.JSX.Element => {
const {
children,

Expand Down
4 changes: 2 additions & 2 deletions src/withAuthenticationRequired.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface WithAuthenticationRequiredProps {
/**
* Show a message when redirected to the signin page.
*/
OnRedirecting?: () => JSX.Element;
OnRedirecting?: () => React.JSX.Element;

/**
* Allows executing logic before the user is redirected to the signin page.
Expand All @@ -35,7 +35,7 @@ export const withAuthenticationRequired = <P extends object>(
Component: React.ComponentType<P>,
options: WithAuthenticationRequiredProps = {},
): React.FC<P> => {
const { OnRedirecting = (): JSX.Element => <></>, onBeforeSignin, signinRedirectArgs } = options;
const { OnRedirecting = (): React.JSX.Element => <></>, onBeforeSignin, signinRedirectArgs } = options;
const displayName = `withAuthenticationRequired(${Component.displayName || Component.name})`;
const C: React.FC<P> = (props) => {
const auth = useAuth();
Expand Down
2 changes: 1 addition & 1 deletion test/helpers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import React from "react";
import { AuthProvider, type AuthProviderProps } from "../src/AuthProvider";

export const createWrapper = (opts: AuthProviderProps, strictMode = true) => {
const AllProviders = ({ children }: React.PropsWithChildren): JSX.Element => {
const AllProviders = ({ children }: React.PropsWithChildren): React.JSX.Element => {
const provider = <AuthProvider {...opts}>{children}</AuthProvider>;
if (!strictMode) {
return provider;
Expand Down
4 changes: 2 additions & 2 deletions test/withAuth.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ describe("withAuth", () => {
it("should wrap a class component, adding AuthContextProps to the component's `auth` prop", async () => {
// arrange
class MyComponent extends Component {
render(): JSX.Element {
render(): React.JSX.Element {
for (const [k, v] of Object.entries(this.props)) {
if (k === "auth") {
return <>{k}: {Object.keys(v as Map<string, unknown>)}</>;
Expand All @@ -34,7 +34,7 @@ describe("withAuth", () => {
it("should pass through wrapped component props", async () => {
// arrange
class MyPropsComponent extends Component<{ originalProp: string }> {
render(): JSX.Element {
render(): React.JSX.Element {
return <>originalPropValue: {this.props.originalProp}</>;
}
}
Expand Down
16 changes: 8 additions & 8 deletions test/withAuthenticationRequired.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ describe("withAuthenticationRequired", () => {
authContext.signinRedirect = signinRedirectMock;
useAuthMock.mockReturnValue(authContext);

const MyComponent = (): JSX.Element => <>Private</>;
const MyComponent = (): React.JSX.Element => <>Private</>;
const WrappedComponent = withAuthenticationRequired(MyComponent);

// act
Expand All @@ -40,7 +40,7 @@ describe("withAuthenticationRequired", () => {
authContext.signinRedirect = signinRedirectMock;
useAuthMock.mockReturnValue(authContext);

const MyComponent = (): JSX.Element => <>Private</>;
const MyComponent = (): React.JSX.Element => <>Private</>;
const WrappedComponent = withAuthenticationRequired(MyComponent);

// act
Expand All @@ -67,8 +67,8 @@ describe("withAuthenticationRequired", () => {
authContext.signinRedirect = signinRedirectMock;
useAuthMock.mockReturnValue(authContext);

const MyComponent = (): JSX.Element => <>Private</>;
const OnRedirecting = (): JSX.Element => <>Redirecting</>;
const MyComponent = (): React.JSX.Element => <>Private</>;
const OnRedirecting = (): React.JSX.Element => <>Redirecting</>;
const WrappedComponent = withAuthenticationRequired(MyComponent, {
OnRedirecting,
});
Expand All @@ -94,7 +94,7 @@ describe("withAuthenticationRequired", () => {
authContext.signinRedirect = signinRedirectMock;
useAuthMock.mockReturnValue(authContext);

const MyComponent = (): JSX.Element => <>Private</>;
const MyComponent = (): React.JSX.Element => <>Private</>;
const onBeforeSigninMock = jest.fn();
const WrappedComponent = withAuthenticationRequired(MyComponent, {
onBeforeSignin: onBeforeSigninMock,
Expand Down Expand Up @@ -124,7 +124,7 @@ describe("withAuthenticationRequired", () => {
authContext.signinRedirect = signinRedirectMock;
useAuthMock.mockReturnValue(authContext);

const MyComponent = (): JSX.Element => <>Private</>;
const MyComponent = (): React.JSX.Element => <>Private</>;
const WrappedComponent = withAuthenticationRequired(MyComponent, {
signinRedirectArgs: {
redirect_uri: "foo",
Expand Down Expand Up @@ -156,9 +156,9 @@ describe("withAuthenticationRequired", () => {
authContext.signinRedirect = signinRedirectMock;
useAuthMock.mockReturnValue(authContext);

const MyComponent = (): JSX.Element => <>Private</>;
const MyComponent = (): React.JSX.Element => <>Private</>;
const WrappedComponent = withAuthenticationRequired(MyComponent);
const App = ({ foo }: { foo: number }): JSX.Element => (
const App = ({ foo }: { foo: number }): React.JSX.Element => (
<div>
{foo}
<AuthProvider {...settingsStub}>
Expand Down
Loading