wnodex 0.1.0 → 0.2.2

package/src/middlewares/rate-limit.ts

@@ -1,39 +0,0 @@
-import type { Application } from 'express';
-
-import rateLimit from 'express-rate-limit';
-
-import type { WnodexConfigOutput } from '../schemas/wnodex-config.js';
-
-/**
- * Configures the rate limiting middleware to protect the application
- * from excessive requests, mitigating abuse and denial of service attacks.
- *
- * It reads the `rateLimit` option from the provided config.
- * If it's a boolean:
- * - `false` disables rate limiting.
- * - `true` enables rate limiting with default settings.
- * If it's an object, it spreads the properties into the rateLimit options.
- * @param app Express Application instance to apply the rate limiter to.
- * @param config Typed application configuration object containing rateLimit option.
- *
- * @returns The result of `app.use(rateLimit())` if rate limiting is enabled, otherwise `undefined`.
- *
- * @example
- * private setupMiddlewares() {
- *    configureHelmet(this.app, this.config);
- * }
- */
-export function configureRateLimit(
-  app: Application,
-  config: WnodexConfigOutput
-) {
-  const { rateLimit: options } = config;
-
-  if (typeof options === 'boolean') {
-    if (options === false || !options) return;
-
-    return app.use(rateLimit());
-  } else {
-    return app.use(rateLimit({ ...options }));
-  }
-}

package/src/middlewares/session.ts

@@ -1,25 +0,0 @@
-import type { Application } from 'express';
-
-import session from 'express-session';
-
-import type { WnodexConfigOutput } from '../schemas/wnodex-config.js';
-
-/**
- * Configures the Express session middleware with the provided options.
- * Applies session management to the Express application, enabling
- * stateful sessions with cookies.
- * @param app The Express application instance.
- * @param config The validated configuration object containing session options.
- * @returns The Express Application instance with Session middleware applied,
- * or undefined if ession is disabled.
- *
- * @example
- * configureSession(app, { session: { secret: 'your-secret', resave: false, saveUninitialized: false } });
- */
-export function configureSession(app: Application, config: WnodexConfigOutput) {
-  const { session: options } = config;
-
-  if (!options) return;
-
-  return app.use(session({ ...options }));
-}

package/src/schemas/compression.ts

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-
-export const CompressionOptionsSchema = z.boolean().optional().default(true);
-
-export type CompressionOptionsInput = z.input<typeof CompressionOptionsSchema>;
-export type CompressionOptionsOutput = z.output<
-  typeof CompressionOptionsSchema
->;

package/src/schemas/cookie-parser.ts

@@ -1,21 +0,0 @@
-import type { CookieParseOptions } from 'cookie-parser';
-
-import { z } from 'zod';
-
-export const CookieParserOptionsSchema = z
-  .union([
-    z.boolean(),
-    z.object({
-      secret: z.union([z.string(), z.array(z.string())]),
-      options: z.custom<CookieParseOptions>().optional(),
-    }),
-  ])
-  .optional()
-  .default(true);
-
-export type CookieParserOptionsInput = z.input<
-  typeof CookieParserOptionsSchema
->;
-export type CookieParserOptionsOutput = z.output<
-  typeof CookieParserOptionsSchema
->;

package/src/schemas/cors.ts

@@ -1,13 +0,0 @@
-import type { CorsOptions } from 'cors';
-
-import { z } from 'zod';
-
-import { DEFAULT_CORS_OPTIONS } from '../consts/cors.js';
-
-export const CorsOptionsSchema = z
-  .union([z.boolean(), z.custom<CorsOptions>()])
-  .optional()
-  .default(DEFAULT_CORS_OPTIONS);
-
-export type CorsOptionsInput = z.input<typeof CorsOptionsSchema>;
-export type CorsOptionsOutput = z.output<typeof CorsOptionsSchema>;

package/src/schemas/error-metadata.ts

