@veliseev93/clerk-react-native 0.0.1-dev.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ronas IT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,133 @@
+# @veliseev93/clerk-react-native
+
+> Temporary npm scope for pre-release testing. Production package: `@ronas-it/clerk-react-native`.
+
+Hooks and helpers for user authentication with [Clerk Expo SDK](https://clerk.com/docs/references/expo/overview).
+
+## Install
+
+```sh
+npm install @veliseev93/clerk-react-native @clerk/clerk-expo @clerk/types expo-web-browser expo-auth-session
+```
+
+`react`, `react-native`, and your Clerk/Expo versions should match what `@clerk/clerk-expo` expects for your Expo SDK.
+
+## API
+
+### `useClerkResources`
+
+Hook, that provides access to essential Clerk methods and objects.
+
+Returned object:
+
+- `signUp` — [SignUp](https://clerk.com/docs/references/javascript/sign-up)
+- `signIn` — [SignIn](https://clerk.com/docs/references/javascript/sign-in)
+- `setActive` — sets the active session
+- `signOut` — signs out the current user
+
+### `useAuthWithIdentifier`
+
+Hook, that provides functionality to handle user sign-up and sign-in processes using an identifier such as an email, phone number, or username. It supports both OTP (One Time Password) and password-based authentication methods.
+
+Parameters:
+
+- `method`: type of identifier (`'emailAddress'`, `'phoneNumber'`, `'username'`)
+- `verifyBy`: `'otp'` or `'password'`
+
+Returned object:
+
+- `startSignUp`, `startSignIn`, `startAuthorization`, `isLoading`
+- For email/phone + OTP: `verifyCode`, `isVerifying` (`verifyCode` requires `code`, `isSignUp`, optional `tokenTemplate`)
+
+**Example:**
+
+```ts
+import React, { useState } from 'react';
+import { View, TextInput, Button } from 'react-native';
+import { useAuthWithIdentifier } from '@veliseev93/clerk-react-native';
+
+export const AuthWithIdentifierComponent = () => {
+  const [identifier, setIdentifier] = useState('');
+  const [verificationCode, setVerificationCode] = useState('');
+  const { startSignUp, verifyCode, isLoading, isVerifying } = useAuthWithIdentifier('emailAddress', 'otp');
+
+  const handleSignUp = async () => {
+    await startSignUp({ identifier });
+  };
+
+  const handleVerifyCode = async () => {
+    const result = await verifyCode({ code: verificationCode, isSignUp: true });
+    console.log(result.sessionToken);
+  };
+
+  return (
+    <View>
+      <TextInput
+        placeholder="Enter your email"
+        value={identifier}
+        onChangeText={setIdentifier}
+        keyboardType="email-address"
+      />
+      <TextInput
+        placeholder="Enter verification code"
+        value={verificationCode}
+        onChangeText={setVerificationCode}
+      />
+      <Button onPress={handleSignUp} title="Sign Up" disabled={isLoading || isVerifying} />
+      <Button onPress={handleVerifyCode} title="Verify code" disabled={isLoading || isVerifying} />
+    </View>
+  );
+};
+```
+
+### `useAuthWithSSO`
+
+Hook for [SSO](https://clerk.com/docs/references/expo/use-sso) flows.
+
+- `startSSOFlow` — `strategy`, `redirectUrl`, optional `tokenTemplate`
+- `isLoading`
+
+### `useAuthWithTicket`
+
+Ticket-based auth (token from Backend API).
+
+- `startAuthorization` — `ticket`, optional `tokenTemplate`
+- `isLoading`
+
+### `useGetSessionToken`
+
+- `getSessionToken` — optional [token template](https://clerk.com/docs/backend-requests/jwt-templates)
+
+### `useAddIdentifier`
+
+Add email or phone identifiers and verify with codes.
+
+- `createIdentifier`, `verifyCode`, `isCreating`, `isVerifying`
+
+### `useUpdateIdentifier`
+
+Update primary email or phone: add and verify new identifier, then set primary and remove old.
+
+- `createIdentifier`, `verifyCode`, `isCreating`, `isVerifying`, `isUpdating`
+
+### `useOtpVerification`
+
+Lower-level OTP send/verify for sign-in and sign-up.
+
+- `sendOtpCode`, `verifyCode`, `isVerifying`
+
+### `useResetPassword`
+
+Password reset via email or phone OTP.
+
+- `startResetPassword`, `verifyCode`, `resetPassword`, `isCodeSending`, `isResetting`, `isVerifying`
+
+### `useChangePassword`
+
+Update the signed-in user's password (`currentPassword`, `newPassword`).
+
+- `updatePassword`, `isPasswordUpdating`
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).