squarecommonblhelper 11.2.1 → 11.4.0

package/README.md

@@ -1,252 +1,18 @@
 # squareCommonBLHelper
-
+ 
+> 📌 versioning: see [CHANGELOG.md](./CHANGELOG.md).
+ 
 ## about
-
+ 
 helper for common bl for my projects.
-
+ 
 ## usage
-
+ 
 [Example](./example.js)
-
+ 
 ## env
-
+ 
 1. node js - v18.17.0
 2. npm - v9.6.7
-
-## changelog
-
-### v11.2.1
-
-- AuthenticationCommonBL:
-  - fix getUserRecoveryMethodsV0 response type.
-
-### v11.2.0
-
-- AuthenticationCommonBL:
-  - update getUserRecoveryMethodsV0 response type.
-
-### v11.1.0
-
-- all:
-  - add new optional parameter logErrors to all methods.
-
-### v11.0.0
-
-- AuthenticationCommonBL:
-  - UpdateUserProfilePhotoV0Response now compatible with square_common_bl>=7.0.0
-
-### v10.1.0
-
-- AuthenticationCommonBL:
-  - add UpdateUserProfilePhotoV0ResponseZ.
-
-### v10.0.0
-
-- AuthenticationCommonBL:
-  - **breaking change**, rename the following types to match the standard naming convention:
-    - UpdateProfileDetailsV0ResponseZ
-    - SendResetPasswordEmailV0ResponseZ
-    - UpdateUserRecoveryMethodsV0ResponseZ
-    - SendVerificationEmailV0ResponseZ
-    - ValidateEmailVerificationCodeV0ResponseZ
-
-### v9.3.1
-
-- AuthenticationCommonBL:
-  - fix type of backup_code_details in GetUserDetailsV0ResponseZ.
-
-### v9.3.0
-
-- AuthenticationCommonBL:
-  - add backup_code_details in GetUserDetailsV0ResponseZ.
-
-### v9.2.3
-
-- AuthenticationCommonBL:
-  - updateUserRecoveryMethodsV0 now compatible with square_common_bl>=6.0.0
-
-### v9.2.2
-
-- AuthenticationCommonBL:
-  - bugfix in updateUserRecoveryMethodsV0 query parameters (string[] instead of comma separated list).
-
-### v9.2.1
-
-- AuthenticationCommonBL:
-  - update type of GetUserDetailsV0ResponseZ and GetUserRecoveryMethodsV0ResponseZ to include RecoveryMethodEnumZ as key instead of random string.
-
-### v9.2.0
-
-- AuthenticationCommonBL:
-  - add getUserRecoveryMethodsV0.
-
-### v9.1.0
-
-- AuthenticationCommonBL:
-  - add email_verification_details in GetUserDetailsV0ResponseZ.
-
-### v9.0.2
-
-- AuthenticationCommonBL:
-  - add recovery_methods in GetUserDetailsV0ResponseZ.
-
-### v9.0.1
-
-- AuthenticationCommonBL:
-  - add user_profile_phone_number_country_code and user_profile_email_verified in GetUserDetailsV0ResponseZ.
-
-### v9.0.0
-
-- AuthenticationCommonBL:
-  - **breaking change**: remove user_profile_username from GetUserDetailsV0ResponseZ.
-
-### v8.0.1
-
-- AuthenticationCommonBL:
-  - add username to GetUserDetailsV0ResponseZ.
-
-### v8.0.0
-
-- AuthenticationCommonBL:
-  - **breaking change**, rename the following types to match the standard naming convention:
-    - DeleteUserV0ResponseZ
-    - LogoutAllV0ResponseZ
-    - LogoutAppsV0ResponseZ
-    - GenerateAccountBackupCodeV0ResponseZ
-    - updateProfileDetailsV0ResponseZ
-
-### v7.0.0
-
-- GreetingCommonBL:
-  - **breaking change**: replace createGreetingV0 with createAnonymousGreetingV0.
-
-### v6.1.0
-
-- AuthenticationCommonBL:
-  - update output types of sendResetPasswordEmailV0ResponseZ and sendVerificationEmailV0ResponseZ.
-
-### 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:
-  - fix url in updateUserProfilePhotoV0.
-
-### v5.2.0
-
-- AuthenticationCommonBL:
-  - add updateUserProfilePhotoV0.
-  - rename getUserProfilePhoto to getUserProfilePhotoV0.
-
-### v5.1.0
-
-- AuthenticationCommonBL:
-  - add getUserProfilePhoto.
-
-### v5.0.0
-
-- AuthenticationCommonBL:
-  - change type for GetUserDetailsV0ResponseZ to make it compatible with latest changes.
-
-### v4.2.0
-
-- AuthenticationCommonBL:
-  - add logoutAppsV0.
-
-### v4.1.0
-
-- AuthenticationCommonBL:
-  - add logoutAllV0.
-
-### v4.0.0
-
-- AuthenticationCommonBL:
-  - change type for GetUserDetailsV0ResponseZ to make it compatible with latest changes.
-
-### v3.0.0
-
-- AuthenticationCommonBL:
-  - remove generateAccessTokenV0, logoutV0.
-
-### v2.0.1
-
-- use strictObject in zod.
-- export types in index file.
-
-### v2.0.0
-
-- remove UtilsCommonBL
-
-### v1.8.0
-
-- AuthenticationCommonBL:
-  - add types for deleteUserV0
-
-### v1.7.0
-
-- AuthenticationCommonBL:
-  - add types for logoutV0
-
-### v1.6.0
-
-- AuthenticationCommonBL:
-  - add types for getUserDetailsV0
-
-### v1.5.0
-
-- AuthenticationCommonBL:
-  - add types for updatePasswordV0
-
-### v1.4.0
-
-- AuthenticationCommonBL:
-  - bug fix in updateUsernameV0
-  - add types for updateUsernameV0
-
-### v1.3.0
-
-- add types in AuthenticationCommonBL:
-  - generateAccessTokenV0
-
-### v1.2.0
-
-- add types in greeting:
-  - createGreetingV0
-
-### v1.1.0
-
-- add AuthenticationCommonBL class with the following methods:
-  - logoutV0
-  - generateAccessTokenV0
-  - deleteUserV0
-  - updateUsernameV0
-  - updatePasswordV0
-  - getUserDetailsV0
-
-### v1.0.3
-
-- experimental release.
-
-### v1.0.2
-
-- replace user_id with accessToken from greeting -> createGreetingV0.
-
-### v1.0.1
-
-- remove app_id from greeting -> createGreetingV0.
-
-### v1.0.0
-
-- initial implementation.
-
+ 
 ## Feedback is appreciated. Thank you!

