@asgardeo/react 0.2.3 → 0.3.0

package/dist/index.d.ts

@@ -1,9 +1,5 @@
-import { ReactElement, FC, PropsWithChildren } from 'react';
-import { BrandingProps, UIAuthConfig, Store, AuthApiResponse, MeAPIResponse } from '@asgardeo/js';
-export { UIAuthConfig } from '@asgardeo/js';
-
 /**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
  *
  * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -19,346 +15,38 @@ export { UIAuthConfig } from '@asgardeo/js';
  * specific language governing permissions and limitations
  * under the License.
  */
-
-interface SignInProps {
-    basicAuthChildren?: ReactElement;
-    brandingProps?: BrandingProps;
-    emailOtpChildren?: ReactElement;
-    identifierFirstChildren?: ReactElement;
-    showFooter?: boolean;
-    showLogo?: boolean;
-    showSignUp?: boolean;
-    smsOtpChildren?: ReactElement;
-    totpChildren?: ReactElement;
-}
-interface SignInButtonProps extends SignInProps {
-    customComponent?: ReactElement;
-}
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * This component provides the sign-in functionality.
- *
- * @param {SignInProps} props - Props injected to the component.
- * @param {BrandingProps} props.brandingProps - Branding related props.
- * @param {boolean} props.showSignUp - Show sign-up.
- *
- * @returns {ReactElement} - React element.
- */
-declare const SignIn: FC<SignInProps>;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-interface SignedProps {
-    fallback?: ReactElement;
-}
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * This component renders its children if the user is signed out.
- *
- * @param {PropsWithChildren<SignedProps>} props - Props injected to the component.
- * @param {ReactElement} props.fallback - Fallback element to render.
- *
- * @return {JSX.Element}
- */
-declare const SignedIn: FC<PropsWithChildren<SignedProps>>;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * This component renders its children if the user is signed out.
- *
- * @param {PropsWithChildren<SignedProps>} props - Props injected to the component.
- * @param {ReactElement} props.fallback - Fallback element to render.
- *
- * @return {JSX.Element}
- */
-declare const SignedOut: FC<PropsWithChildren<SignedProps>>;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * SignInButton component. This button will render a modal with the SignIn component when clicked.
- *
- * @param {Object} props - Component props.
- * @param {ReactElement} props.customComponent - Optional custom component to be rendered.
- * @returns {ReactElement} Rendered SignInButton component.
- */
-declare const SignInButton: (props: SignInButtonProps) => ReactElement;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * SignOutButton component.
- *
- * This component renders a sign out button. When clicked, it triggers the sign out process.
- *
- * @returns {ReactElement} Rendered SignOutButton component.
- */
-declare const SignOutButton: () => ReactElement;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-declare enum Hooks {
-    SignIn = 0,
-    SignOut = 1
-}
-interface UseOnProps {
-    /**
-     * The callback to be executed when the event is triggered.
-     */
-    callback: (response?: any) => void | Promise<void>;
-    /**
-     * The event to listen to.
-     */
-    event: Hooks;
-}
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-interface AsgardeoProviderProps {
-    branding?: BrandingProps;
-    config: UIAuthConfig;
-    store?: Store;
-}
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * `AsgardeoProvider` is a component that provides an Asgardeo context to all its children.
- * It takes an object of type `AsgardeProviderProps` as props, which includes the children to render,
- * a configuration object, a store instance, and a branding object.
- *
- * @param {PropsWithChildren<AsgardeoProviderProps>} props - The properties passed to the component.
- * @param {ReactNode} props.children - The children to render inside the provider.
- * @param {Config} props.config - The configuration object for the Asgardeo context.
- * @param {Store} [props.store] - An optional store instance. If not provided, a new SessionStore will be created.
- * @param {Branding} props.branding - The branding object for the Asgardeo context.
- *
- * @returns {ReactElement} A React element that provides the Asgardeo context to all its children.
- */
-declare const AsgardeoProvider: FC<PropsWithChildren<AsgardeoProviderProps>>;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-interface UseAuthentication {
-    accessToken: string;
-    authResponse: AuthApiResponse;
-    isAuthenticated: Promise<boolean> | boolean;
-    isGlobalLoading: boolean;
-    setUsername: (username: string) => void;
-    signOut: () => void;
-    user: MeAPIResponse;
-    username: string;
-}
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/**
- * `useAuthentication` is a custom hook that provides access to the authentication context.
- * It returns an object containing the current user, the authentication status, the access token, and a sign out function.
- *
- * @returns {UseAuthentication} An object containing the current user (`user`), the authentication status (`isAuthenticated`),
- * the access token (`accessToken`), and a sign out function (`signOut`).
- */
-declare const useAuthentication: () => UseAuthentication;
-
-/**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
- *
- * WSO2 LLC. licenses this file to you 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
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-declare const useOn: (props: UseOnProps) => void;
-
-export { AsgardeoProvider, Hooks, SignIn, SignInButton, SignOutButton, SignedIn, SignedOut, useAuthentication, useOn };
+export { default as AsgardeoProvider } from './providers/AsgardeoProvider';
+export * from './providers/AsgardeoProvider';
+export { default as AsgardeoContext } from './contexts/AsgardeoContext';
+export * from './contexts/AsgardeoContext';
+export { default as useAsgardeo } from './hooks/useAsgardeo';
+export * from './hooks/useAsgardeo';
+export { default as useBrowserUrl } from './hooks/useBrowserUrl';
+export * from './hooks/useBrowserUrl';
+export { default as BaseSignInButton } from './components/actions/SignInButton/BaseSignInButton';
+export * from './components/actions/SignInButton/BaseSignInButton';
+export { default as SignInButton } from './components/actions/SignInButton/SignInButton';
+export * from './components/actions/SignInButton/SignInButton';
+export { default as BaseSignOutButton } from './components/actions/SignOutButton/BaseSignOutButton';
+export * from './components/actions/SignOutButton/BaseSignOutButton';
+export { default as SignOutButton } from './components/actions/SignOutButton/SignOutButton';
+export * from './components/actions/SignOutButton/SignOutButton';
+export { default as BaseSignUpButton } from './components/actions/SignUpButton/BaseSignUpButton';
+export * from './components/actions/SignUpButton/BaseSignUpButton';
+export { default as SignUpButton } from './components/actions/SignUpButton/SignUpButton';
+export * from './components/actions/SignUpButton/SignUpButton';
+export { default as SignedIn } from './components/control/SignedIn';
+export * from './components/control/SignedIn';
+export { default as SignedOut } from './components/control/SignedOut';
+export * from './components/control/SignedOut';
+export { default as User } from './components/presentation/User';
+export * from './components/presentation/User';
+export { default as BaseUserProfile } from './components/presentation/UserProfile/BaseUserProfile';
+export * from './components/presentation/UserProfile/BaseUserProfile';
+export { default as UserProfile } from './components/presentation/UserProfile/UserProfile';
+export * from './components/presentation/UserProfile/UserProfile';
+export { default as BaseUserDropdown } from './components/presentation/UserDropdown/BaseUserDropdown';
+export * from './components/presentation/UserDropdown/BaseUserDropdown';
+export { default as UserDropdown } from './components/presentation/UserDropdown/UserDropdown';
+export * from './components/presentation/UserDropdown/UserDropdown';
+export * from '@asgardeo/browser';