@xenterprises/fastify-xconfig 1.0.0 → 1.0.2

package/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI workflow
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+        os: [ubuntu-latest, windows-latest]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install Dependencies
+      run: npm install --ignore-scripts
+    - name: Test
+      run: npm run test

package/.taprc

@@ -0,0 +1,3 @@
+ts: false
+jsx: false
+coverage: false

package/README.md

@@ -1,182 +1,29 @@
-# xConfig - Fastify Configuration Plugin
+# __MY_PLUGIN__
 
-**xConfig** is a Fastify configuration plugin designed for setting up middleware, services, and route handling.
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)  ![CI workflow](__MY_PLUGIN_URL__
+/workflows/CI%20workflow/badge.svg)
 
-This plugin provides a comprehensive setup for configuring various services such as Prisma, SendGrid, Twilio, Cloudinary, CORS, rate limiting, authentication, and more within a Fastify instance. It centralizes configuration, allowing for easy customization and scaling.
+Supports Fastify versions `4.x`
 
-## Key Features
-
-- Handles CORS, rate-limiting, multipart handling, and error handling out of the box.
-- Integrates with third-party services such as SendGrid, Twilio, Cloudinary, Stripe, and Bugsnag.
-- Provides authentication setup for both Admin and User, with Stack Auth integration.
-- Includes Prisma database connection and gracefully handles disconnecting on server shutdown.
-- Adds health check routes and resource usage monitoring, with environment validation.
-- Customizes route listing and applies various performance and security options.
+## Install
+```
+npm i __MY_PLUGIN__
+```
 
 ## Usage
+Require `__MY_PLUGIN__` and register.
+```js
+const fastify = require('fastify')()
 
-This plugin should be registered in your Fastify instance with custom options provided for each service. It ensures proper initialization of services like SendGrid, Twilio, and Prisma.
-
-### Example
-
-```typescript
-import Fastify from "fastify";
-import xConfig from "./path/to/xConfig";
+fastify.register(require('__MY_PLUGIN__'), {
+  // put your options here
+})
 
