postex-auth-sdk-stage 2.2.0 → 2.3.1

package/README.md

@@ -101,7 +101,7 @@ Accepts either a direct email string or an identifier object.
 
 ```typescript
 async getStatus(
-  identifier: string | { email?: string; mobileNumber?: string }
+  identifier: string | { email?: string; mobileNumber?: string; username?: string }
 ): Promise<AuthStatusResponse>
 ```
 
@@ -110,6 +110,7 @@ async getStatus(
 - `auth.getStatus('user@example.com')`
 - `auth.getStatus({ email: 'user@example.com' })`
 - `auth.getStatus({ mobileNumber: '03011266254' })`
+- `auth.getStatus({ username: 'user123' })`
 
 **Returns:**
 
@@ -126,10 +127,17 @@ Start the authentication process. Returns either a WebAuthn challenge or confirm
 
 ```typescript
 async initiateAuth(
-  identifier: string | { email?: string; mobileNumber?: string }
+  identifier: string | { email?: string; mobileNumber?: string; username?: string }
 ): Promise<InitiateAuthResponse>
 ```
 
+**Supported input forms:**
+
+- `auth.initiateAuth('user@example.com')`
+- `auth.initiateAuth({ email: 'user@example.com' })`
+- `auth.initiateAuth({ mobileNumber: '03011266254' })`
+- `auth.initiateAuth({ username: 'user123' })`
+
 **Returns:**
 
 - `status`: `'webauthn_challenge'` | `'otp_sent'`
@@ -140,11 +148,11 @@ async initiateAuth(
 #### initiateOTP()
 
 Start OTP authentication directly via `/otp/initiate`.
-Requires at least one identifier: `email` or `mobileNumber`.
+Requires at least one identifier: `email`, `mobileNumber`, or `username`.
 
 ```typescript
 async initiateOTP(
-  identifier: string | { email?: string; mobileNumber?: string }
+  identifier: string | { email?: string; mobileNumber?: string; username?: string }
 ): Promise<{
   message?: string;
 }>
@@ -153,11 +161,12 @@ async initiateOTP(
 **Supported input forms:**
 - `auth.initiateOTP({ email: 'user@example.com' })`
 - `auth.initiateOTP({ mobileNumber: '03011266254' })`
-- `auth.initiateOTP({ email: 'user@example.com' })`
+- `auth.initiateOTP({ username: 'user123' })`
 
 **Validation:**
 
-- Throws an error when both `email` and `mobileNumber` are missing/empty.
+- Throws an error when `email`, `mobileNumber`, and `username` are all missing/empty.
+- `username` is trimmed, must be 64 characters or fewer, and must not contain control characters.
 
 ---
 

package/dist/auth.d.ts

@@ -2,6 +2,7 @@ type AuthEntity = "xstak" | "postex" | "callcourier" | "postexglobal" | "postexs
 type AuthIdentifierInput = string | {
     email?: string;
     mobileNumber?: string;
+    username?: string;
     realm?: string;
 };
 interface RealmOptions {
@@ -36,7 +37,6 @@ interface InitiateAuthResponse {
 }
 interface OTPVerifyResponse {
     access_token: string;
-    id_token: string;
     refresh_token: string;
     expires_in: number;
     token_type: string;
@@ -88,7 +88,6 @@ interface PasskeyStatusResponse {
 interface AuthResponse {
     access_token: string;
     refresh_token: string;
-    id_token?: string;
     email: string;
     name: string;
     expiresIn?: number;
@@ -98,7 +97,6 @@ interface AuthResponse {
 /** Response from POST /auth/refresh */
 interface RefreshTokenResponse {
     access_token: string;
-    id_token?: string;
     token_type: string;
     expires_in: number;
 }
@@ -129,6 +127,7 @@ export declare class AuthSDK {
     private assertNoControlChars;
     private validateEmail;
     private validateMobileNumber;
+    private validateUsername;
     private validateOTP;
     private validateMagicLinkToken;
     private validateRealm;
@@ -156,8 +155,8 @@ export declare class AuthSDK {
      */
     initiateAuth(identifier: AuthIdentifierInput, options?: RealmOptions): Promise<InitiateAuthResponse>;
     /**
-     * POST /otp/initiate - Direct OTP initiation using email or mobile number.
-     * Requires at least one identifier: email or mobileNumber.
+     * POST /otp/initiate - Direct OTP initiation using email, mobile number, or username.
+     * Requires at least one identifier: email, mobileNumber, or username.
      */
     initiateOTP(identifier: AuthIdentifierInput, options?: RealmOptions): Promise<OTPInitiateResponse>;
     /**
@@ -237,7 +236,6 @@ export declare class AuthSDK {
     storeTokens(tokens: {
         accessToken: string;
         refreshToken?: string;
-        idToken?: string;
         expiresIn?: number;
         tokenType?: string;
     }): Promise<void>;