kcommons 5.16.16 → 5.17.1

package/build/index.d.ts

@@ -33,6 +33,7 @@ export * from "./typings/common/paginationFilters.typings";
 export * from "./typings/common/uploadMedia.typings";
 export * from "./typings/common/retrieveMedia.typings";
 export * from "./typings/quote.typings";
+export * from "./typings/notifications.typings";
 export * from "./constants/permission.constants";
 export * from "./constants/entityTypes.constants";
 export * from "./constants/documentStatus.typings";
@@ -40,3 +41,4 @@ export * from "./constants/form.constants";
 export * from "./constants/upload.constants";
 export * from "./classes/asnWrapper.class";
 export * from "./utils/permission.utils";
+export * from "./templates/notifications/rfq.notifications";

package/build/index.js

@@ -50,6 +50,7 @@ __exportStar(require("./typings/common/paginationFilters.typings"), exports);
 __exportStar(require("./typings/common/uploadMedia.typings"), exports);
 __exportStar(require("./typings/common/retrieveMedia.typings"), exports);
 __exportStar(require("./typings/quote.typings"), exports);
+__exportStar(require("./typings/notifications.typings"), exports);
 // Constants
 __exportStar(require("./constants/permission.constants"), exports);
 __exportStar(require("./constants/entityTypes.constants"), exports);
@@ -60,3 +61,5 @@ __exportStar(require("./constants/upload.constants"), exports);
 __exportStar(require("./classes/asnWrapper.class"), exports);
 // Utils
 __exportStar(require("./utils/permission.utils"), exports);
+// Templates
+__exportStar(require("./templates/notifications/rfq.notifications"), exports);

package/build/templates/notifications/rfq.notifications.d.ts

@@ -0,0 +1,2 @@
+import { INotificationTemplate } from "../../typings/notifications.typings";
+export declare const RFQ_NOTIFICATION_TEMPLATES: Record<string, (...args: any) => INotificationTemplate | INotificationTemplate>;

package/build/templates/notifications/rfq.notifications.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RFQ_NOTIFICATION_TEMPLATES = void 0;
+exports.RFQ_NOTIFICATION_TEMPLATES = {
+    chanceForApproval: ({ rfq_id, rfq_no, }) => {
+        return {
+            actionLink: `/purchase/request-for-requisition/${rfq_id}`,
+            message: `Please approve the RFQ ${rfq_no}`,
+            title: "RFQ Approval",
+        };
+    },
+};

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

@@ -11,6 +11,7 @@ import { IItemSubcategory } from "./itemSubcategory.typings";
 import { INestedMI, INestedMIItem } from "./mi.typings";
 import { INestedMRN, INestedMRNItem } from "./mrn.typings";
 import { INestedNegotiation } from "./negotiation.typings";
+import { INestedNotification } from "./notifications.typings";
 import { INestedOffice } from "./offices.typings";
 import { INestedPo } from "./po.typings";
 import { INestedPR, INestedPrItem } from "./pr.typings";
