Add docs site

ejsmith · ejsmith · commit 471808a66fed · 2025-08-28T21:08:43.000-05:00
diff --git a/deno.json b/deno.json
@@ -14,5 +14,5 @@
     "@std/path": "jsr:@std/path@^1.1.2",
     "zod": "npm:zod@^4.1.4"
   },
-  "exclude": ["npm"]
+  "exclude": ["npm", "docs"]
 }
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.vitepress/cache/
+.vitepress/dist/
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -0,0 +1,64 @@
+import { defineConfig } from "vitepress";
+
+export default defineConfig({
+  title: "Foundatio FetchClient",
+  description:
+    "A tiny, typed wrapper around fetch with caching, middleware, rate limiting, and great DX.",
+  base: "/",
+  ignoreDeadLinks: true,
+  head: [
+    ["link", {
+      rel: "icon",
+      href:
+        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png",
+      type: "image/png",
+    }],
+    ["meta", { name: "theme-color", content: "#3c8772" }],
+  ],
+  themeConfig: {
+    logo: {
+      light:
+        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/master/media/foundatio.svg",
+      dark:
+        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/master/media/foundatio-dark-bg.svg",
+    },
+    siteTitle: "FetchClient",
+    nav: [
+      { text: "Guide", link: "/guide/what-is-fetchclient" },
+      { text: "GitHub", link: "https://github.com/FoundatioFx/FetchClient" },
+    ],
+    sidebar: {
+      "/guide/": [
+        {
+          text: "Introduction",
+          items: [
+            {
+              text: "What is FetchClient?",
+              link: "/guide/what-is-fetchclient",
+            },
+            { text: "Getting Started", link: "/guide/getting-started" },
+            { text: "Features", link: "/guide/features" },
+          ],
+        },
+      ],
+    },
+    socialLinks: [
+      { icon: "github", link: "https://github.com/FoundatioFx/FetchClient" },
+      { icon: "discord", link: "https://discord.gg/6HxgFCx" },
+    ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright © 2025 Foundatio",
+    },
+    editLink: {
+      pattern:
+        "https://github.com/FoundatioFx/FetchClient/edit/main/docs/:path",
+    },
+    search: {
+      provider: "local",
+    },
+  },
+  markdown: {
+    lineNumbers: false,
+  },
+});
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -0,0 +1,64 @@
+import { defineConfig } from "vitepress";
+
+export default defineConfig({
+  title: "Foundatio FetchClient",
+  description:
+    "A tiny, typed wrapper around fetch with caching, middleware, rate limiting, and great DX.",
+  base: "/",
+  ignoreDeadLinks: true,
+  head: [
+    ["link", {
+      rel: "icon",
+      href:
+        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png",
+      type: "image/png",
+    }],
+    ["meta", { name: "theme-color", content: "#3c8772" }],
+  ],
+  themeConfig: {
+    logo: {
+      light:
+        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/master/media/foundatio.svg",
+      dark:
+        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/master/media/foundatio-dark-bg.svg",
+    },
+    siteTitle: "FetchClient",
+    nav: [
+      { text: "Guide", link: "/guide/what-is-fetchclient" },
+      { text: "GitHub", link: "https://github.com/FoundatioFx/FetchClient" },
+    ],
+    sidebar: {
+      "/guide/": [
+        {
+          text: "Introduction",
+          items: [
+            {
+              text: "What is FetchClient?",
+              link: "/guide/what-is-fetchclient",
+            },
+            { text: "Getting Started", link: "/guide/getting-started" },
+            { text: "Features", link: "/guide/features" },
+          ],
+        },
+      ],
+    },
+    socialLinks: [
+      { icon: "github", link: "https://github.com/FoundatioFx/FetchClient" },
+      { icon: "discord", link: "https://discord.gg/6HxgFCx" },
+    ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright © 2025 Foundatio",
+    },
+    editLink: {
+      pattern:
+        "https://github.com/FoundatioFx/FetchClient/edit/main/docs/:path",
+    },
+    search: {
+      provider: "local",
+    },
+  },
+  markdown: {
+    lineNumbers: false,
+  },
+});
diff --git a/docs/guide/features.md b/docs/guide/features.md
@@ -0,0 +1,13 @@
+# Features
+
+- Typed responses for JSON APIs
+- Functional helpers and class-based client
+- Caching with TTL and invalidation
+- Middleware pipeline
+- Rate limiting per domain
+- Timeouts and AbortSignal support
+- Problem Details error handling
+- Auth helpers (Bearer token)
+- Base URL and loading state
+
+See the README for richer examples.
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -0,0 +1,56 @@
+# Getting Started
+
+## Install
+
+```bash
+npm install @foundatiofx/fetchclient
+```
+
+## Quick Usage
+
+### Typed Response
+
+```ts
+import { FetchClient } from "@foundatiofx/fetchclient";
+
+type Products = { products: Array<{ id: number; name: string }> };
+
+const client = new FetchClient();
+const response = await client.getJSON<Products>(
+  `https://dummyjson.com/products/search?q=iphone&limit=10`,
+);
+
+const products = response.data;
+```
+
+### Functional API
+
+```ts
+import { getJSON, postJSON } from "@foundatiofx/fetchclient";
+
+type Product = { id: number; title: string };
+
+const { data: created } = await postJSON<Product>(
+  "https://dummyjson.com/products/add",
+  { name: "iPhone 13" },
+);
+
+const { data: product } = await getJSON<Product>(
+  `https://dummyjson.com/products/${created!.id}`,
+);
+```
+
+### Middleware
+
+```ts
+import { FetchClient, useMiddleware } from "@foundatiofx/fetchclient";
+
+useMiddleware(async (ctx, next) => {
+  console.log("starting request");
+  await next();
+  console.log("completed request");
+});
+
+const client = new FetchClient();
+await client.getJSON(`https://dummyjson.com/products/search?q=iphone`);
+```
diff --git a/docs/guide/what-is-fetchclient.md b/docs/guide/what-is-fetchclient.md
@@ -0,0 +1,13 @@
+# What is FetchClient?
+
+FetchClient is a tiny library that makes working with `fetch` delightful. It
+provides:
+
+- Typed JSON helpers: `getJSON`, `postJSON`, etc.
+- A `FetchClient` class with middleware support
+- Caching with TTL and programmatic invalidation
+- Rate limiting per domain
+- Timeouts and AbortSignal support
+- Helpful error handling with Problem Details
+
+Use just the functions for small scripts, or the client for full apps.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,42 @@
+---
+layout: home
+hero:
+  name: Foundatio FetchClient
+  text: Typed, ergonomic fetch for JS/TS
+  tagline: JSON helpers, caching, middleware, rate limiting, and great DX
+  image:
+    src: https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png
+    alt: Foundatio
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /guide/getting-started
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/FoundatioFx/FetchClient
+features:
+  - icon: ⚡
+    title: Typed Responses
+    details: Full TypeScript support for strongly-typed JSON results.
+  - icon: 🧩
+    title: Middleware & Caching
+    details: Compose middleware and cache responses with TTL.
+  - icon: 🎯
+    title: Rate Limits & Timeouts
+    details: Built-in rate limiting, timeouts, and robust error handling.
+---
+
+## Quick Example
+
+```ts
+import { FetchClient } from "@foundatiofx/fetchclient";
+
+type Products = { products: Array<{ id: number; name: string }> };
+
+const client = new FetchClient();
+const res = await client.getJSON<Products>(
+  `https://dummyjson.com/products/search?q=iphone&limit=10`,
+);
+
+console.log(res.data?.products.length);
+```
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
diff --git a/readme.md b/readme.md

Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,5 @@`
`14`	`14`	`"@std/path": "jsr:@std/path@^1.1.2",`
`15`	`15`	`"zod": "npm:zod@^4.1.4"`
`16`	`16`	`},`
`17`		`- "exclude": ["npm"]`
	`17`	`+ "exclude": ["npm", "docs"]`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules/`
	`2`	`+.vitepress/cache/`
	`3`	`+.vitepress/dist/`