refactor: version parameter in cleanHeaders

__tests__/lib/fetch.test.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/ban-ts-comment, no-console */
+/* eslint-disable no-console */
 import { Headers } from 'node-fetch';
 import { describe, beforeEach, afterEach, it, expect, vi } from 'vitest';
 
@@ -328,19 +328,17 @@ describe('#cleanHeaders()', () => {
   });
 
   it('should filter out undefined headers', () => {
-    expect(
-      // @ts-ignore Testing a quirk of `node-fetch`.
-      Array.from(cleanHeaders('test', new Headers({ 'x-readme-version': undefined }))),
-    ).toStrictEqual([['authorization', 'Basic dGVzdDo=']]);
+    expect(Array.from(cleanHeaders('test', undefined, new Headers({ 'x-something': undefined })))).toStrictEqual([
+      ['authorization', 'Basic dGVzdDo='],
+    ]);
   });
 
   it('should filter out null headers', () => {
     expect(
-      // @ts-ignore Testing a quirk of `node-fetch`.
-      Array.from(cleanHeaders('test', new Headers({ 'x-readme-version': '1234', Accept: null }))),
+      Array.from(cleanHeaders('test', undefined, new Headers({ 'x-something': '1234', Accept: null }))),
     ).toStrictEqual([
       ['authorization', 'Basic dGVzdDo='],
-      ['x-readme-version', '1234'],
+      ['x-something', '1234'],
     ]);
   });
 
@@ -351,7 +349,7 @@ describe('#cleanHeaders()', () => {
       'Content-Type': 'application/json',
     });
 
