squarecommonblhelper 11.0.0 → 11.2.0

package/README.md

@@ -15,6 +15,16 @@ helper for common bl for my projects.
 
 ## changelog
 
+### v11.2.0
+
+- AuthenticationCommonBL:
+  - update getUserRecoveryMethodsV0 response type.
+
+### v11.1.0
+
+- all:
+  - add new optional parameter logErrors to all methods.
+
 ### v11.0.0
 
 - AuthenticationCommonBL:

package/dist/authentication.d.ts

@@ -2,12 +2,12 @@ import { RecoveryMethodEnum } from "./types/AuthenticationResponses.js";
 declare class AuthenticationCommonBL {
     private commonBLBaseURL;
     constructor(commonBLBaseURL?: string);
-    deleteUserV0(accessToken: string, password: string): Promise<{
+    deleteUserV0(accessToken: string, password: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: null;
         log?: any;
     }>;
-    updateUsernameV0(accessToken: string, newUsername: string): Promise<{
+    updateUsernameV0(accessToken: string, newUsername: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: {
@@ -17,7 +17,7 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    getUserDetailsV0(accessToken: string): Promise<{
+    getUserDetailsV0(accessToken: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: {
@@ -52,25 +52,25 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    logoutAllV0(accessToken: string): Promise<{
+    logoutAllV0(accessToken: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: null;
         log?: any;
     }>;
-    logoutAppsV0(accessToken: string, appNames: string[]): Promise<{
+    logoutAppsV0(accessToken: string, appNames: string[], logErrors?: boolean): Promise<{
         message: string | null;
         data: null;
         log?: any;
     }>;
-    getUserProfilePhotoV0(accessToken: string): Promise<Blob>;
-    updateUserProfilePhotoV0(accessToken: string, profilePhoto?: File): Promise<{
+    getUserProfilePhotoV0(accessToken: string, logErrors?: boolean): Promise<Blob>;
+    updateUserProfilePhotoV0(accessToken: string, profilePhoto?: File, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: string | null;
         };
         log?: any;
     }>;
-    generateAccountBackupCodesV0(accessToken: string): Promise<{
+    generateAccountBackupCodesV0(accessToken: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: {
@@ -80,7 +80,7 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    updateProfileDetailsV0(accessToken: string, firstName?: string, lastName?: string, email?: string, phoneNumberCountryCode?: string, phoneNumber?: string): Promise<{
+    updateProfileDetailsV0(accessToken: string, firstName?: string, lastName?: string, email?: string, phoneNumberCountryCode?: string, phoneNumber?: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: {
@@ -97,7 +97,7 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    sendResetPasswordEmailV0(username: string): Promise<{
+    sendResetPasswordEmailV0(username: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             expires_at: string;
@@ -105,14 +105,14 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    updateUserRecoveryMethodsV0(accessToken: string, recoveryMethodsToAdd?: RecoveryMethodEnum[], recoveryMethodsToRemove?: RecoveryMethodEnum[]): Promise<{
+    updateUserRecoveryMethodsV0(accessToken: string, recoveryMethodsToAdd?: RecoveryMethodEnum[], recoveryMethodsToRemove?: RecoveryMethodEnum[], logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: ("EMAIL" | "BACKUP_CODE")[];
         };
         log?: any;
     }>;
-    sendVerificationEmailV0(accessToken: string): Promise<{
+    sendVerificationEmailV0(accessToken: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             expires_at: string;
@@ -120,17 +120,26 @@ declare class AuthenticationCommonBL {
         } | null;
         log?: any;
     }>;
-    validateEmailVerificationCodeV0(accessToken: string, verificationCode: string): Promise<{
+    validateEmailVerificationCodeV0(accessToken: string, verificationCode: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             user_profile_email_verified: string;
         } | null;
         log?: any;
     }>;
-    getUserRecoveryMethodsV0(username: string): Promise<{
+    getUserRecoveryMethodsV0(username: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: Partial<Record<"EMAIL" | "BACKUP_CODE", boolean>>;
+            backup_code_details: {
+                total: number;
+                available: number;
+                generated_at: string;
+            };
+            email_recovery_details: {
+                expires_at: string;
+                cooldown_reset_at: string;
+            };
         };
         log?: any;
     }>;

package/dist/authentication.js

@@ -5,7 +5,7 @@ class AuthenticationCommonBL {
     constructor(commonBLBaseURL = "http://localhost:10110") {
         this.commonBLBaseURL = commonBLBaseURL;
     }
-    async deleteUserV0(accessToken, password) {
+    async deleteUserV0(accessToken, password, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -19,14 +19,18 @@ class AuthenticationCommonBL {
             // body
             { password: password }, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return DeleteUserV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async updateUsernameV0(accessToken, newUsername) {
+    async updateUsernameV0(accessToken, newUsername, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -40,14 +44,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            { new_username: newUsername });
+            { new_username: newUsername }, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return UpdateUsernameV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async getUserDetailsV0(accessToken) {
+    async getUserDetailsV0(accessToken, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -61,14 +69,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return GetUserDetailsV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async logoutAllV0(accessToken) {
+    async logoutAllV0(accessToken, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -82,14 +94,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return LogoutAllV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async logoutAppsV0(accessToken, appNames) {
+    async logoutAppsV0(accessToken, appNames, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -103,14 +119,18 @@ class AuthenticationCommonBL {
             // body
             { app_names: appNames }, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return LogoutAppsV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async getUserProfilePhotoV0(accessToken) {
+    async getUserProfilePhotoV0(accessToken, logErrors = true) {
         try {
             const data = await fetchFileData(
             // base url
@@ -124,14 +144,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return data;
         }
         catch (error) {
             throw error;
         }
     }
-    async updateUserProfilePhotoV0(accessToken, profilePhoto) {
+    async updateUserProfilePhotoV0(accessToken, profilePhoto, logErrors = true) {
         try {
             const MAX_SIZE = 5 * 1024 * 1024; // 5 MiB
             const ALLOWED_TYPES = ["image/png", "image/jpeg"];
@@ -159,14 +183,18 @@ class AuthenticationCommonBL {
             // body
             formData, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return UpdateUserProfilePhotoV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async generateAccountBackupCodesV0(accessToken) {
+    async generateAccountBackupCodesV0(accessToken, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -180,14 +208,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return GenerateAccountBackupCodeV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async updateProfileDetailsV0(accessToken, firstName, lastName, email, phoneNumberCountryCode, phoneNumber) {
+    async updateProfileDetailsV0(accessToken, firstName, lastName, email, phoneNumberCountryCode, phoneNumber, logErrors = true) {
         try {
             const queryParams = {};
             if (firstName)
@@ -213,14 +245,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            queryParams);
+            queryParams, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return UpdateProfileDetailsV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async sendResetPasswordEmailV0(username) {
+    async sendResetPasswordEmailV0(username, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -234,14 +270,18 @@ class AuthenticationCommonBL {
             // body
             { username: username }, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return SendResetPasswordEmailV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async updateUserRecoveryMethodsV0(accessToken, recoveryMethodsToAdd, recoveryMethodsToRemove) {
+    async updateUserRecoveryMethodsV0(accessToken, recoveryMethodsToAdd, recoveryMethodsToRemove, logErrors = true) {
         try {
             if (!recoveryMethodsToAdd) {
                 recoveryMethodsToAdd = [];
@@ -264,14 +304,18 @@ class AuthenticationCommonBL {
                 recovery_methods_to_remove: recoveryMethodsToRemove,
             }, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return UpdateUserRecoveryMethodsV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async sendVerificationEmailV0(accessToken) {
+    async sendVerificationEmailV0(accessToken, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -285,14 +329,18 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return SendVerificationEmailV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async validateEmailVerificationCodeV0(accessToken, verificationCode) {
+    async validateEmailVerificationCodeV0(accessToken, verificationCode, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -306,14 +354,18 @@ class AuthenticationCommonBL {
             // body
             { verification_code: verificationCode }, 
             // query params
-            undefined);
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return ValidateEmailVerificationCodeV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;
         }
     }
-    async getUserRecoveryMethodsV0(username) {
+    async getUserRecoveryMethodsV0(username, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -327,7 +379,11 @@ class AuthenticationCommonBL {
             // body
             undefined, 
             // query params
-            { username: username });
+            { username: username }, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
             return GetUserRecoveryMethodsV0ResponseZ.parse(data);
         }
         catch (error) {

package/dist/greeting.d.ts

@@ -1,7 +1,7 @@
 declare class GreetingCommonBL {
     private commonBLBaseURL;
     constructor(commonBLBaseURL?: string);
-    createAnonymousGreetingV0(greetingAnonymousSenderName?: string, greetingText?: string): Promise<{
+    createAnonymousGreetingV0(greetingAnonymousSenderName?: string, greetingText?: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             main: {

package/dist/greeting.js

@@ -5,12 +5,12 @@ class GreetingCommonBL {
     constructor(commonBLBaseURL = "http://localhost:10110") {
         this.commonBLBaseURL = commonBLBaseURL;
     }
-    async createAnonymousGreetingV0(greetingAnonymousSenderName, greetingText) {
+    async createAnonymousGreetingV0(greetingAnonymousSenderName, greetingText, logErrors = true) {
         try {
             const data = await fetchJSONData(this.commonBLBaseURL, "create_anonymous_greeting/v0", "POST", undefined, {
                 greeting_anonymous_sender_name: greetingAnonymousSenderName,
                 greeting_text: greetingText,
-            });
+            }, undefined, undefined, logErrors);
             return CreateAnonymousGreetingV0ResponseZ.parse(data);
         }
         catch (error) {

package/dist/types/AuthenticationResponses.d.ts

@@ -620,21 +620,80 @@ declare const GetUserRecoveryMethodsV0ResponseZ: z.ZodObject<z.objectUtil.extend
 }, {
     data: z.ZodObject<{
         main: z.ZodRecord<z.ZodEnum<["EMAIL", "BACKUP_CODE"]>, z.ZodBoolean>;
+        email_recovery_details: z.ZodObject<{
+            expires_at: z.ZodString;
+            cooldown_reset_at: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            expires_at: string;
+            cooldown_reset_at: string;
+        }, {
+            expires_at: string;
+            cooldown_reset_at: string;
+        }>;
+        backup_code_details: z.ZodObject<{
+            total: z.ZodNumber;
+            available: z.ZodNumber;
+            generated_at: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            total: number;
+            available: number;
+            generated_at: string;
+        }, {
+            total: number;
+            available: number;
+            generated_at: string;
+        }>;
     }, "strict", z.ZodTypeAny, {
         main: Partial<Record<"EMAIL" | "BACKUP_CODE", boolean>>;
+        backup_code_details: {
+            total: number;
+            available: number;
+            generated_at: string;
+        };
+        email_recovery_details: {
+            expires_at: string;
+            cooldown_reset_at: string;
+        };
     }, {
         main: Partial<Record<"EMAIL" | "BACKUP_CODE", boolean>>;
+        backup_code_details: {
+            total: number;
+            available: number;
+            generated_at: string;
+        };
+        email_recovery_details: {
+            expires_at: string;
+            cooldown_reset_at: string;
+        };
     }>;
 }>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: {
         main: Partial<Record<"EMAIL" | "BACKUP_CODE", boolean>>;
+        backup_code_details: {
+            total: number;
+            available: number;
+            generated_at: string;
+        };
+        email_recovery_details: {
+            expires_at: string;
+            cooldown_reset_at: string;
+        };
     };
     log?: any;
 }, {
     message: string | null;
     data: {
         main: Partial<Record<"EMAIL" | "BACKUP_CODE", boolean>>;
+        backup_code_details: {
+            total: number;
+            available: number;
+            generated_at: string;
+        };
+        email_recovery_details: {
+            expires_at: string;
+            cooldown_reset_at: string;
+        };
     };
     log?: any;
 }>;

package/dist/types/AuthenticationResponses.js

@@ -100,6 +100,15 @@ const ValidateEmailVerificationCodeV0ResponseZ = APIOutputZ.extend({
 const GetUserRecoveryMethodsV0ResponseZ = APIOutputZ.extend({
     data: z.strictObject({
         main: z.record(RecoveryMethodEnumZ, z.boolean()),
+        email_recovery_details: z.strictObject({
+            expires_at: z.string(),
+            cooldown_reset_at: z.string(),
+        }),
+        backup_code_details: z.strictObject({
+            total: z.number(),
+            available: z.number(),
+            generated_at: z.string(),
+        }),
     }),
 });
 const UpdateUserProfilePhotoV0ResponseZ = APIOutputZ.extend({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarecommonblhelper",
-  "version": "11.0.0",
+  "version": "11.2.0",
   "description": "helper for common bl for my projects.",
   "main": "dist/index.js",
   "type": "module",
@@ -34,7 +34,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "squarecommons": "^2.4.0",
+    "squarecommons": "^2.5.0",
     "zod": "^3.24.1"
   }
 }