postex-auth-sdk-stage 1.2.4 → 1.3.0

package/README.md

@@ -40,7 +40,10 @@ npm install postex-auth-sdk-stage
 ```javascript
 import { AuthSDK } from 'postex-auth-sdk-stage';
 
-const auth = new AuthSDK({ apiKey: 'your-api-key' });
+const auth = new AuthSDK({
+  apiKey: 'your-api-key',
+  appId: 'postexglobal'
+});
 ```
 
 ### Basic Authentication Flow
@@ -85,6 +88,7 @@ new AuthSDK(config: AuthSDKConfig)
 | Parameter | Description |
 |-----------|-------------|
 | `config.apiKey` | (Optional) Your API key for authentication |
+| `config.appId` | (Optional) Selects which Auth environment to use. Allowed values: `'xstak'`, `'postex'`, `'callcourier'`, `'postexglobal'`. Default: `'postexglobal'` |
 
 ---
 
@@ -133,6 +137,30 @@ async initiateAuth(
 
 ---
 
+#### initiateOTP()
+
+Start OTP authentication directly via `/otp/initiate`.
+Requires at least one identifier: `email` or `mobileNumber`.
+
+```typescript
+async initiateOTP(
+  identifier: string | { email?: string; mobileNumber?: string }
+): Promise<{
+  message?: string;
+}>
+```
+
+**Supported input forms:**
+- `auth.initiateOTP({ email: 'user@example.com' })`
+- `auth.initiateOTP({ mobileNumber: '03011266254' })`
+- `auth.initiateOTP({ email: 'user@example.com' })`
+
+**Validation:**
+
+- Throws an error when both `email` and `mobileNumber` are missing/empty.
+
+---
+
 #### verifyOTP()
 
 Verify the OTP code entered by the user. Automatically stores tokens on success.
@@ -712,7 +740,7 @@ import {
 
 ## Support and Resources
 
-- **API Documentation:** https://auth-stage.postexglobal.com/docs
+- **API Documentation:** https://auth.postexglobal.com/docs
 - **GitHub Repository:** (Add your repository link)
 - **Issue Tracker:** (Add your issue tracker link)
 - **Email Support:** (Add your support email)
@@ -721,7 +749,7 @@ import {
 
 ## API overview
 
-- **AuthSDK** – Main client: `getStatus`, `initiateAuth`, `verifyOTP`, `resendOTP`, `verifySignupOTP`, `resendSignupOTP`, `verifyMagicLink`, `completeMagicLink`, `authenticateWithPasskey`, `registerPasskey`, `getPasskeyStatus`, `removePasskey`, `getRequestAuthHeaders`, `authenticatedFetch`, `refreshToken`, `logout`, `getAccessToken`, `storeTokens`, `clearTokens`
+- **AuthSDK** – Main client: `getStatus`, `initiateAuth`, `initiateOTP`, `verifyOTP`, `resendOTP`, `verifySignupOTP`, `resendSignupOTP`, `verifyMagicLink`, `completeMagicLink`, `authenticateWithPasskey`, `registerPasskey`, `getPasskeyStatus`, `removePasskey`, `getRequestAuthHeaders`, `authenticatedFetch`, `refreshToken`, `logout`, `getAccessToken`, `storeTokens`, `clearTokens`
 - **WebAuthn** – Helpers: `isWebAuthnSupported`, `isConditionalUISupported`, base64/ArrayBuffer conversion, DPoP key and proof helpers, passkey email/mobile storage (`getPasskeyEmail`, `setPasskeyEmail`, `clearPasskeyEmail`, `getPasskeyMobileNumber`, `setPasskeyMobileNumber`, `clearPasskeyMobileNumber`)
 - **AuthSDKFetchError** – Error class with `response.status` and `response.data`
 

package/dist/auth.d.ts

@@ -1,4 +1,4 @@
-type AuthEntity = "xstak" | "postex" | "callcourier" | "postexglobal";
+type AuthEntity = "xstak" | "postex" | "callcourier" | "postexglobal" | "postexsa";
 interface AuthSDKConfig {
     apiKey?: string;
     appId?: AuthEntity;
@@ -36,6 +36,17 @@ interface OTPVerifyResponse {
     email: string;
     [key: string]: any;
 }
+interface OTPInitiateResponse {
+    statusText?: string;
+    statusCode?: number;
+    success?: boolean;
+    message?: string;
+    data?: {
+        message?: string;
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
 interface PasskeyRegistrationChallenge {
     challenge: string;
     rp: {
@@ -123,6 +134,14 @@ export declare class AuthSDK {
         email?: string;
         mobileNumber?: string;
     }): Promise<InitiateAuthResponse>;
+    /**
+     * POST /otp/initiate - Direct OTP initiation using email or mobile number.
+     * Requires at least one identifier: email or mobileNumber.
+     */
+    initiateOTP(identifier: string | {
+        email?: string;
+        mobileNumber?: string;
+    }): Promise<OTPInitiateResponse>;
     /**
      * POST /otp/verify - Verifies the OTP code entered by the user.
      * Stores tokens from the response.