binoauth 0.0.1 → 0.0.2

package/README.md

@@ -15,45 +15,48 @@ bun add binoauth
 ## Quick Start
 
 ```typescript
-import BinoAuth from 'binoauth';
+import BinoAuth from "binoauth";
 
 const auth = new BinoAuth({
-  apiKey: 'ak_live_your_api_key',
-  tenant: 'your-tenant-id'
+  apiKey: "ak_live_your_api_key",
+  tenant: "your-tenant-id",
 });
 
 // Email OTP
-const resp = await auth.sendEmailOTP('user@example.com');
+const resp = await auth.sendEmailOTP("user@example.com");
 if (resp.ok) {
-  console.log('OTP sent successfully');
+  console.log("OTP sent successfully");
 }
 
 // Login with password
-const loginResp = await auth.login('password', {
-  email: 'user@example.com',
-  password: 'password123'
+const loginResp = await auth.login("password", {
+  email: "user@example.com",
+  password: "password123",
 });
 
 if (loginResp.ok) {
-  console.log('Login successful:', loginResp.data);
+  console.log("Login successful:", loginResp.data);
 }
 ```
 
 ## Features
 
 ### Authentication Methods
+
 - **Email OTP**: Send and verify email-based one-time passwords
-- **Phone OTP**: Send and verify SMS-based one-time passwords  
+- **Phone OTP**: Send and verify SMS-based one-time passwords
 - **Password Login**: Traditional email/password authentication
 - **Magic Links**: Passwordless email-based authentication
 - **Device Code Flow**: For CLI applications and IoT devices
 
 ### Token Management
+
 - **OAuth2 Compatible**: All tokens work with existing OAuth2 resource servers
 - **Refresh Tokens**: Automatic token refresh capabilities
 - **Session Management**: Secure logout and session invalidation
 
 ### User Management
+
 - **Profile Access**: Get and update user profiles
 - **User Administration**: Create, read, update, delete users (admin API)
 
