@octokit/endpoint - npm Package Compare versions

Comparing version 7.0.6 to 8.0.0-beta.1

dist-node/index.js

@@ -27,2 +27,22 @@ "use strict";
 
+// pkg/dist-src/defaults.js
+var import_universal_user_agent = require("universal-user-agent");
+
+// pkg/dist-src/version.js
+var VERSION = "8.0.0-beta.1";
+
+// pkg/dist-src/defaults.js
+var userAgent = `octokit-endpoint.js/${VERSION} ${(0, import_universal_user_agent.getUserAgent)()}`;
+var DEFAULTS = {
+  method: "GET",
+  baseUrl: "https://api.github.com",
+  headers: {
+    accept: "application/vnd.github.v3+json",
+    "user-agent": userAgent
+  },
+  mediaType: {
+    format: ""
+  }
+};
+
 // pkg/dist-src/util/lowercase-keys.js
@@ -78,8 +98,12 @@ function lowercaseKeys(object) {
   const mergedOptions = mergeDeep(defaults || {}, options);
-  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") {
+    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) => preview.replace(/-preview/, "")
+    );
   }
-  mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(
-    (preview) => preview.replace(/-preview/, "")
-  );
   return mergedOptions;
@@ -276,3 +300,3 @@ }
       headers.accept = headers.accept.split(/,/).map(
-        (preview) => preview.replace(
+        (format) => format.replace(
           /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
@@ -283,8 +307,10 @@ `application/vnd$1$2.${options.mediaType.format}`
     }
-    if (options.mediaType.previews.length) {
-      const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
-      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.endsWith("/graphql")) {
+      if (options.mediaType.previews?.length) {
+        const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
+        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(",");
+      }
     }
@@ -333,23 +359,2 @@ }
 
-// pkg/dist-src/defaults.js
-var import_universal_user_agent = require("universal-user-agent");
-
-// pkg/dist-src/version.js
-var VERSION = "7.0.6";
-
-// pkg/dist-src/defaults.js
-var userAgent = `octokit-endpoint.js/${VERSION} ${(0, import_universal_user_agent.getUserAgent)()}`;
-var DEFAULTS = {
-  method: "GET",
-  baseUrl: "https://api.github.com",
-  headers: {
-    accept: "application/vnd.github.v3+json",
-    "user-agent": userAgent
-  },
-  mediaType: {
-    format: "",
-    previews: []
-  }
-};
-
 // pkg/dist-src/index.js
@@ -356,0 +361,0 @@ var endpoint = withDefaults(null, DEFAULTS);

dist-src/defaults.js

@@ -12,4 +12,3 @@ import { getUserAgent } from "universal-user-agent";
   mediaType: {
-    format: "",
-    previews: []
+    format: ""
   }
@@ -16,0 +15,0 @@ };

dist-src/endpoint-with-defaults.js

@@ -0,1 +1,2 @@
+import { DEFAULTS } from "./defaults";
 import { merge } from "./merge";
@@ -2,0 +3,0 @@ import { parse } from "./parse";

dist-src/merge.js

@@ -15,8 +15,12 @@ import { lowercaseKeys } from "./util/lowercase-keys";
   const mergedOptions = mergeDeep(defaults || {}, options);
-  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") {
+    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) => preview.replace(/-preview/, "")
+    );
   }
-  mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(
-    (preview) => preview.replace(/-preview/, "")
-  );
   return mergedOptions;
@@ -23,0 +27,0 @@ }

dist-src/parse.js

