@xenterprises/fastify-xconfig 2.0.2 → 2.1.1

package/.env

@@ -0,0 +1,33 @@
+# Environment variables for xConfig Plugin
+# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
+# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
+
+# Database Configuration (Required)
+DATABASE_URL="postgresql://user:password@localhost:5432/dbname?sslmode=require"
+
+# Server Configuration
+NODE_ENV=development
+PORT=3002
+FASTIFY_ADDRESS=0.0.0.0
+
+# Error Tracking (optional)
+BUGSNAG_API_KEY="your-bugsnag-api-key"
+
+# CORS Configuration (optional)
+CORS_ORIGIN="http://localhost:3000,https://example.com"
+RATE_LIMIT_MAX=100
+RATE_LIMIT_TIME_WINDOW="1 minute"
+
+# ========================================
+# DEPRECATED / NO LONGER USED BY XCONFIG
+# ========================================
+# The following services have been extracted to separate plugins:
+#
+# Authentication → Use @xenterprises/fastify-xauth-jwks
+# Geolocation → Use @xenterprises/fastify-xgeocode
+# SMS Services → Use xTwilio plugin (separate module)
+# Email Services → Use separate email plugin
+# Image/File Storage → Use xStorage plugin (separate module)
+# Payment Processing → Use xStripe plugin (separate module)
+#
+# Old Stack Auth variables are deprecated - use xAuthJWSK instead

package/.gitlab-ci.yml

