Update openapi-fetch, add docs sitemap (#1108)

docs/astro.config.mjs

@@ -1,11 +1,12 @@
 import { defineConfig } from "astro/config";
 import preact from "@astrojs/preact";
 import react from "@astrojs/react";
+import sitemap from "@astrojs/sitemap";
 
 // https://astro.build/config
 export default defineConfig({
-  integrations: [preact(), react()],
-  site: `https://openapi-typescript.pages.dev`,
+  integrations: [preact(), react(), sitemap()],
+  site: `https://openapi-ts.pages.dev`,
   vite: {
     define: {
       "import.meta.env.VITE_ALGOLIA_APP_ID": JSON.stringify(process.env.ALGOLIA_APP_ID ?? ""),

docs/package.json

@@ -21,6 +21,7 @@
     "sass": "^1.62.1"
   },
   "devDependencies": {
+    "@astrojs/sitemap": "^1.3.1",
     "@types/node": "^20.1.1",
     "html-escaper": "^3.0.3",
     "typescript": "^5.0.4"

docs/src/components/HeadCommon.astro

@@ -2,17 +2,12 @@
 import "../styles/app.scss";
 ---
 
-<!-- Global Metadata -->
 <meta charset="utf-8" />
 <meta name="viewport" content="width=device-width" />
 <meta name="generator" content={Astro.generator} />
 <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
-<link rel="sitemap" href="/sitemap.xml" />
-
-<!-- Scrollable a11y code helper -->
+<link rel="sitemap" href="/sitemap-index.xml" />
 <script src="/make-scrollable-code-focusable.js" is:inline></script>
-
-<!-- This is intentionally inlined to avoid FOUC -->
 <script is:inline>
   const root = document.documentElement;
   const theme = localStorage.getItem("theme");
@@ -22,12 +17,3 @@ import "../styles/app.scss";
     root.classList.remove("theme-dark");
   }
 </script>
-
-<!-- Global site tag (gtag.js) - Google Analytics -->
-<!-- <script async src="https://www.googletagmanager.com/gtag/js?id=G-TEL60V1WM9" is:inline></script>
-<script>
-  window.dataLayer = window.dataLayer || [];
-  function gtag(){dataLayer.push(arguments);}
-  gtag('js', new Date());
-  gtag('config', 'G-TEL60V1WM9');
-</script> -->

docs/src/components/HeadSEO.astro

@@ -11,10 +11,7 @@ const canonicalImageSrc = new URL(imageSrc, Astro.site);
 const imageAlt = image?.alt ?? OPEN_GRAPH.image.alt;
 ---
 
-<!-- Page Metadata -->
 <link rel="canonical" href={canonicalUrl} />
-
-<!-- OpenGraph Tags -->
 <meta property="og:title" content={formattedContentTitle} />
 <meta property="og:type" content="article" />
 <meta property="og:url" content={canonicalUrl} />
@@ -23,18 +20,9 @@ const imageAlt = image?.alt ?? OPEN_GRAPH.image.alt;
 <meta property="og:image:alt" content={imageAlt} />
 <meta name="description" property="og:description" content={description ?? SITE.description} />
 <meta property="og:site_name" content={SITE.title} />
-
-<!-- Twitter Tags -->
 <meta name="twitter:card" content="summary_large_image" />
 <meta name="twitter:site" content={OPEN_GRAPH.twitter} />
 <meta name="twitter:title" content={formattedContentTitle} />
 <meta name="twitter:description" content={description ?? SITE.description} />
 <meta name="twitter:image" content={canonicalImageSrc} />
 <meta name="twitter:image:alt" content={imageAlt} />
-
-<!--
-  TODO: Add json+ld data, maybe https://schema.org/APIReference makes sense?
-  Docs: https://developers.google.com/search/docs/advanced/structured-data/intro-structured-data
-  https://www.npmjs.com/package/schema-dts seems like a great resource for implementing this.
-  Even better, there's a React component that integrates with `schema-dts`: https://github.com/google/react-schemaorg
--->

docs/src/components/Header/Search.tsx

@@ -1,10 +1,9 @@
 /** @jsxImportSource react */
 import { useState, useCallback, useRef } from "react";
 import "@docsearch/css";
-import "./Search.css";
-
-import { createPortal } from "react-dom";
 import * as docSearchReact from "@docsearch/react";
+import { createPortal } from "react-dom";
+import "./Search.css";
 
 /** FIXME: This is still kinda nasty, but DocSearch is not ESM ready. */
 const DocSearchModal = docSearchReact.DocSearchModal || (docSearchReact as any).default.DocSearchModal;

docs/src/components/LeftSidebar/LeftSidebar.astro

@@ -1,6 +1,4 @@
 ---
-import { SIDEBAR } from "../../consts.js";
-
 type Props = {
   currentPage: string;
 };

docs/src/layouts/MainLayout.astro

@@ -15,6 +15,11 @@ type Props = CollectionEntry<"docs">["data"] & {
   headings: MarkdownHeading[];
 };
 
+interface Link {
+  url: string;
+  text: string;
+}
+
 const { headings, ...data } = Astro.props;
 const canonicalURL = new URL(Astro.url.pathname, Astro.site);
 const currentPage = Astro.url.pathname;
@@ -131,7 +136,7 @@ const nextLink: Record<string, Link | undefined> = {
           <slot />
           {currentPage === "/about" && <Contributors usernames={OPENAPI_TS_CONTRIBUTORS} />}
           {currentPage === "/openapi-fetch/about" && <Contributors usernames={OPENAPI_FETCH_CONTRIBUTORS} />}
-          {nextLink[currentPage] && <NextLink href={nextLink[currentPage].url}>{nextLink[currentPage].text}</NextLink>}
+          {nextLink[currentPage] && <NextLink href={nextLink[currentPage]!.url}>{nextLink[currentPage]!.text}</NextLink>}
         </PageContent>
       </div>
       <aside id="grid-right" class="grid-sidebar" title="Table of Contents">

packages/openapi-fetch/CHANGELOG.md

@@ -1,5 +1,17 @@
 # openapi-fetch
 
+## 0.1.4
+
+### Patch Changes
+
+- 63ebe48: Fix request body type when optional (#48)
+
+## 0.1.3
+
+### Patch Changes
+
+- 8c01480: Fix querySerializer signature
+
 ## 0.1.2
 
 ### Patch Changes

packages/openapi-fetch/src/index.test.ts

@@ -351,6 +351,42 @@ describe("post()", () => {
     // assert error is empty
     expect(error).toBe(undefined);
   });
+
+  it("request body type when optional", async () => {
+    fetchMocker.mockResponse(() => ({ status: 201, body: "{}" }));
+    const client = createClient<paths>();
+
+    // expect error on wrong body type
+    // @ts-expect-error
+    await client.post("/post/optional", { body: { error: true } });
+
+    // (no error)
+    await client.post("/post/optional", {
+      body: {
+        title: "",
+        publish_date: 3,
+        body: "",
+      },
+    });
+  });
+
+  it("request body type when optional inline", async () => {
+    fetchMocker.mockResponse(() => ({ status: 201, body: "{}" }));
+    const client = createClient<paths>();
+
+    // expect error on wrong body type
+    // @ts-expect-error
+    await client.post("/post/optional/inline", { body: { error: true } });
+
+    // (no error)
+    await client.post("/post/optional/inline", {
+      body: {
+        title: "",
+        publish_date: 3,
+        body: "",
+      },
+    });
+  });
 });
 
 describe("delete()", () => {

packages/openapi-fetch/src/index.ts

@@ -34,16 +34,19 @@ export type FilterKeys<Obj, Matchers> = { [K in keyof Obj]: K extends Matchers ?
 /** handle "application/json", "application/vnd.api+json", "appliacation/json;charset=utf-8" and more */
 export type JSONLike = `${string}json${string}`;
 
-// fetch types
+// general purpose types
 export type Params<O> = O extends { parameters: any } ? { params: NonNullable<O["parameters"]> } : BaseParams;
-export type RequestBodyObj<O> = O extends { requestBody: any } ? O["requestBody"] : never;
+export type RequestBodyObj<O> = O extends { requestBody?: any } ? O["requestBody"] : never;
 export type RequestBodyContent<O> = undefined extends RequestBodyObj<O> ? FilterKeys<NonNullable<RequestBodyObj<O>>, "content"> | undefined : FilterKeys<RequestBodyObj<O>, "content">;
 export type RequestBodyJSON<O> = FilterKeys<RequestBodyContent<O>, JSONLike> extends never ? FilterKeys<NonNullable<RequestBodyContent<O>>, JSONLike> | undefined : FilterKeys<RequestBodyContent<O>, JSONLike>;
 export type RequestBody<O> = undefined extends RequestBodyJSON<O> ? { body?: RequestBodyJSON<O> } : { body: RequestBodyJSON<O> };
 export type QuerySerializer<O> = (query: O extends { parameters: { query: any } } ? O["parameters"]["query"] : Record<string, unknown>) => string;
-export type FetchOptions<T> = Params<T> & RequestBody<T> & Omit<RequestInit, "body"> & { querySerializer?: QuerySerializer<T> };
+export type RequestOptions<T> = Params<T> & RequestBody<T> & { querySerializer?: QuerySerializer<T> };
 export type Success<O> = FilterKeys<FilterKeys<O, OkStatus>, "content">;
 export type Error<O> = FilterKeys<FilterKeys<O, ErrorStatus>, "content">;
+
+// fetch types
+export type FetchOptions<T> = RequestOptions<T> & Omit<RequestInit, "body">;
 export type FetchResponse<T> =
   | { data: T extends { responses: any } ? NonNullable<FilterKeys<Success<T["responses"]>, JSONLike>> : unknown; error?: never; response: Response }
   | { data?: never; error: T extends { responses: any } ? NonNullable<FilterKeys<Error<T["responses"]>, JSONLike>> : unknown; response: Response };

packages/openapi-fetch/test/v1.d.ts

@@ -23,6 +23,28 @@ export interface paths {
       };
     };
   };
+  "/post/optional": {
+    post: {
+      requestBody: components["requestBodies"]["CreatePostOptional"];
+      responses: {
+        201: components["responses"]["CreatePost"];
+        500: components["responses"]["Error"];
+      };
+    };
+  };
+  "/post/optional/inline": {
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["Post"];
+        };
+      };
+      responses: {
+        201: components["responses"]["CreatePost"];
+        500: components["responses"]["Error"];
+      };
+    };
+  };
   "/posts": {
     get: {
       responses: {
@@ -271,6 +293,15 @@ export interface components {
         };
       };
     };
+    CreatePostOptional?: {
+      content: {
+        "application/json": {
+          title: string;
+          body: string;
+          publish_date: number;
+        };
+      };
+    };
     CreateTag?: {
       content: {
         "application/json": {

packages/openapi-fetch/test/v1.yaml

@@ -1,5 +1,7 @@
-openapi:
-  version: '3.1'
+openapi: 3.1
+info:
+  title: Test Specification
+  version: '1.0'
 paths:
   /comment:
     put:
@@ -19,6 +21,27 @@ paths:
           $ref: '#/components/responses/CreatePost'
         500:
           $ref: '#/components/responses/Error'
+  /post/optional:
+    post:
+      requestBody:
+        $ref: '#/components/requestBodies/CreatePostOptional'
+      responses:
+        201:
+          $ref: '#/components/responses/CreatePost'
+        500:
+          $ref: '#/components/responses/Error'
+  /post/optional/inline:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Post'
+      responses:
+        201:
+          $ref: '#/components/responses/CreatePost'
+        500:
+          $ref: '#/components/responses/Error'
   /posts:
     get:
       responses:
@@ -214,6 +237,23 @@ components:
               - title
               - body
               - publish_date
+    CreatePostOptional:
+      required: false
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              title:
+                type: string
+              body:
+                type: string
+              publish_date:
+                type: number
+            required:
+              - title
+              - body
+              - publish_date
     CreateTag:
       content:
         application/json: