squarecommonblhelper 5.2.1 → 6.0.0

package/README.md

@@ -15,6 +15,18 @@ helper for common bl for my projects.
 
 ## changelog
 
+### v6.0.0
+
+- AuthenticationCommonBL:
+  - **breaking change** remove updatePasswordV0.
+  - add generateAccountBackupCodesV0.
+  - method changed of deleteUserV0 from delete to post.
+  - add updateProfileDetailsV0.
+  - add sendResetPasswordEmailV0.
+  - add updateUserRecoveryMethodsV0.
+  - add sendVerificationEmailV0.
+  - add validateEmailVerificationCodeV0.
+
 ### v5.2.1
 
 - AuthenticationCommonBL:

package/dist/authentication.d.ts

@@ -1,3 +1,4 @@
+import { RecoveryMethodEnum } from "./types/AuthenticationResponses.js";
 declare class AuthenticationCommonBL {
     private commonBLBaseURL;
     constructor(commonBLBaseURL?: string);
@@ -16,11 +17,6 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    updatePasswordV0(accessToken: string, oldPassword: string, newPassword: string): Promise<{
-        message: string | null;
-        data: null;
-        log?: any;
-    }>;
     getUserDetailsV0(accessToken: string): Promise<{
         message: string | null;
         data: {
@@ -60,5 +56,61 @@ declare class AuthenticationCommonBL {
         data?: any;
         log?: any;
     }>;
+    generateAccountBackupCodesV0(accessToken: string): Promise<{
+        message: string | null;
+        data: {
+            main: {
+                user_id: string;
+                backup_codes: string[];
+            };
+        };
+        log?: any;
+    }>;
+    updateProfileDetailsV0(accessToken: string, firstName?: string, lastName?: string, email?: string, phoneNumberCountryCode?: string, phoneNumber?: string): Promise<{
+        message: string | null;
+        data: {
+            main: {
+                user_id: string;
+                user_profile_id: number;
+                user_profile_photo_storage_token: string | null;
+                user_profile_email: string | null;
+                user_profile_phone_number: string | null;
+                user_profile_first_name: string | null;
+                user_profile_last_name: string | null;
+                user_profile_phone_number_country_code: string | null;
+                user_profile_email_verified: string | null;
+            }[];
+            affected_count: number;
+        };
+        log?: any;
+    }>;
+    sendResetPasswordEmailV0(username: string): Promise<{
+        message: string | null;
+        data: {
+            expires_at: string;
+        };
+        log?: any;
+    }>;
+    updateUserRecoveryMethodsV0(accessToken: string, recoveryMethodsToAdd?: RecoveryMethodEnum[], recoveryMethodsToRemove?: RecoveryMethodEnum[]): Promise<{
+        message: string | null;
+        data: {
+            main: ("EMAIL" | "BACKUP_CODE")[];
+        };
+        log?: any;
+    }>;
+    sendVerificationEmailV0(accessToken: string): Promise<{
+        message: string | null;
+        data: {
+            expires_at: string;
+        } | null;
+        log?: any;
+    }>;
+    validateEmailVerificationCodeV0(accessToken: string, verificationCode: string): Promise<{
+        message: string | null;
+        data: {
+            user_profile_email_verified: string;
+        } | null;
+        log?: any;
+    }>;
 }
 export { AuthenticationCommonBL };

package/dist/authentication.js

@@ -1,5 +1,5 @@
 import { fetchFileData, fetchJSONData } from "squarecommons";
-import { DeleteUserV0Z, GetUserDetailsV0ResponseZ, LogoutAllV0Z, LogoutAppsV0Z, UpdatePasswordV0ResponseZ, UpdateUsernameV0ResponseZ, } from "./types/AuthenticationResponses.js";
+import { DeleteUserV0Z, GenerateAccountBackupCodeZ, GetUserDetailsV0ResponseZ, LogoutAllV0Z, LogoutAppsV0Z, sendResetPasswordEmailV0ResponseZ, sendVerificationEmailV0ResponseZ, updateProfileDetailsZ, UpdateUsernameV0ResponseZ, updateUserRecoveryMethodsV0ResponseZ, validateEmailVerificationCodeV0ResponseZ } from "./types/AuthenticationResponses.js";
 class AuthenticationCommonBL {
     commonBLBaseURL;
     constructor(commonBLBaseURL = "http://localhost:10110") {
@@ -13,7 +13,7 @@ class AuthenticationCommonBL {
             // endpoint
             "delete_user/v0", 
             // method
-            "DELETE", 
+            "POST", 
             // headers
             { access_token: accessToken }, 
             // body
@@ -47,27 +47,6 @@ class AuthenticationCommonBL {
             throw error;
         }
     }
-    async updatePasswordV0(accessToken, oldPassword, newPassword) {
-        try {
-            const data = await fetchJSONData(
-            // base url
-            this.commonBLBaseURL, 
-            // endpoint
-            "update_password/v0", 
-            // method
-            "PATCH", 
-            // headers
-            { access_token: accessToken }, 
-            // body
-            { old_password: oldPassword, new_password: newPassword }, 
-            // query params
-            undefined);
-            return UpdatePasswordV0ResponseZ.parse(data);
-        }
-        catch (error) {
-            throw error;
-        }
-    }
     async getUserDetailsV0(accessToken) {
         try {
             const data = await fetchJSONData(
@@ -187,5 +166,152 @@ class AuthenticationCommonBL {
             throw error;
         }
     }
+    async generateAccountBackupCodesV0(accessToken) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "generate_account_backup_codes/v0", 
+            // method
+            "POST", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            undefined, 
+            // query params
+            undefined);
+            return GenerateAccountBackupCodeZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async updateProfileDetailsV0(accessToken, firstName, lastName, email, phoneNumberCountryCode, phoneNumber) {
+        try {
+            const queryParams = {};
+            if (firstName)
+                queryParams["first_name"] = firstName;
+            if (lastName)
+                queryParams["last_name"] = lastName;
+            if (email)
+                queryParams["email"] = email;
+            if (phoneNumberCountryCode)
+                queryParams["phone_number_country_code"] = phoneNumberCountryCode;
+            if (phoneNumber)
+                queryParams["phone_number"] = phoneNumber;
+            // Call API
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "update_profile_details/v0", 
+            // method
+            "PATCH", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            undefined, 
+            // query params
+            queryParams);
+            return updateProfileDetailsZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async sendResetPasswordEmailV0(username) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "send_reset_password_email/v0", 
+            // method
+            "POST", 
+            // headers
+            undefined, 
+            // body
+            { username: username }, 
+            // query params
+            undefined);
+            return sendResetPasswordEmailV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async updateUserRecoveryMethodsV0(accessToken, recoveryMethodsToAdd, recoveryMethodsToRemove) {
+        try {
+            if (!recoveryMethodsToAdd) {
+                recoveryMethodsToAdd = [];
+            }
+            if (!recoveryMethodsToRemove) {
+                recoveryMethodsToRemove = [];
+            }
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "update_user_recovery_methods/v0", 
+            // method
+            "PATCH", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            undefined, 
+            // query params
+            {
+                recovery_methods_to_add: recoveryMethodsToAdd.join(","),
+                recovery_methods_to_remove: recoveryMethodsToRemove.join(","),
+            });
+            return updateUserRecoveryMethodsV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async sendVerificationEmailV0(accessToken) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "send_verification_email/v0", 
+            // method
+            "POST", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            undefined, 
+            // query params
+            undefined);
+            return sendVerificationEmailV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async validateEmailVerificationCodeV0(accessToken, verificationCode) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "validate_email_verification_code/v0", 
+            // method
+            "POST", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            { verification_code: verificationCode }, 
+            // query params
+            undefined);
+            return validateEmailVerificationCodeV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
 }
 export { AuthenticationCommonBL };

package/dist/types/AuthenticationResponses.d.ts

@@ -46,22 +46,6 @@ declare const UpdateUsernameV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
     log?: any;
 }>;
 type UpdateUsernameV0Response = z.infer<typeof UpdateUsernameV0ResponseZ>;
-declare const UpdatePasswordV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
-    data: z.ZodAny;
-    message: z.ZodNullable<z.ZodString>;
-    log: z.ZodAny;
-}, {
-    data: z.ZodNull;
-}>, "strict", z.ZodTypeAny, {
-    message: string | null;
-    data: null;
-    log?: any;
-}, {
-    message: string | null;
-    data: null;
-    log?: any;
-}>;
-type UpdatePasswordV0Response = z.infer<typeof UpdatePasswordV0ResponseZ>;
 declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
     data: z.ZodAny;
     message: z.ZodNullable<z.ZodString>;
@@ -270,4 +254,258 @@ declare const LogoutAppsV0Z: z.ZodObject<z.objectUtil.extendShape<{
     log?: any;
 }>;
 type LogoutAppsV0 = z.infer<typeof LogoutAppsV0Z>;
-export { UpdateUsernameV0ResponseZ, UpdateUsernameV0Response, UpdatePasswordV0ResponseZ, UpdatePasswordV0Response, GetUserDetailsV0ResponseZ, GetUserDetailsV0Response, DeleteUserV0, DeleteUserV0Z, LogoutAllV0, LogoutAllV0Z, LogoutAppsV0, LogoutAppsV0Z, };
+declare const GenerateAccountBackupCodeZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodObject<{
+            user_id: z.ZodString;
+            backup_codes: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            user_id: string;
+            backup_codes: string[];
+        }, {
+            user_id: string;
+            backup_codes: string[];
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        main: {
+            user_id: string;
+            backup_codes: string[];
+        };
+    }, {
+        main: {
+            user_id: string;
+            backup_codes: string[];
+        };
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: {
+            user_id: string;
+            backup_codes: string[];
+        };
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: {
+            user_id: string;
+            backup_codes: string[];
+        };
+    };
+    log?: any;
+}>;
+type GenerateAccountBackupCode = z.infer<typeof GenerateAccountBackupCodeZ>;
+declare const updateProfileDetailsZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodArray<z.ZodObject<{
+            user_profile_photo_storage_token: z.ZodNullable<z.ZodString>;
+            user_profile_email: z.ZodNullable<z.ZodString>;
+            user_profile_phone_number_country_code: z.ZodNullable<z.ZodString>;
+            user_profile_first_name: z.ZodNullable<z.ZodString>;
+            user_profile_last_name: z.ZodNullable<z.ZodString>;
+            user_id: z.ZodString;
+            user_profile_id: z.ZodNumber;
+            user_profile_email_verified: z.ZodNullable<z.ZodString>;
+            user_profile_phone_number: z.ZodNullable<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            user_id: string;
+            user_profile_id: number;
+            user_profile_photo_storage_token: string | null;
+            user_profile_email: string | null;
+            user_profile_phone_number: string | null;
+            user_profile_first_name: string | null;
+            user_profile_last_name: string | null;
+            user_profile_phone_number_country_code: string | null;
+            user_profile_email_verified: string | null;
+        }, {
+            user_id: string;
+            user_profile_id: number;
+            user_profile_photo_storage_token: string | null;
+            user_profile_email: string | null;
+            user_profile_phone_number: string | null;
+            user_profile_first_name: string | null;
+            user_profile_last_name: string | null;
+            user_profile_phone_number_country_code: string | null;
+            user_profile_email_verified: string | null;
+        }>, "many">;
+        affected_count: z.ZodNumber;
+    }, "strict", z.ZodTypeAny, {
+        main: {
+            user_id: string;
+            user_profile_id: number;
+            user_profile_photo_storage_token: string | null;
+            user_profile_email: string | null;
+            user_profile_phone_number: string | null;
+            user_profile_first_name: string | null;
+            user_profile_last_name: string | null;
+            user_profile_phone_number_country_code: string | null;
+            user_profile_email_verified: string | null;
+        }[];
+        affected_count: number;
+    }, {
+        main: {
+            user_id: string;
+            user_profile_id: number;
+            user_profile_photo_storage_token: string | null;
+            user_profile_email: string | null;
+            user_profile_phone_number: string | null;
+            user_profile_first_name: string | null;
+            user_profile_last_name: string | null;
+            user_profile_phone_number_country_code: string | null;
+            user_profile_email_verified: string | null;
+        }[];
+        affected_count: number;
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: {
+            user_id: string;
+            user_profile_id: number;
+            user_profile_photo_storage_token: string | null;
+            user_profile_email: string | null;
+            user_profile_phone_number: string | null;
+            user_profile_first_name: string | null;
+            user_profile_last_name: string | null;
+            user_profile_phone_number_country_code: string | null;
+            user_profile_email_verified: string | null;
+        }[];
+        affected_count: number;
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: {
+            user_id: string;
+            user_profile_id: number;
+            user_profile_photo_storage_token: string | null;
+            user_profile_email: string | null;
+            user_profile_phone_number: string | null;
+            user_profile_first_name: string | null;
+            user_profile_last_name: string | null;
+            user_profile_phone_number_country_code: string | null;
+            user_profile_email_verified: string | null;
+        }[];
+        affected_count: number;
+    };
+    log?: any;
+}>;
+type updateProfileDetails = z.infer<typeof updateProfileDetailsZ>;
+declare const sendResetPasswordEmailV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        expires_at: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        expires_at: string;
+    }, {
+        expires_at: string;
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        expires_at: string;
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        expires_at: string;
+    };
+    log?: any;
+}>;
+type sendResetPasswordEmailV0Response = z.infer<typeof sendResetPasswordEmailV0ResponseZ>;
+declare const RecoveryMethodEnumZ: z.ZodEnum<["EMAIL", "BACKUP_CODE"]>;
+type RecoveryMethodEnum = z.infer<typeof RecoveryMethodEnumZ>;
+declare const updateUserRecoveryMethodsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodArray<z.ZodEnum<["EMAIL", "BACKUP_CODE"]>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        main: ("EMAIL" | "BACKUP_CODE")[];
+    }, {
+        main: ("EMAIL" | "BACKUP_CODE")[];
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: ("EMAIL" | "BACKUP_CODE")[];
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: ("EMAIL" | "BACKUP_CODE")[];
+    };
+    log?: any;
+}>;
+type updateUserRecoveryMethodsV0Response = z.infer<typeof updateUserRecoveryMethodsV0ResponseZ>;
+declare const sendVerificationEmailV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodNullable<z.ZodObject<{
+        expires_at: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        expires_at: string;
+    }, {
+        expires_at: string;
+    }>>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        expires_at: string;
+    } | null;
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        expires_at: string;
+    } | null;
+    log?: any;
+}>;
+type sendVerificationEmailV0Response = z.infer<typeof sendVerificationEmailV0ResponseZ>;
+declare const validateEmailVerificationCodeV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodNullable<z.ZodObject<{
+        user_profile_email_verified: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        user_profile_email_verified: string;
+    }, {
+        user_profile_email_verified: string;
+    }>>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        user_profile_email_verified: string;
+    } | null;
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        user_profile_email_verified: string;
+    } | null;
+    log?: any;
+}>;
+type validateEmailVerificationCodeV0Response = z.infer<typeof validateEmailVerificationCodeV0ResponseZ>;
+export { UpdateUsernameV0ResponseZ, UpdateUsernameV0Response, GetUserDetailsV0ResponseZ, GetUserDetailsV0Response, DeleteUserV0, DeleteUserV0Z, LogoutAllV0, LogoutAllV0Z, LogoutAppsV0, LogoutAppsV0Z, GenerateAccountBackupCode, GenerateAccountBackupCodeZ, updateProfileDetailsZ, updateProfileDetails, sendResetPasswordEmailV0ResponseZ, sendResetPasswordEmailV0Response, RecoveryMethodEnumZ, RecoveryMethodEnum, updateUserRecoveryMethodsV0ResponseZ, updateUserRecoveryMethodsV0Response, sendVerificationEmailV0ResponseZ, sendVerificationEmailV0Response, validateEmailVerificationCodeV0ResponseZ, validateEmailVerificationCodeV0Response, };

