@jaredwray/mockhttp 0.0.1 → 0.1.0

package/package.json

@@ -1,12 +1,23 @@
 {
   "name": "@jaredwray/mockhttp",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Mock Http - Easy way to mock http with httpbin replacement",
   "type": "module",
   "main": "dist/index.js",
   "directories": {
     "test": "test"
   },
+  "scripts": {
+    "test": "xo --fix && vitest run --coverage",
+    "dev": "xo --fix && npx tsx src/index.ts --watch",
+    "build": "rimraf ./dist && tsup src/index.ts --format esm --dts --clean",
+    "docker:build": "docker build -t jaredwray/mockhttp .",
+    "docker:run": "docker run -p 3000:3000 jaredwray/mockhttp",
+    "docker:push": "docker push jaredwray/mockhttp",
+    "docker:stop": "docker stop $(docker ps -a -q --filter ancestor=jaredwray/mockhttp --format=\"{{.ID}}\")",
+    "prepare": "npm run build",
+    "start": "node dist/index.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jaredwray/mockhttp.git"
@@ -24,16 +35,21 @@
   },
   "homepage": "https://github.com/jaredwray/mockhttp#readme",
   "devDependencies": {
-    "@vitest/coverage-v8": "^2.1.5",
+    "@swc/core": "^1.10.1",
+    "@vitest/coverage-v8": "^2.1.8",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.5",
-    "xo": "^0.59.3"
+    "vitest": "^2.1.8",
+    "xo": "^0.60.0"
   },
   "dependencies": {
+    "@fastify/helmet": "^13.0.0",
     "@fastify/static": "^8.0.3",
     "@fastify/swagger": "^9.4.0",
-    "@fastify/swagger-ui": "^5.1.0",
+    "@fastify/swagger-ui": "^5.2.0",
+    "@scalar/api-reference": "^1.25.80",
     "fastify": "^5.1.0",
     "pino": "^9.5.0",
     "pino-pretty": "^13.0.0"
@@ -42,11 +58,5 @@
     "dist",
     "public",
     "LICENCE"
-  ],
-  "scripts": {
-    "test": "xo --fix && vitest run --coverage",
-    "dev": "xo --fix && npx tsx src/index.ts --watch",
-    "build": "tsc",
-    "start": "node dist/index.js"
-  }
-}
+  ]
+}

package/dist/fastify-config.js

@@ -1,12 +0,0 @@
-export const fastifyConfig = {
-    logger: {
-        transport: {
-            target: 'pino-pretty',
-            options: {
-                colorize: true,
-                translateTime: true,
-                ignore: 'pid,hostname',
-            },
-        },
-    },
-};

package/dist/routes/delete-route.js

