@xenterprises/fastify-xconfig 1.0.2 → 1.1.0

package/.github/workflows/ci.yml

@@ -1,19 +0,0 @@
-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

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

package/example.ts

@@ -1,13 +0,0 @@
-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/src/xConfig.ts

@@ -1,20 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,14 +0,0 @@
-'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

@@ -1,115 +0,0 @@
-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.');
-  }
-});