@platform-x/hep-notification-client 1.0.0 → 1.1.3

package/README.md

@@ -0,0 +1,8 @@
+#@platform-x/hep-notification-client
+Provide module to send email to the users.
+
+How to install and use
+
+npm install @platform-x/hep-notification-client
+
+import the modules and implement.

package/dist/src/common/service/requestService.d.ts

@@ -0,0 +1,26 @@
+interface RequestHandlerPostOptions {
+    url: string;
+    body: any;
+    options?: any;
+}
+interface RequestHandlerGetOptions {
+    url: string;
+    options?: any;
+}
+export declare class HttpRequestHandler {
+    private requestTimeout;
+    constructor();
+    /**
+     * post - handler to do post api calls
+     * @param requestConfig
+     * @returns
+     */
+    post(requestConfig: RequestHandlerPostOptions): Promise<any>;
+    /**
+     * get - handler to do get api calls
+     * @param requestConfig
+     * @returns
+     */
+    get(requestConfig: RequestHandlerGetOptions): Promise<any>;
+}
+export {};

package/dist/src/common/service/twilioService.d.ts

@@ -0,0 +1,18 @@
+export declare class TwilioService {
+    private client;
+    private senderNumber;
+    /**
+     * Constructor to initialize Twilio client and sender number
+     * @param accountSid - Twilio Account SID
+     * @param authToken - Twilio Auth Token
+     * @param senderNumber - Twilio Sender Phone Number
+     */
+    constructor(accountSid: string, authToken: string, senderNumber: string);
+    /**
+     * Send an SMS using Twilio
+     * @param to - Recipient's phone number
+     * @param message - Message content
+     * @returns Promise resolving with the Twilio response
+     */
+    sendSMS(to: string, message: string): Promise<import("twilio/lib/rest/api/v2010/account/message").MessageInstance>;
+}

package/dist/src/common/util/commonUtil.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Validate a phone number for format and length
+ * @param phoneNumber
+ * @returns
+ */
+export declare const validatePhoneNumber: (phoneNumber: string) => boolean;
+/**
+ * Validate a message for length and content
+ * @param message
+ * @returns
+ */
+export declare const validateMessage: (message: string) => boolean;
+/**
+ * Validate both phone number and message
+ * @param phoneNumber
+ * @param message
+ * @returns
+ */
+export declare const validate: (phoneNumber: string, message: string) => {
+    valid: boolean;
+    errors: any;
+};

package/dist/src/common/util/errorHandler.d.ts

@@ -0,0 +1,44 @@
+export declare const enum HTTP_STATUS_CODE {
+    INTERNAL_SERVER_ERROR = 500
+}
+export declare const HTTP_STATUS_MAP: Map<number, string>;
+export declare const enum HTTP_STATUS_TYPE {
+    INTERNAL_SERVER_ERROR = "Internal Server Error"
+}
+export declare class CommonErrorTemplate extends Error {
+    code: number;
+    type: string;
+    constructor(msg: string, code?: number);
+    toJSON(): {
+        code: number;
+        type: string;
+        message: string;
+    };
+}
+export declare class ApiError extends CommonErrorTemplate {
+    constructor(msg: string, code?: number);
+}
+export declare class SolrError extends CommonErrorTemplate {
+    constructor(msg: string, code?: number);
+}
+export declare class CustomError {
+    code: number | undefined;
+    type: string | undefined;
+    message: string | undefined;
+    stack: string | undefined;
+    errorObj: Error | undefined | null;
+    constructor(errObj?: any, code?: number, type?: string, message?: string, stack?: string);
+    toJSON(): {
+        code: number | undefined;
+        type: string | undefined;
+        message: string | undefined;
+    };
+}
+/**
+ * errorMapper - to map error object to custom error
+ */
+export declare const errorMapper: (err: any, statusCode?: number, type?: string) => any;
+/**
+ * throwError - to throw custome error
+ */
+export declare const throwError: (err: any, statusCode?: number, type?: string) => never;

package/dist/src/common/util/logger.d.ts

@@ -0,0 +1,68 @@
+export interface payLoadInterface {
+    statusCode?: number;
+    data?: any;
+}
+export interface LoggerInterface {
+    info(message: string, method: string): void;
+    warn(message: string, method: string, payload?: object): void;
+    error(message: string, method: string, payload?: object): void;
+    debug(message: string, method: string, payload?: object): void;
+}
+export declare class LoggerClass implements LoggerInterface {
+    private logger;
+    private infoLevel;
+    private debugLevel;
+    private errorLevel;
+    private warnLevel;
+    private blockedKeywords;
+    constructor();
+    /**
+     * It's written to handle JSON.circular error
+     * @param obj
+     * @returns
+     */
+    customstringify(obj: any): string;
+    /**
+     * for info log
+     * @param message
+     * @param payload
+     * @param method
+     * @returns
+     */
+    info(message: string, method: string): void;
+    /**
+     * for warn log
+     * @param message
+     * @param payload
+     * @param method
+     * @returns
+     */
+    warn(message: string, method: string, payload?: any): void;
+    /**
+     * for error log
+     * @param message
+     * @param payload
+     * @param method
+     * @returns
+     */
+    error(message: string, method: string, payload?: any): void;
+    /**
+     * for debug log
+     * @param message
+     * @param payload
+     * @param method
+     * @returns
+     */
+    debug(message: string, method: string, payload?: any): void;
+    /**
+     * to map log levels and handle from config
+     */
+    private mapLogLevels;
+    /**
+     * to sanitize logs from unwanted fields to be shown
+     * @param request
+     * @returns
+     */
+    private sanitizeLog;
+}
+export declare const Logger: LoggerClass;

package/dist/src/common/util/requestTracer.d.ts

@@ -0,0 +1,2 @@
+export declare const getTraceId: () => any;
+export declare const getSpanId: () => any;

package/dist/src/common/util/solrConnector.d.ts

@@ -0,0 +1,35 @@
+interface SolrQuery {
+    query(query: string | object | null | undefined): any;
+    paginate(start?: number, rows?: number): any;
+    filterList(fields: any): any;
+    sort(fields: any): any;
+    filterQuery(fields: any): any;
+}
+export declare class SolrClient {
+    private host;
+    private port;
+    private core;
+    private path;
+    private secure;
+    private solrNodeClient;
+    private solrQuery;
+    constructor(core?: string);
+    getQuery(): any;
+    createQuery(): SolrQuery;
+    executeSearch(): Promise<any>;
+    /**
+     * solrSearch- fn to call solr search
+     * @param queryParams
+     * @param fields
+     * @param fieldType
+     * @param sortData
+     * @returns
+     */
+    solrSearch(queryParams: any, fields?: any, fieldType?: any, sortData?: any, filterQuery?: any): Promise<unknown>;
+    private query;
+    private paginate;
+    private filterList;
+    private sort;
+    private filterQuery;
+}
+export {};

package/dist/src/config/index.d.ts

@@ -0,0 +1,42 @@
+declare const _default: {
+    LOG_LEVELS: string[];
+    APP_NAME: string;
+    NODE_ENV: string | undefined;
+    SOLR_IMAGE_HOST_URL: string;
+    SENDGRID_API_KEY: string;
+    EMAIL_FROM: string;
+    SOLR: {
+        HOST: string | undefined;
+        PORT: string | undefined;
+        PATH: string | undefined;
+        CORE: string | undefined;
+        SECURE: boolean;
+    };
+    TWILIO: {
+        ACCOUNT_SID: string;
+        AUTH_TOKEN: string;
+        SENDER_NUMBER: string;
+    };
+    MONGO: {
+        HOST: string | undefined;
+        PORT: string | undefined;
+        DB_NAME: string | undefined;
+        USER: string | undefined;
+        PASS: string | undefined;
+    };
+    MULTISITE_WITH_SOLR: string | boolean;
+    APPLICATION_FORM_COLLECTION: string;
+    MAIL_ID: string;
+    CFF_MAIL_FROM: string;
+    USER_NAME: string;
+    CONTACT_FORM_COLLECTION: string;
+    NEWS_LETTER_FORM_COLLECTION: string;
+    CFF_WEEKLY_DAYS: string | number;
+    CFF_LAST_WEEK_HOURS: string | number;
+    RENDERING_API_GATEWAY_URL: string;
+    CFF_INFO_MAIL: string;
+    CFF_CC_EMAIL: string;
+    SITE_HOST: string;
+    DELIVERY_API_URL: string;
+};
+export default _default;

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+import { EmailHandler } from "./platform-x/util/emailHandler";
+import { TwilioService } from "./common/service/twilioService";
+export { EmailHandler, TwilioService };

package/dist/src/platform-x/constants/index.d.ts

@@ -0,0 +1,11 @@
+export declare const DEFAULT_SOLR_ROWS = 2147483647;
+export declare const CREATE_USER_EMAIL_TEMPLATE: {
+    subject: string;
+    hclplatformx_Body: string;
+}[];
+/** HTTP Request related constants */
+export declare const HTTP_CONTENT_TYPE_JSON = "application/json";
+export declare const TRACE_ID_HEADER_NAME = "Platform-X-Trace-Id";
+export declare const DEFAULT_APP_PORT = 8080;
+export declare const DEFAULT_APP_NAME = "api-gateway";
+export declare const DEFAULT_REALM_NAME = "platform-x";

package/dist/src/platform-x/constants/style.d.ts