package/dist/types/AuthenticationResponses.js

@@ -8,9 +8,6 @@ const UpdateUsernameV0ResponseZ = APIOutputZ.extend({
         }),
     }),
 });
-const UpdatePasswordV0ResponseZ = APIOutputZ.extend({
-    data: z.null(),
-});
 const GetUserDetailsV0ResponseZ = APIOutputZ.extend({
     data: z.strictObject({
         main: z.strictObject({
@@ -41,4 +38,51 @@ const LogoutAllV0Z = APIOutputZ.extend({
 const LogoutAppsV0Z = APIOutputZ.extend({
     data: z.null(),
 });
-export { UpdateUsernameV0ResponseZ, UpdatePasswordV0ResponseZ, GetUserDetailsV0ResponseZ, DeleteUserV0Z, LogoutAllV0Z, LogoutAppsV0Z, };
+const GenerateAccountBackupCodeZ = APIOutputZ.extend({
+    data: z.strictObject({
+        main: z.strictObject({
+            user_id: z.string(),
+            backup_codes: z.array(z.string()),
+        }),
+    }),
+});
+const updateProfileDetailsZ = APIOutputZ.extend({
+    data: z.strictObject({
+        main: z
+            .array(z.strictObject({
+            user_profile_photo_storage_token: z.string().nullable(),
+            user_profile_email: z.string().nullable(),
+            user_profile_phone_number_country_code: z.string().nullable(),
+            user_profile_first_name: z.string().nullable(),
+            user_profile_last_name: z.string().nullable(),
+            user_id: z.string(),
+            user_profile_id: z.number(),
+            user_profile_email_verified: z.string().nullable(),
+            user_profile_phone_number: z.string().nullable(),
+        }))
+            .length(1),
+        affected_count: z.number(),
+    }),
+});
+const sendResetPasswordEmailV0ResponseZ = APIOutputZ.extend({
+    data: z.strictObject({
+        expires_at: z.string(),
+    }),
+});
+const RecoveryMethodEnumZ = z.enum(["EMAIL", "BACKUP_CODE"]);
+const updateUserRecoveryMethodsV0ResponseZ = APIOutputZ.extend({
+    data: z.strictObject({
+        main: z.array(RecoveryMethodEnumZ),
+    }),
+});
+const sendVerificationEmailV0ResponseZ = APIOutputZ.extend({
+    data: z.nullable(z.strictObject({
+        expires_at: z.string(),
+    })),
+});
+const validateEmailVerificationCodeV0ResponseZ = APIOutputZ.extend({
+    data: z.nullable(z.strictObject({
+        user_profile_email_verified: z.string(),
+    })),
+});
+export { UpdateUsernameV0ResponseZ, GetUserDetailsV0ResponseZ, DeleteUserV0Z, LogoutAllV0Z, LogoutAppsV0Z, GenerateAccountBackupCodeZ, updateProfileDetailsZ, sendResetPasswordEmailV0ResponseZ, RecoveryMethodEnumZ, updateUserRecoveryMethodsV0ResponseZ, sendVerificationEmailV0ResponseZ, validateEmailVerificationCodeV0ResponseZ, };

package/example.js

@@ -29,3 +29,21 @@ console.log(
   await authenticationCommonBL.logoutAppsV0("dummy_access_token", ["test"])
 );
 console.log(await authenticationCommonBL.getProfilePhoto("dummy_access_token"));
+console.log(
+  await authenticationCommonBL.sendResetPasswordEmailV0("dummy_username")
+);
+console.log(
+  await authenticationCommonBL.updateProfileDetailsV0(
+    "dummy_access_token",
+    "first_name"
+  )
+);
+console.log(
+  await authenticationCommonBL.updateUserRecoveryMethodsV0(
+    "dummy_access_token",
+    ["BACKUP_CODE"]
+  )
+);
+console.log(
+  await authenticationCommonBL.sendVerificationEmailV0("dummy_access_token")
+);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarecommonblhelper",
-  "version": "5.2.1",
+  "version": "6.0.0",
   "description": "helper for common bl for my projects.",
   "main": "dist/index.js",
   "type": "module",