itrm-tools 1.3.5-beta.1 → 1.3.5-beta.2

package/src/api/APIService.ts

@@ -1,117 +0,0 @@
-import express, { Express, Request, Response } from 'express';
-import { APIRequest } from './APIRequest';
-import { APIRouter } from './APIRouter';
-import { ExpressConfiguration } from './ExpressConfiguration';
-import { DocumentationRequest } from './request/docs/DocumentationRequest';
-
-export namespace ITRMAPIServiceGlobal {
-    export var memory: any = {};
-    export var service: APIService | undefined = undefined;
-    export var requests: any = {};
-    export var routers: any = {};
-    export var whitelist: string[] = [];
-    export var tools: any = {};
-}
-
-export declare interface APIServiceConfig {
-    name: string,
-    port: string | number,
-    express: ExpressConfiguration
-}
-
-export declare interface APIServiceResponse {
-    status: string,
-    message: string,
-    error?: any
-}
-
-export class APIService {
-    protected server: any = undefined;
-    protected app: Express = express();
-    protected name: string;
-    protected port: number | string;
-    protected config: ExpressConfiguration;
-
-    constructor(config: APIServiceConfig) {
-        this.name = config.name;
-        this.port = config.port;
-        this.config = config.express;
-    }
-
-    public init() {
-        ITRMAPIServiceGlobal.service = this;
-        this.config.apply(this.app);
-        this.app.get('/', (req: Request, res: Response | any) => {
-            return res.send('Server working!');
-        });
-    }
-
-    public addRouter(router: APIRouter) {
-        ITRMAPIServiceGlobal.routers[router.path] = router;
-        this.app.use(router.path, router.router);
-    }
-
-    public addRequest(request: APIRequest) {
-        ITRMAPIServiceGlobal.requests[request.method + "_" + request.path] = request;
-        request.addToApp(this.app);
-    }
-
-    public getServerInformation() {
-        return {
-            name: this.name,
-            port: this.port,
-            routers: ITRMAPIServiceGlobal.routers,
-            requests: ITRMAPIServiceGlobal.requests
-        }
-    }
-
-    public enableDocumentation() {
-        const swaggerUi = require('swagger-ui-express');
-        const documentationRequest = new DocumentationRequest();
-        this.app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(documentationRequest.init()));
-    }
-
-    public run(init: Function): Promise<APIServiceResponse> {
-        return new Promise<APIServiceResponse>((resolve, reject) => {
-            this.server = this.app.listen(this.port, async () => {
-                console.log(`⚡️[server]: Server is running at http://localhost:${this.port}`);
-                try {
-                    await init();
-                    resolve({ status: 'Ok', message: 'Server has been Initialized' });
-                } catch (err: any) {
-                    reject({
-                        status: 'Error',
-                        message: 'An error has ocurred in the initialization function',
-                        error: err
-                    });
-                }
-            });
-        });
-    }
-
-    public close(finish: Function): Promise<APIServiceResponse> {
-        return new Promise<APIServiceResponse>((resolve, reject) => {
-            this.server.close(async (err: any) => {
-                if (err)
-                    reject({
-                        status: 'Error',
-                        message: 'An error has ocurred when closing Server',
-                        error: err
-                    });
-                try {
-                    await finish();
-                    resolve({
-                        status: 'Ok',
-                        message: 'Server has been closed'
-                    });
-                } catch (err: any) {
-                    reject({
-                        status: 'Error',
-                        message: 'An error has ocurred in the closing function',
-                        error: err
-                    });
-                }
-            });
-        });
-    }
-}

package/src/api/ExpressConfiguration.ts

@@ -1,5 +0,0 @@
-import { Express } from 'express';
-
-export interface ExpressConfiguration {
-    apply(app: Express): void;
-}

package/src/api/HttpsAPIService.ts

