@codisolutions23/node-utils 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -0,0 +1,143 @@
+import { Request, Response, NextFunction } from 'express';
+import { MongoClient, Db, ObjectId } from 'mongodb';
+import Redis from 'ioredis';
+import jwt from 'jsonwebtoken';
+import * as winston from 'winston';
+import { RedisClientType } from 'redis';
+
+declare function authenticateJWT(secretKey?: string): (req: Request, res: Response, next: NextFunction) => void;
+
+declare class HttpError extends Error {
+    readonly statusCode: number;
+    readonly isOperational: boolean;
+    constructor(message: string, statusCode: number, isOperational?: boolean);
+}
+declare class BadRequestError extends HttpError {
+    constructor(message?: string);
+}
+declare class UnauthorizedError extends HttpError {
+    constructor(message?: string);
+}
+declare class ForbiddenError extends HttpError {
+    constructor(message?: string);
+}
+declare class NotFoundError extends HttpError {
+    constructor(message?: string);
+}
+declare class UnprocessableEntityError extends HttpError {
+    constructor(message?: string);
+}
+declare class InternalServerError extends HttpError {
+    constructor(message?: string);
+}
+
+declare const errorHandler: (error: HttpError, req: Request, res: Response, next: NextFunction) => void;
+
+interface AtlasConfig {
+    uri: string;
+    db: string;
+    name?: string;
+}
+declare class useAtlas {
+    private static mongoClient;
+    private static mongoDb;
+    static connect(config: AtlasConfig): Promise<void>;
+    static getClient(): MongoClient | null;
+    static getDb(): Db | null;
+    static close(): Promise<void>;
+}
+
+declare function buildCacheKey(prefix: string, values: Record<string, any>): string;
+
+declare function useCache(): {
+    get: <T = unknown>(cacheKey: string) => Promise<T | null>;
+    set: <T = unknown>(cacheKey: string, data: T, ttl?: number, group?: string) => Promise<void>;
+    remove: (cacheKey: string) => Promise<void>;
+    clearGroup: (group: string) => Promise<void>;
+};
+
+declare function getTemplatePath(directory: string, filePath: string): string;
+
+interface CompileOptions {
+    context?: Record<string, any>;
+    filePath: string;
+}
+declare function renderHandlebarsTemplate({ context, filePath, }: CompileOptions): Promise<string>;
+
+type RedisOptions = {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+};
+declare function useRedis(): {
+    initialize: (options: RedisOptions) => Redis;
+    getClient: () => Redis;
+    disconnect: () => void;
+};
+
+interface JwtSignParams {
+    payload?: Record<string, unknown>;
+    secretKey: string;
+    signOptions?: jwt.SignOptions;
+}
+declare function signJwtToken({ payload, secretKey, signOptions, }: JwtSignParams): string;
+
+declare const logger: winston.Logger;
+
+interface MailerConfig {
+    email: string;
+    password: string;
+    host: string;
+    port: number;
+    secure: boolean;
+}
+declare class useMailer {
+    private config;
+    private transporter;
+    constructor(config: MailerConfig);
+    sendMail({ sender, to, subject, text, html, }: {
+        sender?: string;
+        to: string;
+        subject: string;
+        text?: string;
+        html?: string;
+    }): Promise<string>;
+}
+
+declare function toObjectId(id: string | ObjectId): ObjectId;
+
+declare function paginate<T>(items: T[], page: number | undefined, limit: number | undefined, total: number): {
+    items: T[];
+    pages: number;
+    pageRange: string;
+};
+
+declare function comparePasswords(password: string, hashed: string): Promise<boolean>;
+declare function hashPassword(password: string, saltRounds?: number): Promise<string>;
+
+declare function initRedisClient(): Promise<RedisClientType | undefined>;
+declare function useRedisClient(): RedisClientType;
+
+interface S3Config {
+    accessKeyId: string;
+    secretAccessKey: string;
+    endpoint: string;
+    region: string;
+    bucket: string;
+    forcePathStyle: boolean;
+}
+declare class useS3 {
+    private config;
+    private client;
+    constructor(config: S3Config);
+    uploadObject({ key, body, metadata, contentType, }: {
+        key: string;
+        body: string | Buffer;
+        metadata?: Record<string, string>;
+        contentType?: string;
+    }): Promise<string>;
+    deleteObject(key: string): Promise<string>;
+}
+
+export { BadRequestError, ForbiddenError, HttpError, InternalServerError, NotFoundError, UnauthorizedError, UnprocessableEntityError, authenticateJWT, buildCacheKey, comparePasswords, errorHandler, getTemplatePath, hashPassword, initRedisClient, logger, paginate, renderHandlebarsTemplate, signJwtToken, toObjectId, useAtlas, useCache, useMailer, useRedis, useRedisClient, useS3 };