@@ -0,0 +1 @@
+export declare const style = "<style>\n                        .username {\n                            font-size:24px;\n                        }\n                        .main_div {\n                            background-color: #dff3ff;\n                            box-sizing: border-box;\n\t\t\t\t\t\t\tfont-family: Segoe, \"Segoe UI\", \"DejaVu Sans\", \"Trebuchet MS\", Verdana, \"sans-serif\"\n                        }\n                        table {\n                            height: 100%;\n                            margin-left: auto;\n                            margin-right: auto;\n                        }\n                        .table_div {\n                            max-width: 600px;\n                            width: 100%;\n                            background-color: #fff;\n                            padding: 40px;\n                            border-radius: 5px;\n                            box-shadow: 8px 8px 16px 0 #b4e3ff;\n                            box-sizing: border-box;\n                        }\n                        .table_2 {\n                            width: 100%;\n                            padding-bottom: 30px;\n                            border-bottom: solid 1px #bfbfbf;\n                            margin-bottom: 30px;\n                        }\n                        .w-400 {\n                            width: 402px;\n                        }\n                        .w_h_30 {\n                            width: 40px;\n                            height: auto;\n                        }\n                        h1 {\n                            font-size: 24px;\n                            color: #000;\n                            text-transform: capitalize;\n                            margin: 0 0 20px;\n                        }\n                        .main_text {\n                            font-size: 16px;\n                            line-height: 1.5;\n                            color: #000000;\n                            margin: 0 0 30px;\n                        }\n                        a {\n                            color: #0077b5;\n                        }\n                        .mb_20 {\n                            margin-bottom: 20px;\n                        }\n                        .btn {\n                            display: block;\n                            width: 100px;\n                            padding: 15px 30px;\n                            font-size: 18px;\n                            font-weight: 600;\n                            color: #ffffff;\n                            text-align: center;\n                            background-color: #2D2D39;\n                            border-radius: 4px;\n                            text-decoration: none;\n                        }\n                        .border {\n                            margin-bottom: 30px;\n                            border-bottom: solid 1px #bfbfbf;\n                            padding-bottom: 30px;\n                        }\n                        .mb_pb_20 {\n                            margin-bottom: 30px;\n                            padding-bottom: 30px;\n                        }\n                        .sub_text {\n                            font-size: 14px;\n                            line-height: 1.5;\n                            color: #000000;\n                            margin: 26.5px 16px 15px 1px;\n                        }\n                        .link {\n                            font-size: 14px;\n                            font-weight: 600;\n                            color: #0077b5;\n                            margin-bottom: 20px;\n                            margin-right: 15px;\n                        }\n                        .thanks{\n                            font-size: 16px;\n                            line-height: 1.5;\n                            color: #000000;\n                            margin-top:40px\n                        }\n                        .mt_10{\n                        margin-top:10px\n                        }\n                    </style>\n";

package/dist/src/platform-x/dataSource/emailDataSource.d.ts

@@ -0,0 +1,5 @@
+import { SolrHttpDataSource } from '../util/solr-data-source/SolrHttpDataSource';
+export declare class EmailDataSource extends SolrHttpDataSource {
+    constructor();
+    fetchPageModel(tagName: string): Promise<any>;
+}

package/dist/src/platform-x/database/connection.d.ts

@@ -0,0 +1,8 @@
+import mongoose from 'mongoose';
+declare const _default: {
+    database: mongoose.Connection;
+    mongoose: typeof mongoose;
+    connect: () => void;
+    disconnect: () => void;
+};
+export default _default;

package/dist/src/platform-x/database/dao/formBuilder.dao.d.ts

@@ -0,0 +1,9 @@
+export default class FormBuilderDao {
+    /**
+     * Get data based on collectionName collection
+     * @param email
+     * @returns
+     */
+    fetch(collectionName: string, data: any): Promise<any>;
+    details(collectionName: string, filter: any, sort: any): Promise<any>;
+}

package/dist/src/platform-x/database/index.d.ts

@@ -0,0 +1,7 @@
+declare const db: {
+    database: import("mongoose").Connection;
+    mongoose: typeof import("mongoose");
+    connect: () => void;
+    disconnect: () => void;
+};
+export default db;

package/dist/src/platform-x/database/models/formBuilder.model.d.ts

@@ -0,0 +1,38 @@
+import mongoose from 'mongoose';
+/**
+ * Function for create model with dynamic collection name
+ * @param collectionName
+ * @returns
+ */
+declare const dynamicModelName: (collectionName: string) => Promise<mongoose.Model<any, unknown, unknown, unknown, any, any> | mongoose.Model<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {}, {}> & {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    timestamps: true;
+    minimize: false;
+    strict: false;
+}, {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {}>, {}> & mongoose.FlatRecord<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>>;
+export default dynamicModelName;

package/dist/src/platform-x/util/emailHandler.d.ts

@@ -0,0 +1,55 @@
+interface EmailOptions {
+    email: string;
+    emailTemplate: string;
+    subject: string;
+    bcc?: string;
+    personalizations?: Personalize;
+}
+interface Personalize {
+    to: [ToWithSubstitutions];
+    cc?: [ToWithSubstitutions];
+    bcc?: [ToWithSubstitutions];
+}
+interface ToWithSubstitutions {
+    to: string;
+    substitutions?: [string];
+}
+export declare class EmailHandler {
+    constructor();
+    /**
+     * post - handler to do emails triggering
+     * @param emailConfig
+     * @returns
+     */
+    sendEmail(emailConfig: EmailOptions): Promise<unknown>;
+    prepareEmailRequest(reqBody: any, emailType: any): Promise<any>;
+    /**
+     *
+     * @param reqBody
+     * @param emailType
+     * @returns
+     */
+    prepareSendEmailRequest(reqBody: any, emailType: any): Promise<any>;
+    /**
+     *
+     * @param emailConfiguration
+     * @returns
+     */
+    pushEmails(emailConfiguration: any): Promise<any>;
+    /**
+     * Function to send email with personalize data using sendgrid
+     * @param emailConfig
+     * @returns
+     */
+    sendEmailWithPersonalizations(emailConfig: any, isCFF?: any): Promise<unknown>;
+    /**
+     * prepare personalize email request to send email through sendgrid
+     * @param reqBody
+     * @returns
+     */
+    sendPersonalizeEmailRequest(reqBody: any): Promise<any>;
+    sendPlaceOrderEmail(reqBody: any): Promise<any>;
+    sendPlaceOrderEmailv1(reqBody: any): Promise<any>;
+    private fetchEmailTemplateData;
+}
+export {};

package/dist/src/platform-x/util/emailHandler.js

@@ -62,6 +62,8 @@ const formBuilder_dao_1 = __importDefault(require("../database/dao/formBuilder.d
 const dompurify_1 = __importDefault(require("dompurify"));
 const jsdom_1 = require("jsdom");
 const logger_1 = require("../../common/util/logger");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
 const window = new jsdom_1.JSDOM('').window;
 const DOMPurify = (0, dompurify_1.default)(window);
 // NOSONAR-NEXT-LINE
@@ -377,7 +379,8 @@ class EmailHandler {
                 const start = moment.tz(reqBody.dateTime, 'UTC'); // original timezone
                 let curentTimeZone = start;
                 curentTimeZone.tz(reqBody.timezoneOffset).format('Do MMMM YYYY, h:mm a');
-                let emailTemplate = 'templates/orderPlaced.ejs';
+                const emailTemplatePath = path_1.default.resolve(__dirname, '../templates/orderPlaced.ejs');
+                const emailTemplate = fs_1.default.readFileSync(emailTemplatePath, 'utf-8');
                 let billingStr = '';
                 billingStr +=
                     Object.keys(reqBody.billing_address).length !== 0

package/dist/src/platform-x/util/emailTemplate.d.ts

@@ -0,0 +1,4 @@
+export declare class EmailTemplateHandler {
+    constructor();
+    static prepareEmailTemplate(reqBody: any): Promise<string>;
+}

package/dist/src/platform-x/util/solr-data-source/SolrHttpDataSource.d.ts

@@ -0,0 +1,26 @@
+export interface Pagination {
+    start: number;
+    rows: number;
+}
+export interface FilterQueryType {
+    field: string;
+    value: string;
+}
+export interface SolrQueryRequest {
+    query: string | object;
+    filterQuery?: FilterQueryType[] | null | any;
+    pagination?: Pagination;
+    filter?: object | string[];
+    sort?: object;
+}
+export declare class SolrHttpDataSource<TContext = any> {
+    private solr;
+    context: TContext;
+    private cache;
+    private memoizedResults;
+    constructor();
+    cacheKey(id: string): string;
+    memoizedCacheKey(): string;
+    createQuery(queryRequest: SolrQueryRequest): void;
+    executeSearch(): Promise<any>;
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@platform-x/hep-notification-client",
-  "version": "1.0.0",
+  "version": "1.1.3",
   "description": "@platform-x/hep-notification-client",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc",
-    "prepare": "npm run build"
+    "build": "tsc && npm run copy-static",
+    "copy-static": "xcopy src\\templates dist\\templates /E /I /Y"
   },
   "author": "",
   "license": "ISC",
@@ -41,6 +41,7 @@
     "dotenv": "^10.0.0",
     "ejs": "^3.1.10",
     "express": "^4.17.1",
+    "fs": "^0.0.1-security",
     "jsdom": "^26.1.0",
     "lodash": "^4.17.21",
     "moment": "^2.30.1",