@@ -1,35 +0,0 @@
-import https, { ServerOptions } from 'https';
-import { APIService, APIServiceConfig, APIServiceResponse } from "./APIService";
-
-export class HttpsAPIService extends APIService {
-    private httpsServer: any = undefined;
-    private options: ServerOptions;
-
-    constructor(config: APIServiceConfig, options: ServerOptions) {
-        super(config);
-        this.options = options;
-    }
-
-    public init() {
-        super.init();
-        this.httpsServer = https.createServer(this.options, this.app);
-    }
-
-    public run(init: Function): Promise<APIServiceResponse> {
-        return new Promise<APIServiceResponse>((resolve, reject) => {
-            this.server = this.httpsServer.listen(this.port, async () => {
-                console.log(`⚡️[server]: Server is running at https://localhost:${this.port}`);
-                try {
-                    await init();
-                    resolve({ status: 'Ok', message: 'Server has been Initialized' });
-                } catch (err: any) {
-                    reject({
-                        status: 'Error',
-                        message: 'An error has ocurred in the initialization function',
-                        error: err
-                    });
-                }
-            });
-        });
-    }
-}

package/src/api/alegra/AlegraConnectionManager.ts

@@ -1,54 +0,0 @@
-import { AxiosRequestConfig } from "axios";
-import { RequestAxiosCall } from "../request/RequestAxiosCall";
-import { IAlegraContact, IAlegraJournal, IAlegraPayment, IAlegraResult } from "./AlegraTypes";
-
-export class AlegraConnectionManager {
-    private alegraUrl: string;
-    private headers: AxiosRequestConfig;
-
-    constructor(alegraUrl: string, token: string) {
-        this.alegraUrl = alegraUrl;
-        this.headers = { headers: { Authorization: `Basic ${token}` } };
-    }
-
-    public async createContact(contact: IAlegraContact) {
-        return (await RequestAxiosCall.post(`${this.alegraUrl}/v1/contacts`, contact, this.headers)) as IAlegraContact;
-    }
-
-    public async findContact(document: string): Promise<IAlegraContact | undefined> {
-        let response: any = await RequestAxiosCall.get(`${this.alegraUrl}/v1/contacts?order_direction=ASC&identification=${document}`, this.headers);
-        return response.length > 0 ? response[0] : undefined;
-    }
-    
-    public async createJournal(body: IAlegraJournal) {
-        return (await RequestAxiosCall.post(`${this.alegraUrl}/v1/journals`, body, this.headers)) as IAlegraJournal;
-    }
-
-    public async findJournal(journalId: string | number) {
-        return (await RequestAxiosCall.get(`${this.alegraUrl}/v1/journals/${journalId}`, this.headers) as IAlegraJournal);
-    }
-
-    public async updateJournal(journalId: string | number, body: IAlegraJournal) {
-        return await RequestAxiosCall.put(`${this.alegraUrl}/v1/journals/${journalId}`, body, this.headers);
-    }
-
-    public async deleteJournal(journalId: string | number) {
-        return (await RequestAxiosCall.delete(`${this.alegraUrl}/v1/journals/${journalId}`, this.headers)) as IAlegraResult;
-    }
-
-    public async createPayment(body: IAlegraPayment) {
-        return (await RequestAxiosCall.post(`${this.alegraUrl}/v1/payments`, body, this.headers)) as IAlegraPayment;
-    }
-    
-    public async findPayment(paymentId: string | number) {
-        return (await RequestAxiosCall.get(`${this.alegraUrl}/v1/payments/${paymentId}`, this.headers) as IAlegraPayment);
-    }
-    
-    public async updatePayment(paymentId: string | number, body: IAlegraPayment) {
-        return await RequestAxiosCall.put(`${this.alegraUrl}/v1/payments/${paymentId}`, body, this.headers);
-    }
-
-    public async deletePayment(paymentId: string | number) {
-        return (await RequestAxiosCall.delete(`${this.alegraUrl}/v1/payments/${paymentId}`, this.headers)) as IAlegraResult;
-    }
-}