package/dist/authentication.d.ts

@@ -48,6 +48,7 @@ declare class AuthenticationCommonBL {
                     available: number;
                     generated_at: string;
                 } | null;
+                auth_providers: string[];
             };
         };
         log?: any;
@@ -97,7 +98,7 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    sendResetPasswordEmailV0(username: string, logErrors?: boolean): Promise<{
+    sendResetPasswordEmailV0(username: string, redirectUrl?: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             expires_at: string;
@@ -112,7 +113,7 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
-    sendVerificationEmailV0(accessToken: string, logErrors?: boolean): Promise<{
+    sendVerificationEmailV0(accessToken: string, redirectUrl?: string, logErrors?: boolean): Promise<{
         message: string | null;
         data: {
             expires_at: string;
@@ -143,5 +144,26 @@ declare class AuthenticationCommonBL {
         };
         log?: any;
     }>;
+    addSelfAuthProviderV0(accessToken: string, password: string, logErrors?: boolean): Promise<{
+        message: string | null;
+        data: {
+            main: string[];
+        };
+        log?: any;
+    }>;
+    addGoogleAuthProviderV0(accessToken: string, googleIdToken: string, logErrors?: boolean): Promise<{
+        message: string | null;
+        data: {
+            main: string[];
+        };
+        log?: any;
+    }>;
+    unlinkAuthProviderV0(accessToken: string, authProvider: string, logErrors?: boolean): Promise<{
+        message: string | null;
+        data: {
+            main: string[];
+        };
+        log?: any;
+    }>;
 }
 export { AuthenticationCommonBL };

package/dist/authentication.js

@@ -1,5 +1,5 @@
 import { fetchFileData, fetchJSONData } from "squarecommons";
-import { DeleteUserV0ResponseZ, GenerateAccountBackupCodeV0ResponseZ, GetUserDetailsV0ResponseZ, GetUserRecoveryMethodsV0ResponseZ, LogoutAllV0ResponseZ, LogoutAppsV0ResponseZ, SendResetPasswordEmailV0ResponseZ, SendVerificationEmailV0ResponseZ, UpdateProfileDetailsV0ResponseZ, UpdateUsernameV0ResponseZ, UpdateUserProfilePhotoV0ResponseZ, UpdateUserRecoveryMethodsV0ResponseZ, ValidateEmailVerificationCodeV0ResponseZ, } from "./types/AuthenticationResponses.js";
+import { DeleteUserV0ResponseZ, GenerateAccountBackupCodeV0ResponseZ, GetUserDetailsV0ResponseZ, GetUserRecoveryMethodsV0ResponseZ, LogoutAllV0ResponseZ, LogoutAppsV0ResponseZ, SendResetPasswordEmailV0ResponseZ, SendVerificationEmailV0ResponseZ, UpdateProfileDetailsV0ResponseZ, UpdateUsernameV0ResponseZ, UpdateUserProfilePhotoV0ResponseZ, UpdateUserRecoveryMethodsV0ResponseZ, ValidateEmailVerificationCodeV0ResponseZ, AddSelfAuthProviderV0ResponseZ, AddGoogleAuthProviderV0ResponseZ, UnlinkAuthProviderV0ResponseZ, } from "./types/AuthenticationResponses.js";
 class AuthenticationCommonBL {
     commonBLBaseURL;
     constructor(commonBLBaseURL = "http://localhost:10110") {
@@ -256,7 +256,7 @@ class AuthenticationCommonBL {
             throw error;
         }
     }
-    async sendResetPasswordEmailV0(username, logErrors = true) {
+    async sendResetPasswordEmailV0(username, redirectUrl, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -268,7 +268,7 @@ class AuthenticationCommonBL {
             // headers
             undefined, 
             // body
-            { username: username }, 
+            { username: username, redirect_url: redirectUrl }, 
             // query params
             undefined, 
             // credentials
@@ -315,7 +315,7 @@ class AuthenticationCommonBL {
             throw error;
         }
     }
-    async sendVerificationEmailV0(accessToken, logErrors = true) {
+    async sendVerificationEmailV0(accessToken, redirectUrl, logErrors = true) {
         try {
             const data = await fetchJSONData(
             // base url
@@ -327,7 +327,7 @@ class AuthenticationCommonBL {
             // headers
             { access_token: accessToken }, 
             // body
-            undefined, 
+            { redirect_url: redirectUrl }, 
             // query params
             undefined, 
             // credentials
@@ -390,5 +390,80 @@ class AuthenticationCommonBL {
             throw error;
         }
     }
+    async addSelfAuthProviderV0(accessToken, password, logErrors = true) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "add_self_auth_provider/v0", 
+            // method
+            "POST", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            { password: password }, 
+            // query params
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
+            return AddSelfAuthProviderV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async addGoogleAuthProviderV0(accessToken, googleIdToken, logErrors = true) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "add_google_auth_provider/v0", 
+            // method
+            "POST", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            { google_id_token: googleIdToken }, 
+            // query params
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
+            return AddGoogleAuthProviderV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async unlinkAuthProviderV0(accessToken, authProvider, logErrors = true) {
+        try {
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "unlink_auth_provider/v0", 
+            // method
+            "POST", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            { auth_provider: authProvider }, 
+            // query params
+            undefined, 
+            // credentials
+            undefined, 
+            // logErrors
+            logErrors);
+            return UnlinkAuthProviderV0ResponseZ.parse(data);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
 }
 export { AuthenticationCommonBL };

package/dist/types/AuthenticationResponses.d.ts

@@ -120,6 +120,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             }>>;
+            auth_providers: z.ZodArray<z.ZodString, "many">;
         }, "strict", z.ZodTypeAny, {
             user_id: string;
             username: string;
@@ -148,6 +149,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             } | null;
+            auth_providers: string[];
         }, {
             user_id: string;
             username: string;
@@ -176,6 +178,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             } | null;
+            auth_providers: string[];
         }>;
     }, "strict", z.ZodTypeAny, {
         main: {
@@ -206,6 +209,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             } | null;
+            auth_providers: string[];
         };
     }, {
         main: {
@@ -236,6 +240,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             } | null;
+            auth_providers: string[];
         };
     }>;
 }>, "strict", z.ZodTypeAny, {
@@ -269,6 +274,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             } | null;
+            auth_providers: string[];
         };
     };
     log?: any;
