feat: remove previews logic

README.md

@@ -184,17 +184,6 @@ axios(requestOptions);
         Media type param, such as <code>raw</code>, <code>diff</code>, or <code>text+json</code>. See <a href="https://developer.github.com/v3/media/">Media Types</a>. Setting <code>options.mediaType.format</code> will amend the <code>headers.accept</code> value.
       </td>
     </tr>
-    <tr>
-      <th>
-        <code>options.mediaType.previews</code>
-      </th>
-      <td>
-        Array of Strings
-      </td>
-      <td>
-        Name of previews, such as <code>mercy</code>, <code>symmetra</code>, or <code>scarlet-witch</code>. See <a href="https://developer.github.com/v3/previews/">API Previews</a>. If <code>options.mediaType.previews</code> was set as default, the new previews will be merged into the default ones. Setting <code>options.mediaType.previews</code> will amend the <code>headers.accept</code> value. <code>options.mediaType.previews</code> will be merged with an existing array set using <code>.defaults()</code>.
-      </td>
-    </tr>
     <tr>
       <th>
         <code>options.data</code>

src/defaults.ts

@@ -16,6 +16,5 @@ export const DEFAULTS: EndpointDefaults = {
   },
   mediaType: {
     format: "",
-    previews: [] as string[],
   },
 };

src/merge.ts

@@ -25,16 +25,20 @@ export function merge(
 
   const mergedOptions = mergeDeep(defaults || {}, options) as EndpointDefaults;
 
-  // mediaType.previews arrays are merged, instead of overwritten
-  if (defaults && defaults.mediaType.previews.length) {
-    mergedOptions.mediaType.previews = defaults.mediaType.previews
-      .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))
-      .concat(mergedOptions.mediaType.previews);
+  if (options.url === "/graphql") {
+    // mediaType.previews arrays are merged, instead of overwritten
+    if (defaults && defaults.mediaType.previews!.length) {
+      mergedOptions.mediaType.previews = defaults.mediaType.previews!
+        .filter(
+          (preview) => !mergedOptions.mediaType.previews!.includes(preview)
+        )
+        .concat(mergedOptions.mediaType.previews!);
+    }
+
+    mergedOptions.mediaType.previews = mergedOptions.mediaType.previews!.map(
+      (preview: string) => preview.replace(/-preview/, "")
+    );
   }
 
-  mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(
-    (preview: string) => preview.replace(/-preview/, "")
-  );
-
   return mergedOptions;
 }

src/parse.ts

@@ -47,27 +47,29 @@ export function parse(options: EndpointDefaults): RequestOptions {
       // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw
       headers.accept = headers.accept
         .split(/,/)
-        .map((preview) =>
-          preview.replace(
+        .map((format) =>
+          format.replace(
             /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
             `application/vnd$1$2.${options.mediaType.format}`
           )
         )
         .join(",");
     }
 
-    if (options.mediaType.previews.length) {
-      const previewsFromAcceptHeader =
-        headers.accept.match(/[\w-]+(?=-preview)/g) || ([] as string[]);
-      headers.accept = previewsFromAcceptHeader
-        .concat(options.mediaType.previews)
-        .map((preview) => {
-          const format = options.mediaType.format
-            ? `.${options.mediaType.format}`
-            : "+json";
-          return `application/vnd.github.${preview}-preview${format}`;
-        })
-        .join(",");
+    if (url === "/graphql") {
+      if (options.mediaType.previews!.length) {
+        const previewsFromAcceptHeader =
+          headers.accept.match(/[\w-]+(?=-preview)/g) || ([] as string[]);
+        headers.accept = previewsFromAcceptHeader
+          .concat(options.mediaType.previews!)
+          .map((preview) => {
+            const format = options.mediaType.format
+              ? `.${options.mediaType.format}`
+              : "+json";
+            return `application/vnd.github.${preview}-preview${format}`;
+          })
+          .join(",");
+      }
     }
   }
 

test/defaults.test.ts

@@ -89,51 +89,6 @@ describe("endpoint.defaults()", () => {
     });
     expect(myEndpoint.DEFAULTS.mediaType).toEqual({
       format: "raw",
-      previews: [],
-    });
-  });
-
-  it(".defaults() merges mediaType.previews", () => {
-    const myEndpoint = endpoint.defaults({
-      mediaType: {
-        previews: ["foo"],
-      },
-    });
-    const myEndpoint2 = myEndpoint.defaults({
-      mediaType: {
-        previews: ["bar"],
-      },
-    });
-
-    expect(myEndpoint.DEFAULTS.mediaType).toEqual({
-      format: "",
-      previews: ["foo"],
-    });
-    expect(myEndpoint2.DEFAULTS.mediaType).toEqual({
-      format: "",
-      previews: ["foo", "bar"],
-    });
-  });
-
-  it('.defaults() merges mediaType.previews with "-preview" suffix', () => {
-    const myEndpoint = endpoint.defaults({
-      mediaType: {
-        previews: ["foo-preview"],
-      },
-    });
-    const myEndpoint2 = myEndpoint.defaults({
-      mediaType: {
-        previews: ["bar-preview"],
-      },
-    });
-
-    expect(myEndpoint.DEFAULTS.mediaType).toEqual({
-      format: "",
-      previews: ["foo"],
-    });
-    expect(myEndpoint2.DEFAULTS.mediaType).toEqual({
-      format: "",
-      previews: ["foo", "bar"],
     });
   });
 });