package/src/api/alegra/AlegraTypes.ts

@@ -1,150 +0,0 @@
-export interface IAlegraContact {
-    id?: string | number;
-    name?: string;
-    identification?: string;
-    email?: string;
-    phonePrimary?: string;
-    phoneSecondary?: string;
-    fax?: string;
-    mobile?: string;
-    observations?: string;
-    status?: 'active' | 'inactive';
-    kindOfPerson?: 'PERSON_ENTITY' | 'LEGAL_ENTITY ' | 'OTHER_ENTITY ';
-    regime?: 'COMMON_REGIME' | 'SIMPLIFIED_REGIME' | 'NATIONAL_CONSUMPTION_TAX' | 'NOT_REPONSIBLE_FOR_CONSUMPTION' | 'INC_IVA_RESPONSIBLE' | 'SPECIAL_REGIME';
-    nameObject?: {
-        firstName: string;
-        secondName: string;
-        lastName: string;
-        secondLastName?: string;
-    };
-    identificationObject?: {
-        type: 'CC' | 'TI' | 'NIT' | 'DIE' | 'PP' | 'CE' | 'TE' | 'RC' | 'FOREIGN_NIT' | 'NUIP';
-        number: string;
-        dv?: string;
-    };
-    fiscalResidence?: 'RESIDENT' | 'NON_RESIDENT';
-    enableHealthSector?: boolean;
-    healthPatients?: any;
-    address?: {
-        address: string;
-        city: string;
-        department?: string;
-        country?: 'Colombia';
-        zipCode?: string;
-    };
-    type?: string[];
-    seller?: any;
-    term?: {
-        id: number;
-        name: string;
-        days: string;
-    };
-    priceList?: {
-        id: number;
-        name: string;
-    };
-    internalContacts?: string[];
-    settings?: { sendElectronicDocuments: boolean; };
-    statementAttached?: boolean;
-    accounting?: {
-        accountReceivable: {
-          id: string;
-          idParent: string;
-          name: string;
-          text: string;
-          code: string;
-          description: string;
-          type: string;
-          readOnly: boolean;
-          nature: string;
-          blocked: string;
-          status: string;
-          categoryRule: any;
-          use: string;
-          showThirdPartyBalance: boolean
-        };
-        debtToPay: {
-          id: string;
-          idParent: string;
-          name: string;
-          text: string;
-          code: string;
-          description: string;
-          type: string;
-          readOnly: boolean;
-          nature: string;
-          blocked: string;
-          status: string;
-          categoryRule?: any;
-          use: string;
-          showThirdPartyBalance: boolean
-        }
-    }
-}
-
-export interface IAlegraPayment {
-    id?: string | number;
-    date: string;
-    bankAccount: {
-        id: string | number;
-    };
-    client: IAlegraContact,
-    paymentMethod: 'transfer' | 'cash' | 'deposit' | 'check' | 'credit-card' | 'debit-card';
-    observations: string;
-    anotation: string;
-    type: 'in' | 'out';
-    categories: IAlegraCategory[];
-    costCenter?: any;
-    numberTemplate?: {
-        id: string;
-        prefix: any,
-        number: string;
-        fullNumber: string;
-        formattedNumber:string;
-    }
-}
-
-export interface IAlegraCategory {
-    id: string | number;
-    name?: string;
-    price: number;
-    quantity: number;
-    observations: string;
-    total?: number;
-    behavior?: string;
-    tax?: any[]
-}
-
-export interface IAlegraJournal {
-    id?: string | number;
-    date: string;
-    observations: string;
-    entries: IAlegraEntry[];
-    client?: IAlegraContact;
-    reference?: string;
-    status?: string;
-    total?: number;
-}
-
-export interface IAlegraEntry {
-    id: string | number;
-    client: IAlegraContact;
-    description: string;
-    debit: number;
-    credit: number;
-    name?: string;
-    type?: string;
-    line?: string;
-    lineParent?: any;
-    costCenter?: any;
-    associatedDocument?: {
-        idResource: any;
-        resourceType: any;
-        resource: any;
-    }
-}
-
-export interface IAlegraResult {
-    code: number;
-    message: string;
-}