@@ -303,6 +309,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
                 available: number;
                 generated_at: string;
             } | null;
+            auth_providers: string[];
         };
     };
     log?: any;
@@ -724,4 +731,82 @@ declare const UpdateUserProfilePhotoV0ResponseZ: z.ZodObject<z.objectUtil.extend
     log?: any;
 }>;
 type UpdateUserProfilePhotoV0Response = z.infer<typeof UpdateUserProfilePhotoV0ResponseZ>;
-export { UpdateUsernameV0ResponseZ, UpdateUsernameV0Response, GetUserDetailsV0ResponseZ, GetUserDetailsV0Response, DeleteUserV0Response, DeleteUserV0ResponseZ, LogoutAllV0Response, LogoutAllV0ResponseZ, LogoutAppsV0Response, LogoutAppsV0ResponseZ, GenerateAccountBackupCodeV0Response, GenerateAccountBackupCodeV0ResponseZ, UpdateProfileDetailsV0ResponseZ, UpdateProfileDetailsV0Response, SendResetPasswordEmailV0ResponseZ, SendResetPasswordEmailV0Response, RecoveryMethodEnumZ, RecoveryMethodEnum, UpdateUserRecoveryMethodsV0ResponseZ, UpdateUserRecoveryMethodsV0Response, SendVerificationEmailV0ResponseZ, SendVerificationEmailV0Response, ValidateEmailVerificationCodeV0ResponseZ, ValidateEmailVerificationCodeV0Response, GetUserRecoveryMethodsV0ResponseZ, GetUserRecoveryMethodsV0Response, UpdateUserProfilePhotoV0ResponseZ, UpdateUserProfilePhotoV0Response, };
+declare const AddSelfAuthProviderV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        main: string[];
+    }, {
+        main: string[];
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: string[];
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: string[];
+    };
+    log?: any;
+}>;
+type AddSelfAuthProviderV0Response = z.infer<typeof AddSelfAuthProviderV0ResponseZ>;
+declare const AddGoogleAuthProviderV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        main: string[];
+    }, {
+        main: string[];
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: string[];
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: string[];
+    };
+    log?: any;
+}>;
+type AddGoogleAuthProviderV0Response = z.infer<typeof AddGoogleAuthProviderV0ResponseZ>;
+declare const UnlinkAuthProviderV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        main: string[];
+    }, {
+        main: string[];
+    }>;
+}>, "strict", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: string[];
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: string[];
+    };
+    log?: any;
+}>;
+type UnlinkAuthProviderV0Response = z.infer<typeof UnlinkAuthProviderV0ResponseZ>;
+export { UpdateUsernameV0ResponseZ, UpdateUsernameV0Response, GetUserDetailsV0ResponseZ, GetUserDetailsV0Response, DeleteUserV0Response, DeleteUserV0ResponseZ, LogoutAllV0Response, LogoutAllV0ResponseZ, LogoutAppsV0Response, LogoutAppsV0ResponseZ, GenerateAccountBackupCodeV0Response, GenerateAccountBackupCodeV0ResponseZ, UpdateProfileDetailsV0ResponseZ, UpdateProfileDetailsV0Response, SendResetPasswordEmailV0ResponseZ, SendResetPasswordEmailV0Response, RecoveryMethodEnumZ, RecoveryMethodEnum, UpdateUserRecoveryMethodsV0ResponseZ, UpdateUserRecoveryMethodsV0Response, SendVerificationEmailV0ResponseZ, SendVerificationEmailV0Response, ValidateEmailVerificationCodeV0ResponseZ, ValidateEmailVerificationCodeV0Response, GetUserRecoveryMethodsV0ResponseZ, GetUserRecoveryMethodsV0Response, UpdateUserProfilePhotoV0ResponseZ, UpdateUserProfilePhotoV0Response, AddSelfAuthProviderV0ResponseZ, AddSelfAuthProviderV0Response, AddGoogleAuthProviderV0ResponseZ, AddGoogleAuthProviderV0Response, UnlinkAuthProviderV0ResponseZ, UnlinkAuthProviderV0Response, };

