@ccci/micro-server 1.1.3 → 1.1.6

package/dist/types/RedisTypes.d.ts

@@ -0,0 +1,48 @@
+import { RediSearchSchema } from "redis";
+export interface QueryOptions {
+    page?: number;
+    limit?: number;
+    sort?: string;
+    withCount?: boolean;
+    paginate?: boolean;
+    search?: string;
+}
+export type RediSearchFieldValue = string | number | boolean | Date | null | undefined | Array<string | number | boolean>;
+export interface RediSearchCreateOptions {
+    ON?: "HASH" | "JSON";
+    PREFIX?: string | string[];
+    FILTER?: string;
+    LANGUAGE?: string;
+    LANGUAGE_FIELD?: string;
+    SCORE?: number;
+    SCORE_FIELD?: string;
+    MAXTEXTFIELDS?: boolean;
+    TEMPORARY?: number;
+    NOOFFSETS?: boolean;
+    NOHL?: boolean;
+    NOFIELDS?: boolean;
+    NOFREQS?: boolean;
+    SKIPINITIALSCAN?: boolean;
+    STOPWORDS?: string[] | "OFF";
+}
+export interface RediSearchIndexConfig<T = unknown> {
+    indexKey: string;
+    schema: RediSearchSchema;
+    options?: RediSearchCreateOptions;
+    fields?: (item: T, score: number) => Record<string, RediSearchFieldValue>;
+}
+export interface RediSearchQueryConfig {
+    indexKey: string;
+    query?: string;
+    sortBy?: string;
+    returnFields?: string[];
+    dialect?: number;
+}
+export interface RedisResult<T> {
+    rows: T[];
+    count?: number;
+    page: number;
+    limit: number;
+    hasNextPage: boolean;
+}
+//# sourceMappingURL=RedisTypes.d.ts.map

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ccci/micro-server",
-  "version": "1.1.3",
+  "version": "1.1.6",
   "module": "index.ts",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "A collection of Commom Backend Utility Classes",
   "scripts": {
-    "build": "bun build --target=node ./src/index.ts --outfile=dist/index.js && bun run build:declaration",
+    "build": "bun build --target=node ./src/index.ts --outfile=dist/index.js",
     "build:declaration": "tsc --emitDeclarationOnly --project tsconfig.types.json",
     "postbuild": "rimraf tsconfig.types.tsbuildinfo",
     "release": "bun run build && git add . && git commit -m 'release' && git push && npm version patch && npm publish"
@@ -23,7 +23,10 @@
     "@types/nodemailer": "^6.4.15",
     "prettier": "^3.0.3",
     "rimraf": "^5.0.5",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "vite": "^5.0.10",
+    "vite-tsconfig-paths": "^6.1.0",
+    "vitest": "^1.1.0"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
@@ -45,6 +48,7 @@
     "express": "^4.19.2",
     "express-fileupload": "^1.5.0",
     "express-list-endpoints": "^7.1.1",
+    "fast-xml-parser": "^5.3.4",
     "firebase": "^10.13.1",
     "firebase-admin": "^12.4.0",
     "handlebars": "^4.7.8",
@@ -55,6 +59,7 @@
     "nodemailer": "^6.9.13",
     "pg": "^8.11.5",
     "pg-hstore": "^2.3.4",
+    "redis": "^5.11.0",
     "sequelize": "^6.37.3",
     "socket.io": "^4.7.5",
     "winston": "^3.13.0"

package/dist/decorators/Endpoints.d.ts

@@ -1,12 +0,0 @@
-export declare const endpoint: (target: any, methodName: string, descriptor: PropertyDescriptor) => void;
-export declare const PublicAccess: <T extends new (...args: any[]) => {}>(constructor: T) => {
-    new (...args: any[]): {
-        grantPublicAccess: boolean;
-    };
-} & T;
-export declare const PrivateAccess: <T extends new (...args: any[]) => {}>(constructor: T) => {
-    new (...args: any[]): {
-        grantPublicAccess: boolean;
-    };
-} & T;
-//# sourceMappingURL=Endpoints.d.ts.map

package/dist/types/ApplicationOptionType.d.ts

@@ -1,36 +0,0 @@
-export type ApplicationOptionType = {
-    routeContext?: string;
-    configDir?: string;
-    modelDir?: string;
-    controllerDir?: string;
-    routeDir?: string;
-    websocketPort?: number;
-    websocketDir?: string;
-    enableRedis?: boolean;
-    enableMinio?: boolean;
-    enableKafka?: boolean;
-    enableS3?: boolean;
-    enableWebSocket?: boolean;
-    enableFirebase?: boolean;
-    enableEmail?: boolean;
-    clientId?: string;
-    brokers?: string[];
-    consumersPath?: string;
-    producersPath?: string;
-    minioHost?: string;
-    minioPort?: number;
-    minioAccessKey?: string;
-    minioSecretKey?: string;
-    minioUseSSL?: boolean;
-    smtpService?: string;
-    smtpHost?: string;
-    smtpUser?: string;
-    smtpPassword?: string;
-    enablePushNotifications?: boolean;
-    s3ForcePathStyle?: boolean;
-    s3Endpoint?: string;
-    s3region?: string;
-    s3AccessKeyId?: string;
-    s3SecretAccessKey?: string;
-};
-//# sourceMappingURL=ApplicationOptionType.d.ts.map

package/dist/types/AttachmentMetadataTypes.d.ts

@@ -1,23 +0,0 @@
-export type AttachmentMetadataType = {
-    Bucket?: string;
-    Etag?: string;
-    Key?: string;
-    Location?: string;
-    MimeType?: string;
-    Thumbnail?: string;
-    isHls?: boolean;
-};
-export type DeleteObjectRequest = {
-    Bucket: string;
-    Key: string;
-    MFA?: string;
-    VersionId?: string;
-    RequestPayer?: 'requester';
-    BypassGovernanceRetention?: boolean;
-    ExpectedBucketOwner?: string;
-    IfMatch?: string;
-    IfMatchLastModifiedTime?: Date;
-    IfMatchSize?: number;
-};
-export declare const mimeTypes: Record<string, string>;
-//# sourceMappingURL=AttachmentMetadataTypes.d.ts.map

package/dist/types/BaseControllerTypes.d.ts

@@ -1,42 +0,0 @@
-import { Order, WhereOptions } from "sequelize";
-export type RequestQuery = {
-    search?: string;
-    limit?: number;
-    page?: number;
-    includes?: string;
-    fields?: string;
-    paranoid?: string;
-    sort?: string;
-    paginate?: string;
-    date_range?: string;
-    others?: any;
-    scan?: string;
-    groupBy?: string;
-};
-export type QueryOptions = {
-    where?: WhereOptions<any>;
-    limit?: number;
-    offset?: number;
-    attributes?: Array<string>;
-    order?: Order;
-    paranoid?: boolean;
-    includes?: Array<string | IncludeType>;
-};
-export type ResponseType = {
-    success: boolean;
-    error?: number;
-    statusCode?: number;
-    errorMessage?: string;
-    errorDescription?: string;
-    response?: object;
-    version?: string;
-    errors?: string[];
-};
-export type IncludeType = {
-    association?: string;
-    include?: Array<IncludeType>;
-};
-export type CommonType = {
-    [x: string | symbol]: any;
-};
-//# sourceMappingURL=BaseControllerTypes.d.ts.map

package/dist/types/BaseModelTypes.d.ts

@@ -1,41 +0,0 @@
-export declare enum FindTypeEnum {
-    FIND_ALL = "findAndCountAll",
-    FIND_PK = "findByPk",
-    FIND_ONE = "findOne",
-    COUNT = "count"
-}
-export type IncludesType = {
-    path?: string;
-    association?: AssociationType;
-};
-export type AssociationType = {
-    include: Array<string> | Array<object>;
-    association?: string;
-    where?: object;
-};
-export type QueryType = {
-    where?: object;
-    limit?: number;
-    offset?: number;
-    select?: object;
-    order?: object;
-    attributes?: object;
-    returning?: boolean;
-    raw?: boolean;
-    nest?: boolean;
-    distinct?: string;
-    include?: object;
-};
-export type RequestUserType = {
-    id?: number;
-    email?: string;
-    clientSecret?: string;
-};
-export type ModelOptions = {
-    tableName: string;
-    schema?: string;
-    paranoid?: boolean;
-    defaultAttributes?: boolean;
-    comment?: string;
-};
-//# sourceMappingURL=BaseModelTypes.d.ts.map

package/dist/types/BaseRouterTypes.d.ts

@@ -1,9 +0,0 @@
-import { Request, Response, NextFunction } from 'express';
-import { ResponseType } from './BaseControllerTypes';
-export type Mappings = {
-    path: string;
-    method: string;
-    function: (req: Request, res: Response, next: NextFunction) => Promise<void | ResponseType>;
-    middleware?: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-};
-//# sourceMappingURL=BaseRouterTypes.d.ts.map

package/dist/types/BaseSocketType.d.ts

@@ -1,6 +0,0 @@
-export type WebSocketData = {
-    userId?: number;
-    channel?: string;
-    room?: string;
-};
-//# sourceMappingURL=BaseSocketType.d.ts.map

package/dist/types/BrokerType.d.ts

@@ -1,13 +0,0 @@
-export type PublishType = {
-    topic: string;
-    headers?: Record<string, string>;
-    event: string;
-    message: Record<string, any>;
-};
-export type MessageType = {
-    headers?: Record<string, string>;
-    event: string;
-    data: any;
-};
-export type MessageHandler = (message: MessageType) => Promise<void>;
-//# sourceMappingURL=BrokerType.d.ts.map

package/dist/types/NotificationTypes.d.ts

@@ -1,9 +0,0 @@
-export type NotificationType = {
-    title: string;
-    body: string;
-    imageUrl?: string;
-};
-export type NotificationOptions = {
-    isBroadcast?: Boolean;
-};
-//# sourceMappingURL=NotificationTypes.d.ts.map

package/dist/types/UploadedFileType.d.ts

@@ -1,11 +0,0 @@
-export type UploadedFileType = {
-    etag?: string;
-    path?: string;
-    bucket?: string;
-    directory?: string;
-    objectName?: string;
-    mimeType?: string;
-    location?: string;
-    filesize?: number;
-};
-//# sourceMappingURL=UploadedFileType.d.ts.map

package/dist/utils/ApplicationServer.d.ts

@@ -1,30 +0,0 @@
-import { Application } from 'express';
-import Mailer from './Mailer';
-import BaseSocketHandler from './BaseSocketHandler';
-import { ApplicationOptionType } from '@/types/ApplicationOptionType';
-/**
- * Application Sever class
- */
-export default class ApplicationServer {
-    static app: Application;
-    static mailer: Mailer;
-    static socketHandlers: Array<{
-        path: string;
-        handler: BaseSocketHandler;
-    }>;
-    /**
-     * Initializes the application server
-     * @param {number} port  port for the micro service
-     * @param {ApplicationOptionType} options additional server configuration
-     * @param {Array<String>} sync models to be sync to the database
-     *
-     */
-    static bootstrap(port: number, options?: ApplicationOptionType, sync?: Array<string> | Boolean): Promise<void>;
-    static getInstance(): Application;
-    static getWebsocketHandlers(): Array<{
-        path: string;
-        handler: any;
-    }>;
-    static getMailer(): Mailer;
-}
-//# sourceMappingURL=ApplicationServer.d.ts.map

package/dist/utils/BaseAuthenticatorModel.d.ts

@@ -1,7 +0,0 @@
-import BaseModel from "./BaseModel";
-export default class BaseAuthenticatorModel extends BaseModel {
-    password?: string;
-    authenticate(password: string): boolean;
-    updatePassword(password?: string): string | undefined;
-}
-//# sourceMappingURL=BaseAuthenticatorModel.d.ts.map

package/dist/utils/BaseConsumer.d.ts

@@ -1,44 +0,0 @@
-import { ConsumerRunConfig, type Consumer, type ConsumerConfig } from "kafkajs";
-import { BaseKafka } from "./BaseKafka";
-import type { MessageHandler } from "../types/BrokerType";
-/**
- * BaseConsumer class provides basic functionality for consuming messages from a Kafka topic.
- * It manages the connection, subscription, and message handling logic for Kafka consumers.
- */
-export declare class BaseConsumer {
-    consumer: Consumer | null;
-    private kafka;
-    /**
-     * Creates an instance of BaseConsumer using a BaseKafka instance.
-     *
-     * @param {BaseKafka} baseKafka - The instance of the BaseKafka class which provides access to the Kafka client.
-     */
-    constructor(baseKafka: BaseKafka);
-    /**
-     * Connects the consumer to the Kafka cluster with the specified group ID and optional consumer configuration.
-     * If the consumer is already connected, it logs a message and does nothing.
-     *
-     * @param {string} groupId - The consumer group ID to join.
-     * @param {ConsumerConfig} [config] - Optional additional configuration for the consumer.
-     * @returns {Promise<void>} - A promise that resolves once the consumer is connected.
-     */
-    connect(groupId: string, config?: ConsumerConfig): Promise<void>;
-    /**
-     * Disconnects the consumer from the Kafka cluster.
-     * If the consumer is already disconnected, it logs a message and does nothing.
-     *
-     * @returns {Promise<void>} - A promise that resolves once the consumer is disconnected.
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Subscribes the consumer to a Kafka topic and starts processing messages from the topic.
-     * The consumer runs the provided message handler for each received message.
-     *
-     * @param {string} topic - The Kafka topic to subscribe to.
-     * @param {MessageHandler} messageHandler - A function to handle the processed messages.
-     * @returns {Promise<void>} - A promise that resolves once the consumer has successfully subscribed and started processing messages.
-     * @throws {Error} - Throws an error if the consumer is not connected before subscribing.
-     */
-    subscribe(topic: string, messageHandler: MessageHandler, consumerRunConfig?: ConsumerRunConfig): Promise<void>;
-}
-//# sourceMappingURL=BaseConsumer.d.ts.map

package/dist/utils/BaseController.d.ts

@@ -1,97 +0,0 @@
-import { Request, Response, NextFunction } from 'express';
-import { ResponseType } from '../types/BaseControllerTypes';
-export default class BaseController {
-    protected _model: import("sequelize").ModelCtor<import("sequelize").Model<any, any>> | undefined;
-    _modelName: string | undefined;
-    protected broadcastOnCreate: boolean;
-    protected broadcastOnUpdate: boolean;
-    protected broadcastOnDelete: boolean;
-    constructor(model?: string);
-    /**
-     * Find all the rows matching your query, within a specified offset / limit,
-     * and get the total number of rows matching your query.
-     * -- added distinct:true
-     * ```js
-     * Controller.find(req, res, next)
-     * ```
-     * @param req
-     * @param res
-     * @param next
-     */
-    find(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    /**
-     * Search for a single instance by its primary key.
-     * This applies LIMIT 1, so the listener will always be called with a single instance.
-     * @param req
-     * @param res
-     * @param next
-     */
-    findById(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    /**
-     *
-     * @param req
-     * @param res
-     * @param next
-     */
-    create(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    /**
-     * Update multiple instances that match the where options. The promise returns an array with one or two elements. The first element is always the number of affected rows, while the second element is the actual affected rows (only supported in postgres and mssql with options.returning true.)
-     * @param req
-     * @param res
-     * @param next
-     */
-    update(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    /**
-     * Delete multiple instances, or set their deletedAt timestamp to the current time if paranoid is enabled.
-     * @param req
-     * @param res
-     * @param next
-     */
-    delete(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    /**
-     * Find all the rows matching your query, within a specified offset / limit,
-     * and get the total number of rows matching your query.
-     * ```js
-     * Controller.find(req, res, next)
-     * ```
-     * @param req
-     * @param res
-     * @param next
-     */
-    archives(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    restore(req: Request, res: Response, next?: NextFunction): Promise<ResponseType>;
-    /**
-     * count total number of records
-     * @param req
-     * @param res
-     * @param next
-     * @returns
-     */
-    count(req: Request, res: Response, next?: NextFunction): Promise<{
-        count: number;
-    }>;
-    /**
-     * Return a basic statistics based on the query and group provided.
-     * ```js
-     * Controller.find(req, res, next)
-     * ```
-     * @param req
-     * @param res
-     * @param next
-     */
-    stats(req: Request, res: Response, next?: NextFunction): Promise<any>;
-    /**
-     * ###############################################################
-     * ###################### LIFE CYCLE HOOKS #######################
-     * ###############################################################
-     */
-    beforeCreate(req: Request): Promise<void>;
-    afterCreate(req: Request, rec: any): Promise<void>;
-    beforeUpdate(req: Request): Promise<void>;
-    afterUpdate(req: Request, rec: any, orig: any): Promise<void>;
-    beforeDelete(req: Request): Promise<void>;
-    afterDelete(req: Request, rec: any): Promise<void>;
-    beforeFind(req: Request): Promise<void>;
-    afterFind(req: Request): Promise<void>;
-}
-//# sourceMappingURL=BaseController.d.ts.map

package/dist/utils/BaseControllerHelper.d.ts

@@ -1,27 +0,0 @@
-import { BaseError, UniqueConstraintError } from "sequelize";
-import { RequestQuery, QueryOptions, ResponseType } from "../types/BaseControllerTypes";
-/**
- * Constructs a Sequelize query object based on the provided request query.
- * This function dynamically builds the `where` clause, allows for sorting,
- * pagination, field selection, and includes related models.
- *
- * @param {RequestQuery} query - The incoming request query parameters.
- * @returns {QueryOptions} - Returns a Sequelize query options object to be used for querying the database.
- */
-export declare function ConstructQuery(query: RequestQuery): QueryOptions;
-/**
- * A helper function to structure a successful response.
- *
- * @param {any} response - Data to include in the response.
- * @returns {ResponseType} - An object with success status and response data.
- */
-export declare function ResponseHelper(response?: any): ResponseType;
-/**
- * Handles errors and constructs an error response based on the type of error (Sequelize, database, or validation).
- *
- * @param {UniqueConstraintError | BaseError | Error | any} error - The error encountered during execution.
- * @returns {ResponseType} - Returns a structured error response with error codes and messages.
- */
-export declare function ErrorResponseHandler(error: UniqueConstraintError | BaseError | Error | any): ResponseType;
-export { ResponseType };
-//# sourceMappingURL=BaseControllerHelper.d.ts.map

package/dist/utils/BaseKafka.d.ts

@@ -1,37 +0,0 @@
-import { Kafka, type KafkaConfig } from "kafkajs";
-/**
- * BaseKafka class provides basic functionality for interacting with a Kafka cluster.
- * It allows creating Kafka topics and fetching the Kafka instance for producing/consuming messages.
- */
-export declare class BaseKafka {
-    private kafka;
-    private consumerPath;
-    private producerPath;
-    /**
-     * Creates an instance of BaseKafka with the provided Kafka configuration.
-     *
-     * @param {KafkaConfig} config - Kafka configuration object containing client settings.
-     */
-    constructor(config: KafkaConfig);
-    /**
-     * Returns the Kafka instance to be used for producing and consuming messages.
-     *
-     * @returns {Kafka} - Kafka instance.
-     */
-    getKafka(): Kafka;
-    /**
-     * Creates Kafka topics if they don't already exist.
-     *
-     * This method checks if the specified topics exist, and if not, it creates them with the given
-     * number of partitions and replication factor.
-     *
-     * @param {Array<{ topic: string; partitions: number; replicationFactor: number }>} topics - List of topics to be created with their partitions and replication factor.
-     * @returns {Promise<void>} - A promise that resolves once the topics are created (or skipped if they already exist).
-     */
-    createTopics(topics: {
-        topic: string;
-        partitions: number;
-        replicationFactor: number;
-    }[]): Promise<void>;
-}
-//# sourceMappingURL=BaseKafka.d.ts.map

package/dist/utils/BaseModel.d.ts

@@ -1,44 +0,0 @@
-import { DataTypes, Model } from 'sequelize';
-import type { ModelAttributes } from "sequelize";
-import type IBaseModel from './IBaseModel';
-import { ModelOptions } from '@/types/BaseModelTypes';
-export default class BaseModel extends Model implements IBaseModel {
-    id?: number;
-    /**
-     * Sets common model attributes
-     * @returns
-     */
-    static getCommonAttributes(defaultAttributes: boolean): {
-        createdById: {
-            type: DataTypes.IntegerDataType;
-            comment: string;
-        };
-        updatedById: {
-            type: DataTypes.IntegerDataType;
-            comment: string;
-        };
-        isActive: {
-            type: DataTypes.AbstractDataType;
-            comment: string;
-            allowNull: boolean;
-            defaultValue: boolean;
-        };
-    } | null;
-    static getCommonAssociations(): void;
-    /**
-    *
-    * @param {ModelAttributes} fields table columns
-    * @param {string} tableName  name of the table
-    * @param {string} schema this will overwrite the default schema
-    * @param {boolean} paranoid paranoid option. defaults to true
-    * @param {boolean} defaultAttributes need to inherit default attributes. defaults to true
-    */
-    static initialize(fields: ModelAttributes, tableName: string, schema?: string, paranoid?: boolean, defaultAttributes?: boolean, comment?: string): void;
-    /**
-     *
-     * @param {ModelAttributes} fields table columns
-     * @param {string} options  Model Options
-     */
-    static initialize(fields: ModelAttributes, options: ModelOptions): void;
-}
-//# sourceMappingURL=BaseModel.d.ts.map

package/dist/utils/BaseProducer.d.ts

@@ -1,42 +0,0 @@
-import { type ProducerConfig } from "kafkajs";
-import { BaseKafka } from "./BaseKafka";
-import type { PublishType } from "../types/BrokerType";
-/**
- * BaseProducer class provides basic functionality for producing messages to a Kafka topic.
- * It manages the connection, disconnection, and message publishing logic for Kafka producers.
- */
-export declare class BaseProducer {
-    private producer;
-    private kafka;
-    /**
-     * Creates an instance of BaseProducer using a BaseKafka instance.
-     *
-     * @param {BaseKafka} baseKafka - The instance of the BaseKafka class which provides access to the Kafka client.
-     */
-    constructor(baseKafka: BaseKafka);
-    /**
-     * Connects the producer to the Kafka cluster with the specified optional configuration.
-     * If the producer is already connected, it logs a message and does nothing.
-     *
-     * @param {ProducerConfig} [config] - Optional additional configuration for the producer.
-     * @returns {Promise<void>} - A promise that resolves once the producer is connected.
-     */
-    connect(config?: ProducerConfig): Promise<void>;
-    /**
-     * Disconnects the producer from the Kafka cluster.
-     * If the producer is already disconnected, it logs a message and does nothing.
-     *
-     * @returns {Promise<void>} - A promise that resolves once the producer is disconnected.
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Publishes a message to a Kafka topic.
-     * If the producer is not connected, it throws an error.
-     *
-     * @param {PublishType} data - The data to publish, including the topic, event, headers, and message content.
-     * @returns {Promise<boolean>} - A promise that resolves to true if the message was successfully sent, false otherwise.
-     * @throws {Error} - Throws an error if the producer is not connected.
-     */
-    publish(data: PublishType): Promise<boolean>;
-}
-//# sourceMappingURL=BaseProducer.d.ts.map