package/dist/index.d.ts

@@ -0,0 +1,143 @@
+import { Request, Response, NextFunction } from 'express';
+import { MongoClient, Db, ObjectId } from 'mongodb';
+import Redis from 'ioredis';
+import jwt from 'jsonwebtoken';
+import * as winston from 'winston';
+import { RedisClientType } from 'redis';
+
+declare function authenticateJWT(secretKey?: string): (req: Request, res: Response, next: NextFunction) => void;
+
+declare class HttpError extends Error {
+    readonly statusCode: number;
+    readonly isOperational: boolean;
+    constructor(message: string, statusCode: number, isOperational?: boolean);
+}
+declare class BadRequestError extends HttpError {
+    constructor(message?: string);
+}
+declare class UnauthorizedError extends HttpError {
+    constructor(message?: string);
+}
+declare class ForbiddenError extends HttpError {
+    constructor(message?: string);
+}
+declare class NotFoundError extends HttpError {
+    constructor(message?: string);
+}
+declare class UnprocessableEntityError extends HttpError {
+    constructor(message?: string);
+}
+declare class InternalServerError extends HttpError {
+    constructor(message?: string);
+}
+
+declare const errorHandler: (error: HttpError, req: Request, res: Response, next: NextFunction) => void;
+
+interface AtlasConfig {
+    uri: string;
+    db: string;
+    name?: string;
+}
+declare class useAtlas {
+    private static mongoClient;
+    private static mongoDb;
+    static connect(config: AtlasConfig): Promise<void>;
+    static getClient(): MongoClient | null;
+    static getDb(): Db | null;
+    static close(): Promise<void>;
+}
+
+declare function buildCacheKey(prefix: string, values: Record<string, any>): string;
+
+declare function useCache(): {
+    get: <T = unknown>(cacheKey: string) => Promise<T | null>;
+    set: <T = unknown>(cacheKey: string, data: T, ttl?: number, group?: string) => Promise<void>;
+    remove: (cacheKey: string) => Promise<void>;
+    clearGroup: (group: string) => Promise<void>;
+};
+
+declare function getTemplatePath(directory: string, filePath: string): string;
+
+interface CompileOptions {
+    context?: Record<string, any>;
+    filePath: string;
+}
+declare function renderHandlebarsTemplate({ context, filePath, }: CompileOptions): Promise<string>;
+
+type RedisOptions = {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+};
+declare function useRedis(): {
+    initialize: (options: RedisOptions) => Redis;
+    getClient: () => Redis;
+    disconnect: () => void;
+};
+
+interface JwtSignParams {
+    payload?: Record<string, unknown>;
+    secretKey: string;
+    signOptions?: jwt.SignOptions;
+}
+declare function signJwtToken({ payload, secretKey, signOptions, }: JwtSignParams): string;
+
+declare const logger: winston.Logger;
+
+interface MailerConfig {
+    email: string;
+    password: string;
+    host: string;
+    port: number;
+    secure: boolean;
+}
+declare class useMailer {
+    private config;
+    private transporter;
+    constructor(config: MailerConfig);
+    sendMail({ sender, to, subject, text, html, }: {
+        sender?: string;
+        to: string;
+        subject: string;
+        text?: string;
+        html?: string;
+    }): Promise<string>;
+}
+
+declare function toObjectId(id: string | ObjectId): ObjectId;
+
+declare function paginate<T>(items: T[], page: number | undefined, limit: number | undefined, total: number): {
+    items: T[];
+    pages: number;
+    pageRange: string;
+};
+
+declare function comparePasswords(password: string, hashed: string): Promise<boolean>;
+declare function hashPassword(password: string, saltRounds?: number): Promise<string>;
+
+declare function initRedisClient(): Promise<RedisClientType | undefined>;
+declare function useRedisClient(): RedisClientType;
+
+interface S3Config {
+    accessKeyId: string;
+    secretAccessKey: string;
+    endpoint: string;
+    region: string;
+    bucket: string;
+    forcePathStyle: boolean;
+}
+declare class useS3 {
+    private config;
+    private client;
+    constructor(config: S3Config);
+    uploadObject({ key, body, metadata, contentType, }: {
+        key: string;
+        body: string | Buffer;
+        metadata?: Record<string, string>;
+        contentType?: string;
+    }): Promise<string>;
+    deleteObject(key: string): Promise<string>;
+}
+
+export { BadRequestError, ForbiddenError, HttpError, InternalServerError, NotFoundError, UnauthorizedError, UnprocessableEntityError, authenticateJWT, buildCacheKey, comparePasswords, errorHandler, getTemplatePath, hashPassword, initRedisClient, logger, paginate, renderHandlebarsTemplate, signJwtToken, toObjectId, useAtlas, useCache, useMailer, useRedis, useRedisClient, useS3 };