squarecommonblhelper 11.2.0 → 11.3.0

package/README.md

@@ -1,247 +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.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;
@@ -135,11 +136,11 @@ declare class AuthenticationCommonBL {
                 total: number;
                 available: number;
                 generated_at: string;
-            };
+            } | null;
             email_recovery_details: {
                 expires_at: string;
                 cooldown_reset_at: string;
-            };
+            } | null;
         };
         log?: any;
     }>;

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;
@@ -620,7 +627,7 @@ 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<{
+        email_recovery_details: z.ZodNullable<z.ZodObject<{
             expires_at: z.ZodString;
             cooldown_reset_at: z.ZodString;
         }, "strict", z.ZodTypeAny, {
@@ -629,8 +636,8 @@ declare const GetUserRecoveryMethodsV0ResponseZ: z.ZodObject<z.objectUtil.extend
         }, {
             expires_at: string;
             cooldown_reset_at: string;
-        }>;
-        backup_code_details: z.ZodObject<{
+        }>>;
+        backup_code_details: z.ZodNullable<z.ZodObject<{
             total: z.ZodNumber;
             available: z.ZodNumber;
             generated_at: z.ZodString;
@@ -642,29 +649,29 @@ declare const GetUserRecoveryMethodsV0ResponseZ: z.ZodObject<z.objectUtil.extend
             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;
-        };
+        } | null;
         email_recovery_details: {
             expires_at: string;
             cooldown_reset_at: string;
-        };
+        } | null;
     }, {
         main: Partial<Record<"EMAIL" | "BACKUP_CODE", boolean>>;
         backup_code_details: {
             total: number;
             available: number;
             generated_at: string;
-        };
+        } | null;
         email_recovery_details: {
             expires_at: string;
             cooldown_reset_at: string;
-        };
+        } | null;
     }>;
 }>, "strict", z.ZodTypeAny, {
     message: string | null;
@@ -674,11 +681,11 @@ declare const GetUserRecoveryMethodsV0ResponseZ: z.ZodObject<z.objectUtil.extend
             total: number;
             available: number;
             generated_at: string;
-        };
+        } | null;
         email_recovery_details: {
             expires_at: string;
             cooldown_reset_at: string;
-        };
+        } | null;
     };
     log?: any;
 }, {
@@ -689,11 +696,11 @@ declare const GetUserRecoveryMethodsV0ResponseZ: z.ZodObject<z.objectUtil.extend
             total: number;
             available: number;
             generated_at: string;
-        };
+        } | null;
         email_recovery_details: {
             expires_at: string;
             cooldown_reset_at: string;
-        };
+        } | null;
     };
     log?: any;
 }>;

package/dist/types/AuthenticationResponses.js

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

package/package.json

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