test/endpoint.test.ts

@@ -362,126 +362,6 @@ describe("endpoint()", () => {
     });
   });
 
-  it("options.mediaType.previews", () => {
-    const options = endpoint({
-      method: "GET",
-      url: "/repos/{owner}/{repo}/issues/{number}",
-      mediaType: {
-        previews: ["symmetra"],
-      },
-      owner: "octokit",
-      repo: "endpoint.js",
-      number: 123,
-    });
-
-    expect(options).toEqual({
-      method: "GET",
-      url: "https://api.github.com/repos/octokit/endpoint.js/issues/123",
-      headers: {
-        accept: "application/vnd.github.symmetra-preview+json",
-        "user-agent": userAgent,
-      },
-    });
-  });
-
-  it("options.mediaType.previews with -preview suffix", () => {
-    const options = endpoint({
-      method: "GET",
-      url: "/repos/{owner}/{repo}/issues/{number}",
-      mediaType: {
-        previews: ["jean-grey-preview", "symmetra-preview"],
-      },
-      owner: "octokit",
-      repo: "endpoint.js",
-      number: 123,
-    });
-
-    expect(options).toEqual({
-      method: "GET",
-      url: "https://api.github.com/repos/octokit/endpoint.js/issues/123",
-      headers: {
-        accept:
-          "application/vnd.github.jean-grey-preview+json,application/vnd.github.symmetra-preview+json",
-        "user-agent": userAgent,
-      },
-    });
-  });
-
-  it("options.mediaType.format + options.mediaType.previews", () => {
-    const options = endpoint({
-      method: "GET",
-      url: "/repos/{owner}/{repo}/issues/{number}",
-      mediaType: {
-        format: "raw",
-        previews: ["symmetra"],
-      },
-      owner: "octokit",
-      repo: "endpoint.js",
-      number: 123,
-    });
-
-    expect(options).toEqual({
-      method: "GET",
-      url: "https://api.github.com/repos/octokit/endpoint.js/issues/123",
-      headers: {
-        accept: "application/vnd.github.symmetra-preview.raw",
-        "user-agent": userAgent,
-      },
-    });
-  });
-
-  it("options.mediaType.format + options.mediaType.previews + accept header", () => {
-    const options = endpoint({
-      method: "GET",
-      url: "/repos/{owner}/{repo}/issues/{number}",
-      headers: {
-        accept: "application/vnd.foo-preview,application/vnd.bar-preview",
-      },
-      mediaType: {
-        format: "raw",
-        previews: ["symmetra"],
-      },
-      owner: "octokit",
-      repo: "endpoint.js",
-      number: 123,
-    });
-
-    expect(options).toEqual({
-      method: "GET",
-      url: "https://api.github.com/repos/octokit/endpoint.js/issues/123",
-      headers: {
-        accept:
-          "application/vnd.github.foo-preview.raw,application/vnd.github.bar-preview.raw,application/vnd.github.symmetra-preview.raw",
-        "user-agent": userAgent,
-      },
-    });
-  });
-
-  it("application/octet-stream accept header + previews", () => {
-    const options = endpoint({
-      method: "GET",
-      url: "/repos/{owner}/{repo}/releases/assets/{asset_id}",
-      headers: {
-        accept: "application/octet-stream",
-      },
-      mediaType: {
-        previews: ["symmetra"],
-      },
-      owner: "octokit",
-      repo: "endpoint.js",
-      asset_id: 123,
-    });
-
-    expect(options).toEqual({
-      method: "GET",
-      url: "https://api.github.com/repos/octokit/endpoint.js/releases/assets/123",
-      headers: {
-        accept: "application/octet-stream",
-        "user-agent": userAgent,
-      },
-    });
-  });
-
   it("Undefined query parameter", () => {
     const options = endpoint({
       method: "GET",

test/merge.test.ts

@@ -28,7 +28,6 @@ describe("endpoint.merge()", () => {
       baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
       mediaType: {
         format: "",
-        previews: [],
       },
       method: "GET",
       url: "/orgs/{org}/repos",
@@ -62,7 +61,6 @@ describe("endpoint.merge()", () => {
       baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
       mediaType: {
         format: "",
-        previews: [],
       },
       method: "GET",
       url: "/orgs/{org}/repos",
@@ -81,7 +79,6 @@ describe("endpoint.merge()", () => {
       baseUrl: "https://api.github.com",
       mediaType: {
         format: "",
-        previews: [],
       },
       method: "GET",
       headers: {

test/parse.test.ts

@@ -28,7 +28,6 @@ describe("endpoint.parse()", () => {
       },
       mediaType: {
         format: "",
-        previews: [],
       },
     });
     expect(url).toEqual("https://example.com/");
@@ -45,7 +44,6 @@ describe("endpoint.parse()", () => {
       },
       mediaType: {
         format: "",
-        previews: ["foo", "bar"],
       },
     };