@asgardeo/react 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,355 @@
+import { ReactElement, FC, PropsWithChildren } from 'react';
+import { BrandingProps, UIAuthConfig, Store, MeAPIResponse } from '@asgardeo/js';
+export { UIAuthConfig } from '@asgardeo/js';
+
+/**
+ * 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 SignInProps {
+    brandingProps?: BrandingProps;
+    showFooter?: boolean;
+    showLogo?: boolean;
+    showSignUp?: boolean;
+}
+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;
+    isAuthenticated: Promise<boolean> | boolean;
+    signOut: () => void;
+    user: MeAPIResponse;
+}
+
+/**
+ * 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asgardeo/react",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React Wrapper to build customizable login UIs for Asgardeo or Identity Server",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -9,7 +9,9 @@
   "author": "WSO2",
   "license": "Apache-2.0",
   "files": [
-    "dist"
+    "dist",
+    "LICENSE",
+    "README.md"
   ],
   "homepage": "https://github.com/asgardeo/web-ui-sdks/tree/main/packages/react#readme",
   "bugs": {
@@ -17,7 +19,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/asgardeo/web-ui-sdks/",
+    "url": "https://github.com/asgardeo/web-ui-sdks",
     "directory": "packages/react"
   },
   "keywords": [
@@ -47,6 +49,7 @@
     "prettier": "^3.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
+    "rollup": "^4.17.2",
     "rollup-plugin-dts": "^6.1.0",
     "rollup-plugin-polyfill-node": "^0.13.0",
     "rollup-plugin-styles": "^4.0.0",
@@ -63,12 +66,13 @@
     "clsx": "^2.1.1",
     "fast-sha256": "^1.3.0",
     "jose": "^5.3.0",
-    "randombytes": "^2.1.0",
-    "rollup": "^4.17.2"
+    "randombytes": "^2.1.0"
   },
   "peerDependencies": {
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0"
   },
-  "scripts": {}
+  "scripts": {
+    "build": "rollup -c"
+  }
 }