-    expect(Array.from(cleanHeaders('test', headers))).toStrictEqual([
+    expect(Array.from(cleanHeaders('test', undefined, headers))).toStrictEqual([
       ['authorization', 'Basic dGVzdDo='],
       ['accept', 'text/plain'],
       ['content-type', 'application/json'],

src/cmds/categories/create.ts

@@ -90,13 +90,7 @@ export default class CategoriesCreateCommand extends Command {
       }
       return readmeAPIFetch('/api/v1/categories', {
         method: 'post',
-        headers: cleanHeaders(
-          key,
-          new Headers({
-            'x-readme-version': selectedVersion,
-            'Content-Type': 'application/json',
-          }),
-        ),
+        headers: cleanHeaders(key, selectedVersion, new Headers({ 'Content-Type': 'application/json' })),
         body: JSON.stringify({
           title,
           type: categoryType,

src/cmds/docs/edit.ts

@@ -64,13 +64,7 @@ export default class DocsEditCommand extends Command {
 
     const existingDoc = await readmeAPIFetch(`/api/v1/docs/${slug}`, {
       method: 'get',
-      headers: cleanHeaders(
-        key,
-        new Headers({
-          'x-readme-version': selectedVersion,
-          Accept: 'application/json',
-        }),
-      ),
+      headers: cleanHeaders(key, selectedVersion, new Headers({ Accept: 'application/json' })),
     }).then(handleRes);
 
     await writeFile(filename, existingDoc.body);
@@ -87,13 +81,7 @@ export default class DocsEditCommand extends Command {
 
         return readmeAPIFetch(`/api/v1/docs/${slug}`, {
           method: 'put',
-          headers: cleanHeaders(
-            key,
-            new Headers({
-              'x-readme-version': selectedVersion,
-              'Content-Type': 'application/json',
-            }),
-          ),
+          headers: cleanHeaders(key, selectedVersion, new Headers({ 'Content-Type': 'application/json' })),
           body: JSON.stringify(
             Object.assign(existingDoc, {
               body: updatedDoc,

src/cmds/openapi/index.ts

@@ -222,11 +222,8 @@ export default class OpenAPICommand extends Command {
     const options: RequestInit = {
       headers: cleanHeaders(
         key,
-        new Headers({
-          Accept: 'application/json',
-          'Content-Type': 'application/json',
-          'x-readme-version': selectedVersion,
-        }),
+        selectedVersion,
+        new Headers({ Accept: 'application/json', 'Content-Type': 'application/json' }),
       ),
       body: JSON.stringify({ registryUUID }),
     };
@@ -283,12 +280,7 @@ export default class OpenAPICommand extends Command {
     function getSpecs(url: string) {
       return readmeAPIFetch(url, {
         method: 'get',
-        headers: cleanHeaders(
-          key,
-          new Headers({
-            'x-readme-version': selectedVersion,
-          }),
-        ),
+        headers: cleanHeaders(key, selectedVersion),
       });
     }
 

src/cmds/versions/create.ts

@@ -91,10 +91,8 @@ export default class CreateVersionCommand extends Command {
       method: 'post',
       headers: cleanHeaders(
         key,
-        new Headers({
-          Accept: 'application/json',
-          'Content-Type': 'application/json',
-        }),
+        undefined,
+        new Headers({ Accept: 'application/json', 'Content-Type': 'application/json' }),
       ),
       body: JSON.stringify(body),
     })

src/cmds/versions/update.ts

@@ -78,10 +78,8 @@ export default class UpdateVersionCommand extends Command {
       method: 'put',
       headers: cleanHeaders(
         key,
-        new Headers({
-          Accept: 'application/json',
-          'Content-Type': 'application/json',
-        }),
+        undefined,
+        new Headers({ Accept: 'application/json', 'Content-Type': 'application/json' }),
       ),
       body: JSON.stringify(body),
     })

src/lib/deleteDoc.ts

@@ -26,13 +26,7 @@ export default async function deleteDoc(
   }
   return readmeAPIFetch(`/api/v1/${type}/${slug}`, {
     method: 'delete',
-    headers: cleanHeaders(
-      key,
-      new Headers({
-        'x-readme-version': selectedVersion,
-        'Content-Type': 'application/json',
-      }),
-    ),
+    headers: cleanHeaders(key, selectedVersion, new Headers({ 'Content-Type': 'application/json' })),
   })
     .then(handleRes)
     .then(() => `🗑️  successfully deleted \`${slug}\`.`);

src/lib/getCategories.ts

@@ -14,13 +14,7 @@ export default async function getCategories(key: string, selectedVersion: string
     let totalCount = 0;
     return readmeAPIFetch('/api/v1/categories?perPage=20&page=1', {
       method: 'get',
-      headers: cleanHeaders(
-        key,
-        new Headers({
-          'x-readme-version': selectedVersion,
-          Accept: 'application/json',
-        }),
-      ),
+      headers: cleanHeaders(key, selectedVersion, new Headers({ Accept: 'application/json' })),
     })
       .then(res => {
         totalCount = Math.ceil(parseInt(res.headers.get('x-total-count'), 10) / 20);
@@ -39,13 +33,7 @@ export default async function getCategories(key: string, selectedVersion: string
       [...new Array(totalCount + 1).keys()].slice(2).map(async page => {
         return readmeAPIFetch(`/api/v1/categories?perPage=20&page=${page}`, {
           method: 'get',
-          headers: cleanHeaders(
-            key,
-            new Headers({
-              'x-readme-version': selectedVersion,
-              Accept: 'application/json',
-            }),
-          ),
+          headers: cleanHeaders(key, selectedVersion, new Headers({ Accept: 'application/json' })),
         }).then(handleRes);
       }),
     )),

src/lib/getDocs.ts

@@ -34,13 +34,7 @@ function flatten(data: Document[][]): Document[] {
 async function getCategoryDocs(key: string, selectedVersion: string, category: string): Promise<Document[]> {
   return readmeAPIFetch(`/api/v1/categories/${category}/docs`, {
     method: 'get',
-    headers: cleanHeaders(
-      key,
-      new Headers({
-        'x-readme-version': selectedVersion,
-        'Content-Type': 'application/json',
-      }),
-    ),
+    headers: cleanHeaders(key, selectedVersion, new Headers({ 'Content-Type': 'application/json' })),
   }).then(handleRes);
 }
 

src/lib/readmeAPIFetch.ts

@@ -242,12 +242,21 @@ async function handleRes(res: Response, rejectOnJsonError = true) {
  * Returns the basic auth header and any other defined headers for use in `node-fetch` API calls.
  *
  */
-function cleanHeaders(key: string, inputHeaders: Headers = new Headers()) {
+function cleanHeaders(
+  key: string,
+  /** used for `x-readme-header` */
+  version?: string,
+  inputHeaders: Headers = new Headers(),
+) {
   const encodedKey = Buffer.from(`${key}:`).toString('base64');
   const headers = new Headers({
     Authorization: `Basic ${encodedKey}`,
   });
 
+  if (version) {
+    headers.set('x-readme-version', version);
+  }
+
   for (const header of inputHeaders.entries()) {
     // If you supply `undefined` or `null` to the `Headers` API it'll convert that those to a
     // string.

src/lib/syncDocsPath.ts

@@ -66,13 +66,7 @@ async function pushDoc(
         `/api/v1/${type}`,
         {
           method: 'post',
-          headers: cleanHeaders(
-            key,
-            new Headers({
-              'x-readme-version': selectedVersion,
-              'Content-Type': 'application/json',
-            }),
-          ),
+          headers: cleanHeaders(key, selectedVersion, new Headers({ 'Content-Type': 'application/json' })),
           body: JSON.stringify({
             slug,
             ...payload,
@@ -103,13 +97,7 @@ async function pushDoc(
       `/api/v1/${type}/${slug}`,
       {
         method: 'put',
-        headers: cleanHeaders(
-          key,
-          new Headers({
-            'x-readme-version': selectedVersion,
-            'Content-Type': 'application/json',
-          }),
-        ),
+        headers: cleanHeaders(key, selectedVersion, new Headers({ 'Content-Type': 'application/json' })),
         body: JSON.stringify(payload),
       },
       { filePath, fileType: 'path' },
@@ -120,13 +108,7 @@ async function pushDoc(
 
   return readmeAPIFetch(`/api/v1/${type}/${slug}`, {
     method: 'get',
-    headers: cleanHeaders(
-      key,
-      new Headers({
-        'x-readme-version': selectedVersion,
-        Accept: 'application/json',
-      }),
-    ),
+    headers: cleanHeaders(key, selectedVersion, new Headers({ Accept: 'application/json' })),
   })
     .then(async res => {
       const body = await handleRes(res, false);