squarecommonblhelper 1.1.0 → 1.3.0

package/README.md

@@ -15,6 +15,16 @@ helper for common bl for my projects.
 
 ## changelog
 
+### 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:

package/dist/authentication.d.ts

@@ -1,11 +1,39 @@
 declare class AuthenticationCommonBL {
     private commonBLBaseURL;
     constructor(commonBLBaseURL?: string);
-    logoutV0(refreshToken: string): Promise<import("squarecommons").APIOutput>;
-    generateAccessTokenV0(refreshToken: string): Promise<import("squarecommons").APIOutput>;
-    deleteUserV0(accessToken: string, password: string): Promise<import("squarecommons").APIOutput>;
-    updateUsernameV0(accessToken: string, newUsername: string): Promise<import("squarecommons").APIOutput>;
-    updatePasswordV0(accessToken: string, oldPassword: string, newPassword: string): Promise<import("squarecommons").APIOutput>;
-    getUserDetailsV0(accessToken: string): Promise<import("squarecommons").APIOutput>;
+    logoutV0(refreshToken: string): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
+    generateAccessTokenV0(refreshToken: string): Promise<{
+        message: string | null;
+        data: {
+            main: {
+                access_token: string;
+            };
+        };
+        log?: any;
+    }>;
+    deleteUserV0(accessToken: string, password: string): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
+    updateUsernameV0(accessToken: string, newUsername: string): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
+    updatePasswordV0(accessToken: string, oldPassword: string, newPassword: string): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
+    getUserDetailsV0(accessToken: string): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
 }
 export { AuthenticationCommonBL };

package/dist/authentication.js

@@ -1,4 +1,5 @@
 import { fetchJSONData } from "squarecommons";
