@xenterprises/fastify-xconfig 2.1.4 → 2.2.1

package/dist/middleware/multipart.d.ts

@@ -1,2 +0,0 @@
-import { FastifyInstance } from "fastify";
-export declare function setupMultipart(fastify: FastifyInstance, options: any): Promise<void>;

package/dist/middleware/multipart.js

@@ -1,7 +0,0 @@
-export async function setupMultipart(fastify, options) {
-    if (options.active !== false) {
-        await fastify.register(import("@fastify/multipart"), options);
-        console.info("   ✅ Multipart Enabled");
-    }
-}
-//# sourceMappingURL=multipart.js.map

package/dist/middleware/multipart.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"multipart.js","sourceRoot":"","sources":["../../src/middleware/multipart.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAwB,EAAE,OAAY;IACzE,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC7B,MAAM,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACzC,CAAC;AACH,CAAC"}

package/dist/middleware/rateLimit.d.ts

@@ -1,2 +0,0 @@
-import { FastifyInstance } from "fastify";
-export declare function setupRateLimit(fastify: FastifyInstance, options: any): Promise<void>;

package/dist/middleware/rateLimit.js

@@ -1,7 +0,0 @@
-export async function setupRateLimit(fastify, options) {
-    if (options.active !== false) {
-        await fastify.register(import("@fastify/rate-limit"), options);
-        console.info("   ✅ Rate Limiting Enabled");
-    }
-}
-//# sourceMappingURL=rateLimit.js.map

package/dist/middleware/rateLimit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rateLimit.js","sourceRoot":"","sources":["../../src/middleware/rateLimit.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAwB,EAAE,OAAY;IACzE,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC7B,MAAM,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC"}

package/dist/middleware/underPressure.d.ts

@@ -1,2 +0,0 @@
-import { FastifyInstance } from "fastify";
-export declare function setupUnderPressure(fastify: FastifyInstance, options: any): Promise<void>;

package/dist/middleware/underPressure.js

@@ -1,7 +0,0 @@
-export async function setupUnderPressure(fastify, options) {
-    if (options.active !== false) {
-        await fastify.register(import("@fastify/under-pressure"), options);
-        console.info("   ✅ Under Pressure Enabled");
-    }
-}
-//# sourceMappingURL=underPressure.js.map

package/dist/middleware/underPressure.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"underPressure.js","sourceRoot":"","sources":["../../src/middleware/underPressure.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,OAAwB,EACxB,OAAY;IAEZ,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC7B,MAAM,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC"}

package/dist/utils/colorize.d.ts

@@ -1,4 +0,0 @@
-import type { FastifyInstance, RouteOptions } from "fastify";
-export declare function colorize(method: string, text: string): string;
-export declare function printRoutes(routes: RouteOptions[], colors?: boolean): void;
-export declare function captureRoutes(fastify: FastifyInstance): RouteOptions[];

package/dist/utils/colorize.js

@@ -1,33 +0,0 @@
-const COLORS = {
-    POST: 33,
-    GET: 32,
-    PUT: 34,
-    DELETE: 31,
-    PATCH: 90,
-    clear: 39,
-};
-// Function to colorize method and path names
-export function colorize(method, text) {
-    const colorCode = COLORS[method] || COLORS.clear;
-    return `\u001b[${colorCode}m${text}\u001b[${COLORS.clear}m`;
-}
-// Function to print the collected routes
-export function printRoutes(routes, colors = true) {
-    routes
-        .sort((a, b) => a.url.localeCompare(b.url))
-        .forEach(({ method, url }) => {
-        const methodsArray = Array.isArray(method) ? method : [method];
-        methodsArray
-            .filter((m) => m !== "HEAD")
-            .forEach((m) => console.info(`${colors ? colorize(m, m) : m}\t${colors ? colorize(m, url) : url}`));
-    });
-}
-// Helper function to capture all registered routes
-export function captureRoutes(fastify) {
-    const routes = [];
-    fastify.addHook("onRoute", (routeOptions) => {
-        routes.push(routeOptions);
-    });
-    return routes;
-}
-//# sourceMappingURL=colorize.js.map