package/src/api/builder/StandardGetRequestBuilder.ts

@@ -1,34 +0,0 @@
-import { GroupedParameters, RequestContext, RequestParameterType } from "../APIRequest";
-import { APIRequestBuilder } from "../APIRequestBuilder";
-
-export abstract class StandardGetRequestBuilder extends APIRequestBuilder {
-  protected buildDefaultParams(): GroupedParameters[] {
-    return [
-      {
-        context: RequestContext.QUERY,
-        properties: [{ name: "id", type: RequestParameterType.STRING }],
-      },
-      {
-        context: RequestContext.QUERY,
-        properties: [{ name: "limit", type: RequestParameterType.STRING }],
-      },
-      {
-        context: RequestContext.QUERY,
-        properties: [{ name: "count", type: RequestParameterType.STRING }],
-      },
-      {
-        context: RequestContext.QUERY,
-        properties: [
-          { name: "limit", type: RequestParameterType.STRING },
-          { name: "offset", type: RequestParameterType.STRING },
-        ],
-      },
-    ];
-  }
-
-  public abstract buildSpecificParams(): GroupedParameters[];
-
-  public buildParams(): GroupedParameters[] {
-    return this.buildDefaultParams().concat(this.buildSpecificParams());
-  }
-}

package/src/api/channel/ServerSentEventsManager.ts

@@ -1,28 +0,0 @@
-import { Response } from 'express';
-
-export class ServerSentEventsManager {
-    private res: Response;
-
-    constructor(res: Response, config?: any) {
-        config = config ?? {
-            'Cache-control': 'no-cahe',
-            'Content-Type': 'text/event-stream',
-            'Connection': 'keep-alive'
-        };
-        res.set(config);
-        res.flushHeaders();
-        this.res = res;
-    }
-
-    public write(status: number, payload: string) {
-        this.res.status(status).write(payload);
-    }
-
-    public writeObject(status: number, payload: any) {
-        this.res.status(status).write(JSON.stringify(payload));
-    }
-
-    public end(status: number, payload: string) {
-        this.res.status(200).end(payload);
-    }
-}

package/src/api/check/APIChecker.ts

@@ -1,50 +0,0 @@
-import { Request, Response, NextFunction } from "express";
-
-export declare interface APICheckResult {
-    approved: boolean,
-    payload?: any,
-    rejection?: {
-        code: number,
-        payload: any
-    }
-}
-
-export declare interface APICheckConfig {
-    check: string
-}
-
-export interface APICheck {
-    getConfig(): APICheckConfig;
-    apply(config: APICheckConfig, req: Request): PromiseLike<APICheckResult>;
-}
-
-export interface Checkable {
-    addCheck(check: APICheck): void;
-    check(req: Request, res: Response, next: NextFunction): PromiseLike<void | Response>;
-}
-
-export class APIChecker {
-    private checks: APICheck[] = [];
-
-    public addCheck(check: APICheck) {
-        this.checks.push(check);
-    }
-
-    public async applyChecks(req: Request): Promise<APICheckResult> {
-        if (!req.body || !req.body.checkResults)
-            req.body = { ...(req.body ?? {}), checkResults: {} };
-        for (let check of this.checks) {
-            let result = await check.apply(check.getConfig(), req);
-            req.body.checkResults[check.getConfig().check] = result.payload;
-            if (!result.approved)
-                return result;
-        }
-        return { approved: true };
-    }
-
-    public reject(res: Response, result: APICheckResult) {
-        if (result.rejection)
-            return res.status(result.rejection.code).json(result.rejection.payload);
-        return res.status(401).json({ message: 'Unknown reason' });
-    }
-}

package/src/api/check/CheckableAPIRequest.ts

