kcommons 13.10.3 → 13.11.0

package/build/index.d.ts

@@ -65,6 +65,7 @@ export * from "./typings/common/uploadMedia.typings";
 export * from "./typings/common/retrieveMedia.typings";
 export * from "./typings/common/lifecycleLogger.typings";
 export * from "./typings/common/openUOM.typings";
+export * from "./typings/common/ocr/ocrGst.typings";
 export * from "./constants/permission.constants";
 export * from "./constants/entityTypes.constants";
 export * from "./constants/statuses.constants";
@@ -127,6 +128,8 @@ export * from "./typings/kpis/vendor/main/vHomeDashboardKpi.typings";
 export * from "./typings/vendor/companyProfile.typings";
 export * from "./helpers/padNumber.helper";
 export * from "./typings/plugins/plugin.typings";
+export * from "./utils/validators/gst.validator";
+export * from "./utils/validators/pan.validator";
 export interface ITesting {
     message: string;
     age: number;

package/build/index.js

@@ -85,6 +85,7 @@ __exportStar(require("./typings/common/uploadMedia.typings"), exports);
 __exportStar(require("./typings/common/retrieveMedia.typings"), exports);
 __exportStar(require("./typings/common/lifecycleLogger.typings"), exports);
 __exportStar(require("./typings/common/openUOM.typings"), exports);
+__exportStar(require("./typings/common/ocr/ocrGst.typings"), exports);
 // Constants
 __exportStar(require("./constants/permission.constants"), exports);
 __exportStar(require("./constants/entityTypes.constants"), exports);
@@ -162,3 +163,6 @@ __exportStar(require("./typings/vendor/companyProfile.typings"), exports);
 __exportStar(require("./helpers/padNumber.helper"), exports);
 // Plugins
 __exportStar(require("./typings/plugins/plugin.typings"), exports);
+// Validators
+__exportStar(require("./utils/validators/gst.validator"), exports);
+__exportStar(require("./utils/validators/pan.validator"), exports);

package/build/typings/common/ocr/ocrGst.typings.d.ts

@@ -0,0 +1,6 @@
+export interface IOcrGstUploadAckReq {
+    upload_key: string;
+}
+export interface IOcrGstUploadAckRes {
+    extracted_data: string[] | null;
+}

package/build/typings/common/ocr/ocrGst.typings.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/typings/common/uploadMedia.typings.d.ts

@@ -1,3 +1,11 @@
+/** --- For Downloads--- */
+export interface IRequestDownloadURLReq {
+    key: string;
+}
+export interface IRequestDownloadURLRes {
+    publicUrl: string;
+}
+/** --- For Uploads --- */
 export declare enum UPLOAD_MEDIA_TYPE {
     DOCUMENT = "documents",
     IMAGE = "images"

package/build/typings/common/uploadMedia.typings.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OPEN_DOCUMENT_TYPE = exports.MEDIA_ACCEESS_TYPE = exports.UPLOAD_MEDIA_TYPE = void 0;
+/** --- For Uploads --- */
 var UPLOAD_MEDIA_TYPE;
 (function (UPLOAD_MEDIA_TYPE) {
     UPLOAD_MEDIA_TYPE["DOCUMENT"] = "documents";

package/build/typings/user.typings.d.ts

@@ -36,6 +36,9 @@ import { INestedVendorOnboardingRequest } from "./company/vendorOnboardingReques
 import { INestedVendorManagementBody } from "./company/masters/vendorManagementBody.typings";
 import { INestedVendorOnboardingRequestCategory } from "./company/vendorOnboardingRequest/vendorOnboardingRequestCategory.typings";
 import { INestedItemManagementBody } from "./company/masters/itemManagementbody.typings";
+import { INestedQuote } from "./quote.typings";
+import { INestedASN } from "./asn.typings";
+import { INestedInvoice } from "./invoices.typings";
 export interface IUser {
     id: string;
     is_enabled?: boolean | null;
@@ -64,6 +67,7 @@ export interface IUser {
     active_company?: null | INestedCompany;
     active_role?: null | INestedRole;
     subordinates?: null | INestedUser[];
+    otps?: null | INestedUser[];
     as_incharge_in_purchase_locations?: null | INestedPurchaseLocation[];
     as_incharge_in_store_locations?: null | INestedStoreLocation[];
     as_incharge_in_offices?: null | INestedOffice[];
@@ -79,7 +83,6 @@ export interface IUser {
     created_items: INestedItem[] | null;
     items_sent_for_approval: INestedItem[] | null;
     approval_chains?: null | INestedApprovalChainEntry[];
-    created_indents?: null | INestedIndent[];
     indents_created_for_user?: null | INestedIndent[];
     mi_issued_for_user?: null | INestedMI[];
     created_mis?: null | INestedMI[];
@@ -158,10 +161,18 @@ export interface IUser {
     last_updated_item_management_bodies: INestedItemManagementBody[] | null;
     as_head_of_item_management_bodies: INestedItemManagementBody[] | null;
     cancelled_items: INestedItem[] | null;
+    as_contact_person_for_rfqs: INestedRFQ[] | null;
+    as_contact_person_for_quotes: INestedQuote[] | null;
+    cancelled_asns: INestedASN[] | null;
+    created_payment_terms: INestedUser | null;
+    invoices_marked_as_paid_or_rejected: INestedInvoice[] | null;
+    onboarded_company_vendors: INestedCompanyVendors[] | null;
+    created_indents: INestedIndent | null;
 }
-export interface INestedUser extends Omit<IUser, "updated_at" | "created_at" | "deleted_at" | "reporting_to" | "active_company" | "active_role" | "subordinates" | "otps" | "as_incharge_in_purchase_locations" | "as_incharge_in_store_locations" | "as_incharge_in_offices" | "as_incharge_in_gates" | "as_contact_person_companies" | "as_contact_person_offices" | "as_contact_person_gates" | "owned_companies" | "head_for_departments" | "created_item_subcategories" | "last_updated_item_subcategories" | "head_for_departments" | "approval_chains" | "created_indents" | "indents_created_for_user" | "created_mis" | "mis_issued_for_user" | "mis_sent_for_approval" | "mis_issued" | "mis_last_updated" | "created_prs" | "pr_sent_for_approval" | "pr_sent_to_purchase_location" | "last_updated_prs" | "created_rfqs" | "entity_approval_chains" | "as_contact_person_for_rfqs" | "as_contact_person_for_quotes" | "rfqs_sent_for_approval" | "rfqs_sent_to_vendors" | "created_rfq_items" | "negotiations" | "created_pos" | "last_updated_pos" | "as_contact_person_for_pos" | "pos_sent_for_approval" | "pos_sent_to_vendors" | "created_grns" | "last_updated_grns" | "as_contact_person_for_grns" | "grns_sent_for_approval" | "grns_sent_to_store" | "mrns_sent_for_approval" | "as_contact_person_for_mrns" | "created_boms" | "last_updated_boms" | "created_vendor_groups" | "last_updated_vendor_groups" | "comparatives_sent_for_approval" | "user_notifications" | "created_extra_quesstions" | "updated_extra_quesstions" | "answered_questions" | "created_extra_core_question_for_companies" | "updated_extra_core_question_for_companies" | "cancelled_asns" | "created_contact_people" | "updated_contact_people" | "last_updated_company_item_vendor_version" | "items_last_updated_by_user" | "company_vendors_last_updated_by_user" | "created_istds" | "last_updated_istds" | "source_contact_person_for_istd" | "dest_contact_person_for_istd" | "istds_sent_for_source_approval" | "istds_sent_for_dest_approval" | "istds_sent_for_dest_store" | "istds_marked_as_processed" | "istds_terminated" | "created_payment_terms" | "created_iads" | "user_last_updated_iads" | "as_approver_for_iads" | "iads_terminated_by_user" | "finalised_iads" | "assigned_roles" | "initiated_inventory_logs" | "logs" | "vendor_onboarding_requests_created_by_user" | "vendor_onboarding_requests_last_updated" | "vendor_onboarding_requests_sent_for_approval" | "invitation_sent_for_vendor_onboarding_requests" | "created_vendor_management_bodies" | "last_updated_vendor_management_bodies" | "head_of_vendor_management_bodies" | "cancelled_vendor_onboarding_requests" | "company_vendor_created_by_user" | "company_vendors_last_updated_by_user" | "sent_for_approval_company_vendors" | "sent_questions_to_company_vendors" | "cancelled_company_vendors" | "created_vendor_onboarding_request_categories" | "last_updated_vendor_onboarding_request_categories" | "created_item_management_bodies" | "last_updated_item_management_bodies" | "as_head_of_item_management_bodies" | "created_items" | "items_sent_for_approval" | "cancelled_items"> {
+export interface INestedUser extends Omit<IUser, "updated_at" | "created_at" | "deleted_at" | "reporting_to" | "active_company" | "active_role" | "subordinates" | "otps" | "as_incharge_in_purchase_locations" | "as_incharge_in_store_locations" | "as_incharge_in_offices" | "as_incharge_in_gates" | "as_contact_person_companies" | "as_contact_person_offices" | "as_contact_person_gates" | "owned_companies" | "head_for_departments" | "created_item_subcategories" | "last_updated_item_subcategories" | "head_for_departments" | "approval_chains" | "indents_created_for_user" | "created_mis" | "mis_issued_for_user" | "mis_sent_for_approval" | "mis_issued" | "mis_last_updated" | "created_prs" | "pr_sent_for_approval" | "pr_sent_to_purchase_location" | "last_updated_prs" | "created_rfqs" | "entity_approval_chains" | "as_contact_person_for_rfqs" | "as_contact_person_for_quotes" | "rfqs_sent_for_approval" | "rfqs_sent_to_vendors" | "created_rfq_items" | "negotiations" | "created_pos" | "last_updated_pos" | "as_contact_person_for_pos" | "pos_sent_for_approval" | "pos_sent_to_vendors" | "created_grns" | "last_updated_grns" | "as_contact_person_for_grns" | "grns_sent_for_approval" | "grns_sent_to_store" | "mrns_sent_for_approval" | "as_contact_person_for_mrns" | "created_boms" | "last_updated_boms" | "created_vendor_groups" | "last_updated_vendor_groups" | "comparatives_sent_for_approval" | "user_notifications" | "created_extra_quesstions" | "updated_extra_quesstions" | "answered_questions" | "created_extra_core_question_for_companies" | "updated_extra_core_question_for_companies" | "cancelled_asns" | "created_contact_people" | "updated_contact_people" | "last_updated_company_item_vendor_version" | "items_last_updated_by_user" | "company_vendors_last_updated_by_user" | "created_istds" | "last_updated_istds" | "source_contact_person_for_istd" | "dest_contact_person_for_istd" | "istds_sent_for_source_approval" | "istds_sent_for_dest_approval" | "istds_sent_for_dest_store" | "istds_marked_as_processed" | "istds_terminated" | "created_payment_terms" | "created_iads" | "user_last_updated_iads" | "as_approver_for_iads" | "iads_terminated_by_user" | "finalised_iads" | "assigned_roles" | "initiated_inventory_logs" | "logs" | "vendor_onboarding_requests_created_by_user" | "vendor_onboarding_requests_last_updated" | "vendor_onboarding_requests_sent_for_approval" | "invitation_sent_for_vendor_onboarding_requests" | "created_vendor_management_bodies" | "last_updated_vendor_management_bodies" | "head_of_vendor_management_bodies" | "cancelled_vendor_onboarding_requests" | "company_vendor_created_by_user" | "company_vendors_last_updated_by_user" | "sent_for_approval_company_vendors" | "sent_questions_to_company_vendors" | "cancelled_company_vendors" | "created_vendor_onboarding_request_categories" | "last_updated_vendor_onboarding_request_categories" | "created_item_management_bodies" | "last_updated_item_management_bodies" | "as_head_of_item_management_bodies" | "created_items" | "items_sent_for_approval" | "cancelled_items" | "invoices_marked_as_paid_or_rejected" | "onboarded_company_vendors" | "created_indents"> {
 }
 export declare enum UserInclude {
+    subordinates = "subordinates",
     as_incharge_in_purchase_locations = "as_incharge_in_purchase_locations",
     as_incharge_in_store_locations = "as_incharge_in_store_locations",
     as_incharge_in_offices = "as_incharge_in_offices",
@@ -192,7 +203,7 @@ export declare enum UserInclude {
     pos_sent_for_approval = "pos_sent_for_approval",
     pos_sent_to_vendors = "pos_sent_to_vendors",
     created_grns = "created_grns",
-    last_updated_grns = "lalst_updated_grns",
+    last_updated_grns = "last_updated_grns",
     grns_sent_for_approval = "grns_sent_for_approval",
     grns_sent_to_store = "grns_sent_to_store",
     mrns_sent_for_approval = "mrns_sent_for_approval",
@@ -250,7 +261,21 @@ export declare enum UserInclude {
     as_head_of_item_management_bodies = "as_head_of_item_management_bodies",
     created_items = "created_items",
     items_sent_for_approval = "items_sent_for_approval",
-    cancelled_items = "cancelled_items"
+    cancelled_items = "cancelled_items",
+    otps = "otps",
+    created_indents = "created_indents",
+    created_prs = "created_prs",
+    created_rfqs = "created_rfqs",
+    entity_approval_chains = "entity_approval_chains",
+    as_contact_person_for_rfqs = "as_contact_person_for_rfqs",
+    as_contact_person_for_quotes = "as_contact_person_for_quotes",
+    rfqs_sent_for_approval = "rfqs_sent_for_approval",
+    rfqs_sent_to_vendors = "rfqs_sent_to_vendors",
+    created_rfq_items = "created_rfq_items",
+    cancelled_asns = "cancelled_asns",
+    created_payment_terms = "created_payment_terms",
+    invoices_marked_as_paid_or_rejected = "invoices_marked_as_paid_or_rejected",
+    onboarded_company_vendors = "onboarded_company_vendors"
 }
 export interface IUserFilters {
     name?: string | null;

package/build/typings/user.typings.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserInclude = void 0;
 var UserInclude;
 (function (UserInclude) {
-    // subordinates = "subordinates",
+    UserInclude["subordinates"] = "subordinates";
     UserInclude["as_incharge_in_purchase_locations"] = "as_incharge_in_purchase_locations";
     UserInclude["as_incharge_in_store_locations"] = "as_incharge_in_store_locations";
     UserInclude["as_incharge_in_offices"] = "as_incharge_in_offices";
@@ -34,7 +34,7 @@ var UserInclude;
     UserInclude["pos_sent_for_approval"] = "pos_sent_for_approval";
     UserInclude["pos_sent_to_vendors"] = "pos_sent_to_vendors";
     UserInclude["created_grns"] = "created_grns";
-    UserInclude["last_updated_grns"] = "lalst_updated_grns";
+    UserInclude["last_updated_grns"] = "last_updated_grns";
     UserInclude["grns_sent_for_approval"] = "grns_sent_for_approval";
     UserInclude["grns_sent_to_store"] = "grns_sent_to_store";
     UserInclude["mrns_sent_for_approval"] = "mrns_sent_for_approval";
@@ -95,4 +95,18 @@ var UserInclude;
     UserInclude["created_items"] = "created_items";
     UserInclude["items_sent_for_approval"] = "items_sent_for_approval";
     UserInclude["cancelled_items"] = "cancelled_items";
+    UserInclude["otps"] = "otps";
+    UserInclude["created_indents"] = "created_indents";
+    UserInclude["created_prs"] = "created_prs";
+    UserInclude["created_rfqs"] = "created_rfqs";
+    UserInclude["entity_approval_chains"] = "entity_approval_chains";
+    UserInclude["as_contact_person_for_rfqs"] = "as_contact_person_for_rfqs";
+    UserInclude["as_contact_person_for_quotes"] = "as_contact_person_for_quotes";
+    UserInclude["rfqs_sent_for_approval"] = "rfqs_sent_for_approval";
+    UserInclude["rfqs_sent_to_vendors"] = "rfqs_sent_to_vendors";
+    UserInclude["created_rfq_items"] = "created_rfq_items";
+    UserInclude["cancelled_asns"] = "cancelled_asns";
+    UserInclude["created_payment_terms"] = "created_payment_terms";
+    UserInclude["invoices_marked_as_paid_or_rejected"] = "invoices_marked_as_paid_or_rejected";
+    UserInclude["onboarded_company_vendors"] = "onboarded_company_vendors";
 })(UserInclude || (exports.UserInclude = UserInclude = {}));

package/build/typings/vendor.typings.d.ts

@@ -33,6 +33,11 @@ export interface IVendor extends IAddress {
     beneficiary_name: string | null;
     vkraya_id: string;
     password: string;
+    is_bank_details_verified: boolean;
+    is_gst_verified: boolean;
+    is_pan_verified: boolean;
+    is_cin_verified: boolean;
+    is_udyam_verified: boolean;
     is_profile_complete: boolean;
     is_profile_verified: boolean;
     is_self_verified: boolean;

package/build/utils/validators/gst.validator.d.ts

@@ -0,0 +1,14 @@
+export declare const GST_REGEX: RegExp;
+/**
+ * Returns boolean based on whether the provided GST is valid or not.
+ * * @param gst_no Gst No to be validated
+ * @returns Boolean
+ *
+ * Validation Rules:
+ * 1. First 2 Characters should be Numbers.
+ * 2. Next 10 characters should be a valid PAN Number.
+ * 3. The 13th character can be 1-9 or A-Z.
+ * 4. The 14th character has to be "Z".
+ * 5. The 15th character has to be 1-9.
+ */
+export declare function isValidGST(gst_no: string): boolean;

package/build/utils/validators/gst.validator.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GST_REGEX = void 0;
+exports.isValidGST = isValidGST;
+exports.GST_REGEX = /^(0[1-9]|1[0-9]|2[0-9]|3[0-7])[A-Z]{5}\d{4}[A-Z][A-Z0-9]Z[A-Z0-9]$/i;
+/**
+ * Returns boolean based on whether the provided GST is valid or not.
+ * * @param gst_no Gst No to be validated
+ * @returns Boolean
+ *
+ * Validation Rules:
+ * 1. First 2 Characters should be Numbers.
+ * 2. Next 10 characters should be a valid PAN Number.
+ * 3. The 13th character can be 1-9 or A-Z.
+ * 4. The 14th character has to be "Z".
+ * 5. The 15th character has to be 1-9.
+ */
+function isValidGST(gst_no) {
+    return exports.GST_REGEX.test(gst_no);
+}

package/build/utils/validators/pan.validator.d.ts

@@ -0,0 +1,12 @@
+export declare const PAN_REGEX: RegExp;
+/**
+ * Checks whether the provided PAN No. is valid or not.
+ * @param pan_no Pan No. to be validated
+ * @returns Boolean
+ *
+ * Validation Rules:
+ * 1. First 5 characters should be alphabets in uppercase.
+ * 2. The next 4 characters should be numbers.
+ * 3. The last character should be again alphabet in uppercase.
+ */
+export declare function isValidPan(pan_no: string): boolean;

package/build/utils/validators/pan.validator.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAN_REGEX = void 0;
+exports.isValidPan = isValidPan;
+exports.PAN_REGEX = /^[A-Z]{5}\d{4}[A-Z]$/i;
+/**
+ * Checks whether the provided PAN No. is valid or not.
+ * @param pan_no Pan No. to be validated
+ * @returns Boolean
+ *
+ * Validation Rules:
+ * 1. First 5 characters should be alphabets in uppercase.
+ * 2. The next 4 characters should be numbers.
+ * 3. The last character should be again alphabet in uppercase.
+ */
+function isValidPan(pan_no) {
+    return exports.PAN_REGEX.test(pan_no);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kcommons",
-  "version": "13.10.3",
+  "version": "13.11.0",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",

package/build/typings/company/settings/CompanySettings.typings.d.ts

@@ -1,6 +0,0 @@
-export declare enum SETTINGS_TABS {
-    USERPROFILE = "userprofile",
-    COMPANY_SETTINGS = "company_settings",
-    BILLING = "billing",
-    COMPANY_VENDORS = "company_vendors"
-}

package/build/typings/company/settings/CompanySettings.typings.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SETTINGS_TABS = void 0;
-var SETTINGS_TABS;
-(function (SETTINGS_TABS) {
-    SETTINGS_TABS["USERPROFILE"] = "userprofile";
-    SETTINGS_TABS["COMPANY_SETTINGS"] = "company_settings";
-    SETTINGS_TABS["BILLING"] = "billing";
-    SETTINGS_TABS["COMPANY_VENDORS"] = "company_vendors";
-})(SETTINGS_TABS || (exports.SETTINGS_TABS = SETTINGS_TABS = {}));