package/dist/types/AuthenticationResponses.js

@@ -40,6 +40,7 @@ const GetUserDetailsV0ResponseZ = APIOutputZ.extend({
                 generated_at: z.string(),
             })
                 .nullable(),
+            auth_providers: z.array(z.string()),
         }),
     }),
 });
@@ -120,4 +121,19 @@ const UpdateUserProfilePhotoV0ResponseZ = APIOutputZ.extend({
         main: z.string().nullable(),
     }),
 });
-export { UpdateUsernameV0ResponseZ, GetUserDetailsV0ResponseZ, DeleteUserV0ResponseZ, LogoutAllV0ResponseZ, LogoutAppsV0ResponseZ, GenerateAccountBackupCodeV0ResponseZ, UpdateProfileDetailsV0ResponseZ, SendResetPasswordEmailV0ResponseZ, RecoveryMethodEnumZ, UpdateUserRecoveryMethodsV0ResponseZ, SendVerificationEmailV0ResponseZ, ValidateEmailVerificationCodeV0ResponseZ, GetUserRecoveryMethodsV0ResponseZ, UpdateUserProfilePhotoV0ResponseZ, };
+const AddSelfAuthProviderV0ResponseZ = APIOutputZ.extend({
+    data: z.strictObject({
+        main: z.array(z.string()),
+    }),
+});
+const AddGoogleAuthProviderV0ResponseZ = APIOutputZ.extend({
+    data: z.strictObject({
+        main: z.array(z.string()),
+    }),
+});
+const UnlinkAuthProviderV0ResponseZ = APIOutputZ.extend({
+    data: z.strictObject({
+        main: z.array(z.string()),
+    }),
+});
+export { UpdateUsernameV0ResponseZ, GetUserDetailsV0ResponseZ, DeleteUserV0ResponseZ, LogoutAllV0ResponseZ, LogoutAppsV0ResponseZ, GenerateAccountBackupCodeV0ResponseZ, UpdateProfileDetailsV0ResponseZ, SendResetPasswordEmailV0ResponseZ, RecoveryMethodEnumZ, UpdateUserRecoveryMethodsV0ResponseZ, SendVerificationEmailV0ResponseZ, ValidateEmailVerificationCodeV0ResponseZ, GetUserRecoveryMethodsV0ResponseZ, UpdateUserProfilePhotoV0ResponseZ, AddSelfAuthProviderV0ResponseZ, AddGoogleAuthProviderV0ResponseZ, UnlinkAuthProviderV0ResponseZ, };

package/package.json

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