@@ -1,33 +0,0 @@
-import { Request, Response, NextFunction } from "express";
-import { APIRequest, APIRequestConfig, RequestMethod } from "../APIRequest";
-import { ITRMAPIServiceGlobal } from "../APIService";
-import { APICheckResult, APIChecker, APICheck, Checkable } from "./APIChecker";
-
-export abstract class CheckableAPIRequest extends APIRequest implements Checkable {
-    private checker: APIChecker = new APIChecker();
-
-    constructor(method: RequestMethod, config: APIRequestConfig) {
-        super(method, config);
-    }
-
-    public addCheck(check: APICheck) {
-        this.checker.addCheck(check);
-    }
-
-    public async check(req: Request, res: Response | any, next: NextFunction) {
-        try {
-            let request: CheckableAPIRequest = ITRMAPIServiceGlobal.requests[APIRequest.buildKey(req)];
-            let result: APICheckResult = await request.checker.applyChecks(req);
-            if (result.approved)
-                return next();
-            return request.checker.reject(res, result);
-        } catch (error: any) {
-            console.log("> error:", error);
-            return await res.status(error?.response?.status ?? 500).json({
-                type: 'InternalRequestCheckError',
-                error: 'An error has ocurred when runing the checks for the request',
-                payload: error?.response?.data ?? error
-            });
-        }
-    }
-}

package/src/api/check/CheckableAPIRouter.ts

@@ -1,39 +0,0 @@
-import { RouterOptions, Request, Response, NextFunction } from "express";
-import { APIRouter } from "../APIRouter";
-import { ITRMAPIServiceGlobal } from "../APIService";
-import { APICheck, APIChecker, APICheckResult, Checkable } from "./APIChecker";
-
-export abstract class CheckableAPIRouter extends APIRouter  implements Checkable {
-    private checker: APIChecker = new APIChecker();
-    
-    constructor(path: string, options?: RouterOptions) {
-        super(path, options);
-    }
-
-    public init() {
-        this.router.use(this.check);
-    }
-
-    public addCheck(checker: APICheck) {
-        this.checker.addCheck(checker);
-    }
-
-    public async check(req: Request, res: Response, next: NextFunction): Promise<void | Response | any> {
-        try {
-            let route: CheckableAPIRouter = ITRMAPIServiceGlobal.routers[req.baseUrl];
-            route.setHeaders(res);
-            let result: APICheckResult = await route.checker.applyChecks(req)
-            if (result.approved)
-                return route.runMiddleware(req, res, next);
-            return route.checker.reject(res, result);
-        } catch (error: any) {
-            return await res.status(error?.response?.status ?? 500).json({
-                type: 'InternalRouterCheckError',
-                error: 'An error has ocurred when runing the checks for the router',
-                payload: error?.response?.data ?? error
-            });
-        }
-    }
-
-    protected abstract setHeaders(res: Response) : void;
-}

package/src/api/check/request/CheckableDeleteRequest.ts

@@ -1,17 +0,0 @@
-import { Express, Router } from "express";
-import { APIRequestConfig, RequestMethod } from "../../APIRequest";
-import { CheckableAPIRequest } from "../CheckableAPIRequest";
-
-export abstract class CheckableDeleteRequest extends CheckableAPIRequest {
-    constructor(config: APIRequestConfig) {
-        super(RequestMethod.DELETE, config);
-    }
-
-    public addToApp(app: Express): void {
-        app.delete(this.path, this.check, this.process);
-    }
-
-    public addToRouter(router: Router): void {
-        router.delete(this.path, this.check, this.process);
-    }
-}

package/src/api/check/request/CheckableFileUploadingPostRequest.ts

