vms-nest-api-document 1.0.0

package/dist/core/apiCall.d.ts

@@ -0,0 +1,6 @@
+declare const apiGet: <T>(url: string, params?: Record<string, unknown>) => Promise<T>;
+declare const apiPost: <T, D>(url: string, data: D) => Promise<T>;
+declare const apiPatch: <T, D>(url: string, data: D) => Promise<T>;
+declare const apiDelete: <T>(url: string) => Promise<T>;
+
+export { apiDelete, apiGet, apiPatch, apiPost };

package/dist/core/apiCall.js

@@ -0,0 +1,33 @@
+// src/core/sdk-config.ts
+var KEY = "__vms_axios_instance__";
+var getAxiosInstance = () => {
+  const instance = globalThis[KEY];
+  if (!instance) {
+    throw new Error("\u274C Axios instance not configured. Call setAxiosInstance() first.");
+  }
+  return instance;
+};
+
+// src/core/apiCall.ts
+var apiGet = async (url, params) => {
+  const response = await getAxiosInstance().get(url, { params });
+  return response.data;
+};
+var apiPost = async (url, data) => {
+  const response = await getAxiosInstance().post(url, data);
+  return response.data;
+};
+var apiPatch = async (url, data) => {
+  const response = await getAxiosInstance().patch(url, data);
+  return response.data;
+};
+var apiDelete = async (url) => {
+  const response = await getAxiosInstance().delete(url);
+  return response.data;
+};
+export {
+  apiDelete,
+  apiGet,
+  apiPatch,
+  apiPost
+};

package/dist/core/sdk-config.d.ts

@@ -0,0 +1,6 @@
+import { AxiosInstance } from 'axios';
+
+declare const setAxiosInstance: (instance: AxiosInstance) => void;
+declare const getAxiosInstance: () => AxiosInstance;
+
+export { getAxiosInstance, setAxiosInstance };

package/dist/core/sdk-config.js