+import { GenerateAccessTokenV0ResponseZ } from "./types/AuthenticationResponses.js";
 class AuthenticationCommonBL {
     commonBLBaseURL;
     constructor(commonBLBaseURL = "http://localhost:10110") {
@@ -40,7 +41,7 @@ class AuthenticationCommonBL {
             undefined, 
             // query params
             undefined);
-            return data;
+            return GenerateAccessTokenV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;

package/dist/greeting.d.ts

@@ -1,6 +1,19 @@
 declare class GreetingCommonBL {
     private commonBLBaseURL;
     constructor(commonBLBaseURL?: string);
-    createGreetingV0(greetingIsAnonymous: boolean, greetingAnonymousSenderName?: string, accessToken?: string, greetingText?: string): Promise<import("squarecommons").APIOutput>;
+    createGreetingV0(greetingIsAnonymous: boolean, greetingAnonymousSenderName?: string, accessToken?: string, greetingText?: string): Promise<{
+        message: string | null;
+        data: {
+            main: {
+                greeting_anonymous_sender_name: string | null;
+                user_id: string | null;
+                greeting_id: number;
+                greeting_datetime: string;
+                greeting_is_anonymous: boolean;
+                greeting_text: string | null;
+            }[];
+        };
+        log?: any;
+    }>;
 }
 export { GreetingCommonBL };

package/dist/greeting.js

@@ -1,4 +1,5 @@
 import { fetchJSONData } from "squarecommons";
+import { CreateGreetingV0ResponseZ } from "./types/GreetingResponses.js";
 class GreetingCommonBL {
     commonBLBaseURL;
     constructor(commonBLBaseURL = "http://localhost:10110") {
@@ -20,7 +21,7 @@ class GreetingCommonBL {
                 greeting_anonymous_sender_name: greetingAnonymousSenderName,
                 greeting_text: greetingText,
             });
-            return data;
+            return CreateGreetingV0ResponseZ.parse(data);
         }
         catch (error) {
             throw error;

package/dist/types/AuthenticationResponses.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+declare const GenerateAccessTokenV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodObject<{
+            access_token: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            access_token: string;
+        }, {
+            access_token: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        main: {
+            access_token: string;
+        };
+    }, {
+        main: {
+            access_token: string;
+        };
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: {
+            access_token: string;
+        };
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: {
+            access_token: string;
+        };
+    };
+    log?: any;
+}>;
+type GenerateAccessTokenV0Response = z.infer<typeof GenerateAccessTokenV0ResponseZ>;
+export { GenerateAccessTokenV0ResponseZ, GenerateAccessTokenV0Response };

package/dist/types/AuthenticationResponses.js

@@ -0,0 +1,10 @@
+import { APIOutputZ } from "squarecommons";
+import { z } from "zod";
+const GenerateAccessTokenV0ResponseZ = APIOutputZ.extend({
+    data: z.object({
+        main: z.object({
+            access_token: z.string(),
+        }),
+    }),
+});
+export { GenerateAccessTokenV0ResponseZ };

package/dist/types/GreetingResponses.d.ts

@@ -0,0 +1,77 @@
+import { z } from "zod";
+declare const CreateGreetingV0ResponseZ: z.ZodObject<z.objectUtil.extendShape<{
+    data: z.ZodAny;
+    message: z.ZodNullable<z.ZodString>;
+    log: z.ZodAny;
+}, {
+    data: z.ZodObject<{
+        main: z.ZodArray<z.ZodObject<{
+            greeting_anonymous_sender_name: z.ZodNullable<z.ZodString>;
+            user_id: z.ZodNullable<z.ZodString>;
+            greeting_id: z.ZodNumber;
+            greeting_datetime: z.ZodString;
+            greeting_is_anonymous: z.ZodBoolean;
+            greeting_text: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            greeting_anonymous_sender_name: string | null;
+            user_id: string | null;
+            greeting_id: number;
+            greeting_datetime: string;
+            greeting_is_anonymous: boolean;
+            greeting_text: string | null;
+        }, {
+            greeting_anonymous_sender_name: string | null;
+            user_id: string | null;
+            greeting_id: number;
+            greeting_datetime: string;
+            greeting_is_anonymous: boolean;
+            greeting_text: string | null;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        main: {
+            greeting_anonymous_sender_name: string | null;
+            user_id: string | null;
+            greeting_id: number;
+            greeting_datetime: string;
+            greeting_is_anonymous: boolean;
+            greeting_text: string | null;
+        }[];
+    }, {
+        main: {
+            greeting_anonymous_sender_name: string | null;
+            user_id: string | null;
+            greeting_id: number;
+            greeting_datetime: string;
+            greeting_is_anonymous: boolean;
+            greeting_text: string | null;
+        }[];
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    message: string | null;
+    data: {
+        main: {
+            greeting_anonymous_sender_name: string | null;
+            user_id: string | null;
+            greeting_id: number;
+            greeting_datetime: string;
+            greeting_is_anonymous: boolean;
+            greeting_text: string | null;
+        }[];
+    };
+    log?: any;
+}, {
+    message: string | null;
+    data: {
+        main: {
+            greeting_anonymous_sender_name: string | null;
+            user_id: string | null;
+            greeting_id: number;
+            greeting_datetime: string;
+            greeting_is_anonymous: boolean;
+            greeting_text: string | null;
+        }[];
+    };
+    log?: any;
+}>;
+type CreateGreetingV0Response = z.infer<typeof CreateGreetingV0ResponseZ>;
+export { CreateGreetingV0ResponseZ, CreateGreetingV0Response };

package/dist/types/GreetingResponses.js

@@ -0,0 +1,15 @@
+import { APIOutputZ } from "squarecommons";
+import { z } from "zod";
+const CreateGreetingV0ResponseZ = APIOutputZ.extend({
+    data: z.object({
+        main: z.array(z.object({
+            greeting_anonymous_sender_name: z.string().nullable(),
+            user_id: z.string().nullable(),
+            greeting_id: z.number(),
+            greeting_datetime: z.string(),
+            greeting_is_anonymous: z.boolean(),
+            greeting_text: z.string().nullable(),
+        })),
+    }),
+});
+export { CreateGreetingV0ResponseZ };

package/dist/utils.d.ts

@@ -1,6 +1,10 @@
 declare class UtilsCommonBL {
     private commonBLBaseURL;
     constructor(commonBLBaseURL?: string);
-    getAppIdV0(appName: string): Promise<import("squarecommons").APIOutput>;
+    getAppIdV0(appName: string): Promise<{
+        message: string | null;
+        data?: any;
+        log?: any;
+    }>;
 }
 export { UtilsCommonBL };

package/example.js

@@ -11,4 +11,6 @@ let utilsCommonBL = new UtilsCommonBL();
 console.log(await utilsCommonBL.getAppIdV0("test"));
 
 let authenticationCommonBL = new AuthenticationCommonBL();
-console.log(await authenticationCommonBL.generateAccessTokenV0(""));
+console.log(
+  await authenticationCommonBL.generateAccessTokenV0("dummy_refresh_token")
+);

package/package.json

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