@@ -1,15 +0,0 @@
-import { z } from 'zod';
-
-import { ERROR_CODES } from '../consts/error-codes.js';
-
-export const ErrorMetadataSchema = z
-  .object({
-    code: z.enum(Object.values(ERROR_CODES)),
-    cause: z.unknown().optional(),
-    context: z.record(z.string(), z.unknown()).optional(),
-  })
-  .strict();
-
-export type ErrorMetadata = z.infer<typeof ErrorMetadataSchema>;
-export type ErrorMetadataInput = z.input<typeof ErrorMetadataSchema>;
-export type ErrorMetadataOutput = z.output<typeof ErrorMetadataSchema>;

package/src/schemas/helmet.ts

@@ -1,11 +0,0 @@
-import type { HelmetOptions } from 'helmet';
-
-import { z } from 'zod';
-
-export const HelmetOptionsSchema = z
-  .union([z.boolean(), z.custom<HelmetOptions>()])
-  .optional()
-  .default(false);
-
-export type HelmetOptionsInput = z.input<typeof HelmetOptionsSchema>;
-export type HelmetOptionsOutput = z.output<typeof HelmetOptionsSchema>;

package/src/schemas/hpp.ts

@@ -1,9 +0,0 @@
-import { z } from 'zod';
-
-export const HppOptionsSchema = z
-  .union([z.boolean(), z.array(z.string())])
-  .optional()
-  .default(true);
-
-export type HppOptionsInput = z.input<typeof HppOptionsSchema>;
-export type HppOptionsoutput = z.output<typeof HppOptionsSchema>;

package/src/schemas/index.ts

@@ -1,12 +0,0 @@
-export * from './compression.js';
-export * from './cookie-parser.js';
-export * from './cors.js';
-export * from './error-metadata.js';
-export * from './helmet.js';
-export * from './hpp.js';
-export * from './node-env.js';
-export * from './passport.js';
-export * from './port.js';
-export * from './rate-limit.js';
-export * from './session.js';
-export * from './wnodex-config.js';

package/src/schemas/node-env.ts

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-
-import { NODE_ENV_VALUES } from '../consts/node-env.js';
-
-export const NODE_ENVS = Object.values(NODE_ENV_VALUES);
-
-export const NodeEnvSchema = z.enum([...NODE_ENVS]);
-
-export const NodeEnvEnum = NodeEnvSchema.enum;
-
-export type NodeEnv = z.infer<typeof NodeEnvSchema>;

package/src/schemas/passport.ts

@@ -1,11 +0,0 @@
-import passport from 'passport';
-
-import { z } from 'zod';
-
-export const PassportSchema = z
-  .union([z.literal(false), z.custom<typeof passport>()])
-  .optional()
-  .default(false);
-
-export type PassportInput = z.input<typeof PassportSchema>;
-export type PassportOutput = z.output<typeof PassportSchema>;

package/src/schemas/port.ts

@@ -1,22 +0,0 @@
-import { z } from 'zod';
-
-import {
-  DEFAULT_PORT,
-  MAX_PORT,
-  MIN_PORT,
-  RESERVED_PORTS,
-} from '../consts/port.js';
-
-export const PortSchema = z
-  .union([
-    z.string().regex(/^\d{4,5}$/),
-    z.number().int().min(MIN_PORT).max(MAX_PORT),
-  ])
-  .transform((val) => (typeof val === 'string' ? Number(val) : val))
-  .refine((port: number) => !RESERVED_PORTS[port], {
-    message: 'The selected port is reserved for another application',
-  })
-  .optional()
-  .default(DEFAULT_PORT);
-
-export type PortInput = z.input<typeof PortSchema>;

package/src/schemas/rate-limit.ts

@@ -1,33 +0,0 @@
-import { z } from 'zod';
-
-import {
-  DEFAULT_RATE_LIMIT_MAX,
-  DEFAULT_RATE_LIMIT_MESSAGE,
-  DEFAULT_RATE_LIMIT_OPTIONS,
-  DEFAULT_RATE_LIMIT_WINDOW_MS,
-} from '../consts/rate-limit.js';
-
-export const RateLimitOptionsSchema = z
-  .union([
-    z.boolean(),
-    z.object({
-      windowMs: z
-        .number()
-        .int()
-        .positive()
-        .optional()
-        .default(DEFAULT_RATE_LIMIT_WINDOW_MS),
-      max: z
-        .number()
-        .int()
-        .positive()
-        .optional()
-        .default(DEFAULT_RATE_LIMIT_MAX),
-      message: z.string().optional().default(DEFAULT_RATE_LIMIT_MESSAGE),
-    }),
-  ])
-  .optional()
-  .default({ ...DEFAULT_RATE_LIMIT_OPTIONS });
-
-export type RateLimitOptionsInput = z.input<typeof RateLimitOptionsSchema>;
-export type RateLimitOptionsOutput = z.output<typeof RateLimitOptionsSchema>;