@@ -0,0 +1,17 @@
+// src/core/sdk-config.ts
+var KEY = "__vms_axios_instance__";
+var setAxiosInstance = (instance) => {
+  globalThis[KEY] = instance;
+  console.log("\u2705 Axios instance set globally");
+};
+var getAxiosInstance = () => {
+  const instance = globalThis[KEY];
+  if (!instance) {
+    throw new Error("\u274C Axios instance not configured. Call setAxiosInstance() first.");
+  }
+  return instance;
+};
+export {
+  getAxiosInstance,
+  setAxiosInstance
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/services/account/analytics/user_login_analytics_service.d.ts

@@ -0,0 +1,80 @@
+import { LoginFrom, PAGING } from '../../../core/Enums.js';
+import { SBR, FBR } from '../../../core/BaseResponse.js';
+import { z } from 'zod';
+
+interface UserLoginAnalytics extends Record<string, unknown> {
+    id: string;
+    user_id: string;
+    organisation_id: string;
+    country_id: string;
+    login_from: LoginFrom;
+    os_details: Record<string, unknown>;
+    ip_details: Record<string, unknown>;
+    added_date_time?: string;
+}
+declare const UserLoginAnalyticsSchema: z.ZodObject<{
+    user_id: z.ZodEffects<z.ZodString, string, string>;
+    organisation_id: z.ZodEffects<z.ZodString, string, string>;
+    login_from: z.ZodType<LoginFrom, z.ZodTypeDef, LoginFrom>;
+    os_details: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    ip_details: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    country_id: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    user_id: string;
+    organisation_id: string;
+    country_id: string;
+    login_from: LoginFrom;
+    os_details: Record<string, any>;
+    ip_details: Record<string, any>;
+}, {
+    user_id: string;
+    organisation_id: string;
+    country_id: string;
+    login_from: LoginFrom;
+    os_details?: Record<string, any> | undefined;
+    ip_details?: Record<string, any> | undefined;
+}>;
+type UserLoginAnalyticsDTO = z.infer<typeof UserLoginAnalyticsSchema>;
+declare const UserLoginAnalyticsQuerySchema: z.ZodObject<{
+    search: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    paging: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof PAGING>>>;
+    page_count: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    page_index: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    login_from: z.ZodType<LoginFrom, z.ZodTypeDef, LoginFrom>;
+    date_format_id: z.ZodEffects<z.ZodString, string, string>;
+    time_zone_id: z.ZodEffects<z.ZodString, string, string>;
+} & {
+    user_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    organisation_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    country_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    login_from: LoginFrom;
+    search: string;
+    paging: PAGING;
+    page_count: number;
+    page_index: number;
+    date_format_id: string;
+    time_zone_id: string;
+    user_ids: string[];
+    organisation_ids: string[];
+    country_ids: string[];
+}, {
+    login_from: LoginFrom;
+    date_format_id: string;
+    time_zone_id: string;
+    search?: string | undefined;
+    paging?: PAGING | undefined;
+    page_count?: unknown;
+    page_index?: unknown;
+    user_ids?: string[] | undefined;
+    organisation_ids?: string[] | undefined;
+    country_ids?: string[] | undefined;
+}>;
+type UserLoginAnalyticsQueryDTO = z.infer<typeof UserLoginAnalyticsQuerySchema>;
+declare const toUserLoginAnalyticsPayload: (analytics: UserLoginAnalytics) => UserLoginAnalyticsDTO;
+declare const newUserLoginAnalyticsPayload: () => UserLoginAnalyticsDTO;
+declare const findUserLoginAnalytics: (data: UserLoginAnalyticsQueryDTO) => Promise<FBR<UserLoginAnalytics[]>>;
+declare const createUserLoginAnalytics: (data: UserLoginAnalyticsDTO) => Promise<SBR>;
+declare const deleteUserLoginAnalytics: (id: string) => Promise<SBR>;
+
+export { type UserLoginAnalytics, type UserLoginAnalyticsDTO, type UserLoginAnalyticsQueryDTO, UserLoginAnalyticsQuerySchema, UserLoginAnalyticsSchema, createUserLoginAnalytics, deleteUserLoginAnalytics, findUserLoginAnalytics, newUserLoginAnalyticsPayload, toUserLoginAnalyticsPayload };

package/dist/services/account/analytics/user_login_analytics_service.js

@@ -0,0 +1,294 @@
+// src/core/sdk-config.ts
+var KEY = "__vms_axios_instance__";
+var getAxiosInstance = () => {
+  const instance = globalThis[KEY];
+  if (!instance) {
+    throw new Error("\u274C Axios instance not configured. Call setAxiosInstance() first.");
+  }
+  return instance;
+};
+
+// src/core/apiCall.ts
+var apiPost = async (url, data) => {
+  const response = await getAxiosInstance().post(url, data);
+  return response.data;
+};
+var apiDelete = async (url) => {
+  const response = await getAxiosInstance().delete(url);
+  return response.data;
+};
+
+// src/services/account/analytics/user_login_analytics_service.ts
+import { z as z3 } from "zod";
+
+// src/zod_utils/zod_utils.ts
+import { z } from "zod";
+
+// src/core/BaseResponse.ts
+var r_log = (data = {}) => {
+  return data;
+};
+
+// src/zod_utils/zod_utils.ts
+var handleNullOrUndefined = (value) => typeof value === "string" ? value : "";
+var stringMandatory = (fieldName, min = 1, max = 100) => {
+  const schema = z.string().trim().min(min, `${fieldName} must be at least ${min} characters.`).max(max, `${fieldName} must be at most ${max} characters.`).nonempty(`${fieldName} is required.`).transform(handleNullOrUndefined);
+  return schema;
+};
+var stringOptional = (fieldName, min = 0, max = 255, defaultValue = "") => {
+  const schema = z.string().trim().min(min, `${fieldName} must be at least ${min} characters.`).max(max, `${fieldName} must be at most ${max} characters.`).transform(handleNullOrUndefined).default(defaultValue);
+  return schema;
+};
+var stringArrayOptional = (fieldName, min = 0, max = 100, defaultValue = [], unique = false) => {
+  const schema = z.array(z.string().trim(), {
+    invalid_type_error: `${fieldName} must be an array of strings.`
+  }).min(min, `${fieldName} must contain at least ${min} items.`).max(max, `${fieldName} must contain at most ${max} items.`);
+  if (unique) {
+    schema.refine(
+      (arr) => new Set(arr).size === arr.length,
+      `${fieldName} must contain unique values.`
+    );
+  }
+  return schema.optional().default(defaultValue);
+};
+var numberOptional = (fieldName, min = 0, max = 1e14, defaultValue = 0) => {
+  return z.preprocess(
+    (val) => typeof val === "string" && val.trim() !== "" ? Number(val) : val,
+    z.number({ invalid_type_error: `${fieldName} must be a number.` }).min(min, `${fieldName} must be at least ${min}.`).max(max, `${fieldName} must be at most ${max}.`).optional().default(defaultValue)
+  );
+};
+var enumMandatory = (fieldName, enumType, defaultValue) => {
+  return z.union([
+    z.nativeEnum(enumType, {
+      invalid_type_error: `${fieldName} should be one of the following values: ${Object.values(
+        enumType
+      ).join(", ")}.`
+    }),
+    z.string().refine((val) => Object.values(enumType).includes(val), {
+      message: `${fieldName} should be one of the following values: ${Object.values(
+        enumType
+      ).join(", ")}.`
+    })
+  ]).default(defaultValue).refine((val) => val !== "", {
+    message: `Please select ${fieldName}.`
+  });
+};
+var enumOptional = (fieldName, enumType, defaultValue) => {
+  return z.nativeEnum(enumType, {
+    invalid_type_error: `${fieldName} must be an array containing only the following values: ${Object.values(
+      enumType
+    ).join(", ")}.`
+  }).optional().default(() => defaultValue);
+};
+var getAllEnums = (enumType) => {
+  return Object.values(enumType);
+};
+var enumArrayOptional = (fieldName, enumType, defaultValue = getAllEnums(enumType), min = 0, max = 100, unique = false) => {
+  const schema = z.array(z.nativeEnum(enumType), {
+    invalid_type_error: `${fieldName} must be an array containing only the following values: ${Object.values(
+      enumType
+    ).join(", ")}.`
+  }).min(min, `${fieldName} must contain at least ${min} items.`).max(max, `${fieldName} must contain at most ${max} items.`);
+  if (unique) {
+    schema.refine(
+      (arr) => new Set(arr).size === arr.length,
+      `${fieldName} must contain unique values.`
+    );
+  }
+  return schema.optional().default(() => defaultValue);
+};
+var dynamicJsonSchema = (fieldName, defaultValue = {}) => z.record(z.any()).optional().default(() => defaultValue);
+var single_select_optional = (fieldName) => {
+  r_log(fieldName);
+  const schema = z.string().trim().transform(handleNullOrUndefined);
+  return schema;
+};
+var multi_select_optional = (fieldName, max = 1e3, defaultValue = []) => {
+  const schema = z.array(
+    z.string({
+      invalid_type_error: `${fieldName} must be an array of strings.`
+    })
+  ).max(
+    max,
+    `Please select at most ${max} ${fieldName}${max > 1 ? "s" : ""}.`
+  );
+  return schema.optional().default(defaultValue);
+};
+
+// src/zod_utils/zod_base_schema.ts
+import { z as z2 } from "zod";
+
+// src/core/Enums.ts
+var PAGING = /* @__PURE__ */ ((PAGING2) => {
+  PAGING2["Yes"] = "Yes";
+  PAGING2["No"] = "No";
+  return PAGING2;
+})(PAGING || {});
+var LoadParents = /* @__PURE__ */ ((LoadParents2) => {
+  LoadParents2["Yes"] = "Yes";
+  LoadParents2["No"] = "No";
+  LoadParents2["Custom"] = "Custom";
+  return LoadParents2;
+})(LoadParents || {});
+var LoadChild = /* @__PURE__ */ ((LoadChild2) => {
+  LoadChild2["No"] = "No";
+  LoadChild2["Yes"] = "Yes";
+  LoadChild2["Count"] = "Count";
+  LoadChild2["Custom"] = "Custom";
+  LoadChild2["Direct"] = "Direct";
+  return LoadChild2;
+})(LoadChild || {});
+var LoadChildCount = /* @__PURE__ */ ((LoadChildCount2) => {
+  LoadChildCount2["No"] = "No";
+  LoadChildCount2["Yes"] = "Yes";
+  LoadChildCount2["Custom"] = "Custom";
+  return LoadChildCount2;
+})(LoadChildCount || {});
+var OrderBy = /* @__PURE__ */ ((OrderBy2) => {
+  OrderBy2["asc"] = "asc";
+  OrderBy2["desc"] = "desc";
+  return OrderBy2;
+})(OrderBy || {});
+var LoginFrom = /* @__PURE__ */ ((LoginFrom2) => {
+  LoginFrom2["Web"] = "Web";
+  LoginFrom2["Android"] = "Android";
+  LoginFrom2["IPhone"] = "IPhone";
+  LoginFrom2["AndroidPWA"] = "AndroidPWA";
+  LoginFrom2["iOSPWA"] = "iOSPWA";
+  return LoginFrom2;
+})(LoginFrom || {});
+var Status = /* @__PURE__ */ ((Status2) => {
+  Status2["Active"] = "Active";
+  Status2["Inactive"] = "Inactive";
+  return Status2;
+})(Status || {});
+var FileType = /* @__PURE__ */ ((FileType2) => {
+  FileType2["NoFile"] = "NoFile";
+  FileType2["Image"] = "Image";
+  FileType2["Video"] = "Video";
+  FileType2["PDF"] = "PDF";
+  FileType2["Excel"] = "Excel";
+  return FileType2;
+})(FileType || {});
+var YesNo = /* @__PURE__ */ ((YesNo2) => {
+  YesNo2["Yes"] = "Yes";
+  YesNo2["No"] = "No";
+  return YesNo2;
+})(YesNo || {});
+
+// src/zod_utils/zod_base_schema.ts
+var OrderBySchema = z2.array(
+  z2.object({
+    name: stringMandatory("Order Field Name", 0, 255),
+    field: stringMandatory("Order Field Name", 0, 255),
+    direction: enumMandatory("Order Direction", OrderBy, "asc" /* asc */)
+  })
+);
+var BaseFileSchema = z2.object({
+  usage_type: stringMandatory("Usage Type", 3, 100),
+  file_type: enumMandatory("File Type", FileType, "Image" /* Image */),
+  file_url: stringOptional("File URL", 0, 300),
+  file_key: stringOptional("File Key", 0, 300),
+  file_name: stringOptional("File Name", 0, 300),
+  file_description: stringOptional("File Description", 0, 2e3),
+  file_size: numberOptional("File Size"),
+  file_metadata: dynamicJsonSchema("File Metadata", {}),
+  status: enumMandatory("Status", Status, "Active" /* Active */)
+});
+var BaseQuerySchema = z2.object({
+  search: stringOptional("Search", 0, 255, ""),
+  status: enumArrayOptional("Status", Status, getAllEnums(Status), 0, 10, true),
+  paging: enumOptional("Paging", PAGING, "Yes" /* Yes */),
+  page_count: numberOptional("Page Count", 0, 1e3, 100),
+  page_index: numberOptional("Page Index", 0, 1e3, 0),
+  load_parents: enumOptional("Load Parents", LoadParents, "No" /* No */),
+  load_parents_list: stringArrayOptional("Load Parents List"),
+  load_child: enumOptional("Load Child", LoadChild, "No" /* No */),
+  load_child_list: stringArrayOptional("Load Child List"),
+  load_child_count: enumOptional(
+    "Load Child",
+    LoadChildCount,
+    "No" /* No */
+  ),
+  load_child_count_list: stringArrayOptional("Load Child List"),
+  include_details: dynamicJsonSchema("Include Details", {}),
+  where_relations: dynamicJsonSchema("Where Relations", {}),
+  order_by: OrderBySchema.optional().default([]),
+  include_master_data: enumOptional("Include Master Data", YesNo, "No" /* No */),
+  date_format_id: single_select_optional("MasterMainDateFormat"),
+  time_zone_id: single_select_optional("MasterMainTimeZone")
+});
+var FilePresignedUrlSchema = z2.object({
+  file_name: stringMandatory("File Name", 1, 255),
+  file_type: enumMandatory("File Type", FileType, "Image" /* Image */)
+});
+var MongoBaseQuerySchema = z2.object({
+  search: stringOptional("Search", 0, 255, ""),
+  paging: enumOptional("Paging", PAGING, "Yes" /* Yes */),
+  page_count: numberOptional("Page Count", 0, 1e3, 100),
+  page_index: numberOptional("Page Index", 0, 1e3, 0),
+  login_from: enumMandatory("Login From", LoginFrom, "Web" /* Web */),
+  date_format_id: single_select_optional("MasterMainDateFormat"),
+  // ✅ Single-selection -> MasterMainDateFormat
+  time_zone_id: single_select_optional("MasterMainTimeZone")
+  // ✅ Single-selection -> MasterMainTimeZone
+});
+
+// src/services/account/analytics/user_login_analytics_service.ts
+var URL = "analytics/user_login_analytics";
+var ENDPOINTS = {
+  find: `${URL}/search`,
+  create: URL,
+  delete: (id) => `${URL}/${id}`
+};
+var UserLoginAnalyticsSchema = z3.object({
+  user_id: stringMandatory("User", 3, 100),
+  organisation_id: stringMandatory("Organisation", 3, 100),
+  login_from: enumMandatory("Status", LoginFrom, "Web" /* Web */),
+  os_details: dynamicJsonSchema("OS Details", {}),
+  ip_details: dynamicJsonSchema("IP Details", {}),
+  country_id: stringMandatory("Country", 2, 100)
+  // ✅ Country ID
+});
+var UserLoginAnalyticsQuerySchema = MongoBaseQuerySchema.extend({
+  user_ids: multi_select_optional("User"),
+  organisation_ids: multi_select_optional("Organisation"),
+  country_ids: multi_select_optional("Country")
+});
+var toUserLoginAnalyticsPayload = (analytics) => ({
+  user_id: analytics.user_id,
+  organisation_id: analytics.organisation_id,
+  login_from: analytics.login_from,
+  os_details: analytics.os_details,
+  ip_details: analytics.ip_details,
+  country_id: analytics.country_id
+});
+var newUserLoginAnalyticsPayload = () => ({
+  user_id: "",
+  organisation_id: "",
+  login_from: "Web" /* Web */,
+  os_details: {},
+  ip_details: {},
+  country_id: ""
+});
+var findUserLoginAnalytics = async (data) => {
+  return apiPost(
+    ENDPOINTS.find,
+    data
+  );
+};
+var createUserLoginAnalytics = async (data) => {
+  return apiPost(ENDPOINTS.create, data);
+};
+var deleteUserLoginAnalytics = async (id) => {
+  return apiDelete(ENDPOINTS.delete(id));
+};
+export {
+  UserLoginAnalyticsQuerySchema,
+  UserLoginAnalyticsSchema,
+  createUserLoginAnalytics,
+  deleteUserLoginAnalytics,
+  findUserLoginAnalytics,
+  newUserLoginAnalyticsPayload,
+  toUserLoginAnalyticsPayload
+};

package/dist/services/account/analytics/user_page_analytics_service.d.ts

@@ -0,0 +1,73 @@
+import { PAGING, LoginFrom } from '../../../core/Enums.js';
+import { SBR, FBR } from '../../../core/BaseResponse.js';
+import { z } from 'zod';
+
+interface UserPageAnalytics extends Record<string, unknown> {
+    id: string;
+    user_id: string;
+    organisation_id: string;
+    page: string;
+    sub_module: string;
+    main_module: string;
+    added_date_time?: string;
+}
+declare const UserPageAnalyticsSchema: z.ZodObject<{
+    user_id: z.ZodEffects<z.ZodString, string, string>;
+    organisation_id: z.ZodEffects<z.ZodString, string, string>;
+    page: z.ZodEffects<z.ZodString, string, string>;
+    sub_module: z.ZodEffects<z.ZodString, string, string>;
+    main_module: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    user_id: string;
+    organisation_id: string;
+    page: string;
+    sub_module: string;
+    main_module: string;
+}, {
+    user_id: string;
+    organisation_id: string;
+    page: string;
+    sub_module: string;
+    main_module: string;
+}>;
+type UserPageAnalyticsDTO = z.infer<typeof UserPageAnalyticsSchema>;
+declare const UserPageAnalyticsQuerySchema: z.ZodObject<{
+    search: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    paging: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof PAGING>>>;
+    page_count: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    page_index: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    login_from: z.ZodType<LoginFrom, z.ZodTypeDef, LoginFrom>;
+    date_format_id: z.ZodEffects<z.ZodString, string, string>;
+    time_zone_id: z.ZodEffects<z.ZodString, string, string>;
+} & {
+    user_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    organisation_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    login_from: LoginFrom;
+    search: string;
+    paging: PAGING;
+    page_count: number;
+    page_index: number;
+    date_format_id: string;
+    time_zone_id: string;
+    user_ids: string[];
+    organisation_ids: string[];
+}, {
+    login_from: LoginFrom;
+    date_format_id: string;
+    time_zone_id: string;
+    search?: string | undefined;
+    paging?: PAGING | undefined;
+    page_count?: unknown;
+    page_index?: unknown;
+    user_ids?: string[] | undefined;
+    organisation_ids?: string[] | undefined;
+}>;
+type UserPageAnalyticsQueryDTO = z.infer<typeof UserPageAnalyticsQuerySchema>;
+declare const toUserPageAnalyticsPayload: (analytics: UserPageAnalytics) => UserPageAnalyticsDTO;
+declare const newUserPageAnalyticsPayload: () => UserPageAnalyticsDTO;
+declare const findUserPageAnalytics: (data: UserPageAnalyticsQueryDTO) => Promise<FBR<UserPageAnalytics[]>>;
+declare const createUserPageAnalytics: (data: UserPageAnalyticsDTO) => Promise<SBR>;
+declare const deleteUserPageAnalytics: (id: string) => Promise<SBR>;
+
+export { type UserPageAnalytics, type UserPageAnalyticsDTO, type UserPageAnalyticsQueryDTO, UserPageAnalyticsQuerySchema, UserPageAnalyticsSchema, createUserPageAnalytics, deleteUserPageAnalytics, findUserPageAnalytics, newUserPageAnalyticsPayload, toUserPageAnalyticsPayload };