@@ -1,27 +0,0 @@
-const deleteSchema = {
-    description: 'Handles a DELETE request and returns request information',
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the DELETE request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const deleteRoute = (fastify) => {
-    fastify.delete('/delete', { schema: deleteSchema }, async (request) => ({
-        method: 'DELETE',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/get-route.js

@@ -1,34 +0,0 @@
-export const getSchema = {
-    description: 'Returns request information for GET requests',
-    querystring: {
-        type: 'object',
-        additionalProperties: true,
-        properties: {},
-        description: 'Query parameters sent in the request',
-    },
-    headers: {
-        type: 'object',
-        additionalProperties: true,
-        properties: {},
-        description: 'Headers sent in the request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                queryParams: { type: 'object', additionalProperties: { type: 'string' } },
-            },
-            required: ['method', 'headers', 'queryParams'],
-        },
-    },
-};
-export const getRoute = (fastify) => {
-    fastify.get('/get', { schema: getSchema }, async (request, _reply) => ({
-        method: 'GET',
-        headers: request.headers,
-        queryParams: request.query,
-    }));
-};

package/dist/routes/http-methods/delete.js

@@ -1,28 +0,0 @@
-const deleteSchema = {
-    description: 'Handles a DELETE request and returns request information',
-    tags: ['HTTP Methods'],
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the DELETE request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const deleteRoute = (fastify) => {
-    fastify.delete('/delete', { schema: deleteSchema }, async (request) => ({
-        method: 'DELETE',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/http-methods/get.js

@@ -1,35 +0,0 @@
-export const getSchema = {
-    description: 'Returns request information for GET requests',
-    tags: ['HTTP Methods'],
-    querystring: {
-        type: 'object',
-        additionalProperties: true,
-        properties: {},
-        description: 'Query parameters sent in the request',
-    },
-    headers: {
-        type: 'object',
-        additionalProperties: true,
-        properties: {},
-        description: 'Headers sent in the request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                queryParams: { type: 'object', additionalProperties: { type: 'string' } },
-            },
-            required: ['method', 'headers', 'queryParams'],
-        },
-    },
-};
-export const getRoute = (fastify) => {
-    fastify.get('/get', { schema: getSchema }, async (request, _reply) => ({
-        method: 'GET',
-        headers: request.headers,
-        queryParams: request.query,
-    }));
-};

package/dist/routes/http-methods/index.js

@@ -1,5 +0,0 @@
-export { getRoute } from './get.js';
-export { postRoute } from './post.js';
-export { deleteRoute } from './delete.js';
-export { putRoute } from './put.js';
-export { patchRoute } from './patch.js';

package/dist/routes/http-methods/patch.js

@@ -1,28 +0,0 @@
-const patchSchema = {
-    description: 'Handles a PATCH request and returns request information',
-    tags: ['HTTP Methods'],
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the PATCH request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const patchRoute = (fastify) => {
-    fastify.patch('/patch', { schema: patchSchema }, async (request) => ({
-        method: 'PATCH',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/http-methods/post.js

@@ -1,28 +0,0 @@
-const postSchema = {
-    description: 'Handles a POST request and returns request information',
-    tags: ['HTTP Methods'],
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the POST request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const postRoute = (fastify) => {
-    fastify.post('/post', { schema: postSchema }, async (request) => ({
-        method: 'POST',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/http-methods/put.js

@@ -1,28 +0,0 @@
-const putSchema = {
-    description: 'Handles a PUT request and returns request information',
-    tags: ['HTTP Methods'],
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the PUT request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const putRoute = (fastify) => {
-    fastify.put('/put', { schema: putSchema }, async (request) => ({
-        method: 'PUT',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/index-route.js

@@ -1,67 +0,0 @@
-export const indexRoute = (fastify) => {
-    fastify.get('/', { schema: { hide: true } }, async (_request, reply) => {
-        const redocHtml = `
-	<!doctype html>
-<html>
-  <head>
-    <title>{ mockhttp } </title>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1" />
-      <style>
-      :root {
-  --scalar-custom-header-height: 70px;
-}
-.custom-header {
-  height: var(--scalar-custom-header-height);
-  background-color: var(--scalar-background-1);
-  box-shadow: inset 0 -1px 0 var(--scalar-border-color);
-  color: var(--scalar-color-1);
-  font-size: var(--scalar-font-size-2);
-  padding: 0 18px;
-  position: sticky;
-  justify-content: space-between;
-  top: 0;
-  z-index: 100;
-}
-.custom-header,
-.custom-header nav {
-  display: flex;
-  align-items: center;
-  gap: 18px;
-}
-
-.custom-header img {
-  height: var(--scalar-custom-header-height);
-  object-fit: contain;
-}
-
-.custom-header a:hover {
-  color: var(--scalar-color-2);
-}
-
-.github-corner {
-  fill: var(--scalar-border-color) !important;
-}
-
-      </style>
-  </head>
-  <body>
-  <header class="custom-header scalar-app">
-    <img src="/logo.svg" alt="{ mockhttp }" />
-    <a href="https://github.com/jaredwray/mockhttp" class="github-corner" aria-label="View source on GitHub">
-      <svg width="70" height="70" viewBox="0 0 250 250" style="color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
-  </header>
-
-    <script
-      id="api-reference"
-      data-url="/docs/json"></script>
-
-    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
-  </body>
-</html>
-`;
-        await reply.type('text/html').send(redocHtml);
-    });
-};

package/dist/routes/ip-route.js

@@ -1,25 +0,0 @@
-const ipSchema = {
-    description: 'Returns the IP address of the client',
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                ip: { type: 'string', description: 'The IP address of the client' },
-            },
-            required: ['ip'],
-        },
-    },
-};
-export const ipRoute = (fastify) => {
-    fastify.get('/ip', { schema: ipSchema }, async (request) => {
-        const cloudflareIp = request.headers['cf-connecting-ip'];
-        const forwardedIp = request.headers['x-forwarded-for'];
-        const remoteIp = request.ip;
-        // Determine the client's IP address, considering Cloudflare and other proxies
-        const ip = cloudflareIp ?? (typeof forwardedIp === 'string' ? forwardedIp.split(',')[0].trim() : remoteIp);
-        return {
-            ip,
-        };
-    });
-};

package/dist/routes/post-route.js

@@ -1,27 +0,0 @@
-const postSchema = {
-    description: 'Handles a POST request and returns request information',
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the POST request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const postRoute = (fastify) => {
-    fastify.post('/post', { schema: postSchema }, async (request) => ({
-        method: 'POST',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/put-route.js

@@ -1,27 +0,0 @@
-const putSchema = {
-    description: 'Handles a PUT request and returns request information',
-    body: {
-        type: 'object',
-        additionalProperties: true,
-        description: 'The body of the PUT request',
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                method: { type: 'string' },
-                headers: { type: 'object', additionalProperties: { type: 'string' } },
-                body: { type: 'object', additionalProperties: true },
-            },
-            required: ['method', 'headers', 'body'],
-        },
-    },
-};
-export const putRoute = (fastify) => {
-    fastify.put('/put', { schema: putSchema }, async (request) => ({
-        method: 'PUT',
-        headers: request.headers,
-        body: request.body,
-    }));
-};

package/dist/routes/request-inspection/headers.js

@@ -1,26 +0,0 @@
-const headersSchema = {
-    description: 'Returns all headers of the client request',
-    tags: ['Request Inspection'],
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                headers: {
-                    type: 'object',
-                    additionalProperties: { type: 'string' },
-                    description: 'All headers of the client request',
-                },
-            },
-            required: ['headers'],
-        },
-    },
-};
-export const headersRoute = (fastify) => {
-    fastify.get('/headers', { schema: headersSchema }, async (request) => {
-        const headers = request.headers;
-        return {
-            headers,
-        };
-    });
-};

package/dist/routes/request-inspection/index.js

@@ -1,3 +0,0 @@
-export { ipRoute } from './ip.js';
-export { headersRoute } from './headers.js';
-export { userAgentRoute } from './user-agent.js';

package/dist/routes/request-inspection/ip.js

@@ -1,26 +0,0 @@
-const ipSchema = {
-    description: 'Returns the IP address of the client',
-    tags: ['Request Inspection'],
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                ip: { type: 'string', description: 'The IP address of the client' },
-            },
-            required: ['ip'],
-        },
-    },
-};
-export const ipRoute = (fastify) => {
-    fastify.get('/ip', { schema: ipSchema }, async (request) => {
-        const cloudflareIp = request.headers['cf-connecting-ip'];
-        const forwardedIp = request.headers['x-forwarded-for'];
-        const remoteIp = request.ip;
-        // Determine the client's IP address, considering Cloudflare and other proxies
-        const ip = cloudflareIp ?? (typeof forwardedIp === 'string' ? forwardedIp.split(',')[0].trim() : remoteIp);
-        return {
-            ip,
-        };
-    });
-};

package/dist/routes/request-inspection/user-agent.js

@@ -1,25 +0,0 @@
-const userAgentSchema = {
-    description: 'Returns the User-Agent header of the client request',
-    tags: ['Request Inspection'],
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                userAgent: {
-                    type: 'string',
-                    description: 'The User-Agent header of the client request',
-                },
-            },
-            required: ['userAgent'],
-        },
-    },
-};
-export const userAgentRoute = (fastify) => {
-    fastify.get('/user-agent', { schema: userAgentSchema }, async (request) => {
-        const userAgent = request.headers['user-agent'];
-        return {
-            userAgent,
-        };
-    });
-};

package/dist/routes/status-codes/get.js

@@ -1,29 +0,0 @@
-const statusSchema = {
-    description: 'Returns a response with the provided status code',
-    tags: ['Status Codes'],
-    params: {
-        type: 'object',
-        properties: {
-            code: { type: 'string', description: 'HTTP status code to be returned' },
-        },
-        required: ['code'],
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                status: { type: 'string' },
-            },
-        },
-    },
-};
-export const getStatusCodeRoute = (fastify) => {
-    fastify.get('/status/:code', { schema: statusSchema }, async (request, reply) => {
-        const { code } = request.params;
-        await reply.code(Number(code));
-        return {
-            status: `Response with status code ${code}`,
-        };
-    });
-};

package/dist/routes/status-codes/index.js

@@ -1,102 +0,0 @@
-import { randomInt } from 'node:crypto';
-const statusCodes = [
-    { code: 100, message: 'Continue' },
-    { code: 101, message: 'Switching Protocols' },
-    { code: 102, message: 'Processing' },
-    { code: 103, message: 'Early Hints' },
-    { code: 200, message: 'OK' },
-    { code: 201, message: 'Created' },
-    { code: 202, message: 'Accepted' },
-    { code: 203, message: 'Non-Authoritative Information' },
-    { code: 204, message: 'No Content' },
-    { code: 205, message: 'Reset Content' },
-    { code: 206, message: 'Partial Content' },
-    { code: 207, message: 'Multi-Status' },
-    { code: 208, message: 'Already Reported' },
-    { code: 226, message: 'IM Used' },
-    { code: 300, message: 'Multiple Choices' },
-    { code: 301, message: 'Moved Permanently' },
-    { code: 302, message: 'Found' },
-    { code: 303, message: 'See Other' },
-    { code: 304, message: 'Not Modified' },
-    { code: 305, message: 'Use Proxy' },
-    { code: 306, message: 'Switch Proxy' },
-    { code: 307, message: 'Temporary Redirect' },
-    { code: 308, message: 'Permanent Redirect' },
-    { code: 400, message: 'Bad Request' },
-    { code: 401, message: 'Unauthorized' },
-    { code: 402, message: 'Payment Required' },
-    { code: 403, message: 'Forbidden' },
-    { code: 404, message: 'Not Found' },
-    { code: 405, message: 'Method Not Allowed' },
-    { code: 406, message: 'Not Acceptable' },
-    { code: 407, message: 'Proxy Authentication Required' },
-    { code: 408, message: 'Request Timeout' },
-    { code: 409, message: 'Conflict' },
-    { code: 410, message: 'Gone' },
-    { code: 411, message: 'Length Required' },
-    { code: 412, message: 'Precondition Failed' },
-    { code: 413, message: 'Payload Too Large' },
-    { code: 414, message: 'URI Too Long' },
-    { code: 415, message: 'Unsupported Media Type' },
-    { code: 416, message: 'Range Not Satisfiable' },
-    { code: 417, message: 'Expectation Failed' },
-    { code: 418, message: 'I\'m a teapot' },
-    { code: 421, message: 'Misdirected Request' },
-    { code: 422, message: 'Unprocessable Entity' },
-    { code: 423, message: 'Locked' },
-    { code: 424, message: 'Failed Dependency' },
-    { code: 425, message: 'Too Early' },
-    { code: 426, message: 'Upgrade Required' },
-    { code: 428, message: 'Precondition Required' },
-    { code: 429, message: 'Too Many Requests' },
-    { code: 431, message: 'Request Header Fields Too Large' },
-    { code: 451, message: 'Unavailable For Legal Reasons' },
-    { code: 500, message: 'Internal Server Error' },
-    { code: 501, message: 'Not Implemented' },
-    { code: 502, message: 'Bad Gateway' },
-    { code: 503, message: 'Service Unavailable' },
-    { code: 504, message: 'Gateway Timeout' },
-    { code: 505, message: 'HTTP Version Not Supported' },
-    { code: 506, message: 'Variant Also Negotiates' },
-    { code: 507, message: 'Insufficient Storage' },
-    { code: 508, message: 'Loop Detected' },
-    { code: 510, message: 'Not Extended' },
-    { code: 511, message: 'Network Authentication Required' },
-];
-const statusSchema = {
-    description: 'Return status code or random status code if more than one are given ',
-    tags: ['Status Codes'],
-    params: {
-        type: 'object',
-        properties: {
-            code: { type: 'string', description: 'HTTP status code to be returned' },
-        },
-    },
-    response: {
-        // eslint-disable-next-line  @typescript-eslint/naming-convention
-        200: {
-            type: 'object',
-            properties: {
-                status: { type: 'string' },
-            },
-        },
-    },
-};
-export const statusCodeRoute = (fastify) => {
-    const handler = async (request, reply) => {
-        let { code } = request.params;
-        // Check if the code is a valid HTTP status code, otherwise pick a random one
-        if (!code || !statusCodes.map(status => status.code).includes(Number(code))) {
-            code = statusCodes[randomInt(0, statusCodes.length)].code.toString();
-        }
-        await reply.code(Number(code)).send({
-            status: `Response with status code ${code}`,
-        });
-    };
-    fastify.get('/status/:code?', { schema: statusSchema }, handler);
-    fastify.post('/status/:code?', { schema: statusSchema }, handler);
-    fastify.put('/status/:code?', { schema: statusSchema }, handler);
-    fastify.patch('/status/:code?', { schema: statusSchema }, handler);
-    fastify.delete('/status/:code?', { schema: statusSchema }, handler);
-};