@@ -0,0 +1,45 @@
+# ============================================================================
+# GitLab CI/CD Pipeline - xConfig
+# ============================================================================
+# Runs tests on merge requests and commits to main/master
+
+stages:
+  - test
+
+variables:
+  NODE_ENV: test
+
+# ============================================================================
+# Shared Configuration
+# ============================================================================
+.shared_rules: &shared_rules
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+    - if: '$CI_COMMIT_BRANCH == "main"'
+    - if: '$CI_COMMIT_BRANCH == "master"'
+    - if: '$CI_COMMIT_TAG'
+
+# ============================================================================
+# STAGE: TEST
+# ============================================================================
+test:
+  stage: test
+  image: node:20-alpine
+  <<: *shared_rules
+
+  cache:
+    key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - node_modules/
+
+  before_script:
+    - npm ci
+
+  script:
+    - echo "Running xConfig tests..."
+    - npm test
+    - npm audit --audit-level=high || true
+
+  retry:
+    max: 2
+    when: runner_system_failure

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xenterprises/fastify-xconfig",
   "type": "module",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "Fastify configuration plugin for setting up middleware, services, and route handling.",
   "main": "src/xConfig.js",
   "scripts": {

package/test/index.js

@@ -1,17 +0,0 @@
-// test.js
-const fastify = require('fastify')();
-const myPlugin = require('../src/xConfig');
-
-fastify.register(myPlugin);
-
-fastify.get('/', async (request, reply) => {
-  return { message: fastify.myPluginMethod() };
-});
-
-try {
-  const address = await fastify.listen({ port: 3000 });
-  console.log(`Server running at ${address}`);
-} catch (err) {
-  console.error(err);
-  process.exit(1);
-}

package/test/xConfig.test.js

@@ -1,278 +0,0 @@
-// test/xConfig.test.js
-import { test } from "node:test";
-import assert from "node:assert";
-import Fastify from "fastify";
-import xConfig from "../src/xConfig.js";
-
-// Minimal config for testing
-const minimalConfig = {
-  prisma: { active: false },
-  bugsnag: { active: false },
-};
-
-test("xConfig Plugin - registers successfully", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-    assert.ok(true, "Plugin registered successfully");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - provides utility decorators", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-    // At least one utility decorator should be available
-    const hasUtilityDecorators =
-      fastify.xEcho !== undefined ||
-      fastify.xUUID !== undefined;
-    assert.ok(hasUtilityDecorators, "At least one utility decorator is available");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - has health route registered", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    const routes = [];
-    fastify.addHook("onRoute", (r) => routes.push(r));
-    await fastify.register(xConfig, minimalConfig);
-
-    // Check that health route is present
-    const hasHealthRoute = routes.some((r) => r.url === "/health");
-    assert.ok(hasHealthRoute, "Health endpoint route is registered");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - accepts custom CORS config", async () => {
-  const fastify = Fastify({ logger: false });
-  const customConfig = {
-    ...minimalConfig,
-    cors: { origin: "http://example.com" },
-  };
-  try {
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Custom CORS config accepted");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - accepts custom rate limit config", async () => {
-  const fastify = Fastify({ logger: false });
-  const customConfig = {
-    ...minimalConfig,
-    rateLimit: { max: 50, timeWindow: "1 minute" },
-  };
-  try {
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Custom rate limit config accepted");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - under pressure monitoring available", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    const customConfig = {
-      ...minimalConfig,
-      underPressure: {
-        maxEventLoopDelay: 1000,
-        maxHeapUsedBytes: 1000000000,
-        maxRssBytes: 1000000000
-      }
-    };
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Under pressure config accepted");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - multipart handling available", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    const customConfig = {
-      ...minimalConfig,
-      multipart: { limits: { fileSize: 52428800 } }
-    };
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Multipart config accepted");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Plugin - health check endpoint responds", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    const routes = [];
-    fastify.addHook("onRoute", (r) => routes.push(r));
-    await fastify.register(xConfig, minimalConfig);
-
-    const response = await fastify.inject({
-      method: "GET",
-      url: "/health"
-    });
-    assert.equal(response.statusCode, 200, "Health endpoint returns 200");
-    const body = JSON.parse(response.body);
-    assert.ok(body.status, "Health response includes status field");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Utilities - xUUID generates valid UUIDs", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-
-    const uuid1 = fastify.xRandomUUID();
-    const uuid2 = fastify.xRandomUUID();
-
-    // Check that randomUUID is a function
-    assert.equal(typeof fastify.xRandomUUID, "function", "randomUUID is a function");
-
-    // Check that UUIDs are generated
-    assert.ok(uuid1, "UUID is generated");
-    assert.ok(uuid2, "Second UUID is generated");
-
-    // Check that UUIDs are different
-    assert.notEqual(uuid1, uuid2, "UUIDs are unique");
-
-    // Check UUID format (36 chars, with dashes at positions 8, 13, 18, 23)
-    assert.match(uuid1, /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i, "UUID matches format");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Utilities - xSlugify handles various inputs", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-
-    // Test basic slugification
-    assert.equal(fastify.xSlugify("Hello World"), "hello-world", "Converts to lowercase and replaces spaces");
-    assert.equal(fastify.xSlugify("UPPERCASE"), "uppercase", "Converts uppercase to lowercase");
-    assert.equal(fastify.xSlugify("Multiple   Spaces"), "multiple-spaces", "Collapses multiple spaces");
-
-    // Test special character removal
-    assert.equal(fastify.xSlugify("Hello@World!"), "helloworld", "Removes special characters");
-    assert.equal(fastify.xSlugify("Test-String"), "test-string", "Preserves dashes");
-
-    // Test edge cases
-    assert.equal(fastify.xSlugify("  Trim  "), "trim", "Trims leading and trailing spaces");
-    assert.equal(fastify.xSlugify("---multiple-dashes---"), "multiple-dashes", "Collapses multiple dashes");
-    assert.equal(fastify.xSlugify(""), "", "Handles empty string");
-
-    // Test with numbers
-    assert.equal(fastify.xSlugify("Test123"), "test123", "Preserves numbers");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Utilities - xEcho returns status message", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-
-    const echo = fastify.xEcho();
-    assert.ok(echo, "xEcho returns a value");
-    assert.equal(typeof echo, "string", "xEcho returns a string");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Health Endpoint - response structure validation", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-
-    const response = await fastify.inject({
-      method: "GET",
-      url: "/health"
-    });
-
-    assert.equal(response.statusCode, 200, "Returns 200 status");
-
-    const body = JSON.parse(response.body);
-    assert.ok(body.status, "Has status field");
-    assert.ok(body.timestamp, "Has timestamp field");
-    assert.ok(body.details, "Has details object");
-    assert.ok(typeof body.details === "object", "Details is an object");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Configuration - CORS disabled when active is false", async () => {
-  const fastify = Fastify({ logger: false });
-  const customConfig = {
-    ...minimalConfig,
-    cors: { active: false },
-  };
-  try {
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Plugin accepts cors.active: false");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Configuration - rate limit disabled when active is false", async () => {
-  const fastify = Fastify({ logger: false });
-  const customConfig = {
-    ...minimalConfig,
-    rateLimit: { active: false },
-  };
-  try {
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Plugin accepts rateLimit.active: false");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Configuration - fancy errors can be disabled", async () => {
-  const fastify = Fastify({ logger: false });
-  const customConfig = {
-    ...minimalConfig,
-    fancyErrors: false,
-  };
-  try {
-    await fastify.register(xConfig, customConfig);
-    assert.ok(true, "Plugin accepts fancyErrors: false");
-  } finally {
-    await fastify.close();
-  }
-});
-
-test("xConfig Integration - all decorators available together", async () => {
-  const fastify = Fastify({ logger: false });
-  try {
-    await fastify.register(xConfig, minimalConfig);
-
-    // Verify all expected decorators exist
-    assert.ok(fastify.xEcho, "xEcho decorator available");
-    assert.ok(fastify.xRandomUUID, "randomUUID decorator available");
-    assert.ok(fastify.xGenerateUUID, "generateUUID decorator available");
-    assert.ok(fastify.xSlugify, "slugify decorator available");
-
-    // Verify they're functions
-    assert.equal(typeof fastify.xEcho, "function", "xEcho is a function");
-    assert.equal(typeof fastify.xRandomUUID, "function", "randomUUID is a function");
-    assert.equal(typeof fastify.xGenerateUUID, "function", "generateUUID is a function");
-    assert.equal(typeof fastify.xSlugify, "function", "slugify is a function");
-  } finally {
-    await fastify.close();
-  }
-});