@@ -1,26 +0,0 @@
-import { Express, Router } from "express";
-import { APIRequestConfig, RequestMethod } from "../../APIRequest";
-import { CheckableAPIRequest } from "../CheckableAPIRequest";
-import { Multer, StorageEngine } from "multer";
-import { ITRMAPIServiceGlobal } from "../../APIService";
-import { initializeFileUploadingGlobalVars } from "../../express/ExpressFileUploadingConfiguration";
-
-export abstract class CheckableFileUploadingPostRequest extends CheckableAPIRequest {
-    protected upload: Multer;
-    protected storage: StorageEngine;
-
-    constructor(config: APIRequestConfig) {
-        super(RequestMethod.GET, config);
-        initializeFileUploadingGlobalVars();
-        this.upload = ITRMAPIServiceGlobal.tools.file.upload;
-        this.storage = ITRMAPIServiceGlobal.tools.file.storage;
-    }
-    
-    public addToApp(app: Express): void {
-        app.post(this.path, this.upload.single("file"), this.check, this.process);
-    }
-
-    public addToRouter(router: Router): void {
-        router.post(this.path, this.upload.single("file"), this.check, this.process);
-    }
-}

package/src/api/check/request/CheckableGetRequest.ts

@@ -1,17 +0,0 @@
-import { Express, Router } from "express";
-import { APIRequestConfig, RequestMethod } from "../../APIRequest";
-import { CheckableAPIRequest } from "../CheckableAPIRequest";
-
-export abstract class CheckableGetRequest extends CheckableAPIRequest {
-    constructor(config: APIRequestConfig) {
-        super(RequestMethod.GET, config);
-    }
-    
-    public addToApp(app: Express): void {
-        app.get(this.path, this.check, this.process);
-    }
-
-    public addToRouter(router: Router): void {
-        router.get(this.path, this.check, this.process);
-    }
-}

package/src/api/check/request/CheckablePostRequest.ts

@@ -1,17 +0,0 @@
-import { Express, Router } from "express";
-import { APIRequestConfig, RequestMethod } from "../../APIRequest";
-import { CheckableAPIRequest } from "../CheckableAPIRequest";
-
-export abstract class CheckablePostRequest extends CheckableAPIRequest {
-    constructor(config: APIRequestConfig) {
-        super(RequestMethod.POST, config);
-    }
-    
-    public addToApp(app: Express): void {
-        app.post(this.path, this.check, this.process);
-    }
-
-    public addToRouter(router: Router): void {
-        router.post(this.path, this.check, this.process);
-    }
-}

package/src/api/check/request/CheckablePutRequest.ts

@@ -1,17 +0,0 @@
-import { Express, Router } from "express";
-import { APIRequestConfig, RequestMethod } from "../../APIRequest";
-import { CheckableAPIRequest } from "../CheckableAPIRequest";
-
-export abstract class CheckablePutRequest extends CheckableAPIRequest {
-    constructor(config: APIRequestConfig) {
-        super(RequestMethod.PUT, config);
-    }
-    
-    public addToApp(app: Express): void {
-        app.put(this.path, this.check, this.process);
-    }
-
-    public addToRouter(router: Router): void {
-        router.put(this.path, this.check, this.process);
-    }
-}

package/src/api/check/route/CorsCheckApiRouter.ts

@@ -1,22 +0,0 @@
-import { NextFunction, Request, Response, RouterOptions } from "express";
-import { CheckableAPIRouter } from "../CheckableAPIRouter";
-
-export class CorsCheckApiRouter extends CheckableAPIRouter {
-  constructor(path: string, options?: RouterOptions) {
-    super(path, options);
-  }
-
-  protected setHeaders(res: Response<any, Record<string, any>>): void {
-    res.setHeader("Access-Control-Allow-Origin", "*");
-    res.setHeader("Access-Control-Allow-Methods", "GET,POST,PUT,DELETE,OPTIONS");
-    res.setHeader("Access-Control-Allow-Headers", "Content-Type,Authorization,platform");
-  }
-
-  protected async runMiddleware(
-    req: Request,
-    res: Response,
-    next: NextFunction
-  ): Promise<void | Response> {
-    return next();
-  }
-}