@@ -56,7 +57,8 @@ export declare enum COMPANY_INCLUDE {
     company_boms = "company_boms",
     company_bom_items = "company_bom_items",
     company_comparatives = "company_comparatives",
-    company_comparative_items = "company_comparative_items"
+    company_comparative_items = "company_comparative_items",
+    company_notifications = "company_notifications"
 }
 export interface ICompany extends IAddress {
     id: string;
@@ -113,6 +115,7 @@ export interface ICompany extends IAddress {
     company_bom_items: INestedBOMItem[] | null;
     company_comparatives: INestedComparative[] | null;
     company_comparative_items: INestedComparativeItem[] | null;
+    company_notifications: INestedNotification[] | null;
 }
-export interface INestedCompany extends Omit<ICompany, "associated_purchase_locations" | "associated_vendors" | "associated_permissions" | "associated_roles" | "approval_configs" | "subdepartments" | "subcategories" | "categories" | "items" | "offices" | "stores" | "employees" | "departments" | "vendor_groups" | "company_indents" | "indent_items" | "company_mis" | "mi_items" | "company_prs" | "pr_items" | "company_rfqs" | "company_quotes" | "entity_approval_chain_entries" | "company_negotiations" | "company_pos" | "company_grns" | "company_grns_items" | "company_mrns" | "company_mrns_items" | "company_boms" | "company_bom_items" | "company_comparatives" | "company_comparative_items"> {
+export interface INestedCompany extends Omit<ICompany, "associated_purchase_locations" | "associated_vendors" | "associated_permissions" | "associated_roles" | "approval_configs" | "subdepartments" | "subcategories" | "categories" | "items" | "offices" | "stores" | "employees" | "departments" | "vendor_groups" | "company_indents" | "indent_items" | "company_mis" | "mi_items" | "company_prs" | "pr_items" | "company_rfqs" | "company_quotes" | "entity_approval_chain_entries" | "company_negotiations" | "company_pos" | "company_grns" | "company_grns_items" | "company_mrns" | "company_mrns_items" | "company_boms" | "company_bom_items" | "company_comparatives" | "company_comparative_items" | "company_notifications"> {
 }

package/build/typings/company.typings.js

@@ -36,4 +36,5 @@ var COMPANY_INCLUDE;
     COMPANY_INCLUDE["company_bom_items"] = "company_bom_items";
     COMPANY_INCLUDE["company_comparatives"] = "company_comparatives";
     COMPANY_INCLUDE["company_comparative_items"] = "company_comparative_items";
+    COMPANY_INCLUDE["company_notifications"] = "company_notifications";
 })(COMPANY_INCLUDE || (exports.COMPANY_INCLUDE = COMPANY_INCLUDE = {}));

package/build/typings/notifications.typings.d.ts

@@ -0,0 +1,65 @@
+import { EntityTypes } from "../constants/entityTypes.constants";
+import { IPERMISSION_ENTITIES, PERMISSION_ACTIONS } from "../constants/permission.constants";
+import { INestedCompany } from "./company.typings";
+import { INestedUser } from "./user.typings";
+import { INestedVendor } from "./vendor.typings";
+export interface INotificationsPayload {
+}
+export declare enum NOTIFICATION_INCLUDE {
+    company = "company",
+    user = "user",
+    vendor = "vendor"
+}
+export interface INotification {
+    id: string;
+    company_id: string;
+    user_id: string | null;
+    vendor_id: string | null;
+    category: string;
+    read: boolean;
+    title: string;
+    description: string;
+    action_link: string | null;
+    company: INestedCompany | null;
+    user: INestedUser | null;
+    vendor: INestedVendor | null;
+}
+export interface INestedNotification extends Omit<INotification, "company" | "vendor" | "user"> {
+}
+export declare enum NOTIFICAITON_CATEGORIES {
+    INDIVIDUAL = "INDIVIDUAL",
+    GROUP = "GROUP"
+}
+export declare enum GROUP_NOTIFICATION_TYPES {
+    ENTITY_DEPENDENT = "ENTITY_DEPENDENT",
+    PRIVILEGE_DEPENDENT = "PRIVILEGE_DEPENDENT",
+    ENTITY_PRIVILEGE_DEPENDENT = "ENTITY_PRIVILEGE_DEPENDENT"
+}
+export interface IEntityDependentNotificaiton {
+    type: GROUP_NOTIFICATION_TYPES.ENTITY_DEPENDENT;
+    entity_type: EntityTypes;
+    entity_id: string;
+}
+export interface IPrivilegeDependentNotifications {
+    type: GROUP_NOTIFICATION_TYPES.PRIVILEGE_DEPENDENT;
+    permission_entity: IPERMISSION_ENTITIES;
+    actions: PERMISSION_ACTIONS[];
+}
+export interface IEntityAndPrivilegeDependentNotifications {
+    type: GROUP_NOTIFICATION_TYPES.ENTITY_PRIVILEGE_DEPENDENT;
+    entity_type: EntityTypes;
+    entity_id: string;
+    permission_entity: IPERMISSION_ENTITIES;
+    actions: PERMISSION_ACTIONS[];
+}
+export type IGroupNotification = IEntityAndPrivilegeDependentNotifications | IPrivilegeDependentNotifications | IEntityAndPrivilegeDependentNotifications;
+export interface IIndividualNotification {
+    user_id: string;
+    vendor_id: string;
+}
+export type INotificationType = IIndividualNotification | IGroupNotification;
+export interface INotificationTemplate {
+    title: string;
+    message: string;
+    actionLink: string;
+}

