react-native-linkedin-oauth2 1.0.1 → 1.1.1

package/dist/index.d.ts

@@ -1,2 +1,200 @@
-export declare const loginLinkedIn: () => void;
+/**
+ * @file index.tsx
+ * @author NikhilRW
+ * @description A React Native component that implements LinkedIn OAuth2 authentication
+ * using a WebView. It handles the authorization code flow, token exchange, and user profile retrieval.
+ *
+ * @requires react-native-webview
+ * @requires react-native
+ * @requires react
+ */
+import React from 'react';
+import { type ModalProps, type ViewStyle, type StyleProp } from 'react-native';
+/**
+ * Represents the user profile data returned from LinkedIn's /userinfo endpoint.
+ * This follows the OpenID Connect standard claims.
+ *
+ * @interface LinkedInProfile
+ */
+export interface LinkedInProfile {
+    /**
+     * The unique identifier for the user (Subject).
+     * This is a stable identifier for the user.
+     */
+    sub: string;
+    /**
+     * Whether the user's email address has been verified by LinkedIn.
+     */
+    email_verified?: boolean;
+    /**
+     * The full name of the user.
+     */
+    name: string;
+    /**
+     * The user's locale information.
+     */
+    locale: {
+        /** The country code (e.g., US). */
+        country: string;
+        /** The language code (e.g., en). */
+        language: string;
+    };
+    /**
+     * The user's given name (first name).
+     */
+    given_name: string;
+    /**
+     * The user's family name (last name).
+     */
+    family_name: string;
+    /**
+     * The user's email address.
+     * Only present if the 'email' scope was requested and granted.
+     */
+    email?: string;
+    /**
+     * URL to the user's profile picture.
+     */
+    picture: string;
+    /**
+     * Allow for additional properties that might be returned by the API.
+     */
+    [key: string]: any;
+}
+/**
+ * Represents the response from the LinkedIn Access Token endpoint.
+ *
+ * @interface LinkedInTokenResponse
+ */
+export interface LinkedInTokenResponse {
+    /**
+     * The access token used to authorize API requests.
+     */
+    access_token: string;
+    /**
+     * The duration in seconds until the access token expires.
+     */
+    expires_in: number;
+    /**
+     * The scope of access granted by the token.
+     */
+    scope: string;
+    /**
+     * The type of token (usually "Bearer").
+     */
+    token_type: string;
+    /**
+     * The ID token (if OpenID Connect scopes were requested).
+     */
+    id_token?: string;
+}
+/**
+ * Props for the LinkedInModal component.
+ *
+ * @interface LinkedInModalProps
+ */
+export interface LinkedInModalProps {
+    /**
+     * Controls the visibility of the modal.
+     */
+    isVisible: boolean;
+    /**
+     * The Client ID obtained from the LinkedIn Developer Portal.
+     * Required for authentication.
+     */
+    clientId?: string;
+    /**
+     * The Client Secret obtained from the LinkedIn Developer Portal.
+     * Required for exchanging the authorization code for an access token.
+     * @warning Do not expose this in client-side code if possible; consider using a backend proxy for high security.
+     */
+    clientSecret?: string;
+    /**
+     * A space-separated list of permissions to request.
+     * Common scopes: 'openid', 'email', 'profile', 'w_member_social'.
+     * @default 'openid email profile'
+     */
+    scope?: string;
+    /**
+     * The Redirect URI registered in the LinkedIn Developer Portal.
+     * This must match exactly what is configured in the portal.
+     */
+    redirectUri?: string;
+    /**
+     * Callback function triggered when login is successful.
+     * @param {LinkedInProfile} user - The profile data of the authenticated user.
+     */
+    onSuccess?: (user: LinkedInProfile) => void;
+    /**
+     * Callback function triggered when an error occurs during authentication.
+     * @param {Error} error - The error object containing details about the failure.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback function triggered when the modal is closed (e.g., by the user or after success).
+     */
+    onClose?: () => void;
+    /**
+     * If true, the component will attempt to log the user out of LinkedIn.
+     * @default false
+     */
+    logout?: boolean;
+    /**
+     * Callback function triggered when the logout process is complete.
+     */
+    onLogout?: () => void;
+    /**
+     * Custom function to render the header of the modal.
+     * @param {Object} props - Props passed to the header renderer.
+     * @param {function} props.onClose - Function to close the modal.
+     * @returns {React.ReactNode} The custom header component.
+     */
+    renderHeader?: (props: {
+        onClose: () => void;
+    }) => React.ReactNode;
+    /**
+     * Custom function to render the loading indicator.
+     * @returns {React.ReactNode} The custom loading component.
+     */
+    renderLoading?: () => React.ReactNode;
+    /**
+     * Style object for the SafeAreaView container.
+     */
+    containerStyle?: StyleProp<ViewStyle>;
+    /**
+     * Style object for the inner wrapper View.
+     */
+    wrapperStyle?: StyleProp<ViewStyle>;
+    /**
+     * Whether to automatically close the modal after a successful login.
+     * @default true
+     */
+    closeOnSuccess?: boolean;
+    /**
+     * Additional props to pass to the underlying React Native Modal component.
+     * @see https://reactnative.dev/docs/modal
+     */
+    modalProps?: Partial<Omit<ModalProps, 'visible'>>;
+}
+/**
+ * LinkedInModal Component.
+ *
+ * A modal component that loads a WebView to handle LinkedIn OAuth2 authentication.
+ *
+ * @component
+ * @example
+ * ```tsx
+ * <LinkedInModal
+ *   isVisible={showLinkedInModal}
+ *   clientId="YOUR_CLIENT_ID"
+ *   clientSecret="YOUR_CLIENT_SECRET"
+ *   redirectUri="YOUR_REDIRECT_URI"
+ *   onSuccess={(user) => console.log(user)}
+ *   onError={(error) => console.error(error)}
+ *   onClose={() => setShowLinkedInModal(false)}
+ * />
+ * ```
+ */
+export declare const LinkedInModal: React.FC<LinkedInModalProps>;
+export default LinkedInModal;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,YAEzB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAMN,MAAM,OAAO,CAAC;AAEf,OAAO,EAOL,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,SAAS,EAEf,MAAM,cAAc,CAAC;AAOtB;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE;QACN,mCAAmC;QACnC,OAAO,EAAE,MAAM,CAAC;QAChB,oCAAoC;QACpC,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;IAE5C;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IAEtB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,IAAI,CAAA;KAAE,KAAK,KAAK,CAAC,SAAS,CAAC;IAEnE;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,KAAK,CAAC,SAAS,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAEpC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;CACnD;AA8LD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAiJtD,CAAC;AAkDF,eAAe,aAAa,CAAC"}