@vasrefil/api-toolkit 1.2.8 → 1.3.1

package/dist/helpers/query.helper.js

@@ -33,6 +33,12 @@ class QueryHelper_ {
                             const value = isNaN(fit.value) ? fit.value : Number(fit.value);
                             result.push({ [fit.field]: { $lte: value } });
                         }
+                        else if (fit.operator === 'date_gte') {
+                            result.push({ [fit.field]: { $gte: date_util_1.DateUtil.get_local_date(fit.value) } });
+                        }
+                        else if (fit.operator === 'date_lte') {
+                            result.push({ [fit.field]: { $lte: date_util_1.DateUtil.get_local_date(fit.value) } });
+                        }
                     });
                     filter_query = { [logical_operator]: result };
                 }

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

@@ -1,5 +1,5 @@
 declare class DateUtil_ {
-    get_local_date: (date?: Date) => Date;
+    get_local_date: (date?: string | Date) => Date;
     get_start_date(date: any): number;
     get_end_date(date: any): number;
     get_date_format(date: Date, format: string): Date;

package/dist/utilities/go-mailer.util.js

@@ -63,7 +63,7 @@ class GoMailerUtil_ {
         this.trigger_event = async (payload) => {
             try {
                 const headers = { Authorization: `Bearer ${env_1.default.GO_MAILER.API_KEY}` };
-                const url = 'https://automata.go-mailer.com/api/v1/events/trigger';
+                const url = 'https://api.go-mailer.com/v1/automations';
                 const { data } = await axios_1.default.post(url, payload, { headers });
                 return data;
             }
@@ -75,7 +75,7 @@ class GoMailerUtil_ {
         this.send_transactional_email = async (payload) => {
             try {
                 const headers = { Authorization: `Bearer ${env_1.default.GO_MAILER.API_KEY}` };
-                const url = 'https://mailing.go-mailer.com/api/v1/transactionals/dispatch';
+                const url = 'https://api.go-mailer.com/v1/transactionals';
                 const { data } = await axios_1.default.post(url, payload, { headers });
                 return data;
             }

package/package.json

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

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

@@ -1,8 +0,0 @@
-import { RootService } from '../services/_root.service';
-import { Request, Response, NextFunction } from 'express';
-declare class AuthMidWare extends RootService {
-    private _is_authenticated;
-    auth: (req: Request, res: Response, next: NextFunction) => Promise<any>;
-}
-declare const _default: AuthMidWare;
-export default _default;

package/dist/middlewares/auth.midware.js

@@ -1,52 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const token_util_1 = __importDefault(require("../utilities/token.util"));
-const _root_service_1 = require("../services/_root.service");
-const status_interface_1 = require("../interfaces/status.interface");
-const user_response_1 = require("../api-response/user.response");
-const env_1 = __importDefault(require("../env"));
-class AuthMidWare extends _root_service_1.RootService {
-    constructor() {
-        super(...arguments);
-        this._is_authenticated = async (req) => {
-            try {
-                const apiKey = req.headers['api-key'];
-                if (apiKey) {
-                    if (apiKey !== env_1.default.API_KEY)
-                        throw user_response_1.UserApiResp.NOT_AUTHORIZED;
-                }
-                else {
-                    const authHeader = req.headers.authorization;
-                    if (!authHeader)
-                        throw user_response_1.UserApiResp.NO_AUTHORIZATION_HEADER;
-                    const token = authHeader.split(' ')[1];
-                    const tokenData = await token_util_1.default.verify_admin_user(token);
-                    if (!tokenData)
-                        throw user_response_1.UserApiResp.NOT_AUTHORIZED;
-                    req.user = tokenData;
-                }
-                return req;
-            }
-            catch (error) {
-                const status = error.status || status_interface_1.Status.UN_AUTHORIZED;
-                const message = error.message || 'You are not authorized';
-                throw { status, message, error, req };
-            }
-        };
-        this.auth = async (req, res, next) => {
-            const actionType = 'USER_AUTH_MIDWARE';
-            try {
-                await this._is_authenticated(req);
-                next();
-            }
-            catch (error) {
-                const { status, message, data } = this.get_error(error);
-                return this.sendResponse({ req, res, status, actionType, message, data, error });
-            }
-        };
-    }
-}
-exports.default = new AuthMidWare;

package/dist/out-tsc/api-response/user.response.d.ts

@@ -1,48 +0,0 @@
-import { Status } from '../interfaces/status.interface';
-export declare const UserApiResp: {
-    NO_AUTHORIZATION_HEADER: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    NOT_AUTHORIZED: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    USER_NOT_FOUND: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    USER_DEACTIVATED: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    UNVERIFIED_EMAIL: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    UNCOMPELETE_ACCOUNT_SETUP: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    UNCOMPELETE_PIN_SETUP: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    NO_PIN_TOKEN_HEADER: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-    EXPIRED_PIN_TOKEN: {
-        code: string;
-        status: Status;
-        message: string;
-    };
-};

package/dist/out-tsc/api-response/user.response.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserApiResp = void 0;
-const status_interface_1 = require("../interfaces/status.interface");
-exports.UserApiResp = {
-    NO_AUTHORIZATION_HEADER: {
-        code: 'NAH0401', status: status_interface_1.Status.UN_AUTHORIZED, message: 'Please specify authorization header'
-    },
-    NOT_AUTHORIZED: {
-        code: 'NA00401', status: status_interface_1.Status.UN_AUTHORIZED, message: 'You are not authorized'
-    },
-    USER_NOT_FOUND: {
-        code: 'UNF0401', status: status_interface_1.Status.UN_AUTHORIZED, message: 'User not found'
-    },
-    USER_DEACTIVATED: {
-        code: 'UD00401', status: status_interface_1.Status.UN_AUTHORIZED, message: 'Your account has been deactivated'
-    },
-    UNVERIFIED_EMAIL: {
-        code: 'UE00403', status: status_interface_1.Status.FORBIDDEN, message: 'Your email address is not verified'
-    },
-    UNCOMPELETE_ACCOUNT_SETUP: {
-        code: 'UAS0403', status: status_interface_1.Status.FORBIDDEN, message: 'Account setup is not completed'
-    },
-    UNCOMPELETE_PIN_SETUP: {
-        code: 'UPS0403', status: status_interface_1.Status.FORBIDDEN, message: 'Pin setup is not completed'
-    },
-    NO_PIN_TOKEN_HEADER: {
-        code: 'NPTH401', status: status_interface_1.Status.UN_AUTHORIZED, message: 'Please specify pin_token header'
-    },
-    EXPIRED_PIN_TOKEN: {
-        code: 'EPT0401', status: status_interface_1.Status.UN_AUTHORIZED, message: 'Your session has expired, Please login with your pin'
-    },
-};

package/dist/out-tsc/app-middlewares/airbrake.d.ts

@@ -1,10 +0,0 @@
-import { ServiceRespI } from '../interfaces/interface';
-declare class AirbrakeLogger {
-    private airbrake;
-    constructor(projectId: string, projectKey: string);
-    logRequestError(serviceResponse: ServiceRespI): void;
-    logError(error: any, params: any, route: any): void;
-    getAirbrakeInstance(): any;
-    getAirbrakeExpress(): any;
-}
-export { AirbrakeLogger };

package/dist/out-tsc/app-middlewares/airbrake.js

@@ -1,58 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AirbrakeLogger = void 0;
-const env_1 = __importDefault(require("../env"));
-const Airbrake = require('@airbrake/node');
-const airbrakeExpress = require('@airbrake/node/dist/instrumentation/express');
-const json_stringify_safe = require('json-stringify-safe');
-class AirbrakeLogger {
-    constructor(projectId, projectKey) {
-        this.airbrake = new Airbrake.Notifier({
-            projectId: projectId,
-            projectKey: projectKey,
-            environment: `${env_1.default.NODE_ENV}`
-        });
-    }
-    logRequestError(serviceResponse) {
-        try {
-            const { request, error, data, message, actionType } = serviceResponse;
-            const dataErr = data ? json_stringify_safe(data) : null;
-            const errorErr = error ? json_stringify_safe(error, null) : null;
-            const messageErr = message ? json_stringify_safe(message) : null;
-            const error_ = messageErr || errorErr || dataErr;
-            const actionType_ = actionType || 'App Error';
-            const body = request && request.body ? request.body : 'no body';
-            const url = request && request.url ? request.url : 'no url';
-            this.airbrake.notify({
-                error: error_,
-                params: { url, body, actionType: actionType_ },
-                route: url
-            });
-        }
-        catch (error) {
-            this.airbrake.notify(error);
-        }
-    }
-    logError(error, params, route) {
-        try {
-            this.airbrake.notify({
-                error: json_stringify_safe(error, null),
-                params,
-                route
-            });
-        }
-        catch (error) {
-            this.airbrake.notify(error);
-        }
-    }
-    getAirbrakeInstance() {
-        return this.airbrake;
-    }
-    getAirbrakeExpress() {
-        return airbrakeExpress;
-    }
-}
-exports.AirbrakeLogger = AirbrakeLogger;

package/dist/out-tsc/controllers/_root.control.d.ts

@@ -1,53 +0,0 @@
-/// <reference types="mongoose/types/aggregate" />
-/// <reference types="mongoose/types/callback" />
-/// <reference types="mongoose/types/collection" />
-/// <reference types="mongoose/types/connection" />
-/// <reference types="mongoose/types/cursor" />
-/// <reference types="mongoose/types/document" />
-/// <reference types="mongoose/types/error" />
-/// <reference types="mongoose/types/expressions" />
-/// <reference types="mongoose/types/helpers" />
-/// <reference types="mongoose/types/middlewares" />
-/// <reference types="mongoose/types/indexes" />
-/// <reference types="mongoose/types/models" />
-/// <reference types="mongoose/types/mongooseoptions" />
-/// <reference types="mongoose/types/pipelinestage" />
-/// <reference types="mongoose/types/populate" />
-/// <reference types="mongoose/types/query" />
-/// <reference types="mongoose/types/schemaoptions" />
-/// <reference types="mongoose/types/schematypes" />
-/// <reference types="mongoose/types/session" />
-/// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/utility" />
-/// <reference types="mongoose/types/validation" />
-/// <reference types="mongoose/types/virtuals" />
-/// <reference types="mongoose/types/inferschematype" />
-import { Model } from 'mongoose';
-import { FetchAllQuery, FetchWithPaginationDataI, ModelPopulateI, NestedRecordQueryOptionsI } from '../interfaces/root-controller.interface';
-export declare class RootController {
-    private model;
-    private modelName;
-    constructor(model: Model<any>, modelName?: string);
-    unique: (conditions: {
-        key: string;
-        value: string;
-    }) => Promise<boolean>;
-    getDocumentCount: (conditon?: {}, query?: object) => Promise<number>;
-    create: (payload: any) => Promise<any>;
-    fetchAll(condition?: object, query?: FetchAllQuery, select?: string | object, populate?: any): import("mongoose").Query<Omit<any, never>[], any, {}, any>;
-    fetchAllWithPagination: (conditon: object, query?: FetchAllQuery, select?: string | object, populate?: ModelPopulateI[]) => Promise<FetchWithPaginationDataI>;
-    getOneP: (condition: object, select?: any) => Promise<any>;
-    getOne(condition: object, select?: string | object, populate?: any): any;
-    getById: (id: string, select?: string | object) => Promise<any>;
-    updateOne(condition: object, updateValues: object): any;
-    updateMany(condition: object, updateValues: object): import("mongoose").Query<import("mongodb").UpdateResult, any, {}, any>;
-    updateById(id: string, updateValues: object): any;
-    deleteOne(condition: object): import("mongoose").Query<import("mongodb").DeleteResult, any, {}, any>;
-    deleteMany(condition: object): import("mongoose").Query<import("mongodb").DeleteResult, any, {}, any>;
-    deleteById(id: string): import("mongoose").Query<any, any, {}, any>;
-    search: (payload: {
-        key: any;
-        value: any;
-    }, select?: string) => Promise<never>;
-    getNestedRecord: (options: NestedRecordQueryOptionsI, errorMessage?: string) => Promise<any>;
-}

package/dist/out-tsc/controllers/_root.control.js

@@ -1,127 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RootController = void 0;
-const query_helper_1 = require("../helpers/query.helper");
-class RootController {
-    constructor(model, modelName = 'Document') {
-        this.unique = async (conditions) => {
-            const { key, value } = conditions;
-            const res = await this.model.findOne({ [key]: value });
-            if (res) {
-                return false;
-            }
-            else {
-                return true;
-            }
-        };
-        this.getDocumentCount = async (conditon = {}, query) => {
-            const { filter } = query_helper_1.QueryHelper.build_query(query);
-            return await this.model.countDocuments({ ...filter, ...conditon });
-        };
-        this.create = async (payload) => {
-            try {
-                const document = await (this.model.create({ ...payload }));
-                return document.toJSON();
-            }
-            catch (error) {
-                throw error;
-            }
-        };
-        this.fetchAllWithPagination = async (conditon, query, select = '', populate) => {
-            try {
-                const records = await this.fetchAll(conditon, query, select, populate);
-                const total_records = await this.getDocumentCount(conditon, query);
-                return { records, total_records };
-            }
-            catch (error) {
-                throw error;
-            }
-        };
-        this.getOneP = async (condition, select) => {
-            try {
-                select = select ? select : '';
-                const document = await this.model.findOne(condition).select(select).lean();
-                if (!document)
-                    throw { message: `${this.modelName} not found` };
-                return document;
-            }
-            catch (error) {
-                throw error;
-            }
-        };
-        this.getById = async (id, select = '') => {
-            try {
-                const document = await this.model.findById(id).select(select).lean();
-                if (!document)
-                    throw { message: `${this.modelName} not found` };
-                return document;
-            }
-            catch (error) {
-                throw error;
-            }
-        };
-        this.search = async (payload, select = '') => {
-            try {
-                const regrex = new RegExp(`${payload.value}`, 'i');
-                const records = await this.model.find({ [payload.key]: { $regex: regrex } }).select(select);
-                if (!records)
-                    throw { message: `${this.modelName} not found` };
-                throw records;
-            }
-            catch (error) {
-                throw error;
-            }
-        };
-        this.getNestedRecord = async (options, errorMessage) => {
-            const { parentField, childIdField = '_id', parentId, childId } = options;
-            // Build the query
-            const query = {
-                _id: parentId,
-                [`${parentField}.${childIdField}`]: { $eq: childId }
-            };
-            // Build the projection
-            const projection = {
-                [parentField]: {
-                    $elemMatch: {
-                        [childIdField]: childId
-                    }
-                }
-            };
-            // Execute the query
-            const result = await this.model.findOne(query, projection);
-            if (!result) {
-                throw new Error(errorMessage || `Nested record not found in ${parentField}`);
-            }
-            // Return the first element of the matched array
-            return result[parentField][0];
-        };
-        this.model = model;
-        this.modelName = modelName;
-    }
-    fetchAll(condition = {}, query, select = '', populate) {
-        const { filter, skip, limit, sort } = query_helper_1.QueryHelper.build_query(query);
-        return this.model.find({ ...filter, ...condition }).select(select).skip(skip).limit(limit).sort(sort).populate(populate);
-    }
-    getOne(condition, select = '', populate) {
-        return this.model.findOne(condition).select(select).populate(populate).lean();
-    }
-    updateOne(condition, updateValues) {
-        return this.model.updateOne({ ...condition }, { ...updateValues }, { new: true });
-    }
-    updateMany(condition, updateValues) {
-        return this.model.updateMany({ ...condition }, { ...updateValues }).lean();
-    }
-    updateById(id, updateValues) {
-        return this.model.findByIdAndUpdate(id, { ...updateValues }, { new: true }).lean();
-    }
-    deleteOne(condition) {
-        return this.model.deleteOne({ ...condition });
-    }
-    deleteMany(condition) {
-        return this.model.deleteMany({ ...condition });
-    }
-    deleteById(id) {
-        return this.model.findByIdAndDelete(id);
-    }
-}
-exports.RootController = RootController;

package/dist/out-tsc/controllers/index.d.ts

@@ -1 +0,0 @@
-export * from "./_root.control";

package/dist/out-tsc/controllers/index.js

@@ -1,17 +0,0 @@
-"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.control"), exports);

package/dist/out-tsc/controllers/sample.control.d.ts

@@ -1,6 +0,0 @@
-import { RootController } from './_root.control';
-declare class SampleController extends RootController {
-    constructor();
-}
-declare const _default: SampleController;
-export default _default;

package/dist/out-tsc/controllers/sample.control.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _root_control_1 = require("./_root.control");
-const sample_model_1 = __importDefault(require("../models/sample.model"));
-class SampleController extends _root_control_1.RootController {
-    constructor() {
-        super(sample_model_1.default);
-    }
-}
-exports.default = new SampleController;

package/dist/out-tsc/env.d.ts

@@ -1,12 +0,0 @@
-declare const env: {
-    MONGODB_URI: string | undefined;
-    ADMIN_JWT_KEY: string;
-    NODE_ENV: string | undefined;
-    RATE_LIMIT_REDIS_URL: string | undefined;
-    API_KEY: string | undefined;
-    AIRBRAKE: {
-        PROJECT_ID: string | undefined;
-        PROJECT_KEY: string | undefined;
-    };
-};
-export default env;

package/dist/out-tsc/env.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const dotenv = require('dotenv');
-dotenv.config();
-const env = {
-    MONGODB_URI: process.env.MONGODB_URI,
-    ADMIN_JWT_KEY: process.env.ADMIN_JWT_KEY,
-    NODE_ENV: process.env.NODE_ENV,
-    RATE_LIMIT_REDIS_URL: process.env.RATE_LIMIT_REDIS_URL,
-    API_KEY: process.env.API_KEY,
-    AIRBRAKE: {
-        PROJECT_ID: process.env.AIRBRAKE_PROJECT_ID,
-        PROJECT_KEY: process.env.AIRBRAKE_PROJECT_KEY
-    },
-};
-exports.default = env;

package/dist/out-tsc/helpers/currency-formatter.helper.d.ts

@@ -1 +0,0 @@
-export declare const currency_fmt: (value: any) => string;

package/dist/out-tsc/helpers/currency-formatter.helper.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.currency_fmt = void 0;
-const currency_fmt = (value) => {
-    const result = new Intl.NumberFormat('en-NG', {
-        style: 'currency',
-        currency: 'NGN',
-    }).format(value);
-    return result;
-};
-exports.currency_fmt = currency_fmt;

package/dist/out-tsc/helpers/query.helper.d.ts

@@ -1,22 +0,0 @@
-declare class QueryHelper_ {
-    build_query(query: any): {
-        sort: any;
-        limit: number;
-        skip: number;
-        filter: any;
-        page: number;
-    };
-    get_date_range(payload: {
-        date_type: string;
-        date_range: {
-            start_date: Date;
-            end_date: Date;
-        };
-    }): {};
-    get_filters(filter: any): any;
-    process_filters: (query: any) => {} | undefined;
-    private get_sort;
-    private str_to_obj;
-}
-declare const QueryHelper: QueryHelper_;
-export { QueryHelper };