@edraj/tsdmart 2.7.0 → 2.8.0

package/README.md

@@ -19,6 +19,12 @@ make sure you define `axiosDmartInstance` with your axios instance before import
 * `login(shortname: string, password: string) -> Promise<LoginResponse>` - Performs a login action (shortname).
 * `loginBy(credentials: dict, password: string) -> Promise<LoginResponse>` - Performs a login action but altering the default identifier that you can customise.
 * `logout() -> Promise<ApiResponse>` - Performs a logout action.
+* `otp_request(request: SendOTPRequest,acceptLanguage: string | null = null)  -> Promise<ApiResponse | null>` - Requests an OTP (One Time Password) for login.
+* `otp_request_login(request: SendOTPRequest,acceptLanguage: string | null = null) -> Promise<ApiResponse | null>` - Requests an OTP for login and returns a login response.
+* `password_reset_request(request: PasswordResetRequest) -> Promise<ApiResponse | null>` - Requests a password reset.
+* `confirm_otp(request: ConfirmOTPRequest) -> Promise<ApiResponse | null>` - Confirms the OTP (One Time Password) for login or password reset.
+* `user_reset(shortname: string) -> Promise<ApiResponse | null>` - Resets the user password by sending an OTP to the user's email.
+* `validate_password(password: string) -> Promise<ApiResponse | null>` - Validates the password.
 * `create_user(request: any) -> Promise<ActionResponse>` - Creates a new user.
 * `update_user(request: any) -> Promise<ActionResponse>` - Updates an existing user.
 * `check_existing(prop: string, value: string) -> Promise<ResponseEntry | null>` - Checks if a user exists.

package/dmart.model.ts

@@ -47,6 +47,21 @@ export enum UserType {
   bot = "bot",
 }
 
+export interface SendOTPRequest {
+  msisdn?: string;
+  email?: string;
+}
+
+export interface PasswordResetRequest {
+  msisdn?: string;
+  shortname?: string;
+  email?: string;
+}
+
+export interface ConfirmOTPRequest {
+  code: string
+}
+
 export type LoginResponseRecord = ApiResponseRecord & {
   attributes: {
     access_token: string;

package/dmart.service.ts

@@ -1,19 +1,22 @@
 import {AxiosInstance} from "axios";
 import {
-    ActionRequest,
-    ActionResponse,
-    ApiQueryResponse,
-    ApiResponse,
-    ContentType,
-    headers,
-    LoginResponse,
-    ProfileResponse,
-    QueryRequest,
-    QueryType,
-    ResourceType,
-    ResponseEntry,
-    SortyType,
-    Status,
+  ActionRequest, ActionRequestRecord,
+  ActionResponse,
+  ApiQueryResponse,
+  ApiResponse,
+  ConfirmOTPRequest,
+  ContentType,
+  headers,
+  LoginResponse,
+  PasswordResetRequest,
+  ProfileResponse,
+  QueryRequest,
+  QueryType,
+  ResourceType,
+  ResponseEntry,
+  SendOTPRequest,
+  SortyType,
+  Status,
 } from "./dmart.model";
 
 
@@ -100,7 +103,7 @@ export class Dmart {
     }
   }
 
-  public static async create_user(request: any) {
+  public static async create_user(request: ActionRequestRecord) {
     try {
       const { data } = await Dmart.axiosDmartInstance.post<ActionResponse>(
         `user/create`,
@@ -113,7 +116,7 @@ export class Dmart {
     }
   }
 
-  public static async update_user(request: any) {
+  public static async update_user(request: ActionRequestRecord) {
     try {
       const { data } = await Dmart.axiosDmartInstance.post<ActionResponse>(
         `user/profile`,
@@ -510,4 +513,98 @@ export class Dmart {
       throw error;
     }
   }
+
+  public static async otp_request(
+    request: SendOTPRequest,
+    acceptLanguage: string | null = null
+  ) {
+    try {
+      const requestHeaders = { ...headers };
+      if (acceptLanguage) {
+        requestHeaders['Accept-Language'] = acceptLanguage;
+      }
+
+      const { data } = await Dmart.axiosDmartInstance.post<ApiResponse>(
+        `user/otp-request`,
+        request,
+        { headers: requestHeaders }
+      );
+      return data;
+    } catch (error: any) {
+      throw error;
+    }
+  }
+
+  public static async otp_request_login(
+    request: SendOTPRequest,
+    acceptLanguage: string | null = null
+  ) {
+    try {
+      const requestHeaders = { ...headers };
+      if (acceptLanguage) {
+        requestHeaders['Accept-Language'] = acceptLanguage;
+      }
+
+      const { data } = await Dmart.axiosDmartInstance.post<ApiResponse>(
+        `user/otp-request-login`,
+        request,
+        { headers: requestHeaders }
+      );
+      return data;
+    } catch (error: any) {
+      throw error;
+    }
+  }
+
+  public static async password_reset_request(request: PasswordResetRequest) {
+    try {
+      const { data } = await Dmart.axiosDmartInstance.post<ApiResponse>(
+        `user/password-reset-request`,
+        request,
+        { headers }
+      );
+      return data;
+    } catch (error: any) {
+      throw error;
+    }
+  }
+
+  public static async confirm_otp(request: ConfirmOTPRequest) {
+    try {
+      const { data } = await Dmart.axiosDmartInstance.post<ApiResponse>(
+        `user/otp-confirm`,
+        request,
+        { headers }
+      );
+      return data;
+    } catch (error: any) {
+      throw error;
+    }
+  }
+
+  public static async user_reset(shortname: string) {
+    try {
+      const { data } = await Dmart.axiosDmartInstance.post<ApiResponse>(
+        `user/reset`,
+        { shortname },
+        { headers }
+      );
+      return data;
+    } catch (error: any) {
+      throw error;
+    }
+  }
+
+  public static async validate_password(password: string) {
+    try {
+      const { data } = await Dmart.axiosDmartInstance.post<ApiResponse>(
+        `user/validate_password`,
+        { password },
+        { headers }
+      );
+      return data;
+    } catch (error: any) {
+      throw error;
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edraj/tsdmart",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "A TypeScript implementation of the Dmart that depends on axios.",
   "author": "Kefah T. Issa",
   "email": "kefah.issa@gmail.com",