saas-backend-kit 1.0.0 → 1.0.2

package/saas-banner.svg

@@ -0,0 +1,239 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 900 320" width="900" height="320">
+  <defs>
+    <linearGradient id="bg" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" style="stop-color:#0a0a0f"/>
+      <stop offset="50%" style="stop-color:#0d1117"/>
+      <stop offset="100%" style="stop-color:#111827"/>
+    </linearGradient>
+    <linearGradient id="pipeGrad" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#26d97f;stop-opacity:0"/>
+      <stop offset="50%" style="stop-color:#26d97f;stop-opacity:1"/>
+      <stop offset="100%" style="stop-color:#26d97f;stop-opacity:0"/>
+    </linearGradient>
+    <linearGradient id="pipeGrad2" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#3178c6;stop-opacity:0"/>
+      <stop offset="50%" style="stop-color:#3178c6;stop-opacity:1"/>
+      <stop offset="100%" style="stop-color:#3178c6;stop-opacity:0"/>
+    </linearGradient>
+    <linearGradient id="pipeGrad3" x1="0%" y1="0%" x2="100%" y2="0%">
+      <stop offset="0%" style="stop-color:#ff9900;stop-opacity:0"/>
+      <stop offset="50%" style="stop-color:#ff9900;stop-opacity:1"/>
+      <stop offset="100%" style="stop-color:#ff9900;stop-opacity:0"/>
+    </linearGradient>
+    <filter id="glow-green">
+      <feGaussianBlur stdDeviation="4" result="blur"/>
+      <feMerge><feMergeNode in="blur"/><feMergeNode in="SourceGraphic"/></feMerge>
+    </filter>
+    <filter id="glow-blue">
+      <feGaussianBlur stdDeviation="3" result="blur"/>
+      <feMerge><feMergeNode in="blur"/><feMergeNode in="SourceGraphic"/></feMerge>
+    </filter>
+    <filter id="glow-soft">
+      <feGaussianBlur stdDeviation="2" result="blur"/>
+      <feMerge><feMergeNode in="blur"/><feMergeNode in="SourceGraphic"/></feMerge>
+    </filter>
+  </defs>
+
+  <!-- Background -->
+  <rect width="900" height="320" fill="url(#bg)" rx="14"/>
+
+  <!-- Subtle dot-grid background -->
+  <pattern id="dots" x="0" y="0" width="24" height="24" patternUnits="userSpaceOnUse">
+    <circle cx="1" cy="1" r="0.8" fill="#1e293b" opacity="0.8"/>
+  </pattern>
+  <rect width="900" height="320" fill="url(#dots)" rx="14" opacity="0.6"/>
+
+  <!-- ===================== DATA PIPELINE VISUALIZATION ===================== -->
+  <!-- Horizontal pipeline backbone -->
+  <line x1="60" y1="160" x2="840" y2="160" stroke="#1e293b" stroke-width="2"/>
+
+  <!-- Animated data packet 1 - green -->
+  <rect x="0" y="154" width="36" height="12" rx="6" fill="url(#pipeGrad)" opacity="0.9">
+    <animate attributeName="x" values="-40;900" dur="3.2s" repeatCount="indefinite"/>
+  </rect>
+
+  <!-- Animated data packet 2 - blue -->
+  <rect x="0" y="154" width="28" height="12" rx="6" fill="url(#pipeGrad2)" opacity="0.85">
+    <animate attributeName="x" values="-40;900" dur="3.2s" begin="-1.1s" repeatCount="indefinite"/>
+  </rect>
+
+  <!-- Animated data packet 3 - orange -->
+  <rect x="0" y="154" width="22" height="12" rx="6" fill="url(#pipeGrad3)" opacity="0.8">
+    <animate attributeName="x" values="-40;900" dur="3.2s" begin="-2.0s" repeatCount="indefinite"/>
+  </rect>
+
+  <!-- ===================== MODULE NODES (pipeline stops) ===================== -->
+  <!-- Each node represents a feature of the library -->
+
+  <!-- Node 1: AUTH -->
+  <g filter="url(#glow-blue)">
+    <circle cx="130" cy="160" r="32" fill="#0d1117" stroke="#3178c6" stroke-width="1.8"/>
+    <circle cx="130" cy="160" r="32" fill="none" stroke="#3178c6" stroke-width="1">
+      <animate attributeName="r" values="32;40;32" dur="3s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="3s" repeatCount="indefinite"/>
+    </circle>
+    <text x="130" y="155" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#3178c6" font-weight="bold">🔐</text>
+    <text x="130" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#3178c6" font-weight="bold">AUTH</text>
+    <text x="130" y="204" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#3178c6" opacity="0.6">JWT · RBAC</text>
+  </g>
+
+  <!-- Connector line -->
+  <line x1="162" y1="160" x2="218" y2="160" stroke="#1e293b" stroke-width="1.5" stroke-dasharray="4,3"/>
+
+  <!-- Node 2: QUEUE -->
+  <g filter="url(#glow-green)">
+    <circle cx="250" cy="160" r="32" fill="#0d1117" stroke="#26d97f" stroke-width="1.8"/>
+    <circle cx="250" cy="160" r="32" fill="none" stroke="#26d97f" stroke-width="1">
+      <animate attributeName="r" values="32;40;32" dur="3.5s" begin="-0.8s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="3.5s" begin="-0.8s" repeatCount="indefinite"/>
+    </circle>
+    <text x="250" y="155" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#26d97f" font-weight="bold">⚡</text>
+    <text x="250" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#26d97f" font-weight="bold">QUEUE</text>
+    <text x="250" y="204" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#26d97f" opacity="0.6">BullMQ</text>
+  </g>
+
+  <!-- Connector line -->
+  <line x1="282" y1="160" x2="338" y2="160" stroke="#1e293b" stroke-width="1.5" stroke-dasharray="4,3"/>
+
+  <!-- Node 3: NOTIFY -->
+  <g filter="url(#glow-soft)">
+    <circle cx="370" cy="160" r="32" fill="#0d1117" stroke="#f59e0b" stroke-width="1.8"/>
+    <circle cx="370" cy="160" r="32" fill="none" stroke="#f59e0b" stroke-width="1">
+      <animate attributeName="r" values="32;40;32" dur="4s" begin="-1.5s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="4s" begin="-1.5s" repeatCount="indefinite"/>
+    </circle>
+    <text x="370" y="155" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#f59e0b" font-weight="bold">🔔</text>
+    <text x="370" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#f59e0b" font-weight="bold">NOTIFY</text>
+    <text x="370" y="204" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#f59e0b" opacity="0.6">Email · SMS</text>
+  </g>
+
+  <!-- Connector line -->
+  <line x1="402" y1="160" x2="458" y2="160" stroke="#1e293b" stroke-width="1.5" stroke-dasharray="4,3"/>
+
+  <!-- Node 4: UPLOAD (CENTER - largest) -->
+  <g filter="url(#glow-soft)">
+    <circle cx="490" cy="160" r="36" fill="#0d1117" stroke="#ff9900" stroke-width="2"/>
+    <circle cx="490" cy="160" r="36" fill="none" stroke="#ff9900" stroke-width="1.2">
+      <animate attributeName="r" values="36;48;36" dur="3s" begin="-0.4s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="3s" begin="-0.4s" repeatCount="indefinite"/>
+    </circle>
+    <text x="490" y="154" text-anchor="middle" font-family="'Courier New',monospace" font-size="10" fill="#ff9900" font-weight="bold">☁️</text>
+    <text x="490" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="10" fill="#ff9900" font-weight="bold">S3</text>
+    <text x="490" y="208" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#ff9900" opacity="0.6">AWS Upload</text>
+  </g>
+
+  <!-- Connector line -->
+  <line x1="526" y1="160" x2="578" y2="160" stroke="#1e293b" stroke-width="1.5" stroke-dasharray="4,3"/>
+
+  <!-- Node 5: RATE LIMIT -->
+  <g filter="url(#glow-soft)">
+    <circle cx="610" cy="160" r="32" fill="#0d1117" stroke="#e11d48" stroke-width="1.8"/>
+    <circle cx="610" cy="160" r="32" fill="none" stroke="#e11d48" stroke-width="1">
+      <animate attributeName="r" values="32;40;32" dur="2.8s" begin="-2.1s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="2.8s" begin="-2.1s" repeatCount="indefinite"/>
+    </circle>
+    <text x="610" y="155" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#e11d48" font-weight="bold">🛡️</text>
+    <text x="610" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#e11d48" font-weight="bold">LIMIT</text>
+    <text x="610" y="204" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#e11d48" opacity="0.6">Rate Guard</text>
+  </g>
+
+  <!-- Connector line -->
+  <line x1="642" y1="160" x2="698" y2="160" stroke="#1e293b" stroke-width="1.5" stroke-dasharray="4,3"/>
+
+  <!-- Node 6: LOGGER -->
+  <g filter="url(#glow-soft)">
+    <circle cx="730" cy="160" r="32" fill="#0d1117" stroke="#8b5cf6" stroke-width="1.8"/>
+    <circle cx="730" cy="160" r="32" fill="none" stroke="#8b5cf6" stroke-width="1">
+      <animate attributeName="r" values="32;40;32" dur="3.8s" begin="-1.0s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="3.8s" begin="-1.0s" repeatCount="indefinite"/>
+    </circle>
+    <text x="730" y="155" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#8b5cf6" font-weight="bold">📋</text>
+    <text x="730" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#8b5cf6" font-weight="bold">LOGGER</text>
+    <text x="730" y="204" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#8b5cf6" opacity="0.6">Pino · JSON</text>
+  </g>
+
+  <!-- Connector line -->
+  <line x1="762" y1="160" x2="818" y2="160" stroke="#1e293b" stroke-width="1.5" stroke-dasharray="4,3"/>
+
+  <!-- Node 7: CONFIG -->
+  <g filter="url(#glow-soft)">
+    <circle cx="845" cy="160" r="28" fill="#0d1117" stroke="#06b6d4" stroke-width="1.8"/>
+    <circle cx="845" cy="160" r="28" fill="none" stroke="#06b6d4" stroke-width="1">
+      <animate attributeName="r" values="28;36;28" dur="3.2s" begin="-2.6s" repeatCount="indefinite"/>
+      <animate attributeName="opacity" values="0.5;0;0.5" dur="3.2s" begin="-2.6s" repeatCount="indefinite"/>
+    </circle>
+    <text x="845" y="155" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#06b6d4" font-weight="bold">⚙️</text>
+    <text x="845" y="168" text-anchor="middle" font-family="'Courier New',monospace" font-size="9" fill="#06b6d4" font-weight="bold">CFG</text>
+    <text x="845" y="204" text-anchor="middle" font-family="'Courier New',monospace" font-size="8" fill="#06b6d4" opacity="0.6">Zod · Env</text>
+  </g>
+
+  <!-- ===================== TITLE + SUBTITLE ===================== -->
+  <text x="450" y="50" text-anchor="middle" font-family="'Courier New',monospace" font-size="28" font-weight="bold" fill="#f8fafc" letter-spacing="2" filter="url(#glow-soft)">
+    saas-backend-kit
+    <animate attributeName="opacity" values="0.85;1;0.85" dur="4s" repeatCount="indefinite"/>
+  </text>
+
+  <text x="450" y="76" text-anchor="middle" font-family="'Courier New',monospace" font-size="12" fill="#64748b">
+    Production-grade modular backend toolkit · Node.js · Express · Fastify
+  </text>
+
+  <!-- npm install command badge — animated border -->
+  <rect x="310" y="88" width="280" height="30" rx="6" fill="#0d1117" stroke="#26d97f" stroke-width="1" opacity="0.9">
+    <animate attributeName="stroke-opacity" values="0.4;1;0.4" dur="2s" repeatCount="indefinite"/>
+  </rect>
+  <text x="450" y="108" text-anchor="middle" font-family="'Courier New',monospace" font-size="12" fill="#26d97f">
+    $ npm install saas-backend-kit
+  </text>
+
+  <!-- ===================== FLOATING PARTICLES ===================== -->
+  <circle cx="50" cy="50" r="2" fill="#26d97f" opacity="0.5">
+    <animate attributeName="cy" values="50;270;50" dur="7s" repeatCount="indefinite"/>
+    <animate attributeName="opacity" values="0.5;0;0.5" dur="7s" repeatCount="indefinite"/>
+  </circle>
+  <circle cx="870" cy="90" r="1.5" fill="#3178c6" opacity="0.5">
+    <animate attributeName="cy" values="90;30;90" dur="5s" repeatCount="indefinite"/>
+    <animate attributeName="opacity" values="0.5;0;0.5" dur="5s" repeatCount="indefinite"/>
+  </circle>
+  <circle cx="200" cy="280" r="2" fill="#f59e0b" opacity="0.4">
+    <animate attributeName="cx" values="200;700;200" dur="11s" repeatCount="indefinite"/>
+    <animate attributeName="opacity" values="0.4;0;0.4" dur="11s" repeatCount="indefinite"/>
+  </circle>
+  <circle cx="750" cy="30" r="1.5" fill="#8b5cf6" opacity="0.45">
+    <animate attributeName="cx" values="750;200;750" dur="9s" repeatCount="indefinite"/>
+    <animate attributeName="opacity" values="0.45;0;0.45" dur="9s" repeatCount="indefinite"/>
+  </circle>
+
+  <!-- ===================== BOTTOM STATUS BAR ===================== -->
+  <rect x="0" y="285" width="900" height="35" fill="#080c10" rx="0"/>
+  <rect x="0" y="282" width="900" height="3" fill="#26d97f" opacity="0.25"/>
+
+  <!-- Status indicators -->
+  <circle cx="30" cy="302" r="5" fill="#26d97f">
+    <animate attributeName="opacity" values="1;0.3;1" dur="1.5s" repeatCount="indefinite"/>
+  </circle>
+  <text x="42" y="307" font-family="'Courier New',monospace" font-size="10" fill="#26d97f" opacity="0.8">LIVE</text>
+
+  <text x="90" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b">|</text>
+  <text x="100" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b" opacity="0.7">MIT Licensed</text>
+
+  <text x="210" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b">|</text>
+  <text x="220" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b" opacity="0.7">TypeScript Ready</text>
+
+  <text x="360" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b">|</text>
+  <text x="370" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b" opacity="0.7">7 Modular Plugins</text>
+
+  <text x="520" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b">|</text>
+  <text x="530" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b" opacity="0.7">Express · Fastify</text>
+
+  <text x="670" y="307" font-family="'Courier New',monospace" font-size="10" fill="#64748b">|</text>
+  <text x="680" y="307" font-family="'Courier New',monospace" font-size="10" fill="#3178c6" opacity="0.85">by @AshishK-M</text>
+
+  <!-- Scrolling ticker on right -->
+  <clipPath id="tickerClip">
+    <rect x="800" y="288" width="95" height="28"/>
+  </clipPath>
+  <text font-family="'Courier New',monospace" font-size="9" fill="#26d97f" opacity="0.6" clip-path="url(#tickerClip)">
+    <tspan x="900" y="305">auth · queue · notify · upload · logger · rateLimit · config</tspan>
+    <animate attributeName="x" values="900;600" dur="8s" repeatCount="indefinite"/>
+  </text>
+</svg>

package/src/auth/jwt.ts

@@ -39,7 +39,7 @@ export class JWTService {
   }
 
   refreshTokens(refreshToken: string): TokenPair {
-    const payload = this.verifyRefreshToken(refreshToken);
+    const { iat, exp, nbf, ...payload } = this.verifyRefreshToken(refreshToken) as JWTPayload & { iat?: number; exp?: number; nbf?: number };
     return this.generateTokenPair(payload);
   }
 }

package/src/config/index.ts

@@ -24,6 +24,11 @@ export const envSchema = z.object({
   RATE_LIMIT_WINDOW: z.string().default('1m'),
   RATE_LIMIT_LIMIT: z.string().default('100'),
   LOG_LEVEL: z.enum(['fatal', 'error', 'warn', 'info', 'debug', 'trace']).default('info'),
+  AWS_REGION: z.string().default('us-east-1'),
+  AWS_ACCESS_KEY_ID: z.string().optional(),
+  AWS_SECRET_ACCESS_KEY: z.string().optional(),
+  AWS_S3_BUCKET: z.string().optional(),
+  AWS_ENDPOINT: z.string().optional(),
 });
 
 export type EnvConfig = z.infer<typeof envSchema>;

package/src/index.ts

@@ -5,6 +5,7 @@ export { logger } from './logger';
 export { rateLimit, createRateLimiter } from './rate-limit';
 export { config } from './config';
 export { ResponseHelper, response } from './response';