-const fastify = Fastify();
-fastify.register(xConfig, {
-  prisma: { active: true },
-  sendGrid: { apiKey: "your-sendgrid-api-key" },
-  twilio: {
-    accountSid: "your-account-sid",
-    authToken: "your-auth-token",
-    phoneNumber: "your-twilio-number",
-  },
-  cloudinary: {
-    cloudName: "your-cloud-name",
-    apiKey: "your-api-key",
-    apiSecret: "your-api-secret",
-  },
-  auth: {
-    excludedPaths: ["/public", "/portal/auth/register"],
-    admin: {
-      active: true,
-      stackProjectId: "your-admin-stack-project-id",
-      publishableKey: "your-admin-stack-publishable-key",
-      secretKey: "your-admin-stack-secret-key",
-    },
-    user: {
-      active: true,
-      stackProjectId: "your-user-stack-project-id",
-      publishableKey: "your-user-stack-publishable-key",
-      secretKey: "your-user-stack-secret-key",
-    },
-  },
-  cors: { origin: ["https://your-frontend.com"], credentials: true },
-});
-
-fastify.listen({ port: 3000 });
+fastify.listen({ port: 3000 })
 ```
 
-## Parameters
-
-- **prisma**: Prisma Client configuration (optional).
-- **sendGrid**: SendGrid configuration for email services (optional).
-- **twilio**: Twilio configuration for SMS services (optional).
-- **cloudinary**: Cloudinary configuration for media upload services (optional).
-- **auth**: Authentication configuration for Admin and User with Stack Auth integration (optional).
-- **cors**: CORS configuration (optional).
-- **rateLimit**: Rate-limiting options (optional).
-- **multipart**: Multipart handling options for file uploads (optional).
-- **bugsnag**: Bugsnag error reporting configuration (optional).
-- **underPressure**: Under Pressure plugin options for monitoring and throttling under load (optional).
-
-## Authentication
-
-The plugin provides both Admin and User authentication with Stack Auth integration. It handles token verification, protected routes, and authentication endpoints.
-
-### User Authentication
-
-- `/portal/auth/login` - User login endpoint
-- `/portal/auth/me` - Get current user information
-- `/portal/auth/verify` - Verify a user token
-
-### Admin Authentication
-
-- `/admin/auth/login` - Admin login endpoint
-- `/admin/auth/me` - Get current admin information
-- `/admin/auth/verify` - Verify an admin token
-
-### Stack Auth Integration
-
-The plugin integrates with [Stack Auth](https://stack-auth.com) for secure authentication. You'll need to provide:
-
-- `stackProjectId` - Your Stack Auth project ID
-- `publishableKey` - Your Stack Auth publishable client key
-- `secretKey` - Your Stack Auth secret server key
-
-These can be provided via environment variables or in the plugin options.
-
-## Health Check
+## Acknowledgements
 
-The `/health` route provides a health check with details about uptime, memory usage, CPU load, database and Redis status, and environment variable validation.
+## License
 
-## Services
-
-- **Prisma**: Initializes Prisma Client and decorates the Fastify instance for database queries.
-- **SendGrid**: Provides an email sending service through SendGrid, integrated with the Fastify instance.
-- **Twilio**: Provides SMS sending and phone number validation services.
-- **Cloudinary**: Handles file uploads to Cloudinary and deletion of media files.
-- **Authentication**: Stack Auth integration for secure user and admin authentication.
-
-## Hooks
-
-- **onRequest**: Validates tokens for protected routes.
-- **onClose**: Gracefully disconnects Prisma and other services on server shutdown.
-
-## Error Handling
-
-Enhanced error handling is enabled by default, showing detailed error messages during development. Bugsnag integration is optional for real-time error reporting.
-
-## Route Listing
-
-The plugin prints all routes after registration, color-coded by HTTP method, unless disabled.
-
-## Dependencies
-
-The following dependencies are used for various services and integrations:
-
-- Prisma Client, SendGrid, Twilio, Cloudinary, Fastify CORS, Fastify Rate Limit, Fastify Multipart, Fastify Under Pressure, and Fastify Bugsnag.
-
-## Environment Variables
-
-### Required for Authentication
-
-- `ADMIN_STACK_PROJECT_ID` - Stack Auth project ID for admin authentication
-- `ADMIN_STACK_PUBLISHABLE_CLIENT_KEY` - Stack Auth publishable key for admin authentication
-- `ADMIN_STACK_SECRET_SERVER_KEY` - Stack Auth secret key for admin authentication
-- `USER_STACK_PROJECT_ID` - Stack Auth project ID for user authentication
-- `USER_STACK_PUBLISHABLE_CLIENT_KEY` - Stack Auth publishable key for user authentication
-- `USER_STACK_SECRET_SERVER_KEY` - Stack Auth secret key for user authentication
-
-### Other Environment Variables
-
-- `DATABASE_URL` - Required for Prisma Client
-- `SENDGRID_API_KEY` - Required for SendGrid integration
-- `TWILIO_ACCOUNT_SID`, `TWILIO_AUTH_TOKEN`, `TWILIO_PHONE_NUMBER` - Required for Twilio integration
-- `CLOUDINARY_CLOUD_NAME`, `CLOUDINARY_API_KEY`, `CLOUDINARY_API_SECRET` - Required for Cloudinary integration
-
-## Example Configuration
-
-```javascript
-fastify.register(xConfig, {
-  prisma: { active: true },
-  sendGrid: { apiKey: "SG.your_api_key" },
-  twilio: {
-    accountSid: "ACxxxxxxxxxxxxxxxx",
-    authToken: "your_auth_token",
-    phoneNumber: "+1234567890",
-  },
-  cloudinary: {
-    cloudName: "your-cloud-name",
-    apiKey: "your-api-key",
-    apiSecret: "your-api-secret",
-  },
-  auth: {
-    excludedPaths: ["/public", "/portal/auth/login", "/portal/auth/register"],
-    admin: {
-      active: true,
-      stackProjectId: "your-admin-stack-project-id",
-      publishableKey: "your-admin-stack-publishable-key",
-      secretKey: "your-admin-stack-secret-key",
-    },
-    user: {
-      active: true,
-      stackProjectId: "your-user-stack-project-id",
-      publishableKey: "your-user-stack-publishable-key",
-      secretKey: "your-user-stack-secret-key",
-    },
-  },
-  cors: { origin: ["https://your-frontend.com"], credentials: true },
-});
-```
+Licensed under [MIT](./LICENSE).<br/>

package/dist/utils/randomUUID.d.ts

@@ -1 +1 @@
-export declare const generateUUID: any;
+export declare const generateUUID: () => `${string}-${string}-${string}-${string}-${string}`;

package/dist/xConfig.d.ts

@@ -1,3 +1,4 @@
-declare function xConfig(fastify: any, options: any): Promise<void>;
+import type { FastifyInstance, FastifyPluginOptions } from "fastify";
+declare function xConfig(fastify: FastifyInstance, options: FastifyPluginOptions): Promise<void>;
 declare const _default: typeof xConfig;
 export default _default;

package/dist/xConfig.js

@@ -1,7 +1,12 @@
-//src/xConfig.js
 import fp from "fastify-plugin";
+import { captureRoutes, printRoutes } from "./utils/colorize";
 async function xConfig(fastify, options) {
-    fastify.decorate("xEcho", () => "Hello from X Enterprises!");
+    // Capture routes using the hook
+    const routes = captureRoutes(fastify);
+    // After all plugins are loaded, print the routes
+    fastify.ready(() => {
+        printRoutes(routes);
+    });
 }
 export default fp(xConfig, {
     name: "xConfig",

package/dist/xConfig.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"xConfig.js","sourceRoot":"","sources":["../src/xConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEhC,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE9D,KAAK,UAAU,OAAO,CACpB,OAAwB,EACxB,OAA6B;IAE7B,gCAAgC;IAChC,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAEtC,iDAAiD;IACjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE;QACjB,WAAW,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,eAAe,EAAE,CAAC,OAAO,EAAE;IACzB,IAAI,EAAE,SAAS;CAChB,CAAC,CAAC"}

package/example.ts

@@ -0,0 +1,13 @@
+import { FastifyPluginCallback } from 'fastify'
+
+declare module 'fastify' {
+  export interface FastifyInstance {
+    // This is an example decorator type added to fastify
+    exampleDecorator: () => string
+  }
+}
+
+declare const example: FastifyPluginCallback<() => string>
+
+export { example }
+export default example

package/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@xenterprises/fastify-xconfig",
-  "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Fastify configuration plugin for setting up middleware, services, and route handling.",
-  "main": "src/xConfig.js",
+  "main": "dist/xConfig.js",
+  "directories": {
+    "test": "test"
+  },
+  "type": "module",
   "scripts": {
-    "start": "fastify start -l info server/app.js",
-    "dev": "fastify start -w -l info -P server/app.js",
-    "test": "node --test test/**/*.test.js"
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "node dist/xConfig.js",
+    "lint": "standard && npm run lint:typescript",
+    "lint:typescript": "ts-standard",
+    "test:typescript": "tsd",
+    "unit": "node --test"
   },
+  "keywords": [],
   "author": "Tim Mushen",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/node": "^22.7.4",
-    "c8": "^9.0.0",
-    "fastify": "^4.28.1",
-    "fastify-plugin": "^4.0.0",
-    "fastify-tsconfig": "^2.0.0",
-    "typescript": "^5.6.3"
-  },
+  "license": "MIT",
+  "types": "dist/xConfig.d.ts",
   "dependencies": {
-    "@fastify/autoload": "^6.0.2",
+    "@fastify/autoload": "^6.0.1",
     "@fastify/cookie": "^9.4.0",
     "@fastify/cors": "^9.0.1",
     "@fastify/jwt": "^8.0.1",
@@ -28,21 +29,39 @@
     "@fastify/rate-limit": "^9.1.0",
     "@fastify/sensible": "^5.6.0",
     "@fastify/under-pressure": "^9.0.1",
-    "@prisma/client": "^6.3.1",
+    "@prisma/client": "^5.20.0",
     "@sendgrid/client": "^8.1.3",
     "@sendgrid/mail": "^8.1.3",
     "bcrypt": "^5.1.1",
-    "check-disk-space": "^3.4.0",
-    "fastify": "^4.28.1",
     "fastify-bugsnag": "^4.1.4",
     "fastify-cli": "^6.2.1",
     "fastify-cloudinary": "^2.0.0",
     "fastify-list-routes": "^1.0.0",
     "fastify-multipart": "^5.4.0",
-    "fastify-plugin": "^4.0.0",
     "fastify-rate-limit": "^5.9.0",
     "stripe": "^16.12.0",
     "twilio": "^5.3.2",
     "uncrypto": "^0.1.3"
-  }
-}
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.0",
+    "fastify": "^4.28.1",
+    "fastify-plugin": "^4.0.0",
+    "fastify-tsconfig": "^2.0.0",
+    "standard": "^17.0.0",
+    "ts-standard": "^12.0.1",
+    "tsd": "^0.31.0",
+    "typescript": "^5.6.3"
+  },
+  "tsd": {
+    "directory": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xenterprises/module-fastify-xconfig.git"
+  },
+  "bugs": {
+    "url": "https://github.com/xenterprises/module-fastify-xconfig/issues"
+  },
+  "homepage": "https://github.com/xenterprises/module-fastify-xconfig#readme"
+}

package/src/xConfig.ts

@@ -0,0 +1,20 @@
+import fp from "fastify-plugin";
+import type { FastifyInstance, FastifyPluginOptions } from "fastify";
+import { captureRoutes, printRoutes } from "./utils/colorize";
+
+async function xConfig(
+  fastify: FastifyInstance,
+  options: FastifyPluginOptions
+) {
+  // Capture routes using the hook
+  const routes = captureRoutes(fastify);
+
+  // After all plugins are loaded, print the routes
+  fastify.ready(() => {
+    printRoutes(routes);
+  });
+}
+
+export default fp(xConfig, {
+  name: "xConfig",
+});

package/test/index.test-d.ts

@@ -0,0 +1,13 @@
+import fastify from 'fastify'
+import example from '../example'
+import { expectType } from 'tsd'
+
+let app
+try {
+  app = fastify()
+  void app.ready()
+  void app.register(example)
+  expectType<() => string>(app.exampleDecorator)
+} catch (err) {
+  console.error(err)
+}

package/test/index.test.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const { test } = require('node:test')
+const assert = require('node:assert')
+
+test('should register the correct decorator', async t => {
+  const app = require('fastify')()
+
+  app.register(require('..'))
+
+  await app.ready()
+
+  assert.equal(app.exampleDecorator(), 'decorated')
+})

package/test/xConfig.js

@@ -0,0 +1,115 @@
+import { test } from 'node:test';
+import * as assert from 'node:assert';
+import Fastify from 'fastify';
+import xConfig from '../path/to/xConfig.js'; // Adjust the path accordingly
+
+test('xConfig plugin works standalone', async (t) => {
+  const fastify = Fastify();
+
+  // Register the xConfig plugin with necessary options
+  await fastify.register(xConfig, {
+    prisma: { active: false }, // Mocked or disabled for testing
+    sendGrid: { active: false },
+    twilio: { active: false },
+    stripe: { active: false },
+    auth: {
+      admin: { active: false },
+      user: { active: false }
+    },
+    cors: { active: true },
+    underPressure: { active: false },
+    rateLimit: { active: false }
+  });
+
+  await fastify.ready();
+
+  // Test if the plugin registered correctly
+  assert.ok(fastify.prisma === undefined, 'Prisma should not be registered');
+  assert.ok(fastify.sendGrid === undefined, 'SendGrid should not be registered');
+  assert.ok(fastify.stripe === undefined, 'Stripe should not be registered');
+
+  // Test if health route is registered and works
+  const response = await fastify.inject({
+    method: 'GET',
+    url: '/health'
+  });
+
+  const body = JSON.parse(response.body);
+  assert.strictEqual(response.statusCode, 200, 'Health route should return status 200');
+  assert.strictEqual(body.status, 'healthy', 'Health status should be healthy');
+});
+
+test('xConfig CORS is enabled', async (t) => {
+  const fastify = Fastify();
+
+  // Register the xConfig plugin with CORS enabled
+  await fastify.register(xConfig, {
+    cors: {
+      active: true,
+      origin: ['http://localhost:3000'],
+      credentials: true
+    }
+  });
+
+  await fastify.ready();
+
+  // Check if the CORS headers are returned correctly
+  const response = await fastify.inject({
+    method: 'OPTIONS',
+    url: '/',
+    headers: {
+      origin: 'http://localhost:3000'
+    }
+  });
+
+  assert.strictEqual(response.headers['access-control-allow-origin'], 'http://localhost:3000');
+  assert.strictEqual(response.headers['access-control-allow-credentials'], 'true');
+  assert.strictEqual(response.statusCode, 204, 'CORS preflight request should return 204');
+});
+
+test('xConfig routes are listed correctly', async (t) => {
+  const fastify = Fastify();
+
+  // Register xConfig plugin with a dummy route to check if routes are listed
+  await fastify.register(xConfig, {
+    prisma: { active: false },
+    auth: { admin: { active: false }, user: { active: false } }
+  });
+
+  fastify.get('/test-route', async (request, reply) => {
+    reply.send({ message: 'Test Route' });
+  });
+
+  await fastify.ready();
+
+  // Test if the '/test-route' is available
+  const response = await fastify.inject({
+    method: 'GET',
+    url: '/test-route'
+  });
+
+  assert.strictEqual(response.statusCode, 200, 'Test route should return 200');
+  assert.strictEqual(JSON.parse(response.body).message, 'Test Route');
+
+  // Check if routes are printed correctly (this is more of a manual log observation)
+  fastify.ready(() => {
+    fastify.printRoutes(); // This will print routes to console
+  });
+});
+
+test('xConfig fails if required options are missing', async (t) => {
+  const fastify = Fastify();
+
+  // Test missing required options like SendGrid API Key
+  try {
+    await fastify.register(xConfig, {
+      sendGrid: { active: true }
+    });
+
+    await fastify.ready();
+    assert.fail('Should have thrown an error due to missing SendGrid API Key');
+  } catch (err) {
+    assert.ok(err instanceof Error, 'Should throw an error');
+    assert.strictEqual(err.message, 'SendGrid API key must be provided.');
+  }
+});

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "declaration": true,              // Generates .d.ts files for types
+    "outDir": "./dist",               // Output directory for compiled files
+    "strict": true,                   // Enable all strict type-checking options
+    "moduleResolution": "node",       // Proper module resolution
+    "esModuleInterop": true,          // Allows default imports from CJS modules
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],            // Specifies files to include for compilation
+  "exclude": ["node_modules", "dist"]
+}

package/server/app.js

@@ -1,85 +0,0 @@
-// server/app.js
-import Fastify from 'fastify';
-import xConfig from '../src/xConfig.js';  // Import your plugin correctly
-
-const fastify = Fastify();
-
-
-export default async function (fastify, opts) {
-  fastify.register(xConfig, {
-    professional: false,
-    fancyErrors: true,
-    prisma: {
-      active: false,
-    },
-    bugsnag: {
-      apiKey: process.env.BUGSNAG_API_KEY
-    },
-    rateLimit: {
-      max: process.env.RATE_LIMIT_MAX || 100,
-      timeWindow: process.env.RATE_LIMIT_TIME_WINDOW || '1 minute'
-    },
-    stripe: {
-      active: false,
-      apiKey: process.env.STRIPE_API_KEY
-    },
-    sendGrid: {
-      active: true,
-      apiKey: process.env.SENDGRID_API_KEY,
-      apiKeyEmailValidation: process.env.SENDGRID_API_EMAIL_VALIDATION_KEY,
-      fromEmail: process.env.SENDGRID_FROM_EMAIL || 'ops@getx.io',
-    },
-    twilio: {
-      active: true,
-      accountSid: process.env.TWILIO_ACCOUNT_SID,
-      authToken: process.env.TWILIO_AUTH_TOKEN,
-      phoneNumber: process.env.TWILIO_PHONE_NUMBER
-    },
-    cloudinary: {
-      active: false,
-      cloudName: process.env.CLOUDINARY_CLOUD_NAME,
-      apiKey: process.env.CLOUDINARY_API_KEY,
-      apiSecret: process.env.CLOUDINARY_API_SECRET,
-      basePath: process.env.CLOUDINARY_BASE_PATH || 'basepath'
-    },
-    cors: {
-      active: true,
-      origin: process.env.CORS_ORIGIN || ['http://localhost:3000', 'https://app.bandmate.io'],
-      credentials: true
-    },
-    auth: {
-      excludedPaths: ['/public', '/portal/auth/register'],
-      admin: {
-        active: true,
-        secret: process.env.ADMIN_JWT_SECRET,
-        expiresIn: '1h',
-        cookieOptions: {
-          name: 'adminToken',
-          httpOnly: true,
-          secure: true, // Set to false if not using HTTPS
-          sameSite: 'strict', // Can be 'lax', 'strict', or 'none'
-        }
-      },
-      user: {
-        active: true,
-        portalStackProjectId: process.env.STACK_PROJECT_ID,
-        me: {
-          isOnboarded: true
-        },
-        registerEmail: {
-          subject: 'Welcome to Bandmate!',
-          templateId: ''
-        }
-      },
-    },
-    geocode: {
-      active: true,
-      apiKey: process.env.GEOCODIO_API_KEY
-    }
-  });  // Register the default export, which should be a function
-  fastify.get('/', async (request, reply) => {
-    console.log(fastify.xEcho())
-    return { status: fastify.xEcho() }
-  })
-
-};