package/dist/utils/colorize.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"colorize.js","sourceRoot":"","sources":["../../src/utils/colorize.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,GAA+B;IACzC,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE;IACP,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;IACV,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;CACV,CAAC;AAEF,6CAA6C;AAC7C,MAAM,UAAU,QAAQ,CAAC,MAAc,EAAE,IAAY;IACnD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAoB,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC;IAC/D,OAAO,UAAU,SAAS,IAAI,IAAI,UAAU,MAAM,CAAC,KAAK,GAAG,CAAC;AAC9D,CAAC;AAED,yCAAyC;AACzC,MAAM,UAAU,WAAW,CAAC,MAAsB,EAAE,MAAM,GAAG,IAAI;IAC/D,MAAM;SACH,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SAC1C,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE;QAC3B,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC/D,YAAY;aACT,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC;aAC3B,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACb,OAAO,CAAC,IAAI,CACV,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CACrE,CACF,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,aAAa,CAAC,OAAwB;IACpD,MAAM,MAAM,GAAmB,EAAE,CAAC;IAElC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;QAC1C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/utils/formatBytes.d.ts

@@ -1 +0,0 @@
-export declare function formatBytes(bytes: number, decimals?: number): string;

package/dist/utils/formatBytes.js

@@ -1,10 +0,0 @@
-export function formatBytes(bytes, decimals = 2) {
-    if (bytes === 0)
-        return "0 Bytes";
-    const k = 1024;
-    const dm = decimals < 0 ? 0 : decimals;
-    const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB"];
-    const i = Math.floor(Math.log(bytes) / Math.log(k));
-    return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
-}
-//# sourceMappingURL=formatBytes.js.map

package/dist/utils/formatBytes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatBytes.js","sourceRoot":"","sources":["../../src/utils/formatBytes.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,QAAQ,GAAG,CAAC;IACrD,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAClC,MAAM,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACvC,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,OAAO,GAAG,UAAU,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC3E,CAAC"}

package/dist/utils/randomUUID.d.ts

@@ -1 +0,0 @@
-export declare const generateUUID: any;

package/dist/utils/randomUUID.js

@@ -1,3 +0,0 @@
-import { randomUUID } from "uncrypto";
-export const generateUUID = randomUUID;
-//# sourceMappingURL=randomUUID.js.map

package/dist/utils/randomUUID.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"randomUUID.js","sourceRoot":"","sources":["../../src/utils/randomUUID.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,CAAC"}

package/dist/utils/statAsync.d.ts

@@ -1,2 +0,0 @@
-import fs from "fs";
-export declare const statAsync: typeof fs.stat.__promisify__;

package/dist/utils/statAsync.js

@@ -1,4 +0,0 @@
-import fs from "fs";
-import util from "util";
-export const statAsync = util.promisify(fs.stat);
-//# sourceMappingURL=statAsync.js.map

package/dist/utils/statAsync.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"statAsync.js","sourceRoot":"","sources":["../../src/utils/statAsync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC"}

package/dist/xConfig.d.ts

@@ -1,3 +0,0 @@
-declare function xConfig(fastify: any, options: any): Promise<void>;
-declare const _default: typeof xConfig;
-export default _default;

package/dist/xConfig.js

@@ -1,9 +0,0 @@
-//src/xConfig.js
-import fp from "fastify-plugin";
-async function xConfig(fastify, options) {
-    fastify.decorate("xEcho", () => "Hello from X Enterprises!");
-}
-export default fp(xConfig, {
-    name: "xConfig",
-});
-//# sourceMappingURL=xConfig.js.map

package/dist/xConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"xConfig.js","sourceRoot":"","sources":["../src/xConfig.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEhC,KAAK,UAAU,OAAO,CAAC,OAAO,EAAE,OAAO;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,2BAA2B,CAAC,CAAC;AAC/D,CAAC;AAED,eAAe,EAAE,CAAC,OAAO,EAAE;IACzB,IAAI,EAAE,SAAS;CAChB,CAAC,CAAC"}

package/ts-reference/integrations/cloudinary.ts

@@ -1,26 +0,0 @@
-import { v2 as Cloudinary } from "cloudinary";
-
-export async function setupCloudinary(fastify: any, cloudinaryOptions: any) {
-  if (cloudinaryOptions.active !== false) {
-    Cloudinary.config({
-      cloud_name: cloudinaryOptions.cloudName,
-      api_key: cloudinaryOptions.apiKey,
-      api_secret: cloudinaryOptions.apiSecret,
-    });
-    fastify.decorate("cloudinary", {
-      async upload(fileStream: any, options = {}) {
-        return new Promise((resolve, reject) => {
-          const uploadStream = Cloudinary.uploader.upload_stream(
-            options,
-            (error, result) => {
-              if (error) reject(error);
-              else resolve(result);
-            }
-          );
-          fileStream.pipe(uploadStream);
-        });
-      },
-    });
-    console.info("   ✅ Cloudinary Enabled");
-  }
-}

package/ts-reference/integrations/prisma.ts

@@ -1,13 +0,0 @@
-import { PrismaClient } from "@prisma/client";
-
-export async function setupPrisma(fastify: any, prismaOptions: any) {
-  if (prismaOptions.active !== false) {
-    const prisma = new PrismaClient(prismaOptions);
-    await prisma.$connect();
-    fastify.decorate("prisma", prisma);
-    fastify.addHook("onClose", async () => {
-      await fastify.prisma.$disconnect();
-    });
-    console.info("   ✅ Prisma Enabled");
-  }
-}

package/ts-reference/integrations/sendgrid.ts

@@ -1,27 +0,0 @@
-import Sendgrid from "@sendgrid/mail";
-
-export async function setupSendGrid(fastify: any, sendGridOptions: any) {
-  if (sendGridOptions.active !== false) {
-    if (!sendGridOptions.apiKey)
-      throw new Error("SendGrid API key must be provided.");
-    Sendgrid.setApiKey(sendGridOptions.apiKey);
-    fastify.decorate("sendgrid", {
-      async sendEmail(
-        to: string,
-        subject: string,
-        templateId: string,
-        dynamicTemplateData: any
-      ) {
-        const msg = {
-          to,
-          from: sendGridOptions.fromEmail,
-          subject,
-          templateId,
-          dynamicTemplateData,
-        };
-        await Sendgrid.send(msg);
-      },
-    });
-    console.info("   ✅ SendGrid Enabled");
-  }
-}

package/ts-reference/integrations/stripe.ts

@@ -1,15 +0,0 @@
-import Stripe from "stripe";
-
-export async function setupStripe(fastify: any, stripeOptions: any) {
-  if (stripeOptions.active !== false) {
-    const stripeClient = new Stripe(stripeOptions.apiKey, {
-      apiVersion: "2024-06-20",
-    });
-    fastify.decorate("stripe", {
-      async createPaymentIntent(amount: number, currency = "usd") {
-        return await stripeClient.paymentIntents.create({ amount, currency });
-      },
-    });
-    console.info("   ✅ Stripe Enabled");
-  }
-}

package/ts-reference/integrations/twilio.ts

@@ -1,20 +0,0 @@
-import Twilio from "twilio";
-
-export async function setupTwilio(fastify: any, twilioOptions: any) {
-  if (twilioOptions.active !== false) {
-    const twilioClient = Twilio(
-      twilioOptions.accountSid,
-      twilioOptions.authToken
-    );
-    fastify.decorate("twilio", {
-      async sendSMS(to: string, body: string) {
-        return await twilioClient.messages.create({
-          body,
-          to,
-          from: twilioOptions.phoneNumber,
-        });
-      },
-    });
-    console.info("   ✅ Twilio Enabled");
-  }
-}

package/ts-reference/middleware/bugsnag.ts

@@ -1,10 +0,0 @@
-import { FastifyInstance } from "fastify";
-
-export async function setupBugsnag(fastify: FastifyInstance, options: any) {
-  if (options.active !== false && options.apiKey) {
-    await fastify.register(import("fastify-bugsnag"), {
-      apiKey: options.apiKey,
-    });
-    console.info("   ✅ Bugsnag Enabled");
-  }
-}

package/ts-reference/middleware/cors.ts

@@ -1,13 +0,0 @@
-import { FastifyInstance } from "fastify";
-
-export async function setupCors(fastify: FastifyInstance, options: any) {
-  if (options.active !== false) {
-    await fastify.register(import("@fastify/cors"), {
-      origin: options.origin || ["https://getx.io", "http://localhost:3000"],
-      credentials:
-        options.credentials !== undefined ? options.credentials : true,
-      methods: options.methods || ["GET", "POST", "PUT", "DELETE", "OPTIONS"],
-    });
-    console.info("   ✅ CORS Enabled");
-  }
-}

package/ts-reference/middleware/errorHandler.ts

@@ -1,24 +0,0 @@
-import { FastifyInstance } from "fastify";
-
-export async function setupErrorHandler(
-  fastify: FastifyInstance,
-  fancyErrors: boolean
-) {
-  if (fancyErrors !== false) {
-    fastify.setErrorHandler((error, request, reply) => {
-      const statusCode = error.statusCode || 500;
-      const response = {
-        status: statusCode,
-        message: error.message || "Internal Server Error",
-        stack: process.env.NODE_ENV === "development" ? error.stack : undefined,
-      };
-
-      // Optional Bugsnag error reporting
-      if (fastify.bugsnag) fastify.bugsnag.notify(error);
-
-      fastify.log.error(response);
-      reply.status(statusCode).send(response);
-    });
-    console.info("   ✅ Fancy Errors Enabled");
-  }
-}

package/ts-reference/middleware/multipart.ts

@@ -1,8 +0,0 @@
-import { FastifyInstance } from "fastify";
-
-export async function setupMultipart(fastify: FastifyInstance, options: any) {
-  if (options.active !== false) {
-    await fastify.register(import("@fastify/multipart"), options);
-    console.info("   ✅ Multipart Enabled");
-  }
-}

package/ts-reference/middleware/rateLimit.ts

@@ -1,8 +0,0 @@
-import { FastifyInstance } from "fastify";
-
-export async function setupRateLimit(fastify: FastifyInstance, options: any) {
-  if (options.active !== false) {
-    await fastify.register(import("@fastify/rate-limit"), options);
-    console.info("   ✅ Rate Limiting Enabled");
-  }
-}

package/ts-reference/middleware/underPressure.ts

@@ -1,11 +0,0 @@
-import { FastifyInstance } from "fastify";
-
-export async function setupUnderPressure(
-  fastify: FastifyInstance,
-  options: any
-) {
-  if (options.active !== false) {
-    await fastify.register(import("@fastify/under-pressure"), options);
-    console.info("   ✅ Under Pressure Enabled");
-  }
-}

package/ts-reference/utils/colorize.ts

@@ -1,45 +0,0 @@
-import type { FastifyInstance, RouteOptions } from "fastify";
-
-type HttpMethod = "POST" | "GET" | "PUT" | "DELETE" | "PATCH" | "clear";
-
-const COLORS: Record<HttpMethod, number> = {
-  POST: 33,
-  GET: 32,
-  PUT: 34,
-  DELETE: 31,
-  PATCH: 90,
-  clear: 39,
-};
-
-// Function to colorize method and path names
-export function colorize(method: string, text: string) {
-  const colorCode = COLORS[method as HttpMethod] || COLORS.clear;
-  return `\u001b[${colorCode}m${text}\u001b[${COLORS.clear}m`;
-}
-
-// Function to print the collected routes
-export function printRoutes(routes: RouteOptions[], colors = true): void {
-  routes
-    .sort((a, b) => a.url.localeCompare(b.url))
-    .forEach(({ method, url }) => {
-      const methodsArray = Array.isArray(method) ? method : [method];
-      methodsArray
-        .filter((m) => m !== "HEAD")
-        .forEach((m) =>
-          console.info(
-            `${colors ? colorize(m, m) : m}\t${colors ? colorize(m, url) : url}`
-          )
-        );
-    });
-}
-
-// Helper function to capture all registered routes
-export function captureRoutes(fastify: FastifyInstance): RouteOptions[] {
-  const routes: RouteOptions[] = [];
-
-  fastify.addHook("onRoute", (routeOptions) => {
-    routes.push(routeOptions);
-  });
-
-  return routes;
-}

package/ts-reference/utils/formatBytes.ts

@@ -1,8 +0,0 @@
-export function formatBytes(bytes: number, decimals = 2): string {
-  if (bytes === 0) return "0 Bytes";
-  const k = 1024;
-  const dm = decimals < 0 ? 0 : decimals;
-  const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB"];
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
-}

package/ts-reference/utils/randomUUID.ts

@@ -1,3 +0,0 @@
-import { randomUUID } from "uncrypto";
-
-export const generateUUID = randomUUID;

package/ts-reference/utils/statAsync.ts

@@ -1,4 +0,0 @@
-import fs from "fs";
-import util from "util";
-
-export const statAsync = util.promisify(fs.stat);

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "extends": "fastify-tsconfig",
-  "compilerOptions": {
-    "outDir": "dist",
-    "sourceMap": true,
-    "moduleResolution": "node",
-    "module": "NodeNext",
-    "target": "ES2022",
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true
-  },
-  "include": ["src/**/*.ts", "ts-reference/**/*.ts"],
-  "exclude": ["node_modules", "dist"]
-}

