@jaredwray/mockhttp 0.2.2 → 0.3.0

package/README.md

@@ -7,9 +7,17 @@
 [![npm](https://img.shields.io/npm/v/@jaredwray/mockhttp)](https://npmjs.com/package/@jaredwray/mockhttp)
 [![Docker Pulls](https://img.shields.io/docker/pulls/jaredwray/mockhttp)](https://hub.docker.com/r/jaredwray/mockhttp)
 
-
 A simple HTTP server that can be used to mock HTTP responses for testing purposes. Inspired by [httpbin](https://httpbin.org/) and built using `nodejs` and `fastify` with the idea of running it via https://mockhttp.org, via docker `jaredwray/mockhttp`, or nodejs `npm install jaredwray/mockhttp`.
 
+# Features
+* All the features of [httpbin](https://httpbin.org/)
+* CORS and Helmet support
+* Built with `nodejs` and `fastify`
+* Deploy via `docker` or `nodejs`
+* Global deployment via [mockhttp.org](https://mockhttp.org) (free service)
+* Better API documentation and examples
+* Maintained and updated regularly!
+
 # Deploy via Docker
 ```bash
 docker run -d -p 3000:3000 jaredwray/mockhttp
@@ -24,14 +32,14 @@ then run `mockhttp` in your code.
 
 ```javascript
 import { mockhttp } from '@jaredwray/mockhttp';
-mockhttp.start(); // start the server
+await mockhttp.start(); // start the server
 const response = await fetch('http://localhost:8080/ip');
-mockhttp.stop(); // stop the server
+await mockhttp.stop(); // stop the server
 ```
 
 # About mockhttp.org 
 
-[mockhttp.org](https://mockhttp.org) is a free service that runs this codebase and allows you to use it for testing purposes. It is a simple way to mock HTTP responses for testing purposes. It is globally available has some limitations on it to prevent abuse but many people will not see it. It is ran via [Cloudflare](https://cloudflare.com) and [Google Cloud Run](https://cloud.google.com/run/) across 7 regions globally.
+[mockhttp.org](https://mockhttp.org) is a free service that runs this codebase and allows you to use it for testing purposes. It is a simple way to mock HTTP responses for testing purposes. It is globally available has some limitations on it to prevent abuse but many people will not see it. It is ran via [Cloudflare](https://cloudflare.com) and [Google Cloud Run](https://cloud.google.com/run/) across 7 regions globally and can do millions of requests per second.
 
 # Contributing
 

package/dist/index.js

@@ -8,9 +8,8 @@ import Fastify from "fastify";
 import fastifyStatic from "@fastify/static";
 import { fastifySwagger } from "@fastify/swagger";
 import fastifyHelmet from "@fastify/helmet";
-import fastifyCors from "@fastify/cors";
 
-// src/routes/index-route.ts
+// src/routes/index.ts
 var indexRoute = /* @__PURE__ */ __name((fastify2) => {
   fastify2.get("/", {
     schema: {
@@ -83,6 +82,35 @@ var indexRoute = /* @__PURE__ */ __name((fastify2) => {
   });
 }, "indexRoute");
 
+// src/routes/sitemap.ts
+var sitemapRoute = /* @__PURE__ */ __name((fastify2) => {
+  fastify2.get("/sitemap.xml", {
+    schema: {
+      hide: true
+    }
+  }, async (_request, reply) => {
+    try {
+      const host = _request.headers.host ?? "mockhttp.org";
+      const isSecure = _request.headers["x-forwarded-proto"]?.includes("https");
+      const protocol = isSecure ? "https" : "http";
+      const xml = `<?xml version="1.0" encoding="UTF-8"?>
+                            <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+                                <url>
+                                    <loc>${protocol}://${host}/</loc>
+                                    <changefreq>monthly</changefreq>
+                                    <priority>1.0</priority>
+                                </url>
+                        </urlset>`;
+      await reply.type("text/xml").send(xml);
+    } catch (error) {
+      fastify2.log.error(error);
+      await reply.status(500).send({
+        error: "Internal Server Error"
+      });
+    }
+  });
+}, "sitemapRoute");
+
 // src/fastify-config.ts
 var fastifyConfig = {
   logger: {
@@ -104,7 +132,7 @@ import { fastifySwaggerUi } from "@fastify/swagger-ui";
 // package.json
 var package_default = {
   name: "@jaredwray/mockhttp",
-  version: "0.2.2",
+  version: "0.3.0",
   description: "Mock Http - Easy way to mock http with httpbin replacement",
   type: "module",
   main: "dist/index.js",
@@ -113,7 +141,7 @@ var package_default = {
   },
   scripts: {
     test: "xo --fix && vitest run --coverage",
-    dev: "xo --fix && npx tsx src/index.ts --watch",
+    dev: "xo --fix && 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",
@@ -140,26 +168,25 @@ var package_default = {
   },
   homepage: "https://github.com/jaredwray/mockhttp#readme",
   devDependencies: {
-    "@swc/core": "^1.10.1",
+    "@swc/core": "^1.10.9",
     "@types/html-escaper": "^3.0.2",
-    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/coverage-v8": "^3.0.4",
     rimraf: "^6.0.1",
-    tsup: "^8.3.5",
+    tsup: "^8.3.6",
     tsx: "^4.19.2",
-    typescript: "^5.7.2",
-    vitest: "^2.1.8",
+    typescript: "^5.7.3",
+    vitest: "^3.0.4",
     xo: "^0.60.0"
   },
   dependencies: {
-    "@fastify/cors": "^10.0.1",
-    "@fastify/helmet": "^13.0.0",
-    "@fastify/static": "^8.0.3",
-    "@fastify/swagger": "^9.4.0",
-    "@fastify/swagger-ui": "^5.2.0",
-    "@scalar/api-reference": "^1.25.82",
-    fastify: "^5.1.0",
+    "@fastify/helmet": "^13.0.1",
+    "@fastify/static": "^8.0.4",
+    "@fastify/swagger": "^9.4.2",
+    "@fastify/swagger-ui": "^5.2.1",
+    "@scalar/api-reference": "^1.25.108",
+    fastify: "^5.2.1",
     "html-escaper": "^3.0.3",
-    pino: "^9.5.0",
+    pino: "^9.6.0",
     "pino-pretty": "^13.0.0"
   },
   files: [
@@ -170,11 +197,22 @@ var package_default = {
 };
 
 // src/swagger.ts
+var description = `
+A simple HTTP server that can be used to mock HTTP responses for testing purposes. Inspired by [httpbin](https://httpbin.org/) and built using \`nodejs\` and \`fastify\` with the idea of running it via https://mockhttp.org, via docker \`jaredwray/mockhttp\`, or nodejs \`npm install jaredwray/mockhttp\`.
+
+* [GitHub Repository](https://github.com/jaredwray/mockhttp)
+* [Docker Image](https://hub.docker.com/r/jaredwray/mockhttp)
+* [NPM Package](https://www.npmjs.com/package/jaredwray/mockhttp)
+
+# About mockhttp.org 
+
+[mockhttp.org](https://mockhttp.org) is a free service that runs this codebase and allows you to use it for testing purposes. It is a simple way to mock HTTP responses for testing purposes. It is globally available has some limitations on it to prevent abuse but many people will not see it. It is ran via [Cloudflare](https://cloudflare.com) and [Google Cloud Run](https://cloud.google.com/run/) across 7 regions globally and can do millions of requests per second.
+`;
 var fastifySwaggerConfig = {
   openapi: {
     info: {
       title: "Mock HTTP API",
-      description: "A replacement for httpbin built using Fastify and Typescript",
+      description,
       version: package_default.version
     },
     consumes: [
@@ -1047,6 +1085,176 @@ var responseHeadersRoutes = /* @__PURE__ */ __name((fastify2) => {
   });
 }, "responseHeadersRoutes");
 
+// src/routes/redirects/absolute-redirect.ts
+var absoluteRedirectSchema = {
+  tags: [
+    "Redirects"
+  ],
+  description: "Redirects the request to the target URL using an absolute URL",
+  params: {
+    type: "object",
+    properties: {
+      value: {
+        type: "integer",
+        minimum: 1
+      }
+    },
+    required: [
+      "value"
+    ]
+  },
+  headers: {
+    type: "object",
+    properties: {
+      host: {
+        type: "string"
+      }
+    },
+    required: [
+      "host"
+    ]
+  },
+  response: {
+    // eslint-disable-next-line  @typescript-eslint/naming-convention
+    302: {
+      type: "string"
+    }
+  }
+};
+var absoluteRedirectRoute = /* @__PURE__ */ __name((fastify2) => {
+  fastify2.get("/absolute-redirect/:value", {
+    schema: absoluteRedirectSchema
+  }, async (request, reply) => {
+    const value = request.params.value;
+    const { host } = request.headers;
+    const protocol = request.protocol;
+    let url = `${protocol}://${host}/get`;
+    let html = `
+        <title>Redirecting...</title>
+        <h1>Redirecting...</h1>
+        <p>You should be redirected automatically to target URL: <a href="${url}">${url}</a>.  If not click the link.</p>
+        `;
+    if (value > 1) {
+      url = `${protocol}://${host}/absolute-redirect/${value - 1}`;
+      html = `
+            <title>Redirecting...</title>
+            <h1>Redirecting...</h1>
+            <p>You should be redirected automatically to target URL: <a href="${url}">${url}</a>.  If not click the link.</p>
+            `;
+    }
+    await reply.header("Location", url).status(302).type("text/html").send(html);
+  });
+}, "absoluteRedirectRoute");
+
+// src/routes/redirects/relative-redirect.ts
+var relativeRedirectSchema = {
+  tags: [
+    "Redirects"
+  ],
+  description: "Redirects the request to the target URL using an relative URL",
+  params: {
+    type: "object",
+    properties: {
+      value: {
+        type: "integer",
+        minimum: 1
+      }
+    },
+    required: [
+      "value"
+    ]
+  },
+  headers: {
+    type: "object",
+    properties: {
+      host: {
+        type: "string"
+      }
+    },
+    required: [
+      "host"
+    ]
+  },
+  response: {
+    // eslint-disable-next-line  @typescript-eslint/naming-convention
+    302: {
+      type: "string"
+    }
+  }
+};
+var relativeRedirectRoute = /* @__PURE__ */ __name((fastify2) => {
+  fastify2.get("/relative-redirect/:value", {
+    schema: relativeRedirectSchema
+  }, async (request, reply) => {
+    const value = request.params.value;
+    let url = "/get";
+    let html = `
+        <title>Redirecting...</title>
+        <h1>Redirecting...</h1>
+        <p>You should be redirected automatically to target URL: <a href="${url}">${url}</a>.  If not click the link.</p>
+        `;
+    if (value > 1) {
+      url = `/relative-redirect/${value - 1}`;
+      html = `
+            <title>Redirecting...</title>
+            <h1>Redirecting...</h1>
+            <p>You should be redirected automatically to target URL: <a href="${url}">${url}</a>.  If not click the link.</p>
+            `;
+    }
+    await reply.header("Location", url).status(302).type("text/html").send(html);
+  });
+}, "relativeRedirectRoute");
+
+// src/routes/redirects/redirect-to.ts
+var redirectToSchema = {
+  tags: [
+    "Redirects"
+  ],
+  description: "Redirects the request to the target URL",
+  querystring: {
+    type: "object",
+    properties: {
+      url: {
+        type: "string",
+        format: "uri",
+        description: "The URL to redirect to"
+      },
+      // eslint-disable-next-line  @typescript-eslint/naming-convention
+      status_code: {
+        type: "string",
+        pattern: "^[1-5][0-9][0-9]$",
+        description: "The HTTP status code to use for redirection"
+      }
+    },
+    required: [
+      "url"
+    ],
+    additionalProperties: false
+  }
+};
+var redirectToRoute = /* @__PURE__ */ __name((fastify2) => {
+  const handler = /* @__PURE__ */ __name(async (request, reply) => {
+    const { url, status_code } = request.query;
+    const statusCode = status_code ? Number(status_code) : 302;
+    await reply.redirect(url, statusCode);
+  }, "handler");
+  fastify2.get("/redirect-to", {
+    schema: redirectToSchema
+  }, handler);
+  fastify2.post("/redirect-to", {
+    schema: redirectToSchema
+  }, handler);
+  fastify2.put("/redirect-to", {
+    schema: redirectToSchema
+  }, handler);
+  fastify2.patch("/redirect-to", {
+    schema: redirectToSchema
+  }, handler);
+  fastify2.delete("/redirect-to", {
+    schema: redirectToSchema
+  }, handler);
+}, "redirectToRoute");
+
 // src/index.ts
 var fastify = Fastify(fastifyConfig);
 await fastify.register(fastifyStatic, {
@@ -1057,13 +1265,11 @@ await fastify.register(fastifyStatic, {
   root: path.resolve("./public"),
   decorateReply: false
 });
-await fastify.register(fastifyCors, {
-  origin: "*"
-});
 await fastify.register(fastifyHelmet);
 await fastify.register(fastifySwagger, fastifySwaggerConfig);
 await registerSwaggerUi(fastify);
 await fastify.register(indexRoute);
+await fastify.register(sitemapRoute);
 await fastify.register(getRoute);
 await fastify.register(postRoute);
 await fastify.register(deleteRoute);
@@ -1076,6 +1282,9 @@ await fastify.register(userAgentRoute);
 await fastify.register(cacheRoutes);
 await fastify.register(etagRoutes);
 await fastify.register(responseHeadersRoutes);
+await fastify.register(absoluteRedirectRoute);
+await fastify.register(relativeRedirectRoute);
+await fastify.register(redirectToRoute);
 var start = /* @__PURE__ */ __name(async () => {
   try {
     let port = 3e3;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaredwray/mockhttp",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Mock Http - Easy way to mock http with httpbin replacement",
   "type": "module",
   "main": "dist/index.js",
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "test": "xo --fix && vitest run --coverage",
-    "dev": "xo --fix && npx tsx src/index.ts --watch",
+    "dev": "xo --fix && 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",
@@ -36,26 +36,25 @@
   },
   "homepage": "https://github.com/jaredwray/mockhttp#readme",
   "devDependencies": {
-    "@swc/core": "^1.10.1",
+    "@swc/core": "^1.10.9",
     "@types/html-escaper": "^3.0.2",
-    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/coverage-v8": "^3.0.4",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.5",
+    "tsup": "^8.3.6",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.8",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.4",
     "xo": "^0.60.0"
   },
   "dependencies": {
-    "@fastify/cors": "^10.0.1",
-    "@fastify/helmet": "^13.0.0",
-    "@fastify/static": "^8.0.3",
-    "@fastify/swagger": "^9.4.0",
-    "@fastify/swagger-ui": "^5.2.0",
-    "@scalar/api-reference": "^1.25.82",
-    "fastify": "^5.1.0",
+    "@fastify/helmet": "^13.0.1",
+    "@fastify/static": "^8.0.4",
+    "@fastify/swagger": "^9.4.2",
+    "@fastify/swagger-ui": "^5.2.1",
+    "@scalar/api-reference": "^1.25.108",
+    "fastify": "^5.2.1",
     "html-escaper": "^3.0.3",
-    "pino": "^9.5.0",
+    "pino": "^9.6.0",
     "pino-pretty": "^13.0.0"
   },
   "files": [

package/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /