@vasrefil/api-toolkit 1.0.22 → 1.0.24

package/dist/env.d.ts

@@ -11,6 +11,10 @@ declare const env: {
         BASEURL: string;
         API_KEY: string | undefined;
     };
+    LOG: {
+        BASEURL: string;
+        API_KEY: string | undefined;
+    };
     AIRBRAKE: {
         PROJECT_ID: string | undefined;
         PROJECT_KEY: string | undefined;

package/dist/env.js

@@ -17,6 +17,10 @@ const env = {
         BASEURL: NODE_ENV === NODE_ENVS.PROD ? 'https://api.vasrefil.com' : 'https://api-v2-test.vasrefil.com',
         API_KEY: process.env.VASREFIL_API_KEY
     },
+    LOG: {
+        BASEURL: process.env.NODE_ENV === NODE_ENVS.PROD ? 'https://log-api.vasrefil.com' : 'https://log-api-dev.vasrefil.com',
+        API_KEY: process.env.VASREFIL_LOG_API_KEY
+    },
     AIRBRAKE: {
         PROJECT_ID: process.env.AIRBRAKE_PROJECT_ID,
         PROJECT_KEY: process.env.AIRBRAKE_PROJECT_KEY

package/dist/interfaces/interface.d.ts

@@ -1,5 +1,6 @@
 import { Status } from "./status.interface";
-import { Request, Response } from 'express';
+import { Response } from 'express';
+import { UserRequestI } from "./user.interface";
 export interface SampleI {
     _id: string;
     name: string;
@@ -7,15 +8,16 @@ export interface SampleI {
     createdAt: number;
 }
 export interface ServiceRespI {
-    req: Request;
+    req: UserRequestI;
+    request?: UserRequestI;
     res: Response;
     status: Status;
-    request?: Request;
     actionType: string;
     data?: any;
     message?: string;
     error?: any;
-    admin_message?: string;
+    NODE_ENV?: string;
+    code?: string;
 }
 export interface FiltersQueryI {
     filterSet: {

package/dist/middlewares/index.d.ts

@@ -1,2 +1,3 @@
 export * from './admin-auth.midware';
 export * from './user-auth.midware';
+export * from './validator.midware';

package/dist/middlewares/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./admin-auth.midware"), exports);
 __exportStar(require("./user-auth.midware"), exports);
+__exportStar(require("./validator.midware"), exports);

package/dist/middlewares/validator.midware.d.ts

@@ -5,8 +5,8 @@ import { Request, Response, NextFunction } from 'express';
  * Validation middleware that uses joi to validate the request body.
  * @param schema Joi schema to use to validate the request body
  */
-export declare class Joi extends RootService {
+export declare class JoiVdtor_ extends RootService {
     vdtor(schema: joi.Schema, field?: 'body' | 'query'): (req: Request, res: Response, next: NextFunction) => Promise<any>;
 }
-declare const newJoi: Joi;
-export default newJoi;
+declare const Joi: JoiVdtor_;
+export { Joi };

package/dist/middlewares/validator.midware.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Joi = void 0;
+exports.Joi = exports.JoiVdtor_ = void 0;
 const _root_service_1 = require("../services/_root.service");
 const status_interface_1 = require("../interfaces/status.interface");
 const { FAILED_VALIDATION } = status_interface_1.Status;
@@ -8,7 +8,7 @@ const { FAILED_VALIDATION } = status_interface_1.Status;
  * Validation middleware that uses joi to validate the request body.
  * @param schema Joi schema to use to validate the request body
  */
-class Joi extends _root_service_1.RootService {
+class JoiVdtor_ extends _root_service_1.RootService {
     vdtor(schema, field = 'body') {
         return async (req, res, next) => {
             const actionType = 'SCHEMA_VALIDATION';
@@ -17,16 +17,13 @@ class Joi extends _root_service_1.RootService {
                 next();
             }
             catch (err) {
-                const errorDetails = err.details.map((e) => e.message);
-                const response = {
-                    message: 'Some validation errors occured',
-                    errors: errorDetails,
-                };
-                return this.sendResponse({ req, res, status: FAILED_VALIDATION, actionType, data: response });
+                let message = 'Some validation errors occured';
+                const errorDetails = err && err.details && err.details;
+                return this.sendResponse({ req, res, status: FAILED_VALIDATION, actionType, message, error: errorDetails });
             }
         };
     }
 }
+exports.JoiVdtor_ = JoiVdtor_;
+const Joi = new JoiVdtor_;
 exports.Joi = Joi;
-const newJoi = new Joi();
-exports.default = newJoi;

package/dist/public-api.d.ts

@@ -4,3 +4,4 @@ export * from './utilities';
 export * from './app-middlewares';
 export * from './interfaces';
 export * from './middlewares';
+export * from './services';

package/dist/public-api.js

@@ -20,3 +20,4 @@ __exportStar(require("./utilities"), exports);
 __exportStar(require("./app-middlewares"), exports);
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./middlewares"), exports);
+__exportStar(require("./services"), exports);

package/dist/routes/sample.route.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const sample_service_1 = __importDefault(require("../services/sample.service"));
-const validator_midware_1 = __importDefault(require("../middlewares/validator.midware"));
+const validator_midware_1 = require("../middlewares/validator.midware");
 const sample_validator_1 = __importDefault(require("../validations/sample.validator"));
 class SampleRoute {
     loadRoutes(prefix, router) {
@@ -20,7 +20,7 @@ class SampleRoute {
         this.deleteById(prefix, router);
     }
     create(prefix, router) {
-        router.post(`${prefix}`, validator_midware_1.default.vdtor(sample_validator_1.default.create), sample_service_1.default.create);
+        router.post(`${prefix}`, validator_midware_1.Joi.vdtor(sample_validator_1.default.create), sample_service_1.default.create);
     }
     getAll(prefix, router) {
         router.get(`${prefix}`, sample_service_1.default.getAll);

package/dist/services/_root.service.d.ts

@@ -1,12 +1,14 @@
 import { Status } from '../interfaces/status.interface';
 import { ServiceRespI } from "../interfaces/interface";
 export declare class RootService {
+    SUCCESS: Status;
     sendResponse: (serviceResponse: ServiceRespI) => any;
     get_error(error: any): {
         status: Status;
         message: string;
         data: any;
     };
+    private sanitize_service_resp;
+    private get_response;
     private getHttpStatus;
-    private get_error_;
 }

package/dist/services/_root.service.js

@@ -1,42 +1,111 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RootService = void 0;
 const logger_util_1 = require("../utilities/logger.util");
 const status_interface_1 = require("../interfaces/status.interface");
+const airbrake_1 = require("../app-middlewares/airbrake");
+const log_util_1 = require("../utilities/log.util");
+const env_1 = __importDefault(require("../env"));
+const mongoose = __importStar(require("mongoose"));
 class RootService {
     constructor() {
+        this.SUCCESS = status_interface_1.Status.SUCCESS;
         this.sendResponse = (serviceResponse) => {
-            let { res, status, data, message, actionType, error } = serviceResponse;
+            let { res, data, actionType } = serviceResponse;
             try {
-                status = status || status_interface_1.Status.ERROR;
-                const code = error && error.code ? error.code : null;
-                const response = { status, data, message, code };
-                if (error) {
-                    response.error = this.get_error_(error);
-                }
-                const status_code = this.getHttpStatus(status);
+                const log_service_resp = this.sanitize_service_resp(serviceResponse);
+                const { response, status_code } = this.get_response(serviceResponse);
                 res.status(status_code).json(response);
                 if (status_code >= 400) {
                     const dataErr = data ? JSON.stringify(data) : data;
                     const error = `[${actionType || 'App Error'}] ${response.message} ${dataErr}`;
                     logger_util_1.winston.error(error);
                 }
+                log_util_1.LogUtil.user_event({ serviceResponse: log_service_resp });
             }
             catch (error) {
-                res.status(500).json({ status: 'ERROR', data: error, message: error.message });
+                logger_util_1.winston.error(error);
+                (0, airbrake_1.airbrake_request_logger)({ serviceResponse });
+                res.status(500).json({ status: 'ERROR', data: error, message: error?.message });
+            }
+        };
+        this.sanitize_service_resp = (serviceResponse) => {
+            const { user } = serviceResponse.req;
+            let user_;
+            if (user) {
+                user_ = {
+                    email: user.email,
+                    user_name: user.user_name,
+                };
             }
+            const request_data = log_util_1.LogUtil.get_request(serviceResponse.req);
+            const request = { ...request_data, user: user_, };
+            serviceResponse.request = request;
+            serviceResponse.NODE_ENV = env_1.default.NODE_ENV;
+            return serviceResponse;
         };
-        this.get_error_ = (err) => {
-            const error = err && err.error ? err.error : err;
-            const { req, message, status, code, ...err_rest } = error;
-            return err_rest;
+        this.get_response = (serviceResponse) => {
+            try {
+                let { status, data, message, error, code: code_ } = serviceResponse;
+                status = status || status_interface_1.Status.ERROR;
+                const code = error && error.code ? error.code : (code_ || null);
+                const status_code = this.getHttpStatus(status);
+                let response = { status, code, message, data };
+                return { response, status_code };
+            }
+            catch (error) {
+                logger_util_1.winston.error(error);
+                (0, airbrake_1.airbrake_request_logger)({ serviceResponse });
+                throw {
+                    message: 'Error occured try again later',
+                    error
+                };
+            }
         };
     }
     get_error(error) {
         let response = { status: status_interface_1.Status.ERROR, message: 'Request failed', data: null };
         const { status, message, data } = error;
         response.status = status ? status : response.status;
-        response.message = message ? message : response.message;
+        if (!(error instanceof mongoose.Error)) {
+            response.message = message ? message : response.message;
+        }
         response.data = data ? data : response.data;
         return response;
     }

package/dist/services/index.d.ts

@@ -0,0 +1 @@
+export * from './_root.service';

package/dist/services/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./_root.service"), exports);

package/dist/utilities/api-request.util.d.ts

@@ -6,4 +6,5 @@ interface ApiRequestPayloadI {
     params?: any;
 }
 export declare const VasrefilApiRequest: (request: ApiRequestPayloadI) => Promise<any>;
+export declare const LogApiRequest: (request: ApiRequestPayloadI) => Promise<any>;
 export {};

package/dist/utilities/api-request.util.js

@@ -3,16 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VasrefilApiRequest = void 0;
+exports.LogApiRequest = exports.VasrefilApiRequest = void 0;
 const axios_1 = __importDefault(require("axios"));
 const env_1 = __importDefault(require("../env"));
 const helpers_1 = require("../helpers");
-const API_KEY = env_1.default.VASREFIL.API_KEY;
-const BASEURL = env_1.default.VASREFIL.BASEURL;
-const VasrefilApiRequest = async (request) => {
+const ApiRequest = async (request, option) => {
     try {
-        let baseurl = request.baseurl || BASEURL;
-        const headers = { 'api-key': API_KEY };
+        const baseurl = request.baseurl || option.BASEURL;
+        const headers = { 'api-key': option.API_KEY };
         const { data } = await axios_1.default.request({
             method: request.method,
             url: `${baseurl}/${request.endpoint}`,
@@ -22,6 +20,17 @@ const VasrefilApiRequest = async (request) => {
         });
         return data;
     }
+    catch (error) {
+        throw error;
+    }
+};
+const VasrefilApiRequest = async (request) => {
+    try {
+        const API_KEY = env_1.default.VASREFIL.API_KEY;
+        const BASEURL = env_1.default.VASREFIL.BASEURL;
+        const data = await ApiRequest(request, { BASEURL, API_KEY });
+        return data;
+    }
     catch (error) {
         throw {
             error: helpers_1.RequestHelper.get_error(error),
@@ -30,3 +39,18 @@ const VasrefilApiRequest = async (request) => {
     }
 };
 exports.VasrefilApiRequest = VasrefilApiRequest;
+const LogApiRequest = async (request) => {
+    try {
+        const API_KEY = env_1.default.LOG.API_KEY;
+        const BASEURL = env_1.default.LOG.BASEURL;
+        const data = await ApiRequest(request, { BASEURL, API_KEY });
+        return data;
+    }
+    catch (error) {
+        throw {
+            error: helpers_1.RequestHelper.get_error(error),
+            admin_message: 'Vasrefil-Log-API: send api request failed'
+        };
+    }
+};
+exports.LogApiRequest = LogApiRequest;

package/dist/utilities/index.d.ts

@@ -1,3 +1,4 @@
 export * from './api-request.util';
 export * from './date.util';
 export * from './logger.util';
+export * from './log.util';

package/dist/utilities/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api-request.util"), exports);
 __exportStar(require("./date.util"), exports);
 __exportStar(require("./logger.util"), exports);
+__exportStar(require("./log.util"), exports);

package/dist/utilities/log.util.d.ts

@@ -0,0 +1,85 @@
+import { ServiceRespI } from '../interfaces/interface';
+import { UserRequestI } from '../interfaces/user.interface';
+declare class LogUtil_ {
+    user_event: (dto: {
+        serviceResponse: ServiceRespI;
+    }) => Promise<void>;
+    get_request: (req: UserRequestI) => {
+        params: import("express-serve-static-core").ParamsDictionary;
+        query: import("qs").ParsedQs;
+        headers: {
+            [key: string]: string | string[] | undefined;
+            accept?: string | undefined;
+            "accept-language"?: string | undefined;
+            "accept-patch"?: string | undefined;
+            "accept-ranges"?: string | undefined;
+            "access-control-allow-credentials"?: string | undefined;
+            "access-control-allow-headers"?: string | undefined;
+            "access-control-allow-methods"?: string | undefined;
+            "access-control-allow-origin"?: string | undefined;
+            "access-control-expose-headers"?: string | undefined;
+            "access-control-max-age"?: string | undefined;
+            "access-control-request-headers"?: string | undefined;
+            "access-control-request-method"?: string | undefined;
+            age?: string | undefined;
+            allow?: string | undefined;
+            "alt-svc"?: string | undefined;
+            "cache-control"?: string | undefined;
+            connection?: string | undefined;
+            "content-disposition"?: string | undefined;
+            "content-encoding"?: string | undefined;
+            "content-language"?: string | undefined;
+            "content-length"?: string | undefined;
+            "content-location"?: string | undefined;
+            "content-range"?: string | undefined;
+            "content-type"?: string | undefined;
+            cookie?: string | undefined;
+            date?: string | undefined;
+            etag?: string | undefined;
+            expect?: string | undefined;
+            expires?: string | undefined;
+            forwarded?: string | undefined;
+            from?: string | undefined;
+            host?: string | undefined;
+            "if-match"?: string | undefined;
+            "if-modified-since"?: string | undefined;
+            "if-none-match"?: string | undefined;
+            "if-unmodified-since"?: string | undefined;
+            "last-modified"?: string | undefined;
+            location?: string | undefined;
+            origin?: string | undefined;
+            pragma?: string | undefined;
+            "proxy-authenticate"?: string | undefined;
+            "proxy-authorization"?: string | undefined;
+            "public-key-pins"?: string | undefined;
+            range?: string | undefined;
+            referer?: string | undefined;
+            "retry-after"?: string | undefined;
+            "sec-websocket-accept"?: string | undefined;
+            "sec-websocket-extensions"?: string | undefined;
+            "sec-websocket-key"?: string | undefined;
+            "sec-websocket-protocol"?: string | undefined;
+            "sec-websocket-version"?: string | undefined;
+            "set-cookie"?: string[] | undefined;
+            "strict-transport-security"?: string | undefined;
+            tk?: string | undefined;
+            trailer?: string | undefined;
+            "transfer-encoding"?: string | undefined;
+            upgrade?: string | undefined;
+            "user-agent"?: string | undefined;
+            vary?: string | undefined;
+            via?: string | undefined;
+            warning?: string | undefined;
+            "www-authenticate"?: string | undefined;
+        };
+        method: string;
+        url: string;
+        statusCode: number | undefined;
+        body: any;
+    };
+    private get_user_event_response;
+    private get_user;
+    private create_activity_log;
+}
+declare const LogUtil: LogUtil_;
+export { LogUtil };

package/dist/utilities/log.util.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogUtil = void 0;
+const airbrake_1 = require("../app-middlewares/airbrake");
+const api_request_util_1 = require("./api-request.util");
+const json_stringify_safe = require('json-stringify-safe');
+class LogUtil_ {
+    constructor() {
+        this.user_event = async (dto) => {
+            const { request, actionType, status } = dto.serviceResponse;
+            try {
+                const statuses = ['SUCCESS', 'CREATED', 'PROCESSING'];
+                if (!statuses.includes(status)) {
+                    const user = this.get_user(dto.serviceResponse);
+                    const response = this.get_user_event_response(dto.serviceResponse);
+                    const payload = {
+                        distinct_id: user.distinct_id,
+                        request: JSON.stringify(request),
+                        response: JSON.stringify(response),
+                        request_url: request?.url,
+                        event: actionType,
+                        type: 'USER_EVENT',
+                        response_status: status,
+                    };
+                    await this.create_activity_log(payload);
+                }
+            }
+            catch (error) {
+                airbrake_1.airbrake.notify({
+                    error: JSON.stringify(error),
+                    context: { component: 'USER_EVENT' },
+                    params: { actionType, status, request },
+                });
+            }
+        };
+        this.get_request = (req) => {
+            const { authorization, pin_token, ...headers_ } = req.headers;
+            const { password, pin, old_pin, new_pin, bvn, nin, file, ...body_ } = req.body;
+            const { params, query, method, url, statusCode } = req;
+            delete headers_['pin-token'];
+            const request = {
+                params, query, headers: headers_, method, url, statusCode,
+                body: body_,
+            };
+            return request;
+        };
+        this.get_user_event_response = (serviceResponse) => {
+            const { data, message, error } = serviceResponse;
+            let response = {};
+            if (data || message || error) {
+                if (error) {
+                    delete error.req;
+                }
+                const data_ = data ? json_stringify_safe(data) : null;
+                const error_ = error ? json_stringify_safe(error, null) : null;
+                const message_ = message ? message : null;
+                response = {
+                    message: message_, error: error_
+                };
+            }
+            return response;
+        };
+        this.get_user = (serviceResponse) => {
+            const { req, actionType } = serviceResponse;
+            let distinct_id = req.user ? req.user.email : (req.body.email || '--');
+            // if(this.cronjobs_events.includes(actionType)) {
+            //     distinct_id = 'cron-job.org';
+            // }
+            if (actionType.toLowerCase().includes('webhook')) {
+                distinct_id = actionType.toLowerCase();
+            }
+            if (req.admin_user) {
+                distinct_id = req.admin_user.email;
+            }
+            return { distinct_id };
+        };
+        this.create_activity_log = async (body) => {
+            try {
+                const resp = await (0, api_request_util_1.LogApiRequest)({
+                    method: 'POST',
+                    endpoint: 'activities',
+                    body
+                });
+                return resp;
+            }
+            catch (error) {
+                throw error;
+            }
+        };
+    }
+}
+const LogUtil = new LogUtil_;
+exports.LogUtil = LogUtil;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vasrefil/api-toolkit",
   "description": "This is Vasrefil API toolkit",
-  "version": "1.0.22",
+  "version": "1.0.24",
   "author": "Sodiq Alabi",
   "main": "dist/public-api.js",
   "types": "dist/public-api.d.ts",