package/xConfigReference.js

@@ -1,119 +0,0 @@
-/**
- * xConfig - Fastify configuration plugin for core middleware and services
- *
- * This plugin provides centralized configuration for essential Fastify middleware and services:
- * - CORS and rate limiting
- * - Multipart form handling and back pressure monitoring
- * - Prisma database integration
- * - Error tracking (Bugsnag)
- * - Health checks and resource monitoring
- *
- * Key Features:
- * - Handles CORS, rate-limiting, multipart handling, and error handling out of the box
- * - Integrates with Prisma for database operations
- * - Provides optional Bugsnag integration for error tracking
- * - Includes health check routes with resource usage monitoring
- * - Gracefully handles server shutdown and resource cleanup
- *
- * Usage:
- * This plugin should be registered in your Fastify instance with options for each service.
- *
- * Example:
- * ```javascript
- * import Fastify from 'fastify';
- * import xConfig from '@xenterprises/fastify-xconfig';
- *
- * const fastify = Fastify();
- * fastify.register(xConfig, {
- *   professional: false,
- *   fancyErrors: true,
- *   prisma: {},
- *   bugsnag: { apiKey: process.env.BUGSNAG_API_KEY },
- *   cors: {
- *     active: true,
- *     origin: ['http://localhost:3000'],
- *     credentials: true
- *   },
- *   rateLimit: {
- *     max: 100,
- *     timeWindow: '1 minute'
- *   },
- *   multipart: {
- *     limits: { fileSize: 52428800 }  // 50MB
- *   },
- *   underPressure: {
- *     maxEventLoopDelay: 1000,
- *     maxHeapUsedBytes: 1000000000,
- *     maxRssBytes: 1000000000
- *   }
- * });
- *
- * fastify.listen({ port: 3000 });
- * ```
- *
- * Parameters:
- * @param {Object} options - Configuration options
- *   - professional {Boolean}: Disable route listing in professional mode (default: false)
- *   - fancyErrors {Boolean}: Enable formatted error responses (default: true)
- *   - prisma {Object}: Prisma Client configuration (optional)
- *   - bugsnag {Object}: Bugsnag error reporting config with apiKey (optional)
- *   - cors {Object}: CORS configuration with active, origin, credentials (optional)
- *   - rateLimit {Object}: Rate-limiting with max and timeWindow (optional)
- *   - multipart {Object}: Multipart handling options (optional)
- *   - underPressure {Object}: Back pressure monitoring configuration (optional)
- *
- * Health Check:
- * The `/health` route provides status about:
- * - Application uptime and version
- * - Database connectivity
- * - Memory and CPU usage
- * - Disk space availability
- * - Environment configuration validation
- *
- * Services:
- * - Prisma: Database ORM for queries
- * - CORS: Cross-origin resource sharing
- * - Rate Limiting: Request rate throttling
- * - Multipart: File upload handling
- * - Under Pressure: Load monitoring and throttling
- * - Bugsnag: Error tracking and reporting
- *
- * Decorators:
- * - fastify.health.check(): Get health status
- * - fastify.prisma: Prisma client instance
- * - fastify.slugify(string): Convert string to slug format
- * - fastify.UUID(): Generate UUID
- *
- * Separated Services:
- * The following services have been extracted to dedicated plugins:
- * - Authentication/JWKS → xAuthJWSK plugin
- * - Geocoding → xGeocode plugin
- * - SMS/Email → xTwilio plugin (separate module)
- * - File Storage → xStorage plugin (separate module)
- * - Payment Processing → xStripe plugin (separate module)
- *
- * Environment Variables:
- * - DATABASE_URL: PostgreSQL connection string
- * - NODE_ENV: development/production
- * - BUGSNAG_API_KEY: Optional error tracking
- * - CORS_ORIGIN: Comma-separated CORS origins
- * - RATE_LIMIT_MAX: Max requests (default: 100)
- * - RATE_LIMIT_TIME_WINDOW: Rate limit window (default: '1 minute')
- *
- * Error Handling:
- * Fancy error handling is enabled by default, showing enhanced error messages during development.
- * Errors are logged with full stack traces in development and clean messages in production.
- * Bugsnag integration is optional for real-time error reporting in production.
- *
- * Hooks:
- * - onClose: Gracefully disconnects Prisma on server shutdown
- *
- * Notes:
- * - This plugin is designed for essential middleware only
- * - Third-party services (SendGrid, Twilio, Stripe, etc.) should use dedicated plugins
- * - All configuration is optional except DATABASE_URL (if using Prisma)
- * - The plugin is highly customizable and works well in both development and production
- */
-
-// This file serves as documentation and reference for the xConfig plugin
-// The actual implementation is in src/xConfig.js