@ccci/micro-server 1.1.3 → 1.1.6

package/dist/utils/BaseRouter.d.ts

@@ -1,91 +0,0 @@
-import { Request, Response, NextFunction, Router } from 'express';
-import BaseController from './BaseController';
-import { Mappings } from '../types/BaseRouterTypes';
-export default class BaseRouter<T extends BaseController> {
-    grantPublicAccess: boolean;
-    controller: T;
-    /**
-     *
-     * @param {Controller} controller
-     */
-    constructor(controller: T);
-    /**
-     * @description GET route
-     * @param {Request} req
-     * @param {Response} res
-     * @param {NextFunction} next
-     */
-    get(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * @description GET ARCHIVES route
-     * @param {Request} req
-     * @param {Response} res
-     * @param {NextFunction} next
-     */
-    archives(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * @description POST route
-     * @param {Request} req
-     * @param {Response} res
-     * @param {NextFunction} next
-     */
-    post(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * @description GET route (/:id)
-     * @param {HttpRequest} req
-     * @param {HttpResponse} res
-     * @param {*} next
-     */
-    getId(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * @description PUT route (/:id)
-     * @param {HttpRequest} req
-     * @param {HttpResponse} res
-     * @param {*} next
-     */
-    update(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     *
-     * @param req
-     * @param res
-     * @param next
-     */
-    delete(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     *
-     * @param req
-     * @param res
-     * @param next
-     */
-    restore(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * /count route
-     * @param req
-     * @param res
-     * @param next
-     */
-    count(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * /stats get count by group
-     * @param req
-     * @param res
-     * @param next
-     */
-    stats(req: Request, res: Response, next: NextFunction): Promise<void>;
-    /**
-     * @description default mappings that will be inherited across all router class
-     * @returns {Array} mappings
-     */
-    getMapping: () => Mappings[];
-    /**
-     * @description additional mappings placeholder, designed to be overriden
-     * @returns {Array} mappings
-     */
-    getAdditionalMapping: () => Mappings[];
-    /**
-     * @description create the express router
-     * @returns {Router} router
-     */
-    getRoutes(): Router;
-}
-//# sourceMappingURL=BaseRouter.d.ts.map

package/dist/utils/BaseSocketHandler.d.ts

@@ -1,37 +0,0 @@
-/// <reference types="bun-types" />
-/// <reference types="node" />
-/// <reference types="bun-types" />
-import type { Server, ServerWebSocket } from 'bun';
-export default class BaseSocketHandler {
-    static channel: string;
-    static server: Server;
-    static websocket: ServerWebSocket;
-    /**
-     *
-     * @param req {Request}
-     * @param server {Server}
-     * @returns
-     */
-    upgrade(req: Request, server: Server): Promise<void>;
-    /**
-     *
-     * @param ws {ServerWebSocket}
-     * @param message {String}
-     */
-    accept(ws: ServerWebSocket, message: string): Promise<void>;
-    /**
-     *
-     * @param ws {ServerWebSocket}
-     */
-    connect(ws: ServerWebSocket): Promise<void>;
-    /**
-     *
-     * @param ws {ServerWebSocket}
-     * @param code {number}
-     * @param reason {reason}
-     */
-    disconnect(ws: ServerWebSocket, code: number, reason: string): Promise<void>;
-    getInstance(): ServerWebSocket;
-    static parse(url: String): any;
-}
-//# sourceMappingURL=BaseSocketHandler.d.ts.map

package/dist/utils/DatabaseConnector.d.ts

@@ -1,26 +0,0 @@
-import { Model, ModelStatic, Sequelize } from "sequelize";
-export default class DatabaseConnector {
-    private static connections;
-    private static connection;
-    private static rootDir;
-    constructor(path: string);
-    /**
-     * Initializes the database connection
-     * @param path
-     */
-    static init(): Promise<Array<Sequelize>>;
-    static checkConnection(connection: Sequelize): Promise<void>;
-    /**
-     *
-     * @param path root dir (__dirname)
-     */
-    initializeModels(): Promise<void>;
-    getConnections(): Array<Sequelize>;
-    static getConnection(): Sequelize;
-    connect(connection: Sequelize): Promise<void>;
-    static getModel(modelName: string): ModelStatic<Model>;
-    static sync(modelName: string, force?: boolean, alter?: boolean): Promise<void>;
-    static syncAll(force?: boolean, alter?: boolean): Promise<void>;
-    static disconnect(): void;
-}
-//# sourceMappingURL=DatabaseConnector.d.ts.map

package/dist/utils/ErrorHandler.d.ts

@@ -1,5 +0,0 @@
-export default class ErrorHandler extends Error {
-    statusCode: number | undefined;
-    constructor(message?: string, statusCode?: number);
-}
-//# sourceMappingURL=ErrorHandler.d.ts.map

package/dist/utils/IBaseModel.d.ts

@@ -1,9 +0,0 @@
-export default interface IBaseModel {
-    id?: number;
-    createdById?: number;
-    updatedById?: number;
-    createdAt?: Date;
-    updatedAt?: Date;
-    _search?: string;
-}
-//# sourceMappingURL=IBaseModel.d.ts.map

package/dist/utils/Logger.d.ts

@@ -1,8 +0,0 @@
-export default class Logger {
-    static info(message: string, details?: any): void;
-    static error(error: Error): void;
-    static warn(message: string): void;
-    static debug(message: string, details?: any): void;
-    static table(data: object[]): void;
-}
-//# sourceMappingURL=Logger.d.ts.map

package/dist/utils/Mailer.d.ts

@@ -1,23 +0,0 @@
-import { ApplicationOptionType } from '..';
-interface MailInterface {
-    from?: string;
-    to: string | string[];
-    cc?: string | string[];
-    bcc?: string | string[];
-    subject: string;
-    text?: string;
-    html: string;
-}
-export default class Mailer {
-    private static instance;
-    private transporter;
-    private sender;
-    private LOCAL_DIR;
-    static getInstance(): Mailer;
-    connect(options: ApplicationOptionType): Promise<void>;
-    hasValidConfig(options: ApplicationOptionType): boolean;
-    sendMail(options: MailInterface, template?: string, values?: any): Promise<void>;
-    findTemplate(name: string): Promise<unknown>;
-}
-export {};
-//# sourceMappingURL=Mailer.d.ts.map

package/dist/utils/Mixins.d.ts

@@ -1,39 +0,0 @@
-/**
- * Retrieves the MIME type for a given file name based on its extension.
- * @param fileName - The name of the file to extract the MIME type for.
- * @returns The MIME type if found, or null if not found.
- */
-export declare const getMimeType: (fileName: string) => string | null;
-/**
- * Extracts numeric IDs from a string in the format [Name:ID].
- * @param input - The input string containing IDs in the format [Name:ID].
- * @returns An array of extracted numeric IDs.
- */
-export declare const extractIds: (input: string) => number[];
-/**
- * Decrypts an encoded string using a salt.
- * @param salt - The salt used for decryption.
- * @param encoded - The encoded string to decrypt.
- * @returns The decrypted string.
- */
-export declare const decrypt: (salt: string, encoded: string) => string;
-/**
- * Encrypts a plain text string using a salt.
- * @param salt - The salt used for encryption.
- * @param text - The plain text string to encrypt.
- * @returns The encrypted string in hexadecimal format.
- */
-export declare const encrypt: (salt: string, text: string) => string;
-/**
- * Returns the start and end dates of the current week.
- * The week starts on Monday (00:00:00.000) and ends on Sunday (23:59:59.999).
- *
- * @returns An object containing:
- *   - `startOfWeek`: Date representing the beginning of the current week (Monday at midnight).
- *   - `endOfWeek`: Date representing the end of the current week (Sunday at 23:59:59.999).
- */
-export declare const getCurrentWeek: () => {
-    startOfWeek: Date;
-    endOfWeek: Date;
-};
-//# sourceMappingURL=Mixins.d.ts.map

package/dist/utils/PushNotifier.d.ts

@@ -1,19 +0,0 @@
-import type { NotificationType, NotificationOptions } from '@/types/NotificationTypes';
-import admin from 'firebase-admin';
-import { BatchResponse } from 'firebase-admin/lib/messaging/messaging-api';
-export default class PushNotifier {
-    static FirebaseAdmin: typeof admin;
-    static instance: number;
-    private static rootDir;
-    constructor(path: string);
-    /**
-     * Initiate sending push notifications
-     * @param tokens firebase user tokens
-     * @param message message to send
-     * @param metadata
-     * @param options
-     */
-    static sendNotifications(tokens: Array<string>, message: NotificationType, metadata?: any, options?: NotificationOptions): Promise<BatchResponse | undefined>;
-    static sendNotification(token: string, message: NotificationType, metadata?: any, options?: NotificationOptions): Promise<string | undefined>;
-}
-//# sourceMappingURL=PushNotifier.d.ts.map

package/dist/utils/RouterFactory.d.ts

@@ -1,12 +0,0 @@
-import { Application, Request, Response, NextFunction } from 'express';
-export default class RouterFactory {
-    /**
-     *
-     * @param app express application instance
-     * @param pathName root path of the application
-     * @param folderName path of the routers (default: routes)
-     */
-    static init(app: Application, pathName: string, folderName?: string, context?: string): Promise<void>;
-    static authenticate(req: Request, res: Response, next: NextFunction, grantPublicAccess?: boolean): Response<any, Record<string, any>> | undefined;
-}
-//# sourceMappingURL=RouterFactory.d.ts.map

package/dist/utils/ServeKafka.d.ts

@@ -1,16 +0,0 @@
-import type { KafkaConfig } from "kafkajs";
-export declare class ServeKafka {
-    private consumerPath;
-    private producerPath;
-    private config;
-    constructor(config: KafkaConfig, consumerPath?: string, producerPath?: string);
-    /**
-     * Starts all consumers by dynamically importing and initializing consumer classes.
-     */
-    startConsumers(): Promise<void>;
-    /**
-     * Starts all producers by dynamically importing and initializing producer classes.
-     */
-    startProducers(): Promise<void>;
-}
-//# sourceMappingURL=ServeKafka.d.ts.map

package/dist/utils/TokenGenerator.d.ts

@@ -1,11 +0,0 @@
-import { Request } from 'express';
-import { RequestUserType } from '../types/BaseModelTypes';
-/**
- * generate jwt token from the payload
- * @param payload
- * @returns
- */
-export declare function generate(payload: object): string;
-export declare function verify(token: string, secret?: string): RequestUserType;
-export declare function decode(val: string | Request): RequestUserType;
-//# sourceMappingURL=TokenGenerator.d.ts.map

package/dist/utils/Uploader.d.ts

@@ -1,33 +0,0 @@
-import { UploadedFile } from 'express-fileupload';
-import * as minio from 'minio';
-import { ApplicationOptionType } from '..';
-import { UploadedFileType } from '@/types/UploadedFileType';
-import { RemoveOptions } from 'minio';
-export default class Uploader {
-    static client: minio.Client;
-    constructor();
-    /**
-     * Initializes the minIO client instance
-     */
-    static init(options: ApplicationOptionType): Promise<void>;
-    /**
-     * checks .env variables if properly configured
-     */
-    static hasValidConfig(options: ApplicationOptionType): boolean;
-    /**
-     *
-     * @param bucket {string} The bucket name in minIO
-     * @param dir {string} The directory where the files are stored
-     * @param uploads {Array<UploadedFile> | UploadedFile} file(s) to be uploaded
-     * @returns
-     */
-    static upload(bucket: string, dir: string, uploads: Array<UploadedFile> | UploadedFile): Promise<Array<UploadedFileType> | UploadedFileType>;
-    /**
-     *
-     * @param bucket {string} bucket name
-     * @param file {string} file directory
-     */
-    preview(bucket: string, file: string): Promise<void>;
-    static delete(bucketName: string, objectName: string, removeOpts?: RemoveOptions): Promise<void>;
-}
-//# sourceMappingURL=Uploader.d.ts.map

package/dist/utils/WebSocketServer.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="bun-types" />
-/// <reference types="bun-types" />
-import { ServerWebSocket } from 'bun';
-import BaseSocketHandler from './BaseSocketHandler';
-export default class WebSocketServer {
-    static socketHandlers: Array<{
-        path: string;
-        handler: BaseSocketHandler;
-    }>;
-    static init(port: number | undefined, dir: string, folder?: string): Array<{
-        path: string;
-        handler: BaseSocketHandler;
-    }>;
-    /**
-     *
-     * @returns
-     */
-    static getSocketHandlers(): Array<{
-        path: string;
-        handler: BaseSocketHandler;
-    }>;
-    /**
-     *
-     * @param path
-     * @returns
-     */
-    static getHandler(path: string): ServerWebSocket | null;
-}
-//# sourceMappingURL=WebSocketServer.d.ts.map

package/dist/utils/uploader-s3.d.ts

@@ -1,68 +0,0 @@
-/// <reference types="node" />
-import { ApplicationOptionType } from "@/types/ApplicationOptionType";
-import { S3, DeleteObjectRequest } from "@aws-sdk/client-s3";
-import { AttachmentMetadataType } from "@/types/AttachmentMetadataTypes";
-export default class UploaderS3 {
-    static client: S3;
-    static uploadSessions: Record<string, string>;
-    /**
-     * Initializes the S3 client instance
-     */
-    static init(options: ApplicationOptionType): Promise<void>;
-    /**
-     * Validates configuration options
-     */
-    static hasValidConfig(options: ApplicationOptionType): boolean;
-    /**
-     * Lists all available S3 buckets
-     */
-    static listBuckets(): Promise<void>;
-    /**
-     * Starts a new multipart upload session
-     * @param bucketName S3 bucket name
-     * @param key Key for the object in S3
-     */
-    static startMultipartUpload(bucketName: string, key: string): Promise<string>;
-    /**
-     * Uploads a file part to S3
-     * @param bucketName S3 bucket name
-     * @param key Key for the object in S3
-     * @param uploadId Multipart upload session ID
-     * @param partNumber Part number for the upload
-     * @param chunk Chunk of the file to upload
-     */
-    static uploadPart(bucketName: string, key: string, uploadId: string, partNumber: number, chunk: Buffer): Promise<string | null>;
-    /**
-     * Completes a multipart upload
-     * @param bucketName S3 bucket name
-     * @param key Key for the object in S3
-     * @param uploadId Multipart upload session ID
-     * @param parts List of uploaded parts
-     */
-    static completeMultipartUpload(bucketName: string, key: string, uploadId: string, parts: {
-        PartNumber: number;
-        ETag: string;
-    }[]): Promise<AttachmentMetadataType>;
-    /**
-     * Aborts a multipart upload
-     * @param bucketName S3 bucket name
-     * @param key Key for the object in S3
-     * @param uploadId Multipart upload session ID
-     */
-    static abortMultipartUpload(bucketName: string, key: string, uploadId: string): Promise<void>;
-    /**
-     * Directly uploads a file to S3 without chunking
-     * @param bucketName S3 bucket name
-     * @param key Key for the object in S3
-     * @param fileContent The content of the file to upload
-     * @param contentType The MIME type of the file
-     */
-    static uploadFile(bucketName: string, key: string, fileContent: Buffer | Uint8Array | Blob | string, contentType: string): Promise<AttachmentMetadataType>;
-    /**
-     * Deletes all incomplete multipart uploads in the specified bucket
-     * @param bucketName S3 bucket name
-     */
-    static deleteIncompleteUploads(bucketName: string): Promise<void>;
-    static deleteFile(request: DeleteObjectRequest): Promise<void>;
-}
-//# sourceMappingURL=uploader-s3.d.ts.map