package/src/schemas/session.ts

@@ -1,40 +0,0 @@
-import { z } from 'zod';
-
-import {
-  DEFAULT_SESSION_COOKIE_HTTP_ONLY,
-  DEFAULT_SESSION_COOKIE_MAX_AGE,
-  DEFAULT_SESSION_COOKIE_SECURE,
-  DEFAULT_SESSION_RESAVE,
-  DEFAULT_SESSION_SAVE_UNINITIALIZED,
-} from '../consts/session.js';
-
-export const SessionCookieSchema = z
-  .object({
-    secure: z.boolean().optional().default(DEFAULT_SESSION_COOKIE_SECURE),
-    maxAge: z.number().optional().default(DEFAULT_SESSION_COOKIE_MAX_AGE),
-    httpOnly: z.boolean().optional().default(DEFAULT_SESSION_COOKIE_HTTP_ONLY),
-  })
-  .optional()
-  .default({
-    secure: DEFAULT_SESSION_COOKIE_SECURE,
-    maxAge: DEFAULT_SESSION_COOKIE_MAX_AGE,
-    httpOnly: DEFAULT_SESSION_COOKIE_HTTP_ONLY,
-  });
-
-export const SessionOptionsSchema = z
-  .union([
-    z.literal(false),
-    z.object({
-      secret: z.string(),
-      resave: z.boolean().optional().default(DEFAULT_SESSION_RESAVE),
-      saveUninitialized: z
-        .boolean()
-        .optional()
-        .default(DEFAULT_SESSION_SAVE_UNINITIALIZED),
-      cookie: SessionCookieSchema,
-    }),
-  ])
-  .optional()
-  .default(false);
-
-export type SessionOptions = z.infer<typeof SessionOptionsSchema>;

package/src/schemas/wnodex-config.ts

@@ -1,26 +0,0 @@
-import { z } from 'zod';
-
-import { CompressionOptionsSchema } from './compression.js';
-import { CookieParserOptionsSchema } from './cookie-parser.js';
-import { CorsOptionsSchema } from './cors.js';
-import { HelmetOptionsSchema } from './helmet.js';
-import { HppOptionsSchema } from './hpp.js';
-import { PassportSchema } from './passport.js';
-import { PortSchema } from './port.js';
-import { RateLimitOptionsSchema } from './rate-limit.js';
-import { SessionOptionsSchema } from './session.js';
-
-export const WnodexConfigSchema = z.object({
-  port: PortSchema,
-  helmet: HelmetOptionsSchema,
-  cors: CorsOptionsSchema,
-  compression: CompressionOptionsSchema,
-  rateLimit: RateLimitOptionsSchema,
-  cookieParser: CookieParserOptionsSchema,
-  hpp: HppOptionsSchema,
-  session: SessionOptionsSchema,
-  passport: PassportSchema,
-});
-
-export type WnodexConfigInput = z.input<typeof WnodexConfigSchema>;
-export type WnodexConfigOutput = z.output<typeof WnodexConfigSchema>;

package/src/wnodex.ts

