@ajayjbtickets/common 1.0.9 → 1.0.10

package/dist/index.d.mts

@@ -0,0 +1,179 @@
+import { Response, Request, NextFunction } from 'express';
+import winston from 'winston';
+import { ZodSchema } from 'zod';
+import jsonwebtoken, { SignOptions, VerifyOptions } from 'jsonwebtoken';
+
+declare const ENVIRONMENTS: {
+    production: string;
+    development: string;
+    testing: string;
+};
+
+declare enum ErrorType {
+    BAD_TOKEN = "BadTokenError",
+    TOKEN_EXPIRED = "TokenExpiredError",
+    UNAUTHORIZED = "AuthFailureError",
+    ACCESS_TOKEN = "AccessTokenError",
+    INTERNAL = "InternalError",
+    NOT_FOUND = "NotFoundError",
+    NO_ENTRY = "NoEntryError",
+    NO_DATA = "NoDataError",
+    BAD_REQUEST = "BadRequestError",
+    FORBIDDEN = "ForbiddenError"
+}
+type ErrorDetailType = {
+    field: string | number;
+    message?: (string | number)[];
+};
+declare abstract class ApiError extends Error {
+    type: ErrorType;
+    message: string;
+    errors: ErrorDetailType[];
+    constructor(type: ErrorType, message: string | undefined, errors: ErrorDetailType[]);
+    static handle(err: ApiError, res: Response): void;
+}
+declare class BadTokenError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class TokenExpiredError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class AuthFailureError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class AccessTokenError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class InternalError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class NotFoundError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class NoEntryError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class NoDataError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class BadRequestError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class ForbiddenError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+
+declare enum StatusCode {
+    SUCCESS = "10000",
+    FAILURE = "10001",
+    RETRY = "10002",
+    IN_VALID_ACCESS_TOKEN = "10003"
+}
+declare enum ResponseStatusCode {
+    SUCCESS = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NO_CONTENT = 204,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    CONFLICT = 409,
+    GONE = 410,
+    PAYLOAD_TOO_LARGE = 413,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    UNPROCESSABLE_ENTITY = 422,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504
+}
+declare abstract class ApiResponse {
+    message: string;
+    statusCode: string | undefined;
+    status: number;
+    constructor(status: number, message: string, statusCode?: string);
+    prepare<T extends ApiResponse>(res: Response, response: T, headers?: {
+        [key: string]: string;
+    }): void;
+    send(res: Response, headers?: {
+        [key: string]: string;
+    }): void;
+    private sanitize;
+}
+declare class SuccessResponse<T> extends ApiResponse {
+    data: T;
+    constructor(responseStatusCode: ResponseStatusCode.SUCCESS | ResponseStatusCode.CREATED | ResponseStatusCode.ACCEPTED | ResponseStatusCode.NO_CONTENT, message: string, data: T);
+    send(res: Response): void;
+}
+declare class AccessTokenErrorResponse extends ApiResponse {
+    protected instruction: string;
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+    send(res: Response, headers?: {
+        [key: string]: string;
+    }): void;
+}
+declare class BadTokenResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class BadRequestResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class InternalErrorResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class NoFoundResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class ForbiddenResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+
+declare const logger: winston.Logger;
+
+declare enum ValidationSource {
+    BODY = "body",
+    HEADER = "headers",
+    QUERY = "query",
+    PARAM = "params"
+}
+
+declare const schemaValidator: (type: ValidationSource, schema: ZodSchema) => (req: Request, res: Response, next: NextFunction) => void;
+
+declare const verifyToken: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
+interface JwtPayload {
+    _id: string;
+    email: string;
+}
+declare class JwtService {
+    static sign(payload: string | Buffer | object, signOptions?: SignOptions): string;
+    static verify(token: string, verifyOptions?: VerifyOptions): string | jsonwebtoken.Jwt | jsonwebtoken.JwtPayload;
+    static generatePayload<T extends JwtPayload>(user: T): T;
+}
+
+declare class Password {
+    static hashPassword(password: string): Promise<string>;
+    static comparePassword(password: string, hashedPassword: string): Promise<string | boolean>;
+}
+
+type AsyncFunction = (req: Request, res: Response, next: NextFunction) => Promise<any>;
+declare const asyncHandler: (execution: AsyncFunction) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
+export { AccessTokenError, AccessTokenErrorResponse, ApiError, ApiResponse, AuthFailureError, BadRequestError, BadRequestResponse, BadTokenError, BadTokenResponse, ENVIRONMENTS, type ErrorDetailType, ErrorType, ForbiddenError, ForbiddenResponse, InternalError, InternalErrorResponse, type JwtPayload, JwtService, NoDataError, NoEntryError, NoFoundResponse, NotFoundError, Password, ResponseStatusCode, StatusCode, SuccessResponse, TokenExpiredError, ValidationSource, asyncHandler, logger, schemaValidator, verifyToken };

package/dist/index.d.ts

@@ -1,10 +1,179 @@
-export * from "./constants/environments";
-export * from "./core/ApiError";
-export * from "./core/ApiResponse";
-export * from "./core/Logger";
-export * from "./middlewares/schemaValidator";
-export * from "./middlewares/verifyToken";
-export * from "./services/jwt.service";
-export * from "./services/password.service";
-export * from "./types/validation";
-export * from "./utils/asyncHandler";
+import { Response, Request, NextFunction } from 'express';
+import winston from 'winston';
+import { ZodSchema } from 'zod';
+import jsonwebtoken, { SignOptions, VerifyOptions } from 'jsonwebtoken';
+
+declare const ENVIRONMENTS: {
+    production: string;
+    development: string;
+    testing: string;
+};
+
+declare enum ErrorType {
+    BAD_TOKEN = "BadTokenError",
+    TOKEN_EXPIRED = "TokenExpiredError",
+    UNAUTHORIZED = "AuthFailureError",
+    ACCESS_TOKEN = "AccessTokenError",
+    INTERNAL = "InternalError",
+    NOT_FOUND = "NotFoundError",
+    NO_ENTRY = "NoEntryError",
+    NO_DATA = "NoDataError",
+    BAD_REQUEST = "BadRequestError",
+    FORBIDDEN = "ForbiddenError"
+}
+type ErrorDetailType = {
+    field: string | number;
+    message?: (string | number)[];
+};
+declare abstract class ApiError extends Error {
+    type: ErrorType;
+    message: string;
+    errors: ErrorDetailType[];
+    constructor(type: ErrorType, message: string | undefined, errors: ErrorDetailType[]);
+    static handle(err: ApiError, res: Response): void;
+}
+declare class BadTokenError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class TokenExpiredError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class AuthFailureError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class AccessTokenError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class InternalError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class NotFoundError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class NoEntryError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class NoDataError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class BadRequestError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+declare class ForbiddenError extends ApiError {
+    constructor(message?: string, errors?: ErrorDetailType[]);
+}
+
+declare enum StatusCode {
+    SUCCESS = "10000",
+    FAILURE = "10001",
+    RETRY = "10002",
+    IN_VALID_ACCESS_TOKEN = "10003"
+}
+declare enum ResponseStatusCode {
+    SUCCESS = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NO_CONTENT = 204,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    CONFLICT = 409,
+    GONE = 410,
+    PAYLOAD_TOO_LARGE = 413,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    UNPROCESSABLE_ENTITY = 422,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504
+}
+declare abstract class ApiResponse {
+    message: string;
+    statusCode: string | undefined;
+    status: number;
+    constructor(status: number, message: string, statusCode?: string);
+    prepare<T extends ApiResponse>(res: Response, response: T, headers?: {
+        [key: string]: string;
+    }): void;
+    send(res: Response, headers?: {
+        [key: string]: string;
+    }): void;
+    private sanitize;
+}
+declare class SuccessResponse<T> extends ApiResponse {
+    data: T;
+    constructor(responseStatusCode: ResponseStatusCode.SUCCESS | ResponseStatusCode.CREATED | ResponseStatusCode.ACCEPTED | ResponseStatusCode.NO_CONTENT, message: string, data: T);
+    send(res: Response): void;
+}
+declare class AccessTokenErrorResponse extends ApiResponse {
+    protected instruction: string;
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+    send(res: Response, headers?: {
+        [key: string]: string;
+    }): void;
+}
+declare class BadTokenResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class BadRequestResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class InternalErrorResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class NoFoundResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+declare class ForbiddenResponse extends ApiResponse {
+    errors: ErrorDetailType[];
+    constructor(message: string, errors: ErrorDetailType[]);
+}
+
+declare const logger: winston.Logger;
+
+declare enum ValidationSource {
+    BODY = "body",
+    HEADER = "headers",
+    QUERY = "query",
+    PARAM = "params"
+}
+
+declare const schemaValidator: (type: ValidationSource, schema: ZodSchema) => (req: Request, res: Response, next: NextFunction) => void;
+
+declare const verifyToken: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
+interface JwtPayload {
+    _id: string;
+    email: string;
+}
+declare class JwtService {
+    static sign(payload: string | Buffer | object, signOptions?: SignOptions): string;
+    static verify(token: string, verifyOptions?: VerifyOptions): string | jsonwebtoken.Jwt | jsonwebtoken.JwtPayload;
+    static generatePayload<T extends JwtPayload>(user: T): T;
+}
+
+declare class Password {
+    static hashPassword(password: string): Promise<string>;
+    static comparePassword(password: string, hashedPassword: string): Promise<string | boolean>;
+}
+
+type AsyncFunction = (req: Request, res: Response, next: NextFunction) => Promise<any>;
+declare const asyncHandler: (execution: AsyncFunction) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
+export { AccessTokenError, AccessTokenErrorResponse, ApiError, ApiResponse, AuthFailureError, BadRequestError, BadRequestResponse, BadTokenError, BadTokenResponse, ENVIRONMENTS, type ErrorDetailType, ErrorType, ForbiddenError, ForbiddenResponse, InternalError, InternalErrorResponse, type JwtPayload, JwtService, NoDataError, NoEntryError, NoFoundResponse, NotFoundError, Password, ResponseStatusCode, StatusCode, SuccessResponse, TokenExpiredError, ValidationSource, asyncHandler, logger, schemaValidator, verifyToken };