@octokit/auth-token - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

dist-node/index.js

@@ -6,3 +6,3 @@ 'use strict';
 async function auth(token) {
-  const tokenType = /^v\d+\./.test(token) ? "installation" : "oauth";
+  const tokenType = token.split(/\./).length === 3 ? "app" : /^v\d+\./.test(token) ? "installation" : "oauth";
   return {
@@ -15,9 +15,22 @@ type: "token",
 
+/**
+ * Prefix token for usage in the Authorization header
+ *
+ * @param token OAuth token or JSON Web Token
+ */
+function withAuthorizationPrefix(token) {
+  if (token.split(/\./).length === 3) {
+    return `bearer ${token}`;
+  }
+
+  return `token ${token}`;
+}
+
 async function hook(token, request, route, parameters) {
   const endpoint = request.endpoint.merge(route, parameters);
-  endpoint.headers.authorization = `token ${token}`;
+  endpoint.headers.authorization = withAuthorizationPrefix(token);
   return request(endpoint);
 }
 
-function createTokenAuth(token) {
+const createTokenAuth = function createTokenAuth(token) {
   if (!token) {
@@ -31,8 +44,9 @@ throw new Error("[@octokit/auth-token] No token passed to createTokenAuth");
 
+  token = token.replace(/^(token|bearer) +/i, "");
   return Object.assign(auth.bind(null, token), {
     hook: hook.bind(null, token)
   });
-}
+};
 
 exports.createTokenAuth = createTokenAuth;
 //# sourceMappingURL=index.js.map

dist-src/auth.js

 export async function auth(token) {
-    const tokenType = /^v\d+\./.test(token) ? "installation" : "oauth";
+    const tokenType = token.split(/\./).length === 3
+        ? "app"
+        : /^v\d+\./.test(token)
+            ? "installation"
+            : "oauth";
     return {
@@ -4,0 +8,0 @@ type: "token",

dist-src/hook.js

@@ -0,5 +1,6 @@
+import { withAuthorizationPrefix } from "./with-authorization-prefix";
 export async function hook(token, request, route, parameters) {
     const endpoint = request.endpoint.merge(route, parameters);
-    endpoint.headers.authorization = `token ${token}`;
+    endpoint.headers.authorization = withAuthorizationPrefix(token);
     return request(endpoint);
 }

dist-src/index.js

 import { auth } from "./auth";
 import { hook } from "./hook";
-export function createTokenAuth(token) {
+export const createTokenAuth = function createTokenAuth(token) {
     if (!token) {
@@ -10,5 +10,6 @@ throw new Error("[@octokit/auth-token] No token passed to createTokenAuth");
     }
+    token = token.replace(/^(token|bearer) +/i, "");
     return Object.assign(auth.bind(null, token), {
         hook: hook.bind(null, token)
     });
-}
+};

dist-types/index.d.ts

@@ -1,2 +0,2 @@
-import { AuthInterface, Token } from "./types";
-export declare function createTokenAuth(token: Token): AuthInterface;
+import { StrategyInterface } from "./types";
+export declare const createTokenAuth: StrategyInterface;

dist-types/types.d.ts

 import * as OctokitTypes from "@octokit/types";
 export declare type AnyResponse = OctokitTypes.OctokitResponse<any>;
-export declare type AuthInterface = OctokitTypes.AuthInterface;
+export declare type StrategyInterface = OctokitTypes.StrategyInterface<[Token], [], Authentication>;
 export declare type EndpointDefaults = OctokitTypes.EndpointDefaults;
@@ -20,2 +20,7 @@ export declare type EndpointOptions = OctokitTypes.EndpointOptions;
 };
-export declare type Authentication = OAuthTokenAuthentication | InstallationTokenAuthentication;
+export declare type AppAuthentication = {
+    type: "token";
+    tokenType: "app";
+    token: Token;
+};
+export declare type Authentication = OAuthTokenAuthentication | InstallationTokenAuthentication | AppAuthentication;

dist-web/index.js

 async function auth(token) {
-    const tokenType = /^v\d+\./.test(token) ? "installation" : "oauth";
+    const tokenType = token.split(/\./).length === 3
+        ? "app"
+        : /^v\d+\./.test(token)
+            ? "installation"
+            : "oauth";
     return {
@@ -10,9 +14,21 @@ type: "token",
 
+/**
+ * Prefix token for usage in the Authorization header
+ *
+ * @param token OAuth token or JSON Web Token
+ */
+function withAuthorizationPrefix(token) {
+    if (token.split(/\./).length === 3) {
+        return `bearer ${token}`;
+    }
+    return `token ${token}`;
+}
+
 async function hook(token, request, route, parameters) {
     const endpoint = request.endpoint.merge(route, parameters);
-    endpoint.headers.authorization = `token ${token}`;
+    endpoint.headers.authorization = withAuthorizationPrefix(token);
     return request(endpoint);
 }
 
-function createTokenAuth(token) {
+const createTokenAuth = function createTokenAuth(token) {
     if (!token) {
@@ -24,8 +40,9 @@ throw new Error("[@octokit/auth-token] No token passed to createTokenAuth");
     }
+    token = token.replace(/^(token|bearer) +/i, "");
     return Object.assign(auth.bind(null, token), {
         hook: hook.bind(null, token)
     });
-}
+};
 
 export { createTokenAuth };
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@octokit/auth-token",
   "description": "GitHub API token authentication for browsers and Node.js",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "license": "MIT",
@@ -24,3 +24,3 @@ "files": [
   "dependencies": {
-    "@octokit/types": "^1.1.0"
+    "@octokit/types": "^2.0.0"
   },
@@ -47,3 +47,3 @@ "devDependencies": {
   "main": "dist-node/index.js",
-  "deno": "dist-web/index.js"
+  "module": "dist-web/index.js"
 }

No alert changes

Improved metrics

Total package byte prevSize

21038

increased by20.46%

Number of package files

17

increased by13.33%

Lines of code

162

increased by52.83%

Dependency changes

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

• + Added@types/node@20.12.13(transitive)

• + Addedundici-types@5.26.5(transitive)

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

• - Removed@types/node@12.20.55(transitive)

• Updated@octokit/types@^2.0.0