@@ -29,3 +29,3 @@ import { addQueryParameters } from "./util/add-query-parameters";
       headers.accept = headers.accept.split(/,/).map(
-        (preview) => preview.replace(
+        (format) => format.replace(
           /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
@@ -36,8 +36,10 @@ `application/vnd$1$2.${options.mediaType.format}`
     }
-    if (options.mediaType.previews.length) {
-      const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
-      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.endsWith("/graphql")) {
+      if (options.mediaType.previews?.length) {
+        const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
+        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(",");
+      }
     }
@@ -44,0 +46,0 @@ }

dist-src/version.js

@@ -1,4 +0,4 @@
-const VERSION = "7.0.6";
+const VERSION = "8.0.0-beta.1";
 export {
   VERSION
 };

dist-types/version.d.ts

@@ -1,1 +0,1 @@
-export declare const VERSION = "7.0.6";
+export declare const VERSION = "8.0.0-beta.1";

dist-web/index.js

@@ -0,1 +1,21 @@
+// pkg/dist-src/defaults.js
+import { getUserAgent } from "universal-user-agent";
+
+// pkg/dist-src/version.js
+var VERSION = "8.0.0-beta.1";
+
+// pkg/dist-src/defaults.js
+var userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;
+var DEFAULTS = {
+  method: "GET",
+  baseUrl: "https://api.github.com",
+  headers: {
+    accept: "application/vnd.github.v3+json",
+    "user-agent": userAgent
+  },
+  mediaType: {
+    format: ""
+  }
+};
+
 // pkg/dist-src/util/lowercase-keys.js
@@ -51,8 +71,12 @@ function lowercaseKeys(object) {
   const mergedOptions = mergeDeep(defaults || {}, options);
-  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") {
+    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) => preview.replace(/-preview/, "")
+    );
   }
-  mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(
-    (preview) => preview.replace(/-preview/, "")
-  );
   return mergedOptions;
@@ -249,3 +273,3 @@ }
       headers.accept = headers.accept.split(/,/).map(
-        (preview) => preview.replace(
+        (format) => format.replace(
           /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
@@ -256,8 +280,10 @@ `application/vnd$1$2.${options.mediaType.format}`
     }
-    if (options.mediaType.previews.length) {
-      const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
-      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.endsWith("/graphql")) {
+      if (options.mediaType.previews?.length) {
+        const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
+        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(",");
+      }
     }
@@ -306,23 +332,2 @@ }
 
-// pkg/dist-src/defaults.js
-import { getUserAgent } from "universal-user-agent";
-
-// pkg/dist-src/version.js
-var VERSION = "7.0.6";
-
-// pkg/dist-src/defaults.js
-var userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;
-var DEFAULTS = {
-  method: "GET",
-  baseUrl: "https://api.github.com",
-  headers: {
-    accept: "application/vnd.github.v3+json",
-    "user-agent": userAgent
-  },
-  mediaType: {
-    format: "",
-    previews: []
-  }
-};
-
 // pkg/dist-src/index.js
@@ -329,0 +334,0 @@ var endpoint = withDefaults(null, DEFAULTS);

package.json

 {
   "name": "@octokit/endpoint",
-  "version": "7.0.6",
+  "version": "8.0.0-beta.1",
   "publishConfig": {
@@ -20,3 +20,3 @@ "access": "public"
     "@types/jest": "^29.0.0",
-    "esbuild": "^0.17.19",
+    "esbuild": "^0.18.0",
     "glob": "^10.2.7",
@@ -31,3 +31,3 @@ "jest": "^29.0.0",
   "dependencies": {
-    "@octokit/types": "^9.0.0",
+    "@octokit/types": "^10.0.0",
     "is-plain-object": "^5.0.0",
@@ -37,3 +37,3 @@ "universal-user-agent": "^6.0.0"
   "engines": {
-    "node": ">= 14"
+    "node": ">= 18"
   },
@@ -40,0 +40,0 @@ "files": [

README.md

@@ -189,13 +189,2 @@ # endpoint.js
       <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>
@@ -202,0 +191,0 @@ </th>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

87606

increased by0.22%

Lines of code

1055

increased by1.54%

Worsened metrics

Number of low quality alerts

2

increased by100%

Number of lines in readme file

411

decreased by-2.61%

Dependency changes

• + Added@octokit/types@10.0.0(transitive)

• - Removed@octokit/types@9.3.2(transitive)

• Updated@octokit/types@^10.0.0