package/build/typings/notifications.typings.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GROUP_NOTIFICATION_TYPES = exports.NOTIFICAITON_CATEGORIES = exports.NOTIFICATION_INCLUDE = void 0;
+var NOTIFICATION_INCLUDE;
+(function (NOTIFICATION_INCLUDE) {
+    NOTIFICATION_INCLUDE["company"] = "company";
+    NOTIFICATION_INCLUDE["user"] = "user";
+    NOTIFICATION_INCLUDE["vendor"] = "vendor";
+})(NOTIFICATION_INCLUDE || (exports.NOTIFICATION_INCLUDE = NOTIFICATION_INCLUDE = {}));
+var NOTIFICAITON_CATEGORIES;
+(function (NOTIFICAITON_CATEGORIES) {
+    NOTIFICAITON_CATEGORIES["INDIVIDUAL"] = "INDIVIDUAL";
+    NOTIFICAITON_CATEGORIES["GROUP"] = "GROUP";
+})(NOTIFICAITON_CATEGORIES || (exports.NOTIFICAITON_CATEGORIES = NOTIFICAITON_CATEGORIES = {}));
+var GROUP_NOTIFICATION_TYPES;
+(function (GROUP_NOTIFICATION_TYPES) {
+    GROUP_NOTIFICATION_TYPES["ENTITY_DEPENDENT"] = "ENTITY_DEPENDENT";
+    GROUP_NOTIFICATION_TYPES["PRIVILEGE_DEPENDENT"] = "PRIVILEGE_DEPENDENT";
+    GROUP_NOTIFICATION_TYPES["ENTITY_PRIVILEGE_DEPENDENT"] = "ENTITY_PRIVILEGE_DEPENDENT";
+})(GROUP_NOTIFICATION_TYPES || (exports.GROUP_NOTIFICATION_TYPES = GROUP_NOTIFICATION_TYPES = {}));

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

@@ -79,8 +79,9 @@ export interface IUser {
     created_vendor_groups?: INestedVendorGroups[] | null;
     last_updated_vendor_groups?: INestedVendorGroups[] | null;
     comparatives_sent_for_approval?: INestedComparative[] | null;
+    user_notifications?: INestedNegotiation[] | null;
 }