+export { upload, s3Service, S3Service } from './upload';
 export { createApp, createExpressApp, SaaSAppBuilder, PluginManager, Plugin, AppOptions } from './plugin';
 
 export { AuthOptions, User, JWTPayload, TokenPair, LoginCredentials, RegisterData, Role, Permission, RolePermissions } from './auth/types';
@@ -14,3 +15,4 @@ export { LoggerConfig, LogLevel } from './logger';
 export { RateLimitOptions } from './rate-limit';
 export { EnvConfig, ConfigOptions } from './config';
 export { ApiResponse, PaginatedResponse, ErrorResponse } from './response';
+export { S3Config, UploadOptions, UploadResult, SignedUrlOptions, FileObject } from './upload';

package/src/rate-limit/express.ts

@@ -22,6 +22,7 @@ class InMemoryRateLimiter {
 
   constructor() {
     this.cleanupInterval = setInterval(() => this.cleanup(), 60000);
+    this.cleanupInterval.unref();
   }
 
   private cleanup(): void {

package/src/response/index.ts

@@ -13,7 +13,8 @@ export interface ApiResponse<T = unknown> {
   };
 }
 
-export interface PaginatedResponse<T> extends ApiResponse<T> {
+export interface PaginatedResponse<T> extends Omit<ApiResponse<T[]>, 'data'> {
+  data: T[];
   meta: {
     page: number;
     limit: number;
@@ -141,57 +142,65 @@ declare global {
   }
 }
 
-Response.prototype.success = function <T>(data?: T, message?: string, statusCode: number = 200) {
-  return ResponseHelper.success(this, data, message, statusCode);
-};
+try {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const proto = require('express').response;
+  if (proto) {
+    proto.success = function <T>(this: Response, data?: T, message?: string, statusCode: number = 200) {
+      return ResponseHelper.success(this, data, message, statusCode);
+    };
 
-Response.prototype.created = function <T>(data?: T, message?: string) {
-  return ResponseHelper.created(this, data, message);
-};
+    proto.created = function <T>(this: Response, data?: T, message?: string) {
+      return ResponseHelper.created(this, data, message);
+    };
 
-Response.prototype.updated = function <T>(data?: T, message?: string) {
-  return ResponseHelper.updated(this, data, message);
-};
+    proto.updated = function <T>(this: Response, data?: T, message?: string) {
+      return ResponseHelper.updated(this, data, message);
+    };
 
-Response.prototype.deleted = function (message?: string) {
-  return ResponseHelper.deleted(this, message);
-};
+    proto.deleted = function (this: Response, message?: string) {
+      return ResponseHelper.deleted(this, message);
+    };
 
-Response.prototype.error = function (error: string, statusCode: number = 400, code?: string, details?: Record<string, unknown>) {
-  return ResponseHelper.error(this, error, statusCode, code, details);
-};
+    proto.error = function (this: Response, error: string, statusCode: number = 400, code?: string, details?: Record<string, unknown>) {
+      return ResponseHelper.error(this, error, statusCode, code, details);
+    };
 
-Response.prototype.badRequest = function (error?: string, code?: string) {
-  return ResponseHelper.badRequest(this, error, code);
-};
+    proto.badRequest = function (this: Response, error?: string, code?: string) {
+      return ResponseHelper.badRequest(this, error, code);
+    };
 
-Response.prototype.unauthorized = function (error?: string, code?: string) {
-  return ResponseHelper.unauthorized(this, error, code);
-};
+    proto.unauthorized = function (this: Response, error?: string, code?: string) {
+      return ResponseHelper.unauthorized(this, error, code);
+    };
 
-Response.prototype.forbidden = function (error?: string, code?: string) {
-  return ResponseHelper.forbidden(this, error, code);
-};
+    proto.forbidden = function (this: Response, error?: string, code?: string) {
+      return ResponseHelper.forbidden(this, error, code);
+    };
 
-Response.prototype.notFound = function (error?: string, code?: string) {
-  return ResponseHelper.notFound(this, error, code);
-};
+    proto.notFound = function (this: Response, error?: string, code?: string) {
+      return ResponseHelper.notFound(this, error, code);
+    };
 
-Response.prototype.conflict = function (error?: string, code?: string) {
-  return ResponseHelper.conflict(this, error, code);
-};
+    proto.conflict = function (this: Response, error?: string, code?: string) {
+      return ResponseHelper.conflict(this, error, code);
+    };
 
-Response.prototype.validationError = function (error: string, details?: Record<string, unknown>) {
-  return ResponseHelper.validationError(this, error, details);
-};
+    proto.validationError = function (this: Response, error: string, details?: Record<string, unknown>) {
+      return ResponseHelper.validationError(this, error, details);
+    };
 
-Response.prototype.internalError = function (error?: string) {
-  return ResponseHelper.internalError(this, error);
-};
+    proto.internalError = function (this: Response, error?: string) {
+      return ResponseHelper.internalError(this, error);
+    };
 
-Response.prototype.paginated = function <T>(data: T[], page: number, limit: number, total: number) {
-  return ResponseHelper.paginated(this, data, page, limit, total);
-};
+    proto.paginated = function <T>(this: Response, data: T[], page: number, limit: number, total: number) {
+      return ResponseHelper.paginated(this, data, page, limit, total);
+    };
+  }
+} catch {
+  // express not available at runtime
+}
 
 export const response = ResponseHelper;
 export default ResponseHelper;