squarecommonblhelper 5.0.0 → 5.2.0

package/README.md

@@ -15,6 +15,17 @@ helper for common bl for my projects.
 
 ## changelog
 
+### v5.2.0
+
+- AuthenticationCommonBL:
+  - add updateUserProfilePhotoV0.
+  - rename getUserProfilePhoto to getUserProfilePhotoV0.
+
+### v5.1.0
+
+- AuthenticationCommonBL:
+  - add getUserProfilePhoto.
+
 ### v5.0.0
 
 - AuthenticationCommonBL:

package/dist/authentication.d.ts

@@ -54,5 +54,11 @@ declare class AuthenticationCommonBL {
         data: null;
         log?: any;
     }>;
+    getUserProfilePhotoV0(accessToken: string): Promise<Blob>;
+    updateUserProfilePhotoV0(accessToken: string, profilePhoto?: File): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
 }
 export { AuthenticationCommonBL };

package/dist/authentication.js

@@ -1,4 +1,4 @@
-import { fetchJSONData } from "squarecommons";
+import { fetchFileData, fetchJSONData } from "squarecommons";
 import { DeleteUserV0Z, GetUserDetailsV0ResponseZ, LogoutAllV0Z, LogoutAppsV0Z, UpdatePasswordV0ResponseZ, UpdateUsernameV0ResponseZ, } from "./types/AuthenticationResponses.js";
 class AuthenticationCommonBL {
     commonBLBaseURL;
@@ -131,5 +131,61 @@ class AuthenticationCommonBL {
             throw error;
         }
     }
+    async getUserProfilePhotoV0(accessToken) {
+        try {
+            const data = await fetchFileData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "get_user_profile_photo/v0", 
+            // method
+            "GET", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            undefined, 
+            // query params
+            undefined);
+            return data;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async updateUserProfilePhotoV0(accessToken, profilePhoto) {
+        try {
+            const MAX_SIZE = 5 * 1024 * 1024; // 5 MiB
+            const ALLOWED_TYPES = ['image/png', 'image/jpeg'];
+            if (profilePhoto) {
+                if (!ALLOWED_TYPES.includes(profilePhoto.type)) {
+                    throw new Error('invalid file type: only png or jpeg allowed');
+                }
+                if (profilePhoto.size > MAX_SIZE) {
+                    throw new Error('file too large: must be under 5 MiB');
+                }
+            }
+            const formData = new FormData();
+            if (profilePhoto) {
+                formData.append("profile_photo", profilePhoto);
+            }
+            const data = await fetchJSONData(
+            // base url
+            this.commonBLBaseURL, 
+            // endpoint
+            "update_user_profile_photo/v0", 
+            // method
+            "PATCH", 
+            // headers
+            { access_token: accessToken }, 
+            // body
+            formData, 
+            // query params
+            undefined);
+            return data;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
 }
 export { AuthenticationCommonBL };

package/dist/types/AuthenticationResponses.d.ts

@@ -26,7 +26,7 @@ declare const UpdateUsernameV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
             username: string;
         };
     }>;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: {
         main: {
@@ -52,7 +52,7 @@ declare const UpdatePasswordV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
     log: z.ZodAny;
 }, {
     data: z.ZodNull;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: null;
     log?: any;
@@ -176,7 +176,7 @@ declare const GetUserDetailsV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
             }[];
         };
     }>;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: {
         main: {
@@ -228,7 +228,7 @@ declare const DeleteUserV0Z: z.ZodObject<z.objectUtil.extendShape<{
     log: z.ZodAny;
 }, {
     data: z.ZodNull;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: null;
     log?: any;
@@ -244,7 +244,7 @@ declare const LogoutAllV0Z: z.ZodObject<z.objectUtil.extendShape<{
     log: z.ZodAny;
 }, {
     data: z.ZodNull;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: null;
     log?: any;
@@ -260,7 +260,7 @@ declare const LogoutAppsV0Z: z.ZodObject<z.objectUtil.extendShape<{
     log: z.ZodAny;
 }, {
     data: z.ZodNull;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: null;
     log?: any;

package/dist/types/GreetingResponses.d.ts

@@ -46,7 +46,7 @@ declare const CreateGreetingV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
             greeting_text: string | null;
         }[];
     }>;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     message: string | null;
     data: {
         main: {

package/example.js

@@ -28,3 +28,4 @@ console.log(await authenticationCommonBL.logoutAllV0("dummy_access_token"));
 console.log(
   await authenticationCommonBL.logoutAppsV0("dummy_access_token", ["test"])
 );
+console.log(await authenticationCommonBL.getProfilePhoto("dummy_access_token"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarecommonblhelper",
-  "version": "5.0.0",
+  "version": "5.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.0.0",
+    "squarecommons": "^2.3.0",
     "zod": "^3.24.1"
   }
 }