kcommons 5.16.16 → 5.17.0

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/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 INestedNotificationEntity {
+}
+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/package.json

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