@@ -72,89 +75,99 @@ const auth = new BinoAuth({
 ### Authentication Methods
 
 #### `sendEmailOTP(email: string)`
+
 Send an OTP code to the user's email address.
 
 ```typescript
-const result = await auth.sendEmailOTP('user@example.com');
+const result = await auth.sendEmailOTP("user@example.com");
 ```
 
 #### `sendPhoneOTP(phone: string)`
+
 Send an OTP code to the user's phone number.
 
 ```typescript
-const result = await auth.sendPhoneOTP('+1234567890');
+const result = await auth.sendPhoneOTP("+1234567890");
 ```
 
 #### `sendMagicLink(email: string)`
+
 Send a magic link to the user's email address.
 
 ```typescript
-const result = await auth.sendMagicLink('user@example.com');
+const result = await auth.sendMagicLink("user@example.com");
 ```
 
 #### `login(type: 'password' | 'otp', credentials: LoginCredentials)`
+
 Authenticate a user with different methods.
 
 ```typescript
 // Password login
-const result = await auth.login('password', {
-  email: 'user@example.com',
-  password: 'password123'
+const result = await auth.login("password", {
+  email: "user@example.com",
+  password: "password123",
 });
 
 // OTP login
-const result = await auth.login('otp', {
-  otp: '123456',
-  phone: '+1234567890' // Optional: specify if phone OTP
+const result = await auth.login("otp", {
+  otp: "123456",
+  phone: "+1234567890", // Optional: specify if phone OTP
 });
 ```
 
 ### Password Reset
 
 #### `sendResetPasswordEmailOTP(email: string)`
+
 Send a password reset OTP to email.
 
 ```typescript
-const result = await auth.sendResetPasswordEmailOTP('user@example.com');
+const result = await auth.sendResetPasswordEmailOTP("user@example.com");
 ```
 
 #### `sendResetPasswordPhoneOTP(phone: string)`
+
 Send a password reset OTP to phone.
 
 ```typescript
-const result = await auth.sendResetPasswordPhoneOTP('+1234567890');
+const result = await auth.sendResetPasswordPhoneOTP("+1234567890");
 ```
 
 #### `resetPassword(params: ResetPasswordParams)`
+
 Reset user password with OTP verification.
 
 ```typescript
 const result = await auth.resetPassword({
-  otp: '123456',
-  newPassword: 'newpassword123',
-  repeatNewPassword: 'newpassword123'
+  otp: "123456",
+  newPassword: "newpassword123",
+  repeatNewPassword: "newpassword123",
 });
 ```
 
 ### Token Management
 
 #### `refreshToken(refreshToken: string)`
+
 Refresh an access token using a refresh token.
 
 ```typescript
-const result = await auth.refreshToken('refresh_token_here');
+const result = await auth.refreshToken("refresh_token_here");
 ```
 
 #### `logout(accessToken?: string)`
+
 Logout and invalidate session.
 
 ```typescript
-const result = await auth.logout('access_token_here');
+const result = await auth.logout("access_token_here");
 ```
 
 ### User Profile
 
 #### `getProfile()`
+
 Get the current user's profile information.
 
 ```typescript
@@ -164,6 +177,7 @@ const result = await auth.getProfile();
 ### Device Code Flow
 
 #### `requestDeviceCode()`
+
 Request a device code for CLI/IoT authentication.
 
 ```typescript
@@ -173,22 +187,25 @@ console.log(`Code: ${result.data.user_code}`);
 ```
 
 #### `pollDeviceToken(deviceCode: string)`
+
 Poll for device authorization completion.
 
 ```typescript
-const result = await auth.pollDeviceToken('device_code_here');
+const result = await auth.pollDeviceToken("device_code_here");
 ```
 
 ### User Management (Admin API)
 
 #### `getUser(userId: string)`
+
 Get user information by ID.
 
 ```typescript
-const result = await auth.getUser('user_id_here');
+const result = await auth.getUser("user_id_here");
 ```
 
 #### `getUsers(params?: { page?: number; limit?: number })`
+
 Get paginated list of users.
 
 ```typescript
@@ -196,12 +213,15 @@ const result = await auth.getUsers({ page: 1, limit: 10 });
 ```
 
 #### `createUser(userData: any)`
+
 Create a new user (not implemented in current admin SDK).
 
 #### `updateUser(userId: string, userData: any)`
+
 Update user information (not implemented in current admin SDK).
 
 #### `deleteUser(userId: string)`
+
 Delete a user (not implemented in current admin SDK).
 
 ## Response Format
@@ -210,32 +230,33 @@ All methods return a `BinoAuthResponse` object:
 
 ```typescript
 interface BinoAuthResponse<T = any> {
-  ok: boolean;                    // Success indicator
-  data?: T;                       // Response data (if successful)
-  error?: string;                 // Error message (if failed)
-  error_description?: string;     // Detailed error description (if failed)
+  ok: boolean; // Success indicator
+  data?: T; // Response data (if successful)
+  error?: string; // Error message (if failed)
+  error_description?: string; // Detailed error description (if failed)
 }
 ```
 
 ## Error Handling
 
 ```typescript
-const result = await auth.login('password', {
-  email: 'user@example.com',
-  password: 'wrong_password'
+const result = await auth.login("password", {
+  email: "user@example.com",
+  password: "wrong_password",
 });
 
 if (!result.ok) {
-  console.error('Login failed:', result.error);
-  console.error('Details:', result.error_description);
+  console.error("Login failed:", result.error);
+  console.error("Details:", result.error_description);
 } else {
-  console.log('Login successful:', result.data);
+  console.log("Login successful:", result.data);
 }
 ```
 
 ## OAuth2 Compatibility
 
 All tokens generated by this SDK are OAuth2-compatible JWT tokens that can be used with:
+
 - Resource servers expecting OAuth2 Bearer tokens
 - Existing OAuth2 middleware and libraries
 - Standard Authorization headers: `Authorization: Bearer <token>`
@@ -260,6 +281,7 @@ MIT
 ## Support
 
 For issues and questions:
+
 - GitHub Issues: [binoauth/binoauth](https://github.com/binoauth/binoauth/issues)
 - Email: support@binoauth.com
-- Documentation: [docs.binoauth.com](https://docs.binoauth.com)
+- Documentation: [docs.binoauth.com](https://docs.binoauth.com)