-export interface INestedUser extends Omit<IUser, "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" | "as_contact_person_for_grns" | "as_contact_person_for_mrns" | "owned_companies" | "head_for_departments" | "approved_items" | "approval_chains" | "created_indents" | "created_mis" | "created_prs" | "created_rfqs" | "entity_approval_chains" | "rfqs_sent_for_approval" | "rfqs_sent_to_vendors" | "created_rfq_items" | "assigned_roles" | "negotiations" | "created_pos" | "as_contact_person_for_pos" | "pos_sent_for_approval" | "pos_sent_to_vendors" | "grns_sent_for_approval" | "grns_sent_to_store" | "mrns_sent_for_approval" | "created_boms" | "last_updated_boms" | "created_vendor_groups" | "last_updated_vendor_groups" | "comparatives_sent_for_approval"> {
+export interface INestedUser extends Omit<IUser, "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" | "as_contact_person_for_grns" | "as_contact_person_for_mrns" | "owned_companies" | "head_for_departments" | "approved_items" | "approval_chains" | "created_indents" | "created_mis" | "created_prs" | "created_rfqs" | "entity_approval_chains" | "rfqs_sent_for_approval" | "rfqs_sent_to_vendors" | "created_rfq_items" | "assigned_roles" | "negotiations" | "created_pos" | "as_contact_person_for_pos" | "pos_sent_for_approval" | "pos_sent_to_vendors" | "grns_sent_for_approval" | "grns_sent_to_store" | "mrns_sent_for_approval" | "created_boms" | "last_updated_boms" | "created_vendor_groups" | "last_updated_vendor_groups" | "comparatives_sent_for_approval" | "user_notifications"> {
 }
 export declare enum UserInclude {
     as_incharge_in_purchase_locations = "as_incharge_in_purchase_locations",
@@ -110,5 +111,6 @@ export declare enum UserInclude {
     created_vendor_groups = "created_vendor_groups",
     last_updated_vendor_groups = "last_updated_vendor_groups",
     active_role = "active_role",
-    comparatives_sent_for_approval = "comparatives_sent_for_approval"
+    comparatives_sent_for_approval = "comparatives_sent_for_approval",
+    user_notifications = "user_notifications"
 }

package/build/typings/user.typings.js

@@ -32,4 +32,5 @@ var UserInclude;
     UserInclude["last_updated_vendor_groups"] = "last_updated_vendor_groups";
     UserInclude["active_role"] = "active_role";
     UserInclude["comparatives_sent_for_approval"] = "comparatives_sent_for_approval";
+    UserInclude["user_notifications"] = "user_notifications";
 })(UserInclude || (exports.UserInclude = UserInclude = {}));

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

@@ -1,5 +1,6 @@
 import { INestedCompany } from "./company.typings";
 import { INestedNegotiation } from "./negotiation.typings";
+import { INestedNotification } from "./notifications.typings";
 import { INestedQuote } from "./quote.typings";
 import { INestedRFQ } from "./rfq.typings";
 import { IAddress } from "./utils/address.typings";
@@ -39,14 +40,16 @@ export interface IVendor extends IAddress {
     associated_companies: INestedCompany[] | null;
     negotiations: INestedNegotiation[] | null;
     as_additional_in_rfqs: INestedRFQ[] | null;
+    vendor_notifications: INestedNotification[] | null;
 }
-export interface INestedVendor extends Omit<IVendor, "quotes" | "associated_companies" | "negotiations" | "as_additional_in_rfqs"> {
+export interface INestedVendor extends Omit<IVendor, "quotes" | "associated_companies" | "negotiations" | "as_additional_in_rfqs" | "vendor_notifications"> {
 }
 export declare enum VENDOR_INCLUDE {
     quotes = "quotes",
     associated_companies = "associated_companies",
     negotiations = "negotiations",
-    as_additional_in_rfqs = "as_additional_in_rfqs"
+    as_additional_in_rfqs = "as_additional_in_rfqs",
+    vendor_notifications = "vendor_notifications"
 }
 export interface IVENDOR_TOKEN_PAYLOAD {
     vendor_id: string;

package/build/typings/vendor.typings.js

@@ -7,5 +7,6 @@ var VENDOR_INCLUDE;
     VENDOR_INCLUDE["associated_companies"] = "associated_companies";
     VENDOR_INCLUDE["negotiations"] = "negotiations";
     VENDOR_INCLUDE["as_additional_in_rfqs"] = "as_additional_in_rfqs";
+    VENDOR_INCLUDE["vendor_notifications"] = "vendor_notifications";
     // pos = "pos",
 })(VENDOR_INCLUDE || (exports.VENDOR_INCLUDE = VENDOR_INCLUDE = {}));

package/package.json

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