@@ -1,152 +0,0 @@
-import type { Server } from 'node:http';
-
-import express, { type Application } from 'express';
-
-import type { Logger } from 'pino';
-
-import { setupConfig } from './helpers/setup-config.js';
-import { setupMiddlewares } from './helpers/setup-middlewares.js';
-import { logger } from './logger.js';
-import {
-  type WnodexConfigInput,
-  type WnodexConfigOutput,
-} from './schemas/wnodex-config.js';
-
-/**
- * Main application class for the Wnodex server.
- *
- * Handles Express app instantiation, configuration validation,
- * middleware setup, logging, error handling, server startup, and graceful shutdown.
- */
-export class Wnodex {
-  public app: Application;
-  private server?: Server;
-  private readonly config: WnodexConfigOutput;
-  private readonly logger: Logger;
-
-  /**
-   * Constructs a new Wnodex server instance.
-   * Initializes the Express app, logger, validates and stores configuration, and applies middlewares.
-   * @param config Configuration input for Wnodex, validated by WnodexConfigSchema.
-   * @example
-   * const wnodex = new Wnodex({ port: 3000 });
-   */
-  constructor(config: WnodexConfigInput) {
-    this.app = express();
-
-    // Logger
-    this.logger = logger;
-    this.app.set('logger', logger);
-
-    // Config
-    this.config = setupConfig(config);
-
-    // Global Middlewares
-    setupMiddlewares(this.app, this.config);
-  }
-
-  /**
-   * Provides access to the application's logger instance.
-   * @returns Logger instance.
-   * @example
-   * const log = wnodex.getLogger();
-   */
-  public getLogger(): Logger {
-    return this.logger;
-  }
-
-  /**
-   * Returns the validated Wnodex configuration.
-   * @returns WnodexConfigOutput object.
-   * @example
-   * const config = wnodex.getConfig();
-   */
-  public getConfig(): WnodexConfigOutput {
-    return this.config;
-  }
-
-  /**
-   * Public getter for the express app instance.
-   * @returns The express application instance.
-   * @example
-   * const app = Wnodex.getApp();
-   */
-  public getApp(): Application {
-    return this.app;
-  }
-
-  // --- Wnodex Start Helper ---
-
-  /**
-   * Starts the Wnodex server and listens on the specified port.
-   * Resolves when the server is ready.
-   * @returns Promise that resolves once server is running.
-   * @example
-   * await wnodex.start();
-   */
-  public start(): Promise<void> {
-    const logger = this.getLogger();
-    const { port } = this.getConfig();
-
-    return new Promise((resolve) => {
-      this.server = this.app.listen(port, () => {
-        logger.info(`Server running @ http://localhost:${port}`);
-        resolve();
-      });
-
-      // Attach error handler immediately after server creation
-      this.server?.on('error', (err) => {
-        logger.error(err, 'Server error:');
-      });
-    });
-  }
-
-  // --- Wnodex Graceful Shutdown ---
-
-  /**
-   * Gracefully shuts down the Wnodex server.
-   * Stops accepting new connections, allows active connections to finish,
-   * runs optional asynchronous cleanup chores, and closes the server.
-   * @param chores An optional async callback function to perform cleanup tasks
-   * before shutdown (e.g., closing DB connections, clearing cache). This function is awaited before closing the server.
-   *
-   * @returns Promise that resolves when the server has stopped gracefully.
-   *
-   * @example
-   * await wnodex.shutdown(async () => {
-   *   await db.close();
-   *   await cache.clear();
-   * });
-   */
-  public async shutdown(chores?: () => Promise<void> | void): Promise<void> {
-    const logger = this.getLogger();
-
-    if (!this.server) {
-      logger.warn('Server not running.');
-      return;
-    }
-
-    logger.info('Shutdown initiated...');
-
-    if (chores) {
-      try {
-        await chores();
-      } catch (error) {
-        logger.error(error, 'Error during cleanup chores');
-        // Proceed with shutdown even if chores fail
-      }
-    }
-
-    return new Promise((resolve, reject) => {
-      this.server!.close((err) => {
-        if (err) {
-          logger.error(err, 'Error during server shutdown');
-          reject(err);
-          return;
-        }
-        logger.info('Server stopped gracefully.');
-        resolve();
-      });
-    });
-  }
-}

package/tsconfig.lib.json

@@ -1,13 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": "src",
-    "outDir": "dist",
-    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
-    "emitDeclarationOnly": false,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "references": []
-}

package/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"fileNames":[],"fileInfos":[],"root":[],"options":{"composite":true,"declarationMap":true,"emitDeclarationOnly":true,"importHelpers":true,"module":199,"noEmitOnError":true,"noFallthroughCasesInSwitch":true,"noImplicitOverride":true,"noImplicitReturns":true,"noUnusedLocals":true,"skipLibCheck":true,"strict":true,"target":9},"version":"5.9.3"}